igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
139 lines (138 loc) • 4.97 kB
TypeScript
import { AxisAnnotation as AxisAnnotation_internal } from "./AxisAnnotation";
import { ContentChildrenManager } from "igniteui-react-core";
/**
* Represents an axis annotation
*/
export declare class IgrAxisAnnotation {
protected createImplementation(): AxisAnnotation_internal;
protected _implementation: any;
protected mounted: boolean;
get nativeElement(): HTMLElement;
/**
* @hidden
*/
get i(): AxisAnnotation_internal;
protected onImplementationCreated(): void;
protected _contentChildrenManager: ContentChildrenManager;
constructor();
protected _provideImplementation(i: any): void;
/**
* Gets or sets the value at which this annotation is displayed on the axis.
*/
get value(): any;
set value(v: any);
/**
* Gets or sets the text that should be displayed for the annotation. Leave null to display the value automatically.
*/
get text(): string;
set text(v: string);
/**
* Gets or sets the corner radius to use for the axis annotation borders.
*/
get backgroundCornerRadius(): number;
set backgroundCornerRadius(v: number);
/**
* Gets or sets the label format string to use for the label.
*/
get labelFormat(): string;
set labelFormat(v: string);
/**
* Gets or sets the format specifiers to use with the LabelFormat string.
*/
get labelFormatSpecifiers(): any[];
set labelFormatSpecifiers(v: any[]);
/**
* Sets or gets a function which takes an object that produces a formatted label for the value of this annotation.
*/
get formatLabel(): (item: any) => string;
set formatLabel(v: (item: any) => string);
/**
* Gets or sets the color to use for the text in the annotation.
*/
get textColor(): string;
set textColor(v: string);
/**
* Gets or sets the background to use for tha axis annotation box.
*/
get background(): string;
set background(v: string);
/**
* Gets or sets the Outline to use for tha axis annotation box.
*/
get outline(): string;
set outline(v: string);
/**
* Gets or sets the border stroke thickness to use for tha axis annotation box.
*/
get strokeThickness(): number;
set strokeThickness(v: number);
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get backgroundPaddingLeft(): number;
set backgroundPaddingLeft(v: number);
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get backgroundPaddingTop(): number;
set backgroundPaddingTop(v: number);
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get backgroundPaddingRight(): number;
set backgroundPaddingRight(v: number);
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get backgroundPaddingBottom(): number;
set backgroundPaddingBottom(v: number);
/**
* Gets or sets whether the annotation is pill shaped. This will automatically adjust the background corner radius to make
* it appear pill shaped.
*/
get isPillShaped(): boolean;
set isPillShaped(v: boolean);
/**
* Gets or sets whether the badge is enabled in the annotation.
*/
get isBadgeEnabled(): boolean;
set isBadgeEnabled(v: boolean);
/**
* Gets or sets the background color to use for the badge inside the axis annotation box.
*/
get badgeBackground(): string;
set badgeBackground(v: string);
/**
* Gets or sets the outline color to use for the badge inside the axis annotation box.
*/
get badgeOutline(): string;
set badgeOutline(v: string);
/**
* Gets or sets the outline thickness for the badge inside the axis annotation box.
*/
get badgeOutlineThickness(): number;
set badgeOutlineThickness(v: number);
/**
* Gets or sets the corner radius for the badge inside the axis annotation box.
*/
get badgeCornerRadius(): number;
set badgeCornerRadius(v: number);
/**
* Gets or sets the spacing between the badge and text inside the axis annotation box.
*/
get badgeMargin(): number;
set badgeMargin(v: number);
/**
* Gets or sets the size of the badge inside the axis annotation box.
*/
get badgeSize(): number;
set badgeSize(v: number);
/**
* Gets or sets the image path to use for the badge.
*/
get badgeImagePath(): string;
set badgeImagePath(v: string);
findByName(name: string): any;
resetCachedExtent(): void;
resolveLabelValue(): string;
}