Skip to content
D
Documentation

Overview

reference
1 min readUpdated

@grafloria/renderer

SVG renderer for the Grafloria diagram engine — interaction, theming, accessibility, and SVG/PNG/PDF vector export

Install

bash
npm install @grafloria/renderer @grafloria/engine

It expects these alongside it:

  • @grafloria/engine ^0.3.18

What it exports

  • Core: 17 exports, including cancelFrame, CanvasRect, getDocument, hasDocument
  • A11y: 51 exports, including Adjacency, analyseTopology, boundsOfPoints, buildAdjacency
  • Canvas: 79 exports, including ALWAYS_SAFE_MODE, applyMatrix, arcToCubics, BackendMode
  • Comments: 9 exports, including CommentOverlayController, CommentOverlayOptions, CommentPanelOptions, CommentPanelView
  • Export: 106 exports, including Artifact, AssetFetcher, AVG_CHAR_WIDTH_EM, base64ToBytes
  • Ext: 115 exports, including activeRegistryScope, AnchorContext, AnchorFn, AnchorResult
  • Ext — Components: 15 exports, including attachCanvasPlugins, BACKGROUND_LAYER_CLASS, BackgroundHandle, BackgroundOptions
  • Instance: 49 exports, including applyEdges, applyEdgeSpec, applyGroups, applyNodes
  • Interaction: 85 exports, including AddWaypointResult, AlignmentGuide, angleAt, Announcement
  • Lazy: 13 exports, including DeferredQuery, EntityKind, FreezeQuery, HostCullMode
  • Perf: 8 exports, including EMPTY_SNAPSHOT, formatSnapshot, GovernorOptions, GovernorState
  • Presence: 12 exports, including actorColor, actorInitials, bindPresence, BindPresenceOptions
  • Presentation: 11 exports, including FollowOptions, followPresenter, InMemoryViewportChannel, isDocumentLocked
  • Services: 25 exports, including AnimationConfig, AnimationEventData, AnimationLifecycleEvent, AnimationLifecycleManager
  • Svg: 198 exports, including applySpread, ArrowRenderer, assignSpreadLanes, autoSizeDiagram
  • Themes: 83 exports, including assertThemeContrast, auditThemeContrast, BASE_STYLE_RULES, BRIDGEABLE_TOKENS
  • Types: 50 exports, including BooleanPropertyDefinition, BoundingBox, CanvasRendererConfig, ColorPalette
  • Utils: 37 exports, including AnimationColorSchemes, AnimationDescriptor, AnimationPresets, AnimationPriority
  • Vnode: 17 exports, including camelToKebab, ContainerIdGenerator, createDomElement, createForeignObject

Also exported from here

These names are documented with the package that defines them, and can be imported from this one too.

Was this page helpful?

Overview — Grafloria