An object defining configuration properties for the TileView UI component.
Specifies the shortcut key that sets focus on the UI component.
Selector: access-key
Default Value: undefined
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
Specifies whether the UI component changes its visual state as a result of user interaction.
Selector: active-state-enabled
Default Value: true
The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.
Use this property when you display the component on a platform whose guidelines include the active state change for UI components.
Specifies the height of the base tile view item.
Selector: base-item-height
Default Value: 100
The actual item height equals the heightRatio field value of an item multiplied by the value of this property.
Specifies the width of the base tile view item.
Selector: base-item-width
Default Value: 100
The actual item width equals the widthRatio value of an item multiplied by the value of this property.
Binds the UI component to data.
Selector: data-source
Default Value: null
The TileView works with collections of string
values or objects.
Depending on your data source, bind TileView to data as follows. If the data source provides objects, also specify the itemTemplate. You can skip this part if the objects contain fields described in the items section.
Data Array
Assign the array to the dataSource option.
Read-Only Data in JSON Format
Set the dataSource property to the URL of a JSON file or service that returns JSON data.
OData
Implement an ODataStore.
Web API, PHP, MongoDB
Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:
Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.
jQuery$(function() { let serviceUrl = "https://url/to/my/service"; $("#tileViewContainer").dxTileView({ // ... dataSource: DevExpress.data.AspNet.createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) }) });Angular
import { Component } from '@angular/core'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { store: CustomStore; constructor() { let serviceUrl = "https://url/to/my/service"; this.store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) } }
<dx-tile-view ... [dataSource]="store"> </dx-tile-view>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxTileViewModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxTileViewModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxTileView ... :data-source="store" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import { DxTileView } from 'devextreme-vue/tile-view'; export default { components: { DxTileView }, data() { const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); return { store } } } </script>React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import TileView from 'devextreme-react/tile-view'; const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); class App extends React.Component { render() { return ( <TileView ... dataSource={store} /> ); } } export default App;
Any other data source
Implement a CustomStore.
Regardless of the data source on the input, the TileView always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.
Review the following notes about data binding:
Do not specify the items property if you specified the dataSource, and vice versa.
Field names cannot be equal to this
and should not contain the following characters: .
, :
, [
, and ]
.
TileView does not execute dataSource.sort functions. To implement custom sorting logic, implement columns[].calculateSortValue.
Specifies whether the UI component is oriented horizontally or vertically.
Default Value: 'horizontal'
Specifies whether the UI component responds to user interaction.
Specifies the global attributes to be attached to the UI component's container element.
Selector: DxElementAttr
Default Value: {}
jQuery$(function(){ $("#tileViewContainer").dxTileView({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });Angular
<dx-tile-view ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-tile-view>
import { DxTileViewModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxTileViewModule ], // ... })Vue
<template> <DxTileView ... :element-attr="tileViewAttributes"> </DxTileView> </template> <script> import DxTileView from 'devextreme-vue/tile-view'; export default { components: { DxTileView }, data() { return { tileViewAttributes: { id: 'elementId', class: 'class-name' } } } } </script>React
import React from 'react'; import TileView from 'devextreme-react/tile-view'; class App extends React.Component { tileViewAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <TileView ... elementAttr={this.tileViewAttributes}> </TileView> ); } } export default App;
Specifies whether the UI component can be focused using keyboard navigation.
Selector: focus-state-enabled
Default Value: true (desktop)
Specifies the UI component's height.
This property accepts a value of one of the following types:
Number
The height in pixels.
String
A CSS-accepted measurement of height. For example, "55px"
, "20vh"
, "80%"
, "inherit"
.
This property does not support the value "auto"
.
Specifies text for a hint that appears when a user pauses on the UI component.
Specifies whether the UI component changes its state when a user pauses on it.
Selector: hover-state-enabled
Default Value: true
The time period in milliseconds before the onItemHold event is raised.
Selector: item-hold-timeout
Default Value: 750
Specifies the distance in pixels between adjacent tiles.
Selector: item-margin
Default Value: 20
An array of items displayed by the UI component.
The items array can contain:
If you need to update the UI component items, reassign the entire items array as shown in the following example:
tileViewInstance.option('items', newItems);
As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.
Do not use the items property if you use dataSource, and vice versa.
Specifies a custom template for items.
Selector: item-template
Template Data:The item object to be rendered.
Default Name: 'item'
Specifies the text or HTML markup displayed by the UI component if the item collection is empty.
Selector: no-data-text
Default Value: 'No data to display'
The TileView component evaluates the noDataText property's value. This evaluation, however, makes the TileView potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the noDataText property. Refer to the following help topic for more information: Potentially Vulnerable API - noDataText.
A function that is executed when the UI component is rendered and each time the component is repainted.
Selector: @content-ready
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed before the UI component is disposed of.
Selector: @disposing
Function parameters:Information about the event.
Object structure:
Default Value: null
A function used in JavaScript frameworks to save the UI component instance.
Selector: @initialized
Function parameters:Information about the event.
Object structure:
Default Value: null
Angular<dx-tile-view ... (onInitialized)="saveInstance($event)"> </dx-tile-view>
import { Component } from "@angular/core"; import TileView from "devextreme/ui/data_grid"; // ... export class AppComponent { tileViewInstance: TileView; saveInstance (e) { this.tileViewInstance = e.component; } }Vue
App.vue (Composition API)
<template> <div> <DxTileView ... @initialized="saveInstance"> </DxTileView> </div> </template> <script> import DxTileView from 'devextreme-vue/tile-view'; export default { components: { DxTileView }, data: function() { return { tileViewInstance: null }; }, methods: { saveInstance: function(e) { this.tileViewInstance = e.component; } } }; </script>
<template> <div> <DxTileView ... @initialized="saveInstance"> </DxTileView> </div> </template> <script setup> import DxTileView from 'devextreme-vue/tile-view'; let tileViewInstance = null; const saveInstance = (e) => { tileViewInstance = e.component; } </script>React
import TileView from 'devextreme-react/tile-view'; class App extends React.Component { constructor(props) { super(props); this.saveInstance = this.saveInstance.bind(this); } saveInstance(e) { this.tileViewInstance = e.component; } render() { return ( <div> <TileView onInitialized={this.saveInstance} /> </div> ); } }See Also jQuery
A function that is executed when a collection item is clicked or tapped.
Selector: @item-click
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed when a collection item is right-clicked or pressed.
Selector: @item-context-menu
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed when a collection item has been held for a specified period.
Selector: @item-hold
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed after a collection item is rendered.
Selector: @item-rendered
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed after a UI component property is changed.
Selector: @option-changed
Function parameters:Information about the event.
Object structure:
Name Type Description value anyThe modified property's new value.
previousValue anyThe UI component's previous value.
nameThe modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullNameThe path to the modified property that includes all parent properties.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
Default Value: null
The following example shows how to subscribe to component property changes:
jQuery$(function() { $("#tileViewContainer").dxTileView({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });Angular
<dx-tile-view ... (onOptionChanged)="handlePropertyChange($event)"> </dx-tile-view>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxTileViewModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxTileViewModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxTileView ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxTileView from 'devextreme-vue/tile-view'; export default { components: { DxTileView }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import TileView from 'devextreme-react/tile-view'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <TileView ... onOptionChanged={handlePropertyChange} /> ); }
Switches the UI component to a right-to-left representation.
Selector: rtl-enabled
Default Value: false
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
DataGrid Demo Navigation UI Demo Editors Demo
Specifies when the UI component shows the scrollbar.
Selector: show-scrollbar
Default Value: 'never', 'onScroll' (Mac, Android, iOS)
MacOS, iOS, and Android devices use native scrolling. 'onHover' and 'always' values do not have an effect in native scrolling mode, the component applies the 'onScroll' value instead.
Specifies the number of the element when the Tab key is used for navigating.
Selector: tab-index
Default Value: 0
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
Specifies whether the UI component is visible.
Specifies the UI component's width.
This property accepts a value of one of the following types:
Number
The width in pixels.
String
A CSS-accepted measurement of width. For example, "55px"
, "20vw"
, "80%"
, "auto"
, "inherit"
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4