Struct Colorbar

pub struct Colorbar {
    pub opts: Vec<Opt>,
}

Add a colorbar to the figure.

This command relies on the local variable im being defined and set equal to the output of a plotting command to which a color map can be applied (e.g. Imshow). The output of this command is stored in a local variable cbar.

cbar = fig.colorbar(im, ax=ax, **{opts})

Prelude: No

JSON data: None

Fields

opts: Vec<Opt>

Optional keyword arguments.

Implementations

impl Colorbar

pub fn new() -> Self

Create a new Colorbar with no options.

Trait Implementations

impl Clone for Colorbar

fn clone(&self) -> Colorbar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Colorbar

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

Formats the value using the given formatter.

impl Default for Colorbar

fn default() -> Self

Returns the “default value” for a type.

impl Matplotlib for Colorbar

fn is_prelude(&self) -> bool

Return true if self should be considered as a prelude item, which are execute in the order seen but before any non-prelude items.

fn data(&self) -> Option<Value>

Optionally encode some data as JSON, to be made available at self’s call site in the matplotlib script.

fn py_cmd(&self) -> String

Write self as Python. The (default) local environment will hold the following variables:

impl MatplotlibOpts for Colorbar

fn kwarg<T: Into<PyValue>>(&mut self, key: &str, val: T) -> &mut Self

Apply a single keyword argument.

fn o<T: Into<PyValue>>(self, key: &str, val: T) -> Self

where Self: Sized,

Apply a single keyword argument with full ownership of self.

fn oo<I>(self, opts: I) -> Self

where I: IntoIterator<Item = Opt>, Self: Sized,

Apply a series of keyword arguments with full ownership of self.

impl PartialEq for Colorbar

fn eq(&self, other: &Colorbar) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Colorbar