Skip to main content

Text

Struct Text 

Source
pub struct Text {
    pub content: String,
    pub font: String,
    pub size: usize,
    pub color: Rgb,
    pub x: f64,
    pub y: f64,
}
Expand description

A structure representing text with customizable content, font, size, and color.

§Example

use polars::prelude::*;
use plotlars::{Axis, BarPlot, Plot, Text, Rgb};

let dataset = df![
        "label" => &[""],
        "value" => &[0],
    ]
    .unwrap();

let axis = Axis::new()
    .tick_values(vec![]);

BarPlot::builder()
    .data(&dataset)
    .labels("label")
    .values("value")
    .plot_title(
        Text::from("Title")
            .x(0.1)
            .color(Rgb(178, 34, 34))
            .size(30)
            .font("Zapfino")
    )
    .x_title(
        Text::from("X")
            .color(Rgb(65, 105, 225))
            .size(20)
            .font("Marker Felt")
    )
    .y_title(
        Text::from("Y")
            .color(Rgb(255, 140, 0))
            .size(20)
            .font("Arial Black")
    )
    .x_axis(&axis)
    .y_axis(&axis)
    .build()
    .plot();

Example

Fields§

§content: String§font: String§size: usize§color: Rgb§x: f64§y: f64

Implementations§

Source§

impl Text

Source

pub fn from(content: impl Into<String>) -> Self

Creates a new Text instance from the given content.

§Argument
  • content - A value that can be converted into a String, representing the textual content.
Source

pub fn font(self, font: impl Into<String>) -> Self

Sets the font of the text.

§Argument
  • font - A value that can be converted into a String, representing the font name.
Source

pub fn size(self, size: usize) -> Self

Sets the size of the text.

§Argument
  • size - A usize value specifying the font size.
Source

pub fn color(self, color: Rgb) -> Self

Sets the color of the text.

§Argument
  • color - An Rgb value specifying the color of the text.
Source

pub fn x(self, x: f64) -> Self

Sets the x-coordinate position of the text.

§Argument
  • x - A f64 value specifying the horizontal position.
Source

pub fn y(self, y: f64) -> Self

Sets the y-coordinate position of the text.

§Argument
  • y - A f64 value specifying the vertical position.
Source

pub fn has_custom_position(&self) -> bool

Source

pub fn with_plot_title_defaults(self) -> Self

Apply default positioning for plot titles (x=0.5, y=0.95 - centered above)

Source

pub fn with_subplot_title_defaults(self) -> Self

Apply default positioning for subplot titles (x=0.5, y=1.1 - centered above, higher than overall)

Source

pub fn with_x_title_defaults(self) -> Self

Apply default positioning for x-axis titles (x=0.5, y=-0.15 - centered below)

Source

pub fn with_y_title_defaults(self) -> Self

Apply default positioning for y-axis titles (x=-0.08, y=0.5 - left side, vertically centered)

Source

pub fn with_x_title_defaults_for_annotation(self) -> Self

Apply default positioning for x-axis title annotations Used when user sets custom position and annotation mode is triggered Ensures unset coordinates get appropriate axis defaults

Source

pub fn with_y_title_defaults_for_annotation(self) -> Self

Apply default positioning for y-axis title annotations Used when user sets custom position and annotation mode is triggered Ensures unset coordinates get appropriate axis defaults

Trait Implementations§

Source§

impl Clone for Text

Source§

fn clone(&self) -> Text

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Text

Source§

fn default() -> Self

Provides default values for the Text struct.

  • content: An empty string.
  • font: An empty string.
  • size: 12 (reasonable default for visibility).
  • color: Default Rgb value.
  • x: 0.5.
  • y: 0.9.
Source§

impl From<&String> for Text

Source§

fn from(content: &String) -> Self

Converts to this type from the input type.
Source§

impl From<&str> for Text

Source§

fn from(content: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Text

Source§

fn from(content: String) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Text

§

impl RefUnwindSafe for Text

§

impl Send for Text

§

impl Sync for Text

§

impl Unpin for Text

§

impl UnsafeUnpin for Text

§

impl UnwindSafe for Text

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Key for T
where T: Clone,

Source§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
Source§

fn size(&self) -> usize

The size of the key in bytes.
Source§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
Source§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
Source§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
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 = Infallible

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

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

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> PlanCallbackArgs for T

Source§

impl<T> PlanCallbackOut for T