Graphic Item Functions

Help Contents

Introduction

Graphic Item Functions allow Operator Actions, executed in a Graphic Page, to interact with items on the page.

Using Graphic Item Functions you can:

Locating Graphic Items

All graphic items have Id and Label properties:

Properties window showing the shape id and user defined label

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:

  1. The first graphic item with a matching Label.
  2. The graphic item with a matching Id from the same graphic page as the calling function.
  3. If the function is called from an embedded graphic, the search continues from step 1 in the container graphic page.
  4. If no graphic item is found, a runtime error is reported.

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:


Graphic Item Functions

These Graphic Item Functions read and write graphic item properties:

Get FunctionSet FunctionRelated Data Binding
GraphicItemGetBlink GraphicItemSetBlink DataBindBlink
GraphicItemGetData
GraphicItemGetDisableActions GraphicItemSetDisableActions DataBindDisableActions
GraphicItemGetGlobalVariable GraphicItemSetGlobalVariable Global Bindings
GraphicItemGetParentId
GraphicItemGetSqlListAutoUpdate GraphicItemSetSqlListAutoUpdate
GraphicItemGetSqlListSqlCommand GraphicItemSetSqlListSqlCommand
GraphicItemGetText GraphicItemSetText DataBindText
GraphicItemGetTextStrikeout GraphicItemSetTextStrikeout DataBindTextStrikeout
GraphicItemGetTextUnderline GraphicItemSetTextUnderline DataBindTextUnderline
GraphicItemGetTooltip GraphicItemSetTooltip DataBindTooltip
GraphicItemGetTrendTrackingMode GraphicItemSetTrendTrackingMode
GraphicItemGetTrendXInterval GraphicItemSetTrendXInterval
GraphicItemGetTrendXOffset GraphicItemSetTrendXOffset
GraphicItemGetVisible GraphicItemSetVisible DataBindVisible

These Graphic Item Functions execute commands on graphic items:

FunctionSummary
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 )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.

Remarks

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.

Return Value

Returns a BOOL value indicating whether the graphic item is blinking (true) or not blinking (false).


GraphicItemGetData

Returns data from a graphic item.

Informal syntax:

GraphicItemGetData( ItemId, Format, SelectedData )

Formal syntax:

GraphicItemGetData( ItemId:=Expression, Format:=Expression, SelectedData:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
Format ANY_STRING The format of the data to return. These values are supported:
  • 'text/csv' - Return the data as comma separated values.
  • 'text/tab-separated-values' - Return the data as tab separated values.
SelectedData BOOL Whether to return all of the data, or selected data:
  • FALSE - Return all of the data from the item.
  • TRUE - Return only selected data from the item.

Remarks

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.

Return Value

Returns a STRING value containing the data from the item.


GraphicItemGetDisableActions

Gets the value of the DataBindDisableActions data binding.

Informal syntax:

GraphicItemGetDisableActions( ItemId )

Formal syntax:

GraphicItemGetDisableActions( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.

Remarks

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.

Return Value

Returns a BOOL value indicating whether the actions on the item are disable (true) or enabled (false).


GraphicItemGetGlobalVariable

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)

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
GlobalValueANY_STRINGA global variable expression to evaluate.

Remarks

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.

Return Value

The return value does not have a type. Use a Type Cast to convert the return value. For example:

TO_STRING( GraphicItemGetGlobalVariable( ItemID, "SelectedTurbine" ) )

GraphicItemGetParentId

Returns the ItemId of the parent graphic item.

Informal and formal syntax:

GraphicItemGetParentId()

Parameters

None

Remarks

The GraphicItemGetParentId function returns the ItemId of the parent graphic page.

This function does not report any errors.

Return Value

Returns the ItemId of the parent as STRING value.


GraphicItemGetSqlListAutoUpdate

Gets the value of the AutoUpdate property of an SQL List.

Informal syntax:

GraphicItemGetSqlListAutoUpdate( ItemId )

Formal syntax:

GraphicItemGetSqlListAutoUpdate( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.

Remarks

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.

Return Value

Returns a BOOL value indicating whether the SQL List automatically updates.


GraphicItemGetSqlListSqlCommand

Gets the value of the SqlCommand property of an SQL List.

Informal syntax:

GraphicItemGetSqlListSqlCommand( ItemId )

Formal syntax:

GraphicItemGetSqlListSqlCommand( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.

Remarks

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.

Return Value

Returns the SQL command as a STRING value.


GraphicItemGetText

Gets the value of the DataBindText data binding.

Informal syntax:

GraphicItemGetText( ItemId )

Formal syntax:

GraphicItemGetText( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.

Remarks

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.

Return Value

Returns a STRING value representing the current text value.


GraphicItemGetTextStrikeout

Gets the value of the DataBindTextStrikeout data binding.

Informal syntax:

GraphicItemGetTextStrikeout( ItemId )

Formal syntax:

GraphicItemGetTextStrikeout( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.

Remarks

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.

Return Value

Returns a BOOL value indicating whether the text is drawn with a strikeout effect.


GraphicItemGetTextUnderline

Gets the value of the DataBindTextUnderline data binding.

Informal syntax:

GraphicItemGetTextUnderline( ItemId )

Formal syntax:

GraphicItemGetTextUnderline( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.

Remarks

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.

Return Value

Returns a BOOL value indicating whether the text is drawn with an underline.


GraphicItemGetTooltip

Gets the value of the DataBindTooltip data binding.

Informal syntax:

GraphicItemGetTooltip( ItemId )

Formal syntax:

GraphicItemGetTooltip( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.

Remarks

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.

Return Value

Returns a STRING value representing the current tooltip value.


GraphicItemGetTrendTrackingMode

Gets whether the tracking mode of an Embedded Plot is enabled.

Informal syntax:

GraphicItemGetTrendTrackingMode( ItemId )

Formal syntax:

GraphicItemGetTrendTrackingMode( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the trend item.

Remarks

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.

Return Value

Returns a BOOL value indicating whether tracking mode is enabled.


GraphicItemGetTrendXInterval

Gets the X Axis interval of an Embedded Plot.

Informal syntax:

GraphicItemGetTrendXInterval( ItemId )

Formal syntax:

GraphicItemGetTrendXInterval( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the trend item.

Remarks

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.

Return Value

Returns a TIME value representing the current X Axis interval.


GraphicItemGetTrendXOffset

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 )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the trend item.

Remarks

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.

Return Value

Returns a TIME value representing the current offset (relative to the current time) of the right edge of the X Axis.


GraphicItemGetVisible

Gets the value of the DataBindVisible data binding.

Informal syntax:

GraphicItemGetVisible( ItemId )

Formal syntax:

GraphicItemGetVisible( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.

Remarks

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.

Return Value

Returns a BOOL value indicating whether the graphic item is visible (true) or hidden (false).


GraphicItemPlotAddPen

Adds a pen to an Embedded Plot.

Informal syntax:

GraphicItemPlotAddPen( ItemId, Source, Label )

Formal syntax:

GraphicItemPlotAddPen( ItemId:=Expression, Source:=Expression, Label:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the embedded plot item.
SourceANY_STRINGThe name of the data source to add to the plot.
LabelANY_STRINGThe label to display in the key area of the plot.

Remarks

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.

Return Value

None.


GraphicItemPlotHasPen

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 )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the embedded plot item.
SourceANY_STRINGThe name of the data source to test.

Remarks

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.

Return Value

A BOOL value indicating whether the plot has a pen connected to Source.


GraphicItemPlotRemovePen

Adds a pen to an Embedded Plot.

Informal syntax:

GraphicItemPlotRemovePen( ItemId, Source )

Formal syntax:

GraphicItemPlotRemovePen( ItemId:=Expression, Source:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the embedded plot item.
SourceANY_STRINGThe name of the data source to remove from the plot.

Remarks

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.

Return Value

None.


Sets the value of the DataBindBlink data binding.

Informal syntax:

GraphicItemSetBlink( ItemId, Blink )

Formal syntax:

GraphicItemSetBlink( ItemId:=Expression, Blink:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
BlinkBOOLWhether the item will blink (true) or not blink (false).

Remarks

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.

Return Value

None.


GraphicItemSetDisableActions

Sets the value of the DataBindDisableActions data binding.

Informal syntax:

GraphicItemSetDisableActions( ItemId, DisableActions )

Formal syntax:

GraphicItemSetDisableActions( ItemId:=Expression, DisableActions:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
DisableActionsBOOLWhether actions are disabled (true) or enabled (false).

Remarks

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.

Return Value

None.


GraphicItemSetGlobalVariable

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 )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
VariableRefANY_STRINGThe global variable to set.
ValueANY_ELEMENTARYThe value to write to the global variable.

Remarks

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.

Return Value

None.


GraphicItemSetSqlListAutoUpdate

Sets the value of the AutoUpdate property of an SQL List.

Informal syntax:

GraphicItemSetSqlListAutoUpdate( ItemId, AutoUpdate )

Formal syntax:

GraphicItemSetSqlListAutoUpdate( ItemId:=Expression, AutoUpdate:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
AutoUpdateBOOLWhether the SQL List should automatically update.

Remarks

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.

Return Value

None.


GraphicItemSetSqlListSqlCommand

Sets the value of the SqlCommand property of an SQL List.

Informal syntax:

GraphicItemSetSqlListSqlCommand( ItemId, SqlCommand )

Formal syntax:

GraphicItemSetSqlListSqlCommand( ItemId:=Expression, SqlCommand:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
SqlCommandANY_STRINGThe new SQL Command of the SQL List.

Remarks

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.

Return Value

None.


GraphicItemSetText

Sets the value of the DataBindText data binding.

Informal syntax:

GraphicItemSetText( ItemId, Text )

Formal syntax:

GraphicItemSetText( ItemId:=Expression, Text:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
TextSTRINGThe new text to display.

Remarks

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.

Return Value

None.


GraphicItemSetTextStrikeout

Sets the value of the DataBindTextStrikeout data binding.

Informal syntax:

GraphicItemSetTextStrikeout( ItemId, Strikeout )

Formal syntax:

GraphicItemSetTextStrikeout( ItemId:=Expression, Strikeout:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
StrikeoutBOOLWhether the text should be drawn with strikeout (TRUE) or not (FALSE).

Remarks

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.

Return Value

None.


GraphicItemSetTextUnderline

Sets the value of the DataBindTextUnderline data binding.

Informal syntax:

GraphicItemSetTextUnderline( ItemId, Underline )

Formal syntax:

GraphicItemSetTextUnderline( ItemId:=Expression, Underline:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
UnderlineBOOLWhether the text should be drawn with underline (TRUE) or not (FALSE).

Remarks

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.

Return Value

None.


GraphicItemSetTooltip

Sets the value of the DataBindTooltip data binding.

Informal syntax:

GraphicItemSetTooltip( ItemId, Tooltip )

Formal syntax:

GraphicItemSetTooltip( ItemId:=Expression, Tooltip:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
TooltipSTRINGThe new text to display in the tooltip.

Remarks

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.

Return Value

None.


GraphicItemSetTrendTrackingMode

Sets whether the tracking mode of a trend is enabled.

Informal syntax:

GraphicItemSetTrendTrackingMode( ItemId, TrackingMode )

Formal syntax:

GraphicItemSetTrendTrackingMode( ItemId:=Expression, TrackingMode:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the trend item.
TrackingModeBOOLWhether tracking mode is enabled on the trend.

Remarks

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.

Return Value

None.


GraphicItemSetTrendXInterval

Sets the X Axis interval of a graphic trend item.

Informal syntax:

GraphicItemSetTrendXInterval( ItemId, XInterval )

Formal syntax:

GraphicItemSetTrendXInterval( ItemId:=Expression, XInterval:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the trend item.
XIntervalTIMEThe new X Axis interval of the trend.

Remarks

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.

Return Value

None.


GraphicItemSetTrendXOffset

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 )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the trend item.
XOffsetTIMEThe new X Axis offset of the trend.

Remarks

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.

Return Value

None.


GraphicItemSetVisible

Sets the value of the DataBindVisible data binding.

Informal syntax:

GraphicItemSetVisible( ItemId, Visible )

Formal syntax:

GraphicItemSetVisible( ItemId:=Expression, Visible:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the item.
VisibleBOOLWhether the item will be displayed (true) or hidden (false).

Remarks

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.

Return Value

None.


GraphicItemSqlListRefresh

Refreshes the query of an SQL List.

Informal syntax:

GraphicItemSqlListRefresh( ItemId )

Formal syntax:

GraphicItemSqlListRefresh( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the SQL List.

Remarks

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.

Return Value

None.


GraphicItemTrendNextInterval

Moves the X Axis of an Embedded Plot to the next time interval.

Informal syntax:

GraphicItemTrendNextInterval( ItemId )

Formal syntax:

GraphicItemTrendNextInterval( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the trend item.

Remarks

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.

Return Value

None.


GraphicItemTrendPreviousInterval

Moves the X Axis of an Embedded Plot to the previous time interval.

Informal syntax:

GraphicItemTrendPreviousInterval( ItemId )

Formal syntax:

GraphicItemTrendPreviousInterval( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the trend item.

Remarks

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.

Return Value

None.


GraphicItemTrendReset

Resets the X Axis of an Embedded Plot back to its default values.

Informal syntax:

GraphicItemTrendReset( ItemId )

Formal syntax:

GraphicItemTrendReset( ItemId:=Expression )

Parameters

ParameterTypeDescription
ItemIdANY_STRINGThe Label or Id of the trend item.

Remarks

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.

Return Value

None.


HideSelf

Hides an embedded graphic by setting the value of the DataBindVisible data binding of the embedded graphic to False.

Informal and formal syntax:

HideSelf()

Parameters

None.

Remarks

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.

Return Value

None.


Further Information

Data Bindings

For the different data bindings available on graphic items.

Graphic Editor Toolbar

For the different tools available to edit graphic pages.

Graphic Editor

For information about editing graphic pages in Fernhill SCADA.

Glossary

For the meaning of terms used in Fernhill SCADA.