3.7.5.27 Layer.Axis.Break

LabTalk Object Type:

Window

The break object is a sub-object of the layer.axis.breaks object.

You can use range notation to define a layer object:

[winName!]layer[n].axis.breakm.property =

m here refers to the index of the break, if not specified, the first axis break will be used.

axis is the axis specification: X is the X axis (Top and Bottom), Y is the Y axis (Left and Right) and Z is the Z axis (Front and Back).


Note: This property is NOT supported in 3D Ternary graph.

Properties:

An axis break must exist for the following properties to be valid.

Property Access Description
layer.axis.breakm.from Read/write,
numeric

Starting axis break value.

layer.axis.breakm.to Read/write,
numeric

Ending axis break value.

layer.axis.breakm.pos Read/write,
numeric

The position of axis break at % of axis length.

layer.axis.breakm.space Read/write,
int

Specify the scale type of the axis region after the break.

layer.axis.breakm.formula Read/write,
string

Only useful when scale type is set to Custom Formula (layer.axis.break.space = 11), used to specify the direct formula of the custom axis scale after the break.

layer.axis.breakm.invformula Read/write,
string

Only useful when scale type is set to Custom Formula (layer.axis.break.space = 11), used to specify the inverse formula of the custom axis scale after the break.

layer.axis.breakm.tickstype Read/write,
int

Specify the major ticks type of the axis region after the break.

layer.axis.breakm.inc Read/write,
numeric

Only useful when major ticks type is set to By Increment, (layer.axis.break.tickstype = 1), specify major tick increment after the break (Major Ticks Value).

layer.axis.breakm.majorTICKS Read/write,
int

Only useful when major ticks type is set to By Counts, (layer.axis.break.tickstype = 2), specify number of major ticks after the break (Major Ticks Count).

layer.axis.breakm.ticksbydata Read/write,
dataset

Only useful when major ticks type is set to By Dataset, (layer.axis.break.tickstype = 3), specify the dataset for major tick location after the break.

layer.axis.breakm.ticksbylabel Read/write,
int

Only useful when major ticks type is set to By Plot Column Label, (layer.axis.break.tickstype = 4), specify the column label row for major tick location after the break.

layer.axis.breakm.mtickstype Read/write,
int

Specify the minor ticks type of the axis region after the break.

layer.axis.breakm.minorTicks Read/write,
int

Only useful when minor ticks type is set to By Count,(layer.axis.break.mtickstype = 1). specify the number of minor ticks between adjacent major ticks after the break.

layer.axis.breakm.mticksbydata Read/write,
dataset

Only useful when minor ticks type is set to By Dataset, (layer.axis.break.mtickstype = 2), specify the dataset for minor tick location after the break.

layer.axis.breakm.autoscale Read/write,
int

Specify whether to auto scale the axis in the region(s) after the break(s). 1=autoscale, 0=Do not autoscale.

Examples:

The following example shows how to enable and customize two axis breaks in an empty graph window:

//Create an empty graph window
win -t plot;
//Enable two axis breaks in x axis
layer.x.breaks.enable = 1;
layer.x.breaks.count = 2;
//Customize the first axis break
//Set the break to be from 2 to 4
layer.x.break1.from = 2;
layer.x.break1.to = 4;
//Change the axis break position to be at 40%
layer.x.break1.pos = 40;
//Change the increment after the first axis break to be 0.5
layer.x.break1.inc = 1;
//Customize the second axis break
//Set the break's from and to values to be from 6 to 6.5
layer.x.break2.from = 6;
layer.x.break2.to = 6.5;
//Change the major tick type to be "By Dataset" after the second break
layer.x.break2.tickstype = 3;
//Define a dataset and use it as major tick location after break
layer.x.break2.ticksbydata$ = 6.7 7.1 7.9 8.5 9.6;