Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class SparklineGroup

Represents a group of Sparklines

Hierarchy

Hierarchy

  • Base
    • SparklineGroup

Implements

  • IChangeInfoContext

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

colorAxis

  • get colorAxis(): WorkbookColorInfo

  • Determines the color of the axis Note: this property is ignored unless the dateAxis property is explicity set to true.

    Throws

    ArgumentNullException Color can't be set to null.

    Throws

    ArgumentException Color can't be set to 'Auto'.

    See

    dateAxis

    Returns WorkbookColorInfo

  • set colorAxis(a: WorkbookColorInfo): void

  • Parameters

    Returns void

colorFirstPoint

  • get colorFirstPoint(): WorkbookColorInfo

  • Determines the color of the first point Note: this property is ignored unless the firstPoint property is explicity set to true.

    Throws

    ArgumentNullException Color can't be set to null.

    Throws

    ArgumentException Color can't be set to 'Auto'.

    See

    firstPoint

    Returns WorkbookColorInfo

  • set colorFirstPoint(a: WorkbookColorInfo): void

  • Parameters

    Returns void

colorHighPoint

  • get colorHighPoint(): WorkbookColorInfo

  • Determines the color of the high point Note: this property is ignored unless the highPoint property is explicity set to true.

    Throws

    ArgumentNullException Color can't be set to null.

    Throws

    ArgumentException Color can't be set to 'Auto'.

    See

    highPoint

    Returns WorkbookColorInfo

  • set colorHighPoint(a: WorkbookColorInfo): void

  • Parameters

    Returns void

colorLastPoint

  • get colorLastPoint(): WorkbookColorInfo

  • Determines the color of the last point Note: this property is ignored unless the lastPoint property is explicity set to true.

    Throws

    ArgumentNullException Color can't be set to null.

    Throws

    ArgumentException Color can't be set to 'Auto'.

    See

    lastPoint

    Returns WorkbookColorInfo

  • set colorLastPoint(a: WorkbookColorInfo): void

  • Parameters

    Returns void

colorLowPoint

  • get colorLowPoint(): WorkbookColorInfo

  • Determines the color of the low point Note: this property is ignored unless the lowPoint property is explicity set to true.

    Throws

    ArgumentNullException Color can't be set to null.

    Throws

    ArgumentException Color can't be set to 'Auto'.

    See

    lowPoint

    Returns WorkbookColorInfo

  • set colorLowPoint(a: WorkbookColorInfo): void

  • Parameters

    Returns void

colorMarkers

  • get colorMarkers(): WorkbookColorInfo

  • Determines the color of the markers Note: this property is ignored unless the markers property is explicity set to true.

    Throws

    ArgumentNullException Color can't be set to null.

    Throws

    ArgumentException Color can't be set to 'Auto'.

    See

    markers

    Returns WorkbookColorInfo

  • set colorMarkers(a: WorkbookColorInfo): void

  • Parameters

    Returns void

colorNegativePoints

  • get colorNegativePoints(): WorkbookColorInfo

  • Determines the color of the negative point Note: this property is ignored unless the negativePoints property is explicity set to true.

    Throws

    ArgumentNullException Color can't be set to null.

    Throws

    ArgumentException Color can't be set to 'Auto'.

    See

    negativePoints

    Returns WorkbookColorInfo

  • set colorNegativePoints(a: WorkbookColorInfo): void

  • Parameters

    Returns void

colorSeries

  • get colorSeries(): WorkbookColorInfo

  • Determines the default color for the series The color to use for the series.

    Throws

    ArgumentNullException Color can't be set to null.

    Throws

    ArgumentException Color can't be set to 'Auto'.

    Returns WorkbookColorInfo

  • set colorSeries(a: WorkbookColorInfo): void

  • Parameters

    Returns void

dateAxis

  • get dateAxis(): boolean

  • Determines whether to use a date axis

    See

    Returns boolean

  • set dateAxis(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

dateRange

dateRangeFormula

displayBlanksAs

displayHidden

  • get displayHidden(): boolean

  • Determines whether values from cells that are hidden will be displayed

    Returns boolean

  • set displayHidden(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

displayXAxis

  • get displayXAxis(): boolean

  • Determines if the x-axis will be displayed

    Returns boolean

  • set displayXAxis(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

firstPoint

  • get firstPoint(): boolean

  • Determines if the first point is displayed differently.

    See

    colorFirstPoint

    Returns boolean

  • set firstPoint(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

guid

  • get guid(): null | Guid

  • A unique identifier for this group (read-only). Note: this property is optional but if one group contains a guid then all groups in the collection nust also have guids generated for them.

    See

    SparklineGroupCollection.generateGuidsForGroups

    Returns null | Guid

  • set guid(a: null | Guid): void

  • Parameters

    • a: null | Guid

    Returns void

highPoint

  • get highPoint(): boolean

  • Determines if the high point is displayed differently.

    See

    colorHighPoint

    Returns boolean

  • set highPoint(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

lastPoint

  • get lastPoint(): boolean

  • Determines if the last point is displayed differently.

    See

    colorLastPoint

    Returns boolean

  • set lastPoint(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

lineWeight

  • get lineWeight(): number

  • Determines the weight of a line in points.

    Throws

    ArgumentOutOfRangeException if the value is less than zero or greather than 1584.

    Returns number

  • set lineWeight(a: number): void

  • Parameters

    • a: number

    Returns void

lowPoint

  • get lowPoint(): boolean

  • Determines if the low point is displayed differently.

    See

    colorLowPoint

    Returns boolean

  • set lowPoint(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

markers

  • get markers(): boolean

  • Determines if markers are displayed.

    See

    colorMarkers

    Returns boolean

  • set markers(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

negativePoints

  • get negativePoints(): boolean

  • Determines if the negative points are displayed differently.

    See

    colorNegativePoints

    Returns boolean

  • set negativePoints(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

rightToLeft

  • get rightToLeft(): boolean

  • Determines if the sparkline goes from right to left.

    Returns boolean

  • set rightToLeft(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

type

  • get type(): SparklineType

  • The type of sparkline

    Returns SparklineType

  • set type(a: SparklineType): void

  • Parameters

    Returns void

verticalAxisMax

  • get verticalAxisMax(): number

  • A custom maximum value for the Y axis. Note: if verticalAxisMaxType property is not set to 'Custom' then this property is ignored.

    See

    verticalAxisMaxType

    Returns number

  • set verticalAxisMax(a: number): void

  • Parameters

    • a: number

    Returns void

verticalAxisMaxType

verticalAxisMin

  • get verticalAxisMin(): number

  • A custom minimum value for the Y axis. Note: if verticalAxisMinType property is not set to 'Custom' then this property is ignored.

    See

    verticalAxisMinType

    Returns number

  • set verticalAxisMin(a: number): void

  • Parameters

    • a: number

    Returns void

verticalAxisMinType

workbook

  • get workbook(): Workbook

  • Returns a reference to the associated workbook.

    Returns Workbook

worksheet

  • get worksheet(): Worksheet

  • Returns a reference to the associated worksheet.

    Returns Worksheet

Methods

equals

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • Returns number

memberwiseClone

setDateRange

  • Assigns a new dateRange. Note: dateRange is ignored unless the dateAxis property is explicity set to true.

    See

    dateRange

    Parameters

    • dateRange: string

      The string representation of the formula.

    • Optional cellReferenceMode: CellReferenceMode

      An optional CellReferenceMode to use to parse the dateRange. If null it defaults to the workbook's mode.

    Returns void

sparklines

  • Indexer

    Returns

    The item at the specified index

    Throws

    IndexOutOfRangeException If the index is negative or greater than or equal to count

    Parameters

    • index: number

      The zer-based index of an item

    • Optional value: Sparkline

    Returns Sparkline

  • The collection of sparklines in the group (read-only)

    Returns SparklineCollection

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

Static staticInit

  • Returns void