Struct ImageExportOptions 

#[non_exhaustive]
pub struct ImageExportOptions {
    pub size: [u32; 2],
    pub include_title: bool,
    pub include_timestamp: bool,
    pub include_watermark: bool,
    pub transparent_background: bool,
    pub include_crosshair: bool,
    pub textures: HashMap<TextureId, Arc<ColorImage>>,
}

Image options shared by the export dialog and offscreen rendering.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

size: [u32; 2]

Output width and height in pixels.

include_title: bool

Include the symbol above the chart.

include_timestamp: bool

Include the export time in the chart’s time zone above the chart.

include_watermark: bool

Draw the symbol watermark and the one set with Chart::set_watermark, as they show on screen, independently of the title and timestamp.

transparent_background: bool

Omit the chart and header backgrounds, retaining plot and drawing colours.

include_crosshair: bool

Draw the crosshair where the pointer last placed it over the plots, or where Chart::set_crosshair_position or a synchronized chart placed it since.

textures: HashMap<TextureId, Arc<ColorImage>>

Pixels of the textures the host binds itself, by the id its images use, so Chart::export_png and Chart::export_svg can draw them with png-export. Without an entry, an image of such a texture fails the export. Supplied textures use linear filtering and clamp to their edges. Prefer [egui::TextureId::User]: ids that collide with the offscreen frame’s own textures return an error. ChartImage frames include the supplied pixels too.

Trait Implementations

impl Clone for ImageExportOptions

fn clone(&self) -> ImageExportOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageExportOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ImageExportOptions

fn default() -> Self

Returns the “default value” for a type.