ItemElementCustomColorEventArgs Interface
In This Article
Provides information for the ViewerApiExtensionOptions.onItemElementCustomColor event.
#Declaration
TypeScript
export interface ItemElementCustomColorEventArgs extends DashboardItemBaseEventArgs
#Remarks
Use the onItemElementCustomColor handler to raise the ItemElementCustomColor
event.
#Inheritance
DashboardItemBaseEventArgs
ItemElementCustomColorEventArgs
#Properties
#getColor Property
Gets the color of the current dashboard item element.
#Declaration
TypeScript
getColor: () => string
#Property Value
Type |
---|
() => string |
#getMeasures Property
Gets measures corresponding to the current dashboard item element.
#Declaration
TypeScript
getMeasures: () => Array<DevExpress.Dashboard.Data.ItemDataMeasure>
#Property Value
Type |
---|
() => Item |
#getTargetElement Property
Gets the axis point tuple that corresponds to the current dashboard item element.
#Declaration
TypeScript
getTargetElement: () => DevExpress.Dashboard.Data.ItemDataAxisPointTuple
#Property Value
Type |
---|
() => Item |
#setColor Property
Sets the color of the current dashboard item element.
#Declaration
TypeScript
setColor: (color: string) => void
#Property Value
Type |
---|
(color: string) => void |
#Remarks
To specify the required dashboard item element, use the getTargetElement and getMeasures properties.
The setColor property 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).