ItemElementCustomColorEventArgs Interface
Provides information for the ItemElementCustomColor event.
Declaration
export interface ItemElementCustomColorEventArgs
Remarks
Use the onItemElementCustomColor handler to raise the ItemElementCustomColor event.
Properties
getColor Property
Gets the color of the current dashboard item element.
Declaration
getColor: () => string
Property Value
Type |
---|
() => string |
getMeasures Property
Gets measures corresponding to the current dashboard item element.
Declaration
getMeasures: () => Array<ItemDataMeasure>
Property Value
Type |
---|
() => Array<ItemDataMeasure> |
getTargetElement Property
Gets the axis point tuple that corresponds to the current dashboard item element.
Declaration
getTargetElement: () => ItemDataAxisPointTuple
Property Value
Type |
---|
() => ItemDataAxisPointTuple |
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. |
setColor Property
Sets the color of the current dashboard item element.
Declaration
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).