Skip to content

Variable: tableAttributes ​

ts
const tableAttributes: ObjectNode<{
  cells: ObjectNode<{
    align: Attr<
      'left' | 'center' | 'right' | readonly ('left' | 'center' | 'right')[],
      {
        arrayOk: true;
        description: 'Horizontal alignment of the text in its cell, one per column or, nested, per column and row.';
        dflt: 'center';
        editType: 'plot';
        values: readonly ['left', 'center', 'right'];
      }
    >;
    fill: ObjectNode<{
      color: Attr<
        string | readonly string[],
        {
          arrayOk: true;
          description: 'Cell background color, one per column or, nested, per column and row (e.g. alternating row colors).';
          dflt: 'white';
          editType: 'style';
        }
      >;
    }>;
    font: ObjectNode<{
      color: Attr<
        string | readonly string[],
        {
          arrayOk: true;
          description: 'Text color, or one per column (nested arrays: per row).';
          editType: 'style';
        }
      >;
      family: Attr<
        string | readonly string[],
        {
          arrayOk: true;
          description: 'CSS font-family list, or one per column (nested arrays: per row).';
          editType: 'plot';
          noBlank: true;
          strict: true;
        }
      >;
      size: Attr<
        number | TypedArray | readonly number[],
        {
          arrayOk: true;
          description: 'Font size in CSS px, or one per column (nested arrays: per row).';
          editType: 'plot';
          min: 1;
        }
      >;
      style: Attr<
        'normal' | 'italic' | readonly ('normal' | 'italic')[],
        {
          arrayOk: true;
          description: 'Font style, or one per column (nested arrays: per row).';
          editType: 'plot';
          values: readonly ['normal', 'italic'];
        }
      >;
      weight: Attr<
        number | TypedArray | readonly number[] | 'normal' | 'bold',
        {
          arrayOk: true;
          description: 'Font weight: a CSS numeric weight (1–1000), `normal` or `bold`, or one per column.';
          editType: 'plot';
          extras: readonly ['normal', 'bold'];
          max: 1000;
          min: 1;
        }
      >;
    }>;
    format: AttrSpec<DataArray, DataArray | undefined>;
    height: Attr<
      number,
      {
        description:
          | "Height of the header rows in px. Rows grow to fit text that has spaces, line breaks or markup: its height plus 8 px of padding above and below (Plotly's `cellPad`)."
          | "Height of the rows in px. Rows grow to fit text that has spaces, line breaks or markup: its height plus 8 px of padding above and below (Plotly's `cellPad`).";
        dflt: number;
        editType: 'plot';
      }
    >;
    line: ObjectNode<{
      color: Attr<
        string | readonly string[],
        {
          arrayOk: true;
          description: 'Color of the cell outlines, one per column or, nested, per column and row.';
          dflt: 'grey';
          editType: 'style';
        }
      >;
      width: Attr<
        number | TypedArray | readonly number[],
        {
          arrayOk: true;
          description: 'Width of the cell outlines in px (centered on the cell edges), one per column or, nested, per column and row.';
          dflt: 1;
          editType: 'plot';
        }
      >;
    }>;
    prefix: Attr<
      string | readonly string[],
      {
        arrayOk: true;
        description: 'Text before each value, one per column or, nested, per column and row.';
        editType: 'calc';
      }
    >;
    suffix: Attr<
      string | readonly string[],
      {
        arrayOk: true;
        description: 'Text after each value, one per column or, nested, per column and row.';
        editType: 'calc';
      }
    >;
    values: AttrSpec<DataArray, DataArray | undefined>;
  }>;
  columnorder: AttrSpec<DataArray, DataArray | undefined>;
  columnwidth: Attr<
    number | TypedArray | readonly number[],
    {
      arrayOk: true;
      description: 'Relative column widths: columns share the domain width in proportion to these values (one for all, or one per column; a short array repeats its last entry, non-numeric entries count 1).';
      editType: 'plot';
    }
  >;
  header: ObjectNode<{
    align: Attr<
      'left' | 'center' | 'right' | readonly ('left' | 'center' | 'right')[],
      {
        arrayOk: true;
        description: 'Horizontal alignment of the text in its cell, one per column or, nested, per column and row.';
        dflt: 'center';
        editType: 'plot';
        values: readonly ['left', 'center', 'right'];
      }
    >;
    fill: ObjectNode<{
      color: Attr<
        string | readonly string[],
        {
          arrayOk: true;
          description: 'Cell background color, one per column or, nested, per column and row (e.g. alternating row colors).';
          dflt: 'white';
          editType: 'style';
        }
      >;
    }>;
    font: ObjectNode<{
      color: Attr<
        string | readonly string[],
        {
          arrayOk: true;
          description: 'Text color, or one per column (nested arrays: per row).';
          editType: 'style';
        }
      >;
      family: Attr<
        string | readonly string[],
        {
          arrayOk: true;
          description: 'CSS font-family list, or one per column (nested arrays: per row).';
          editType: 'plot';
          noBlank: true;
          strict: true;
        }
      >;
      size: Attr<
        number | TypedArray | readonly number[],
        {
          arrayOk: true;
          description: 'Font size in CSS px, or one per column (nested arrays: per row).';
          editType: 'plot';
          min: 1;
        }
      >;
      style: Attr<
        'normal' | 'italic' | readonly ('normal' | 'italic')[],
        {
          arrayOk: true;
          description: 'Font style, or one per column (nested arrays: per row).';
          editType: 'plot';
          values: readonly ['normal', 'italic'];
        }
      >;
      weight: Attr<
        number | TypedArray | readonly number[] | 'normal' | 'bold',
        {
          arrayOk: true;
          description: 'Font weight: a CSS numeric weight (1–1000), `normal` or `bold`, or one per column.';
          editType: 'plot';
          extras: readonly ['normal', 'bold'];
          max: 1000;
          min: 1;
        }
      >;
    }>;
    format: AttrSpec<DataArray, DataArray | undefined>;
    height: Attr<
      number,
      {
        description:
          | "Height of the header rows in px. Rows grow to fit text that has spaces, line breaks or markup: its height plus 8 px of padding above and below (Plotly's `cellPad`)."
          | "Height of the rows in px. Rows grow to fit text that has spaces, line breaks or markup: its height plus 8 px of padding above and below (Plotly's `cellPad`).";
        dflt: number;
        editType: 'plot';
      }
    >;
    line: ObjectNode<{
      color: Attr<
        string | readonly string[],
        {
          arrayOk: true;
          description: 'Color of the cell outlines, one per column or, nested, per column and row.';
          dflt: 'grey';
          editType: 'style';
        }
      >;
      width: Attr<
        number | TypedArray | readonly number[],
        {
          arrayOk: true;
          description: 'Width of the cell outlines in px (centered on the cell edges), one per column or, nested, per column and row.';
          dflt: 1;
          editType: 'plot';
        }
      >;
    }>;
    prefix: Attr<
      string | readonly string[],
      {
        arrayOk: true;
        description: 'Text before each value, one per column or, nested, per column and row.';
        editType: 'calc';
      }
    >;
    suffix: Attr<
      string | readonly string[],
      {
        arrayOk: true;
        description: 'Text after each value, one per column or, nested, per column and row.';
        editType: 'calc';
      }
    >;
    values: AttrSpec<DataArray, DataArray | undefined>;
  }>;
}>;

Experimental

The table schema.

Released under the MIT License.