F# Figure Reference: pie Traces



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

      • 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 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=pie].title.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=pie].title.font
        Type: string or array of strings
        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=pie].title.font
        Type: number or array of numbers greater than or equal to 1
      • style
        Parent: data[type=pie].title.font
        Type: enumerated or array of enumerateds , 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=pie].title.font
        Type: enumerated or array of enumerateds , 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=pie].title.font
        Type: enumerated or array of enumerateds , 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=pie].title.font
        Type: integer or array of integers between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

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

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

      Sets the title of the chart. If it is empty, no title is displayed.

  • 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 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=pie].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=pie].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=pie].legendgrouptitle.font
        Type: number greater than or equal to 1
      • style
        Parent: data[type=pie].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=pie].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=pie].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=pie].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=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: IEnumerable<#IConvertible>

    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: IEnumerable<#IConvertible>

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

  • labels
    Parent: data[type=pie]
    Type: IEnumerable<#IConvertible>

    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: IEnumerable<#IConvertible>

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