IgxUserStripAnnotation

Represents an user annotation for rendering data strip annotation

Constructors

new IgxUserStripAnnotation(): IgxUserStripAnnotation

Returns IgxUserStripAnnotation

Properties

ngAcceptInputType_badgeCornerRadius

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_badgeCornerRadius: string | number

ngAcceptInputType_badgeMargin

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_badgeMargin: string | number

ngAcceptInputType_badgeSize

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_badgeSize: string | number

ngAcceptInputType_badgeThickness

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_badgeThickness: string | number

ngAcceptInputType_badgeVisible

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_badgeVisible: string | boolean

ngAcceptInputType_endValue

ngAcceptInputType_endValue: string | number

ngAcceptInputType_endValueDisplayMode

ngAcceptInputType_endValueDisplayMode: string | DataAnnotationDisplayMode

ngAcceptInputType_isPillShaped

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_isPillShaped: string | boolean

ngAcceptInputType_isVisible

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_isVisible: string | boolean

ngAcceptInputType_labelBorderRadius

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_labelBorderRadius: string | number

ngAcceptInputType_labelBorderThickness

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_labelBorderThickness: string | number

ngAcceptInputType_labelPadding

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_labelPadding: string | number

ngAcceptInputType_overlayTextAngle

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextAngle: string | number

ngAcceptInputType_overlayTextBackgroundMode

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextBackgroundMode: string | AnnotationAppearanceMode

ngAcceptInputType_overlayTextBackgroundShift

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextBackgroundShift: string | number

ngAcceptInputType_overlayTextBorderMode

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextBorderMode: string | AnnotationAppearanceMode

ngAcceptInputType_overlayTextBorderRadius

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextBorderRadius: string | number

ngAcceptInputType_overlayTextBorderShift

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextBorderShift: string | number

ngAcceptInputType_overlayTextBorderThickness

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextBorderThickness: string | number

ngAcceptInputType_overlayTextColorMode

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextColorMode: string | AnnotationAppearanceMode

ngAcceptInputType_overlayTextColorShift

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextColorShift: string | number

ngAcceptInputType_overlayTextHorizontalMargin

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextHorizontalMargin: string | number

ngAcceptInputType_overlayTextHorizontalPadding

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextHorizontalPadding: string | number

ngAcceptInputType_overlayTextLocation

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextLocation: string | OverlayTextLocation

ngAcceptInputType_overlayTextVerticalMargin

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextVerticalMargin: string | number

ngAcceptInputType_overlayTextVerticalPadding

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextVerticalPadding: string | number

ngAcceptInputType_overlayTextVisible

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_overlayTextVisible: string | boolean

ngAcceptInputType_shapeThickness

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_shapeThickness: string | number

ngAcceptInputType_startValue

ngAcceptInputType_startValue: string | number

ngAcceptInputType_startValueDisplayMode

ngAcceptInputType_startValueDisplayMode: string | DataAnnotationDisplayMode

ngAcceptInputType_value

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_value: string | number

ngAcceptInputType_valueDisplayMode

Inherited from: IgxUserShapeAnnotation

ngAcceptInputType_valueDisplayMode: string | DataAnnotationDisplayMode

Accessors

annotationData

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

Gets or sets the background of badge annotation.

get badgeBackground(): string

Returns string

set badgeBackground(v: string): void

Parameters

v: string

Returns void

badgeCornerRadius

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

Gets or sets margin of the badge annotations.

get badgeMargin(): number

Returns number

set badgeMargin(v: number): void

Parameters

v: number

Returns void

badgeOutline

Inherited from: IgxUserShapeAnnotation

Gets or sets the outline of badge annotation.

get badgeOutline(): string

Returns string

set badgeOutline(v: string): void

Parameters

v: string

Returns void

badgeSize

Inherited from: IgxUserShapeAnnotation

Gets or sets size of the badge annotations.

get badgeSize(): number

Returns number

set badgeSize(v: number): void

Parameters

v: number

Returns void

badgeThickness

Inherited from: IgxUserShapeAnnotation

Gets or sets thickness of the badge annotations.

get badgeThickness(): number

Returns number

set badgeThickness(v: number): void

Parameters

v: number

Returns void

badgeVisible

Inherited from: IgxUserShapeAnnotation

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

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

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

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

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

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

Gets or sets display mode of end value of annotation.

get endValueDisplayMode(): DataAnnotationDisplayMode

Returns DataAnnotationDisplayMode

set endValueDisplayMode(v: DataAnnotationDisplayMode): void

Parameters

v: DataAnnotationDisplayMode

Returns void

identifier

Inherited from: IgxUserShapeAnnotation

get identifier(): string

Returns string

set identifier(v: string): void

Parameters

v: string

Returns void

isPillShaped

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

Gets or sets padding around the label in annotation.

get labelPadding(): number

Returns number

set labelPadding(v: number): void

Parameters

v: number

Returns void

overlayText

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

Gets or sets the background the overlay text.

get overlayTextBackground(): string

Returns string

set overlayTextBackground(v: string): void

Parameters

v: string

Returns void

overlayTextBackgroundMode

Inherited from: IgxUserShapeAnnotation

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

get overlayTextBackgroundMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode

set overlayTextBackgroundMode(v: AnnotationAppearanceMode): void

Parameters

v: AnnotationAppearanceMode

Returns void

overlayTextBackgroundShift

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

get overlayTextBorderMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode

set overlayTextBorderMode(v: AnnotationAppearanceMode): void

Parameters

v: AnnotationAppearanceMode

Returns void

overlayTextBorderRadius

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

Gets or sets the color the overlay text.

get overlayTextColor(): string

Returns string

set overlayTextColor(v: string): void

Parameters

v: string

Returns void

overlayTextColorMode

Inherited from: IgxUserShapeAnnotation

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

get overlayTextColorMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode

set overlayTextColorMode(v: AnnotationAppearanceMode): void

Parameters

v: AnnotationAppearanceMode

Returns void

overlayTextColorShift

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

v: OverlayTextLocation

Returns void

overlayTextStyle

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

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

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

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

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

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

Gets or sets display mode of start value of annotation.

get startValueDisplayMode(): DataAnnotationDisplayMode

Returns DataAnnotationDisplayMode

set startValueDisplayMode(v: DataAnnotationDisplayMode): void

Parameters

v: DataAnnotationDisplayMode

Returns void

targetAxis

Inherited from: IgxUserShapeAnnotation

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

get targetAxis(): IgxAxisComponent

Returns IgxAxisComponent

set targetAxis(v: IgxAxisComponent): void

Parameters

v: IgxAxisComponent

Returns void

targetAxisMatcher

Inherited from: IgxUserShapeAnnotation

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

get targetAxisMatcher(): IgxAxisMatcher

Returns IgxAxisMatcher

set targetAxisMatcher(v: IgxAxisMatcher): void

Parameters

v: IgxAxisMatcher

Returns void

value

Inherited from: IgxUserShapeAnnotation

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

Inherited from: IgxUserShapeAnnotation

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

get valueDisplayMode(): DataAnnotationDisplayMode

Returns DataAnnotationDisplayMode

set valueDisplayMode(v: DataAnnotationDisplayMode): void

Parameters

v: DataAnnotationDisplayMode

Returns void

Methods

bindAxes

Inherited from: IgxUserShapeAnnotation

bindAxes(axes: IgxAxisComponent[]): void

Parameters

axes: IgxAxisComponent[]

Returns void

bindSeries

Inherited from: IgxUserShapeAnnotation

bindSeries(series: IgxSeriesComponent[]): void

Parameters

series: IgxSeriesComponent[]

Returns void

findByName

Inherited from: IgxUserShapeAnnotation

findByName(name: string): any

Parameters

name: string

Returns any

_createFromInternal

Inherited from: IgxUserShapeAnnotation

_createFromInternal(internal: any): IgxUserBaseAnnotation

Parameters

internal: any