Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

ViewerSettingChangedEvent

• webVis API Reference
• ViewerSettingChangedEvent

Class ViewerSettingChangedEvent

Event that is fired when a viewer setting is changed. The event contains the name of the setting that was changed and the new value of the setting as well as the viewer in which the setting was changed.

See

• EventType.VIEWER_SETTING_CHANGED
• ViewerSettingStrings

Hierarchy (View Summary)

• WebVisEvent
  • ViewerSettingChangedEvent

Index

Properties

id transactionCode? transactionID? type? value viewer viewerSetting

Properties

id

id: number

The unique ID of the event.

Inherited from WebVisEvent.id

OptionaltransactionCode

transactionCode?: string

The transaction code associated with the event.

Inherited from WebVisEvent.transactionCode

OptionaltransactionID

transactionID?: number

The transaction ID associated with the event.

Inherited from WebVisEvent.transactionID

Optionaltype

type?: EventType

The type of the event.

Inherited from WebVisEvent.type

value

value: any

The new value of the setting

viewer

viewer: ViewerAPI

The viewer in which the setting was changed

viewerSetting

viewerSetting: string

The name of the setting that has changed