MapComponent (JasperReports 6.1.1 API)

All Superinterfaces:

Cloneable, Component, JRCloneable

All Known Implementing Classes:

StandardMapComponent
```
public interface MapComponent
extends Component, JRCloneable
```
The Map component interface.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_PATH_NAME`
`static Integer`	`DEFAULT_ZOOM`
`static String`	`ELEMENT_MARKER_DATA`
`static String`	`ELEMENT_PATH_DATA`
`static String`	`ELEMENT_PATH_STYLE`
`static String`	`PROPERTY_address`
`static String`	`PROPERTY_CLIENT_ID`
`static String`	`PROPERTY_isPolygon`
`static String`	`PROPERTY_KEY`
`static String`	`PROPERTY_latitude`
`static String`	`PROPERTY_locations`
`static String`	`PROPERTY_longitude`
`static String`	`PROPERTY_name`
`static String`	`PROPERTY_PREFIX`
`static String`	`PROPERTY_SIGNATURE`
`static String`	`PROPERTY_style`
`static String`	`PROPERTY_title`
`static String`	`PROPERTY_VERSION`

Method Summary

Methods
Modifier and Type	Method and Description
`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
`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 `getMarkerDataList()`.
`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.

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable
clone

- Field Detail
  - PROPERTY_PREFIX
```
static final String PROPERTY_PREFIX
```
    See Also:
    Constant Field Values
  - PROPERTY_KEY
```
static final String PROPERTY_KEY
```
    See Also:
    Constant Field Values
  - PROPERTY_CLIENT_ID
```
static final String PROPERTY_CLIENT_ID
```
    See Also:
    Constant Field Values
  - PROPERTY_SIGNATURE
```
static final String PROPERTY_SIGNATURE
```
    See Also:
    Constant Field Values
  - PROPERTY_VERSION
```
static final String PROPERTY_VERSION
```
    See Also:
    Constant Field Values
  - PROPERTY_latitude
```
static final String PROPERTY_latitude
```
    See Also:
    Constant Field Values
  - PROPERTY_longitude
```
static final String PROPERTY_longitude
```
    See Also:
    Constant Field Values
  - PROPERTY_address
```
static final String PROPERTY_address
```
    See Also:
    Constant Field Values
  - PROPERTY_title
```
static final String PROPERTY_title
```
    See Also:
    Constant Field Values
  - PROPERTY_name
```
static final String PROPERTY_name
```
    See Also:
    Constant Field Values
  - PROPERTY_style
```
static final String PROPERTY_style
```
    See Also:
    Constant Field Values
  - PROPERTY_isPolygon
```
static final String PROPERTY_isPolygon
```
    See Also:
    Constant Field Values
  - PROPERTY_locations
```
static final String PROPERTY_locations
```
    See Also:
    Constant Field Values
  - ELEMENT_MARKER_DATA
```
static final String ELEMENT_MARKER_DATA
```
    See Also:
    Constant Field Values
  - ELEMENT_PATH_STYLE
```
static final String ELEMENT_PATH_STYLE
```
    See Also:
    Constant Field Values
  - ELEMENT_PATH_DATA
```
static final String ELEMENT_PATH_DATA
```
    See Also:
    Constant Field Values
  - DEFAULT_PATH_NAME
```
static final String DEFAULT_PATH_NAME
```
    See Also:
    Constant Field Values
  - DEFAULT_ZOOM
```
static final Integer DEFAULT_ZOOM
```
- Method Detail
  - getLatitudeExpression
```
JRExpression getLatitudeExpression()
```
    Returns a JRExpression representing the latitude coordinate of the map center
    
    Returns:
    the latitude expression
  - getLongitudeExpression
```
JRExpression getLongitudeExpression()
```
    Returns a JRExpression representing the longitude coordinate of the map center
    
    Returns:
    the longitude expression
  - getAddressExpression
```
JRExpression getAddressExpression()
```
    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
    
    Returns:
    the address expression
  - getZoomExpression
```
JRExpression getZoomExpression()
```
    Returns a numeric expression representing the zoom factor of the map.
    
    Returns:
    the zoom expression
  - getLanguageExpression
```
JRExpression getLanguageExpression()
```
    Returns a JRExpression representing the language for the labels on the map.
    
    Returns:
    the language expression
  - getEvaluationTime
```
EvaluationTimeEnum getEvaluationTime()
```
    Returns the evaluation time of the map component element
    
    Returns:
    the evaluation time
  - getEvaluationGroup
```
String getEvaluationGroup()
```
    Returns the evaluation group name for the map component element
    
    Returns:
    the evaluation group
  - getMapType
```
MapTypeEnum getMapType()
```
    Returns the type of the Google map. Possible values are:
    - ROADMAP (default value)
    - SATELLITE
    - TERRAIN
    - HYBRID
    Returns:
    the type of the Google map
    See Also:
    MapTypeEnum
  - getMapScale
```
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. Possible values are:
    - 1 (default value)
    - 2
    - 4 (for Business customers only)
    Returns:
    the scale factor
  - getImageType
```
MapImageTypeEnum getImageType()
```
    Returns the image format of the map. Possible values are:
    - PNG (default value)
    - PNG_8
    - PNG_32
    - GIF
    - JPG
    - JPG_BASELINE
    Returns:
    the image format of the map
    See Also:
    MapImageTypeEnum
  - getOnErrorType
```
OnErrorTypeEnum getOnErrorType()
```
    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
    Returns:
    the onErrorType attribute
    See Also:
    OnErrorTypeEnum
  - getMarkerDataList
```
List<ItemData> getMarkerDataList()
```
    Returns a list of ItemData objects representing collections of markers on the map
    
    Returns:
    a list of marker data
    See Also:
    ItemData
  - getPathStyleList
```
List<ItemData> getPathStyleList()
```
    Returns a list of ItemData objects representing collections of path styles for the map
    
    Returns:
    a list of path styles
    See Also:
    ItemData
  - getPathDataList
```
List<ItemData> getPathDataList()
```
    Returns a list of ItemData objects representing collections of paths on the map
    
    Returns:
    a list of path data
    See Also:
    ItemData
  - getMarkerData
```
ItemData getMarkerData()
```
    Deprecated. Replaced by getMarkerDataList().
  - getMarkerDataset
```
MarkerDataset getMarkerDataset()
```
    Deprecated. Replaced by getMarkerDataList().

Interface MapComponent

Field Summary

Method Summary

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable

Field Detail

PROPERTY_PREFIX

PROPERTY_KEY

PROPERTY_CLIENT_ID

PROPERTY_SIGNATURE

PROPERTY_VERSION

PROPERTY_latitude

PROPERTY_longitude

PROPERTY_address

PROPERTY_title

PROPERTY_name

PROPERTY_style

PROPERTY_isPolygon

PROPERTY_locations

ELEMENT_MARKER_DATA

ELEMENT_PATH_STYLE

ELEMENT_PATH_DATA

DEFAULT_PATH_NAME

DEFAULT_ZOOM

Method Detail

getLatitudeExpression

getLongitudeExpression

getAddressExpression

getZoomExpression

getLanguageExpression

getEvaluationTime

getEvaluationGroup

getMapType

getMapScale

getImageType

getOnErrorType

getMarkerDataList

getPathStyleList

getPathDataList

getMarkerData

getMarkerDataset