public interface MapComponent extends Component, JRCloneable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTRIBUTE_IMAGE_TYPE
This attribute represents the image format of the map.
|
static java.lang.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 java.lang.String |
ATTRIBUTE_MAP_TYPE
The attribute that provides the map type.
|
static java.lang.String |
ATTRIBUTE_ON_ERROR_TYPE
Applies to static maps only.
|
static java.lang.Float |
DEFAULT_LATITUDE |
static java.lang.Float |
DEFAULT_LONGITUDE |
static MapTypeEnum |
DEFAULT_MAP_TYPE |
static OnErrorTypeEnum |
DEFAULT_ON_ERROR_TYPE |
static java.lang.String |
DEFAULT_PATH_NAME |
static java.lang.Integer |
DEFAULT_ZOOM |
static java.lang.String |
ELEMENT_MARKER_DATA |
static java.lang.String |
ELEMENT_PATH_DATA |
static java.lang.String |
ELEMENT_PATH_STYLE |
static java.lang.String |
ITEM_PROPERTY_address
Specifies the address of a given point on the map.
|
static java.lang.String |
ITEM_PROPERTY_clickable
boolean value that specifies if this item (marker or path) is clickable; optional.
|
static java.lang.String |
ITEM_PROPERTY_draggable
boolean value that specifies if this item (marker or path) is draggable; optional.
|
static java.lang.String |
ITEM_PROPERTY_latitude
Numeric floating-point value representing the latitude of the place on the map;
required if no equivalent
ITEM_PROPERTY_address is set. |
static java.lang.String |
ITEM_PROPERTY_longitude
Numeric floating-point value representing the longitude of the place on the map;
required if no equivalent
ITEM_PROPERTY_address is set. |
static java.lang.String |
ITEM_PROPERTY_MARKER_color
Optional String value representing the color for the default pin icons.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_cursor
String value representing the cursor value; optional.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_flat
boolean value that specifies if the marker icon is flat; optional.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_icon
String value representing the URL where the marker icon is loaded from; optional.
|
static java.lang.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 java.lang.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 java.lang.String |
ITEM_PROPERTY_MARKER_ICON_height
Integer value representing the icon height, in pixels.
|
static java.lang.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 java.lang.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 java.lang.String |
ITEM_PROPERTY_MARKER_ICON_url
String value representing the URL where the marker icon is loaded from; optional.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_ICON_width
Integer value representing the icon width, in pixels.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_INFOWINDOW_content
String value representing the content to be displayed in an info window; optional.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_INFOWINDOW_latitude
Optional floating-point value representing the latitude used to determine the info window position on the map.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_INFOWINDOW_longitude
Optional floating-point value representing the longitude used to determine the info window position on the map.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_INFOWINDOW_maxWidth
Optional integer value representing the maximum width in pixels of the info window.
|
static java.lang.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 java.lang.String |
ITEM_PROPERTY_MARKER_label
String value representing the label for the default pin icons; optional.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_optimized
boolean value that specifies if the marker icon is optimized; optional.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_raiseOnDrag
boolean value to be applied for the raiseOnDrag property; optional.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_shadow
String value representing the URL where the custom marker shadow icon is loaded from; optional.
|
static java.lang.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 java.lang.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 java.lang.String |
ITEM_PROPERTY_MARKER_SHADOW_height
Integer value representing the shadow icon height, in pixels.
|
static java.lang.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 java.lang.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 java.lang.String |
ITEM_PROPERTY_MARKER_SHADOW_url
String value representing the URL where the custom marker shadow icon is loaded from; optional.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_SHADOW_width
Integer value representing the shadow icon width, in pixels.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_size
Predefined String value representing the default marker icon size; optional.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_target
String value representing the hyperlink target for the marker; optional.
|
static java.lang.String |
ITEM_PROPERTY_MARKER_title
String value representing the tooltip for the marker icon; optional.
|
static java.lang.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 java.lang.String |
ITEM_PROPERTY_MARKER_zIndex
Integer value representing the z index of this item (marker or path); optional.
|
static java.lang.String |
ITEM_PROPERTY_name
String value representing the name, as unique identifier.
|
static java.lang.String |
ITEM_PROPERTY_style
String value representing the name of a path style (in
pathData ) or the name of the
parent style (in pathStyle ); optional. |
static java.lang.String |
ITEM_PROPERTY_STYLE_editable
Flag that specifies if the path is editable; optional.
|
static java.lang.String |
ITEM_PROPERTY_STYLE_fillColor
String value representing the color of the fill; optional.
|
static java.lang.String |
ITEM_PROPERTY_STYLE_fillOpacity
Numeric floating-point value in [0..1] representing the opacity of the path fill; optional.
|
static java.lang.String |
ITEM_PROPERTY_STYLE_geodesic
Flag that specifies if the path is geodesic; optional.
|
static java.lang.String |
ITEM_PROPERTY_STYLE_isPolygon
Flag that specifies whether the path is a polygon; optional.
|
static java.lang.String |
ITEM_PROPERTY_STYLE_strokeColor
The color of the stroke; optional.
|
static java.lang.String |
ITEM_PROPERTY_STYLE_strokeOpacity
Numeric floating-point value in [0..1] representing the opacity of the path stroke; optional.
|
static java.lang.String |
ITEM_PROPERTY_STYLE_strokeWeight
Numeric integer value representing the stroke weight; optional.
|
static java.lang.String |
ITEM_PROPERTY_visible
boolean value that specifies if this item (marker or path) is visible on the map; optional.
|
static java.lang.String |
MAP_ELEMENT_NAME
The name of map generic elements.
|
static JRGenericElementType |
MAP_ELEMENT_TYPE
The qualified type of Flash generic elements.
|
static java.lang.String |
PARAMETER_CACHE_RENDERER
The cached image renderer.
|
static java.lang.String |
PARAMETER_LANGUAGE
The name of the parameter that provides the map language.
|
static java.lang.String |
PARAMETER_MARKERS
The name of the parameter that provides the list of marker objects for the map.
|
static java.lang.String |
PARAMETER_ON_ERROR_TYPE
The name of the parameter that provides the onErrorType attribute.
|
static java.lang.String |
PARAMETER_PATH_LOCATIONS
The name of the parameter that provides the path locations.
|
static java.lang.String |
PARAMETER_PATHS
The name of the flag parameter that specifies paths on the map
|
static java.lang.String |
PARAMETER_REQ_PARAMS
The name of the parameter that provides the Google API map request parameters.
|
static java.lang.String |
PARAMETER_ZOOM
The name of the parameter that provides the zoom factor.
|
static java.lang.String |
PROPERTY_CLIENT_ID |
static java.lang.String |
PROPERTY_KEY |
static java.lang.String |
PROPERTY_PREFIX |
static java.lang.String |
PROPERTY_SIGNATURE |
static java.lang.String |
PROPERTY_VERSION |
Modifier and Type | Method and Description |
---|---|
JRExpression |
getAddressExpression()
Returns a
JRExpression
representing the address of the map center. |
java.lang.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() . |
java.util.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.
|
java.util.List<ItemData> |
getPathDataList()
Returns a list of
ItemData objects
representing collections of paths on the map |
java.util.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.
|
clone
static final java.lang.String PROPERTY_PREFIX
static final java.lang.String PROPERTY_KEY
static final java.lang.String PROPERTY_CLIENT_ID
static final java.lang.String PROPERTY_SIGNATURE
static final java.lang.String PROPERTY_VERSION
static final java.lang.String ATTRIBUTE_MAP_TYPE
static final java.lang.String ATTRIBUTE_ON_ERROR_TYPE
static final java.lang.String ATTRIBUTE_MAP_SCALE
static final java.lang.String ATTRIBUTE_IMAGE_TYPE
static final java.lang.String ITEM_PROPERTY_latitude
ITEM_PROPERTY_address
is set.
Applies to items in markerData
and pathData
.static final java.lang.String ITEM_PROPERTY_longitude
ITEM_PROPERTY_address
is set.
Applies to items in markerData
and pathData
.static final java.lang.String ITEM_PROPERTY_address
ITEM_PROPERTY_latitude
and ITEM_PROPERTY_longitude
properties are set.
Applies to items in markerData
and pathData
.static final java.lang.String ITEM_PROPERTY_name
pathData
and pathStyle
. It is required for items in pathStyle
and optional for items in pathData
. Default name for items in pathData
is DEFAULT_PATH_NAME
.static final java.lang.String ITEM_PROPERTY_style
pathData
) or the name of the
parent style (in pathStyle
); optional.
Applies to items in pathData
and pathStyle
.
If not provided, the path will be generated using Google default style settings for paths.static final java.lang.String ITEM_PROPERTY_clickable
markerData
and pathStyle
.static final java.lang.String ITEM_PROPERTY_draggable
markerData
and pathStyle
.static final java.lang.String ITEM_PROPERTY_visible
markerData
and pathStyle
.static final java.lang.String ITEM_PROPERTY_MARKER_zIndex
markerData
and pathStyle
.static final java.lang.String ITEM_PROPERTY_MARKER_title
static final java.lang.String ITEM_PROPERTY_MARKER_url
static final java.lang.String ITEM_PROPERTY_MARKER_target
static final java.lang.String ITEM_PROPERTY_MARKER_color
ITEM_PROPERTY_MARKER_ICON_url
property is not set. Its value may represent:
static final java.lang.String ITEM_PROPERTY_MARKER_label
ITEM_PROPERTY_MARKER_ICON_url
property is not set.static final java.lang.String ITEM_PROPERTY_MARKER_cursor
static final java.lang.String ITEM_PROPERTY_MARKER_size
static final java.lang.String ITEM_PROPERTY_MARKER_flat
static final java.lang.String ITEM_PROPERTY_MARKER_optimized
static final java.lang.String ITEM_PROPERTY_MARKER_raiseOnDrag
static final java.lang.String ITEM_PROPERTY_MARKER_icon
ITEM_PROPERTY_MARKER_ICON_url
property value.static final java.lang.String ITEM_PROPERTY_MARKER_ICON_url
ITEM_PROPERTY_MARKER_icon
property.
If not set, a default google pin icon will be loaded.static final java.lang.String ITEM_PROPERTY_MARKER_ICON_width
ITEM_PROPERTY_MARKER_ICON_height
must be also set.
This property is optional.static final java.lang.String ITEM_PROPERTY_MARKER_ICON_height
ITEM_PROPERTY_MARKER_ICON_width
must be also set.
This property is optional.static final java.lang.String ITEM_PROPERTY_MARKER_ICON_ORIGIN_x
static final java.lang.String ITEM_PROPERTY_MARKER_ICON_ORIGIN_y
static final java.lang.String ITEM_PROPERTY_MARKER_ICON_ANCHOR_x
static final java.lang.String ITEM_PROPERTY_MARKER_ICON_ANCHOR_y
static final java.lang.String ITEM_PROPERTY_MARKER_shadow
ITEM_PROPERTY_MARKER_SHADOW_url
.static final java.lang.String ITEM_PROPERTY_MARKER_SHADOW_url
ITEM_PROPERTY_MARKER_shadow
property.static final java.lang.String ITEM_PROPERTY_MARKER_SHADOW_width
ITEM_PROPERTY_MARKER_SHADOW_height
must be also set.
This property is optional.static final java.lang.String ITEM_PROPERTY_MARKER_SHADOW_height
ITEM_PROPERTY_MARKER_SHADOW_width
must be also set.
This property is optional.static final java.lang.String ITEM_PROPERTY_MARKER_SHADOW_ORIGIN_x
static final java.lang.String ITEM_PROPERTY_MARKER_SHADOW_ORIGIN_y
static final java.lang.String ITEM_PROPERTY_MARKER_SHADOW_ANCHOR_x
static final java.lang.String ITEM_PROPERTY_MARKER_SHADOW_ANCHOR_y
static final java.lang.String ITEM_PROPERTY_MARKER_INFOWINDOW_content
ITEM_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.static final java.lang.String ITEM_PROPERTY_MARKER_INFOWINDOW_pixelOffset
static final java.lang.String ITEM_PROPERTY_MARKER_INFOWINDOW_maxWidth
static final java.lang.String ITEM_PROPERTY_MARKER_INFOWINDOW_latitude
static final java.lang.String ITEM_PROPERTY_MARKER_INFOWINDOW_longitude
static final java.lang.String ITEM_PROPERTY_STYLE_isPolygon
static final java.lang.String ITEM_PROPERTY_STYLE_strokeWeight
static final java.lang.String ITEM_PROPERTY_STYLE_strokeColor
static final java.lang.String ITEM_PROPERTY_STYLE_strokeOpacity
static final java.lang.String ITEM_PROPERTY_STYLE_fillColor
static final java.lang.String ITEM_PROPERTY_STYLE_fillOpacity
static final java.lang.String ITEM_PROPERTY_STYLE_editable
static final java.lang.String ITEM_PROPERTY_STYLE_geodesic
static final java.lang.String ELEMENT_MARKER_DATA
static final java.lang.String ELEMENT_PATH_STYLE
static final java.lang.String ELEMENT_PATH_DATA
static final java.lang.String MAP_ELEMENT_NAME
static final JRGenericElementType MAP_ELEMENT_TYPE
static final java.lang.String PARAMETER_ON_ERROR_TYPE
static final java.lang.String PARAMETER_MARKERS
static final java.lang.String PARAMETER_LANGUAGE
static final java.lang.String PARAMETER_ZOOM
static final java.lang.String PARAMETER_CACHE_RENDERER
static final java.lang.String PARAMETER_REQ_PARAMS
static final java.lang.String PARAMETER_PATHS
static final java.lang.String PARAMETER_PATH_LOCATIONS
static final java.lang.Float DEFAULT_LATITUDE
static final java.lang.Float DEFAULT_LONGITUDE
static final java.lang.Integer DEFAULT_ZOOM
static final MapTypeEnum DEFAULT_MAP_TYPE
static final OnErrorTypeEnum DEFAULT_ON_ERROR_TYPE
static final java.lang.String DEFAULT_PATH_NAME
JRExpression getLatitudeExpression()
JRExpression
representing the latitude coordinate of the map centerJRExpression getLongitudeExpression()
JRExpression
representing the longitude coordinate of the map centerJRExpression getAddressExpression()
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 coordinatesJRExpression getZoomExpression()
JRExpression getLanguageExpression()
JRExpression
representing the language for the labels on the map.EvaluationTimeEnum getEvaluationTime()
java.lang.String getEvaluationGroup()
MapTypeEnum getMapType()
MapTypeEnum
MapScaleEnum getMapScale()
1
(default value)2
4
(for Business customers only)MapImageTypeEnum getImageType()
MapImageTypeEnum
OnErrorTypeEnum getOnErrorType()
OnErrorTypeEnum
java.util.List<ItemData> getMarkerDataList()
ItemData
objects
representing collections of markers on the mapItemData
java.util.List<ItemData> getPathStyleList()
ItemData
objects
representing collections of path styles for the mapItemData
java.util.List<ItemData> getPathDataList()
ItemData
objects
representing collections of paths on the mapItemData
ItemData getMarkerData()
getMarkerDataList()
.MarkerDataset getMarkerDataset()
getMarkerDataList()
.© 2001-2014 TIBCO Software Inc. www.jaspersoft.com