Black Lives Matter. Please consider donating to Black Girls Code today.

Python Figure Reference: candlestick Traces

A plotly.graph_objects.Candlestick trace is a graph object in the figure's data list with any of the named arguments or attributes listed below.

The candlestick is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The boxes represent the spread between the `open` and `close` values and the lines represent the spread between the `low` and `high` values Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing candles are drawn in green whereas decreasing are drawn in red.

  • name
    Code: fig.update_traces(name=<VALUE>, selector=dict(type='candlestick'))
    Type: string

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

  • visible
    Code: fig.update_traces(visible=<VALUE>, selector=dict(type='candlestick'))
    Type: enumerated , one of ( True | False | "legendonly" )
    Default: True

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

  • showlegend
    Code: fig.update_traces(showlegend=<VALUE>, selector=dict(type='candlestick'))
    Type: boolean
    Default: True

    Determines whether or not an item corresponding to this trace is shown in the legend.

  • legendgroup
    Code: fig.update_traces(legendgroup=<VALUE>, selector=dict(type='candlestick'))
    Type: string
    Default: ""

    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • opacity
    Code: fig.update_traces(opacity=<VALUE>, selector=dict(type='candlestick'))
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Code: fig.update_traces(ids=<VALUE>, selector=dict(type='candlestick'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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.

  • x
    Code: fig.update_traces(x=<VALUE>, selector=dict(type='candlestick'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

  • close
    Code: fig.update_traces(close=<VALUE>, selector=dict(type='candlestick'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    Sets the close values.

  • open
    Code: fig.update_traces(open=<VALUE>, selector=dict(type='candlestick'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    Sets the open values.

  • high
    Code: fig.update_traces(high=<VALUE>, selector=dict(type='candlestick'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    Sets the high values.

  • low
    Code: fig.update_traces(low=<VALUE>, selector=dict(type='candlestick'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    Sets the low values.

  • text
    Code: fig.update_traces(text=<VALUE>, selector=dict(type='candlestick'))
    Type: string or array of strings
    Default: ""

    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.

  • hovertext
    Code: fig.update_traces(hovertext=<VALUE>, selector=dict(type='candlestick'))
    Type: string or array of strings
    Default: ""

    Same as `text`.

  • hoverinfo
    Code: fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='candlestick'))
    Type: flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "x", "y", "x+y", "x+y+z", "all"
    Default: "all"

    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.

  • meta
    Code: fig.update_traces(meta=<VALUE>, selector=dict(type='candlestick'))
    Type: number or categorical coordinate string

    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.

  • customdata
    Code: fig.update_traces(customdata=<VALUE>, selector=dict(type='candlestick'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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

  • xaxis
    Code: fig.update_traces(xaxis=<VALUE>, selector=dict(type='candlestick'))
    Type: subplotid
    Default: x

    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.

  • yaxis
    Code: fig.update_traces(yaxis=<VALUE>, selector=dict(type='candlestick'))
    Type: subplotid
    Default: y

    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.

  • xperiod
    Code: fig.update_traces(xperiod=<VALUE>, selector=dict(type='candlestick'))
    Type: number or categorical coordinate string
    Default: 0

    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.

  • xperiodalignment
    Code: fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='candlestick'))
    Type: enumerated , one of ( "start" | "middle" | "end" )
    Default: "middle"

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

  • xperiod0
    Code: fig.update_traces(xperiod0=<VALUE>, selector=dict(type='candlestick'))
    Type: number or categorical coordinate string

    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.

  • line
    Code: fig.update_traces(line=dict(...), selector=dict(type='candlestick'))
    Type: dict containing one or more of the keys listed below.
    • width
      Code: fig.update_traces(line_width=<VALUE>, selector=dict(type='candlestick'))
      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`.

  • whiskerwidth
    Code: fig.update_traces(whiskerwidth=<VALUE>, selector=dict(type='candlestick'))
    Type: number between or equal to 0 and 1
    Default: 0

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

  • selectedpoints
    Code: fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='candlestick'))
    Type: number or categorical coordinate string

    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.

  • increasing
    Code: fig.update_traces(increasing=dict(...), selector=dict(type='candlestick'))
    Type: dict containing one or more of the keys listed below.
    • line
      Code: fig.update_traces(increasing_line=dict(...), selector=dict(type='candlestick'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(increasing_line_color=<VALUE>, selector=dict(type='candlestick'))
        Type: color
        Default: "#3D9970"

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

      • width
        Code: fig.update_traces(increasing_line_width=<VALUE>, selector=dict(type='candlestick'))
        Type: number greater than or equal to 0
        Default: 2

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

    • fillcolor
      Code: fig.update_traces(increasing_fillcolor=<VALUE>, selector=dict(type='candlestick'))
      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.

  • decreasing
    Code: fig.update_traces(decreasing=dict(...), selector=dict(type='candlestick'))
    Type: dict containing one or more of the keys listed below.
    • line
      Code: fig.update_traces(decreasing_line=dict(...), selector=dict(type='candlestick'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(decreasing_line_color=<VALUE>, selector=dict(type='candlestick'))
        Type: color
        Default: "#FF4136"

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

      • width
        Code: fig.update_traces(decreasing_line_width=<VALUE>, selector=dict(type='candlestick'))
        Type: number greater than or equal to 0
        Default: 2

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

    • fillcolor
      Code: fig.update_traces(decreasing_fillcolor=<VALUE>, selector=dict(type='candlestick'))
      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.

  • hoverlabel
    Code: fig.update_traces(hoverlabel=dict(...), selector=dict(type='candlestick'))
    Type: dict containing one or more of the keys listed below.
    • bgcolor
      Code: fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='candlestick'))
      Type: color or array of colors

      Sets the background color of the hover labels for this trace

    • bordercolor
      Code: fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='candlestick'))
      Type: color or array of colors

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

    • font
      Code: fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='candlestick'))
      Type: dict containing one or more of the keys listed below.

      Sets the font used in hover labels.

      • family
        Code: fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='candlestick'))
        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".

      • size
        Code: fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='candlestick'))
        Type: number or array of numbers greater than or equal to 1
      • color
        Code: fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='candlestick'))
        Type: color or array of colors
    • align
      Code: fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='candlestick'))
      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

    • namelength
      Code: fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='candlestick'))
      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
      Code: fig.update_traces(hoverlabel_split=<VALUE>, selector=dict(type='candlestick'))
      Type: boolean

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

  • xcalendar
    Code: fig.update_traces(xcalendar=<VALUE>, selector=dict(type='candlestick'))
    Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    Default: "gregorian"

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

  • uirevision
    Code: fig.update_traces(uirevision=<VALUE>, selector=dict(type='candlestick'))
    Type: number or categorical coordinate string

    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.