The Sparkline supports the following scripting events. Click next to any event name in the Events pane to see a short description for the selected event.
See Accessing Screen Objects for more information about how to view control objects in script in the Canvas application.
When an event is enabled, the control will be automatically added to script and the Include in script property will be set to True.
| Event | Description | Example | |
|---|---|---|---|
|
Click |
The Click event is called when the user clicks once on the control with the left mouse button. For the sparkline, the Click event is limited to the chart line itself, and not the surrounding space, allowing you to overlay a sparkline on top of another control. |
|
|
|
Close |
The Close event is called when the screen is closed. |
|
|
|
Data Load Completed |
The Data Load Completed event is called when all series have finished loading historical data. |
|
|
|
Initialize |
The Initialize event is called when the screen is created in preview or run mode to allow further initialization of the control. |
|
|
|
Loaded |
The Loaded event is called when the control is rendered and ready for interaction. |
|
|
|
Mouse Enter |
The Mouse Enter event is called when the mouse pointer enters (moves over) a control. |
|
|
|
Mouse Leave |
The Mouse Leave event is called when the mouse pointer leaves (moves out of) a control. |
|
See Order of Event Execution for information about the order in which events are executed on a screen.