We use cookies to give you the best experience on our website. If you continue to browse, then you agree to our privacy policy and cookie policy. Image for the cookie policy date
Unfortunately, activation email could not send to your email. Please try again.
Syncfusion Feedback

Difference between the working behavior of Filter Parameter and Dashboard Parameters

Platform: Dashboard Platform |
Control: Dashboard SDK

Difference in working behavior between Filter Parameters and Dashboard Parameters

Filter parameters

Using the filterParameters API, you can apply a filter to a dashboard on initial loading itself.

To set a filter with filterParameters API, use the following syntax.

filterParameters: "columnName=filter(value1, value2, value3)"

Here, the filter represents the operator name.

Refer to the following link for filterParameters API,

https://help.syncfusion.com/dashboard-platform/dashboard-sdk/ejdashboardviewer#members:filterparameters

To apply the filter to the dashboard, use the following syntax.

filterParameters: "columnName=value"

For example, in a sales analysis dashboard, the sales trends information for different products will be shown. You can show the sales in Germany alone by passing the country column filter as Germany in the filterParameters API. Refer to the following code snippet to achieve the same.

$("#dashboard").ejDashboardViewer({
                serviceUrl: 'service URL',
                dashboardPath:'Path of the dashboard',
                filterParameters: "Country=Germany",
 });

 

The following screenshot illustrates a previous dashboard with applied filter.

 

Dashboard with applied filter

Apply filter parameters in URL:

To append your query string made with parameters and values to a URL, add a prefix (?) to the query string for multivalued parameters as follows.

http://<servername>/<culturename>/dashboards/view/<category>/<dashboardname>?ProductName=Chang,Pavlova

The following screenshot illustrates a dashboard with multivalued parameters.

A screenshot of a social media post

Description generated with very high confidence

For more details about filter parameters : https://help.syncfusion.com/dashboard-platform/dashboard-sdk/how-to/apply-filter-using-filterparameters-api

 

Dashboard parameters

This API is used to pass the dashboard parameter by including them in the dashboard URL.

Example:

 $("#dashboard").ejDashboardViewer({
      serviceUrl: 'service URL',
      dashboardPath:'Path of the dashboard',
       filterParameters:location.search.substr(1)
});

 

To set a dashboard parameter within the URL, follow the syntax.

@parameter = value

Here, the parameter represents the parameter name.

The following screenshot illustrates the dashboard parameter in the URL.

To append your query string made with the parameter name and value to a URL, add a prefix(?) to the query string as follows.

http://<servername>//<culturename>/dashboards/<category>/<dashboardname>?@Parameter1=WILMK

The following screenshot of dashboard preview illustrates the dashboard parameter through URL.

A screenshot of a cell phone

Description generated with very high confidence

 

For a dashboard parameter, use the dashboard in the following three modules:

  • Query view
  • Stored procedure
  • Expression column

Apply the filter through the dashboard parameter. It will reflect in the dashboard, if the dashboard has been designed using the above three modules with dashboard parameters in the Dashboard Designer.

Note:

You can use the filter parameter instead of dashboard parameter for applying the filter to the dashboard.

 

For more detail about dashboard parameters: https://help.syncfusion.com/dashboard-platform/dashboard-designer/compose-dashboard/configuring-dashboard-parameters

ADD COMMENT
You must log in to leave a comment

Please sign in to access our KB

This page will automatically be redirected to the sign-in page in 10 seconds.

Up arrow icon

Warning Icon You are using an outdated version of Internet Explorer that may not display all features of this and other websites. Upgrade to Internet Explorer 8 or newer for a better experience.Close Icon

Live Chat Icon For mobile