Plugin API

Api for accessing the Datamodel

Note that this always already contains all changes when the Plugin scripts are executed

Hierarchy

  • DataModel

Index

Methods

Methods

create

  • Creates a new object of the given type in the model and returns it.

    Parameters

    Returns BuildingBlock

findByType

  • Ge an array containing all Building Block objects of the given type in the model.

    Parameters

    Returns BuildingBlock[]

findByTypeAndId

  • Get a Building Block object with the given type and id. Null if there is no such object.

    Parameters

    • typePersistentName: BuildingBlockType

      Persistent name of the building block type

    • id: number

      Id of the building block

    Returns BuildingBlock | null

findByTypeAndName

  • Get a Building Block object with the given type and name. Null if there is no such object.

    Parameters

    • typePersistentName: BuildingBlockType

      Persistent name of the building block type

    • name: string

      Name of the building block

    Returns BuildingBlock | null

getAllPropertyNamesByType

  • Get the names of all properties of a Building Block Type.

    Parameters

    Returns string[]

getAllRelationNamesByType

  • Get the names of all relation ends connected to the Building Block Type.

    Parameters

    Returns string[]

getAllTypeNames

  • Names of all Building Block Types in the metamodel.

    Returns BuildingBlockType[]

Legend

Generated using TypeDoc