Struct CandlestickChart 

pub struct CandlestickChart<T, X, Y>
where
    T: 'static,
    X: Eq + Hash + Into<SharedString> + 'static,
    Y: PlotValue,
{ /* private fields */ }

Implementations

impl<T, X, Y> CandlestickChart<T, X, Y>

where X: Eq + Hash + Into<SharedString> + 'static, Y: PlotValue,

pub fn new<I>(data: I) -> Self

where I: IntoIterator<Item = T>,

pub fn id(self, id: impl Into<ElementId>) -> Self

Name this chart’s ElementId, replacing the default taken from the construction site.

Pass one where a single construction site renders several of these charts as siblings: they share the default id, and with it one hover state and one path cache. The id must be unique among those siblings.

pub fn interactive(self, interactive: bool) -> Self

Turn this chart’s interactive layer on or off. On by default.

The layer is the hitbox under the cursor and what it drives: a highlight band marks the hovered candle, and a tooltip shows its open, high, low and close. Turn it off for a chart that only decorates, or one an element above it wants the cursor for: without a hitbox it neither answers the mouse nor takes the hover from what sits over it. A chart that is off also drops its path cache, which is keyed on the same id.

pub fn tooltip_title(self, title: impl Fn(&T) -> SharedString + 'static) -> Self

Set the hover tooltip’s title for a datum, instead of its x value.

pub fn tooltip_value( self, value: impl Fn(&T, usize, f64) -> SharedString + 'static, ) -> Self

Set the text of each tooltip row’s value; the raw number by default.

The closure receives the datum, the row’s index (0 to 3 for open, high, low and close) and the value the row reads.

pub fn tooltip_value_color<H>( self, color: impl Fn(&T, usize, f64) -> H + 'static, ) -> Self

where H: Into<Hsla>,

Color each tooltip row’s value, such as green or red by its sign; the tooltip’s text color by default.

The closure receives the same arguments as tooltip_value.

pub fn tooltip_content<E>( self, content: impl Fn(&T, &mut Window, &mut App) -> E + 'static, ) -> Self

where E: IntoElement,

Draw the tooltip box’s content for a datum yourself, in place of the title and rows, for a layout they cannot express such as a table.

The highlight band and where the box sits stay the chart’s, and tooltip_title, tooltip_value and tooltip_value_color no longer apply.

pub fn x(self, x: impl Fn(&T) -> X + 'static) -> Self

pub fn open(self, open: impl Fn(&T) -> Y + 'static) -> Self

pub fn high(self, high: impl Fn(&T) -> Y + 'static) -> Self

pub fn low(self, low: impl Fn(&T) -> Y + 'static) -> Self

pub fn close(self, close: impl Fn(&T) -> Y + 'static) -> Self

pub fn tick_margin(self, tick_margin: usize) -> Self

pub fn body_width_ratio(self, ratio: f32) -> Self

pub fn max_band_width(self, width: impl Into<Pixels>) -> Self

Keep every candle’s band at most width wide, so a few candles across a wide chart stay narrow.

Default is 30px.

pub fn x_axis(self, x_axis: bool) -> Self

Show or hide the x-axis line and labels.

Default is true.

pub fn grid(self, grid: bool) -> Self

pub fn bullish(self, color: impl Into<Hsla>) -> Self

Set the color of a candle that closed above its open.

Defaults to the theme’s chart.bullish color. Markets that read a rise as red set this and Self::bearish the other way round.

pub fn bearish(self, color: impl Into<Hsla>) -> Self

Set the color of a candle that closed at or below its open.

Defaults to the theme’s chart.bearish color.

Trait Implementations

impl<T, X, Y> IntoElement for CandlestickChart<T, X, Y>

where T: 'static, X: Eq + Hash + Into<SharedString> + 'static, Y: PlotValue,

type Element = PlotElement<CandlestickChart<T, X, Y>>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl<T, X, Y> Plot for CandlestickChart<T, X, Y>

where X: Eq + Hash + Into<SharedString> + 'static, Y: PlotValue,

fn paint(&mut self, bounds: Bounds<Pixels>, window: &mut Window, cx: &mut App)

fn id(&self) -> Option<ElementId>

A stable element id that enables interactive tooltip support for this plot.

fn tooltip_state( &self, position: Point<Pixels>, bounds: Bounds<Pixels>, _cx: &App, ) -> Option<TooltipState>

Map the cursor to the tooltip state to display.

fn tooltip( &self, state: &TooltipState, cursor: Point<Pixels>, bounds: Bounds<Pixels>, window: &mut Window, cx: &mut App, ) -> Option<AnyElement>

Render the tooltip overlay for the active TooltipState.

fn prepaint( &mut self, _bounds: Bounds<Pixels>, _window: &mut Window, _cx: &mut App, ) -> Vec<AnyElement>

Lay out and place the child elements this plot hosts (e.g. element labels).

fn hover( &mut self, _hover: Option<&PlotHover>, _window: &mut Window, _cx: &mut App, )

Receive the hovered datum this frame, before Plot::tooltip and Plot::paint run.