Struct plotly_types::traces::ohlc::Ohlc

pub struct Ohlc<'a> { /* fields omitted */ }

The ohlc (short for Open-High-Low-Close) is a style of financial chart describing open, high, low and close for a given x coordinate (most likely time). The tip of the lines represent the low and high values and the horizontal segments represent the open and close values. Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing items are drawn in green whereas decreasing are drawn in red.

Implementations

impl<'a> Ohlc<'a>

pub fn visible(&mut self, visible: Visible) -> &mut 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).

default: true

pub fn showlegend(&mut self, showlegend: bool) -> &mut Self

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

default: true

pub fn legendgroup(&mut self, legendgroup: &'a str) -> &mut Self

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

default: ``

pub fn opacity(&mut self, opacity: f64) -> &mut Self

Sets the opacity of the trace.

default: 1

pub fn name(&mut self, name: &'a str) -> &mut Self

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

pub fn uid(&mut self, uid: &'a str) -> &mut Self

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

pub fn ids(&mut self, ids: &'a [&'a str]) -> &mut 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.

pub fn meta(&mut self, meta: Any) -> &mut 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.

pub fn selectedpoints(&mut self, selectedpoints: Any) -> &mut 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.

pub fn hoverinfo(&mut self) -> &mut Hoverinfo

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.

default: all

pub fn stream(&mut self) -> &mut Stream<'a>

pub fn uirevision(&mut self, uirevision: Any) -> &mut 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.

pub fn x(&mut self, x: &'a [f64]) -> &mut Self

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

pub fn open(&mut self, open: &'a [f64]) -> &mut Self

Sets the open values.

pub fn high(&mut self, high: &'a [f64]) -> &mut Self

Sets the high values.

pub fn low(&mut self, low: &'a [f64]) -> &mut Self

Sets the low values.

pub fn close(&mut self, close: &'a [f64]) -> &mut Self

Sets the close values.

pub fn line(&mut self) -> &mut Line<'a>

pub fn increasing(&mut self) -> &mut Increasing<'a>

pub fn decreasing(&mut self) -> &mut Decreasing<'a>

pub fn text(&mut self, text: &'a str) -> &mut 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.

default: ``

pub fn hovertext(&mut self, hovertext: &'a str) -> &mut Self

Same as text.

default: ``

pub fn tickwidth(&mut self, tickwidth: f64) -> &mut Self

Sets the width of the open/close tick marks relative to the x minimal interval.

default: 0.3

pub fn hoverlabel(&mut self) -> &mut Hoverlabel<'a>

pub fn xcalendar(&mut self, xcalendar: Xcalendar) -> &mut Self

Sets the calendar system to use with x date data.

default: gregorian

pub fn xaxis(&mut self, xaxis: &'a str) -> &mut 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.

default: x

pub fn yaxis(&mut self, yaxis: &'a str) -> &mut Self

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.

default: y

pub fn idssrc(&mut self, idssrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for ids .

pub fn customdatasrc(&mut self, customdatasrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for customdata .

pub fn metasrc(&mut self, metasrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for meta .

pub fn hoverinfosrc(&mut self, hoverinfosrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for hoverinfo .

pub fn xsrc(&mut self, xsrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for x .

pub fn opensrc(&mut self, opensrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for open .

pub fn highsrc(&mut self, highsrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for high .

pub fn lowsrc(&mut self, lowsrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for low .

pub fn closesrc(&mut self, closesrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for close .

pub fn textsrc(&mut self, textsrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for text .

pub fn hovertextsrc(&mut self, hovertextsrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for hovertext .

Trait Implementations

impl<'a> Default for Ohlc<'a>

fn default() -> Ohlc<'a>

Returns the "default value" for a type.

impl<'a> Serialize for Ohlc<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.