Home Reference Source
public class | source

Group

Extends:

Resource → Group

Direct Subclass:

Graph

Group (subgraph) model

Static Method Summary

Static Public Methods
public static

createTemplateInstances(json: *, modelClasses: *)

Generate group template instances

public static

expandGroupTemplates(json: *, modelClasses: *)

Generate groups from group templates, i.e.

public static

Create lyphs that inherit properties from templates

public static

fromJSON(json: *, modelClasses: *, entitiesByID: *): *

Create a graph model from the JSON specification

public static

Replicate border nodes and create collapsible links The effect of this procedure depends on the order in which lyphs that share border nodes are selected If the added dashed links create an overlap, one has to change the order of lyphs in the input file!

public static

replaceReferencesToTemplates(json: *, modelClasses: *)

Replace references to lyph templates with references to auto-generated lyphs that inherit properties from templates

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
public get

activeGroups: T[]: *

Groups that can be toggled on or off in the global graph

public get
public get

resources: *[]: *

Entities that belong to the group (resources excluding subgroups)

public get

visibleLinks: *[]: *

Visible links

public get
public get

visibleNodes: T[]: *

Visible nodes

public get

visibleRegions: *[]: *

Visible regions

public

тзь: *

Method Summary

Public Methods
public

hide()

Hide current group (=hide all its entities)

public

Add entities from subgroups to the current group

public

show()

Show current group (=show all its entities)

public

showGroups(groups: *)

Show subgroups of the current group.

public

Validate process edges

Inherited Summary

From class Resource
public static get

Model: *

public static

fromJSON(json: Object, modelClasses: Object, entitiesByID: Map<string, Resource>): Resource

Creates a Resource object from its JSON specification

public

id: *

public

assignPathProperties(modelClasses: Object)

Assign properties to the objects specified with the help of JSON path expressions in the resource 'assign' statements

public

assignPathRelationships(modelClasses: Object, entitiesByID: Map<string, Resource>)

Create relationships defined with the help of JSON path expressions in the resource 'assign' statements

public

containsMaterial(materialID: *): * | void | T

Checks if the current resource carries a material.

public

Assign properties to resources specified with the help of JSON path expressions in the resource 'interpolate' statements

public

isSubtypeOf(supertypeID: *): boolean

Checks if the current resource is derived from The method makes more sense for lyphs, but it is useful to be able to test any resource, this simplifies filtering

public

replaceIDs(modelClasses: Object, entitiesByID: Map<string, Resource>)

Replace IDs with object references

public

Waiting list keeps objects that refer to unresolved model resources.

public

syncRelationship(key: string, spec: Object, modelClasses: Object)

Synchronize a relationship field of the resource with its counterpart (auto-fill a field that is involved into a bi-directional relationship based on its partial definition, i.e., A.child = B yields B.parent = A).

public

syncRelationships(modelClasses: Object, entitiesByID: Map<string, Resource>)

Synchronize all relationship properties of the resource

public

toJSON(depth: *, initDepth: *): *

Prepare a circular resource object to be serialized in JSON.

Static Public Methods

public static createTemplateInstances(json: *, modelClasses: *) source

Generate group template instances

Params:

NameTypeAttributeDescription
json *

input model

modelClasses *

model resource classes

public static expandGroupTemplates(json: *, modelClasses: *) source

Generate groups from group templates, i.e. auto-create necessary nodes and links conveying given or generated lyphs

Params:

NameTypeAttributeDescription
json *

input model

modelClasses *

model resource classes

public static expandLyphTemplates(lyphs: *) source

Create lyphs that inherit properties from templates

Params:

NameTypeAttributeDescription
lyphs *

public static fromJSON(json: *, modelClasses: *, entitiesByID: *): * source

Create a graph model from the JSON specification

Override:

Resource#fromJSON

Params:

NameTypeAttributeDescription
json *

input model

modelClasses *

model resource classes

entitiesByID *

global map of model resources

Return:

*

Graph model - model suitable for visualization

public static replaceBorderNodes(json: *) source

Replicate border nodes and create collapsible links The effect of this procedure depends on the order in which lyphs that share border nodes are selected If the added dashed links create an overlap, one has to change the order of lyphs in the input file!

Params:

NameTypeAttributeDescription
json *

group model defined by user

public static replaceReferencesToTemplates(json: *, modelClasses: *) source

Replace references to lyph templates with references to auto-generated lyphs that inherit properties from templates

Params:

NameTypeAttributeDescription
json *

input model

modelClasses *

model resource classes

Public Constructors

public constructor() source

Override:

Resource#constructor

Public Members

public [property]: * source

public get activeGroups: T[]: * source

Groups that can be toggled on or off in the global graph

Return:

T[]

public get create3d: * source

public get resources: *[]: * source

Entities that belong to the group (resources excluding subgroups)

Return:

*[]

Visible links

Return:

*[]

public get visibleLyphs: * source

public get visibleNodes: T[]: * source

Visible nodes

Return:

T[]

public get visibleRegions: *[]: * source

Visible regions

Return:

*[]

public тзь: * source

Public Methods

public hide() source

Hide current group (=hide all its entities)

public mergeSubgroupEntities() source

Add entities from subgroups to the current group

public show() source

Show current group (=show all its entities)

public showGroups(groups: *) source

Show subgroups of the current group. A resources is shown if it belongs to at least one visible subgroup

Params:

NameTypeAttributeDescription
groups *

selected subgroups

public validateProcessEdges() source

Validate process edges