GradientMarker Structure Reference


                    
                    
                    symbol

Sets the marker symbol type.

Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

Declaration

Swift

public var symbol: Symbol?


                    
                    
                    opacity

Sets the marker opacity.

Declaration

Swift

public var opacity: Data<Double>?


                    
                    
                    size

Sets the marker size (in px).

Declaration

Swift

public var size: Data<Double>?


                    
                    
                    sizeReference

Has an effect only if marker.size is set to a numerical array.

Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

Declaration

Swift

public var sizeReference: Double?


                    
                    
                    sizeMin

Has an effect only if marker.size is set to a numerical array.

Sets the minimum size (in px) of the rendered marker points.

Declaration

Swift

public var sizeMin: Double?


                    
                    
                    sizeMode

Has an effect only if marker.size is set to a numerical array.

Sets the rule for which the data in size is converted to pixels.

Declaration

Swift

public var sizeMode: SizeMode?


                    
                    
                    colorBar

Undocumented

Declaration

Swift

public var colorBar: ColorBar?


                    
                    
                    line

Undocumented

Declaration

Swift

public var line: MarkerLine?


                    
                    
                    gradient

Undocumented

Declaration

Swift

public var gradient: Gradient?


                    
                    
                    coloring

Sets themarkercolor.

It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

Declaration

Swift

public var coloring: Coloring?


                    
                    
                    cAuto

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.coloris 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?


                    
                    
                    cMin

Sets the lower bound of the color domain.

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

Declaration

Swift

public var cMin: Double?


                    
                    
                    cMax

Sets the upper bound of the color domain.

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

Declaration

Swift

public var cMax: Double?


                    
                    
                    cMiddle

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 in marker.coloris set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

Declaration

Swift

public var cMiddle: Double?


                    
                    
                    colorScale

Sets the colorscale.

Has an effect only if in marker.coloris 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?


                    
                    
                    autoColorScale

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

Has an effect only if in marker.coloris 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?


                    
                    
                    reverseScale

Reverses the color mapping if true.

Has an effect only if in marker.coloris 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?


                    
                    
                    showScale

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

Has an effect only if in marker.coloris set to a numerical array.

Declaration

Swift

public var showScale: Bool?


                    
                    
                    colorAxis

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


                    
                    
                    init(symbol:opacity:size:sizeReference:sizeMin:sizeMode:colorBar:line:gradient:coloring:cAuto:cMin:cMax:cMiddle:colorScale:autoColorScale:reverseScale:showScale:colorAxis:)

Creates GradientMarker object with specified properties.

Declaration

Swift

public init(symbol: Symbol? = nil, opacity: Data<Double>? = nil, size: Data<Double>? = nil,
        sizeReference: Double? = nil, sizeMin: Double? = nil, sizeMode: SizeMode? = nil, colorBar:
        ColorBar? = nil, line: MarkerLine? = nil, gradient: Gradient? = nil, coloring: Coloring? = 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, colorAxis: ColorAxis = .preset)

Parameters

`symbol`	Sets the marker symbol type.
`opacity`	Sets the marker opacity.
`size`	Sets the marker size (in px).
`sizeReference`	Has an effect only if `marker.size` is set to a numerical array.
`sizeMin`	Has an effect only if `marker.size` is set to a numerical array.
`sizeMode`	Has an effect only if `marker.size` is set to a numerical array.
`colorBar`
`line`
`gradient`
`coloring`	Sets themarkercolor.
`cAuto`	Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is 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.
`colorAxis`	Sets a reference to a shared color axis.