2.10.2 plot_bygroup

Contents

Menu Information

Plot: 2D: Cluster Plot

Brief Information

Create a multiple-panel graph by specified group information

Additional Information

Minimum Origin Version Required: 2019

Command Line Usage

1. plot_bygroup -r 1 iy:=[Book1]Sheet1!((A,B),(A,C)) type:=scatter hgroup:=[Book1]Sheet1!D xlink:=1;

2. plot_bygroup iy:=[Book1]Sheet1!(E,F) type:=column hgroup:=[Book1]Sheet1!A vgroup:=[Book1]Sheet1!B color:=[Book1]Sheet1!C rowcol:=2;

Variables

Display
Name 		Variable
Name 		I/O
and
Type 		Default
Value 		Description
Input iy

Input

XYRange

<active>

Specifies the data you want to plot. Multiple XY ranges are supported.

Plot Type type

Input

int

0

Specifies the graph type you want to plot.

Option list:

  • line(0):Line
  • scatter(1):Scatter
  • linesymb(2):Line+Symbol
  • column(3):Column
  • bar(4):Bar
Graph Template template

Input

string

<auto>

Specifies the graph template to create the group plot. Default template used is groupedplot.otpu (installed to Origin program folder).

Variable for Separate Layers > Horizontal hgroup

Input

Range

<optional>

Specifies the group column(s) that is used to categorize the input data. Each group variable will be displayed in a separate panel and penels are arranged horizontally.

Variable for Separate Layers > Vertical vgroup

Input

Range

<optional>

Specifies the group column(s) that is used to categorize the input data. Each group variable will be displayed in a separate panel and panels are arranged vertically.

hexclude

Input

string

Not intended for use.

vexclude

Input

string

Not intended for use.

Variable to Color Data Points color

Input

Range

<optional>

Specifies the column that is used to color-map the plot(s).

Variable for Symbol Shape shape

Input

Range

<optional>

Specifies the column that is used to index the symbol shape. Scatter and Line+Symbol plots only.

Variable for Symbol Size size

Input

Range

<optional>

Specifies the column that is used to control the symbol size. Scatter and Line+Symbol plots only.

Arrange Layers arrange

Input

int

0

Specifies how to arrange the layers in the generated group graph. The multiple layers will be arranged on a row X col grid. Available when either hgroup or vgroup is not assign.

Option list:

  • rowcol(0):Number of Columns/Rows
    Specifies the number of columns/rows in rowcol and the number of rows/columns will be calculated accordingly
  • overlap(1):Overlap All Layers
    All layers are overlapped each other and thus only one panel with offset axises is displayed. Note: when this option is selected, settings under the Spacing branch (include hgap, vgap, leftmg, rightmg, topmg and ) is not available.
Number of Columns/Rows rowcol

Input

int

1

Specifies the number of columns/rows when arrange = rowcol

Link Layers link

Input

int

1
 Specifies whether to link the rest of layers to Layer1
Horizontal Gap hgap

Input

int

5
 Specifies the horizontal gap between adjacent layers.
Vertical Gap vgap

Input

int

5
 Specifies the vertical gap between adjacent layers.
Left Margin leftmg

Input

int

15
 Specifies the left margin of the generated graph page.
Right Margin rightmg

Input

int

10
 Specifies the right margin of the generated graph page.
Top Margin topmg

Input

int

10
 Specifies the top margin of the generated graph page.
Bottom Margin bottommg

Input

int

15
 Specifies the bottom margin of the generated graph page.
Uniform X Scale xlink

Input

int

0
 Check this to link X axis of child layer to that of parent layer as Straight (1 to 1) .
Uniform Y Scale ylink

Input

int

0
 Check this to link Y axis of child layer to that of parent layer as Straight (1 to 1).
X Axes Gap(%) xoffset

Input

double

8
 This is available only when arrange = overlap and xlink = 0. When all layers are overlapped, this determines the offset gap of X axes from different layers, in unit of percentage of the page dimension.
Y Axes Gap(%) yoffset

Input

double

8
 This is available only when arrange = overlap and ylink = 0. When all layers are overlapped, this determines the offset gap of Y axes from different layers, in unit of percentage of the page dimension.
Show Group Info in X Title xinfo

Input

int

0
 This is available only when arrange = overlap and xlink = 0. Specifies whether to show group information in X axis title.
Show Group Info in Y Title yinfo

Input

int

0
 This is available only when arrange = overlap and ylink = 0. Specifies whether to show group information in Y axis title.
Hide Axes for Inner Layers inner

Input

int

0
 This is available only when when arrange = rowcol (but disable when rowcol is not Auto). Specifies whether to hide axis ticks and labels for inner layers. If checked, only the left most layers show the ticks and labels of Y axes and bottom layers show the X axes. If layer gap is set to 0, check this checkbox to eliminate the gap between adjacent panels.
Show Group Info in info

Input

int

1
 This is available when arrange is NOT set to overlap. Specifies how to show the group information.

Option list:

  • none(0):None'
    do not show the group information.
  • layerTitle(1):Layer Title
    show the group information in the layer title
  • axisTitle(2):Axis Title
    show the group information in the XY axis title
  • layerBanner(3):Layer Banner
    show the group information in the layer banner
Show Axis Frame frame

Input

int

0
 Specifies whether to show axis frame.
Output Data rd

Output

ReportData

[<input>]<new>
 Specifies the worksheet where the unstacked data is output to. This intermediate worksheet is used to create the group graph.

Description

This X-Function creates a trellis-like graph. Input data is categorized into multiple layers by the specified group column(s). Please refer to cluster plot for more details.

Related X-Functions

plot_group