Skip to main content

Class: SliderComponent

component.SliderComponent

classdesc Component for comparing pairs of images. Renders a slider for adjusting the curtain of the first image.

Deactivate the sequence, direction and image plane components when activating the slider component to avoid interfering UI elements.

To retrive and use the slider component

example

var viewer = new Viewer({ ... });
viewer.deactivateComponent("image");viewer.deactivateComponent("direction");viewer.deactivateComponent("sequence");
viewer.activateComponent("slider");
var sliderComponent = viewer.getComponent("slider");

Hierarchy#

Properties#

componentName#

â–ª Static componentName: ComponentName = "slider"

Overrides#

Component.componentName

Defined in#

component/slider/SliderComponent.ts:95

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#

NameTypeDescription
configurationSliderConfigurationComponent configuration.

Returns#

void

Inherited from#

Component.configure

Defined in#

component/Component.ts:131


fire#

â–¸ fire<T>(type, event): void

Type parameters#

Name
T

Parameters#

NameType
typeComponentEventType
eventT

Returns#

void

Inherited from#

Component.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#

NameTypeDescription
typeComponentEventTypeThe name of the event to unsubscribe from.
handler(event: T) => voidThe handler to remove.

Returns#

void

Inherited from#

Component.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#

NameTypeDescription
typeComponentEventTypeThe name of the event to subscribe to.
handler(event: T) => voidThe handler called when the event occurs.

Returns#

void

Inherited from#

Component.on

Defined in#

component/Component.ts:163