Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class ChartPoint

java.lang.Object
  extended by com.aspose.cells.ChartPoint

public class ChartPoint
extends java.lang.Object

Represents a single point in a series in a chart.


Method Summary
 int compareTo(ChartPoint point)
          Compares this ChartPoint with another one for order.
 int compareTo(int index)
          Compares this ChartPoint with another one that has given point index for order.
 Area getArea()
          Gets the Area.
 Line getBorder()
          Gets the border Line.
 DataLabels getDataLabels()
          Gets the DataLabels object
 DataLabels getDataLabelsOrNull()
          Gets the customed DataLabels object of this point.
 int getExplosion()
          Get the distance of an open pie slice from the center of the pie chart, expressed as a percentage of the pie diameter.
 int getKey()
          Gets the comparable key of this ChartPoint.
 Marker getMarker()
          Gets the Marker settings for line chart, scatter chart, or radar chart.
 Color getMarkerBackgroundColor()
          Gets the marker backgournd color in a line chart, scatter chart, or radar chart.
 Color getMarkerForegroundColor()
          Gets the marker foregournd color in a line chart, scatter chart, or radar chart.
 int getMarkerSize()
          Gets the marker size in a line chart, scatter chart, or radar chart.
 short getMarkerStyle()
          Gets the marker style in a line chart, scatter chart, or radar chart.
 int getPointIndex()
          Gets the index of this ChartPoint.
 boolean isInvertIfNegative()
          Indicates if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.
 boolean isShadow()
          Indicates whether the series has a shadow
 void setExplosion(int value)
          Set the distance of an open pie slice from the center of the pie chart, expressed as a percentage of the pie diameter.
 void setInvertIfNegative(boolean invert)
          Sets whether Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.
 void setKey(int key)
          Sets the comparable key of this ChartPoint.
 void setMarkerBackgroundColor(Color markerBackgroundColor)
          Sets the marker backgournd color in a line chart, scatter chart, or radar chart.
 void setMarkerForegroundColor(Color markerForegroundColor)
          Represents the marker foregournd color in a line chart, scatter chart, or radar chart.
 void setMarkerSize(int markerSize)
          Sets the marker size in a line chart, scatter chart, or radar chart.
 void setMarkerStyle(short markerStyle)
          Sets the marker style in a line chart, scatter chart, or radar chart.
 void setShadow(boolean isShadow)
          Sets whether the series has a shadow
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getPointIndex

public int getPointIndex()
Gets the index of this ChartPoint.

Returns:
the index of this ChartPoint.
See Also:
ChartPoints.getChartPoint(int)

getBorder

public Line getBorder()
Gets the border Line.

Returns:
the border Line.
Throws:
CellsException - if the series has bean removed.

getArea

public Area getArea()
Gets the Area.

Returns:
the border Line.
Throws:
CellsException - if the series has bean removed.

getDataLabels

public DataLabels getDataLabels()
Gets the DataLabels object

Returns:
the DataLabels object
Throws:
CellsException - if series collection has been removed.

getDataLabelsOrNull

public DataLabels getDataLabelsOrNull()
Gets the customed DataLabels object of this point. If this point has no its own customed DataLabels, return null. That means this point shares the DataLabels settings of the ASeries or the Whole Chart.

Returns:
the customed DataLabels object of this point.
Throws:
CellsException - if series collection has been removed.

isShadow

public boolean isShadow()
Indicates whether the series has a shadow

Returns:
whether the series has a shadow

setShadow

public void setShadow(boolean isShadow)
Sets whether the series has a shadow

Parameters:
isShadow - whether the series has a shadow

getExplosion

public int getExplosion()
Get the distance of an open pie slice from the center of the pie chart, expressed as a percentage of the pie diameter.

Returns:
the distance of an open pie slice from the center of the pie chart

setExplosion

public void setExplosion(int value)
Set the distance of an open pie slice from the center of the pie chart, expressed as a percentage of the pie diameter.

Parameters:
value - the distance of an open pie slice from the center of the pie chart

isInvertIfNegative

public boolean isInvertIfNegative()
Indicates if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

Returns:
true if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

setInvertIfNegative

public void setInvertIfNegative(boolean invert)
Sets whether Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

Parameters:
invert - whether Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

getMarker

public Marker getMarker()
Gets the Marker settings for line chart, scatter chart, or radar chart.

Returns:
Marker settings of ChartPoint.

getMarkerBackgroundColor

public Color getMarkerBackgroundColor()
Gets the marker backgournd color in a line chart, scatter chart, or radar chart.

Returns:
the marker backgournd color
Throws:
CellsException - if chart has been removed.
See Also:
Marker.getArea()

setMarkerBackgroundColor

public void setMarkerBackgroundColor(Color markerBackgroundColor)
Sets the marker backgournd color in a line chart, scatter chart, or radar chart.

Parameters:
markerBackgroundColor - the marker backgournd color.
Throws:
CellsException - if chart has been removed.
See Also:
Marker.getArea()

getMarkerForegroundColor

public Color getMarkerForegroundColor()
Gets the marker foregournd color in a line chart, scatter chart, or radar chart.

Returns:
the marker foregournd color.
Throws:
CellsException - if chart has been removed.
See Also:
Marker.getLine()

setMarkerForegroundColor

public void setMarkerForegroundColor(Color markerForegroundColor)
Represents the marker foregournd color in a line chart, scatter chart, or radar chart.

Parameters:
markerForegroundColor - the marker foregournd color.
Throws:
CellsException - if chart has been removed.

getMarkerSize

public int getMarkerSize()
Gets the marker size in a line chart, scatter chart, or radar chart.

Returns:
the marker size.
Throws:
CellsException - if chart has been removed.
See Also:
Marker.getSize()

setMarkerSize

public void setMarkerSize(int markerSize)
Sets the marker size in a line chart, scatter chart, or radar chart.

Parameters:
markerSize - the marker size(between 2 and 72).
Throws:
java.lang.IllegalArgumentException - if marker size is not between 2 and 72;
CellsException - if chart has been removed.
See Also:
Marker.setSize(int)

getMarkerStyle

public short getMarkerStyle()
Gets the marker style in a line chart, scatter chart, or radar chart.

Returns:
the marker style.
Throws:
CellsException - if chart has been removed.
See Also:
Marker.getStyle()

setMarkerStyle

public void setMarkerStyle(short markerStyle)
Sets the marker style in a line chart, scatter chart, or radar chart.

Parameters:
markerStyle - the marker style. It could be one of the following values:
ChartMarkerType.AUTOMATIC
ChartMarkerType.CIRCLE
ChartMarkerType.DASH
ChartMarkerType.DOT
ChartMarkerType.DIAMOND
ChartMarkerType.NONE
ChartMarkerType.SQUARE_PLUS
ChartMarkerType.SQUARE
ChartMarkerType.SQUARE_STAR
ChartMarkerType.TRIANGLE
ChartMarkerType.SQUARE_X
Throws:
java.lang.IllegalArgumentException - if marker style is invalid.
CellsException - if chart has been removed.
See Also:
Marker.setStyle(short)

compareTo

public int compareTo(int index)
Compares this ChartPoint with another one that has given point index for order.

Parameters:
index - the point index to be compared with the index of this point.
Returns:
a negative integer, zero, or a positive integer as the index of this point is less than, equal to, or greater than the specified point index.

compareTo

public int compareTo(ChartPoint point)
Compares this ChartPoint with another one for order.

Parameters:
point - the ChartPoint to be compared with this one.
Returns:
a negative integer, zero, or a positive integer as the index of this point is less than, equal to, or greater than the index of the specified ChartPoint object.

getKey

public int getKey()
Gets the comparable key of this ChartPoint. Same with getPointIndex().

Returns:
the comparable key of this ChartPoint, that is the point index.

setKey

public void setKey(int key)
Sets the comparable key of this ChartPoint. Only for inner usage. Does not make any change for this ChartPoint object.

Parameters:
key - key value.