Developers
VisQuill GDK API reference
Every class, interface and type of @visquill/visquill-gdk 1.0.2, with signatures, parameters and descriptions. For the ideas behind them, start with the developer guide.
Geometry
Computations
ArcsclassProvides utilities for constructing, analyzing, and sampling circular arcs in 2D space.BarsclassProvides utilities for constructing bar geometries along baselines.BoxesclassProvides utility methods for creating and manipulating axis-aligned rectangles (boxes).CirclesclassProvides utilities for constructing and analyzing circles in 2D space.ConvexHullsclassProvides a collection of convex hull–related algorithms for analyzing and extracting directional sections and ordered variants of convex hulls from a given set of points.CurvesclassProvides utilities for constructing offset curves and filled areas along baselines.DistributeclassProvides methods for distributing points along geometric objects such as circles, line segments, polygons, and polylines.ExtremesclassProvides utility methods for determining extreme points within a sequence of points using a screen-based coordinate system (X increases to the right, Y increases downward).FitsclassProvides utilities for computing transforms that fit one shape inside another.MatchclassProvides geometric matching utilities for point sets.OffsetsclassProvides utilities for computing offset contours, points, and segments in 2D space.PinsclassProvides static utility methods for manipulating Pin objects, which represent positioned and oriented points in 2D space.PointsclassProvides utilities for analyzing and manipulating points in 2D space.PolygonsclassProvides utilities for constructing, analyzing, and transforming polygons.PolylinesclassProvides utilities for constructing, transforming, and measuring polylines.RectanglesclassProvides utility methods for creating, manipulating, and calculating properties of rectangles.SegmentsclassProvides utilities for constructing and measuring line segments, including directed segment creation and length computations.ShapesclassProvides utilities for computing bounding boxes for different types of shapes.SymbolsclassProvides factory methods for creating common geometric symbols centered at a point.TrianglesclassProvides utility methods for analyzing triangles and extracting geometric properties.ViewportsclassProvides static utility methods for manipulating viewport state, represented as Pin objects.
Shapes
ArcinterfaceRepresents a circular arc defined by three points in space.BoxinterfaceRepresents an axis-aligned bounding box (AABB) defined by two corner points.CastclassUtility class for type casting generic shape objects to specific shape types.CircleinterfaceRepresents a circle defined by three points in space.CircularShapeinterfaceRepresents a circular shape type in the geometry system.PolygoninterfaceRepresents a closed polygon shape defined by a sequence of vertices.PolygonalShapeinterfaceRepresents a shape composed of multiple connected line segments forming a polygon-like structure.PolylineinterfaceRepresents a polyline shape, which is a connected series of line segments defined by a sequence of points.RectangleinterfaceRepresents a rectangle shape with four sides and four right angles.SegmentinterfaceRepresents a line segment shape defined by two endpoints in geometric space.ShapeinterfaceRepresents a geometric shape defined by a collection of points.ShapeLiketypeRepresents a shape that can be expressed as a sequence of points.TriangleinterfaceRepresents a triangle: a polygon with exactly three vertices.
Primitives
Collections
CollectioninterfaceRepresents a collection of elements that can be added and removed.ReadOnlyCollectioninterfaceRepresents a collection of elements that can be read and iterated, but not changed.SequenceinterfaceRepresents a generic array collection that provides indexed access to elements and supports operations for modifying, updating, and managing element sequences.
Computations
ValuesclassProvides arithmetic operations for Real and Integer values, including addition, subtraction, multiplication, division, and modulus.VectorsclassProvides utility methods for vector, direction, point, and angle calculations, including arithmetic, rotation, angle measurement, and normalization.
Values
BoolinterfaceRepresents a boolean value wrapper that provides access to a mutable boolean.BoolLiketypeRepresents a boolean value.IntegerinterfaceRepresents a mutable integer type interface that extends ReadOnlyInteger.IteminterfaceRepresents a generic item container that holds a value of any type.NumberLiketypeRepresents a numeric value.ReadOnlyIntegerinterfaceRepresents a readonly integer value wrapper that provides access to an immutable integer.ReadOnlyRealinterfaceRepresents a read-only real number: a wrapper that provides read access to a number value.RealinterfaceRepresents a mutable real number: a wrapper that provides read and write access to a number value.StringValueinterfaceRepresents a text value wrapper that provides access to a mutable string value.
Vectors
PininterfaceRepresents a pin, which is a point with orientation in 2D space.PinLiketypeRepresents a pin or point location, optionally with a direction vector.PointinterfaceRepresents a point in 2D space.VectorinterfaceRepresents a two-dimensional vector with X and Y components.VectorLiketypeRepresents a 2D vector-like value that can be expressed in two different formats.VectorsLiketypeRepresents a collection of vectors in various acceptable formats.
Reactive
Animation
AnimateclassCentral animation controller for all reactive value types.EasingFunctionsclassProvides a collection of easing functions for animation interpolation.RvgBoolAnimatorclassAnimator for reactive boolean values.RvgEasedOptionsclassOptions for eased (tween) animations.RvgFollowOptionsclassOptions for follow (spring/damped) animations.RvgIntegerAnimatorclassAnimator for reactive integer values.RvgNumberAnimatorclassAnimator for reactive real-number values.RvgPinAnimatorclassAnimator for reactive Pin values.RvgPointAnimatorclassAnimator for reactive Point values.RvgSetOptionsclassOptions for deferred set animations.RvgShapeAnimatorclassAnimator for reactive Shape values.RvgStringAnimatorclassAnimator for reactive string values.RvgTextDurationModeenumControls how the duration parameter of a text animation is interpreted.RvgTextOptionsclassOptions for string (text) animations.
Core
RVG
Core
RvgGraphicinterfaceRepresents a graphic interface that provides hierarchical organization of visual elements through groups and layers.RvgGroupinterfaceRepresents a container for creating and managing geometric shapes, visual elements, and reactive values.RvgMaskinterfaceProvides masking functionality for a group.SvgclassEscape hatch to retrieve the underlying SVG DOM element of a graphic, a group, or a visual.SvgBoxElementtypeType alias for the underlying SVG element used to render box visuals.SvgCircleElementtypeType alias for the underlying SVG element used to render circle visuals.SvgPolygonElementtypeType alias for the underlying SVG element used to render polygon visuals.SvgPolylineElementtypeType alias for the underlying SVG element used to render polyline visuals.SvgSegmentElementtypeType alias for the underlying SVG element used to render segment visuals.SvgTextElementtypeType alias for the underlying SVG element used to render text visuals.VisQuillclassEntry point for creating reactive vector graphics.VisQuillOptionstypeConfiguration options for creating a VisQuill graphics context.
Factories
RvgHandleFactoryinterfaceFactory for creating interactive manipulation handles that enable direct user interaction and dragging of visual elements.RvgShapeFactoryinterfaceFactory for creating non-visual geometric shape data structures that represent mathematical primitives without rendering capabilities.RvgTextFactoryinterfaceFactory for creating text visual elements that can be positioned along polyline paths or anchored at specific points with customizable styling and orientation.RvgValueFactoryinterfaceFactory for creating observable value containers that automatically propagate changes to dependent computations and visual elements.RvgViewportFactoryinterfaceFactory for creating viewport visuals that combine a clipping shape with a transformed sub-coordinate system containing nested content.RvgVisualFactoryinterfaceFactory for creating styled visual representations of geometric primitives that can be rendered and interacted with in a graphical context.
Viewports
RvgBoxViewportinterfaceRepresents a viewport with a rectangular clipping boundary.RvgCircleViewportinterfaceRepresents a viewport with a circular clipping boundary defined by three points.RvgViewportinterfaceRepresents a viewport that defines a clipping region and coordinate transformation system within the rendering hierarchy.RvgViewportControllerinterfaceRepresents a controller for viewport navigation operations such as panning and zooming.ViewportInteractivityOptionsclassConfigures interactivity options for viewport controls, including panning and zooming capabilities.
Visuals
RvgAnchoredTextinterfaceRepresents a visual element for text anchored at a specific position with orientation.RvgArcinterfaceRepresents a visual element for arc shapes.RvgBoxinterfaceRepresents a visual element for boxes.RvgCircleinterfaceRepresents a visual element for circles.RvgHandleinterfaceRepresents a draggable handle visual element that combines visual and pin properties.RvgPininterfaceRepresents a visual element for pins.RvgPointinterfaceRepresents a visual element for points with vector properties.RvgPolygoninterfaceRepresents a visual element for polygons.RvgPolygonalVisualinterfaceRepresents a visual element for polygonal shapes.RvgPolylineinterfaceRepresents a visual element for polylines.RvgRectangleinterfaceRepresents a visual element for boxes.RvgSegmentinterfaceRepresents a visual element for segments.RvgShapeVisualinterfaceRepresents a visual element for shapes.RvgTextPathinterfaceRepresents a visual element for text aligned along a path.RvgTriangleinterfaceRepresents a visual element for triangles.RvgVisualinterfaceRepresents a visual element wrapper that provides visibility control, z-order management, and mounting/unmounting capabilities in a rendering system like SVG.