Live Chat

We'll need to share your messages (and your email address if you're logged in) with our live chat provider, Drift. Here's their privacy policy.

If you don't want to do this, you can email us instead at contact@anvil.works.

plotly.graph_objs Module

Functions

plotly.graph_objs.Bar([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [x=], [x0=], [dx=], [y=], [y0=], [dy=], [xperiod=], [yperiod=], [xperiod0=], [yperiod0=], [xperiodalignment=], [yperiodalignment=], [text=], [texttemplate=], [hovertext=], [hovertemplate=], [textposition=], [insidetextanchor=], [textangle=], [textfont=], [insidetextfont=], [outsidetextfont=], [constraintext=], [cliponaxis=], [orientation=], [base=], [offset=], [width=], [marker=], [offsetgroup=], [alignmentgroup=], [selected=], [unselected=], [_deprecated=], [error_x=], [error_y=], [xcalendar=], [ycalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [xsrc=], [ysrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [hovertemplatesrc=], [textpositionsrc=], [basesrc=], [offsetsrc=], [widthsrc=]) → Bar

Create a new ‘Bar’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the x coordinates.

  • x0 - Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • dx - Sets the x coordinate step. See `x0` for more info.

  • y - Sets the y coordinates.

  • y0 - Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • dy - Sets the y coordinate step. See `y0` for more info.

  • xperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the x axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • yperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the y axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • yperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • xperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

  • yperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.

  • text - Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `value` and `label`.

  • hovertext - Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variables `value` and `label`. 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>`.

  • textposition - Specifies the location of the `text`. *inside* positions `text` inside, next to the bar end (rotated and scaled if needed). *outside* positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. *auto* tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside.

  • insidetextanchor - Determines if texts are kept at center or start/end points in `textposition` *inside* mode.

  • textangle - Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With *auto* the texts may automatically be rotated to fit with the maximum size in bars.

  • textfont - Sets the font used for `text`.

  • insidetextfont - Sets the font used for `text` lying inside the bar.

  • outsidetextfont - Sets the font used for `text` lying outside the bar.

  • constraintext - Constrain the size of text inside or outside a bar to be no larger than the bar itself.

  • cliponaxis - Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*.

  • orientation - Sets the orientation of the bars. With *v* (*h*), the value of the each bar spans along the vertical (horizontal).

  • base - Sets where the bar base is drawn (in position axis units). In *stack* or *relative* barmode, traces that set *base* will be excluded and drawn in *overlay* mode instead.

  • offset - Shifts the position where the bar is drawn (in position axis units). In *group* barmode, traces that set *offset* will be excluded and drawn in *overlay* mode instead.

  • width - Sets the bar width (in position axis units).

  • offsetgroup - Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

  • alignmentgroup - Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .

  • basesrc - Sets the source reference on Chart Studio Cloud for base .

  • offsetsrc - Sets the source reference on Chart Studio Cloud for offset .

  • widthsrc - Sets the source reference on Chart Studio Cloud for width .


plotly.graph_objs.Barpolar([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [r=], [theta=], [r0=], [dr=], [theta0=], [dtheta=], [thetaunit=], [base=], [offset=], [width=], [text=], [hovertext=], [marker=], [hoverinfo=], [hovertemplate=], [selected=], [unselected=], [subplot=], [idssrc=], [customdatasrc=], [metasrc=], [rsrc=], [thetasrc=], [basesrc=], [offsetsrc=], [widthsrc=], [textsrc=], [hovertextsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Barpolar

Create a new ‘Barpolar’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • r - Sets the radial coordinates

  • theta - Sets the angular coordinates

  • r0 - Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.

  • dr - Sets the r coordinate step.

  • theta0 - Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.

  • dtheta - Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.

  • thetaunit - Sets the unit of input *theta* values. Has an effect only when on *linear* angular axes.

  • base - Sets where the bar base is drawn (in radial axis units). In *stack* barmode, traces that set *base* will be excluded and drawn in *overlay* mode instead.

  • offset - Shifts the angular position where the bar is drawn (in *thetatunit* units).

  • width - Sets the bar angular width (in *thetaunit* units).

  • text - Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.

  • hovertext - Same as `text`.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • subplot - Sets a reference between this trace's data coordinates and a polar subplot. If *polar* (the default value), the data refer to `layout.polar`. If *polar2*, the data refer to `layout.polar2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • rsrc - Sets the source reference on Chart Studio Cloud for r .

  • thetasrc - Sets the source reference on Chart Studio Cloud for theta .

  • basesrc - Sets the source reference on Chart Studio Cloud for base .

  • offsetsrc - Sets the source reference on Chart Studio Cloud for offset .

  • widthsrc - Sets the source reference on Chart Studio Cloud for width .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Box([visible=], [showlegend=], [legendgroup=], [opacity=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [y=], [x=], [x0=], [y0=], [dx=], [dy=], [xperiod=], [yperiod=], [xperiod0=], [yperiod0=], [xperiodalignment=], [yperiodalignment=], [name=], [q1=], [median=], [q3=], [lowerfence=], [upperfence=], [notched=], [notchwidth=], [notchspan=], [boxpoints=], [jitter=], [pointpos=], [boxmean=], [mean=], [sd=], [orientation=], [quartilemethod=], [width=], [marker=], [line=], [fillcolor=], [whiskerwidth=], [offsetgroup=], [alignmentgroup=], [selected=], [unselected=], [text=], [hovertext=], [hovertemplate=], [hoveron=], [xcalendar=], [ycalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [ysrc=], [xsrc=], [q1src=], [mediansrc=], [q3src=], [lowerfencesrc=], [upperfencesrc=], [notchspansrc=], [meansrc=], [sdsrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=]) → Box

Create a new ‘Box’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • y - Sets the y sample data or coordinates. See overview for more info.

  • x - Sets the x sample data or coordinates. See overview for more info.

  • x0 - Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

  • y0 - Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

  • dx - Sets the x coordinate step for multi-box traces set using q1/median/q3.

  • dy - Sets the y coordinate step for multi-box traces set using q1/median/q3.

  • xperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the x axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • yperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the y axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • yperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • xperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

  • yperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.

  • name - Sets the trace name. The trace name appear as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical

  • q1 - Sets the Quartile 1 values. There should be as many items as the number of boxes desired.

  • median - Sets the median values. There should be as many items as the number of boxes desired.

  • q3 - Sets the Quartile 3 values. There should be as many items as the number of boxes desired.

  • lowerfence - Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point below 1.5 times the IQR.

  • upperfence - Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `upperfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point above 1.5 times the IQR.

  • notched - Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home/notched-box-plots for more info. Defaults to *false* unless `notchwidth` or `notchspan` is set.

  • notchwidth - Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es).

  • notchspan - Sets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is set, we compute it as 1.57 * IQR / sqrt(N), where N is the sample size.

  • boxpoints - If *outliers*, only the sample points lying outside the whiskers are shown If *suspectedoutliers*, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If *all*, all sample points are shown If *false*, only the box(es) are shown with no sample points Defaults to *suspectedoutliers* when `marker.outliercolor` or `marker.line.outliercolor` is set. Defaults to *all* under the q1/median/q3 signature. Otherwise defaults to *outliers*.

  • jitter - Sets the amount of jitter in the sample points drawn. If *0*, the sample points align along the distribution axis. If *1*, the sample points are drawn in a random jitter of width equal to the width of the box(es).

  • pointpos - Sets the position of the sample points in relation to the box(es). If *0*, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes

  • boxmean - If *true*, the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If *sd* the standard deviation is also drawn. Defaults to *true* when `mean` is set. Defaults to *sd* when `sd` is set Otherwise defaults to *false*.

  • mean - Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each box using the sample values.

  • sd - Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the standard deviation for each box using the sample values.

  • orientation - Sets the orientation of the box(es). If *v* (*h*), the distribution is visualized along the vertical (horizontal).

  • quartilemethod - Sets the method used to compute the sample's Q1 and Q3 quartiles. The *linear* method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://www.amstat.org/publications/jse/v14n3/langford.html). The *exclusive* method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The *inclusive* method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

  • width - Sets the width of the box in data coordinate If *0* (default value) the width is automatically selected based on the positions of other box traces in the same subplot.

  • fillcolor - Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

  • whiskerwidth - Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).

  • offsetgroup - Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

  • alignmentgroup - Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

  • text - Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • hovertext - Same as `text`.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • hoveron - Do the hover effects highlight individual boxes or sample points or both?

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • q1src - Sets the source reference on Chart Studio Cloud for q1 .

  • mediansrc - Sets the source reference on Chart Studio Cloud for median .

  • q3src - Sets the source reference on Chart Studio Cloud for q3 .

  • lowerfencesrc - Sets the source reference on Chart Studio Cloud for lowerfence .

  • upperfencesrc - Sets the source reference on Chart Studio Cloud for upperfence .

  • notchspansrc - Sets the source reference on Chart Studio Cloud for notchspan .

  • meansrc - Sets the source reference on Chart Studio Cloud for mean .

  • sdsrc - Sets the source reference on Chart Studio Cloud for sd .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Candlestick([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverinfo=], [stream=], [transform=], [uirevision=], [xperiod=], [xperiod0=], [xperiodalignment=], [x=], [open=], [high=], [low=], [close=], [line=], [increasing=], [decreasing=], [text=], [hovertext=], [whiskerwidth=], [hoverlabel=], [xcalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [xsrc=], [opensrc=], [highsrc=], [lowsrc=], [closesrc=], [textsrc=], [hovertextsrc=]) → Candlestick

Create a new ‘Candlestick’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • xperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the x axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • xperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

  • x - Sets the x coordinates. If absent, linear coordinate will be generated.

  • open - Sets the open values.

  • high - Sets the high values.

  • low - Sets the low values.

  • close - Sets the close values.

  • text - Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.

  • hovertext - Same as `text`.

  • whiskerwidth - Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).

  • xcalendar - Sets the calendar system to use with `x` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • opensrc - Sets the source reference on Chart Studio Cloud for open .

  • highsrc - Sets the source reference on Chart Studio Cloud for high .

  • lowsrc - Sets the source reference on Chart Studio Cloud for low .

  • closesrc - Sets the source reference on Chart Studio Cloud for close .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .


plotly.graph_objs.Carpet([visible=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [stream=], [uirevision=], [carpet=], [x=], [y=], [a=], [a0=], [da=], [b=], [b0=], [db=], [cheaterslope=], [aaxis=], [baxis=], [font=], [color=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [xsrc=], [ysrc=], [asrc=], [bsrc=]) → Carpet

Create a new ‘Carpet’ object

  • visible - 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).

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • carpet - An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie

  • x - A two dimensional array of x coordinates at each carpet point. If omitted, the plot is a cheater plot and the xaxis is hidden by default.

  • y - A two dimensional array of y coordinates at each carpet point.

  • a - An array containing values of the first parameter value

  • a0 - Alternate to `a`. Builds a linear space of a coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step.

  • da - Sets the a coordinate step. See `a0` for more info.

  • b - A two dimensional array of y coordinates at each carpet point.

  • b0 - Alternate to `b`. Builds a linear space of a coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step.

  • db - Sets the b coordinate step. See `b0` for more info.

  • cheaterslope - The shift applied to each successive row of data in creating a cheater plot. Only used if `x` is been omitted.

  • font - The default font used for axis & tick labels on this carpet

  • color - Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • asrc - Sets the source reference on Chart Studio Cloud for a .

  • bsrc - Sets the source reference on Chart Studio Cloud for b .


plotly.graph_objs.Choropleth([visible=], [legendgroup=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [locations=], [locationmode=], [z=], [geojson=], [featureidkey=], [text=], [hovertext=], [marker=], [selected=], [unselected=], [hoverinfo=], [hovertemplate=], [showlegend=], [zauto=], [zmin=], [zmax=], [zmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [geo=], [idssrc=], [customdatasrc=], [metasrc=], [locationssrc=], [zsrc=], [textsrc=], [hovertextsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Choropleth

Create a new ‘Choropleth’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • locations - Sets the coordinates via location IDs or names. See `locationmode` for more info.

  • locationmode - Determines the set of locations used to match entries in `locations` to regions on the map. Values *ISO-3*, *USA-states*, *country names* correspond to features on the base map and value *geojson-id* corresponds to features from a custom GeoJSON linked to the `geojson` attribute.

  • z - Sets the color values.

  • geojson - Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*.

  • featureidkey - Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example *properties.name*.

  • text - Sets the text elements associated with each location.

  • hovertext - Same as `text`.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • zauto - Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.

  • zmin - Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zmax - Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid - Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.

  • colorscale - Sets the colorscale. 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`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

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

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

  • geo - Sets a reference between this trace's geospatial coordinates and a geographic map. If *geo* (the default value), the geospatial coordinates refer to `layout.geo`. If *geo2*, the geospatial coordinates refer to `layout.geo2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • locationssrc - Sets the source reference on Chart Studio Cloud for locations .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Choroplethmapbox([visible=], [legendgroup=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [locations=], [z=], [geojson=], [featureidkey=], [below=], [text=], [hovertext=], [marker=], [selected=], [unselected=], [hoverinfo=], [hovertemplate=], [showlegend=], [zauto=], [zmin=], [zmax=], [zmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [subplot=], [idssrc=], [customdatasrc=], [metasrc=], [locationssrc=], [zsrc=], [textsrc=], [hovertextsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Choroplethmapbox

Create a new ‘Choroplethmapbox’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • locations - Sets which features found in *geojson* to plot using their feature `id` field.

  • z - Sets the color values.

  • geojson - Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*.

  • featureidkey - Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Support nested property, for example *properties.name*.

  • below - Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer.

  • text - Sets the text elements associated with each location.

  • hovertext - Same as `text`.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variable `properties` 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>`.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • zauto - Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.

  • zmin - Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zmax - Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid - Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.

  • colorscale - Sets the colorscale. 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`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

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

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

  • subplot - Sets a reference between this trace's data coordinates and a mapbox subplot. If *mapbox* (the default value), the data refer to `layout.mapbox`. If *mapbox2*, the data refer to `layout.mapbox2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • locationssrc - Sets the source reference on Chart Studio Cloud for locations .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Cone([visible=], [legendgroup=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [uirevision=], [x=], [y=], [z=], [u=], [v=], [w=], [sizemode=], [sizeref=], [anchor=], [text=], [hovertext=], [hovertemplate=], [showlegend=], [cauto=], [cmin=], [cmax=], [cmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [opacity=], [lightposition=], [lighting=], [hoverinfo=], [scene=], [idssrc=], [customdatasrc=], [metasrc=], [xsrc=], [ysrc=], [zsrc=], [usrc=], [vsrc=], [wsrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=], [hoverinfosrc=]) → Cone

Create a new ‘Cone’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the x coordinates of the vector field and of the displayed cones.

  • y - Sets the y coordinates of the vector field and of the displayed cones.

  • z - Sets the z coordinates of the vector field and of the displayed cones.

  • u - Sets the x components of the vector field.

  • v - Sets the y components of the vector field.

  • w - Sets the z components of the vector field.

  • sizemode - Determines whether `sizeref` is set as a *scaled* (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as *absolute* value (in the same units as the vector field).

  • sizeref - Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. This factor (computed internally) corresponds to the minimum "time" to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With `sizemode` set to *scaled*, `sizeref` is unitless, its default value is *0.5* With `sizemode` set to *absolute*, `sizeref` has the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm.

  • anchor - Sets the cones' anchor with respect to their x/y/z positions. Note that *cm* denote the cone's center of mass which corresponds to 1/4 from the tail to tip.

  • text - Sets the text elements associated with the cones. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • hovertext - Same as `text`.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variable `norm` 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>`.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • cauto - Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.

  • cmin - Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well.

  • cmax - Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well.

  • cmid - Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`.

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

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.

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

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

  • opacity - Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • scene - Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • usrc - Sets the source reference on Chart Studio Cloud for u .

  • vsrc - Sets the source reference on Chart Studio Cloud for v .

  • wsrc - Sets the source reference on Chart Studio Cloud for w .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .


plotly.graph_objs.Contour([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [z=], [x=], [x0=], [dx=], [y=], [y0=], [dy=], [xperiod=], [yperiod=], [xperiod0=], [yperiod0=], [xperiodalignment=], [yperiodalignment=], [text=], [hovertext=], [transpose=], [xtype=], [ytype=], [zhoverformat=], [hovertemplate=], [hoverongaps=], [connectgaps=], [fillcolor=], [autocontour=], [ncontours=], [contours=], [line=], [zauto=], [zmin=], [zmax=], [zmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [xcalendar=], [ycalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [zsrc=], [xsrc=], [ysrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=]) → Contour

Create a new ‘Contour’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • z - Sets the z data.

  • x - Sets the x coordinates.

  • x0 - Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • dx - Sets the x coordinate step. See `x0` for more info.

  • y - Sets the y coordinates.

  • y0 - Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • dy - Sets the y coordinate step. See `y0` for more info.

  • xperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the x axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • yperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the y axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • yperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • xperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

  • yperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.

  • text - Sets the text elements associated with each z value.

  • hovertext - Same as `text`.

  • transpose - Transposes the z data.

  • xtype - If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).

  • ytype - If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)

  • zhoverformat - Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • hoverongaps - Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array otherwise it is defaulted to false.

  • fillcolor - Sets the fill color if `contours.type` is *constraint*. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

  • autocontour - Determines whether or not the contour level attributes are picked by an algorithm. If *true*, the number of contour levels can be set in `ncontours`. If *false*, set the contour level attributes in `contours`.

  • ncontours - Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is *true* or if `contours.size` is missing.

  • zauto - Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.

  • zmin - Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zmax - Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid - Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.

  • colorscale - Sets the colorscale. 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`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

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

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

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Contourcarpet([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [stream=], [uirevision=], [carpet=], [z=], [a=], [a0=], [da=], [b=], [b0=], [db=], [text=], [hovertext=], [transpose=], [atype=], [btype=], [fillcolor=], [autocontour=], [ncontours=], [contours=], [line=], [zauto=], [zmin=], [zmax=], [zmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [zsrc=], [asrc=], [bsrc=], [textsrc=], [hovertextsrc=]) → Contourcarpet

Create a new ‘Contourcarpet’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • carpet - The `carpet` of the carpet axes on which this contour trace lies

  • z - Sets the z data.

  • a - Sets the x coordinates.

  • a0 - Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • da - Sets the x coordinate step. See `x0` for more info.

  • b - Sets the y coordinates.

  • b0 - Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • db - Sets the y coordinate step. See `y0` for more info.

  • text - Sets the text elements associated with each z value.

  • hovertext - Same as `text`.

  • transpose - Transposes the z data.

  • atype - If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).

  • btype - If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)

  • fillcolor - Sets the fill color if `contours.type` is *constraint*. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

  • autocontour - Determines whether or not the contour level attributes are picked by an algorithm. If *true*, the number of contour levels can be set in `ncontours`. If *false*, set the contour level attributes in `contours`.

  • ncontours - Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is *true* or if `contours.size` is missing.

  • zauto - Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.

  • zmin - Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zmax - Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid - Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.

  • colorscale - Sets the colorscale. 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`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

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

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

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • asrc - Sets the source reference on Chart Studio Cloud for a .

  • bsrc - Sets the source reference on Chart Studio Cloud for b .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .


plotly.graph_objs.Densitymapbox([visible=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [transform=], [uirevision=], [lon=], [lat=], [z=], [radius=], [below=], [text=], [hovertext=], [hoverinfo=], [hovertemplate=], [showlegend=], [zauto=], [zmin=], [zmax=], [zmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [subplot=], [idssrc=], [customdatasrc=], [metasrc=], [lonsrc=], [latsrc=], [zsrc=], [radiussrc=], [textsrc=], [hovertextsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Densitymapbox

Create a new ‘Densitymapbox’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • lon - Sets the longitude coordinates (in degrees East).

  • lat - Sets the latitude coordinates (in degrees North).

  • z - Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

  • radius - Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.

  • below - Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to '', the layer will be inserted above every existing layer.

  • text - Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • hovertext - Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • zauto - Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.

  • zmin - Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zmax - Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid - Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.

  • colorscale - Sets the colorscale. 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`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

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

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

  • subplot - Sets a reference between this trace's data coordinates and a mapbox subplot. If *mapbox* (the default value), the data refer to `layout.mapbox`. If *mapbox2*, the data refer to `layout.mapbox2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • lonsrc - Sets the source reference on Chart Studio Cloud for lon .

  • latsrc - Sets the source reference on Chart Studio Cloud for lat .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • radiussrc - Sets the source reference on Chart Studio Cloud for radius .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Figure() → Figure

Create a new ‘Figure’ object


plotly.graph_objs.Funnel([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [x=], [x0=], [dx=], [y=], [y0=], [dy=], [xperiod=], [yperiod=], [xperiod0=], [yperiod0=], [xperiodalignment=], [yperiodalignment=], [hovertext=], [hovertemplate=], [hoverinfo=], [textinfo=], [texttemplate=], [text=], [textposition=], [insidetextanchor=], [textangle=], [textfont=], [insidetextfont=], [outsidetextfont=], [constraintext=], [cliponaxis=], [orientation=], [offset=], [width=], [marker=], [connector=], [offsetgroup=], [alignmentgroup=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [xsrc=], [ysrc=], [hovertextsrc=], [hovertemplatesrc=], [hoverinfosrc=], [texttemplatesrc=], [textsrc=], [textpositionsrc=]) → Funnel

Create a new ‘Funnel’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the x coordinates.

  • x0 - Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • dx - Sets the x coordinate step. See `x0` for more info.

  • y - Sets the y coordinates.

  • y0 - Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • dy - Sets the y coordinate step. See `y0` for more info.

  • xperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the x axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • yperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the y axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • yperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • xperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

  • yperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.

  • hovertext - Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variables `percentInitial`, `percentPrevious` and `percentTotal`. 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>`.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • textinfo - Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `percentInitial`, `percentPrevious`, `percentTotal`, `label` and `value`.

  • text - Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • textposition - Specifies the location of the `text`. *inside* positions `text` inside, next to the bar end (rotated and scaled if needed). *outside* positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. *auto* tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside.

  • insidetextanchor - Determines if texts are kept at center or start/end points in `textposition` *inside* mode.

  • textangle - Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With *auto* the texts may automatically be rotated to fit with the maximum size in bars.

  • textfont - Sets the font used for `text`.

  • insidetextfont - Sets the font used for `text` lying inside the bar.

  • outsidetextfont - Sets the font used for `text` lying outside the bar.

  • constraintext - Constrain the size of text inside or outside a bar to be no larger than the bar itself.

  • cliponaxis - Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*.

  • orientation - Sets the orientation of the funnels. With *v* (*h*), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only *y* array is presented or orientation is set to *v*. Also regarding graphs including only 'horizontal' funnels, *autorange* on the *y-axis* are set to *reversed*.

  • offset - Shifts the position where the bar is drawn (in position axis units). In *group* barmode, traces that set *offset* will be excluded and drawn in *overlay* mode instead.

  • width - Sets the bar width (in position axis units).

  • offsetgroup - Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

  • alignmentgroup - Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .


plotly.graph_objs.Funnelarea([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [transform=], [uirevision=], [labels=], [label0=], [dlabel=], [values=], [marker=], [text=], [hovertext=], [scalegroup=], [textinfo=], [texttemplate=], [hoverinfo=], [hovertemplate=], [textposition=], [textfont=], [insidetextfont=], [title=], [domain=], [aspectratio=], [baseratio=], [idssrc=], [customdatasrc=], [metasrc=], [labelssrc=], [valuessrc=], [textsrc=], [hovertextsrc=], [texttemplatesrc=], [hoverinfosrc=], [hovertemplatesrc=], [textpositionsrc=]) → Funnelarea

Create a new ‘Funnelarea’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • labels - Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

  • label0 - Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.

  • dlabel - Sets the label step. See `label0` for more info.

  • values - Sets the values of the sectors. If omitted, we count occurrences of each label.

  • text - Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • hovertext - Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* flag.

  • scalegroup - If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

  • textinfo - Determines which trace information appear on the graph.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `text` and `percent`.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variables `label`, `color`, `value`, `text` and `percent`. 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>`.

  • textposition - Specifies the location of the `textinfo`.

  • textfont - Sets the font used for `textinfo`.

  • insidetextfont - Sets the font used for `textinfo` lying inside the sector.

  • aspectratio - Sets the ratio between height and width

  • baseratio - Sets the ratio between bottom length and maximum top length.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • labelssrc - Sets the source reference on Chart Studio Cloud for labels .

  • valuessrc - Sets the source reference on Chart Studio Cloud for values .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .


plotly.graph_objs.Heatmap([visible=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [z=], [x=], [x0=], [dx=], [y=], [y0=], [dy=], [xperiod=], [yperiod=], [xperiod0=], [yperiod0=], [xperiodalignment=], [yperiodalignment=], [text=], [hovertext=], [transpose=], [xtype=], [ytype=], [zsmooth=], [hoverongaps=], [connectgaps=], [xgap=], [ygap=], [zhoverformat=], [hovertemplate=], [showlegend=], [zauto=], [zmin=], [zmax=], [zmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [xcalendar=], [ycalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [zsrc=], [xsrc=], [ysrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=]) → Heatmap

Create a new ‘Heatmap’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • z - Sets the z data.

  • x - Sets the x coordinates.

  • x0 - Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • dx - Sets the x coordinate step. See `x0` for more info.

  • y - Sets the y coordinates.

  • y0 - Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • dy - Sets the y coordinate step. See `y0` for more info.

  • xperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the x axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • yperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the y axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • yperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • xperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

  • yperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.

  • text - Sets the text elements associated with each z value.

  • hovertext - Same as `text`.

  • transpose - Transposes the z data.

  • xtype - If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).

  • ytype - If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)

  • zsmooth - Picks a smoothing algorithm use to smooth `z` data.

  • hoverongaps - Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array and `zsmooth` is not false; otherwise it is defaulted to false.

  • xgap - Sets the horizontal gap (in pixels) between bricks.

  • ygap - Sets the vertical gap (in pixels) between bricks.

  • zhoverformat - Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • zauto - Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.

  • zmin - Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zmax - Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid - Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.

  • colorscale - Sets the colorscale. 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`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

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

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

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Heatmapgl([visible=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [z=], [x=], [x0=], [dx=], [y=], [y0=], [dy=], [text=], [transpose=], [xtype=], [ytype=], [zsmooth=], [zauto=], [zmin=], [zmax=], [zmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [zsrc=], [xsrc=], [ysrc=], [textsrc=]) → Heatmapgl

Create a new ‘Heatmapgl’ object

  • visible - 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).

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • z - Sets the z data.

  • x - Sets the x coordinates.

  • x0 - Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • dx - Sets the x coordinate step. See `x0` for more info.

  • y - Sets the y coordinates.

  • y0 - Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • dy - Sets the y coordinate step. See `y0` for more info.

  • text - Sets the text elements associated with each z value.

  • transpose - Transposes the z data.

  • xtype - If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).

  • ytype - If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)

  • zsmooth - Picks a smoothing algorithm use to smooth `z` data.

  • zauto - Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.

  • zmin - Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zmax - Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid - Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.

  • colorscale - Sets the colorscale. 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`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

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

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

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .


plotly.graph_objs.Histogram([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [x=], [y=], [text=], [hovertext=], [orientation=], [histfunc=], [histnorm=], [cumulative=], [nbinsx=], [xbins=], [nbinsy=], [ybins=], [autobinx=], [autobiny=], [bingroup=], [hovertemplate=], [marker=], [offsetgroup=], [alignmentgroup=], [selected=], [unselected=], [_deprecated=], [error_x=], [error_y=], [xcalendar=], [ycalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [xsrc=], [ysrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=]) → Histogram

Create a new ‘Histogram’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the sample data to be binned on the x axis.

  • y - Sets the sample data to be binned on the y axis.

  • text - Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.

  • hovertext - Same as `text`.

  • orientation - Sets the orientation of the bars. With *v* (*h*), the value of the each bar spans along the vertical (horizontal).

  • histfunc - Specifies the binning function used for this histogram trace. If *count*, the histogram values are computed by counting the number of values lying inside each bin. If *sum*, *avg*, *min*, *max*, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

  • histnorm - Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

  • nbinsx - Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.

  • nbinsy - Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.

  • autobinx - Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.

  • autobiny - Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace.

  • bingroup - Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same *orientation* under `barmode` *stack*, *relative* and *group* are forced into the same bingroup, Using `bingroup`, traces under `barmode` *overlay* and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same `bingroup`

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variable `binNumber` 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>`.

  • offsetgroup - Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

  • alignmentgroup - Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Histogram2d([visible=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [x=], [y=], [z=], [marker=], [histnorm=], [histfunc=], [nbinsx=], [xbins=], [nbinsy=], [ybins=], [autobinx=], [autobiny=], [bingroup=], [xbingroup=], [ybingroup=], [xgap=], [ygap=], [zsmooth=], [zhoverformat=], [hovertemplate=], [showlegend=], [zauto=], [zmin=], [zmax=], [zmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [xcalendar=], [ycalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [xsrc=], [ysrc=], [zsrc=], [hovertemplatesrc=]) → Histogram2d

Create a new ‘Histogram2d’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the sample data to be binned on the x axis.

  • y - Sets the sample data to be binned on the y axis.

  • z - Sets the aggregation data.

  • histnorm - Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

  • histfunc - Specifies the binning function used for this histogram trace. If *count*, the histogram values are computed by counting the number of values lying inside each bin. If *sum*, *avg*, *min*, *max*, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

  • nbinsx - Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.

  • nbinsy - Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.

  • autobinx - Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.

  • autobiny - Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace.

  • bingroup - Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of *1* on two histogram2d traces will make them their x-bins and y-bins match separately.

  • xbingroup - Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`

  • ybingroup - Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`

  • xgap - Sets the horizontal gap (in pixels) between bricks.

  • ygap - Sets the vertical gap (in pixels) between bricks.

  • zsmooth - Picks a smoothing algorithm use to smooth `z` data.

  • zhoverformat - Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variable `z` 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>`.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • zauto - Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.

  • zmin - Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zmax - Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid - Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.

  • colorscale - Sets the colorscale. 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`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

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

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

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Histogram2dContour([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [x=], [y=], [z=], [marker=], [histnorm=], [histfunc=], [nbinsx=], [xbins=], [nbinsy=], [ybins=], [autobinx=], [autobiny=], [bingroup=], [xbingroup=], [ybingroup=], [autocontour=], [ncontours=], [contours=], [line=], [zhoverformat=], [hovertemplate=], [zauto=], [zmin=], [zmax=], [zmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [xcalendar=], [ycalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [xsrc=], [ysrc=], [zsrc=], [hovertemplatesrc=]) → Histogram2dContour

Create a new ‘Histogram2dContour’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the sample data to be binned on the x axis.

  • y - Sets the sample data to be binned on the y axis.

  • z - Sets the aggregation data.

  • histnorm - Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

  • histfunc - Specifies the binning function used for this histogram trace. If *count*, the histogram values are computed by counting the number of values lying inside each bin. If *sum*, *avg*, *min*, *max*, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

  • nbinsx - Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.

  • nbinsy - Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.

  • autobinx - Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.

  • autobiny - Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace.

  • bingroup - Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of *1* on two histogram2d traces will make them their x-bins and y-bins match separately.

  • xbingroup - Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`

  • ybingroup - Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`

  • autocontour - Determines whether or not the contour level attributes are picked by an algorithm. If *true*, the number of contour levels can be set in `ncontours`. If *false*, set the contour level attributes in `contours`.

  • ncontours - Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is *true* or if `contours.size` is missing.

  • zhoverformat - Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variable `z` 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>`.

  • zauto - Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.

  • zmin - Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

  • zmax - Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

  • zmid - Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.

  • colorscale - Sets the colorscale. 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`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

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

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

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Image([visible=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [uirevision=], [source=], [z=], [colormodel=], [zsmooth=], [zmin=], [zmax=], [x0=], [y0=], [dx=], [dy=], [text=], [hovertext=], [hoverinfo=], [hovertemplate=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [zsrc=], [textsrc=], [hovertextsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Image

Create a new ‘Image’ object

  • visible - 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).

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • source - Specifies the data URI of the image to be visualized. The URI consists of "data:image/[<media subtype>][;base64],<data>"

  • z - A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.

  • colormodel - Color model used to map the numerical color components described in `z` into colors. If `source` is specified, this attribute will be set to `rgba256` otherwise it defaults to `rgb`.

  • zsmooth - Picks a smoothing algorithm used to smooth `z` data. This only applies for image traces that use the `source` attribute.

  • zmin - Array defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For the `rgba256` colormodel, it is [0, 0, 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the `hsla` colormodel, it is [0, 0, 0, 0].

  • zmax - Array defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [255, 255, 255]. For the `rgba` colormodel, it is [255, 255, 255, 1]. For the `rgba256` colormodel, it is [255, 255, 255, 255]. For the `hsl` colormodel, it is [360, 100, 100]. For the `hsla` colormodel, it is [360, 100, 100, 1].

  • x0 - Set the image's x position.

  • y0 - Set the image's y position.

  • dx - Set the pixel's horizontal size.

  • dy - Set the pixel's vertical size

  • text - Sets the text elements associated with each z value.

  • hovertext - Same as `text`.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variables `z`, `color` and `colormodel`. 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>`.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Indicator([visible=], [name=], [uid=], [ids=], [customdata=], [meta=], [stream=], [transform=], [uirevision=], [mode=], [value=], [align=], [domain=], [title=], [number=], [delta=], [gauge=], [idssrc=], [customdatasrc=], [metasrc=]) → Indicator

Create a new ‘Indicator’ object

  • visible - 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).

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • mode - Determines how the value is displayed on the graph. `number` displays the value numerically in text. `delta` displays the difference to a reference value in text. Finally, `gauge` displays the value graphically on an axis.

  • value - Sets the number to be displayed.

  • align - Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered

  • gauge - The gauge of the Indicator plot.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .


plotly.graph_objs.Isosurface([visible=], [legendgroup=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [uirevision=], [x=], [y=], [z=], [value=], [isomin=], [isomax=], [surface=], [spaceframe=], [slices=], [caps=], [text=], [hovertext=], [hovertemplate=], [showlegend=], [cauto=], [cmin=], [cmax=], [cmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [opacity=], [lightposition=], [lighting=], [flatshading=], [contour=], [hoverinfo=], [scene=], [idssrc=], [customdatasrc=], [metasrc=], [xsrc=], [ysrc=], [zsrc=], [valuesrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=], [hoverinfosrc=]) → Isosurface

Create a new ‘Isosurface’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the X coordinates of the vertices on X axis.

  • y - Sets the Y coordinates of the vertices on Y axis.

  • z - Sets the Z coordinates of the vertices on Z axis.

  • value - Sets the 4th dimension (value) of the vertices.

  • isomin - Sets the minimum boundary for iso-surface plot.

  • isomax - Sets the maximum boundary for iso-surface plot.

  • text - Sets the text elements associated with the vertices. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • hovertext - Same as `text`.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • cauto - Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.

  • cmin - Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.

  • cmax - Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well.

  • cmid - Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`.

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

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.

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

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

  • opacity - Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

  • flatshading - Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • scene - Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • valuesrc - Sets the source reference on Chart Studio Cloud for value .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .


plotly.graph_objs.Layout([font=], [title=], [uniformtext=], [autosize=], [width=], [height=], [margin=], [computed=], [paper_bgcolor=], [plot_bgcolor=], [autotypenumbers=], [separators=], [hidesources=], [showlegend=], [colorway=], [datarevision=], [uirevision=], [editrevision=], [selectionrevision=], [template=], [modebar=], [newshape=], [activeshape=], [meta=], [transition=], [_deprecated=], [clickmode=], [dragmode=], [hovermode=], [hoverdistance=], [spikedistance=], [hoverlabel=], [selectdirection=], [grid=], [calendar=], [xaxis=], [yaxis=], [ternary=], [scene=], [geo=], [mapbox=], [polar=], [legend=], [annotation=], [shape=], [image=], [updatemenu=], [slider=], [colorscale=], [coloraxis=], [metasrc=]) → Layout

Create a new ‘Layout’ object

  • font - Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.

  • autosize - Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.

  • width - Sets the plot's width (in px).

  • height - Sets the plot's height (in px).

  • computed - Placeholder for exporting automargin-impacting values namely `margin.t`, `margin.b`, `margin.l` and `margin.r` in *full-json* mode.

  • paper_bgcolor - Sets the background color of the paper where the graph is drawn.

  • plot_bgcolor - Sets the background color of the plotting area in-between x and y axes.

  • autotypenumbers - Using *strict* a numeric string in trace data is not converted to a number. Using *convert types* a numeric string in trace data may be treated as a number during automatic axis `type` detection. This is the default value; however it could be overridden for individual axes.

  • separators - Sets the decimal and thousand separators. For example, *. * puts a '.' before decimals and a space between thousands. In English locales, dflt is *.,* but other locales may alter this default.

  • hidesources - Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise).

  • showlegend - Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`.

  • colorway - Sets the default trace colors.

  • datarevision - If provided, a changed value tells `Plotly.react` that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, `Plotly.react` assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.

  • uirevision - Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision=*time*` and `yaxis.uirevision=*cost*`. Then if only the y data is changed, you can update `yaxis.uirevision=*quantity*` and the y axis range will reset but the x axis range will retain any user-driven zoom.

  • editrevision - Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.

  • selectionrevision - Controls persistence of user-driven changes in selected points from all traces.

  • template - Default attributes to be applied to the plot. Templates can be created from existing plots using `Plotly.makeTemplate`, or created manually. They should be objects with format: `{layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...}` `layoutTemplate` and `traceTemplate` are objects matching the attribute structure of `layout` and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: false`.

  • meta - Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenus` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}.

  • transition - Sets transition options used during Plotly.react updates.

  • clickmode - Determines the mode of single click interactions. *event* is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes *lasso* and *select*, but with no event data attached (kept for compatibility reasons). The *select* flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. *select* with `hovermode`: *x* can be confusing, consider explicitly setting `hovermode`: *closest* when using this feature. Selection events are sent accordingly as long as *event* flag is set as well. When the *event* flag is missing, `plotly_click` and `plotly_selected` events are not fired.

  • dragmode - Determines the mode of drag interactions. *select* and *lasso* apply only to scatter traces with markers or text. *orbit* and *turntable* apply only to 3D scenes.

  • hovermode - Determines the mode of hover interactions. If *closest*, a single hoverlabel will appear for the *closest* point within the `hoverdistance`. If *x* (or *y*), multiple hoverlabels will appear for multiple points at the *closest* x- (or y-) coordinate within the `hoverdistance`, with the caveat that no more than one hoverlabel will appear per trace. If *x unified* (or *y unified*), a single hoverlabel will appear multiple points at the closest x- (or y-) coordinate within the `hoverdistance` with the caveat that no more than one hoverlabel will appear per trace. In this mode, spikelines are enabled by default perpendicular to the specified axis. If false, hover interactions are disabled. If `clickmode` includes the *select* flag, `hovermode` defaults to *closest*. If `clickmode` lacks the *select* flag, it defaults to *x* or *y* (depending on the trace's `orientation` value) for plots based on cartesian coordinates. For anything else the default value is *closest*.

  • hoverdistance - Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict.

  • spikedistance - Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.

  • selectdirection - When `dragmode` is set to *select*, this limits the selection of the drag to horizontal, vertical or diagonal. *h* only allows horizontal selection, *v* only vertical, *d* only diagonal and *any* sets no limit.

  • calendar - Sets the default calendar system to use for interpreting and displaying dates throughout the plot.

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .


plotly.graph_objs.Mesh3d([visible=], [legendgroup=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [uirevision=], [x=], [y=], [z=], [i=], [j=], [k=], [text=], [hovertext=], [hovertemplate=], [delaunayaxis=], [alphahull=], [intensity=], [intensitymode=], [color=], [vertexcolor=], [facecolor=], [cauto=], [cmin=], [cmax=], [cmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [opacity=], [flatshading=], [contour=], [lightposition=], [lighting=], [hoverinfo=], [showlegend=], [xcalendar=], [ycalendar=], [zcalendar=], [scene=], [idssrc=], [customdatasrc=], [metasrc=], [xsrc=], [ysrc=], [zsrc=], [isrc=], [jsrc=], [ksrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=], [intensitysrc=], [vertexcolorsrc=], [facecolorsrc=], [hoverinfosrc=]) → Mesh3d

Create a new ‘Mesh3d’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the X coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.

  • y - Sets the Y coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.

  • z - Sets the Z coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.

  • i - A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the *first* vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `i[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `i` represents a point in space, which is the first vertex of a triangle.

  • j - A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the *second* vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `j[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `j` represents a point in space, which is the second vertex of a triangle.

  • k - A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the *third* vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `k[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `k` represents a point in space, which is the third vertex of a triangle.

  • text - Sets the text elements associated with the vertices. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • hovertext - Same as `text`.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • delaunayaxis - Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if `i`, `j`, `k` are not provided and `alphahull` is set to indicate Delaunay triangulation.

  • alphahull - Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays are not supplied. For general use of `mesh3d` it is preferred that `i`, `j`, `k` are supplied. If *-1*, Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to `delaunayaxis`. In case the `delaunayaxis` intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of `delaunayaxis`. If *>0*, the alpha-shape algorithm is used. In this case, the positive `alphahull` value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If *0*, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the `x`, `y` and `z` point set into a convex hull.

  • intensity - Sets the intensity values for vertices or cells as defined by `intensitymode`. It can be used for plotting fields on meshes.

  • intensitymode - Determines the source of `intensity` values.

  • color - Sets the color of the whole mesh

  • vertexcolor - Sets the color of each vertex Overrides *color*. While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.

  • facecolor - Sets the color of each face Overrides *color* and *vertexcolor*.

  • cauto - Determines whether or not the color domain is computed with respect to the input data (here `intensity`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.

  • cmin - Sets the lower bound of the color domain. Value should have the same units as `intensity` and if set, `cmax` must be set as well.

  • cmax - Sets the upper bound of the color domain. Value should have the same units as `intensity` and if set, `cmin` must be set as well.

  • cmid - Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `intensity`. Has no effect when `cauto` is `false`.

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

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.

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

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

  • opacity - Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

  • flatshading - Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • zcalendar - Sets the calendar system to use with `z` date data.

  • scene - Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • isrc - Sets the source reference on Chart Studio Cloud for i .

  • jsrc - Sets the source reference on Chart Studio Cloud for j .

  • ksrc - Sets the source reference on Chart Studio Cloud for k .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • intensitysrc - Sets the source reference on Chart Studio Cloud for intensity .

  • vertexcolorsrc - Sets the source reference on Chart Studio Cloud for vertexcolor .

  • facecolorsrc - Sets the source reference on Chart Studio Cloud for facecolor .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .


plotly.graph_objs.Ohlc([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverinfo=], [stream=], [transform=], [uirevision=], [xperiod=], [xperiod0=], [xperiodalignment=], [x=], [open=], [high=], [low=], [close=], [line=], [increasing=], [decreasing=], [text=], [hovertext=], [tickwidth=], [hoverlabel=], [xcalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [xsrc=], [opensrc=], [highsrc=], [lowsrc=], [closesrc=], [textsrc=], [hovertextsrc=]) → Ohlc

Create a new ‘Ohlc’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • xperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the x axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • xperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

  • x - Sets the x coordinates. If absent, linear coordinate will be generated.

  • open - Sets the open values.

  • high - Sets the high values.

  • low - Sets the low values.

  • close - Sets the close values.

  • text - Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.

  • hovertext - Same as `text`.

  • tickwidth - Sets the width of the open/close tick marks relative to the *x* minimal interval.

  • xcalendar - Sets the calendar system to use with `x` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • opensrc - Sets the source reference on Chart Studio Cloud for open .

  • highsrc - Sets the source reference on Chart Studio Cloud for high .

  • lowsrc - Sets the source reference on Chart Studio Cloud for low .

  • closesrc - Sets the source reference on Chart Studio Cloud for close .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .


plotly.graph_objs.Parcats([visible=], [name=], [uid=], [meta=], [stream=], [transform=], [uirevision=], [domain=], [hoverinfo=], [hoveron=], [hovertemplate=], [arrangement=], [bundlecolors=], [sortpaths=], [labelfont=], [tickfont=], [dimension=], [line=], [counts=], [metasrc=], [countssrc=]) → Parcats

Create a new ‘Parcats’ object

  • visible - 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).

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • hoveron - Sets the hover interaction mode for the parcats diagram. If `category`, hover interaction take place per category. If `color`, hover interactions take place per color per category. If `dimension`, hover interactions take place across all categories per dimension.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variables `count`, `probability`, `category`, `categorycount`, `colorcount` and `bandcolorcount`. 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>`.

  • arrangement - Sets the drag interaction mode for categories and dimensions. If `perpendicular`, the categories can only move along a line perpendicular to the paths. If `freeform`, the categories can freely move on the plane. If `fixed`, the categories and dimensions are stationary.

  • bundlecolors - Sort paths so that like colors are bundled together within each category.

  • sortpaths - Sets the path sorting algorithm. If `forward`, sort paths based on dimension categories from left to right. If `backward`, sort paths based on dimensions categories from right to left.

  • labelfont - Sets the font for the `dimension` labels.

  • tickfont - Sets the font for the `category` labels.

  • dimension - The dimensions (variables) of the parallel categories diagram.

  • counts - The number of observations represented by each state. Defaults to 1 so that each state represents one observation

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • countssrc - Sets the source reference on Chart Studio Cloud for counts .


plotly.graph_objs.Parcoords([visible=], [name=], [uid=], [ids=], [customdata=], [meta=], [stream=], [transform=], [uirevision=], [domain=], [labelangle=], [labelside=], [labelfont=], [tickfont=], [rangefont=], [dimension=], [line=], [idssrc=], [customdatasrc=], [metasrc=]) → Parcoords

Create a new ‘Parcoords’ object

  • visible - 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).

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • labelangle - Sets the angle of the labels with respect to the horizontal. For example, a `tickangle` of -90 draws the labels vertically. Tilted labels with *labelangle* may be positioned better inside margins when `labelposition` is set to *bottom*.

  • labelside - Specifies the location of the `label`. *top* positions labels above, next to the title *bottom* positions labels below the graph Tilted labels with *labelangle* may be positioned better inside margins when `labelposition` is set to *bottom*.

  • labelfont - Sets the font for the `dimension` labels.

  • tickfont - Sets the font for the `dimension` tick values.

  • rangefont - Sets the font for the `dimension` range values.

  • dimension - The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .


plotly.graph_objs.Pie([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [transform=], [uirevision=], [labels=], [label0=], [dlabel=], [values=], [marker=], [text=], [hovertext=], [scalegroup=], [textinfo=], [hoverinfo=], [hovertemplate=], [texttemplate=], [textposition=], [textfont=], [insidetextorientation=], [insidetextfont=], [outsidetextfont=], [automargin=], [title=], [domain=], [hole=], [sort=], [direction=], [rotation=], [pull=], [_deprecated=], [idssrc=], [customdatasrc=], [metasrc=], [labelssrc=], [valuessrc=], [textsrc=], [hovertextsrc=], [hoverinfosrc=], [hovertemplatesrc=], [texttemplatesrc=], [textpositionsrc=], [pullsrc=]) → Pie

Create a new ‘Pie’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • labels - Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

  • label0 - Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.

  • dlabel - Sets the label step. See `label0` for more info.

  • values - Sets the values of the sectors. If omitted, we count occurrences of each label.

  • text - Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • hovertext - Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* flag.

  • scalegroup - If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

  • textinfo - Determines which trace information appear on the graph.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variables `label`, `color`, `value`, `percent` and `text`. 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>`.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `percent` and `text`.

  • textposition - Specifies the location of the `textinfo`.

  • textfont - Sets the font used for `textinfo`.

  • insidetextorientation - Controls the orientation of the text inside chart sectors. When set to *auto*, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The *horizontal* option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The *radial* option orients text along the radius of the sector. The *tangential* option orients text perpendicular to the radius of the sector.

  • insidetextfont - Sets the font used for `textinfo` lying inside the sector.

  • outsidetextfont - Sets the font used for `textinfo` lying outside the sector.

  • automargin - Determines whether outside text labels can push the margins.

  • hole - Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.

  • sort - Determines whether or not the sectors are reordered from largest to smallest.

  • direction - Specifies the direction at which succeeding sectors follow one another.

  • rotation - Instead of the first slice starting at 12 o'clock, rotate to some other angle.

  • pull - Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • labelssrc - Sets the source reference on Chart Studio Cloud for labels .

  • valuessrc - Sets the source reference on Chart Studio Cloud for values .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .

  • pullsrc - Sets the source reference on Chart Studio Cloud for pull .


plotly.graph_objs.Pointcloud([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverinfo=], [hoverlabel=], [stream=], [uirevision=], [x=], [y=], [xy=], [indices=], [xbounds=], [ybounds=], [text=], [marker=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [xsrc=], [ysrc=], [xysrc=], [indicessrc=], [xboundssrc=], [yboundssrc=], [textsrc=]) → Pointcloud

Create a new ‘Pointcloud’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the x coordinates.

  • y - Sets the y coordinates.

  • xy - Faster alternative to specifying `x` and `y` separately. If supplied, it must be a typed `Float32Array` array that represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]`

  • indices - A sequential value, 0..n, supply it to avoid creating this array inside plotting. If specified, it must be a typed `Int32Array` array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large `indices` typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each `Plotly.restyle()` call.

  • xbounds - Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `ybounds` for the performance benefits.

  • ybounds - Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `xbounds` for the performance benefits.

  • text - Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • xysrc - Sets the source reference on Chart Studio Cloud for xy .

  • indicessrc - Sets the source reference on Chart Studio Cloud for indices .

  • xboundssrc - Sets the source reference on Chart Studio Cloud for xbounds .

  • yboundssrc - Sets the source reference on Chart Studio Cloud for ybounds .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .


plotly.graph_objs.Sankey([visible=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [stream=], [uirevision=], [hoverinfo=], [hoverlabel=], [domain=], [orientation=], [valueformat=], [valuesuffix=], [arrangement=], [textfont=], [node=], [link=], [idssrc=], [customdatasrc=], [metasrc=]) → Sankey

Create a new ‘Sankey’ object

  • visible - 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).

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. Note that this attribute is superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively.

  • orientation - Sets the orientation of the Sankey diagram.

  • valueformat - Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

  • valuesuffix - Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.

  • arrangement - If value is `snap` (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via `nodepad`. If value is `perpendicular`, the nodes can only move along a line perpendicular to the flow. If value is `freeform`, the nodes can freely move on the plane. If value is `fixed`, the nodes are stationary.

  • textfont - Sets the font for node labels

  • node - The nodes of the Sankey plot.

  • link - The links of the Sankey plot.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .


plotly.graph_objs.Scatter([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [x=], [x0=], [dx=], [y=], [y0=], [dy=], [xperiod=], [yperiod=], [xperiod0=], [yperiod0=], [xperiodalignment=], [yperiodalignment=], [stackgroup=], [orientation=], [groupnorm=], [stackgaps=], [text=], [texttemplate=], [hovertext=], [mode=], [hoveron=], [hovertemplate=], [line=], [connectgaps=], [cliponaxis=], [fill=], [fillcolor=], [marker=], [selected=], [unselected=], [textposition=], [textfont=], [error_x=], [error_y=], [xcalendar=], [ycalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [xsrc=], [ysrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [hovertemplatesrc=], [textpositionsrc=]) → Scatter

Create a new ‘Scatter’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the x coordinates.

  • x0 - Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • dx - Sets the x coordinate step. See `x0` for more info.

  • y - Sets the y coordinates.

  • y0 - Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • dy - Sets the y coordinate step. See `y0` for more info.

  • xperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the x axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • yperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the y axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • yperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • xperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

  • yperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.

  • stackgroup - Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if `orientation` is *h*). If blank or omitted this trace will not be stacked. Stacking also turns `fill` on by default, using *tonexty* (*tonextx*) if `orientation` is *h* (*v*) and sets the default `mode` to *lines* irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

  • orientation - Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is *legendonly* but not if it is `false`. Sets the stacking direction. With *v* (*h*), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.

  • groupnorm - Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used - including if `visible` is *legendonly* but not if it is `false`. Sets the normalization for the sum of this `stackgroup`. With *fraction*, the value of each trace at each location is divided by the sum of all trace values at that location. *percent* is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.

  • stackgaps - Only relevant when `stackgroup` is used, and only the first `stackgaps` found in the `stackgroup` will be used - including if `visible` is *legendonly* but not if it is `false`. Determines how we handle locations at which other traces in this group have data but this one does not. With *infer zero* we insert a zero at these locations. With *interpolate* we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.

  • text - Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.

  • hovertext - Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • mode - Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` 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*.

  • hoveron - 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • 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` and `yaxis.layer` to *below traces*.

  • fill - Sets the area to fill with a solid color. Defaults to *none* unless this trace is stacked, then it gets *tonexty* (*tonextx*) if `orientation` is *v* (*h*) Use with `fillcolor` if not *none*. *tozerox* and *tozeroy* fill to x=0 and y=0 respectively. *tonextx* and *tonexty* fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like *tozerox* and *tozeroy*. *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. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

  • fillcolor - Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

  • textposition - Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • textfont - Sets the text font.

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .


plotly.graph_objs.Scatter3d([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [transform=], [uirevision=], [x=], [y=], [z=], [text=], [texttemplate=], [hovertext=], [hovertemplate=], [mode=], [surfaceaxis=], [surfacecolor=], [projection=], [connectgaps=], [line=], [marker=], [textposition=], [textfont=], [hoverinfo=], [error_x=], [error_y=], [error_z=], [xcalendar=], [ycalendar=], [zcalendar=], [scene=], [idssrc=], [customdatasrc=], [metasrc=], [xsrc=], [ysrc=], [zsrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [hovertemplatesrc=], [textpositionsrc=], [hoverinfosrc=]) → Scatter3d

Create a new ‘Scatter3d’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the x coordinates.

  • y - Sets the y coordinates.

  • z - Sets the z coordinates.

  • text - Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.

  • hovertext - Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • mode - Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` 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*.

  • surfaceaxis - If *-1*, the scatter points are not fill with a surface If *0*, *1*, *2*, the scatter points are filled with a Delaunay surface about the x, y, z respectively.

  • surfacecolor - Sets the surface fill color.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • textposition - Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • zcalendar - Sets the calendar system to use with `z` date data.

  • scene - Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .


plotly.graph_objs.Scattercarpet([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [carpet=], [a=], [b=], [mode=], [text=], [texttemplate=], [hovertext=], [line=], [connectgaps=], [fill=], [fillcolor=], [marker=], [textfont=], [textposition=], [selected=], [unselected=], [hoverinfo=], [hoveron=], [hovertemplate=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [asrc=], [bsrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [textpositionsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Scattercarpet

Create a new ‘Scattercarpet’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • carpet - An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie

  • a - Sets the a-axis coordinates.

  • b - Sets the b-axis coordinates.

  • mode - Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` 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*.

  • text - Sets text elements associated with each (a,b) 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). If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `a`, `b` and `text`.

  • hovertext - Sets hover text elements associated with each (a,b) 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). To be seen, trace `hoverinfo` must contain a *text* flag.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

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

  • textfont - Sets the text font.

  • textposition - Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • hoveron - 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • asrc - Sets the source reference on Chart Studio Cloud for a .

  • bsrc - Sets the source reference on Chart Studio Cloud for b .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Scattergeo([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [lon=], [lat=], [locations=], [locationmode=], [geojson=], [featureidkey=], [mode=], [text=], [texttemplate=], [hovertext=], [textfont=], [textposition=], [line=], [connectgaps=], [marker=], [fill=], [fillcolor=], [selected=], [unselected=], [hoverinfo=], [hovertemplate=], [geo=], [idssrc=], [customdatasrc=], [metasrc=], [lonsrc=], [latsrc=], [locationssrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [textpositionsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Scattergeo

Create a new ‘Scattergeo’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • lon - Sets the longitude coordinates (in degrees East).

  • lat - Sets the latitude coordinates (in degrees North).

  • locations - Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.

  • locationmode - Determines the set of locations used to match entries in `locations` to regions on the map. Values *ISO-3*, *USA-states*, *country names* correspond to features on the base map and value *geojson-id* corresponds to features from a custom GeoJSON linked to the `geojson` attribute.

  • geojson - Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when `locations` is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*.

  • featureidkey - Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example *properties.name*.

  • mode - Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` 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*.

  • text - Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `lat`, `lon`, `location` and `text`.

  • hovertext - Sets hover text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • textfont - Sets the text font.

  • textposition - Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • fill - Sets the area to fill with a solid color. Use with `fillcolor` if not *none*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

  • 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` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • geo - Sets a reference between this trace's geospatial coordinates and a geographic map. If *geo* (the default value), the geospatial coordinates refer to `layout.geo`. If *geo2*, the geospatial coordinates refer to `layout.geo2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • lonsrc - Sets the source reference on Chart Studio Cloud for lon .

  • latsrc - Sets the source reference on Chart Studio Cloud for lat .

  • locationssrc - Sets the source reference on Chart Studio Cloud for locations .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Scattergl([visible=], [showlegend=], [legendgroup=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [x=], [x0=], [dx=], [y=], [y0=], [dy=], [xperiod=], [yperiod=], [xperiod0=], [yperiod0=], [xperiodalignment=], [yperiodalignment=], [text=], [hovertext=], [textposition=], [textfont=], [mode=], [line=], [marker=], [connectgaps=], [fill=], [fillcolor=], [selected=], [unselected=], [opacity=], [hovertemplate=], [texttemplate=], [error_x=], [error_y=], [xcalendar=], [ycalendar=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [xsrc=], [ysrc=], [textsrc=], [hovertextsrc=], [textpositionsrc=], [hovertemplatesrc=], [texttemplatesrc=]) → Scattergl

Create a new ‘Scattergl’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the x coordinates.

  • x0 - Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • dx - Sets the x coordinate step. See `x0` for more info.

  • y - Sets the y coordinates.

  • y0 - Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • dy - Sets the y coordinate step. See `y0` for more info.

  • xperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the x axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • yperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the y axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • yperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • xperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

  • yperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.

  • text - Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • hovertext - Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • textposition - Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • textfont - Sets the text font.

  • mode - Determines the drawing mode for this scatter trace.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • fill - Sets the area to fill with a solid color. Defaults to *none* unless this trace is stacked, then it gets *tonexty* (*tonextx*) if `orientation` is *v* (*h*) Use with `fillcolor` if not *none*. *tozerox* and *tozeroy* fill to x=0 and y=0 respectively. *tonextx* and *tonexty* fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like *tozerox* and *tozeroy*. *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. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

  • fillcolor - Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

  • opacity - Sets the opacity of the trace.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .


plotly.graph_objs.Scattermapbox([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [lon=], [lat=], [mode=], [text=], [texttemplate=], [hovertext=], [line=], [connectgaps=], [marker=], [fill=], [fillcolor=], [textfont=], [textposition=], [below=], [selected=], [unselected=], [hoverinfo=], [hovertemplate=], [subplot=], [idssrc=], [customdatasrc=], [metasrc=], [lonsrc=], [latsrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Scattermapbox

Create a new ‘Scattermapbox’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • lon - Sets the longitude coordinates (in degrees East).

  • lat - Sets the latitude coordinates (in degrees North).

  • mode - Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover.

  • text - Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `lat`, `lon` and `text`.

  • hovertext - Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • fill - Sets the area to fill with a solid color. Use with `fillcolor` if not *none*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

  • fillcolor - Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

  • textfont - Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size). Has an effect only when `type` is set to *symbol*.

  • textposition - Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • below - Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to *''*.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • subplot - Sets a reference between this trace's data coordinates and a mapbox subplot. If *mapbox* (the default value), the data refer to `layout.mapbox`. If *mapbox2*, the data refer to `layout.mapbox2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • lonsrc - Sets the source reference on Chart Studio Cloud for lon .

  • latsrc - Sets the source reference on Chart Studio Cloud for lat .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Scatterpolar([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [mode=], [r=], [theta=], [r0=], [dr=], [theta0=], [dtheta=], [thetaunit=], [text=], [texttemplate=], [hovertext=], [line=], [connectgaps=], [marker=], [cliponaxis=], [textposition=], [textfont=], [fill=], [fillcolor=], [hoverinfo=], [hoveron=], [hovertemplate=], [selected=], [unselected=], [subplot=], [idssrc=], [customdatasrc=], [metasrc=], [rsrc=], [thetasrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [textpositionsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Scatterpolar

Create a new ‘Scatterpolar’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • mode - Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` 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*.

  • r - Sets the radial coordinates

  • theta - Sets the angular coordinates

  • r0 - Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.

  • dr - Sets the r coordinate step.

  • theta0 - Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.

  • dtheta - Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.

  • thetaunit - Sets the unit of input *theta* values. Has an effect only when on *linear* angular axes.

  • text - Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `r`, `theta` and `text`.

  • hovertext - Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • 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` and `yaxis.layer` to *below traces*.

  • textposition - Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • textfont - Sets the text font.

  • fill - Sets the area to fill with a solid color. Use with `fillcolor` if not *none*. scatterpolar 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` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • hoveron - 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • subplot - Sets a reference between this trace's data coordinates and a polar subplot. If *polar* (the default value), the data refer to `layout.polar`. If *polar2*, the data refer to `layout.polar2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • rsrc - Sets the source reference on Chart Studio Cloud for r .

  • thetasrc - Sets the source reference on Chart Studio Cloud for theta .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Scatterpolargl([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [mode=], [r=], [theta=], [r0=], [dr=], [theta0=], [dtheta=], [thetaunit=], [text=], [texttemplate=], [hovertext=], [hovertemplate=], [line=], [connectgaps=], [marker=], [fill=], [fillcolor=], [textposition=], [textfont=], [hoverinfo=], [selected=], [unselected=], [subplot=], [idssrc=], [customdatasrc=], [metasrc=], [rsrc=], [thetasrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [hovertemplatesrc=], [textpositionsrc=], [hoverinfosrc=]) → Scatterpolargl

Create a new ‘Scatterpolargl’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • mode - Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` 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*.

  • r - Sets the radial coordinates

  • theta - Sets the angular coordinates

  • r0 - Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.

  • dr - Sets the r coordinate step.

  • theta0 - Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.

  • dtheta - Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.

  • thetaunit - Sets the unit of input *theta* values. Has an effect only when on *linear* angular axes.

  • text - Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `r`, `theta` and `text`.

  • hovertext - Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • fill - Sets the area to fill with a solid color. Defaults to *none* unless this trace is stacked, then it gets *tonexty* (*tonextx*) if `orientation` is *v* (*h*) Use with `fillcolor` if not *none*. *tozerox* and *tozeroy* fill to x=0 and y=0 respectively. *tonextx* and *tonexty* fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like *tozerox* and *tozeroy*. *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. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

  • fillcolor - Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

  • textposition - Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • textfont - Sets the text font.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • subplot - Sets a reference between this trace's data coordinates and a polar subplot. If *polar* (the default value), the data refer to `layout.polar`. If *polar2*, the data refer to `layout.polar2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • rsrc - Sets the source reference on Chart Studio Cloud for r .

  • thetasrc - Sets the source reference on Chart Studio Cloud for theta .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .


plotly.graph_objs.Scatterternary([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [a=], [b=], [c=], [sum=], [mode=], [text=], [texttemplate=], [hovertext=], [line=], [connectgaps=], [cliponaxis=], [fill=], [fillcolor=], [marker=], [textfont=], [textposition=], [selected=], [unselected=], [hoverinfo=], [hoveron=], [hovertemplate=], [subplot=], [idssrc=], [customdatasrc=], [metasrc=], [asrc=], [bsrc=], [csrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [textpositionsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Scatterternary

Create a new ‘Scatterternary’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • a - Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.

  • b - Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.

  • c - Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.

  • sum - The number each triplet should sum to, if only two of `a`, `b`, and `c` are provided. This overrides `ternary<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>.sum

  • mode - Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` 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*.

  • text - 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.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `a`, `b`, `c` and `text`.

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

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • 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` and `yaxis.layer` to *below traces*.

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

  • textfont - Sets the text font.

  • textposition - Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • hoveron - 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • subplot - 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 to `layout.ternary2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • asrc - Sets the source reference on Chart Studio Cloud for a .

  • bsrc - Sets the source reference on Chart Studio Cloud for b .

  • csrc - Sets the source reference on Chart Studio Cloud for c .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Splom([visible=], [showlegend=], [legendgroup=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [dimension=], [text=], [hovertext=], [hovertemplate=], [marker=], [xaxes=], [yaxes=], [diagonal=], [showupperhalf=], [showlowerhalf=], [selected=], [unselected=], [opacity=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=]) → Splom

Create a new ‘Splom’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • text - Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.

  • hovertext - Same as `text`.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • xaxes - Sets the list of x axes corresponding to dimensions of this splom trace. By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is false and `showupperhalf` or `showlowerhalf` is false, this splom trace will generate one less x-axis and one less y-axis.

  • yaxes - Sets the list of y axes corresponding to dimensions of this splom trace. By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is false and `showupperhalf` or `showlowerhalf` is false, this splom trace will generate one less x-axis and one less y-axis.

  • showupperhalf - Determines whether or not subplots on the upper half from the diagonal are displayed.

  • showlowerhalf - Determines whether or not subplots on the lower half from the diagonal are displayed.

  • opacity - Sets the opacity of the trace.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Streamtube([visible=], [legendgroup=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [uirevision=], [x=], [y=], [z=], [u=], [v=], [w=], [starts=], [maxdisplayed=], [sizeref=], [text=], [hovertext=], [hovertemplate=], [showlegend=], [cauto=], [cmin=], [cmax=], [cmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [opacity=], [lightposition=], [lighting=], [hoverinfo=], [scene=], [idssrc=], [customdatasrc=], [metasrc=], [xsrc=], [ysrc=], [zsrc=], [usrc=], [vsrc=], [wsrc=], [hovertemplatesrc=], [hoverinfosrc=]) → Streamtube

Create a new ‘Streamtube’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the x coordinates of the vector field.

  • y - Sets the y coordinates of the vector field.

  • z - Sets the z coordinates of the vector field.

  • u - Sets the x components of the vector field.

  • v - Sets the y components of the vector field.

  • w - Sets the z components of the vector field.

  • maxdisplayed - The maximum number of displayed segments in a streamtube.

  • sizeref - The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.

  • text - Sets a text element associated with this trace. If trace `hoverinfo` contains a *text* flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array `text` values.

  • hovertext - Same as `text`.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variables `tubex`, `tubey`, `tubez`, `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. 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>`.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • cauto - Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.

  • cmin - Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well.

  • cmax - Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well.

  • cmid - Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`.

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

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.

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

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

  • opacity - Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • scene - Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • usrc - Sets the source reference on Chart Studio Cloud for u .

  • vsrc - Sets the source reference on Chart Studio Cloud for v .

  • wsrc - Sets the source reference on Chart Studio Cloud for w .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .


plotly.graph_objs.Sunburst([visible=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [transform=], [uirevision=], [labels=], [parents=], [values=], [branchvalues=], [count=], [level=], [maxdepth=], [marker=], [leaf=], [text=], [textinfo=], [texttemplate=], [hovertext=], [hoverinfo=], [hovertemplate=], [textfont=], [insidetextorientation=], [insidetextfont=], [outsidetextfont=], [rotation=], [sort=], [root=], [domain=], [idssrc=], [customdatasrc=], [metasrc=], [labelssrc=], [parentssrc=], [valuessrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Sunburst

Create a new ‘Sunburst’ object

  • visible - 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).

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • labels - Sets the labels of each of the sectors.

  • parents - Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique.

  • values - Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed.

  • branchvalues - Determines how the items in `values` are summed. When set to *total*, items in `values` are taken to be value of all its descendants. When set to *remainder*, items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

  • count - Determines default for `values` when it is not provided, by inferring a 1 for each of the *leaves* and/or *branches*, otherwise 0.

  • level - Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`.

  • maxdepth - Sets the number of rendered sectors from any given `level`. Set `maxdepth` to *-1* to render all the levels in the hierarchy.

  • text - Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • textinfo - Determines which trace information appear on the graph.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`.

  • hovertext - Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* flag.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. 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>`.

  • textfont - Sets the font used for `textinfo`.

  • insidetextorientation - Controls the orientation of the text inside chart sectors. When set to *auto*, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The *horizontal* option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The *radial* option orients text along the radius of the sector. The *tangential* option orients text perpendicular to the radius of the sector.

  • insidetextfont - Sets the font used for `textinfo` lying inside the sector.

  • outsidetextfont - Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented at the center of a sunburst graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used.

  • rotation - Rotates the whole diagram counterclockwise by some angle. By default the first slice starts at 3 o'clock.

  • sort - Determines whether or not the sectors are reordered from largest to smallest.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • labelssrc - Sets the source reference on Chart Studio Cloud for labels .

  • parentssrc - Sets the source reference on Chart Studio Cloud for parents .

  • valuessrc - Sets the source reference on Chart Studio Cloud for values .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Surface([visible=], [legendgroup=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [uirevision=], [z=], [x=], [y=], [text=], [hovertext=], [hovertemplate=], [connectgaps=], [surfacecolor=], [cauto=], [cmin=], [cmax=], [cmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [contours=], [hidesurface=], [lightposition=], [lighting=], [opacity=], [opacityscale=], [_deprecated=], [hoverinfo=], [showlegend=], [xcalendar=], [ycalendar=], [zcalendar=], [scene=], [idssrc=], [customdatasrc=], [metasrc=], [zsrc=], [xsrc=], [ysrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=], [surfacecolorsrc=], [hoverinfosrc=]) → Surface

Create a new ‘Surface’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • z - Sets the z coordinates.

  • x - Sets the x coordinates.

  • y - Sets the y coordinates.

  • text - Sets the text elements associated with each z value. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • hovertext - Same as `text`.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • connectgaps - Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.

  • surfacecolor - Sets the surface color values, used for setting a color scale independent of `z`.

  • cauto - Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.

  • cmin - Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmax` must be set as well.

  • cmax - Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmin` must be set as well.

  • cmid - Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when `cauto` is `false`.

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

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.

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

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

  • hidesurface - Determines whether or not a surface is drawn. For example, set `hidesurface` to *false* `contours.x.show` to *true* and `contours.y.show` to *true* to draw a wire frame plot.

  • opacity - Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

  • opacityscale - Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • xcalendar - Sets the calendar system to use with `x` date data.

  • ycalendar - Sets the calendar system to use with `y` date data.

  • zcalendar - Sets the calendar system to use with `z` date data.

  • scene - Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • surfacecolorsrc - Sets the source reference on Chart Studio Cloud for surfacecolor .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .


plotly.graph_objs.Table([visible=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverinfo=], [hoverlabel=], [stream=], [uirevision=], [domain=], [columnwidth=], [columnorder=], [header=], [cells=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [columnwidthsrc=], [columnordersrc=]) → Table

Create a new ‘Table’ object

  • visible - 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).

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • columnwidth - The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.

  • columnorder - Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column index `0` in the data will be rendered as the third column, as columns have an index base of zero.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • columnwidthsrc - Sets the source reference on Chart Studio Cloud for columnwidth .

  • columnordersrc - Sets the source reference on Chart Studio Cloud for columnorder .


plotly.graph_objs.Treemap([visible=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [transform=], [uirevision=], [labels=], [parents=], [values=], [branchvalues=], [count=], [level=], [maxdepth=], [tiling=], [marker=], [pathbar=], [text=], [textinfo=], [texttemplate=], [hovertext=], [hoverinfo=], [hovertemplate=], [textfont=], [insidetextfont=], [outsidetextfont=], [textposition=], [sort=], [root=], [domain=], [idssrc=], [customdatasrc=], [metasrc=], [labelssrc=], [parentssrc=], [valuessrc=], [textsrc=], [texttemplatesrc=], [hovertextsrc=], [hoverinfosrc=], [hovertemplatesrc=]) → Treemap

Create a new ‘Treemap’ object

  • visible - 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).

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • labels - Sets the labels of each of the sectors.

  • parents - Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique.

  • values - Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed.

  • branchvalues - Determines how the items in `values` are summed. When set to *total*, items in `values` are taken to be value of all its descendants. When set to *remainder*, items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

  • count - Determines default for `values` when it is not provided, by inferring a 1 for each of the *leaves* and/or *branches*, otherwise 0.

  • level - Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`.

  • maxdepth - Sets the number of rendered sectors from any given `level`. Set `maxdepth` to *-1* to render all the levels in the hierarchy.

  • text - Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • textinfo - Determines which trace information appear on the graph.

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`.

  • hovertext - Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* flag.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. 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>`.

  • textfont - Sets the font used for `textinfo`.

  • insidetextfont - Sets the font used for `textinfo` lying inside the sector.

  • outsidetextfont - Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used.

  • textposition - Sets the positions of the `text` elements.

  • sort - Determines whether or not the sectors are reordered from largest to smallest.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • labelssrc - Sets the source reference on Chart Studio Cloud for labels .

  • parentssrc - Sets the source reference on Chart Studio Cloud for parents .

  • valuessrc - Sets the source reference on Chart Studio Cloud for values .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Violin([visible=], [showlegend=], [legendgroup=], [opacity=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverinfo=], [hoverlabel=], [stream=], [transform=], [uirevision=], [y=], [x=], [x0=], [y0=], [name=], [orientation=], [bandwidth=], [scalegroup=], [scalemode=], [spanmode=], [span=], [line=], [fillcolor=], [points=], [jitter=], [pointpos=], [width=], [marker=], [text=], [hovertext=], [hovertemplate=], [box=], [meanline=], [side=], [offsetgroup=], [alignmentgroup=], [selected=], [unselected=], [hoveron=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [hoverinfosrc=], [ysrc=], [xsrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=]) → Violin

Create a new ‘Violin’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • y - Sets the y sample data or coordinates. See overview for more info.

  • x - Sets the x sample data or coordinates. See overview for more info.

  • x0 - Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

  • y0 - Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

  • name - Sets the trace name. The trace name appear as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute `scalegroup` (please see its description for details).

  • orientation - Sets the orientation of the violin(s). If *v* (*h*), the distribution is visualized along the vertical (horizontal).

  • bandwidth - Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb.

  • scalegroup - If there are multiple violins that should be sized according to to some metric (see `scalemode`), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's `width` is undefined, `scalegroup` will default to the trace's name. In this case, violins with the same names will be linked together

  • scalemode - Sets the metric by which the width of each violin is determined.*width* means each violin has the same (max) width*count* means the violins are scaled by the number of sample points makingup each violin.

  • spanmode - Sets the method by which the span in data space where the density function will be computed. *soft* means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. *hard* means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode *manual* and fill in the `span` attribute.

  • span - Sets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to *manual*.

  • fillcolor - Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

  • points - If *outliers*, only the sample points lying outside the whiskers are shown If *suspectedoutliers*, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If *all*, all sample points are shown If *false*, only the violins are shown with no sample points. Defaults to *suspectedoutliers* when `marker.outliercolor` or `marker.line.outliercolor` is set, otherwise defaults to *outliers*.

  • jitter - Sets the amount of jitter in the sample points drawn. If *0*, the sample points align along the distribution axis. If *1*, the sample points are drawn in a random jitter of width equal to the width of the violins.

  • pointpos - Sets the position of the sample points in relation to the violins. If *0*, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.

  • width - Sets the width of the violin in data coordinates. If *0* (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.

  • text - Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • hovertext - Same as `text`.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • side - Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under *overlay* mode, where one trace has `side` set to *positive* and the other to *negative*.

  • offsetgroup - Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

  • alignmentgroup - Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

  • hoveron - Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .


plotly.graph_objs.Volume([visible=], [legendgroup=], [name=], [uid=], [ids=], [customdata=], [meta=], [hoverlabel=], [stream=], [uirevision=], [x=], [y=], [z=], [value=], [isomin=], [isomax=], [surface=], [spaceframe=], [slices=], [caps=], [text=], [hovertext=], [hovertemplate=], [cauto=], [cmin=], [cmax=], [cmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=], [coloraxis=], [opacity=], [opacityscale=], [lightposition=], [lighting=], [flatshading=], [contour=], [hoverinfo=], [showlegend=], [scene=], [idssrc=], [customdatasrc=], [metasrc=], [xsrc=], [ysrc=], [zsrc=], [valuesrc=], [textsrc=], [hovertextsrc=], [hovertemplatesrc=], [hoverinfosrc=]) → Volume

Create a new ‘Volume’ object

  • visible - 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).

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • x - Sets the X coordinates of the vertices on X axis.

  • y - Sets the Y coordinates of the vertices on Y axis.

  • z - Sets the Z coordinates of the vertices on Z axis.

  • value - Sets the 4th dimension (value) of the vertices.

  • isomin - Sets the minimum boundary for iso-surface plot.

  • isomax - Sets the maximum boundary for iso-surface plot.

  • text - Sets the text elements associated with the vertices. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • hovertext - Same as `text`.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: 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>`.

  • cauto - Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.

  • cmin - Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.

  • cmax - Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well.

  • cmid - Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`.

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

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. 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.

  • reversescale - Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.

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

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

  • opacity - Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

  • opacityscale - Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.

  • flatshading - Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • scene - Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • zsrc - Sets the source reference on Chart Studio Cloud for z .

  • valuesrc - Sets the source reference on Chart Studio Cloud for value .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .


plotly.graph_objs.Waterfall([visible=], [showlegend=], [legendgroup=], [opacity=], [name=], [uid=], [ids=], [customdata=], [meta=], [selectedpoints=], [hoverlabel=], [stream=], [transform=], [uirevision=], [measure=], [base=], [x=], [x0=], [dx=], [y=], [y0=], [dy=], [xperiod=], [yperiod=], [xperiod0=], [yperiod0=], [xperiodalignment=], [yperiodalignment=], [hovertext=], [hovertemplate=], [hoverinfo=], [textinfo=], [texttemplate=], [text=], [textposition=], [insidetextanchor=], [textangle=], [textfont=], [insidetextfont=], [outsidetextfont=], [constraintext=], [cliponaxis=], [orientation=], [offset=], [width=], [increasing=], [decreasing=], [totals=], [connector=], [offsetgroup=], [alignmentgroup=], [xaxis=], [yaxis=], [idssrc=], [customdatasrc=], [metasrc=], [measuresrc=], [xsrc=], [ysrc=], [hovertextsrc=], [hovertemplatesrc=], [hoverinfosrc=], [texttemplatesrc=], [textsrc=], [textpositionsrc=], [offsetsrc=], [widthsrc=]) → Waterfall

Create a new ‘Waterfall’ object

  • visible - 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).

  • showlegend - Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup - Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity - Sets the opacity of the trace.

  • name - Sets the trace name. The trace name appear as the legend item and on hover.

  • uid - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

  • 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

  • meta - Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • selectedpoints - 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 the `selected` and `unselected` styles have no effect.

  • transform - An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.

  • uirevision - Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

  • measure - An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.

  • base - Sets where the bar base is drawn (in position axis units).

  • x - Sets the x coordinates.

  • x0 - Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • dx - Sets the x coordinate step. See `x0` for more info.

  • y - Sets the y coordinates.

  • y0 - Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • dy - Sets the y coordinate step. See `y0` for more info.

  • xperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the x axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • yperiod - Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M<n>* on the y axis. Special values in the form of *M<n>* could be used to declare the number of months. In this case `n` must be a positive integer.

  • xperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • yperiod0 - Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

  • xperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

  • yperiodalignment - Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.

  • hovertext - Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

  • 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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` 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 are `arrayOk: true`) are available. variables `initial`, `delta` and `final`. 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>`.

  • hoverinfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

  • textinfo - Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).

  • 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-3.x-api-reference/blob/master/Formatting.md#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#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `initial`, `delta`, `final` and `label`.

  • text - Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

  • textposition - Specifies the location of the `text`. *inside* positions `text` inside, next to the bar end (rotated and scaled if needed). *outside* positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. *auto* tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside.

  • insidetextanchor - Determines if texts are kept at center or start/end points in `textposition` *inside* mode.

  • textangle - Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With *auto* the texts may automatically be rotated to fit with the maximum size in bars.

  • textfont - Sets the font used for `text`.

  • insidetextfont - Sets the font used for `text` lying inside the bar.

  • outsidetextfont - Sets the font used for `text` lying outside the bar.

  • constraintext - Constrain the size of text inside or outside a bar to be no larger than the bar itself.

  • cliponaxis - Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*.

  • orientation - Sets the orientation of the bars. With *v* (*h*), the value of the each bar spans along the vertical (horizontal).

  • offset - Shifts the position where the bar is drawn (in position axis units). In *group* barmode, traces that set *offset* will be excluded and drawn in *overlay* mode instead.

  • width - Sets the bar width (in position axis units).

  • offsetgroup - Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

  • alignmentgroup - Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

  • xaxis - Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis - Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.

  • idssrc - Sets the source reference on Chart Studio Cloud for ids .

  • customdatasrc - Sets the source reference on Chart Studio Cloud for customdata .

  • metasrc - Sets the source reference on Chart Studio Cloud for meta .

  • measuresrc - Sets the source reference on Chart Studio Cloud for measure .

  • xsrc - Sets the source reference on Chart Studio Cloud for x .

  • ysrc - Sets the source reference on Chart Studio Cloud for y .

  • hovertextsrc - Sets the source reference on Chart Studio Cloud for hovertext .

  • hovertemplatesrc - Sets the source reference on Chart Studio Cloud for hovertemplate .

  • hoverinfosrc - Sets the source reference on Chart Studio Cloud for hoverinfo .

  • texttemplatesrc - Sets the source reference on Chart Studio Cloud for texttemplate .

  • textsrc - Sets the source reference on Chart Studio Cloud for text .

  • textpositionsrc - Sets the source reference on Chart Studio Cloud for textposition .

  • offsetsrc - Sets the source reference on Chart Studio Cloud for offset .

  • widthsrc - Sets the source reference on Chart Studio Cloud for width .


Globals

















































plotly.graph_objs