Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StackedValue

a stacked value is a number wrapper that also contains information about its stack

Hierarchy

  • StackedValue

Index

Properties

Methods

Properties

Readonly stack

stack: readonly { color: string; ratio: number }[]

the individual ratios (percentages) and their colors

Readonly value

value: number

the stacked bar value

Methods

[toPrimitive]

  • [toPrimitive](hint: "default"): string
  • [toPrimitive](hint: "string"): string
  • [toPrimitive](hint: "number"): number
  • [toPrimitive](hint: string): string | number

  • Converts a StackedValue object to a string.

    Parameters

    • hint: "default"

    Returns string

  • Converts a StackedValue object to a string.

    Parameters

    • hint: "string"

    Returns string

  • Converts a StackedValue object to a number.

    Parameters

    • hint: "number"

    Returns number

  • Converts a StackedValue object to a string or number.

    throws

    {TypeError} If 'hint' was given something other than "number", "string", or "default".

    Parameters

    • hint: string

      The strings "number", "string", or "default" to specify what primitive to return.

    Returns string | number

    A number if 'hint' was "number", a string if 'hint' was "string" or "default".

toString

  • toString(): string

  • Returns string

valueOf

  • valueOf(): number

  • Returns number

Generated using TypeDoc