Class: CosmographBars
Internal
Abstract component with methods for highlighting crossfiltered data by current links and points selection. Unlike exclusive components (which only allow one active selection), inclusive components can coexist with other selections.
Extends
Constructors
Constructor
new CosmographBars(
cosmograph,targetElement,config):CosmographBars
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 | CosmographBarsConfig | Configuration for the filtering component |
Returns
CosmographBars
Inherited from
CosmographInclusiveSelectionComponent.constructor
Accessors
defaultConfig
Get Signature
get defaultConfig():
CosmographBarsConfig
Returns
Overrides
CosmographInclusiveSelectionComponent.defaultConfig
accessor
Get Signature
get accessor():
string|undefined
Returns
string | undefined
Overrides
CosmographInclusiveSelectionComponent.accessor
Methods
remove()
remove():
void
Removes the component and cleans up event listeners
Returns
void
Inherited from
CosmographInclusiveSelectionComponent.remove
setConfig()
setConfig(
config):Promise<void>
Parameters
| Parameter | Type |
|---|---|
config | Partial<TConfig> |
Returns
Promise<void>
Inherited from
CosmographInclusiveSelectionComponent.setConfig
setSelectedItem()
setSelectedItem(
item?):void
Sets the selected bar item.
Parameters
| Parameter | Type | Description |
|---|---|---|
item? | BarData | The bar data item to select, or undefined to clear selection. |
Returns
void