Common Component Events

This section describes events that are supported by most components. The individual description for each component includes a list of supported common events.

Mouse events (Clicked, Double Clicked, Pressed, Released, Entered, Exited) will only be generated if the corresponding events property is selected in the component.

Mouse Clicked

This event is fired when a user clicks on the component with the left mouse button. Will only fire when the Mouse Pressed and Mouse Released event occurs on the same component. Component property Generate Mouse Clicked Events must be set to True for this event to fire.

Event Name

mouseClicked

Records:

1

Record Format:

Field Name

Field Type

Notes

altDown

Boolean

Indicates whether an alt key was pressed during the event.

controlDown

Boolean

Indicates whether a control key was pressed during the event.

shiftDown

Boolean

Indicates whether a shift key was pressed during the event.

metaDown

Boolean

Indicates whether the meta key was pressed during the event. By default the meta key is the “Windows” key in Windows operating system, and the “Command” key in MacOS. Since the operating system usually has a binding to this key, this value can be false even when the user is pressing the key.

x

Integer

Horizontal pixel coordinate of the pointer relative to the component when the event occurred.

y

Integer

Vertical pixel coordinate of the pointer relative to the component when the event occurred.

xOnScreen

Integer

Absolute horizontal pixel coordinate of the pointer within the dashboard’s viewport when the event occurred.

yOnScreen

Integer

Absolute vertical pixel coordinate of the pointer within the dashboard’s viewport when the event occurred.

button

Integer

Integer indicating which mouse button was pressed.

width

Integer

Width of the component in pixels when the event occurred.

height

Integer

Height of the component in pixels when the event occurred.

top

Integer

Vertical coordinate value of the top of the component relative to the dashboard’s viewport.

bottom

Integer

Vertical coordinate value of the bottom of the component relative to the dashboard’s viewport.

right

Integer

Horizontal coordinate value of the right side of the component relative to the dashboard’s viewport.

left

Integer

Horizontal coordinate value of the left side of the component relative to the dashboard’s viewport.

name

String

Name of the DOM model node where cursor was located when event fired.

textContent

String

Text content of the DOM model node where cursor was located when event fired.

attributesList

String

JSON attributes list of the DOM model node where cursor was locatedwhen event fired.

value

String

Value of the DOM model node where cursor was located when event fired.

Mouse Double Clicked

This event is fired when a user double clicks on the component with the left mouse button. Component property Generate Mouse Double Clicked Events must be set to True for this event to fire.

Event Name

mouseDoubleClicked

Records:

1

Record Format:

Same as Mouse Clicked

Mouse Released

This event is fired when a user releases any mouse button over the component. Component property Generate Mouse Released Events must be set to True for this event to fire.

Event Name

mouseReleased

Records:

1

Record Format:

Same as Mouse Clicked

Mouse Pressed

This event is fired when a user presses any mouse button over the component. Component property Generate Mouse Pressed Events must be set to True for this event to fire.

Event Name

mousePressed

Records:

1

Record Format:

Same as Mouse Clicked

Mouse Entered

This event is fired when the pointer enters the component area. Component property Generate Mouse Entered Events must be set to True for this event to fire.

Event Name

mouseEntered

Records:

1

Record Format:

Same as Mouse Clicked

Mouse Exited

This event is fired when the pointer exits the component area. Component property Generate Mouse Exited Events must be set to True for this event to fire.

Event Name

mouseExited

Records:

1

Record Format:

Same as Mouse Clicked

Input Changed

This event is fired when a user edits data in a component's input field.

Event Name

inputChanged

Records:

1

Record Format:

Field Name

Field Type

Notes

value

String

Value. New text of an input field.

Key Pressed

The Generate Key Pressed Events property of the Events property group must be enabled for a component to fire this event.

A dashboard component generates this event when a user presses one or more keys on the keyboard while focused on the component.

Event Name

keyPressed

Records:

1

Record Format:

Field Name

Field Type

Notes

id

Integer

A unique identifier for the key pressed event.

when

Date

Timestamp indicating when the event occurred.

modifiers

Integer

Indicates the number of modifier keys that were pressed during the key pressed event. A modifier key is any of the following:

  • Alt

  • Shift

  • Control

  • Meta key (“Windows” key on Windows, “Command” key on Mac)

altDown

Boolean

Indicates whether the alt key was pressed during the event.

altGraphDown

Boolean

Indicates whether the alt graph key was pressed during the event.

controlDown

Boolean

Indicates whether the control key was pressed during the event.

shiftDown

Boolean

Indicates whether the shift key was pressed during the event.

metaDown

Boolean

Indicates whether the meta key was pressed during the event.

actionKey

Boolean

Indicates whether the action key was pressed during the event. The action key is an alias for the primary action key of the user’s operating system:

  • On Windows/Linux: the action key is equivalent to the control key.

  • On Mac: the action key is equivalent to the meta key, e.g. the command key

keyChar

String

The character associated with the key that was pressed during the key pressed event.

keyCode

Integer

The code associated with the key that was pressed during the key pressed event.

keyLocation

Integer

The location of the key that was pressed during the key pressed event. Typically used to differentiate between keys that appear multiple times on the keyboard, such as left control and right control:

  • 0 indicates the pressed key is in the standard location

  • 1 indicates the left key was pressed, e.g. left control, left shift, left alt.

  • 2 indicates the right key was pressed e.g. right control, right shift, right alt.

  • 3 indicates a key pressed in the numeric keypad, e.g. keypad enter, keypad 0-9, etc.

Key Released

The Generate Key Released Events property of the Events property group must be enabled for a component to fire this event.

A dashboard component generates this event when a user releases one or more depressed keys on the keyboard while focused on the component.

Event Name

keyReleased

Records:

1

Record Format:

Field Name

Field Type

Notes

id

Integer

A unique identifier for the key released event.

when

Date

Timestamp indicating when the event occurred.

modifiers

Integer

Indicates the number of modifier keys that were depressed during the key released event. See description of Key Pressed event for details.

altDown

Boolean

Indicates whether the alt key was depressed during the event.

altGraphDown

Boolean

Indicates whether the alt graph key was depressed during the event.

controlDown

Boolean

Indicates whether the control key was depressed during the event.

shiftDown

Boolean

Indicates whether the shift key was depressed during the event.

metaDown

Boolean

Indicates whether the meta key was depressed during the event.

actionKey

Boolean

Indicates whether the action key was depressed during the event.

keyChar

String

The character associated with the key that was released during the key released event.

keyCode

Integer

The code associated with the key that was released during the key released event.

keyLocation

Integer

The location of the key that was released during the key released event. See description of Key Pressed event for details.

Was this page helpful?