Interface MapComponent
-
- All Superinterfaces:
Cloneable
,Component
,JRCloneable
,JREvaluation
- All Known Implementing Classes:
StandardMapComponent
public interface MapComponent extends Component, JREvaluation, JRCloneable
The Map component interface.- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
-
-
Field Summary
Fields Modifier and Type Field Description static String
ATTRIBUTE_IMAGE_TYPE
This attribute represents the image format of the map.static String
ATTRIBUTE_MAP_SCALE
Numeric (positive integer) attribute that provides the scale value used to return higher-resolution map images when working with high resolution screens available on mobile devices.static String
ATTRIBUTE_MAP_TYPE
The attribute that provides the map type.static String
ATTRIBUTE_MARKER_CLUSTERING
boolean attribute that specifies whether to group markers into clusters or not; optional.static String
ATTRIBUTE_MARKER_SPIDERING
boolean attribute that specifies whether to "spider-ify" overlapping markers or not; optional.static String
ATTRIBUTE_ON_ERROR_TYPE
Applies to static maps only.static Float
DEFAULT_LATITUDE
static Float
DEFAULT_LONGITUDE
static MapTypeEnum
DEFAULT_MAP_TYPE
static OnErrorTypeEnum
DEFAULT_ON_ERROR_TYPE
static String
DEFAULT_PATH_NAME
static Integer
DEFAULT_ZOOM
static String
ELEMENT_LEGEND_ITEM
static String
ELEMENT_MARKER_DATA
static String
ELEMENT_PATH_DATA
static String
ELEMENT_PATH_STYLE
static String
ELEMENT_RESET_MAP_ITEM
static String
ITEM_PROPERTY_address
Specifies the address of a given point on the map.static String
ITEM_PROPERTY_clickable
boolean value that specifies if this item (marker or path) is clickable; optional.static String
ITEM_PROPERTY_draggable
boolean value that specifies if this item (marker or path) is draggable; optional.static String
ITEM_PROPERTY_latitude
Numeric floating-point value representing the latitude of the place on the map; required if no equivalentITEM_PROPERTY_address
is set.static String
ITEM_PROPERTY_longitude
Numeric floating-point value representing the longitude of the place on the map; required if no equivalentITEM_PROPERTY_address
is set.static String
ITEM_PROPERTY_MARKER_color
Optional String value representing the color for the default pin icons.static String
ITEM_PROPERTY_MARKER_cursor
String value representing the cursor value; optional.static String
ITEM_PROPERTY_MARKER_flat
boolean value that specifies if the marker icon is flat; optional.static String
ITEM_PROPERTY_MARKER_icon
String value representing the URL where the marker icon is loaded from; optional.static String
ITEM_PROPERTY_MARKER_ICON_ANCHOR_x
Integer value representing the horizontal position to anchor the marker icon with respect to the location of the marker on the map.static String
ITEM_PROPERTY_MARKER_ICON_ANCHOR_y
Integer value representing the vertical position to anchor the marker icon with respect to the location of the marker on the map.static String
ITEM_PROPERTY_MARKER_ICON_height
Integer value representing the icon height, in pixels.static String
ITEM_PROPERTY_MARKER_ICON_ORIGIN_x
Integer value representing the horizontal position of the marker icon within a sprite, if any, in pixels.static String
ITEM_PROPERTY_MARKER_ICON_ORIGIN_y
Integer value representing the vertical position of the marker icon within a sprite, if any, in pixels.static String
ITEM_PROPERTY_MARKER_ICON_url
String value representing the URL where the marker icon is loaded from; optional.static String
ITEM_PROPERTY_MARKER_ICON_width
Integer value representing the icon width, in pixels.static String
ITEM_PROPERTY_MARKER_INFOWINDOW_content
String value representing the content to be displayed in an info window; optional.static String
ITEM_PROPERTY_MARKER_INFOWINDOW_latitude
Optional floating-point value representing the latitude used to determine the info window position on the map.static String
ITEM_PROPERTY_MARKER_INFOWINDOW_longitude
Optional floating-point value representing the longitude used to determine the info window position on the map.static String
ITEM_PROPERTY_MARKER_INFOWINDOW_maxWidth
Optional integer value representing the maximum width in pixels of the info window.static String
ITEM_PROPERTY_MARKER_INFOWINDOW_pixelOffset
Optional integer value representing the offset (in pixels) from the tip of the info window to the location on which the info window is anchored.static String
ITEM_PROPERTY_MARKER_label
String value representing the label for the default pin icons; optional.static String
ITEM_PROPERTY_MARKER_optimized
boolean value that specifies if the marker icon is optimized; optional.static String
ITEM_PROPERTY_MARKER_raiseOnDrag
boolean value to be applied for the raiseOnDrag property; optional.static String
ITEM_PROPERTY_MARKER_shadow
String value representing the URL where the custom marker shadow icon is loaded from; optional.static String
ITEM_PROPERTY_MARKER_SHADOW_ANCHOR_x
Integer value representing the horizontal position to anchor the shadow icon with respect to the location of the marker on the map.static String
ITEM_PROPERTY_MARKER_SHADOW_ANCHOR_y
Integer value representing the vertical position to anchor the shadow icon with respect to the location of the marker on the map.static String
ITEM_PROPERTY_MARKER_SHADOW_height
Integer value representing the shadow icon height, in pixels.static String
ITEM_PROPERTY_MARKER_SHADOW_ORIGIN_x
Integer value representing the horizontal position of the shadow icon within a sprite, if any, in pixels.static String
ITEM_PROPERTY_MARKER_SHADOW_ORIGIN_y
Integer value representing the vertical position of the shadow icon within a sprite, if any, in pixels.static String
ITEM_PROPERTY_MARKER_SHADOW_url
String value representing the URL where the custom marker shadow icon is loaded from; optional.static String
ITEM_PROPERTY_MARKER_SHADOW_width
Integer value representing the shadow icon width, in pixels.static String
ITEM_PROPERTY_MARKER_size
Predefined String value representing the default marker icon size; optional.static String
ITEM_PROPERTY_MARKER_target
String value representing the hyperlink target for the marker; optional.static String
ITEM_PROPERTY_MARKER_title
String value representing the tooltip for the marker icon; optional.static String
ITEM_PROPERTY_MARKER_url
String value representing a link to a page or document that will be open when the marker is clicked on; optional.static String
ITEM_PROPERTY_MARKER_zIndex
Integer value representing the z index of this item (marker or path); optional.static String
ITEM_PROPERTY_name
String value representing the name, as unique identifier.static String
ITEM_PROPERTY_style
String value representing the name of a path style (inpathData
) or the name of the parent style (inpathStyle
); optional.static String
ITEM_PROPERTY_STYLE_editable
Flag that specifies if the path is editable; optional.static String
ITEM_PROPERTY_STYLE_fillColor
String value representing the color of the fill; optional.static String
ITEM_PROPERTY_STYLE_fillOpacity
Numeric floating-point value in [0..1] representing the opacity of the path fill; optional.static String
ITEM_PROPERTY_STYLE_geodesic
Flag that specifies if the path is geodesic; optional.static String
ITEM_PROPERTY_STYLE_isPolygon
Flag that specifies whether the path is a polygon; optional.static String
ITEM_PROPERTY_STYLE_strokeColor
The color of the stroke; optional.static String
ITEM_PROPERTY_STYLE_strokeOpacity
Numeric floating-point value in [0..1] representing the opacity of the path stroke; optional.static String
ITEM_PROPERTY_STYLE_strokeWeight
Numeric integer value representing the stroke weight; optional.static String
ITEM_PROPERTY_visible
boolean value that specifies if this item (marker or path) is visible on the map; optional.static String
LEGEND_OR_RESET_MAP_PROPERTY_enabled
static String
LEGEND_OR_RESET_MAP_PROPERTY_label
Legend or resetMap item property with value of typeString
that specifies the labelstatic String
LEGEND_OR_RESET_MAP_PROPERTY_position
Legend or resetMap item property with value of typeCustomMapControlPositionEnum
static String
LEGEND_PROPERTY_legendMaxHeight
Legend item property with value of typeString
that specifies the legend maximum height in pixels when in non-fullscreen modestatic String
LEGEND_PROPERTY_legendMaxHeight_fullscreen
Legend item property with value of typeString
that specifies the legend maximum height in pixels when in fullscreen modestatic String
LEGEND_PROPERTY_legendMaxWidth
Legend item property with value of typeString
that specifies the legend maximum width in pixels when in non-fullscreen modestatic String
LEGEND_PROPERTY_legendMaxWidth_fullscreen
Legend item property with value of typeString
that specifies the legend maximum width in pixels when in fullscreen modestatic String
LEGEND_PROPERTY_orientation
Legend item property with value of typeCustomMapControlOrientationEnum
static String
LEGEND_PROPERTY_useMarkerIcons
static String
MAP_ELEMENT_NAME
The name of map generic elements.static JRGenericElementType
MAP_ELEMENT_TYPE
The qualified type of map generic elements.static String
PARAMETER_CACHE_RENDERER
The cached image renderer.static String
PARAMETER_DEFAULT_MARKER_ICON
static String
PARAMETER_LANGUAGE
The name of the parameter that provides the map language.static String
PARAMETER_LEGEND_PROPERTIES
static String
PARAMETER_MARKERS
The name of the parameter that provides the list of marker objects for the map.static String
PARAMETER_ON_ERROR_TYPE
The name of the parameter that provides the onErrorType attribute.static String
PARAMETER_PATH_LOCATIONS
The name of the parameter that provides the path locations.static String
PARAMETER_PATHS
The name of the flag parameter that specifies paths on the mapstatic String
PARAMETER_REQ_PARAMS
The name of the parameter that provides the Google API map request parameters.static String
PARAMETER_RESET_MAP_PROPERTIES
static String
PARAMETER_ZOOM
The name of the parameter that provides the zoom factor.static String
PROPERTY_CLIENT_ID
static String
PROPERTY_DEFAULT_MARKER_ICON
static String
PROPERTY_GOOGLE_VERSION
static String
PROPERTY_KEY
static String
PROPERTY_PREFIX
static String
PROPERTY_SIGNATURE
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description JRExpression
getAddressExpression()
Returns aJRExpression
representing the address of the map center.MapImageTypeEnum
getImageType()
Returns the image format of the map.JRExpression
getLanguageExpression()
Returns aJRExpression
representing the language for the labels on the map.JRExpression
getLatitudeExpression()
Returns aJRExpression
representing the latitude coordinate of the map centerItem
getLegendItem()
JRExpression
getLongitudeExpression()
Returns aJRExpression
representing the longitude coordinate of the map centerMapScaleEnum
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.Boolean
getMarkerClustering()
List<ItemData>
getMarkerDataList()
Deprecated.Replaced bygetMarkerItemDataList()
.List<MarkerItemData>
getMarkerItemDataList()
Returns a list ofMarkerItemData
objects representing collections of markers on the mapBoolean
getMarkerSpidering()
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 ofItemData
objects representing collections of paths on the mapList<ItemData>
getPathStyleList()
Returns a list ofItemData
objects representing collections of path styles for the mapItem
getResetMapItem()
JRExpression
getZoomExpression()
Returns a numeric expression representing the zoom factor of the map.-
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable
clone
-
Methods inherited from interface net.sf.jasperreports.engine.JREvaluation
getEvaluationGroup, getEvaluationTime
-
-
-
-
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_GOOGLE_VERSION
static final String PROPERTY_GOOGLE_VERSION
- See Also:
- Constant Field Values
-
PROPERTY_DEFAULT_MARKER_ICON
static final String PROPERTY_DEFAULT_MARKER_ICON
- See Also:
- Constant Field Values
-
ATTRIBUTE_MAP_TYPE
static final String ATTRIBUTE_MAP_TYPE
The attribute that provides the map type. Possible values are:- roadmap (default)
- satellite
- terrain
- hybrid
- See Also:
- Constant Field Values
-
ATTRIBUTE_ON_ERROR_TYPE
static final String ATTRIBUTE_ON_ERROR_TYPE
Applies to static maps only. This attribute specifies the behavior of the engine when the image is not available. Possible values are:- Error (default)
- Blank
- Icon
- See Also:
- Constant Field Values
-
ATTRIBUTE_MAP_SCALE
static final String ATTRIBUTE_MAP_SCALE
Numeric (positive integer) attribute that provides the scale value used to return higher-resolution map images when working with high resolution screens available on mobile devices. Possible values are:- 1 (default)
- 2
- 4 (for Business customers only)
- See Also:
- Constant Field Values
-
ATTRIBUTE_IMAGE_TYPE
static final String ATTRIBUTE_IMAGE_TYPE
This attribute represents the image format of the map. Possible values are:- png (default)
- png8
- png32
- gif
- jpg
- jpg-baseline
- See Also:
- Constant Field Values
-
ATTRIBUTE_MARKER_CLUSTERING
static final String ATTRIBUTE_MARKER_CLUSTERING
boolean attribute that specifies whether to group markers into clusters or not; optional.- See Also:
- Constant Field Values
-
ATTRIBUTE_MARKER_SPIDERING
static final String ATTRIBUTE_MARKER_SPIDERING
boolean attribute that specifies whether to "spider-ify" overlapping markers or not; optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_latitude
static final String ITEM_PROPERTY_latitude
Numeric floating-point value representing the latitude of the place on the map; required if no equivalentITEM_PROPERTY_address
is set. Applies to items inmarkerData
andpathData
.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_longitude
static final String ITEM_PROPERTY_longitude
Numeric floating-point value representing the longitude of the place on the map; required if no equivalentITEM_PROPERTY_address
is set. Applies to items inmarkerData
andpathData
.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_address
static final String ITEM_PROPERTY_address
Specifies the address of a given point on the map. The address-based geo-location is considered only if noITEM_PROPERTY_latitude
andITEM_PROPERTY_longitude
properties are set. Applies to items inmarkerData
andpathData
.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_name
static final String ITEM_PROPERTY_name
String value representing the name, as unique identifier. Applies to items inpathData
andpathStyle
. It is required for items inpathStyle
and optional for items inpathData
. Default name for items inpathData
isDEFAULT_PATH_NAME
.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_style
static final String ITEM_PROPERTY_style
String value representing the name of a path style (inpathData
) or the name of the parent style (inpathStyle
); optional. Applies to items inpathData
andpathStyle
. If not provided, the path will be generated using Google default style settings for paths.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_clickable
static final String ITEM_PROPERTY_clickable
boolean value that specifies if this item (marker or path) is clickable; optional. Default value is true. Applies to items inmarkerData
andpathStyle
.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_draggable
static final String ITEM_PROPERTY_draggable
boolean value that specifies if this item (marker or path) is draggable; optional. Default value is false. Applies to items inmarkerData
andpathStyle
.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_visible
static final String ITEM_PROPERTY_visible
boolean value that specifies if this item (marker or path) is visible on the map; optional. Default value is true. Applies to items inmarkerData
andpathStyle
.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_zIndex
static final String ITEM_PROPERTY_MARKER_zIndex
Integer value representing the z index of this item (marker or path); optional. Applies to items inmarkerData
andpathStyle
.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_title
static final String ITEM_PROPERTY_MARKER_title
String value representing the tooltip for the marker icon; optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_url
static final String ITEM_PROPERTY_MARKER_url
String value representing a link to a page or document that will be open when the marker is clicked on; optional.
-
ITEM_PROPERTY_MARKER_target
static final String ITEM_PROPERTY_MARKER_target
String value representing the hyperlink target for the marker; optional. Allowed values are:- _blank (default)
- _parent
- _self
- _top
- a valid window/frame name
- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_color
static final String ITEM_PROPERTY_MARKER_color
Optional String value representing the color for the default pin icons. This property is taken into account whenITEM_PROPERTY_MARKER_ICON_url
property is not set. Its value may represent:- one of the predefined color names in the following list (see also ColorEnum):
- black
- blue
- cyan
- darkGray
- gray
- green
- lightGray
- magenta
- orange
- pink
- red(default)
- yellow
- white
- a valid color hex code (prefixed by #). For instance: #0000FF.
- the color RGB value.
- See Also:
- Constant Field Values
- one of the predefined color names in the following list (see also ColorEnum):
-
ITEM_PROPERTY_MARKER_label
static final String ITEM_PROPERTY_MARKER_label
String value representing the label for the default pin icons; optional. This property is taken into account whenITEM_PROPERTY_MARKER_ICON_url
property is not set.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_cursor
static final String ITEM_PROPERTY_MARKER_cursor
String value representing the cursor value; optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_size
static final String ITEM_PROPERTY_MARKER_size
Predefined String value representing the default marker icon size; optional. This property is considered for static maps only. Allowed values are:- mid
- tiny
- small
- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_flat
static final String ITEM_PROPERTY_MARKER_flat
boolean value that specifies if the marker icon is flat; optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_optimized
static final String ITEM_PROPERTY_MARKER_optimized
boolean value that specifies if the marker icon is optimized; optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_raiseOnDrag
static final String ITEM_PROPERTY_MARKER_raiseOnDrag
boolean value to be applied for the raiseOnDrag property; optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_icon
static final String ITEM_PROPERTY_MARKER_icon
String value representing the URL where the marker icon is loaded from; optional. This property is overridden by theITEM_PROPERTY_MARKER_ICON_url
property value.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_ICON_url
static final String ITEM_PROPERTY_MARKER_ICON_url
String value representing the URL where the marker icon is loaded from; optional. When is set, it overrides the value ofITEM_PROPERTY_MARKER_icon
property. If not set, a default google pin icon will be loaded.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_ICON_width
static final String ITEM_PROPERTY_MARKER_ICON_width
Integer value representing the icon width, in pixels. To be considered,ITEM_PROPERTY_MARKER_ICON_height
must be also set. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_ICON_height
static final String ITEM_PROPERTY_MARKER_ICON_height
Integer value representing the icon height, in pixels. To be considered,ITEM_PROPERTY_MARKER_ICON_width
must be also set. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_ICON_ORIGIN_x
static final String ITEM_PROPERTY_MARKER_ICON_ORIGIN_x
Integer value representing the horizontal position of the marker icon within a sprite, if any, in pixels. Default value is 0. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_ICON_ORIGIN_y
static final String ITEM_PROPERTY_MARKER_ICON_ORIGIN_y
Integer value representing the vertical position of the marker icon within a sprite, if any, in pixels. Default value is 0. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_ICON_ANCHOR_x
static final String ITEM_PROPERTY_MARKER_ICON_ANCHOR_x
Integer value representing the horizontal position to anchor the marker icon with respect to the location of the marker on the map. Default value is 0. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_ICON_ANCHOR_y
static final String ITEM_PROPERTY_MARKER_ICON_ANCHOR_y
Integer value representing the vertical position to anchor the marker icon with respect to the location of the marker on the map. Default value is 0. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_shadow
static final String ITEM_PROPERTY_MARKER_shadow
String value representing the URL where the custom marker shadow icon is loaded from; optional. This property is overridden byITEM_PROPERTY_MARKER_SHADOW_url
.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_SHADOW_url
static final String ITEM_PROPERTY_MARKER_SHADOW_url
String value representing the URL where the custom marker shadow icon is loaded from; optional. When is set, it overrides the value of theITEM_PROPERTY_MARKER_shadow
property.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_SHADOW_width
static final String ITEM_PROPERTY_MARKER_SHADOW_width
Integer value representing the shadow icon width, in pixels. To be considered,ITEM_PROPERTY_MARKER_SHADOW_height
must be also set. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_SHADOW_height
static final String ITEM_PROPERTY_MARKER_SHADOW_height
Integer value representing the shadow icon height, in pixels. To be considered,ITEM_PROPERTY_MARKER_SHADOW_width
must be also set. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_SHADOW_ORIGIN_x
static final String ITEM_PROPERTY_MARKER_SHADOW_ORIGIN_x
Integer value representing the horizontal position of the shadow icon within a sprite, if any, in pixels. Default value is 0. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_SHADOW_ORIGIN_y
static final String ITEM_PROPERTY_MARKER_SHADOW_ORIGIN_y
Integer value representing the vertical position of the shadow icon within a sprite, if any, in pixels. Default value is 0. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_SHADOW_ANCHOR_x
static final String ITEM_PROPERTY_MARKER_SHADOW_ANCHOR_x
Integer value representing the horizontal position to anchor the shadow icon with respect to the location of the marker on the map. Default value is 0. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_SHADOW_ANCHOR_y
static final String ITEM_PROPERTY_MARKER_SHADOW_ANCHOR_y
Integer value representing the vertical position to anchor the shadow icon with respect to the location of the marker on the map. Default value is 0. This property is optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_INFOWINDOW_content
static final String ITEM_PROPERTY_MARKER_INFOWINDOW_content
String value representing the content to be displayed in an info window; optional. Empty contents are not processed. When a marker icon is clicked on the map, additional information can be displayed either in a separate window/frame or in an info window floating above the map. If bothITEM_PROPERTY_MARKER_url
and info window settings are present in a marker definition, the info window takes precedence over the marker URL. Clicking on the marker icon will open the info window.- See Also:
ITEM_PROPERTY_MARKER_url
, Constant Field Values
-
ITEM_PROPERTY_MARKER_INFOWINDOW_pixelOffset
static final String ITEM_PROPERTY_MARKER_INFOWINDOW_pixelOffset
Optional integer value representing the offset (in pixels) from the tip of the info window to the location on which the info window is anchored. Default value is 0.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_INFOWINDOW_maxWidth
static final String ITEM_PROPERTY_MARKER_INFOWINDOW_maxWidth
Optional integer value representing the maximum width in pixels of the info window.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_INFOWINDOW_latitude
static final String ITEM_PROPERTY_MARKER_INFOWINDOW_latitude
Optional floating-point value representing the latitude used to determine the info window position on the map. Neglected for info windows attached to markers.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_MARKER_INFOWINDOW_longitude
static final String ITEM_PROPERTY_MARKER_INFOWINDOW_longitude
Optional floating-point value representing the longitude used to determine the info window position on the map. Neglected for info windows attached to markers.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_STYLE_isPolygon
static final String ITEM_PROPERTY_STYLE_isPolygon
Flag that specifies whether the path is a polygon; optional. Default value: false.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_STYLE_strokeWeight
static final String ITEM_PROPERTY_STYLE_strokeWeight
Numeric integer value representing the stroke weight; optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_STYLE_strokeColor
static final String ITEM_PROPERTY_STYLE_strokeColor
The color of the stroke; optional. Can be represented as #-prefixed HTML color code or as predefined HTML color name- See Also:
- Constant Field Values
-
ITEM_PROPERTY_STYLE_strokeOpacity
static final String ITEM_PROPERTY_STYLE_strokeOpacity
Numeric floating-point value in [0..1] representing the opacity of the path stroke; optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_STYLE_fillColor
static final String ITEM_PROPERTY_STYLE_fillColor
String value representing the color of the fill; optional. Can be represented as #-prefixed HTML color code or as predefined HTML color name- See Also:
- Constant Field Values
-
ITEM_PROPERTY_STYLE_fillOpacity
static final String ITEM_PROPERTY_STYLE_fillOpacity
Numeric floating-point value in [0..1] representing the opacity of the path fill; optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_STYLE_editable
static final String ITEM_PROPERTY_STYLE_editable
Flag that specifies if the path is editable; optional.- See Also:
- Constant Field Values
-
ITEM_PROPERTY_STYLE_geodesic
static final String ITEM_PROPERTY_STYLE_geodesic
Flag that specifies if the path is geodesic; optional.- See Also:
- Constant Field Values
-
LEGEND_OR_RESET_MAP_PROPERTY_enabled
static final String LEGEND_OR_RESET_MAP_PROPERTY_enabled
Legend or resetMap item property with value ofBoolean
or booleanString
that specifies if the legend or the resetMap is enabled Configurable individually for each legend or resetMap item
Defaults tofalse
or"false"
- See Also:
- Constant Field Values
-
LEGEND_OR_RESET_MAP_PROPERTY_position
static final String LEGEND_OR_RESET_MAP_PROPERTY_position
Legend or resetMap item property with value of typeCustomMapControlPositionEnum
ForlegendItem
it defaults toCustomMapControlPositionEnum.RIGHT_CENTER
ForresetMapItem
it defaults toCustomMapControlPositionEnum.RIGHT_TOP
- See Also:
- Constant Field Values
-
LEGEND_OR_RESET_MAP_PROPERTY_label
static final String LEGEND_OR_RESET_MAP_PROPERTY_label
Legend or resetMap item property with value of typeString
that specifies the label ForELEMENT_LEGEND_ITEM
it defaults to "Legend"
ForELEMENT_RESET_MAP_ITEM
it defaults to "Reset map"- See Also:
- Constant Field Values
-
LEGEND_PROPERTY_orientation
static final String LEGEND_PROPERTY_orientation
Legend item property with value of typeCustomMapControlOrientationEnum
Defaults toVERTICAL
- See Also:
- Constant Field Values
-
LEGEND_PROPERTY_legendMaxWidth
static final String LEGEND_PROPERTY_legendMaxWidth
Legend item property with value of typeString
that specifies the legend maximum width in pixels when in non-fullscreen mode Defaults to "100px"- See Also:
- Constant Field Values
-
LEGEND_PROPERTY_legendMaxWidth_fullscreen
static final String LEGEND_PROPERTY_legendMaxWidth_fullscreen
Legend item property with value of typeString
that specifies the legend maximum width in pixels when in fullscreen mode Defaults to "150px"- See Also:
- Constant Field Values
-
LEGEND_PROPERTY_legendMaxHeight
static final String LEGEND_PROPERTY_legendMaxHeight
Legend item property with value of typeString
that specifies the legend maximum height in pixels when in non-fullscreen mode Defaults to "150px"- See Also:
- Constant Field Values
-
LEGEND_PROPERTY_legendMaxHeight_fullscreen
static final String LEGEND_PROPERTY_legendMaxHeight_fullscreen
Legend item property with value of typeString
that specifies the legend maximum height in pixels when in fullscreen mode Defaults to "300px"- See Also:
- Constant Field Values
-
LEGEND_PROPERTY_useMarkerIcons
static final String LEGEND_PROPERTY_useMarkerIcons
Legend item property with value ofBoolean
or booleanString
that specifies if the legend series should use marker icons or not Defaults totrue
or"true"
- See Also:
- Constant Field Values
-
ELEMENT_MARKER_DATA
static final String ELEMENT_MARKER_DATA
- See Also:
- Constant Field Values
-
ELEMENT_LEGEND_ITEM
static final String ELEMENT_LEGEND_ITEM
- See Also:
- Constant Field Values
-
ELEMENT_RESET_MAP_ITEM
static final String ELEMENT_RESET_MAP_ITEM
- 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
-
MAP_ELEMENT_NAME
static final String MAP_ELEMENT_NAME
The name of map generic elements.- See Also:
- Constant Field Values
-
MAP_ELEMENT_TYPE
static final JRGenericElementType MAP_ELEMENT_TYPE
The qualified type of map generic elements.
-
PARAMETER_ON_ERROR_TYPE
static final String PARAMETER_ON_ERROR_TYPE
The name of the parameter that provides the onErrorType attribute.- See Also:
- Constant Field Values
-
PARAMETER_MARKERS
static final String PARAMETER_MARKERS
The name of the parameter that provides the list of marker objects for the map.- See Also:
- Constant Field Values
-
PARAMETER_LEGEND_PROPERTIES
static final String PARAMETER_LEGEND_PROPERTIES
- See Also:
- Constant Field Values
-
PARAMETER_RESET_MAP_PROPERTIES
static final String PARAMETER_RESET_MAP_PROPERTIES
- See Also:
- Constant Field Values
-
PARAMETER_LANGUAGE
static final String PARAMETER_LANGUAGE
The name of the parameter that provides the map language.- See Also:
- Constant Field Values
-
PARAMETER_ZOOM
static final String PARAMETER_ZOOM
The name of the parameter that provides the zoom factor.- See Also:
- Constant Field Values
-
PARAMETER_CACHE_RENDERER
static final String PARAMETER_CACHE_RENDERER
The cached image renderer.- See Also:
- Constant Field Values
-
PARAMETER_REQ_PARAMS
static final String PARAMETER_REQ_PARAMS
The name of the parameter that provides the Google API map request parameters.- See Also:
- Constant Field Values
-
PARAMETER_PATHS
static final String PARAMETER_PATHS
The name of the flag parameter that specifies paths on the map- See Also:
- Constant Field Values
-
PARAMETER_PATH_LOCATIONS
static final String PARAMETER_PATH_LOCATIONS
The name of the parameter that provides the path locations.- See Also:
- Constant Field Values
-
PARAMETER_DEFAULT_MARKER_ICON
static final String PARAMETER_DEFAULT_MARKER_ICON
- See Also:
- Constant Field Values
-
DEFAULT_LATITUDE
static final Float DEFAULT_LATITUDE
-
DEFAULT_LONGITUDE
static final Float DEFAULT_LONGITUDE
-
DEFAULT_ZOOM
static final Integer DEFAULT_ZOOM
-
DEFAULT_MAP_TYPE
static final MapTypeEnum DEFAULT_MAP_TYPE
-
DEFAULT_ON_ERROR_TYPE
static final OnErrorTypeEnum DEFAULT_ON_ERROR_TYPE
-
DEFAULT_PATH_NAME
static final String DEFAULT_PATH_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
getLatitudeExpression
JRExpression getLatitudeExpression()
Returns aJRExpression
representing the latitude coordinate of the map center- Returns:
- the latitude expression
-
getLongitudeExpression
JRExpression getLongitudeExpression()
Returns aJRExpression
representing the longitude coordinate of the map center- Returns:
- the longitude expression
-
getAddressExpression
JRExpression getAddressExpression()
Returns aJRExpression
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 aJRExpression
representing the language for the labels on the map.- Returns:
- the language expression
-
getMapType
MapTypeEnum getMapType()
Returns the type of the Google map. Possible values are:- 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:- 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:- Returns:
- the onErrorType attribute
- See Also:
OnErrorTypeEnum
-
getMarkerClustering
Boolean getMarkerClustering()
- Returns:
- the
ATTRIBUTE_MARKER_CLUSTERING
attribute
-
getMarkerSpidering
Boolean getMarkerSpidering()
- Returns:
- the
ATTRIBUTE_MARKER_SPIDERING
attribute
-
getMarkerItemDataList
List<MarkerItemData> getMarkerItemDataList()
Returns a list ofMarkerItemData
objects representing collections of markers on the map- Returns:
- a list of marker data
- See Also:
ItemData
-
getMarkerDataList
List<ItemData> getMarkerDataList()
Deprecated.Replaced bygetMarkerItemDataList()
.
-
getLegendItem
Item getLegendItem()
-
getResetMapItem
Item getResetMapItem()
-
getPathStyleList
List<ItemData> getPathStyleList()
Returns a list ofItemData
objects representing collections of path styles for the map- Returns:
- a list of path styles
- See Also:
ItemData
-
-