Skip to content

Ohlc

close: 'data array' #(1)!
customdata: 'data array' #(2)!
decreasing:
  line:
    color: 'color' #(3)!
    dash: 'string' #(4)!
    width: 'number greater than or equal to 0' #(5)!
high: 'data array' #(6)!
hoverinfo: 'flaglist string. any combination of "x", "y", "z", "text", "name" joined
  with a "+" or "all" or "none" or "skip".' #(7)!
hoverlabel:
  align: 'enumerated or array of enumerateds , one of ( "left" | "right" | "auto"
    )' #(8)!
  bgcolor: 'color or array of colors' #(9)!
  bordercolor: 'color or array of colors' #(10)!
  font:
    color: color or array of colors
    family: 'string or array of strings' #(11)!
    size: number or array of numbers greater than or equal to 1
  namelength: 'integer or array of integers greater than or equal to -1' #(12)!
  split: 'boolean' #(13)!
hovertext: 'string or array of strings' #(14)!
ids: 'data array' #(15)!
increasing:
  line:
    color: 'color' #(16)!
    dash: 'string' #(17)!
    width: 'number greater than or equal to 0' #(18)!
legendgroup: 'string' #(19)!
legendgrouptitle:
  font:
    color: color
    family: 'string' #(20)!
    size: number greater than or equal to 1
  text: 'string' #(21)!
legendrank: 'number' #(22)!
legendwidth: 'number greater than or equal to 0' #(23)!
line:
  dash: 'string' #(24)!
  width: 'number greater than or equal to 0' #(25)!
low: 'data array' #(26)!
meta: 'number or categorical coordinate string' #(27)!
opacity: 'number between or equal to 0 and 1' #(28)!
open: 'data array' #(29)!
selectedpoints: 'number or categorical coordinate string' #(30)!
showlegend: 'boolean' #(31)!
text: 'string or array of strings' #(32)!
tickwidth: 'number between or equal to 0 and 0.5' #(33)!
type: ohlc
uirevision: 'number or categorical coordinate string' #(34)!
visible: 'enumerated , one of ( true | false | "legendonly" )' #(35)!
x: 'data array' #(36)!
xaxis: 'subplotid' #(37)!
xcalendar: 'enumerated , one of ( "chinese" | "coptic" | "discworld" | "ethiopian"
  | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi"
  | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" )' #(38)!
xhoverformat: 'string' #(39)!
xperiod: 'number or categorical coordinate string' #(41)!
xperiod0: 'number or categorical coordinate string' #(40)!
xperiodalignment: 'enumerated , one of ( "start" | "middle" | "end" )' #(42)!
yaxis: 'subplotid' #(43)!
yhoverformat: 'string' #(44)!
  1. Sets the close values.
  2. 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
  3. Sets the line color.
  4. 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").
  5. Sets the line width (in px).
  6. Sets the high values.
  7. 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.
  8. 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
  9. Sets the background color of the hover labels for this trace
  10. Sets the border color of the hover labels for this trace.
  11. 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".
  12. 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.
  13. Show hover information (open, close, high, low) in separate labels.
  14. Same as text.
  15. 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.
  16. Sets the line color.
  17. 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").
  18. Sets the line width (in px).
  19. Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  20. 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".
  21. Sets the title of the legend group.
  22. 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.
  23. Sets the width (in px or fraction) of the legend for this trace.
  24. 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"). Note that this style setting can also be set per direction via increasing.line.dash and decreasing.line.dash.
  25. [object Object] Note that this style setting can also be set per direction via increasing.line.width and decreasing.line.width.
  26. Sets the low values.
  27. 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.
  28. Sets the opacity of the trace.
  29. Sets the open values.
  30. 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.
  31. Determines whether or not an item corresponding to this trace is shown in the legend.
  32. 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.
  33. Sets the width of the open/close tick marks relative to the "x" minimal interval.
  34. 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.
  35. 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).
  36. Sets the x coordinates. If absent, linear coordinate will be generated.
  37. 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.
  38. Sets the calendar system to use with x date data.
  39. 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.
  40. 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.
  41. Only relevant when the axis type is "date". Sets the period positioning in milliseconds or "M" on the x axis. Special values in the form of "M" could be used to declare the number of months. In this case n must be a positive integer.
  42. Only relevant when the axis type is "date". Sets the alignment of data points on the x axis.
  43. 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.
  44. 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.