Struct Plotly

pub struct Plotly { /* private fields */ }

Plotly component wrapper

Examples

#[function_component(MyPlot)]
fn my_plot() -> Html {
    let mut plot = Plot::new();
    let x_values = vec![1, 2, 3];
    let y_values = vec![1, 3, 2];

    let trace = Scatter::new(x_values, y_values)
        .mode(Mode::LinesMarkersText)
        .name("Scatter");

    plot.add_trace(trace);

    html! { <Plotly plot={plot}/> }
}

Trait Implementations

impl Component for Plotly

type Message = ()

Messages are used to make Components dynamic and interactive. Simple Component’s can declare their Message type to be (). Complex Component’s commonly use an enum to declare multiple Message types.

type Properties = PlotlyProps

The Component’s properties.

fn create(_ctx: &Context<Self>) -> Self

Called when component is created.

fn view(&self, _ctx: &Context<Self>) -> Html

Components define their visual layout using a JSX-style syntax through the use of the html! procedural macro. The full guide to using the macro can be found in Yew’s documentation.

fn destroy(&mut self, _ctx: &Context<Self>)

Called right before a Component is unmounted.

fn rendered(&mut self, ctx: &Context<Self>, first_render: bool)

The rendered method is called after each time a Component is rendered but before the browser updates the page.

fn update(&mut self, ctx: &Context<Self>, msg: Self::Message) -> bool

Called when a new message is sent to the component via its scope.

fn changed( &mut self, ctx: &Context<Self>, _old_props: &Self::Properties, ) -> bool

Called when properties passed to the component change

fn prepare_state(&self) -> Option<String>

Prepares the state during server side rendering.