Class: SequenceComponent

component.SequenceComponent

classdesc Component showing navigation arrows for sequence directions as well as playing button. Exposes an API to start and stop play.

Hierarchy

• Component<SequenceConfiguration>

  ↳ SequenceComponent

Constructors

constructor

• new SequenceComponent(name, container, navigator, renderer?, scheduler?)

Parameters

Name	Type
name	string
container	Container
navigator	Navigator
renderer?	SequenceDOMRenderer
scheduler?	Scheduler

Overrides

Component.constructor

Defined in

component/sequence/SequenceComponent.ts:68

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

Component.on

Defined in

component/sequence/SequenceComponent.ts:165

• on(type, handler): void

Event fired when playing starts or stops.

example

// Initialize the viewervar viewer = new Viewer({ // viewer options });var component = viewer.getComponent('<component-name>');// Set an event listenercomponent.on('playing', function() {  console.log("A playing event has occurred.");});

Parameters

Name	Type
type	"playing"
handler	(event: ComponentPlayEvent) => void

Returns

void

Defined in

component/sequence/SequenceComponent.ts:184

Properties

componentName

▪ Static componentName: ComponentName = "sequence"

inheritdoc

Overrides

Component.componentName

Defined in

component/sequence/SequenceComponent.ts:59

Accessors

activated

• get activated(): boolean

Get activated.

Returns

boolean

Value indicating if the component is currently active.

Defined in

component/Component.ts:78

---

defaultConfiguration

• get defaultConfiguration(): TConfiguration

Get default configuration.

Returns

TConfiguration

Default configuration for component.

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

Defined in

component/Component.ts:107

Methods

configure

▸ configure(configuration): void

Configure the component.

Parameters

Name	Type	Description
configuration	SequenceConfiguration	Component configuration.

Returns

void

Inherited from

Component.configure

Defined in

component/Component.ts:131

---

fire

▸ fire(type, event): void

Parameters

Name	Type
type	"hover"
event	ComponentHoverEvent

Returns

void

Overrides

Component.fire

Defined in

component/sequence/SequenceComponent.ts:120

▸ fire(type, event): void

Parameters

Name	Type
type	"playing"
event	ComponentPlayEvent

Returns

void

Overrides

Component.fire

Defined in

component/sequence/SequenceComponent.ts:124

---

off

▸ off(type, handler): void

Unsubscribe from an event by its name.

Parameters

Name	Type
type	"hover"
handler	(event: ComponentHoverEvent) => void

Returns

void

Overrides

Component.off

Defined in

component/sequence/SequenceComponent.ts:135

▸ off(type, handler): void

Parameters

Name	Type
type	"playing"
handler	(event: ComponentPlayEvent) => void

Returns

void

Overrides

Component.off

Defined in

component/sequence/SequenceComponent.ts:139

---

play

▸ play(): void

Start playing.

fires playing

Returns

void

Defined in

component/sequence/SequenceComponent.ts:200

---

stop

▸ stop(): void

Stop playing.

fires playing

Returns

void

Defined in

component/sequence/SequenceComponent.ts:207