Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class WorkbookColorInfo

An immutable object which represents a color in a Microsoft Excel workbook.

See

  • [[IWorksheetCellFormat.bottomBorderColorInfo]]
  • [[IWorksheetCellFormat.diagonalBorderColorInfo]]
  • [[IWorksheetCellFormat.leftBorderColorInfo]]
  • [[IWorksheetCellFormat.rightBorderColorInfo]]
  • [[IWorksheetCellFormat.topBorderColorInfo]]
  • [[IWorkbookFont.colorInfo]]
  • [[CellFillPattern.backgroundColorInfo]]
  • [[CellFillPattern.patternColorInfo]]
  • [[CellFillGradientStop.colorInfo]]

Hierarchy

Hierarchy

  • Base
    • WorkbookColorInfo

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new WorkbookColorInfo(): WorkbookColorInfo

  • Returns WorkbookColorInfo

  • new WorkbookColorInfo(color): WorkbookColorInfo

  • Parameters

    • color: string | Color

    Returns WorkbookColorInfo

  • new WorkbookColorInfo(color, tint): WorkbookColorInfo

  • Parameters

    • color: string | Color
    • tint: number

    Returns WorkbookColorInfo

  • new WorkbookColorInfo(color, transform): WorkbookColorInfo

  • Parameters

    Returns WorkbookColorInfo

  • new WorkbookColorInfo(themeColorType): WorkbookColorInfo

  • Parameters

    Returns WorkbookColorInfo

  • new WorkbookColorInfo(themeColorType, tint): WorkbookColorInfo

  • Parameters

    Returns WorkbookColorInfo

  • new WorkbookColorInfo(themeColorType, transform): WorkbookColorInfo

  • Parameters

    Returns WorkbookColorInfo

  • new WorkbookColorInfo(color, themeColorType, tint, isLoading, preventUsingAutomaticColor?): WorkbookColorInfo

  • Parameters

    • color: string | Color
    • themeColorType: WorkbookThemeColorType
    • tint: number
    • isLoading: boolean
    • Optional preventUsingAutomaticColor: boolean

    Returns WorkbookColorInfo

  • new WorkbookColorInfo(color, themeColorType, tint, transform, isLoading, preventUsingAutomaticColor?): WorkbookColorInfo

  • Parameters

    Returns WorkbookColorInfo

  • new WorkbookColorInfo(workbook, index): WorkbookColorInfo

  • Parameters

    Returns WorkbookColorInfo

  • new WorkbookColorInfo(..._rest): WorkbookColorInfo

  • Parameters

    • Rest ..._rest: any[]

    Returns WorkbookColorInfo

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

color

  • get color(): string | Color

  • Gets the base color associated of the [[WorkbookColorInfo]].

    See

    [[tint]]

    Returns string | Color

isAutomatic

  • get isAutomatic(): boolean

  • Gets the value which indicates whether the [[WorkbookColorInfo]] is automatic, or the window text system color.

    Returns boolean

themeColorType

  • get themeColorType(): WorkbookThemeColorType

  • Gets the base theme color associated of the [[WorkbookColorInfo]].

    See

    [[tint]]

    Returns WorkbookThemeColorType

tint

  • get tint(): number

  • Gets the to apply to the base color, from -1.0 (100% darken) to 1.0 (100% lighten).

    See

    • [[color]]
    • [[themeColorType]]

    Returns number

transform

  • get transform(): WorkbookColorTransform

  • Returns the associated [[WorkbookColorTransform]], or null if this instance is not associated with a transform.

    Returns WorkbookColorTransform

Static automatic

  • get automatic(): WorkbookColorInfo

  • Gets the automatic color, which is the window text system color.

    See

    [[isAutomatic]]

    Returns WorkbookColorInfo

Methods

equals

  • equals(obj): boolean

  • Determines whether the [[WorkbookColorInfo]] is equal to the specified object.

    Parameters

    • obj: any

      The object to test for equality.

    Returns boolean

getHashCode

  • getHashCode(): number

  • Gets the hash code for the [[WorkbookColorInfo]].

    Returns number

getResolvedColor

  • getResolvedColor(): string

  • Gets the actual color which will be seen in Microsoft Excel if the [[WorkbookColorInfo]] is used.

    Throws

    [[ArgumentNullException]] The [[themeColorType]] is not null. When the ThemeColorType is set, the [[getResolvedColor]] method must be called with a non-null [[Workbook]].

    Returns string

  • getResolvedColor(workbook): string

  • Gets the actual color which will be seen in Microsoft Excel if the [[WorkbookColorInfo]] is used.

    Throws

    [[ArgumentNullException]] 'workbook' is null and [[themeColorType]] is not null. When the ThemeColorType is set, the method must be called with a non-null [[Workbook]].

    Parameters

    • workbook: Workbook

      The workbook in which the WorkbookColorInfo is used.

    Returns string

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

toString

  • toString(): string

  • Gets the string representation of the [[WorkbookColorInfo]].

    Returns string

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