igniteui-webcomponents-charts/lib/igc-data-annotation-axis-layer-component.d.ts

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

import { DataAnnotationDisplayMode } from "./DataAnnotationDisplayMode";
import { AnnotationAppearanceMode } from "./AnnotationAppearanceMode";
import { IgcAxisComponent } from "./igc-axis-component";
import { DataAnnotationTargetMode } from "./DataAnnotationTargetMode";
import { IgcAnnotationLayerComponent } from "./igc-annotation-layer-component";
import { DataAnnotationAxisLayer } from "./DataAnnotationAxisLayer";
/**
 * Represents a base annotation layer that displays annotations over an axis.
*/
export declare abstract class IgcDataAnnotationAxisLayerComponent extends IgcAnnotationLayerComponent {
    /**
                                 * @hidden
                                 */
    get i(): DataAnnotationAxisLayer;
    constructor();
    connectedCallback(): void;
    disconnectedCallback(): void;
    private static _observedAttributesIgcDataAnnotationAxisLayerComponent;
    static get observedAttributes(): string[];
    /**
     * Gets or sets display mode of label on axis annotation.
    */
    get annotationLabelDisplayMode(): DataAnnotationDisplayMode;
    set annotationLabelDisplayMode(v: DataAnnotationDisplayMode);
    /**
     * Gets or sets whether to show all annotations over target axis
    */
    get annotationLabelVisible(): boolean;
    set annotationLabelVisible(v: boolean);
    /**
     * Gets or sets the text color used in the axis annotation.
    */
    get annotationTextColor(): string;
    set annotationTextColor(v: string);
    /**
     * Gets or sets the mode used for shifting the text color in axis annotation.
    */
    get annotationTextColorMode(): AnnotationAppearanceMode;
    set annotationTextColorMode(v: AnnotationAppearanceMode);
    /**
     * Gets or sets the percentage used to shift AnnotationTextColor. Value must range between -1.0 to 1.0, where 0 means no color shift.
    */
    get annotationTextColorShift(): number;
    set annotationTextColorShift(v: number);
    /**
     * Gets or sets whether the annotation text color matches brush of the layer
    */
    get annotationTextColorMatchLayer(): boolean;
    set annotationTextColorMatchLayer(v: boolean);
    /**
     * Gets or sets the color used for backing of the axis annotation.
    */
    get annotationBackground(): string;
    set annotationBackground(v: string);
    /**
     * Gets or sets the border radius used for displaying the axis annotation.
    */
    get annotationBorderRadius(): number;
    set annotationBorderRadius(v: number);
    /**
     * Gets or sets the mode used for shifting the background of axis annotation.
    */
    get annotationBackgroundMode(): AnnotationAppearanceMode;
    set annotationBackgroundMode(v: AnnotationAppearanceMode);
    /**
     * Gets or sets the percentage used to shift AnnotationBackground. Value must range between -1.0 to 1.0, where 0 means no color shift.
    */
    get annotationBackgroundShift(): number;
    set annotationBackgroundShift(v: number);
    /**
     * Gets or sets whether the annotation background matches brush of the layer
    */
    get annotationBackgroundMatchLayer(): boolean;
    set annotationBackgroundMatchLayer(v: boolean);
    /**
     * Gets or sets whether the annotation border matches outline of the layer (if it has a fill visual) otherwise brush of the layer
    */
    get annotationBorderMatchLayer(): boolean;
    set annotationBorderMatchLayer(v: boolean);
    /**
     * Gets or sets the color used for border color of the axis annotation.
    */
    get annotationBorderColor(): string;
    set annotationBorderColor(v: string);
    /**
     * Gets or sets the mode used for shifting border color of the axis annotation.
    */
    get annotationBorderMode(): AnnotationAppearanceMode;
    set annotationBorderMode(v: AnnotationAppearanceMode);
    /**
     * Gets or sets the percentage amount used to shift AnnotationBorderColor. Value must range between -1.0 to 1.0, where 0 means no color shift.
    */
    get annotationBorderShift(): number;
    set annotationBorderShift(v: number);
    get annotationPaddingBottom(): number;
    set annotationPaddingBottom(v: number);
    get annotationPaddingLeft(): number;
    set annotationPaddingLeft(v: number);
    get annotationPaddingRight(): number;
    set annotationPaddingRight(v: number);
    get annotationPaddingTop(): number;
    set annotationPaddingTop(v: number);
    ensureAnnotationPadding(): void;
    /**
     * Gets or sets border thickness of the axis annotations.
    */
    get annotationBorderThickness(): number;
    set annotationBorderThickness(v: number);
    /**
     * Gets or sets maximum precision for displaying values on axis annotation.
    */
    get annotationValueMaxPrecision(): number;
    set annotationValueMaxPrecision(v: number);
    /**
     * Gets or sets minimum precision for displaying values on axis annotation.
    */
    get annotationValueMinPrecision(): number;
    set annotationValueMinPrecision(v: number);
    /**
     * Gets or sets the target axis for this annotation. If null, this annotation will use TargetMode to determine target axis.
    */
    get targetAxis(): IgcAxisComponent;
    set targetAxis(v: IgcAxisComponent);
    /**
     * Gets or sets the mode for targeting axes present in the chart. Defaults to targeting all category-axes present in the chart
    */
    get targetMode(): DataAnnotationTargetMode;
    set targetMode(v: DataAnnotationTargetMode);
    findByName(name: string): any;
    protected _styling(container: any, component: any, parent?: any): void;
}