|
ActiveXLS v6.4.0 API Documentation | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | CONST | CONSTR | METHOD | DETAIL: CONST | CONSTR | METHOD |
System.ObjectActiveXLS.Charts.ExcelAxis
This class stores the chart axis information like extends label, font name, font size, font bold, font italic, font underline style, font subscript, font superscript, font strikethrough, foreground color, style line, weight line, color line, type of major and minor tick mark, tick mark label, number format, rotation of the axis, visibility.
Constructor Summary | |
ExcelAxis()
Defines an instance of the excel axis. |
Method Summary | |
ExcelAxis |
Clone()
Creates and returns a copy of this object. |
double |
getCrossValue()
Returns the crosses value of the axis. |
System.String |
getFont()
Returns the chart axis font name. |
int |
getFontSize()
Returns the size of the chart axis font. |
System.Drawing.Color |
getForeground()
Returns the foreground color of the chart axis. |
long |
getHeight()
Internal use only |
System.String |
getLabel()
Returns the chart axis title. |
int |
getLabelFrequency()
Returns the number of categories between tick-mark labels. |
System.Drawing.Color |
getLineColor()
Returns the line color of the chart axis. |
int |
getLineStyle()
Returns the line style of the chart axis. |
int |
getLineWeight()
Returns the line weight of the chart axis. |
int |
getMajorTickMarkType()
Returns the type of the major tick mark. |
double |
getMajorUnit()
Returns the major unit of the value Y axis scale. |
double |
getMaximumValue()
Returns the maximun value of the value Y axis scale. |
double |
getMinimumValue()
Returns the minimum value of the value Y axis scale. |
int |
getMinorTickMarkType()
Returns the type of the minor tick mark. |
double |
getMinorUnit()
Returns the minor unit of the value Y axis scale. |
System.String |
getNumberFormat()
Returns the chart axis number format. |
int |
getRotationDegrees()
Returns the rotation degrees of the chart axis. |
int |
getTickMarkLabel()
Returns the label of the tick mark. |
int |
getTickMarksFrequency()
Returns the number of categories between tick marks. |
int |
getUnderlineStyle()
Returns the underline style of the chart axis. |
long |
getWidth()
Internal use only |
long |
getXPosition()
Internal use only |
long |
getYPosition()
Internal use only |
bool |
IsAutomaticCategoryAxisCrossesValue()
Returns the automatic option of the crosses value of the category X axis. |
bool |
IsAutomaticMajorUnit()
Returns the automatic option of the major unit of the value Y axis scale. |
bool |
IsAutomaticMaximumValue()
Returns the automatic option of the maximum value of the value Y axis scale. |
bool |
IsAutomaticMinimumValue()
Returns the automatic option of the minimum value of the value Y axis scale. |
bool |
IsAutomaticMinorUnit()
Returns the automatic option of the minor unit of the value Y axis scale. |
bool |
IsBold()
Returns the bold setting of the chart axis font. |
bool |
IsCrossedBetweenCategories()
Returns true if the value Y axis crosses between categories, false otherwise. |
bool |
IsItalic()
Returns the italic setting of the chart axis font. |
bool |
IsLogarithmicScale()
Returns true if the logarithmic scale is applied, false otherwise The property is applicable only to value Y axis. |
bool |
IsMaximumCross()
Returns true if the axis crosses at maximum value, false otherwise. |
bool |
IsNumberFormatLinked()
Returns true, if the number format of the labels is the same as the number format of the data source, false otherwise. |
bool |
IsReverseOrder()
Returns true if the values are in reverse order, false otherwise |
bool |
IsStrikethrough()
Returns the strikethrough setting of the chart axis font. |
bool |
IsSubscript()
Returns the subscript setting of the chart axis font. |
bool |
IsSuperscript()
Returns the superscript setting of the chart axis font. |
bool |
IsVisible()
Returns the visible setting of the chart axis. |
void |
setAutomaticCategoryAxisCrossesValue(bool isAutomatic)
Sets the automatic option of the crosses value of the category X axis. |
void |
setAutomaticMajorUnit(bool isAutomatic)
Sets the automatic option of the major unit of the value Y axis scale. |
void |
setAutomaticMaximumValue(bool isAutomatic)
Sets the automatic option of the maximum value of the value Y axis scale. |
void |
setAutomaticMinimumValue(bool isAutomatic)
Sets the automatic option of the minimum value of the value Y axis scale. |
void |
setAutomaticMinorUnit(bool isAutomatic)
Sets the automatic option of the minor unit of the value Y axis scale. |
void |
setBold(bool isBold)
Sets the bold setting of the chart axis font. |
void |
setCrossedBetweenCategories(bool between)
Sets the flag true if the axis crosses between categories, or false if it does not. |
void |
setCrossValue(double crossValue)
Sets the crosses value of the axis. |
void |
setFont(System.String fontName)
Sets the chart axis font name. |
void |
setFontSettings(System.String fontName,
int fontSize,
bool isBold,
bool isItalic,
System.Drawing.Color foreground)
Sets the font settings. |
void |
setFontSize(int fontSize)
Sets the size of the chart axis font. |
void |
setForeground(System.Drawing.Color foreground)
Sets the foreground color of the chart axis. |
void |
setItalic(bool isItalic)
Sets the italic setting of the chart axis font. |
void |
setLabel(System.String label)
Sets the chart axis title. |
void |
setLabelFrequency(int labelFrequency)
Sets the number of categories between tick-mark labels. |
void |
setLineColor(System.Drawing.Color lineColor)
Sets the line color of the chart axis. |
void |
setLineStyle(int lineStyle)
Sets the line style of the chart axis. |
void |
setLineWeight(int axisWeight)
Sets the line weight of the chart axis. |
void |
setLogarithmicScale(bool isLogarithmicScale)
Sets the logarithmic scale. |
void |
setMajorTickMarkType(int majorTickMarkType)
Sets the type of the major tick mark. |
void |
setMajorUnit(double majorUnit)
Sets the major unit of the value Y axis scale. |
void |
setMaximumCross(bool isMaximumCross)
Sets the flag true if the axis crosses at maximum value, or false if it does not. |
void |
setMaximumValue(double maximumValue)
Sets the maximum value of the value Y axis scale. |
void |
setMinimumValue(double minimumValue)
Sets the minimum value of the value Y axis scale. |
void |
setMinorTickMarkType(int minorTickMarkType)
Sets the type of the minor tick mark. |
void |
setMinorUnit(double minorUnit)
Sets the minor unit of the value Y axis scale. |
void |
setNumberFormat(System.String numberFormat)
Sets the chart axis number format. |
void |
setNumberFormatLinked(bool isNumberFormatLinked)
Sets if the number format of the chart axis is linked to the number format of the data source. |
void |
setPosition(long nXPosition,
long nYPosition,
long nWidth,
long nHeight)
Internal use only |
void |
setReverseOrder(bool isReverseOrder)
Sets the values in reverse order. |
void |
setRotationDegrees(int rotationDegrees)
Sets the rotation degrees of the chart axis. |
void |
setStrikethrough(bool isStrikethrough)
Sets the strikethrough setting of the chart axis font. |
void |
setSubscript(bool isSubscript)
Sets the subscript setting of the chart axis font. |
void |
setSuperscript(bool isSuperscript)
Sets the superscript setting of the chart axis font. |
void |
setTickMarkLabel(int tickMarkLabel)
Sets the label of the tick mark. |
void |
setTickMarksFrequency(int tickMarksFrequency)
Sets the number of categories between tick marks. |
void |
setUnderlineStyle(int underlineStyle)
Sets the underline style of the chart axis. |
void |
setVisible(bool isVisible)
Sets the visible setting of the chart axis. |
Constructor Detail |
public ExcelAxis()
Method Detail |
public void setLabel(System.String label)
label
- the chart axis titlegetLabel()
public System.String getLabel()
setLabel(System.String)
public void setVisible(bool isVisible)
isVisible
- the visible setting of the chart axisIsVisible()
public bool IsVisible()
setVisible(bool)
public int getLineStyle()
Chart
class.
setLineStyle(int)
public void setLineStyle(int lineStyle)
Chart
class.
lineStyle
- the line style of the chart axisgetLineStyle()
public int getLineWeight()
Chart
class.
setLineWeight(int)
public void setLineWeight(int axisWeight)
Chart
class.
axisWeight
- the line weight of the chart axisgetLineWeight()
public System.Drawing.Color getLineColor()
setLineColor(System.Drawing.Color)
public void setLineColor(System.Drawing.Color lineColor)
lineColor
- the line color of the chart axisgetLineColor()
public int getMajorTickMarkType()
Chart
class.
setMajorTickMarkType(int)
public void setMajorTickMarkType(int majorTickMarkType)
Chart
class.
majorTickMarkType
- the type of the major tick markgetMajorTickMarkType()
public int getMinorTickMarkType()
Chart
class.
setMinorTickMarkType(int)
public void setMinorTickMarkType(int minorTickMarkType)
Chart
class.
minorTickMarkType
- the type of the minor tick markgetMinorTickMarkType()
public int getTickMarkLabel()
Chart
class.
setTickMarkLabel(int)
public void setTickMarkLabel(int tickMarkLabel)
Chart
class.
tickMarkLabel
- the label of the tick markgetTickMarkLabel()
public System.Drawing.Color getForeground()
setForeground(System.Drawing.Color)
public void setForeground(System.Drawing.Color foreground)
foreground
- the foreground color of the chart axisgetForeground()
public bool IsStrikethrough()
setStrikethrough(bool)
public void setStrikethrough(bool isStrikethrough)
isStrikethrough
- the strikethrough setting of the chart axis fontIsStrikethrough()
public bool IsSuperscript()
setSuperscript(bool)
public void setSuperscript(bool isSuperscript)
isSuperscript
- the superscript setting of the chart axis fontIsSuperscript()
public bool IsSubscript()
setSubscript(bool)
public void setSubscript(bool isSubscript)
isSubscript
- the subscript setting of the chart axis fontIsSubscript()
public int getUnderlineStyle()
FontSettings
class.
setUnderlineStyle(int)
public void setUnderlineStyle(int underlineStyle)
FontSettings
class.
underlineStyle
- the underline style of the chart axisgetUnderlineStyle()
public int getFontSize()
setFontSize(int)
public void setFontSize(int fontSize)
fontSize
- the size of the chart axis fontgetFontSize()
public System.String getFont()
setFont(System.String)
public void setFont(System.String fontName)
fontName
- the chart axis font namegetFont()
public bool IsBold()
setBold(bool)
public void setBold(bool isBold)
isBold
- the bold style of the chart axis fontIsBold()
public bool IsItalic()
setItalic(bool)
public void setItalic(bool isItalic)
isItalic
- the italic style of the chart axis fontIsItalic()
public void setFontSettings(System.String fontName, int fontSize, bool isBold, bool isItalic, System.Drawing.Color foreground)
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 colorpublic System.String getNumberFormat()
Format
class.
setNumberFormat(System.String)
public void setNumberFormat(System.String numberFormat)
Format
class.
numberFormat
- the chart axis number formatgetNumberFormat()
public void setNumberFormatLinked(bool isNumberFormatLinked)
isNumberFormatLinked
- true, if the number format of the labels is the same as the number format of the data source, false otherwiseIsNumberFormatLinked()
public bool IsNumberFormatLinked()
setNumberFormatLinked(bool)
public int getRotationDegrees()
setRotationDegrees(int)
public void setRotationDegrees(int rotationDegrees)
rotationDegrees
- the rotation degrees of the chart axisgetRotationDegrees()
public void setPosition(long nXPosition, long nYPosition, long nWidth, long nHeight)
public long getXPosition()
public long getYPosition()
public long getWidth()
public long getHeight()
public double getMinimumValue()
setMinimumValue(double)
,
getMaximumValue()
,
setMaximumValue(double)
,
IsAutomaticMinimumValue()
,
setAutomaticMinimumValue(bool)
public void setMinimumValue(double minimumValue)
minimumValue
- the minimum value of the value Y axis scalegetMinimumValue()
,
getMaximumValue()
,
setMaximumValue(double)
,
IsAutomaticMinimumValue()
,
setAutomaticMinimumValue(bool)
public bool IsAutomaticMinimumValue()
setAutomaticMinimumValue(bool)
,
setMinimumValue(double)
,
getMinimumValue()
public void setAutomaticMinimumValue(bool isAutomatic)
isAutomatic
- the automatic optionIsAutomaticMinimumValue()
,
setMinimumValue(double)
,
getMinimumValue()
public double getMaximumValue()
setMaximumValue(double)
,
getMinimumValue()
,
setMinimumValue(double)
,
IsAutomaticMaximumValue()
,
setAutomaticMaximumValue(bool)
public void setMaximumValue(double maximumValue)
maximumValue
- the maximum value of the value Y axis scalegetMaximumValue()
,
getMinimumValue()
,
setMinimumValue(double)
,
IsAutomaticMaximumValue()
,
setAutomaticMaximumValue(bool)
public bool IsAutomaticMaximumValue()
setAutomaticMaximumValue(bool)
,
setMaximumValue(double)
,
getMaximumValue()
public void setAutomaticMaximumValue(bool isAutomatic)
isAutomatic
- the automatic optionIsAutomaticMaximumValue()
,
setMaximumValue(double)
,
getMaximumValue()
public double getMajorUnit()
setMajorUnit(double)
,
getMinorUnit()
,
setMinorUnit(double)
,
IsAutomaticMajorUnit()
,
setAutomaticMajorUnit(bool)
public void setMajorUnit(double majorUnit)
majorUnit
- the major unit of the value Y axis scalegetMajorUnit()
,
getMinorUnit()
,
setMinorUnit(double)
,
IsAutomaticMajorUnit()
,
setAutomaticMajorUnit(bool)
public bool IsAutomaticMajorUnit()
setAutomaticMajorUnit(bool)
,
setMajorUnit(double)
,
getMajorUnit()
public void setAutomaticMajorUnit(bool isAutomatic)
isAutomatic
- the automatic optionIsAutomaticMajorUnit()
,
setMajorUnit(double)
,
getMajorUnit()
public double getMinorUnit()
setMinorUnit(double)
,
getMajorUnit()
,
setMajorUnit(double)
,
IsAutomaticMinorUnit()
,
setAutomaticMinorUnit(bool)
public void setMinorUnit(double minorUnit)
minorUnit
- the minor unit of the value Y axis scalegetMinorUnit()
,
getMajorUnit()
,
setMajorUnit(double)
,
IsAutomaticMinorUnit()
,
setAutomaticMinorUnit(bool)
public bool IsAutomaticMinorUnit()
setAutomaticMinorUnit(bool)
,
setMinorUnit(double)
,
getMinorUnit()
public void setAutomaticMinorUnit(bool isAutomatic)
isAutomatic
- the automatic optionIsAutomaticMajorUnit()
,
setMinorUnit(double)
,
getMinorUnit()
public double getCrossValue()
setCrossValue(double)
,
IsAutomaticCategoryAxisCrossesValue()
,
setAutomaticCategoryAxisCrossesValue(bool)
public void setCrossValue(double crossValue)
crossValue
- the crosses value of the axisgetCrossValue()
,
IsAutomaticCategoryAxisCrossesValue()
,
setAutomaticCategoryAxisCrossesValue(bool)
public bool IsAutomaticCategoryAxisCrossesValue()
setAutomaticCategoryAxisCrossesValue(bool)
,
setCrossValue(double)
,
getCrossValue()
public void setAutomaticCategoryAxisCrossesValue(bool isAutomatic)
isAutomatic
- the automatic optionIsAutomaticCategoryAxisCrossesValue()
,
setCrossValue(double)
,
getCrossValue()
public bool IsLogarithmicScale()
setLogarithmicScale(bool)
public void setLogarithmicScale(bool isLogarithmicScale)
isLogarithmicScale
- the logarithmic scale optionIsLogarithmicScale()
public bool IsReverseOrder()
setReverseOrder(bool)
public void setReverseOrder(bool isReverseOrder)
isReverseOrder
- the reverse order optionIsReverseOrder()
public bool IsMaximumCross()
setMaximumCross(bool)
public void setMaximumCross(bool isMaximumCross)
isMaximumCross
- the maximum cross optionIsMaximumCross()
public int getLabelFrequency()
setLabelFrequency(int)
public void setLabelFrequency(int labelFrequency)
labelFrequency
- the number of categories between tick-mark labelsgetLabelFrequency()
public int getTickMarksFrequency()
setTickMarksFrequency(int)
public void setTickMarksFrequency(int tickMarksFrequency)
tickMarksFrequency
- the number of categories between tick marksgetTickMarksFrequency()
public bool IsCrossedBetweenCategories()
setCrossedBetweenCategories(bool)
public void setCrossedBetweenCategories(bool between)
between
- the between optionIsCrossedBetweenCategories()
public ExcelAxis Clone()
|
Copyright 2009 On Time Computing Solutions | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | CONST | CONSTR | METHOD | DETAIL: CONST | CONSTR | METHOD |