Class ImageRenderer

A cell renderer which renders data values as images.

Hierarchy (view full)

AsyncCellRenderer
- ImageRenderer

Index

Constructors

Properties

backgroundColor height placeholder textColor width dataCache

Methods

drawBackground drawImage drawPlaceholder isReady load paint paintPlaceholder

Constructors

constructor

new ImageRenderer(options?): ImageRenderer
Construct a new text renderer.
Parameters
- options: ImageRenderer.IOptions = {}
  The options for initializing the renderer.
Returns ImageRenderer
Overrides AsyncCellRenderer.constructor
- Defined in datagrid/src/imagerenderer.ts:28

Properties

`Readonly` backgroundColor

backgroundColor: CellRenderer.ConfigOption<string>

The CSS color for the cell background.

`Readonly` height

height: CellRenderer.ConfigOption<string>

The height of the image.

`Readonly` placeholder

placeholder: CellRenderer.ConfigOption<string>

The placeholder text.

`Readonly` textColor

textColor: CellRenderer.ConfigOption<string>

The CSS color for drawing the placeholder text.

`Readonly` width

width: CellRenderer.ConfigOption<string>

The width of the image.

`Private` `Static` dataCache

dataCache: Map<string, undefined | HTMLImageElement> = ...

Methods

drawBackground

drawBackground(gc, config): 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
- Defined in datagrid/src/imagerenderer.ts:138

drawImage

drawImage(gc, config): void
Draw the image for the cell.
Parameters
- gc: GraphicsContext
  The graphics context to use for drawing.
- config: CellRenderer.CellConfig
  The configuration data for the cell.
Returns void
- Defined in datagrid/src/imagerenderer.ts:178

drawPlaceholder

drawPlaceholder(gc, config): void
Draw the placeholder for the cell.
Parameters
- gc: GraphicsContext
  The graphics context to use for drawing.
- config: CellRenderer.CellConfig
  The configuration data for the cell.
Returns void
- Defined in datagrid/src/imagerenderer.ts:159

isReady

isReady(config): boolean
Whether the renderer is ready or not for that specific config. If it's not ready, the datagrid will paint the placeholder. If it's ready, the datagrid will paint the image synchronously.
Parameters
- config: CellRenderer.CellConfig
  The configuration data for the cell.
Returns boolean
Whether the renderer is ready for this config or not.
Overrides AsyncCellRenderer.isReady
- Defined in datagrid/src/imagerenderer.ts:74

load

load(config): Promise<void>
Load the image asynchronously for a specific config.
Parameters
- config: CellRenderer.CellConfig
  The configuration data for the cell.
Returns Promise<void>
Overrides AsyncCellRenderer.load
- Defined in datagrid/src/imagerenderer.ts:85

paint

paint(gc, config): 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
Overrides AsyncCellRenderer.paint
- Defined in datagrid/src/imagerenderer.ts:126

paintPlaceholder

paintPlaceholder(gc, config): void
Paint the placeholder for a cell, waiting for the renderer to be ready.
Parameters
- gc: GraphicsContext
  The graphics context to use for drawing.
- config: CellRenderer.CellConfig
  The configuration data for the cell.
Returns void
Overrides AsyncCellRenderer.paintPlaceholder
- Defined in datagrid/src/imagerenderer.ts:114