Interface MapComponent

    • Field Detail

      • 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 equivalent ITEM_PROPERTY_address is set.

        Applies to items in markerData and pathData.

        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 equivalent ITEM_PROPERTY_address is set.

        Applies to items in markerData and pathData.

        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 in 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.

        See Also:
        Constant Field Values
      • ITEM_PROPERTY_style

        static final 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.

        Applies to items in pathData and pathStyle.

        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 in markerData and pathStyle.

        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 in markerData and pathStyle.

        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 in markerData and pathStyle.

        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 in markerData and pathStyle.

        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_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 when ITEM_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
      • 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_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 of ITEM_PROPERTY_MARKER_icon property.

        If not set, a default google pin icon will be loaded.

        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_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 the ITEM_PROPERTY_MARKER_shadow property.

        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 both 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.

        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 of Boolean or boolean String that specifies if the legend or the resetMap is enabled

        Configurable individually for each legend or resetMap item
        Defaults to false or "false"

        See Also:
        Constant Field Values
      • LEGEND_PROPERTY_legendMaxWidth

        static final String LEGEND_PROPERTY_legendMaxWidth
        Legend item property with value of type String 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 type String 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 type String 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 type String 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 of Boolean or boolean String that specifies if the legend series should use marker icons or not

        Defaults to true or "true"

        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_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_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
      • 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
    • 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
      • 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
      • 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
      • getMarkerItemDataList

        List<MarkerItemData> getMarkerItemDataList()
        Returns a list of MarkerItemData objects representing collections of markers on the map
        Returns:
        a list of marker data
        See Also:
        ItemData
      • getLegendItem

        Item getLegendItem()
      • getResetMapItem

        Item getResetMapItem()
      • 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