Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 1.71 KB

grafer-layer-data.md

File metadata and controls

51 lines (30 loc) · 1.71 KB

GraferLayerData

This datatype is an object holding data for a single layer, which consists of at least one node property, edge property, or label property, in addition to corresponding parameters and options. It is not valid to omit all three data properties.


Properties

name

string - optional

An identifier unique to layer, used to manipulate layer after initiation. If none is provided, then a default name will be given Layer_i where i is the index of the layer in the layer list.

nodes

GraferNodesData - optional

An object containing node data along with related option data.

See GraferNodesData for more information.

edges

GraferEdgesData - optional

An object containing edge data along with related option data.

See GraferEdgesData for more information.

labels

GraferLabelsData - optional

An object containing label data along with related option data.

See GraferLabelsData for more information.

options

An object containing configuration options for the layer.

Property Type Description
enabled boolean Hides or shows the layer.
nearDepth number Takes a range between 0 - 1. Defaults to 0. Controls camera near depth.
farDepth number Takes a range between 0 - 1. Defaults to 1. Controls camera far depth.
glow number Takes a range between 0 - 1. Defaults to 0. Controls strength of the glow effect applied to all elements in the layer. If 0 no glow affect is applied. The larger the number the more diffuse the glow effect becomes.