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

Container Library

Brace 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

Braces Container

{
    "id": "shape19",
    "type": "braceContainer",
    "boundingBox": { ... },
    "style": { ... },
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Bracket 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

Bracket Container

{
    "id": "shape20",
    "type": "bracketContainer",
    "boundingBox": { ... },
    "style": { ... },
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Circle 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

Circle Container

{
    "id": "shape21",
    "type": "circleContainer",
    "boundingBox": { ... },
    "style": { ... },
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Diamond 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

Diamond Container

{
    "id": "shape22",
    "type": "diamondContainer",
    "boundingBox": { ... },
    "style": { ... },
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Pill 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

Pill Container

{
    "id": "shape23",
    "type": "pillContainer",
    "boundingBox": { ... },
    "style": { ... },
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Rectangle 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

Rectangle Container

{
    "id": "shape24",
    "type": "rectangleContainer",
    "boundingBox": { ... },
    "style": { ... },
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Rounded Rectangle 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

Rounded Rectangle Container

{
    "id": "shape25",
    "type": "roundedRectangleContainer",
    "boundingBox": { ... },
    "style": { ... },
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Swim Lanes

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

PropertyDescription
verticalBoolean
Determines orientation of the swim lanes.
Required
titleBarTitle Bar
Defines the behavior of the title bar of the swim lane.
Required
lanesArray[Swim Lane]
An array of swim lanes.
Required
magnetizeBoolean
Determines whether shapes within the container move with the container. Defaults to true.
Optional

Advances Swimlane Container

{
    "id": "shape26",
    "type": "swimLanes",
    "boundingBox": { ... },
    "style": { ... },
    "vertical": false,
    "titleBar": { ... },
    "lanes": [ ... ],
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Title Bar

PropertyDescription
heightNumber
The height of the title bar.
Required
verticalTextBoolean
Determines the orientation of the title text.
Required
{
  "height": 50,
  "verticalText": true
}

Swim Lane

PropertyDescription
titleString
The title text of a swim lane.
Required
widthBoolean
The width of a swim lane. All individual lane widths must add up to total swim lanes width or height, depending on orientation.
Required
headerFillColor
Hexadecimal string representing a RGB or RGBA color value for the header fill.
Required
laneFillColor
Hexadecimal string representing a RGB or RGBA color value for the lane fill.
Required
{
  "title": "Swim lane 1",
  "width": 300,
  "headerFill": "#635DFF",
  "laneFill": "#F2F3F5"
}