ig.excel.ChartTextAreaBase

Represents the text area of a chart element.

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

    .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

    .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

    .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

    .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

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

    Gets the formula used to get the text displayed within the text area. (read-only).

    Remarks

    To set this property call the SetFormula method.

    See Also

  • horizontalOverflow

    .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

    .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

  • left

    .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

    .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

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

    Determines whether the position of the text area is automatic or custom as specified by the ChartTextAreaBase.left and ChartTextAreaBase.top properties.

    See Also

  • position

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

    Determines whether the position of the text area is automatic or custom as specified by the ChartTextAreaBase.left and ChartTextAreaBase.top properties.

    • value
    • Type:ig.excel.ElementPosition

    See Also

  • readingOrder

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

    Determines the reading order

    See Also

  • readingOrder

    .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

    .rotation( );

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

  • rotation

    .rotation( value:number );

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

    • value
    • Type:number

  • setFormula

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

    Assigns a new Formula to this instance.

    • formula
    • Type:string
    • The string representation of the formula used to get the ChartTextAreaBase.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.

    See Also

  • sheet
    Inherited

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

    Gets the owning sheet (read-only)

    See Also

  • text

    .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

    .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

    .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

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

    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

    .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

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

    Determines the vertical alignment of the text area.

    See Also

  • verticalAlignment

    .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

    .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

    .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

  • 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

    .wrapText( );

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

  • wrapText

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