@syncfusion/ej2-circulargauge/src/circular-gauge/axes/gradient.d.ts

Essential JS 2 CircularGauge Components

import { CircularGauge } from '../circular-gauge';
import { ColorStopModel, GradientPositionModel } from './gradient-model';
import { ChildProperty } from '@syncfusion/ej2-base';
import { PointerModel, CapModel, NeedleTailModel, RangeModel } from '../axes/axis-model';
/**
 * Specifies the color information for the gradient in the circular gauge.
 */
export declare class ColorStop extends ChildProperty<ColorStop> {
    /**
     * Defines the color to be used in the gradient.
     *
     * @default '#000000'
     */
    color: string;
    /**
     * Defines the opacity to be used in the gradient.
     *
     * @default 1
     */
    opacity: number;
    /**
     * Defines the gradient color begin and end in percentage.
     *
     * @default '0%'
     */
    offset: string;
    /**
     * Defines the style of the color stop in the gradient element.
     *
     * @default ''
     */
    style: string;
}
/**
 * Specifies the position in percentage from which the radial gradient must be applied.
 */
export declare class GradientPosition extends ChildProperty<GradientPosition> {
    /**
     * Defines the horizontal position in percentage.
     *
     * @default '0%'
     */
    x: string;
    /**
     * Defines the vertical position in percentage.
     *
     * @default '0%'
     */
    y: string;
}
/**
 * This specifies the properties of the linear gradient colors for the circular gauge.
 */
export declare class LinearGradient extends ChildProperty<LinearGradient> {
    /**
     * Defines the start value of the linear gradient.
     *
     * @default ''
     */
    startValue: string;
    /**
     * Defines the end value of the linear gradient.
     *
     * @default ''
     */
    endValue: string;
    /**
     * Defines the color range properties for the gradient.
     *
     */
    colorStop: ColorStopModel[];
}
/**
 * This specifies the properties of the radial gradient colors for the circular gauge.
 */
export declare class RadialGradient extends ChildProperty<RadialGradient> {
    /**
     * Defines the radius of the radial gradient in percentage.
     *
     * @default '0%'
     */
    radius: string;
    /**
     * Defines the outer circle of the radial gradient.
     */
    outerPosition: GradientPositionModel;
    /**
     * Defines the inner circle of the radial gradient.
     */
    innerPosition: GradientPositionModel;
    /**
     * Defines the color range properties for the gradient.
     */
    colorStop: ColorStopModel[];
}
/**
 * Sets and gets the module that enables the gradient option for pointers and ranges.
 *
 * @hidden
 */
export declare class Gradient {
    private gauge;
    /**
     * Constructor for gauge
     *
     * @param {CircularGauge} gauge - Specifies the instance of the gauge
     */
    constructor(gauge: CircularGauge);
    /**
     * To get linear gradient string for pointers and ranges
     *
     * @param { PointerModel | CapModel | NeedleTailModel | RangeModel} element - Specifies the element.
     * @param {name} name - Specifies the name of the gradient.
     * @param {name} direction - Specifies the gradient position.
     * @returns {string} - Returns the string value.
     * @private
     */
    private calculateLinearGradientPosition;
    /**
     * To get linear gradient string for pointers and ranges
     *
     * @param { PointerModel | CapModel | NeedleTailModel | RangeModel} element - Specifies the element.
     * @param {number} index - Specifies the index of the axis.
     * @param { string } direction - Specifies the gradient position.
     * @param { number } rangeIndex - Specifies the index of the range.
     * @returns {string} - Returns the string value.
     * @private
     */
    private getLinearGradientColor;
    /**
     * To get color, opacity, offset and style for circular gradient path.
     *
     * @param {ColorStopModel[]} colorStop - Specifies the colorStop.
     * @param {number} index - Specifies the index.
     * @returns {GradientColor[]} - return the gradient color value.
     * @private
     */
    private getCircularGradientColor;
    /**
     * To get the radial gradient string.
     *
     * @param {PointerModel | CapModel | NeedleTailModel | RangeModel} element - Specifies the element.
     * @returns {string} - Returns the string.
     * @private
     */
    private getRadialGradientColor;
    /**
     * To get color, opacity, offset and style.
     *
     * @param { ColorStopModel[]} colorStop - Specifies the color stop.
     * @returns {GradientColor[]} - Returns the gradientColor.
     * @private
     */
    private getGradientColor;
    /**
     * To get a gradient color string
     *
     * @param {PointerModel | CapModel | NeedleTailModel | RangeModel} element - Specifies the element.
     * @param {number} index - specifies the index.
     * @param {string} direction - specifies the direction.
     * @param {number} rangeIndex - specifies the index of range.
     * @returns {string} - Returns the string
     * @private
     */
    getGradientColorString(element: PointerModel | CapModel | NeedleTailModel | RangeModel, index?: number, direction?: string, rangeIndex?: number): string;
    protected getModuleName(): string;
    /**
     * To destroy the Gradient.
     *
     * @returns {void}
     * @private
     */
    destroy(): void;
}