A dataset display is the combination of a management bar with one or multiple data visualization types and a possible mechanism of pagination. The most common visualization types used are table, list, and card.
Check the Lexicon Dataset Display Pattern for a more in-depth look at the motivations and proper usage of this component.
Example
{call ClayDatasetDisplay.render}
{param actionItems: actionItemsWithQuickItems /}
{param creationMenu: creationMenuConfiguration /}
{param filterItems: listOfFilterMenuItems /}
{param items: itemsOfDataset /}
{param selectedView: 2 /}
{param searchActionURL: 'mySearchURL' /}
{param searchFormName: 'mySearchName' /}
{param searchInputName: 'mySearchInputName' /}
{param selectable: true /}
{param spritemap: spritemap /}
{param title: 'Group Header 1' /}
{param views: viewsList /}
{/call}
API
Property | Description | Type | Required | Default |
---|---|---|---|---|
_selectedItems |
The selected items of the item list. For internal purposes. | array|undefined | false | undefined |
_totalItems |
The total number of items in the item list. For internal purposes. | number|undefined | false | undefined |
actionItems |
List of items to display in the management toolbar actions menu. | array|undefined | false | [] |
creationMenu |
Configuration of the management bar plus button. | object|string|bool|undefined | false | undefined |
data |
Data to add to the element. | object | false | undefined |
defaultEventHandler |
Object that wires events with default listeners | object|undefined | false | undefined |
elementClasses |
CSS classes to be applied to the element. | string|undefined | false | undefined |
filterItems |
List of filter menu items. | array|undefined | false | undefined |
filterLabels |
List of filter label items. | array|undefined | false | undefined |
id |
Id to be applied to the element. | string|undefined | false | undefined |
items |
Items of the dataset. | array|undefined | false | undefined |
searchActionURL |
URL of the search form action | string|undefined | false | undefined |
searchFormName |
Name of the search form. | string|undefined | false | undefined |
searchInputName |
Name of the search input. | string|undefined | false | undefined |
selectable |
Flag to indicate if the dataset is selectable. | bool | false | false |
selectedView |
Position in the views list of the selected view. | number|undefined | false | undefined |
showCreationMenu |
Flag to indicate if management toolbar creation menu button should be shown or not. | bool | false | true |
showFiltersDoneButton |
Flag to indicate if the | bool | false | true |
sortingOrder |
Sorting order. | string|undefined | false | asc |
spritemap |
The path to the SVG spritemap file containing the icons. | string | true | undefined |
title |
Header of the list. | string|undefined | false | undefined |
views |
List of view items. | array|undefined | false | undefined |