Struct DataTable 

pub struct DataTable {

    pub header_bg: Color,
    pub header_fg: Color,
    pub row_numbers_fg: Color,
    pub separator_fg: Color,
    pub table_cell_padding: u16,
    pub alternate_row_bg: Option<Color>,
    pub column_colors: bool,
    pub str_col: Option<Color>,
    pub int_col: Option<Color>,
    pub float_col: Option<Color>,
    pub bool_col: Option<Color>,
    pub temporal_col: Option<Color>,
    pub binary_col: Option<Color>,
    pub binary_cols: HashSet<String>,
    pub number_format: NumberFormatSettings,
    pub dtype_row: bool,
    pub selected_bg: Option<Color>,
    pub selection_style: Style,
    pub accent: Color,
    pub dimmed: Color,
    pub drift_rows: Vec<u32>,
    pub drift_groups: Arc<Vec<DriftGroup>>,
    pub sort_columns: Vec<String>,
    pub sort_descending: Vec<bool>,
    pub current_column: Option<String>,
    pub column_cursor_style: Style,
    pub cell_cursor_style: Style,
    pub glyphs: &'static Glyphs,
    pub screen_width: u16,
    pub find_cell: Option<(usize, String)>,
    pub find_style: Style,
    pub match_cells: Option<Arc<MatchCells>>,
    /* private fields */
}

Fields

header_bg: Color

header_fg: Color

row_numbers_fg: Color

separator_fg: Color

table_cell_padding: u16

alternate_row_bg: Option<Color>

column_colors: bool

When true, colorize cells by column type using the optional colors below.

str_col: Option<Color>

int_col: Option<Color>

float_col: Option<Color>

bool_col: Option<Color>

temporal_col: Option<Color>

binary_col: Option<Color>

Color for binary-column placeholder cells (the ‹binary› stub). Applied with italic, independent of column_colors, so stubs always read as “placeholder, not data”.

binary_cols: HashSet<String>

Names of columns that are binary in the source schema. Their cells hold the ‹binary› stub (see binary_stub) and are styled with binary_col + italic.

number_format: NumberFormatSettings

Display-time number formatting (digit grouping, separators, alignment).

dtype_row: bool

Draw a second header row naming each column’s type.

selected_bg: Option<Color>

Tint under the row the cursor is on. None falls back to reversed video.

selection_style: Style

The full selected-row style, from the theme’s highlight_style helper.

accent: Color

The rail beside the selected row and the off-screen column hints.

dimmed: Color

Null cells and the type row.

drift_rows: Vec<u32>

Per row on screen, its file’s drift group. Empty when the dataset’s files agree, or when the rows no longer stand for rows of a file.

drift_groups: Arc<Vec<DriftGroup>>

What each drift group is missing. Indexed by the values in drift_rows.

sort_columns: Vec<String>

Columns the view is sorted by; each carries a direction mark in the header. Filled from the state at render, so the marks always describe the frame drawn.

sort_descending: Vec<bool>

Which way each of them runs, per column, as it is applied.

current_column: Option<String>

The column cursor’s column: its header and cells are tinted.

column_cursor_style: Style

The column cursor’s cells, from the theme’s column_cursor_style helper.

cell_cursor_style: Style

The column cursor’s header and the current cell, from the theme’s cell_cursor_style helper.

glyphs: &'static Glyphs

The glyph set the table draws with: the terminal’s, unless a test asks for one.

screen_width: u16

The terminal’s width, which bounds automatic text widths (see crate::widgets::column_widths::text_cap). 0 takes the table’s own width.

find_cell: Option<(usize, String)>

The cell a find landed on: its view row and column.

find_style: Style

How that cell is drawn, from the theme’s find_match_style.

match_cells: Option<Arc<MatchCells>>

The cells a find being typed matches, by view row and column, drawn as found.

Implementations

impl DataTable

pub fn new() -> Self

pub fn with_colors( self, header_bg: Color, header_fg: Color, row_numbers_fg: Color, separator_fg: Color, ) -> Self

pub fn with_cell_padding(self, padding: u16) -> Self

pub fn with_screen_width(self, width: u16) -> Self

The terminal’s width, so automatic widths do not change when a sidebar opens.

pub fn with_alternate_row_bg(self, color: Option<Color>) -> Self

pub fn with_column_type_colors( self, str_col: Color, int_col: Color, float_col: Color, bool_col: Color, temporal_col: Color, ) -> Self

Enable column-type coloring and set colors for string, int, float, bool, and temporal columns.

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

Set the color used for binary-column placeholder cells.

pub fn with_binary_columns(self, names: HashSet<String>) -> Self

Set the names of binary columns, whose cells render the ‹binary› stub.

pub fn with_number_format(self, settings: NumberFormatSettings) -> Self

Set display-time number formatting (digit grouping and alignment).

pub fn with_dtype_row(self, on: bool) -> Self

Show or hide the second header row of column types.

pub fn with_drift(self, rows: Vec<u32>, groups: Arc<Vec<DriftGroup>>) -> Self

Tell the table which rows came from files missing which columns, so a cell the file never had draws differently from a null the data holds.

pub fn with_selection_colors( self, selection_style: Style, selected_bg: Option<Color>, accent: Color, dimmed: Color, ) -> Self

The selected row’s style and tint, rail color, and dim null color, from the theme’s highlight_style; no fallbacks of its own.

pub fn with_match_cells(self, cells: Option<Arc<MatchCells>>) -> Self

Draw these cells (view row, column) as found: a find’s matches as it is typed.

pub fn with_find_cell(self, cell: Option<(usize, String)>, style: Style) -> Self

Mark the cell a find landed on, drawn in style while the cursor is on it.

pub fn with_cursor_styles(self, column: Style, cell: Style) -> Self

The column cursor’s styles, from the theme’s helpers: its cells, and its header and the current cell.

pub fn header_height(&self) -> u16

How many rows the header takes: the names, plus the type row when it is on.

Trait Implementations

impl Default for DataTable

fn default() -> Self

Returns the “default value” for a type.

impl StatefulWidget for DataTable

type State = DataTableState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.