Class: Component<TConfiguration>

Type parameters#

Name	Type
`TConfiguration`	extends `ComponentConfiguration`

Hierarchy#

EventEmitter
↳ Component
↳↳ BearingComponent
↳↳ CacheComponent
↳↳ DirectionComponent
↳↳ KeyboardComponent
↳↳ MarkerComponent
↳↳ PointerComponent
↳↳ PopupComponent
↳↳ SequenceComponent
↳↳ SliderComponent
↳↳ SpatialComponent
↳↳ TagComponent
↳↳ ZoomComponent

Implements#

IComponent

Constructors#

constructor#

• new Component<TConfiguration>(name, container, navigator)

Type parameters#

Name	Type
`TConfiguration`	extends `ComponentConfiguration`

Parameters#

Name	Type
`name`	`string`
`container`	`Container`
`navigator`	`Navigator`

Overrides#

EventEmitter.constructor

Defined in#

component/Component.ts:44

Properties#

componentName#

▪ Static componentName: ComponentName | FallbackComponentName

Defined in#

component/Component.ts:30

Accessors#

activated#

• get activated(): boolean

Get activated.

Returns#

boolean

Value indicating if the component is currently active.

Implementation of#

IComponent.activated

Defined in#

component/Component.ts:78

defaultConfiguration#

• get defaultConfiguration(): TConfiguration

Get default configuration.

Returns#

TConfiguration

Default configuration for component.

Implementation of#

IComponent.defaultConfiguration

Defined in#

component/Component.ts:92

name#

• get name(): string

Get name.

description The name of the component. Used when interacting with the component through the Viewer's API.

Returns#

string

Implementation of#

IComponent.name

Defined in#

component/Component.ts:107

Methods#

configure#

▸ configure(configuration): void

Configure the component.

Parameters#

Name	Type	Description
`configuration`	`TConfiguration`	Component configuration.

Returns#

void

Implementation of#

IComponent.configure

Defined in#

component/Component.ts:131

fire#

▸ fire<T>(type, event): void

inheritdoc

Type parameters#

Name
`T`

Parameters#

Name	Type
`type`	`ComponentEventType`
`event`	`T`

Returns#

void

Overrides#

EventEmitter.fire

Defined in#

component/Component.ts:149

off#

▸ off<T>(type, handler): void

Unsubscribe from an event by its name.

Type parameters#

Name
`T`

Parameters#

Name	Type	Description
`type`	`ComponentEventType`	The name of the event to unsubscribe from.
`handler`	(`event`: `T`) => `void`	The handler to remove.

Returns#

void

Overrides#

EventEmitter.off

Defined in#

component/Component.ts:156

on#

▸ on<T>(type, handler): void

Subscribe to an event by its name.

Type parameters#

Name
`T`

Parameters#

Name	Type	Description
`type`	`ComponentEventType`	The name of the event to subscribe to.
`handler`	(`event`: `T`) => `void`	The handler called when the event occurs.

Returns#

void

Overrides#

EventEmitter.on

Defined in#

component/Component.ts:163