Julia Figure Reference: scattercarpet Traces



Plots a scatter trace on either the first carpet axis or the carpet axis with a matching `carpet` attribute.

  • type
    Parent: data[type=scattercarpet]
    Type: "scattercarpet"
  • name
    Parent: data[type=scattercarpet]
    Type: string

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

  • visible
    Parent: data[type=scattercarpet]
    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).

  • showlegend
    Parent: data[type=scattercarpet]
    Type: boolean
    Default: true

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

  • legend
    Parent: data[type=scattercarpet]
    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
    Parent: data[type=scattercarpet]
    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.

  • legendgroup
    Parent: data[type=scattercarpet]
    Type: string
    Default: ""

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

  • legendgrouptitle
    Parent: data[type=scattercarpet]
    Type: Dict containing one or more of the keys listed below.
    • font
      Parent: data[type=scattercarpet].legendgrouptitle
      Type: Dict containing one or more of the keys listed below.

      Sets this legend group's title font.

      • color
        Parent: data[type=scattercarpet].legendgrouptitle.font
        Type: color
      • family
        Parent: data[type=scattercarpet].legendgrouptitle.font
        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
        Parent: data[type=scattercarpet].legendgrouptitle.font
        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
        Parent: data[type=scattercarpet].legendgrouptitle.font
        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
        Parent: data[type=scattercarpet].legendgrouptitle.font
        Type: number greater than or equal to 1
      • style
        Parent: data[type=scattercarpet].legendgrouptitle.font
        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
        Parent: data[type=scattercarpet].legendgrouptitle.font
        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
        Parent: data[type=scattercarpet].legendgrouptitle.font
        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
        Parent: data[type=scattercarpet].legendgrouptitle.font
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • text
      Parent: data[type=scattercarpet].legendgrouptitle
      Type: string
      Default: ""

      Sets the title of the legend group.

  • legendwidth
    Parent: data[type=scattercarpet]
    Type: number greater than or equal to 0

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

  • opacity
    Parent: data[type=scattercarpet]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • mode
    Parent: data[type=scattercarpet]
    Type: flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    Examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    Default: "markers"

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

  • ids
    Parent: data[type=scattercarpet]
    Type: data array, Vector

    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
    Parent: data[type=scattercarpet]
    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`.

  • a
    Parent: data[type=scattercarpet]
    Type: data array, Vector

    Sets the a-axis coordinates.

  • b
    Parent: data[type=scattercarpet]
    Type: data array, Vector

    Sets the b-axis coordinates.

  • text
    Parent: data[type=scattercarpet]
    Type: string or array of strings
    Default: ""

    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.

  • textposition
    Parent: data[type=scattercarpet]
    Type: enumerated or array of enumerateds , one of ( "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    Default: "middle center"

    Sets the positions of the `text` elements with respects to the (x,y) coordinates.

  • texttemplate
    Parent: data[type=scattercarpet]
    Type: string or array of strings
    Default: ""

    Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `a`, `b` and `text`.

  • texttemplatefallback
    Parent: data[type=scattercarpet]
    Type: number or categorical coordinate string
    Default: -

    Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.