Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcAxisAnnotation

Represents an axis annotation

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 axis annotation 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

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

      • Parameters

        • item: any

        Returns string

  • set formatLabel(v): void

  • Parameters

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

        • Parameters

          • item: any

          Returns string

    Returns void

labelFormat

  • get labelFormat(): string

  • Gets or sets the label format string to use for the label.

    Returns string

  • set labelFormat(v): void

  • Parameters

    • v: string

    Returns void

labelFormatSpecifiers

  • get labelFormatSpecifiers(): any[]

  • Gets or sets the format specifiers to use with the LabelFormat string.

    Returns any[]

  • set labelFormatSpecifiers(v): void

  • Parameters

    • v: any[]

    Returns void

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

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

value

  • get value(): any

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

    Returns any

  • set value(v): void

  • Parameters

    • v: any

    Returns void

Methods

findByName

  • findByName(name): any

  • Parameters

    • name: string

    Returns any

resetCachedExtent

  • resetCachedExtent(): void

  • Returns void

resolveLabelValue

  • resolveLabelValue(): string

  • Returns string