BAxis

public struct BAxis : Encodable

Undocumented

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

  • Undocumented

    Declaration

    Swift

    public var smoothing: Double?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Title : Encodable

  • Undocumented

    Declaration

    Swift

    public var title: Title?

  • 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.

    See more

    Declaration

    Swift

    public enum Carpet<XData, YData, AData, BData>.BAxis.`Type` : String, Encodable

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

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

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

  • 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.

    Declaration

    Swift

    public var rangeMode: RangeMode?

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

  • Determines whether or not this axis is zoom-able.

    If true, then zoom is disabled.

    Declaration

    Swift

    public var fixedRange: Bool?

  • Undocumented

    See more

    Declaration

    Swift

    public enum CheaterType : String, Encodable

  • Undocumented

    Declaration

    Swift

    public var cheaterType: CheaterType?

  • Undocumented

    See more

    Declaration

    Swift

    public enum TickMode : String, Encodable

  • Undocumented

    Declaration

    Swift

    public var tickMode: TickMode?

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

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

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

  • Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.

    See more

    Declaration

    Swift

    public enum ShowTickLabels : String, Encodable

  • Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.

    Declaration

    Swift

    public var showTickLabels: ShowTickLabels?

  • Sets the tick font.

    Declaration

    Swift

    public var tickFont: Font?

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

  • Sets a tick label prefix.

    Declaration

    Swift

    public var tickPrefix: String?

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

  • Sets a tick label suffix.

    Declaration

    Swift

    public var tickSuffix: String?

  • Same as showtickprefix but for tick suffixes.

    Declaration

    Swift

    public var showTickSuffix: ShowTickSuffix?

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

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

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

    Declaration

    Swift

    public var minExponent: Double?

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

    Declaration

    Swift

    public var separateThousands: Bool?

  • 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: 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?

  • Undocumented

    Declaration

    Swift

    public var tickFormatStops: [TickFormatStop]?

  • 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.

    Declaration

    Swift

    public var categoryOrder: CarpetCategoryOrder?

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

  • Extra padding between label and the axis

    Declaration

    Swift

    public var labelPadding: Int?

  • Sets a axis label prefix.

    Declaration

    Swift

    public var labelPrefix: String?

  • Sets a axis label suffix.

    Declaration

    Swift

    public var labelSuffix: String?

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

    Declaration

    Swift

    public var showLine: Bool?

  • Sets the axis line color.

    Declaration

    Swift

    public var lineColor: Color?

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

    Declaration

    Swift

    public var lineWidth: Double?

  • Sets the axis line color.

    Declaration

    Swift

    public var gridColor: Color?

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

    Declaration

    Swift

    public var gridWidth: Double?

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

  • Sets the number of minor grid ticks per major grid tick

    Declaration

    Swift

    public var minorGridCount: Int?

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

    Declaration

    Swift

    public var minorGridWidth: Double?

  • Sets the color of the grid lines.

    Declaration

    Swift

    public var minorGridColor: Color?

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

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

    Declaration

    Swift

    public var startLine: Bool?

  • Sets the line color of the start line.

    Declaration

    Swift

    public var startLineColor: Color?

  • Sets the width (in px) of the start line.

    Declaration

    Swift

    public var startLineWidth: Double?

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

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

    Declaration

    Swift

    public var endLine: Bool?

  • Sets the width (in px) of the end line.

    Declaration

    Swift

    public var endLineWidth: Double?

  • Sets the line color of the end line.

    Declaration

    Swift

    public var endLineColor: Color?

  • The starting index of grid lines along the axis

    Declaration

    Swift

    public var tick0: Double?

  • The stride between grid lines along the axis

    Declaration

    Swift

    public var dTick: Double?

  • The starting index of grid lines along the axis

    Declaration

    Swift

    public var arrayTick0: Int?

  • The stride between grid lines along the axis

    Declaration

    Swift

    public var arraydTick: Int?

  • Creates BAxis object with specified properties.

    Declaration

    Swift

    public init(color: Color? = nil, smoothing: Double? = nil, title: Title? = nil, type: `Type`? =
        nil, autoTypeNumbers: AutoTypeNumbers? = nil, autoRange: AutoRange? = nil, rangeMode: RangeMode?
        = nil, range: InfoArray? = nil, fixedRange: Bool? = nil, cheaterType: CheaterType? = nil,
        tickMode: TickMode? = nil, numTicks: Int? = nil, tickValues: [Double]? = nil, tickText:
        [Double]? = nil, showTickLabels: ShowTickLabels? = 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, categoryOrder: CarpetCategoryOrder? =
        nil, categoryArray: [Double]? = nil, labelPadding: Int? = nil, labelPrefix: String? = nil,
        labelSuffix: String? = nil, showLine: Bool? = nil, lineColor: Color? = nil, lineWidth: Double? =
        nil, gridColor: Color? = nil, gridWidth: Double? = nil, showGrid: Bool? = nil, minorGridCount:
        Int? = nil, minorGridWidth: Double? = nil, minorGridColor: Color? = nil, startLine: Bool? = nil,
        startLineColor: Color? = nil, startLineWidth: Double? = nil, endLine: Bool? = nil, endLineWidth:
        Double? = nil, endLineColor: Color? = nil, tick0: Double? = nil, dTick: Double? = nil,
        arrayTick0: Int? = nil, arraydTick: Int? = nil)

    Parameters

    color

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

    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.
    fixedRange

    Determines whether or not this axis is zoom-able.
    cheaterType

    tickMode

    numTicks

    Specifies the maximum number of ticks for the particular axis.
    tickValues

    Sets the values at which ticks on this axis appear.
    tickText

    Sets the text displayed at the ticks position via tickvals.
    showTickLabels

    Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.
    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

    categoryOrder

    Specifies the ordering logic for the case of categorical variables.
    categoryArray

    Sets the order in which categories on this axis appear.
    labelPadding

    Extra padding between label and the axis
    labelPrefix

    Sets a axis label prefix.
    labelSuffix

    Sets a axis label suffix.
    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.
    gridColor

    Sets the axis line color.
    gridWidth

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

    Determines whether or not grid lines are drawn.
    minorGridCount

    Sets the number of minor grid ticks per major grid tick
    minorGridWidth

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

    Sets the color of the grid lines.
    startLine

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

    Sets the line color of the start line.
    startLineWidth

    Sets the width (in px) of the start line.
    endLine

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

    Sets the width (in px) of the end line.
    endLineColor

    Sets the line color of the end line.
    tick0

    The starting index of grid lines along the axis
    dTick

    The stride between grid lines along the axis
    arrayTick0

    The starting index of grid lines along the axis
    arraydTick

    The stride between grid lines along the axis