Skip to main content
BuyLog In
Business Intelligence Dashboard
Search in…
Docs > Web Dashboard > Integrate the Dashboard Component into a Web App > Dashboard Control for JavaScript Applications (JQuery, Knockout, etc.) > Mobile Layout
All docs
V24.2
Business Intelligence Dashboard
Get Started
.NET Support
What's New
Basic Concepts and Terminology
Common Features
WinForms Dashboard
Web Dashboard
Prerequisites
Concepts and Terminology
Integrate the Dashboard Component into a Web App
ASP.NET Core Dashboard Control
ASP.NET MVC Dashboard Extension
ASP.NET Web Forms Dashboard Control
Dashboard Component for Blazor
Dashboard Component for Angular
Dashboard Component for React
Dashboard Component for Vue
Dashboard Control for JavaScript Applications (JQuery, Knockout, etc.)
Required Client Libraries
Add Web Dashboard to a JavaScript Application
Client-Side API Overview
Designer and Viewer Modes
Manage Dashboard State
Obtain Underlying and Displayed Data
Manage Data Inspector
Manage Extensions
Mobile Layout
Themes and Styles
Upgrade to a New Package Version
Localization
Content Security Policy (CSP)
Dashboard Backend
Create Dashboards on the Web
UI Elements and Customization
Advanced Customization
WPF Dashboard Viewer
Visual Studio Integration
Redistribution and Deployment
Video Tutorials
Migration Guides
Examples
End-User Documentation
.NET Framework API Reference
.NET API Reference
HTML JS Control API Reference
ASP.NET Client API Reference
Download CHM

Mobile Layout in JavaScript Applications

  • 4 minutes to read

You can enable mobile layout for mobile browsers when the Web Dashboard operates in ‘Viewer’ and ‘ViewerOnly’ modes.

Web Dashboard - Mobile Layout

Run Demo: Mobile-Ready Dashboard (Browser Emulator)

Requirements

For the mobile layout to work correctly in the Web Dashboard control, do the following:

  • Add the Client libraries to the web page.

  • Include the viewport meta tag in the HTML file.

    The browser requires a special tag to render its content in a mobile browser. Without a viewport meta tag, mobile devices render pages at typical desktop screen widths and then scale the pages to fit the screen. Set the viewport to specify the width and scaling of the viewport.

    To do This, include the viewport meta tag in your HTML file inside the <head> block as shown below:

    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />

    The content attribute specifies the following properties:

    • The width=device-width property specifies that the page width is set to fit the width of the device’s screen.
    • The user-scalable=no property specifies that zoom in and zoom out actions are not allowed on the page.
    • The initial-scale and maximum-scale properties specify the initial and maximal scale on the page.

Mobile Layout’s Views

The Web Dashboard in a mobile layout consists of the following views:

View

Description

Image

List View

The List view displays all dashboard items in the current dashboard. The item’s interactivity is disabled. Filter elements are not displayed in the List view (see Dashboard Items Behavior).

Show image

List View

Item View

The Item view displays the selected item. Interactivity is supported. Filter elements are not displayed in the Item view (see Dashboard Items Behavior).

Show image

Item View

Filter Panel

The Filter panel displays filters that are applied to the dashboard/dashboard items. Click the Filter button (the Filter button icon) in the List View to display all filters in the current dashboard. Click the Filter button in the Item view to see the filters applied to the dashboard item. Click the filter in the Filter panel to open the corresponding filter element and filter data.

Show images

Filter Panel Filter Element

You can register the dashboard panel extension to display a list of available dashboards in mobile layout and to switch between dashboards. After you register the extension, the Dashboards button is displayed at the top of the control.

Dashboard Panel

Mobile Layout’s Mode

The MobileLayoutExtension extension allows you to use mobile layout. Mobile layout is automatically enabled on mobile phones. You can use the MobileLayoutExtensionOptions.mobileLayoutEnabled property to explicitly specify when to enable a mobile layout.

See the MobileLayoutMode enumeration to get values that specify a mobile layout mode for the Web Dashboard.

The code below shows how to use the mobile layout both for mobile phones and desktop applications:

var dashboardControl = new DevExpress.Dashboard.DashboardControl(document.getElementById("web-dashboard"), {
    extensions: {
        "mobile-layout": {
            mobileLayoutEnabled: "Always",
        }
    }
}

You can completely disable a mobile layout functionality for your Web Dashboard application if you unregister the extension. Call the DashboardControl.unregisterExtension method and pass the extension’s unique name as a parameter:

dashboardControl.unregisterExtension('mobileLayout');

Mobile layout is detected on the initial dashboard loading. If you use browser’s Device Emulator in DevTools and switch the emulated device, reload the webpage (F5) to apply a mobile layout correctly.

Dashboard Items Behavior

The Web Dashboard in mobile layout displays the items listed below with the following specifics:

Grid
  • The Grid adjusts columns automatically to the minimum width required to display its content (the ColumnWidthMode is set to AutoFitToContents).
  • Grid hides columns to adapt the content to the screen or container size. Click the ellipsis button in the Grid’s row to display hidden data inside the adaptive detail row.
  • The default column fit of the sparkline and bars is two times tighter than in a desktop version.
  • Column resizing is disabled.
Cards
Filter Elements
  • Filter elements are displayed in the Filter panel and hidden in the List and Item views.

Export

You can export only dashboard items and cannot export the entire dashboard when the Web Dashboard displays dashboards on mobile phones.