Ext — Components

Import these from @grafloria/renderer.

Functions

attachCanvasPlugins

ts
Copy
function attachCanvasPlugins(
  instance: CanvasPluginHost,
  options: CanvasPluginOptions = {}
): CanvasPlugins

createBackground

Create the background grid inside root, tracking viewport.

ts
Copy
function createBackground(
  root: HTMLElement,
  viewport: ViewportController,
  options: BackgroundOptions = {}
): BackgroundHandle

createControls

ts
Copy
function createControls(
  root: HTMLElement,
  viewport: ViewportController,
  options: ControlsOptions = {}
): ControlsHandle

createMiniMap

ts
Copy
function createMiniMap(
  root: HTMLElement,
  viewport: ViewportController,
  getModel: () => DiagramModel,
  options: MiniMapOptions = {}
): MiniMapHandle

Constants

BACKGROUND_LAYER_CLASS

ts
Copy
const BACKGROUND_LAYER_CLASS: "grafloria-background-layer"

Interfaces

BackgroundHandle

ts
Copy
interface BackgroundHandle

Properties

Members

• update(options: Partial<BackgroundOptions>): void — Change any option; re-renders immediately.
• setVisible(visible: boolean): void — Show/hide without tearing down (this is what gridEnabled drives).
• isVisible(): boolean
• dispose(): void

BackgroundOptions

ts
Copy
interface BackgroundOptions

Properties

CanvasPluginHost

The structural surface the plugins actually need. DiagramInstance satisfies it; so does any framework canvas that keeps a live ViewportController (the Angular wrapper builds exactly this adapter).

ts
Copy
interface CanvasPluginHost

Properties

Members

• getModel(): DiagramModel
• getEngine(): DiagramEngine
• fitView(padding?: number): void

CanvasPluginOptions

ts
Copy
interface CanvasPluginOptions

Properties

CanvasPlugins

ts
Copy
interface CanvasPlugins

Properties

ControlsHandle

ts
Copy
interface ControlsHandle

Properties

Members

• setVisible(visible: boolean): void
• isVisible(): boolean
• setLocked(locked: boolean): void — Reflect a lock state changed elsewhere (keeps aria-pressed honest).
• dispose(): void

ControlsOptions

ts
Copy
interface ControlsOptions

Properties

MiniMapHandle

ts
Copy
interface MiniMapHandle

Properties

Members

• refresh(): void — Rebuild the node layer (call when the model changed).
• setVisible(visible: boolean): void
• isVisible(): boolean
• update(options: Partial<MiniMapOptions>): void
• dispose(): void

MiniMapOptions

ts
Copy
interface MiniMapOptions

Properties

Types

BackgroundVariant

ts
Copy
type BackgroundVariant = 'dots' | 'lines' | 'cross' | 'none';