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.

Nested properties

PropertyDescriptionValueMandatory
typeDiagram type. Supported options are: object-relations: A relations diagram.componentLibrary_relations_diagram_object-relations.pngdiagram: A data lineage or entity relations diagram.string in (“object-relations”, “diagram”)Yes
titleTranslation 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.stringNo
defaultDefault behavior of lineage diagrams.arrayNo
isDefaultSpecifies whether this diagram is set as the default.booleanNo
metamodelKeyUsed 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.componentLibrary_relations_diagram_data-lineage.pngCustom 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