GeezerVison is showing plotly.com — plotly.graph_objects.Candlestick — 7.1.0 documentation
-
class
plotly.graph_objects.Candlestick(arg=None, close=None, customdata=None, decreasing=None, high=None, hoverinfo=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertext=None, ids=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, meta=None, name=None, opacity=None, open=None, selectedpoints=None, showlegend=None, text=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)¶
-
__init__(arg=None, close=None, customdata=None, decreasing=None, high=None, hoverinfo=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertext=None, ids=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, meta=None, name=None, opacity=None, open=None, selectedpoints=None, showlegend=None, text=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)¶
Construct a new Candlestick object
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) than the open value are called increasing
(decreasing). By default, increasing candles are drawn in green
whereas decreasing are drawn in red.
- Parameters
arg – dict of properties compatible with this constructor or
an instance of plotly.graph_objects.Candlestick close – Sets the close values. customdata – 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 decreasing – plotly.graph_objects.candlestick.Decreasing
instance or dict with compatible properties high – Sets the high values. hoverinfo – Determines what trace information appears 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. hoverlabel – plotly.graph_objects.candlestick.Hoverlabel
instance or dict with compatible properties hovertemplate – 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>. hovertemplatefallback – 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. hovertext – Same as text. ids – 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. increasing – plotly.graph_objects.candlestick.Increasing
instance or dict with compatible properties 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. legendgroup – 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. legendgrouptitle – plotly.graph_objects.candlestick.Legendgrouptit
le instance or dict with compatible properties legendrank – 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. legendwidth – Sets the width (in px or fraction) of the legend for
this trace. line – plotly.graph_objects.candlestick.Line instance
or dict with compatible properties low – Sets the low values. meta – 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. name – Sets the trace name. The trace name appears as the
legend item and on hover. opacity – Sets the opacity of the trace. open – Sets the open values. selectedpoints – 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. showlegend – Determines whether or not an item corresponding to this
trace is shown in the legend. text – 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. uid – Assign an id to this trace, Use this to provide object
constancy between traces during animations and
transitions. uirevision – 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. visible – 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). whiskerwidth – Sets the width of the whiskers relative to the box
width. For example, with 1, the whiskers are as wide as
the box(es). x – Sets the x coordinates. If absent, linear coordinate
will be generated. xaxis – 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. xcalendar – Sets the calendar system to use with x date data. xhoverformat – Sets the hover text formatting rule for 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. xperiod – 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. xperiod0 – 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. xperiodalignment – Only relevant when the axis type is “date”. Sets the
alignment of data points on the x axis. yaxis – 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. yhoverformat – Sets the hover text formatting rule for 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. zorder – 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.
- Returns
-
- Return type
Candlestick
-
class
plotly.graph_objects.candlestick.Decreasing(arg=None, fillcolor=None, line=None, **kwargs)¶
-
property
fillcolor¶
Sets the fill color. Defaults to a half-transparent variant of
the line color, marker color, or marker line color, whichever
is available.
- The ‘fillcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
line¶
The ‘line’ property is an instance of Line
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.candlestick.decreasing.Line
-
class
plotly.graph_objects.candlestick.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, namelength=None, showarrow=None, split=None, **kwargs)¶
-
property
align¶
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
- The ‘align’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
bgcolor¶
Sets the background color of the hover labels for this trace
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/ A list or array of any of the above
- Returns
-
- Return type
str|numpy.ndarray
-
property
bordercolor¶
Sets the border color of the hover labels for this trace.
- The ‘bordercolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/ A list or array of any of the above
- Returns
-
- Return type
str|numpy.ndarray
-
property
font¶
Sets the font used in hover labels.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.candlestick.hoverlabel.Font
-
property
namelength¶
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.
- The ‘namelength’ property is an integer and may be specified as:
An int (or float that will be cast to an int)
in the interval [-1, 9223372036854775807] A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
int|numpy.ndarray
-
property
showarrow¶
Sets whether or not to show the hover label arrow/triangle
pointing to the data point.
- The ‘showarrow’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
split¶
Show hover information (open, close, high, low) in separate
labels, rather than a single unified label. Default: False.
When set to True, hovertemplate is ignored.
- The ‘split’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
class
plotly.graph_objects.candlestick.Increasing(arg=None, fillcolor=None, line=None, **kwargs)¶
-
property
fillcolor¶
Sets the fill color. Defaults to a half-transparent variant of
the line color, marker color, or marker line color, whichever
is available.
- The ‘fillcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
line¶
The ‘line’ property is an instance of Line
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.candlestick.increasing.Line
-
class
plotly.graph_objects.candlestick.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶
-
property
font¶
Sets this legend group’s title font.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.candlestick.legendgrouptitle.Font
-
property
text¶
Sets the title of the legend group.
- The ‘text’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
class
plotly.graph_objects.candlestick.Line(arg=None, width=None, **kwargs)¶
-
property
width¶
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.
- The ‘width’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
|
