IgxAxisAnnotation

Represents an axis annotation

Constructors

new IgxAxisAnnotation(): IgxAxisAnnotation

Returns IgxAxisAnnotation

Properties

ngAcceptInputType_backgroundCornerRadius

ngAcceptInputType_backgroundCornerRadius: string | number

ngAcceptInputType_backgroundPaddingBottom

ngAcceptInputType_backgroundPaddingBottom: string | number

ngAcceptInputType_backgroundPaddingLeft

ngAcceptInputType_backgroundPaddingLeft: string | number

ngAcceptInputType_backgroundPaddingRight

ngAcceptInputType_backgroundPaddingRight: string | number

ngAcceptInputType_backgroundPaddingTop

ngAcceptInputType_backgroundPaddingTop: string | number

ngAcceptInputType_badgeCornerRadius

ngAcceptInputType_badgeCornerRadius: string | number

ngAcceptInputType_badgeMargin

ngAcceptInputType_badgeMargin: string | number

ngAcceptInputType_badgeOutlineThickness

ngAcceptInputType_badgeOutlineThickness: string | number

ngAcceptInputType_badgeSize

ngAcceptInputType_badgeSize: string | number

ngAcceptInputType_isBadgeEnabled

ngAcceptInputType_isBadgeEnabled: string | boolean

ngAcceptInputType_isPillShaped

ngAcceptInputType_isPillShaped: string | boolean

ngAcceptInputType_labelFormatSpecifiers

ngAcceptInputType_labelFormatSpecifiers: string | any[]

ngAcceptInputType_strokeThickness

ngAcceptInputType_strokeThickness: string | number

Accessors

background

Gets or sets the background to use for tha axis annotation box.

get background(): string

Returns string

set background(v: string): void

Parameters

v: string

Returns void

backgroundCornerRadius

Gets or sets the corner radius to use for the axis annotation borders.

get backgroundCornerRadius(): number

Returns number

set backgroundCornerRadius(v: number): void

Parameters

v: number

Returns void

backgroundPaddingBottom

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

Returns number

set backgroundPaddingBottom(v: number): void

Parameters

v: number

Returns void

backgroundPaddingLeft

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

Returns number

set backgroundPaddingLeft(v: number): void

Parameters

v: number

Returns void

backgroundPaddingRight

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

Returns number

set backgroundPaddingRight(v: number): void

Parameters

v: number

Returns void

backgroundPaddingTop

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

Returns number

set backgroundPaddingTop(v: number): void

Parameters

v: number

Returns void

badgeBackground

Gets or sets the background color to use for the badge inside the axis annotation box.

get badgeBackground(): string

Returns string

set badgeBackground(v: string): void

Parameters

v: string

Returns void

badgeCornerRadius

Gets or sets the corner radius for the badge inside the axis annotation box.

get badgeCornerRadius(): number

Returns number

set badgeCornerRadius(v: number): void

Parameters

v: number

Returns void

badgeImagePath

Gets or sets the image path to use for the badge.

get badgeImagePath(): string

Returns string

set badgeImagePath(v: string): void

Parameters

v: string

Returns void

badgeMargin

Gets or sets the spacing between the badge and text inside the axis annotation box.

get badgeMargin(): number

Returns number

set badgeMargin(v: number): void

Parameters

v: number

Returns void

badgeOutline

Gets or sets the outline color to use for the badge inside the axis annotation box.

get badgeOutline(): string

Returns string

set badgeOutline(v: string): void

Parameters

v: string

Returns void

badgeOutlineThickness

Gets or sets the outline thickness for the badge inside the axis annotation box.

get badgeOutlineThickness(): number

Returns number

set badgeOutlineThickness(v: number): void

Parameters

v: number

Returns void

badgeSize

Gets or sets the size of the badge inside the axis annotation box.

get badgeSize(): number

Returns number

set badgeSize(v: number): void

Parameters

v: number

Returns void

formatLabel

Sets or gets a function which takes an object that produces a formatted label for the value of this annotation.

get formatLabel(): object

Returns object

set formatLabel(v: object): void

Parameters

v: object

Returns void

isBadgeEnabled

Gets or sets whether the badge is enabled in the annotation.

get isBadgeEnabled(): boolean

Returns boolean

set isBadgeEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isPillShaped

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

Returns boolean

set isPillShaped(v: boolean): void

Parameters

v: boolean

Returns void

labelFormat

Gets or sets the label format string to use for the label.

get labelFormat(): string

Returns string

set labelFormat(v: string): void

Parameters

v: string

Returns void

labelFormatSpecifiers

Gets or sets the format specifiers to use with the LabelFormat string.

get labelFormatSpecifiers(): any[]

Returns any[]

set labelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

outline

Gets or sets the Outline to use for tha axis annotation box.

get outline(): string

Returns string

set outline(v: string): void

Parameters

v: string

Returns void

strokeThickness

Gets or sets the border stroke thickness to use for tha axis annotation box.

get strokeThickness(): number

Returns number

set strokeThickness(v: number): void

Parameters

v: number

Returns void

text

Gets or sets the text that should be displayed for the annotation. Leave null to display the value automatically.

get text(): string

Returns string

set text(v: string): void

Parameters

v: string

Returns void

textColor

Gets or sets the color to use for the text in the annotation.

get textColor(): string

Returns string

set textColor(v: string): void

Parameters

v: string

Returns void

value

Gets or sets the value at which this annotation is displayed on the axis.

get value(): any

Returns any

set value(v: any): void

Parameters

v: any

Returns void

Methods

findByName

findByName(name: string): any

Parameters

name: string

Returns any

resetCachedExtent

resetCachedExtent(): void

Returns void

resolveLabelValue

resolveLabelValue(): string

Constructors