Represent a column in summary row

Hierarchy

Hierarchy (view full)

Constructors

Accessors

  • get allowLabels(): boolean
  • Gets or sets whether the label text is allowed by the series, e.g. "H:"

    Returns boolean

  • set allowLabels(v): void
  • Parameters

    • v: boolean

    Returns void

  • get allowUnits(): boolean
  • Gets or sets whether the unit text is allowed by the series, e.g. "Hz"

    Returns boolean

  • set allowUnits(v): void
  • Parameters

    • v: boolean

    Returns void

  • get formatAllowAbbreviation(): boolean
  • Gets or sets whether or not allow displaying value with abbreviation

    Returns boolean

  • set formatAllowAbbreviation(v): void
  • Parameters

    • v: boolean

    Returns void

  • get formatAllowCurrency(): boolean
  • Gets or sets whether or not allow displaying value as currency

    Returns boolean

  • set formatAllowCurrency(v): void
  • Parameters

    • v: boolean

    Returns void

  • get formatAllowDecimal(): boolean
  • Gets or sets whether or not allow displaying value as decimal

    Returns boolean

  • set formatAllowDecimal(v): void
  • Parameters

    • v: boolean

    Returns void

  • get formatAllowInteger(): boolean
  • Gets or sets whether or not allow displaying value as integer

    Returns boolean

  • set formatAllowInteger(v): void
  • Parameters

    • v: boolean

    Returns void

  • get formatAllowPercent(): boolean
  • Gets or sets whether or not allow displaying value as percentage

    Returns boolean

  • set formatAllowPercent(v): void
  • Parameters

    • v: boolean

    Returns void

  • get formatMaxFractions(): number
  • Gets or sets maximum digits used for displaying faction of the value

    Returns number

  • set formatMaxFractions(v): void
  • Parameters

    • v: number

    Returns void

  • get formatMinFractions(): number
  • Gets or sets minimum digits used for displaying faction of the value

    Returns number

  • set formatMinFractions(v): void
  • Parameters

    • v: number

    Returns void

  • get formatUseNegativeColor(): boolean
  • Gets or sets whether or not use conditional color

    Returns boolean

  • set formatUseNegativeColor(v): void
  • Parameters

    • v: boolean

    Returns void

  • get formatUsePositiveColor(): boolean
  • Gets or sets whether or not use conditional color

    Returns boolean

  • set formatUsePositiveColor(v): void
  • Parameters

    • v: boolean

    Returns void

  • get formatWithSeriesColor(): string
  • Gets value color used by the series

    Returns string

  • set formatWithSeriesColor(v): void
  • Parameters

    • v: string

    Returns void

  • get index(): number
  • Gets the index of series

    Returns number

  • set index(v): void
  • Parameters

    • v: number

    Returns void

  • get isExcludeByDefault(): boolean
  • Gets or sets whether this value is excluded/hidden by default in Data Legend

    Returns boolean

  • set isExcludeByDefault(v): void
  • Parameters

    • v: boolean

    Returns void

  • get memberLabel(): string
  • Gets or sets member path for the series value, e.g. "High"

    Returns string

  • set memberLabel(v): void
  • Parameters

    • v: string

    Returns void

  • get memberPath(): string
  • Gets or sets member path for the series value, e.g. "HighPrice"

    Returns string

  • set memberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get memberSymbol(): string
  • Gets or sets label for the series value, e.g. "H:"

    Returns string

  • set memberSymbol(v): void
  • Parameters

    • v: string

    Returns void

  • get memberUnit(): string
  • Gets or sets unit text for the value, e.g. "Hz"

    Returns string

  • set memberUnit(v): void
  • Parameters

    • v: string

    Returns void

  • get orderIndex(): number
  • Returns number

  • set orderIndex(v): void
  • Parameters

    • v: number

    Returns void

  • get seriesLabels(): string[]
  • Get labels rendered on left side of series values, e.g. "H:" for High, "L:" for Low

    Returns string[]

  • get seriesUnits(): string[]
  • Get optional units on right side of series values, e.g. "Hz" for hertz

    Returns string[]

  • get seriesValues(): number[]
  • Get values of series in the summary column

    Returns number[]

  • get value(): number
  • Gets value of series

    Returns number

  • set value(v): void
  • Parameters

    • v: number

    Returns void

  • get valueNegativePrefix(): string
  • Gets or sets prefix for negative value

    Returns string

  • set valueNegativePrefix(v): void
  • Parameters

    • v: string

    Returns void

  • get valueNegativeSuffix(): string
  • Gets or sets suffix for negative value

    Returns string

  • set valueNegativeSuffix(v): void
  • Parameters

    • v: string

    Returns void

  • get valuePositivePrefix(): string
  • Gets or sets prefix for positive value

    Returns string

  • set valuePositivePrefix(v): void
  • Parameters

    • v: string

    Returns void

  • get valuePositiveSuffix(): string
  • Gets or sets suffix for positive value

    Returns string

  • set valuePositiveSuffix(v): void
  • Parameters

    • v: string

    Returns void

  • get valueType(): DataLegendSeriesValueType
  • Gets or sets type of value

    Returns DataLegendSeriesValueType

  • set valueType(v): void
  • Parameters

    Returns void

Methods

  • Add label in the summary column

    Parameters

    • label: string

    Returns void

  • Add unit in the summary column

    Parameters

    • units: string

    Returns void

  • Add a value in the summary column

    Parameters

    • value: number

    Returns void

  • Parameters

    • name: string

    Returns any

  • Converts this object to a string

    Returns string