Subsections of View
AspectSelector
Type: AspectSelector
Extends View
Script class of the AspectSelector view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
index
| Change the current selection of the AspectSelector view. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
afterApply()
| Event raised after the AspectSelector value is applied on selection change. Note that the callback is called within an active undo-scope + calibration update scope. External scripts can bind to the 'afterApply' event to be notified. view.on("afterApply", function() { ... }); |
beforeApply()
| Event raised before the AspectSelector value is applied on selection change. Note that the callback is called within an active undo-scope + calibration update scope. External scripts can bind to the 'beforeApply' event to be notified. view.on("beforeApply", function() { ... }); |
change(index)
| Event raised after the AspectSelector selection changed / was applied. External scripts can bind to the 'change' event to be notified. view.on("change", function(index, value) { ... }); |
Type: Button
Extends View
Script class of the Button view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
text
| Get/Set the text of the Button view. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
onClick()
| Called in Button scripts when the user clicked the Button. External scripts can bind to the 'click' event to be notified when the user clicks the Button. button.on("click", function() { ... }); |
CheckableView
Type: CheckableView
Extends View
Script class of the CheckableView.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
checked
| Get/Set the check state of the CheckableView view. |
text
| Get/Set the text of the CheckableView view. |
value
| Get/Set the check state of the CheckableView view. Synonymous with 'checked' |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
checked()
| Called when the view changed to the checked state. External scripts can bind to the 'checked' event to be notified. view.on("checked", function() { ... }); |
onClick(checked)
| Called in CheckableView scripts when the user clicked the CheckableView. External scripts can bind to the 'click' event to be notified when the user clicks the Button. view.on("click", function(checked) { ... }); The checked parameter is the new state of the CheckableView. The 'click' event is emitted when the user clicked the control. |
onGetValue()
| Gets the value that should be displayed by the CheckableView. Accesses to channels and options are tracked automatically, so changes to those values will cause onGetValue to be called again. |
onSetValue(checked)
| Called whenever the CheckableView state changes either through clicking or by another script setting the checked property. External scripts can bind to the 'change' event to be notified when the user clicks the Button. view.on("change", function(checked) { ... }); The checked parameter is the new state of the CheckableView. The 'change' event is emitted when the checked state changes either through clicking or by another script setting the checked property. |
unchecked()
| Called when the view changed to the unchecked state. External scripts can bind to the 'unchecked' event to be notified. view.on("unchecked", function() { ... }); |
CheckBox
Type: CheckBox
Extends CheckableView
Script class of the Check Box view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
checked
| Get/Set the check state of the CheckableView view. |
text
| Get/Set the text of the CheckableView view. |
value
| Get/Set the check state of the CheckableView view. Synonymous with 'checked' |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
checked()
| Called when the view changed to the checked state. External scripts can bind to the 'checked' event to be notified. view.on("checked", function() { ... }); |
onClick(checked)
| Called in CheckableView scripts when the user clicked the CheckableView. External scripts can bind to the 'click' event to be notified when the user clicks the Button. view.on("click", function(checked) { ... }); The checked parameter is the new state of the CheckableView. The 'click' event is emitted when the user clicked the control. |
onGetValue()
| Gets the value that should be displayed by the CheckableView. Accesses to channels and options are tracked automatically, so changes to those values will cause onGetValue to be called again. |
onSetValue(checked)
| Called whenever the CheckableView state changes either through clicking or by another script setting the checked property. External scripts can bind to the 'change' event to be notified when the user clicks the Button. view.on("change", function(checked) { ... }); The checked parameter is the new state of the CheckableView. The 'change' event is emitted when the checked state changes either through clicking or by another script setting the checked property. |
unchecked()
| Called when the view changed to the unchecked state. External scripts can bind to the 'unchecked' event to be notified. view.on("unchecked", function() { ... }); |
ComboBox
Type: ComboBox
Extends View
Script class of the ComboBox view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
index
| Change the current selection of the ComboBox view. |
items
| Set the list of items in the ComboBox. Expects an array of objects. Objects must have the property 'text'. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
getItem(index)
| Get item at the given index |
Events
Event | Description |
change(index, value)
| Event raised when the combobox selection changed. External scripts can bind to the 'change' event to be notified. view.on("change", function(index, value) { ... }); |
Dial
Type: Dial
Extends View
Script class of the Dial view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
value
| Get/Set the value of the dial. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
program()
| For Modifier Channels, the program button will apply the modification to the related Map / Table. |
Events
Event | Description |
onProgramButton()
| Called in when the Dial 'program' button (of available) is clicked. External scripts can bind to the 'program' event to be notified when this event occurs. view.on("program", function(value) { ... }); |
onSetValue(value)
| Called in when the Dial value has changed. External scripts can bind to the 'change' event to be notified when the value changes. view.on("change", function(value) { ... }); |
GridView
Type: GridView
Extends View
Script class of the GridView view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
columns
| Get/Set the columns for the view. Note that the columns may also be set via the 'data' property. |
data
| Get/Set the data for the view. This may be specified as an array of rows or an object, with a 'data' property for the rows (an array). Each row is an array of objects for each cell in the row. The columns may be specified via the 'columns' property, if using an object, specified like a row. Cell objects may have any of the following properties, which may be specified as functions or values. checked - For cells with checkboxes, indicates if cell should be checked. Else uses 'value'. value - the value of the cell. setter - function to accept value from cell editor. editorOptions - If specified, the cell editor will be a drop-down with the specified values. This may be an array of values or an array of objects of the form { text: "text", value: "value" }. A function may also be specified that returns such a structure. text - the text to display in the cell. value will be used if text not provided. option - name or instance of an ecu.option. Many fields are populated from the object, unless overidden. channel - name or instance of an ecu.channel. Many fields are populated from the object, unless overidden. object - instance of an ecu object (e.g. ecu.option). Many fields are populated from the object, unless overidden. description - Description text. toolTip - Tool tip to show when cell is hovered. statusTip - Tip to show in status bar when cell is hovered. userText - User text value. tag - Column tag, used for persistence of column widths. icon - the icon to display in the cell. iconExpanded - the icon to display in the cell if it is expanded (tree views). colSpan - number of columns spanned by the cell. rowSpan - number of rows spanned by the cell. color - the color to display in the cell. backgroundColor - the background color to display in the cell. userValue - User value. sortKey - If sorting the column, this value is used in preference to 'text' or 'value' isSelectable - Indicates if the cell may be selected isEditable - Indicates if the cell may be edited isEnabled - Indicates if the cell is enabled isDisabled - Indicates if the cell is disabled isDefault - Indicates if the cell is a default value isCheckable - Indicates if the cell is checkable (should display a checkbox) isUserCheckDisabled - Indicates if the isCheckable cells checkbox may be checked/unchecked by the user |
selected
| Get/Set the selected sites, as a JSON string, scripts can use JSON.parse. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
refresh()
| Refresh the view, invalidating any cached values. |
Label
Type: Label
Extends View
Script class of the Sequencer view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
text
| Get/Set the text displayed by the label. Label text can include macro expansion in the form $[User Scalar Name] to display units. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
MultiSiteView
Type: MultiSiteView
Extends View
Script class of the Multi-Site views (map/table grid/graph).
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
canShowCorrectionsDialog
| Determines if the view supports corrections dialog (e.g. Log Maps). |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
resetLogMapCapture()
| Resets Log Map capturing (if supported). This sets all the site weights in the log map to zero. |
showCorrectionsDialog()
| Shows the corrections dialog (if supported) |
Notes
Type: Notes
Extends View
Script class of the Notes view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
text
| Get/Set the text of the Notes view. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
NumberEdit
Type: NumberEdit
Extends View
Script class of the Number Edit view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
value
| Get/Set the value of the NumberEdit. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
onSetValue(value)
| Called in when the NumberEdit value has changed. External scripts can bind to the 'change' event to be notified when the value changes. view.on("change", function(value) { ... }); |
OptionEditor
Type: OptionEditor
Extends View
Script class of the Number Edit view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
value
| Get/Set the (real) value of the OptionEditor. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
change(value)
| Called in when the OptionEditor value has changed. External scripts can bind to the 'change' event to be notified when the value changes. view.on("change", function(value) { ... }); |
Type: RadioButton
Extends CheckableView
Script class of the RadioButton view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
checked
| Get/Set the check state of the CheckableView view. |
text
| Get/Set the text of the CheckableView view. |
value
| Get/Set the check state of the CheckableView view. Synonymous with 'checked' |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
checked()
| Called when the view changed to the checked state. External scripts can bind to the 'checked' event to be notified. view.on("checked", function() { ... }); |
onClick(checked)
| Called in CheckableView scripts when the user clicked the CheckableView. External scripts can bind to the 'click' event to be notified when the user clicks the Button. view.on("click", function(checked) { ... }); The checked parameter is the new state of the CheckableView. The 'click' event is emitted when the user clicked the control. |
onGetValue()
| Gets the value that should be displayed by the CheckableView. Accesses to channels and options are tracked automatically, so changes to those values will cause onGetValue to be called again. |
onSetValue(checked)
| Called whenever the CheckableView state changes either through clicking or by another script setting the checked property. External scripts can bind to the 'change' event to be notified when the user clicks the Button. view.on("change", function(checked) { ... }); The checked parameter is the new state of the CheckableView. The 'change' event is emitted when the checked state changes either through clicking or by another script setting the checked property. |
unchecked()
| Called when the view changed to the unchecked state. External scripts can bind to the 'unchecked' event to be notified. view.on("unchecked", function() { ... }); |
Scope
Type: Scope
Extends View
Script class of the Scope view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
clear()
| Clear the scope data |
putData(channel, timestamp, value)
| Add data to the scope |
SensorCalibrationView
Type: SensorCalibrationView
Extends View
Script class of the Sensor Calibration view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Sequencer
Type: Sequencer
Extends View
Script class of the Sequencer view.
Related Types
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
clearTrace()
| Clears the trace view. For long running sequences the trace window can become a performance issue. |
get(name)
| Get the value of a sequencer variable. |
gotoItem(name)
| Direct the sequencer to jump to the sequence item called 'name' once the current item completes. |
has(name)
| Returns 'true' if the sequencer variable has been previously defined. |
set(name, value)
| Set the value of a sequencer variable. The variable will be created if it does not exist. |
trace(msg)
| Trace a message in the info area of the sequencer window. |
unset(name)
| Deletes the sequencer variable. Following this, has(name) will return false. |
Subsections of Sequencer
SequencerItem
Type: SequencerItem
An individual Sequencer item - represents a single step in the defined sequence.
Methods
Method | Description |
getProperty(name)
| Get the value of a property of the sequence item (normally editable via the properties pane of the sequencer view). |
setProperty(name, value)
| Set the value of a property of the sequence item (normally editable via the properties pane of the sequencer view). |
trace
| Trace a message in the info area of the sequencer window. |
SignalGenerator
Type: SignalGenerator
Extends View
Script class of the Signal Generator view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
frequency
| Get/Set the signal generator frequency, in Hz. |
isOutputEnabled
| Enables/disables the output of the generator. |
numCells
| Get/Set the number of cells in the waveform. |
pullupResistance
| Get/Set the pullup resistance value, in ohms. |
waveform
| Get the waveform object, a table of type EcuObjectScaled. This enables editing of waveform values. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
onFrequencyChanged()
| Called when the frequency of the generator has been changed. External scripts can bind to the 'frequency_changed' event to be notified when the user clicks the Button. view.on("frequency_changed", function(frequency) { ... }); The frequency parameter is the new frequency of the generator, in Hz. |
Type: ToggleButton
Extends CheckableView
Script class of the ToggleButton view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
checked
| Get/Set the check state of the CheckableView view. |
text
| Get/Set the text of the CheckableView view. |
value
| Get/Set the check state of the CheckableView view. Synonymous with 'checked' |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
checked()
| Called when the view changed to the checked state. External scripts can bind to the 'checked' event to be notified. view.on("checked", function() { ... }); |
onClick(checked)
| Called in CheckableView scripts when the user clicked the CheckableView. External scripts can bind to the 'click' event to be notified when the user clicks the Button. view.on("click", function(checked) { ... }); The checked parameter is the new state of the CheckableView. The 'click' event is emitted when the user clicked the control. |
onGetValue()
| Gets the value that should be displayed by the CheckableView. Accesses to channels and options are tracked automatically, so changes to those values will cause onGetValue to be called again. |
onSetValue(checked)
| Called whenever the CheckableView state changes either through clicking or by another script setting the checked property. External scripts can bind to the 'change' event to be notified when the user clicks the Button. view.on("change", function(checked) { ... }); The checked parameter is the new state of the CheckableView. The 'change' event is emitted when the checked state changes either through clicking or by another script setting the checked property. |
unchecked()
| Called when the view changed to the unchecked state. External scripts can bind to the 'unchecked' event to be notified. view.on("unchecked", function() { ... }); |
UnitPreferenceView
Type: UnitPreferenceView
Extends View
Script class of the UnitPreferenceView.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
unit
| Get/Set the selected unit script ID. |
unitPreference
| Get/Set the selected unit preference name (User Scalar) |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
change(unit)
| Called whenever the selected unit changes either through clicking or by a script setting it. Scripts can bind to the 'change' event to be notified when the selection changes. view.on("change", function(unit) { ... }); The unit parameter is the script ID of the selected units (e.g. voltage:V) |
UnitSelector
Type: UnitSelector
Extends View
Script class of the UnitSelector view.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
unit
| Get/Set the selected unit script ID. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
Event | Description |
change(unit)
| Called whenever the selected unit changes either through clicking or by a script setting it. Scripts can bind to the 'change' event to be notified when the selection changes. view.on("change", function(unit) { ... }); The unit parameter is the script ID of the selected units (e.g. voltage:V) |
selection(selected)
| Called whenever the 'base' (unsorted) selection changes. |
WizardListView
Type: WizardListView
Extends View
Script class of the WizardListView.
Properties
Property | Description |
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
index
| Change the current selection of the WizardListView view. |
items
| Change the current selection of the WizardListView view. |
View Properties
Properties defined by the view that are normally editable via properties editor.
Property | Name | Description |
title |
Title |
The title of the window. |
id |
Script ID |
The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip |
Window tool tip. |
display_units_text |
Display Units |
Show units after the number on the view. |
display_units_label |
Display Units (Label) |
Show units after the label on the view. |
prefix_text |
Prefix Text |
Text to display before the value. |
postfix_text |
Postfix Text |
Text to display after the value. |
limits |
Limits |
Set up alarm limits for this gauge. |
show_value |
Show Value |
|
show_label |
Show Label |
|
label_font |
Label Font |
|
value_font |
Value Font |
|
value_height_percent |
Value Height % |
A value of zero disables auto font size fitting if Value Height Max is set |
value_height_max_dp |
Value Height Max [dp] |
Maximum font height of the value text, in device pixels |
label_height_percent |
Label Height % |
|
label_height_max_dp |
Label Height Max [dp] |
Maximum font height of the label, in device pixels |
label_text |
Label Text |
|
label_align |
Label Align |
|
label_valign |
Label Vertical Align |
|
value_align |
Value Align |
|
value_valign |
Value Vertical Align |
|
low_limit_text |
Low Limit Text |
|
high_limit_text |
High Limit Text |
|
value_text |
Value Override Text |
|
max_length_text |
Max length Text |
Leave blank for auto |
bg_colour |
Background |
Background colour |
text_colour |
Text |
Text colour |
alarm_low_bg_colour |
Alarm Low Background |
Alarm Lower Limit Background colour |
alarm_low_text_colour |
Alarm Low Text |
Alarm Lower Limit Text colour |
alarm_high_bg_colour |
Alarm High Background |
Alarm Upper Limit Background colour |
alarm_high_text_colour |
Alarm High Text |
Alarm Upper Limit Text colour |
parameter |
Input Value |
The source of the value that will be displayed by the gauge. |
update_rate |
Update Rate |
Rate at which the input value is requested from the ECU. |
decimal_places |
Decimal Places |
Set to -1 for auto |
Methods
Method | Description |
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |