Skip to main content

ColumnMeta

yew_datatable::prelude

Struct ColumnMeta

pub struct ColumnMeta {Show 13 fields
    pub id: ColumnId,
    pub header: String,
    pub footer: Option<String>,
    pub sortable: bool,
    pub filterable: bool,
    pub resizable: bool,
    pub visible: bool,
    pub min_width: Option<f64>,
    pub max_width: Option<f64>,
    pub default_width: Option<f64>,
    pub is_group: bool,
    pub parent_id: Option<ColumnId>,
    pub filter_placeholder: Option<String>,
}

Expand description

Metadata for a column that affects its behavior.

Controls column display properties, interaction capabilities, and sizing constraints.

Fields§

§id: ColumnId

The column ID.

§header: String

Display header text.

§footer: Option<String>

Footer text.

§sortable: bool

Whether the column is sortable.

§filterable: bool

Whether the column is filterable.

§resizable: bool

Whether the column is resizable.

§visible: bool

Whether the column is visible by default.

§min_width: Option<f64>

Minimum column width in pixels.

§max_width: Option<f64>

Maximum column width in pixels.

§default_width: Option<f64>

Default column width in pixels.

§is_group: bool

Whether this is a group column (contains sub-columns).

§parent_id: Option<ColumnId>

Parent column ID for nested columns.

§filter_placeholder: Option<String>

Placeholder text for column filter input.

Implementations§

impl ColumnMeta

pub fn new(id: impl Into<ColumnId>, header: impl Into<String>) -> ColumnMeta

Creates new column metadata with the given ID and header.

§Parameters

id: The column identifier.
header: The display header text.

§Returns

ColumnMeta: A new column metadata with default settings.

pub fn with_footer(self, footer: impl Into<String>) -> ColumnMeta

Sets the footer text.

§Parameters

footer: The footer text to display.

§Returns

Self: The modified column metadata.

pub fn with_sortable(self, sortable: bool) -> ColumnMeta

Sets whether the column is sortable.

§Parameters

sortable: Whether sorting is enabled.

§Returns

Self: The modified column metadata.

pub fn with_filterable(self, filterable: bool) -> ColumnMeta

Sets whether the column is filterable.

§Parameters

filterable: Whether filtering is enabled.

§Returns

Self: The modified column metadata.

pub fn with_resizable(self, resizable: bool) -> ColumnMeta

Sets whether the column is resizable.

§Parameters

resizable: Whether resizing is enabled.

§Returns

Self: The modified column metadata.

pub fn with_visible(self, visible: bool) -> ColumnMeta

Sets whether the column is visible by default.

§Parameters

visible: Whether the column is visible.

§Returns

Self: The modified column metadata.

pub fn with_min_width(self, width: f64) -> ColumnMeta

Sets the minimum column width.

§Parameters

width: The minimum width in pixels.

§Returns

Self: The modified column metadata.

pub fn with_max_width(self, width: f64) -> ColumnMeta

Sets the maximum column width.

§Parameters

width: The maximum width in pixels.

§Returns

Self: The modified column metadata.

pub fn with_default_width(self, width: f64) -> ColumnMeta

Sets the default column width.

§Parameters

width: The default width in pixels.

§Returns

Self: The modified column metadata.

pub fn with_filter_placeholder( self, placeholder: impl Into<String>, ) -> ColumnMeta

Sets the filter placeholder text.

§Parameters

placeholder: The placeholder text for the filter input.

§Returns

Self: The modified column metadata.

pub fn as_group(self) -> ColumnMeta

Marks this column as a group column.

Group columns contain sub-columns and are not sortable or filterable.

§Returns

Self: The modified column metadata.

pub fn with_parent(self, parent_id: impl Into<ColumnId>) -> ColumnMeta

Sets the parent column ID.

§Parameters

parent_id: The parent column identifier.

§Returns

Self: The modified column metadata.

Trait Implementations§

impl Clone for ColumnMeta

fn clone(&self) -> ColumnMeta

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

impl Debug for ColumnMeta

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

Formats the value using the given formatter. Read more

impl Default for ColumnMeta

Provides a default column metadata with empty ID and header.

fn default() -> ColumnMeta

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl Freeze for ColumnMeta

impl RefUnwindSafe for ColumnMeta

impl Send for ColumnMeta

impl Sync for ColumnMeta

impl Unpin for ColumnMeta

impl UnsafeUnpin for ColumnMeta

impl UnwindSafe for ColumnMeta

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

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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> IntoPropValue<Option<T>> for T

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.

impl<T> IntoPropValue<T> for T

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.

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.

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<Token, Builder, How> AllPropsFor<Builder, How> for Token
where Builder: Buildable<Token>, <Builder as Buildable<Token>>::WrappedToken: HasAllProps<<Builder as Buildable<Token>>::Output, How>,

impl<T> HasAllProps<(), T> for T