Skip to main content

Class: ScrollableCameraViewPlugin

Plugins.ScrollableCameraViewPlugin

Hierarchy​

Properties​

PluginType​

▪ Static Readonly PluginType: "ScrollableCameraViewPlugin"

Overrides​

CameraViewControlPlugin.PluginType


enabled​

• enabled: boolean = true

Inherited from​

CameraViewControlPlugin.enabled


animEase​

• animEase: "linear" | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine" = 'easeInOutSine'

EasingFunctions

Inherited from​

CameraViewControlPlugin.animEase


interpolateMode​

• interpolateMode: "linear" | "spherical" = 'spherical'

Inherited from​

CameraViewControlPlugin.interpolateMode


enableDamping​

• enableDamping: boolean = true

Inherited from​

CameraViewControlPlugin.enableDamping


damping​

• damping: number = 0.04

Inherited from​

CameraViewControlPlugin.damping


initAnimationTime​

• initAnimationTime: number = 1

Inherited from​

CameraViewControlPlugin.initAnimationTime


dependencies​

• dependencies: typeof CameraViewPlugin[]

Inherited from​

CameraViewControlPlugin.dependencies


wrapper​

• wrapper: HTMLDivElement


parent​

• parent: HTMLElement


toJSON​

• toJSON: any = undefined

Overrides​

CameraViewControlPlugin.toJSON


uiConfig​

• uiConfig: UiObjectConfig<any, string>


_dirty​

• Protected _dirty: boolean = false

Inherited from​

CameraViewControlPlugin._dirty


_viewer​

• Protected Optional _viewer: ViewerApp

Inherited from​

CameraViewControlPlugin._viewer

Accessors​

dirty​

• get dirty(): boolean

Returns​

boolean

Inherited from​

CameraViewControlPlugin.dirty

• set dirty(value): void

Parameters​

NameType
valueboolean

Returns​

void

Inherited from​

CameraViewControlPlugin.dirty


viewer​

• get viewer(): undefined | ViewerApp

Returns​

undefined | ViewerApp

Inherited from​

CameraViewControlPlugin.viewer


_cameraViews​

• Protected get _cameraViews(): CameraView[]

Returns​

CameraView[]

Inherited from​

CameraViewControlPlugin._cameraViews

Methods​

onDispose​

▸ onDispose(viewer): Promise<void>

Parameters​

NameType
viewerViewerApp

Returns​

Promise<void>

Inherited from​

CameraViewControlPlugin.onDispose


fromJSON​

▸ fromJSON(data, meta?): null | ScrollableCameraViewPlugin | Promise<null | ScrollableCameraViewPlugin>

Parameters​

NameType
dataany
meta?any

Returns​

null | ScrollableCameraViewPlugin | Promise<null | ScrollableCameraViewPlugin>

Inherited from​

CameraViewControlPlugin.fromJSON


exportState​

▸ exportState(): any

Returns​

any

Inherited from​

CameraViewControlPlugin.exportState


importState​

▸ importState(state): Promise<void>

Parameters​

NameType
stateany

Returns​

Promise<void>

Inherited from​

CameraViewControlPlugin.importState


storeState​

▸ storeState(prefix?, storage?, data?): void

Parameters​

NameType
prefix?string
storage?Storage
data?any

Returns​

void

Inherited from​

CameraViewControlPlugin.storeState


loadState​

▸ loadState(prefix?, storage?): Promise<void>

Parameters​

NameType
prefix?string
storage?Storage

Returns​

Promise<void>

Inherited from​

CameraViewControlPlugin.loadState


setState​

▸ setState(state): void

Parameters​

NameType
statenumber

Returns​

void

Inherited from​

CameraViewControlPlugin.setState


onAdded​

▸ onAdded(viewer): Promise<void>

Parameters​

NameType
viewerViewerApp

Returns​

Promise<void>

Inherited from​

CameraViewControlPlugin.onAdded


onRemove​

▸ onRemove(viewer): Promise<void>

Parameters​

NameType
viewerViewerApp

Returns​

Promise<void>

Inherited from​

CameraViewControlPlugin.onRemove


_storeKey​

▸ Protected _storeKey(prefix?): string

Parameters​

NameType
prefix?string

Returns​

string

Inherited from​

CameraViewControlPlugin._storeKey


_onEnabledChanged​

▸ Protected _onEnabledChanged(): void

Returns​

void

Inherited from​

CameraViewControlPlugin._onEnabledChanged


_preFrame​

▸ Protected _preFrame(ev): void

Parameters​

NameType
evany

Returns​

void

Overrides​

CameraViewControlPlugin._preFrame

Constructors​

constructor​

• new ScrollableCameraViewPlugin(parent?, enabled?)

Parameters​

NameTypeDefault value
parentstring | HTMLElementdocument.body
enabledbooleantrue

Overrides​

CameraViewControlPlugin.constructor