poIResultCtrl ClearPlot

Syntax

poIResultCtrl_handle ClearPlot id context notify

Application

HyperView Tcl Modify

Description

This command, valid only in Upfront Data Loading Mode, clears the plot of the specified result definition. Returns Success (0) if clearing was successful or Warning (2) if there was a problem during clearing.

Inputs

id: The ID of the result definition to clear.

context: A string indicating the context of the request. Valid values are: scalar, tensor, vector, and iso.
notify: Set to 'true' to trigger an event to update the browser, otherwise 'false'. The default value is true.

Example

To clear a scalar plot with ID 3:

hwi OpenStack
hwi GetSessionHandle sess
sess GetProjectHandle proj
proj GetPageHandle page [proj GetActivePage]
page GetWindowHandle win [page GetActiveWindow]
win GetClientHandle client
client GetModelHandle model [client GetActiveModel]
model GetResultCtrlHandle rc
rc ClearPlot 3 scalar true
hwi CloseStack

Errors

Returns error code if there was an error clearing the plot and sets error condition on the session handle. See session_handle GetError.