Skip to main content

ColumnVisibilityState

yew_datatable::prelude

Struct ColumnVisibilityState 

Source 
pub struct ColumnVisibilityState { /* private fields */ }
Expand description

Complete column visibility state for the table.

Tracks per-column visibility overrides with a configurable default visibility for columns not explicitly set.

Implementations§

Source§

impl ColumnVisibilityState

Source

pub fn new() -> ColumnVisibilityState

Creates a new visibility state with all columns visible.

§Returns
  • ColumnVisibilityState: A new state with default visible set to true.
Source

pub fn with_hidden( hidden: impl IntoIterator<Item = ColumnId>, ) -> ColumnVisibilityState

Creates a visibility state with specific hidden columns.

§Parameters
  • hidden: The column identifiers to hide.
§Returns
  • ColumnVisibilityState: A new state with the specified columns hidden.
Source

pub fn with_visible( visible: impl IntoIterator<Item = ColumnId>, ) -> ColumnVisibilityState

Creates a visibility state with specific visible columns (all others hidden).

§Parameters
  • visible: The column identifiers to show.
§Returns
  • ColumnVisibilityState: A new state with only the specified columns visible.
Source

pub fn with_default_visible(self, visible: bool) -> ColumnVisibilityState

Sets the default visibility for columns not explicitly set.

§Parameters
  • visible: The default visibility state.
§Returns
  • Self: The modified visibility state.
Source

pub fn is_visible(&self, column_id: &ColumnId) -> bool

Returns whether a column is visible.

§Parameters
  • column_id: The column identifier to check.
§Returns
  • bool: Whether the column is visible.
Source

pub fn visibility_map(&self) -> &HashMap<ColumnId, bool>

Returns the visibility map.

§Returns
  • &HashMap<ColumnId, bool>: A reference to the visibility override map.
Source

pub fn visible_columns<'a>(&self, columns: &'a [ColumnId]) -> Vec<&'a ColumnId>

Returns the list of visible column IDs from a given list.

§Parameters
  • columns: The column identifiers to filter.
§Returns
  • Vec<&ColumnId>: References to visible column IDs.
Source

pub fn hidden_columns<'a>(&self, columns: &'a [ColumnId]) -> Vec<&'a ColumnId>

Returns the list of hidden column IDs from a given list.

§Parameters
  • columns: The column identifiers to filter.
§Returns
  • Vec<&ColumnId>: References to hidden column IDs.
Source

pub fn set_visibility(&mut self, column_id: ColumnId, visible: bool)

Sets the visibility of a column.

§Parameters
  • column_id: The column identifier.
  • visible: Whether the column should be visible.
Source

pub fn show(&mut self, column_id: ColumnId)

Shows a column.

§Parameters
  • column_id: The column identifier to show.
Source

pub fn hide(&mut self, column_id: ColumnId)

Hides a column.

§Parameters
  • column_id: The column identifier to hide.
Source

pub fn toggle(&mut self, column_id: ColumnId)

Toggles the visibility of a column.

§Parameters
  • column_id: The column identifier to toggle.
Source

pub fn show_many(&mut self, column_ids: impl IntoIterator<Item = ColumnId>)

Shows multiple columns.

§Parameters
  • column_ids: The column identifiers to show.
Source

pub fn hide_many(&mut self, column_ids: impl IntoIterator<Item = ColumnId>)

Hides multiple columns.

§Parameters
  • column_ids: The column identifiers to hide.
Source

pub fn show_all(&mut self)

Shows all columns.

Source

pub fn hide_all(&mut self)

Hides all columns.

Source

pub fn reset_column(&mut self, column_id: &ColumnId)

Resets the visibility for a specific column.

§Parameters
  • column_id: The column identifier to reset.
Source

pub fn reset(&mut self)

Resets to initial state.

Trait Implementations§

Source§

impl Clone for ColumnVisibilityState

Source§

fn clone(&self) -> ColumnVisibilityState

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 Debug for ColumnVisibilityState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ColumnVisibilityState

Provides default visibility state with all columns visible.

Source§

fn default() -> ColumnVisibilityState

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

impl PartialEq for ColumnVisibilityState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for ColumnVisibilityState

Source§

impl StructuralPartialEq for ColumnVisibilityState

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoPropValue<Option<T>> for T

Source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
Source§

impl<T> IntoPropValue<T> for T

Source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

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
Source§

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
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<Token, Builder, How> AllPropsFor<Builder, How> for Token
where Builder: Buildable<Token>, <Builder as Buildable<Token>>::WrappedToken: HasAllProps<<Builder as Buildable<Token>>::Output, How>,

Source§

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