Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class LegendEntry

Represents a legend entry in a chart legend.

NOTE: Legend entries are not supported for the following chart types:

  • Box and Whisker
  • Histogram
  • Pareto
  • Sunburst
  • Treemap
  • Waterfall

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

chart

  • get chart(): WorksheetChart

  • Returns the owning chart (read-only)

    See

    [[owner]]

    Returns WorksheetChart

font

  • get font(): IWorkbookFont

  • Returns or sets the font for this legend entry. Read-only.

    This property provides a way to specify font settings for a particular legend entry; to apply font settings to all legend entries, use the [[Legend.defaultFont]] property.

    See

    [[Legend.defaultFont]]

    Returns IWorkbookFont

fontFill

  • get fontFill(): ChartFillBase

  • Returns or sets a [[ChartFillBase]] derived object which defines the font color(s) for this legend entry.

    This property returns null by default, indicating that no fill is applied.

    To apply a solid color fill, assign an instance of the [[ChartSolidFill]] class to this property.

    To apply a gradient fill, assign an instance of the [[ChartGradientFill]] class to this property.

    See

    • [[ChartSolidFill]]
    • [[ChartGradientFill]]

    Returns ChartFillBase

  • set fontFill(a): void

  • Parameters

    Returns void

isDeleted

  • get isDeleted(): boolean

  • Returns or sets a boolean value indicating whether this entry has been removed from the [[WorksheetChart.legend]]

    Deletion does not remove the entry from the [[Legend.legendEntries]] collection, but rather marks it as deleted, so that it does not appear in the legend.

    See

    • [[WorksheetChart.legend]]
    • [[legend]]
    • [[Trendline.legendEntry]]

    Returns boolean

  • set isDeleted(a): void

  • Parameters

    • a: boolean

    Returns void

owner

  • get owner(): ChartObject

  • returns this object's owner. (read-only) The owner or null if this object is owned directly by the Chart

    See

    [[chart]]

    Returns ChartObject

sheet

  • get sheet(): Sheet

  • The owning sheet (read-only)

    Returns Sheet

workbook

  • get workbook(): Workbook

  • The owning workbook (read-only)

    Returns Workbook

worksheet

  • get worksheet(): Worksheet

  • The owning worksheet (read-only)

    Returns Worksheet

Methods

del

  • del(): void

  • Marks the entry as being deleted.

    Returns void

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean