plotly.graph_objects.Sankey

class plotly.graph_objects.Sankey(arg=None, arrangement=None, customdata=None, direction=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, name=None, node=None, orientation=None, selectedpoints=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, **kwargs)
__init__(arg=None, arrangement=None, customdata=None, direction=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, name=None, node=None, orientation=None, selectedpoints=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, **kwargs)

Construct a new Sankey object

Sankey plots for network flow data analysis. The nodes are specified in nodes and the links between sources and targets in links. The colors are set in nodes[i].color and links[i].color, otherwise defaults are used.

Parameters

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

  • arrangement – If value is snap (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via nodepad. If value is perpendicular, the nodes can only move along a line perpendicular to the flow. If value is freeform, the nodes can freely move on the plane. If value is fixed, the nodes are stationary.

  • 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

  • direction – Sets the direction of the flow along the orientation axis. With forward (the default), sources are on the left (horizontal) or top (vertical). With reversed, sources are on the right (horizontal) or bottom (vertical).

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

  • hoverinfo – Determines what trace information appears 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. Note that this attribute is superseded by node.hoverinfo and node.hoverinfo for nodes and links respectively.

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

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

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

  • legendgrouptitle – plotly.graph_objects.sankey.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.

  • link – The links of the Sankey plot.

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

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

  • node – The nodes of the Sankey plot.

  • orientation – Sets the orientation of the Sankey diagram. With h (the default), the flow runs horizontally. With v, the flow runs vertically. Use direction to control which side the sources are placed on.

  • selectedpoints – Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

  • textfont – Sets the font for node labels

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

  • valueformat – Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.

  • valuesuffix – Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.

  • 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

Sankey

plotly.graph_objects.sankey

plotly.graph_objects.sankey

class plotly.graph_objects.sankey.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 sankey trace.

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

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

Returns

Return type

int

property row

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

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

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

Returns

Return type

int

property x
Sets the horizontal domain of this sankey trace (in plot

fraction).

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

  • a list or tuple of 2 elements where:

  1. The ‘x[0]’ property is a number and may be specified as:

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

  2. The ‘x[1]’ property is a number and may be specified as:

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

    list

property y
Sets the vertical domain of this sankey trace (in plot

fraction).

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

  • a list or tuple of 2 elements where:

  1. The ‘y[0]’ property is a number and may be specified as:

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

  2. The ‘y[1]’ property is a number and may be specified as:

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

    list

class plotly.graph_objects.sankey.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, namelength=None, showarrow=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

Returns

Return type

Any|numpy.ndarray

property bgcolor

Sets the background color of the hover labels for this trace

The ‘bgcolor’ 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/

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bordercolor

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

The ‘bordercolor’ 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/

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property font

Sets the font used in hover labels.

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

Returns

Return type

plotly.graph_objects.sankey.hoverlabel.Font

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 an 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

Returns

Return type

int|numpy.ndarray

property showarrow

Sets whether or not to show the hover label arrow/triangle pointing to the data point.

The ‘showarrow’ property is a boolean and must be specified as:

  • A boolean value: True or False

Returns

Return type

bool

class plotly.graph_objects.sankey.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:

Returns

Return type

plotly.graph_objects.sankey.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

property arrowlen

Sets the length (in px) of the links arrow, if 0 no arrow will be drawn.

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

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

Returns

Return type

int|float

property color

Sets the link color. It can be a single value, or an array for specifying color for each link. If link.color is omitted, then by default, a translucent grey link will be used.

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/

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property colorscaledefaults

When used in a template (as layout.template.data.sankey.link.colorscaledefaults), sets the default property values to use for elements of sankey.link.colorscales

The ‘colorscaledefaults’ property is an instance of Colorscale that may be specified as:

Returns

Return type

plotly.graph_objects.sankey.link.Colorscale

property colorscales

The ‘colorscales’ property is a tuple of instances of Colorscale that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.sankey.link.Colorscale

  • A list or tuple of dicts of string/value properties that will be passed to the Colorscale constructor

Returns

Return type

tuple[plotly.graph_objects.sankey.link.Colorscale]

property customdata

Assigns extra data to each link.

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

Returns

Return type

numpy.ndarray

property hovercolor

Sets the link hover color. It can be a single value, or an array for specifying hover colors for each link. If link.hovercolor is omitted, then by default, links will become slightly more opaque when hovered over.

The ‘hovercolor’ 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/

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property hoverinfo

Determines what trace information appears when hovering links. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

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

    [‘all’, ‘none’, ‘skip’]

Returns

Return type

Any

property hoverlabel

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

Returns

Return type

plotly.graph_objects.sankey.link.Hoverlabel

property 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. 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 variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event- data. Additionally, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label. 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>.

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

  • A string

  • A number that will be converted to a string

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

Returns

Return type

str|numpy.ndarray

property hovertemplatefallback

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 ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

property label

The shown name of the link.

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

Returns

Return type

numpy.ndarray

property line

The ‘line’ property is an instance of Line that may be specified as:

Returns

Return type

plotly.graph_objects.sankey.link.Line

property sort

For auto (the default), the order of links attached to each node is determined automatically by the layout. For input, the order of links at each node is kept the same as the order in the input array.

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

    [‘auto’, ‘input’]

Returns

Return type

Any

property source

An integer number [0..nodes.length - 1] that represents the source node.

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

Returns

Return type

numpy.ndarray

property target

An integer number [0..nodes.length - 1] that represents the target node.

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

Returns

Return type

numpy.ndarray

property value

A numeric value representing the flow volume value.

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

Returns

Return type

numpy.ndarray

class plotly.graph_objects.sankey.Node(arg=None, align=None, color=None, customdata=None, groups=None, hoverinfo=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, label=None, line=None, pad=None, sort=None, thickness=None, x=None, y=None, **kwargs)
property align

Sets the alignment method used to position the nodes along the horizontal axis.

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

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

Returns

Return type

Any

property color

Sets the node color. It can be a single value, or an array for specifying color for each node. If node.color is omitted, then the default Plotly color palette will be cycled through to have a variety of colors. These defaults are not fully opaque, to allow some visibility of what is beneath the node.

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/

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property customdata

Assigns extra data to each node.

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

Returns

Return type

numpy.ndarray

property groups

Groups of nodes. Each group is defined by an array with the indices of the nodes it contains. Multiple groups can be specified.

The ‘groups’ property is an info array that may be specified as: * a 2D list where:

The ‘groups[i][j]’ property is a number and may be specified as: - An int or float

Returns

Return type

list

property hoverinfo

Determines what trace information appears when hovering nodes. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

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

    [‘all’, ‘none’, ‘skip’]

Returns

Return type

Any

property hoverlabel

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

Returns

Return type

plotly.graph_objects.sankey.node.Hoverlabel

property 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. 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 variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event- data. Additionally, all attributes that can be specified per- point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label. 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>.

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

  • A string

  • A number that will be converted to a string

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

Returns

Return type

str|numpy.ndarray

property hovertemplatefallback

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 ‘hovertemplatefallback’ property accepts values of any type

Returns

Return type

Any

property label

The shown name of the node.

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

Returns

Return type

numpy.ndarray

property line

The ‘line’ property is an instance of Line that may be specified as:

Returns

Return type

plotly.graph_objects.sankey.node.Line

property pad

Sets the padding (in px) between the nodes.

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

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

Returns

Return type

int|float

property sort

For auto (the default), the vertical order of nodes will be determined automatically by the layout. For input, the vertical order of nodes is kept the same as the order in the input array.

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

    [‘auto’, ‘input’]

Returns

Return type

Any

property thickness

Sets the thickness (in px) of the nodes.

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

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

Returns

Return type

int|float

property x

The normalized horizontal position of the node.

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

Returns

Return type

numpy.ndarray

property y

The normalized vertical position of the node.

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

Returns

Return type

numpy.ndarray

class plotly.graph_objects.sankey.Textfont(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)
property 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 family

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.

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

  • A non-empty string

Returns

Return type

str

property lineposition

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.

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

  • Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property shadow

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.

The ‘shadow’ 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 size
The ‘size’ property is a number and may be specified as:

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

Returns

Return type

int|float

property style

Sets whether a font should be styled with a normal or italic face from its family.

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

    [‘normal’, ‘italic’]

Returns

Return type

Any

property textcase

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

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

    [‘normal’, ‘word caps’, ‘upper’, ‘lower’]

Returns

Return type

Any

property variant

Sets the variant of the font.

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

    [‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]

Returns

Return type

Any

property weight

Sets the weight (or boldness) of the font.

The ‘weight’ property is an integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)

Returns

Return type

int