Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxDataLegendSummaryColumn

Represent a column in summary row

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static ngAcceptInputType_allowLabels

ngAcceptInputType_allowLabels: string | boolean

Static ngAcceptInputType_allowUnits

ngAcceptInputType_allowUnits: string | boolean

Static ngAcceptInputType_formatAllowAbbreviation

ngAcceptInputType_formatAllowAbbreviation: string | boolean

Static ngAcceptInputType_formatAllowCurrency

ngAcceptInputType_formatAllowCurrency: string | boolean

Static ngAcceptInputType_formatAllowDecimal

ngAcceptInputType_formatAllowDecimal: string | boolean

Static ngAcceptInputType_formatAllowInteger

ngAcceptInputType_formatAllowInteger: string | boolean

Static ngAcceptInputType_formatAllowPercent

ngAcceptInputType_formatAllowPercent: string | boolean

Static ngAcceptInputType_formatMaxFractions

ngAcceptInputType_formatMaxFractions: string | number

Static ngAcceptInputType_formatMinFractions

ngAcceptInputType_formatMinFractions: string | number

Static ngAcceptInputType_formatUseNegativeColor

ngAcceptInputType_formatUseNegativeColor: string | boolean

Static ngAcceptInputType_formatUsePositiveColor

ngAcceptInputType_formatUsePositiveColor: string | boolean

Static ngAcceptInputType_index

ngAcceptInputType_index: string | number

Static ngAcceptInputType_isExcludeByDefault

ngAcceptInputType_isExcludeByDefault: string | boolean

Static ngAcceptInputType_orderIndex

ngAcceptInputType_orderIndex: string | number

Static ngAcceptInputType_seriesLabels

ngAcceptInputType_seriesLabels: string | string[]

Static ngAcceptInputType_seriesUnits

ngAcceptInputType_seriesUnits: string | string[]

Static ngAcceptInputType_seriesValues

ngAcceptInputType_seriesValues: string | number[]

Static ngAcceptInputType_value

ngAcceptInputType_value: string | number

Static ngAcceptInputType_valueType

ngAcceptInputType_valueType: string | DataLegendSeriesValueType

Accessors

allowLabels

  • get allowLabels(): boolean

  • Gets or sets whether the label text is allowed by the series, e.g. "H:"

    Returns boolean

  • set allowLabels(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

allowUnits

  • get allowUnits(): boolean

  • Gets or sets whether the unit text is allowed by the series, e.g. "Hz"

    Returns boolean

  • set allowUnits(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

formatAllowAbbreviation

  • get formatAllowAbbreviation(): boolean

  • Gets or sets whether or not allow displaying value with abbreviation

    Returns boolean

  • set formatAllowAbbreviation(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

formatAllowCurrency

  • get formatAllowCurrency(): boolean

  • Gets or sets whether or not allow displaying value as currency

    Returns boolean

  • set formatAllowCurrency(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

formatAllowDecimal

  • get formatAllowDecimal(): boolean

  • Gets or sets whether or not allow displaying value as decimal

    Returns boolean

  • set formatAllowDecimal(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

formatAllowInteger

  • get formatAllowInteger(): boolean

  • Gets or sets whether or not allow displaying value as integer

    Returns boolean

  • set formatAllowInteger(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

formatAllowPercent

  • get formatAllowPercent(): boolean

  • Gets or sets whether or not allow displaying value as percentage

    Returns boolean

  • set formatAllowPercent(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

formatMaxFractions

  • get formatMaxFractions(): number

  • Gets or sets maximum digits used for displaying faction of the value

    Returns number

  • set formatMaxFractions(v: number): void

  • Parameters

    • v: number

    Returns void

formatMinFractions

  • get formatMinFractions(): number

  • Gets or sets minimum digits used for displaying faction of the value

    Returns number

  • set formatMinFractions(v: number): void

  • Parameters

    • v: number

    Returns void

formatUseNegativeColor

  • get formatUseNegativeColor(): boolean

  • Gets or sets whether or not use conditional color

    Returns boolean

  • set formatUseNegativeColor(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

formatUsePositiveColor

  • get formatUsePositiveColor(): boolean

  • Gets or sets whether or not use conditional color

    Returns boolean

  • set formatUsePositiveColor(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

formatWithSeriesColor

  • get formatWithSeriesColor(): string

  • Gets value color used by the series

    Returns string

  • set formatWithSeriesColor(v: string): void

  • Parameters

    • v: string

    Returns void

index

  • get index(): number

  • Gets the index of series

    Returns number

  • set index(v: number): void

  • Parameters

    • v: number

    Returns void

isExcludeByDefault

  • get isExcludeByDefault(): boolean

  • Gets or sets whether this value is excluded/hidden by default in Data Legend

    Returns boolean

  • set isExcludeByDefault(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

memberLabel

  • get memberLabel(): string

  • Gets or sets member path for the series value, e.g. "High"

    Returns string

  • set memberLabel(v: string): void

  • Parameters

    • v: string

    Returns void

memberPath

  • get memberPath(): string

  • Gets or sets member path for the series value, e.g. "HighPrice"

    Returns string

  • set memberPath(v: string): void

  • Parameters

    • v: string

    Returns void

memberSymbol

  • get memberSymbol(): string

  • Gets or sets label for the series value, e.g. "H:"

    Returns string

  • set memberSymbol(v: string): void

  • Parameters

    • v: string

    Returns void

memberUnit

  • get memberUnit(): string

  • Gets or sets unit text for the value, e.g. "Hz"

    Returns string

  • set memberUnit(v: string): void

  • Parameters

    • v: string

    Returns void

orderIndex

  • get orderIndex(): number

  • Returns number

  • set orderIndex(v: number): void

  • Parameters

    • v: number

    Returns void

seriesLabels

  • get seriesLabels(): string[]

  • Get labels rendered on left side of series values, e.g. "H:" for High, "L:" for Low

    Returns string[]

seriesUnits

  • get seriesUnits(): string[]

  • Get optional units on right side of series values, e.g. "Hz" for hertz

    Returns string[]

seriesValues

  • get seriesValues(): number[]

  • Get values of series in the summary column

    Returns number[]

value

  • get value(): number

  • Gets value of series

    Returns number

  • set value(v: number): void

  • Parameters

    • v: number

    Returns void

valueNegativePrefix

  • get valueNegativePrefix(): string

  • Gets or sets prefix for negative value

    Returns string

  • set valueNegativePrefix(v: string): void

  • Parameters

    • v: string

    Returns void

valueNegativeSuffix

  • get valueNegativeSuffix(): string

  • Gets or sets suffix for negative value

    Returns string

  • set valueNegativeSuffix(v: string): void

  • Parameters

    • v: string

    Returns void

valuePositivePrefix

  • get valuePositivePrefix(): string

  • Gets or sets prefix for positive value

    Returns string

  • set valuePositivePrefix(v: string): void

  • Parameters

    • v: string

    Returns void

valuePositiveSuffix

  • get valuePositiveSuffix(): string

  • Gets or sets suffix for positive value

    Returns string

  • set valuePositiveSuffix(v: string): void

  • Parameters

    • v: string

    Returns void

valueType

Methods

addLabel

  • Add label in the summary column

    Parameters

    • label: string

    Returns void

addUnits

  • Add unit in the summary column

    Parameters

    • units: string

    Returns void

addValue

  • Add a value in the summary column

    Parameters

    • value: number

    Returns void

findByName

  • Parameters

    • name: string

    Returns any

toString

  • Converts this object to a string

    Returns string