DashboardFilters Class Methods

In this section, the DashboardFilters class methods are presented in alphabetical order.

Syntax

GetDashboardFilter(&sCrefReferer,&sDashboardName,&nMode)

Description

Use the GetDashboardFilter method to use filters on dashboards to display the desired visualization.

Parameters

Parameter

Description

&sCrefReferer

Specifies the content reference in which the dashboard is displayed in the panel on the right.

&sDashboardName

Specifies the dashboard for which the current filter is applicable.

&nMode

Specifies the mode in which the dashboard is presented as an integer.

Valid values are:

  • 1 - Full view

  • 2 - Right frame

  • 3 - Tile view.

Returns

A FilterValues object.

Example

The following example extends the DashboardFilters class and uses the NotEquals filter.

import PTSF_INSIGHTS:DashboardFilters;
import PTSF_INSIGHTS:FilterValues;

class FVAPPCLS1 extends PTSF_INSIGHTS:DashboardFilters
   method GetDashboardFilter(&sCrefReferer As string, &sDashboardName As string, &nMode As integer) Returns array of PTSF_INSIGHTS:FilterValues
end-class;

method GetDashboardFilter
   /+ &sCrefReferer as String, +/
   /+ &sDashboardName as String, +/
   /+ &nMode as Integer +/
   /+ Returns Array of PTSF_INSIGHTS:FilterValues +/
   /+ Extends/implements PTSF_INSIGHTS:DashboardFilters.GetDashboardFilter +/
   
   Local array of PTSF_INSIGHTS:FilterValues &filter;
   
   Local PTSF_INSIGHTS:FilterValues &NotContNum;
   &NotContNum.NotEquals().Key("INV_ITEM_ID_ORCL_ES_ENG", "", True).Value("15041");
   &filter.Push(&NotContNum);
   Return &filter;
end-method;