jQuery/JS Common - Object Structures
This section describes the structure of the objects that are used in API multiple times as function parameters or property values.
BarGaugeLegendItem
An object that provides information about a legend item in the BarGauge UI component.
BaseChartLegendItem
An object that provides information about a legend item in the Chart and PolarChart UI components.
device
This object is returned by the DevExpress.devices.current() and DevExpress.devices.real() methods to provide information on the device on which the application is currently running. Use the fields of this object to get the required information on the device.
You can emulate as if the application runs on another device. For this purpose, use the DevExpress.devices.current() function passing the required device object as a parameter.
The information on the device on which the application is currently running is used to provide an appropriate look and feel for the application. In particular, the styles that are most appropriate for the current device will be applied.
dxDiagramConnector
An object that provides information about a connector in the Diagram UI component.
dxDiagramCustomCommand
An object that provides information about a custom command in the Diagram UI component.
dxDiagramItem
An object that provides information about an item (shape or connector) in the Diagram UI component.
ExcelExportDataGridProps
Properties that can be passed to the exportDataGrid(options) method from the excelExporter module.
ExcelExportPivotGridProps
Properties that can be passed to the exportPivotGrid(options) method from the excelExporter module.
FileSystemItem
An object that provides information about a file system item (file or folder) in the FileManager UI component.
format
This property accepts three types of values:
String
A predefined format or custom format string.Function
Applies a custom format to a value and returns this value as a string. A shortcut for the formatter property.Object
Allows you to configure the format. Can have one of the following structures:// Uses a predefined format format: { type: String, // one of the predefined formats precision: Number, // the precision of values currency: String // a specific 3-letter code for the "currency" format }or
// Specifies a custom format format: { formatter: Function, // a custom formatting function parser: Function // a parsing function for string values }You can specify the Intl NumberFormat's and DateTimeFormat's
optionsparameter fields:format: { year: "2-digit", month: "narrow", day: "2-digit" } === or === format: { style: "currency", currency: "EUR", useGrouping: true }If you use Globalize, you can use the fields the numberFormatter, currencyFormatter, and dateFormatter accept instead of the fields described in this section. For example, you can use skeletons to format dates. Note that this approach can require additional CLDR modules not shipped with the DevExtreme package.
format: { skeleton: 'GyMMMd' }
FunnelLegendItem
An object that provides information about a legend item in the Funnel UI component.
globalConfig
Pass this object to the DevExpress.config(globalConfig) method to apply these setting, or call the same method without arguments to get the object with current settings.
DevExpress.config({
rtlEnabled: true,
forceIsoDateParsing: false,
//...
});PdfExportDataGridProps
Properties that can be passed as a parameter to the exportDataGrid(options) method from the pdfExporter module.
PieChartLegendItem
An object that provides information about a legend item in the PieChart UI component.
positionConfig
Assign this object to the position property of an overlay UI component (Popup, Popover, Tooltip, etc.).
To position an element, specify the my, at, and of properties. In the following code, the Popup UI component's left side is aligned with the target's right side. This configuration reads as follows: "place my left side at the right side of the #target element."
jQuery
$(function() {
$("#popupContainer").dxPopup({
// ...
position: {
my: "left",
at: "right",
of: "#target"
}
});
});Angular
<dx-popup ... >
<dxo-position
my="left"
at="right"
of="#target">
</dxo-position>
</dx-popup>Vue
<template>
<DxPopup ... >
<DxPosition
my="left"
at="right"
of="#target"
/>
</DxPopup>
</template>
<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import DxPopup, {
DxPosition
} from 'devextreme-vue/popup';
export default {
components: {
DxPopup,
DxPosition
}
}
</script>React
import React from 'react';
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import Popup, {
Position
} from 'devextreme-react/popup';
class App extends React.Component {
render() {
return (
<Popup ... >
<Position
my="left"
at="right"
of="#target"
/>
</Popup>
);
}
}
export default App;You can use the offset property to further adjust the position.
Possible positions are limited by the Window. To limit them by another element, specify the boundary property. If actual boundaries should be narrower or wider than the boundary element, set the boundaryOffset.
When a specified position exceeds the boundaries, a collision occurs. Use the collision property to specify how such collisions should be resolved.
template
Templates are passed as properties that end with ...Template (in jQuery, Angular, and Vue) or ...Render/...Component (in React).
Each template has access to the following parameters:
data
A data source object or an object with fields specific to a particular template. For information on the contents ofdata, refer to the Template Data section of the template's API reference article.index
A zero-based index of the item in the collection. Available only in collection UI component templates.element
A jQuery element that represents the UI component element being customized. Available only if you use jQuery.
The following code shows how to declare a template and use these parameters. This code declares an itemTemplate for the List UI component:
jQuery
$(function() {
$("#listContainer").dxList({
items: [
{ itemProperty: "someValue" },
// ...
],
itemTemplate: function (data, index, element) {
return index + " - " + data.itemProperty;
// ===== or using the "element" parameter =====
const $item = $("<div>").text(
index + " - " + data.itemProperty
);
element.append($item);
}
});
});Angular
<dx-list
[items]="listData"
itemTemplate="list-item">
<div *dxTemplate="let data of 'list-item'; let index = index">
{{index}} - {{data.itemProperty}}
</div>
</dx-list>
import { Component } from '@angular/core';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
listData = [
{ itemProperty: "someValue" },
// ...
]
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxListModule } from 'devextreme-angular';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
DxListModule
],
providers: [ ],
bootstrap: [AppComponent]
})
export class AppModule { }Vue
<template>
<DxList
:items="listData"
item-template="list-item">
<template #list-item="{ data, index }">
{{ index }} - {{ data.itemProperty }}
</template>
</DxList>
</template>
<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import DxList from 'devextreme-vue/list';
export default {
components: {
DxList
},
data() {
return {
listData: [
{ itemProperty: 'someValue' },
// ...
]
}
}
}
</script>React
import React from 'react';
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import List from 'devextreme-react/list';
const renderListItem = (data, index) => {
return (
<div>{index} - {data.itemProperty}</div>
);
}
class App extends React.Component {
listData = [
{ itemProperty: 'someValue' },
// ...
];
render() {
return (
<List
items={this.listData}
itemRender={renderListItem}
/>
);
}
}
export default App;Collection UI components also support templates for individual items. Do not specify the UI component's dataSource property if you use individual templates.
jQuery
$(function() {
$("#listContainer").dxList({
items: [{
template: function () {
return $("<i>").text("Item 1")
}
}, {
template: function () {
return $("<b>").text("Item 2")
}
},{
template: function () {
return $("<div>").append(
$("<span>").text("Item with nested component"),
$("<div>").dxButton({
text: "Click me"
})
)
}
}]
});
});Angular
<dx-list>
<dxi-item>
<i>Item 1</i>
</dxi-item>
<dxi-item>
<b>Item 2</b>
</dxi-item>
<dxi-item>
<div *dxTemplate>
Item with a nested component
<dx-button text="Click me"></dx-button>
</div>
</dxi-item>
</dx-list>
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxListModule, DxButtonModule } from 'devextreme-angular';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
DxListModule,
DxButtonModule
],
providers: [ ],
bootstrap: [AppComponent]
})
export class AppModule { }Vue
<template>
<DxList>
<DxItem>
<template #default>
<i>Item 1</i>
</template>
</DxItem>
<DxItem>
<template #default>
<i>Item 2</i>
</template>
</DxItem>
<DxItem>
<template #default>
<div>
Item with a nested component
<DxButton text="Click me" />
</div>
</template>
</DxItem>
</DxList>
</template>
<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import DxList, {
DxItem
} from 'devextreme-vue/list';
import DxButton from 'devextreme-vue/button';
export default {
components: {
DxList,
DxItem,
DxButton
}
}
</script>React
import React from 'react';
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import List, { Item } from 'devextreme-react/list';
import Button from 'devextreme-react/button';
class App extends React.Component {
render() {
return (
<List>
<Item>
<i>Item 1</i>
</Item>
<Item>
<i>Item 2</i>
</Item>
<Item>
Item with a nested component
<Button text="Click me" />
</Item>
</List>
);
}
}
export default App;See Also
VectorMapLegendItem
An object that provides information about a legend item in the VectorMap UI component.