Skip to main content
BuyLog In
Business Intelligence Dashboard
Search in…
Docs > Web Dashboard > Create Dashboards on the Web > Data Analysis > Dashboard Parameters > Create Dashboard Parameters
All docs
V23.2
Business Intelligence Dashboard
Get Started
.NET Support
Basic Concepts and Terminology
Common Features
WinForms Dashboard
Web Dashboard
Prerequisites
Concepts and Terminology
Integrate the Dashboard Component into a Web App
Create Dashboards on the Web
Create a Dashboard
Provide Data
Add Dashboard Items
Bind Dashboard Items to Data
Dashboard Item Settings
Data Shaping
Interactivity
Appearance Customization
Data Analysis
Aggregations
Window Calculations
Dashboard Parameters
Create Dashboard Parameters
Reference Dashboard Parameters
Specify Parameter Values
Convert Dashboard Items
Dashboard Layout
Undo and Redo Operations
Save a Dashboard
Open a Dashboard
Delete a Dashboard
Exporting
UI Elements and Customization
Advanced Customization
WPF Dashboard Viewer
Visual Studio Integration
Redistribution and Deployment
Video Tutorials
Migration Guides
Examples
End-User Documentation
.NET Framework API Reference
.NET API Reference
HTML JS Control API Reference
ASP.NET Client API Reference
Download CHM

Create a Dashboard Parameter on the Web

  • 4 minutes to read

This topic shows how to add a dashboard parameter and specify its settings in the UI.

Create a Parameter

To create a dashboard parameter, follow the steps below.

  1. Invoke the dashboard menu and select Parameters.

  2. In the Parameter List, click the Add button. The parameter’s settings form appears as follows:

    Web Dashboard - Add a New Dashboard Parameter

  3. Specify the parameter’s settings.

Parameter Settings

Name

Specifies the parameter name.

When you create and modify parameter names, follow the rules below:

  • A name can contain letters, numbers, and underscores.
  • A name cannot contain spaces.
  • A name cannot be an empty string.
  • The dashboard cannot contain parameters with the same name.
  • Names are case-sensitive. For example, you can create the names Parameter and PARAMETER.

The corresponding property: Parameter.name

Description

Specifies the parameter description displayed in the Parameter column of the Dashboard Parameters dialog:

Dashboard Parameter with Description

The corresponding property: Parameter.description

Visible

Specifies whether the parameter is visible in the Dashboard Parameters dialog.

The corresponding property: Parameter.parameterVisible

Allow Null

Specifies whether a null value can be passed as a parameter value.

The corresponding property: Parameter.allowNull

Allow Multiselect

Specifies whether multi-selection is enabled for the current parameter.

The following limitations apply to parameters with multi-selection enabled:

  • Use the Is any of or Is none of operators to pass a multi-select parameter to a filter criteria or to the Expression format condition.
  • Use the In or Not In operators to pass a multi-select parameter to a calculated field expression.
  • Custom SQL queries do not support multi-select parameters out of the box. For more information, refer to the following article: Use Query Parameters.
  • Stored procedures used in SQL and Entity Framework data sources do not support multi-select parameters out of the box. For more information, refer to the following article: Use Query Parameters.

The corresponding property: Parameter.allowMultiselect

Select All Values

Specifies whether all parameter values should be selected in the initial state of the dashboard.

Note that this option is in effect when the Allow Multiselect setting is enabled.

The corresponding property: Parameter.selectAllValues

Type

Specifies the parameter type. Select the parameter type from the drop-down list in the Type field.

The following types are available:

  • String
  • Date
  • Number (16-bit integer)
  • Number (32-bit integer)
  • Number (64-bit integer)
  • Number (floating point)
  • Number (double-precision floating point)
  • Number (decimal)
  • Boolean
  • GUID (Globally Unique Identifier)

The corresponding property: Parameter.type

Default Value

Specifies the default parameter value.

The corresponding properties: Parameter.defaultValue / Parameter.defaultValues

Look-Up Settings

Specifies the parameter’s look-up editor settings.

The corresponding property: Parameter.lookUpSourceType

The following Look-up Settings are available in the Web Dashboard:

No Look-Up
An end user specifies the parameter value in the Dashboard Parameters dialog.
Static List

An end user selects a parameter value from a static list. To add predefined parameter values, use the plus button.

The corresponding property: Parameter.staticListLookUpSettings

Dynamic List

An end user selects a parameter value defined in a data source.

The corresponding property: Parameter.dynamicListLookUpSettings

You can specify a data source as a source for dashboard parameter values. To provide access to data source values, specify the following options:

UI Settings Description API
Data Source Specifies the data source for the dashboard parameter. dataSource
Data Member Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. dataMember
Value Member Specifies the name of the data field for the parameter values. valueMemberName
Display Member (optional) Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. displayMemberName
Sort By (optional) Specifies the data member used to sort parameter values. sortByMember
Sort Order (optional) Specifies the sort order. sortOrder

Note

You cannot use an OLAP data source as the data source for a dashboard parameter.

See Also