API

Conditions
Condition

功能描述: 配置条件格式。TextCondition,BackgroundCondition,IntervalCondition,IconCondition 均继承于 Condition。

参数说明类型默认值必选
field1. 字段 ID
2. 使用正则表达式匹配字段 ID
string | RegExp✓
mapping作用映射函数​ConditionMapping✓

ConditionMapping

功能描述:字段标记处理函数。查看 文档 和 示例

// TextCondition,BackgroundCondition,IntervalCondition,IconCondition 各自对应的 mapping 函数返回 的 T 有所不同 
export type ConditionMapping<T = unknown> = ( 
  fieldValue: number | string, 
  data: RawData, 
  cell: S2CellType, 
) => ConditionMappingResult<T>; 
 

condition 用法示例:

const options = { 
  conditions: { 
    text: [ 
      { 
        field: "province", 
        mapping: (fieldValue, data, cell) => { 
          return { 
            fill: "green", 
            fontSize: 16, 
            opacity: 0.2, 
            textAlign: 'right' 
          }; 
        }, 
      }, 
    ], 
    interval: [ 
      { 
        field: "sub_type", 
        mapping: (fieldValue, data, cell) => { 
          return { 
            fill: "green", 
            isCompare: true, 
            maxValue: 8000, 
            minValue: 300, 
          }; 
        }, 
      }, 
    ], 
    background: [ 
      { 
        field: "count", 
        mapping: (fieldValue, data, cell) => { 
          return { 
            fill: "green", 
            intelligentReverseTextColor: true, 
          }; 
        }, 
      }, 
    ], 
    icon: [ 
      { 
        field: "number", 
        position: 'left', 
        mapping: (fieldValue, data, cell) => { 
          return { 
            icon: "InfoCircle", 
            fill: "green", 
          }; 
        }, 
      }, 
    ], 
  }, 
}; 
 
TextCondition
BackgroundCondition
IntervalCondition
IconCondition