ASPxClientDashboardItemElementCustomColorEventArgs Class

Provides data for the ASPxClientDashboard.ItemElementCustomColor event.

Declaration

declare class ASPxClientDashboardItemElementCustomColorEventArgs extends ASPxClientEventArgs

Remarks

The ASPxClientDashboard.ItemElementCustomColor event allows you to color the required dashboard item elements (for instance, chart series points, pie segments) using the specified colors. The ASPxClientDashboardItemElementCustomColorEventArgs class exposes the following settings that allow you to color the required element.

• Use the ASPxClientDashboardItemElementCustomColorEventArgs.ItemName property to obtain the component name of the dashboard item for which the event was raised.

• The ASPxClientDashboardItemElementCustomColorEventArgs.GetTargetElement method returns the axis point tuple that corresponds to the current dashboard item element.

  The ASPxClientDashboardItemElementCustomColorEventArgs.GetMeasures method returns measures corresponding to the current dashboard item element.

• Use the ASPxClientDashboardItemElementCustomColorEventArgs.SetColor method to set the color of the current dashboard item element.

Note

By default, the Chart dashboard item colors lines (or fills areas) for the Line/Area series types using the color of the first series point. For these lines/areas, the ASPxClientDashboardItemElementCustomColorEventArgs.GetTargetElement method returns a tuple that does not contain the axis point on the DashboardDataAxisNames.ChartArgumentAxis.

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.

Inherited Members

constructor

Inheritance

ASPxClientEventArgs

ASPxClientDashboardItemElementCustomColorEventArgs

Properties

ItemName Property

Gets the component name of the dashboard item for which the event was raised.

Declaration

ItemName: string

Property Value

Type	Description
string	A string value that is the component name of the dashboard item for which the event was raised.

Methods

GetColor Method

Gets the color of the current dashboard item element.

Declaration

GetColor(): string

Returns

Type	Description
string	A String that is the color of the current dashboard item element.

GetMeasures Method

Gets measures corresponding to the current dashboard item element.

Declaration

GetMeasures(): ASPxClientDashboardItemDataMeasure[]

Returns

Type	Description
ASPxClientDashboardItemDataMeasure[]	An array of ASPxClientDashboardItemDataMeasure objects that specify measures.

GetTargetElement Method

Gets the axis point tuple that corresponds to the current dashboard item element.

Declaration

GetTargetElement(): ASPxClientDashboardItemDataAxisPointTuple

Returns

Type	Description
ASPxClientDashboardItemDataAxisPointTuple	An ASPxClientDashboardItemDataAxisPointTuple object that is the axis point tuple.

SetColor(color) Method

Sets the color of the current dashboard item element.

Declaration

SetColor(
    color: string
): void

Parameters

Name	Type	Description
color	string	A String that specifies the color of the current dashboard item element.

Remarks

To specify the required dashboard item element, use the ASPxClientDashboardItemElementCustomColorEventArgs.GetTargetElement and ASPxClientDashboardItemElementCustomColorEventArgs.GetMeasures methods.

This method supports the following colors:

• hexadecimal colors;
• RGB colors;
• RGBA colors (not supported in Internet Explorer 8);
• predefined/cross-browser color names;
• predefined SVG colors (not supported in Internet Explorer 8).