PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Overview of the Dashboard control
  • Creating a Dashboard control
  • Characteristics of the Dashboard control
  • Adding a widget to a Dashboard control
  • Defining or modifying the display options of a widget
  • Configuring a Dashboard control in the editor
  • Defining the size of cells
  • Defining the size and position of widgets
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Overview of the Dashboard control
Dashboards are essential elements in an application: They group the key elements allowing the executives to make decisions.
The Dashboard control allows you to easily create dashboards that can be customized and adapted by the end user. The user can for example move the different dashboard elements, decide which elements will be visible, ...
The elements displayed in the Dashboard control are widgets. These widgets can be moved, hidden and resized by the end user.
A widget can be easily created:
  • WINDEVAndroidiPhone/iPadMac Catalyst In WINDEV and WINDEV Mobile, it's an internal window.
  • WEBDEV - Server codeWEBDEV - Browser code In WEBDEV, it's an internal page.
Creating a Dashboard control
To create a Dashboard control:
  1. On the "Creation" tab, in the "Containers" group, click "Dashboard".
  2. Click where the control will be created in the window or page.To view the characteristics of the control, select "Description" in the context menu.
Remark: The dimensions of the control are optimized to take up the available space at the specified position. If the control size does not suit you, press Ctrl + Z: the control size will be reset to default.
Characteristics of the Dashboard control
The characteristics of a Dashboard control are described in the "Details" and "Content" tabs of the control description window ("Description" in the context menu).
"Details" tab: Dimensions and overview of Dashboard control
The "Details" tab allows you to specify the following options:
  • Variable width of Widgets: In this case, you can define the number of columns found in the Dashboard control as well as the height of cells.
  • Variable number of Widgets: In this case, you can define the size of cells (width and height in pixels).
  • Fixed width and number of Widgets . In this case, you can define the number of columns and the size of the cells. The "Adapt" buttons are used to adapt the number of columns according to the size of cells (and conversely).
  • the margins between the different widgets displayed in the Dashboard control.
WEBDEV - Server codeWEBDEV - Browser code "Details" tab: Position of the context menu
The context menu of the Dashboard control allows users to:
  • Switch to edit mode. The edit mode allows the user to change the order of widgets, to modify their size, ... The available options can be configured by DashMode.
  • Restore initial configuration.
The context menu of the Dashboard control opens via a button in the control. You can:
  • specify the button to use (option "Place the button"). By default, a button is created when creating the Dashboard control. It is possible to use another button found in the page. This button must be associated with the "Open the Dashboard menu" action ("General" tab of the button description window). If the "None" button is selected, the context menu will not appear.
    Remark: You can hide the context menu programmatically with the Visible property.
  • specify the position of the button that will open the context menu (option "at position"). This button can be positioned at the top left, top right, bottom left or bottom right of Dashboard control.
"Details" tab: Modification by the user
These are the options in the Dashboard control:
  • Compact Widgets: This option is used to automatically reorganize the widgets in the Dashboard control when a widget is deleted by the end user.
  • Remember configuration of Widgets: This option is used to automatically save the configuration of the Dashboard control performed by the user when closing the window or page. This configuration will be automatically re-displayed during the next opening of window (or page).
    WINDEVAndroidiPhone/iPadMac Catalyst Remark: The user can configure his Dashboard via the AAF context menu (Automatic Application Features). For more details, see AAF of Dashboard control.
  • WINDEV Permanent edit mode: This option is used to propose the Dashboard control in edit mode directly during its display. The user will be able to move, resize or hide the widgets directly.
"Content" tab: Defining the widgets found in the Dashboard control
The "Content" tab is used to define the widgets found in the Dashboard control.
You can also define or add widgets programmatically with DashAddWidget.
A widget corresponds to:
  • WINDEVAndroidiPhone/iPadMac Catalyst an internal window.
  • WEBDEV - Server codeWEBDEV - Browser code an internal page.
The "Content" tab is used to:

Adding a widget to a Dashboard control

To add a widget into a Dashboard control:
  1. In the "Content" tab of the control description, click "Add".
  2. In the window that appears:
    • WINDEVAndroidiPhone/iPadMac Catalyst select the internal windows that will be added as widget and validate.
    • WEBDEV - Server codeWEBDEV - Browser code select the internal pages that will be added as widget and validate.
    Remark: Only the internal windows or pages without parameter can be added into the Dashboard control in the editor. To add an internal window or an internal page with parameters, the additions must be performed through programming with DashAddWidget.
  3. The internal windows or pages appear in the list of widgets displayed in the Dashboard control. The display options can be defined for each widget. These options correspond to the initial display of widget.
Remarks:
  • The order of widgets in list has no influence on the widget position in the Dashboard control. This position can be defined in the widget description.
  • The number associated with the widget is used to handle it through programming.
  • To modify the background color of your widget, use a cell in your window or internal page. This cell will contain the controls of your window or internal page. The background of cell will be used to color the widget.

Defining or modifying the display options of a widget

To define or modify the initial display options of a Widget:
  1. Select the widget to configure in the "Content" tab of the description window of Dashboard control.
  2. In the right section of the screen, specify:
    • the associated internal window or page if necessary.
    • whether the widget must be visible by default. If the widget is invisible, a logo is displayed beside the widget name in the list. the user will be able to make it visible via the context menu.
    • the initial size and position of the widget. This position and this size are expressed in cells. The number of cells was defined in the "Details" tab of the control description window. If the position or the size is modified for a widget, the position of the next widgets is automatically updated.
      Remark: The maximum widget size corresponds to the maximum size of the internal window associated with the widget. For example, if the maximum widget size is set to two cells of 150 pixels in width and one cell of 150 pixels in height, the maximum size of the corresponding internal window must be set to 300 pixels x 150 pixels.
    • the widget caption. This caption is important: it will appear in the context menu (AAF) to allow the user to display the widget.
Remark: You also have the ability to define the position and size of widgets in the editor.
Configuring a Dashboard control in the editor

Defining the size of cells

To define the size and position of widgets in the window editor:
  1. Select the Dashboard control.
  2. A border is displayed around the cells found in the Dashboard control.
  3. The first cell has sizing handles.
    • Position the mouse cursor on one of the widget sides. The cursor turns into an arrow.
    • Click and drag until the cell reaches the desired size.
    • The new size applies to all the cells of the Dashboard control.

Defining the size and position of widgets

To define the size and position of widgets in the window editor:
  1. Select the Dashboard control.
  2. Switch to edit mode by using one of the following methods:
    • Click the Dashboard control.
    • Select "Edit the size and position of widgets" in the context menu of the control.
  3. A yellow border appears around the control. You can:
    • Resize the Widgets found in the Dashboard control:
      • Position the mouse cursor on one of the widget sides. The cursor turns into an arrow.
      • Click and drag until the cell reaches the desired size.
    • Move the Widgets found in the Dashboard control:
      • Click the widget.
      • Move the widget while keeping the mouse button down.
  4. To exit from the edit mode, use one of the following methods:
    • Press the Esc key on the keyboard.
    • Select "End the edit" in the context menu of the control.
    • Click the window or page.
Related Examples:
WD Dashboard Training (WINDEV): WD Dashboard
[ + ] The "WD Dashboard" example is an educational example for using the Dashboard control.
This example explains how to:
- handle the control in "edit" mode,
- save/load a configuration,
- configure the control (initial configuration, addition/deletion of widgets, ...),
- refresh a widget,
- etc.
WW_Dashboard Training (WEBDEV): WW_Dashboard
[ + ] The "WD Dashboard" example is an educational example for using the Dashboard control.
This example explains how to:
- handle the control in "edit" mode,
- save/load a configuration,
- configure the control (initial configuration, addition/deletion of widgets, ...),
- refresh a widget.
WM CRM Cross-platform examples (WINDEV Mobile): WM CRM
[ + ] WM CRM is a multi-platform project for Android and iOS.
It explains how to develop a CRM application intended to the Android and iPad tablets.
Minimum version required
  • Version 19
This page is also available for…
Comments
video webdev dasboard
https://youtu.be/QTpZ8oxXCxM
amarildo
29 Nov. 2018
video Dashboard WinDev Mobile
https://youtu.be/KVErsG4aJ0E
amarildo
29 Nov. 2018
video windev dashboard
https://youtu.be/fh78EqJPxxU
amarildo
28 Nov. 2018