ActiveItemEvent

• webVis API Reference
• ActiveItemEvent

Class ActiveItemEvent

ACTIVE_ITEM ACTIVE_ITEM

Hierarchy

• WebVisEvent
  • ActiveItemEvent

Index

Constructors

constructor

Properties

id itemID itemType transactionCode? transactionID? type? viewer

Constructors

constructor

• new ActiveItemEvent(itemID, itemType, viewer): ActiveItemEvent

• The ACTIVE_ITEM event indicates a change to the current active item.

  Parameters

  • itemID: number

    The ID of the item

  • itemType: ActiveItemType

    The type of the active item

  • viewer: ViewerAPI

    The viewer to which the active item relates.

  Returns ActiveItemEvent

  Overrides WebVisEvent.constructor

Properties

id

id: number

Inherited from WebVisEvent.id

itemID

itemID: number

The ID of the item

itemType

itemType: ActiveItemType

The type of the active item

Optional transactionCode

transactionCode?: string

Inherited from WebVisEvent.transactionCode

Optional transactionID

transactionID?: number

Inherited from WebVisEvent.transactionID

Optional type

type?: EventType

Inherited from WebVisEvent.type

viewer

viewer: ViewerAPI

The viewer to which the active item relates.