ig.excel.SeriesDataLabels

Defines the properties for all data labels displayed for this Series.

Remarks

This property provides a way to set properties on multiple data labels.

Use the DataPoint.dataLabel property to customize an individual data label.

The property values of the DataPoint.dataLabel class take precedence over the properties of this class.

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.

  • border
    Inherited

    .border( );
    Return Type:
    ig.excel.ChartBorder
    Return Type Description:
    Returns a ChartBorder.

    Determines the appearance of the border drawn around the text area, as well as whether a border appears.

    See Also

  • border
    Inherited

    .border( value:ig.excel.ChartBorder );
    Return Type:
    ig.excel.ChartBorder
    Return Type Description:
    Returns a ChartBorder.

    Determines the appearance of the border drawn around the text area, as well as whether a border appears.

    • value
    • Type:ig.excel.ChartBorder

    See Also

  • chart
    Inherited

    .chart( );
    Return Type:
    ig.excel.WorksheetChart
    Return Type Description:
    Returns a WorksheetChart.

    Returns the owning chart (read-only)

    See Also

  • dataLabelsRange

    .dataLabelsRange( );
    Return Type:
    ig.excel.Formula
    Return Type Description:
    Returns a Formula.

    Returns a Formula which defines the cell range from which part or all of the label text is obtained.

    Remarks

    Use the SeriesDataLabels.setDataLabelsRange method to assign a new value.

    The cell values obtained from this property are only displayed when the DataLabel.showRange property is set to true.

    The specified range must contain only one column or one row, or an exception is thrown.

    See Also

  • defaultFont
    Inherited

    .defaultFont( );
    Return Type:
    ig.excel.IWorkbookFont
    Return Type Description:
    Returns a IWorkbookFont.

    Defines the font properties for each formatted run in the ChartTextAreaBase.text that has no more specific setting. Read-only.

    Remarks

    Use this object to apply font formatting to the entire run of text which comprises the chart or axis title.

    Font formatting can be applied to individual runs of text using the FormattedString.getFont method of the object returned from the ChartTextAreaBase.text property. Any such formatting overrides that which is defined by the DefaultFont settings.

    Note: this property will return null until the ChartTitle is set on the WorksheetChart.ChartTitle property.

    See Also

  • fill
    Inherited

    .fill( );
    Return Type:
    ig.excel.ChartFillBase
    Return Type Description:
    Returns a ChartFillBase.

    Returns a ChartFillBase derived object which defines the fill properties for the text area.

    Remarks

    This property returns null by default, indicating that no fill is applied.

    To apply a solid color fill, assign an instance of the ChartSolidFill class to this property.

    To apply a gradient fill, assign an instance of the ChartGradientFill class to this property.

    See Also

  • fill
    Inherited

    .fill( value:ig.excel.ChartFillBase );
    Return Type:
    ig.excel.ChartFillBase
    Return Type Description:
    Returns a ChartFillBase.

    Sets a ChartFillBase derived object which defines the fill properties for the text area.

    • value
    • Type:ig.excel.ChartFillBase

    Remarks

    This property returns null by default, indicating that no fill is applied.

    To apply a solid color fill, assign an instance of the ChartSolidFill class to this property.

    To apply a gradient fill, assign an instance of the ChartGradientFill class to this property.

    See Also

  • formula
    Inherited

    .formula( );
    Return Type:
    ig.excel.Formula
    Return Type Description:
    Returns a Formula.

    Not supported.

    See Also

  • height

    .height( );

    Not supported.

  • height

    .height( value:number );

    Not supported.

    • value
    • Type:number

  • horizontalOverflow
    Inherited

    .horizontalOverflow( );
    Return Type:
    ig.excel.TextHorizontalOverflow
    Return Type Description:
    Returns a TextHorizontalOverflow.

    Determines whether text is allowed to continue horizontally outside the bounds of the containing element.

    See Also

  • horizontalOverflow
    Inherited

    .horizontalOverflow( value:ig.excel.TextHorizontalOverflow );
    Return Type:
    ig.excel.TextHorizontalOverflow
    Return Type Description:
    Returns a TextHorizontalOverflow.

    Determines whether text is allowed to continue horizontally outside the bounds of the containing element.

    • value
    • Type:ig.excel.TextHorizontalOverflow

    See Also

  • isDeleted

    .isDeleted( );

    Not supported.

  • isDeleted

    .isDeleted( value:boolean );

    Not supported.

    • value
    • Type:boolean

  • labelPosition
    Inherited

    .labelPosition( );
    Return Type:
    ig.excel.DataLabelPosition
    Return Type Description:
    Returns a DataLabelPosition.

    Returns a value which determines the label's position as relative to the series bar/line.

    Remarks

    When this property is set to Custom, the position is determined by the values of the Left and Top properties.

    When a custom label position is assigned, connecting lines appear between the label and its respective DataPoint. These lines are referred to as 'leader lines'; use the Series.leaderLines property to control their appearance.

    Note that leader lines can be hidden by setting the SeriesDataLabels.showLeaderLines property to false.

    See Also

  • labelPosition
    Inherited

    .labelPosition( value:ig.excel.DataLabelPosition );
    Return Type:
    ig.excel.DataLabelPosition
    Return Type Description:
    Returns a DataLabelPosition.

    Sets a value which determines the label's position as relative to the series bar/line.

    • value
    • Type:ig.excel.DataLabelPosition

    Remarks

    When this property is set to Custom, the position is determined by the values of the Left and Top properties.

    When a custom label position is assigned, connecting lines appear between the label and its respective DataPoint. These lines are referred to as 'leader lines'; use the Series.leaderLines property to control their appearance.

    Note that leader lines can be hidden by setting the SeriesDataLabels.showLeaderLines property to false.

    See Also

  • left

    .left( );

    Not supported.

  • left

    .left( value:number );

    Not supported.

    • value
    • Type:number

  • numberFormat
    Inherited

    .numberFormat( );

    Returns the format to use for numbers.

    See Also

  • numberFormat
    Inherited

    .numberFormat( value:string );

    Sets the format to use for numbers.

    • value
    • Type:string

    See Also

  • numberFormatLinked
    Inherited

    .numberFormatLinked( );

    True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

    See Also

  • numberFormatLinked
    Inherited

    .numberFormatLinked( value:boolean );

    True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

    • value
    • Type:boolean

    See Also

  • owner
    Inherited

    .owner( );
    Return Type:
    ig.excel.ChartObject
    Return Type Description:
    The owner or null if this object is owned directly by the Chart

    returns this object's owner. (read-only)

    See Also

  • parentLabelLayout

    .parentLabelLayout( );
    Return Type:
    ig.excel.ParentLabelLayout
    Return Type Description:
    Returns a ParentLabelLayout.

    Returns a value which determines the label positioning for a Treemap chart.

    Remarks

    This property is only applicable for Treemap charts.

    See Also

  • parentLabelLayout

    .parentLabelLayout( value:ig.excel.ParentLabelLayout );
    Return Type:
    ig.excel.ParentLabelLayout
    Return Type Description:
    Returns a ParentLabelLayout.

    Sets a value which determines the label positioning for a Treemap chart.

    • value
    • Type:ig.excel.ParentLabelLayout

    Remarks

    This property is only applicable for Treemap charts.

    See Also

  • position
    Inherited

    .position( );
    Return Type:
    ig.excel.ElementPosition
    Return Type Description:
    Returns a ElementPosition.

    This property is not supported. Use the DataLabel.labelPosition property instead.

    See Also

  • position
    Inherited

    .position( value:ig.excel.ElementPosition );
    Return Type:
    ig.excel.ElementPosition
    Return Type Description:
    Returns a ElementPosition.

    This property is not supported. Use the DataLabel.labelPosition property instead.

    • value
    • Type:ig.excel.ElementPosition

    See Also

  • readingOrder
    Inherited

    .readingOrder( );
    Return Type:
    ig.excel.ReadingOrder
    Return Type Description:
    Returns a ReadingOrder.

    Determines the reading order

    See Also

  • readingOrder
    Inherited

    .readingOrder( value:ig.excel.ReadingOrder );
    Return Type:
    ig.excel.ReadingOrder
    Return Type Description:
    Returns a ReadingOrder.

    Determines the reading order

    • value
    • Type:ig.excel.ReadingOrder

    See Also

  • rotation
    Inherited

    .rotation( );

    Determines the rotation of the text area, expressed in degrees.

  • rotation
    Inherited

    .rotation( value:number );

    Determines the rotation of the text area, expressed in degrees.

    • value
    • Type:number

  • separator
    Inherited

    .separator( );

    Returns the separator used between multiple values in the label.

  • separator
    Inherited

    .separator( value:string );

    Sets the separator used between multiple values in the label.

    • value
    • Type:string

  • setDataLabelsRange

    .setDataLabelsRange( formula:string, [cellReferenceMode:ig.excel.CellReferenceMode] );

    Assigns a Formula to the SeriesDataLabels.dataLabelsRange

    • formula
    • Type:string
    • The string representation of the formula used to obtain the data label text.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • Optional
    • A CellReferenceMode value which specifies whether the formula parameter should be interpreted as an A1 or R1C1 expression. This parameter is optional and defaults to null, in which case the Workbook.cellReferenceMode property is used.

  • setFormula
    Inherited

    .setFormula( formula:string, [cellReferenceMode:ig.excel.CellReferenceMode] );

    Not supported.

    • formula
    • Type:string
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • Optional

  • sheet
    Inherited

    .sheet( );
    Return Type:
    ig.excel.Sheet
    Return Type Description:
    Returns a Sheet.

    Gets the owning sheet (read-only)

    See Also

  • showBubbleSize
    Inherited

    .showBubbleSize( );

    Returns if the bubble size is shown. Applies only to Series which are displayed within a bubble chart.

  • showBubbleSize
    Inherited

    .showBubbleSize( value:boolean );

    Sets if the bubble size is shown. Applies only to Series which are displayed within a bubble chart.

    • value
    • Type:boolean

  • showCategoryName
    Inherited

    .showCategoryName( );

    Returns a value indicating whether the category name is shown.

    Remarks

    The category name is not shown by default; to show the category name in the label, set this property to true.

  • showCategoryName
    Inherited

    .showCategoryName( value:boolean );

    Sets a value indicating whether the category name is shown.

    • value
    • Type:boolean

    Remarks

    The category name is not shown by default; to show the category name in the label, set this property to true.

  • showLeaderLines

    .showLeaderLines( );

    Returns a boolean value indicating whether leader lines are displayed for the data labels associated with this instance.

    Remarks

    Leader lines connect data labels to their respective data points.

    The LeaderLines property provides a way to customize the appearance of the connecting lines. These lines are only drawn, however, for data labels whose DataLabel.labelPosition property is set to Custom.

    Use this property to allow leader lines to be shown using the default appearance, i.e., setting this property to true without specifying a custom appearance causes them to acquire the default appearance as determined by Excel.

    Leader lines can be hidden by setting this property to false.

    See Also

  • showLeaderLines

    .showLeaderLines( value:boolean );

    Sets a boolean value indicating whether leader lines are displayed for the data labels associated with this instance.

    • value
    • Type:boolean

    Remarks

    Leader lines connect data labels to their respective data points.

    The LeaderLines property provides a way to customize the appearance of the connecting lines. These lines are only drawn, however, for data labels whose DataLabel.labelPosition property is set to Custom.

    Use this property to allow leader lines to be shown using the default appearance, i.e., setting this property to true without specifying a custom appearance causes them to acquire the default appearance as determined by Excel.

    Leader lines can be hidden by setting this property to false.

    See Also

  • showLegendKey
    Inherited

    .showLegendKey( );

    Returns if the Legend key is shown.

    Remarks

    The legend key is not shown by default; to show the legend key in the label, set this property to true.

  • showLegendKey
    Inherited

    .showLegendKey( value:boolean );

    Sets if the Legend key is shown.

    • value
    • Type:boolean

    Remarks

    The legend key is not shown by default; to show the legend key in the label, set this property to true.

  • showPercentage
    Inherited

    .showPercentage( );

    Returns a value indicating whether the percentage of the range is shown.

    Remarks

    The percentage is not shown by default; to show the percentage in the label, set this property to true.

  • showPercentage
    Inherited

    .showPercentage( value:boolean );

    Sets a value indicating whether the percentage of the range is shown.

    • value
    • Type:boolean

    Remarks

    The percentage is not shown by default; to show the percentage in the label, set this property to true.

  • showRange
    Inherited

    .showRange( );

    Returns a boolean value indicating whether the data label range is shown.

    Remarks

    The data label range is defined by the SeriesDataLabels.dataLabelsRange

    The data label range is not shown by default; to show the range in the label, set this property to true.

    See Also

  • showRange
    Inherited

    .showRange( value:boolean );

    Sets a boolean value indicating whether the data label range is shown.

    • value
    • Type:boolean

    Remarks

    The data label range is defined by the SeriesDataLabels.dataLabelsRange

    The data label range is not shown by default; to show the range in the label, set this property to true.

    See Also

  • showSeriesName
    Inherited

    .showSeriesName( );

    Returns a value indicating whether the series name is shown in the label.

    Remarks

    The series name is not shown by default; to show the series name in the label, set this property to true.

  • showSeriesName
    Inherited

    .showSeriesName( value:boolean );

    Sets a value indicating whether the series name is shown in the label.

    • value
    • Type:boolean

    Remarks

    The series name is not shown by default; to show the series name in the label, set this property to true.

  • showValue
    Inherited

    .showValue( );

    Returns a value indicating whether the value is shown.

    Remarks

    The value is shown by default; to prevent the value from displaying in the label, set this property to false.

  • showValue
    Inherited

    .showValue( value:boolean );

    Sets a value indicating whether the value is shown.

    • value
    • Type:boolean

    Remarks

    The value is shown by default; to prevent the value from displaying in the label, set this property to false.

  • text

    .text( );
    Return Type:
    ig.excel.FormattedString
    Return Type Description:
    Returns a FormattedString.

    Not supported.

    See Also

  • text

    .text( value:ig.excel.FormattedString );
    Return Type:
    ig.excel.FormattedString
    Return Type Description:
    Returns a FormattedString.

    Not supported.

    • value
    • Type:ig.excel.FormattedString

    See Also

  • textDirection
    Inherited

    .textDirection( );
    Return Type:
    ig.excel.TextDirection
    Return Type Description:
    Returns a TextDirection.

    Determines the orientation and direction in which text flows.

    Remarks

    Note that the ChartTextAreaBase.rotation property is only applicable when this property is set to Horizontal.

    See Also

  • textDirection
    Inherited

    .textDirection( value:ig.excel.TextDirection );
    Return Type:
    ig.excel.TextDirection
    Return Type Description:
    Returns a TextDirection.

    Determines the orientation and direction in which text flows.

    • value
    • Type:ig.excel.TextDirection

    Remarks

    Note that the ChartTextAreaBase.rotation property is only applicable when this property is set to Horizontal.

    See Also

  • top

    .top( );

    Not supported.

  • top

    .top( value:number );

    Not supported.

    • value
    • Type:number

  • verticalAlignment
    Inherited

    .verticalAlignment( );
    Return Type:
    ig.excel.VerticalTitleAlignment
    Return Type Description:
    Returns a VerticalTitleAlignment.

    Determines the vertical alignment of the text area.

    See Also

  • verticalAlignment
    Inherited

    .verticalAlignment( value:ig.excel.VerticalTitleAlignment );
    Return Type:
    ig.excel.VerticalTitleAlignment
    Return Type Description:
    Returns a VerticalTitleAlignment.

    Determines the vertical alignment of the text area.

    • value
    • Type:ig.excel.VerticalTitleAlignment

    See Also

  • verticalOverflow
    Inherited

    .verticalOverflow( );
    Return Type:
    ig.excel.TextVerticalOverflow
    Return Type Description:
    Returns a TextVerticalOverflow.

    Determines whether text is allowed to continue vertically outside the bounds of the containing element.

    See Also

  • verticalOverflow
    Inherited

    .verticalOverflow( value:ig.excel.TextVerticalOverflow );
    Return Type:
    ig.excel.TextVerticalOverflow
    Return Type Description:
    Returns a TextVerticalOverflow.

    Determines whether text is allowed to continue vertically outside the bounds of the containing element.

    • value
    • Type:ig.excel.TextVerticalOverflow

    See Also

  • width

    .width( );

    Not supported.

  • width

    .width( value:number );

    Not supported.

    • value
    • Type:number

  • workbook
    Inherited

    .workbook( );
    Return Type:
    ig.excel.Workbook
    Return Type Description:
    Returns a Workbook.

    Gets the owning workbook (read-only)

    See Also

  • worksheet
    Inherited

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    Returns a Worksheet.

    Gets the owning worksheet (read-only)

    See Also

  • wrapText
    Inherited

    .wrapText( );

    Determines whether text is wrapped when it would exceed the bounds of the containing element.

  • wrapText
    Inherited

    .wrapText( value:boolean );

    Determines whether text is wrapped when it would exceed the bounds of the containing element.

    • value
    • Type:boolean

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