Package com.stimulsoft.report.chart.view.seriesLabels

Class StiSeriesLabels

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.base.services.StiService

com.stimulsoft.report.chart.view.seriesLabels.StiSeriesLabels

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiSerializeToCodeAsClass, IStiSeriesLabels, IStiTextFormat, Cloneable

Direct Known Subclasses:

StiAxisSeriesLabels, StiFunnelSeriesLabels, StiNoneLabels, StiPieSeriesLabels

public abstract class StiSeriesLabels
extends StiService
implements IStiSerializeToCodeAsClass, IStiSeriesLabels, IStiTextFormat

Field Summary

Fields inherited from class com.stimulsoft.base.services.StiService

properties

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor	Description
StiSeriesLabels()

Method Summary

Modifier and Type	Method	Description
Object	clone()	Creates a new object that is a copy of the current instance.
final boolean	getAllowApplyStyle()	Gets or sets value which indicates that chart style will be used.
float	getAngle()	Gets or sets angle of text rotation.
boolean	getAntialiasing()	Gets or sets value which control antialiasing drawing mode of series labels.
final StiAxisSeriesLabelsCoreXF	getAxisCore()
StiColor	getBorderColor()	Gets or sets border color of series labels.
StiBrush	getBrush()	Gets or sets brush which will be used to fill area of series labels.
final IStiChart	getChart()
final StiChartConditionsCollection	getConditions()	Gets or sets collection of conditions which can be used to change behavior of series labels.
final StiSeriesLabelsCoreXF	getCore()
boolean	getDrawBorder()	Gets or sets value which incates that border will be drawn or not.
StiFont	getFont()	Gets or sets font which will be used to draw series labels.
final String	getFormat()	Gets or sets format string which used for formating series values (if applicable).
StiFormatService	getFormatService()
StiColor	getLabelColor()	Gets or sets foreground color of series labels.
StiSeriesLabelsValueType	getLegendValueType()	Gets or sets which type of information will be shown in legend.
StiMarkerAlignment	getMarkerAlignment()	Gets or sets marker alignment related to label text.
final StiSize	getMarkerSize()	Gets or sets marker size.
final boolean	getMarkerVisible()	Gets or sets vibility of marker.
final StiPieSeriesLabelsCoreXF	getPieCore()
final boolean	getPreventIntersection()	Gets or sets value which indicates that whether it is necessary to avoid intersections between border of series labels and border of series.
final String	getServiceCategory()	Gets a service category.
String	getServiceName()	Gets a service name.
final Class	getServiceType()	Gets a service type.
final boolean	getShowNulls()	Gets or sets value which indicates that series labels will be shown or not if value equal to null.
final boolean	getShowOnZeroValues()	Deprecated.
final boolean	getShowZeros()	Gets or sets value which indicates that series labels will be shown or not if value equal to zero.
final int	getStep()	Gets or sets value which indicates with what steps do labels be shown.
final String	getTextAfter()	Gets or sets text which will be shown after label text.
final String	getTextBefore()	Gets or sets text which will be shown before label text.
StiFormatService	getTextFormat()	Gets or sets the format of the text.
boolean	getUseSeriesColor()	Gets or sets value which indicates that series colors must be used.
StiSeriesLabelsValueType	getValueType()	Gets or sets which type of information will be shown in series labels.
String	getValueTypeSeparator()	Gets or sets string which contain separator for value information (if applicated).
boolean	getVisible()	Gets or sets visiblity of series labels.
int	getWidth()	Fixed width of axis labels
boolean	isWordWrap()
void	LoadFromJsonObject(JSONObject jObject)
static IStiSeriesLabels	LoadFromJsonObjectInternal(JSONObject jObject, StiChart chart)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
final void	setAllowApplyStyle(boolean value)
void	setAngle(float value)
void	setAntialiasing(boolean value)
void	setBorderColor(StiColor value)
void	setBrush(StiBrush value)
final void	setChart(IStiChart value)
final void	setConditions(StiChartConditionsCollection value)
final void	setCore(StiSeriesLabelsCoreXF value)
void	setDrawBorder(boolean value)
void	setFont(StiFont value)
final void	setFormat(String value)
void	setFormatService(StiFormatService formatService)
void	setLabelColor(StiColor value)
void	setLegendValueType(StiSeriesLabelsValueType value)
void	setMarkerAlignment(StiMarkerAlignment value)
final void	setMarkerSize(StiSize value)
final void	setMarkerVisible(boolean value)
final void	setPreventIntersection(boolean value)
final void	setShowNulls(boolean value)
final void	setShowOnZeroValues(boolean value)	Deprecated.
final void	setShowZeros(boolean value)
final void	setStep(int value)
final void	setTextAfter(String value)
final void	setTextBefore(String value)
void	setTextFormat(StiFormatService value)
void	setUseSeriesColor(boolean value)
void	setValueType(StiSeriesLabelsValueType value)
void	setValueTypeSeparator(String value)
void	setVisible(boolean value)
void	setWidth(int width)	Fixed width of axis labels
void	setWordWrap(boolean wordWrap)
String	toString()

Methods inherited from class com.stimulsoft.base.services.StiService

getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, packService, properties, setProperties, setServiceEnabled

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

getReference, setReference

Constructor Details

StiSeriesLabels

public StiSeriesLabels()

Method Details

clone

public Object clone()

Creates a new object that is a copy of the current instance.

Specified by:

clone in interface IStiSeriesLabels

Overrides:

clone in class StiService

Returns:

A new object that is a copy of this instance.

getServiceName

public String getServiceName()

Gets a service name.

Overrides:

getServiceName in class StiService

getServiceCategory

public final String getServiceCategory()

Gets a service category.

Overrides:

getServiceCategory in class StiService

getServiceType

public final Class getServiceType()

Gets a service type.

Specified by:

getServiceType in class StiService

getPreventIntersection

public final boolean getPreventIntersection()

Gets or sets value which indicates that whether it is necessary to avoid intersections between border of series labels and border of series.

Specified by:

getPreventIntersection in interface IStiSeriesLabels

setPreventIntersection

public final void setPreventIntersection(boolean value)

Specified by:

setPreventIntersection in interface IStiSeriesLabels

getCore

public final StiSeriesLabelsCoreXF getCore()

Specified by:

getCore in interface IStiSeriesLabels

setCore

public final void setCore(StiSeriesLabelsCoreXF value)

Specified by:

setCore in interface IStiSeriesLabels

getAxisCore

public final StiAxisSeriesLabelsCoreXF getAxisCore()

getPieCore

public final StiPieSeriesLabelsCoreXF getPieCore()

getAllowApplyStyle

public final boolean getAllowApplyStyle()

Gets or sets value which indicates that chart style will be used.

Specified by:

getAllowApplyStyle in interface IStiSeriesLabels

setAllowApplyStyle

public final void setAllowApplyStyle(boolean value)

Specified by:

setAllowApplyStyle in interface IStiSeriesLabels

getFormatService

public StiFormatService getFormatService()

Specified by:

getFormatService in interface IStiSeriesLabels

setFormatService

public void setFormatService(StiFormatService formatService)

Specified by:

setFormatService in interface IStiSeriesLabels

getTextFormat

public StiFormatService getTextFormat()

Description copied from interface: IStiTextFormat

Gets or sets the format of the text.

Specified by:

getTextFormat in interface IStiTextFormat

setTextFormat

public void setTextFormat(StiFormatService value)

Specified by:

setTextFormat in interface IStiTextFormat

getConditions

public final StiChartConditionsCollection getConditions()

Gets or sets collection of conditions which can be used to change behavior of series labels.

setConditions

public final void setConditions(StiChartConditionsCollection value)

getShowOnZeroValues

@Deprecated
public final boolean getShowOnZeroValues()

Deprecated.

setShowOnZeroValues

@Deprecated
public final void setShowOnZeroValues(boolean value)

Deprecated.

getShowZeros

public final boolean getShowZeros()

Gets or sets value which indicates that series labels will be shown or not if value equal to zero.

Specified by:

getShowZeros in interface IStiSeriesLabels

setShowZeros

public final void setShowZeros(boolean value)

Specified by:

setShowZeros in interface IStiSeriesLabels

getShowNulls

public final boolean getShowNulls()

Gets or sets value which indicates that series labels will be shown or not if value equal to null.

Specified by:

getShowNulls in interface IStiSeriesLabels

setShowNulls

public final void setShowNulls(boolean value)

Specified by:

setShowNulls in interface IStiSeriesLabels

getMarkerVisible

public final boolean getMarkerVisible()

Gets or sets vibility of marker.

Specified by:

getMarkerVisible in interface IStiSeriesLabels

setMarkerVisible

public final void setMarkerVisible(boolean value)

Specified by:

setMarkerVisible in interface IStiSeriesLabels

getMarkerSize

public final StiSize getMarkerSize()

Gets or sets marker size.

Specified by:

getMarkerSize in interface IStiSeriesLabels

setMarkerSize

public final void setMarkerSize(StiSize value)

Specified by:

setMarkerSize in interface IStiSeriesLabels

getMarkerAlignment

public StiMarkerAlignment getMarkerAlignment()

Gets or sets marker alignment related to label text.

Specified by:

getMarkerAlignment in interface IStiSeriesLabels

setMarkerAlignment

public void setMarkerAlignment(StiMarkerAlignment value)

Specified by:

setMarkerAlignment in interface IStiSeriesLabels

getStep

public final int getStep()

Gets or sets value which indicates with what steps do labels be shown.

Specified by:

getStep in interface IStiSeriesLabels

setStep

public final void setStep(int value)

Specified by:

setStep in interface IStiSeriesLabels

getValueType

public StiSeriesLabelsValueType getValueType()

Gets or sets which type of information will be shown in series labels.

Specified by:

getValueType in interface IStiSeriesLabels

setValueType

public void setValueType(StiSeriesLabelsValueType value)

Specified by:

setValueType in interface IStiSeriesLabels

getValueTypeSeparator

public String getValueTypeSeparator()

Gets or sets string which contain separator for value information (if applicated).

Specified by:

getValueTypeSeparator in interface IStiSeriesLabels

setValueTypeSeparator

public void setValueTypeSeparator(String value)

Specified by:

setValueTypeSeparator in interface IStiSeriesLabels

getLegendValueType

public StiSeriesLabelsValueType getLegendValueType()

Gets or sets which type of information will be shown in legend.

Specified by:

getLegendValueType in interface IStiSeriesLabels

setLegendValueType

public void setLegendValueType(StiSeriesLabelsValueType value)

Specified by:

setLegendValueType in interface IStiSeriesLabels

getTextBefore

public final String getTextBefore()

Gets or sets text which will be shown before label text.

Specified by:

getTextBefore in interface IStiSeriesLabels

setTextBefore

public final void setTextBefore(String value)

Specified by:

setTextBefore in interface IStiSeriesLabels

getTextAfter

public final String getTextAfter()

Gets or sets text which will be shown after label text.

Specified by:

getTextAfter in interface IStiSeriesLabels

setTextAfter

public final void setTextAfter(String value)

Specified by:

setTextAfter in interface IStiSeriesLabels

getAngle

public float getAngle()

Gets or sets angle of text rotation.

Specified by:

getAngle in interface IStiSeriesLabels

setAngle

public void setAngle(float value)

Specified by:

setAngle in interface IStiSeriesLabels

getFormat

public final String getFormat()

Gets or sets format string which used for formating series values (if applicable).

Specified by:

getFormat in interface IStiSeriesLabels

setFormat

public final void setFormat(String value)

Specified by:

setFormat in interface IStiSeriesLabels

getAntialiasing

public boolean getAntialiasing()

Gets or sets value which control antialiasing drawing mode of series labels.

Specified by:

getAntialiasing in interface IStiSeriesLabels

setAntialiasing

public void setAntialiasing(boolean value)

Specified by:

setAntialiasing in interface IStiSeriesLabels

getVisible

public boolean getVisible()

Gets or sets visiblity of series labels.

Specified by:

getVisible in interface IStiSeriesLabels

setVisible

public void setVisible(boolean value)

Specified by:

setVisible in interface IStiSeriesLabels

getDrawBorder

public boolean getDrawBorder()

Gets or sets value which incates that border will be drawn or not.

Specified by:

getDrawBorder in interface IStiSeriesLabels

setDrawBorder

public void setDrawBorder(boolean value)

Specified by:

setDrawBorder in interface IStiSeriesLabels

getUseSeriesColor

public boolean getUseSeriesColor()

Gets or sets value which indicates that series colors must be used.

Specified by:

getUseSeriesColor in interface IStiSeriesLabels

setUseSeriesColor

public void setUseSeriesColor(boolean value)

Specified by:

setUseSeriesColor in interface IStiSeriesLabels

getLabelColor

public StiColor getLabelColor()

Gets or sets foreground color of series labels.

Specified by:

getLabelColor in interface IStiSeriesLabels

setLabelColor

public void setLabelColor(StiColor value)

Specified by:

setLabelColor in interface IStiSeriesLabels

getBorderColor

public StiColor getBorderColor()

Gets or sets border color of series labels.

Specified by:

getBorderColor in interface IStiSeriesLabels

setBorderColor

public void setBorderColor(StiColor value)

Specified by:

setBorderColor in interface IStiSeriesLabels

getBrush

public StiBrush getBrush()

Gets or sets brush which will be used to fill area of series labels.

Specified by:

getBrush in interface IStiSeriesLabels

setBrush

public void setBrush(StiBrush value)

Specified by:

setBrush in interface IStiSeriesLabels

getFont

public StiFont getFont()

Gets or sets font which will be used to draw series labels.

Specified by:

getFont in interface IStiSeriesLabels

setFont

public void setFont(StiFont value)

Specified by:

setFont in interface IStiSeriesLabels

getChart

public final IStiChart getChart()

Specified by:

getChart in interface IStiSeriesLabels

setChart

public final void setChart(IStiChart value)

Specified by:

setChart in interface IStiSeriesLabels

isWordWrap

public boolean isWordWrap()

Specified by:

isWordWrap in interface IStiSeriesLabels

Returns:

the wordWrap

setWordWrap

public void setWordWrap(boolean wordWrap)

Specified by:

setWordWrap in interface IStiSeriesLabels

Parameters:

wordWrap - the wordWrap to set

getWidth

public int getWidth()

Fixed width of axis labels

Specified by:

getWidth in interface IStiSeriesLabels

Returns:

the width

setWidth

public void setWidth(int width)

Fixed width of axis labels

Parameters:

width - the width to set

toString

public String toString()

Overrides:

toString in class Object

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Throws:

JSONException

LoadFromJsonObjectInternal

public static IStiSeriesLabels LoadFromJsonObjectInternal(JSONObject jObject,
 StiChart chart)
                                                   throws JSONException

Throws:

JSONException