Canvas SDK reference

Every export of @internote/canvas-sdk, as the package declares it: the signature, what it is for, and the file it is written in. Generated from the declarations themselves, so a name here exists and a name that has changed says so.

@internote/canvas-sdk403 exports5 entry points

Build Internote canvas environments — the canvas.graph, canvas.code, … a scene's canvas holds — and declare how the compiler reads them.

This is the package root, and it is React-free: everything here runs in a browser, on a server, in a build script or under node --test. It holds both halves of an environment that are not drawing:

  • Defining and registering — defineEnvironment, EnvironmentDefinition, the EnvironmentRegistry, and the declarations a definition carries: toolbar items, footer, storage tiers, plugin manifest.
  • The compile side — attribute and value types, the library builder, the refiner kit for parsing your own value types, and the semantic pass a validate hook is written with.
  • Reading content — compiled documents, the node tree (flatNodes, nodesOf, attrOf…), expressions, data columns, colours, text measurement, parameters, the reader's view.
  • Time — steps, cues, keyframe tracks and the per-environment EnvironmentAnimationRuntime.
  • Live values — the LiveValueStore a surface publishes computed numbers into and prose reads them from.

The other entry points:

  • @internote/canvas-sdk/react — what a surface is drawn with: the hooks, labels, maths, footer controls and chrome components.
  • @internote/canvas-sdk/host — for an application embedding the canvas: the document host, the scene view and the adapters it is given.
  • @internote/canvas-sdk/compile — the compile pipeline. Server only.
  • @internote/canvas-sdk/testing — a headless host and a worked example.
  • @internote/canvas-sdk/styles — the stylesheet, imported once.

#By area

An export is documented once, on the page for the job it does.

Environments
The definition itself — what defineEnvironment takes, what the registry does with it, and the helpers a definition reads its own node tree with.
79
Compiling
What runs before a reader sees anything: an attribute refined from the text it was written as, the semantic pass over the result, the manifest a plugin declares, and the service that compiles a document.
30
Drawing
The React half: the hooks a surface is built on, the components it draws labels, maths and rich text with, the footer controls, and the geometry behind a mark.
65
Animation
Steps and cues as the runtime plays them: the keyframe tracks a cue.to declares, the interpolations that read them, and the controller that advances a step.
21
Storage
The two tiers an environment keeps state in: the session it holds while it is open, and the interaction store that outlives the visit.
21
Toolbar and footer
The chrome the host draws around a surface: the toolbar an environment declares as data, the footer it renders as JSX, and the view channel between them.
14
Data
Datasets as an environment reads them: a column resolved to numbers, dates, periods or categories, the axis presets over them, and a series entry.
48
Parameters
Free parameters and the sweeps over them: which names an expression leaves open, the axis a sweep walks, and the session that holds the current value.
14
Text and expressions
What an attribute’s text becomes: rich text and its footnotes, live values, symbol names, measured and wrapped labels, and a compiled expression.
37
Colour
The colour vocabulary an author writes and a surface resolves: hues and their tones, the ramps, the surface paints, and the CSS each becomes.
42
Host
For the application embedding a canvas, not for the environments in it: the document and scene hosts, and the adapters they are given for storage, code execution and plugins.
24
Testing
The fixture and the walkthrough a test drives a definition through the whole environment contract with, through public surfaces only. The headless host it mounts on is under Host.
8

#Entry points

What an import from each one gets. The root is React-free; @internote/canvas-sdk/react is the half that draws. @internote/canvas-sdk/styles is the stylesheet, imported once by the application, and exports nothing.

@internote/canvas-sdk
packages/canvas-sdk/src/index.ts
Documented under Environments, Compiling, Drawing, Animation, Storage, Toolbar and footer, Data, Parameters, Text and expressions, Colour and Host.
339
@internote/canvas-sdk/compile
packages/canvas-sdk/src/compile/index.ts
Documented under Compiling.
3
@internote/canvas-sdk/host
packages/canvas-sdk/src/host/index.ts
Documented under Host.
22
@internote/canvas-sdk/react
packages/canvas-sdk/src/react/index.ts
Documented under Drawing.
66
@internote/canvas-sdk/testing
packages/canvas-sdk/src/testing/index.ts
Documented under Testing.
13

#Passed on from Chalk

The root re-exports 27 names from @internote/chalk, so an environment reads a document’s tree without a second dependency. They are Chalk’s, documented with the language rather than here: chalkBindingOf, inlineItemsOf, isInlineContent, validateComplexExpression, validateParametrisedExpression, CHALK_BINDING_KEY, SYMBOL_NAMES, AttrSpec, CaseSpec, ChalkBinding, ChalkDataset, ChalkLibrary, ClassSpec, ComplexExpression, MicronodeSpec, NodeSpec, SwitchSpec, ChalkAttribute, ChalkDocument, ChalkElement, InlineItem, InlinePolicySpec, NodeContent, PolicySpec, SymbolName, TypeRefSpec, TypeSpec.

Last updated