Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StopRules

分段规则类

export

Hierarchy

  • StopRules

Index

Constructors

Properties

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

memberof

StopRules

fieldName: string

分段渲染的属性字段名

memberof

StopRules

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

Type declaration

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

Type declaration

stops: IStopRuleItem[]

配置项列表

memberof

StopRules

Methods

  • clone(deep?: boolean, original?: boolean): StopRules
  • 复制一份当前分段规则的副本

    memberof

    StopRules

    Parameters

    • deep: boolean = false

      是否是深拷贝,默认是false

    • original: boolean = false

      是否是拷贝初始状态值,因为数据可能被动态修改,默认是false,表示拷贝当前状态

    Returns StopRules

    {StopRules}

  • 根据value和判断方式获取分段配置

    memberof

    StopRules

    Parameters

    Returns IStopRuleItem

    {IStopRuleItem} 返回区间配置

  • getStops(): any[]
  • 获取结果数组

    memberof

    StopRules

    Returns any[]

    {any[]}

  • 根据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 }} 返回这个区间的对应的最大值配置和最小值配置。唯一值渲染的对应配置是最大值。

  • 获取判据数组

    memberof

    StopRules

    Returns StopRuleValueType[]

    {number[]}

  • reset(): void
  • 将调色板恢复到初始状态

    memberof

    StopRules

    Returns void

  • 仅针对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