com.stimulsoft.report.maps

Class StiMap

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.maps.StiMap

All Implemented Interfaces:

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

public class StiMap
extends StiComponent
implements IStiExportImageExtended, IStiBorder

Copyright Stimulsoft

Field Summary

Fields

Modifier and Type	Field and Description
StiBorder	border
boolean	isHashDataEmpty
java.lang.String	keyDataColumn

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

canGrow, canShrink, componentPlacement, conditions, interaction, isRendered, page, parent, parentBookmark, PropertyComponentStyle, PropertyDelimiterComponent, PropertyDockable, PropertyInherited, PropertyLinked, PropertyLocked, PropertyMaxSize, PropertyMinSize, PropertyPlaceOnToolbox, PropertyRenderedCount, PropertyRestrictions, PropertySelectionTick, PropertyShowQuickButtons, PropertyUseParentStyles, top, width

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 and Description
StiMap()
StiMap(StiRectangle rect) Creates a new StiGauge.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone(boolean cloneProperties) Creates a new object that is a copy of the current instanc.
StiComponent	createNew()
StiBorder	getBorder() frame of the component.
StiBrush	getBrush() 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.
StiRectangle	getClientRectangle() gets or sets the client area of a component.
java.lang.String	getColorDataColumn() a name of the column that contains the values.
java.util.List<StiColor>	getCurrentStyleColors()
java.lang.String	getDataColumnColor() Deprecated.
java.lang.String	getDataColumnGroup() Deprecated.
java.lang.String	getDataColumnKey() Deprecated.
java.lang.String	getDataColumnName() Deprecated.
java.lang.String	getDataColumnValue() Deprecated.
StiMapSource	getDataFrom()
StiRectangle	getDefaultClientRectangle() gets the default client area of a component.
static java.util.List<StiMapData>	getDefaultMapData(StiMapID mapID)
StiDisplayNameType	getDisplayNameType()
java.lang.String	getGroupDataColumn() a name of the column that contains the values.
boolean	getGrowToHeight() gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
StiImage	getImage(double zoom)
StiImage	getImage(double zoom, StiExportFormat format)
java.lang.String	getKeyDataColumn() a name of the column that contains the values.
java.lang.String	getLatitude()
java.lang.String	getLocalizedCategory() Gets a localized name of the component category.
java.lang.String	getLocalizedName() Gets a localized component name.
java.lang.String	getLongitude()
java.lang.String	getMapData()
java.util.List<StiMapData>	GetMapData()
static java.util.List<StiMapData>	getMapDataInternal(java.lang.String mapData, StiMapID mapID)
static java.util.List<StiMapData>	getMapDataInternal(java.lang.String mapData, StiMapID mapID, StiRefObject<java.lang.Boolean> isHashDataEmpty)
StiMapID	getMapID()
StiMapMode	getMapMode()
StiMapStyleIdent	getMapStyle()
static StiMapStyle	getMapStyle(StiMap map)
static StiMapStyle	getMapStyle(StiMapStyleIdent style)
StiMapType	getMapType()
java.lang.String	getNameDataColumn() a name of the column that contains the values.
StiBrush	getStyleBackground()
static java.util.List<StiColor>	getStyleColors(StiMapStyleIdent style)
boolean	getUseParentStyles() gets or sets a value which indicates that this component must use styles from parent component.
java.lang.String	getValueDataColumn() a name of the column that contains the values.
boolean	isColorEach()
boolean	isExportAsImage(StiExportFormat format)
boolean	isHashDataEmpty()
boolean	isShortValue()
boolean	isShowLegend()
boolean	isShowValue()
boolean	isStretch()
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setBorder(StiBorder border)
void	setBrush(StiBrush brush) a brush to fill a component.
void	setClientRectangle(StiRectangle value)
void	setColorDataColumn(java.lang.String colorDataColumn) a name of the column that contains the values."
void	setColorEach(boolean colorEach)
void	setDataColumnColor(java.lang.String value) Deprecated.
void	setDataColumnGroup(java.lang.String value) Deprecated.
void	setDataColumnKey(java.lang.String value) Deprecated.
void	setDataColumnName(java.lang.String value) Deprecated.
void	setDataColumnValue(java.lang.String value) Deprecated.
void	setDataFrom(StiMapSource dataFrom)
void	setDisplayNameType(StiDisplayNameType displayNameType)
void	setGroupDataColumn(java.lang.String groupDataColumn) a name of the column that contains the values.
void	setKeyDataColumn(java.lang.String keyDataColumn) a name of the column that contains the values.
void	setLatitude(java.lang.String latitude)
void	setLongitude(java.lang.String longitude)
void	setMapData(java.lang.String value)
void	setMapID(StiMapID mapID)
void	setMapMode(StiMapMode mapMode)
void	setMapStyle(StiMapStyleIdent mapStyle)
void	setMapType(StiMapType mapType)
void	setNameDataColumn(java.lang.String nameDataColumn) a name of the column that contains the values.
void	setShortValue(boolean shortValue)
void	setShowLegend(boolean showLegend)
void	setShowValue(boolean showValue)
void	setStretch(boolean stretch)
void	setValueDataColumn(java.lang.String valueDataColumn) a name of the column that contains the values.

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

addSize, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, fillComponentPlacement, getActualSize, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getBuilder, getClickEvent, getComponentPlacement, getComponentStyle, getComponentType, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, getDoubleClickEvent, getDrillDownParameters, getEnabled, getEvents, getForceRedrawAll, getgetBookmarkEvent, getgetDrillDownReportEvent, getgetHyperlinkEvent, getgetTagEvent, getgetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, 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, getPrintable, getPrintOn, getPriority, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShiftMode, getShowQuickButtons, getStates, getTag, getTagValue, getToolboxPosition, getToolTip, getToolTipValue, getTop, getWidth, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, InvokeClick, InvokeDoubleClick, InvokeEndRender, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, isAutomaticDock, isDesigning, IsParentSelect, NewGuid, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, RestoreState, saveState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setCanGrow, setCanShrink, setClickEvent, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDockStyle, setDoubleClickEvent, setDrillDownParameters, setEnabled, 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, 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, finalize, 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

border

public StiBorder border

keyDataColumn

public java.lang.String keyDataColumn

isHashDataEmpty

public boolean isHashDataEmpty

Constructor Detail

StiMap

public StiMap()

StiMap

public StiMap(StiRectangle rect)

Creates a new StiGauge.

Parameters:

rect - The rectangle describes size 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

clone

public java.lang.Object clone(boolean cloneProperties)

Description copied from class: StiComponent

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

Overrides:

clone in class StiComponent

Returns:

A new object that is a copy of this instance.

getImage

public StiImage getImage(double zoom)

getImage

public StiImage getImage(double zoom,
                StiExportFormat format)

isExportAsImage

public boolean isExportAsImage(StiExportFormat format)

Specified by:

isExportAsImage in interface IStiExportImageExtended

Overrides:

isExportAsImage in class StiComponent

getBorder

public StiBorder getBorder()

frame 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

getLocalizedCategory

public java.lang.String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiBase

getLocalizedName

public java.lang.String getLocalizedName()

Description copied from class: StiBase

Gets a localized component name.

Overrides:

getLocalizedName 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

getClientRectangle

public StiRectangle getClientRectangle()

Description copied from class: StiComponent

gets or sets the client area of a component.

Overrides:

getClientRectangle in class StiComponent

setClientRectangle

public void setClientRectangle(StiRectangle value)

Overrides:

setClientRectangle in class StiComponent

getDataColumnKey

@Deprecated
public java.lang.String getDataColumnKey()

Deprecated.

Please use property KeyDataColumn

Returns:

setDataColumnKey

@Deprecated
public void setDataColumnKey(java.lang.String value)

Deprecated.

Please use property KeyDataColumn

Parameters:

value -

getDataColumnName

@Deprecated
public java.lang.String getDataColumnName()

Deprecated.

Please use property NameDataColumn

Returns:

setDataColumnName

@Deprecated
public void setDataColumnName(java.lang.String value)

Deprecated.

Please use property NameDataColumn

Parameters:

value -

getDataColumnValue

@Deprecated
public java.lang.String getDataColumnValue()

Deprecated.

Please use property ValueDataColumn

Returns:

setDataColumnValue

@Deprecated
public void setDataColumnValue(java.lang.String value)

Deprecated.

Please use property ValueDataColumn

Parameters:

value -

getDataColumnGroup

@Deprecated
public java.lang.String getDataColumnGroup()

Deprecated.

Please use property GroupDataColumn

Returns:

setDataColumnGroup

@Deprecated
public void setDataColumnGroup(java.lang.String value)

Deprecated.

Please use property GroupDataColumn

Parameters:

value -

getDataColumnColor

@Deprecated
public java.lang.String getDataColumnColor()

Deprecated.

Please use property ColorDataColumn

Returns:

setDataColumnColor

@Deprecated
public void setDataColumnColor(java.lang.String value)

Deprecated.

Please use property ColorDataColumn

isShortValue

public boolean isShortValue()

Returns:

the shortValue

setShortValue

public void setShortValue(boolean shortValue)

Parameters:

shortValue - the shortValue to set

getBrush

public StiBrush getBrush()

a brush to fill a component.

Returns:

the brush

setBrush

public void setBrush(StiBrush brush)

a brush to fill a component.

Parameters:

brush - the brush to set

getMapStyle

public StiMapStyleIdent getMapStyle()

Returns:

the mapStyle

setMapStyle

public void setMapStyle(StiMapStyleIdent mapStyle)

Parameters:

mapStyle - the mapStyle to set

getDataFrom

public StiMapSource getDataFrom()

Returns:

the dataFrom

setDataFrom

public void setDataFrom(StiMapSource dataFrom)

Parameters:

dataFrom - the dataFrom to set

isStretch

public boolean isStretch()

Returns:

the stretch

setStretch

public void setStretch(boolean stretch)

Parameters:

stretch - the stretch to set

isColorEach

public boolean isColorEach()

Returns:

the colorEach

setColorEach

public void setColorEach(boolean colorEach)

Parameters:

colorEach - the colorEach to set

isShowValue

public boolean isShowValue()

Returns:

the showValue

setShowValue

public void setShowValue(boolean showValue)

Parameters:

showValue - the showValue to set

getMapID

public StiMapID getMapID()

Returns:

the mapID

setMapID

public void setMapID(StiMapID mapID)

Parameters:

mapID - the mapID to set

isShowLegend

public boolean isShowLegend()

Returns:

the showLegend

setShowLegend

public void setShowLegend(boolean showLegend)

Parameters:

showLegend - the showLegend to set

getDisplayNameType

public StiDisplayNameType getDisplayNameType()

Returns:

the displayNameType

setDisplayNameType

public void setDisplayNameType(StiDisplayNameType displayNameType)

Parameters:

displayNameType - the displayNameType to set

getMapType

public StiMapType getMapType()

Returns:

the mapType

setMapType

public void setMapType(StiMapType mapType)

Parameters:

mapType - the mapType to set

getMapData

public java.lang.String getMapData()

Returns:

the mapData

setMapData

public void setMapData(java.lang.String value)

Parameters:

mapData - the mapData to set

getKeyDataColumn

public java.lang.String getKeyDataColumn()

a name of the column that contains the values.

Returns:

the keyDataColumn

setKeyDataColumn

public void setKeyDataColumn(java.lang.String keyDataColumn)

a name of the column that contains the values.

Parameters:

keyDataColumn - the keyDataColumn to set

getNameDataColumn

public java.lang.String getNameDataColumn()

a name of the column that contains the values.

Returns:

the nameDataColumn

setNameDataColumn

public void setNameDataColumn(java.lang.String nameDataColumn)

a name of the column that contains the values.

Parameters:

nameDataColumn - the nameDataColumn to set

getValueDataColumn

public java.lang.String getValueDataColumn()

a name of the column that contains the values.

Returns:

the valueDataColumn

setValueDataColumn

public void setValueDataColumn(java.lang.String valueDataColumn)

a name of the column that contains the values.

Parameters:

valueDataColumn - the valueDataColumn to set

getGroupDataColumn

public java.lang.String getGroupDataColumn()

a name of the column that contains the values.

Returns:

the groupDataColumn

setGroupDataColumn

public void setGroupDataColumn(java.lang.String groupDataColumn)

a name of the column that contains the values.

Parameters:

groupDataColumn - the groupDataColumn to set

getColorDataColumn

public java.lang.String getColorDataColumn()

a name of the column that contains the values.

Returns:

the colorDataColumn

setColorDataColumn

public void setColorDataColumn(java.lang.String colorDataColumn)

a name of the column that contains the values."

Parameters:

colorDataColumn - the colorDataColumn to set

getLatitude

public java.lang.String getLatitude()

Returns:

the latitude

setLatitude

public void setLatitude(java.lang.String latitude)

Parameters:

latitude - the latitude to set

getLongitude

public java.lang.String getLongitude()

Returns:

the longitude

setLongitude

public void setLongitude(java.lang.String longitude)

Parameters:

longitude - the longitude to set

isHashDataEmpty

public boolean isHashDataEmpty()

Returns:

the isHashDataEmpty

getMapMode

public StiMapMode getMapMode()

Returns:

the mapMode

setMapMode

public void setMapMode(StiMapMode mapMode)

Parameters:

mapMode - the mapMode to set

getUseParentStyles

public boolean getUseParentStyles()

Description copied from class: StiComponent

gets or sets a value which indicates that this component must use styles from parent component.

Overrides:

getUseParentStyles 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

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

getGrowToHeight

public boolean getGrowToHeight()

Description copied from class: StiComponent

gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.

Specified by:

getGrowToHeight in interface IStiGrowToHeight

Overrides:

getGrowToHeight in class StiComponent

createNew

public StiComponent createNew()

getMapDataInternal

public static java.util.List<StiMapData> getMapDataInternal(java.lang.String mapData,
                                            StiMapID mapID)
                                                     throws java.io.UnsupportedEncodingException,
                                                            JSONException,
                                                            java.io.IOException

Throws:

java.io.UnsupportedEncodingException

JSONException

java.io.IOException

getDefaultMapData

public static java.util.List<StiMapData> getDefaultMapData(StiMapID mapID)
                                                    throws java.io.UnsupportedEncodingException,
                                                           java.io.IOException,
                                                           JSONException

Throws:

java.io.UnsupportedEncodingException

java.io.IOException

JSONException

getMapDataInternal

public static java.util.List<StiMapData> getMapDataInternal(java.lang.String mapData,
                                            StiMapID mapID,
                                            StiRefObject<java.lang.Boolean> isHashDataEmpty)
                                                     throws JSONException,
                                                            java.io.UnsupportedEncodingException,
                                                            java.io.IOException

Throws:

JSONException

java.io.UnsupportedEncodingException

java.io.IOException

GetMapData

public java.util.List<StiMapData> GetMapData()
                                      throws java.io.UnsupportedEncodingException,
                                             JSONException,
                                             java.io.IOException

Throws:

java.io.UnsupportedEncodingException

JSONException

java.io.IOException

getCurrentStyleColors

public java.util.List<StiColor> getCurrentStyleColors()

getStyleColors

public static java.util.List<StiColor> getStyleColors(StiMapStyleIdent style)

getStyleBackground

public StiBrush getStyleBackground()

getMapStyle

public static StiMapStyle getMapStyle(StiMap map)

getMapStyle

public static StiMapStyle getMapStyle(StiMapStyleIdent style)