constructor

• new SparklineGroup(a, b): SparklineGroup

• Parameters

  • a: number

  • b: Worksheet

  Returns SparklineGroup

• new SparklineGroup(a, b, c): SparklineGroup

• Parameters

  • a: number

  • b: Worksheet

  • c: SparklineType

  Returns SparklineGroup

• new SparklineGroup(a, ..._rest): SparklineGroup

• Parameters

  • a: number

  • ..._rest: any[]

  Returns SparklineGroup

Static$t

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): void

• Parameters

  • a: WorkbookColorInfo

  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): void

• Parameters

  • a: WorkbookColorInfo

  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): void

• Parameters

  • a: WorkbookColorInfo

  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): void

• Parameters

  • a: WorkbookColorInfo

  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): void

• Parameters

  • a: WorkbookColorInfo

  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): void

• Parameters

  • a: WorkbookColorInfo

  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): void

• Parameters

  • a: WorkbookColorInfo

  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): void

• Parameters

  • a: WorkbookColorInfo

  Returns void

dateAxis

• get dateAxis(): boolean

• Determines whether to use a date axis

  See

  • [[colorAxis]]
  • [[dateRange]]
  • [[setDateRange]]

  Returns boolean

• set dateAxis(a): void

• Parameters

  • a: boolean

  Returns void

dateRange

• get dateRange(): WorksheetRegion

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

  See

  • [[dateAxis]]
  • [[dateRangeFormula]]
  • [[setDateRange]]

  Returns WorksheetRegion

dateRangeFormula

• get dateRangeFormula(): Formula

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

  See

  • [[dateAxis]]
  • [[dateRangeFormula]]
  • [[setDateRange]]

  Returns Formula

displayBlanksAs

• get displayBlanksAs(): SparklineDisplayBlanksAs

• Determines how blanks will be displayed

  Returns SparklineDisplayBlanksAs

• set displayBlanksAs(a): void

• Parameters

  • a: SparklineDisplayBlanksAs

  Returns void

displayHidden

• get displayHidden(): boolean

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

  Returns boolean

• set displayHidden(a): void

• Parameters

  • a: boolean

  Returns void

displayXAxis

• get displayXAxis(): boolean

• Determines if the x-axis will be displayed

  Returns boolean

• set displayXAxis(a): 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): void

• Parameters

  • a: boolean

  Returns void

guid

• get guid(): 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 Guid

• set guid(a): void

• Parameters

  • a: Guid

  Returns void

highPoint

• get highPoint(): boolean

• Determines if the high point is displayed differently.

  See

  [[colorHighPoint]]

  Returns boolean

• set highPoint(a): 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): 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): 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): void

• Parameters

  • a: boolean

  Returns void

markers

• get markers(): boolean

• Determines if markers are displayed.

  See

  [[colorMarkers]]

  Returns boolean

• set markers(a): 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): void

• Parameters

  • a: boolean

  Returns void

rightToLeft

• get rightToLeft(): boolean

• Determines if the sparkline goes from right to left.

  Returns boolean

• set rightToLeft(a): void

• Parameters

  • a: boolean

  Returns void

type

• get type(): SparklineType

• The type of sparkline

  Returns SparklineType

• set type(a): void

• Parameters

  • a: SparklineType

  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): void

• Parameters

  • a: number

  Returns void

verticalAxisMaxType

• get verticalAxisMaxType(): SparklineAxisMinMax

• 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.

  See

  [[verticalAxisMax]]

  Returns SparklineAxisMinMax

• set verticalAxisMaxType(a): void

• Parameters

  • a: SparklineAxisMinMax

  Returns void

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): void

• Parameters

  • a: number

  Returns void

verticalAxisMinType

• get verticalAxisMinType(): SparklineAxisMinMax

• 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.

  See

  [[verticalAxisMin]]

  Returns SparklineAxisMinMax

• set verticalAxisMinType(a): void

• Parameters

  • a: SparklineAxisMinMax

  Returns void

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

setDateRange

• setDateRange(dateRange, cellReferenceMode?): void

• 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.

  • cellReferenceMode: CellReferenceMode

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

  Returns void

sparklines

• sparklines(index, value?): Sparkline

• Indexer

  Throws

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

  Parameters

  • index: number

    The zer-based index of an item

  • value: Sparkline

  Returns Sparkline

• sparklines(): SparklineCollection

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

  Returns SparklineCollection

StaticstaticInit

• staticInit(): void

• Returns void