2.5.33 legendbox


Contents

Menu Information

Graph:Legend:Box Chart Components

Brief Information

Create enhanced legend for box chart

Additional Information

Minimum Origin Version Required:9.1 SR0

Command Line Usage

1. legendbox igl:=[Graph1]1! mode:=2 box:=0;//Replace the existing legend object in the first layer of Graph1, the legend entry for box will not be shown

2. legendbox mode:=1 id:=L data:=1;//Update the legend entries for box chart components in the active layer, use long name as box identifier and show the entries for data points.

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
Input Graph igl

Input

GraphLayer

<active>
 Specify the graph layer to add the legend for box chart components. It is required that this graph layer contains a box chart.
Append mode

Input

int

1
 Specify how to deal with the existing legend object on the graph when the legend for box chart components is created.

Option list:

  • append:Append{0}
    Append the legend entries for box chart components to the existing legend (if any), even though the existing legend already contains legend entries for box chart components.
  • update:Update{1}
    Update the legend entries for box chart components in the existing legend (if any). If there are no such legend entries yet, the new legend entries for box chart components will be added to the existing legend.
  • replace:Replace{2}
    Replace the existing legend object (if any) with a legend for box chart components.
Box / Bar box

Input

int

1
 Specify whether to show the legend entry for box or bar.
Box (or Bar) Identifier / Data Identifier id

Input

string

<none>
 Specify the column label row to be used as the identifier of each box/ bar (box type is not Data) or of each data set (box type is Data).

Option list:

  • G:Short Name
    Use the column short name(s) as box (or bar) identifier.
  • L:Long Name
    Use the column Long Name(s) as box (or bar) identifier.
  • C:Comments
    Use the Comments row as box (or bar) identifier.
  • U:Units
    Use the Units row as box (or bar) identifier.
  • <custom>
    Use a custom identifier format
  • <none>
    No box identifier. Default options for normal box chart and Grouped box chart
Custom Identifier Format custom

Input

string

Specify the custom format of the box (or bar) identifier.
Show Box Range / Show Bar Represent range

Input

int

1
 Specify whether to show the box range after box identifier or show bar represent after bar identifier. 0=not show, 1=show.
Whisker / Error Bar whisker

Input

int

1
 Specify whether to show the entry for Whisker or Error Bar. 0=not show, 1=show.
Median Line mdl

Input

int

1
 Specify whether to show the entry for median line. 0=not show, 1=show.
Mean Line ml

Input

int

0
 Specify whether to show the entry for mean line. 0=not show, 1=show.
Max max

Input

int

0
 Specify whether to show the entry for the Max percentile. 0=not show, 1=show.
99% perc99

Input

int

0
 Specify whether to show the entry for the 99% percentile. 0=not show, 1=show.
Mean mean

Input

int

1
 Specify whether to show the entry for the Mean percentile. 0=not show, 1=show.
median Median

Input

int

1
 Specify whether to show the entry for the Median percentile. 0=not show, 1=show.
1% perc1

Input

int

0
 Specify whether to show the entry for the 1% percentile. 0=not show, 1=show.
Min min

Input

int

0
 Specify whether to show the entry for the Min percentile. 0=not show, 1=show.
Custom Percentiles cp

Input

int

0
 Specify whether to show the entry for the Custom Percentiles. 0=not show, 1=show.
Data data

Input

int

0
 Specify whether to show the entry for data points in box chart. 0=not show, 1=show. To turn on data points, you need to select a box type which includes Data.
Data Indentifier dataid

Input

string

G
 The first four use the variable in the corresponding column label row of the source data column.
  • Short Name
  • Long Name
  • Units
  • Comments
  • Any Categorical Group Columns: Columns of categorical data used to define box chart groups.
  • <Custom>: Used with Custom Identifier Format to build the text string.
  • : Use the data symbol of the first plot.
Custom Identifier Format datacustom

Input

string

Only available when <Custom> is selected for Data Identifier. Specify your Identifier by one of the following:
  • Select a built-in custom format from the drop-down menu.
  • Click the arrow button to the right side of the combo box.
  • Enter your own strings for identifier directly, referring to the complete list of @options for details.
Outliers outlier

Input

int

1
 Specify whether to show the entry for Outliers. 0=not show, 1=show.
Extreme Values extreme

Input

int

0
 Specify whether to show extreme values. 1 = show, 0 = not show.
Create Legend create

Input

int

1
 Specify whether to create the legend of box chart components when there is no legend in current graph layer. 1 = create, 0 = not create.
Connect Mean cm

Input

int

0
 Specify whether to show the entry for the Connect Mean line. 0=not show, 1=show.
Connect Median Line cmd

Input

int

0
 Specify whether to show the entry for the Connect Median line. 0=not show, 1=show.
Connect Data Points cd

Input

int

0
 Specify whether to show the entry for the Connect Data Points line. 0=not show, 1=show.
Connect Percentiles ccp

Input

int

0
 Specify whether to show the entry for the Connect Percentiles line. 0=not show, 1=show.

Description

This X-Function can only be used when the input graph layer fulfills this requirement. You can use the script 

legendbox -d;

to bring up the dialog control.

Note that from dialog control, the input graph layer can only be the active layer, and the mode can only be Update.


Related X-Functions

legendupdate,plotgboxraw