2.14.7 get_plot_sel

Brief Information

Get plot ranges defined by data markers on graph

Additional Information

X-Function not designed for Auto GetN Dialog.

Minimum Origin Version Required: 8.0 SR6

Command Line Usage

get_plot_sel str:=selection scope:=layer;

X-Function Execution Options

Please refer to the page for additional option switches when accessing the x-function from script

Variables

Display
Name
Variable
Name
I/O
and
Type
Default
Value
Description
str

Output

string

sel
This string variable is used to hold the output string of the plot selections. If there are no plot selections in the specified scope (see the scope variable below), the string will be empty.
sep

Input

string

If there are more than one plot selection in the specified scope (see the scope variable below), a separator is used to separate the range strings in the output string. This variable can be used to specify the separator.
scope

Input

int

Layer
Specify the scope of the graph to get the plot selections.

Option list:

  • plot:Active Plot
    Get the plot selections from the active plot.
  • layer:Active Layer
    Get the plot selections from all plots in the active layer.
  • page:Active Page
    Get the plot selections from all plots in the active page.

Description

This X-Function is capable of getting the plot selections in the active graph. The result is output to a string variable. Multiple selections are supported. A specified separator can be used to separate strings for different selection in the output string. In addition, you can limit the scope of operation to only the active plot, the active layer or the whole active page.


Keywords:subset, subrange, selection