DashboardSpecialValues Class
Provides access to dashboard special values.
Declaration
declare class DashboardSpecialValues
Remarks
Fields exposed by the DashboardSpecialValues class are introduced to identify various special values (such as null or Others values) that can be displayed within the dashboard. For instance, these values can be returned when performing the following actions.
- Obtaining client data using the API of the Dashboard Viewer’s (see Obtaining Underlying and Displayed Data).
- Obtaining values that can be used to perform Master Filtering (for example, this can be done using GetAvailableFilterValues methods).
Warning
A use of ASPxClientDashboard
API reduces flexibility when you configure the control. The DashboardControl underlies the ASPxClientDashboard
object. The control provides access to all client settings and allows you to implement complex scenarios. We recommend that you use the DashboardControl
API to configure the Web Dashboard on the client. More information: Client-Side Functionality.
Properties
ErrorValue Property
Represents an error value (for instance, this can be a calculated field value that cannot be evaluated).
Declaration
static readonly ErrorValue: string
Property Value
Type |
---|
string |
NullValue Property
Represents a null value.
Declaration
static readonly NullValue: string
Property Value
Type |
---|
string |
OlapNullValue Property
Represents a null value in OLAP mode.
Declaration
static readonly OlapNullValue: string
Property Value
Type |
---|
string |
OthersValue Property
Represents an Others value.
Declaration
static readonly OthersValue: string
Property Value
Type |
---|
string |
Methods
IsErrorValue(value) Method
Returns whether the specified value is an DashboardSpecialValues.ErrorValue.
Declaration
static IsErrorValue(
value: any
): boolean
Parameters
Name | Type | Description |
---|---|---|
value | any | The specified value. |
Returns
Type | Description |
---|---|
boolean | true, if the specified value is an DashboardSpecialValues.ErrorValue; otherwise, false. |
IsNullValue(value) Method
Returns whether the specified value is an DashboardSpecialValues.NullValue.
Declaration
static IsNullValue(
value: any
): boolean
Parameters
Name | Type | Description |
---|---|---|
value | any | The specified value. |
Returns
Type | Description |
---|---|
boolean | true, if the specified value is an DashboardSpecialValues.NullValue; otherwise, false. |
IsOlapNullValue(value) Method
Returns whether the specified value is an DashboardSpecialValues.OlapNullValue.
Declaration
static IsOlapNullValue(
value: any
): boolean
Parameters
Name | Type | Description |
---|---|---|
value | any | The specified value. |
Returns
Type | Description |
---|---|
boolean | true, if the specified value is an DashboardSpecialValues.OlapNullValue; otherwise, false. |
IsOthersValue(value) Method
Returns whether the specified value is an DashboardSpecialValues.OthersValue.
Declaration
static IsOthersValue(
value: any
): boolean
Parameters
Name | Type | Description |
---|---|---|
value | any | The specified value. |
Returns
Type | Description |
---|---|
boolean | true, if the specified value is an DashboardSpecialValues.OthersValue; otherwise, false. |