Angular Box API
The Box widget allows you to arrange various elements within it. Separate and adaptive, the Box widget acts as a building block for the layout.
DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.
The following code shows how to create the Box widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.
jQuery
<div id="box"> <div id="item1" data-options="dxItem: { ratio: 1, baseSize: 10 }"> <p>Item 1</p> </div> <div id="item2" data-options="dxItem: { ratio: 3, baseSize: 40 }"> <p>Item 2</p> </div> <div id="item3" data-options="dxItem: { ratio: 2, baseSize: 20 }"> <p>Item 3</p> </div> </div>
$(function () { $("#box").dxBox({ direction: "row", height: "70%", width: "90%" }); });
Angular
<dx-box direction="row" height="70%" width="90%"> <dxi-item id="item1" [ratio]="1" [baseSize]="10"> <p>Item 1</p> </dxi-item> <dxi-item id="item2" [ratio]="3" [baseSize]="40"> <p>Item 2</p> </dxi-item> <dxi-item id="item3" [ratio]="2" [baseSize]="20"> <p>Item 3</p> </dxi-item> </dx-box>
import { DxBoxModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxBoxModule ], // ... })
AngularJS
<div dx-box="{ direction: 'row', height: '70%', width: '90%' }"> <div id="item1" data-options="dxItem: { ratio: 1, baseSize: 10 }"> <p>Item 1</p> </div> <div id="item2" data-options="dxItem: { ratio: 3, baseSize: 40 }"> <p>Item 2</p> </div> <div id="item3" data-options="dxItem: { ratio: 2, baseSize: 20 }"> <p>Item 3</p> </div> </div>
Knockout
<div data-bind="dxBox: { direction: 'row', height: '70%', width: '90%' }"> <div id="item1" data-options="dxItem: { ratio: 1, baseSize: 10 }"> <p>Item 1</p> </div> <div id="item2" data-options="dxItem: { ratio: 3, baseSize: 40 }"> <p>Item 2</p> </div> <div id="item3" data-options="dxItem: { ratio: 2, baseSize: 20 }"> <p>Item 3</p> </div> </div>
ASP.NET MVC Controls
@(Html.DevExtreme().Box() .ID("box") .Direction(BoxDirection.Row) .Height("70%") .Width("90%") .Items(items => { items.Add().Ratio(1).BaseSize(10).Template("<p>Item 1</p>"); items.Add().Ratio(3).BaseSize(40).Template("<p>Item 2</p>"); items.Add().Ratio(2).BaseSize(20).Template("<p>Item 3</p>"); }) )
@(Html.DevExtreme().Box() _ .ID("box") _ .Direction(BoxDirection.Row) _ .Height("70%") _ .Width("90%") _ .Items(Sub(items) items.Add().Ratio(1).BaseSize(10).Template("<p>Item 1</p>") items.Add().Ratio(3).BaseSize(40).Template("<p>Item 2</p>") items.Add().Ratio(2).BaseSize(20).Template("<p>Item 3</p>") End Sub) )
See Also
Properties
Name | Description |
---|---|
align |
Specifies how widget items are aligned along the main direction. |
crossAlign |
Specifies how widget items are aligned cross-wise. |
dataSource |
Binds the widget to data. |
direction |
Specifies the direction of item positioning in the widget. |
disabled |
Specifies whether the widget responds to user interaction. |
elementAttr |
Specifies the attributes to be attached to the widget's root element. |
height |
Specifies the widget's height. |
hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
itemHoldTimeout |
The time period in milliseconds before the onItemHold event is raised. |
items |
An array of items displayed by the widget. |
itemTemplate |
Specifies a custom template for items. |
onContentReady |
A function that is executed when the widget's content is ready and each time the content is changed. |
onDisposing |
A function that is executed before the widget is disposed of. |
onInitialized |
A function used in JavaScript frameworks to save the widget instance. |
onItemClick |
A function that is executed when a collection item is clicked or tapped. |
onItemContextMenu |
A function that is executed when a collection item is right-clicked or pressed. |
onItemHold |
A function that is executed when a collection item has been held for a specified period. |
onItemRendered |
A function that is executed after a collection item is rendered. |
onOptionChanged |
A function that is executed after a widget option is changed. |
rtlEnabled |
Switches the widget to a right-to-left representation. |
visible |
Specifies whether the widget is visible. |
width |
Specifies the widget's width. |
Methods
Name | Description |
---|---|
beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
dispose() |
Disposes of all the resources allocated to the Box instance. |
element() |
Gets the root widget element. |
endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
getDataSource() |
Gets the DataSource instance. |
getInstance(element) |
Gets the instance of a widget found using its DOM node. |
instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
off(eventName) |
Detaches all event handlers from a single event. |
off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
on(eventName, eventHandler) |
Subscribes to an event. |
on(events) |
Subscribes to events. |
option() |
Gets all widget options. |
option(optionName) |
Gets the value of a single option. |
option(optionName, optionValue) |
Updates the value of a single option. |
option(options) |
Updates the values of several options. |
repaint() |
Repaints the widget without reloading data. Call it to update the widget's markup. |
Events
Name | Description |
---|---|
contentReady |
Raised when the widget's content is ready. |
disposing |
Raised before the widget is disposed of. |
initialized |
Raised only once, after the widget is initialized. |
itemClick |
Raised when a collection item is clicked or tapped. |
itemContextMenu |
Raised when a collection item is right-clicked or pressed. |
itemHold |
Raised when a collection item has been held for a specified period. |
itemRendered |
Raised after a collection item is rendered. |
optionChanged |
Raised after a widget option is changed. |
Default Item Template
By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is a list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.