igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
53 lines (52 loc) • 2.13 kB
TypeScript
import { ColorScaleInterpolationMode } from "./ColorScaleInterpolationMode";
import { IgrColorScale, IIgrColorScaleProps } from "./igr-color-scale";
import { CustomPaletteColorScale } from "./CustomPaletteColorScale";
/**
* ColorScale class for selecting a color from a given palette, or interpolating between adjacent colors in that palette.
*/
export declare class IgrCustomPaletteColorScale extends IgrColorScale<IIgrCustomPaletteColorScaleProps> {
protected createImplementation(): CustomPaletteColorScale;
/**
* @hidden
*/
get i(): CustomPaletteColorScale;
constructor(props: IIgrCustomPaletteColorScaleProps);
/**
* The lowest value to assign a color. Any given value less than this value will be made Transparent.
*/
get minimumValue(): number;
set minimumValue(v: number);
/**
* The highest value to assign a color. Any given value greater than this value will be made Transparent.
*/
get maximumValue(): number;
set maximumValue(v: number);
/**
* A list of colors to select from or interpolate between.
*/
get palette(): string[];
set palette(v: string[]);
/**
* The approach to use when getting a color from the palette.
*/
get interpolationMode(): ColorScaleInterpolationMode;
set interpolationMode(v: ColorScaleInterpolationMode);
providePalette(colors: string[]): void;
}
export interface IIgrCustomPaletteColorScaleProps extends IIgrColorScaleProps {
/**
* The lowest value to assign a color. Any given value less than this value will be made Transparent.
*/
minimumValue?: number | string;
/**
* The highest value to assign a color. Any given value greater than this value will be made Transparent.
*/
maximumValue?: number | string;
/**
* A list of colors to select from or interpolate between.
*/
/**
* The approach to use when getting a color from the palette.
*/
interpolationMode?: ColorScaleInterpolationMode | string;
}