Property description
The diagramTypes property defines the type of diagram used to visualize relations.
Minimal JSON
{
"type": ""
}{
"key": "data_lineage_relations_diagram_generic",
"template": {
"componentId": "template#data_lineage_relations_diagram_generic",
"type": "relations",
"diagramTypes": [
{
"type": "diagram",
"metamodelKey": "data_lineage",
"title": "template.relations_data_lineage_diagram",
"isDefault": true
},
{
"type": "object-relations",
"title": "template.relations_object_relations_diagram"
}
]
}
}Example taken from the core package.
Warning
A diagram of type object-relations never renders hierarchy relations — relation types carrying the is_relation_type_child_of or is_relation_type_parent_of feature. Listing them in the component’s filter or filterOut has no effect, and they are not offered in the relation type filter of the Select object relations dialog.
Nested properties
| Property | Description | Value | Mandatory |
|---|---|---|---|
type | Diagram type. Supported options are: object-relations: A relations diagram. diagram: A data lineage or entity relations diagram. | string in (“object-relations”, “diagram”) | Yes |
title | Translation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the name property, if you use a specific string of text for the title, this text will appear with the package key. For example, Comment Section will be displayed as package_key_comment section. | string | No |
default | Default behavior of lineage diagrams. | array | No |
isDefault | Specifies whether this diagram is set as the default. | boolean | No |
metamodelKey | Used in case of a diagram. Specifies whether the diagram is a data lineage or entity relations diagram. Supported options are: data-lineage: A data lineage. Custom metamodelKey: Key of a metamodel defined by the user, e.g. entity-relation. | string in (“data-lineage” or another defined metamodel e.g. “entity-relation”) | No |