Class MVFOIGroup
MVFOIGroup defines a group of user defined FOI(MVFOI) objects. All FOI objects of the group can be added together to the map through MVMapView#addFOIGroup. The visiblity of these FOI objects can be control through #setVisible.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
MVFOIGroup(foiArray)
|
| Method Attributes | Method Name and Description |
|---|---|
|
addFOI(foi)
This method adds one MVFOI object to the group.
|
|
|
addFOIs(foiArray)
This method adds a bulk of MVFOI objects to the group.
|
|
|
clearAll()
This method removes all MVFOI objects from the group and the map.
|
|
|
enableMultiFeatureMarker(enabled)
This methods sets whether to enable multi-feature markers.
|
|
|
refresh()
This method redraw all MVFOI objects of the group.
|
|
|
removeFOI(foi)
This method removes a MVFOI object from the group.
|
|
|
setMaxVisibleZoomLevel(maxZoom)
This method sets the maximum zoom level at which the layer is enabled and visible.
|
|
|
setMinVisibleZoomLevel(minZoom)
This method sets the minimum zoom level at which the layer is enabled and visible.
|
|
|
setVisible(visible)
This method sets the visibility of the group of MVFOI objects.
|
|
|
setZIndex(idx)
This method sets the z-index (display order) value of the FOI group.
|
Class Detail
MVFOIGroup(foiArray)
- Parameters:
- {Array} foiArray
- array of MVFOIs that need to be grouped.
- Returns:
- The newly created FOI Group object.
Method Detail
{void}
addFOI(foi)
This method adds one MVFOI object to the group. If the map has already been
displayed, the added point will be added and become visible instantly on
the map.
- Parameters:
- {object} foi
- FOI object that specifies the user-defined FOI to be added to the map.
- Returns:
- None
{void}
addFOIs(foiArray)
This method adds a bulk of MVFOI objects to the group. It does not automatically
display the added MVFOI objects to the map. The application needs to call refresh
to update the map.
- Parameters:
- {Array} foiArray
- array of MVFOIs that need to be grouped.
- Returns:
- None
{void}
clearAll()
This method removes all MVFOI objects from the group and the map.
- Returns:
- None
{void}
enableMultiFeatureMarker(enabled)
This methods sets whether to enable multi-feature markers. A multi-feature marker
represents multiple point FOIs that are located at the exactly same location. When you
click or move mouse over such a marker, the list of FOIs will be displayed in a popup
window.
- Parameters:
- {Boolean} enabled
- true (enable multi-feature markers) or false (disable multi-feature markers).
- {Object} options.
- An object that that may have up to three attributes, style, listHeight and listWidth. style specifies the multi-feature marker style. listHeight and listWidth specify the max size of the popup window.
- Returns:
- None
{void}
refresh()
This method redraw all MVFOI objects of the group.
If the map has not been initialized, this method will do nothing.
- Returns:
- None
{void}
removeFOI(foi)
This method removes a MVFOI object from the group. If the map has already been
displayed, the point will be removed from the map instantly.
- Parameters:
- {object} foi
- FOI object that specifies the user-defined FOI to be added to the map.
- Returns:
- None
{void}
setMaxVisibleZoomLevel(maxZoom)
This method sets the maximum zoom level at which the layer is enabled and visible.
The FOI group will be disabled and hidden whenever the map is zoomed in beyond
the maximum visible zoom level (map zoom level is greater than the maximum
visible zoom level).
- Parameters:
- {int} maxZoom
- maxZoom is a integer that specifies the maximum zoom level.
- Returns:
- None
{void}
setMinVisibleZoomLevel(minZoom)
This method sets the minimum zoom level at which the layer is enabled and visible.
The FOI group will be disabled and hidden whenever the map is zoomed out beyond
the minimum visible zoom level (map zoom level is less than the minimum
visible zoom level).
- Parameters:
- {int} minZoom
- minZoom is a integer that specifies the minimum zoom level.
- Returns:
- None
{void}
setVisible(visible)
This method sets the visibility of the group of MVFOI objects.
- Parameters:
- {Boolean} visible
- true (make the FOI group visible) or false (make the FOI group not visible).
- Returns:
- None
{void}
setZIndex(idx)
This method sets the z-index (display order) value of the FOI group. The group
with a larger z-index value is displayed above the group with a smaller z-index
value.
- Parameters:
- {int} idx
- an integer value between 1-999.
- Returns:
- None