Represents an user annotation for rendering data point annotation on a series

Constructors

Section titled "Constructors"

IgrUserPointAnnotation 

new IgrUserPointAnnotation(): IgrUserPointAnnotation

Returns IgrUserPointAnnotation

Accessors

Section titled "Accessors"

annotationData

Section titled "annotationData"

Inherited from: IgrUserBaseAnnotation

Gets or sets the additional data that should be stored with the annotation.

 
get annotationData(): string

Returns string 

set annotationData(v: string): void

Parameters

  • v: string

Returns void

badgeBackground

Section titled "badgeBackground"

Inherited from: IgrUserBaseAnnotation

Gets or sets the background of badge annotation.

 
get badgeBackground(): string

Returns string 

set badgeBackground(v: string): void

Parameters

  • v: string

Returns void

badgeCornerRadius

Section titled "badgeCornerRadius"

Inherited from: IgrUserBaseAnnotation

Gets or sets border radius of the badge annotations.

 
get badgeCornerRadius(): number

Returns number 

set badgeCornerRadius(v: number): void

Parameters

  • v: number

Returns void

badgeImagePath

Section titled "badgeImagePath"

Inherited from: IgrUserBaseAnnotation

Gets or sets image path for displayed in the badge annotations.

 
get badgeImagePath(): string

Returns string 

set badgeImagePath(v: string): void

Parameters

  • v: string

Returns void

badgeMargin

Section titled "badgeMargin"

Inherited from: IgrUserBaseAnnotation

Gets or sets margin of the badge annotations.

 
get badgeMargin(): number

Returns number 

set badgeMargin(v: number): void

Parameters

  • v: number

Returns void

badgeOutline

Section titled "badgeOutline"

Inherited from: IgrUserBaseAnnotation

Gets or sets the outline of badge annotation.

 
get badgeOutline(): string

Returns string 

set badgeOutline(v: string): void

Parameters

  • v: string

Returns void

badgeSize

Section titled "badgeSize"

Inherited from: IgrUserBaseAnnotation

Gets or sets size of the badge annotations.

 
get badgeSize(): number

Returns number 

set badgeSize(v: number): void

Parameters

  • v: number

Returns void

badgeThickness

Section titled "badgeThickness"

Inherited from: IgrUserBaseAnnotation

Gets or sets thickness of the badge annotations.

 
get badgeThickness(): number

Returns number 

set badgeThickness(v: number): void

Parameters

  • v: number

Returns void

badgeVisible

Section titled "badgeVisible"

Inherited from: IgrUserBaseAnnotation

Gets or sets whether to draw the badge in annotation

 
get badgeVisible(): boolean

Returns boolean 

set badgeVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

identifier

Section titled "identifier"

Inherited from: IgrUserBaseAnnotation 

get identifier(): string

Returns string 

set identifier(v: string): void

Parameters

  • v: string

Returns void

isPillShaped

Section titled "isPillShaped"

Inherited from: IgrUserBaseAnnotation

Gets or sets whether the annotation is pill shaped.

 
get isPillShaped(): boolean

Returns boolean 

set isPillShaped(v: boolean): void

Parameters

  • v: boolean

Returns void

isVisible

Section titled "isVisible"

Inherited from: IgrUserBaseAnnotation

Gets or sets whether to the annotations is rendered

 
get isVisible(): boolean

Returns boolean 

set isVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

label

Section titled "label"

Inherited from: IgrUserBaseAnnotation

Gets or sets the text that should be displayed on axis annotation.

 
get label(): string

Returns string 

set label(v: string): void

Parameters

  • v: string

Returns void

labelBackground

Section titled "labelBackground"

Inherited from: IgrUserBaseAnnotation

Gets or sets the background text displayed in the annotation.

 
get labelBackground(): string

Returns string 

set labelBackground(v: string): void

Parameters

  • v: string

Returns void

labelBorderColor

Section titled "labelBorderColor"

Inherited from: IgrUserBaseAnnotation

Gets or sets the border color of the axis annotation.

 
get labelBorderColor(): string

Returns string 

set labelBorderColor(v: string): void

Parameters

  • v: string

Returns void

labelBorderRadius

Section titled "labelBorderRadius"

Inherited from: IgrUserBaseAnnotation

Gets or sets the border radius of the annotation.

 
get labelBorderRadius(): number

Returns number 

set labelBorderRadius(v: number): void

Parameters

  • v: number

Returns void

labelBorderThickness

Section titled "labelBorderThickness"

Inherited from: IgrUserBaseAnnotation

Gets or sets border thickness of the axis annotations.

 
get labelBorderThickness(): number

Returns number 

set labelBorderThickness(v: number): void

Parameters

  • v: number

Returns void

labelColor

Section titled "labelColor"

Inherited from: IgrUserBaseAnnotation

Gets or sets the color of text displayed in the annotation.

 
get labelColor(): string

Returns string 

set labelColor(v: string): void

Parameters

  • v: string

Returns void

labelPadding

Section titled "labelPadding"

Inherited from: IgrUserBaseAnnotation

Gets or sets padding around the label in annotation.

 
get labelPadding(): number

Returns number 

set labelPadding(v: number): void

Parameters

  • v: number

Returns void

nativeElement

Section titled "nativeElement"

Inherited from: IgrUserBaseAnnotation 

get nativeElement(): HTMLElement

Returns HTMLElement

targetSeries

Section titled "targetSeries"

Gets or sets the target series that will display the annotation.

 
get targetSeries(): IgrSeries

Returns IgrSeries 

set targetSeries(v: IgrSeries): void

Parameters

Returns void

targetSeriesMatcher

Section titled "targetSeriesMatcher"

Gets or sets a matcher for matching a series that will display the annotation.

 
get targetSeriesMatcher(): IgrSeriesMatcher

Returns IgrSeriesMatcher 

set targetSeriesMatcher(v: IgrSeriesMatcher): void

Parameters

Returns void

targetSeriesName

Section titled "targetSeriesName"

Gets or sets the name to use to resolve targetSeries from markup.

 
get targetSeriesName(): string

Returns string 

set targetSeriesName(v: string): void

Parameters

  • v: string

Returns void

xValue

Section titled "xValue"

Gets or sets the value that determines location of the annotation in the coordinates of x-axis.

 
get xValue(): number

Returns number 

set xValue(v: number): void

Parameters

  • v: number

Returns void

yValue

Section titled "yValue"

Gets or sets the value that determines location of the annotation in the coordinates of y-axis.

 
get yValue(): number

Returns number 

set yValue(v: number): void

Parameters

  • v: number

Returns void

Methods

Section titled "Methods"

bindAxes

Section titled "bindAxes"

Inherited from: IgrUserBaseAnnotation 

bindAxes(axes: IgrAxis<IIgrAxisProps>[]): void

Parameters

Returns void

bindSeries

Section titled "bindSeries" 
bindSeries(series: IgrSeries<IIgrSeriesProps>[]): void

Parameters

Returns void

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

_createFromInternal

Section titled "_createFromInternal"

Inherited from: IgrUserBaseAnnotation 

_createFromInternal(internal: any): IgrUserBaseAnnotation

Parameters

  • internal: any

Returns IgrUserBaseAnnotation