Represents an user annotation for rendering data strip annotation

Constructors

Section titled "Constructors"

IgrUserStripAnnotation 

new IgrUserStripAnnotation(): IgrUserStripAnnotation

Returns IgrUserStripAnnotation

Accessors

Section titled "Accessors"

annotationData

Section titled "annotationData"

Inherited from: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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

endLabel

Section titled "endLabel"

Gets or sets optional text displayed in the label at the end of annotation.

 
get endLabel(): string

Returns string 

set endLabel(v: string): void

Parameters

  • v: string

Returns void

endLabelBackground

Section titled "endLabelBackground"

Gets or sets background of the label at the end of annotation.

 
get endLabelBackground(): string

Returns string 

set endLabelBackground(v: string): void

Parameters

  • v: string

Returns void

endLabelBorderColor

Section titled "endLabelBorderColor"

Gets or sets border color of the label at the end of annotation.

 
get endLabelBorderColor(): string

Returns string 

set endLabelBorderColor(v: string): void

Parameters

  • v: string

Returns void

endLabelColor

Section titled "endLabelColor"

Gets or sets text color of the label at the end of annotation.

 
get endLabelColor(): string

Returns string 

set endLabelColor(v: string): void

Parameters

  • v: string

Returns void

endValue

Section titled "endValue"

Gets or sets the value that determines end of the annotation on an axis.

 
get endValue(): number

Returns number 

set endValue(v: number): void

Parameters

  • v: number

Returns void

endValueDisplayMode

Section titled "endValueDisplayMode"

Gets or sets display mode of end value of annotation.

 
get endValueDisplayMode(): DataAnnotationDisplayMode

Returns DataAnnotationDisplayMode 

set endValueDisplayMode(v: DataAnnotationDisplayMode): void

Parameters

Returns void

identifier

Section titled "identifier"

Inherited from: IgrUserShapeAnnotation 

get identifier(): string

Returns string 

set identifier(v: string): void

Parameters

  • v: string

Returns void

isPillShaped

Section titled "isPillShaped"

Inherited from: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation

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: IgrUserShapeAnnotation 

get nativeElement(): HTMLElement

Returns HTMLElement

overlayText

Section titled "overlayText"

Inherited from: IgrUserShapeAnnotation

Gets or sets the text that should be overlayed in plot area of the chart.

 
get overlayText(): string

Returns string 

set overlayText(v: string): void

Parameters

  • v: string

Returns void

overlayTextAngle

Section titled "overlayTextAngle"

Inherited from: IgrUserShapeAnnotation

Gets or sets the angle rotation (in degrees) of the overlay text in relation to the annotation shape.

 
get overlayTextAngle(): number

Returns number 

set overlayTextAngle(v: number): void

Parameters

  • v: number

Returns void

overlayTextBackground

Section titled "overlayTextBackground"

Inherited from: IgrUserShapeAnnotation

Gets or sets the background the overlay text.

 
get overlayTextBackground(): string

Returns string 

set overlayTextBackground(v: string): void

Parameters

  • v: string

Returns void

overlayTextBackgroundMode

Section titled "overlayTextBackgroundMode"

Inherited from: IgrUserShapeAnnotation

Gets or sets the mode used for shifting the background of overlay text.

 
get overlayTextBackgroundMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode 

set overlayTextBackgroundMode(v: AnnotationAppearanceMode): void

Parameters

Returns void

overlayTextBackgroundShift

Section titled "overlayTextBackgroundShift"

Inherited from: IgrUserShapeAnnotation

Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift.

 
get overlayTextBackgroundShift(): number

Returns number 

set overlayTextBackgroundShift(v: number): void

Parameters

  • v: number

Returns void

overlayTextBorderColor

Section titled "overlayTextBorderColor"

Inherited from: IgrUserShapeAnnotation

Gets or sets the border color of the overlay text.

 
get overlayTextBorderColor(): string

Returns string 

set overlayTextBorderColor(v: string): void

Parameters

  • v: string

Returns void

overlayTextBorderMode

Section titled "overlayTextBorderMode"

Inherited from: IgrUserShapeAnnotation

Gets or sets the mode used for shifting the border of overlay text.

 
get overlayTextBorderMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode 

set overlayTextBorderMode(v: AnnotationAppearanceMode): void

Parameters

Returns void

overlayTextBorderRadius

Section titled "overlayTextBorderRadius"

Inherited from: IgrUserShapeAnnotation

Gets or sets the border radius corner of the overlay text.

 
get overlayTextBorderRadius(): number

Returns number 

set overlayTextBorderRadius(v: number): void

Parameters

  • v: number

Returns void

overlayTextBorderShift

Section titled "overlayTextBorderShift"

Inherited from: IgrUserShapeAnnotation

Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift.

 
get overlayTextBorderShift(): number

Returns number 

set overlayTextBorderShift(v: number): void

Parameters

  • v: number

Returns void

overlayTextBorderThickness

Section titled "overlayTextBorderThickness"

Inherited from: IgrUserShapeAnnotation

Gets or sets the border thickness of the overlay text.

 
get overlayTextBorderThickness(): number

Returns number 

set overlayTextBorderThickness(v: number): void

Parameters

  • v: number

Returns void

overlayTextColor

Section titled "overlayTextColor"

Inherited from: IgrUserShapeAnnotation

Gets or sets the color the overlay text.

 
get overlayTextColor(): string

Returns string 

set overlayTextColor(v: string): void

Parameters

  • v: string

Returns void

overlayTextColorMode

Section titled "overlayTextColorMode"

Inherited from: IgrUserShapeAnnotation

Gets or sets the mode used for shifting the background of overlay text.

 
get overlayTextColorMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode 

set overlayTextColorMode(v: AnnotationAppearanceMode): void

Parameters

Returns void

overlayTextColorShift

Section titled "overlayTextColorShift"

Inherited from: IgrUserShapeAnnotation

Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift.

 
get overlayTextColorShift(): number

Returns number 

set overlayTextColorShift(v: number): void

Parameters

  • v: number

Returns void

overlayTextHorizontalMargin

Section titled "overlayTextHorizontalMargin"

Inherited from: IgrUserShapeAnnotation

Gets or sets the horizontal margin of the overlay text in relation to the annotation shape.

 
get overlayTextHorizontalMargin(): number

Returns number 

set overlayTextHorizontalMargin(v: number): void

Parameters

  • v: number

Returns void

overlayTextHorizontalPadding

Section titled "overlayTextHorizontalPadding"

Inherited from: IgrUserShapeAnnotation

Gets or sets the horizontal padding of the overlay text in relation to the annotation shape.

 
get overlayTextHorizontalPadding(): number

Returns number 

set overlayTextHorizontalPadding(v: number): void

Parameters

  • v: number

Returns void

overlayTextLocation

Section titled "overlayTextLocation"

Inherited from: IgrUserShapeAnnotation

Gets or sets location of the overlay text in relation to the annotation shape.

 
get overlayTextLocation(): OverlayTextLocation

Returns OverlayTextLocation 

set overlayTextLocation(v: OverlayTextLocation): void

Parameters

Returns void

overlayTextStyle

Section titled "overlayTextStyle"

Inherited from: IgrUserShapeAnnotation

Gets or Sets the style to use for the display text.

 
get overlayTextStyle(): string

Returns string 

set overlayTextStyle(v: string): void

Parameters

  • v: string

Returns void

overlayTextVerticalMargin

Section titled "overlayTextVerticalMargin"

Inherited from: IgrUserShapeAnnotation

Gets or sets the vertical margin of the overlay text in relation to the annotation shape.

 
get overlayTextVerticalMargin(): number

Returns number 

set overlayTextVerticalMargin(v: number): void

Parameters

  • v: number

Returns void

overlayTextVerticalPadding

Section titled "overlayTextVerticalPadding"

Inherited from: IgrUserShapeAnnotation

Gets or sets the vertical padding of the overlay text in relation to the annotation shape.

 
get overlayTextVerticalPadding(): number

Returns number 

set overlayTextVerticalPadding(v: number): void

Parameters

  • v: number

Returns void

overlayTextVisible

Section titled "overlayTextVisible"

Inherited from: IgrUserShapeAnnotation

Gets or sets whether the overlay text is visible in plot area of the chart

 
get overlayTextVisible(): boolean

Returns boolean 

set overlayTextVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

shapeBackground

Section titled "shapeBackground"

Inherited from: IgrUserShapeAnnotation

Gets or sets background of the annotation shape displayed in the plot area of the chart.

 
get shapeBackground(): string

Returns string 

set shapeBackground(v: string): void

Parameters

  • v: string

Returns void

shapeOutline

Section titled "shapeOutline"

Inherited from: IgrUserShapeAnnotation

Gets or sets border color of the annotation shape displayed in the plot area of the chart.

 
get shapeOutline(): string

Returns string 

set shapeOutline(v: string): void

Parameters

  • v: string

Returns void

shapeThickness

Section titled "shapeThickness"

Inherited from: IgrUserShapeAnnotation

Gets or sets border thickness of the annotation shape displayed in the plot area of the chart.

 
get shapeThickness(): number

Returns number 

set shapeThickness(v: number): void

Parameters

  • v: number

Returns void

startLabel

Section titled "startLabel"

Gets or sets optional text displayed in the label at the start of annotation.

 
get startLabel(): string

Returns string 

set startLabel(v: string): void

Parameters

  • v: string

Returns void

startLabelBackground

Section titled "startLabelBackground"

Gets or sets background of the label at the start of annotation.

 
get startLabelBackground(): string

Returns string 

set startLabelBackground(v: string): void

Parameters

  • v: string

Returns void

startLabelBorderColor

Section titled "startLabelBorderColor"

Gets or sets border color of the label at the start of annotation.

 
get startLabelBorderColor(): string

Returns string 

set startLabelBorderColor(v: string): void

Parameters

  • v: string

Returns void

startLabelColor

Section titled "startLabelColor"

Gets or sets text color of the label at the start of annotation.

 
get startLabelColor(): string

Returns string 

set startLabelColor(v: string): void

Parameters

  • v: string

Returns void

startValue

Section titled "startValue"

Gets or sets the value that determines start of the annotation on an axis.

 
get startValue(): number

Returns number 

set startValue(v: number): void

Parameters

  • v: number

Returns void

startValueDisplayMode

Section titled "startValueDisplayMode"

Gets or sets display mode of start value of annotation.

 
get startValueDisplayMode(): DataAnnotationDisplayMode

Returns DataAnnotationDisplayMode 

set startValueDisplayMode(v: DataAnnotationDisplayMode): void

Parameters

Returns void

targetAxis

Section titled "targetAxis"

Inherited from: IgrUserShapeAnnotation

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

 
get targetAxis(): IgrAxis

Returns IgrAxis 

set targetAxis(v: IgrAxis): void

Parameters

Returns void

targetAxisMatcher

Section titled "targetAxisMatcher"

Inherited from: IgrUserShapeAnnotation

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

 
get targetAxisMatcher(): IgrAxisMatcher

Returns IgrAxisMatcher 

set targetAxisMatcher(v: IgrAxisMatcher): void

Parameters

Returns void

targetAxisName

Section titled "targetAxisName"

Inherited from: IgrUserShapeAnnotation

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

 
get targetAxisName(): string

Returns string 

set targetAxisName(v: string): void

Parameters

  • v: string

Returns void

value

Section titled "value"

Inherited from: IgrUserShapeAnnotation

Gets or sets the value that determines location of annotation on axis.

 
get value(): number

Returns number 

set value(v: number): void

Parameters

  • v: number

Returns void

valueDisplayMode

Section titled "valueDisplayMode"

Inherited from: IgrUserShapeAnnotation

Gets or sets display mode of label in the center annotation.

 
get valueDisplayMode(): DataAnnotationDisplayMode

Returns DataAnnotationDisplayMode 

set valueDisplayMode(v: DataAnnotationDisplayMode): void

Parameters

Returns void

Methods

Section titled "Methods"

bindAxes

Section titled "bindAxes"

Inherited from: IgrUserShapeAnnotation 

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

Parameters

Returns void

bindSeries

Section titled "bindSeries"

Inherited from: IgrUserShapeAnnotation 

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

Parameters

Returns void

findByName

Section titled "findByName"

Inherited from: IgrUserShapeAnnotation 

findByName(name: string): any

Parameters

  • name: string

Returns any

_createFromInternal

Section titled "_createFromInternal"

Inherited from: IgrUserShapeAnnotation 

_createFromInternal(internal: any): IgrUserBaseAnnotation

Parameters

  • internal: any

Returns IgrUserBaseAnnotation