Methods

The component's default device options.

Object structure:

Name	Type	Description
device	Device \| Array<Device> \| Function	Device parameters. When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.
options	Object	Options to be applied.

Name

Type

Description

device

Device

|

Array<Device>

|

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.

options

Options to be applied.

defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the Gallery widget in an application executed on the desktop.

jQuery

JavaScript

DevExpress.ui.dxGallery.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Gallery options
    }
});

Angular

TypeScript

import Gallery from "devextreme/ui/gallery";
// ...
export class AppComponent {
    constructor () {
        Gallery.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Gallery options
            }
        });
    }
}

Vue

<template>
    <div>
        <dx-gallery id="gallery1" />
        <dx-gallery 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 options
    }
});

export default {
    components: {
        DxGallery
    }
}
</script>

React

import React from "react";
import dxGallery from "devextreme/ui/gallery";
import Gallery from "devextreme-react/gallery";

class App extends React.Component {
    render () {
        dxGallery.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Gallery options
            }
        })
        return (
            <div>
                <Gallery id="gallery1" />
                <Gallery id="gallery2" />
            </div>
        )
    }
}

export default App;

dispose()

Disposes of all the resources allocated to the Gallery instance.

After calling this method, remove the DOM element associated with the widget:

jQuery

JavaScript

$("#myGallery").dxGallery("dispose");
$("#myGallery").remove();

Angular

HTML

<dx-gallery #galleryVar id="myGallery"></dx-gallery>

TypeScript

import { ..., ViewChild } from "@angular/core";
import { DxGalleryComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("galleryVar", { static: false }) gallery: DxGalleryComponent;
    // Prior to Angular 8
    // @ViewChild("galleryVar") gallery: DxGalleryComponent;

    removeGallery (e) {
        this.gallery.instance.dispose();
        document.getElementById("myGallery").remove();
    }
}

element()

Gets the root widget element.

Return Value:

Element (jQuery or HTML)

An HTML element or a jQuery element when you use jQuery.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

focus()

Sets focus on the widget.

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE

This method returns the DataSource instance even if the widget's dataSource option was given a simple array.

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:

element:

DOM Node

|

jQuery

The widget's container.

Return Value:

The widget's instance.

getInstance is a static method that the widget 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);

goToItem(itemIndex, animation)

Shows a specific image.

Parameters:

itemIndex:

Number

The index of the image in the dataSource.

animation:

Boolean

Specifies whether switching to the image should be animated.

Return Value:

Promise<void> (jQuery or native)

A Promise that is resolved after the image is shown. It is a native Promise or a jQuery.Promise when you use jQuery.

instance()

Gets the widget's instance. Use it to access other methods of the widget.

Return Value:

This widget's instance.

nextItem(animation)

Shows the next image.

Parameters:

animation:

Boolean

Specifies whether switching to the image should be animated.

Return Value:

Promise<void> (jQuery or native)

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 option value. If loop is set to true, the first item is shown. Otherwise, the method does nothing.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

on(events)

Subscribes to events.

Parameters:

events:

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

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.

option()

Gets all widget options.

Return Value:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:

optionName:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

prevItem(animation)

Shows the previous image.

Parameters:

animation:

Boolean

Specifies whether switching to the image should be animated.

Return Value:

Promise<void> (jQuery or native)

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 option value. If loop is set to true, the last item is shown. Otherwise, the method does nothing.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:

key:

A key.

handler:

A handler. Accepts the keydown event as the argument. It is a dxEvent 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.

repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.

resetOption(optionName)

Resets an option to its default value.

Parameters:

optionName: