Graphic Item Functions allow Operator Actions, executed in a Graphic Page, to interact with items on the page.
Using Graphic Item Functions you can:
All graphic items have Id and Label properties:
The graphic editor automatically assigns a value to the Id property. You can use any string value for the Label property.
Most Graphic Item Functions use an ItemId parameter to indicate which graphic item to interact with. When a Graphic Item function runs, the function will search for a graphic item in the following order:
We recommended you always use the Label property to select graphic items.
Note: Certain edit operations can change the Id of a shape. For example:
These Graphic Item Functions read and write graphic item properties:
These Graphic Item Functions execute commands on graphic items:
Function | Summary |
---|---|
GraphicItemPlotAddPen | Adds a pen to an Embedded Plot. |
GraphicItemPlotHasPen | Tests whether an Embedded Plot has a pen. |
GraphicItemPlotRemovePen | Removes a pen from an Embedded Plot. |
GraphicItemSqlListRefresh | Asks an SQL List to execute the SQL Command and display the results. |
GraphicItemTrendNextInterval | Moves the X axis of an Embedded Plot to the next interval. |
GraphicItemTrendPreviousInterval | Moves the X axis of an Embedded Plot to the previous interval. |
GraphicItemTrendReset | Resets the X Axis of an Embedded Plot back to default values. |
HideSelf | Hides a pop-up panel. |
Gets the value of the DataBindBlink data binding.
Informal syntax:
GraphicItemGetBlink( ItemId )
Formal syntax:
GraphicItemGetBlink( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
The GraphicItemGetBlink function finds the graphic item using the ItemId parameter. If found, the function returns the value of the DataBindBlink data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a BOOL value indicating whether the graphic item is blinking (true) or not blinking (false).
Returns data from a graphic item.
Informal syntax:
GraphicItemGetData( ItemId, Format, SelectedData )
Formal syntax:
GraphicItemGetData( ItemId:=Expression, Format:=Expression, SelectedData:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
Format | ANY_STRING |
The format of the data to return. These values are supported:
|
SelectedData | BOOL |
Whether to return all the data, or selected data:
|
The GraphicItemGetData function finds the graphic item using the ItemId parameter. If found, the function queries the item for data in the requested format.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a STRING value containing the data from the item.
Gets the value of the DataBindDisableActions data binding.
Informal syntax:
GraphicItemGetDisableActions( ItemId )
Formal syntax:
GraphicItemGetDisableActions( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
The GraphicItemGetDisableActions function finds the graphic item using the ItemId parameter. If found, the function returns the value of the DataBindDisableActions data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a BOOL value indicating whether the actions on the item are disable (true) or enabled (false).
Reads the value of a Global Variable in the Global Bindings of a Graphic Page.
Informal syntax:
GraphicItemGetGlobalVariable( ItemId, GlobalValue )
Formal syntax:
GraphicItemGetGlobalVariable( ItemId:=Expression, GlobalValue:=Expression)
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
GlobalValue | ANY_STRING | A global variable expression to evaluate. |
The GraphicItemGetGlobalVariable function finds the graphic item using the ItemId parameter. If found, the function will evaluate the GlobalValue parameter. If the ItemId parameter is an empty string, the function will use the top level graphic page.
A runtime error will be reported if:
You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
The return value does not have a type. Use a Type Cast to convert the return value. For example:
TO_STRING( GraphicItemGetGlobalVariable( ItemID, "SelectedTurbine" ) )
Returns the ItemId of the parent graphic item.
Informal and formal syntax:
GraphicItemGetParentId()
None
The GraphicItemGetParentId function returns the ItemId of the parent graphic page.
This function does not report any errors.
Returns the ItemId of the parent as STRING value.
Gets the value of the AutoUpdate property of an SQL List.
Informal syntax:
GraphicItemGetSqlListAutoUpdate( ItemId )
Formal syntax:
GraphicItemGetSqlListAutoUpdate( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
The GraphicItemGetSqlListAutoUpdate function finds the graphic item using the ItemId parameter. If found, the function returns the value of the AutoUpdate property.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a BOOL value indicating whether the SQL List automatically updates.
Gets the value of the SqlCommand property of an SQL List.
Informal syntax:
GraphicItemGetSqlListSqlCommand( ItemId )
Formal syntax:
GraphicItemGetSqlListSqlCommand( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
The GraphicItemGetSqlListSqlCommand function finds the graphic item using the ItemId parameter. If found, the function returns the value of the SqlCommand property.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns the SQL command as a STRING value.
Gets the value of the DataBindText data binding.
Informal syntax:
GraphicItemGetText( ItemId )
Formal syntax:
GraphicItemGetText( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
The GraphicItemGetText function finds the graphic item using the ItemId parameter. If found, the function returns the value of the DataBindText data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a STRING value representing the current text value.
Gets the value of the DataBindTextStrikeout data binding.
Informal syntax:
GraphicItemGetTextStrikeout( ItemId )
Formal syntax:
GraphicItemGetTextStrikeout( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
The GraphicItemGetTextStrikeout function finds the graphic item using the ItemId parameter. If found, the function returns the value of the DataBindTextStrikeout data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a BOOL value indicating whether the text is drawn with a strikeout effect.
Gets the value of the DataBindTextUnderline data binding.
Informal syntax:
GraphicItemGetTextUnderline( ItemId )
Formal syntax:
GraphicItemGetTextUnderline( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
The GraphicItemGetTextUnderline function finds the graphic item using the ItemId parameter. If found, the function returns the value of the DataBindTextUnderline data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a BOOL value indicating whether the text is drawn with an underline.
Gets the value of the DataBindTooltip data binding.
Informal syntax:
GraphicItemGetTooltip( ItemId )
Formal syntax:
GraphicItemGetTooltip( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
The GraphicItemGetTooltip function finds the graphic item using the ItemId parameter. If found, the function returns the value of the DataBindTooltip data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a STRING value representing the current tooltip value.
Gets whether the tracking mode of an Embedded Plot is enabled.
Informal syntax:
GraphicItemGetTrendTrackingMode( ItemId )
Formal syntax:
GraphicItemGetTrendTrackingMode( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the trend item. |
The GraphicItemGetTrendTrackingMode function finds the graphic trend item using the ItemId parameter. If found, the function returns TRUE if tracking mode is enabled, and FALSE if not enabled.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a BOOL value indicating whether tracking mode is enabled.
Gets the X Axis interval of an Embedded Plot.
Informal syntax:
GraphicItemGetTrendXInterval( ItemId )
Formal syntax:
GraphicItemGetTrendXInterval( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the trend item. |
The GraphicItemGetTrendXInterval function finds the graphic trend item using the ItemId parameter. If found, the function returns the current X Axis interval.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a TIME value representing the current X Axis interval.
Gets the offset (relative to the current time) of the right edge of the X Axis of a trend.
Informal syntax:
GraphicItemGetTrendXOffset( ItemId )
Formal syntax:
GraphicItemGetTrendXOffset( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the trend item. |
The GraphicItemGetTrendXOffset function finds the graphic trend item using the ItemId parameter. If found, the function returns the offset (relative to the current time) of the right edge of the X Axis.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a TIME value representing the current offset (relative to the current time) of the right edge of the X Axis.
Gets the value of the DataBindVisible data binding.
Informal syntax:
GraphicItemGetVisible( ItemId )
Formal syntax:
GraphicItemGetVisible( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
The GraphicItemGetVisible function finds the graphic item using the ItemId parameter. If found, the function returns the value of the DataBindVisible data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Returns a BOOL value indicating whether the graphic item is visible (true) or hidden (false).
Adds a pen to an Embedded Plot.
Informal syntax:
GraphicItemPlotAddPen( ItemId, Source, Label )
Formal syntax:
GraphicItemPlotAddPen( ItemId:=Expression, Source:=Expression, Label:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the embedded plot item. |
Source | ANY_STRING | The name of the data source to add to the plot. |
Label | ANY_STRING | The label to display in the key area of the plot. |
The GraphicItemPlotAddPen function finds the embedded plot item using the ItemId parameter. If found, the function adds a pen to the embedded plot.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Tests whether an Embedded Plot has a pen connected to a data source.
Informal syntax:
GraphicItemPlotHasPen( ItemId, Source )
Formal syntax:
GraphicItemPlotHasPen( ItemId:=Expression, Source:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the embedded plot item. |
Source | ANY_STRING | The name of the data source to test. |
The GraphicItemPlotHasPen function finds the embedded plot item using the ItemId parameter. If found, the function returns a value indicating whether the plot has a pen connected to Source.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
A BOOL value indicating whether the plot has a pen connected to Source.
Adds a pen to an Embedded Plot.
Informal syntax:
GraphicItemPlotRemovePen( ItemId, Source )
Formal syntax:
GraphicItemPlotRemovePen( ItemId:=Expression, Source:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the embedded plot item. |
Source | ANY_STRING | The name of the data source to remove from the plot. |
The GraphicItemPlotRemovePen function finds the embedded plot item using the ItemId parameter. If found, the function removes the pen from the embedded plot.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Sets the value of the DataBindBlink data binding.
Informal syntax:
GraphicItemSetBlink( ItemId, Blink )
Formal syntax:
GraphicItemSetBlink( ItemId:=Expression, Blink:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
Blink | BOOL | Whether the item will blink (true) or not blink (false). |
The GraphicItemSetBlink function finds the graphic item using the ItemId parameter. If found, the function writes the Blink parameter to the DataBindBlink data binding. Writing the value True will make the item blink. Writing the value False will stop the item blinking.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Note: If the DataBindBlink is configured on a graphic item, any value written by this function will only have a temporary effect. The value will be overwritten by the data binding at the next data refresh.
None.
Sets the value of the DataBindDisableActions data binding.
Informal syntax:
GraphicItemSetDisableActions( ItemId, DisableActions )
Formal syntax:
GraphicItemSetDisableActions( ItemId:=Expression, DisableActions:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
DisableActions | BOOL | Whether actions are disabled (true) or enabled (false). |
The GraphicItemSetDisableActions function finds the graphic item using the ItemId parameter. If found, the function writes the DisableActions parameter to the DataBindDisableActions data binding. Writing the value True will disable actions on the item. Writing the value False will enable actions on the item.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Note: If the DataBindDisableActions is configured on a graphic item, any value written by this function will only have a temporary effect. The value will be overwritten by the data binding at the next data refresh.
None.
Sets the value of a Global Variable in the Global Bindings of a Graphic Page.
Informal syntax:
GraphicItemSetGlobalVariable( ItemId, VariableRef, Value )
Formal syntax:
GraphicItemSetGlobalVariable( ItemId:=Expression, VariableRef:=Expression, Value:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
VariableRef | ANY_STRING | The global variable to set. |
Value | ANY_ELEMENTARY | The value to write to the global variable. |
The GraphicItemSetGlobalVariable function finds the graphic item using the ItemId parameter. If found, the function will write the Value parameter to the global variable defined by the VariableRef parameter. If the ItemId parameter is an empty string, the function will use the top level graphic page.
A runtime error will be reported if:
You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Sets the value of the AutoUpdate property of an SQL List.
Informal syntax:
GraphicItemSetSqlListAutoUpdate( ItemId, AutoUpdate )
Formal syntax:
GraphicItemSetSqlListAutoUpdate( ItemId:=Expression, AutoUpdate:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
AutoUpdate | BOOL | Whether the SQL List should automatically update. |
The GraphicItemSetSqlListAutoUpdate function finds the graphic item using the ItemId parameter. If found, the function writes the AutoUpdate parameter to the AutoUpdate property.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Sets the value of the SqlCommand property of an SQL List.
Informal syntax:
GraphicItemSetSqlListSqlCommand( ItemId, SqlCommand )
Formal syntax:
GraphicItemSetSqlListSqlCommand( ItemId:=Expression, SqlCommand:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
SqlCommand | ANY_STRING | The new SQL Command of the SQL List. |
The GraphicItemSetSqlListSqlCommand function finds the graphic item using the ItemId parameter. If found, the function writes the SqlCommand parameter to the SqlCommand property.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Sets the value of the DataBindText data binding.
Informal syntax:
GraphicItemSetText( ItemId, Text )
Formal syntax:
GraphicItemSetText( ItemId:=Expression, Text:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
Text | STRING | The new text to display. |
The GraphicItemSetText function finds the graphic item using the ItemId parameter. If found, the function writes the Text parameter to the DataBindText data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Note: If the DataBindText is configured on a graphic item, any value written by this function will only have a temporary effect. The value will be overwritten by the data binding at the next data refresh.
None.
Sets the value of the DataBindTextStrikeout data binding.
Informal syntax:
GraphicItemSetTextStrikeout( ItemId, Strikeout )
Formal syntax:
GraphicItemSetTextStrikeout( ItemId:=Expression, Strikeout:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
Strikeout | BOOL | Whether the text should be drawn with strikeout (TRUE) or not (FALSE). |
The GraphicItemSetTextStrikeout function finds the graphic item using the ItemId parameter. If found, the function writes the Strikeout parameter to the DataBindTextStrikeout data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Note: If the DataBindTextStrikeout is configured on a graphic item, any value written by this function will only have a temporary effect. The value will be overwritten by the data binding at the next data refresh.
None.
Sets the value of the DataBindTextUnderline data binding.
Informal syntax:
GraphicItemSetTextUnderline( ItemId, Underline )
Formal syntax:
GraphicItemSetTextUnderline( ItemId:=Expression, Underline:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
Underline | BOOL | Whether the text should be drawn with underline (TRUE) or not (FALSE). |
The GraphicItemSetTextUnderline function finds the graphic item using the ItemId parameter. If found, the function writes the Underline parameter to the DataBindTextUnderline data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Note: If the DataBindTextUnderline is configured on a graphic item, any value written by this function will only have a temporary effect. The value will be overwritten by the data binding at the next data refresh.
None.
Sets the value of the DataBindTooltip data binding.
Informal syntax:
GraphicItemSetTooltip( ItemId, Tooltip )
Formal syntax:
GraphicItemSetTooltip( ItemId:=Expression, Tooltip:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
Tooltip | STRING | The new text to display in the tooltip. |
The GraphicItemSetTooltip function finds the graphic item using the ItemId parameter. If found, the function writes the Tooltip parameter to the DataBindTooltip data binding.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Note: If the DataBindTooltip is configured on a graphic item, any value written by this function will only have a temporary effect. The value will be overwritten by the data binding at the next data refresh.
None.
Sets whether the tracking mode of a trend is enabled.
Informal syntax:
GraphicItemSetTrendTrackingMode( ItemId, TrackingMode )
Formal syntax:
GraphicItemSetTrendTrackingMode( ItemId:=Expression, TrackingMode:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the trend item. |
TrackingMode | BOOL | Whether tracking mode is enabled on the trend. |
The GraphicItemSetTrendTrackingMode function finds the graphic trend item using the ItemId parameter. If found, the function writes the TrackingMode parameter to embedded trend.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Sets the X Axis interval of a graphic trend item.
Informal syntax:
GraphicItemSetTrendXInterval( ItemId, XInterval )
Formal syntax:
GraphicItemSetTrendXInterval( ItemId:=Expression, XInterval:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the trend item. |
XInterval | TIME | The new X Axis interval of the trend. |
The GraphicItemSetTrendXInterval function finds the graphic trend item using the ItemId parameter. If found, the function writes the XInterval parameter to embedded trend.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Sets the offset (relative to the current time) of the right edge of the X Axis of a trend.
Informal syntax:
GraphicItemSetTrendXOffset( ItemId, XOffset )
Formal syntax:
GraphicItemSetTrendXOffset( ItemId:=Expression, XOffset:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the trend item. |
XOffset | TIME | The new X Axis offset of the trend. |
The GraphicItemSetTrendXOffset function finds the graphic trend item using the ItemId parameter. If found, the function writes the XOffset parameter to embedded trend.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Sets the value of the DataBindVisible data binding.
Informal syntax:
GraphicItemSetVisible( ItemId, Visible )
Formal syntax:
GraphicItemSetVisible( ItemId:=Expression, Visible:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the item. |
Visible | BOOL | Whether the item will be displayed (true) or hidden (false). |
The GraphicItemSetVisible function finds the graphic item using the ItemId parameter. If found, the function writes the Visible parameter to the DataBindVisible data binding. Writing the value True will display the item. Writing the value False will hide the item.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
Note: If the DataBindVisible is configured on a graphic item, any value written by this function will only have a temporary effect. The value will be overwritten by the data binding at the next data refresh.
None.
Refreshes the query of an SQL List.
Informal syntax:
GraphicItemSqlListRefresh( ItemId )
Formal syntax:
GraphicItemSqlListRefresh( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the SQL List. |
The GraphicItemSqlListRefresh function finds the SQL List using the ItemId parameter. If found, the function requests the SQL List to execute the SQL Command and display the results.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Moves the X Axis of an Embedded Plot to the next time interval.
Informal syntax:
GraphicItemTrendNextInterval( ItemId )
Formal syntax:
GraphicItemTrendNextInterval( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the trend item. |
The GraphicItemTrendNextInterval function finds the graphic trend item using the ItemId parameter. If found, the function moves the X Axis of the trend to the next time interval.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Moves the X Axis of an Embedded Plot to the previous time interval.
Informal syntax:
GraphicItemTrendPreviousInterval( ItemId )
Formal syntax:
GraphicItemTrendPreviousInterval( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the trend item. |
The GraphicItemTrendPreviousInterval function finds the graphic trend item using the ItemId parameter. If found, the function moves the X Axis of the trend to the previous time interval.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Resets the X Axis of an Embedded Plot back to its default values.
Informal syntax:
GraphicItemTrendReset( ItemId )
Formal syntax:
GraphicItemTrendReset( ItemId:=Expression )
Parameter | Type | Description |
---|---|---|
ItemId | ANY_STRING | The Label or Id of the trend item. |
The GraphicItemTrendReset function finds the graphic trend item using the ItemId parameter. If found, the function resets the X Axis of the embedded trend back to its default values.
If the graphic item is not found, a runtime error will be reported. You can detect and handle runtime errors by assigning ENO to a variable in a formal call. For more information see Formal Function Calls.
None.
Hides an embedded graphic by setting the value of the DataBindVisible data binding of the embedded graphic to False.
Informal and formal syntax:
HideSelf()
None.
The HideSelf function the DataBindVisible data binding of the embedded graphic to False. This has the effect of hiding the embedded graphic.
The HideSelf function does nothing if the code calling the function is run from a top level graphic page.
None.
For the different data bindings available on graphic items.
For the different tools available to edit graphic pages.
For information about editing graphic pages in Fernhill SCADA.
For the meaning of terms used in Fernhill SCADA.