Lua API

Node

Node

A Node is returned from requests such as NodeGet but can also be returned as a list from requests such as NodesGet, NodeGetNeighbors, etc.

getId

Retrieve the id of the Node

Number Node:getId()

Example:


node = NodeGet("Node", "Max")
node:getId()

getTypeId

Retrieve the type id of the Node

Number Node:getTypeId()

Example:


node = NodeGet("Node", "Max")
node:getTypeId()

getType

Retrieve the type of the Node

String Node:getType()

Example:


node = NodeGet("Node", "Max")
node:getType()

getKey

Retrieve the key of the Node

String Node:getKey()

Example:


node = NodeGet("Node", "Max")
node:getKey()

getProperties

Retrieve the properties of the Node

Table Node:getProperties()

Example:


node = NodeGet("Node", "Max")
node:getProperties()

getProperty

Retrieve a property of the Node

sol::object Node:getProperty(String)

Example:


node = NodeGet("Node", "Max")
node:getProperty("name")