plotly.graph_objects.box package

class plotly.graph_objects.box.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, namelength=None, showarrow=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

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.box.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.box.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

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.box.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.box.Line(arg=None, color=None, width=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color

Sets the color of line bounding the box(es).

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 width

Sets the width (in px) of line bounding the box(es).

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

class plotly.graph_objects.box.Marker(arg=None, angle=None, color=None, line=None, opacity=None, outliercolor=None, size=None, symbol=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property angle

Sets the marker angle in respect to angleref.

The ‘angle’ 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 color

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

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 line

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

Returns

Return type

plotly.graph_objects.box.marker.Line

property opacity

Sets the marker opacity.

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

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

Returns

Return type

int|float

property outliercolor

Sets the color of the outlier sample points.

The ‘outliercolor’ 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 size

Sets the marker size (in px).

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

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

Returns

Return type

int|float

property symbol

Sets the marker symbol type. Adding 100 is equivalent to appending “-open” to a symbol name. Adding 200 is equivalent to appending “-dot” to a symbol name. Adding 300 is equivalent to appending “-open-dot” or “dot-open” to a symbol name.

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

    [0, ‘0’, ‘circle’, 100, ‘100’, ‘circle-open’, 200, ‘200’, ‘circle-dot’, 300, ‘300’, ‘circle-open-dot’, 1, ‘1’, ‘square’, 101, ‘101’, ‘square-open’, 201, ‘201’, ‘square-dot’, 301, ‘301’, ‘square-open-dot’, 2, ‘2’, ‘diamond’, 102, ‘102’, ‘diamond-open’, 202, ‘202’, ‘diamond-dot’, 302, ‘302’, ‘diamond-open-dot’, 3, ‘3’, ‘cross’, 103, ‘103’, ‘cross-open’, 203, ‘203’, ‘cross-dot’, 303, ‘303’, ‘cross-open-dot’, 4, ‘4’, ‘x’, 104, ‘104’, ‘x-open’, 204, ‘204’, ‘x-dot’, 304, ‘304’, ‘x-open-dot’, 5, ‘5’, ‘triangle-up’, 105, ‘105’, ‘triangle-up-open’, 205, ‘205’, ‘triangle-up-dot’, 305, ‘305’, ‘triangle-up-open-dot’, 6, ‘6’, ‘triangle-down’, 106, ‘106’, ‘triangle-down-open’, 206, ‘206’, ‘triangle-down-dot’, 306, ‘306’, ‘triangle-down-open-dot’, 7, ‘7’, ‘triangle-left’, 107, ‘107’, ‘triangle-left-open’, 207, ‘207’, ‘triangle-left-dot’, 307, ‘307’, ‘triangle-left-open-dot’, 8, ‘8’, ‘triangle-right’, 108, ‘108’, ‘triangle-right-open’, 208, ‘208’, ‘triangle-right-dot’, 308, ‘308’, ‘triangle-right-open-dot’, 9, ‘9’, ‘triangle-ne’, 109, ‘109’, ‘triangle-ne-open’, 209, ‘209’, ‘triangle-ne-dot’, 309, ‘309’, ‘triangle-ne-open-dot’, 10, ‘10’, ‘triangle-se’, 110, ‘110’, ‘triangle-se-open’, 210, ‘210’, ‘triangle-se-dot’, 310, ‘310’, ‘triangle-se-open-dot’, 11, ‘11’, ‘triangle-sw’, 111, ‘111’, ‘triangle-sw-open’, 211, ‘211’, ‘triangle-sw-dot’, 311, ‘311’, ‘triangle-sw-open-dot’, 12, ‘12’, ‘triangle-nw’, 112, ‘112’, ‘triangle-nw-open’, 212, ‘212’, ‘triangle-nw-dot’, 312, ‘312’, ‘triangle-nw-open-dot’, 13, ‘13’, ‘pentagon’, 113, ‘113’, ‘pentagon-open’, 213, ‘213’, ‘pentagon-dot’, 313, ‘313’, ‘pentagon-open-dot’, 14, ‘14’, ‘hexagon’, 114, ‘114’, ‘hexagon-open’, 214, ‘214’, ‘hexagon-dot’, 314, ‘314’, ‘hexagon-open-dot’, 15, ‘15’, ‘hexagon2’, 115, ‘115’, ‘hexagon2-open’, 215, ‘215’, ‘hexagon2-dot’, 315, ‘315’, ‘hexagon2-open-dot’, 16, ‘16’, ‘octagon’, 116, ‘116’, ‘octagon-open’, 216, ‘216’, ‘octagon-dot’, 316, ‘316’, ‘octagon-open-dot’, 17, ‘17’, ‘star’, 117, ‘117’, ‘star-open’, 217, ‘217’, ‘star-dot’, 317, ‘317’, ‘star-open-dot’, 18, ‘18’, ‘hexagram’, 118, ‘118’, ‘hexagram-open’, 218, ‘218’, ‘hexagram-dot’, 318, ‘318’, ‘hexagram-open-dot’, 19, ‘19’, ‘star-triangle-up’, 119, ‘119’, ‘star-triangle-up-open’, 219, ‘219’, ‘star-triangle-up-dot’, 319, ‘319’, ‘star-triangle-up-open-dot’, 20, ‘20’, ‘star-triangle-down’, 120, ‘120’, ‘star-triangle-down-open’, 220, ‘220’, ‘star-triangle-down-dot’, 320, ‘320’, ‘star-triangle-down-open-dot’, 21, ‘21’, ‘star-square’, 121, ‘121’, ‘star-square-open’, 221, ‘221’, ‘star-square-dot’, 321, ‘321’, ‘star-square-open-dot’, 22, ‘22’, ‘star-diamond’, 122, ‘122’, ‘star-diamond-open’, 222, ‘222’, ‘star-diamond-dot’, 322, ‘322’, ‘star-diamond-open-dot’, 23, ‘23’, ‘diamond-tall’, 123, ‘123’, ‘diamond-tall-open’, 223, ‘223’, ‘diamond-tall-dot’, 323, ‘323’, ‘diamond-tall-open-dot’, 24, ‘24’, ‘diamond-wide’, 124, ‘124’, ‘diamond-wide-open’, 224, ‘224’, ‘diamond-wide-dot’, 324, ‘324’, ‘diamond-wide-open-dot’, 25, ‘25’, ‘hourglass’, 125, ‘125’, ‘hourglass-open’, 26, ‘26’, ‘bowtie’, 126, ‘126’, ‘bowtie-open’, 27, ‘27’, ‘circle-cross’, 127, ‘127’, ‘circle-cross-open’, 28, ‘28’, ‘circle-x’, 128, ‘128’, ‘circle-x-open’, 29, ‘29’, ‘square-cross’, 129, ‘129’, ‘square-cross-open’, 30, ‘30’, ‘square-x’, 130, ‘130’, ‘square-x-open’, 31, ‘31’, ‘diamond-cross’, 131, ‘131’, ‘diamond-cross-open’, 32, ‘32’, ‘diamond-x’, 132, ‘132’, ‘diamond-x-open’, 33, ‘33’, ‘cross-thin’, 133, ‘133’, ‘cross-thin-open’, 34, ‘34’, ‘x-thin’, 134, ‘134’, ‘x-thin-open’, 35, ‘35’, ‘asterisk’, 135, ‘135’, ‘asterisk-open’, 36, ‘36’, ‘hash’, 136, ‘136’, ‘hash-open’, 236, ‘236’, ‘hash-dot’, 336, ‘336’, ‘hash-open-dot’, 37, ‘37’, ‘y-up’, 137, ‘137’, ‘y-up-open’, 38, ‘38’, ‘y-down’, 138, ‘138’, ‘y-down-open’, 39, ‘39’, ‘y-left’, 139, ‘139’, ‘y-left-open’, 40, ‘40’, ‘y-right’, 140, ‘140’, ‘y-right-open’, 41, ‘41’, ‘line-ew’, 141, ‘141’, ‘line-ew-open’, 42, ‘42’, ‘line-ns’, 142, ‘142’, ‘line-ns-open’, 43, ‘43’, ‘line-ne’, 143, ‘143’, ‘line-ne-open’, 44, ‘44’, ‘line-nw’, 144, ‘144’, ‘line-nw-open’, 45, ‘45’, ‘arrow-up’, 145, ‘145’, ‘arrow-up-open’, 46, ‘46’, ‘arrow-down’, 146, ‘146’, ‘arrow-down-open’, 47, ‘47’, ‘arrow-left’, 147, ‘147’, ‘arrow-left-open’, 48, ‘48’, ‘arrow-right’, 148, ‘148’, ‘arrow-right-open’, 49, ‘49’, ‘arrow-bar-up’, 149, ‘149’, ‘arrow-bar-up-open’, 50, ‘50’, ‘arrow-bar-down’, 150, ‘150’, ‘arrow-bar-down-open’, 51, ‘51’, ‘arrow-bar-left’, 151, ‘151’, ‘arrow-bar-left-open’, 52, ‘52’, ‘arrow-bar-right’, 152, ‘152’, ‘arrow-bar-right-open’, 53, ‘53’, ‘arrow’, 153, ‘153’, ‘arrow-open’, 54, ‘54’, ‘arrow-wide’, 154, ‘154’, ‘arrow-wide-open’]

Returns

Return type

Any

class plotly.graph_objects.box.Selected(arg=None, marker=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

Returns

Return type

plotly.graph_objects.box.selected.Marker

class plotly.graph_objects.box.Unselected(arg=None, marker=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property marker

The ‘marker’ property is an instance of Marker that may be specified as:

Returns

Return type

plotly.graph_objects.box.unselected.Marker