RealmOA Library

oa::plot::Figure

Grid figure container. Created without an Engine; the Engine is supplied only at sink time.

StRust public API

Declaration

pub struct Figure { /* private fields */ }
Public Rust declaration.

Public Methods

pub fn ax(&mut self, row: i32, col: i32) -> &mut Axes
pub fn title(&mut self, text: &str)
pub fn x_label(&mut self, text: &str)
pub fn y_label(&mut self, text: &str)
pub fn config(&self) -> &FigureConfig
pub fn rows(&self) -> i32
pub fn cols(&self) -> i32
pub fn cell_rect(&self, row: i32, col: i32, w: u32, h: u32) -> CellRect
pub fn save_to(&self, engine: &Engine, path: &str) -> Result<()>
pub fn render(&self, engine: &Engine) -> Result<Image>
pub fn show(&self, engine: &Engine) -> Result<()>
pub fn render_frame(&self, w: u32, h: u32, ui: &mut Ui<'_>) -> Result<()>

Associated Functions

pub fn new(config: FigureConfig) -> Self
pub fn default_config() -> Self

Public Method Documentation

pub fn ax( &mut self, row: i32, col: i32 ) -> &mut Axes
No public source comment is attached to this declaration.
pub fn title( &mut self, text: &str )
No public source comment is attached to this declaration.
pub fn x_label( &mut self, text: &str )
No public source comment is attached to this declaration.
pub fn y_label( &mut self, text: &str )
No public source comment is attached to this declaration.
pub fn config( &self ) -> &FigureConfig
No public source comment is attached to this declaration.
pub fn rows( &self ) -> i32
No public source comment is attached to this declaration.
pub fn cols( &self ) -> i32
No public source comment is attached to this declaration.
pub fn cell_rect( &self, row: i32, col: i32, w: u32, h: u32 ) -> CellRect
No public source comment is attached to this declaration.
pub fn save_to(&self, engine: &Engine, path: &str) -> Result<()>
No public source comment is attached to this declaration.
pub fn render( &self, engine: &Engine ) -> Result<Image>
No public source comment is attached to this declaration.
pub fn show(&self, engine: &Engine) -> Result<()>
No public source comment is attached to this declaration.
pub fn render_frame(&self, w: u32, h: u32, ui: &mut Ui<'_>) -> Result<()>
No public source comment is attached to this declaration.
pub fn new( config: FigureConfig ) -> Self
No public source comment is attached to this declaration.
pub fn default_config() -> Self
No public source comment is attached to this declaration.