Name | Type | Default | Description |
AddNewButton | bool | false | Toggles the button for adding new cards. |
AllowDrag | bool | false | Allows reordering by dragging cards. |
CardHeight | int? | N/A | Describes the height for each card. |
CellOrientation | Orientation | Orientation.Vertical | Describes the orientation of the card cells. |
Collapsible | bool | false | Allows collapsing the card content. |
Columns | IEnumerable<ICardViewColumn> | N/A | Describes the columns properties:- label - Sets the column name
- dataField - Sets the dataField name
- icon - Sets the icon for the column
- formatSettings - Sets the settings about the format for the current column
- formatFunction - Function for customizing the value
|
CoverField | string | """" | Describes which data field to be set as cover. |
CoverMode | CardViewCoverMode | CardViewCoverMode.Crop | Describes the cover image fit property. |
DataSource | object | N/A | Determines the data source for the item that will be displayed inside the card. |
DataSourceSettings | DataSourceSettings | N/A | Sets the grid's data source settings when the dataSource property is set to an Array or URL. |
Editable | bool | false | Allows the edit option for the cards. |
HeaderPosition | CardViewHeaderPosition | CardViewHeaderPosition.None | Sets or gets the header position. The header contains the Customize, Filter, Sort, and Search buttons. |
Locale | string | "en" | Sets or gets the locale. Used in conjunction with the property messages. |
Messages | object | N/A | Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. |
RightToLeft | bool | false | Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. |
Theme | string | "" | Determines the theme. Theme defines the look of the element |
Scrolling | Scrolling | Scrolling.Physical | Describes the scrolling behavior of the element. |
TitleField | string | "" | Describes which data field to be set as title. |
Name | Type | Arguments | Description |
AddFilter | void | string[] filters, string operatorArg | Adds filteringArgs: string[] filters - Filter information,string operator - Logical operator between the filters of different fields |
AddFilter | void | string[] filters | Adds filtering |
AddRecord | void | object recordId, object data, string position | Adds a new recordArgs: object recordId - The id of the record to add,object data - The data of the record to add,string position - The position to add the record to. Possible values: 'first' and 'last'. |
AddRecord | void | N/A | Adds a new record |
AddSort | void | IEnumerable<object> dataFields, IEnumerable<object> orderBy | Adds sortingArgs: string dataFields - The data field(s) to sort by,IEnumerable<object> orderBy - The sort direction(s) to sort the data field(s) by |
AddSort | void | string dataFields, string orderBy | Adds sortingArgs: string dataFields - The data field(s) to sort by,string orderBy - The sort direction(s) to sort the data field(s) by |
BeginEdit | void | object recordId | Begins an edit operationArgs: object recordId - The id of the record to edit |
BeginEdit | void | int recordId | Begins an edit operationArgs: int recordId - The id of the record to edit |
BeginEdit | void | string recordId | Begins an edit operationArgs: string recordId - The id of the record to edit |
CancelEdit | void | N/A | Ends the current edit operation and discards changes |
ClosePanel | void | N/A | Closes any open header panel (drop down) |
EndEdit | void | N/A | Ends the current edit operation and saves changes |
EnsureVisible | object | object recordId | Makes sure a record is visible by scrolling to it. If succcessful, the method returns the HTML element of the record's card.Args: object recordId - The id of the record to scroll to |
EnsureVisible | object | int recordId | Makes sure a record is visible by scrolling to it. If succcessful, the method returns the HTML element of the record's card.Args: int recordId - The id of the record to scroll to |
EnsureVisible | object | string recordId | Makes sure a record is visible by scrolling to it. If succcessful, the method returns the HTML element of the record's card.Args: string recordId - The id of the record to scroll to |
GetDataSourceAsync() | Task<IEnumerable<object>> | 'N/A' | Gets the "DataSource" property as Task<IEnumerable<object>>. |
OpenCustomizePanel | void | N/A | Opens the "Customize cards" header panel (drop down) |
OpenFilterPanel | void | N/A | Opens the "Filter" header panel (drop down) |
OpenSortPanel | void | N/A | Opens the "Sort" header panel (drop down) |
Refresh | void | 'N/A' | Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements. |
RemoveFilter | void | N/A | Removes filtering |
RemoveRecord | void | object recordId | Removes a recordArgs: object recordId - The id of the record to remove |
RemoveRecord | void | int recordId | Removes a recordArgs: int recordId - The id of the record to remove |
RemoveRecord | void | string recordId | Removes a recordArgs: string recordId - The id of the record to remove |
RemoveSort | void | N/A | Removes sorting |
Render | void | 'N/A' | Re-renders the Blazor Component. This method will make a full re-render. |
ShowColumn | void | string dataField | Shows a columnArgs: string dataField - The data field of the column |
StateHasChanged | void | 'N/A' | Refreshes the state and Re-renders the Blazor Component, if necessary. |
Name | Type | Description | Event Detail |
OnFilter | EventCallback<Event> | This event is triggered when a filter has been applied. | N/A |
Filtered | event CardViewFilteredEventHandler | This event is triggered when a filter has been applied. | CardViewFilteredEventArgs |
OnSort | EventCallback<Event> | This event is triggered when sorting has been applied. | N/A |
Sorted | event CardViewSortedEventHandler | This event is triggered when sorting has been applied. | CardViewSortedEventArgs |
OnOpen | EventCallback<Event> | This event is triggered when the window is opened. | N/A |
Opened | event CardViewOpenedEventHandler | This event is triggered when the window is opened. | CardViewOpenedEventArgs |
OnOpening | EventCallback<Event> | This event is triggered when the window is about to be opened. The opening operation can be canceled by calling event.preventDefault() in the event handler function. | N/A |
Opening | event CardViewOpeningEventHandler | This event is triggered when the window is about to be opened. The opening operation can be canceled by calling event.preventDefault() in the event handler function. | CardViewOpeningEventArgs |
OnClose | EventCallback<Event> | This event is triggered when the window is closed. | N/A |
Closed | event CardViewClosedEventHandler | This event is triggered when the window is closed. | CardViewClosedEventArgs |
OnClosing | EventCallback<Event> | This event is triggered when the window is about to be closed. The closing operation can be canceled by calling event.preventDefault() in the event handler function. | N/A |
Closing | event CardViewClosingEventHandler | This event is triggered when the window is about to be closed. The closing operation can be canceled by calling event.preventDefault() in the event handler function. | CardViewClosingEventArgs |
OnDragStart | EventCallback<Event> | This event is triggered when the user starts dragging the card. | N/A |
DragStarted | event CardViewDragStartedEventHandler | This event is triggered when the user starts dragging the card. | CardViewDragStartedEventArgs |
OnDragging | EventCallback<Event> | This event is triggered when the user is dragging the card. | N/A |
Dragging | event CardViewDraggingEventHandler | This event is triggered when the user is dragging the card. | CardViewDraggingEventArgs |
OnDragEnd | EventCallback<Event> | This event is triggered when the user dragged the card. | N/A |
DragEnded | event CardViewDragEndedEventHandler | This event is triggered when the user dragged the card. | CardViewDragEndedEventArgs |
Name | Type | Default | Description |
DataField | string | "" | Sets or gets the column's data source bound field. |
DataType | CardViewColumnDataType | CardViewColumnDataType.String | Sets or gets the column's data type. |
Icon | object | "" | Sets or gets the column's icon. Expects CSS class name. |
Image | bool | false | Sets or gets the column's image visibility. |
Label | string | "" | Sets or gets the text displayed in the column's header. |
Visible | bool | true | Sets or gets whether the column is visible. Set the property to 'false' to hide the column. |
FormatFunction | Action<object> | null | Sets or gets the column's format function. |
FormatSettings | object | new object() | Sets or gets the column's format settings. You can use any of the build in formatting options or to NumberFormat object like that: 'Intl: { NumberFormat: { style: \'currency\', currency: \'EUR\' }}' or DateTimeFormat object like that: 'Intl: { DateTimeFormat: { dateStyle: \'full\' }}'' |
Name | Type | Default | Description |
AutoGenerateColumns | bool | false | Sets or gets whether a column will be auto-generated. |
ChildrenDataField | string | "" | Sets or gets a children data field like 'children', 'items' in the data source. When this property is set, the component will look for this data field when looping through the items. If it is found a hierarchical data source would be created. |
Root | string | "" | Sets or gets the XML binding root. |
SanitizeHTML | DataSourceSettingsSanitizeHTML | DataSourceSettingsSanitizeHTML.BlackList | Sets or gets the XML binding root. |
Record | string | "" | Sets or gets the XML binding record. |
GroupBy | string[] | new string[]{} | Sets or gets the data fields to group by. |
DataFields | IEnumerable<IDataSourceSettingsDataField> | null | Sets or gets the data fields which decribe the loaded data and data type. Ex: ['id: number', 'firstName: string', 'lastName: string'] |
DataSourceType | DataSourceSettingsDataSourceType | DataSourceSettingsDataSourceType.Array | Sets or gets whether the data source type. |
Id | string | "" | Sets or gets the component's id |
KeyDataField | string | "" | Sets or gets the key data field to be used for building the hierarchy. It is used in combination with the parentDataField property. Usually the 'id' field is used as key data field and 'parentId' as parent data field' |
ParentDataField | string | "" | Sets or gets the parent data field to be used for building the hierarchy. It is used in combination with the keyDataField property. Usually the 'id' field is used as key data field and 'parentId' as parent data field' |
MapChar | string | "." | Sets the 'mapChar' data field of the record |
VirtualDataSource | object | null | Sets the virtual data source function which is called each time the Grid requests data. Demos using 'virtualDataSource' are available on the Grid demos page. |
VirtualDataSourceOnExpand | object | null | Sets the virtual data source on expand function. This function is called when we load data on demand in Tree or TreeGrid and virtualDataSource in these components is set, too |