JavaScript Figure Reference: pie Traces

A pie trace is an object with the key "type" equal to "pie" (i.e. {"type": "pie"}) and any of the keys listed below.

A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors`

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

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

  • title
    Parent: data[type=pie]
    Type: object containing one or more of the keys listed below.
    • font
      Parent: data[type=pie].title
      Type: object containing one or more of the keys listed below.

      Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

      • color
        Parent: data[type=pie].title.font
        Type: color or array of colors
      • family
        Parent: data[type=pie].title.font
        Type: string or array of strings

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

      • size
        Parent: data[type=pie].title.font
        Type: number or array of numbers greater than or equal to 1
    • position
      Parent: data[type=pie].title
      Type: enumerated , one of ( "top left" | "top center" | "top right" | "middle center" | "bottom left" | "bottom center" | "bottom right" )

      Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute.

    • text
      Parent: data[type=pie].title
      Type: string
      Default: ""

      Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

  • visible
    Parent: data[type=pie]
    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=pie]
    Type: boolean
    Default: true

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

  • legend
    Parent: data[type=pie]
    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=pie]
    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=pie]
    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=pie]
    Type: object containing one or more of the keys listed below.
    • font
      Parent: data[type=pie].legendgrouptitle
      Type: object containing one or more of the keys listed below.

      Sets this legend group's title font.

      • color
        Parent: data[type=pie].legendgrouptitle.font
        Type: color
      • family
        Parent: data[type=pie].legendgrouptitle.font
        Type: string

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

      • size
        Parent: data[type=pie].legendgrouptitle.font
        Type: number greater than or equal to 1
    • text
      Parent: data[type=pie].legendgrouptitle
      Type: string
      Default: ""

      Sets the title of the legend group.

  • legendwidth
    Parent: data[type=pie]
    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=pie]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=pie]
    Type: data array

    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.

  • values
    Parent: data[type=pie]
    Type: data array

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

  • labels
    Parent: data[type=pie]
    Type: data array

    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.

  • dlabel
    Parent: data[type=pie]
    Type: number
    Default: 1

    Sets the label step. See `label0` for more info.

  • label0
    Parent: data[type=pie]
    Type: number
    Default: 0

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

  • pull
    Parent: data[type=pie]
    Type: number or array of numbers between or equal to 0 and 1
    Default: 0

    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.

  • text
    Parent: data[type=pie]
    Type: data array

    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.

  • textposition
    Parent: data[type=pie]
    Type: enumerated or array of enumerateds , one of ( "inside" | "outside" | "auto" | "none" )
    Default: "auto"

    Specifies the location of the `textinfo`.

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

    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-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. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `percent` and `text`.

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

    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
    Parent: data[type=pie]
    Type: flaglist string. Any combination of "label", "text", "value", "percent", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "label", "text", "label+text", "label+text+value", "all"
    Default: "all"

    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
    Parent: data[type=pie]
    Type: string or array of strings
    Default: ""

    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}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. 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. 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. Finally, the template string has access to 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>`.

  • meta
    Parent: data[type=pie]
    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
    Parent: data[type=pie]
    Type: data array

    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

  • domain
    Parent: data[type=pie]
    Type: object containing one or more of the keys listed below.
    • column
      Parent: data[type=pie].domain
      Type: integer greater than or equal to 0
      Default: 0

      If there is a layout grid, use the domain for this column in the grid for this pie trace .

    • row
      Parent: data[type=pie].domain
      Type: integer greater than or equal to 0
      Default: 0

      If there is a layout grid, use the domain for this row in the grid for this pie trace .

    • x
      Parent: data[type=pie].domain
      Type: array
      Default: [0, 1]

      Sets the horizontal domain of this pie trace (in plot fraction).

    • y
      Parent: data[type=pie].domain
      Type: array
      Default: [0, 1]

      Sets the vertical domain of this pie trace (in plot fraction).

  • automargin
    Parent: data[type=pie]
    Type: boolean

    Determines whether outside text labels can push the margins.

  • marker
    Parent: data[type=pie]
    Type: object containing one or more of the keys listed below.
    • colors
      Parent: data[type=pie].marker
      Type: data array

      Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.

    • line
      Parent: data[type=pie].marker
      Type: object containing one or more of the keys listed below.
      • color
        Parent: data[type=pie].marker.line
        Type: color or array of colors
        Default: "#444"

        Sets the color of the line enclosing each sector.

      • width
        Parent: data[type=pie].marker.line
        Type: number or array of numbers greater than or equal to 0
        Default: 0

        Sets the width (in px) of the line enclosing each sector.

    • pattern
      Parent: data[type=pie].marker
      Type: object containing one or more of the keys listed below.

      Sets the pattern within the marker.

      • bgcolor
        Parent: data[type=pie].marker.pattern
        Type: color or array of colors

        When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is "overlay". Otherwise, defaults to a transparent background.

      • fgcolor
        Parent: data[type=pie].marker.pattern
        Type: color or array of colors

        When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is "replace". Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.

      • fgopacity
        Parent: data[type=pie].marker.pattern
        Type: number between or equal to 0 and 1

        Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1.

      • fillmode
        Parent: data[type=pie].marker.pattern
        Type: enumerated , one of ( "replace" | "overlay" )
        Default: "replace"

        Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.

      • shape
        Parent: data[type=pie].marker.pattern
        Type: enumerated or array of enumerateds , one of ( "" | "/" | "\" | "x" | "-" | "|" | "+" | "." )
        Default: ""

        Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

      • size
        Parent: data[type=pie].marker.pattern
        Type: number or array of numbers greater than or equal to 0
        Default: 8

        Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

      • solidity
        Parent: data[type=pie].marker.pattern
        Type: number or array of numbers between or equal to 0 and 1
        Default: 0.3

        Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

  • textfont
    Parent: data[type=pie]
    Type: object containing one or more of the keys listed below.

    Sets the font used for `textinfo`.

    • color
      Parent: data[type=pie].textfont
      Type: color or array of colors
    • family
      Parent: data[type=pie].textfont
      Type: string or array of strings

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

    • size
      Parent: data[type=pie].textfont
      Type: number or array of numbers greater than or equal to 1
  • textinfo
    Parent: data[type=pie]
    Type: flaglist string. Any combination of "label", "text", "value", "percent" joined with a "+" OR "none".
    Examples: "label", "text", "label+text", "label+text+value", "none"

    Determines which trace information appear on the graph.

  • direction
    Parent: data[type=pie]
    Type: enumerated , one of ( "clockwise" | "counterclockwise" )
    Default: "counterclockwise"

    Specifies the direction at which succeeding sectors follow one another.

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

    Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.

  • hoverlabel
    Parent: data[type=pie]
    Type: object containing one or more of the keys listed below.
    • align
      Parent: data[type=pie].hoverlabel
      Type: enumerated or array of enumerateds , one of ( "left" | "right" | "auto" )
      Default: "auto"

      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

    • bgcolor
      Parent: data[type=pie].hoverlabel
      Type: color or array of colors

      Sets the background color of the hover labels for this trace

    • bordercolor
      Parent: data[type=pie].hoverlabel
      Type: color or array of colors

      Sets the border color of the hover labels for this trace.

    • font
      Parent: data[type=pie].hoverlabel
      Type: object containing one or more of the keys listed below.

      Sets the font used in hover labels.

      • color
        Parent: data[type=pie].hoverlabel.font
        Type: color or array of colors
      • family
        Parent: data[type=pie].hoverlabel.font
        Type: string or array of strings

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

      • size
        Parent: data[type=pie].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
    • namelength
      Parent: data[type=pie].hoverlabel
      Type: integer or array of integers greater than or equal to -1
      Default: 15

      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.

  • insidetextfont
    Parent: data[type=pie]
    Type: object containing one or more of the keys listed below.

    Sets the font used for `textinfo` lying inside the sector.

    • color
      Parent: data[type=pie].insidetextfont
      Type: color or array of colors
    • family
      Parent: data[type=pie].insidetextfont
      Type: string or array of strings

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

    • size
      Parent: data[type=pie].insidetextfont
      Type: number or array of numbers greater than or equal to 1
  • insidetextorientation
    Parent: data[type=pie]
    Type: enumerated , one of ( "horizontal" | "radial" | "tangential" | "auto" )
    Default: "auto"

    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.

  • outsidetextfont
    Parent: data[type=pie]
    Type: object containing one or more of the keys listed below.

    Sets the font used for `textinfo` lying outside the sector.

    • color
      Parent: data[type=pie].outsidetextfont
      Type: color or array of colors
    • family
      Parent: data[type=pie].outsidetextfont
      Type: string or array of strings

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

    • size
      Parent: data[type=pie].outsidetextfont
      Type: number or array of numbers greater than or equal to 1
  • rotation
    Parent: data[type=pie]
    Type: angle
    Default: 0

    Instead of the first slice starting at 12 o'clock, rotate to some other angle.

  • scalegroup
    Parent: data[type=pie]
    Type: string
    Default: ""

    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.

  • sort
    Parent: data[type=pie]
    Type: boolean
    Default: true

    Determines whether or not the sectors are reordered from largest to smallest.

  • uirevision
    Parent: data[type=pie]
    Type: number or categorical coordinate string

    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.