# --- THIS FILE IS AUTO-GENERATED ---

# Modifications will be overwitten the next time code generation run.

from plotly.basedatatypes import BaseTraceType as _BaseTraceType

import copy as _copy

class Ohlc(_BaseTraceType):

_parent_path_str = ""

_path_str = "ohlc"

_valid_props = {

"close",

"closesrc",

"customdata",

"customdatasrc",

"decreasing",

"high",

"highsrc",

"hoverinfo",

"hoverinfosrc",

"hoverlabel",

"hovertemplate",

"hovertemplatefallback",

"hovertemplatesrc",

"hovertext",

"hovertextsrc",

"ids",

"idssrc",

"increasing",

"legend",

"legendgroup",

"legendgrouptitle",

"legendrank",

"legendwidth",

"line",

"low",

"lowsrc",

"meta",

"metasrc",

"name",

"opacity",

"open",

"opensrc",

"selectedpoints",

"showlegend",

"stream",

"text",

"textsrc",

"tickwidth",

"type",

"uid",

"uirevision",

"visible",

"x",

"xaxis",

"xcalendar",

"xhoverformat",

"xperiod",

"xperiod0",

"xperiodalignment",

"xsrc",

"yaxis",

"yhoverformat",

"zorder",

}

@property

def close(self):

"""

Sets the close values.

The 'close' property is an array that may be specified as a tuple,

list, numpy array, or pandas Series

Returns

-------

numpy.ndarray

"""

return self["close"]

@close.setter

def close(self, val):

self["close"] = val

@property

def closesrc(self):

"""

Sets the source reference on Chart Studio Cloud for `close`.

The 'closesrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["closesrc"]

@closesrc.setter

def closesrc(self, val):

self["closesrc"] = val

@property

def customdata(self):

"""

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

The 'customdata' property is an array that may be specified as a tuple,

list, numpy array, or pandas Series

Returns

-------

numpy.ndarray

"""

return self["customdata"]

@customdata.setter

def customdata(self, val):

self["customdata"] = val

@property

def customdatasrc(self):

"""

Sets the source reference on Chart Studio Cloud for

`customdata`.

The 'customdatasrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["customdatasrc"]

@customdatasrc.setter

def customdatasrc(self, val):

self["customdatasrc"] = val

@property

def decreasing(self):

"""

The 'decreasing' property is an instance of Decreasing

that may be specified as:

- An instance of :class:`plotly.graph_objs.ohlc.Decreasing`

- A dict of string/value properties that will be passed

to the Decreasing constructor

Returns

-------

plotly.graph_objs.ohlc.Decreasing

"""

return self["decreasing"]

@decreasing.setter

def decreasing(self, val):

self["decreasing"] = val

@property

def high(self):

"""

Sets the high values.

The 'high' property is an array that may be specified as a tuple,

list, numpy array, or pandas Series

Returns

-------

numpy.ndarray

"""

return self["high"]

@high.setter

def high(self, val):

self["high"] = val

@property

def highsrc(self):

"""

Sets the source reference on Chart Studio Cloud for `high`.

The 'highsrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["highsrc"]

@highsrc.setter

def highsrc(self, val):

self["highsrc"] = val

@property

def hoverinfo(self):

"""

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.

The 'hoverinfo' property is a flaglist and may be specified

as a string containing:

- Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters

(e.g. 'x+y')

OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')

- A list or array of the above

Returns

-------

Any|numpy.ndarray

"""

return self["hoverinfo"]

@hoverinfo.setter

def hoverinfo(self, val):

self["hoverinfo"] = val

@property

def hoverinfosrc(self):

"""

Sets the source reference on Chart Studio Cloud for

`hoverinfo`.

The 'hoverinfosrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["hoverinfosrc"]

@hoverinfosrc.setter

def hoverinfosrc(self, val):

self["hoverinfosrc"] = val

@property

def hoverlabel(self):

"""

The 'hoverlabel' property is an instance of Hoverlabel

that may be specified as:

- An instance of :class:`plotly.graph_objs.ohlc.Hoverlabel`

- A dict of string/value properties that will be passed

to the Hoverlabel constructor

Returns

-------

plotly.graph_objs.ohlc.Hoverlabel

"""

return self["hoverlabel"]

@hoverlabel.setter

def hoverlabel(self, val):

self["hoverlabel"] = val

@property

def hovertemplate(self):

"""

Template string used for rendering the information that appear

on hover box. Note that this will override `hoverinfo`.

Variables are inserted using %{variable}, for example "y: %{y}"

as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When

showing info for several points, "xother" will be added to

those with different x positions from the first point. An

underscore before or after "(x|y)other" will add a space on

that side, only when this field is shown. Numbers are formatted

using d3-format's syntax %{variable:d3-format}, for example

"Price: %{y:$.2f}".

https://github.com/d3/d3-format/tree/v1.4.5#d3-format for

details on the formatting syntax. Dates are formatted using

d3-time-format's syntax %{variable|d3-time-format}, for example

"Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-

format/tree/v2.2.3#locale_format for details on the date

formatting syntax. Variables that can't be found will be

replaced with the specifier. For example, a template of "data:

%{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1

and y is missing. Variables with an undefined value will be

replaced with the fallback value. The variables available in

`hovertemplate` are the ones emitted as event data described at

this link https://plotly.com/javascript/plotlyjs-events/#event-

data. Additionally, all attributes that can be specified per-

point (the ones that are `arrayOk: true`) are available.

Finally, the template string has access to variables `open`,

`high`, `low` and `close`. Anything contained in tag `<extra>`

is displayed in the secondary box, for example

`<extra>%{fullData.name}</extra>`. To hide the secondary box

completely, use an empty tag `<extra></extra>`.

The 'hovertemplate' property is a string and must be specified as:

- A string

- A number that will be converted to a string

- A tuple, list, or one-dimensional numpy array of the above

Returns

-------

str|numpy.ndarray

"""

return self["hovertemplate"]

@hovertemplate.setter

def hovertemplate(self, val):

self["hovertemplate"] = val

@property

def hovertemplatefallback(self):

"""

Fallback string that's displayed when a variable referenced in

a template is missing. If the boolean value 'false' is passed

in, the specifier with the missing variable will be displayed.

The 'hovertemplatefallback' property accepts values of any type

Returns

-------

Any

"""

return self["hovertemplatefallback"]

@hovertemplatefallback.setter

def hovertemplatefallback(self, val):

self["hovertemplatefallback"] = val

@property

def hovertemplatesrc(self):

"""

Sets the source reference on Chart Studio Cloud for

`hovertemplate`.

The 'hovertemplatesrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["hovertemplatesrc"]

@hovertemplatesrc.setter

def hovertemplatesrc(self, val):

self["hovertemplatesrc"] = val

@property

def hovertext(self):

"""

Same as `text`.

The 'hovertext' property is a string and must be specified as:

- A string

- A number that will be converted to a string

- A tuple, list, or one-dimensional numpy array of the above

Returns

-------

str|numpy.ndarray

"""

return self["hovertext"]

@hovertext.setter

def hovertext(self, val):

self["hovertext"] = val

@property

def hovertextsrc(self):

"""

Sets the source reference on Chart Studio Cloud for

`hovertext`.

The 'hovertextsrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["hovertextsrc"]

@hovertextsrc.setter

def hovertextsrc(self, val):

self["hovertextsrc"] = val

@property

def ids(self):

"""

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.

The 'ids' property is an array that may be specified as a tuple,

list, numpy array, or pandas Series

Returns

-------

numpy.ndarray

"""

return self["ids"]

@ids.setter

def ids(self, val):

self["ids"] = val

@property

def idssrc(self):

"""

Sets the source reference on Chart Studio Cloud for `ids`.

The 'idssrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["idssrc"]

@idssrc.setter

def idssrc(self, val):

self["idssrc"] = val

@property

def increasing(self):

"""

The 'increasing' property is an instance of Increasing

that may be specified as:

- An instance of :class:`plotly.graph_objs.ohlc.Increasing`

- A dict of string/value properties that will be passed

to the Increasing constructor

Returns

-------

plotly.graph_objs.ohlc.Increasing

"""

return self["increasing"]

@increasing.setter

def increasing(self, val):

self["increasing"] = val

@property

def legend(self):

"""

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.

The 'legend' property is an identifier of a particular

subplot, of type 'legend', that may be specified as:

- the string 'legend' optionally followed by an integer >= 1

(e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)

Returns

-------

str

"""

return self["legend"]

@legend.setter

def legend(self, val):

self["legend"] = val

@property

def legendgroup(self):

"""

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.

The 'legendgroup' property is a string and must be specified as:

- A string

- A number that will be converted to a string

Returns

-------

str

"""

return self["legendgroup"]

@legendgroup.setter

def legendgroup(self, val):

self["legendgroup"] = val

@property

def legendgrouptitle(self):

"""

The 'legendgrouptitle' property is an instance of Legendgrouptitle

that may be specified as:

- An instance of :class:`plotly.graph_objs.ohlc.Legendgrouptitle`

- A dict of string/value properties that will be passed

to the Legendgrouptitle constructor

Returns

-------

plotly.graph_objs.ohlc.Legendgrouptitle

"""

return self["legendgrouptitle"]

@legendgrouptitle.setter

def legendgrouptitle(self, val):

self["legendgrouptitle"] = val

@property

def legendrank(self):

"""

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.

The 'legendrank' property is a number and may be specified as:

- An int or float

Returns

-------

int|float

"""

return self["legendrank"]

@legendrank.setter

def legendrank(self, val):

self["legendrank"] = val

@property

def legendwidth(self):

"""

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

trace.

The 'legendwidth' property is a number and may be specified as:

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

Returns

-------

int|float

"""

return self["legendwidth"]

@legendwidth.setter

def legendwidth(self, val):

self["legendwidth"] = val

@property

def line(self):

"""

The 'line' property is an instance of Line

that may be specified as:

- An instance of :class:`plotly.graph_objs.ohlc.Line`

- A dict of string/value properties that will be passed

to the Line constructor

Returns

-------

plotly.graph_objs.ohlc.Line

"""

return self["line"]

@line.setter

def line(self, val):

self["line"] = val

@property

def low(self):

"""

Sets the low values.

The 'low' property is an array that may be specified as a tuple,

list, numpy array, or pandas Series

Returns

-------

numpy.ndarray

"""

return self["low"]

@low.setter

def low(self, val):

self["low"] = val

@property

def lowsrc(self):

"""

Sets the source reference on Chart Studio Cloud for `low`.

The 'lowsrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["lowsrc"]

@lowsrc.setter

def lowsrc(self, val):

self["lowsrc"] = val

@property

def meta(self):

"""

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.

The 'meta' property accepts values of any type

Returns

-------

Any|numpy.ndarray

"""

return self["meta"]

@meta.setter

def meta(self, val):

self["meta"] = val

@property

def metasrc(self):

"""

Sets the source reference on Chart Studio Cloud for `meta`.

The 'metasrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["metasrc"]

@metasrc.setter

def metasrc(self, val):

self["metasrc"] = val

@property

def name(self):

"""

Sets the trace name. The trace name appears as the legend item

and on hover.

The 'name' property is a string and must be specified as:

- A string

- A number that will be converted to a string

Returns

-------

str

"""

return self["name"]

@name.setter

def name(self, val):

self["name"] = val

@property

def opacity(self):

"""

Sets the opacity of the trace.

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

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

Returns

-------

int|float

"""

return self["opacity"]

@opacity.setter

def opacity(self, val):

self["opacity"] = val

@property

def open(self):

"""

Sets the open values.

The 'open' property is an array that may be specified as a tuple,

list, numpy array, or pandas Series

Returns

-------

numpy.ndarray

"""

return self["open"]

@open.setter

def open(self, val):

self["open"] = val

@property

def opensrc(self):

"""

Sets the source reference on Chart Studio Cloud for `open`.

The 'opensrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["opensrc"]

@opensrc.setter

def opensrc(self, val):

self["opensrc"] = val

@property

def selectedpoints(self):

"""

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.

The 'selectedpoints' property accepts values of any type

Returns

-------

Any

"""

return self["selectedpoints"]

@selectedpoints.setter

def selectedpoints(self, val):

self["selectedpoints"] = val

@property

def showlegend(self):

"""

Determines whether or not an item corresponding to this trace

is shown in the legend.

The 'showlegend' property is a boolean and must be specified as:

- A boolean value: True or False

Returns

-------

bool

"""

return self["showlegend"]

@showlegend.setter

def showlegend(self, val):

self["showlegend"] = val

@property

def stream(self):

"""

The 'stream' property is an instance of Stream

that may be specified as:

- An instance of :class:`plotly.graph_objs.ohlc.Stream`

- A dict of string/value properties that will be passed

to the Stream constructor

Returns

-------

plotly.graph_objs.ohlc.Stream

"""

return self["stream"]

@stream.setter

def stream(self, val):

self["stream"] = val

@property

def text(self):

"""

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.

The 'text' property is a string and must be specified as:

- A string

- A number that will be converted to a string

- A tuple, list, or one-dimensional numpy array of the above

Returns

-------

str|numpy.ndarray

"""

return self["text"]

@text.setter

def text(self, val):

self["text"] = val

@property

def textsrc(self):

"""

Sets the source reference on Chart Studio Cloud for `text`.

The 'textsrc' property must be specified as a string or

as a plotly.grid_objs.Column object

Returns

-------

str

"""

return self["textsrc"]

@textsrc.setter

def textsrc(self, val):

self["textsrc"] = val

@property

def tickwidth(self):

"""

Sets the width of the open/close tick marks relative to the "x"

minimal interval.

The 'tickwidth' property is a number and may be specified as:

- An int or float in the interval [0, 0.5]

Returns

-------

int|float

"""

return self["tickwidth"]

@tickwidth.setter

def tickwidth(self, val):

self["tickwidth"] = val

@property

def uid(self):

"""

Assign an id to this trace, Use this to provide object

constancy between traces during animations and transitions.

The 'uid' property is a string and must be specified as:

- A string

- A number that will be converted to a string

Returns

-------

str

"""

return self["uid"]

@uid.setter

def uid(self, val):

self["uid"] = val

@property

def uirevision(self):

"""

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.

The 'uirevision' property accepts values of any type

Returns

-------

Any

"""

return self["uirevision"]

@uirevision.setter

def uirevision(self, val):

self["uirevision"] = val

@property

def visible(self):

"""

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

The 'visible' property is an enumeration that may be specified as:

- One of the following enumeration values:

[True, False, 'legendonly']

Returns

-------

Any

"""

return self["visible"]

@visible.setter

def visible(self, val):

self["visible"] = val

@property

def x(self):

"""

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

generated.

The 'x' property is an array that may be specified as a tuple,

list, numpy array, or pandas Series

Returns

-------

numpy.ndarray

"""

return self["x"]

@x.setter

def x(self, val):

self["x"] = val

@property

def xaxis(self):

"""

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.

The 'xaxis' property is an identifier of a particular

subplot, of type 'x', that may be specified as:

- the string 'x' optionally followed by an integer >= 1

(e.g. 'x', 'x1', 'x2', 'x3', etc.)

Returns

-------

str

"""

return self["xaxis"]

@xaxis.setter

def xaxis(self, val):

self["xaxis"] = val

@property

def xcalendar(self):

"""

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

The 'xcalendar' property is an enumeration that may be specified as:

- One of the following enumeration values:

['chinese', 'coptic', 'discworld', 'ethiopian',

'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',

'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',

'thai', 'ummalqura']

Returns

-------

Any

"""

return self["xcalendar"]

@xcalendar.setter

def xcalendar(self, val):

self["xcalendar"] = val

@property

def xhoverformat(self):

"""

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

The 'xhoverformat' property is a string and must be specified as:

- A string

- A number that will be converted to a string

Returns

-------

str

"""