Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MapObject defines an object to be displayed on the map.

Properties that define one or more pixel values (symbolPath, symbolSize, labelPosition, etc...) are expressed in 96 DPI pixels.

Hierarchy

  • MapObject

Index

Constructors

Properties

color: Color

The point or line color of the map object

fillColor: Color

The fill color of the map object (used when spatialArea is provided or as fill color for a symbol)

label: string

The label of the map object
This label is placed at the center of the spatial point, line or area.

labelColor: Color

The color of the label font

labelFontName: string

The name of the label font

labelFontSize: number

The size of the label font

labelPosition: Coordinate

The position offset of the label, expressed in pixels.

lineWidth: number

The line width for spatial lines or areas

objectId: string

The identifier of the map object

objectType: string

The type of map object

properties: AMap<string>

A map of object properties.
In case of a map object whose MapObject.objectType value equals MapObject.TYPE_FOV, the following properties are available : viewId,renderMode,pan,tilt,fov.

resourceId: string

The identifier of the resource this map object belongs to

spatialArea: CoordinatePath

The spatial area

spatialLine: CoordinatePath

The spatial line

spatialPoint: Coordinate

The spatial point

symbolName: string

The symbol name to use.
Any symbol available in the DefaultSymbols Orbit Symbol Library can be used.
For more information about the DefaultSymbols library, see Point Legend, Orbit Symbol Library.
Note: Only used if symbolPath is not defined.

symbolPath: CoordinatePath

The symbol path to use as a symbol for this object.
The symbol path is expressed in pixels, relative to the center of the object.

symbolSize: number

The symbol size to use.
Note: Only applies to symbolName or symbolUrl.

symbolUrl: string

The symbol URL to use.
Note: Only used if symbolName and symbolPath are not defined.

TYPE: string = "M"

The type of objects in this class

TYPE_FOOTPRINT: string = "footprint"

The type of footprint map objects

TYPE_FOV: string = "fov"

The type of field-of-view map objects

TYPE_GLOBAL: string = "global"

The type of global map objects

TYPE_MEASUREMENT: string = "measurement"

The type of measurement map objects

TYPE_VECTOR: string = "vector"

The type of vector map objects (points,lines,areas)

Methods

  • Create a copy of this instance.

    Returns MapObject

    returns a copy.

  • toString(): string
  • Convert the object to a string.

    Returns string

    the string form of the object.