ColorBar

public struct ColorBar : Encodable

Note

Used by ColorAxis.colorBar, GradientMarker.colorBar, Marker.colorBar, Heatmap<ZData, XYData>.colorBar, Histogram<XData, YData>.Marker.colorBar, Histogram2D<XData, YData, ZData>.colorBar, Histogram2DContour<XData, YData, ZData>.colorBar, Contour<ZData, XData, YData>.colorBar, ScatterTernary<AData, BData, CData>.GradientMarker.colorBar, Funnel<XData, YData>.Marker.colorBar, Sunburst<ValuesData>.Marker.colorBar, Treemap<ValuesData>.Marker.colorBar, Scatter3D<XData, YData, ZData>.DashedMarkerLine.colorBar, SymbolicMarker.colorBar, Surface<ZSurfaceData, XYData>.colorBar, Isosurface<XData, YData, ZData, ValueData>.colorBar, Volume<XYZData, ValueData>.colorBar, Mesh3D<XData, YData, ZData, IntensityData, VertexcolorData, FacecolorData>.colorBar, Cone<XYZData, UVWData>.colorBar, StreamTube<XYZData, UVWData>.colorBar, ScatterGeo<CoordinateData, LocationsData>.GradientMarker.colorBar, Choropleth<LocationsData, ZData>.colorBar, ScatterGL<XData, YData>.SymbolicMarker.colorBar, ScatterPlotMatrix.SymbolicMarker.colorBar, HeatmapGL<ZData, XYData>.colorBar, ParallelCoordinates.MarkerLine.colorBar, ParallelCategories.ShapedMarkerLine.colorBar, ScatterMapbox<CoordinateData>.SymbolicMarker.colorBar, ChoroplethMapbox<LocationsData, ZData>.colorBar, DensityMapbox<CoordinateData, ZData>.colorBar, ScatterCarpet<AData, BData>.GradientMarker.colorBar, ContourCarpet<ZData, AData, BData>.colorBar, ScatterPolar<RData, ThetaData>.GradientMarker.colorBar, ScatterPolarGL<RData, ThetaData>.SymbolicMarker.colorBar, BarPolar<RData, ThetaData>.Marker.colorBar.

  • Determines whether this color bar’s thickness (i.e.

    the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

    Declaration

    Swift

    public var thicknessMode: ThicknessMode?

  • Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

    Declaration

    Swift

    public var thickness: Double?

  • Determines whether this color bar’s length (i.e.

    the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

    Declaration

    Swift

    public var lengthMode: LengthMode?

  • Sets the length of the color bar This measure excludes the padding of both ends.

    That is, the color bar length is this length minus the padding on both ends.

    Declaration

    Swift

    public var length: Double?
  • x

    Sets the x position of the color bar (in plot fraction).

    Declaration

    Swift

    public var x: Double?

  • Sets this color bar’s horizontal position anchor.

    This anchor binds the x position to the left, center or right of the color bar.

    Declaration

    Swift

    public var xAnchor: XAnchor?

  • Sets the amount of padding (in px) along the x direction.

    Declaration

    Swift

    public var xPadding: Double?
  • y

    Sets the y position of the color bar (in plot fraction).

    Declaration

    Swift

    public var y: Double?

  • Sets this color bar’s vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar.

    Declaration

    Swift

    public var yAnchor: YAnchor?

  • Sets the amount of padding (in px) along the y direction.

    Declaration

    Swift

    public var yPading: Double?

  • Sets the axis line color.

    Declaration

    Swift

    public var outlineColor: Color?

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

    Declaration

    Swift

    public var outlineWidth: Double?

  • Sets the axis line color.

    Declaration

    Swift

    public var borderColor: Color?

  • Sets the width (in px) or the border enclosing this color bar.

    Declaration

    Swift

    public var borderWidth: Double?

  • Sets the color of padded area.

    Declaration

    Swift

    public var backgroundColor: Color?

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

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

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

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

  • Determines where tick labels are drawn.

    Declaration

    Swift

    public var tickLabelPosition: TickLabelPosition?

  • Sets the tick length (in px).

    Declaration

    Swift

    public var tickLength: Double?

  • Sets the tick width (in px).

    Declaration

    Swift

    public var tickWidth: Double?

  • Sets the tick color.

    Declaration

    Swift

    public var tickColor: Color?

  • Determines whether or not the tick labels are drawn.

    Declaration

    Swift

    public var showTickLabels: Bool?

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

  • Undocumented

    Declaration

    Swift

    public var tickFormatStops: [TickFormatStop]?

  • 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 “true”, even 4-digit integers are separated

    Declaration

    Swift

    public var separateThousands: Bool?

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

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

    Declaration

    Swift

    public var minExponent: Double?

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

  • Undocumented

    Declaration

    Swift

    public var title: LegendTitle?

  • Creates ColorBar object with specified properties.

    Declaration

    Swift

    public init(thicknessMode: ThicknessMode? = nil, thickness: Double? = nil, lengthMode:
        LengthMode? = nil, length: Double? = nil, x: Double? = nil, xAnchor: XAnchor? = nil, xPadding:
        Double? = nil, y: Double? = nil, yAnchor: YAnchor? = nil, yPading: Double? = nil, outlineColor:
        Color? = nil, outlineWidth: Double? = nil, borderColor: Color? = nil, borderWidth: Double? =
        nil, backgroundColor: Color? = nil, tickMode: TickMode? = nil, numTicks: Int? = nil, tick0:
        Anything? = nil, dTick: Anything? = nil, tickValues: [Double]? = nil, tickText: [Double]? = nil,
        ticks: Ticks? = nil, tickLabelPosition: TickLabelPosition? = 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, title:
        LegendTitle? = nil)

    Parameters

    thicknessMode

    Determines whether this color bar’s thickness (i.e.
    thickness

    Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    lengthMode

    Determines whether this color bar’s length (i.e.
    length

    Sets the length of the color bar This measure excludes the padding of both ends.
    x

    Sets the x position of the color bar (in plot fraction).
    xAnchor

    Sets this color bar’s horizontal position anchor.
    xPadding

    Sets the amount of padding (in px) along the x direction.
    y

    Sets the y position of the color bar (in plot fraction).
    yAnchor

    Sets this color bar’s vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar.
    yPading

    Sets the amount of padding (in px) along the y direction.
    outlineColor

    Sets the axis line color.
    outlineWidth

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

    Sets the axis line color.
    borderWidth

    Sets the width (in px) or the border enclosing this color bar.
    backgroundColor

    Sets the color of padded area.
    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.
    tickLabelPosition

    Determines where tick labels are drawn.
    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.
    title