Skip to main content

Interface: SliderConfiguration

component.SliderConfiguration

Interface for configuration of slider component.

interface

var viewer = new Viewer({    ...    component: {        slider: {            initialPosition: 0.5,            ids: {                background: '<background-id>',                foreground: '<foreground-id>',            },            sliderVisible: true,        },    },    ...});

Hierarchy#

  • ComponentConfiguration

    ↳ SliderConfiguration

Properties#

ids#

• Optional ids: SliderConfigurationIds

Slider image ids.

description Configures the component to show the image planes for the supplied image ids in the foreground and the background.

Defined in#

component/interfaces/SliderConfiguration.ts:97


initialPosition#

• Optional initialPosition: number

Initial position of the slider on the interval [0, 1].

description Configures the initial position of the slider. The inital position value will be used when the component is activated.

default 1

Defined in#

component/interfaces/SliderConfiguration.ts:88


mode#

• Optional mode: SliderConfigurationMode

Mode used for image pair transitions.

description Configures the mode for transitions between image pairs.

Defined in#

component/interfaces/SliderConfiguration.ts:115


sliderVisible#

• Optional sliderVisible: boolean

Value indicating whether the slider should be visible.

description Set the value controlling if the slider is visible.

default true

Defined in#

component/interfaces/SliderConfiguration.ts:107