plotly.graph_objects.layout.shape package¶

class plotly.graph_objects.layout.shape.Label(arg=None, font=None, padding=None, text=None, textangle=None, textposition=None, texttemplate=None, texttemplatefallback=None, xanchor=None, yanchor=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property font¶

Sets the shape label text font.

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

Returns

Return type

plotly.graph_objects.layout.shape.label.Font

property padding¶

Sets padding (in px) between edge of label and edge of shape.

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

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property text¶

Sets the text to display with shape. It is also used for legend item if name is not provided.

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

  • A string

  • A number that will be converted to a string

Returns

Return type

str

property textangle¶

Sets the angle at which the label text is drawn with respect to the horizontal. For lines, angle “auto” is the same angle as the line. For all other shapes, angle “auto” is horizontal.

The ‘textangle’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).

Returns

Return type

int|float

property textposition¶

Sets the position of the label text relative to the shape. Supported values for rectangles, circles and paths are top left, top center, top right, middle left, middle center, middle right, bottom left, bottom center, and bottom right. Supported values for lines are “start”, “middle”, and “end”. Default: middle center for rectangles, circles, and paths; “middle” for lines.

The ‘textposition’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’, ‘start’, ‘middle’, ‘end’]

Returns

Return type

Any

property texttemplate¶

Template string used for rendering the shape’s label. Note that this will override text. Variables are inserted using %{variable}, for example “x0: %{x0}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{x0:$.2f}”. See 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: %{x0|%m %b %Y}”. See https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. A single multiplication or division operation may be applied to numeric variables, and combined with d3 number formatting, for example “Length in cm: %{x0*2.54}”, “%{slope*60:.1f} meters per second.” For log axes, variable values are given in log units. For date axes, x/y coordinate variables and center variables use datetimes, while all other variable values use values in ms. Finally, the template string has access to variables x0, x1, y0, y1, slope, dx, dy, width, height, length, xcenter, ycenter, simpleXVariables and simpleYVariables. 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.

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

  • A string

  • A number that will be converted to a string

Returns

Return type

str

property texttemplatefallback¶

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.

The ‘texttemplatefallback’ property accepts values of any type

Returns

Return type

Any

property xanchor¶

Sets the label’s horizontal position anchor This anchor binds the specified textposition to the “left”, “center” or “right” of the label text. For example, if textposition is set to top right and xanchor to “right” then the right-most portion of the label text lines up with the right-most edge of the shape.

The ‘xanchor’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

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

Returns

Return type

Any

property yanchor¶

Sets the label’s vertical position anchor This anchor binds the specified textposition to the “top”, “middle” or “bottom” of the label text. For example, if textposition is set to top right and yanchor to “top” then the top-most portion of the label text lines up with the top-most edge of the shape.

The ‘yanchor’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘top’, ‘middle’, ‘bottom’]

Returns

Return type

Any

class plotly.graph_objects.layout.shape.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property font¶

Sets this legend group’s title font.

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

Returns

Return type

plotly.graph_objects.layout.shape.legendgrouptitle.Font

property text¶

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

Returns

Return type

str

class plotly.graph_objects.layout.shape.Line(arg=None, color=None, dash=None, width=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property color¶

Sets the line color.

The ‘color’ property is a color and may be specified as a string in the following formats:

  • hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

  • hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

  • rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

  • rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

  • hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

  • hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

  • hwb (e.g. ‘hwb(0 0% 100%)’)

  • lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

  • color (e.g. ‘color(display-p3 1 0 0)’)

  • named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

  • Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property dash¶

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

The ‘dash’ property is an enumeration that may be specified as:
  • One of the following dash styles:

    [‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]

  • A string containing a dash length list in pixels or percentages

    (e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)

Returns

Return type

str

property width¶

Sets the line width (in px).

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

  • An int or float in the interval [0, inf]

Returns

Return type

int|float