Angular Box Methods

This section describes members used to manipulate the UI component.

See Also

beginUpdate()

Prevents the UI component from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.

See Also

defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.

Parameters:
rule:

Object

The component's default device properties.

Object structure:
Name Type Description
device

Device

|

Array<Device>

|

Function

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

options

Object

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

jQuery
JavaScript
DevExpress.ui.dxBox.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Box properties
    }
});
Angular
TypeScript
import Box, { Properties } from "devextreme/ui/box";
// ...
export class AppComponent {
    constructor () {
        Box.defaultOptions<Properties>({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Box properties
            }
        });
    }
}
Vue
<template>
    <div>
        <DxBox id="box1" />
        <DxBox id="box2" />
    </div>
</template>
<script>
import DxBox from "devextreme-vue/box";
import Box from "devextreme/ui/box";

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

export default {
    components: {
        DxBox
    }
}
</script>
React
import dxBox from "devextreme/ui/box";
import Box from "devextreme-react/box";

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

export default function App() {
    return (
        <div>
            <Box id="box1" />
            <Box id="box2" />
        </div>
    )
}

dispose()

Disposes of all the resources allocated to the Box instance.

jQuery

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

JavaScript
$("#myBox").dxBox("dispose");
$("#myBox").remove();
Angular

Use conditional rendering instead of this method:

app.component.html
<dx-box ...
    *ngIf="condition">
</dx-box>
Vue

Use conditional rendering instead of this method:

App.vue
<template>
    <DxBox ...
        v-if="condition">
    </DxBox>
</template>

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

export default {
    components: {
        DxBox
    }
}
</script>
React

Use conditional rendering instead of this method:

App.js
import React from 'react';

import Box from 'devextreme-react/box';

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

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

class App extends React.Component {
    render() {
        return (
            <DxBox 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.

See Also

endUpdate()

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

Main article: beginUpdate()

See Also

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE
This method returns the DataSource instance even if the UI component's dataSource property was given a simple array.
See Also

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:

Object

The UI component's instance.

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

// Modular approach
import Box from "devextreme/ui/box";
...
let element = document.getElementById("myBox");
let instance = Box.getInstance(element) as Box;

// Non-modular approach
let element = document.getElementById("myBox");
let instance = DevExpress.ui.dxBox.getInstance(element);
See Also

instance()

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

Return Value:

Box

This UI component's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

Box

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

Box

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

Box

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.

Parameters:
events:

Object

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

Return Value:

Box

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()

Return Value:

Object

The UI component's properties.

option(optionName)

Gets the value of a single property.

Parameters:
optionName:

String

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:

String

The property's name or full path.

optionValue: any

This property's new value.

option(options)

Updates the values of several properties.

Parameters:
options:

Object

Options with their new values.

repaint()

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

See Also

resetOption(optionName)

Resets a property to its default value.

Parameters:
optionName:

String

A property's name.

See Also