Python Figure Reference: carpet Traces

A plotly.graph_objects.Carpet trace is a graph object in the figure's data list with any of the named arguments or attributes listed below.

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

  • name
    Code: fig.update_traces(name=<VALUE>, selector=dict(type='carpet'))
    Type: string

    Sets the trace name. The trace name appears as the legend item and on hover.

  • visible
    Code: fig.update_traces(visible=<VALUE>, selector=dict(type='carpet'))
    Type: enumerated , one of ( True | False | "legendonly" )
    Default: True

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

  • legend
    Code: fig.update_traces(legend=<VALUE>, selector=dict(type='carpet'))
    Type: subplotid
    Default: 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.

  • legendrank
    Code: fig.update_traces(legendrank=<VALUE>, selector=dict(type='carpet'))
    Type: number
    Default: 1000

    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.

  • legendgrouptitle
    Code: fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='carpet'))
    Type: dict containing one or more of the keys listed below.
    • font
      Code: fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='carpet'))
      Type: dict containing one or more of the keys listed below.

      Sets this legend group's title font.

      • color
        Code: fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='carpet'))
        Type: color
      • family
        Code: fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='carpet'))
        Type: string

        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.

      • lineposition
        Code: fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='carpet'))
        Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
        Examples: "under", "over", "under+over", "under+over+through", "none"
        Default: "none"

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

      • shadow
        Code: fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='carpet'))
        Type: string
        Default: "none"

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

      • size
        Code: fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='carpet'))
        Type: number greater than or equal to 1
      • style
        Code: fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='carpet'))
        Type: enumerated , one of ( "normal" | "italic" )
        Default: "normal"

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

      • textcase
        Code: fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='carpet'))
        Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
        Default: "normal"

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

      • variant
        Code: fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='carpet'))
        Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
        Default: "normal"

        Sets the variant of the font.

      • weight
        Code: fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='carpet'))
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • text
      Code: fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: ""

      Sets the title of the legend group.

  • legendwidth
    Code: fig.update_traces(legendwidth=<VALUE>, selector=dict(type='carpet'))
    Type: number greater than or equal to 0

    Sets the width (in px or fraction) of the legend for this trace.

  • opacity
    Code: fig.update_traces(opacity=<VALUE>, selector=dict(type='carpet'))
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Code: fig.update_traces(ids=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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.

  • zorder
    Code: fig.update_traces(zorder=<VALUE>, selector=dict(type='carpet'))
    Type: integer
    Default: 0

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

  • x
    Code: fig.update_traces(x=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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
    Code: fig.update_traces(y=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

  • a
    Code: fig.update_traces(a=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    An array containing values of the first parameter value

  • a0
    Code: fig.update_traces(a0=<VALUE>, selector=dict(type='carpet'))
    Type: number
    Default: 0

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

  • da
    Code: fig.update_traces(da=<VALUE>, selector=dict(type='carpet'))
    Type: number
    Default: 1

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

  • b
    Code: fig.update_traces(b=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

  • b0
    Code: fig.update_traces(b0=<VALUE>, selector=dict(type='carpet'))
    Type: number
    Default: 0

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

  • db
    Code: fig.update_traces(db=<VALUE>, selector=dict(type='carpet'))
    Type: number
    Default: 1

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

  • meta
    Code: fig.update_traces(meta=<VALUE>, selector=dict(type='carpet'))
    Type: number or categorical coordinate string

    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.

  • customdata
    Code: fig.update_traces(customdata=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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

  • aaxis
    Code: fig.update_traces(aaxis=dict(...), selector=dict(type='carpet'))
    Type: dict containing one or more of the keys listed below.
    • arraydtick
      Code: fig.update_traces(aaxis_arraydtick=<VALUE>, selector=dict(type='carpet'))
      Type: integer greater than or equal to 1
      Default: 1

      The stride between grid lines along the axis

    • arraytick0
      Code: fig.update_traces(aaxis_arraytick0=<VALUE>, selector=dict(type='carpet'))
      Type: integer greater than or equal to 0
      Default: 0

      The starting index of grid lines along the axis

    • autorange
      Code: fig.update_traces(aaxis_autorange=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( True | False | "reversed" )
      Default: True

      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
      Code: fig.update_traces(aaxis_autotypenumbers=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "convert types" | "strict" )
      Default: "convert types"

      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
      Code: fig.update_traces(aaxis_categoryarray=<VALUE>, selector=dict(type='carpet'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

    • categoryorder
      Code: fig.update_traces(aaxis_categoryorder=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" )
      Default: "trace"

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

    • cheatertype
      Code: fig.update_traces(aaxis_cheatertype=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "index" | "value" )
      Default: "value"
    • color
      Code: fig.update_traces(aaxis_color=<VALUE>, selector=dict(type='carpet'))
      Type: 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
      Code: fig.update_traces(aaxis_dtick=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 1

      The stride between grid lines along the axis

    • endline
      Code: fig.update_traces(aaxis_endline=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      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
      Code: fig.update_traces(aaxis_endlinecolor=<VALUE>, selector=dict(type='carpet'))
      Type: color

      Sets the line color of the end line.

    • endlinewidth
      Code: fig.update_traces(aaxis_endlinewidth=<VALUE>, selector=dict(type='carpet'))
      Type: number
      Default: 1

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

    • exponentformat
      Code: fig.update_traces(aaxis_exponentformat=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" | "SI extended" )
      Default: "B"

      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
      Code: fig.update_traces(aaxis_fixedrange=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

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

    • gridcolor
      Code: fig.update_traces(aaxis_gridcolor=<VALUE>, selector=dict(type='carpet'))
      Type: color

      Sets the axis line color.

    • griddash
      Code: fig.update_traces(aaxis_griddash=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: "solid"

      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
      Code: fig.update_traces(aaxis_gridwidth=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 1

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

    • labelalias
      Code: fig.update_traces(aaxis_labelalias=<VALUE>, selector=dict(type='carpet'))
      Type: number or categorical coordinate string

      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.

    • labelpadding
      Code: fig.update_traces(aaxis_labelpadding=<VALUE>, selector=dict(type='carpet'))
      Type: integer
      Default: 10

      Extra padding between label and the axis

    • labelprefix
      Code: fig.update_traces(aaxis_labelprefix=<VALUE>, selector=dict(type='carpet'))
      Type: string

      Sets a axis label prefix.

    • labelsuffix
      Code: fig.update_traces(aaxis_labelsuffix=<VALUE>, selector=dict(type='carpet'))
      Type: string