You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/grafer-points-data.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,7 @@ An array of point objects to be loaded into Grafer. The PointData property list
14
14
| Property | Type | Description |
15
15
| :--- | :--- | :--- |
16
16
| id | string - *optional*| Name of the point. Will be used as an ID when referencing point in node, edge, and label data. Will default to its index in the PointData array if left out. |
17
+
| parentId | string - *optional* | ID of the point which this point is the child of. Used to enable relative positioning of points and relative radius. Will default to *No Parent* if left out.
17
18
| x | number | X-Coordinate of the point. |
18
19
| y | number | Y-Coordinate of the point. |
19
20
| z | number - *optional*| Z-Coordinate of the point. Will default to 0 if left out. |
@@ -27,7 +28,19 @@ Data [mappings](../guides/mappings.md) are used to compute properties at runtime
27
28
| Property | Type | Description |
28
29
| :--- | :--- | :--- |
29
30
| id | (datum: PointData) => string - *optional*||
| radius | (datum: PointData) => number - *optional*||
36
+
37
+
### `options`
38
+
###### { [key: string]: any } - *optional*
39
+
40
+
An object containing configuration options for the points.
41
+
42
+
| Property | Type | Description |
43
+
| :--- | :--- | :--- |
44
+
| positionHierarchyType | HierarchyTypes | Changes how point hierarchies changes the point positions. See [HierarchyTypes](./hierarchy-types.md) for more information. |
45
+
| radiusHierarchyType | HierarchyTypes | Changes how point hierarchies changes the point radius. See [HierarchyTypes](./hierarchy-types.md) for more information. |
46
+
| maxHierarchyDepth | number | Sets the maximum hierarchy depth that any point will have. Defaults to 100. |
0 commit comments