Package 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:
IStiAppExpressionCollection, IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, IStiBorder, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiExportImage, IStiExportImageExtended, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiReportProperty, IStiInherited, IStiStateSaveRestore, Cloneable
public class StiMap extends StiComponent implements IStiExportImageExtended, IStiBorder
Copyright Stimulsoft

  • Field Details

    • border

      public StiBorder border

    • keyDataColumn

      public String keyDataColumn

    • isHashDataEmpty

      public boolean isHashDataEmpty

  • Constructor Details

    • StiMap

      public StiMap()

    • StiMap

      public StiMap(StiRectangle rect)
      Creates a new StiGauge.
      Parameters:
      rect - The rectangle describes size and position of the component.

  • Method Details

    • 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 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 String getLocalizedCategory()
      Gets a localized name of the component category.
      Overrides:
      getLocalizedCategory in class StiBase

    • getLocalizedName

      public 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 String getDataColumnKey()
      Deprecated.
      Please use property KeyDataColumn
      Returns:

    • setDataColumnKey

      @Deprecated public void setDataColumnKey(String value)
      Deprecated.
      Please use property KeyDataColumn
      Parameters:
      value -

    • getDataColumnName

      @Deprecated public String getDataColumnName()
      Deprecated.
      Please use property NameDataColumn
      Returns:

    • setDataColumnName

      @Deprecated public void setDataColumnName(String value)
      Deprecated.
      Please use property NameDataColumn
      Parameters:
      value -

    • getDataColumnValue

      @Deprecated public String getDataColumnValue()
      Deprecated.
      Please use property ValueDataColumn
      Returns:

    • setDataColumnValue

      @Deprecated public void setDataColumnValue(String value)
      Deprecated.
      Please use property ValueDataColumn
      Parameters:
      value -

    • getDataColumnGroup

      @Deprecated public String getDataColumnGroup()
      Deprecated.
      Please use property GroupDataColumn
      Returns:

    • setDataColumnGroup

      @Deprecated public void setDataColumnGroup(String value)
      Deprecated.
      Please use property GroupDataColumn
      Parameters:
      value -

    • getDataColumnColor

      @Deprecated public String getDataColumnColor()
      Deprecated.
      Please use property ColorDataColumn
      Returns:

    • setDataColumnColor

      @Deprecated public void setDataColumnColor(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

    • getPoints

      public List<StiPoint> getPoints()

    • setPoints

      public void setPoints(List<StiPoint> points)

    • 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

    • getOnePointZoom

      public int getOnePointZoom()

    • setOnePointZoom

      public void setOnePointZoom(int onePointZoom)

    • 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 String getMapData()
      Returns:
      the mapData

    • setMapData

      public void setMapData(String value)
      Parameters:
      mapData - the mapData to set

    • getKeyDataColumn

      public String getKeyDataColumn()
      a name of the column that contains the values.
      Returns:
      the keyDataColumn

    • setKeyDataColumn

      public void setKeyDataColumn(String keyDataColumn)
      a name of the column that contains the values.
      Parameters:
      keyDataColumn - the keyDataColumn to set

    • getNameDataColumn

      public String getNameDataColumn()
      a name of the column that contains the values.
      Returns:
      the nameDataColumn

    • setNameDataColumn

      public void setNameDataColumn(String nameDataColumn)
      a name of the column that contains the values.
      Parameters:
      nameDataColumn - the nameDataColumn to set

    • getValueDataColumn

      public String getValueDataColumn()
      a name of the column that contains the values.
      Returns:
      the valueDataColumn

    • setValueDataColumn

      public void setValueDataColumn(String valueDataColumn)
      a name of the column that contains the values.
      Parameters:
      valueDataColumn - the valueDataColumn to set

    • getGroupDataColumn

      public String getGroupDataColumn()
      a name of the column that contains the values.
      Returns:
      the groupDataColumn

    • setGroupDataColumn

      public void setGroupDataColumn(String groupDataColumn)
      a name of the column that contains the values.
      Parameters:
      groupDataColumn - the groupDataColumn to set

    • getColorDataColumn

      public String getColorDataColumn()
      a name of the column that contains the values.
      Returns:
      the colorDataColumn

    • setColorDataColumn

      public void setColorDataColumn(String colorDataColumn)
      a name of the column that contains the values."
      Parameters:
      colorDataColumn - the colorDataColumn to set

    • getLatitude

      public String getLatitude()
      Returns:
      the latitude

    • setLatitude

      public void setLatitude(String latitude)
      Parameters:
      latitude - the latitude to set

    • getLongitude

      public String getLongitude()
      Returns:
      the longitude

    • setLongitude

      public void setLongitude(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 List<StiMapData> getMapDataInternal(String mapData, StiMapID mapID) throws UnsupportedEncodingException, JSONException, IOException
      Throws:
      UnsupportedEncodingException
      JSONException
      IOException

    • getDefaultMapData

      public static List<StiMapData> getDefaultMapData(StiMapID mapID) throws UnsupportedEncodingException, IOException, JSONException
      Throws:
      UnsupportedEncodingException
      IOException
      JSONException

    • getMapDataInternal

      public static List<StiMapData> getMapDataInternal(String mapData, StiMapID mapID, StiRefObject<Boolean> isHashDataEmpty) throws JSONException, UnsupportedEncodingException, IOException
      Throws:
      JSONException
      UnsupportedEncodingException
      IOException

    • GetMapData

      public List<StiMapData> GetMapData() throws UnsupportedEncodingException, JSONException, IOException
      Throws:
      UnsupportedEncodingException
      JSONException
      IOException

    • getCurrentStyleColors

      public List<StiColor> getCurrentStyleColors()

    • getStyleColors

      public static List<StiColor> getStyleColors(StiMapStyleIdent style)

    • getStyleBackground

      public StiBrush getStyleBackground()

    • getMapStyle

      public static StiMapStyle getMapStyle(StiMap map)

    • getMapStyle

      public static StiMapStyle getMapStyle(StiMapStyleIdent style)