Interface IOptions

An options object for initializing a text renderer.

interface IOptions {
    backgroundColor?: CellRenderer.ConfigOption<string>;
    elideDirection?: CellRenderer.ConfigOption<TextRenderer.ElideDirection>;
    font?: CellRenderer.ConfigOption<string>;
    format?: FormatFunc;
    horizontalAlignment?: CellRenderer.ConfigOption<TextRenderer.HorizontalAlignment>;
    horizontalPadding?: number;
    textColor?: CellRenderer.ConfigOption<string>;
    verticalAlignment?: CellRenderer.ConfigOption<TextRenderer.VerticalAlignment>;
    wrapText?: CellRenderer.ConfigOption<boolean>;
}

Hierarchy (view full)

Properties

backgroundColor? elideDirection? font? format? horizontalAlignment? horizontalPadding? textColor? verticalAlignment? wrapText?

Properties

Optional backgroundColor

backgroundColor?: CellRenderer.ConfigOption<string>

The background color for the cells.

The default is ''.

Optional elideDirection

elideDirection?: CellRenderer.ConfigOption<TextRenderer.ElideDirection>

The ellipsis direction for the cell text.

The default is 'none'.

Optional font

font?: CellRenderer.ConfigOption<string>

The font for drawing the cell text.

The default is '12px sans-serif'.

Optional format

format?: FormatFunc

The format function for the renderer.

The default is TextRenderer.formatGeneric().

Optional horizontalAlignment

horizontalAlignment?: CellRenderer.ConfigOption<TextRenderer.HorizontalAlignment>

The horizontal alignment for the cell text.

The default is 'left'.

Optional horizontalPadding

horizontalPadding?: number

The horizontal padding for the cell text in pixels.

The default is 8.

Optional textColor

textColor?: CellRenderer.ConfigOption<string>

The color for the drawing the cell text.

The default '#000000'.

Optional verticalAlignment

verticalAlignment?: CellRenderer.ConfigOption<TextRenderer.VerticalAlignment>

The vertical alignment for the cell text.

The default is 'center'.

Optional wrapText

wrapText?: CellRenderer.ConfigOption<boolean>

Whether or not to apply text wrapping.

The default is 'false'.

Settings

Member Visibility

Theme

On This Page

backgroundColorelideDirectionfontformathorizontalAlignmenthorizontalPaddingtextColorverticalAlignmentwrapText