Namespace EasyXLS.Charts

Class ExcelChartLegend

System.Object
EasyXLS.Drawings.DrawingObject
EasyXLS.Drawings.LineDrawingObject
EasyXLS.Drawings.FillDrawingObject
EasyXLS.Drawings.EffectDrawingObject
EasyXLS.Drawings.FontDrawingObject
EasyXLS.Charts.ExcelChartLegend
All Implemented Interfaces:
IEffectDrawingObject, IFontDrawingObject
public class ExcelChartLegend extends FontDrawingObject
This class stores the ChartLegend information like fill settings, font settings, line settings, shadow settings, legend position, keys arrangement direction, visibility .

  • Constructor Details

    • ExcelChartLegend

      public ExcelChartLegend()
      Defines an instance of the excel legend.

  • Method Details

    • IsVisible

      public bool IsVisible()
      Returns the visible setting of the chart legend.
      Returns:
      the visible setting of the chart legend
      See Also:
      setVisible(bool)

    • setVisible

      public void setVisible​(bool value)
      Sets the visible setting of the chart legend.
      Parameters:
      value - the new visible setting of the chart legend
      See Also:
      IsVisible()

    • getBorderStyle

      public int getBorderStyle()
      Deprecated.
      As of version 8.3, replaced by LineStyleFormat.getDashType()
      Returns the border style of the chart legend. Possible values are available in Chart class.
      Returns:
      the border style of the chart legend
      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 legend border. Possible values are available in Chart class.
      Parameters:
      borderStyle - the new style of the chart legend border
      See Also:
      getBorderStyle()

    • getBorderWeight

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

    • setBorderWeight

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

    • getBorderColor

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

    • 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 legend border.
      Parameters:
      borderColor - the new color of the chart legend border
      See Also:
      getBorderColor()

    • IsShadow

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

    • setShadow

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

    • getForeground

      public System.Drawing.Color getForeground()
      Deprecated.
      As of version 8.3, replaced by FontFormat.getForeground()
      Returns the text color of the chart legend.
      Returns:
      the text color of the chart legend
      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 legend.
      Parameters:
      foreground - the new color of the chart legend foreground
      See Also:
      getForeground()

    • getBackground

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

    • 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 legend.
      Parameters:
      background - the new color of the legend background

    • IsStrikethrough

      public bool IsStrikethrough()
      Deprecated.
      As of version 8.3, replaced by FontFormat.IsStrikethrough()
      Returns the strikethrough setting of the chart legend font.
      Returns:
      the strikethrough setting of the chart legend 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 legend 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 legend font.
      Returns:
      Returns the superscript setting of the chart legend 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 legend font.
      Parameters:
      isSuperscript - the new superscript setting of the chart legend font
      See Also:
      IsSuperscript()

    • IsSubscript

      public bool IsSubscript()
      Deprecated.
      As of version 8.3, replaced by FontFormat.IsSubscript()
      Returns the subscript setting of the chart legend font.
      Returns:
      the subscript setting of the chart legend 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 legend font.
      Parameters:
      isSubscript - the new subscript setting of the chart legend 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 legend text. Possible values are available in FontSettings class.
      Returns:
      the underline style of the chart legend text
      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 legend text. Possible values are available in FontSettings class.
      Parameters:
      underlineStyle - the new underline style of the chart legend
      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 legend.
      Returns:
      the size of the font used in the chart legend
      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 legend font.
      Parameters:
      fontSize - the new value of the chart legend 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 legend.
      Returns:
      the font name used in the chart legend
      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 legend 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 legend font.
      Returns:
      the bold setting of the chart legend 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 legend 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 legend font.
      Returns:
      the italic setting of the chart legend 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 legend 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

    • getPlacement

      public int getPlacement()
      Returns the position of the chart legend within the chart area. Possible values are available in Chart class.
      Returns:
      the position of the chart legend within the chart area
      See Also:
      setPlacement(int)

    • setPlacement

      public void setPlacement​(int location)
      Sets the placement setting (position) of the chart legend within the chart area. Possible values are available in Chart class.
      Parameters:
      location - the new position of the chart legend.
      See Also:
      getPlacement()

    • getKeysArrangementDirection

      public int getKeysArrangementDirection()
      Returns the direction in which the keys are arranged inside the legend: vertically or horizontally. It is valid only for Office 97-2003 files. Possible values are available in Chart class.
      Returns:
      the direction for keys arrangement
      See Also:
      setKeysArrangementDirection(int)

    • setKeysArrangementDirection

      public void setKeysArrangementDirection​(int direction)
      Sets the direction in which the keys will be arranged: vertical or horizontal. It is valid only for Office 97-2003 files. Possible values are available in Chart class.
      Parameters:
      direction - the new direction
      See Also:
      getKeysArrangementDirection()

    • get3DFormat

      public Format3D get3DFormat()
      This class does not support 3D formatting.
      Specified by:
      get3DFormat in interface IEffectDrawingObject
      Overrides:
      get3DFormat in class EffectDrawingObject
      Returns:
      always return null
      See Also:
      EffectDrawingObject.set3DFormat(EasyXLS.Drawings.Formatting.Format3D)

    • Clone

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