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.
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 Format
Property | Description | |
---|---|---|
position | AbsolutePosition 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 |
collectionId | ID The id of the provided collection that the org chart will draw data from. | Required |
idField | String 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 |
foreignKeyField | String Defines the name of the field in the collection that references the value of the idField of another identity in the collection. | Required |
nameField | String Defines the name of the field that contains the name of the identity in the collection. | Required |
roleField | String 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 |
imageUrlField | String Defines the name of the field that contains the URL pointing to an image of the identity in the collection. | Optional |
extraFields | Array[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"]
}
Updated 28 days ago