Property description

The displayLevels property determines the levels of your object hierarchy that are shown in your metamodel.

Minimal JSON

{
    "key": "",
    "name": "",
    "displayTypeKey": ""
}
{
    "key": "diagram",
    "displayLevels": [
        {
            "key": "diagram_simple",
            "name": "diagram_simple",
            "displayTypeKey": "simple",
            "isSingleHideable": false,
            "isSelfTargeting": false
        }
    ]
}

Example taken from the core package.

Nested properties

PropertyDescriptionValuesMandatory
keyUnique key of the asset. Used for referencing in the same package or other packages using packageKey#assetKey.stringYes
nameName of the asset, used as the default EN translation.stringYes
displayTypeKeyDefault level of displayed objects. See supported displayTypeKey values.stringYes
descriptionDescription of the property.stringNo
parentKeyKey of the parent level to the selected object types.stringNo
isSingleHideableDetermines whether the level can be hidden. Default is false.booleanNo
objectTypeKeysArray of object type keys visualized in the graph. Not used when the metamodel is defined in the object type graph display level property.arrayNo
stateCurrent status of the asset. Supported options are: active (asset is active and visible in the environment), inactive (asset is inactive and hidden, serves as a soft delete), hidden (asset is active but hidden in the environment).stringNo
translationsArray of translation keys and their definitions that determine how the text is displayed in the UI for the specific asset. For more information, see Translations.stringNo

Supported displayTypeKey values

ValueDescription
circleCircle shape.
columnTable or view column.
conceptual_folderFolder for conceptual models.
cylinderCylinder shape.
diamondDiamond shape.
er_columnEntity relation column.
er_objectEntity relation object.
folderFolder. In the graph, objects will be visualized inside their parents.
hexagonHexagon shape.
knowledge_objectUsed with knowledge graphs.
nonagonNonagon shape.
objectObject.
rhombusRhombus shape.
rightwards_stepRightwards step shape.
simpleSimple rectangle shape.
Tip

For more information, see Modeling diagrams.