MarkerLine
public struct MarkerLine : Encodable
Note
Used byGradientMarker.line
, Marker.line
, Histogram<XData, YData>.Marker.line
,
ScatterTernary<AData, BData, CData>.GradientMarker.line
, Funnel<XData, YData>.Marker.line
,
SymbolicMarker.line
, ScatterGeo<CoordinateData, LocationsData>.GradientMarker.line
,
ScatterGL<XData, YData>.SymbolicMarker.line
, ScatterPlotMatrix.SymbolicMarker.line
,
ScatterCarpet<AData, BData>.GradientMarker.line
, ScatterPolar<RData,
ThetaData>.GradientMarker.line
, ScatterPolarGL<RData, ThetaData>.SymbolicMarker.line
,
BarPolar<RData, ThetaData>.Marker.line
.
-
Sets the width (in px) of the lines bounding the marker points.
Declaration
Swift
public var width: Data<Double>?
-
Sets themarker.linecolor.
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.line.cmin
andmarker.line.cmax
if set.Declaration
Swift
public var coloring: Coloring?
-
Determines whether or not the color domain is computed with respect to the input data (here in
marker.line.color
) or the bounds set inmarker.line.cmin
andmarker.line.cmax
Has an effect only if inmarker.line.color
is set to a numerical array.Defaults to
false
whenmarker.line.cmin
andmarker.line.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 in
marker.line.color
is set to a numerical array. Value should have the same units as inmarker.line.color
and if set,marker.line.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 in
marker.line.color
is set to a numerical array. Value should have the same units as inmarker.line.color
and if set,marker.line.cmin
must be set as well.Declaration
Swift
public var cMax: Double?
-
Sets the mid-point of the color domain by scaling
marker.line.cmin
and/ormarker.line.cmax
to be equidistant to this point.Has an effect only if in
marker.line.color
is set to a numerical array. Value should have the same units as inmarker.line.color
. Has no effect whenmarker.line.cauto
isfalse
.Declaration
Swift
public var cMiddle: Double?
-
Sets the colorscale.
Has an effect only if in
marker.line.color
is 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.line.cmin
andmarker.line.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 bymarker.line.colorscale
.Has an effect only if in
marker.line.color
is set to a numerical array. In casecolorscale
is unspecified orautocolorscale
is true, the default palette will be chosen according to whether numbers in thecolor
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 in
marker.line.color
is set to a numerical array. If true,marker.line.cmin
will correspond to the last color in the array andmarker.line.cmax
will correspond to the first color.Declaration
Swift
public var reverseScale: Bool?
-
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
MarkerLine
object with specified properties.Declaration
Swift
public init(width: Data<Double>? = 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, colorAxis: ColorAxis = .preset)
Parameters
width
Sets the width (in px) of the lines bounding the marker points.
coloring
Sets themarker.linecolor.
cAuto
Determines whether or not the color domain is computed with respect to the input data (here in
marker.line.color
) or the bounds set inmarker.line.cmin
andmarker.line.cmax
Has an effect only if inmarker.line.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.line.cmin
and/ormarker.line.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 bymarker.line.colorscale
.reverseScale
Reverses the color mapping if true.
colorAxis
Sets a reference to a shared color axis.