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

colorAxis

Section titled "colorAxis" 
colorAxis: WorkbookColorInfo

colorFirstPoint

Section titled "colorFirstPoint" 
colorFirstPoint: WorkbookColorInfo

colorHighPoint

Section titled "colorHighPoint" 
colorHighPoint: WorkbookColorInfo

colorLastPoint

Section titled "colorLastPoint" 
colorLastPoint: WorkbookColorInfo

colorLowPoint

Section titled "colorLowPoint" 
colorLowPoint: WorkbookColorInfo

colorMarkers

Section titled "colorMarkers" 
colorMarkers: WorkbookColorInfo

colorNegativePoints

Section titled "colorNegativePoints" 
colorNegativePoints: WorkbookColorInfo

colorSeries

Section titled "colorSeries" 
colorSeries: WorkbookColorInfo

dateAxis

Section titled "dateAxis" 
dateAxis: boolean

displayBlanksAs

Section titled "displayBlanksAs" 
displayBlanksAs: SparklineDisplayBlanksAs

displayHidden

Section titled "displayHidden" 
displayHidden: boolean

displayXAxis

Section titled "displayXAxis" 
displayXAxis: boolean

firstPoint

Section titled "firstPoint" 
firstPoint: boolean

guid

Section titled "guid" 
guid: any

highPoint

Section titled "highPoint" 
highPoint: boolean

lastPoint

Section titled "lastPoint" 
lastPoint: boolean

lineWeight

Section titled "lineWeight" 
lineWeight: number

lowPoint

Section titled "lowPoint" 
lowPoint: boolean

markers

Section titled "markers" 
markers: boolean

negativePoints

Section titled "negativePoints" 
negativePoints: boolean

rightToLeft

Section titled "rightToLeft" 
rightToLeft: boolean

type

Section titled "type" 
type: SparklineType

verticalAxisMax

Section titled "verticalAxisMax" 
verticalAxisMax: number

verticalAxisMaxType

Section titled "verticalAxisMaxType" 
verticalAxisMaxType: SparklineAxisMinMax

verticalAxisMin

Section titled "verticalAxisMin" 
verticalAxisMin: number

verticalAxisMinType

Section titled "verticalAxisMinType" 
verticalAxisMinType: SparklineAxisMinMax

Accessors

Section titled "Accessors"

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

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