Class: CosmographSearch<T>

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

Type Parameters

Type ParameterDefault type
T extends SearchItemSearchItem

Constructors

Constructor

new CosmographSearch<T>(cosmograph, targetElement, config): CosmographSearch<T>

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
configCosmographSearchConfigConfiguration for the filtering component

Returns

CosmographSearch<T>

Inherited from

CosmographExclusiveSelectionComponent.constructor

Accessors

defaultConfig

Get Signature

get defaultConfig(): CosmographSearchConfig<T>

Returns

CosmographSearchConfig<T>

Overrides

CosmographExclusiveSelectionComponent.defaultConfig


accessor

Get Signature

get accessor(): string

Returns

string

Overrides

CosmographExclusiveSelectionComponent.accessor

Methods

setConfig()

setConfig(config): Promise<void>

Parameters

ParameterType
configPartial<TConfig>

Returns

Promise<void>

Inherited from

CosmographExclusiveSelectionComponent.setConfig


remove()

remove(): void

Removes the component and cleans up event listeners

Returns

void

Overrides

CosmographExclusiveSelectionComponent.remove


hideSuggestions()

hideSuggestions(): void

Returns

void


clearInput()

clearInput(): void

Returns

void


focus()

focus(): void

Returns

void


blur()

blur(): void

Returns

void