DevExtreme Vue - DevExtreme Modules Structure

DevExtreme modules have the following structure.

animation

A folder containing modules that expose animation features.

frame

Exposes methods for working with animation.

Exports:

requestAnimationFrame - The requestAnimationFrame method
```
require("animation/frame").requestAnimationFrame
```
cancelAnimationFrame - The cancelAnimationFrame method
```
require("animation/frame").cancelAnimationFrame
```

fx

Exposes an object that serves as a namespace for the methods that are used to animate UI elements.

Exports:

default - The fx object
```
require("animation/fx")
```

presets

Exposes a repository of animations.

Exports:

default - The animationPresets repository
```
require("animation/presets")
```

transition_executor

Exposes an object that serves as a namespace for the methods that are used to perform several specified animations at a time.

Exports:

default - The TransitionExecutor object

require("animation/transition_executor")

core

A folder containing core modules.

config

Exposes the global configuration object.

Exports:

default - The config() and config(config) methods
```
require("core/config")
```

devices

Exposes the object that defines the device on which the application is running.

Exports:

default - The device object
```
require("core/devices")
```

guid

Exposes an object used to generate and hold the GUID.

Exports:

default - The Guid object
```
require("core/guid")
```

data

A folder containing modules used to provide data for widgets.

array_store

Exposes the ArrayStore data access interface.

Exports:

default - The ArrayStore data access interface
```
require("data/array_store")
```

custom_store

Exposes the CustomStore data access interface.

Exports:

default - The CustomStore data access interface
```
require("data/custom_store")
```

data_source

Exposes the DataSource object.

Exports:

default - The DataSource object
```
require("data/data_source")
```

endpoint_selector

Exposes an object used to get URLs that vary in a locally running application and the application running on production..

Exports:

default - The EndpointSelector object
```
require("data/endpoint_selector")
```

errors

Exposes errors and warnings that may occur when using the DevExtreme Data Library.

Exports:

errorHandler - The function called when the Store causes an error. Assign a function to perform a custom action.
```
require("data/errors").errorHandler = function(){
    // Implement logic here
}
```

local_store

Exposes the LocalStore data access interface.

Exports:

default - The LocalStore data access interface
```
require("data/local_store")
```

odata

A folder containing modules exposing OData service.

context

Exposes the ODataContext data access interface.

Exports:

default - The ODataContext data access interface
```
require("data/odata/context")
```

store

Exposes the ODataStore data access interface.

Exports:

default - The ODataStore data access interface
```
require("data/odata/store")
```

utils

Exposes OData utility objects.

Exports:

EdmLiteral - The EdmLiteral object
```
require("data/odata/utils").EdmLiteral
```
keyConverters - The odata.keyConverters object
```
require("data/odata/utils").keyConverters
```

query

Exposes a data query interface object.

Exports:

default - The Query interface object.
```
require("data/query")
```

utils

Exposes utility objects provided by the DevExtreme data layer.

Exports:

base64_encode - The base64_encode method.
```
require("data/utils").base64_encode
```

events

Exposes an object that serves as a namespace for methods used for working with UI events.

Exports:

off - The off method
```
require("events").off
```
on - The on method
```
require("events").on
```
one - The one method
```
require("events").one
```
trigger - The trigger method
```
require("events").trigger
```

click

Exposes the dxclick event.

require("events/click")

contextmenu

Exposes the dxcontextmenu event.

require("events/contextmenu")

dblclick

Exposes the dxdblclick event.

require("events/dblclick")

drag

Exposes the dxdrag dxdragstart, dxdragend, dxdrop, dxdragenter, dxdragleave events.

require("events/drag")

hold

Exposes the dxhold event.

require("events/hold")

hover

Exposes the dxhoverend, dxhoverstart events.

require("events/hover")

pointer

Exposes the dxpointercancel, dxpointerdown, dxpointerenter, dxpointerleave, dxpointermove, dxpointerout, dxpointerover, dxpointerup events.

require("events/pointer")

remove

Exposes the dxremove event.

require("events/remove")

swipe

Exposes the dxswipe, dxswipeend, dxswipestart events.

require("events/swipe")

transform

Exposes the dxtransform, dxtransformend, dxtransformstart, dxzoom, dxzoomend, dxzoomstart, dxpinch, dxpinchend, dxpinchstart, dxtranslate, dxtranslateend, dxtranslatestart events.

require("events/transform")

framework

A folder containing modules that expose SPA Framework features.

command

Exposes a markup component used to define markup options for a command.

Exports:

default - The dxCommand markup component
```
require("framework/command")
```

html

A folder containing modules that expose HTML application functionality.

command_container

Exposes a markup component used to indicate a widget in a layout markup as a command container.

Exports:

default - The dxCommandContainer markup component
```
require("framework/html/command_container")
```

html_application

Exposes an object used to manage views, as well as control the application life cycle.

Exports:

default - The HtmlApplication object

require("framework/html/html_application")

view_engine_components

Exposes components that can be used when defining the markup of an application page.

Exports:

dxView - The dxView markup options

require("framework/html/view_engine_components").dxView

dxLayout - The dxLayout markup options

require("framework/html/view_engine_components").dxLayout

dxViewPlaceholder - The dxViewPlaceholder markup options

require("framework/html/view_engine_components").dxViewPlaceholder

dxContentPlaceholder - The dxContentPlaceholder markup options

require("framework/html/view_engine_components").dxContentPlaceholder

dxTransition - The dxTransition markup options

require("framework/html/view_engine_components").dxTransition

dxContent - The dxContent markup options

require("framework/html/view_engine_components").dxContent

router

Exposes an object responsible for routing.

Exports:

default - The router object
```
require("framework/router")
```

state_manager

Exposes an object used to store the current application state.

Exports:

default - The stateManager object
```
require("framework/state_manager")
```

view_cache

Exposes an object used to store information on the views displayed in an application.

Exports:

default - The viewCache object
```
require("framework/view_cache")
```

integration

A folder containing modules that expose integration features.

angular

The module required for intergation with AngularJS framework.

require("integration/angular")

knockout

The module required for intergation with Knockout framework.

require("integration/knockout")

localization

A folder containing modules that expose localization features.

Besides the listed modules, this folder contains the "messages" folder that provides access to json files containing localized messages. You can use them in the following way.

var deMessages = require('devextreme/localization/messages/de.json');

globalize

A folder that contains modules exposing Globalize integration features.

currency

The module required for custom currency formatting rather than USD.

require("/localization/globalize/currency")

date

The module required for custom date formatting.

require("/localization/globalize/date")

message

The module required for using a custom message dictionary.

require("/localization/globalize/message")

number

The module required for custom number formatting.

require("/localization/globalize/number")

mobile

A folder containing modules that expose mobile utilities.

hide_top_overlay

Exposes the hideTopOverlay method.

Exports:

default - The hideTopOverlay method
```
require("mobile/hide_top_overlay")
```

init_mobile_viewport

Exposes the initMobileViewport method.

Exports:

default - The initMobileViewport method
```
require("mobile/init_mobile_viewport")
```

process_hardware_back_button

Exposes the processHardwareBackButton method.

Exports:

default - The processHardwareBackButton method

require("mobile/process_hardware_back_button")

ui

A folder that contains modules exposing UI widgets.

accordion

Exposes the Accordion widget.

Exports:

default - The Accordion widget
```
require("ui/accordion")
```

action_sheet

Exposes the ActionSheet widget.

Exports:

default - The ActionSheet widget
```
require("ui/action_sheet")
```

autocomplete

Exposes the Autocomplete widget.

Exports:

default - The Autocomplete widget
```
require("ui/autocomplete")
```

box

Exposes the Box widget.

Exports:

default - The Box widget
```
require("ui/box")
```

button

Exposes the Button widget.

Exports:

default - The Button widget
```
require("ui/button")
```

calendar

Exposes the Calendar widget.

Exports:

default - The Calendar widget
```
require("ui/calendar")
```

check_box

Exposes the CheckBox widget.

Exports:

default - The CheckBox widget
```
require("ui/check_box")
```

color_box

Exposes the ColorBox widget.

Exports:

default - The ColorBox widget
```
require("ui/color_box")
```

context_menu

Exposes the ContextMenu widget.

Exports:

default - The ContextMenu widget
```
require("ui/context_menu")
```

data_grid

Exposes the DataGrid widget.

Exports:

default - The DataGrid widget
```
require("ui/data_grid")
```

date_box

Exposes the DateBox widget.

Exports:

default - The DateBox widget
```
require("ui/date_box")
```

defer_rendering

Exposes the DeferRendering widget.

Exports:

default - The DeferRendering widget
```
require("ui/defer_rendering")
```

dialog

Exposes an object that serves as a namespace for methods displaying a message in an application/site.

Exports:

alert - The alert method
```
require("ui/dialog").alert
```
confirm - The confirm method
```
require("ui/dialog").confirm
```
custom - The custom method
```
require("ui/dialog").custom
```

drop_down_box

Exposes the DropDownBox widget.

Exports:

default - The DropDownBox widget
```
require("ui/drop_down_box")
```

file_uploader

Exposes the FileUploader widget.

Exports:

default - The FileUploader widget
```
require("ui/file_uploader")
```

filter_builder

Exposes the FilterBuilder widget.

Exports:

default - The FilterBuilder widget
```
require("ui/filter_builder")
```

form

Exposes the Form widget.

Exports:

default - The Form widget
```
require("ui/form")
```

gallery

Exposes the Gallery widget.

Exports:

default - The Gallery widget
```
require("ui/gallery")
```

list

Exposes the List widget.

Exports:

default - The List widget
```
require("ui/list")
```

load_indicator

Exposes the LoadIndicator widget.

Exports:

default - The LoadIndicator widget
```
require("ui/load_indicator")
```

load_panel

Exposes the LoadPanel widget.

Exports:

default - The LoadPanel widget
```
require("ui/load_panel")
```

lookup

Exposes the Lookup widget.

Exports:

default - The Lookup widget
```
require("ui/lookup")
```

map

Exposes the Map widget.

Exports:

default - The Map widget
```
require("ui/map")
```

multi_view

Exposes the MultiView widget.

Exports:

default - The MultiView widget
```
require("ui/multi_view")
```

nav_bar

Exposes the NavBar widget.

Exports:

default - The NavBar widget
```
require("ui/nav_bar")
```

notify

Exposes methods that create a toast message.

Exports:

default - The notify(message, type, displayTime) and notify(options) methods
```
require("ui/notify")
```

number_box

Exposes the NumberBox widget.

Exports:

default - The NumberBox widget
```
require("ui/number_box")
```

overlay

Exposes methods that work with overlay widgets.

Exports:

bazeZIndex - The baseZIndex(zIndex) method
```
require("ui/overlay").bazeZIndex
```

panorama

Exposes the Panorama widget.

Exports:

default - The Panorama widget
```
require("ui/panorama")
```

pivot

Exposes the Pivot widget.

Exports:

default - The Pivot widget
```
require("ui/pivot")
```

pivot_grid

Exposes the PivotGrid widget.

Exports:

default - The PivotGrid widget
```
require("ui/pivot_grid")
```

data_source

Exposes an object that provides acess to data for the PivotGrid data.

Exports:

default - The PivotGridDataSource object
```
require("ui/pivot_grid/data_source")
```

xmla_store

Exposes the XmlaStore data access interface.

Exports:

default - The XmlaStore data access interface
```
require("ui/pivot_grid/xmla_store")
```

pivot_grid_field_chooser

Exposes the PivotGridFieldChooser widget.

Exports:

default - The PivotGridFieldChooser widget
```
require("ui/pivot_grid_field_chooser")
```

popover

Exposes the Popover widget.

Exports:

default - The Popover widget
```
require("ui/popover")
```

popup

Exposes the Popup widget.

Exports:

default - The Popup widget
```
require("ui/popup")
```

progress_bar

Exposes the ProgressBar widget.

Exports:

default - The ProgressBar widget
```
require("ui/progress_bar")
```

radio_group

Exposes the RadioGroup widget.

Exports:

default - The RadioGroup widget
```
require("ui/radio_group")
```

range_slider

Exposes the RangeSlider widget.

Exports:

default - The RangeSlider widget
```
require("ui/range_slider")
```

resizable

Exposes the Resizable widget.

Exports:

default - The Resizable widget
```
require("ui/resizable")
```

responsive_box

Exposes the ResponsiveBox widget.

Exports:

default - The ResponsiveBox widget
```
require("ui/responsive_box")
```

scheduler

Exposes the Scheduler widget.

Exports:

default - The Scheduler widget
```
require("ui/scheduler")
```

scroll_view

Exposes the ScrollView widget.

Exports:

default - The ScrollView widget
```
require("ui/scroll_view")
```

select_box

Exposes the SelectBox widget.

Exports:

default - The SelectBox widget
```
require("ui/select_box")
```

set_template_engine

Exposes methods that specify a template engine.

Exports:

default - The setTemplateEngine(name) and setTemplateEngine(options) methods
```
require("ui/set_template_engine")
```

slider

Exposes the Slider widget.

Exports:

default - The Slider widget
```
require("ui/slider")
```

slide_out

Exposes the SlideOut widget.

Exports:

default - The SlideOut widget
```
require("ui/slide_out")
```

slide_out_view

Exposes the SlideOutView widget.

Exports:

default - The SlideOutView widget
```
require("ui/slide_out_view")
```

switch

Exposes the Switch widget.

Exports:

default - The Switch widget
```
require("ui/switch")
```

tabs

Exposes the Tabs widget.

Exports:

default - The Tabs widget
```
require("ui/tabs")
```

tab_panel

Exposes the TabPanel widget.

Exports:

default - The TabPanel widget
```
require("ui/tab_panel")
```

tag_box

Exposes the TagBox widget.

Exports:

default - The TagBox widget
```
require("ui/tag_box")
```

text_area

Exposes the TextArea widget.

Exports:

default - The TextArea widget
```
require("ui/text_area")
```

text_box

Exposes the TextBox widget.

Exports:

default - The TextBox widget
```
require("ui/text_box")
```

themes

Exposes an object that serves as a namespace for the methods that work with DevExtreme CSS Themes.

Exports:

current - The current() and current(themeName) methods
```
require("ui/themes").current
```

tile_view

Exposes the TileView widget.

Exports:

default - The TileView widget
```
require("ui/tile_view")
```

toast

Exposes the Toast widget.

Exports:

default - The Toast widget
```
require("ui/toast")
```

toolbar

Exposes the Toolbar widget.

Exports:

default - The Toolbar widget
```
require("ui/toolbar")
```

tooltip

Exposes the Tooltip widget.

Exports:

default - The Tooltip widget
```
require("ui/tooltip")
```

tree_list

Exposes the TreeList widget.

Exports:

default - The TreeList widget
```
require("ui/tree_list")
```

tree_view

Exposes the TreeView widget.

Exports:

default - The dxTrackBar widget
```
require("ui/tree_view")
```

validation_engine

Exposes an object that serves as a namespace for the methods required to perform validation.

Exports:

default - The validationEngine object
```
require("ui/validation_engine")
```

validation_group

Exposes the ValidationGroup widget.

Exports:

default - The ValidationGroup widget
```
require("ui/validation_group")
```

validation_summary

Exposes the ValidationSummary widget.

Exports:

default - The ValidationSummary widget
```
require("ui/validation_summary")
```

validator

Exposes the Validator widget.

Exports:

default - The Validator widget
```
require("ui/validator")
```

viz

A folder containing modules that expose data visualization widgets.

bar_gauge

Exposes the BarGauge widget.

Exports:

default - The BarGauge widget
```
require("viz/bar_gauge")
```

bullet

Exposes the Bullet widget.

Exports:

default - The Bullet widget
```
require("viz/bullet")
```

chart

Exposes the Chart widget.

Exports:

default - The Chart widget
```
require("viz/chart")
```

circular_gauge

Exposes the CircularGauge widget.

Exports:

default - The CircularGauge widget
```
require("viz/circular_gauge")
```

export

Exposes export-related methods.

Exports:

exportFromMarkup - The exportFromMarkup(markup, options) method
```
require("viz/export").exportFromMarkup
```
getMarkup - The getMarkup(widgetInstances) method
```
require("viz/export").getMarkup
```

funnel

Exposes the Funnel widget.

Exports:

default - The Funnel widget
```
require("viz/funnel")
```

linear_gauge

Exposes the LinearGauge widget.

Exports:

default - The LinearGauge widget
```
require("viz/linear_gauge")
```

palette

Exposes methods that control palettes.

Exports:

currentPalette - The currentPalette(paletteName) method
```
require("viz/palette").currentPalette
```
getPalette - The getPalette(paletteName) method
```
require("viz/palette").getPalette
```
registerPalette - The registerPalette(paletteName, palette) method
```
require("viz/palette").registerPalette
```

pie_chart

Exposes the PieChart widget.

Exports:

default - The PieChart widget
```
require("viz/pie_chart")
```

polar_chart

Exposes the PolarChart widget.

Exports:

default - The PolarChart widget
```
require("viz/polar_chart")
```

range_selector

Exposes the RangeSelector widget.

Exports:

default - The RangeSelector widget
```
require("viz/range_selector")
```

sparkline

Exposes the Sparkline widget.

Exports:

default - The Sparkline widget
```
require("viz/sparkline")
```

themes

Exposes methods that control themes.

Exports:

currentTheme - The currentTheme(theme) and currentTheme(platform, colorScheme) methods
```
require("viz/themes").currentTheme
```
refreshTheme - The refreshTheme() method
```
require("viz/themes").refreshTheme
```
registerTheme - The registerTheme(customTheme, baseTheme) method
```
require("viz/themes").registerTheme
```

tree_map

Exposes the TreeMap widget.

Exports:

default - The TreeMap widget
```
require("viz/tree_map")
```

utils

Exposes utility methods.

Exports:

refreshPaths - The refreshPaths() method
```
require("viz/utils").refreshPaths
```

vector_map

Exposes the VectorMap widget.

Exports:

default - The VectorMap widget
```
require("viz/vector_map")
```

projection

Exposes methods of the DevExpress.viz.map object.

Exports:

projection - The projection method

require("viz/vector_map/projection").projection

utils

Exposes the common utility objects.

Exports:

compileGetter - The compileGetter method
```
require("utils").compileGetter
```
compileSetter - The compileSetter method
```
require("utils").compileSetter
```