Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions

An options object for initializing a text renderer. An options object for initializing a text renderer.

Hierarchy

Index

Properties

Optional backgroundColor

backgroundColor: ConfigOption<string>

The background color for the cells.

The default is ''.

Optional elideDirection

elideDirection: ConfigOption<ElideDirection>

The ellipsis direction for the cell text.

The default is 'right'.

Optional font

font: 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: ConfigOption<HorizontalAlignment>

The horizontal alignment for the cell text.

The default is 'left'.

Optional textColor

textColor: ConfigOption<string>

The color for the drawing the cell text.

The default '#000000'.

Optional url

url: ConfigOption<string> | undefined

The URL address

Optional urlName

urlName: ConfigOption<string> | undefined

The friendly link name.

The default is the URL itself.

Optional verticalAlignment

verticalAlignment: ConfigOption<VerticalAlignment>

The vertical alignment for the cell text.

The default is 'center'.

Optional wrapText

wrapText: ConfigOption<boolean>

Whether or not to apply text wrapping.

The default is 'false'.

Generated using TypeDoc