plotly.graph_objects
.Scatterternary¶
-
class
plotly.graph_objects.
Scatterternary
(arg=None, a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶ -
__init__
(arg=None, a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶ Construct a new Scatterternary object
Provides similar functionality to the “scatter” type but on a ternary phase diagram. The data is provided by at least two arrays out of
a
,b
,c
triplets.- Parameters
arg – dict of properties compatible with this constructor or an instance of
plotly.graph_objects.Scatterternary
a – Sets the quantity of component
a
in each data point. Ifa
,b
, andc
are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to matchternary<i>.sum
.asrc – Sets the source reference on Chart Studio Cloud for
a
.b – Sets the quantity of component
a
in each data point. Ifa
,b
, andc
are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to matchternary<i>.sum
.bsrc – Sets the source reference on Chart Studio Cloud for
b
.c – Sets the quantity of component
a
in each data point. Ifa
,b
, andc
are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to matchternary<i>.sum
.cliponaxis – Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set
xaxis.layer
andyaxis.layer
to below traces.connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
csrc – Sets the source reference on Chart Studio Cloud for
c
.customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata
.fill – Sets the area to fill with a solid color. Use with
fillcolor
if not “none”. scatterternary has a subset of the options available to scatter. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other.fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
hoverinfo – Determines which trace information appear on hover. If
none
orskip
are set, no information is displayed upon hovering. But, ifnone
is set, click and hover events are still fired.hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo
.hoverlabel –
plotly.graph_objects.scatterternary.Hoverlabel
instance or dict with compatible propertieshoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.
hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override
hoverinfo
. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available inhovertemplate
are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per-point (the ones that arearrayOk: true
) are available. Anything contained in tag<extra>
is displayed in the secondary box, for example “<extra>{fullData.name}</extra>”. To hide the secondary box completely, use an empty tag<extra></extra>
.hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate
.hovertext – Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace
hoverinfo
must contain a “text” flag.hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext
.ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids
.legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under
layout.legend
,layout.legend2
, etc.legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle –
plotly.graph_objects.scatterternary.Legendgroup title
instance or dict with compatible propertieslegendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed”
legend.traceorder
they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line –
plotly.graph_objects.scatterternary.Line
instance or dict with compatible propertiesmarker –
plotly.graph_objects.scatterternary.Marker
instance or dict with compatible propertiesmeta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace
name
, graph, axis and colorbartitle.text
, annotationtext
rangeselector
,updatemenues
andsliders
label
text all supportmeta
. To access the tracemeta
values in an attribute in the same trace, simply use%{meta[i]}
wherei
is the index or key of themeta
item in question. To access tracemeta
in layout attributes, use%{data[n[.meta[i]}
wherei
is the index or key of themeta
andn
is the trace index.metasrc – Sets the source reference on Chart Studio Cloud for
meta
.mode – Determines the drawing mode for this scatter trace. If the provided
mode
includes “text” then thetext
elements appear at the coordinates. Otherwise, thetext
elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
selected –
plotly.graph_objects.scatterternary.Selected
instance or dict with compatible propertiesselectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the
unselected
are turned on for all points, whereas, any other non-array values means no selection all where theselected
andunselected
styles have no effect.showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream –
plotly.graph_objects.scatterternary.Stream
instance or dict with compatible propertiessubplot – Sets a reference between this trace’s data coordinates and a ternary subplot. If “ternary” (the default value), the data refer to
layout.ternary
. If “ternary2”, the data refer tolayout.ternary2
, and so on.sum – The number each triplet should sum to, if only two of
a
,b
, andc
are provided. This overridesternary<i>.sum
to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary<i>.sumtext – Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace
hoverinfo
contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.textfont – Sets the text font.
textposition – Sets the positions of the
text
elements with respects to the (x,y) coordinates.textpositionsrc – Sets the source reference on Chart Studio Cloud for
textposition
.textsrc – Sets the source reference on Chart Studio Cloud for
text
.texttemplate – Template string used for rendering the information text that appear on points. Note that this will override
textinfo
. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that arearrayOk: true
) are available. Finally, the template string has access to variablesa
,b
,c
andtext
.texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate
.uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the trace:
constraintrange
inparcoords
traces, as well as someeditable: true
modifications such asname
andcolorbar.title
. Defaults tolayout.uirevision
. Note that other user-driven trace attribute changes are controlled bylayout
attributes:trace.visible
is controlled bylayout.legend.uirevision
,selectedpoints
is controlled bylayout.selectionrevision
, andcolorbar.(x|y)
(accessible withconfig: {editable: true}
) is controlled bylayout.editrevision
. Trace changes are tracked byuid
, which only falls back on trace index if nouid
is provided. So if your app can add/remove traces before the end of thedata
array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace auid
that stays with it as it moves.unselected –
plotly.graph_objects.scatterternary.Unselected
instance or dict with compatible propertiesvisible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
- Returns
- Return type
-
plotly.graph_objects
.scatterternary¶
-
class
plotly.graph_objects.scatterternary.
Hoverlabel
(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=None, **kwargs)¶ -
property
align
¶ Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- The ‘align’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘left’, ‘right’, ‘auto’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
alignsrc
¶ Sets the source reference on Chart Studio Cloud for
align
.The ‘alignsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
bgcolor
¶ Sets the background color of the hover labels for this trace
- The ‘bgcolor’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
- A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A list or array of any of the above
- Returns
- Return type
str|numpy.ndarray
-
property
bgcolorsrc
¶ Sets the source reference on Chart Studio Cloud for
bgcolor
.The ‘bgcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
bordercolor
¶ Sets the border color of the hover labels for this trace.
- The ‘bordercolor’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
- A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A list or array of any of the above
- Returns
- Return type
str|numpy.ndarray
-
property
bordercolorsrc
¶ Sets the source reference on Chart Studio Cloud for
bordercolor
.The ‘bordercolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
font
¶ Sets the font used in hover labels.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.scatterternary.hoverlabel.Font
A dict of string/value properties that will be passed to the Font constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
color
.- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family
.- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition
.- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow
.
size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size
.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style
.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase
.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant
.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight
.
- Returns
- Return type
-
property
namelength
¶ Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to
namelength - 3
characters and add an ellipsis.- The ‘namelength’ property is a integer and may be specified as:
An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|numpy.ndarray
-
property
-
class
plotly.graph_objects.scatterternary.
Legendgrouptitle
(arg=None, font=None, text=None, **kwargs)¶ -
property
font
¶ Sets this legend group’s title font.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.scatterternary.legendgrouptitle.Font
A dict of string/value properties that will be passed to the Font constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
- Returns
- Return type
-
property
-
class
plotly.graph_objects.scatterternary.
Line
(arg=None, backoff=None, backoffsrc=None, color=None, dash=None, shape=None, smoothing=None, width=None, **kwargs)¶ -
property
backoff
¶ Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With “auto” the lines would trim before markers if
marker.angleref
is set to “previous”.- The ‘backoff’ property is a number and may be specified as:
An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|float|numpy.ndarray
-
property
backoffsrc
¶ Sets the source reference on Chart Studio Cloud for
backoff
.The ‘backoffsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
color
¶ Sets the line color.
- The ‘color’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
- A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
- Returns
- Return type
-
property
dash
¶ Sets the dash style of lines. Set to a dash type string (“solid”, “dot”, “dash”, “longdash”, “dashdot”, or “longdashdot”) or a dash length list in px (eg “5px,10px,2px,2px”).
- The ‘dash’ property is an enumeration that may be specified as:
- One of the following dash styles:
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
- A string containing a dash length list in pixels or percentages
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)
- Returns
- Return type
-
property
shape
¶ Determines the line shape. With “spline” the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
- The ‘shape’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘linear’, ‘spline’]
- Returns
- Return type
Any
-
property
smoothing
¶ Has an effect only if
shape
is set to “spline” Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a “linear” shape).- The ‘smoothing’ property is a number and may be specified as:
An int or float in the interval [0, 1.3]
- Returns
- Return type
int|float
-
property
width
¶ Sets the line width (in px).
- The ‘width’ property is a number and may be specified as:
An int or float in the interval [0, inf]
- Returns
- Return type
int|float
-
property
-
class
plotly.graph_objects.scatterternary.
Marker
(arg=None, angle=None, angleref=None, anglesrc=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, colorsrc=None, gradient=None, line=None, maxdisplayed=None, opacity=None, opacitysrc=None, reversescale=None, showscale=None, size=None, sizemin=None, sizemode=None, sizeref=None, sizesrc=None, standoff=None, standoffsrc=None, symbol=None, symbolsrc=None, **kwargs)¶ -
property
angle
¶ Sets the marker angle in respect to
angleref
.The ‘angle’ property is a angle (in degrees) that may be specified as a number between -180 and 180, or a list, numpy array or other iterable thereof. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).
- Returns
- Return type
int|float|numpy.ndarray
-
property
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.
- The ‘angleref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘previous’, ‘up’]
- Returns
- Return type
Any
-
property
anglesrc
¶ Sets the source reference on Chart Studio Cloud for
angle
.The ‘anglesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
autocolorscale
¶ Determines whether the colorscale is a default palette (
autocolorscale: true
) or the palette determined bymarker.colorscale
. Has an effect only if inmarker.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.The ‘autocolorscale’ property must be specified as a bool (either True, or False)
- Returns
- Return type
-
property
cauto
¶ Determines whether or not the color domain is computed with respect to the input data (here in
marker.color
) or the bounds set inmarker.cmin
andmarker.cmax
Has an effect only if inmarker.color
is set to a numerical array. Defaults tofalse
whenmarker.cmin
andmarker.cmax
are set by the user.The ‘cauto’ property must be specified as a bool (either True, or False)
- Returns
- Return type
-
property
cmax
¶ 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 inmarker.color
and if set,marker.cmin
must be set as well.- The ‘cmax’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
cmid
¶ Sets the mid-point of the color domain by scaling
marker.cmin
and/ormarker.cmax
to be equidistant to this point. Has an effect only if inmarker.color
is set to a numerical array. Value should have the same units as inmarker.color
. Has no effect whenmarker.cauto
isfalse
.- The ‘cmid’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
cmin
¶ 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 inmarker.color
and if set,marker.cmax
must be set as well.- The ‘cmin’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
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
andmarker.cmax
if set.- The ‘color’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
- A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A number that will be interpreted as a color according to scatterternary.marker.colorscale
A list or array of any of the above
- Returns
- Return type
str|numpy.ndarray
-
property
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.The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
- Returns
- Return type
-
property
colorbar
¶ The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.scatterternary.marker.ColorBar
A dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- dtick
Sets the step in-between ticks on this axis. Use with
tick0
. Must be a positive number, or special strings available to “log” and “date” axes. If the axistype
is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, wheref
is a positive number, gives ticks linearly spaced in value (but not position). For exampletick0
= 0.1,dtick
= “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5).tick0
is ignored for “D1” and “D2”. If the axistype
is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtick
to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.n
must be a positive integer. To set ticks on the 15th of every third month, settick0
to “2000-01-15” anddtick
to “M3”. To set ticks every 4 years, setdtick
to “M48”- exponentformat
Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If “none”, it appears as 1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If “power”, 1x10^9 (with 9 in a super script). If “SI”, 1G. If “B”, 1B.
- labelalias
Replacement text for specific tick or hover labels. For example using {US: ‘USA’, CA: ‘Canada’} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.
- len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use
len
to set the value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformat
is “SI” or “B”.- nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to
nticks
. Has an effect only iftickmode
is set to “auto”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- showexponent
If “all”, all exponents are shown besides their significands. If “first”, only the exponent of the first tick is shown. If “last”, only the exponent of the last tick is shown. If “none”, no exponents appear.
- showticklabels
Determines whether or not the tick labels are drawn.
- showtickprefix
If “all”, all tick labels are displayed with a prefix. If “first”, only the first tick is displayed with a prefix. If “last”, only the last tick is displayed with a suffix. If “none”, tick prefixes are hidden.
- showticksuffix
Same as
showtickprefix
but for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use
thickness
to set the value.- tick0
Sets the placement of the first tick on this axis. Use with
dtick
. If the axistype
is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0
to 2) except whendtick`=*L<f>* (see `dtick
for more info). If the axistype
is “date”, it should be a date string, like date data. If the axistype
is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangle
of -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://github.com/d3/d3-format/tree/v1.4.5#d3- format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display “09~15~23.46”
- tickformatstops
A tuple of
plotly.graph_objects.scatter ternary.marker.colorbar.Tickformatstop
instances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.scatterternary.marker.colorbar.tickformatstop defaults), sets the default property values to use for elements of scatterternary.marker.colorbar.tickformatstops
- ticklabeloverflow
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.
- ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientation
is “h”, top and bottom whenorientation
is “v”.- ticklabelstep
Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled.
tick0
determines which labels are shown. Not implemented for axes withtype
“log” or “multicategory”, or whentickmode
is “array”.- ticklen
Sets the tick length (in px).
- tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via
nticks
. If “linear”, the placement of the ticks is determined by a starting positiontick0
and a tick stepdtick
(“linear” is the default value iftick0
anddtick
are provided). If “array”, the placement of the ticks is set viatickvals
and the tick text isticktext
. (“array” is the default value iftickvals
is provided).- tickprefix
Sets a tick label prefix.
- ticks
Determines whether ticks are drawn or not. If “”, this axis’ ticks are not drawn. If “outside” (“inside”), this axis’ are drawn outside (inside) the axis lines.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals
. Only has an effect iftickmode
is set to “array”. Used withtickvals
.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext
.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmode
is set to “array”. Used withticktext
.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals
.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.scatterternary.mar ker.colorbar.Title
instance or dict with compatible properties- titlefont
Deprecated: Please use scatterternary.marker.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated
titlefont
attribute.- titleside
Deprecated: Please use scatterternary.marker.colorbar.title.side instead. Determines the location of color bar’s title with respect to the color bar. Defaults to “top” when
orientation
if “v” and defaults to “right” whenorientation
if “h”. Note that the title’s location used to be set by the now deprecatedtitleside
attribute.- x
Sets the x position with respect to
xref
of the color bar (in plot fraction). Whenxref
is “paper”, defaults to 1.02 whenorientation
is “v” and 0.5 whenorientation
is “h”. Whenxref
is “container”, defaults to 1 whenorientation
is “v” and 0.5 whenorientation
is “h”. Must be between 0 and 1 ifxref
is “container” and between “-2” and 3 ifxref
is “paper”.- xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the
x
position to the “left”, “center” or “right” of the color bar. Defaults to “left” whenorientation
is “v” and “center” whenorientation
is “h”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
x
refers to. “container” spans the entirewidth
of the plot. “paper” refers to the width of the plotting area only.- y
Sets the y position with respect to
yref
of the color bar (in plot fraction). Whenyref
is “paper”, defaults to 0.5 whenorientation
is “v” and 1.02 whenorientation
is “h”. Whenyref
is “container”, defaults to 0.5 whenorientation
is “v” and 1 whenorientation
is “h”. Must be between 0 and 1 ifyref
is “container” and between “-2” and 3 ifyref
is “paper”.- yanchor
Sets this color bar’s vertical position anchor This anchor binds the
y
position to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” whenorientation
is “v” and “bottom” whenorientation
is “h”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
y
refers to. “container” spans the entireheight
of the plot. “paper” refers to the height of the plotting area only.
- Returns
- Return type
-
property
colorscale
¶ Sets the colorscale. Has an effect only if in
marker.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.cmin
andmarker.cmax
. Alternatively,colorscale
may be a palette name string of the following list: Blackbody,B luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.The ‘colorscale’ property is a colorscale and may be specified as:
A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.
A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
- One of the following named colorscales:
- [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
Appending ‘_r’ to a named colorscale reverses it.
- Returns
- Return type
-
property
colorsrc
¶ Sets the source reference on Chart Studio Cloud for
color
.The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
gradient
¶ The ‘gradient’ property is an instance of Gradient that may be specified as:
An instance of
plotly.graph_objects.scatterternary.marker.Gradient
A dict of string/value properties that will be passed to the Gradient constructor
Supported dict properties:
- color
Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.
- colorsrc
Sets the source reference on Chart Studio Cloud for
color
.- type
Sets the type of gradient used to fill the markers
- typesrc
Sets the source reference on Chart Studio Cloud for
type
.
- Returns
- Return type
-
property
line
¶ The ‘line’ property is an instance of Line that may be specified as:
An instance of
plotly.graph_objects.scatterternary.marker.Line
A dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- autocolorscale
Determines whether the colorscale is a default palette (
autocolorscale: true
) or the palette determined bymarker.line.colorscale
. Has an effect only if inmarker.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.- 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. Defaults tofalse
whenmarker.line.cmin
andmarker.line.cmax
are set by the user.- cmax
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.- cmid
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 inmarker.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
.- cmin
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.- color
Sets the marker.line 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.line.cmin
andmarker.line.cmax
if set.- 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.- colorscale
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: Blackbody,Bl uered,Blues,Cividis,Earth,Electric,Greens,Greys ,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri dis,YlGnBu,YlOrRd.- colorsrc
Sets the source reference on Chart Studio Cloud for
color
.- reversescale
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.- width
Sets the width (in px) of the lines bounding the marker points.
- widthsrc
Sets the source reference on Chart Studio Cloud for
width
.
- Returns
- Return type
-
property
maxdisplayed
¶ Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.
- The ‘maxdisplayed’ property is a number and may be specified as:
An int or float in the interval [0, inf]
- Returns
- Return type
int|float
-
property
opacity
¶ Sets the marker opacity.
- The ‘opacity’ property is a number and may be specified as:
An int or float in the interval [0, 1]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|float|numpy.ndarray
-
property
opacitysrc
¶ Sets the source reference on Chart Studio Cloud for
opacity
.The ‘opacitysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
reversescale
¶ 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 andmarker.cmax
will correspond to the first color.The ‘reversescale’ property must be specified as a bool (either True, or False)
- Returns
- Return type
-
property
showscale
¶ 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.The ‘showscale’ property must be specified as a bool (either True, or False)
- Returns
- Return type
-
property
size
¶ Sets the marker size (in px).
- The ‘size’ property is a number and may be specified as:
An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|float|numpy.ndarray
-
property
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.- The ‘sizemin’ property is a number and may be specified as:
An int or float in the interval [0, inf]
- Returns
- Return type
int|float
-
property
sizemode
¶ Has an effect only if
marker.size
is set to a numerical array. Sets the rule for which the data insize
is converted to pixels.- The ‘sizemode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘diameter’, ‘area’]
- Returns
- Return type
Any
-
property
sizeref
¶ 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 withsizemin
andsizemode
.- The ‘sizeref’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
sizesrc
¶ Sets the source reference on Chart Studio Cloud for
size
.The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
standoff
¶ 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.- The ‘standoff’ property is a number and may be specified as:
An int or float in the interval [0, inf]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|float|numpy.ndarray
-
property
standoffsrc
¶ Sets the source reference on Chart Studio Cloud for
standoff
.The ‘standoffsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
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.
- The ‘symbol’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, ‘0’, ‘circle’, 100, ‘100’, ‘circle-open’, 200, ‘200’, ‘circle-dot’, 300, ‘300’, ‘circle-open-dot’, 1, ‘1’, ‘square’, 101, ‘101’, ‘square-open’, 201, ‘201’, ‘square-dot’, 301, ‘301’, ‘square-open-dot’, 2, ‘2’, ‘diamond’, 102, ‘102’, ‘diamond-open’, 202, ‘202’, ‘diamond-dot’, 302, ‘302’, ‘diamond-open-dot’, 3, ‘3’, ‘cross’, 103, ‘103’, ‘cross-open’, 203, ‘203’, ‘cross-dot’, 303, ‘303’, ‘cross-open-dot’, 4, ‘4’, ‘x’, 104, ‘104’, ‘x-open’, 204, ‘204’, ‘x-dot’, 304, ‘304’, ‘x-open-dot’, 5, ‘5’, ‘triangle-up’, 105, ‘105’, ‘triangle-up-open’, 205, ‘205’, ‘triangle-up-dot’, 305, ‘305’, ‘triangle-up-open-dot’, 6, ‘6’, ‘triangle-down’, 106, ‘106’, ‘triangle-down-open’, 206, ‘206’, ‘triangle-down-dot’, 306, ‘306’, ‘triangle-down-open-dot’, 7, ‘7’, ‘triangle-left’, 107, ‘107’, ‘triangle-left-open’, 207, ‘207’, ‘triangle-left-dot’, 307, ‘307’, ‘triangle-left-open-dot’, 8, ‘8’, ‘triangle-right’, 108, ‘108’, ‘triangle-right-open’, 208, ‘208’, ‘triangle-right-dot’, 308, ‘308’, ‘triangle-right-open-dot’, 9, ‘9’, ‘triangle-ne’, 109, ‘109’, ‘triangle-ne-open’, 209, ‘209’, ‘triangle-ne-dot’, 309, ‘309’, ‘triangle-ne-open-dot’, 10, ‘10’, ‘triangle-se’, 110, ‘110’, ‘triangle-se-open’, 210, ‘210’, ‘triangle-se-dot’, 310, ‘310’, ‘triangle-se-open-dot’, 11, ‘11’, ‘triangle-sw’, 111, ‘111’, ‘triangle-sw-open’, 211, ‘211’, ‘triangle-sw-dot’, 311, ‘311’, ‘triangle-sw-open-dot’, 12, ‘12’, ‘triangle-nw’, 112, ‘112’, ‘triangle-nw-open’, 212, ‘212’, ‘triangle-nw-dot’, 312, ‘312’, ‘triangle-nw-open-dot’, 13, ‘13’, ‘pentagon’, 113, ‘113’, ‘pentagon-open’, 213, ‘213’, ‘pentagon-dot’, 313, ‘313’, ‘pentagon-open-dot’, 14, ‘14’, ‘hexagon’, 114, ‘114’, ‘hexagon-open’, 214, ‘214’, ‘hexagon-dot’, 314, ‘314’, ‘hexagon-open-dot’, 15, ‘15’, ‘hexagon2’, 115, ‘115’, ‘hexagon2-open’, 215, ‘215’, ‘hexagon2-dot’, 315, ‘315’, ‘hexagon2-open-dot’, 16, ‘16’, ‘octagon’, 116, ‘116’, ‘octagon-open’, 216, ‘216’, ‘octagon-dot’, 316, ‘316’, ‘octagon-open-dot’, 17, ‘17’, ‘star’, 117, ‘117’, ‘star-open’, 217, ‘217’, ‘star-dot’, 317, ‘317’, ‘star-open-dot’, 18, ‘18’, ‘hexagram’, 118, ‘118’, ‘hexagram-open’, 218, ‘218’, ‘hexagram-dot’, 318, ‘318’, ‘hexagram-open-dot’, 19, ‘19’, ‘star-triangle-up’, 119, ‘119’, ‘star-triangle-up-open’, 219, ‘219’, ‘star-triangle-up-dot’, 319, ‘319’, ‘star-triangle-up-open-dot’, 20, ‘20’, ‘star-triangle-down’, 120, ‘120’, ‘star-triangle-down-open’, 220, ‘220’, ‘star-triangle-down-dot’, 320, ‘320’, ‘star-triangle-down-open-dot’, 21, ‘21’, ‘star-square’, 121, ‘121’, ‘star-square-open’, 221, ‘221’, ‘star-square-dot’, 321, ‘321’, ‘star-square-open-dot’, 22, ‘22’, ‘star-diamond’, 122, ‘122’, ‘star-diamond-open’, 222, ‘222’, ‘star-diamond-dot’, 322, ‘322’, ‘star-diamond-open-dot’, 23, ‘23’, ‘diamond-tall’, 123, ‘123’, ‘diamond-tall-open’, 223, ‘223’, ‘diamond-tall-dot’, 323, ‘323’, ‘diamond-tall-open-dot’, 24, ‘24’, ‘diamond-wide’, 124, ‘124’, ‘diamond-wide-open’, 224, ‘224’, ‘diamond-wide-dot’, 324, ‘324’, ‘diamond-wide-open-dot’, 25, ‘25’, ‘hourglass’, 125, ‘125’, ‘hourglass-open’, 26, ‘26’, ‘bowtie’, 126, ‘126’, ‘bowtie-open’, 27, ‘27’, ‘circle-cross’, 127, ‘127’, ‘circle-cross-open’, 28, ‘28’, ‘circle-x’, 128, ‘128’, ‘circle-x-open’, 29, ‘29’, ‘square-cross’, 129, ‘129’, ‘square-cross-open’, 30, ‘30’, ‘square-x’, 130, ‘130’, ‘square-x-open’, 31, ‘31’, ‘diamond-cross’, 131, ‘131’, ‘diamond-cross-open’, 32, ‘32’, ‘diamond-x’, 132, ‘132’, ‘diamond-x-open’, 33, ‘33’, ‘cross-thin’, 133, ‘133’, ‘cross-thin-open’, 34, ‘34’, ‘x-thin’, 134, ‘134’, ‘x-thin-open’, 35, ‘35’, ‘asterisk’, 135, ‘135’, ‘asterisk-open’, 36, ‘36’, ‘hash’, 136, ‘136’, ‘hash-open’, 236, ‘236’, ‘hash-dot’, 336, ‘336’, ‘hash-open-dot’, 37, ‘37’, ‘y-up’, 137, ‘137’, ‘y-up-open’, 38, ‘38’, ‘y-down’, 138, ‘138’, ‘y-down-open’, 39, ‘39’, ‘y-left’, 139, ‘139’, ‘y-left-open’, 40, ‘40’, ‘y-right’, 140, ‘140’, ‘y-right-open’, 41, ‘41’, ‘line-ew’, 141, ‘141’, ‘line-ew-open’, 42, ‘42’, ‘line-ns’, 142, ‘142’, ‘line-ns-open’, 43, ‘43’, ‘line-ne’, 143, ‘143’, ‘line-ne-open’, 44, ‘44’, ‘line-nw’, 144, ‘144’, ‘line-nw-open’, 45, ‘45’, ‘arrow-up’, 145, ‘145’, ‘arrow-up-open’, 46, ‘46’, ‘arrow-down’, 146, ‘146’, ‘arrow-down-open’, 47, ‘47’, ‘arrow-left’, 147, ‘147’, ‘arrow-left-open’, 48, ‘48’, ‘arrow-right’, 148, ‘148’, ‘arrow-right-open’, 49, ‘49’, ‘arrow-bar-up’, 149, ‘149’, ‘arrow-bar-up-open’, 50, ‘50’, ‘arrow-bar-down’, 150, ‘150’, ‘arrow-bar-down-open’, 51, ‘51’, ‘arrow-bar-left’, 151, ‘151’, ‘arrow-bar-left-open’, 52, ‘52’, ‘arrow-bar-right’, 152, ‘152’, ‘arrow-bar-right-open’, 53, ‘53’, ‘arrow’, 153, ‘153’, ‘arrow-open’, 54, ‘54’, ‘arrow-wide’, 154, ‘154’, ‘arrow-wide-open’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
-
class
plotly.graph_objects.scatterternary.
Selected
(arg=None, marker=None, textfont=None, **kwargs)¶ -
property
marker
¶ The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scatterternary.selected.Marker
A dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- color
Sets the marker color of selected points.
- opacity
Sets the marker opacity of selected points.
- size
Sets the marker size of selected points.
- Returns
- Return type
-
property
textfont
¶ The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scatterternary.selected.Textfont
A dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
- color
Sets the text font color of selected points.
- Returns
- Return type
-
property
-
class
plotly.graph_objects.scatterternary.
Stream
(arg=None, maxpoints=None, token=None, **kwargs)¶ -
property
maxpoints
¶ Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpoints
is set to 50, only the newest 50 points will be displayed on the plot.- The ‘maxpoints’ property is a number and may be specified as:
An int or float in the interval [0, 10000]
- Returns
- Return type
int|float
-
property
token
¶ The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.
- The ‘token’ property is a string and must be specified as:
A non-empty string
- Returns
- Return type
-
property
-
class
plotly.graph_objects.scatterternary.
Textfont
(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)¶ -
property
color
¶ - The ‘color’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
- A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A list or array of any of the above
- Returns
- Return type
str|numpy.ndarray
-
property
colorsrc
¶ Sets the source reference on Chart Studio Cloud for
color
.The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
family
¶ HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart- studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- The ‘family’ property is a string and must be specified as:
A non-empty string
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
str|numpy.ndarray
-
property
familysrc
¶ Sets the source reference on Chart Studio Cloud for
family
.The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
lineposition
¶ Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)
A list or array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
linepositionsrc
¶ Sets the source reference on Chart Studio Cloud for
lineposition
.The ‘linepositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
shadow
¶ Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
- The ‘shadow’ property is a string and must be specified as:
A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
str|numpy.ndarray
-
property
shadowsrc
¶ Sets the source reference on Chart Studio Cloud for
shadow
.The ‘shadowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
size
¶ - The ‘size’ property is a number and may be specified as:
An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|float|numpy.ndarray
-
property
sizesrc
¶ Sets the source reference on Chart Studio Cloud for
size
.The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
style
¶ Sets whether a font should be styled with a normal or italic face from its family.
- The ‘style’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘italic’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
stylesrc
¶ Sets the source reference on Chart Studio Cloud for
style
.The ‘stylesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
textcase
¶ Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- The ‘textcase’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
textcasesrc
¶ Sets the source reference on Chart Studio Cloud for
textcase
.The ‘textcasesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
variant
¶ Sets the variant of the font.
- The ‘variant’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
variantsrc
¶ Sets the source reference on Chart Studio Cloud for
variant
.The ‘variantsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
weight
¶ Sets the weight (or boldness) of the font.
- The ‘weight’ property is a integer and may be specified as:
An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|numpy.ndarray
-
property
-
class
plotly.graph_objects.scatterternary.
Unselected
(arg=None, marker=None, textfont=None, **kwargs)¶ -
property
marker
¶ The ‘marker’ property is an instance of Marker that may be specified as:
An instance of
plotly.graph_objects.scatterternary.unselected.Marker
A dict of string/value properties that will be passed to the Marker constructor
Supported dict properties:
- color
Sets the marker color of unselected points, applied only when a selection exists.
- opacity
Sets the marker opacity of unselected points, applied only when a selection exists.
- size
Sets the marker size of unselected points, applied only when a selection exists.
- Returns
- Return type
-
property
textfont
¶ The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.scatterternary.unselected.Textfont
A dict of string/value properties that will be passed to the Textfont constructor
Supported dict properties:
- color
Sets the text font color of unselected points, applied only when a selection exists.
- Returns
- Return type
-
property