Class: CosmographRangeColorLegend
Internal
Abstract component that enforces exclusive selection across all instances. Only one component of this type can have an active selection at any time.
Extends
CosmographExclusiveSelectionComponent<CosmographRangeColorLegendConfig,RangeColorLegend,"min"|"max"|undefined>
Constructors
Constructor
new CosmographRangeColorLegend(
cosmograph,targetElement,config):CosmographRangeColorLegend
Constructs a filtering component that connects Cosmograph data to a UI component.
Parameters
| Parameter | Type | Description |
|---|---|---|
cosmograph | Cosmograph | The Cosmograph instance to connect to |
targetElement | HTMLElement | HTML element for rendering the UI component |
config | CosmographRangeColorLegendConfig | Configuration for the filtering component |
Returns
CosmographRangeColorLegend
Inherited from
CosmographExclusiveSelectionComponent.constructor
Accessors
domain
Get Signature
get domain():
undefined| [number,number]
Returns
undefined | [number, number]
defaultConfig
Get Signature
get defaultConfig():
CosmographRangeColorLegendConfig
Returns
CosmographRangeColorLegendConfig
Overrides
CosmographExclusiveSelectionComponent.defaultConfig
accessor
Get Signature
get accessor():
undefined|string
Returns
undefined | string
Overrides
CosmographExclusiveSelectionComponent.accessor
hasClickableEvents
Get Signature
get hasClickableEvents():
boolean
Returns
boolean
Methods
setConfig()
setConfig(
config):Promise<void>
Parameters
| Parameter | Type |
|---|---|
config | Partial<TConfig> |
Returns
Promise<void>
Inherited from
CosmographExclusiveSelectionComponent.setConfig
shouldUpdateComponentData()
shouldUpdateComponentData():
Promise<boolean>
Returns
Promise<boolean>
Overrides
CosmographExclusiveSelectionComponent.shouldUpdateComponentData
hide()
hide():
void
Hides the CosmographRangeColorLegend instance.
Returns
void
show()
show():
void
Shows the CosmographRangeColorLegend instance.
Returns
void
remove()
remove():
void
Removes the CosmographRangeColorLegend instance by destroying it.
Returns
void