DashboardViewer control Methods

The following methods apply in the DashboardViewer control:

• Refresh()
  • Causes the Dashboard to be updated.
• GetFilterValue(&FilterName)
  • Returns the value of a filter of Value or Range type.
• GetFilterValues(&FilterName)
  • Returns the value of a filter of Collection type.
• SetFilterValue(&FilterName, &FilterValue)
  • Sets the value of a filter of Value type.
• SetFilterRange(&FilterNameLowerValue, &FilterLowerValue, &FilterNameUpperValue, &FilterUpperValue)
  • Sets the value of a filter of Range type (if you want to set the value of only one of the range extremes, the FilterName of the extreme which is not to be changed must be passed empty).
• SetFilterValues(&FilterName, &ValuesCollection)
  • Sets the value of a filter of Collection type.

Note

These methods only work in events that are generated client-side. These server-side events have no effect.

Example

Event 'GetFilterValue'
    msg ( DashboardViewer1.GetFilterValue('CustomerAge'))
Endevent

Event 'SetFilterValue'
    DashboardViewer1.SetFilterValue('CustomerAge', '41')
Endevent

Event 'Get Filter Values'
    &Values = DashboardViewer1.GetFilterValues('CarBrandName')
    msg(&Values.ToJson())
Endevent

Event 'Set Filter Values'
    &Values.Clear()
    &Values.Add("Rover")
    &Values.Add("Peugeot")
    DashboardViewer1.SetFilterValues('CarBrandName', &Values)
Endevent

Event 'Get Range Values'
    msg( Format('Initial Age= %1 , End Age= %2', DashboardViewer1.GetFilterValue('CustomerAgeInit'), DashboardViewer1.GetFilterValue('CustomerAgeEnd')))
Endevent

Event 'Set Range Values'
    DashboardViewer1.SetFilterRange('CustomerAgeInit' , '41', 'CustomerAgeEnd' , '51')
Endevent

Sample

TestWebQueryViewer

 

See also

DashboardViewer control
Dashboard object
DashboardViewer Control Events