igniteui-react-charts/lib/igr-user-shape-annotation.d.ts

Ignite UI React charting components for building rich data visualizations using TypeScript APIs.

import { DataAnnotationDisplayMode } from "./DataAnnotationDisplayMode";
import { OverlayTextLocation } from "./OverlayTextLocation";
import { AnnotationAppearanceMode } from "./AnnotationAppearanceMode";
import { IgrUserAxisAnnotation } from "./igr-user-axis-annotation";
import { UserShapeAnnotation as UserShapeAnnotation_internal } from "./UserShapeAnnotation";
/**
 * Represents base class for rendering an annotation with shape of slice of strip
*/
export declare abstract class IgrUserShapeAnnotation extends IgrUserAxisAnnotation {
    /**
                                 * @hidden
                                 */
    get i(): UserShapeAnnotation_internal;
    constructor();
    /**
     * Gets or sets display mode of label in the center annotation.
    */
    get valueDisplayMode(): DataAnnotationDisplayMode;
    set valueDisplayMode(v: DataAnnotationDisplayMode);
    /**
     * Gets or sets background of the annotation shape displayed in the plot area of the chart.
    */
    get shapeBackground(): string;
    set shapeBackground(v: string);
    /**
     * Gets or sets border color of the annotation shape displayed in the plot area of the chart.
    */
    get shapeOutline(): string;
    set shapeOutline(v: string);
    /**
     * Gets or sets border thickness of the annotation shape displayed in the plot area of the chart.
    */
    get shapeThickness(): number;
    set shapeThickness(v: number);
    /**
     * Gets or sets the text that should be overlayed in plot area of the chart.
    */
    get overlayText(): string;
    set overlayText(v: string);
    /**
     * Gets or sets location of the overlay text in relation to the annotation shape.
    */
    get overlayTextLocation(): OverlayTextLocation;
    set overlayTextLocation(v: OverlayTextLocation);
    /**
     * Gets or sets the horizontal margin of the overlay text in relation to the annotation shape.
    */
    get overlayTextHorizontalMargin(): number;
    set overlayTextHorizontalMargin(v: number);
    /**
     * Gets or sets the vertical margin of the overlay text in relation to the annotation shape.
    */
    get overlayTextVerticalMargin(): number;
    set overlayTextVerticalMargin(v: number);
    /**
     * Gets or sets the horizontal padding of the overlay text in relation to the annotation shape.
    */
    get overlayTextHorizontalPadding(): number;
    set overlayTextHorizontalPadding(v: number);
    /**
     * Gets or sets the vertical padding of the overlay text in relation to the annotation shape.
    */
    get overlayTextVerticalPadding(): number;
    set overlayTextVerticalPadding(v: number);
    /**
     * Gets or sets the angle rotation (in degrees) of the overlay text in relation to the annotation shape.
    */
    get overlayTextAngle(): number;
    set overlayTextAngle(v: number);
    /**
     * Gets or sets the color the overlay text.
    */
    get overlayTextColor(): string;
    set overlayTextColor(v: string);
    /**
     * Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift.
    */
    get overlayTextColorShift(): number;
    set overlayTextColorShift(v: number);
    /**
     * Gets or sets the mode used for shifting the background of overlay text.
    */
    get overlayTextColorMode(): AnnotationAppearanceMode;
    set overlayTextColorMode(v: AnnotationAppearanceMode);
    /**
     * Gets or sets the background the overlay text.
    */
    get overlayTextBackground(): string;
    set overlayTextBackground(v: string);
    /**
     * Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift.
    */
    get overlayTextBackgroundShift(): number;
    set overlayTextBackgroundShift(v: number);
    /**
     * Gets or sets the mode used for shifting the background of overlay text.
    */
    get overlayTextBackgroundMode(): AnnotationAppearanceMode;
    set overlayTextBackgroundMode(v: AnnotationAppearanceMode);
    /**
     * Gets or sets the border color of the overlay text.
    */
    get overlayTextBorderColor(): string;
    set overlayTextBorderColor(v: string);
    /**
     * Gets or sets the border radius corner of the overlay text.
    */
    get overlayTextBorderRadius(): number;
    set overlayTextBorderRadius(v: number);
    /**
     * Gets or sets the border thickness of the overlay text.
    */
    get overlayTextBorderThickness(): number;
    set overlayTextBorderThickness(v: number);
    /**
     * Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift.
    */
    get overlayTextBorderShift(): number;
    set overlayTextBorderShift(v: number);
    /**
     * Gets or sets the mode used for shifting the border of overlay text.
    */
    get overlayTextBorderMode(): AnnotationAppearanceMode;
    set overlayTextBorderMode(v: AnnotationAppearanceMode);
    /**
     * Gets or sets whether the overlay text is visible in plot area of the chart
    */
    get overlayTextVisible(): boolean;
    set overlayTextVisible(v: boolean);
    /**
     * Gets or Sets the style to use for the display text.
    */
    get overlayTextStyle(): string;
    set overlayTextStyle(v: string);
}