PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
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
<Dashboard>.InitialConfiguration (Function)
In french: <Tableau de bord>.ConfigurationInitiale
AjaxNot available
Modifies the configuration of a Dashboard control (defined in the editor) before its first display. This allows you to configure and to take into account the widgets declared in programming by <Dashboard>.AddWidget.
Versions 20 and later
Windows This function is now available in WEBDEV Server.
Linux This function is now available for WEBDEV sites in Linux.
New in version 20
Windows This function is now available in WEBDEV Server.
Linux This function is now available for WEBDEV sites in Linux.
Windows This function is now available in WEBDEV Server.
Linux This function is now available for WEBDEV sites in Linux.
Example
WINDEV
// -- Initialisation de TDB_TableauDeBord
// Ajoute des informations dans la configuration initiale:
// - chiffres clés des 3 derniers mois
nX = 1 ; nY = 3
POUR i = 1 À 3
// Ajoute le widget
nIndice = TDB_TableauDeBord.AjouteWidget(FI_Widget_ChiffreClé, ...
ChaîneConstruit("Chiffres de %1", DateVersChaîne(dDate, "Mmm AAAA")), ...
dDate)
// Configure le widget (calé à gauche)
TDB_TableauDeBord.ConfigurationInitiale(nIndice, nX, nY)
// Le prochain sera plus bas
nY++
dDate.Mois--
FIN
// - alerte de stock
// Ajoute le widget
nIndice = TDB_TableauDeBord.AjouteWidget(FI_Widget_AlerteStock, "Alerte stock")
// Configure le widget (calé à gauche)
TDB_TableauDeBord.ConfigurationInitiale(nIndice, 5, 1)
Syntax

Initial configuration: handling the widget by its subscript Hide the details

<Dashboard control>.InitialConfiguration(<Widget subscript> [, <X> [, <Y> [, <Width> [, <Height>]]]])
<Dashboard control>: Control name
Name of Dashboard control to use.
<Widget subscript>: Integer
Subscript of widget to use. This subscript corresponds to:
  • the addition number of widget defined in the window editor or in the page editor.
  • the addition number of widget returned by <Dashboard>.AddWidget.
<X>: Optional integer
Horizontal position of widget in number of cells.
If the parameters [<X>, <Y>] are not specified or have the value [ 0,0], the Widget is positioned on the first free place.
The first cell is cell [1, 1].
<Y>: Optional integer
Vertical position of widget in number of cells.
If the parameters [<X>, <Y>] are not specified or have the value [ 0,0], the Widget is positioned on the first free place.
The first cell is cell [1, 1].
<Width>: Optional integer
Width of widget in number of cells.
If [<Width>, <Height>] are not specified or if their value is equal to [0, 0]:
  • during the first call to <Dashboard>.InitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to <Dashboard>.InitialConfiguration, the widget size corresponds to the size defined during the first call.
<Height>: Optional integer
Height of widget in number of cells.
If [<Width>, <Height>] are not specified or if their value is equal to [0, 0]:
  • during the first call to <Dashboard>.InitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to <Dashboard>.InitialConfiguration, the widget size corresponds to the size defined during the first call.

Initial configuration: handling the widget by its name Hide the details

<Dashboard control>.InitialConfiguration(<Widget> [, <X> [, <Y> [, <Width> [, <Height>]]]])
<Dashboard control>: Control name
Name of Dashboard control to use.
<Widget>: Name of internal window or internal page
  • WINDEV Name of internal window to use.
<X>: Optional integer
Horizontal position of widget in number of cells.
If the parameters [<X>, <Y>] are not specified or have the value [ 0,0], the Widget is positioned on the first free place.
The first cell is cell [1, 1].
<Y>: Optional integer
Vertical position of widget in number of cells.
If the parameters [<X>, <Y>] are not specified or have the value [ 0,0], the Widget is positioned on the first free place.
The first cell is cell [1, 1].
<Width>: Optional integer
Width of widget in number of cells.
If [<Width>, <Height>] are not specified or if their value is equal to [0, 0]:
  • during the first call to <Dashboard>.InitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to <Dashboard>.InitialConfiguration, the widget size corresponds to the size defined during the first call
<Height>: Optional integer
Height of widget in number of cells.
If [<Width>, <Height>] are not specified or if their value is equal to [0, 0]:
  • during the first call to <Dashboard>.InitialConfiguration, the widget size corresponds to the size of source internal window or page (at least 1 cell).
  • during the next calls to <Dashboard>.InitialConfiguration, the widget size corresponds to the size defined during the first call
Remarks
  • If the function <Dashboard>.InitialConfiguration is called after the initialization of Dashboard control, an error is generated.
  • Widgets configured by the <Dashboard>.InitialConfiguration function will be loaded and made visible by Default after the initialization processes are executed.
  • The function <Dashboard>.InitialConfiguration is not taken into account in the following cases:
    • The option "Remember configuration of Widgets" is checked in the description window of the Dashboard control ("Details" tab) and the user makes the widget invisible.
    • The user made the widget invisible and the configuration of the Dashboard control was saved then reloaded.
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.
Component: wd270obj.dll
Minimum version required
  • Version 23
This page is also available for…
Comments
Click [Add] to post a comment