JavaScript/jQuery Gallery Methods
This section describes members used to manipulate the UI component.
See Also
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
| Name | Type | Description |
|---|---|---|
| device | | |
Device parameters. |
| options |
Options to be applied. |
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Gallery UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxGallery.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Gallery properties
}
});Angular
import Gallery, { Properties } from "devextreme/ui/gallery";
// ...
export class AppComponent {
constructor () {
Gallery.defaultOptions<Properties>({
device: { deviceType: "desktop" },
options: {
// Here go the Gallery properties
}
});
}
}Vue
<template>
<div>
<DxGallery id="gallery1" />
<DxGallery id="gallery2" />
</div>
</template>
<script>
import DxGallery from "devextreme-vue/gallery";
import Gallery from "devextreme/ui/gallery";
Gallery.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Gallery properties
}
});
export default {
components: {
DxGallery
}
}
</script>React
import dxGallery from "devextreme/ui/gallery";
import Gallery from "devextreme-react/gallery";
dxGallery.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Gallery properties
}
});
export default function App() {
return (
<div>
<Gallery id="gallery1" />
<Gallery id="gallery2" />
</div>
)
}You can also set rules for multiple device types:
jQuery
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
DevExpress.ui.dxGallery.defaultOptions({
device: deviceConfig,
options: {
// Here go the Gallery properties
}
});
});Angular
import Gallery, { Properties } from "devextreme/ui/gallery";
// ...
export class AppComponent {
constructor () {
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
Gallery.defaultOptions<Properties>({
device: deviceConfig,
options: {
// Here go the Gallery properties
}
});
});
}
}Vue
<template>
<div>
<DxGallery />
</div>
</template>
<script>
import DxGallery from "devextreme-vue/gallery";
import Gallery from "devextreme/ui/gallery";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
Gallery.defaultOptions({
device: deviceConfig,
options: {
// Here go the Gallery properties
}
});
});
export default {
components: {
DxGallery
}
}
</script>React
import dxGallery from "devextreme/ui/gallery";
import Gallery from "devextreme-react/gallery";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
dxGallery.defaultOptions({
device: deviceConfig,
options: {
// Here go the Gallery properties
}
});
});
export default function App() {
return (
<div>
<Gallery />
</div>
)
}dispose()
Disposes of all the resources allocated to the Gallery instance.
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myGallery").dxGallery("dispose");
$("#myGallery").remove();Angular
Use conditional rendering instead of this method:
<dx-gallery ...
*ngIf="condition">
</dx-gallery>Vue
Use conditional rendering instead of this method:
<template>
<DxGallery ...
v-if="condition">
</DxGallery>
</template>
<script>
import DxGallery from 'devextreme-vue/gallery';
export default {
components: {
DxGallery
}
}
</script>React
Use conditional rendering instead of this method:
import React from 'react';
import Gallery from 'devextreme-react/gallery';
function DxGallery(props) {
if (!props.shouldRender) {
return null;
}
return (
<Gallery ... >
</Gallery>
);
}
class App extends React.Component {
render() {
return (
<DxGallery shouldRender="condition" />
);
}
}
export default App;element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
See Also
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Gallery instance found in an element with the myGallery ID:
// Modular approach
import Gallery from "devextreme/ui/gallery";
...
let element = document.getElementById("myGallery");
let instance = Gallery.getInstance(element) as Gallery;
// Non-modular approach
let element = document.getElementById("myGallery");
let instance = DevExpress.ui.dxGallery.getInstance(element);See Also
goToItem(itemIndex, animation)
Shows a specific image.
The index of the image in the dataSource.
Specifies whether switching to the image should be animated.
A Promise that is resolved after the image is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
See Also
nextItem(animation)
Shows the next image.
Specifies whether switching to the image should be animated.
A Promise that is resolved after the image is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
If the current item is the last item in the gallery, the method behavior depends on the loop property value. If loop is set to true, the first item is shown. Otherwise, the method does nothing.
See Also
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
option(options)
Updates the values of several properties.
Options with their new values.
See Also
prevItem(animation)
Shows the previous image.
Specifies whether switching to the image should be animated.
A Promise that is resolved after the image is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
If the current item is the first item in the gallery, the method behavior depends on the loop property value. If loop is set to true, the last item is shown. Otherwise, the method does nothing.
See Also
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
A key.
A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint() method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
resetOption(optionName)
Resets a property to its default value.
A property's name.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.