Skip to content
Sheetwritev0.5.1

CellRenderer@sheetwrite/core

On this page
@sheetwrite/coreinterface

Custom cell renderer hooks for the main-thread canvas or retained DOM overlay.

Source
packages/core/src/types/render.ts#L51

Members 4

canvas 
canvas?(ctx: CanvasRenderingContext2D, c: CellPaintContext): void;
dom Creates a fresh, detached element uniquely owned by one retained DOM cell. 
dom?(c: CellPaintContext): HTMLElement;
update Updates a retained element after its value, style, theme, or geometry changes. 
update?(element: HTMLElement, c: CellPaintContext): void;
destroy Runs immediately before a retained element is removed or replaced. 
destroy?(element: HTMLElement): void;

Declaration

View full TypeScript declaration 
export interface CellRenderer {
  canvas?(ctx: CanvasRenderingContext2D, c: CellPaintContext): void;
  dom?(c: CellPaintContext): HTMLElement;
  update?(element: HTMLElement, c: CellPaintContext): void;
  destroy?(element: HTMLElement): void;
}

Referenced by

Workspace packages depending on @sheetwrite/core

  • @sheetwrite/benchdependency
  • @sheetwrite/docs-startdependency
  • @sheetwrite/reactdependency
  • @sheetwrite/sveltedependency
  • @sheetwrite/vuedependency
  • @sheetwrite/xlsxdependency

Public exports naming CellRenderer

Documentation