Marker Type

The marker object determines the style of the markers representing datums in various types of plots.

Constructors

Constructor Description

Marker()

Full Usage: Marker()

Returns: Marker
Returns: Marker

Static members

Static member Description

Marker.init (?Angle, ?AngleRef, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?Colors, ?ColorAxis, ?ColorBar, ?Colorscale, ?CornerRadius, ?Gradient, ?Outline, ?MaxDisplayed, ?Opacity, ?MultiOpacity, ?Pattern, ?ReverseScale, ?ShowScale, ?Size, ?MultiSize, ?SizeMin, ?SizeMode, ?SizeRef, ?StandOff, ?MultiStandOff, ?Symbol, ?MultiSymbol, ?Symbol3D, ?MultiSymbol3D, ?OutlierColor, ?OutlierWidth)

Full Usage: Marker.init (?Angle, ?AngleRef, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?Colors, ?ColorAxis, ?ColorBar, ?Colorscale, ?CornerRadius, ?Gradient, ?Outline, ?MaxDisplayed, ?Opacity, ?MultiOpacity, ?Pattern, ?ReverseScale, ?ShowScale, ?Size, ?MultiSize, ?SizeMin, ?SizeMode, ?SizeRef, ?StandOff, ?MultiStandOff, ?Symbol, ?MultiSymbol, ?Symbol3D, ?MultiSymbol3D, ?OutlierColor, ?OutlierWidth)

Parameters:
    ?Angle : float - Sets the marker angle in respect to `angleref`.
    ?AngleRef : AngleRef - Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.
    ?AutoColorScale : bool - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is 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.
    ?CAuto : bool - 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. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
    ?CMax : float - Sets the upper bound of the color domain. Has an effect only if in `marker.color`is 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.
    ?CMid : float - 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.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
    ?CMin : float - Sets the lower bound of the color domain. Has an effect only if in `marker.color`is 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.
    ?Color : Color - Sets the marker color. 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.
    ?Colors : seq<Color> - Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
    ?ColorAxis : SubPlotId - 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.
    ?ColorBar : ColorBar - Sets the marker's color bar.
    ?Colorscale : Colorscale - Sets the colorscale. Has an effect only if colors 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, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
    ?CornerRadius : int - Sets the maximum rounding of corners (in px).
    ?Gradient : Gradient - Sets the marker's gradient
    ?Outline : Line - Sets the marker's outline.
    ?MaxDisplayed : int - Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.
    ?Opacity : float - Sets the marker opacity.
    ?MultiOpacity : seq<float> - Sets the individual marker opacity.
    ?Pattern : Pattern - Sets the pattern within the marker.
    ?ReverseScale : bool - Reverses the color mapping if true. Has an effect only if in `marker.color`is 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.
    ?ShowScale : bool - Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    ?Size : int - Sets the marker's size.
    ?MultiSize : seq<int> - Sets the individual marker's size.
    ?SizeMin : int - Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    ?SizeMode : MarkerSizeMode - 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.
    ?SizeRef : int - 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`.
    ?StandOff : float - Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.
    ?MultiStandOff : seq<float> - Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.
    ?Symbol : MarkerSymbol - Sets the marker symbol.
    ?MultiSymbol : seq<MarkerSymbol> - Sets the individual marker symbols.
    ?Symbol3D : MarkerSymbol3D - Sets the marker symbol for 3d traces.
    ?MultiSymbol3D : seq<MarkerSymbol3D> - Sets the individual marker symbols for 3d traces.
    ?OutlierColor : Color - Sets the color of the outlier sample points.
    ?OutlierWidth : int - Sets the width of the outlier sample points.

Returns: Marker

Returns a new Marker object with the given styling.

?Angle : float

Sets the marker angle in respect to `angleref`.

?AngleRef : AngleRef

Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.

?AutoColorScale : bool

Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is 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.

?CAuto : bool

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. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.

?CMax : float

Sets the upper bound of the color domain. Has an effect only if in `marker.color`is 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.

?CMid : float

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

?CMin : float

Sets the lower bound of the color domain. Has an effect only if in `marker.color`is 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.

?Color : Color

Sets the marker color. 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.

?Colors : seq<Color>

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

?ColorAxis : SubPlotId

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.

?ColorBar : ColorBar

Sets the marker's color bar.

?Colorscale : Colorscale

Sets the colorscale. Has an effect only if colors 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, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

?CornerRadius : int

Sets the maximum rounding of corners (in px).

?Gradient : Gradient

Sets the marker's gradient

?Outline : Line

Sets the marker's outline.

?MaxDisplayed : int

Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.

?Opacity : float

Sets the marker opacity.

?MultiOpacity : seq<float>

Sets the individual marker opacity.

?Pattern : Pattern

Sets the pattern within the marker.

?ReverseScale : bool

Reverses the color mapping if true. Has an effect only if in `marker.color`is 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.

?ShowScale : bool

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

?Size : int

Sets the marker's size.

?MultiSize : seq<int>

Sets the individual marker's size.

?SizeMin : int

Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

?SizeMode : MarkerSizeMode

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.

?SizeRef : int

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

?StandOff : float

Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

?MultiStandOff : seq<float>

Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

?Symbol : MarkerSymbol

Sets the marker symbol.

?MultiSymbol : seq<MarkerSymbol>

Sets the individual marker symbols.

?Symbol3D : MarkerSymbol3D

Sets the marker symbol for 3d traces.

?MultiSymbol3D : seq<MarkerSymbol3D>

Sets the individual marker symbols for 3d traces.

?OutlierColor : Color

Sets the color of the outlier sample points.

?OutlierWidth : int

Sets the width of the outlier sample points.

Returns: Marker

Marker.style (?Angle, ?AngleRef, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?Colors, ?ColorAxis, ?ColorBar, ?Colorscale, ?CornerRadius, ?Gradient, ?Outline, ?MaxDisplayed, ?Opacity, ?MultiOpacity, ?Pattern, ?ReverseScale, ?ShowScale, ?Size, ?MultiSize, ?SizeMin, ?SizeMode, ?SizeRef, ?StandOff, ?MultiStandOff, ?Symbol, ?MultiSymbol, ?Symbol3D, ?MultiSymbol3D, ?OutlierColor, ?OutlierWidth)

Full Usage: Marker.style (?Angle, ?AngleRef, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?Colors, ?ColorAxis, ?ColorBar, ?Colorscale, ?CornerRadius, ?Gradient, ?Outline, ?MaxDisplayed, ?Opacity, ?MultiOpacity, ?Pattern, ?ReverseScale, ?ShowScale, ?Size, ?MultiSize, ?SizeMin, ?SizeMode, ?SizeRef, ?StandOff, ?MultiStandOff, ?Symbol, ?MultiSymbol, ?Symbol3D, ?MultiSymbol3D, ?OutlierColor, ?OutlierWidth)

Parameters:
    ?Angle : float - Sets the marker angle in respect to `angleref`.
    ?AngleRef : AngleRef - Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.
    ?AutoColorScale : bool - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is 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.
    ?CAuto : bool - 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. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
    ?CMax : float - Sets the upper bound of the color domain. Has an effect only if in `marker.color`is 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.
    ?CMid : float - 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.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
    ?CMin : float - Sets the lower bound of the color domain. Has an effect only if in `marker.color`is 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.
    ?Color : Color - Sets the marker color. 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.
    ?Colors : seq<Color> - Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
    ?ColorAxis : SubPlotId - 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.
    ?ColorBar : ColorBar - Sets the marker's color bar.
    ?Colorscale : Colorscale - Sets the colorscale. Has an effect only if colors 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, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
    ?CornerRadius : int - Sets the maximum rounding of corners (in px).
    ?Gradient : Gradient - Sets the marker's gradient
    ?Outline : Line - Sets the marker's outline.
    ?MaxDisplayed : int - Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.
    ?Opacity : float - Sets the marker opacity.
    ?MultiOpacity : seq<float> - Sets the individual marker opacity.
    ?Pattern : Pattern - Sets the pattern within the marker.
    ?ReverseScale : bool - Reverses the color mapping if true. Has an effect only if in `marker.color`is 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.
    ?ShowScale : bool - Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    ?Size : int - Sets the marker's size.
    ?MultiSize : seq<int> - Sets the individual marker's size.
    ?SizeMin : int - Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    ?SizeMode : MarkerSizeMode - 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.
    ?SizeRef : int - 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`.
    ?StandOff : float - Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.
    ?MultiStandOff : seq<float> - Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.
    ?Symbol : MarkerSymbol - Sets the marker symbol.
    ?MultiSymbol : seq<MarkerSymbol> - Sets the individual marker symbols.
    ?Symbol3D : MarkerSymbol3D - Sets the marker symbol for 3d traces.
    ?MultiSymbol3D : seq<MarkerSymbol3D> - Sets the individual marker symbols for 3d traces.
    ?OutlierColor : Color - Sets the color of the outlier sample points.
    ?OutlierWidth : int - Sets the width of the outlier sample points.

Returns: Marker -> Marker

Returns a function that applies the given styles to a Marker object.

?Angle : float

Sets the marker angle in respect to `angleref`.

?AngleRef : AngleRef

Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.

?AutoColorScale : bool

Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is 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.

?CAuto : bool

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. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.

?CMax : float

Sets the upper bound of the color domain. Has an effect only if in `marker.color`is 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.

?CMid : float

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

?CMin : float

Sets the lower bound of the color domain. Has an effect only if in `marker.color`is 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.

?Color : Color

Sets the marker color. 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.

?Colors : seq<Color>

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

?ColorAxis : SubPlotId

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.

?ColorBar : ColorBar

Sets the marker's color bar.

?Colorscale : Colorscale

Sets the colorscale. Has an effect only if colors 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, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

?CornerRadius : int

Sets the maximum rounding of corners (in px).

?Gradient : Gradient

Sets the marker's gradient

?Outline : Line

Sets the marker's outline.

?MaxDisplayed : int

Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.

?Opacity : float

Sets the marker opacity.

?MultiOpacity : seq<float>

Sets the individual marker opacity.

?Pattern : Pattern

Sets the pattern within the marker.

?ReverseScale : bool

Reverses the color mapping if true. Has an effect only if in `marker.color`is 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.

?ShowScale : bool

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

?Size : int

Sets the marker's size.

?MultiSize : seq<int>

Sets the individual marker's size.

?SizeMin : int

Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

?SizeMode : MarkerSizeMode

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.

?SizeRef : int

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

?StandOff : float

Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

?MultiStandOff : seq<float>

Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

?Symbol : MarkerSymbol

Sets the marker symbol.

?MultiSymbol : seq<MarkerSymbol>

Sets the individual marker symbols.

?Symbol3D : MarkerSymbol3D

Sets the marker symbol for 3d traces.

?MultiSymbol3D : seq<MarkerSymbol3D>

Sets the individual marker symbols for 3d traces.

?OutlierColor : Color

Sets the color of the outlier sample points.

?OutlierWidth : int

Sets the width of the outlier sample points.

Returns: Marker -> Marker