Marker

public struct Marker : Encodable

Undocumented

  • Undocumented

    Declaration

    Swift

    public var padding: Padding?
  • Sets the color of each sector of this trace.

    If not specified, the default trace color set is used to pick the sector colors.

    Declaration

    Swift

    public var colors: [Double]?
  • Determines if the sector colors are faded towards the background from the leaves up to the headers.

    This option is unavailable when a colorscale is present, defaults to false when marker.colors is set, but otherwise defaults to true. When set to reversed, the fading direction is inverted, that is the top elements within hierarchy are drawn with fully saturated colors while the leaves are faded towards the background color.

    See more

    Declaration

    Swift

    public enum DepthFade : Encodable
  • Determines if the sector colors are faded towards the background from the leaves up to the headers.

    This option is unavailable when a colorscale is present, defaults to false when marker.colors is set, but otherwise defaults to true. When set to reversed, the fading direction is inverted, that is the top elements within hierarchy are drawn with fully saturated colors while the leaves are faded towards the background color.

    Declaration

    Swift

    public var depthFade: DepthFade?
  • Undocumented

    Declaration

    Swift

    public var line: VariableLine?
  • Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in marker.cmin and marker.cmax Has an effect only if colorsis set to a numerical array.

    Defaults to false when marker.cmin and marker.cmax are set by the user.

    Declaration

    Swift

    public var cAuto: Bool?
  • Sets the lower bound of the color domain.

    Has an effect only if colorsis set to a numerical array. Value should have the same units as colors and if set, marker.cmax must be set as well.

    Declaration

    Swift

    public var cMin: Double?
  • Sets the upper bound of the color domain.

    Has an effect only if colorsis set to a numerical array. Value should have the same units as colors and if set, marker.cmin must be set as well.

    Declaration

    Swift

    public var cMax: Double?
  • Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point.

    Has an effect only if colorsis set to a numerical array. Value should have the same units as colors. Has no effect when marker.cauto is false.

    Declaration

    Swift

    public var cMiddle: Double?
  • Sets the colorscale.

    Has an effect only if colorsis set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, usemarker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

    Declaration

    Swift

    public var colorScale: ColorScale?
  • Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale.

    Has an effect only if colorsis set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

    Declaration

    Swift

    public var autoColorScale: Bool?
  • Reverses the color mapping if true.

    Has an effect only if colorsis set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

    Declaration

    Swift

    public var reverseScale: Bool?
  • Determines whether or not a colorbar is displayed for this trace.

    Has an effect only if colorsis set to a numerical array.

    Declaration

    Swift

    public var showScale: Bool?
  • Undocumented

    Declaration

    Swift

    public var colorBar: ColorBar?
  • Sets a reference to a shared color axis.

    References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

    Declaration

    Swift

    public var colorAxis: ColorAxis
  • Creates Marker object with specified properties.

    Declaration

    Swift

    public init(padding: Padding? = nil, colors: [Double]? = nil, depthFade: DepthFade? = nil, line:
            VariableLine? = nil, cAuto: Bool? = nil, cMin: Double? = nil, cMax: Double? = nil, cMiddle:
            Double? = nil, colorScale: ColorScale? = nil, autoColorScale: Bool? = nil, reverseScale: Bool? =
            nil, showScale: Bool? = nil, colorBar: ColorBar? = nil, colorAxis: ColorAxis = .preset)

    Parameters

    padding

    colors

    Sets the color of each sector of this trace.

    depthFade

    Determines if the sector colors are faded towards the background from the leaves up to the headers.

    line

    cAuto

    Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in marker.cmin and marker.cmax Has an effect only if colorsis set to a numerical array.

    cMin

    Sets the lower bound of the color domain.

    cMax

    Sets the upper bound of the color domain.

    cMiddle

    Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point.

    colorScale

    Sets the colorscale.

    autoColorScale

    Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale.

    reverseScale

    Reverses the color mapping if true.

    showScale

    Determines whether or not a colorbar is displayed for this trace.

    colorBar

    colorAxis

    Sets a reference to a shared color axis.