Home Reference Source
public class | source

Region

Extends:

ResourceVisualResourceShape → Region

Class that models regions

Static Method Summary

Static Public Methods
public static

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

Create a Region resource from its JSON specification.

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.

From class VisualResource
public get

Determines whether the resource should appear in the scheme based on its 'hidden' attribute and other resource dependencies

From class Shape
public static

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

Create a Shape resource from its JSON specification together with resources to model shape borders.

Static Public Methods

public static fromJSON(json: Object, modelClasses: Object, entitiesByID: Map<string, Resource>): Shape source

Create a Region resource from its JSON specification. The method checks and sets default values to the region corner points if they are undefined.

Override:

Shape#fromJSON

Params:

NameTypeAttributeDescription
json Object

resource definition

modelClasses Object
  • optional

map of class names vs implementation of ApiNATOMY resources

entitiesByID Map<string, Resource>
  • optional

map of resources in the global model

Return:

Shape

ApiNATOMY Shape resource