GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing plotly.com — plotly.graph_objects.Carpet — 7.1.0 documentation

`plotly.graph_objects`.Carpet¶

class plotly.graph_objects.Carpet(arg=None, a=None, a0=None, aaxis=None, b=None, b0=None, baxis=None, carpet=None, cheaterslope=None, color=None, customdata=None, da=None, db=None, font=None, ids=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, name=None, opacity=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, y=None, yaxis=None, zorder=None, **kwargs)¶

__init__(arg=None, a=None, a0=None, aaxis=None, b=None, b0=None, baxis=None, carpet=None, cheaterslope=None, color=None, customdata=None, da=None, db=None, font=None, ids=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, name=None, opacity=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, y=None, yaxis=None, zorder=None, **kwargs)¶

Construct a new Carpet object

The data describing carpet axis layout is set in y and (optionally) also x. If only y is present, x the plot is interpreted as a cheater plot and is filled in using the y values. x and y may either be 2D arrays matching with each dimension matching that of a and b, or they may be 1D arrays with total length equal to that of a and b.

Parameters

arg – dict of properties compatible with this constructor or an instance of plotly.graph_objects.Carpet
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.
aaxis – plotly.graph_objects.carpet.Aaxis instance or dict with compatible properties
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.
baxis – plotly.graph_objects.carpet.Baxis instance or dict with compatible properties
carpet – An identifier for this carpet, so that scattercarpet and contourcarpet traces can specify a carpet plot on which they lie
cheaterslope – The shift applied to each successive row of data in creating a cheater plot. Only used if x is been omitted.
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.
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
da – Sets the a coordinate step. See a0 for more info.
db – Sets the b coordinate step. See b0 for more info.
font – The default font used for axis & tick labels on this carpet
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.
legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.
legendgrouptitle – plotly.graph_objects.carpet.Legendgrouptitle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
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.
name – Sets the trace name. The trace name appears as the legend item and on hover.
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.
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.
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).
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.
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.
y – A two dimensional array of y coordinates at each carpet point.
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.
zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Returns

Return type

Carpet

`plotly.graph_objects`.carpet¶

plotly.graph_objects.carpet

class plotly.graph_objects.carpet.Aaxis(arg=None, arraydtick=None, arraytick0=None, autorange=None, autotypenumbers=None, categoryarray=None, categoryorder=None, cheatertype=None, color=None, dtick=None, endline=None, endlinecolor=None, endlinewidth=None, exponentformat=None, fixedrange=None, gridcolor=None, griddash=None, gridwidth=None, labelalias=None, labelpadding=None, labelprefix=None, labelsuffix=None, linecolor=None, linewidth=None, minexponent=None, minorgridcolor=None, minorgridcount=None, minorgriddash=None, minorgridwidth=None, nticks=None, range=None, rangemode=None, separatethousands=None, showexponent=None, showgrid=None, showline=None, showticklabels=None, showtickprefix=None, showticksuffix=None, smoothing=None, startline=None, startlinecolor=None, startlinewidth=None, tick0=None, tickangle=None, tickfont=None, tickformat=None, tickformatstops=None, tickformatstopdefaults=None, tickmode=None, tickprefix=None, ticksuffix=None, ticktext=None, tickvals=None, title=None, type=None, **kwargs)¶

property arraydtick¶

The stride between grid lines along the axis

The ‘arraydtick’ property is an integer and may be specified as:

An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]

Returns
Return type: int

property arraytick0¶

The starting index of grid lines along the axis

The ‘arraytick0’ property is an integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property autorange¶

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.

The ‘autorange’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘reversed’]

Returns
Return type: Any

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

The ‘autotypenumbers’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘convert types’, ‘strict’]

Returns
Return type: Any

property categoryarray¶

Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to “array”. Used with categoryorder.

The ‘categoryarray’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

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

The ‘categoryorder’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘trace’, ‘category ascending’, ‘category descending’, ‘array’]

Returns
Return type: Any

property cheatertype¶

The ‘cheatertype’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘index’, ‘value’]

Returns
Return type: Any

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

The ‘color’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property dtick¶

The stride between grid lines along the axis

The ‘dtick’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property endline¶

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.

The ‘endline’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property endlinecolor¶

Sets the line color of the end line.

The ‘endlinecolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property endlinewidth¶

Sets the width (in px) of the end line.

The ‘endlinewidth’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

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

The ‘exponentformat’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’, ‘SI extended’]

Returns
Return type: Any

property fixedrange¶

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

The ‘fixedrange’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property gridcolor¶

Sets the axis line color.

The ‘gridcolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property 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”).

The ‘griddash’ property is an enumeration that may be specified as:

One of the following dash styles:
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
A string containing a dash length list in pixels or percentages
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)

Returns
Return type: str

property gridwidth¶

Sets the width (in px) of the axis line.

The ‘gridwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property labelalias¶

Replacement text for specific tick or hover labels. For example using {US: ‘USA’, CA: ‘Canada’} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html- like tags or MathJax.

The ‘labelalias’ property accepts values of any type

Returns
Return type: Any

property labelpadding¶

Extra padding between label and the axis

The ‘labelpadding’ property is an integer and may be specified as:

An int (or float that will be cast to an int)

Returns
Return type: int

property labelprefix¶

Sets a axis label prefix.

The ‘labelprefix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property labelsuffix¶

Sets a axis label suffix.

The ‘labelsuffix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property linecolor¶

Sets the axis line color.

The ‘linecolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property linewidth¶

Sets the width (in px) of the axis line.

The ‘linewidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property minexponent¶

Hide SI prefix for 10^n if |n| is below this number

The ‘minexponent’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property minorgridcolor¶

Sets the color of the grid lines.

The ‘minorgridcolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property minorgridcount¶

Sets the number of minor grid ticks per major grid tick

The ‘minorgridcount’ property is an integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property minorgriddash¶

The ‘minorgriddash’ property is an enumeration that may be specified as:

One of the following dash styles:
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
A string containing a dash length list in pixels or percentages
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)

Returns
Return type: str

property minorgridwidth¶

Sets the width (in px) of the grid lines.

The ‘minorgridwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property 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”.

The ‘nticks’ property is an integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

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

The ‘range’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘range[0]’ property accepts values of any type
The ‘range[1]’ property accepts values of any type

list

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

The ‘rangemode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘tozero’, ‘nonnegative’]

Returns
Return type: Any

property separatethousands¶

If “true”, even 4-digit integers are separated

The ‘separatethousands’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property showexponent¶

If “all”, all exponents are shown besides their significands. If “first”, only the exponent of the first tick is shown. If “last”, only the exponent of the last tick is shown. If “none”, no exponents appear.

The ‘showexponent’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property showgrid¶

Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.

The ‘showgrid’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property showline¶

Determines whether or not a line bounding this axis is drawn.

The ‘showline’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property showticklabels¶

Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.

The ‘showticklabels’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘start’, ‘end’, ‘both’, ‘none’]

Returns
Return type: Any

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

The ‘showtickprefix’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property showticksuffix¶

Same as showtickprefix but for tick suffixes.

The ‘showticksuffix’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property smoothing¶

The ‘smoothing’ property is a number and may be specified as:

An int or float in the interval [0, 1.3]

Returns
Return type: int|float

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

The ‘startline’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property startlinecolor¶

Sets the line color of the start line.

The ‘startlinecolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property startlinewidth¶

Sets the width (in px) of the start line.

The ‘startlinewidth’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property tick0¶

The starting index of grid lines along the axis

The ‘tick0’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property tickangle¶

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

The ‘tickangle’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).

Returns
Return type: int|float

property tickfont¶

Sets the tick font.

The ‘tickfont’ property is an instance of Tickfont that may be specified as:

An instance of plotly.graph_objects.carpet.aaxis.Tickfont

A dict of string/value properties that will be passed to the Tickfont constructor

Returns
Return type: plotly.graph_objects.carpet.aaxis.Tickfont

property 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”

The ‘tickformat’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property tickformatstopdefaults¶

When used in a template (as layout.template.data.carpet.aaxis.tickformatstopdefaults), sets the default property values to use for elements of carpet.aaxis.tickformatstops

The ‘tickformatstopdefaults’ property is an instance of Tickformatstop that may be specified as:

An instance of plotly.graph_objects.carpet.aaxis.Tickformatstop

A dict of string/value properties that will be passed to the Tickformatstop constructor

Returns
Return type: plotly.graph_objects.carpet.aaxis.Tickformatstop

property tickformatstops¶

The ‘tickformatstops’ property is a tuple of instances of Tickformatstop that may be specified as:

A list or tuple of instances of plotly.graph_objects.carpet.aaxis.Tickformatstop

A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor

Returns
Return type: tuple[plotly.graph_objects.carpet.aaxis.Tickformatstop]

property tickmode¶

The ‘tickmode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘linear’, ‘array’]

Returns
Return type: Any

property tickprefix¶

Sets a tick label prefix.

The ‘tickprefix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property ticksuffix¶

Sets a tick label suffix.

The ‘ticksuffix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property ticktext¶

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to “array”. Used with tickvals.

The ‘ticktext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property tickvals¶

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to “array”. Used with ticktext.

The ‘tickvals’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property title¶

The ‘title’ property is an instance of Title that may be specified as:

An instance of plotly.graph_objects.carpet.aaxis.Title

A dict of string/value properties that will be passed to the Title constructor

Returns
Return type: plotly.graph_objects.carpet.aaxis.Title

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

The ‘type’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘-‘, ‘linear’, ‘date’, ‘category’]

Returns
Return type: Any

class plotly.graph_objects.carpet.Baxis(arg=None, arraydtick=None, arraytick0=None, autorange=None, autotypenumbers=None, categoryarray=None, categoryorder=None, cheatertype=None, color=None, dtick=None, endline=None, endlinecolor=None, endlinewidth=None, exponentformat=None, fixedrange=None, gridcolor=None, griddash=None, gridwidth=None, labelalias=None, labelpadding=None, labelprefix=None, labelsuffix=None, linecolor=None, linewidth=None, minexponent=None, minorgridcolor=None, minorgridcount=None, minorgriddash=None, minorgridwidth=None, nticks=None, range=None, rangemode=None, separatethousands=None, showexponent=None, showgrid=None, showline=None, showticklabels=None, showtickprefix=None, showticksuffix=None, smoothing=None, startline=None, startlinecolor=None, startlinewidth=None, tick0=None, tickangle=None, tickfont=None, tickformat=None, tickformatstops=None, tickformatstopdefaults=None, tickmode=None, tickprefix=None, ticksuffix=None, ticktext=None, tickvals=None, title=None, type=None, **kwargs)¶

property arraydtick¶

The stride between grid lines along the axis

The ‘arraydtick’ property is an integer and may be specified as:

An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]

Returns
Return type: int

property arraytick0¶

The starting index of grid lines along the axis

The ‘arraytick0’ property is an integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property autorange¶

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.

The ‘autorange’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘reversed’]

Returns
Return type: Any

property autotypenumbers¶

The ‘autotypenumbers’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘convert types’, ‘strict’]

Returns
Return type: Any

property categoryarray¶

Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to “array”. Used with categoryorder.

The ‘categoryarray’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property categoryorder¶

The ‘categoryorder’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘trace’, ‘category ascending’, ‘category descending’, ‘array’]

Returns
Return type: Any

property cheatertype¶

The ‘cheatertype’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘index’, ‘value’]

Returns
Return type: Any

property color¶

The ‘color’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property dtick¶

The stride between grid lines along the axis

The ‘dtick’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property endline¶

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.

The ‘endline’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property endlinecolor¶

Sets the line color of the end line.

The ‘endlinecolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property endlinewidth¶

Sets the width (in px) of the end line.

The ‘endlinewidth’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property exponentformat¶

The ‘exponentformat’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’, ‘SI extended’]

Returns
Return type: Any

property fixedrange¶

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

The ‘fixedrange’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property gridcolor¶

Sets the axis line color.

The ‘gridcolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property griddash¶

The ‘griddash’ property is an enumeration that may be specified as:

One of the following dash styles:
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
A string containing a dash length list in pixels or percentages
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)

Returns
Return type: str

property gridwidth¶

Sets the width (in px) of the axis line.

The ‘gridwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property labelalias¶

The ‘labelalias’ property accepts values of any type

Returns
Return type: Any

property labelpadding¶

Extra padding between label and the axis

The ‘labelpadding’ property is an integer and may be specified as:

An int (or float that will be cast to an int)

Returns
Return type: int

property labelprefix¶

Sets a axis label prefix.

The ‘labelprefix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property labelsuffix¶

Sets a axis label suffix.

The ‘labelsuffix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property linecolor¶

Sets the axis line color.

The ‘linecolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property linewidth¶

Sets the width (in px) of the axis line.

The ‘linewidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property minexponent¶

Hide SI prefix for 10^n if |n| is below this number

The ‘minexponent’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property minorgridcolor¶

Sets the color of the grid lines.

The ‘minorgridcolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property minorgridcount¶

Sets the number of minor grid ticks per major grid tick

The ‘minorgridcount’ property is an integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property minorgriddash¶

The ‘minorgriddash’ property is an enumeration that may be specified as:

One of the following dash styles:
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
A string containing a dash length list in pixels or percentages
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)

Returns
Return type: str

property minorgridwidth¶

Sets the width (in px) of the grid lines.

The ‘minorgridwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property nticks¶

The ‘nticks’ property is an integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property range¶

Sets the range of this axis. If the axis type is “log”, then

The ‘range’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘range[0]’ property accepts values of any type
The ‘range[1]’ property accepts values of any type

list

property rangemode¶

The ‘rangemode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘tozero’, ‘nonnegative’]

Returns
Return type: Any

property separatethousands¶

If “true”, even 4-digit integers are separated

The ‘separatethousands’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property showexponent¶

The ‘showexponent’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property showgrid¶

Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.

The ‘showgrid’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property showline¶

Determines whether or not a line bounding this axis is drawn.

The ‘showline’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property showticklabels¶

Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.

The ‘showticklabels’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘start’, ‘end’, ‘both’, ‘none’]

Returns
Return type: Any

property showtickprefix¶

The ‘showtickprefix’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property showticksuffix¶

Same as showtickprefix but for tick suffixes.

The ‘showticksuffix’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property smoothing¶

The ‘smoothing’ property is a number and may be specified as:

An int or float in the interval [0, 1.3]

Returns
Return type: int|float

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

The ‘startline’ property is a boolean and must be specified as:

A boolean value: True or False

Returns
Return type: bool

property startlinecolor¶

Sets the line color of the start line.

The ‘startlinecolor’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property startlinewidth¶

Sets the width (in px) of the start line.

The ‘startlinewidth’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property tick0¶

The starting index of grid lines along the axis

The ‘tick0’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property tickangle¶

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

Returns
Return type: int|float

property tickfont¶

Sets the tick font.

The ‘tickfont’ property is an instance of Tickfont that may be specified as:

An instance of plotly.graph_objects.carpet.baxis.Tickfont

A dict of string/value properties that will be passed to the Tickfont constructor

Returns
Return type: plotly.graph_objects.carpet.baxis.Tickfont

property tickformat¶

The ‘tickformat’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property tickformatstopdefaults¶

When used in a template (as layout.template.data.carpet.baxis.tickformatstopdefaults), sets the default property values to use for elements of carpet.baxis.tickformatstops

The ‘tickformatstopdefaults’ property is an instance of Tickformatstop that may be specified as:

An instance of plotly.graph_objects.carpet.baxis.Tickformatstop

A dict of string/value properties that will be passed to the Tickformatstop constructor

Returns
Return type: plotly.graph_objects.carpet.baxis.Tickformatstop

property tickformatstops¶

The ‘tickformatstops’ property is a tuple of instances of Tickformatstop that may be specified as:

A list or tuple of instances of plotly.graph_objects.carpet.baxis.Tickformatstop

A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor

Returns
Return type: tuple[plotly.graph_objects.carpet.baxis.Tickformatstop]

property tickmode¶

The ‘tickmode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘linear’, ‘array’]

Returns
Return type: Any

property tickprefix¶

Sets a tick label prefix.

The ‘tickprefix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property ticksuffix¶

Sets a tick label suffix.

The ‘ticksuffix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property ticktext¶

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to “array”. Used with tickvals.

The ‘ticktext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property tickvals¶

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to “array”. Used with ticktext.

The ‘tickvals’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property title¶

The ‘title’ property is an instance of Title that may be specified as:

An instance of plotly.graph_objects.carpet.baxis.Title

A dict of string/value properties that will be passed to the Title constructor

Returns
Return type: plotly.graph_objects.carpet.baxis.Title

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

The ‘type’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘-‘, ‘linear’, ‘date’, ‘category’]

Returns
Return type: Any

class plotly.graph_objects.carpet.Font(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶

property color¶

The ‘color’ property is a color and may be specified as a string in the following formats:

hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)
hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)
rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)
rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)
hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)
hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)
hwb (e.g. ‘hwb(0 0% 100%)’)
lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)
color (e.g. ‘color(display-p3 1 0 0)’)
named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)
Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns
Return type: str

property family¶

HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren’t available.

The ‘family’ property is a string and must be specified as:

A non-empty string

Returns
Return type: str

property lineposition¶

Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns
Return type: Any

property shadow¶

Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

The ‘shadow’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property size¶

The ‘size’ property is a number and may be specified as:

An int or float in the interval [1, inf]

Returns
Return type: int|float

property style¶

Sets whether a font should be styled with a normal or italic face from its family.

The ‘style’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘italic’]

Returns
Return type: Any

property textcase¶

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

The ‘textcase’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]

Returns
Return type: Any

property variant¶

Sets the variant of the font.

The ‘variant’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]

Returns
Return type: Any

property weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is an integer and may be specified as:

An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)

Returns
Return type: int

class plotly.graph_objects.carpet.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶

property font¶

Sets this legend group’s title font.

The ‘font’ property is an instance of Font that may be specified as:

An instance of plotly.graph_objects.carpet.legendgrouptitle.Font

A dict of string/value properties that will be passed to the Font constructor

Returns
Return type: plotly.graph_objects.carpet.legendgrouptitle.Font

property text¶

Sets the title of the legend group.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

plotly.graph_objects.Carpet¶

plotly.graph_objects.carpet¶

`plotly.graph_objects`.Carpet¶

`plotly.graph_objects`.carpet¶