JavaScript & React libraryAPI

Class: abstract CosmographExclusiveSelectionComponent<TConfig, TUIComponent, TUIItem>

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

Extended by

Type Parameters

Type Parameter
TConfig extends SelectionComponentConfig
TUIComponent extends SelectionUIComponent<TConfig>
TUIItem

Constructors

Constructor

new CosmographExclusiveSelectionComponent<TConfig, TUIComponent, TUIItem>(cosmograph, targetElement, config): CosmographExclusiveSelectionComponent<TConfig, TUIComponent, TUIItem>

Constructs a filtering component that connects Cosmograph data to a UI component.

Parameters

ParameterTypeDescription
cosmographCosmographThe Cosmograph instance to connect to
targetElementHTMLElementHTML element for rendering the UI component
configTConfigConfiguration for the filtering component

Returns

CosmographExclusiveSelectionComponent<TConfig, TUIComponent, TUIItem>

Inherited from

CosmographSelectionComponent.constructor

Methods

setConfig()

setConfig(config): Promise<void>

Parameters

ParameterType
configPartial<TConfig>

Returns

Promise<void>

Inherited from

CosmographSelectionComponent.setConfig


remove()

remove(): void

Removes the component and cleans up event listeners

Returns

void

Inherited from

CosmographSelectionComponent.remove