ig.excel.SparklineGroup

Sparkline のグループを表します。

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( );

    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.

    See Also

  • colorAxis

    .colorAxis( value:ig.excel.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.

    See Also

  • colorFirstPoint

    .colorFirstPoint( );

    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.

    See Also

  • colorFirstPoint

    .colorFirstPoint( value:ig.excel.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.

    See Also

  • colorHighPoint

    .colorHighPoint( );

    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.

    See Also

  • colorHighPoint

    .colorHighPoint( value:ig.excel.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.

    See Also

  • colorLastPoint

    .colorLastPoint( );

    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.

    See Also

  • colorLastPoint

    .colorLastPoint( value:ig.excel.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.

    See Also

  • colorLowPoint

    .colorLowPoint( );

    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.

    See Also

  • colorLowPoint

    .colorLowPoint( value:ig.excel.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.

    See Also

  • colorMarkers

    .colorMarkers( );

    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.

    See Also

  • colorMarkers

    .colorMarkers( value:ig.excel.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.

    See Also

  • colorNegativePoints

    .colorNegativePoints( );

    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.

    See Also

  • colorNegativePoints

    .colorNegativePoints( value:ig.excel.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.

    See Also

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

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

  • dateAxis

    .dateAxis( );

    Determines whether to use a date axis

    See Also

  • dateAxis

    .dateAxis( value:boolean );

    Determines whether to use a date axis

    • value
    • Type:boolean

    See Also

  • dateRange

    .dateRange( );

    Gets the date range (read-only)

    Remarks

    Note: this property is ignored unless the SparklineGroup.dateAxis property is explicity set to true.

    See Also

  • dateRangeFormula

    .dateRangeFormula( );

    Gets the date range formula (read-only)

    Remarks

    Note: this property is ignored unless the SparklineGroup.dateAxis property is explicity set to true.

    See Also

  • displayBlanksAs

    .displayBlanksAs( );

    Determines how blanks will be displayed

  • displayBlanksAs

    .displayBlanksAs( value:ig.excel.SparklineDisplayBlanksAs );

    Determines how blanks will be displayed

    • value
    • Type:ig.excel.SparklineDisplayBlanksAs

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

    See Also

  • firstPoint

    .firstPoint( value:boolean );

    Determines if the first point is displayed differently.

    • value
    • Type:boolean

    See Also

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

    See Also

  • highPoint

    .highPoint( );

    Determines if the high point is displayed differently.

    See Also

  • highPoint

    .highPoint( value:boolean );

    Determines if the high point is displayed differently.

    • value
    • Type:boolean

    See Also

  • lastPoint

    .lastPoint( );

    Determines if the last point is displayed differently.

    See Also

  • lastPoint

    .lastPoint( value:boolean );

    Determines if the last point is displayed differently.

    • value
    • Type:boolean

    See Also

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

    See Also

  • lowPoint

    .lowPoint( value:boolean );

    Determines if the low point is displayed differently.

    • value
    • Type:boolean

    See Also

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

    See Also

  • negativePoints

    .negativePoints( value:boolean );

    Determines if the negative points are displayed differently.

    • value
    • Type:boolean

    See Also

  • 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( );

    Gets the collection of sparklines in the group (read-only)

  • 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

  • type

    .type( );

    Gets the type of sparkline

  • type

    .type( value:ig.excel.SparklineType );

    Sets the type of sparkline

    • value
    • Type:ig.excel.SparklineType

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

    See Also

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

    See Also

  • verticalAxisMaxType

    .verticalAxisMaxType( );

    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.

    See Also

  • verticalAxisMaxType

    .verticalAxisMaxType( value:ig.excel.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.

    See Also

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

    See Also

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

    See Also

  • verticalAxisMinType

    .verticalAxisMinType( );

    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.

    See Also

  • verticalAxisMinType

    .verticalAxisMinType( value:ig.excel.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.

    See Also

  • workbook

    .workbook( );

    Returns a reference to the associated workbook.

  • worksheet

    .worksheet( );

    Returns a reference to the associated worksheet.

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.