Component description

The relations component configures a group of visual elements that adds and displays relations between objects. The visual appearance is based on the selected elementType.

Minimal JSON

{
  "type": "relations"
}
{
  "key": "data_lineage_relations_diagram_generic",
  "template": {
    "componentId": "template#data_lineage_relations_diagram_generic",
    "type": "relations",
    "title": "template.data_lineage_object_relations",
    "elementType": "diagram",
    "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

PropertyDescriptionValuesMandatory
typerelationsstringYes
attributesArray of attribute types of target objects that should be displayed in the element.arrayNo
componentIdUnique ID of a component. If left empty, a random string will be generated. Primarily used in patch packages to define the component's position within the layout (template).stringNo
defaultSortDefault column used to sort the table.arrayNo
diagramTypesDiagram type. Used for diagram element type.arrayNo
elementTypeType of visual element used to display the relations. For supported element types, see this section. If not specified, grouped-list will be the default value.string*No
filterConfigures filters selecting which relations or objects can be displayed.arrayNo
filterOutConfigures filters selecting which relations or objects cannot be displayed.arrayNo
hideHides relations from specifics spaces or applications.arrayNo
isConditionalDetermines whether the selection of the relations depends on specific conditions. Used in combination with certain filters.booleanNo
isMultiselectDetermines whether the component allows the bulk selection of relations.booleanNo
levelsNumber of levels displayed that can be displayed.integerNo
queryQuery for the component. Supported values are: default, distinctstring in (“default”, “distinct”)No
settingsConfigures the element behavior.arrayNo
startingLevelLevel which is displayed by default.integerNo
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
valuesArray of selected object type relations keys (no other relation type will be displayed).arrayNo

*Supported elementType values

elementTypeDescription
tableTable of all objects related to the current object. componentLibrayy_relations_table.png
static-tableA read-only table of all objects related to the current object. Visually looks the same as table but does not allow adding relations. static-table.png
grouped-listList of all objects, grouped by relation type, related to the current object. Default option. grouped-list.png
static-grouped-listA read-only list of all objects, grouped by relation type, related to the current object. Visually looks the same as grouped-list but does not allow adding relations.
simple-relationList of related objects. Visually similar to grouped-list. simple-relation.png
diagramVisual diagram of relations. For more information and examples, see Diagram Types.
child-relations-tableTable with objects that are related to its child object(s). Visually looks the same as table.