Class StopRules

分段规则类

export

Hierarchy

StopRules

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StopRules(options: IStopRulesOptions, stopConverter?: ((stop: IStopRuleItem) => IStopRuleItem)): StopRules

- Defined in src/core/stop.rule.ts:151
创建 StopRules.

memberof
StopRules

Parameters
- options: IStopRulesOptions
  
  构造器选项
- Optional stopConverter: ((stop: IStopRuleItem) => IStopRuleItem)
  - - (stop: IStopRuleItem): IStopRuleItem
    - Parameters
      - stop: IStopRuleItem
      Returns IStopRuleItem
Returns StopRules

Properties

action

action: StopRuleActionMode

分段配置方式，class表示区间，unique表示唯一值。默认是class

memberof: StopRules

fieldName

fieldName: string

分段渲染的属性字段名

memberof: StopRules

getDesc

getDesc: ((val: StopRuleValueType) => string)

Type declaration

- (val: StopRuleValueType): string
- 根据value获取分段描述
  
  memberof
  StopRules
  
  Parameters
  - val: StopRuleValueType
  Returns string

getRuleIndex

getRuleIndex: ((val: StopRuleValueType) => number)

Type declaration

- (val: StopRuleValueType): number
- 根据value获取分段规则索引号
  
  memberof
  StopRules
  
  Parameters
  - val: StopRuleValueType
  Returns number

stops

stops: IStopRuleItem[]

配置项列表

memberof: StopRules

Methods

clone

clone(deep?: boolean, original?: boolean): StopRules

- Defined in src/core/stop.rule.ts:361
复制一份当前分段规则的副本

memberof
StopRules

Parameters
- deep: boolean = false
  
  是否是深拷贝，默认是false
- original: boolean = false
  
  是否是拷贝初始状态值，因为数据可能被动态修改，默认是false，表示拷贝当前状态
Returns StopRules
{StopRules}

getRule

getRule(val: StopRuleValueType, type?: "pre" | "current" | "next"): IStopRuleItem

- Defined in src/core/stop.rule.ts:288
根据value和判断方式获取分段配置

memberof
StopRules

Parameters
- val: StopRuleValueType
  
  要判断的值
- type: "pre" | "current" | "next" = "current"
Returns IStopRuleItem
{IStopRuleItem} 返回区间配置

getStops

getStops(): any[]

- Defined in src/core/stop.rule.ts:347
获取结果数组

memberof
StopRules

Returns any[]
{any[]}

getVal

getVal(stop: any, getId: ((stop: any) => string)): { max?: IStopRuleItem; min?: IStopRuleItem }

- Defined in src/core/stop.rule.ts:306
根据stop获取对应的value。需要提供一个id函数，用于确定每个stop的唯一值

memberof
StopRules

Parameters
- stop: any
  
  分段结果
- getId: ((stop: any) => string)
  
  id函数
  - - (stop: any): string
    - Parameters
      - stop: any
      Returns string
Returns { max?: IStopRuleItem; min?: IStopRuleItem }
{{ min?: IStopRuleItem, max?: IStopRuleItem }} 返回这个区间的对应的最大值配置和最小值配置。唯一值渲染的对应配置是最大值。
- Optional max?: IStopRuleItem
- Optional min?: IStopRuleItem

getVals

getVals(): StopRuleValueType[]

- Defined in src/core/stop.rule.ts:334
获取判据数组

memberof
StopRules

Returns StopRuleValueType[]
{number[]}

reset

reset(): void

- Defined in src/core/stop.rule.ts:371
将调色板恢复到初始状态

memberof
StopRules

Returns void

setOpacityByIndex

setOpacityByIndex(start: number, mode: StopRuleItemFilterMode, opacity?: number, end?: number): void

- Defined in src/core/stop.rule.ts:394
仅针对stop为颜色类型的透明度设置，可以通过reset方法恢复为原始透明度

memberof
StopRules

Parameters
- start: number
- mode: StopRuleItemFilterMode
  
  设置模式，默认为outside greater：表示将大于此索引的设置为指定的透明度
  
  less：表示将小于此索引的设置为指定的透明度
  
  inside：表示将start和end之间的设置为指定的透明度
  
  outside：表示将start和end之外的设置为指定的透明度
- Optional opacity: number
  
  透明度，默认为0
- Optional end: number
Returns void

Generated using TypeDoc