Skip to main content

Annotation

ggplot_rs::annotate

Enum Annotation 

Source 
pub enum Annotation {
    Text {
        label: String,
        x: f64,
        y: f64,
        size: f64,
        color: (u8, u8, u8),
    },
    Rect {
        xmin: f64,
        xmax: f64,
        ymin: f64,
        ymax: f64,
        fill: (u8, u8, u8),
        alpha: f64,
    },
    Segment {
        x: f64,
        y: f64,
        xend: f64,
        yend: f64,
        color: (u8, u8, u8),
        width: f64,
    },
    LogTicks {
        sides: String,
        outside: bool,
        lengths: (f64, f64, f64),
        color: (u8, u8, u8),
        width: f64,
    },
    Raster {
        image: Arc<Vec<u8>>,
        xmin: f64,
        xmax: f64,
        ymin: f64,
        ymax: f64,
        alpha: f64,
    },
    Inset {
        plot: InsetPlot,
        xmin: f64,
        xmax: f64,
        ymin: f64,
        ymax: f64,
    },
}
Expand description

Annotation types for adding static marks to a plot.

Variants§

§

Text

Text annotation at a data position.

Fields

§label: String
§x: f64
§y: f64
§size: f64
§color: (u8, u8, u8)
§

Rect

Rectangle annotation between two data positions.

Fields

§xmin: f64
§xmax: f64
§ymin: f64
§ymax: f64
§fill: (u8, u8, u8)
§alpha: f64
§

Segment

Line segment annotation between two data positions.

Fields

§x: f64
§y: f64
§xend: f64
§yend: f64
§color: (u8, u8, u8)
§width: f64
§

LogTicks

Log-10 tick marks on panel edges (ggplot2’s annotation_logticks): long ticks at each power of ten, mid at 5×, short at 2–4× and 6–9×. Positions are read in the axis’ (log10-)transformed units, so it suits scale_x_log10() / scale_y_log10() or data already in log10.

Fields

§sides: String

Panel sides to draw on: any of b, l, t, r.

§outside: bool

Draw outward from the panel instead of inward.

§lengths: (f64, f64, f64)

Tick lengths in px (short, mid, long).

§color: (u8, u8, u8)
§width: f64
§

Raster

An encoded image (PNG or JPEG bytes) stretched over a data rectangle (ggplot2’s annotation_raster). ±INFINITY bounds mean the panel edge.

Fields

§image: Arc<Vec<u8>>
§xmin: f64
§xmax: f64
§ymin: f64
§ymax: f64
§alpha: f64
§

Inset

A whole plot drawn into a data rectangle (ggplot2’s annotation_custom with a ggplot grob — an inset). ±INFINITY bounds mean the panel edge.

Fields

§plot: InsetPlot
§xmin: f64
§xmax: f64
§ymin: f64
§ymax: f64

Implementations§

Source§

impl Annotation

Source

pub fn text(label: &str, x: f64, y: f64) -> Self

Create a text annotation.

Source

pub fn rect(xmin: f64, xmax: f64, ymin: f64, ymax: f64) -> Self

Create a rectangle annotation.

Source

pub fn logticks(sides: &str) -> Self

Log-10 tick marks on sides ("bl" by default in ggplot2).

Source

pub fn outside(self) -> Self

outside = TRUE for Annotation::LogTicks (no-op otherwise).

Source

pub fn raster( image: Vec<u8>, xmin: f64, xmax: f64, ymin: f64, ymax: f64, ) -> Self

An encoded PNG / JPEG image over the data rectangle.

Source

pub fn inset(plot: GGPlot, xmin: f64, xmax: f64, ymin: f64, ymax: f64) -> Self

plot drawn as an inset into the data rectangle.

Source

pub fn segment(x: f64, y: f64, xend: f64, yend: f64) -> Self

Create a segment annotation.

Trait Implementations§

Source§

impl Clone for Annotation

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Annotation

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V