Data Backed Shapes

Data backed shapes represent objects on a page that are defined and generated from a provided dataset. Each data backed shape object includes a type that defines what object it is and how it will be parsed and must be linked to a set of data from which the objects will be generated.

Common Properties

These properties are used by all data backed shapes. Additional configuration properties for each data backed shape are listed with the description of the shape.

PropertyDescription
idID
Identifier for a given data backed shape (must be unique).
Required
typeString
The type of data backed shape. An example for each data backed shape is list below.
Required

Org Charts

An Org Chart is a data backed shape that is used to represent the organizational structure of a group of people.

🚧

Org charts are limited to a total size for 4000 users summed across all pages of the document.

Org Chart Reference

Org Chart Format

PropertyDescription
positionAbsolutePosition
The absolute point that the top left corner of the generated content will be placed. Note that the size of the object is dependent on the size and layout of the data provided.
Required
collectionIdID
The id of the provided collection that the org chart will draw data from.
Required
idFieldString
Defines the name of the field in the collection that represents the primary key or ID of the identities in the collection. Primary keys should be unique.
Required
foreignKeyFieldString
Defines the name of the field in the collection that references the value of the idField of another identity in the collection.
Required
nameFieldString
Defines the name of the field that contains the name of the identity in the collection.
Required
roleFieldString
Defines the name of the field that contains the role of the identity in the collection. If included, the role will be displayed on the org chart by default.
Optional
imageUrlFieldString
Defines the name of the field that contains the URL pointing to an image of the identity in the collection.
Optional
extraFieldsArray[String]
An array of names of other fields in the collection that should be included on the org chart. By default, these fields will not appear on the org chart directly but can be accessed in the data panel for the org chart to define if they should be displayed.
Optional
{
    "id": "orgChart1",
    "type": "orgChart",
    "position": {
        "x": 150,
        "y": 150
    },
    "collectionId": "org-chart-data",
    "idField": "Employee ID",
    "foreignKeyField": "Supervisor ID",
    "nameField": "Full Name",
    "roleField": "Role",
    "imageUrlField": "Image",
    "extraFields": ["Email", "Cell Phone", "Building"]
}