Oracle Maps HTML5 JavaScript API Reference

 
Class: MarkerLayer

OM.layer. MarkerLayer

new MarkerLayer(layerName)

This class extends vector layer to display points of interest using markers.

Parameters:
Name Type Description
layerName String

The name of the layer to be created
Returns:

An instance of OM.layer.MarkerLayer

Type
OM.layer.MarkerLayer

Extends

Methods

addFeature(feature)

Add a feature to the layer.

Parameters:
Name Type Description
feature OM.Feature

The feature to add
Inherited From:
Returns:
Type
void

addFeatures(features)

Add a feature array to the layer. If the map is displayed, these
features will not be displayed immediately. Call redraw to show them.

Parameters:
Name Type Description
features Array

The feature array
Inherited From:
Returns:
Type
void

addMapMarker(mapmarker)

Add a map marker to the marker layer

Parameters:
Name Type Description
mapmarker Object

The OM.MapMarker instance to be added into the layer.
Returns:
Type
void

addMapMarkers(mapmarkers)

Add an array of map markers to the marker layer

Parameters:
Name Type Description
mapmarkers Array

The array of OM.MapMarker instances to be added into the layer.
Returns:
Type
void

addSecondaryStyle(style)

Add a secondary style to vector layer. A secondary style is typically
a marker or pie/bar chart style that is to be displayed on a feature that's already
being rendered using a (primary) style. If no primary style is set (via the
setRenderingStyle method) the behaviour of secondary style is not defined.

in one vector layer.

Parameters:
Name Type Description
style OM.style.Style

The added style
Inherited From:
Returns:
Type
void

applyFilter(filter, replace)

Apply a relational filter to layer. A filtered layer will be returned. According to the replace parameter, the filtered
layer may replace the existing layer or as a new layer.

Parameters:
Name Type Description
filter OM.filter.Filter

The filter to be applied
replace Boolean

If replace is true, then the original layer is removed and
replaced with the result layer; If replace is false, the original
layer is kept, and the result is returned as a new layer. Default is false.
Inherited From:
Returns:

The filtered layer. According to the replace paramter, this retured layer could be either
the same layer with the filter applied or a new layer with the filter applied on the original layer.

Type
OM.layer.VectorLayer

bringForward()

Bring the layer to the front by one step (closer to the top of the map).

Inherited From:
Returns:

The new z-index

Type
int

bringSelectedFeaturesToTop()

Gets all the selected features to the top.

Inherited From:
Returns:
Type
void

bringToTop()

Bring the layer all the way to the top of the map

Inherited From:
Returns:

The new z-index

Type
int

centerToTheme()

Center the map to the theme's center point. It automatically pans the map so that it is centered
at the center of the theme's minimum bounding box.

Inherited From:
Returns:

None

clearSelectedFeatures()

Clear all currently selected features. All features are then displayed
with the default rendering style.

Inherited From:
Returns:
Type
void

deHover(the)

This method removes the hover effect from a given feature

Parameters:
Name Type Description
the OM.Feature

feature to be dehovered
Inherited From:
Returns:

none

deselectFeature(feature)

Unhighlight/de-select a feature;

Parameters:
Name Type Description
feature OM.Feature

The feature to be deselected
Inherited From:
Returns:

The deselected feature object

Type
OM.Feature

deselectFeatures()

since version 12.2.1.3
de-select the already selected features
Note, in the current architecture, an event on a graphics (DOM component) is
processed first in fortknox. Later, the event pops up to the Map object.
Regardless a mouse event (e.g. a click) hits a feature within the vector layer(s), it always eventually
be bubbled up to the Map object. In a no-hit case, if there are any already selected
vector features in a previous click/selection, they need to be de-selected.
But if the event hit features, then the layer has taken care of the de-select and then select.

Inherited From:

enableClustering()

Enable client side clustering for point features.

Parameters:
Name Type Description
enable. Boolean

Whether to enable point clustering.
options. Object

An object that specifies various clustering options.


  • threshold {int} The cluster radius in pixesl. Default value is 30 (i.e. points within 30 pixels of each other will be
    aggregated into a cluster)

  • clusterStyle {OM.style.Style} The cluster feature rendering style

  • minPointCount {int} Enable clustering if the number of features in cluster is
    greater than or equal to this value.

  • maxClusteringLevel: {int} Enable clustering if current zoom level is less than or equal to
    this value

  • enableZoomIn: {boolean} Enable/disable default zoom in behavior when click on a cluster marker.
    By default, it's enabled.

  • zoomInLevels: {int} this parameter determines map zoom in levels when click on a cluster marker.
    By default, mapviewer will calculate a proper zoom level to zoom into.

  • clickBehavior: {String} two options, either 'zoom' or 'select', default is 'zoom'
    For 'zoom', a mouse-click on a cluster feature will trigger a zoom-in process to zoom into the cluster features' MBR.
    For 'select', this cluster will be selected.
Inherited From:

enableDisplayInBatch()

Enable client side batch loading for a vector layer

Parameters:
Name Type Description
enable. Boolean

Whether to enable batch loading.
options. Object

An object that specifies two batch loading parameters.


  • interval {int} The interval between batch loading

  • numberInBatch {int} The loading batch size

Inherited From:
Returns:

None

enableEditingMenuContext(enabled)

Enables or not the showing of editing menu context (applies to when layer is in edit mode)

Parameters:
Name Type Description
enabled boolean

if set to true. Default value is true.
Inherited From:

enableFeatureEditing(enable)

Enable or disable feature editing.

Parameters:
Name Type Description
enable Boolean

Enable or disable feature editing
Inherited From:
Returns:
Type
Boolean

enableFeatureHover(enable)

Enable or disable the feature hover effect.

Parameters:
Name Type Description
enable boolean

Enable (when true) or disable (when false) the feature hover effect
Inherited From:
Returns:
Type
void

enableFeatureSelection(enable, mode)

Enable (if true) or disable (if false) feature selection, and set the selection mode.

Parameters:
Name Type Description
enable boolean

Enable (when true) or disable (when false) feature selection
mode int

optional If feature selection is enabled, the selection mode can be either
OM.layer.VectorLayer.SINGLE_SELECTION (i.e. only one feature at a time can be selected)
or OM.layer.VectorLayer.MULTIPLE_SELECTION (i.e. multiple features can be selected).
The default value is OM.layer.VectorLayer.SINGLE_SELECTION.
Inherited From:
Returns:
Type
void

enableIndicatorFeatures()

This method enables or disables "indicator features" on this layer. An indicator
feature is simply a box or rectangle representing a (polygon-type)
feature that is too small to be labeled. Indicator features share the same
attributes and selection/mouse-over behaviour as the main features. Once
enabled, the layer will automatically generate/remove indicator features as
needed.

Parameters:
Name Type Description
enable. Boolean

Whether to enable indicator feautres.
options. Object

Various properties for indicator features, listed below.


  • leadLine {Boolean} Whether to display the lead lines. Default value is false

  • maxIndicators {int} maximum number of indicator features allowed. Default value is 8

  • enabledZoomLevels {Object} It can have two properties: min and max.

  • indicatorSize{Object} indicator feature size in pixel. It can have two properties: width and height. Default
    size is 40*30

  • position {OM.geometry.Point} Specifies the starting position
    (upper-left corner) of the area
    where indicator features are to be
    displayed
Inherited From:
Returns:
Type
void

enableInfoWindow(enable)

Enable or disable the feature info window.

Parameters:
Name Type Description
enable boolean

Enable or disable feature info window. By default,
the info window is enabled.
Inherited From:
Returns:
Type
void

enableToolTip(enable)

Set whether the features in this layer will display a tool tip on mouse over.
Tool tip is enabled by default.

Parameters:
Name Type Description
enable boolean

if set to false, no tooltip will be displayed for this layer.
Inherited From:
Returns:
Type
void

getAllFeatures()

Get all features in this layer. Each element in the returned array is an
instance of OM.Feature.

Inherited From:
Returns:

All features in the layer.

Type
Array

getAttributeNames()

Get all attributes names for the features.

Inherited From:
Returns:

An array of attributes names;

Type
Array

getAttributeType(name)

Gets the the specified attribute type.

Parameters:
Name Type Description
name String

the name of the attribute to be returned.
Inherited From:
Returns:

the type 9"string", "double", ...) for the given attribute,
or null if no attribute type with the given name was found.

Type
Object

getEnableInfoWindow()

get the enable infowindow status: true for enabled and false otherwise
the info window is enabled.

Inherited From:
Returns:

true or false

Type
boolean

getExtent()

Get the layer's minimum bounding rectangle (MBR) by combining all the MBRs of
its geometries.

Inherited From:
Returns:

The layer MBR

Type
OM.geometry.Rectangle

getFeature(id)

Get the OM.Feature object with specified ID.

Parameters:
Name Type Description
id string

A string that uniquely identifies the feature object.
Inherited From:
Returns:

The feature with the specified ID if it exists, null otherwise.

Type
OM.Feature

getFeatureGeometryType()

Get the geometry type for all the features in this theme.
It can be "POLYGON", "LINESTRING" or "POINT".

Inherited From:
Returns:

The geometry type

Type
string

getFeaturesByAttribute(attrName, attrValues)

Given an attribute name and one or more values, find all the features in this layer
that have a matching value for that attribute or property.
The attribute name must be in the list returned by calling getAttributeNames().
The attribute values can be passed either as an array, or a
regular expression (to be implemented).

Parameters:
Name Type Description
attrName String

the name of the attribute
attrValues Array | regEx

an array or a regular expression
Inherited From:
Returns:

an array of the features with the given value; or null if none
was found.

Type
Array

getHoverStyle()

Get the onHover style for a feature.

Inherited From:
Returns:

The hover style object

Type
OM.style.Style

getLabelColumn()

Gets the currently set labeling column name

Inherited From:
Returns:

The labeling column name

Type
String

getLabelingStyle()

Get the labeling style

Inherited From:
Returns:

The labeling style object

Type
OM.style.Style

getName()

Get the layer name.

Inherited From:
Returns:

The layer name

Type
String

getOpacity()

Get the layer's current opacity setting.

Inherited From:
Returns:

The layer's opacity. Is a value between 0 and 1.

Type
float

getPointerSensitivity()

Gets the current pointer sensitivity.

Inherited From:
Returns:

[description]

Type
boolean

getRenderingStyle()

Get the rendering style.

Inherited From:
Returns:

The rendering style object

Type
OM.style.Style

getSelectedFeatures()

Get the selected Features (array of OM.Feature).

Inherited From:
Returns:

The currently selected features

Type
Array

getSelectionChecker()

Inherited From:
Returns:

currently set feature selection checker.

getSelectionMode()

Returns the current feature selection mode.

Inherited From:
Returns:

the current selection mode, which is either OM.layer.VectorLayer.SINGLE_SELECTION or
OM.layer.VectorLayer.MULTIPLE_SELECTION.

Type
String

getSelectStyle()

Get the highlight style for user selected features.

Inherited From:
Returns:

The highlight style object

Type
OM.style.Style

getSelectVisualFilter()

Get the currently set visual filter for selected features.

Inherited From:
Returns:

The visual filter

Type
OM.visualfilter.VisualFilter

getVisualFilter()

Get the current visual filter for the whole layer.

Inherited From:
Returns:

The current visual filter

Type
OM.visualfilter.VisualFilter

getZIndex()

Get the layer's z-index.

Inherited From:
Returns:

The z-index value. Returns -1 if the layer was not added to the map.

Type
int

hasSharedBoundary()

Returns if adjacent boundaries share "common" vertexes when editing.
If true some vertexes operations (add, remove and move) will be applied to
the base feature and other features that "shares" the boundary.

Inherited From:
Returns:

true or false

Type
booelan

hover(the)

This method shows the hover effect on a feature;

Parameters:
Name Type Description
the OM.Feature

feature to be hovered
Inherited From:
Returns:

the feature being hovered over

isClusterSelectable()

Note: when a vector layer has clustering enabled and 'clickBehavior' set to 'select', then
this layer's clusters are selectable.

Inherited From:
Returns:

True if clusters are selectable, false otherwise

Type
Boolean

isDisplayFeaturesTaskEnabled()

Returns if contribution to the display task bar status is set when displaying this layer features.

Inherited From:
Returns:
Type
boolean

isEditingMenuContextEnabled()

Returns id editing menu context showing is enabled (applies to when layer is in edit mode)

Inherited From:
Returns:

true or false

Type
booelan

isFeatureEditable()

Check if features are editable.

Inherited From:
Returns:

True, if the features are editable, false if not.

Type
Boolean

isInZoomLevelRange(curLevel)

Checks if the current map zoom level is within this layer's visible zoom-level range.

Parameters:
Name Type Description
curLevel int

Optional, the zoom level to check if it is within the minVisibleLevel and maxVisibleLevel
range. If not specified, then the current zoom level is used.
Inherited From:
Returns:

true if the current map level is within the layer's zoom level range for
it to be visible.

Type
Boolean

isVisible(curLevel)

Get the visibility of the layer.

Parameters:
Name Type Description
curLevel int

Optional, the zoom level to check if it is within the minVisibleLevel and maxVisibleLevel
range. If not specified, then the current zoom level is used.
Inherited From:
Returns:

True if the theme-based FOI layer is currently visible,
False if the theme-based FOI layer is currently not visible

Type
Boolean

labelsVisible()

Check if feature labels will be rendered, i.e. should be visible.

Inherited From:
Returns:

true (features labels visible) or false (feature labels not visible).

Type
Boolean

on()

A shorthand name for the member function addListener.

Inherited From:
Mixes In:

removeAllFeatures()

Removes all features from a layer

Inherited From:
Returns:

The number of features removed

Type
int

removeFeature(feature)

Removes a feature from the layer

Parameters:
Name Type Description
feature OM.Feature

The feature to remove
Inherited From:
Returns:

The feature, if found in the layer, else returns null.

Type
OM.Feature

removeMapMarker(mapmarker)

Remove a map marker from the marker layer

Parameters:
Name Type Description
mapmarker OM.MapMarker

The OM.MapMarker instance to be removed from the layer.
Returns:
Type
void

removeSecondaryStyle(style)

Remove a specified secondary style from the vector layer.

Parameters:
Name Type Description
style OM.style.Style

The secondary style to remove
Inherited From:
Returns:
Type
void

saveEditing(call)

Save current data editing (Predefined or JDBC layer types).
Check logging for additonal information related this method execution.

Parameters:
Name Type Description
call function

back function name that can be used to get the return value (true or false).
function saveCallBack(result)
{
if(OM.notNull(result))
{
// result can be true or false //alert("Save result: " + result);
}
} 

            // application code
            layer.saveEditing(saveCallBack);
            //
Inherited From:

selectFeature(feature)

Highlight a feature using its selection style. Valid only when
feature selection is enabled.

Parameters:
Name Type Description
feature OM.Feature

The feature to be selected
Inherited From:
Returns:

The selected feature object

Type
OM.Feature

selectFeatureByFilter(filter)

Highlight features that pass the specified filter

Parameters:
Name Type Description
filter OM.filter.Filter

The specified filter
Inherited From:
Returns:
Type
void

sendBackward()

Sendthe layer to the back by one step (closer to the bottom of the map).

Inherited From:
Returns:

The new z-index

Type
int

sendToBottom()

Send the layer all the way to the bottom of the map

Inherited From:
Returns:

The new z-index

Type
int

setBoundingTheme(flag)

Specify whether this theme is a bounding theme.

Parameters:
Name Type Description
flag Boolean

True, if it is a bounding theme, false if not.
Inherited From:
Returns:
Type
void

setBringToTopOnMouseOver(flag)

Specify whether to bring feature images to the top of the map when the mouse
moves over features in the layer. By default, a feature image will be
brought to the top on hover or mouseover..

Parameters:
Name Type Description
flag boolean

True, bring feature images to the top, or false otherwise
(i.e. do not bring feature images to the top).
Inherited From:
Returns:
Type
void

setDisplayFeaturesTaskEnabled()

Enables or not the contribution to the display task bar status when displaying this layer features.

Inherited From:
Returns:
Type
void

setHoverStyle(style)

Set the onHover style for a feature.

Parameters:
Name Type Description
style OM.style.Style

The hover style
Inherited From:
Returns:
Type
void

setKeepSelected(enable)

If set to true, clicking on a feature that is already selected will keep it selected.
The default value is false, meaning clicking on a selected feature will un-select it.

Parameters:
Name Type Description
enable boolean

flag indicating whether to keep features selected on mouse clicks.
Inherited From:

setLabelColumn(col)

Sets the attribute column whose value is used for the labels.

Parameters:
Name Type Description
col String

The attribute column name
Inherited From:
Returns:
Type
void

setLabelingStyle(style)

Set the labeling style. Usually a text or a marker style.

Parameters:
Name Type Description
style OM.style.Style

The new labeling style
Inherited From:
Returns:
Type
void

setLabelsVisible(visible)

Specify whether or not to render feature labels. The default value is false

Parameters:
Name Type Description
visible Boolean

If true, render feature labels. If false, do not render them.
Inherited From:
Returns:
Type
void

setMouseCursorStyle(cursorStyle)

This method sets the mouse cursor style when the mouse is over a feature of this
vector layer.
To set a non-standard cursor using a custom image, you can pass in a json object
specifying these properties:

<UL>
<LI> src : the URL of the cusor image in PNG or GIT format
<LI> hotspotX :  the hotspot x offset relative to the image coordinates
<LI> hotspotY : the hotspot y offset relative to the image coordinates
</UL>
Parameters:
Name Type Description
cursorStyle String

A string that specifies the cursor style to
be used, which must be one of the standard CSS cursor style names
such as "crosshair", "pointer" and "move".
Inherited From:
Returns:

None

setMultiFeatureMarker(marker)

Set mult feature marker. The marker will be used when multi marker features
are the same location.

Parameters:
Name Type Description
marker OM.style.Marker

marker style
Inherited From:
Returns:
Type
void

setName(newName)

Set the layer name with the given name.

Parameters:
Name Type Description
newName String

The new layer name to be assigned to this layer.
Inherited From:
Returns:
Type
None

setNSDP(nsdp)

Set the Non-Spatial Data Provider for the vector layer.

Parameters:
Name Type Description
nsdp Object

The Non-Spatial Data Provider object containing info needed
by the FOI server to join Non-Spatial data and the associated layer's spatial table.
It has these attributes.


  • keyColumn {String}. Required. The column to match non-spatial data with
    spatial data (e.g. 'iso_country_code' or 'state_abbrv').

  • xml {String}. Optional. The non-spatial data in the nsdp xml format

  • json {String}. Optional. The non-spatial data in the nsdp JSON format

  • keyAttr {String}. Optional. Ihe attribute is used to match with spatial data when non-spatial
    data is JSON format.

  • url {String}. Optional. A URL for non-spatial data.

  • fullDisplay {Boolean}. Optional. Whether to display all spatial features (i.e. fullDisplay:true) or
    only those features which match the supplied keyColumn values in the NSDP document (i.e. fullDisplay:false).
    Default value is false. Only matching features are displayed

  • ignoreCase {Boolean}. Optional. Use case-insensitive (if true) or case-sensitive (if false) matching.
    Default value is true.


Inherited From:
Returns:
Type
void

setOpacity(opacity)

Set the layer's opacity. A value between 0 (transparnet) and 1 (opaque).

Parameters:
Name Type Description
opacity float

It should be a number between 0 and 1. e.g. 0.5 means 50% opacity.
Inherited From:
Returns:
Type
void

setPartialSelectStyleForCluster(style)

Set the highlight style for partially selected cluster features.
Re-clustering process can be triggered by a zoom in or zoom out, and a newly formed cluster
may contain a collection of features that a portion of the whole collection is repviously selected.
For example, if a new cluster contains 5 features and 2 of them were previously selecte, then this
cluster is a partially selected cluster. From another perspective, if cluster is clicked, it is fully
selected (it if has not been selected), or it is deselected (if it has been selected).

Parameters:
Name Type Description
style OM.style.Style

The highlight style
Inherited From:
Returns:
Type
void

setPointerSensitivity(enabled)

Sets the vector layer's sensitivity to mouse pointer events. By default a vector layer
will always respond to mouse pointer events, thus preventing any layer behind it
from doing so. If set to false, then it will let mouse pointer events pass through without
responding to it.

Parameters:
Name Type Description
enabled boolean

if set to false, then this vector layer will not handle mouse pointer
events. Default is always set to true.
Inherited From:

setQueryParameters(vararg)

This method sets the query parameters for the vector layer that is based on
a templated predefined theme. The number of parameters is corresponding to
the theme definition. Each parameter can be a number, a string, a OM.geometry.Geometry
object, or a JSON object with these properties:value, type and sqlType.

Parameters:
Name Type Description
vararg

a list of parameters corresponding to the required number of binding
variables in the predefined theme
Inherited From:
Returns:
Type
void

setRenderingStyle(style, attributes)

Set the layer's rendering style.

Parameters:
Name Type Description
style OM.style.Style

The new rendering style
attributes Array

The list of attribute names used to determine the actual rendering style.
It is effective only when renderingStyle is an advanced style.
Inherited From:
Returns:
Type
void

setSelectionChecker(checkerFunc)

Sets a custom function that checks if a feature should be selectable.
This provides application with a finer level of control on a feature by feature basis
when the layer itself allows selections. One use case is to disable user from being
able to select/highlight features that have no measure data associated.

The custom function should expect an instance of the OM.Feature class, and should
return a boolean value indicating whether the feature is selectable. Return true
if the feature can be selected, and false if it should not be selected.

This function is always called just prior to a feature is going to be selected.

Parameters:
Name Type Description
checkerFunc function

a function that is passed in the feature to be selected.
Inherited From:

setSelectStyle(style)

Set the highlight style for user selected features.

Parameters:
Name Type Description
style OM.style.Style

The highlight style
Inherited From:
Returns:
Type
void

setSelectVisualFilter(filter)

Set the visual filter (such as drop shadow) to be applied to
currently selected features.

Parameters:
Name Type Description
filter OM.visualfilter.VisualFilter

The visual effect to use
Inherited From:
Returns:
Type
void

setSharedBoundary(true)

Sets if adjacent boundaries should share "common" vertexes when editing.
If true some vertexes operations (add, remove and move) will be applied to
the base feature and other features that "shares" the boundary.

Parameters:
Name Type Description
true booelan

or false
Inherited From:

setToolTipCustomizer(customizer)

Set a tool tip customizer function on this layer. Use this function
to return a customized tool-tip text for the features.

If no customizer function is set, then the tooltip is based on the label
text set on each feature.

Parameters:
Name Type Description
customizer function

The tool tip customizer function. The function
should expect a single OM.Feature object as parameter.
Inherited From:
Returns:
Type
void

setVisible(visibility)

Sets the visibility of the layer.
Note that the visibility change will NOT be made if the current map zoom level is
outside the layer's 'visible zoom level range' which is set by setZoomLevelRange() method.

Parameters:
Name Type Description
visibility Boolean

A Boolean true (show the layer, i.e. make it visible) or false
(hide the layer).
Inherited From:
Returns:

void}

Type
None

setVisibleBound(bound)

Set a bound (MBR) for the layer visibility. Only content within the supplied bound will be rendered.
That is, the map client will only fetch and display map content within this bound.

Parameters:
Name Type Description
bound OM.geometry.Rectangle

Specifies the layer boundary
Inherited From:
Returns:
Type
void

setVisualFilter(filter)

Set the visual filter (such as drop-shadow) to be applied for all
the features in this layer.

Parameters:
Name Type Description
filter OM.visualfilter.VisualFilter

The visual effect to use
Inherited From:
Returns:
Type
void

setZIndex()

Set the z-index for the layer.

Note: A valid layer z-index should be a number between 1 and n, where n is
the number of layers that are currently displayed in the map. When the newIndex
parameter of setZIndex is less than 1, it will be set to 1. If it is
greater than n, it will be set to n. If z-Index value, newIndex, is already assigned
to another layer, then it will still be assigned to the current layer (on which this function is invoked).
One or more of the other layer will be assigned a different z-index value. The changes will depend on
whether this layer was inserted into the current layer stack or just moved within the layer stack.

Inherited From:
Returns:

The old z-index

Type
int

setZoomLevelRange(minLevel, maxLevel)

Set the zoom level range within which this layer is visible. By default
a layer is set to be visible between a minmum zoom level of 0 and a maximum
(theoretical) zoom level of 100.

Parameters:
Name Type Description
minLevel int

Specifies the min level. The layer will not be
visible if the zoom level is lower than this vlaue.
maxLevel int

Specifies the max level. The layer will not be
visible if the zoom level is higher than this value.
Inherited From:
Returns:
Type
None

size()

Get the count of the number of features in this layer.

Inherited From:
Returns:

The count of the number of features

Type
int

zoomToTheme()

Zoom to the theme's full extent. It automatically adjusts the map center and zoom level so that all
theme features can be displayed inside the map window.

Inherited From:
Returns:
Type
void