Represents base class for rendering an annotation with shape of slice of strip

Constructors

Section titled "Constructors"

IgrUserShapeAnnotation

new IgrUserShapeAnnotation(): IgrUserShapeAnnotation

Returns IgrUserShapeAnnotation

Properties

Section titled "Properties"

annotationData

Section titled "annotationData"

Inherited from: IgrUserAxisAnnotation 

annotationData: string

badgeBackground

Section titled "badgeBackground"

Inherited from: IgrUserAxisAnnotation 

badgeBackground: string

badgeCornerRadius

Section titled "badgeCornerRadius"

Inherited from: IgrUserAxisAnnotation 

badgeCornerRadius: number

badgeImagePath

Section titled "badgeImagePath"

Inherited from: IgrUserAxisAnnotation 

badgeImagePath: string

badgeMargin

Section titled "badgeMargin"

Inherited from: IgrUserAxisAnnotation 

badgeMargin: number

badgeOutline

Section titled "badgeOutline"

Inherited from: IgrUserAxisAnnotation 

badgeOutline: string

badgeSize

Section titled "badgeSize"

Inherited from: IgrUserAxisAnnotation 

badgeSize: number

badgeThickness

Section titled "badgeThickness"

Inherited from: IgrUserAxisAnnotation 

badgeThickness: number

badgeVisible

Section titled "badgeVisible"

Inherited from: IgrUserAxisAnnotation 

badgeVisible: boolean

identifier

Section titled "identifier"

Inherited from: IgrUserAxisAnnotation 

identifier: string

isPillShaped

Section titled "isPillShaped"

Inherited from: IgrUserAxisAnnotation 

isPillShaped: boolean

isVisible

Section titled "isVisible"

Inherited from: IgrUserAxisAnnotation 

isVisible: boolean

label

Section titled "label"

Inherited from: IgrUserAxisAnnotation 

label: string

labelBackground

Section titled "labelBackground"

Inherited from: IgrUserAxisAnnotation 

labelBackground: string

labelBorderColor

Section titled "labelBorderColor"

Inherited from: IgrUserAxisAnnotation 

labelBorderColor: string

labelBorderRadius

Section titled "labelBorderRadius"

Inherited from: IgrUserAxisAnnotation 

labelBorderRadius: number

labelBorderThickness

Section titled "labelBorderThickness"

Inherited from: IgrUserAxisAnnotation 

labelBorderThickness: number

labelColor

Section titled "labelColor"

Inherited from: IgrUserAxisAnnotation 

labelColor: string

labelPadding

Section titled "labelPadding"

Inherited from: IgrUserAxisAnnotation 

labelPadding: number

overlayText

Section titled "overlayText" 
overlayText: string

overlayTextAngle

Section titled "overlayTextAngle" 
overlayTextAngle: number

overlayTextBackground

Section titled "overlayTextBackground" 
overlayTextBackground: string

overlayTextBackgroundMode

Section titled "overlayTextBackgroundMode" 
overlayTextBackgroundMode: AnnotationAppearanceMode

overlayTextBackgroundShift

Section titled "overlayTextBackgroundShift" 
overlayTextBackgroundShift: number

overlayTextBorderColor

Section titled "overlayTextBorderColor" 
overlayTextBorderColor: string

overlayTextBorderMode

Section titled "overlayTextBorderMode" 
overlayTextBorderMode: AnnotationAppearanceMode

overlayTextBorderRadius

Section titled "overlayTextBorderRadius" 
overlayTextBorderRadius: number

overlayTextBorderShift

Section titled "overlayTextBorderShift" 
overlayTextBorderShift: number

overlayTextBorderThickness

Section titled "overlayTextBorderThickness" 
overlayTextBorderThickness: number

overlayTextColor

Section titled "overlayTextColor" 
overlayTextColor: string

overlayTextColorMode

Section titled "overlayTextColorMode" 
overlayTextColorMode: AnnotationAppearanceMode

overlayTextColorShift

Section titled "overlayTextColorShift" 
overlayTextColorShift: number

overlayTextHorizontalMargin

Section titled "overlayTextHorizontalMargin" 
overlayTextHorizontalMargin: number

overlayTextHorizontalPadding

Section titled "overlayTextHorizontalPadding" 
overlayTextHorizontalPadding: number

overlayTextLocation

Section titled "overlayTextLocation" 
overlayTextLocation: OverlayTextLocation

overlayTextStyle

Section titled "overlayTextStyle" 
overlayTextStyle: string

overlayTextVerticalMargin

Section titled "overlayTextVerticalMargin" 
overlayTextVerticalMargin: number

overlayTextVerticalPadding

Section titled "overlayTextVerticalPadding" 
overlayTextVerticalPadding: number

overlayTextVisible

Section titled "overlayTextVisible" 
overlayTextVisible: boolean

shapeBackground

Section titled "shapeBackground" 
shapeBackground: string

shapeOutline

Section titled "shapeOutline" 
shapeOutline: string

shapeThickness

Section titled "shapeThickness" 
shapeThickness: number

targetAxis

Section titled "targetAxis"

Inherited from: IgrUserAxisAnnotation 

targetAxis: IgrAxis

targetAxisMatcher

Section titled "targetAxisMatcher"

Inherited from: IgrUserAxisAnnotation 

targetAxisMatcher: IgrAxisMatcher

targetAxisName

Section titled "targetAxisName"

Inherited from: IgrUserAxisAnnotation 

targetAxisName: string

value

Section titled "value"

Inherited from: IgrUserAxisAnnotation 

value: number

valueDisplayMode

Section titled "valueDisplayMode" 
valueDisplayMode: DataAnnotationDisplayMode

Accessors

Section titled "Accessors"

nativeElement

Section titled "nativeElement"

Inherited from: IgrUserAxisAnnotation 

get nativeElement(): HTMLElement

Returns HTMLElement

Methods

Section titled "Methods"

bindAxes

Section titled "bindAxes"

Inherited from: IgrUserAxisAnnotation 

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

Parameters

Returns void

bindSeries

Section titled "bindSeries"

Inherited from: IgrUserAxisAnnotation 

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

Parameters

Returns void

findByName

Section titled "findByName"

Inherited from: IgrUserAxisAnnotation 

findByName(name: string): any

Parameters

  • name: string

Returns any

_createFromInternal

Section titled "_createFromInternal"

Inherited from: IgrUserAxisAnnotation 

_createFromInternal(internal: any): IgrUserBaseAnnotation

Parameters

  • internal: any

Returns IgrUserBaseAnnotation