Class: CosmographTypeColorLegend
Represents a color legend for the Cosmograph visualization, which displays the available types or categories of data points or links.
Extends
CosmographExclusiveSelectionComponent<CosmographTypeColorLegendConfig,TypeColorLegend,TypeColorLegendItem>
Constructors
Constructor
new CosmographTypeColorLegend(
cosmograph,targetElement,config):CosmographTypeColorLegend
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 | CosmographTypeColorLegendConfig | Configuration for the filtering component |
Returns
CosmographTypeColorLegend
Inherited from
CosmographExclusiveSelectionComponent.constructor
Accessors
defaultConfig
Get Signature
get defaultConfig():
CosmographTypeColorLegendConfig
Returns
CosmographTypeColorLegendConfig
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
show()
show():
void
Shows the CosmographTypeColorLegend.
Returns
void
hide()
hide():
void
Hides the CosmographTypeColorLegend.
Returns
void
remove()
remove():
void
Removes the CosmographTypeColorLegend instance by destroying it.
Returns
void