com.stimulsoft.report.components.simplecomponents
Class StiSparkline

java.lang.Object
  com.stimulsoft.base.serializing.StiSerializedObject
      com.stimulsoft.base.services.StiService
          com.stimulsoft.report.StiBase
              com.stimulsoft.report.components.StiComponent
                  com.stimulsoft.report.components.simplecomponents.StiSparkline

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, IStiBorder, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiDataRelation, IStiExportImage, IStiExportImageExtended, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiReportProperty, IStiInherited, IStiStateSaveRestore, java.lang.Cloneable

public class StiSparkline
extends StiComponent
implements IStiExportImageExtended, IStiDataRelation, IStiBorder, IStiBrush

Copyright Stimulsoft

Field Summary

StiBorder	border
StiBrush	brush
java.lang.String	dataRelationName
StiColor	negativeColor
StiColor	positiveColor
boolean	showFirstLastPoints
boolean	showHighLowPoints
StiSparklineType	type
double[]	values

Fields inherited from class com.stimulsoft.report.components.StiComponent

canGrow, canShrink, componentPlacement, conditions, currentPointer, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, top, width

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

StiSparkline()
Creates a new StiSparkline.

StiSparkline(StiRectangle rect)
Creates a new StiSparkline.

Method Summary

java.lang.Object	clone(boolean cloneProperties) Creates a new object that is a copy of the current instance.
StiComponent	createNew()
boolean	existDataRelation()
double[]	fetchValues()
StiBorder	getBorder() Gets or sets border of the component.
StiBrush	getBrush() Gets or sets a brush to fill a component.
boolean	getCanGrow() gets or sets a value which indicates that this object can grow.
boolean	getCanShrink() gets or sets value which indicates that this object can shrink.
StiDataRelation	getDataRelation() Get link that is used for master-detail reports rendering.
java.lang.String	getDataRelationName() Gets or sets relation name.
StiDataSource	getDataSource()
StiRectangle	getDefaultClientRectangle() gets the default client area of a component.
java.awt.image.BufferedImage	getImage(double zoom)
java.awt.image.BufferedImage	getImage(double zoom, StiExportFormat format)
java.lang.String	getLocalizedCategory() Gets a localized name of the component category.
java.lang.String	getLocalizedName() Gets a localized component name.
StiColor	getNegativeColor() Gets or sets a back color.
StiColor	getPositiveColor() Gets or sets a back color.
int	getPriority() gets a component priority.
StiComponentType	getStiComponentType() Gets the type of processing when printing.
int	getToolboxPosition()
StiSparklineType	getType()
java.lang.String	getValueDataColumn() Gets or sets a name of the column that contains the values.
java.lang.String	getValuesContainer()
boolean	isExportAsImage(StiExportFormat format)
boolean	isShowFirstLastPoints() Gets or sets the value which indicates that first and last points should be show.
boolean	isShowHighLowPoints() Gets or sets the value which indicates that high and low points should be show.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setBorder(StiBorder border)
void	setBrush(StiBrush brush)
void	setDataRelationName(java.lang.String dataRelationName)
void	setNegativeColor(StiColor negativeColor)
void	setPositiveColor(StiColor positiveColor)
void	setShowFirstLastPoints(boolean showFirstLastPoints)
void	setShowHighLowPoints(boolean showHighLowPoints)
void	setType(StiSparklineType type)
void	setValueDataColumn(java.lang.String value) Gets or sets a name of the column that contains the values.
void	setValuesContainer(java.lang.String value)
boolean	shouldSerializeBorder()

Methods inherited from class com.stimulsoft.report.components.StiComponent

addSize, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, fillComponentPlacement, getActualSize, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getClickEvent, getClientRectangle, getComponentPlacement, getComponentStyle, getComponentType, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, getDoubleClickEvent, getDrillDownParameters, getEnabled, getEvents, getExpressions, getForceRedrawAll, getgetBookmarkEvent, getgetDrillDownReportEvent, getgetHyperlinkEvent, getgetTagEvent, getgetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getGrowToHeight, getGuid, getHeight, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInteraction, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLeft, getLevel, getLinked, getLocked, getMaxSize, getMeasureGraphics, getMinSize, getMouseEnterEvent, getMouseLeaveEvent, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getPrintable, getPrintOn, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShiftMode, getShowQuickButtons, getTag, getTagStrValue, getTagValue, getToolTip, getToolTipValue, getTop, getUseParentStyles, getWidth, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, InvokeClick, InvokeDoubleClick, InvokeEndRender, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, isAutomaticDock, isDesigning, IsParentSelect, NewGuid, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, RestoreState, saveState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setCanGrow, setCanShrink, setClickEvent, setClientRectangle, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDockStyle, setDoubleClickEvent, setDrillDownParameters, setEnabled, setExpressions, setgetBookmarkEvent, setgetDrillDownReportEvent, setgetHyperlinkEvent, setgetTagEvent, setgetToolTipEvent, setGrowToHeight, setGuid, setHeight, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, setIsRendered, setIsSelected, setLeft, setLeftProp, setLinked, setLocked, setMaxSize, setMinSize, setMouseEnterEvent, setMouseLeaveEvent, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setPrintable, setPrintOn, setRenderedCount, setReport, SetReportVariables, setRestrictions, setSelectionTick, setSelectRectangle, setShift, setShiftMode, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTop, setTopProp, setUseParentStyles, setWidth, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

getName, getServiceName

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

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

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

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiExportImageExtended

getImage

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiExportImage

getImage

Field Detail

dataRelationName

public java.lang.String dataRelationName

brush

public StiBrush brush

border

public StiBorder border

values

public double[] values

type

public StiSparklineType type

showHighLowPoints

public boolean showHighLowPoints

showFirstLastPoints

public boolean showFirstLastPoints

positiveColor

public StiColor positiveColor

negativeColor

public StiColor negativeColor

Constructor Detail

StiSparkline

public StiSparkline()

Creates a new StiSparkline.

StiSparkline

public StiSparkline(StiRectangle rect)

Creates a new StiSparkline.

Parameters:

rect - The rectangle describes sizes and position of the component.

Method Detail

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiComponent

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiComponent

Throws:

JSONException

getDataRelation

public StiDataRelation getDataRelation()

Get link that is used for master-detail reports rendering.

Specified by:

getDataRelation in interface IStiDataRelation

getDataRelationName

public java.lang.String getDataRelationName()

Gets or sets relation name.

Specified by:

getDataRelationName in interface IStiDataRelation

Returns:

the dataRelationName

setDataRelationName

public void setDataRelationName(java.lang.String dataRelationName)

Specified by:

setDataRelationName in interface IStiDataRelation

Parameters:

dataRelationName - the dataRelationName to set

getImage

public java.awt.image.BufferedImage getImage(double zoom)

getImage

public java.awt.image.BufferedImage getImage(double zoom,
                                             StiExportFormat format)

isExportAsImage

public boolean isExportAsImage(StiExportFormat format)

Specified by:

isExportAsImage in interface IStiExportImageExtended

Overrides:

isExportAsImage in class StiComponent

clone

public java.lang.Object clone(boolean cloneProperties)

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

Overrides:

clone in class StiComponent

Returns:

A new object that is a copy of this instance.

getBrush

public StiBrush getBrush()

Gets or sets a brush to fill a component.

Specified by:

getBrush in interface IStiBrush

Returns:

the brush

setBrush

public void setBrush(StiBrush brush)

Specified by:

setBrush in interface IStiBrush

Parameters:

brush - the brush to set

shouldSerializeBorder

public boolean shouldSerializeBorder()

getBorder

public StiBorder getBorder()

Gets or sets border of the component.

Specified by:

getBorder in interface IStiBorder

Returns:

the border

setBorder

public void setBorder(StiBorder border)

Specified by:

setBorder in interface IStiBorder

Parameters:

border - the border to set

getCanShrink

public boolean getCanShrink()

Description copied from class: StiComponent

gets or sets value which indicates that this object can shrink.

Specified by:

getCanShrink in interface IStiCanShrink

Overrides:

getCanShrink in class StiComponent

getCanGrow

public boolean getCanGrow()

Description copied from class: StiComponent

gets or sets a value which indicates that this object can grow.

Specified by:

getCanGrow in interface IStiCanGrow

Overrides:

getCanGrow in class StiComponent

getPriority

public int getPriority()

Description copied from class: StiComponent

gets a component priority.

Overrides:

getPriority in class StiComponent

getLocalizedCategory

public java.lang.String getLocalizedCategory()

Description copied from class: StiBase

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiBase

getDefaultClientRectangle

public StiRectangle getDefaultClientRectangle()

Description copied from class: StiComponent

gets the default client area of a component.

Overrides:

getDefaultClientRectangle in class StiComponent

getStiComponentType

public StiComponentType getStiComponentType()

Gets the type of processing when printing.

Returns:

Gets the type of processing when printing.

getToolboxPosition

public int getToolboxPosition()

Overrides:

getToolboxPosition in class StiComponent

getLocalizedName

public java.lang.String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiBase

createNew

public StiComponent createNew()

fetchValues

public double[] fetchValues()

getDataSource

public StiDataSource getDataSource()

setValueDataColumn

public void setValueDataColumn(java.lang.String value)

Gets or sets a name of the column that contains the values.

Parameters:

value -

getValueDataColumn

public java.lang.String getValueDataColumn()

Gets or sets a name of the column that contains the values.

Returns:

getValuesContainer

public java.lang.String getValuesContainer()

Returns:

the valuesContainer

setValuesContainer

public void setValuesContainer(java.lang.String value)

Parameters:

valuesContainer - the valuesContainer to set

getType

public StiSparklineType getType()

Returns:

the type

setType

public void setType(StiSparklineType type)

Parameters:

type - the type to set

isShowHighLowPoints

public boolean isShowHighLowPoints()

Gets or sets the value which indicates that high and low points should be show.

Returns:

the showHighLowPoints

setShowHighLowPoints

public void setShowHighLowPoints(boolean showHighLowPoints)

Parameters:

showHighLowPoints - the showHighLowPoints to set

isShowFirstLastPoints

public boolean isShowFirstLastPoints()

Gets or sets the value which indicates that first and last points should be show.

Returns:

the showFirstLastPoints

setShowFirstLastPoints

public void setShowFirstLastPoints(boolean showFirstLastPoints)

Parameters:

showFirstLastPoints - the showFirstLastPoints to set

getPositiveColor

public StiColor getPositiveColor()

Gets or sets a back color.

Returns:

the positiveColor

setPositiveColor

public void setPositiveColor(StiColor positiveColor)

Parameters:

positiveColor - the positiveColor to set

getNegativeColor

public StiColor getNegativeColor()

Gets or sets a back color.

Returns:

the negativeColor

setNegativeColor

public void setNegativeColor(StiColor negativeColor)

Parameters:

negativeColor - the negativeColor to set

existDataRelation

public boolean existDataRelation()

Specified by:

existDataRelation in interface IStiDataRelation