Obj
Base object.
- have unique id
- have parent and children
- can be serialized (store and copy-paste)
- can be traversed
Extended by
Constructors
new Obj()
new Obj():
Obj
Returns
Source
Properties
children
children:
Obj[]
Source
id
id:
string
Source
parent
parent:
null|Obj
Source
type
type:
string
Source
Methods
find()
find(
pred):null|Obj
Find an shape in breath-first order
Parameters
• pred
Returns
null | Obj
Source
findDepthFirst()
findDepthFirst(
pred):null|Obj
Find an shape in depth-first order
Parameters
• pred
Returns
null | Obj
Source
findParent()
findParent(
pred):null|Obj
Find a shape along with the parent-chain
Parameters
• pred
Returns
null | Obj
Source
fromJSON()
fromJSON(
json):void
Parameters
• json: any
Returns
void
Source
getJson()
getJson(
json,field,defaultValue):any
Get a field from the JSON object, return defaultValue if the field is not defined.
Parameters
• json: any
• field: string
• defaultValue: any
Returns
any
Source
isDescendant()
isDescendant(
obj):boolean
Test whether the given shape is a descendant
Parameters
• obj: Obj
Returns
boolean
Source
resolveRefs()
resolveRefs(
idMap,nullIfNotFound):void
Resolve references
Parameters
• idMap: Record<string, Obj>
id to object map
• nullIfNotFound: boolean= false
assign null if not found
Returns
void
Source
setJson()
setJson(
json,field,value,defaultValue,enforce):void
Set a field in the JSON object only if the value is defined and not equal to the default value.
Parameters
• json: any
The JSON object to set the field in.
• field: string
The field name to set.
• value: any
The value to set.
• defaultValue: any
The default value to compare against.
• enforce: boolean= false
If true, the field will be set even if it is equal to the default value.
Returns
void
Source
toJSON()
toJSON(
recursive,keepRefs,enforce):any
Parameters
• recursive: boolean= false
• keepRefs: boolean= false
• enforce: boolean= false
Returns
any
Source
traverse()
traverse(
fun,parent):void
Traverse all objects in breath-first order
Parameters
• fun
• parent: null | Obj= null
Returns
void
Source
traverseDepthFirst()
traverseDepthFirst(
fun,parent):void
Traverse all shapes in depth-first order
Parameters
• fun
• parent: null | Obj= null
Returns
void
Source
traverseDepthFirstSequence()
traverseDepthFirstSequence():
Obj[]
Returns an array of shapes in order of traverse sequence.
Returns
Obj[]
Source
traverseSequence()
traverseSequence():
Obj[]
Returns an array of shapes in order of traverse sequence.
Returns
Obj[]