如何在JavaScript Excel Add-in中为自定义条件规则设置填充图案

目前Excel JavaScript API的公开接口并未提供直接设置条件格式填充图案样式及颜色的属性，但可以通过valuesAsJSON方法直接操作条件格式的底层JSON结构来实现需求。

实现步骤 #

• 获取目标区域的条件格式规则，加载其valuesAsJSON属性以获取完整的规则结构。
• 解析JSON字符串，修改对应填充图案的字段（包括pattern样式和patternColor颜色）。
• 将修改后的JSON字符串写回valuesAsJSON属性，完成设置。

代码示例 #

async function applyConditionalFormatPattern() {
  await Excel.run(async (context) => {
    const activeSheet = context.workbook.worksheets.getActiveWorksheet();
    const targetRange = activeSheet.getRange("A1:C10");
    // 获取目标区域的第一个条件格式规则（可根据实际调整获取方式）
    const targetCfRule = targetRange.conditionalFormats.getItemAt(0);

    // 加载规则的JSON结构
    targetCfRule.load("valuesAsJSON");
    await context.sync();

    // 解析并修改JSON内容
    let cfStructure = JSON.parse(targetCfRule.valuesAsJSON);
    // 以单元格值类型的条件格式为例，调整对应字段路径
    if (cfStructure.type === "cellValue") {
      // 设置填充图案样式，可选值如gray16、lightUp、darkDown等
      cfStructure.format.fill.pattern = "gray16";
      // 设置图案颜色，支持RGB、HEX等格式
      cfStructure.format.fill.patternColor = { rgb: "FF336699" };
    }

    // 将修改后的结构写回
    targetCfRule.valuesAsJSON = JSON.stringify(cfStructure);
    await context.sync();
  });
}

注意事项 #

• 不同类型的条件格式（如数据条、色阶、图标集等）对应的JSON结构路径存在差异，建议先手动在Excel中配置好带图案的条件格式，再通过valuesAsJSON导出结构，参考其字段路径进行修改。
• 该方式依赖Excel底层的JSON schema，虽当前可用，但后续API版本更新可能导致结构变化，需注意兼容性测试。

内容的提问来源于stack exchange，提问作者Alexander