Class ProjectAbstract

Static baseURL

Static graphInstancesToResync

Static mode

Static resources

Static scriptNamespaces

Static serialization

Static clear

• clear(): void

• Clears the list of resources and their serialization, thus removing all resources.

  Returns void

Static clearScriptNamespaces

• clearScriptNamespaces(): void

• Clear the list of script-namespaces.

  Returns void

Static cloneResource

• cloneResource(_resource): Promise<SerializableResource>

• Parameters

  • _resource: SerializableResource

  Returns Promise<SerializableResource>

Static createGraphInstance

• createGraphInstance(_graph): Promise<GraphInstance>

• Creates and returns a GraphInstance of the given Graph and connects it to the graph for synchronisation of mutation.

  Parameters

  • _graph: Graph

  Returns Promise<GraphInstance>

Static deregister

• deregister(_resource): void

• Removes the resource from the list of resources.

  Parameters

  • _resource: SerializableResource

  Returns void

Static deserialize

• deserialize(_serialization): Promise<Resources>

• Create resources from a serialization, deleting all resources previously registered

  Parameters

  • _serialization: SerializationOfResources

  Returns Promise<Resources>

Static generateId

• generateId(_resource): string

• Generate a user readable and unique id using the type of the resource, the date and random numbers

  Parameters

  • _resource: SerializableResource

  Returns string

Static getComponentScripts

• getComponentScripts(): ComponentScripts

• Collects all ComponentScripts registered in Project.scriptNamespaces and returns them.

  Returns ComponentScripts

Static getResource

• getResource(_idResource): Promise<SerializableResource>

• Retrieves the resource stored with the given id

  Parameters

  • _idResource: string

  Returns Promise<SerializableResource>

Static getResourcesByName

• getResourcesByName(_name): SerializableResource[]

• Returns an array of all resources with the requested name.

  Parameters

  • _name: string

  Returns SerializableResource[]

Static getResourcesByType

• getResourcesByType<T>(_type): SerializableResource[]

• Returns an array of all resources of the requested type.

  Type Parameters

  • T

  Parameters

  • _type: (new (_args) => T)
    • • new (_args): T

      • Parameters

        • _args: any

        Returns T

  Returns SerializableResource[]

Static isResource

• isResource(_object): boolean

• Tests, if an object is a SerializableResource

  Parameters

  • _object: Serializable

    The object to examine

  Returns boolean

Static loadResources

• loadResources(_url): Promise<Resources>

• Load Resources from the given url

  Parameters

  • _url: RequestInfo

  Returns Promise<Resources>

Static loadResourcesFromHTML

• loadResourcesFromHTML(): Promise<void>

• Load all resources from the document.head

  Returns Promise<void>

Static loadScript

• loadScript(_url): Promise<void>

• Loads a script from the given URL and integrates it into a HTMLScriptElement in the document.head

  Parameters

  • _url: RequestInfo

  Returns Promise<void>

Static register

• register(_resource, _idResource?): void

• Registers the resource and generates an id for it by default.
  If the resource already has an id, thus having been registered, its deleted from the list and registered anew. It's possible to pass an id, but should not be done except by the Serializer.

  Parameters

  • _resource: SerializableResource
  • Optional _idResource: string

  Returns void

Static registerAsGraph

• registerAsGraph(_node, _replaceWithInstance?): Promise<Graph>

• Creates and registers a resource from a Node, copying the complete graph starting with it

  Parameters

  • _node: Node

    A node to create the resource from
  • _replaceWithInstance: boolean = true

    if true (default), the node used as origin is replaced by a GraphInstance of the Graph created

  Returns Promise<Graph>

Static registerGraphInstanceForResync

• registerGraphInstanceForResync(_instance): void

• Register the given GraphInstance to be resynced

  Parameters

  • _instance: GraphInstance

  Returns void

Static registerScriptNamespace

• registerScriptNamespace(_namespace): void

• Register the given namespace to the list of script-namespaces.

  Parameters

  • _namespace: Object

  Returns void

Static resyncGraphInstances

• resyncGraphInstances(_graph): Promise<void>

• Resync all GraphInstance registered to the given Graph

  Parameters

  • _graph: Graph

  Returns Promise<void>

Static serialize

• serialize(): SerializationOfResources

• Serialize all resources

  Returns SerializationOfResources