Dashboard object Parameters

It is possible to set parameters to the Dashboard object when instantiated and use them anywhere in the widget properties.

Use the Parameters section within the Dashboard editor to define them.

The parameter passing must be set from the caller object using the DashboardViewer control. The syntax is as follows:

DashboardViewer1.Object = DashboardObjectName(&Parm1, &Parm2, ..., &ParmN)

Properties

The properties where parameters can be used are the following:

• Dashboard
  • Title⁽¹⁾ and RefreshPeriod
• any widget
  • Frame title⁽¹⁾
• Query object or Data Provider object
  • Title⁽¹⁾, XAxis Title⁽¹⁾ and YAxis Title⁽¹⁾ (for charts)
  • Page size (for Table and PivotTable)
• Element of a Query object or Data Provider object
  • Title⁽¹⁾
  • Year title⁽¹⁾, Semester title⁽¹⁾, Quarter title⁽¹⁾, Month title⁽¹⁾, DayOfWeekTitle⁽¹⁾ (for Date or DateTime with grouping)
  • TargetValue, MaximumValue (for attributes in the Data)
  • ShowedValues (if Filter = ShowSomeValues), ExpandedValues (if Expand / Collapse = ExpandSomeValues) and CustomOrder (if Order = Custom).
• Filter
  • Caption⁽¹⁾
  • Value (if FilterType = Value)
  • LowerValue and UpperValue (if FilterType = Range)
  • Values (if FilterType = Collection)
  • MinValue and MaxValue (if FiterType = Value or Range)
  • InviteMessage⁽¹⁾ (for filters of type Edit).
• Image object
  • AlternateText⁽¹⁾
• Text Block control
  • Caption⁽¹⁾

⁽¹⁾ - in addition to accepting a parameter; it also accepts a string that contains one or more parameters, for example: "&Surname, &Name".

Sample

Event Start
    &StartDate = &Today - 30
    DashboardViewer1.Object = Statistics(&StartDate)
Endevent

Availability

This property is available since GeneXus 16 upgrade 3.