igniteui-react-charts/lib/igr-data-annotation-slice-layer.d.ts

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

import { IgrDataAnnotationShapeLayer, IIgrDataAnnotationShapeLayerProps } from "./igr-data-annotation-shape-layer";
import { DataAnnotationSliceLayer } from "./DataAnnotationSliceLayer";
/**
 * Represents an annotation layer that renders vertical or horizontal slices/lines at values mapped to AnnotationValueMemberPath property
 * horizontal slices/lines when TargetAxis is set to Y-axis
 * vertical slices/lines when TargetAxis is set to X-axis
*/
export declare class IgrDataAnnotationSliceLayer extends IgrDataAnnotationShapeLayer<IIgrDataAnnotationSliceLayerProps> {
    protected createImplementation(): DataAnnotationSliceLayer;
    /**
                                 * @hidden
                                 */
    get i(): DataAnnotationSliceLayer;
    constructor(props: IIgrDataAnnotationSliceLayerProps);
    /**
     * Gets or sets name of data column with values used to position annotations.
    */
    get annotationValueMemberPath(): string;
    set annotationValueMemberPath(v: string);
    /**
     * Gets or sets mapping custom label on axis annotations.
    */
    get annotationLabelMemberPath(): string;
    set annotationLabelMemberPath(v: string);
    /**
     * Gets or sets a member path for visibility of the badge annotations on an axis.
    */
    get annotationBadgeEnabledMemberPath(): string;
    set annotationBadgeEnabledMemberPath(v: string);
    /**
     * Gets or sets a member path for background of the badge annotations on an axis.
    */
    get annotationBadgeBackgroundMemberPath(): string;
    set annotationBadgeBackgroundMemberPath(v: string);
    /**
     * Gets or sets a member path for outline of the badge annotations on an axis.
    */
    get annotationBadgeOutlineMemberPath(): string;
    set annotationBadgeOutlineMemberPath(v: string);
    /**
     * Gets or sets a member path for image of the badge annotations on an axis.
    */
    get annotationBadgeImageMemberPath(): string;
    set annotationBadgeImageMemberPath(v: string);
}
export interface IIgrDataAnnotationSliceLayerProps extends IIgrDataAnnotationShapeLayerProps {
    /**
     * Gets or sets name of data column with values used to position annotations.
    */
    annotationValueMemberPath?: string;
    /**
     * Gets or sets mapping custom label on axis annotations.
    */
    annotationLabelMemberPath?: string;
    /**
     * Gets or sets a member path for visibility of the badge annotations on an axis.
    */
    annotationBadgeEnabledMemberPath?: string;
    /**
     * Gets or sets a member path for background of the badge annotations on an axis.
    */
    annotationBadgeBackgroundMemberPath?: string;
    /**
     * Gets or sets a member path for outline of the badge annotations on an axis.
    */
    annotationBadgeOutlineMemberPath?: string;
    /**
     * Gets or sets a member path for image of the badge annotations on an axis.
    */
    annotationBadgeImageMemberPath?: string;
}