StandardMapComponent (JasperReports 6.4.1 API)

java.lang.Object
- net.sf.jasperreports.components.map.StandardMapComponent

All Implemented Interfaces:

Serializable, Cloneable, MapComponent, Component, JRChangeEventsSupport, JRCloneable
```
public class StandardMapComponent
extends Object
implements MapComponent, Serializable, JRChangeEventsSupport
```
Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROPERTY_ADDRESS_EXPRESSION`
`static String`	`PROPERTY_EVALUATION_GROUP`
`static String`	`PROPERTY_EVALUATION_TIME`
`static String`	`PROPERTY_IMAGE_TYPE`
`static String`	`PROPERTY_LANGUAGE_EXPRESSION`
`static String`	`PROPERTY_LATITUDE_EXPRESSION`
`static String`	`PROPERTY_LONGITUDE_EXPRESSION`
`static String`	`PROPERTY_MAP_SCALE`
`static String`	`PROPERTY_MAP_TYPE`
`static String`	`PROPERTY_MARKER_DATA` Deprecated. Replaced by `PROPERTY_MARKER_DATA_LIST`.
`static String`	`PROPERTY_MARKER_DATA_LIST`
`static String`	`PROPERTY_MARKER_DATASET` Deprecated. Replaced by `PROPERTY_MARKER_DATA`.
`static String`	`PROPERTY_ON_ERROR_TYPE`
`static String`	`PROPERTY_PATH_DATA_LIST`
`static String`	`PROPERTY_PATH_STYLE_LIST`
`static String`	`PROPERTY_ZOOM_EXPRESSION`

Fields inherited from interface net.sf.jasperreports.components.map.MapComponent
ATTRIBUTE_IMAGE_TYPE, ATTRIBUTE_MAP_SCALE, ATTRIBUTE_MAP_TYPE, ATTRIBUTE_ON_ERROR_TYPE, DEFAULT_LATITUDE, DEFAULT_LONGITUDE, DEFAULT_MAP_TYPE, DEFAULT_ON_ERROR_TYPE, DEFAULT_PATH_NAME, DEFAULT_ZOOM, ELEMENT_MARKER_DATA, ELEMENT_PATH_DATA, ELEMENT_PATH_STYLE, ITEM_PROPERTY_address, ITEM_PROPERTY_clickable, ITEM_PROPERTY_draggable, ITEM_PROPERTY_latitude, ITEM_PROPERTY_longitude, ITEM_PROPERTY_MARKER_color, ITEM_PROPERTY_MARKER_cursor, ITEM_PROPERTY_MARKER_flat, ITEM_PROPERTY_MARKER_icon, ITEM_PROPERTY_MARKER_ICON_ANCHOR_x, ITEM_PROPERTY_MARKER_ICON_ANCHOR_y, ITEM_PROPERTY_MARKER_ICON_height, ITEM_PROPERTY_MARKER_ICON_ORIGIN_x, ITEM_PROPERTY_MARKER_ICON_ORIGIN_y, ITEM_PROPERTY_MARKER_ICON_url, ITEM_PROPERTY_MARKER_ICON_width, ITEM_PROPERTY_MARKER_INFOWINDOW_content, ITEM_PROPERTY_MARKER_INFOWINDOW_latitude, ITEM_PROPERTY_MARKER_INFOWINDOW_longitude, ITEM_PROPERTY_MARKER_INFOWINDOW_maxWidth, ITEM_PROPERTY_MARKER_INFOWINDOW_pixelOffset, ITEM_PROPERTY_MARKER_label, ITEM_PROPERTY_MARKER_optimized, ITEM_PROPERTY_MARKER_raiseOnDrag, ITEM_PROPERTY_MARKER_shadow, ITEM_PROPERTY_MARKER_SHADOW_ANCHOR_x, ITEM_PROPERTY_MARKER_SHADOW_ANCHOR_y, ITEM_PROPERTY_MARKER_SHADOW_height, ITEM_PROPERTY_MARKER_SHADOW_ORIGIN_x, ITEM_PROPERTY_MARKER_SHADOW_ORIGIN_y, ITEM_PROPERTY_MARKER_SHADOW_url, ITEM_PROPERTY_MARKER_SHADOW_width, ITEM_PROPERTY_MARKER_size, ITEM_PROPERTY_MARKER_target, ITEM_PROPERTY_MARKER_title, ITEM_PROPERTY_MARKER_url, ITEM_PROPERTY_MARKER_zIndex, ITEM_PROPERTY_name, ITEM_PROPERTY_style, ITEM_PROPERTY_STYLE_editable, ITEM_PROPERTY_STYLE_fillColor, ITEM_PROPERTY_STYLE_fillOpacity, ITEM_PROPERTY_STYLE_geodesic, ITEM_PROPERTY_STYLE_isPolygon, ITEM_PROPERTY_STYLE_strokeColor, ITEM_PROPERTY_STYLE_strokeOpacity, ITEM_PROPERTY_STYLE_strokeWeight, ITEM_PROPERTY_visible, MAP_ELEMENT_NAME, MAP_ELEMENT_TYPE, PARAMETER_CACHE_RENDERER, PARAMETER_LANGUAGE, PARAMETER_MARKERS, PARAMETER_ON_ERROR_TYPE, PARAMETER_PATH_LOCATIONS, PARAMETER_PATHS, PARAMETER_REQ_PARAMS, PARAMETER_ZOOM, PROPERTY_CLIENT_ID, PROPERTY_KEY, PROPERTY_PREFIX, PROPERTY_SIGNATURE, PROPERTY_VERSION

Constructor Summary

Constructors
Constructor and Description

StandardMapComponent()

StandardMapComponent(MapComponent map, JRBaseObjectFactory objectFactory)

Constructors
Constructor and Description
`StandardMapComponent()`
`StandardMapComponent(MapComponent map, JRBaseObjectFactory objectFactory)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMarkerData(int index, ItemData markerData)`
`void`	`addMarkerData(ItemData markerData)`
`void`	`addPathData(int index, ItemData pathData)`
`void`	`addPathData(ItemData pathData)`
`void`	`addPathStyle(int index, ItemData pathStyle)`
`void`	`addPathStyle(ItemData pathStyle)`
`Object`	`clone()`
`JRExpression`	`getAddressExpression()` Returns a `JRExpression` representing the address of the map center.
`String`	`getEvaluationGroup()` Returns the evaluation group name for the map component element
`EvaluationTimeEnum`	`getEvaluationTime()` Returns the evaluation time of the map component element
`JRPropertyChangeSupport`	`getEventSupport()` Returns the property change support object for this instance.
`MapImageTypeEnum`	`getImageType()` Returns the image format of the map.
`JRExpression`	`getLanguageExpression()` Returns a `JRExpression` representing the language for the labels on the map.
`JRExpression`	`getLatitudeExpression()` Returns a `JRExpression` representing the latitude coordinate of the map center
`JRExpression`	`getLongitudeExpression()` Returns a `JRExpression` representing the longitude coordinate of the map center
`MapScaleEnum`	`getMapScale()` Returns the scale factor of the Google map used to return higher-resolution map images when working with high resolution screens available on mobile devices.
`MapTypeEnum`	`getMapType()` Returns the type of the Google map.
`ItemData`	`getMarkerData()` Deprecated. Replaced by `getMarkerDataList()`.
`List<ItemData>`	`getMarkerDataList()` Returns a list of `ItemData` objects representing collections of markers on the map
`MarkerDataset`	`getMarkerDataset()` Deprecated. Replaced by `getMarkerData()`.
`OnErrorTypeEnum`	`getOnErrorType()` Returns an attribute that customizes the way the engine handles a missing map image during report generation.
`List<ItemData>`	`getPathDataList()` Returns a list of `ItemData` objects representing collections of paths on the map
`List<ItemData>`	`getPathStyleList()` Returns a list of `ItemData` objects representing collections of path styles for the map
`JRExpression`	`getZoomExpression()` Returns a numeric expression representing the zoom factor of the map.
`ItemData`	`removeMarkerData(ItemData markerData)`
`ItemData`	`removePathData(ItemData pathData)`
`ItemData`	`removePathStyle(ItemData pathStyle)`
`void`	`setAddressExpression(JRExpression addressExpression)`
`void`	`setEvaluationGroup(String evaluationGroup)`
`void`	`setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)`
`void`	`setImageType(MapImageTypeEnum imageType)`
`void`	`setLanguageExpression(JRExpression languageExpression)`
`void`	`setLatitudeExpression(JRExpression latitudeExpression)`
`void`	`setLongitudeExpression(JRExpression longitudeExpression)`
`void`	`setMapScale(MapScaleEnum mapScale)`
`void`	`setMapType(MapTypeEnum mapType)`
`void`	`setMarkerData(ItemData markerData)` Deprecated. Replaced by `addMarkerData(ItemData)`.
`void`	`setMarkerDataset(MarkerDataset markerDataset)` Deprecated. Replaced by `setMarkerData(ItemData)`.
`void`	`setOnErrorType(OnErrorTypeEnum onErrorType)`
`void`	`setZoomExpression(JRExpression zoomExpression)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROPERTY_LATITUDE_EXPRESSION
```
public static final String PROPERTY_LATITUDE_EXPRESSION
```
    See Also:
    Constant Field Values
  - PROPERTY_LONGITUDE_EXPRESSION
```
public static final String PROPERTY_LONGITUDE_EXPRESSION
```
    See Also:
    Constant Field Values
  - PROPERTY_ADDRESS_EXPRESSION
```
public static final String PROPERTY_ADDRESS_EXPRESSION
```
    See Also:
    Constant Field Values
  - PROPERTY_ZOOM_EXPRESSION
```
public static final String PROPERTY_ZOOM_EXPRESSION
```
    See Also:
    Constant Field Values
  - PROPERTY_LANGUAGE_EXPRESSION
```
public static final String PROPERTY_LANGUAGE_EXPRESSION
```
    See Also:
    Constant Field Values
  - PROPERTY_EVALUATION_TIME
```
public static final String PROPERTY_EVALUATION_TIME
```
    See Also:
    Constant Field Values
  - PROPERTY_EVALUATION_GROUP
```
public static final String PROPERTY_EVALUATION_GROUP
```
    See Also:
    Constant Field Values
  - PROPERTY_MAP_TYPE
```
public static final String PROPERTY_MAP_TYPE
```
    See Also:
    Constant Field Values
  - PROPERTY_MAP_SCALE
```
public static final String PROPERTY_MAP_SCALE
```
    See Also:
    Constant Field Values
  - PROPERTY_IMAGE_TYPE
```
public static final String PROPERTY_IMAGE_TYPE
```
    See Also:
    Constant Field Values
  - PROPERTY_ON_ERROR_TYPE
```
public static final String PROPERTY_ON_ERROR_TYPE
```
    See Also:
    Constant Field Values
  - PROPERTY_MARKER_DATA_LIST
```
public static final String PROPERTY_MARKER_DATA_LIST
```
    See Also:
    Constant Field Values
  - PROPERTY_PATH_STYLE_LIST
```
public static final String PROPERTY_PATH_STYLE_LIST
```
    See Also:
    Constant Field Values
  - PROPERTY_PATH_DATA_LIST
```
public static final String PROPERTY_PATH_DATA_LIST
```
    See Also:
    Constant Field Values
  - PROPERTY_MARKER_DATASET
```
public static final String PROPERTY_MARKER_DATASET
```
    Deprecated. Replaced by PROPERTY_MARKER_DATA.
    
    See Also:
    Constant Field Values
  - PROPERTY_MARKER_DATA
```
public static final String PROPERTY_MARKER_DATA
```
    Deprecated. Replaced by PROPERTY_MARKER_DATA_LIST.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - StandardMapComponent
```
public StandardMapComponent()
```
  - StandardMapComponent
```
public StandardMapComponent(MapComponent map,
                    JRBaseObjectFactory objectFactory)
```
- Method Detail
  - getLatitudeExpression
```
public JRExpression getLatitudeExpression()
```
    Description copied from interface: MapComponent
    
    Returns a JRExpression representing the latitude coordinate of the map center
    
    Specified by:
    
    getLatitudeExpression in interface MapComponent
    
    Returns:
    the latitude expression
  - setLatitudeExpression
```
public void setLatitudeExpression(JRExpression latitudeExpression)
```
  - getLongitudeExpression
```
public JRExpression getLongitudeExpression()
```
    Description copied from interface: MapComponent
    
    Returns a JRExpression representing the longitude coordinate of the map center
    
    Specified by:
    
    getLongitudeExpression in interface MapComponent
    
    Returns:
    the longitude expression
  - setLongitudeExpression
```
public void setLongitudeExpression(JRExpression longitudeExpression)
```
  - getAddressExpression
```
public JRExpression getAddressExpression()
```
    Description copied from interface: MapComponent
    
    Returns a JRExpression representing the address of the map center. If no latitude or longitude coordinates are provided, the address expression will be used to calculate these coordinates
    
    Specified by:
    
    getAddressExpression in interface MapComponent
    
    Returns:
    the address expression
  - setAddressExpression
```
public void setAddressExpression(JRExpression addressExpression)
```
  - getZoomExpression
```
public JRExpression getZoomExpression()
```
    Description copied from interface: MapComponent
    
    Returns a numeric expression representing the zoom factor of the map.
    
    Specified by:
    
    getZoomExpression in interface MapComponent
    
    Returns:
    the zoom expression
  - setZoomExpression
```
public void setZoomExpression(JRExpression zoomExpression)
```
  - getLanguageExpression
```
public JRExpression getLanguageExpression()
```
    Description copied from interface: MapComponent
    
    Returns a JRExpression representing the language for the labels on the map.
    
    Specified by:
    
    getLanguageExpression in interface MapComponent
    
    Returns:
    the language expression
  - setLanguageExpression
```
public void setLanguageExpression(JRExpression languageExpression)
```
  - getEvaluationTime
```
public EvaluationTimeEnum getEvaluationTime()
```
    Description copied from interface: MapComponent
    
    Returns the evaluation time of the map component element
    
    Specified by:
    
    getEvaluationTime in interface MapComponent
    
    Returns:
    the evaluation time
  - setEvaluationTime
```
public void setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
```
  - getEvaluationGroup
```
public String getEvaluationGroup()
```
    Description copied from interface: MapComponent
    
    Returns the evaluation group name for the map component element
    
    Specified by:
    
    getEvaluationGroup in interface MapComponent
    
    Returns:
    the evaluation group
  - setEvaluationGroup
```
public void setEvaluationGroup(String evaluationGroup)
```
  - getEventSupport
```
public JRPropertyChangeSupport getEventSupport()
```
    Description copied from interface: JRChangeEventsSupport
    
    Returns the property change support object for this instance.
    
    Specified by:
    
    getEventSupport in interface JRChangeEventsSupport
    
    Returns:
    the property change support object for this instance
  - clone
```
public Object clone()
```
    Specified by:
    
    clone in interface JRCloneable
    
    Overrides:
    
    clone in class Object
  - getMapType
```
public MapTypeEnum getMapType()
```
    Description copied from interface: MapComponent
    Returns the type of the Google map. Possible values are:
    - ROADMAP (default value)
    - SATELLITE
    - TERRAIN
    - HYBRID
    Specified by:
    
    getMapType in interface MapComponent
    
    Returns:
    the type of the Google map
    See Also:
    MapTypeEnum
  - setMapType
```
public void setMapType(MapTypeEnum mapType)
```
  - getMapScale
```
public MapScaleEnum getMapScale()
```
    Description copied from interface: MapComponent
    Returns the scale factor of the Google map used to return higher-resolution map images when working with high resolution screens available on mobile devices. Possible values are:
    - 1 (default value)
    - 2
    - 4 (for Business customers only)
    Specified by:
    
    getMapScale in interface MapComponent
    
    Returns:
    the scale factor
  - setMapScale
```
public void setMapScale(MapScaleEnum mapScale)
```
  - getImageType
```
public MapImageTypeEnum getImageType()
```
    Description copied from interface: MapComponent
    Returns the image format of the map. Possible values are:
    - PNG (default value)
    - PNG_8
    - PNG_32
    - GIF
    - JPG
    - JPG_BASELINE
    Specified by:
    
    getImageType in interface MapComponent
    
    Returns:
    the image format of the map
    See Also:
    MapImageTypeEnum
  - setImageType
```
public void setImageType(MapImageTypeEnum imageType)
```
  - getMarkerData
```
public ItemData getMarkerData()
```
    Deprecated. Replaced by getMarkerDataList().
    
    Specified by:
    
    getMarkerData in interface MapComponent
  - setMarkerData
```
public void setMarkerData(ItemData markerData)
```
    Deprecated. Replaced by addMarkerData(ItemData).
  - getOnErrorType
```
public OnErrorTypeEnum getOnErrorType()
```
    Description copied from interface: MapComponent
    Returns an attribute that customizes the way the engine handles a missing map image during report generation. Possible values are:
    - ERROR (default value)
    - BLANK
    - ICON
    Specified by:
    
    getOnErrorType in interface MapComponent
    
    Returns:
    the onErrorType attribute
    See Also:
    OnErrorTypeEnum
  - setOnErrorType
```
public void setOnErrorType(OnErrorTypeEnum onErrorType)
```
  - getMarkerDataset
```
public MarkerDataset getMarkerDataset()
```
    Deprecated. Replaced by getMarkerData().
    
    Specified by:
    
    getMarkerDataset in interface MapComponent
  - setMarkerDataset
```
public void setMarkerDataset(MarkerDataset markerDataset)
```
    Deprecated. Replaced by setMarkerData(ItemData).
  - getPathStyleList
```
public List<ItemData> getPathStyleList()
```
    Description copied from interface: MapComponent
    
    Returns a list of ItemData objects representing collections of path styles for the map
    
    Specified by:
    
    getPathStyleList in interface MapComponent
    
    Returns:
    a list of path styles
    See Also:
    ItemData
  - addPathStyle
```
public void addPathStyle(ItemData pathStyle)
```
  - addPathStyle
```
public void addPathStyle(int index,
                ItemData pathStyle)
```
  - removePathStyle
```
public ItemData removePathStyle(ItemData pathStyle)
```
  - getMarkerDataList
```
public List<ItemData> getMarkerDataList()
```
    Description copied from interface: MapComponent
    
    Returns a list of ItemData objects representing collections of markers on the map
    
    Specified by:
    
    getMarkerDataList in interface MapComponent
    
    Returns:
    a list of marker data
    See Also:
    ItemData
  - addMarkerData
```
public void addMarkerData(ItemData markerData)
```
  - addMarkerData
```
public void addMarkerData(int index,
                 ItemData markerData)
```
  - removeMarkerData
```
public ItemData removeMarkerData(ItemData markerData)
```
  - getPathDataList
```
public List<ItemData> getPathDataList()
```
    Description copied from interface: MapComponent
    
    Returns a list of ItemData objects representing collections of paths on the map
    
    Specified by:
    
    getPathDataList in interface MapComponent
    
    Returns:
    a list of path data
    See Also:
    ItemData
  - addPathData
```
public void addPathData(ItemData pathData)
```
  - addPathData
```
public void addPathData(int index,
               ItemData pathData)
```
  - removePathData
```
public ItemData removePathData(ItemData pathData)
```

Class StandardMapComponent

Field Summary

Fields inherited from interface net.sf.jasperreports.components.map.MapComponent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_LATITUDE_EXPRESSION

PROPERTY_LONGITUDE_EXPRESSION

PROPERTY_ADDRESS_EXPRESSION

PROPERTY_ZOOM_EXPRESSION

PROPERTY_LANGUAGE_EXPRESSION

PROPERTY_EVALUATION_TIME

PROPERTY_EVALUATION_GROUP

PROPERTY_MAP_TYPE

PROPERTY_MAP_SCALE

PROPERTY_IMAGE_TYPE

PROPERTY_ON_ERROR_TYPE

PROPERTY_MARKER_DATA_LIST

PROPERTY_PATH_STYLE_LIST

PROPERTY_PATH_DATA_LIST

PROPERTY_MARKER_DATASET

PROPERTY_MARKER_DATA

Constructor Detail

StandardMapComponent

StandardMapComponent

Method Detail

getLatitudeExpression

setLatitudeExpression

getLongitudeExpression

setLongitudeExpression

getAddressExpression

setAddressExpression

getZoomExpression

setZoomExpression

getLanguageExpression

setLanguageExpression

getEvaluationTime

setEvaluationTime

getEvaluationGroup

setEvaluationGroup

getEventSupport

clone

getMapType

setMapType

getMapScale

setMapScale

getImageType

setImageType

getMarkerData

setMarkerData

getOnErrorType

setOnErrorType

getMarkerDataset

setMarkerDataset

getPathStyleList

addPathStyle

addPathStyle

removePathStyle

getMarkerDataList

addMarkerData

addMarkerData

removeMarkerData

getPathDataList

addPathData

addPathData

removePathData