Grafloria — Documentation

Skip to content

Navigation

Get started

Introduction JavaScript quick start React quick start Vue quick start Angular quick start Qwik quick start

Concepts

How Grafloria works Specs and live models Instance and lifecycle State and event flow Commands and history Documents and kits

Guides

Edit the graph

Edit nodes Validate port connections Route and label edges Configure editing gestures Add editor controls

Layout and containment

Lay out a diagram Group and nest nodes

Appearance

Theme a canvas Highlight and animate state

Diagram editors

Build a workflow editor Edit database models Edit UML classes Build a stencil editor

Dashboards

Build a dashboard Arrange dashboard containers

Collaboration

Synchronize editors Share presence and comments

Saving and export

Save and restore documents Import diagram text and files Export images and documents

Whiteboarding and extensions

Draw and edit ink Tune large-graph rendering Extend rendered geometry Extend layout execution

Framework guides

JavaScript

JavaScript: elements and content

React

React: state and subscriptions React: custom content

Vue

Vue: state and composables Vue: slots and widgets

Angular

Angular: state and tooling Angular: templates and handles

Qwik

Qwik: state and resumption Qwik: custom content and kits

API reference

@grafloria/dashboard @grafloria/react @grafloria/vue @grafloria/qwik @grafloria/qwik/vite

@grafloria/renderer

Overview Core Comments Export — Pdf Ext — Components Lazy Perf Presence Presentation Services Utils Vnode

A11y

Overview classes constants functions interfaces types

Canvas

Overview classes constants functions interfaces types Canvas2DLike CanvasRenderer RecordingContext2D

Export

Overview constants functions b–s functions v–w interfaces types CustomNodeHostSource SerializeOptions SvgExportOptions

Ext

Overview classes constants functions interfaces a–t interfaces t–v types DiagramRegistry

Instance

Overview CreateDiagramOptions DiagramInstance EdgeSpec NodeSpec PortSpec

Interaction

Overview classes constants functions interfaces a–t interfaces v–w types ControlPointEditor InteractionController KeyboardNavigationController SelectionToolsController SnapController ToolHandle WaypointEditor

Svg

Overview classes constants functions a–p functions p–w interfaces a–n interfaces o–s types ShapeDefinition SVGRenderer TextBlockOptions

Themes

Overview classes constants functions interfaces types

Types

Overview interfaces b–s interfaces s–v types ExportOptions PropertyDefinition PropertyValidation SVGRendererConfig VNodeProps

@grafloria/engine

Overview Collab Comments Config Engine Interaction Layout — Grid Pack Layout — Incremental Layout — Sugiyama Serialization State Template Library Templates Utils Validation

Core

Overview classes functions interfaces types SelectionManager

Commands

Overview classes a–r classes r–u functions interfaces types CutCommand SetLinkPointsCommand SetStrokePointsCommand

Dsl

Overview classes constants enums functions interfaces a–s interfaces s–u types DSL

Layout

Overview classes constants functions a–t functions t–t interfaces a–h interfaces i–l interfaces l–u types ELKLayoutOptions LayoutOptions SubgraphLayoutManager UnifiedLayoutOptions

Models

Overview constants functions interfaces types DetachedParentAnchor DiagramEntity DiagramModel GroupModel LinkModel NodeModel PortModel SerializedPort StrokeModel

Ports

Overview PortLayoutArgs

Routing

Overview RoutingOptions

Sync

Overview classes functions interfaces types Awareness SyncAdapter SyncAdapterOptions

Types

Overview constants functions interfaces b–r interfaces s–v types ArrowStyle createDefaultLODConfig LinkLabel LinkStyle NodeStyle

@grafloria/element

Overview Core Stencil Kit

Dashboard Kit

Overview constants functions interfaces types DashboardGridHandle DashboardGridOptions DashboardHandle DashboardOptions DashboardWidgetSpec SectionCaptionOptions TabsOptions WidgetHandle

Diagram Kit

Overview classes constants functions interfaces types JoinColumn

@grafloria/angular

Overview Core Interaction

Components

Overview classes constants functions interfaces types DiagramCanvasComponent GrafloriaDashboardComponent InteractionConfigPanelComponent LinkToolbarComponent NodeToolbarComponent PropertyPanelComponent RenderedLinkPath

Services

Overview AngularAnimationService BreakpointManagerService ComponentRendererService ModeManagerService PropertyPanelService

Loading document...

ADocs generated by Atloria — from the code, always in sync →

Grafloria — Documentation