Stencil Kit

Import these from @grafloria/element.

Functions

bindShapeDataPanel

Bind a shape-data panel into host. It follows the diagram's selection: nodes, edges and multi-selections each get their own sections; nothing selected shows the empty message.

ts
Copy
function bindShapeDataPanel(
  api: ShapeDataPanelApi,
  host: HTMLElement,
  options: ShapeDataPanelOptions = {}
): ShapeDataPanelHandle

bindStencilPalette

Build a stencil palette in palette that drops masters onto canvas.

ts
Copy
function bindStencilPalette(
  api: StencilPaletteApi,
  hosts: { palette: HTMLElement; canvas: HTMLElement },
  options: StencilPaletteOptions = {}
): StencilPaletteHandle

Parameters

• api: the diagram instance (engine + model + viewport)
• hosts: palette: where the list renders · canvas: the drop target (the element the diagram is mounted in)

ensureStencilKitStyles

Inject the palette stylesheet once per document.

ts
Copy
function ensureStencilKitStyles(doc: Document = document): void

Interfaces

ShapeDataPanelApi

ts
Copy
interface ShapeDataPanelApi

Members

• getEngine(): any
• getModel(): any
• on(event: string, handler: (payload: any) => void): () => void

ShapeDataPanelHandle

ts
Copy
interface ShapeDataPanelHandle

Members

• refresh(): void — Re-read the selection and rebuild the fields.
• destroy(): void

ShapeDataPanelOptions

ts
Copy
interface ShapeDataPanelOptions

Properties

StencilPaletteApi

The bits of a diagram instance the palette needs (kept structural so any host — element, React, Vue — satisfies it without importing a class).

ts
Copy
interface StencilPaletteApi

Properties

Members

• getEngine(): any
• getModel(): any

StencilPaletteHandle

ts
Copy
interface StencilPaletteHandle

Members

• setSearch(query: string): void — Filter the list programmatically (same as typing in the search box).
• place(masterId: string, world: { x: number; y: number }): Promise<string | null> — Place a master at a WORLD point without dragging (keyboard / test path).
• destroy(): void — Remove listeners and the palette DOM.

StencilPaletteOptions

ts
Copy
interface StencilPaletteOptions

Properties