ig.excel.DataLabel

Represents the label of a specific DataPoint.

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.

  • ig.excel.DataLabel
    Constructor

    new $.ig.excel.DataLabel( );

    Creates a new DataPoint instance.

  • 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

  • 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

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

    Not supported.

    See Also

  • height

    .height( );

    Returns a value that represents the height of the label, expressed as a ratio, relative to the size of the chart area.

  • height

    .height( value:number );

    Sets a value that represents the height of the label, expressed as a ratio, relative to the size of the chart area.

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

    Returns a boolean value indicating whether this label has been deleted.

  • isDeleted

    .isDeleted( value:boolean );

    Sets a boolean value indicating whether this label has been deleted.

    • value
    • Type:boolean

  • labelPosition

    .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

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

    .left( );

    Gets the left position of the text area (ignored unless ChartTextAreaBase.position is set to 'Custom').

    Remarks

    The value of this property is expressed as a fractional value between 0 and 1 which represents the ratio of the offset to the width of the chart element.

    For example, a value of 0 positions the text area as close as possible to the edge of the chart element; a value of 1 positions it as close as possible to the opposite edge. All values in between 0 and 1 represent a scalar which, when applied to the width of the entire chart element, yields the offset.

    See Also

  • left
    Inherited

    .left( value:number );

    Sets the left position of the text area (ignored unless ChartTextAreaBase.position is set to 'Custom').

    • value
    • Type:number

    Remarks

    The value of this property is expressed as a fractional value between 0 and 1 which represents the ratio of the offset to the width of the chart element.

    For example, a value of 0 positions the text area as close as possible to the edge of the chart element; a value of 1 positions it as close as possible to the opposite edge. All values in between 0 and 1 represent a scalar which, when applied to the width of the entire chart element, yields the offset.

    See Also

  • 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

  • position

    .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

    .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

    .separator( );

    Returns the separator used between multiple values in the label.

  • separator

    .separator( value:string );

    Sets the separator used between multiple values in the label.

    • value
    • Type:string

  • setFormula

    .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

    .showBubbleSize( );

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

  • showBubbleSize

    .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

    .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

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

  • showLegendKey

    .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

    .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

    .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

    .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

    .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

    .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

    .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

    .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

    .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

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

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

    Returns a FormattedString object which defines the text to be displayed by the associated chart element.

    Remarks

    Because mixed font settings are supported for chart element text, a special object is required to customize the text.

    For the simple case where all the text has the same formatting, create an instance of the FormattedString class, specifiying the text as the value of the 'unformattedString' parameter.

    To apply font attributes to a given run of text, i.e., a substring within the text, use the FormattedString.getFont method, and set the applicable properties of the FormattedStringFont instance returned from the GetFont method.

    See Also

  • text
    Inherited

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

    Sets a FormattedString object which defines the text to be displayed by the associated chart element.

    • value
    • Type:ig.excel.FormattedString

    Remarks

    Because mixed font settings are supported for chart element text, a special object is required to customize the text.

    For the simple case where all the text has the same formatting, create an instance of the FormattedString class, specifiying the text as the value of the 'unformattedString' parameter.

    To apply font attributes to a given run of text, i.e., a substring within the text, use the FormattedString.getFont method, and set the applicable properties of the FormattedStringFont instance returned from the GetFont method.

    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
    Inherited

    .top( );

    Gets the top position of the text area (ignored unless ChartTextAreaBase.position is set to 'Custom').

    Remarks

    The value of this property is expressed as a fractional value between 0 and 1 which represents the ratio of the offset to the height of the associated chart element.

    For example, a value of 0 positions the title as close as possible to the edge of the associated chart element; a value of 1 positions it as close as possible to the opposite edge. All values in between 0 and 1 represent a scalar which, when applied to the height of the entire chart element, yields the offset.

    See Also

  • top
    Inherited

    .top( value:number );

    Sets the top position of the text area (ignored unless ChartTextAreaBase.position is set to 'Custom').

    • value
    • Type:number

    Remarks

    The value of this property is expressed as a fractional value between 0 and 1 which represents the ratio of the offset to the height of the associated chart element.

    For example, a value of 0 positions the title as close as possible to the edge of the associated chart element; a value of 1 positions it as close as possible to the opposite edge. All values in between 0 and 1 represent a scalar which, when applied to the height of the entire chart element, yields the offset.

    See Also

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

    Returns a value that represents the width of the label, expressed as a ratio, relative to the size of the chart area.

  • width

    .width( value:number );

    Sets a value that represents the width of the label, expressed as a ratio, relative to the size of the chart area.

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