These docs are for v1.0. Click to read the latest docs for v1.2.

Lucidspark Library

Freehand Drawing

PropertyDescription
styleFreehand Drawing Style
A line style specific to freehand drawings.
Required
pointsArray[AbsolutePosition]
An array of positions that define the shape of the freehand drawing.
Required
offsetAbsolutePosition
The position of the freehand drawing. All points are relative to the offset.
Optional

Freehand Drawing Block

{
    "id": "shape50",
    "type": "freehandDrawing",
    "style": { ... },
    "points": [ ... ],
    "offset": { ... },
    "note": "Test Note"
}

Freehand Drawing Style

PropertyDescription
widthNumber
The thickness of the line. Must be between 0 and 100.
Required
colorColor
Hexadecimal string representing a RGB or RGBA color value of the line.
Required

Spark Callout Square

Spark Callout Square Block

{
    "id": "shape51",
    "type": "sparkCalloutSquare",
    "boundingBox": { ... },
    "style": { ... },
    "text": "Text",
    "actions": [ ... ],
    "customData": [ ... ],
    "linkedData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Spark Container

This shape's bounding box is incompatible with the rotation property.

PropertyDescription
magnetizeBoolean
Determines whether shapes within the container move with the container. Defaults to true.
Optional

Spark Container Block

{
    "id": "shape52",
    "type": "sparkContainer",
    "boundingBox": { ... },
    "style": { ... },
    "text": "Text",
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Spark Frame

This shape's bounding box is incompatible with the rotation property.

PropertyDescription
magnetizeBoolean
Determines whether shapes within the container move with the container. Defaults to true.
Optional

Spark Frame Block

{
    "id": "shape53",
    "type": "sparkFrame",
    "boundingBox": { ... },
    "style": { ... },
    "title": "Frame 1",
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}