Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.42 KB

grafer-points-data.md

File metadata and controls

33 lines (24 loc) · 1.42 KB

GraferPointsData

This datatype is an object containing both an array of point data and an object with data mappings.


Properties

data

PointData[] - optional

An array of point objects to be loaded into Grafer. The PointData property list is given below:

Property Type Description
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.
x number X-Coordinate of the point.
y number Y-Coordinate of the point.
z number - optional Z-Coordinate of the point. Will default to 0 if left out.
radius number - optional Z-Coordinate of the point. Will default to 0 if left out.

mappings

PointDataMappings - optional

Data mappings are used to compute properties at runtime using information provided in the data array. The default mappings use property names specified in the PointData datatype. See data property for explanations of properties mapped.

Property Type Description
id (datum: PointData) => string - optional
x (datum: PointData) => number - optional
y (datum: PointData) => number - optional
z (datum: PointData) => number - optional
radius (datum: PointData) => number - optional