/
XCommands for visualization runtime control

XCommands for visualization runtime control

The XCommand Button function of a button allows to execute specific XCommands upon events triggered by the button. Like other all XCommands, the XCommands related to visualization runtime control are located in the NXA.XLOGIC folder, their file names start with “Visu.”. While other XCommands are executed in the server, the VISU XCommands are always executed on the client. That is, they do not affect server contents, and they to not affect other clients.

 Following XCommands are available:

Context

XCommand

Description

Parameters

Context

XCommand

Description

Parameters

Groups

Visu.Groups.Invisible

Hides all groups matching the provided matching criteria.

  • GroupNameFilter_1 - 10: group name; wildcards * and ? are allowed

Visu.Groups.SetVariables

Sets variables of groups matching the provided criteria.

  • GroupNameFilter: group name; wildcards * and ? are allowed

  • VariableName_1 - 5: variable name

  • VariableValue_1 - 5: variable value

Visu.Groups.Visible

Shows all groups matching the provided criteria.

  • GroupNameFilter_1 - 10: group name; wildcards * and ? are allowed

Layers

Visu.Layers.Disable

Disables all layers matching the provided criteria.

  • LayerNameFilter_1 - 10: layer name; wildcards * and ? are allowed

Visu.Layers.Enable

Enables all layers matching the provided criteria.

  • LayerNameFilter_1 - 10: layer name; wildcards * and ? are allowed

Visu.Layers.Invisible

Hides all layers matching the provided criteria.

  • LayerNameFilter_1 - 10: layer name; wildcards * and ? are allowed

Visu.Layers.SetVariables

Sets variables of layers matching the provided criteria.

  • LayerNameFilter_1 - 10: layer name; wildcards * and ? are allowed

  • VariableName_1 - 5: variable name

  • VariableValue_1 - 5: variable value

Visu.Layers.Visible

Shows all layers matching the provided matching criteria.

  • LayerNameFilter_1 - 10: layer name; wildcards * and ? are allowed

Objects

Visu.Objects.SetProperties

Sets properties of visualization objects matching the provided criteria.

  • ObjectIdFilter: matching criteria for the NAME property; wildcards * and ? are allowed

  • PropertyName_1 - 5: property name

  • PropertyValue_1 - 5: property value

Pages

Visu.Pages.Goto

Navigates to the specified page.

  • PageName: page name. Alternatively use <PREVIOUS> and <NEXT> to navigate in the page history or <HOME> to navigate to the home page.

  • ViewId: view in which the page shall be opened. Valid values are Current, Main, View2, View3. If not used, Current will be used.

Visu.Pages.SetVariables

Sets variables of pages matching the provided criteria.

  • PageNameFilter: page name; wildcards * and ? are allowed

  • VariableName_1 - 5: variable name

  • VariableValue_1 - 5: variable value

Workspace

Visu.Workspace.SetVariables

Sets workspace variables.

  • VariableName_1 - 5: variable name

  • VariableValue_1 - 5: variable value