ig.excel.DataPoint

Represents the a specific data point in a DataPoint.series.

Remarks

This class encapsulates an individual point of data in a DataPoint.series.

A data point manifests differently depending on the chart type; for example, on a bar chart it represents the bar itself, and for a line chart, it represents a point on the line. For pie and doughnut charts, a data point represents a slice or wedge in the pie/doughnut.

Many of the properties exposed by this class are also found on the DataPoint.series class; setting the property on the series affects all points on the series, whereas setting a property on this class affects only one individual point in the series.

In cases where most of the data points share the same property values, use the property of the Series class, overriding the property values for any individual points using 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.

  • applyPicToEnd

    .applyPicToEnd( );

    Returns a value indicating whether a picture is applied to the end of the point or all points in the series.

  • applyPicToEnd

    .applyPicToEnd( value:boolean );

    Sets a value indicating whether a picture is applied to the end of the point or all points in the series.

    • value
    • Type:boolean

  • applyPicToFront

    .applyPicToFront( );

    Returns a value indicating whether a picture is applied to the front of the point or all points in the series.

  • applyPicToFront

    .applyPicToFront( value:boolean );

    Sets a value indicating whether a picture is applied to the front of the point or all points in the series.

    • value
    • Type:boolean

  • applyPicToSides

    .applyPicToSides( );

    Returns a value indicating whether a picture is applied to the sides of the point or all points in the series.

  • applyPicToSides

    .applyPicToSides( value:boolean );

    Sets a value indicating whether a picture is applied to the sides of the point or all points in the series.

    • value
    • Type:boolean

  • border

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

    Determines the appearance of the border drawn around the data point's DataPoint.fill area.

    Remarks

    For series which support fills, this property controls the color and size of the line drawn around the data point's fill region.

    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 data point's DataPoint.fill area.

    • value
    • Type:ig.excel.ChartBorder

    Remarks

    For series which support fills, this property controls the color and size of the line drawn around the data point's fill region.

    See Also

  • chart
    Inherited

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

    Returns the owning chart (read-only)

    See Also

  • dataLabel

    .dataLabel( );
    Return Type:
    ig.excel.DataLabel
    Return Type Description:
    Returns a DataLabel.

    Returns a DataPoint.dataLabel instance which defines the properties of the label displayed for this data point.

    Remarks

    In order to display data labels, the Series.showDataLabels property must be set to true.

    Use the Series.dataLabels property to apply property settings to all data labels in the series.

    Use the DataLabel.isDeleted property to hide the label for a specific data point.

    See Also

  • dataLabel

    .dataLabel( value:ig.excel.DataLabel );
    Return Type:
    ig.excel.DataLabel
    Return Type Description:
    Returns a DataLabel.

    Sets a DataPoint.dataLabel instance which defines the properties of the label displayed for this data point.

    • value
    • Type:ig.excel.DataLabel

    Remarks

    In order to display data labels, the Series.showDataLabels property must be set to true.

    Use the Series.dataLabels property to apply property settings to all data labels in the series.

    Use the DataLabel.isDeleted property to hide the label for a specific data point.

    See Also

  • explosion

    .explosion( );

    Returns the explosion value for a pie-chart or doughnut-chart slice.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value is outside the range of 0 and 400.

    Remarks

    In the context of a pie or doughnut chart, a DataPoint is synonymous with an individual slice of the pie/doughnut.

    Explosion refers to the amount by which a slice in the pie is offset from the center point of the circle.

    The valid range of values is between 0 and 400, inclusive.

    Use the Series.explosion property to set the explosion for all slices in the pie.

    See Also

  • explosion

    .explosion( value:number );

    Sets the explosion value for a pie-chart or doughnut-chart slice.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value is outside the range of 0 and 400.

    Remarks

    In the context of a pie or doughnut chart, a DataPoint is synonymous with an individual slice of the pie/doughnut.

    Explosion refers to the amount by which a slice in the pie is offset from the center point of the circle.

    The valid range of values is between 0 and 400, inclusive.

    Use the Series.explosion property to set the explosion for all slices in the pie.

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

    Remarks

    This property returns null by default, indicating that no fill is applied. In this case, the default fill color for the associated DataPoint.series is used.

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

    • value
    • Type:ig.excel.ChartFillBase

    Remarks

    This property returns null by default, indicating that no fill is applied. In this case, the default fill color for the associated DataPoint.series is used.

    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

  • invertIfNegative

    .invertIfNegative( );

    Returns a value indicating whether the pattern is inverted in the item when it corresponds to a negative number.

  • invertIfNegative

    .invertIfNegative( value:boolean );

    Sets a value indicating whether the pattern is inverted in the item when it corresponds to a negative number.

    • value
    • Type:boolean

  • markerBorder

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

    Determines the appearance of the border (a.k.a. outline) of the marker for this data point.

    Remarks

    This property provides a way to customize the marker border for an individual data point in the series.

    A value of null implies that the marker border is not explicitly set on this data point, and should inherit the value from it's associated DataPoint.series.

    Use the Series.markerBorder property to customize the border for all markers in the series.

    See Also

  • markerBorder

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

    Determines the appearance of the border (a.k.a. outline) of the marker for this data point.

    • value
    • Type:ig.excel.ChartBorder

    Remarks

    This property provides a way to customize the marker border for an individual data point in the series.

    A value of null implies that the marker border is not explicitly set on this data point, and should inherit the value from it's associated DataPoint.series.

    Use the Series.markerBorder property to customize the border for all markers in the series.

    See Also

  • markerFill

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

    Defines the fill appearance of the marker for this data point.

    Remarks

    This property provides a way to customize the marker fill color for an individual data point in the series.

    A value of null implies that the marker fill color is not explicitly set on this data point, and should inherit the value from it's associated DataPoint.series.

    Use the Series.markerFill property to customize the fill color for all markers in the series.

    See Also

  • markerFill

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

    Defines the fill appearance of the marker for this data point.

    • value
    • Type:ig.excel.ChartFillBase

    Remarks

    This property provides a way to customize the marker fill color for an individual data point in the series.

    A value of null implies that the marker fill color is not explicitly set on this data point, and should inherit the value from it's associated DataPoint.series.

    Use the Series.markerFill property to customize the fill color for all markers in the series.

    See Also

  • markerSize

    .markerSize( );

    Determines the size of the marker for this data point.

    Remarks

    This property provides a way to customize the marker size for an individual data point in the series.

    A value of null implies that the marker size is not explicitly set on this data point, and should inherit the value from it's associated DataPoint.series.

    Use the Series.markerSize property to customize the size of all markers in the series.

    See Also

  • markerSize

    .markerSize( value:number );

    Determines the size of the marker for this data point.

    • value
    • Type:number

    Remarks

    This property provides a way to customize the marker size for an individual data point in the series.

    A value of null implies that the marker size is not explicitly set on this data point, and should inherit the value from it's associated DataPoint.series.

    Use the Series.markerSize property to customize the size of all markers in the series.

    See Also

  • markerStyle

    .markerStyle( );

    Determines the style of the marker for this data point.

    Remarks

    This property provides a way to customize the marker style for an individual data point in the series.

    A value of null implies that the marker style is not explicitly set on this data point, and should inherit the value from it's associated DataPoint.series.

    Use the Series.markerStyle property to customize the style of all markers in the series.

    See Also

  • markerStyle

    .markerStyle( value:ig.excel.MarkerStyle );

    Determines the style of the marker for this data point.

    • value
    • Type:ig.excel.MarkerStyle

    Remarks

    This property provides a way to customize the marker style for an individual data point in the series.

    A value of null implies that the marker style is not explicitly set on this data point, and should inherit the value from it's associated DataPoint.series.

    Use the Series.markerStyle property to customize the style of all markers in the series.

    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

  • setAsTotal

    .setAsTotal( );

    Returns a boolean value indicating whether this data point represents a total or subtotal in a waterfall chart.

    Remarks

    This property is only applicable for waterfall charts.

    See Also

  • setAsTotal

    .setAsTotal( value:boolean );

    Sets a boolean value indicating whether this data point represents a total or subtotal in a waterfall chart.

    • value
    • Type:boolean

    Remarks

    This property is only applicable for waterfall charts.

    See Also

  • sheet
    Inherited

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

    Gets the owning sheet (read-only)

    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

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