Namespace EasyXLS.Charts

Class ExcelChartArea

System.Object
EasyXLS.Drawings.DrawingObject
EasyXLS.Drawings.LineDrawingObject
EasyXLS.Drawings.FillDrawingObject
EasyXLS.Drawings.EffectDrawingObject
EasyXLS.Drawings.FontDrawingObject
EasyXLS.Charts.ExcelChartArea
All Implemented Interfaces:
IEffectDrawingObject, IFontDrawingObject
public class ExcelChartArea extends FontDrawingObject
This class stores the chart area information like fill settings, font settings, line settings and shadow settings.

  • Constructor Details

    • ExcelChartArea

      public ExcelChartArea()
      Defines an instance of the chart area.

  • Method Details

    • getBorderStyle

      public int getBorderStyle()
      Deprecated.
      As of version 8.3, replaced by LineStyleFormat.getDashType()
      Returns the border style of the chart area. Possible values are available in Chart class.
      Returns:
      the border style of the chart area
      See Also:
      setBorderStyle(int)

    • setBorderStyle

      public void setBorderStyle​(int borderStyle)
      Deprecated.
      As of version 8.3, replaced by LineStyleFormat.setDashType(System.String)
      Sets the style of the chart area border. Possible values are available in Chart class.
      Parameters:
      borderStyle - the new value of the border style
      See Also:
      getBorderStyle()

    • getBorderWeight

      public int getBorderWeight()
      Deprecated.
      As of version 8.3, replaced by LineStyleFormat.getWidth()
      Returns the border weight of the chart area. Possible values are available in Chart class.
      Returns:
      the border style of the chart area

    • setBorderWeight

      public void setBorderWeight​(int borderWeight)
      Deprecated.
      As of version 8.3, replaced by LineStyleFormat.setWidth(float)
      Sets the weight of the chart area border. Possible values are available in Chart class.
      Parameters:
      borderWeight - the new value of the border weight

    • getBorderColor

      public System.Drawing.Color getBorderColor()
      Deprecated.
      As of version 8.3, replaced by LineColorFormat.getLineColor()
      Returns the border color of the chart area.
      Returns:
      the border color of the chart area

    • setBorderColor

      public void setBorderColor​(System.Drawing.Color borderColor)
      Deprecated.
      As of version 8.3, replaced by LineColorFormat.setLineColor(Color)
      Sets the color of the chart area border.
      Parameters:
      borderColor - the new color of the border

    • IsShadow

      public bool IsShadow()
      Deprecated.
      As of version 8.3, replaced by ShadowFormat.HasShadow()
      Returns the shadow setting of the chart area.
      Returns:
      the shadow setting of the chart area

    • setShadow

      public void setShadow​(bool isShadow)
      Deprecated.
      As of version 8.3, replaced by ShadowFormat.setShadow(int)
      Sets the shadow setting of the chart area.
      Parameters:
      isShadow - the new value of the shadow setting

    • getForeground

      public System.Drawing.Color getForeground()
      Deprecated.
      As of version 8.3, replaced by FontFormat.getForeground()
      Returns the text color of the chart area.
      Returns:
      the text color of the chart area
      See Also:
      setForeground(Color)

    • setForeground

      public void setForeground​(System.Drawing.Color foreground)
      Deprecated.
      As of version 8.3, replaced by FontFormat.setForeground(Color)
      Sets the foreground color of the chart area.
      Parameters:
      foreground - the new color of the foreground
      See Also:
      getForeground()

    • getBackground

      public System.Drawing.Color getBackground()
      Deprecated.
      As of version 8.3, replaced by FillFormat.getBackground()
      Returns the chart area background color.
      Returns:
      the background color of the chart area

    • setBackground

      public void setBackground​(System.Drawing.Color background)
      Deprecated.
      As of version 8.3, replaced by FillFormat.setBackground(Color)
      Sets the background color of the chart area.
      Parameters:
      background - the new color of the area background

    • IsStrikethrough

      public bool IsStrikethrough()
      Deprecated.
      As of version 8.3, replaced by FontFormat.IsStrikethrough()
      Returns the strikethrough setting of the chart area font.
      Returns:
      the strikethrough setting of the chart area font
      See Also:
      setStrikethrough(bool)

    • setStrikethrough

      public void setStrikethrough​(bool isStrikethrough)
      Deprecated.
      As of version 8.3, replaced by FontFormat.setStrikethrough(bool)
      Sets the strikethrough setting of the chart area font.
      Parameters:
      isStrikethrough - the new value of the strikethrough setting
      See Also:
      IsStrikethrough()

    • IsSuperscript

      public bool IsSuperscript()
      Deprecated.
      As of version 8.3, replaced by FontFormat.IsSuperscript()
      Returns the superscript setting of the chart area font.
      Returns:
      the superscript setting of the chart area font
      See Also:
      setSuperscript(bool)

    • setSuperscript

      public void setSuperscript​(bool isSuperscript)
      Deprecated.
      As of version 8.3, replaced by FontFormat.setSuperscript(bool)
      Sets the superscript setting of the chart area font.
      Parameters:
      isSuperscript - the new superscript setting of the chart area
      See Also:
      IsSuperscript()

    • IsSubscript

      public bool IsSubscript()
      Deprecated.
      As of version 8.3, replaced by FontFormat.IsSubscript()
      Returns the subscript setting of the chart area font.
      Returns:
      the subscript setting of the chart area font
      See Also:
      setSubscript(bool)

    • setSubscript

      public void setSubscript​(bool isSubscript)
      Deprecated.
      As of version 8.3, replaced by FontFormat.setSubscript(bool)
      Sets the subscript setting of the chart area font.
      Parameters:
      isSubscript - the new subscript setting of the chart area font
      See Also:
      IsSubscript()

    • getUnderlineStyle

      public int getUnderlineStyle()
      Deprecated.
      As of version 8.3, replaced by FontFormat.getUnderlineStyle()
      Returns the underline style of the chart area text. Possible values are available in FontSettings class.
      Returns:
      the underline style
      See Also:
      setUnderlineStyle(int)

    • setUnderlineStyle

      public void setUnderlineStyle​(int underlineStyle)
      Deprecated.
      As of version 8.3, replaced by FontFormat.setUnderlineSettings(String,bool)
      Sets the underline style of the chart area. Possible values are available in FontSettings class.
      Parameters:
      underlineStyle - the underline style of the chart area
      See Also:
      getUnderlineStyle()

    • getFontSize

      public int getFontSize()
      Deprecated.
      As of version 8.3, replaced by FontFormat.getFontSize()
      Returns the size of the font used in the chart area.
      Returns:
      the size of the font used in the chart area
      See Also:
      setFontSize(int)

    • setFontSize

      public void setFontSize​(int fontSize)
      Deprecated.
      As of version 8.3, replaced by FontFormat.setFontSize(float))
      Sets the size of the chart area font.
      Parameters:
      fontSize - the new value of the font size
      See Also:
      getFontSize()

    • getFont

      public System.String getFont()
      Deprecated.
      As of version 8.3, replaced by FontFormat.getFont()
      Returns the font name used in the chart area.
      Returns:
      the name of the font used in the chart area
      See Also:
      setFont(System.String)

    • setFont

      public void setFont​(System.String fontName)
      Deprecated.
      As of version 8.3, replaced by FontFormat.setFont(System.String)
      Sets the chart area font name.
      Parameters:
      fontName - the name of the new font
      See Also:
      getFont()

    • IsBold

      public bool IsBold()
      Deprecated.
      As of version 8.3, replaced by FontFormat.IsBold()
      Returns the bold setting of the chart area font.
      Returns:
      the bold setting of the chart area font
      See Also:
      setBold(bool)

    • setBold

      public void setBold​(bool isBold)
      Deprecated.
      As of version 8.3, replaced by FontFormat.setBold(bool)
      Sets the bold setting of the chart area font.
      Parameters:
      isBold - the new value of the bold setting
      See Also:
      IsBold()

    • IsItalic

      public bool IsItalic()
      Deprecated.
      As of version 8.3, replaced by FontFormat.IsItalic()
      Returns the italic setting of the chart area font.
      Returns:
      the italic setting of the chart area font
      See Also:
      setItalic(bool)

    • setItalic

      public void setItalic​(bool isItalic)
      Deprecated.
      As of version 8.3, replaced by FontFormat.setItalic(bool)
      Sets the italic setting of the chart area font.
      Parameters:
      isItalic - the new italic style of the chart area font
      See Also:
      IsItalic()

    • setFontSettings

      public void setFontSettings​(System.String fontName, int fontSize, bool isBold, bool isItalic, System.Drawing.Color foreground)
      Deprecated.
      As of version 8.3, replaced by FontFormat.setFontSettings(String,int,bool,bool,Color)
      Sets the font settings.
      Parameters:
      fontName - the name of the font
      fontSize - the size of the font
      isBold - the bold option of the font
      isItalic - the italic option of the font
      foreground - the foreground color

    • HasRoundedCorners

      public bool HasRoundedCorners()
      Returns true if the corners of the border are rounded, false otherwise.
      Returns:
      true if the corners of the border are rounded, false otherwise
      See Also:
      setRoundedCorners(bool)

    • setRoundedCorners

      public void setRoundedCorners​(bool roundedCorners)
      Sets rounded corners for the border.
      Parameters:
      roundedCorners - true if the corners of the border are rounded, false otherwise
      See Also:
      HasRoundedCorners()

    • Clone

      public ExcelChartArea Clone()
      Creates and returns a copy of this object.
      Returns:
      a clone of this instance.