Skip to content

Interface: TraceAxisHints ​

Experimental

What a cartesian trace asks of its axes, beyond holding its data (see CoreTraceModule.axisHints). Every field is a default: what the figure sets on an axis wins, and so does another trace that shows the axis. A trace in a 3D scene asks the same of its scene's three axes (hide: true, and x / y / z; a scene has its own aspectmode).

Properties ​

PropertyModifierTypeDescription
equal?readonlybooleanExperimental One unit is as long on y as on x (shapes keep their proportions): the y axis defaults to scaleanchor = the trace's x axis.
hide?readonlyboolean | "x" | "y"Experimental The axes carry no readable scale for this trace (positions a layout computed): each defaults to visible: false, unless a trace without this hint is on it. 'x' or 'y' hides that axis only (the other one is a real scale: a dendrogram's heights, the dates of a timeline).
reverse?readonly"x" | "y"Experimental That axis runs the other way (larger values to the left, or at the bottom): it defaults to autorange: 'reversed', unless a trace without this hint is on it or a range is given.
x?readonlyunknownExperimental The data the trace puts on its x and y axis when that is not its x / y attribute (positions inside a container): the axis type is detected from it, and a category axis lists its values. Unset: x / y are read as for every trace. z: the same for the z axis of a 3D scene.
y?readonlyunknownExperimental
z?readonlyunknownExperimental

Released under the MIT License.