Represents a group of [[Sparkline]]s

Constructors

Section titled "Constructors"

SparklineGroup 

new SparklineGroup(a: number, b: Worksheet): SparklineGroup

Returns SparklineGroup

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

colorAxis

Section titled "colorAxis"

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

 
get colorAxis(): WorkbookColorInfo

Returns WorkbookColorInfo 

set colorAxis(a: WorkbookColorInfo): void

Parameters

Returns void

colorFirstPoint

Section titled "colorFirstPoint"

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

 
get colorFirstPoint(): WorkbookColorInfo

Returns WorkbookColorInfo 

set colorFirstPoint(a: WorkbookColorInfo): void

Parameters

Returns void

colorHighPoint

Section titled "colorHighPoint"

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

 
get colorHighPoint(): WorkbookColorInfo

Returns WorkbookColorInfo 

set colorHighPoint(a: WorkbookColorInfo): void

Parameters

Returns void

colorLastPoint

Section titled "colorLastPoint"

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

 
get colorLastPoint(): WorkbookColorInfo

Returns WorkbookColorInfo 

set colorLastPoint(a: WorkbookColorInfo): void

Parameters

Returns void

colorLowPoint

Section titled "colorLowPoint"

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

 
get colorLowPoint(): WorkbookColorInfo

Returns WorkbookColorInfo 

set colorLowPoint(a: WorkbookColorInfo): void

Parameters

Returns void

colorMarkers

Section titled "colorMarkers"

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

 
get colorMarkers(): WorkbookColorInfo

Returns WorkbookColorInfo 

set colorMarkers(a: WorkbookColorInfo): void

Parameters

Returns void

colorNegativePoints

Section titled "colorNegativePoints"

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

 
get colorNegativePoints(): WorkbookColorInfo

Returns WorkbookColorInfo 

set colorNegativePoints(a: WorkbookColorInfo): void

Parameters

Returns void

colorSeries

Section titled "colorSeries"

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

 
get colorSeries(): WorkbookColorInfo

Returns WorkbookColorInfo 

set colorSeries(a: WorkbookColorInfo): void

Parameters

Returns void

dateAxis

Section titled "dateAxis"

Determines whether to use a date axis

 
get dateAxis(): boolean

Returns boolean 

set dateAxis(a: boolean): void

Parameters

  • a: boolean

Returns void

dateRange

Section titled "dateRange"

The date range (read-only) Note: this property is ignored unless the [[dateAxis]] property is explicity set to true.

 
get dateRange(): WorksheetRegion

Returns WorksheetRegion

dateRangeFormula

Section titled "dateRangeFormula"

The date range formula (read-only) Note: this property is ignored unless the [[dateAxis]] property is explicity set to true.

 
get dateRangeFormula(): Formula

Returns Formula

displayBlanksAs

Section titled "displayBlanksAs"

Determines how blanks will be displayed

 
get displayBlanksAs(): SparklineDisplayBlanksAs

Returns SparklineDisplayBlanksAs 

set displayBlanksAs(a: SparklineDisplayBlanksAs): void

Parameters

Returns void

displayHidden

Section titled "displayHidden"

Determines whether values from cells that are hidden will be displayed

 
get displayHidden(): boolean

Returns boolean 

set displayHidden(a: boolean): void

Parameters

  • a: boolean

Returns void

displayXAxis

Section titled "displayXAxis"

Determines if the x-axis will be displayed

 
get displayXAxis(): boolean

Returns boolean 

set displayXAxis(a: boolean): void

Parameters

  • a: boolean

Returns void

firstPoint

Section titled "firstPoint"

Determines if the first point is displayed differently.

 
get firstPoint(): boolean

Returns boolean 

set firstPoint(a: boolean): void

Parameters

  • a: boolean

Returns void

guid

Section titled "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.

 
get guid(): any

Returns any 

set guid(a: any): void

Parameters

  • a: any

Returns void

highPoint

Section titled "highPoint"

Determines if the high point is displayed differently.

 
get highPoint(): boolean

Returns boolean 

set highPoint(a: boolean): void

Parameters

  • a: boolean

Returns void

lastPoint

Section titled "lastPoint"

Determines if the last point is displayed differently.

 
get lastPoint(): boolean

Returns boolean 

set lastPoint(a: boolean): void

Parameters

  • a: boolean

Returns void

lineWeight

Section titled "lineWeight"

Determines the weight of a line in points.

 
get lineWeight(): number

Returns number 

set lineWeight(a: number): void

Parameters

  • a: number

Returns void

lowPoint

Section titled "lowPoint"

Determines if the low point is displayed differently.

 
get lowPoint(): boolean

Returns boolean 

set lowPoint(a: boolean): void

Parameters

  • a: boolean

Returns void

markers

Section titled "markers"

Determines if markers are displayed.

 
get markers(): boolean

Returns boolean 

set markers(a: boolean): void

Parameters

  • a: boolean

Returns void

negativePoints

Section titled "negativePoints"

Determines if the negative points are displayed differently.

 
get negativePoints(): boolean

Returns boolean 

set negativePoints(a: boolean): void

Parameters

  • a: boolean

Returns void

rightToLeft

Section titled "rightToLeft"

Determines if the sparkline goes from right to left.

 
get rightToLeft(): boolean

Returns boolean 

set rightToLeft(a: boolean): void

Parameters

  • a: boolean

Returns void

type

Section titled "type"

The type of sparkline

 
get type(): SparklineType

Returns SparklineType 

set type(a: SparklineType): void

Parameters

Returns void

verticalAxisMax

Section titled "verticalAxisMax"

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

 
get verticalAxisMax(): number

Returns number 

set verticalAxisMax(a: number): void

Parameters

  • a: number

Returns void

verticalAxisMaxType

Section titled "verticalAxisMaxType"

Determines how the maximum value for the Y axis is calculated. Note: if this property is set to 'Custom' then the [[verticalAxisMax]] value will be used.

 
get verticalAxisMaxType(): SparklineAxisMinMax

Returns SparklineAxisMinMax 

set verticalAxisMaxType(a: SparklineAxisMinMax): void

Parameters

Returns void

verticalAxisMin

Section titled "verticalAxisMin"

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

 
get verticalAxisMin(): number

Returns number 

set verticalAxisMin(a: number): void

Parameters

  • a: number

Returns void

verticalAxisMinType

Section titled "verticalAxisMinType"

Determines how the minimum value for the Y axis is calculated. Note: if this property is set to 'Custom' then the [[verticalAxisMin]] value will be used.

 
get verticalAxisMinType(): SparklineAxisMinMax

Returns SparklineAxisMinMax 

set verticalAxisMinType(a: SparklineAxisMinMax): void

Parameters

Returns void

workbook

Section titled "workbook"

Returns a reference to the associated workbook.

 
get workbook(): Workbook

Returns Workbook

worksheet

Section titled "worksheet"

Returns a reference to the associated worksheet.

 
get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

setDateRange

Section titled "setDateRange"

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

 
setDateRange(dateRange: string, cellReferenceMode: CellReferenceMode): void

Parameters

  • dateRange: string

    The string representation of the formula.
  • cellReferenceMode: CellReferenceMode

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

Returns void

sparklines

Section titled "sparklines"

Indexer

 
sparklines(index: number, value: Sparkline): Sparkline

Parameters

  • index: number

    The zer-based index of an item
  • value: Sparkline

Returns Sparkline

staticInit

Section titled "staticInit" 
staticInit(): void

Returns void