ig.excel.PlotArea

Represents the area in which the chart series is plotted.

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 chart element area, as well as whether a border appears.

  • 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 chart element area, as well as whether a border appears.

    • value
    • Type:ig.excel.ChartBorder
  • chart
    Inherited

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

    Returns the owning chart (read-only)

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

    To make the area transparent, assign an instance of the ChartEmptyFill class to this property.

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

    To make the area transparent, assign an instance of the ChartEmptyFill class to this property.

  • height

    .height( );

    Returns the height of the area, expressed as a fraction of the height of the containing chart element.

  • height

    .height( value:number );

    Sets the height of the area, expressed as a fraction of the height of the containing chart element.

    • value
    • Type:number
  • left

    .left( );

    Returns a value which represents the left edge of the area, expressed as a fraction of the width of the containing chart element.

    Remarks

    This property can be set to a value between zero and one, where one represents the total width of the containing element.

    For example, to situate the area such that it's left edge coincides with the center of the containing element, set this property to .5.

  • left

    .left( value:number );

    Sets a value which represents the left edge of the area, expressed as a fraction of the width of the containing chart element.

    • value
    • Type:number

    Remarks

    This property can be set to a value between zero and one, where one represents the total width of the containing element.

    For example, to situate the area such that it's left edge coincides with the center of the containing element, set this property to .5.

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

  • position

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

    Returns the position of the plot area on the chart.

  • position

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

    Sets the position of the plot area on the chart.

    • value
    • Type:ig.excel.ElementPosition
  • roundedCorners
    Inherited

    .roundedCorners( );

    Detrmines if the chart area is displayed with rounded corners

  • roundedCorners
    Inherited

    .roundedCorners( value:boolean );

    Detrmines if the chart area is displayed with rounded corners

    • value
    • Type:boolean
  • sheet
    Inherited

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

    Gets the owning sheet (read-only)

    See Also

  • top

    .top( );

    Returns a value which represents the top edge of the area, expressed as a fraction of the height of the containing chart element.

    Remarks

    This property can be set to a value between zero and one, where one represents the total height of the containing element.

    For example, to situate the area such that it's top edge coincides with the center of the containing element, set this property to .5.

  • top

    .top( value:number );

    Sets a value which represents the top edge of the area, expressed as a fraction of the height of the containing chart element.

    • value
    • Type:number

    Remarks

    This property can be set to a value between zero and one, where one represents the total height of the containing element.

    For example, to situate the area such that it's top edge coincides with the center of the containing element, set this property to .5.

  • width

    .width( );

    Returns the width of the area, expressed as a fraction of the width of the containing chart element.

  • width

    .width( value:number );

    Sets the width of the area, expressed as a fraction of the width of the containing chart element.

    • value
    • Type:number
  • workbook
    Inherited

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

    Gets the owning workbook (read-only)

  • worksheet
    Inherited

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

    Gets the owning worksheet (read-only)

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