public interface IAxis extends IFormattedTextContainer
Encapsulates the object that represents a chart's axis.
Modifier and Type | Method and Description |
---|---|
double |
getActualMajorUnit()
Specifies actual major unit of the axis.
|
int |
getActualMajorUnitScale()
Specifies actual major unit scale of the axis.
|
double |
getActualMaxValue()
Specifies actual maximum value on the axis.
|
double |
getActualMinorUnit()
Specifies actual minor unit of the axis.
|
int |
getActualMinorUnitScale()
Specifies actual minor unit scale of the axis.
|
double |
getActualMinValue()
Specifies actual minimum value on the axis.
|
int |
getAggregationType()
Represents aggregation type of category axis (binning).
|
boolean |
getAxisBetweenCategories()
Represents if the value axis crosses the category axis between categories.
|
int |
getBaseUnitScale()
Specifies the smallest time unit that is represented on the date axis.
|
double |
getBinWidth()
Specifies bin width when AggregationType property value setted to AxisAggregationType.ByBinWidth.
|
int |
getCategoryAxisType()
Specifies the type of the category axis.
|
float |
getCrossAt()
Represents the point on the axis where the perpendicular axis crosses it.
|
int |
getCrossType()
Represents the CrossType on the specified axis where the other axis crosses.
|
int |
getDisplayUnit()
Specifies the scaling value of the display units for the value axis.
|
IAxisFormat |
getFormat()
Represents format of axis.
|
int |
getLabelOffset()
Specifies the distance of labels from the axis.
|
double |
getLogBase()
Represents the logarithmic base.
|
IChartLinesFormat |
getMajorGridLinesFormat()
Represents major gridlines format on a chart axis.
|
int |
getMajorTickMark()
Represents the type of major tick mark for the specified axis.
|
double |
getMajorUnit()
Represents the major units for the date or value axis.
|
int |
getMajorUnitScale()
Represents the major unit scale for the date axis.
|
double |
getMaxValue()
Represents the maximum value on the value axis.
|
IChartLinesFormat |
getMinorGridLinesFormat()
Represents minor gridlines format on a chart axis.
|
int |
getMinorTickMark()
Represents the type of minor tick mark for the specified axis.
|
double |
getMinorUnit()
Represents the minor units for the date or value axis.
|
int |
getMinorUnitScale()
Represents the major unit scale for the date axis.
|
double |
getMinValue()
Represents the minimum value on the value axis.
|
java.lang.String |
getNumberFormat()
Represents the format string for the Axis Labels.
|
long |
getNumberOfBins()
Specifies number of bins when AggregationType property value setted to AxisAggregationType.ByNumberOfBins.
|
double |
getOverflowBin()
Specifies overflow bin custom value.
|
int |
getPosition()
Represents position of axis.
|
boolean |
getShowMajorGridLines()
Represents if the major gridlines showed.
|
boolean |
getShowMinorGridLines()
Represents if the minor gridlines showed.
|
int |
getTickLabelPosition()
Represents the position of tick-mark labels on the specified axis.
|
float |
getTickLabelRotationAngle()
Represents the rotation angle of tick labels
Read/write
float . |
long |
getTickLabelSpacing()
Specifies how many tick labels to skip between label that is drawn.
|
long |
getTickMarksSpacing()
Specifies how many tick marks shall be skipped before the next one shall be
drawn.
|
IChartTitle |
getTitle()
Gets the axis' title.
|
double |
getUnderflowBin()
Specifies underflow bin custom value.
|
boolean |
hasTitle()
Determines whether a axis has a visible title.
|
boolean |
isAutomaticMajorUnit()
Indicates whether the major unit of the axis is automatically assigned.
|
boolean |
isAutomaticMaxValue()
Indicates whether the max value is automatically assigned.
|
boolean |
isAutomaticMinorUnit()
Indicates whether the minor unit of the axis is automatically assigned.
|
boolean |
isAutomaticMinValue()
Indicates whether the min value is automatically assigned.
|
boolean |
isAutomaticOverflowBin()
Specifies automatic overflow bin value.
|
boolean |
isAutomaticTickLabelSpacing()
Specifies automatic tick label spacing value.
|
boolean |
isAutomaticTickMarksSpacing()
Specifies automatic tick marks spacing value.
|
boolean |
isAutomaticUnderflowBin()
Specifies automatic underflow bin value.
|
boolean |
isLogarithmic()
Represents if the value axis scale type is logarithmic or not.
|
boolean |
isNumberFormatLinkedToSource()
Indicates whether the format is linked source data.
|
boolean |
isOverflowBin()
Specifies if overflow bin applied.
|
boolean |
isPlotOrderReversed()
Represents if MS PowerPoint plots data points from last to first.
|
boolean |
isUnderflowBin()
Specifies if underflow bin applied.
|
boolean |
isVisible()
Represents if the axis is visible.
|
void |
setAggregationType(int value)
Represents aggregation type of category axis (binning).
|
void |
setAutomaticMajorUnit(boolean value)
Indicates whether the major unit of the axis is automatically assigned.
|
void |
setAutomaticMaxValue(boolean value)
Indicates whether the max value is automatically assigned.
|
void |
setAutomaticMinorUnit(boolean value)
Indicates whether the minor unit of the axis is automatically assigned.
|
void |
setAutomaticMinValue(boolean value)
Indicates whether the min value is automatically assigned.
|
void |
setAutomaticOverflowBin(boolean value)
Specifies automatic overflow bin value.
|
void |
setAutomaticTickLabelSpacing(boolean value)
Specifies automatic tick label spacing value.
|
void |
setAutomaticTickMarksSpacing(boolean value)
Specifies automatic tick marks spacing value.
|
void |
setAutomaticUnderflowBin(boolean value)
Specifies automatic underflow bin value.
|
void |
setAxisBetweenCategories(boolean value)
Represents if the value axis crosses the category axis between categories.
|
void |
setBaseUnitScale(int value)
Specifies the smallest time unit that is represented on the date axis.
|
void |
setBinWidth(double value)
Specifies bin width when AggregationType property value setted to AxisAggregationType.ByBinWidth.
|
void |
setCategoryAxisType(int value)
Specifies the type of the category axis.
|
void |
setCategoryAxisTypeAutomatically()
Sets IAxis.CategoryAxisType property with a value that is automatically determined based on axis data.
|
void |
setCrossAt(float value)
Represents the point on the axis where the perpendicular axis crosses it.
|
void |
setCrossType(int value)
Represents the CrossType on the specified axis where the other axis crosses.
|
void |
setDisplayUnit(int value)
Specifies the scaling value of the display units for the value axis.
|
void |
setLabelOffset(int value)
Specifies the distance of labels from the axis.
|
void |
setLogarithmic(boolean value)
Represents if the value axis scale type is logarithmic or not.
|
void |
setLogBase(double value)
Represents the logarithmic base.
|
void |
setMajorTickMark(int value)
Represents the type of major tick mark for the specified axis.
|
void |
setMajorUnit(double value)
Represents the major units for the date or value axis.
|
void |
setMajorUnitScale(int value)
Represents the major unit scale for the date axis.
|
void |
setMaxValue(double value)
Represents the maximum value on the value axis.
|
void |
setMinorTickMark(int value)
Represents the type of minor tick mark for the specified axis.
|
void |
setMinorUnit(double value)
Represents the minor units for the date or value axis.
|
void |
setMinorUnitScale(int value)
Represents the major unit scale for the date axis.
|
void |
setMinValue(double value)
Represents the minimum value on the value axis.
|
void |
setNumberFormat(java.lang.String value)
Represents the format string for the Axis Labels.
|
void |
setNumberFormatLinkedToSource(boolean value)
Indicates whether the format is linked source data.
|
void |
setNumberOfBins(long value)
Specifies number of bins when AggregationType property value setted to AxisAggregationType.ByNumberOfBins.
|
void |
setOverflowBin(boolean value)
Specifies if overflow bin applied.
|
void |
setOverflowBin(double value)
Specifies overflow bin custom value.
|
void |
setPlotOrderReversed(boolean value)
Represents if MS PowerPoint plots data points from last to first.
|
void |
setPosition(int value)
Represents position of axis.
|
void |
setTickLabelPosition(int value)
Represents the position of tick-mark labels on the specified axis.
|
void |
setTickLabelRotationAngle(float value)
Represents the rotation angle of tick labels
Read/write
float . |
void |
setTickLabelSpacing(long value)
Specifies how many tick labels to skip between label that is drawn.
|
void |
setTickMarksSpacing(long value)
Specifies how many tick marks shall be skipped before the next one shall be
drawn.
|
void |
setTitle(boolean value)
Determines whether a axis has a visible title.
|
void |
setUnderflowBin(boolean value)
Specifies if underflow bin applied.
|
void |
setUnderflowBin(double value)
Specifies underflow bin custom value.
|
void |
setVisible(boolean value)
Represents if the axis is visible.
|
getTextFormat
getChart
getSlide
getPresentation
boolean getAxisBetweenCategories()
Represents if the value axis crosses the category axis between categories.
This property applies only to category axes, and it doesn't apply to 3-D charts.
Read/write boolean
.
void setAxisBetweenCategories(boolean value)
Represents if the value axis crosses the category axis between categories.
This property applies only to category axes, and it doesn't apply to 3-D charts.
Read/write boolean
.
float getCrossAt()
Represents the point on the axis where the perpendicular axis crosses it.
Read/write float
.
void setCrossAt(float value)
Represents the point on the axis where the perpendicular axis crosses it.
Read/write float
.
int getDisplayUnit()
Specifies the scaling value of the display units for the value axis.
Read/write DisplayUnitType
.
void setDisplayUnit(int value)
Specifies the scaling value of the display units for the value axis.
Read/write DisplayUnitType
.
double getActualMaxValue()
Specifies actual maximum value on the axis. Call method IChart.ValidateChartLayout() previously to get actual value.
double getActualMinValue()
Specifies actual minimum value on the axis. Call method IChart.ValidateChartLayout() previously to get actual value.
double getActualMajorUnit()
Specifies actual major unit of the axis. Call method IChart.ValidateChartLayout() previously to get actual value.
double getActualMinorUnit()
Specifies actual minor unit of the axis. Call method IChart.ValidateChartLayout() previously to get actual value.
int getActualMajorUnitScale()
Specifies actual major unit scale of the axis. Call method IChart.ValidateChartLayout() previously to get actual value.
int getActualMinorUnitScale()
Specifies actual minor unit scale of the axis. Call method IChart.ValidateChartLayout() previously to get actual value.
boolean isAutomaticMaxValue()
Indicates whether the max value is automatically assigned.
Read/write boolean
.
void setAutomaticMaxValue(boolean value)
Indicates whether the max value is automatically assigned.
Read/write boolean
.
double getMaxValue()
Represents the maximum value on the value axis.
Read/write double
.
void setMaxValue(double value)
Represents the maximum value on the value axis.
Read/write double
.
double getMinorUnit()
Represents the minor units for the date or value axis.
Read/write double
.
void setMinorUnit(double value)
Represents the minor units for the date or value axis.
Read/write double
.
boolean isAutomaticMinorUnit()
Indicates whether the minor unit of the axis is automatically assigned.
Read/write boolean
.
void setAutomaticMinorUnit(boolean value)
Indicates whether the minor unit of the axis is automatically assigned.
Read/write boolean
.
double getMajorUnit()
Represents the major units for the date or value axis.
Read/write double
.
void setMajorUnit(double value)
Represents the major units for the date or value axis.
Read/write double
.
boolean isAutomaticMajorUnit()
Indicates whether the major unit of the axis is automatically assigned.
Read/write boolean
.
void setAutomaticMajorUnit(boolean value)
Indicates whether the major unit of the axis is automatically assigned.
Read/write boolean
.
boolean isAutomaticMinValue()
Indicates whether the min value is automatically assigned.
Read/write boolean
.
void setAutomaticMinValue(boolean value)
Indicates whether the min value is automatically assigned.
Read/write boolean
.
double getMinValue()
Represents the minimum value on the value axis.
Read/write double
.
void setMinValue(double value)
Represents the minimum value on the value axis.
Read/write double
.
boolean isLogarithmic()
Represents if the value axis scale type is logarithmic or not.
Read/write boolean
.
void setLogarithmic(boolean value)
Represents if the value axis scale type is logarithmic or not.
Read/write boolean
.
double getLogBase()
Represents the logarithmic base. Default value is 10.
Read/write double
.
void setLogBase(double value)
Represents the logarithmic base. Default value is 10.
Read/write double
.
boolean isPlotOrderReversed()
Represents if MS PowerPoint plots data points from last to first.
Read/write boolean
.
void setPlotOrderReversed(boolean value)
Represents if MS PowerPoint plots data points from last to first.
Read/write boolean
.
boolean isVisible()
Represents if the axis is visible.
Read/write boolean
.
void setVisible(boolean value)
Represents if the axis is visible.
Read/write boolean
.
int getMajorTickMark()
Represents the type of major tick mark for the specified axis.
Read/write TickMarkType
.
void setMajorTickMark(int value)
Represents the type of major tick mark for the specified axis.
Read/write TickMarkType
.
int getMinorTickMark()
Represents the type of minor tick mark for the specified axis.
Read/write TickMarkType
.
void setMinorTickMark(int value)
Represents the type of minor tick mark for the specified axis.
Read/write TickMarkType
.
int getTickLabelPosition()
Represents the position of tick-mark labels on the specified axis.
Read/write TickLabelPositionType
.
void setTickLabelPosition(int value)
Represents the position of tick-mark labels on the specified axis.
Read/write TickLabelPositionType
.
int getMajorUnitScale()
Represents the major unit scale for the date axis.
Read/write TimeUnitType
.
void setMajorUnitScale(int value)
Represents the major unit scale for the date axis.
Read/write TimeUnitType
.
int getMinorUnitScale()
Represents the major unit scale for the date axis.
Read/write TimeUnitType
.
void setMinorUnitScale(int value)
Represents the major unit scale for the date axis.
Read/write TimeUnitType
.
int getBaseUnitScale()
Specifies the smallest time unit that is represented on the date axis.
Read/write TimeUnitType
.
void setBaseUnitScale(int value)
Specifies the smallest time unit that is represented on the date axis.
Read/write TimeUnitType
.
IChartLinesFormat getMinorGridLinesFormat()
Represents minor gridlines format on a chart axis.
Read-only IChartLinesFormat
.
IChartLinesFormat getMajorGridLinesFormat()
Represents major gridlines format on a chart axis.
Read-only IChartLinesFormat
.
boolean getShowMinorGridLines()
Represents if the minor gridlines showed.
Read-only boolean
.
boolean getShowMajorGridLines()
Represents if the major gridlines showed.
Read-only boolean
.
IAxisFormat getFormat()
Represents format of axis.
Read-only IAxisFormat
.
IChartTitle getTitle()
Gets the axis' title.
Read-only IChartTitle
.
int getCrossType()
Represents the CrossType on the specified axis where the other axis crosses.
Read/write CrossesType
.
void setCrossType(int value)
Represents the CrossType on the specified axis where the other axis crosses.
Read/write CrossesType
.
int getPosition()
Represents position of axis.
Read/write AxisPositionType
.
void setPosition(int value)
Represents position of axis.
Read/write AxisPositionType
.
boolean hasTitle()
Determines whether a axis has a visible title.
Read/write boolean
.
void setTitle(boolean value)
Determines whether a axis has a visible title.
Read/write boolean
.
java.lang.String getNumberFormat()
Represents the format string for the Axis Labels.
Read/write String
.
void setNumberFormat(java.lang.String value)
Represents the format string for the Axis Labels.
Read/write String
.
boolean isNumberFormatLinkedToSource()
Indicates whether the format is linked source data.
Read/write boolean
.
void setNumberFormatLinkedToSource(boolean value)
Indicates whether the format is linked source data.
Read/write boolean
.
float getTickLabelRotationAngle()
Represents the rotation angle of tick labels
Read/write float
.
void setTickLabelRotationAngle(float value)
Represents the rotation angle of tick labels
Read/write float
.
long getTickLabelSpacing()
Specifies how many tick labels to skip between label that is drawn.
Read/write long
.
void setTickLabelSpacing(long value)
Specifies how many tick labels to skip between label that is drawn.
Read/write long
.
boolean isAutomaticTickLabelSpacing()
Specifies automatic tick label spacing value. If false: use TickLabelSpacing property.
Read/write boolean
.
void setAutomaticTickLabelSpacing(boolean value)
Specifies automatic tick label spacing value. If false: use TickLabelSpacing property.
Read/write boolean
.
long getTickMarksSpacing()
Specifies how many tick marks shall be skipped before the next one shall be
drawn. Applied to category or series axis.
Read/write int
.
void setTickMarksSpacing(long value)
Specifies how many tick marks shall be skipped before the next one shall be
drawn. Applied to category or series axis.
Read/write int
.
boolean isAutomaticTickMarksSpacing()
Specifies automatic tick marks spacing value. If false: use TickMarksSpacing property.
Read/write boolean
.
void setAutomaticTickMarksSpacing(boolean value)
Specifies automatic tick marks spacing value. If false: use TickMarksSpacing property.
Read/write boolean
.
int getLabelOffset()
Specifies the distance of labels from the axis. Applied to category or date axis. Value must be between 0% and 1000%.
Read/write int
.
void setLabelOffset(int value)
Specifies the distance of labels from the axis. Applied to category or date axis. Value must be between 0% and 1000%.
Read/write int
.
int getCategoryAxisType()
Specifies the type of the category axis.
Read/write CategoryAxisType
(getCategoryAxisType()
/setCategoryAxisType(int)
).
void setCategoryAxisType(int value)
Specifies the type of the category axis.
Read/write CategoryAxisType
(getCategoryAxisType()
/setCategoryAxisType(int)
).
void setCategoryAxisTypeAutomatically()
Sets IAxis.CategoryAxisType property with a value that is automatically determined based on axis data.
int getAggregationType()
Represents aggregation type of category axis (binning). Applied to category. Used with Histogram or HistogramPareto series only.
void setAggregationType(int value)
Represents aggregation type of category axis (binning). Applied to category. Used with Histogram or HistogramPareto series only.
double getBinWidth()
Specifies bin width when AggregationType property value setted to AxisAggregationType.ByBinWidth. Applied to category axes. Used with Histogram or HistogramPareto series only.
void setBinWidth(double value)
Specifies bin width when AggregationType property value setted to AxisAggregationType.ByBinWidth. Applied to category axes. Used with Histogram or HistogramPareto series only.
long getNumberOfBins()
Specifies number of bins when AggregationType property value setted to AxisAggregationType.ByNumberOfBins. Applied to category axes. Used with Histogram or HistogramPareto series only.
void setNumberOfBins(long value)
Specifies number of bins when AggregationType property value setted to AxisAggregationType.ByNumberOfBins. Applied to category axes. Used with Histogram or HistogramPareto series only.
boolean isOverflowBin()
Specifies if overflow bin applied. Use IsAutomaticOverflowBin and OverflowBin to adjust overflow bin value.
void setOverflowBin(boolean value)
Specifies if overflow bin applied. Use IsAutomaticOverflowBin and OverflowBin to adjust overflow bin value.
boolean isAutomaticOverflowBin()
Specifies automatic overflow bin value. If false: use OverflowBin property.
void setAutomaticOverflowBin(boolean value)
Specifies automatic overflow bin value. If false: use OverflowBin property.
double getOverflowBin()
Specifies overflow bin custom value. Applied when IsAutomaticOverflowBin property setted to false and IsOverflowBin property equals true.
void setOverflowBin(double value)
Specifies overflow bin custom value. Applied when IsAutomaticOverflowBin property setted to false and IsOverflowBin property equals true.
boolean isUnderflowBin()
Specifies if underflow bin applied. Use IsAutomaticUnderflowBin and UnderflowBin to adjust underflow bin value.
void setUnderflowBin(boolean value)
Specifies if underflow bin applied. Use IsAutomaticUnderflowBin and UnderflowBin to adjust underflow bin value.
boolean isAutomaticUnderflowBin()
Specifies automatic underflow bin value. If false: use UnderflowBin property.
void setAutomaticUnderflowBin(boolean value)
Specifies automatic underflow bin value. If false: use UnderflowBin property.
double getUnderflowBin()
Specifies underflow bin custom value. Applied when IsAutomaticUnderflowBin property setted to false and IsUnderflowBin property equals true.
void setUnderflowBin(double value)
Specifies underflow bin custom value. Applied when IsAutomaticUnderflowBin property setted to false and IsUnderflowBin property equals true.