plotly.graph_objects.Pie — 5.16.0 documentation

相关文章推荐


     
      plotly.express

: high-level interface for data visualization


     
      plotly.graph_objects

: low-level interface to figures, traces and layout


     
      plotly.subplots

: helper function for laying out multi-plot figures


     
      plotly.figure_factory

: helper methods for building specific complex charts


     
      plotly.io

: low-level interface for displaying, reading and writing figures

class


   
    plotly.graph_objects.

Pie

( arg = None , automargin = None , customdata = None , customdatasrc = None , direction = None , dlabel = None , domain = None , hole = None , hoverinfo = None , hoverinfosrc = None , hoverlabel = None , hovertemplate = None , hovertemplatesrc = None , hovertext = None , hovertextsrc = None , ids = None , idssrc = None , insidetextfont = None , insidetextorientation = None , label0 = None , labels = None , labelssrc = None , legend = None , legendgroup = None , legendgrouptitle = None , legendrank = None , legendwidth = None , marker = None , meta = None , metasrc = None , name = None , opacity = None , outsidetextfont = None , pull = None , pullsrc = None , rotation = None , scalegroup = None , showlegend = None , sort = None , stream = None , text = None , textfont = None , textinfo = None , textposition = None , textpositionsrc = None , textsrc = None , texttemplate = None , texttemplatesrc = None , title = None , titlefont = None , titleposition = None , uid = None , uirevision = None , values = None , valuessrc = None , visible = None , ** kwargs ) ¶


   
    __init__

Construct a new Pie object

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

Parameters

arg – dict of properties compatible with this constructor or an instance of plotly.graph_objects.Pie

automargin – Determines whether outside text labels can push the margins.

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

customdatasrc – Sets the source reference on Chart Studio Cloud for customdata .

direction – Specifies the direction at which succeeding sectors follow one another.

dlabel – Sets the label step. See label0 for more info.

domain – plotly.graph_objects.pie.Domain instance or dict with compatible properties

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

hoverinfo – 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.

hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo .

hoverlabel – plotly.graph_objects.pie.Hoverlabel instance or dict with compatible properties

hovertemplate – 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> .

hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate .

hovertext – 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.

hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext .

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.

idssrc – Sets the source reference on Chart Studio Cloud for ids .

insidetextfont – Sets the font used for textinfo lying inside the sector.

insidetextorientation – 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.

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

labels – 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.

labelssrc – Sets the source reference on Chart Studio Cloud for labels .

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 ,

legendgroup – 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 – plotly.graph_objects.pie.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.

marker – plotly.graph_objects.pie.Marker instance or dict with compatible properties

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.

metasrc – Sets the source reference on Chart Studio Cloud for meta .

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

opacity – Sets the opacity of the trace.

outsidetextfont – Sets the font used for textinfo lying outside the sector.

pull – 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.

pullsrc – Sets the source reference on Chart Studio Cloud for pull .

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

scalegroup – 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.

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

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

stream – plotly.graph_objects.pie.Stream instance or dict with compatible properties

text – 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.

textfont – Sets the font used for textinfo .

textinfo – Determines which trace information appear on the graph.

textposition – Specifies the location of the textinfo .

textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition .

textsrc – Sets the source reference on Chart Studio Cloud for text .

texttemplate – 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 .

texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate .

title – plotly.graph_objects.pie.Title instance or dict with compatible properties

titlefont – Deprecated: Please use pie.title.font instead. Sets the font used for title . Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleposition – Deprecated: Please use pie.title.position instead. Specifies the location of the title . Note that the title’s position used to be set by the now deprecated titleposition attribute.

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.

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

valuessrc – Sets the source reference on Chart Studio Cloud for values .

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

Returns

Return type

class


   
    plotly.graph_objects.pie.


   
    Domain

( arg = None , column = None , row = None , x = None , y = None , ** kwargs ) ¶ property


   
    column

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

The ‘column’ property is a integer and may be specified as:

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

property

row

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

The ‘row’ property is a integer and may be specified as:

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

Sets the horizontal domain of this pie trace (in plot

fraction).

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

a list or tuple of 2 elements where:

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

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

a list or tuple of 2 elements where:

class


         
          plotly.graph_objects.pie.


         
          Hoverlabel

( arg = None , align = None , alignsrc = None , bgcolor = None , bgcolorsrc = None , bordercolor = None , bordercolorsrc = None , font = None , namelength = None , namelengthsrc = None , ** kwargs ) ¶ property


         
          align

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

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

One of the following enumeration values:

[‘left’, ‘right’, ‘auto’]

A tuple, list, or one-dimensional numpy array of the above

property


          
           alignsrc

Sets the source reference on Chart Studio Cloud for align .

The ‘alignsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

Sets the background color of the hover labels for this trace

The ‘bgcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

A named CSS color:

aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

A list or array of any of the above

property


            
             bgcolorsrc

Sets the source reference on Chart Studio Cloud for bgcolor .

The ‘bgcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

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

The ‘bordercolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

A named CSS color:

A list or array of any of the above

property


              
               bordercolorsrc

Sets the source reference on Chart Studio Cloud for bordercolor .

The ‘bordercolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

property


             
              font

Sets the font used in hover labels.

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

An instance of plotly.graph_objects.pie.hoverlabel.Font

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

Supported dict properties:

color

colorsrc

Sets the source reference on Chart Studio Cloud for color .

family

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

familysrc

Sets the source reference on Chart Studio Cloud for family .

sizesrc

Sets the source reference on Chart Studio Cloud for size .

property


                 
                  namelength

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.

The ‘namelength’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
A tuple, list, or one-dimensional numpy array of the above

Sets the source reference on Chart Studio Cloud for namelength .

The ‘namelengthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

class


                  
                   plotly.graph_objects.pie.


                  
                   Insidetextfont

(

arg = None

color = None

colorsrc = None

family = None

familysrc = None

size = None

sizesrc = None

** kwargs

)

property


                  
                   color

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

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

A named CSS color:

A list or array of any of the above

property


                     
                      colorsrc

Sets the source reference on Chart Studio Cloud for color .

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

property


                    
                     family

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

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

A non-empty string
A tuple, list, or one-dimensional numpy array of the above

property


                      
                       familysrc

Sets the source reference on Chart Studio Cloud for family .

The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

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

An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above

property


                        
                         sizesrc

Sets the source reference on Chart Studio Cloud for size .

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

class


                        
                         plotly.graph_objects.pie.


                        
                         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.pie.legendgrouptitle.Font

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

Supported dict properties:

color

family

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

class


                             
                              plotly.graph_objects.pie.


                             
                              Marker

(

arg = None

colors = None

colorssrc = None

line = None

pattern = None

** kwargs

)

property


                             
                              colors

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

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

Returns

Return type

numpy.ndarray

property


                              
                               colorssrc

Sets the source reference on Chart Studio Cloud for colors .

The ‘colorssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

An instance of plotly.graph_objects.pie.marker.Line
A dict of string/value properties that will be passed to the Line constructor

Supported dict properties:

color

Sets the color of the line enclosing each sector.

colorsrc

Sets the source reference on Chart Studio Cloud for color .

width

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

widthsrc

Sets the source reference on Chart Studio Cloud for width .
property pattern ¶
Sets the pattern within the marker.

The ‘pattern’ property is an instance of Pattern that may be specified as:

An instance of plotly.graph_objects.pie.marker.Pattern
A dict of string/value properties that will be passed to the Pattern constructor

Supported dict properties:

bgcolor

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.

bgcolorsrc

Sets the source reference on Chart Studio Cloud for bgcolor .

fgcolor

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 .

fgcolorsrc

Sets the source reference on Chart Studio Cloud for fgcolor .

fgopacity

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

fillmode

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

shape

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

shapesrc

Sets the source reference on Chart Studio Cloud for shape .

size

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

sizesrc

Sets the source reference on Chart Studio Cloud for size .

solidity

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.

soliditysrc

Sets the source reference on Chart Studio Cloud for solidity .
class plotly.graph_objects.pie. Outsidetextfont ( arg = None , color = None , colorsrc = None , family = None , familysrc = None , size = None , sizesrc = None , ** kwargs ) ¶ property color ¶

The ‘color’ property is a color and may be specified as:
- A hex string (e.g. ‘#ff0000’)
- An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
- An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
- An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)