ViewerStateChangedEvent

• webVis API Reference
• ViewerStateChangedEvent

Class ViewerStateChangedEvent

VIEWER_STATE_CHANGED

Hierarchy (View Summary)

• WebVisEvent
  • ViewerStateChangedEvent

Index

Constructors

constructor

Properties

id state transactionCode? transactionID? type? viewer

Constructors

constructor

• new ViewerStateChangedEvent(
      state: ViewerState,
      viewer: ViewerAPI,
  ): ViewerStateChangedEvent

• This event occurs if the State of a Viewer change.

  Parameters

  • state: ViewerState

    The new state of the Viewer.
  • viewer: ViewerAPI

    The related Viewer.

  Returns ViewerStateChangedEvent

  Overrides WebVisEvent.constructor

Properties

id

id: number

The unique ID of the event.

Inherited from WebVisEvent.id

state

state: ViewerState

The new state of the Viewer.

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

viewer

viewer: ViewerAPI

The related Viewer.

---

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

• This page needs code samples
• Code samples do not work
• Information is missing
  Please tell us more about what's wrong:
• Information is incorrect
  Please tell us more about what's wrong:
• Information is unclear or confusing
  Please tell us more about what's wrong:
• The page is rendered incorrectly (styling/CSS)
• Give Feedback

Please tell us more about what's wrong: Name E-Mail Problem (required)