A zoom axis can be used to create a number line, used as an axis in
COL_Plot and/or used to plot a COL_Trace against.
An axis is a line that may have
tick marks
labels
grid lines
a title
An axis is drawn to a length. It will have values along its length
from start to stop. Ticks, grid lines and labels are all drawn
at axis value positions. All other dimensions, such as line lengths,
widths, positions, spaces and offsets are defined in draw space, or in the
same space as the length of the axis.
axisx | y — 'x' axes are horizontal, 'y' axes are
vertical ('x')
lengthnumber — length of the axis in draw space
lineboolean | OBJ_AxisLineStyle — line style of the axis -
false will draw no line. By default, a solid line will be drawn if not
defined.
startnumber — start value of axis (0)
stopnumber — stop value of axis. stop must be larger than
start (start + 1)
ticksboolean | TypeTickLocation | OBJ_AxisTicks | boolean | TypeTickLocation | OBJ_AxisTicks[] — tick
options. Use an Array to setup multiple sets/styles of ticks. Use a boolean
value to turn ticks on or off. Use a TypeTickLocation to only set
tick location property (false)
labelsstring | boolean | OBJ_AxisLabels | (params: OBJ_LabelsCallbackParams) => string[] — label options. Use false to turn labels off, or a string or function as
a callback to define custom labels for a set of values. Use
TypeLabelLocation to only set the label location property.
gridboolean | OBJ_AxisTicks | boolean | OBJ_AxisTicks[] — grid
options. Use an array for multiple sets of grids, and use a boolean to
turn grids on and off (false)
fontOBJ_Font — default font of axis (used by title and labels)
showboolean — false hides the axis. Two axes are needed
to plot an CollectionsTrace on a CollectionsPlot, but if either or
both axes aren't to be drawn, then use false to hide each axis (true)
minnumber | null — minimum value axis can be zoomed or panned to
where null no limit (null)
maxnumber | null — maximum value axis can be zoomed or panned to
where null no limit (null)
auto[number, number] — Will select automatic values for
start, stop, and step that cover the range [min, max]
autoStepboolean | decimal — If true then start, stop and
step tick, grid and label values will be automatically calculated such that
they land on 0 and either double/half the original step (true) or ensure
the steps land on factors of 10 ('decimal'). This needs to be not false
if panning or zooming. If false, then the tick, grid and label values will
be from the start, stop and step properties. (false)
valuesnumber[] — custom values for labels, ticks and grid.
Only works for one level of ticks and grid, and doesn't not accomodate
zooming or panning.
CollectionsAxis options object that extends OBJ_Collection options object (without
parent).A zoom axis can be used to create a number line, used as an axis in COL_Plot and/or used to plot a COL_Trace against.
An axis is a line that may have
An axis is drawn to a
length. It will have values along its length fromstarttostop. Ticks, grid lines and labels are all drawn at axis value positions. All other dimensions, such as line lengths, widths, positions, spaces and offsets are defined in draw space, or in the same space as thelengthof the axis.axisx|y—'x'axes are horizontal,'y'axes are vertical ('x')lengthnumber— length of the axis in draw spacelineboolean| OBJ_AxisLineStyle — line style of the axis -falsewill draw no line. By default, a solid line will be drawn if not defined.startnumber— start value of axis (0)stopnumber— stop value of axis.stopmust be larger thanstart(start + 1)ticksboolean| TypeTickLocation | OBJ_AxisTicks |boolean | TypeTickLocation | OBJ_AxisTicks[] — tick options. Use an Array to setup multiple sets/styles of ticks. Use a boolean value to turn ticks on or off. Use a TypeTickLocation to only set tick location property (false)labelsstring|boolean| OBJ_AxisLabels |(params: OBJ_LabelsCallbackParams) => string[]— label options. Usefalseto turn labels off, or a string or function as a callback to define custom labels for a set of values. Use TypeLabelLocation to only set the label location property.gridboolean| OBJ_AxisTicks |boolean| OBJ_AxisTicks[] — grid options. Use an array for multiple sets of grids, and use a boolean to turn grids on and off (false)titlestring| OBJ_AxisTitle — axis titlefontOBJ_Font — default font of axis (used by title and labels)showboolean—falsehides the axis. Two axes are needed to plot an CollectionsTrace on a CollectionsPlot, but if either or both axes aren't to be drawn, then usefalseto hide each axis (true)minnumber|null— minimum value axis can be zoomed or panned to wherenullno limit (null)maxnumber|null— maximum value axis can be zoomed or panned to wherenullno limit (null)auto[number, number]— Will select automatic values forstart,stop, andstepthat cover the range [min, max]autoStepboolean|decimal— Iftruethen start, stop and step tick, grid and label values will be automatically calculated such that they land on 0 and either double/half the original step (true) or ensure the steps land on factors of 10 ('decimal'). This needs to be notfalseif panning or zooming. Iffalse, then the tick, grid and label values will be from thestart,stopandstepproperties. (false)valuesnumber[] — custom values for labels, ticks and grid. Only works for one level of ticks and grid, and doesn't not accomodate zooming or panning.positionTypeParsablePoint — axis position ([0, 0])