menu

Class IgrOverlayTextUpdatingEventArgs

Represents an event arguments for styling Overlay Text

Hierarchy

Hierarchy

IgrOverlayTextUpdatingEventArgs

Constructors

constructor

new IgrOverlayTextUpdatingEventArgs(): IgrOverlayTextUpdatingEventArgs
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:19
Returns IgrOverlayTextUpdatingEventArgs

Accessors

background

get background(): string
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:119
Gets or sets background of the overlay text

Returns string
set background(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:120
Parameters
- v: string
Returns void

backgroundMode

get backgroundMode(): AnnotationAppearanceMode
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:79
Gets or sets appearance mode of the overlay text background

Returns AnnotationAppearanceMode
set backgroundMode(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:80
Parameters
- v: AnnotationAppearanceMode
Returns void

backgroundShift

get backgroundShift(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:64
Gets or sets appearance shift of the overlay text background

Returns number
set backgroundShift(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:65
Parameters
- v: number
Returns void

borderMode

get borderMode(): AnnotationAppearanceMode
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:74
Gets or sets appearance mode of the overlay text border

Returns AnnotationAppearanceMode
set borderMode(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:75
Parameters
- v: AnnotationAppearanceMode
Returns void

borderRadius

get borderRadius(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:49
Gets or sets boarder border radius of the overlay text

Returns number
set borderRadius(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:50
Parameters
- v: number
Returns void

borderShift

get borderShift(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:59
Gets or sets appearance shift of the overlay text border

Returns number
set borderShift(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:60
Parameters
- v: number
Returns void

borderStroke

get borderStroke(): string
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:124
Gets or sets border stroke of the overlay text

Returns string
set borderStroke(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:125
Parameters
- v: string
Returns void

borderThickness

get borderThickness(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:54
Gets or sets boarder thickness of the overlay text

Returns number
set borderThickness(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:55
Parameters
- v: number
Returns void

dataIndex

get dataIndex(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:24
Gets data index associated with the overlay text

Returns number
set dataIndex(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:25
Parameters
- v: number
Returns void

horizontalMargin

get horizontalMargin(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:29
Gets or sets Horizontal Margin for the overlay text

Returns number
set horizontalMargin(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:30
Parameters
- v: number
Returns void

horizontalPadding

get horizontalPadding(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:34
Gets or sets Horizontal Padding for the overlay text

Returns number
set horizontalPadding(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:35
Parameters
- v: number
Returns void

nativeElement

get nativeElement(): HTMLElement
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:12
Returns HTMLElement

shapeBrush

get shapeBrush(): string
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:129
Gets or sets shape brush associated with the overlay text

Returns string
set shapeBrush(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:130
Parameters
- v: string
Returns void

shapeOutline

get shapeOutline(): string
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:134
Gets or sets shape outline associated with the overlay text

Returns string
set shapeOutline(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:135
Parameters
- v: string
Returns void

textAngle

get textAngle(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:94
Gets or sets rotation angle of the overlay text

Returns number
set textAngle(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:95
Parameters
- v: number
Returns void

textColor

get textColor(): string
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:114
Gets or sets color of the overlay text

Returns string
set textColor(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:115
Parameters
- v: string
Returns void

textColorMode

get textColorMode(): AnnotationAppearanceMode
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:84
Gets or sets appearance mode of the overlay text color

Returns AnnotationAppearanceMode
set textColorMode(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:85
Parameters
- v: AnnotationAppearanceMode
Returns void

textColorShift

get textColorShift(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:69
Gets or sets appearance shift of the overlay text color

Returns number
set textColorShift(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:70
Parameters
- v: number
Returns void

textContent

get textContent(): string
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:89
Gets or sets content of the overlay text

Returns string
set textContent(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:90
Parameters
- v: string
Returns void

textEmpty

get textEmpty(): boolean
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:104
Gets or sets visibility of the overlay text

Returns boolean
set textEmpty(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:105
Parameters
- v: boolean
Returns void

textLocation

get textLocation(): OverlayTextLocation
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:109
Gets or sets location of the overlay text in relation to shape annotation

Returns OverlayTextLocation
set textLocation(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:110
Parameters
- v: OverlayTextLocation
Returns void

textVisible

get textVisible(): boolean
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:99
Gets or sets visibility of the overlay text

Returns boolean
set textVisible(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:100
Parameters
- v: boolean
Returns void

verticalMargin

get verticalMargin(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:44
Gets or sets Vertical Margin for the overlay text

Returns number
set verticalMargin(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:45
Parameters
- v: number
Returns void

verticalPadding

get verticalPadding(): number
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:39
Gets or sets Vertical Padding for the overlay text

Returns number
set verticalPadding(v): void
- Defined in dist/igniteui-react-charts/lib/igr-overlay-text-updating-event-args.d.ts:40
Parameters
- v: number
Returns void