Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrCalloutAnnotation

Represents a callout annotation

Hierarchy

Hierarchy

  • IgrCalloutAnnotation

Constructors

Accessors

Methods

Constructors

constructor

Accessors

background

  • get background(): string

  • Gets or sets the background to use for tha axis annotation box.

    Returns string

  • set background(v): void

  • Parameters

    • v: string

    Returns void

backgroundCornerRadius

  • get backgroundCornerRadius(): number

  • Gets or sets the corner radius to use for the callout borders.

    Returns number

  • set backgroundCornerRadius(v): void

  • Parameters

    • v: number

    Returns void

backgroundPaddingBottom

  • get backgroundPaddingBottom(): number

  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set backgroundPaddingBottom(v): void

  • Parameters

    • v: number

    Returns void

backgroundPaddingLeft

  • get backgroundPaddingLeft(): number

  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set backgroundPaddingLeft(v): void

  • Parameters

    • v: number

    Returns void

backgroundPaddingRight

  • get backgroundPaddingRight(): number

  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set backgroundPaddingRight(v): void

  • Parameters

    • v: number

    Returns void

backgroundPaddingTop

  • get backgroundPaddingTop(): number

  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set backgroundPaddingTop(v): void

  • Parameters

    • v: number

    Returns void

content

  • get content(): any

  • Gets or sets the Content that should be annotated.

    Returns any

  • set content(v): void

  • Parameters

    • v: any

    Returns void

formatLabel

  • get formatLabel(): ((item) => string)

  • Sets or gets a function which takes an object that produces a formatted label for the value of this annotation.

    Returns ((item) => string)

      • (item): string

      • Sets or gets a function which takes an object that produces a formatted label for the value of this annotation.

        Parameters

        • item: any

        Returns string

  • set formatLabel(v): void

  • Parameters

    • v: ((item) => string)
        • (item): string

        • Parameters

          • item: any

          Returns string

    Returns void

itemColor

  • get itemColor(): string

  • Gets or sets the ItemColor to which the callout pertains to. Leave unset for an automatic value.

    Returns string

  • set itemColor(v): void

  • Parameters

    • v: string

    Returns void

key

  • get key(): any

  • Gets or sets the Key that should be annotated.

    Returns any

  • set key(v): void

  • Parameters

    • v: any

    Returns void

leaderBrush

  • get leaderBrush(): string

  • Gets or sets the LeaderBrush to use for tha axis annotation box.

    Returns string

  • set leaderBrush(v): void

  • Parameters

    • v: string

    Returns void

nativeElement

  • get nativeElement(): HTMLElement

  • Returns HTMLElement

outline

  • get outline(): string

  • Gets or sets the Outline to use for tha axis annotation box.

    Returns string

  • set outline(v): void

  • Parameters

    • v: string

    Returns void

series

  • get series(): IgrSeries<IIgrSeriesProps>

  • Gets or sets the series to which the callout pertains to. Leave unset for an automatic value.

    Returns IgrSeries<IIgrSeriesProps>

  • set series(v): void

  • Parameters

    Returns void

strokeThickness

  • get strokeThickness(): number

  • Gets or sets the border stroke thickness to use for tha axis annotation box.

    Returns number

  • set strokeThickness(v): void

  • Parameters

    • v: number

    Returns void

text

  • get text(): string

  • Gets or sets the text that should be displayed for the annotation. Leave null to display the value automatically.

    Returns string

  • set text(v): void

  • Parameters

    • v: string

    Returns void

textColor

  • get textColor(): string

  • Gets or sets the color to use for the text in the annotation.

    Returns string

  • set textColor(v): void

  • Parameters

    • v: string

    Returns void

xValue

  • get xValue(): any

  • Gets or sets the XValue at which this annotation is displayed on the axis.

    Returns any

  • set xValue(v): void

  • Parameters

    • v: any

    Returns void

yValue

  • get yValue(): any

  • Gets or sets the YValue at which this annotation is displayed on the axis.

    Returns any

  • set yValue(v): void

  • Parameters

    • v: any

    Returns void

Methods

findByName

  • Parameters

    • name: string

    Returns any