plotly.graph_objects.layout.yaxis package

class plotly.graph_objects.layout.yaxis.Autorangeoptions(arg=None, clipmax=None, clipmin=None, include=None, includesrc=None, maxallowed=None, minallowed=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property clipmax

Clip autorange maximum if it goes beyond this value. Has no effect when autorangeoptions.maxallowed is provided.

The ‘clipmax’ property accepts values of any type

Returns

Return type

Any

property clipmin

Clip autorange minimum if it goes beyond this value. Has no effect when autorangeoptions.minallowed is provided.

The ‘clipmin’ property accepts values of any type

Returns

Return type

Any

property include

Ensure this value is included in autorange.

The ‘include’ property accepts values of any type

Returns

Return type

Any|numpy.ndarray

property includesrc

Sets the source reference on Chart Studio Cloud for include.

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

Returns

Return type

str

property maxallowed

Use this value exactly as autorange maximum.

The ‘maxallowed’ property accepts values of any type

Returns

Return type

Any

property minallowed

Use this value exactly as autorange minimum.

The ‘minallowed’ property accepts values of any type

Returns

Return type

Any

class plotly.graph_objects.layout.yaxis.Minor(arg=None, dtick=None, gridcolor=None, griddash=None, gridwidth=None, nticks=None, showgrid=None, tick0=None, tickcolor=None, ticklen=None, tickmode=None, ticks=None, tickvals=None, tickvalssrc=None, tickwidth=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property dtick

Sets the step in-between ticks on this axis. Use with tick0. Must be a positive number, or special strings available to “log” and “date” axes. If the axis type is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and “D2”. If the axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick to “M48”

The ‘dtick’ property accepts values of any type

Returns

Return type

Any

property gridcolor

Sets the color of the grid lines.

The ‘gridcolor’ 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

Returns

Return type

str

property griddash

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 ‘griddash’ 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 gridwidth

Sets the width (in px) of the grid lines.

The ‘gridwidth’ property is a number and may be specified as:
  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property nticks

Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to “auto”.

The ‘nticks’ 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]

Returns

Return type

int

property showgrid

Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.

The ‘showgrid’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property tick0

Sets the placement of the first tick on this axis. Use with dtick. If the axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

The ‘tick0’ property accepts values of any type

Returns

Return type

Any

property tickcolor

Sets the tick color.

The ‘tickcolor’ 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

Returns

Return type

str

property ticklen

Sets the tick length (in px).

The ‘ticklen’ property is a number and may be specified as:
  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property tickmode

Sets the tick mode for this axis. If “auto”, the number of ticks is set via nticks. If “linear”, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals is provided).

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

    [‘auto’, ‘linear’, ‘array’]

Returns

Return type

Any

property ticks

Determines whether ticks are drawn or not. If “”, this axis’ ticks are not drawn. If “outside” (“inside”), this axis’ are drawn outside (inside) the axis lines.

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

    [‘outside’, ‘inside’, ‘’]

Returns

Return type

Any

property tickvals

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to “array”. Used with ticktext.

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

Returns

Return type

numpy.ndarray

property tickvalssrc

Sets the source reference on Chart Studio Cloud for tickvals.

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

Returns

Return type

str

property tickwidth

Sets the tick width (in px).

The ‘tickwidth’ 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.layout.yaxis.Rangebreak(arg=None, bounds=None, dvalue=None, enabled=None, name=None, pattern=None, templateitemname=None, values=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property bounds
Sets the lower and upper bounds of this axis rangebreak. Can be

used with pattern.

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

  • a list or tuple of 2 elements where:

  1. The ‘bounds[0]’ property accepts values of any type

  2. The ‘bounds[1]’ property accepts values of any type

    list

property dvalue

Sets the size of each values item. The default is one day in milliseconds.

The ‘dvalue’ property is a number and may be specified as:
  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property enabled

Determines whether this axis rangebreak is enabled or disabled. Please note that rangebreaks only work for “date” axis type.

The ‘enabled’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property name

When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

The ‘name’ 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 pattern

Determines a pattern on the time line that generates breaks. If day of week - days of the week in English e.g. ‘Sunday’ or sun (matching is case-insensitive and considers only the first three characters), as well as Sunday-based integers between 0 and 6. If “hour” - hour (24-hour clock) as decimal numbers between 0 and 24. for more info. Examples: - { pattern: ‘day of week’, bounds: [6, 1] } or simply { bounds: [‘sat’, ‘mon’] } breaks from Saturday to Monday (i.e. skips the weekends). - { pattern: ‘hour’, bounds: [17, 8] } breaks from 5pm to 8am (i.e. skips non-work hours).

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

    [‘day of week’, ‘hour’, ‘’]

Returns

Return type

Any

property templateitemname

Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

The ‘templateitemname’ 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 values

Sets the coordinate values corresponding to the rangebreaks. An alternative to bounds. Use dvalue to set the size of the values along the axis.

The ‘values’ property is an info array that may be specified as: * a list of elements where:

The ‘values[i]’ property accepts values of any type

Returns

Return type

list

class plotly.graph_objects.layout.yaxis.Tickfont(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

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:

    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

Returns

Return type

str

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

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

class plotly.graph_objects.layout.yaxis.Tickformatstop(arg=None, dtickrange=None, enabled=None, name=None, templateitemname=None, value=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property dtickrange
range [min, max], where “min”, “max” - dtick values which

describe some zoom level, it is possible to omit “min” or “max” value by passing “null”

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

  • a list or tuple of 2 elements where:

  1. The ‘dtickrange[0]’ property accepts values of any type

  2. The ‘dtickrange[1]’ property accepts values of any type

    list

property enabled

Determines whether or not this stop is used. If false, this stop is ignored even within its dtickrange.

The ‘enabled’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property name

When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

The ‘name’ 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 templateitemname

Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

The ‘templateitemname’ 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 value

string - dtickformat for described zoom level, the same as “tickformat”

The ‘value’ 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.yaxis.Title(arg=None, font=None, standoff=None, text=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property font

Sets this axis’ title font. Note that the title’s font used to be customized by the now deprecated titlefont attribute.

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

  • An instance of plotly.graph_objects.layout.yaxis.title.Font

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

    Supported dict properties:

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

    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.

    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.

    size

    style

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

    textcase

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

    variant

    Sets the variant of the font.

    weight

    Sets the weight (or boldness) of the font.

Returns

Return type

plotly.graph_objects.layout.yaxis.title.Font

property standoff

Sets the standoff distance (in px) between the axis labels and the title text The default value is a function of the axis tick labels, the title font.size and the axis linewidth. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By setting standoff and turning on automargin, plotly.js will push the margins to fit the axis title at given standoff distance.

The ‘standoff’ 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 title of this axis. Note that before the existence of title.text, the title’s contents used to be defined as the title attribute itself. This behavior has been deprecated.

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