Property description

The template-settings component defines layout settings.

Example

Minimal JSON

{
  "type": "template-settings"
}
{
  "key": "parent_object_settings",
  "template": {
    "type": "template-settings",
    "rightPanelClosed": false,
    "hide": {
      "attachments": true,
      "changes": false,
      "commentSection": true,
      "concepts": true,
      "editButton": true,
      "favouriteButton": false,
      "hideEmptyAttributesButton": true,
      "shareObject": false,
      "watchingButton": true,
      "workflowStatus": true,
      "likeButton": true,
      "anchors": true,
      "updated": true,
      "created": true,
      "moveObject": true,
      "renameObject": true,
      "removeObject": true,
      "jiraSearch": true
    }
  }
}

JSON 3

{
  "componentId": "kpi#settings",
  "type": "template-settings",
  "header": {
    "fullnessAttributeTypeKey": "`core_fullness_score`",
    "layout": "default"
  },
  "hide": {
    "export": true
  },
  "layout": "default",
  "attributeLayout": "single-row"
}

Nested properties

PropertyDescriptionValuesMandatory
typetemplate-settingsstringYes
attributeLayoutLayout of attribute cards. Supported values are: multiline: Attribute type and value are on a separate line., single-row: Default value. Attribute type and value are on the same line.stringNo
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
headerConfigures the object page header area using the following properties: descriptionAttributeTypeKey: Includes a description stored in an attribute., fullnessAttributeTypeKey: Includes a fullness score, providing a visual metric for completeness., layout: Configures the icons in the object header. Supported values are:default: Header contains like/dislike, favorite, and watch buttons, workflow state, fullness score, etc., documentation: Removes the header for a wiki-like layout with only the object name, creation timestamp, last updated timestamp, author, and workflow state visible.jsonNo
hideList of boolean values indicating whether each component should be hidden ("component": true) or visible ("component": false): anchors: Removes heading anchors., attachments: Disables adding attachments., changes: Hides the change history section., commentSection: Disables the comment section on the page., concepts: Disables creating concepts., created: Hides the information about who created the object., editButton: [Obsolete] Removes the edit button for the whole object page., export: Hides the export button on the object page., favouriteButton: Disables the option to mark the object as a favorite., hideEmptyAttributesButton: [Obsolete] Hides empty attributes., jiraSearch: If Jira integration is enabled, removes the button that looks the object up in Jira., likeButton: Disables the like/dislike button for the object., moveObject: Hides the option to move the object to a different location from the object settings., removeObject: Disables the option to delete the object., renameObject: Disables the ability to rename the object., shareObject: Disables the object share option., updated: Hides the information about who last updated the object., watchingButton: Disables the button to follow/watch changes to the object., workflowStatus: Removes the workflow status.jsonNo
layoutDetermines the overall look of the object type page. Supported values are: default: Components are in panels with borders., single-row: Removes borders around panels on the page.stringNo
rightPanelClosedDetermines whether the right panel (configured by the rightArea) is closed by default.booleanNo