plotly.graph_objs.carpet Module
Functions
plotly.graph_objs.carpet.Aaxis([_deprecated=], [arraydtick=], [arraytick0=], [autorange=], [autotypenumbers=], [categoryarray=], [categoryarraysrc=], [categoryorder=], [cheatertype=], [color=], [dtick=], [endline=], [endlinecolor=], [endlinewidth=], [exponentformat=], [fixedrange=], [gridcolor=], [griddash=], [gridwidth=], [labelpadding=], [labelprefix=], [labelsuffix=], [linecolor=], [linewidth=], [minexponent=], [minorgridcolor=], [minorgridcount=], [minorgriddash=], [minorgridwidth=], [nticks=], [range=], [rangemode=], [separatethousands=], [showexponent=], [showgrid=], [showline=], [showticklabels=], [showtickprefix=], [showticksuffix=], [smoothing=], [startline=], [startlinecolor=], [startlinewidth=], [tick0=], [tickangle=], [tickfont=], [tickformat=], [tickformatstop=], [tickmode=], [tickprefix=], [ticksuffix=], [ticktext=], [ticktextsrc=], [tickvals=], [tickvalssrc=], [title=], [type=]) → Aaxis
Create a new ‘Aaxis’ object
arraydtick- The stride between grid lines along the axisarraytick0- The starting index of grid lines along the axisautorange- Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to *false*.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. Defaults to layout.autotypenumbers.categoryarray- Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to *array*. Used with `categoryorder`.categoryarraysrc- Sets the source reference on Chart Studio Cloud for `categoryarray`.categoryorder- Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`.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.dtick- The stride between grid lines along the axisendline- Determines whether or not a line is drawn at along the final value of this axis. If *true*, the end line is drawn on top of the grid lines.endlinecolor- Sets the line color of the end line.endlinewidth- Sets the width (in px) of the end line.exponentformat- Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.fixedrange- Determines whether or not this axis is zoom-able. If true, then zoom is disabled.gridcolor- Sets the axis line color.griddash- Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).gridwidth- Sets the width (in px) of the axis line.labelpadding- Extra padding between label and the axislabelprefix- Sets a axis label prefix.labelsuffix- Sets a axis label suffix.linecolor- Sets the axis line color.linewidth- Sets the width (in px) of the axis line.minexponent- Hide SI prefix for 10^n if |n| is below this numberminorgridcolor- Sets the color of the grid lines.minorgridcount- Sets the number of minor grid ticks per major grid tickminorgriddash- Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).minorgridwidth- Sets the width (in px) of the grid lines.nticks- Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.range- Sets the range of this axis. If the axis `type` is *log*, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is *date*, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is *category*, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.rangemode- If *normal*, the range is computed in relation to the extrema of the input data. If *tozero*`, the range extends to 0, regardless of the input data If *nonnegative*, the range is non-negative, regardless of the input data.separatethousands- If "true", even 4-digit integers are separatedshowexponent- If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.showgrid- Determines whether or not grid lines are drawn. If *true*, the grid lines are drawn at every tick mark.showline- Determines whether or not a line bounding this axis is drawn.showticklabels- Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.showtickprefix- If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.showticksuffix- Same as `showtickprefix` but for tick suffixes.startline- Determines whether or not a line is drawn at along the starting value of this axis. If *true*, the start line is drawn on top of the grid lines.startlinecolor- Sets the line color of the start line.startlinewidth- Sets the width (in px) of the start line.tick0- The starting index of grid lines along the axistickangle- Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.tickfont- Sets the tick font.tickformat- Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*tickprefix- Sets a tick label prefix.ticksuffix- Sets a tick label suffix.ticktext- Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.ticktextsrc- Sets the source reference on Chart Studio Cloud for `ticktext`.tickvals- Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.tickvalssrc- Sets the source reference on Chart Studio Cloud for `tickvals`.type- Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
plotly.graph_objs.carpet.Baxis([_deprecated=], [arraydtick=], [arraytick0=], [autorange=], [autotypenumbers=], [categoryarray=], [categoryarraysrc=], [categoryorder=], [cheatertype=], [color=], [dtick=], [endline=], [endlinecolor=], [endlinewidth=], [exponentformat=], [fixedrange=], [gridcolor=], [griddash=], [gridwidth=], [labelpadding=], [labelprefix=], [labelsuffix=], [linecolor=], [linewidth=], [minexponent=], [minorgridcolor=], [minorgridcount=], [minorgriddash=], [minorgridwidth=], [nticks=], [range=], [rangemode=], [separatethousands=], [showexponent=], [showgrid=], [showline=], [showticklabels=], [showtickprefix=], [showticksuffix=], [smoothing=], [startline=], [startlinecolor=], [startlinewidth=], [tick0=], [tickangle=], [tickfont=], [tickformat=], [tickformatstop=], [tickmode=], [tickprefix=], [ticksuffix=], [ticktext=], [ticktextsrc=], [tickvals=], [tickvalssrc=], [title=], [type=]) → Baxis
Create a new ‘Baxis’ object
arraydtick- The stride between grid lines along the axisarraytick0- The starting index of grid lines along the axisautorange- Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to *false*.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. Defaults to layout.autotypenumbers.categoryarray- Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to *array*. Used with `categoryorder`.categoryarraysrc- Sets the source reference on Chart Studio Cloud for `categoryarray`.categoryorder- Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`.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.dtick- The stride between grid lines along the axisendline- Determines whether or not a line is drawn at along the final value of this axis. If *true*, the end line is drawn on top of the grid lines.endlinecolor- Sets the line color of the end line.endlinewidth- Sets the width (in px) of the end line.exponentformat- Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.fixedrange- Determines whether or not this axis is zoom-able. If true, then zoom is disabled.gridcolor- Sets the axis line color.griddash- Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).gridwidth- Sets the width (in px) of the axis line.labelpadding- Extra padding between label and the axislabelprefix- Sets a axis label prefix.labelsuffix- Sets a axis label suffix.linecolor- Sets the axis line color.linewidth- Sets the width (in px) of the axis line.minexponent- Hide SI prefix for 10^n if |n| is below this numberminorgridcolor- Sets the color of the grid lines.minorgridcount- Sets the number of minor grid ticks per major grid tickminorgriddash- Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).minorgridwidth- Sets the width (in px) of the grid lines.nticks- Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.range- Sets the range of this axis. If the axis `type` is *log*, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is *date*, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is *category*, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.rangemode- If *normal*, the range is computed in relation to the extrema of the input data. If *tozero*`, the range extends to 0, regardless of the input data If *nonnegative*, the range is non-negative, regardless of the input data.separatethousands- If "true", even 4-digit integers are separatedshowexponent- If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.showgrid- Determines whether or not grid lines are drawn. If *true*, the grid lines are drawn at every tick mark.showline- Determines whether or not a line bounding this axis is drawn.showticklabels- Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.showtickprefix- If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.showticksuffix- Same as `showtickprefix` but for tick suffixes.startline- Determines whether or not a line is drawn at along the starting value of this axis. If *true*, the start line is drawn on top of the grid lines.startlinecolor- Sets the line color of the start line.startlinewidth- Sets the width (in px) of the start line.tick0- The starting index of grid lines along the axistickangle- Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.tickfont- Sets the tick font.tickformat- Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*tickprefix- Sets a tick label prefix.ticksuffix- Sets a tick label suffix.ticktext- Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.ticktextsrc- Sets the source reference on Chart Studio Cloud for `ticktext`.tickvals- Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.tickvalssrc- Sets the source reference on Chart Studio Cloud for `tickvals`.type- Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
plotly.graph_objs.carpet.Font([color=], [family=], [size=]) → Font
Create a new ‘Font’ object
family- HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.
plotly.graph_objs.carpet.Legendgrouptitle([font=], [text=]) → Legendgrouptitle
Create a new ‘Legendgrouptitle’ object
font- Sets this legend group's title font.text- Sets the title of the legend group.
plotly.graph_objs.carpet.Stream([maxpoints=], [token=]) → Stream
Create a new ‘Stream’ object
maxpoints- Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.token- The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.
Globals
Do you still have questions?
Our Community Forum is full of helpful information and Anvil experts.