Class LegendService

Hierarchy

Evented
- LegendService

Index

Constructors

constructor

Properties

EventTypes

Methods

Constructors

constructor

new LegendService(): LegendService

Inherited from Evented.constructor
Returns LegendService

Properties

Static EventTypes

EventTypes: { attach: string; attachFirst: string; changeOpacity: string; detach: string; detachLast: string } = ...

Type declaration

attach: string

每当有图例增加时触发，不管key是否相同都会触发
attachFirst: string

当某个key的图例第一次被增加时触发
changeOpacity: string

当有透明度发生变化的时候触发
detach: string

当有图例被移除的时候触发
detachLast: string

当某个key的图例最后一个被移除时候触发

Methods

addEventParent

addEventParent(obj: any): LegendService

Inherited from Evented.addEventParent
- Defined in src/core/evented.ts:299
Parameters
- obj: any
Returns LegendService

attach

attach(key: string, onChanged: LegendServiceStopsChangedFunc, sr?: IStopRulesOptions | StopRules): void

- Defined in src/services/legend.service.ts:43
增加一个调色板的监听，一般在图层增加的时候调用，在图例组件中监听相关事件实现视图更新

memberof
LegendService

Parameters
- key: string
  
  调色板的资源key，同样的key表示相同的调色板
- onChanged: LegendServiceStopsChangedFunc
  
  当调色板数值发生改变时的回调
- Optional sr: IStopRulesOptions | StopRules
Returns void

detach

detach(key: string, onChanged?: LegendServiceStopsChangedFunc): void

- Defined in src/services/legend.service.ts:98
清除指定key的回调。一般在图层被移除的时候调用，在图例组件中监听相关事件实现视图更新

memberof
LegendService

Parameters
- key: string
  
  指定的调色板key
- Optional onChanged: LegendServiceStopsChangedFunc
Returns void

fire

fire(type: any, data: IEventData, propagate?: any): LegendService

Inherited from Evented.fire
- Defined in src/core/evented.ts:220
Parameters
- type: any
- data: IEventData
- Optional propagate: any
Returns LegendService

listens

listens(type: any, propagate?: any): boolean

Inherited from Evented.listens
- Defined in src/core/evented.ts:261
Parameters
- type: any
- Optional propagate: any
Returns boolean

lock

lock(): LegendService

Inherited from Evented.lock
- Defined in src/core/evented.ts:119
Returns LegendService

off

off(types: any, fn: any, context?: any): LegendService

Inherited from Evented.off
- Defined in src/core/evented.ts:97
Parameters
- types: any
- fn: any
- Optional context: any
Returns LegendService

on

on(types: any, fn: ((event: IEventData) => void), context?: any): LegendService

Inherited from Evented.on
- Defined in src/core/evented.ts:64
Parameters
- types: any
- fn: ((event: IEventData) => void)
  - - (event: IEventData): void
    - Parameters
      - event: IEventData
      Returns void
- Optional context: any
Returns LegendService

once

once(types: any, fn: ((event: IEventData) => void), context?: any): LegendService

Inherited from Evented.once
- Defined in src/core/evented.ts:276
Parameters
- types: any
- fn: ((event: IEventData) => void)
  - - (event: IEventData): void
    - Parameters
      - event: IEventData
      Returns void
- Optional context: any
Returns LegendService

removeEventParent

removeEventParent(obj: any): LegendService

Inherited from Evented.removeEventParent
- Defined in src/core/evented.ts:307
Parameters
- obj: any
Returns LegendService

setOpacity

setOpacity(key: string, min: number, max?: number, mode?: StopRuleItemFilterMode, opacity?: number): void

- Defined in src/services/legend.service.ts:79
对色标进行过滤，一般可以构建一个色标组件，在组件中相关参数发生变化的时候调用该方法

memberof
LegendService

Parameters
- key: string
  
  用于查找色标的key，在attach的时候提供
- min: number
  
  开始值
- Optional max: number
- mode: StopRuleItemFilterMode = StopRuleItemFilterMode.outside
- opacity: number = 0
  
  透明度，默认为0
Returns void

unlock

unlock(fireLocked?: boolean): void

Inherited from Evented.unlock
- Defined in src/core/evented.ts:124
Parameters
- fireLocked: boolean = true
Returns void

Generated using TypeDoc