ig.excel.SparklineGroup
Represents a group of Sparklines
Dependencies
jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
-
colorAxis
- .colorAxis( );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the axis
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.dateAxis property is explicity set to true. -
colorAxis
- .colorAxis( value:ig.excel.WorkbookColorInfo );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the axis
- value
- Type:ig.excel.WorkbookColorInfo
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.dateAxis property is explicity set to true. -
colorFirstPoint
- .colorFirstPoint( );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the first point
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.firstPoint property is explicity set to true. -
colorFirstPoint
- .colorFirstPoint( value:ig.excel.WorkbookColorInfo );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the first point
- value
- Type:ig.excel.WorkbookColorInfo
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.firstPoint property is explicity set to true. -
colorHighPoint
- .colorHighPoint( );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the high point
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.highPoint property is explicity set to true. -
colorHighPoint
- .colorHighPoint( value:ig.excel.WorkbookColorInfo );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the high point
- value
- Type:ig.excel.WorkbookColorInfo
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.highPoint property is explicity set to true. -
colorLastPoint
- .colorLastPoint( );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the last point
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.lastPoint property is explicity set to true. -
colorLastPoint
- .colorLastPoint( value:ig.excel.WorkbookColorInfo );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the last point
- value
- Type:ig.excel.WorkbookColorInfo
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.lastPoint property is explicity set to true. -
colorLowPoint
- .colorLowPoint( );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the low point
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.lowPoint property is explicity set to true. -
colorLowPoint
- .colorLowPoint( value:ig.excel.WorkbookColorInfo );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the low point
- value
- Type:ig.excel.WorkbookColorInfo
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.lowPoint property is explicity set to true. -
colorMarkers
- .colorMarkers( );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the markers
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.markers property is explicity set to true. -
colorMarkers
- .colorMarkers( value:ig.excel.WorkbookColorInfo );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the markers
- value
- Type:ig.excel.WorkbookColorInfo
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.markers property is explicity set to true. -
colorNegativePoints
- .colorNegativePoints( );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the negative point
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.negativePoints property is explicity set to true. -
colorNegativePoints
- .colorNegativePoints( value:ig.excel.WorkbookColorInfo );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- Returns a WorkbookColorInfo.
Determines the color of the negative point
- value
- Type:ig.excel.WorkbookColorInfo
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. Remarks
Note: this property is ignored unless the SparklineGroup.negativePoints property is explicity set to true. -
colorSeries
- .colorSeries( );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- The color to use for the series.
Determines the default color for the series
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. See Also
-
colorSeries
- .colorSeries( value:ig.excel.WorkbookColorInfo );
- Return Type:
- ig.excel.WorkbookColorInfo
- Return Type Description:
- The color to use for the series.
Determines the default color for the series
- value
- Type:ig.excel.WorkbookColorInfo
Exceptions
Exception Description ig.ArgumentNullException Color can't be set to null. ig.ArgumentException Color can't be set to 'Auto'. See Also
-
dateAxis
- .dateAxis( );
Determines whether to use a date axis
-
dateAxis
- .dateAxis( value:boolean );
Determines whether to use a date axis
- value
- Type:boolean
-
dateRange
- .dateRange( );
- Return Type:
- ig.excel.WorksheetRegion
- Return Type Description:
- Returns a WorksheetRegion.
Gets the date range (read-only)
Remarks
Note: this property is ignored unless the SparklineGroup.dateAxis property is explicity set to true. -
dateRangeFormula
- .dateRangeFormula( );
- Return Type:
- ig.excel.Formula
- Return Type Description:
- Returns a Formula.
Gets the date range formula (read-only)
Remarks
Note: this property is ignored unless the SparklineGroup.dateAxis property is explicity set to true. -
displayBlanksAs
- .displayBlanksAs( );
- Return Type:
- ig.excel.SparklineDisplayBlanksAs
- Return Type Description:
- Returns a SparklineDisplayBlanksAs.
Determines how blanks will be displayed
See Also
-
displayBlanksAs
- .displayBlanksAs( value:ig.excel.SparklineDisplayBlanksAs );
- Return Type:
- ig.excel.SparklineDisplayBlanksAs
- Return Type Description:
- Returns a SparklineDisplayBlanksAs.
Determines how blanks will be displayed
- value
- Type:ig.excel.SparklineDisplayBlanksAs
See Also
-
displayHidden
- .displayHidden( );
Determines whether values from cells that are hidden will be displayed
-
displayHidden
- .displayHidden( value:boolean );
Determines whether values from cells that are hidden will be displayed
- value
- Type:boolean
-
displayXAxis
- .displayXAxis( );
Determines if the x-axis will be displayed
-
displayXAxis
- .displayXAxis( value:boolean );
Determines if the x-axis will be displayed
- value
- Type:boolean
-
firstPoint
- .firstPoint( );
Determines if the first point is displayed differently.
-
firstPoint
- .firstPoint( value:boolean );
Determines if the first point is displayed differently.
- value
- Type:boolean
-
guid
- .guid( );
A unique identifier for this group (read-only).
Remarks
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. -
highPoint
- .highPoint( );
Determines if the high point is displayed differently.
-
highPoint
- .highPoint( value:boolean );
Determines if the high point is displayed differently.
- value
- Type:boolean
-
lastPoint
- .lastPoint( );
Determines if the last point is displayed differently.
-
lastPoint
- .lastPoint( value:boolean );
Determines if the last point is displayed differently.
- value
- Type:boolean
-
lineWeight
- .lineWeight( );
Determines the weight of a line in points.
Exceptions
Exception Description ig.ArgumentOutOfRangeException if the value is less than zero or greather than 1584. -
lineWeight
- .lineWeight( value:number );
Determines the weight of a line in points.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException if the value is less than zero or greather than 1584. -
lowPoint
- .lowPoint( );
Determines if the low point is displayed differently.
-
lowPoint
- .lowPoint( value:boolean );
Determines if the low point is displayed differently.
- value
- Type:boolean
-
markers
- .markers( );
Determines if markers are displayed.
See Also
-
markers
- .markers( value:boolean );
Determines if markers are displayed.
- value
- Type:boolean
See Also
-
negativePoints
- .negativePoints( );
Determines if the negative points are displayed differently.
-
negativePoints
- .negativePoints( value:boolean );
Determines if the negative points are displayed differently.
- value
- Type:boolean
-
rightToLeft
- .rightToLeft( );
Determines if the sparkline goes from right to left.
-
rightToLeft
- .rightToLeft( value:boolean );
Determines if the sparkline goes from right to left.
- value
- Type:boolean
-
setDateRange
- .setDateRange( dateRange:string, [cellReferenceMode:ig.excel.CellReferenceMode] );
Assigns a new SparklineGroup.dateRange.
- dateRange
- Type:string
- The string representation of the formula.
- cellReferenceMode
- Type:ig.excel.CellReferenceMode
- Optional
- An optional CellReferenceMode to use to parse the dateRange. If null it defaults to the workbook's mode.
Remarks
Note: SparklineGroup.dateRange is ignored unless the SparklineGroup.dateAxis property is explicity set to true. See Also
-
sparklines
- .sparklines( );
- Return Type:
- ig.excel.SparklineCollection
- Return Type Description:
- Returns a SparklineCollection.
Gets the collection of sparklines in the group (read-only)
See Also
-
sparklines
- .sparklines( index:number );
- Return Type:
- ig.excel.Sparkline
- Return Type Description:
- The item at the specified index
Indexer
- index
- Type:number
- The zer-based index of an item
Exceptions
Exception Description ig.IndexOutOfRangeException If the index is negative or greater than or equal to SparklineCollection.count See Also
-
type
- .type( );
- Return Type:
- ig.excel.SparklineType
- Return Type Description:
- Returns a SparklineType.
Gets the type of sparkline
See Also
-
type
- .type( value:ig.excel.SparklineType );
- Return Type:
- ig.excel.SparklineType
- Return Type Description:
- Returns a SparklineType.
Sets the type of sparkline
- value
- Type:ig.excel.SparklineType
See Also
-
verticalAxisMax
- .verticalAxisMax( );
A custom maximum value for the Y axis.
Remarks
Note: if SparklineGroup.verticalAxisMaxType property is not set to 'Custom' then this property is ignored. -
verticalAxisMax
- .verticalAxisMax( value:number );
A custom maximum value for the Y axis.
- value
- Type:number
Remarks
Note: if SparklineGroup.verticalAxisMaxType property is not set to 'Custom' then this property is ignored. -
verticalAxisMaxType
- .verticalAxisMaxType( );
- Return Type:
- ig.excel.SparklineAxisMinMax
- Return Type Description:
- Returns a SparklineAxisMinMax.
Determines how the maximum value for the Y axis is calculated.
Remarks
Note: if this property is set to 'Custom' then the SparklineGroup.verticalAxisMax value will be used. -
verticalAxisMaxType
- .verticalAxisMaxType( value:ig.excel.SparklineAxisMinMax );
- Return Type:
- ig.excel.SparklineAxisMinMax
- Return Type Description:
- Returns a SparklineAxisMinMax.
Determines how the maximum value for the Y axis is calculated.
- value
- Type:ig.excel.SparklineAxisMinMax
Remarks
Note: if this property is set to 'Custom' then the SparklineGroup.verticalAxisMax value will be used. -
verticalAxisMin
- .verticalAxisMin( );
A custom minimum value for the Y axis.
Remarks
Note: if SparklineGroup.verticalAxisMinType property is not set to 'Custom' then this property is ignored. -
verticalAxisMin
- .verticalAxisMin( value:number );
A custom minimum value for the Y axis.
- value
- Type:number
Remarks
Note: if SparklineGroup.verticalAxisMinType property is not set to 'Custom' then this property is ignored. -
verticalAxisMinType
- .verticalAxisMinType( );
- Return Type:
- ig.excel.SparklineAxisMinMax
- Return Type Description:
- Returns a SparklineAxisMinMax.
Determines how the minimum value for the Y axis is calculated.
Remarks
Note: if this property is set to 'Custom' then the SparklineGroup.verticalAxisMin value will be used. -
verticalAxisMinType
- .verticalAxisMinType( value:ig.excel.SparklineAxisMinMax );
- Return Type:
- ig.excel.SparklineAxisMinMax
- Return Type Description:
- Returns a SparklineAxisMinMax.
Determines how the minimum value for the Y axis is calculated.
- value
- Type:ig.excel.SparklineAxisMinMax
Remarks
Note: if this property is set to 'Custom' then the SparklineGroup.verticalAxisMin value will be used. -
workbook
- .workbook( );
- Return Type:
- ig.excel.Workbook
- Return Type Description:
- Returns a Workbook.
Returns a reference to the associated workbook.
See Also
-
worksheet
- .worksheet( );
- Return Type:
- ig.excel.Worksheet
- Return Type Description:
- Returns a Worksheet.
Returns a reference to the associated worksheet.
See Also