JavaScript/jQuery ColorBox Methods

The component's default device properties.

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 properties should be applied to the device.
options	Object	Propertiesto 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 properties should be applied to the device.

options

Propertiesto 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 ColorBox UI component in an application executed on the desktop.

jQuery

JavaScript

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

Angular

TypeScript

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

Vue

<template>
    <div>
        <DxColorBox id="colorBox1" />
        <DxColorBox id="colorBox2" />
    </div>
</template>
<script>
import DxColorBox from "devextreme-vue/color-box";
import ColorBox from "devextreme/ui/color_box";

ColorBox.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the ColorBox options
    }
});

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

React

import React from "react";
import dxColorBox from "devextreme/ui/color_box";
import ColorBox from "devextreme-react/color-box";

class App extends React.Component {
    render () {
        dxColorBox.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the ColorBox options
            }
        })
        return (
            <div>
                <ColorBox id="colorBox1" />
                <ColorBox id="colorBox2" />
            </div>
        )
    }
}

export default App;

dispose()

Disposes of all the resources allocated to the ColorBox instance.

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

JavaScript

$("#myColorBox").dxColorBox("dispose");
$("#myColorBox").remove();

Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular

app.component.html

<dx-color-box ...
    *ngIf="condition">
</dx-color-box>

Vue

App.vue

<template>
    <DxColorBox ...
        v-if="condition">
    </DxColorBox>
</template>

<script>
import DxColorBox from 'devextreme-vue/color-box';

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

React

App.js

import React from 'react';

import ColorBox from 'devextreme-react/color-box';

function DxColorBox(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <ColorBox ... >    
        </ColorBox>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxColorBox shouldRender="condition" />
        );
    }
}
export default App;

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

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

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

field()

Gets the UI component's <input> element.

Return Value:

HTMLElement | jQuery

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

focus()

Sets focus to the input element representing the UI component.

getButton(name)

Gets an instance of a custom action button.

Parameters:

name:

The button's name.

Return Value:

Button

| undefined

The Button UI component's instance.

Use the returned button instance to call the Button UI component's methods, for example, focus():

jQuery

index.js

const myCustomButton = $("#colorBoxContainer").dxColorBox("getButton", "myCustomButton");
myCustomButton.focus();

Angular

app.component.ts

app.component.html

import { Component, ViewChild } from '@angular/core';
import { DxColorBoxComponent } from 'devextreme-angular';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    @ViewChild('colorBoxRef', { static: false }) colorBox: DxColorBoxComponent;
    // Prior to Angular 8
    // @ViewChild('colorBoxRef') colorBox: DxColorBoxComponent;

    setFocus() {
        this.colorBox.instance.getButton('myCustomButton').focus();
    }
}

<dx-color-box #colorBoxRef ... >
</dx-color-box>

Vue

App.vue

<template>
    <DxColorBox ...
        :ref="colorBoxRef">
    </DxColorBox>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxColorBox from 'devextreme-vue/color-box';

export default {
    components: {
        DxColorBox
    },

    data() {
        return {
            colorBoxRef
        }
    },

    methods: {
        setFocus() {
            this.colorBox.getButton('myCustomButton').focus();
        }
    },

    computed: {
        colorBox: function() {
            return this.$refs[colorBoxRef].instance;
        }
    }
}
</script>

React

App.js

import React from 'react';

import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import ColorBox from 'devextreme-react/color-box';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.colorBoxRef = React.createRef();

        this.setFocus = () => {
            this.colorBox.getButton('myCustomButton').focus();
        };
    }

    get colorBox() {
        return this.colorBoxRef.current.instance;
    }

    render() {
        return (
            <ColorBox ...
                ref={this.colorBoxRef}>
            </ColorBox>
        );
    }
}
export default App;

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:

element:

Element

|

jQuery

The UI component's container.

Return Value:

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the ColorBox instance found in an element with the myColorBox ID:

// Modular approach
import ColorBox from "devextreme/ui/color_box";
...
let element = document.getElementById("myColorBox");
let instance = ColorBox.getInstance(element) as ColorBox;

// Non-modular approach
let element = document.getElementById("myColorBox");
let instance = DevExpress.ui.dxColorBox.getInstance(element);

instance()

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

Return Value:

This UI component's instance.

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.

open()

Opens the drop-down editor.

option()

Gets all UI component properties.

Return Value:

The UI component's properties.

option(optionName)

Gets the value of a single property.

Parameters:

optionName:

The property's name or full path.

Return Value: any

This property's value.

option(optionName, optionValue)

Updates the value of a single property.

Parameters:

optionName:

The property's name or full path.

optionValue: any

This property's new value.

option(options)

Updates the values of several properties.

Parameters:

options:

Propertieswith their new values.

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 UI component without reloading data. Call it to update the UI component's markup.

reset()

Resets the value property to the default value.

resetOption(optionName)

Resets an property to its default value.

Parameters:

optionName: