Class: DirectionComponent
component.DirectionComponent
classdesc Component showing navigation arrows for steps and turns.
Hierarchy#
Component<DirectionConfiguration>↳
DirectionComponent
Events#
on#
• on(type, handler): void
Fired when the hovered element of a component changes.
example
// Initialize the viewervar viewer = new Viewer({ // viewer options });var component = viewer.getComponent('<component-name>');// Set an event listenercomponent.on('hover', function() { console.log("A hover event has occurred.");});Parameters#
| Name | Type |
|---|---|
type | "hover" |
handler | (event: ComponentHoverEvent) => void |
Returns#
void
Overrides#
Defined in#
component/direction/DirectionComponent.ts:115
Properties#
componentName#
â–ª Static componentName: ComponentName = "direction"
inheritdoc
Overrides#
Defined in#
component/direction/DirectionComponent.ts:43
Accessors#
activated#
• get activated(): boolean
Get activated.
Returns#
boolean
Value indicating if the component is currently active.
Defined in#
defaultConfiguration#
• get defaultConfiguration(): TConfiguration
Get default configuration.
Returns#
TConfiguration
Default configuration for component.
Defined in#
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
Defined in#
Methods#
configure#
â–¸ configure(configuration): void
Configure the component.
Parameters#
| Name | Type | Description |
|---|---|---|
configuration | DirectionConfiguration | Component configuration. |
Returns#
void
Inherited from#
Defined in#
fire#
â–¸ fire(type, event): void
Parameters#
| Name | Type |
|---|---|
type | "hover" |
event | ComponentHoverEvent |
Returns#
void
Overrides#
Defined in#
../doc/component/direction/DirectionComponent.ts:70
off#
â–¸ off(type, handler): void
Unsubscribe from an event by its name.
Parameters#
| Name | Type |
|---|---|
type | "hover" |
handler | (event: ComponentHoverEvent) => void |
Returns#
void