Axis Structure Reference


                    
                    
                    range

Sets the range of this axis.

Declaration

Swift

public var range: InfoArray?


                    
                    
                    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?


                    
                    
                    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?


                    
                    
                    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 color bar’s tick label 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?


                    
                    
                    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]?


                    
                    
                    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?


                    
                    
                    separateThousands

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

Declaration

Swift

public var separateThousands: Bool?


                    
                    
                    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?


                    
                    
                    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?


                    
                    
                    init(range:visible:tickMode:numTicks:tick0:dTick:tickValues:tickText:ticks:tickLength:tickWidth:tickColor:showTickLabels:tickFont:tickAngle:tickFormat:tickFormatStops:tickPrefix:showTickPrefix:tickSuffix:showTickSuffix:separateThousands:exponentFormat:minExponent:showExponent:)

Creates Axis object with specified properties.

Declaration

Swift

public init(range: InfoArray? = nil, visible: Bool? = nil, tickMode: TickMode? = nil, numTicks:
        Int? = nil, tick0: Anything? = nil, dTick: Anything? = nil, tickValues: [Double]? = nil,
        tickText: [Double]? = nil, ticks: Ticks? = nil, tickLength: Double? = nil, tickWidth: Double? =
        nil, tickColor: Color? = nil, showTickLabels: Bool? = nil, tickFont: Font? = nil, tickAngle:
        Angle? = nil, tickFormat: String? = nil, tickFormatStops: [TickFormatStop]? = nil, tickPrefix:
        String? = nil, showTickPrefix: ShowTickPrefix? = nil, tickSuffix: String? = nil, showTickSuffix:
        ShowTickSuffix? = nil, separateThousands: Bool? = nil, exponentFormat: ExponentFormat? = nil,
        minExponent: Double? = nil, showExponent: ShowExponent? = nil)

Parameters

`range`	Sets the range of this axis.
`visible`	A single toggle to hide the axis while preserving interaction like dragging.
`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.
`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 color bar’s tick label font
`tickAngle`	Sets the angle of the tick labels with respect to the horizontal.
`tickFormat`	Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python.
`tickFormatStops`
`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.
`separateThousands`	If “true”, even 4-digit integers are separated
`exponentFormat`	Determines a formatting rule for the tick exponents.
`minExponent`	Hide SI prefix for 10^n if \|n\| is below this number.
`showExponent`	If all, all exponents are shown besides their significands.