Represents base class for all user annotations, e.g. UserPointAnnotation, UserSliceAnnotation, UserStripAnnotation, UserAxisAnnotation
Constructors
Section titled "Constructors"IgxUserBaseAnnotation
new IgxUserBaseAnnotation(): IgxUserBaseAnnotationReturns IgxUserBaseAnnotation
Properties
Section titled "Properties"ngAcceptInputType_badgeCornerRadius
Section titled "ngAcceptInputType_badgeCornerRadius"ngAcceptInputType_badgeCornerRadius: string | numberngAcceptInputType_badgeMargin
Section titled "ngAcceptInputType_badgeMargin"ngAcceptInputType_badgeMargin: string | numberngAcceptInputType_badgeSize
Section titled "ngAcceptInputType_badgeSize"ngAcceptInputType_badgeSize: string | numberngAcceptInputType_badgeThickness
Section titled "ngAcceptInputType_badgeThickness"ngAcceptInputType_badgeThickness: string | numberngAcceptInputType_badgeVisible
Section titled "ngAcceptInputType_badgeVisible"ngAcceptInputType_badgeVisible: string | booleanngAcceptInputType_isPillShaped
Section titled "ngAcceptInputType_isPillShaped"ngAcceptInputType_isPillShaped: string | booleanngAcceptInputType_isVisible
Section titled "ngAcceptInputType_isVisible"ngAcceptInputType_isVisible: string | booleanngAcceptInputType_labelBorderRadius
Section titled "ngAcceptInputType_labelBorderRadius"ngAcceptInputType_labelBorderRadius: string | numberngAcceptInputType_labelBorderThickness
Section titled "ngAcceptInputType_labelBorderThickness"ngAcceptInputType_labelBorderThickness: string | numberngAcceptInputType_labelPadding
Section titled "ngAcceptInputType_labelPadding"ngAcceptInputType_labelPadding: string | numberAccessors
Section titled "Accessors"annotationData
Section titled "annotationData"Gets or sets the additional data that should be stored with the annotation.
get annotationData(): string
Returns string
set annotationData(v: string): voidParameters
- v:
string
Returns void
badgeBackground
Section titled "badgeBackground"Gets or sets the background of badge annotation.
get badgeBackground(): string
Returns string
set badgeBackground(v: string): voidParameters
- v:
string
Returns void
badgeCornerRadius
Section titled "badgeCornerRadius"Gets or sets border radius of the badge annotations.
get badgeCornerRadius(): number
Returns number
set badgeCornerRadius(v: number): voidParameters
- v:
number
Returns void
badgeImagePath
Section titled "badgeImagePath"Gets or sets image path for displayed in the badge annotations.
get badgeImagePath(): string
Returns string
set badgeImagePath(v: string): voidParameters
- v:
string
Returns void
badgeMargin
Section titled "badgeMargin"Gets or sets margin of the badge annotations.
get badgeMargin(): number
Returns number
set badgeMargin(v: number): voidParameters
- v:
number
Returns void
badgeOutline
Section titled "badgeOutline"Gets or sets the outline of badge annotation.
get badgeOutline(): string
Returns string
set badgeOutline(v: string): voidParameters
- v:
string
Returns void
badgeSize
Section titled "badgeSize"Gets or sets size of the badge annotations.
get badgeSize(): number
Returns number
set badgeSize(v: number): voidParameters
- v:
number
Returns void
badgeThickness
Section titled "badgeThickness"Gets or sets thickness of the badge annotations.
get badgeThickness(): number
Returns number
set badgeThickness(v: number): voidParameters
- v:
number
Returns void
badgeVisible
Section titled "badgeVisible"Gets or sets whether to draw the badge in annotation
get badgeVisible(): boolean
Returns boolean
set badgeVisible(v: boolean): voidParameters
- v:
boolean
Returns void
identifier
Section titled "identifier"get identifier(): string
Returns string
set identifier(v: string): voidParameters
- v:
string
Returns void
isPillShaped
Section titled "isPillShaped"Gets or sets whether the annotation is pill shaped.
get isPillShaped(): boolean
Returns boolean
set isPillShaped(v: boolean): voidParameters
- v:
boolean
Returns void
isVisible
Section titled "isVisible"Gets or sets whether to the annotations is rendered
get isVisible(): boolean
Returns boolean
set isVisible(v: boolean): voidParameters
- v:
boolean
Returns void
label
Section titled "label"Gets or sets the text that should be displayed on axis annotation.
get label(): string
Returns string
set label(v: string): voidParameters
- v:
string
Returns void
labelBackground
Section titled "labelBackground"Gets or sets the background text displayed in the annotation.
get labelBackground(): string
Returns string
set labelBackground(v: string): voidParameters
- v:
string
Returns void
labelBorderColor
Section titled "labelBorderColor"Gets or sets the border color of the axis annotation.
get labelBorderColor(): string
Returns string
set labelBorderColor(v: string): voidParameters
- v:
string
Returns void
labelBorderRadius
Section titled "labelBorderRadius"Gets or sets the border radius of the annotation.
get labelBorderRadius(): number
Returns number
set labelBorderRadius(v: number): voidParameters
- v:
number
Returns void
labelBorderThickness
Section titled "labelBorderThickness"Gets or sets border thickness of the axis annotations.
get labelBorderThickness(): number
Returns number
set labelBorderThickness(v: number): voidParameters
- v:
number
Returns void
labelColor
Section titled "labelColor"Gets or sets the color of text displayed in the annotation.
get labelColor(): string
Returns string
set labelColor(v: string): voidParameters
- v:
string
Returns void
labelPadding
Section titled "labelPadding"Gets or sets padding around the label in annotation.
get labelPadding(): number
Returns number
set labelPadding(v: number): voidParameters
- v:
number
Returns void
Methods
Section titled "Methods"bindAxes
Section titled "bindAxes"bindAxes(axes: IgxAxisComponent[]): voidParameters
- axes:
IgxAxisComponent[]
Returns void
bindSeries
Section titled "bindSeries"bindSeries(series: IgxSeriesComponent[]): voidParameters
- series:
IgxSeriesComponent[]
Returns void
findByName
Section titled "findByName"findByName(name: string): anyParameters
- name:
string
Returns any
_createFromInternal
Section titled "_createFromInternal"_createFromInternal(internal: any): IgxUserBaseAnnotationParameters
- internal:
any