Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class Line

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

public class Line
extends java.lang.Object

Encapsulates the object that represents the chart line.


Method Summary
 boolean equals(java.lang.Object another)
           
 short getBeginArrowLengthType()
          Gets the begin arrow length type.
 short getBeginArrowType()
          Gets the begin type of arrow settings for line style.
 short getBeginArrowWidthType()
          Gets the begin arrow width type.
 byte getCapType()
          Gets the cap type for line style.
 Color getColor()
          Gets the Color of the line.
 short getCompoundType()
          Gets the compound type for line style.
 short getDashType()
          Gets the dash type for line style.
 short getEndArrowLengthType()
          Gets the end arrow length type.
 short getEndArrowType()
          Gets the end type of arrow settings for line style.
 short getEndArrowWidthType()
          Gets the end arrow width type.
 Fill getFill()
          Gets the GradientFill or PatternFill when the border is set to gradient or pattern.
 byte getJoinType()
          Gets the join type for line style.
 int getStyle()
          Gets the style of the line.
 float getTransparency()
          Gets the transparency.
 int getWeight()
          Gets the weight type of the line.
 float getWidth()
          Gets the width of line, in points.
 boolean isAuto()
          Indicates whether Microsoft Workbook automatically determines the line pattern.
 boolean isVisible()
          Indicates whether the line is visible in the chart.
 void setAuto(boolean isAuto)
          Sets whether Microsoft Workbook automatically determines the line pattern.
 void setBeginArrowLengthType(short type)
          Sets the begin arrow length type.
 void setBeginArrowType(short type)
          Sets the begin type of arrow settings for line style.
 void setBeginArrowWidthType(short type)
          Sets the begin arrow width type.
 void setCapType(byte type)
          Sets the cap type for line style.
 void setColor(Color color)
          Sets the Color of the line.
 void setCompoundType(short type)
          Sets compound type for line style.
 void setDashType(short type)
          Sets the dash type for line style.
 void setEndArrowLengthType(short type)
          Sets the end arrow length type.
 void setEndArrowType(short type)
          Sets the end type of arrow settings for line style.
 void setEndArrowWidthType(short type)
          Sets the end arrow width type.
 void setFill(Fill fill)
          Sets the border color to gradient or pattern using given fill settings.
 void setJoinType(byte type)
          Sets the join type for line style.
 void setStyle(int style)
          Sets the style of the line
 void setTransparency(float val)
          Sets the transparency.
 void setVisible(boolean visible)
          Sets whether the line is visible in the chart.
 void setWeight(int weightType)
          Sets the weight type of the line.
 void setWidth(float points)
          Sets the width of line, in points.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

equals

public boolean equals(java.lang.Object another)
Overrides:
equals in class java.lang.Object

getColor

public Color getColor()
Gets the Color of the line.

Returns:
the Color of the line.

setColor

public void setColor(Color color)
Sets the Color of the line.

Parameters:
color - the Color of the line.

isVisible

public boolean isVisible()
Indicates whether the line is visible in the chart.

Returns:
whether the line is visible in the chart.

setVisible

public void setVisible(boolean visible)
Sets whether the line is visible in the chart.

Parameters:
visible - whether the line is visible in the chart.

getStyle

public int getStyle()
Gets the style of the line.

Returns:
the style of the line.
See Also:
setStyle(int)

setStyle

public void setStyle(int style)
Sets the style of the line

Parameters:
style - the style of the line. It could be one of the following values:
LineType.DARK_GRAY
LineType.DASH
LineType.DASH_DOT
LineType.DASH_DOT_DOT
LineType.DOT
LineType.LIGHT_GRAY
LineType.MEDIUM_GRAY
LineType.SOLID
Throws:
java.lang.IllegalArgumentException - if line type is invalid.

getWeight

public int getWeight()
Gets the weight type of the line.

Returns:
the weight type of the line.
See Also:
setWeight(int)

setWeight

public void setWeight(int weightType)
Sets the weight type of the line.

Parameters:
weightType - the weight type of the line. It could be one of the following values:
WeightType.HAIR_LINE
WeightType.MEDIUME_LINE
WeightType.SINGLE_LINE
WeightType.WIDE_LINE
Throws:
java.lang.IllegalArgumentException - if line weight type is invalid.

getWidth

public float getWidth()
Gets the width of line, in points.

Returns:
line width in points.

setWidth

public void setWidth(float points)
Sets the width of line, in points.

Parameters:
points - line width in points. Can only be 0~1584

setAuto

public void setAuto(boolean isAuto)
Sets whether Microsoft Workbook automatically determines the line pattern.

Parameters:
isAuto - whether Microsoft Workbook automatically determines the line pattern.

isAuto

public boolean isAuto()
Indicates whether Microsoft Workbook automatically determines the line pattern.

Returns:
whether Microsoft Workbook automatically determines the line pattern.

getCompoundType

public short getCompoundType()
Gets the compound type for line style.

Returns:
the compound type.
See Also:
setCompoundType(short)

setCompoundType

public void setCompoundType(short type)
Sets compound type for line style.

Parameters:
type - compound type. Valid values defined in MsoLineStyle.
See Also:
MsoLineStyle

getDashType

public short getDashType()
Gets the dash type for line style.

Returns:
dash type.
See Also:
setDashType(short)

setDashType

public void setDashType(short type)
Sets the dash type for line style.

Parameters:
type - dash type. Valid values defined in MsoLineDashStyle.
See Also:
MsoLineDashStyle

getCapType

public byte getCapType()
Gets the cap type for line style.

Returns:
cap type.
See Also:
setCapType(byte)

setCapType

public void setCapType(byte type)
Sets the cap type for line style.

Parameters:
type - cap type. Valid values defined in LineCapType.
See Also:
LineCapType

getJoinType

public byte getJoinType()
Gets the join type for line style.

Returns:
join type.
See Also:
setJoinType(byte)

setJoinType

public void setJoinType(byte type)
Sets the join type for line style.

Parameters:
type - join type. Valid values defined in LineJoinType.
See Also:
LineJoinType

getBeginArrowType

public short getBeginArrowType()
Gets the begin type of arrow settings for line style.

Returns:
begin type of arrow.
See Also:
setBeginArrowType(short)

setBeginArrowType

public void setBeginArrowType(short type)
Sets the begin type of arrow settings for line style.

Parameters:
type - arrow type. Valid values defined in MsoLineEndType.
See Also:
MsoLineEndType

getBeginArrowWidthType

public short getBeginArrowWidthType()
Gets the begin arrow width type.

Returns:
begin arrow width type.
See Also:
setBeginArrowWidthType(short)

setBeginArrowWidthType

public void setBeginArrowWidthType(short type)
Sets the begin arrow width type.

Parameters:
type - begin arrow width type. Valid values defined in MsoLineEndWidth.
See Also:
MsoLineEndWidth

getBeginArrowLengthType

public short getBeginArrowLengthType()
Gets the begin arrow length type.

Returns:
begin arrow length type.
See Also:
setBeginArrowLengthType(short)

setBeginArrowLengthType

public void setBeginArrowLengthType(short type)
Sets the begin arrow length type.

Parameters:
type - begin arrow length type. Valid values defined in MsoLineEndLength.
See Also:
MsoLineEndLength

getEndArrowType

public short getEndArrowType()
Gets the end type of arrow settings for line style.

Returns:
end type of arrow.
See Also:
setEndArrowType(short)

setEndArrowType

public void setEndArrowType(short type)
Sets the end type of arrow settings for line style.

Parameters:
type - arrow type. Valid values defined in MsoLineEndType.
See Also:
MsoLineEndType

getEndArrowWidthType

public short getEndArrowWidthType()
Gets the end arrow width type.

Returns:
end arrow width type.
See Also:
setEndArrowWidthType(short)

setEndArrowWidthType

public void setEndArrowWidthType(short type)
Sets the end arrow width type.

Parameters:
type - end arrow width type. Valid values defined in MsoLineEndWidth.
See Also:
MsoLineEndWidth

getEndArrowLengthType

public short getEndArrowLengthType()
Gets the end arrow length type.

Returns:
end arrow length type.
See Also:
setEndArrowLengthType(short)

setEndArrowLengthType

public void setEndArrowLengthType(short type)
Sets the end arrow length type.

Parameters:
type - end arrow length type. Valid values defined in MsoLineEndLength.
See Also:
MsoLineEndLength

getTransparency

public float getTransparency()
Gets the transparency.

Returns:
transparency, 0~1.
See Also:
setTransparency(float)

setTransparency

public void setTransparency(float val)
Sets the transparency.

Parameters:
val - transparency. Can only be a value from 0 to 1.

getFill

public Fill getFill()
Gets the GradientFill or PatternFill when the border is set to gradient or pattern.

Returns:
fill settings if the border is set to gradient or pattern. Otherwise returns null.

setFill

public void setFill(Fill fill)
Sets the border color to gradient or pattern using given fill settings.

Parameters:
fill - Fill settings for border. Can be GradientFill or PatternFill.