ViewerSettingChangedEvent

• webVis API Reference
• ViewerSettingChangedEvent

Class ViewerSettingChangedEvent

VIEWER_SETTING_CHANGED VIEWER_SETTING_CHANGED

Hierarchy

• WebVisEvent
  • ViewerSettingChangedEvent

Index

Constructors

constructor

Properties

id transactionCode? transactionID? type? value viewer viewerSetting

Constructors

constructor

• new ViewerSettingChangedEvent(viewerSetting, value, viewer): ViewerSettingChangedEvent

• The VIEWER_SETTING_CHANGED event occurs if one of the settings is changed.

  Parameters

  • viewerSetting: string

    The name of the setting that has changed.

  • value: any

    The new value of the setting.

  • viewer: ViewerAPI

    The viewer on which the setting was changed.

  Returns ViewerSettingChangedEvent

  Overrides WebVisEvent.constructor

Properties

id

id: number

Inherited from WebVisEvent.id

Optional transactionCode

transactionCode?: string

Inherited from WebVisEvent.transactionCode

Optional transactionID

transactionID?: number

Inherited from WebVisEvent.transactionID

Optional type

type?: EventType

Inherited from WebVisEvent.type

value

value: any

The new value of the setting.

viewer

viewer: ViewerAPI

The viewer on which the setting was changed.

viewerSetting

viewerSetting: string

The name of the setting that has changed.