Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class WorkbookColorPalette

Represents the color palette used when the saved file is opened in Microsoft Excel 2003 and earlier versions.

See

Workbook.palette

Hierarchy

Hierarchy

  • Base
    • WorkbookColorPalette

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

count

  • get count(): number

  • Gets the number of colors in the palette, which is always 56.

    Returns number

isCustom

  • get isCustom(): boolean

  • Gets the value which indicates whether the palette has been cusotmized.

    See

    reset

    Returns boolean

Methods

[iterator]

contains

  • Determines whether the specified color is in the color palette.

    Returns

    Determines whether an equivalent color is in the palette.

    Parameters

    • color: string | Color

      The color to find in the palette.

    Returns boolean

equals

  • Parameters

    • other: any

    Returns boolean

getEnumerator

getHashCode

  • Returns number

getIndexOfNearestColor

  • Gets the index of the closest color in the color palette, which will be seen when the file is opened in Microsoft Excel 2003 and older versions.

    Returns

    A 0-based index into the collection of the closest color available in the palette.

    Parameters

    • color: string | Color

      The color to match in the palette.

    Returns number

item

  • Gets or sets a color in the palette.

    When a color is set in the palette, isCustom will return True. The palette can than be reset with the reset method.

    Colors added to the palette must be opaque.

    Throws

    ArgumentOutOfRangeException 'index' is less than 0 or greater than 55.

    Throws

    ArgumentException The value assigned is an empty color, a system color, or is not opaque.

    See

    Parameters

    • index: number

      The index of the color to get or set in the palette.

    • Optional value: string | Color

    Returns string

memberwiseClone

reset

  • Resets the palette back to the default colors for Microsoft Excel.

    See

    isCustom

    Returns void

Static compare

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • Parameters

    • a: any
    • b: any

    Returns boolean