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

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

Determines whether or not an item corresponding to this trace is shown in the 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.

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.

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.

• font
  Parent: data[type=candlestick].legendgrouptitle
  Type: struct containing one or more of the keys listed below.

  Sets this legend group's title font.

  • color
    Parent: data[type=candlestick].legendgrouptitle.font
    Type: color
  • family
    Parent: data[type=candlestick].legendgrouptitle.font
    Type: string

    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
    Parent: data[type=candlestick].legendgrouptitle.font
    Type: flaglist string. Any combination of 'under', 'over', 'through' joined with a '+' OR 'none'.
    Examples: 'under', 'over', 'under+over', 'under+over+through', 'none'
    Default: 'none'

    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
    Parent: data[type=candlestick].legendgrouptitle.font
    Type: string
    Default: 'none'

    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
    Parent: data[type=candlestick].legendgrouptitle.font
    Type: number greater than or equal to 1
  • style
    Parent: data[type=candlestick].legendgrouptitle.font
    Type: enumerated , one of ( 'normal' | 'italic' )
    Default: 'normal'

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

  • textcase
    Parent: data[type=candlestick].legendgrouptitle.font
    Type: enumerated , one of ( 'normal' | 'word caps' | 'upper' | 'lower' )
    Default: 'normal'

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

  • variant
    Parent: data[type=candlestick].legendgrouptitle.font
    Type: enumerated , one of ( 'normal' | 'small-caps' | 'all-small-caps' | 'all-petite-caps' | 'petite-caps' | 'unicase' )
    Default: 'normal'

    Sets the variant of the font.

  • weight
    Parent: data[type=candlestick].legendgrouptitle.font
    Type: integer between or equal to 1 and 1000
    Default: normal

    Sets the weight (or boldness) of the font.

• text
  Parent: data[type=candlestick].legendgrouptitle
  Type: string
  Default: ''

  Sets the title of the legend group.

Sets the width (in px or fraction) of the legend for this trace.

Sets the opacity of the trace.

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.

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.

Sets the x coordinates. If absent, linear coordinate will be generated.

Sets the close values.

Sets the open values.

Sets the high values.

Sets the low values.

Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.

Same as `text`.

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.

Sets the hover text formatting rulefor `x` 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. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: '%h' for half of the year as a decimal number as well as '%{n}f' for fractional seconds with n digits. For example, '2016-10-13 09:15:23.456' with tickformat '%H~%M~%S.%2f' would display '09~15~23.46'By default the values are formatted using `xaxis.hoverformat`.

Sets the hover text formatting rulefor `y` 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. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: '%h' for half of the year as a decimal number as well as '%{n}f' for fractional seconds with n digits. For example, '2016-10-13 09:15:23.456' with tickformat '%H~%M~%S.%2f' would display '09~15~23.46'By default the values are formatted using `yaxis.hoverformat`.

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.

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

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.yaxis2`, and so on.

Only relevant when the axis `type` is 'date'. Sets the period positioning in milliseconds or 'M<n>' on the x axis. Special values in the form of 'M<n>' could be used to declare the number of months. In this case `n` must be a positive integer.

Only relevant when the axis `type` is 'date'. Sets the alignment of data points on the x axis.

Only relevant when the axis `type` is 'date'. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

• width
  Parent: data[type=candlestick].line
  Type: number greater than or equal to 0
  Default: 2

  Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.

Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).

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.

• fillcolor
  Parent: data[type=candlestick].increasing
  Type: color

  Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

• line
  Parent: data[type=candlestick].increasing
  Type: struct containing one or more of the keys listed below.
  • color
    Parent: data[type=candlestick].increasing.line
    Type: color
    Default: '#3D9970'

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

  • width
    Parent: data[type=candlestick].increasing.line
    Type: number greater than or equal to 0
    Default: 2

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

• fillcolor
  Parent: data[type=candlestick].decreasing
  Type: color

  Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

• line
  Parent: data[type=candlestick].decreasing
  Type: struct containing one or more of the keys listed below.
  • color
    Parent: data[type=candlestick].decreasing.line
    Type: color
    Default: '#FF4136'

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

  • width
    Parent: data[type=candlestick].decreasing.line
    Type: number greater than or equal to 0
    Default: 2

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

• align
  Parent: data[type=candlestick].hoverlabel
  Type: enumerated or array of enumerateds , one of ( 'left' | 'right' | 'auto' )
  Default: 'auto'

  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

• bgcolor
  Parent: data[type=candlestick].hoverlabel
  Type: color or array of colors

  Sets the background color of the hover labels for this trace

• bordercolor
  Parent: data[type=candlestick].hoverlabel
  Type: color or array of colors

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

• font
  Parent: data[type=candlestick].hoverlabel
  Type: struct containing one or more of the keys listed below.

  Sets the font used in hover labels.

  • color
    Parent: data[type=candlestick].hoverlabel.font
    Type: color or array of colors
  • family
    Parent: data[type=candlestick].hoverlabel.font
    Type: string or array of strings

    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
    Parent: data[type=candlestick].hoverlabel.font
    Type: flaglist string. Any combination of 'under', 'over', 'through' joined with a '+' OR 'none'.
    Examples: 'under', 'over', 'under+over', 'under+over+through', 'none'
    Default: 'none'

    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
    Parent: data[type=candlestick].hoverlabel.font
    Type: string or array of strings
    Default: 'none'

    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
    Parent: data[type=candlestick].hoverlabel.font
    Type: number or array of numbers greater than or equal to 1
  • style
    Parent: data[type=candlestick].hoverlabel.font
    Type: enumerated or array of enumerateds , one of ( 'normal' | 'italic' )
    Default: 'normal'

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

  • textcase
    Parent: data[type=candlestick].hoverlabel.font
    Type: enumerated or array of enumerateds , one of ( 'normal' | 'word caps' | 'upper' | 'lower' )
    Default: 'normal'

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

  • variant
    Parent: data[type=candlestick].hoverlabel.font
    Type: enumerated or array of enumerateds , one of ( 'normal' | 'small-caps' | 'all-small-caps' | 'all-petite-caps' | 'petite-caps' | 'unicase' )
    Default: 'normal'

    Sets the variant of the font.

  • weight
    Parent: data[type=candlestick].hoverlabel.font
    Type: integer or array of integers between or equal to 1 and 1000
    Default: normal

    Sets the weight (or boldness) of the font.

• namelength
  Parent: data[type=candlestick].hoverlabel
  Type: integer or array of integers greater than or equal to -1
  Default: 15

  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.

• split
  Parent: data[type=candlestick].hoverlabel
  Type: boolean

  Show hover information (open, close, high, low) in separate labels.

Sets the calendar system to use with `x` date data.

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.