TickFormatStop

public struct TickFormatStop : Encodable

Note

Used by XAxis.tickFormatStops, YAxis.tickFormatStops, Ternary.AAxis.tickFormatStops, Ternary.BAxis.tickFormatStops, Ternary.CAxis.tickFormatStops, Scene.XAxis.tickFormatStops, Scene.YAxis.tickFormatStops, Scene.ZAxis.tickFormatStops, Polar.RadialAxis.tickFormatStops, Polar.AngularAxis.tickFormatStops, ColorBar.tickFormatStops, GradientMarker.ColorBar.tickFormatStops, Marker.ColorBar.tickFormatStops, Heatmap<ZData, XYData>.ColorBar.tickFormatStops, Histogram<XData, YData>.Marker.ColorBar.tickFormatStops, Histogram2D<XData, YData, ZData>.ColorBar.tickFormatStops, Histogram2DContour<XData, YData, ZData>.ColorBar.tickFormatStops, Contour<ZData, XData, YData>.ColorBar.tickFormatStops, ScatterTernary<AData, BData, CData>.GradientMarker.ColorBar.tickFormatStops, Funnel<XData, YData>.Marker.ColorBar.tickFormatStops, Sunburst<ValuesData>.Marker.ColorBar.tickFormatStops, Treemap<ValuesData>.Marker.ColorBar.tickFormatStops, Scatter3D<XData, YData, ZData>.DashedMarkerLine.ColorBar.tickFormatStops, SymbolicMarker.ColorBar.tickFormatStops, Surface<ZSurfaceData, XYData>.ColorBar.tickFormatStops, Isosurface<XData, YData, ZData, ValueData>.ColorBar.tickFormatStops, Volume<XYZData, ValueData>.ColorBar.tickFormatStops, Mesh3D<XData, YData, ZData, IntensityData, VertexcolorData, FacecolorData>.ColorBar.tickFormatStops, Cone<XYZData, UVWData>.ColorBar.tickFormatStops, StreamTube<XYZData, UVWData>.ColorBar.tickFormatStops, ScatterGeo<CoordinateData, LocationsData>.GradientMarker.ColorBar.tickFormatStops, Choropleth<LocationsData, ZData>.ColorBar.tickFormatStops, ScatterGL<XData, YData>.SymbolicMarker.ColorBar.tickFormatStops, ScatterPlotMatrix.SymbolicMarker.ColorBar.tickFormatStops, HeatmapGL<ZData, XYData>.ColorBar.tickFormatStops, ParallelCoordinates.MarkerLine.ColorBar.tickFormatStops, ParallelCategories.ShapedMarkerLine.ColorBar.tickFormatStops, ScatterMapbox<CoordinateData>.SymbolicMarker.ColorBar.tickFormatStops, ChoroplethMapbox<LocationsData, ZData>.ColorBar.tickFormatStops, DensityMapbox<CoordinateData, ZData>.ColorBar.tickFormatStops, Indicator.Gauge.Axis.tickFormatStops, Carpet<XData, YData, AData, BData>.AAxis.tickFormatStops, Carpet<XData, YData, AData, BData>.BAxis.tickFormatStops, ScatterCarpet<AData, BData>.GradientMarker.ColorBar.tickFormatStops, ContourCarpet<ZData, AData, BData>.ColorBar.tickFormatStops, ScatterPolar<RData, ThetaData>.GradientMarker.ColorBar.tickFormatStops, ScatterPolarGL<RData, ThetaData>.SymbolicMarker.ColorBar.tickFormatStops, BarPolar<RData, ThetaData>.Marker.ColorBar.tickFormatStops.

  • Determines whether or not this stop is used.

    If false, this stop is ignored even within its dtickrange.

    Declaration

    Swift

    public var enabled: Bool?

  • range [min, max], where min, max - dtick values which describe some zoom level, it is possible to omit min or max value by passing null

    Declaration

    Swift

    public var dTickRange: InfoArray?

  • string - dtickformat for described zoom level, the same as tickformat

    Declaration

    Swift

    public var value: String?

  • When used in a template, named items are created in the output figure in addition to any items the figure already has in this array.

    You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

    Declaration

    Swift

    public var name: String?

  • Used to refer to a named item in this array in the template.

    Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

    Declaration

    Swift

    public var templateItemName: String?

  • Creates TickFormatStop object with specified properties.

    Declaration

    Swift

    public init(enabled: Bool? = nil, dTickRange: InfoArray? = nil, value: String? = nil, name:
        String? = nil, templateItemName: String? = nil)

    Parameters

    enabled

    Determines whether or not this stop is used.
    dTickRange

    range [min, max], where min, max - dtick values which describe some zoom level, it is possible to omit min or max value by passing null
    value

    string - dtickformat for described zoom level, the same as tickformat
    name

    When used in a template, named items are created in the output figure in addition to any items the figure already has in this array.
    templateItemName

    Used to refer to a named item in this array in the template.