Class HyperlinkRenderer

A cell renderer which renders data values as text.

Hierarchy

TextRenderer
- HyperlinkRenderer

Index

Constructors

constructor

new HyperlinkRenderer(options?: HyperlinkRenderer.IOptions): HyperlinkRenderer
Construct a new text renderer.
Parameters
- options: HyperlinkRenderer.IOptions = {}
  
  The options for initializing the renderer.
Returns HyperlinkRenderer
Overrides TextRenderer.constructor
- Defined in packages/datagrid/src/hyperlinkrenderer.ts:25

Properties

`Readonly` backgroundColor

backgroundColor: CellRenderer.ConfigOption<string>

The CSS color for the cell background.

`Readonly` elideDirection

elideDirection: CellRenderer.ConfigOption<TextRenderer.ElideDirection>

Which side to draw the ellipsis. Set to 'none' to disable ellipsis.

`Readonly` font

font: CellRenderer.ConfigOption<string>

The CSS shorthand font for drawing the text.

`Readonly` format

format: FormatFunc

The format function for the cell value.

`Readonly` horizontalAlignment

horizontalAlignment: CellRenderer.ConfigOption<TextRenderer.HorizontalAlignment>

The horizontal alignment for the cell text.

`Readonly` textColor

textColor: CellRenderer.ConfigOption<string>

The CSS color for drawing the text.

`Readonly` url

url: undefined | CellRenderer.ConfigOption<string>

The URL address.

`Readonly` urlName

urlName: undefined | CellRenderer.ConfigOption<string>

The friendly link name.

`Readonly` verticalAlignment

verticalAlignment: CellRenderer.ConfigOption<TextRenderer.VerticalAlignment>

The vertical alignment for the cell text.

`Readonly` wrapText

wrapText: CellRenderer.ConfigOption<boolean>

Boolean flag for applying text wrapping.

Methods

drawBackground

drawBackground(gc: GraphicsContext, config: CellRenderer.CellConfig): void
Draw the background for the cell.
Parameters
- gc: GraphicsContext
  
  The graphics context to use for drawing.
- config: CellRenderer.CellConfig
  
  The configuration data for the cell.
Returns void
Inherited from TextRenderer.drawBackground
- Defined in packages/datagrid/src/textrenderer.ts:94

drawText

drawText(gc: GraphicsContext, config: CellRenderer.CellConfig): void
Draw the text for the cell.
Parameters
- gc: GraphicsContext
  
  The graphics context to use for drawing.
- config: CellRenderer.CellConfig
  
  The configuration data for the cell.
Returns void
Overrides TextRenderer.drawText
- Defined in packages/datagrid/src/hyperlinkrenderer.ts:51

paint

paint(gc: GraphicsContext, config: CellRenderer.CellConfig): void
Paint the content for a cell.
Parameters
- gc: GraphicsContext
  
  The graphics context to use for drawing.
- config: CellRenderer.CellConfig
  
  The configuration data for the cell.
Returns void
Inherited from TextRenderer.paint
- Defined in packages/datagrid/src/textrenderer.ts:82

Class HyperlinkRenderer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: HyperlinkRenderer.IOptions = {}

Returns HyperlinkRenderer

Properties

Readonly backgroundColor

Readonly elideDirection

Readonly font

Readonly format

Readonly horizontalAlignment

Readonly textColor

Readonly url

Readonly urlName

Readonly verticalAlignment

Readonly wrapText

Methods

drawBackground

Parameters

gc: GraphicsContext

config: CellRenderer.CellConfig

Returns void

drawText

Parameters

gc: GraphicsContext

config: CellRenderer.CellConfig

Returns void

paint

Parameters

gc: GraphicsContext

config: CellRenderer.CellConfig

Returns void

Settings

Member Visibility

Theme

`Readonly` backgroundColor

`Readonly` elideDirection

`Readonly` font

`Readonly` format

`Readonly` horizontalAlignment

`Readonly` textColor

`Readonly` url

`Readonly` urlName

`Readonly` verticalAlignment

`Readonly` wrapText