Geoportal SDK 2D/3D API Reference

Namespace: MarkerOptions

Gp.MarkerOptions

Specific 2D options

Marker options object.

Holds options for marker to display on the map at startup. To be used for map creation (See markersOptions property of Gp.MapOptions object used as a parameter of Gp.Map.load() function).

Available options to define a marker are described below.

Properties:
Name Type Argument Default Description
position Object <optional>
map center

Geographical position of the marker. If none, map center will be used.

Properties
Name Type Argument Default Description
x Float

x coordinates for position

y Float

y coordinates for position

projection String <optional>
map projection

srs center coordinates

content String

Content displayed in the popup when clicking on the marker. HTML is supported.

contentType String <optional>
"text/html"

MimeType of Content displayed in the popup.

url String <optional>
<default lightOrange marker>

Icon URL used to materialize the marker.

offset Array.<Number> <optional>
[-25.5, -38]

Offsets in pixels used when positioning the marker towards targeted point. The first element in the array is the horizontal offset. A positive value shifts the marker right. The second element in the array is the vertical offset. A positive value shifts the marker down. Default is offset associated to default marker image.

ppoffset Array.<Number> <optional>
[0,-15]

Offsets in pixels used when positioning the popup towards click. The first element in the array is the horizontal offset. A positive value shifts the popup right. The second element in the array is the vertical offset. A positive value shifts the popup down. Default value ([0, -15]) fits with default popup positioning.

autoPanOptions Gp.AutoPanOptions

Defines autoPan options for popups.