JavaScript & React libraryAPI

Abstract Class: CosmographInclusiveSelectionComponent<TConfig, TUIComponent>

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

Extended by

Type Parameters

Type Parameter
TConfig extends SelectionComponentConfig
TUIComponent extends SelectionUIComponent<TConfig>

Constructors

Constructor

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

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

CosmographInclusiveSelectionComponent<TConfig, TUIComponent>

Inherited from

CosmographSelectionComponent.constructor

Methods

isInclusiveComponent()

static isInclusiveComponent(id): boolean

Parameters

ParameterType
idstring

Returns

boolean


register()

static register(id): void

Parameters

ParameterType
idstring

Returns

void


unregister()

static unregister(id): void

Parameters

ParameterType
idstring

Returns

void


remove()

remove(): void

Removes the component and cleans up event listeners

Returns

void

Overrides

CosmographSelectionComponent.remove


setConfig()

setConfig(config): Promise<void>

Parameters

ParameterType
configPartial<TConfig>

Returns

Promise<void>

Inherited from

CosmographSelectionComponent.setConfig