Skip to main content

Annotation

plotkit_core::annotations

Struct Annotation

pub struct Annotation {
    pub text: String,
    pub xy: (f64, f64),
    pub xytext: (f64, f64),
    pub fontsize: Option<f64>,
    pub color: Option<Color>,
    pub ha: HAlign,
    pub va: VAlign,
    pub arrowstyle: ArrowStyle,
    pub arrow_color: Option<Color>,
}

Expand description

An annotation with optional arrow from a text position to a data point.

Created by [Axes::annotate]. The text is drawn at xytext and, when an arrow style other than ArrowStyle::None is set, an arrow is drawn from xytext to xy.

Fields§

§text: String

The annotation text string.

§xy: (f64, f64)

The data-space point being annotated.

§xytext: (f64, f64)

The data-space position where the text is placed.

§fontsize: Option<f64>

Optional font size override (in points). None uses the theme default.

§color: Option<Color>

Optional text color override. None uses the theme text color.

§ha: HAlign

Horizontal alignment of the text relative to xytext.

§va: VAlign

Vertical alignment of the text relative to xytext.

§arrowstyle: ArrowStyle

The style of arrow drawn from xytext to xy.

§arrow_color: Option<Color>

Optional arrow color override. None uses the text color.

Implementations§

impl Annotation

pub fn fontsize(&mut self, size: f64) -> &mut Self

Sets the font size (in points).

pub fn color(&mut self, color: Color) -> &mut Self

Sets the text color.

pub fn ha(&mut self, ha: HAlign) -> &mut Self

Sets the horizontal alignment.

pub fn va(&mut self, va: VAlign) -> &mut Self

Sets the vertical alignment.

pub fn arrowstyle(&mut self, style: ArrowStyle) -> &mut Self

Sets the arrow style.

pub fn arrow_color(&mut self, color: Color) -> &mut Self

Sets the arrow color.

Trait Implementations§

impl Clone for Annotation

fn clone(&self) -> Annotation

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

impl Debug for Annotation

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for Annotation

impl RefUnwindSafe for Annotation

impl Send for Annotation

impl Sync for Annotation

impl Unpin for Annotation

impl UnsafeUnpin for Annotation

impl UnwindSafe for Annotation

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.