All exports

Every export of every pack in one list. Type in the box to filter by name or description.

Name	Kind	Pack	What it does
Anchor	type	Core	A point that may follow something else: a fixed position, or a function evaluated each frame.
anglesOf	function	Core	The angles and distance of a perspective camera, the inverse of orbitPosition.
Anim	type	Core	A piece of animation.
antenna	function	Devices	An antenna: a whip on a base, a parabolic dish on a mount, or a lattice tower.
Antenna	class	Devices	An antenna.
AntennaOpts	type	Devices	Options of antenna.
arcSegs	function	Core	A circular arc as cubic segments, none longer than a quarter turn.
areas	function	Charts	An area chart: overlapping filled areas, or stacked with stack: true.
arrow	function	Core	A line with an arrowhead at the end.
axes	function	Core	The coordinate frame: three arrows along x, y and z with labels.
Badge	class	UI on screens	The little count on an icon.
badge	function	UI on screens	A small round badge with a count, such as an unread marker.
BadgeOpts	type	UI on screens	Options of badge.
bars	function	Charts	A bar chart.
Box	class	Core	A box standing on the point at: the centre of its base.
box	function	Core	A box standing on the point at, the centre of its base.
BoxOpts	type	Core	Options of box.
browser	function	Devices	A browser window.
BrowserOpts	type	Devices	Options of browser.
Camera	class	Core	World axes: x to the right, y into the scene, z up.
cameraGlyph	function	Core	A pinhole camera: its apex, image plane and the rays through the corners, aimed at a target.
Chart	class	Charts	A chart drawn on a plane in the scene: flat on the page, standing up, or on a screen (device.put).
chart	function	Charts	A chart.
ChartData	type	Charts	What data can be.
ChartOpts	type	Charts	Options of chart and of the named chart factories (bars, lines, pie, and so on).
ChartType	type	Charts	The kinds of chart chart can draw.
Chat	class	UI on screens	A conversation: messages from me on the right in the accent colour, from them on the left.
chat	function	UI on screens	A chat: bubbles from you and from them, with typing dots.
ChatOpts	type	UI on screens	Options of chat.
circle	function	Core	A circle or arc in a coordinate plane, centred on at.
circleD	function	Core	A full circle as a path, starting at the top and going clockwise, so it draws on like a compass.
clampZoom	function	Core	Multiplies a zoom by a factor and keeps it inside the limits.
cloud	function	Devices	A cloud made of overlapping balls.
CloudOpts	type	Devices	Options of cloud.
code	function	Core	Code on any plane, coloured, optionally numbered.
colourOf	function	Core	a colour role (ink, faint, accent, grid, s1 to s8) or any CSS colour, as a CSS colour
Construct	class	Core	A drawing built from parts that each draw on, fill, turn, move and fade by themselves.
ConstructOpts	type	Core	Options of a construction.
Curve	class	Core	A line through the samples of a function, drawn as one SVG path.
curve	function	Core	A curve through the points of a function t => [x, y, z], sampled samples times between t0 and t1.
cylinder	function	Devices	A cylinder standing on the point at.
CylinderOpts	type	Devices	Options of cylinder.
database	function	Devices	The classic database icon: stacked discs.
DatabaseOpts	type	Devices	Options of database.
Device	class	Devices	A thing with a screen.
Diagram	class	Graphs and flow	Boxes and arrows that place themselves.
diagram	function	Graphs and flow	Boxes and arrows that place themselves.
DiagramEdge	class	Graphs and flow	A line between two nodes, routed by the layout.
DiagramNode	class	Graphs and flow	One box of a diagram: a shape and the words in it.
DiagramOpts	type	Graphs and flow	Options of diagram.
Dialog	class	UI on screens	A dialog box with a title, text and buttons.
dialog	function	UI on screens	A dialog box with a title, a body and buttons.
DialogOpts	type	UI on screens	Options of dialog.
dimension	function	Core	A measured distance: a line with end ticks and a label, offset to one side so it does not cover the thing measured.
document	function	Devices	A sheet of paper with a folded corner and lines of text.
DocumentOpts	type	Devices	Options of document.
donut	function	Charts	A pie with a hole.
Dot	class	Core	A dot of fixed size on the screen at a point of the scene.
dot	function	Core	A dot at a point.
dragToAngles	function	Core	New angles after a drag of (dx, dy) pixels, in degrees.
draw	function	Core	Draws a line, curve or outline on from its start to its end.
ease	value	Core	The named easing curves: linear, in, out, inOut, smooth and back.
Ease	type	Core	An easing function: maps progress 0 to 1 onto progress 0 to 1.
EaseName	type	Core	The name of a built-in easing curve.
EdgeSpec	type	Graphs and flow	Options of Diagram.edge.
Face	class	Core	One flat polygon.
FaceOpts	type	Core	Options of filled surfaces.
fadeIn	function	Core	Fades a node in from invisible to its own opacity.
fadeOut	function	Core	Fades a node out to invisible.
flowchart	function	Graphs and flow	A flowchart from a list of steps.
FlowStep	type	Graphs and flow	One step of a flowchart.
Frustum	class	Optics	The classic picture of a pinhole camera: the centre, the image plane at focal length f, the rays through its corners and the optical axis.
frustum	function	Optics	A pinhole camera with its image plane and rays.
FrustumOpts	type	Optics	Options of frustum.
Graph	class	Maths	A function plotted on axes.
graph	function	Maths	A function plotted on axes, with an optional tangent, shaded area and Riemann rectangles.
GraphOpts	type	Maths	Options of graph.
Ground	class	Core	The ground lattice.
ground	function	Core	A square lattice lying on the floor (z = 0).
Group	class	Core	A node that holds other nodes and moves, turns and scales them together.
group	function	Core	Groups nodes so they move, turn and scale together.
heatmap	function	Charts	A matrix coloured through the theme’s sequential ramp, or a diverging ramp for values around zero.
heightField	function	Core	A height field z = f(x, y) over a rectangle.
histogram	function	Charts	A histogram of raw values, binned into bins bars.
Key	class	Devices	A single keycap.
Keyboard	class	Devices	A keyboard with accurate key sizes and positions and no legends.
keyboard	function	Devices	A keyboard.
keyboardLayout	function	Devices	Every key of a layout, with its place.
KeyboardLayout	type	Devices	A keyboard layout: full (104 keys), tkl (87), 75 or 60.
KeyboardOpts	type	Devices	Options of keyboard.
KeyDef	type	Devices	One key: its place on the board in key units (1 is a standard key), measured from the top left.
Label	class	Core	Text that stays upright and readable, attached to a point in the scene.
label	function	Core	Text that stays upright and readable, attached to a point in the scene.
laptop	function	Devices	A laptop, open.
LaptopOpts	type	Devices	Options of laptop.
layoutRows	function	Core	Splits text into rows that fit cols characters.
line	function	Core	A straight line through two or more points.
lineD	function	Core	A straight line as a path.
lines	function	Charts	A line chart.
lineSegs	function	Core	A straight segment between two points.
Link	class	Core	A curved arrow between two things.
link	function	Core	A curved arrow between two objects or points.
LinkOpts	type	Core	Options of link.
MarkKey	type	Core	What a mark can match: a word, a pattern, or a [start, end) range of the source text.
Marks	type	Core	Words to colour in a text block: a map from the word to a role or CSS colour, or a list of [match, colour] pairs where the match is a string, a regular expression or a [start, end] range.
Mat	type	Maths	A matrix as rows of numbers.
Matrix	class	Maths	A matrix with brackets.
matrix	function	Maths	A matrix with brackets.
MatrixOpts	type	Maths	Options of matrix.
measureD	function	Core	A measuring bracket between two points: a line with a short tick across each end, for showing a length.
Message	type	UI on screens	One chat message: who sent it and what it says.
micHand	function	Devices	A handheld microphone, lying upright with its head on top.
MicOpts	type	Devices	Options of micStand and micHand.
micStand	function	Devices	A microphone on a stand: a round base, a pole, a boom arm and the capsule.
monitor	function	Devices	A desktop monitor on a stand.
MonitorOpts	type	Devices	Options of monitor.
mount	function	Core	Puts a scene in the page and plays it.
MountOpts	type	Core	Options of mount.
mouse	function	Devices	A computer mouse, pointing away from the viewer (front is -y).
MouseOpts	type	Devices	Options of mouse.
moveBy	function	Core	Moves a node by an offset from where it is when the animation starts.
moveTo	function	Core	Moves a node to a point.
nestSvg	function	Core	Places an SVG document inside a rectangle of another SVG, scaled to fill it (like object-fit: cover).
niceTicks	function	Charts	round tick values that cover [lo, hi]
Node	class	Core	The base of everything in a scene.
NodeOpts	type	Core	Options every node takes.
NodeSpec	type	Graphs and flow	Options of Diagram.node.
Notification	class	UI on screens	A notification card.
notification	function	UI on screens	A notification card with a title, a body and an optional icon.
NotificationOpts	type	UI on screens	Options of notification.
NumberLine	class	Maths	A number line.
numberLine	function	Maths	A number line with marks, a sliding marker and jumps between values.
NumberLineOpts	type	Maths	Options of numberLine.
orbit	function	Core	Turns the camera of a scene with the pointer, wheel, touch and keyboard.
Orbit	type	Core	Handle to a running orbit control.
OrbitLimits	type	Core	How far the camera may turn and zoom.
OrbitOpts	type	Core	Options of orbit.
orbitPosition	function	Core	Where a perspective camera sits when it looks at target from distance along the given angles (same angles as the parallel camera).
Palette	type	Charts	Where series colours come from.
par	function	Core	Plays the animations at the same time.
parseSvg	function	Core	Reads an SVG document into a size and inner markup that plane can place.
Part	class	Core	One drawn shape of a construction.
PartOpts	type	Core	Options of a part of a construction.
Path	class	Core	A line through points, drawn as one SVG path.
path	function	Core	A line through any number of points, optionally closed.
PathOpts	type	Core	Options of lines and paths.
Pen	class	Core	A line being drawn by a pen.
pen	function	Core	A line being drawn by a pen: pen(points), then tween draw from 0 to 1.
PenOpts	type	Core	Options of pen.
phone	function	Devices	A phone, upright.
PhoneOpts	type	Devices	Options of phone.
photoCamera	function	Devices	A photo camera with a lens, pointing at the viewer.
PhotoCameraOpts	type	Devices	Options of photoCamera.
pie	function	Charts	A pie chart of the shares in data.
Plane	class	Core	Any SVG laid on a plane in 3D.
plane	function	Core	Lays an SVG (a logo, a chart, a screenshot) on any plane of the scene.
PlaneOpts	type	Core	Options of plane.
Player	type	Core	Controls a mounted scene: play, pause, seek by time or by chapter, and redraw after a change made by hand.
Point	type	Core	A place in the scene: a plain [x, y, z], an anchor of a node, or a node itself (its position).
Point2	type	Charts	A point of a scatter plot.
polar	function	Core	The point at a distance and an angle (degrees, 0 to the right, 90 up) from a centre.
polygon	function	Core	A flat filled polygon through three or more points.
Prim	type	Core	What the renderer draws.
Product	class	Maths	A times B, one entry at a time.
product	function	Maths	Two matrices and their product, with the entry being computed highlighted.
ProductOpts	type	Maths	Options of product.
Progress	class	UI on screens	A progress indicator.
progress	function	UI on screens	A progress indicator as a bar, a ring or separate segments.
ProgressOpts	type	UI on screens	Options of progress.
Pt	type	Core	A point in svg units.
Pulse	class	Core	A dot that rides along a link, a polyline or a function.
pulse	function	Core	A dot that rides along a link or a line.
PulseOpts	type	Core	Options of pulse.
radar	function	Charts	A radar chart: one spoke per label, one polygon per series.
radio	function	Waves	The arcs above an antenna or a router.
rect	function	Core	A flat rectangle standing in a coordinate plane, as a filled face.
renderStill	function	Core	The static markup of a scene at one moment: render on the server, then mount in the browser to bring it to life.
reverse	function	Core	Plays an animation backwards: every tween runs from its end value to its start value, last one first.
ripple	function	Waves	Circles spreading from a point, like a drop in water.
rng	function	Core	A small deterministic random generator, so generated scenes are identical on server and client.
rotateSegs	function	Core	Turns segments about a point.
rotateTo	function	Core	Rotates a node to Euler angles in degrees about x, y and z.
router	function	Devices	A router with antennas, status lights and ports.
RouterDevice	class	Devices	A wifi router with antennas, indicator lights and ports.
RouterOpts	type	Devices	Options of router.
Row	type	Core	One drawn row of text: a slice [start, end) of the source, and the source line it came from.
scaleTo	function	Core	Scales a node to a factor.
scatter	function	Charts	A scatter plot.
Scene	class	Core	A scene is a tree of nodes, a camera, and the settings to draw them.
SceneOpts	type	Core	Options of new Scene.
Seg	type	Core	One cubic Bezier segment: start, two control points, end.
segsD	function	Core	Writes segments as an SVG path string.
seq	function	Core	Plays the animations one after another.
Sequence	class	Graphs and flow	Participants as boxes along the top, each with a dashed lifeline below it, and messages as arrows between the lifelines in the order they happen, time flowing down.
sequence	function	Graphs and flow	A sequence diagram: who talks to whom, in order.
SequenceMessage	type	Graphs and flow	One message of a sequence diagram: an arrow from one participant to another.
SequenceNote	type	Graphs and flow	A note on a sequence diagram, in the list of messages where it happens.
SequenceOpts	type	Graphs and flow	Options of sequence.
SequenceSpec	type	Graphs and flow	What a sequence diagram shows.
Series	type	Charts	A named list of values, with an optional colour.
server	function	Devices	A rack of servers with indicator lights.
ServerOpts	type	Devices	Options of server.
Shape	type	Graphs and flow	The look of a node.
sonar	function	Waves	A sonar beam: arcs travelling in one direction, fading with distance.
sparkline	function	Charts	A small line chart with no axes, the size of a word.
speaker	function	Devices	A loudspeaker cabinet with a woofer and a tweeter, facing the viewer.
SpeakerOpts	type	Devices	Options of speaker.
Sphere	type	Core	A sphere in world space: a centre c and a radius r.
sphere	function	Devices	A shaded sphere resting on the point at.
sphereOf	function	Core	The bounding sphere of the drawable nodes, used by fit: 'sphere'.
SphereOpts	type	Devices	Options of sphere.
Spheres	class	Core	Several spheres drawn as one body: overlapping balls, like a cloud, are ordered together by depth.
stagger	function	Core	Starts each animation a little after the previous one.
StereoOpts	type	Optics	Options of stereoRig.
StereoRig	class	Optics	Two parallel cameras a baseline apart looking at one point: both image planes, both rays, the horizontal epipolar lines, and the depth Z = f * b / d.
stereoRig	function	Optics	Two cameras looking at one point: the picture behind stereo vision and depth from disparity.
StyleOpts	type	Core	Colour and line width, shared by lines, faces and text.
Surface	class	Core	A parametric surface (u, v) to a point, drawn as a mesh of shaded quads.
surface	function	Core	A parametric surface (u, v) => [x, y, z] drawn as a mesh of shaded quads.
SurfaceOpts	type	Core	Options of surface.
SvgPlane	class	Core	Anything drawn as SVG on a plane in the scene: charts, screen elements, maths figures.
SvgPlaneOpts	type	Core	Options shared by everything that is an SVG drawing placed on a plane: charts, screens and maths figures.
Table	type	Charts	Chart data after normalising: the labels along the axis and one series per colour.
tablet	function	Devices	A tablet, landscape by default, standing on its edge.
TabletOpts	type	Devices	Options of tablet.
terminal	function	Devices	A terminal window with an empty body.
TerminalOpts	type	Devices	Options of terminal.
TextBlock	class	Core	Text laid on a plane in the scene: a wall, the floor, a screen.
TextBlockOpts	type	Core	Options of write and code.
TextOpts	type	Core	Options of label.
Timeline	class	Core	A timeline is a list of tweens.
Toast	class	UI on screens	A small pill with one line of text.
toast	function	UI on screens	A short message in a pill, such as a confirmation.
ToastOpts	type	UI on screens	Options of toast.
Token	type	Core	A piece of a line of code with its kind, for colouring.
tokenize	function	Core	Splits a line of code into coloured pieces.
TokenKind	type	Core	What a token is: plain text, a keyword, a string, a number or a comment.
toTable	function	Charts	The table behind any form of data: the labels along the axis and one series per colour.
Transform2d	class	Maths	The plane, deformed by a 2 by 2 matrix.
transform2d	function	Maths	The plane deformed by a 2 by 2 matrix, with the basis vectors, the unit square and the eigenvector lines.
Transform2dOpts	type	Maths	Options of transform2d.
TreeData	type	Graphs and flow	The shape of a tree: a label and the branches below it.
treeDiagram	function	Graphs and flow	A tree from nested data: a label and its children.
tv	function	Devices	A flat-screen television on two feet.
TvOpts	type	Devices	Options of tv.
tween	function	Core	Animate any properties of a node or camera: tween(cube, \{ opacity: 0.2, pos: [1, 0, 0] \}).
Tween	type	Core	One change of one object’s properties over a span of time.
TweenOpts	type	Core	Options of tween.
typeOn	function	Core	Types text or code onto a plane letter by letter.
UiOpts	type	UI on screens	Options shared by everything that lives on a screen.
UnitCircle	class	Maths	The unit circle with the angle in the property angle (degrees): its sine, cosine and, if asked, the wave they trace.
unitCircle	function	Maths	The unit circle, with the sine and cosine of an angle and, if asked, the wave they trace.
UnitCircleOpts	type	Maths	Options of unitCircle.
V3	type	Core	A point or direction [x, y, z].
VectorField	class	Maths	A grid of arrows: the direction and strength of a field at each point.
vectorField	function	Maths	A grid of arrows showing the direction and strength of a field (x, y) => [dx, dy].
VectorFieldOpts	type	Maths	Options of vectorField.
View	type	Core	A camera preset (iso, front, side, top) or explicit \{ yaw, pitch \} angles in degrees.
wait	function	Core	Does nothing for a while.
Wave	class	Waves	Waves of many kinds.
wave	function	Waves	A wave of any kind: sine, longitudinal, standing, rings, directional (sonar), spherical, plane, interference, echo or radio.
WaveKind	type	Waves	The kinds of wave wave can draw.
WaveOpts	type	Waves	Options of wave.
write	function	Core	Text on any plane: write('hello', \{ at, size, u, v \}).