UIComponent class: oracle.adf.view.faces.bi.component.geoMap.UIGeoMap
Component type: oracle.dss.adf.geoMap.GeoMap
The map supports the display of business data on a geographic map with multiple layers of information as theme. The map supports ColorTheme, BarGraphTheme, PieGraphTheme, PointTheme and Predefined Theme.
Each theme represents a layer of information, and the data is abstracted in an instanceof oracle.adf.view.faces.bi.model.GeoMapDataModel.
The inlineStyle attribute can be used to specify a map's width and height. For example, inlineStyle="width:600px;height:400px" or inlineStyle="width:100%;height:400px".
This component can have the following children:
| Type | Phases | Description |
|---|---|---|
| oracle.adf.view.faces.bi.event.MapSelectionEvent | Apply Request Values | SelectionEvent will be fired when the user finished defining a selected region on the map, or when the user unselected the region. Users can use the rectangle tool, circle tool, polygon tool, or point tool to select a region, and users can right click on the map to unselect the region |
| org.apache.myfaces.trinidad.event.AttributeChangeEvent | Invoke Application, Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
| Name | Description |
|---|---|
| popup | The popup facet for left click. It usually contains a dialog or a panelWindow |
| rtPopup | The popup facet for right click. It usually contains a menu |
| Name | Type | Supports EL? | Description |
|---|---|---|---|
| attributeChangeListener | javax.el.MethodExpression | Only EL | a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
| autoZoomStrategy | String | Yes | This attribute determines how the map will adjust the center and zoom level. Valid values are:
|
| autoZoomThemeId | String | Yes | Specifies the id of the theme where the map will use to set its center and zoom level when the map starts. If the autoZoomStrategy is MAXZOOM, the map will zoom down to the maximum level where all objects in the theme is visible. If the autoZoomStrategy is CENTERATZOOMLEVEL, the map will center on the theme, and will use the value in the mapZoom attribute as the starting zoom level. |
| baseMapName | String | Yes | Specifies the name of the baseMap for the map. The name is in the form of data-source-name.cache-instance-name. Cache-instance-name specifes the name of the map cache instance, and data-source-name specifies the name of the MapViewer data source. Refer to mapviewer's documentation for detail. |
| binding | String | Only EL | Binding reference to store the UIGeoMap component |
| copyrightText | String | Yes | Specifies the copyright text of the map. |
| customizationId | String | Yes | The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document. |
| hybridBaseMapName | String | Yes | Specifies the name of the baseMap for the hybrid image map. The name is in the same format as baseMapName. |
| id | String | No | the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|
| inlineStyle | String | Yes | Specifies the inline style of the map's outer DOM element. It can be used to control the size/position, or background color of the map. |
| mapServerConfigId | String | Yes | Specifies the name of the configuration file that contains the URLs for remote map server and geocoded server |
| mapZoom | int | Yes | Specifies the beginning zoom level of the map. The zoom levels are defined in the map cache instance as part of the base map. |
| partialTriggers | String | Yes | Specifies the ids of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. |
| rendered | boolean | Yes | Specifies whether the component is rendered |
| satelliteBaseMapName | String | Yes | Specifies the name of the baseMap for the satellite image map. The name is in the same format as baseMapName. |
| selectionFillColor | String | Yes | Specifies the fill color for the selected region when users make selection on a colorTheme, barGraphTheme and pieGraphTheme, using the rectangle tool, circle tool, polygon tool or point tool on the mapToolbar.. Valid values are RGB hexadecimal. For example, color="#000000" for black. The default value is #49E0F6 |
| selectionListener | String | Yes | a method reference to a selection listener Refers to a backing bean method that takes MapSelectionEvent as an argument The MapSelectionEvent contains the information on the selected region. Sample code: public void processSelection(MapSelectionEvent mapSelectionEvent) { Iterator iterator = mapSelectionEvent.getIterator(); while (iterator.hasNext()) { DataContent dt = (DataContent)iterator.next(); String selectedLocation = dt.getLocationName(); System.out.println (selectedLocation); } } |
| selectionOpacity | int | Yes | Specifies the opacity of the fill color for the selected region when users make selection on a colorTheme, barGraphTheme and pieGraphTheme, using the rectangle tool, circle tool, polygon tool or point tool on the mapToolbar. Valid values are 0 to 100. 0 means 100% transparent, and 100 means no transparency. The default value is 40. |
| selectionStrokeColor | String | Yes | Specifies the stroke color for the selected region when users make selection on a colorTheme, barGraphTheme and pieGraphTheme, using the rectangle tool, circle tool, polygon tool or point tool on the mapToolbar. Valid values are RGB hexadecimal. For example, color="#000000" for black. The default value is #000000 |
| showInfoArea | boolean | Yes | Specifies whether the user can show the information area on the map or not. The default value is true. |
| showScaleBar | boolean | Yes | Specifies whether to show the scale bar on the map or not. The default value is false. |
| srid | String | Yes | Specifies the srid (spatial reference id) of all the coordinates of the map, which includes the center of the map - which defined by starting X and startingY - and all the points in the point theme. Refer to Oracle Spatial documentation for all the valid values and their meaning. The default value is 8307. For mercator projection, the value is 54004. |
| startingX | double | Yes | Specifies the X coordinate of the center of the map. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute assumes that its value is the longitude of the center of the map. |
| startingY | double | Yes | Specifies the Y coordinate of center of the map. The srid for the coordinate is specified in the srid attribute. If the srid attribute is not specified, this attribute assumes that its value is the latitude of the center of the map. |
| styleClass | String | Yes | Sets a CSS style class to use for this component. |
| unit | String | Yes | Specifies the unit of measurement in the information area.
|
| zoomBarPosition | String | Yes | Specifies the position of the zoomBar in the map. Valid values are:
|