ZAxis Structure Reference


                    
                    
                    visible

A single toggle to hide the axis while preserving interaction like dragging.

Default is true when a cheater plot is present on the axis, otherwise false

Declaration

Swift

public var visible: Bool?


                    
                    
                    showSpikes

Sets whether or not spikes starting from data points to this axis’ wall are shown on hover.

Declaration

Swift

public var showSpikes: Bool?


                    
                    
                    spikeSides

Sets whether or not spikes extending from the projection data points to this axis’ wall boundaries are shown on hover.

Declaration

Swift

public var spikeSides: Bool?


                    
                    
                    spikeThickness

Sets the thickness (in px) of the spikes.

Declaration

Swift

public var spikeThickness: Double?


                    
                    
                    spikeColor

Sets the color of the spikes.

Declaration

Swift

public var spikeColor: Color?


                    
                    
                    showBackground

Sets whether or not this axis’ wall has a background color.

Declaration

Swift

public var showBackground: Bool?


                    
                    
                    backgroundColor

Sets the background color of this axis’ wall.

Declaration

Swift

public var backgroundColor: Color?


                    
                    
                    showAxesLabels

Sets whether or not this axis is labeled

Declaration

Swift

public var showAxesLabels: Bool?


                    
                    
                    color

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors.

Grid color is lightened by blending this with the plot background Individual pieces can override this.

Declaration

Swift

public var color: Color?


                    
                    
                    categoryOrder

Specifies the ordering logic for the case of categorical variables.

By default, plotly uses trace, which specifies the order that is present in the data supplied. Set categoryorder to category ascending or category descending if order should be determined by the alphanumerical order of the category names. Set categoryorder to array to derive the ordering from the attribute categoryarray. If a category is not found in the categoryarray array, the sorting behavior for that attribute will be identical to the trace mode. The unspecified categories will follow the categories in categoryarray. Set categoryorder to total ascending or total descending if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

Declaration

Swift

public var categoryOrder: CategoryOrder?


                    
                    
                    categoryArray

Sets the order in which categories on this axis appear.

Only has an effect if categoryorder is set to array. Used with categoryorder.

Declaration

Swift

public var categoryArray: [Double]?


                    
                    
                    title

Undocumented

Declaration

Swift

public var title: Title?


                    
                    
                    Type

Sets the axis type.

By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

Declaration

Swift

public enum Scene.ZAxis.`Type` : String, Encodable


                    
                    
                    type

Sets the axis type.

By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

Declaration

Swift

public var type: Type?


                    
                    
                    autoTypeNumbers

Using strict a numeric string in trace data is not converted to a number.

Using convert types a numeric string in trace data may be treated as a number during automatic axis type detection. Defaults to layout.autotypenumbers.

Declaration

Swift

public var autoTypeNumbers: AutoTypeNumbers?


                    
                    
                    autoRange

Determines whether or not the range of this axis is computed in relation to the input data.

See rangemode for more info. If range is provided, then autorange is set to false.

Declaration

Swift

public var autoRange: AutoRange?


                    
                    
                    rangeMode

If normal, the range is computed in relation to the extrema of the input data.

If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

Declaration

Swift

public var rangeMode: RangeMode?


                    
                    
                    range

Sets the range of this axis.

If the axis type is log, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis type is date, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is category, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

Declaration

Swift

public var range: InfoArray?


                    
                    
                    tickMode

Sets the tick mode for this axis.

If auto, the number of ticks is set via nticks. If linear, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (linear is the default value if tick0 and dtick are provided). If array, the placement of the ticks is set via tickvals and the tick text is ticktext. (array is the default value if tickvals is provided).

Declaration

Swift

public var tickMode: TickMode?


                    
                    
                    numTicks

Specifies the maximum number of ticks for the particular axis.

The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to auto.

Declaration

Swift

public var numTicks: Int?


                    
                    
                    tick0

Sets the placement of the first tick on this axis.

Use with dtick. If the axis type is log, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick=L (see dtick for more info). If the axis type is date, it should be a date string, like date data. If the axis type is category, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

Declaration

Swift

public var tick0: Anything?


                    
                    
                    dTick

Sets the step in-between ticks on this axis.

Use with tick0. Must be a positive number, or special strings available to log and date axes. If the axis type is log, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. log has several special values; L, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = L0.5 will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use D1 (all digits) or D2 (only 2 and 5). tick0 is ignored for D1 and D2. If the axis type is date, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. date also has special values M gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to 2000-01-15 and dtick to M3. To set ticks every 4 years, set dtick to M48

Declaration

Swift

public var dTick: Anything?


                    
                    
                    tickValues

Sets the values at which ticks on this axis appear.

Only has an effect if tickmode is set to array. Used with ticktext.

Declaration

Swift

public var tickValues: [Double]?


                    
                    
                    tickText

Sets the text displayed at the ticks position via tickvals.

Only has an effect if tickmode is set to array. Used with tickvals.

Declaration

Swift

public var tickText: [Double]?


                    
                    
                    ticks

Determines whether ticks are drawn or not.

If *, this axis’ ticks are not drawn. If *outside (inside), this axis’ are drawn outside (inside) the axis lines.

Declaration

Swift

public var ticks: Ticks?


                    
                    
                    mirror

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area.

If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

Declaration

Swift

public var mirror: Mirror?


                    
                    
                    tickLength

Sets the tick length (in px).

Declaration

Swift

public var tickLength: Double?


                    
                    
                    tickWidth

Sets the tick width (in px).

Declaration

Swift

public var tickWidth: Double?


                    
                    
                    tickColor

Sets the tick color.

Declaration

Swift

public var tickColor: Color?


                    
                    
                    showTickLabels

Determines whether or not the tick labels are drawn.

Declaration

Swift

public var showTickLabels: Bool?


                    
                    
                    tickFont

Sets the tick font.

Declaration

Swift

public var tickFont: Font?


                    
                    
                    tickAngle

Sets the angle of the tick labels with respect to the horizontal.

For example, a tickangle of -90 draws the tick labels vertically.

Declaration

Swift

public var tickAngle: Angle?


                    
                    
                    tickPrefix

Sets a tick label prefix.

Declaration

Swift

public var tickPrefix: String?


                    
                    
                    showTickPrefix

If all, all tick labels are displayed with a prefix.

If first, only the first tick is displayed with a prefix. If last, only the last tick is displayed with a suffix. If none, tick prefixes are hidden.

Declaration

Swift

public var showTickPrefix: ShowTickPrefix?


                    
                    
                    tickSuffix

Sets a tick label suffix.

Declaration

Swift

public var tickSuffix: String?


                    
                    
                    showTickSuffix

Same as showtickprefix but for tick suffixes.

Declaration

Swift

public var showTickSuffix: ShowTickSuffix?


                    
                    
                    showExponent

If all, all exponents are shown besides their significands.

If first, only the exponent of the first tick is shown. If last, only the exponent of the last tick is shown. If none, no exponents appear.

Declaration

Swift

public var showExponent: ShowExponent?


                    
                    
                    exponentFormat

Determines a formatting rule for the tick exponents.

For example, consider the number 1,000,000,000. If none, it appears as 1,000,000,000. If e, 1e+9. If E, 1E+9. If power, 1x10^9 (with 9 in a super script). If SI, 1G. If B, 1B.

Declaration

Swift

public var exponentFormat: ExponentFormat?


                    
                    
                    minExponent

Hide SI prefix for 10^n if |n| is below this number.

This only has an effect when tickformat is SI or B.

Declaration

Swift

public var minExponent: Double?


                    
                    
                    separateThousands

If “true”, even 4-digit integers are separated

Declaration

Swift

public var separateThousands: Bool?


                    
                    
                    tickFormat

Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python.

For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time-format#locale_format We add one item to d3’s date formatter: %{n}f for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat %H~%M~%S.%2f would display 09~15~23.46

Declaration

Swift

public var tickFormat: String?


                    
                    
                    tickFormatStops

Undocumented

Declaration

Swift

public var tickFormatStops: [TickFormatStop]?


                    
                    
                    hoverFormat

Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python.

For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time-format#locale_format We add one item to d3’s date formatter: %{n}f for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat %H~%M~%S.%2f would display 09~15~23.46

Declaration

Swift

public var hoverFormat: String?


                    
                    
                    showLine

Determines whether or not a line bounding this axis is drawn.

Declaration

Swift

public var showLine: Bool?


                    
                    
                    lineColor

Sets the axis line color.

Declaration

Swift

public var lineColor: Color?


                    
                    
                    lineWidth

Sets the width (in px) of the axis line.

Declaration

Swift

public var lineWidth: Double?


                    
                    
                    showGrid

Determines whether or not grid lines are drawn.

If true, the grid lines are drawn at every tick mark.

Declaration

Swift

public var showGrid: Bool?


                    
                    
                    gridColor

Sets the color of the grid lines.

Declaration

Swift

public var gridColor: Color?


                    
                    
                    gridWidth

Sets the width (in px) of the grid lines.

Declaration

Swift

public var gridWidth: Double?


                    
                    
                    zeroLine

Determines whether or not a line is drawn at along the 0 value of this axis.

If true, the zero line is drawn on top of the grid lines.

Declaration

Swift

public var zeroLine: Bool?


                    
                    
                    zeroLineColor

Sets the line color of the zero line.

Declaration

Swift

public var zeroLineColor: Color?


                    
                    
                    zeroLineWidth

Sets the width (in px) of the zero line.

Declaration

Swift

public var zeroLineWidth: Double?


                    
                    
                    calendar

Sets the calendar system to use for range and tick0 if this is a date axis.

This does not set the calendar for interpreting data on this axis, that’s specified in the trace or via the global layout.calendar

Declaration

Swift

public var calendar: Calendar?


                    
                    
                    init(visible:showSpikes:spikeSides:spikeThickness:spikeColor:showBackground:backgroundColor:showAxesLabels:color:categoryOrder:categoryArray:title:type:autoTypeNumbers:autoRange:rangeMode:range:tickMode:numTicks:tick0:dTick:tickValues:tickText:ticks:mirror:tickLength:tickWidth:tickColor:showTickLabels:tickFont:tickAngle:tickPrefix:showTickPrefix:tickSuffix:showTickSuffix:showExponent:exponentFormat:minExponent:separateThousands:tickFormat:tickFormatStops:hoverFormat:showLine:lineColor:lineWidth:showGrid:gridColor:gridWidth:zeroLine:zeroLineColor:zeroLineWidth:calendar:)

Creates ZAxis object with specified properties.

Declaration

Swift

public init(visible: Bool? = nil, showSpikes: Bool? = nil, spikeSides: Bool? = nil,
        spikeThickness: Double? = nil, spikeColor: Color? = nil, showBackground: Bool? = nil,
        backgroundColor: Color? = nil, showAxesLabels: Bool? = nil, color: Color? = nil, categoryOrder:
        CategoryOrder? = nil, categoryArray: [Double]? = nil, title: Title? = nil, type: `Type`? = nil,
        autoTypeNumbers: AutoTypeNumbers? = nil, autoRange: AutoRange? = nil, rangeMode: RangeMode? =
        nil, range: InfoArray? = nil, tickMode: TickMode? = nil, numTicks: Int? = nil, tick0: Anything?
        = nil, dTick: Anything? = nil, tickValues: [Double]? = nil, tickText: [Double]? = nil, ticks:
        Ticks? = nil, mirror: Mirror? = nil, tickLength: Double? = nil, tickWidth: Double? = nil,
        tickColor: Color? = nil, showTickLabels: Bool? = nil, tickFont: Font? = nil, tickAngle: Angle? =
        nil, tickPrefix: String? = nil, showTickPrefix: ShowTickPrefix? = nil, tickSuffix: String? =
        nil, showTickSuffix: ShowTickSuffix? = nil, showExponent: ShowExponent? = nil, exponentFormat:
        ExponentFormat? = nil, minExponent: Double? = nil, separateThousands: Bool? = nil, tickFormat:
        String? = nil, tickFormatStops: [TickFormatStop]? = nil, hoverFormat: String? = nil, showLine:
        Bool? = nil, lineColor: Color? = nil, lineWidth: Double? = nil, showGrid: Bool? = nil,
        gridColor: Color? = nil, gridWidth: Double? = nil, zeroLine: Bool? = nil, zeroLineColor: Color?
        = nil, zeroLineWidth: Double? = nil, calendar: Calendar? = nil)

Parameters

`visible`	A single toggle to hide the axis while preserving interaction like dragging.
`showSpikes`	Sets whether or not spikes starting from data points to this axis’ wall are shown on hover.
`spikeSides`	Sets whether or not spikes extending from the projection data points to this axis’ wall boundaries are shown on hover.
`spikeThickness`	Sets the thickness (in px) of the spikes.
`spikeColor`	Sets the color of the spikes.
`showBackground`	Sets whether or not this axis’ wall has a background color.
`backgroundColor`	Sets the background color of this axis’ wall.
`showAxesLabels`	Sets whether or not this axis is labeled
`color`	Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors.
`categoryOrder`	Specifies the ordering logic for the case of categorical variables.
`categoryArray`	Sets the order in which categories on this axis appear.
`title`
`type`	Sets the axis type.
`autoTypeNumbers`	Using strict a numeric string in trace data is not converted to a number.
`autoRange`	Determines whether or not the range of this axis is computed in relation to the input data.
`rangeMode`	If normal, the range is computed in relation to the extrema of the input data.
`range`	Sets the range of this axis.
`tickMode`	Sets the tick mode for this axis.
`numTicks`	Specifies the maximum number of ticks for the particular axis.
`tick0`	Sets the placement of the first tick on this axis.
`dTick`	Sets the step in-between ticks on this axis.
`tickValues`	Sets the values at which ticks on this axis appear.
`tickText`	Sets the text displayed at the ticks position via `tickvals`.
`ticks`	Determines whether ticks are drawn or not.
`mirror`	Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area.
`tickLength`	Sets the tick length (in px).
`tickWidth`	Sets the tick width (in px).
`tickColor`	Sets the tick color.
`showTickLabels`	Determines whether or not the tick labels are drawn.
`tickFont`	Sets the tick font.
`tickAngle`	Sets the angle of the tick labels with respect to the horizontal.
`tickPrefix`	Sets a tick label prefix.
`showTickPrefix`	If all, all tick labels are displayed with a prefix.
`tickSuffix`	Sets a tick label suffix.
`showTickSuffix`	Same as `showtickprefix` but for tick suffixes.
`showExponent`	If all, all exponents are shown besides their significands.
`exponentFormat`	Determines a formatting rule for the tick exponents.
`minExponent`	Hide SI prefix for 10^n if \|n\| is below this number.
`separateThousands`	If “true”, even 4-digit integers are separated
`tickFormat`	Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python.
`tickFormatStops`
`hoverFormat`	Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python.
`showLine`	Determines whether or not a line bounding this axis is drawn.
`lineColor`	Sets the axis line color.
`lineWidth`	Sets the width (in px) of the axis line.
`showGrid`	Determines whether or not grid lines are drawn.
`gridColor`	Sets the color of the grid lines.
`gridWidth`	Sets the width (in px) of the grid lines.
`zeroLine`	Determines whether or not a line is drawn at along the 0 value of this axis.
`zeroLineColor`	Sets the line color of the zero line.
`zeroLineWidth`	Sets the width (in px) of the zero line.
`calendar`	Sets the calendar system to use for `range` and `tick0` if this is a date axis.