Struct Image 

pub struct Image { /* private fields */ }

A structure representing an image plot.

The Image struct allows for the integration of image data into plots, enabling visualization of raster data or standalone images within a plotting context. It supports customizable titles, axis labels, legend configuration, and layout adjustments for better presentation.

Arguments

• path - A string slice specifying the file path of the image to be displayed.
• plot_title - An optional Text struct specifying the title of the plot.
• x_title - An optional Text struct specifying the title of the x-axis.
• y_title - An optional Text struct specifying the title of the y-axis.
• x_axis - An optional reference to an Axis struct for customizing the x-axis.
• y_axis - An optional reference to an Axis struct for customizing the y-axis.

Example

use plotlars::{Axis, Image, Plot};

let axis = Axis::new()
    .show_axis(false);

Image::builder()
    .path("data/image.png")
    .x_axis(&axis)
    .y_axis(&axis)
    .plot_title("Image Plot")
    .build()
    .plot();

Implementations

impl Image

pub fn builder<'f1, 'f2, 'f3>() -> ImageBuilder<'f1, 'f2, 'f3>

Examples found in repository

examples/image.rs (line 6)

fn main() {
    let axis = Axis::new().show_axis(false);

    Image::builder()
        .path("data/image.png")
        .x_axis(&axis)
        .y_axis(&axis)
        .plot_title("Image Plot")
        .build()
        .plot();
}

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PlotHelper for Image

fn get_layout(&self) -> &LayoutPlotly

fn get_traces(&self) -> &Vec<Box<dyn Trace + 'static>>

impl Serialize for Image

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

where __S: Serializer,

Serialize this value into the given Serde serializer.