ListViewModel

Interface representing for the ListView class.

Properties

animation ListViewAnimationSettings

Specifies options to customize the animation effect on adding and removing list view items.

Default: { effect: 'SlideLeft', duration: 400, easing: 'ease' }

checkBoxPosition CheckBoxPosition

Specifies the position of the checkbox.

Default: Left

cssClass AnimationSettingsModel

Specifies CSS classes to customize the appearance of the control.

Default: ""

dataStore [{}] String[] Number[] DataStore

Specifies the data store for the accordion items.

Default: []

enabled Boolean

Specifies whether the control is enabled or disabled, disabled will prevent user interaction.

Default: true

enableHtmlSanitizer Boolean

Specifies whether to allow the rendering of untrusted HTML and JavaScript values withing the control. When true, any untrusted strings or scripts will be remote before rendering.

Default: false

enableRtl Boolean

Specifies whether to render the control in right to left direction.

Default: false

enableState Boolean

Specifies whether to persist the state of the control between page loads.

The following properties will be saved to state.
  • animation
  • cssClass
  • checkBoxPosition
  • enabled
  • fields
  • headerTitle
  • height
  • htmlAttributes
  • showCheckbox
  • showIcon
  • sortOrder
  • selectedId
  • width

Default: false

enableVirtualization Boolean

Specifies whether to enable virtualization to improve the performance of the list view when loading a large amount of data.

Default: false

fields FieldSettingsModel

Specifies a template to customize the dialog's footer. When a footer template if set the buttons will not be rendered.

Default: {}

groupTemplate Function

Specifies a template to customize the appearance of the list view group header.

Default: null

headerTemplate Function

Specifies a template to customize the appearance of the list view header.

Default: null

headerTitle String

Specifies the title of the header.

Default: ""

height String Number

Specifies the height of the control in either pixels, number, or percentage.

Default: ""

htmlAttributes {:}

Specifies additional HTML attributes, such as title, styles, class, id, and name, in a key-value pair format that will be appended to the HTML element. If both the property and equivalent HTML attributes are configured, then the control overrides the property value with the HTML attributes.

Default: {}

locale String

Specifies the culture and localization value for this control, overriding the globally defined value.

Default: en-US

query Query

Specifies a query that will be executed against the data source before the data source results are bound to the control.

Default: null

showCheckbox Boolean

Specifies whether to show or hide the checkbox for list view item selection.

Default: false

showHeader Boolean

Specifies whether to show or hide the header.

Default: false

showIcon Boolean

Specifies whether to show or hide the icon the list view icon.

Default: false

sortOrder SortOrder

Specifies whether to sort the list items in order or to leave the items in the order they were added.

Default: None

template Function

Specifies a template to customize the appearance of the list view items.

Default: null

width String Number

Specifies the width of the control in either pixels, number, or percentage.

Default: 100%

Events

actionBegin EmitType<Object>

Event callback that is raised before retrieving data from the data store.

actionComplete EmitType<Object>

Event callback that is raised after data has been retrieved from the data store.

actionFailure EmitType<Object>

Event callback that is raised when there is a failure in retrieving data from the data store.

created EmitType<CreatedEventArgs>

Event callback that is raised when the control has been created.

destroyed EmitType<Object>

Event callback that is raised when the control has been destroyed.

select EmitType<SelectEventArgs>

Event callback that is raised when a list view item is selected.