TableHeaderLayout

The component TableHeaderLayout is a table header that is built based on an object renderer configuration. Each column can be sortable, this can be configured either in the SearchSetActor, or in the sortFieldOptions.

Properties

• HTMLElement

  • BaseComponent
    • Component

• Element tag: cm4ap-table-header-layout

Parameter

Parameters In the Layout

Name	Type	Description
relationActor	RelationActor	Contains the relation's attributes.
listActor	ListActor	The actor is used for the visibility of the component and for the item marking.
rendererName	string fallback: If SearchSetActor is defined, depending on content searchResultGridRenderer or subpanelGridRenderer If RelationActor is defined 'subpanel/' + relationName default	Name of the renderer that is loaded to display the table header.
correspondingList	string	The list component id defined in the layout configuration. The list component is used to check the width of the header component.
moduleName	string fallback: If Actor RelationActor is defined, the attributes targetModule or moduleName from the actor If Actor SearchActor is defined, the attributes targetModule or module from the actor module of context	The module for which renderer configuration is loaded
searchSetActor	SearchSetActor	The actor is needed to get the sorting fields and renderer name.
searchActor	SearchActor	The actor is needed to get the current search sort and the module name.
selectionActor	SelectionActor	The actor is needed to mark the items and to be able to react to the item marking.
sortFieldOptions	array of (string or FieldOptions)	The field names or information of sortable fields
hideCheckbox default: false	boolean	Defines whether the marking CheckBox should be hidden.
preserveCheckboxSpace	boolean default: true	Defines whether the space from the marking CheckBox should be kept after hiding.

Field Options

Name	Type	Description
field (required)	string	Field name
label (required)	string	text or label key
translate (optional)	boolean	Defines whether the text should be translated