Namespace EasyXLS.Charts
Class ExcelDataTable
System.Object
- All Implemented Interfaces:
IEffectDrawingObject
,IFontDrawingObject
This class stores the data table information like
line settings, fill settings, font settings, shadow settings, legend key visibility,
horizontal lines visibility, vertical lines visibility, outlines visibility, visibility.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionClone()
Creates and returns a copy of this object.System.String
getFont()
Deprecated.int
Deprecated.As of version 8.3, replaced byFontFormat.getFontSize()
System.Drawing.Color
Deprecated.As of version 8.3, replaced byFontFormat.getForeground()
System.Drawing.Color
Deprecated.As of version 8.3, replaced byLineColorFormat.getLineColor()
int
Deprecated.As of version 8.3, replaced byLineStyleFormat.getDashType()
int
Deprecated.As of version 8.3, replaced byLineStyleFormat.getWidth()
int
Deprecated.As of version 8.3, replaced byFontFormat.getUnderlineStyle()
bool
Returns a value showing if the data table has horizontal lines between entries.bool
Returns a bool value representing the visibility of the data table legend key.bool
Returns a bool value representing the visibility of the data table outline lines.bool
Returns a bool value representing the visibility of the vertical lines between values.bool
IsBold()
Deprecated.As of version 8.3, replaced byFontFormat.IsBold()
bool
IsItalic()
Deprecated.As of version 8.3, replaced byFontFormat.IsItalic()
bool
Deprecated.As of version 8.3, replaced byFontFormat.IsStrikethrough()
bool
Deprecated.As of version 8.3, replaced byFontFormat.IsSubscript()
bool
Deprecated.As of version 8.3, replaced byFontFormat.IsSuperscript()
bool
Returns the visible setting of the chart data table.void
setBold(bool isBold)
Deprecated.As of version 8.3, replaced byFontFormat.setBold(bool)
void
setFont(System.String fontName)
Deprecated.As of version 8.3, replaced byFontFormat.setFont(System.String)
void
setFontSettings(System.String fontName, int fontSize, bool isBold, bool isItalic, System.Drawing.Color foreground)
Deprecated.As of version 8.3, replaced byFontFormat.setFontSettings(String,int,bool,bool,Color)
void
setFontSize(int fontSize)
Deprecated.As of version 8.3, replaced byFontFormat.setFontSize(float)
void
setForeground(System.Drawing.Color foreground)
Deprecated.As of version 8.3, replaced byFontFormat.setForeground(Color)
void
setHorizontalLines(bool value)
Sets the visible value of the horizontal data table grid lines.void
setItalic(bool isItalic)
Deprecated.As of version 8.3, replaced byFontFormat.setItalic(bool)
void
setLegendKey(bool value)
Sets the visibility of the data table legend key.void
setLineColor(System.Drawing.Color lineColor)
Deprecated.As of version 8.3, replaced byLineColorFormat.setLineColor(Color)
void
setLineStyle(int lineStyle)
Deprecated.As of version 8.3, replaced byLineStyleFormat.setDashType(System.String)
void
setLineWeight(int lineWeight)
Deprecated.As of version 8.3, replaced byLineStyleFormat.setWidth(float)
void
setOutlineLines(bool value)
Sets the visibility of the data table outline lines.void
setStrikethrough(bool isStrikethrough)
Deprecated.As of version 8.3, replaced byFontFormat.setStrikethrough(bool)
void
setSubscript(bool isSubscript)
Deprecated.As of version 8.3, replaced byFontFormat.setSubscript(bool)
void
setSuperscript(bool isSuperscript)
Deprecated.As of version 8.3, replaced byFontFormat.setSuperscript(bool)
void
setUnderlineStyle(int underlineStyle)
Deprecated.As of version 8.3, replaced byFontFormat.setUnderlineSettings(String,bool)
void
setVerticalLines(bool value)
Sets the visible value of the vertical data table grid lines.void
setVisible(bool value)
Sets the visible setting of the chart data table.Methods inherited from class EasyXLS.Drawings.FontDrawingObject
getFontFormat, setFontFormat
Methods inherited from class EasyXLS.Drawings.EffectDrawingObject
get3DFormat, set3DFormat
Methods inherited from class EasyXLS.Drawings.FillDrawingObject
getFillFormat, setFillFormat
Methods inherited from class EasyXLS.Drawings.LineDrawingObject
getLineColorFormat, getLineStyleFormat, getShadowFormat, setLineColorFormat, setLineStyleFormat, setShadowFormat
Methods inherited from class EasyXLS.Drawings.DrawingObject
getHeight, getHorizontalOffset, getRelativeHeight, getRelativeHorizontalOffset, getRelativeVerticalOffset, getRelativeWidth, getVerticalOffset, getWidth, setLeftUpperOffset, setRelativeLeftUpperOffset, setRelativeSize, setSize
Methods inherited from class System.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
ExcelDataTable
public ExcelDataTable()Defines an instance of the excel data table.
-
-
Method Details
-
IsVisible
public bool IsVisible()Returns the visible setting of the chart data table.- Returns:
- the visible setting of the chart data table
- See Also:
setVisible(bool)
-
setVisible
public void setVisible(bool value)Sets the visible setting of the chart data table.- Parameters:
value
- the new value of the data table visible setting- See Also:
IsVisible()
-
getLineStyle
public int getLineStyle()Deprecated.As of version 8.3, replaced byLineStyleFormat.getDashType()
Returns the line style of the chart data table. Possible values are available inChart
class.- Returns:
- the line style of the chart data table
- See Also:
setLineStyle(int)
-
setLineStyle
public void setLineStyle(int lineStyle)Deprecated.As of version 8.3, replaced byLineStyleFormat.setDashType(System.String)
Sets the style of the chart data table line. Possible values are available inChart
class.- Parameters:
lineStyle
- the new style of the chart data table line- See Also:
getLineStyle()
-
getLineColor
public System.Drawing.Color getLineColor()Deprecated.As of version 8.3, replaced byLineColorFormat.getLineColor()
Returns the line color of the chart data table.- Returns:
- the line color of the chart data table
- See Also:
setLineColor(Color)
-
setLineColor
public void setLineColor(System.Drawing.Color lineColor)Deprecated.As of version 8.3, replaced byLineColorFormat.setLineColor(Color)
Sets the color of the chart data table line.- Parameters:
lineColor
- the new color of the chart data table line- See Also:
getLineColor()
-
getLineWeight
public int getLineWeight()Deprecated.As of version 8.3, replaced byLineStyleFormat.getWidth()
Returns the line weight of the chart data table. Possible values are available inChart
class.- Returns:
- the line weight of the chart data table
- See Also:
setLineWeight(int)
-
setLineWeight
public void setLineWeight(int lineWeight)Deprecated.As of version 8.3, replaced byLineStyleFormat.setWidth(float)
Sets the line weight of the chart data table. Possible values are available inChart
class.- Parameters:
lineWeight
- the new value of the chart data table line weight- See Also:
getLineWeight()
-
HasLegendKey
public bool HasLegendKey()Returns a bool value representing the visibility of the data table legend key.- Returns:
- a bool value representing the visibility of the data table legend key
- See Also:
setLegendKey(bool)
-
setLegendKey
public void setLegendKey(bool value)Sets the visibility of the data table legend key.- Parameters:
value
- the new value of the data table legend key visibility- See Also:
HasLegendKey()
-
HasHorizontalLines
public bool HasHorizontalLines()Returns a value showing if the data table has horizontal lines between entries.- Returns:
- a value showing if the data table has horizontal lines between entries
- See Also:
setHorizontalLines(bool)
-
setHorizontalLines
public void setHorizontalLines(bool value)Sets the visible value of the horizontal data table grid lines.- Parameters:
value
- the new value of the horizontal data table grid lines visibility- See Also:
HasHorizontalLines()
-
HasVerticalLines
public bool HasVerticalLines()Returns a bool value representing the visibility of the vertical lines between values.- Returns:
- a bool value representing the visibility of the vertical lines between values.
- See Also:
setVerticalLines(bool)
-
setVerticalLines
public void setVerticalLines(bool value)Sets the visible value of the vertical data table grid lines.- Parameters:
value
- the new value of the data table grid lines visibility- See Also:
HasVerticalLines()
-
HasOutlineLines
public bool HasOutlineLines()Returns a bool value representing the visibility of the data table outline lines.- Returns:
- a bool value representing the visibility of the data table outline lines.
- See Also:
setOutlineLines(bool)
-
setOutlineLines
public void setOutlineLines(bool value)Sets the visibility of the data table outline lines.- Parameters:
value
- the new value of the data table outline lines visibility- See Also:
HasOutlineLines()
-
IsStrikethrough
public bool IsStrikethrough()Deprecated.As of version 8.3, replaced byFontFormat.IsStrikethrough()
Returns the strikethrough setting of the chart data table font.- Returns:
- the strikethrough setting of the chart data table font
- See Also:
setStrikethrough(bool)
-
setStrikethrough
public void setStrikethrough(bool isStrikethrough)Deprecated.As of version 8.3, replaced byFontFormat.setStrikethrough(bool)
Sets the strikethrough setting of the chart data table font.- Parameters:
isStrikethrough
- the new value of the data table font strikethrough setting- See Also:
IsStrikethrough()
-
IsSuperscript
public bool IsSuperscript()Deprecated.As of version 8.3, replaced byFontFormat.IsSuperscript()
Returns the superscript setting of the chart data table font.- Returns:
- the superscript setting of the chart data table font
- See Also:
setSuperscript(bool)
-
setSuperscript
public void setSuperscript(bool isSuperscript)Deprecated.As of version 8.3, replaced byFontFormat.setSuperscript(bool)
Sets the superscript setting of the chart data table font.- Parameters:
isSuperscript
- the new value of the chart data table font superscript setting- See Also:
IsSuperscript()
-
IsSubscript
public bool IsSubscript()Deprecated.As of version 8.3, replaced byFontFormat.IsSubscript()
Returns the subscript setting of the chart data table font.- Returns:
- the subscript setting of the chart data table font
- See Also:
setSubscript(bool)
-
setSubscript
public void setSubscript(bool isSubscript)Deprecated.As of version 8.3, replaced byFontFormat.setSubscript(bool)
Sets the subscript setting of the chart data table font.- Parameters:
isSubscript
- the new value of the chart data table font subscript setting- See Also:
IsSubscript()
-
getUnderlineStyle
public int getUnderlineStyle()Deprecated.As of version 8.3, replaced byFontFormat.getUnderlineStyle()
Returns the underline style of the chart data table text. Possible values are available inFontSettings
class.- Returns:
- the underline style of the chart data table text
- See Also:
setUnderlineStyle(int)
-
setUnderlineStyle
public void setUnderlineStyle(int underlineStyle)Deprecated.As of version 8.3, replaced byFontFormat.setUnderlineSettings(String,bool)
Sets the underline style of the chart data table text. Possible values are available inFontSettings
class.- Parameters:
underlineStyle
- the new value of the data table text underline style- See Also:
getUnderlineStyle()
-
getFont
public System.String getFont()Deprecated.As of version 8.3, replaced byFontFormat.getFont()
Returns the font name used in the chart data table.- Returns:
- the font name used in the chart data table
- See Also:
setFont(System.String)
-
setFont
public void setFont(System.String fontName)Deprecated.As of version 8.3, replaced byFontFormat.setFont(System.String)
Sets the chart data table font name.- Parameters:
fontName
- the new name of the chart data table font- See Also:
getFont()
-
getFontSize
public int getFontSize()Deprecated.As of version 8.3, replaced byFontFormat.getFontSize()
Returns the size of the font used in the chart data table.- Returns:
- the size of the font used in the chart data table
- See Also:
setFontSize(int)
-
setFontSize
public void setFontSize(int fontSize)Deprecated.As of version 8.3, replaced byFontFormat.setFontSize(float)
Sets the size of the chart data table font.- Parameters:
fontSize
- the new size of the chart data table font- See Also:
getFontSize()
-
IsBold
public bool IsBold()Deprecated.As of version 8.3, replaced byFontFormat.IsBold()
Returns the bold setting of the chart data table font.- Returns:
- the bold setting of the chart data table font
- See Also:
setBold(bool)
-
setBold
public void setBold(bool isBold)Deprecated.As of version 8.3, replaced byFontFormat.setBold(bool)
Sets the bold setting of the chart axis data table.- Parameters:
isBold
- - the new bold setting of the chart axis data table- See Also:
IsBold()
-
IsItalic
public bool IsItalic()Deprecated.As of version 8.3, replaced byFontFormat.IsItalic()
Returns the italic setting of the chart data table font.- Returns:
- the italic setting of the chart data table font
- See Also:
setItalic(bool)
-
setItalic
public void setItalic(bool isItalic)Deprecated.As of version 8.3, replaced byFontFormat.setItalic(bool)
Sets the italic setting of the chart data table font.- Parameters:
isItalic
- the new italic setting of the chart data table 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 byFontFormat.setFontSettings(String,int,bool,bool,Color)
Sets the font settings.- Parameters:
fontName
- the name of the fontfontSize
- the size of the fontisBold
- the bold option of the fontisItalic
- the italic option of the fontforeground
- the foreground color
-
getForeground
public System.Drawing.Color getForeground()Deprecated.As of version 8.3, replaced byFontFormat.getForeground()
Returns the text color of the chart data table.- Returns:
- the text color of the chart data table
- See Also:
setForeground(Color)
-
setForeground
public void setForeground(System.Drawing.Color foreground)Deprecated.As of version 8.3, replaced byFontFormat.setForeground(Color)
Sets the font color of the chart data table.- Parameters:
foreground
- the new font color of the chart data table- See Also:
getForeground()
-
Clone
Creates and returns a copy of this object.- Returns:
- a clone of this instance.
-
FontFormat.getFont()