Overview
Overview
Getting Started
Examples
Our demo site
Layers Overview
Product Versions
Support
Maps
Map
OverviewMap
Layers
Layer
LayersCollection
LayersManager
VectorLayer
LocalVectorLayer
RemoteVectorLayer
Overlay
TileOverlay
Shapes
Shape
Marker
Circle
Poly
Polygon
Polyline
Icons
Icon
ExternalIcon
RectangleIcon
CircleIcon
Geocode
LBS
LBS
Users
Social
Messages
Locations
POIs
Alerts
ResponseStatus
Search
Search
SearchRequest
SettingsRequest
Route
Route
RouteVectorLayer
Points
Coordinate
LatLong
Miscellaneous
AdminAreas
Alert
AppSubscription
AutoSuggest
Billing
Bounds
BrushStyle
Category
ContextMenu
Definitions
EventListener
Geometry
Group
LineStyle
Location
Maneuver
MapSize
Media
Placemark
Poi
Presence
Rule
ScreenPoint
SimpleData
SMSInfo
User
Index
Everything
Functions
Variables

Shape

The Shape class is used to define a shape (Marker, Polygon, Polyline, Circle) to be drawn on the map.
In order to add any shape on the map you should add the shape object to the map’s LayersManager object.

See on the examples page Use shapes -> Add polygon to map

Summary
Shape
The Shape class is used to define a shape (Marker, Polygon, Polyline, Circle) to be drawn on the map.
In order to add any shape on the map you should add the shape object to the map’s LayersManager object.

Constructors
Shape
The Shape constructor.
Methods
getHint
Returns the hint of the shape.
getLabel
Returns the label of the shape.
getType
Returns the shape type.
hide
Hides the shape from the map.
hideLabel
Hides the label of the shape.
isLabelVisible
Returns true if the label of the shape is visible, or false if the label is invisible.
isVisible
Returns true if the shape is visible, or false if the shape is invisible.
redraw
Redraw the shape.
setHint
Sets a new hint to the shape.
setLabel
Sets a new label to the shape.
show
Shows the shape above the map.
showLabel
Shows the label of the shape.
Shape Types
Shape. MARKER
A Marker type.
Shape. POLYGON
A Polygon type.
Shape. POLYLINE
A Polyline type.
Shape. CIRCLE
A Circle type.

Constructors

Shape

Shape()

The Shape constructor.

Methods

getHint

string getHint()

Returns the hint of the shape.

Returns

The hint of the shape.

See Also

setHint, setLabel, getLabel

getLabel

string getLabel()

Returns the label of the shape.

Returns

The label of the shape.

See Also

setLabel, setHint, getHint

getType

Shape Types getType()

Returns the shape type.

Returns

The shape type.

hide

hide()

Hides the shape from the map.

See Also

show

hideLabel

hideLabel()

Hides the label of the shape.

See Also

showLabel

isLabelVisible

boolean isLabelVisible()

Returns true if the label of the shape is visible, or false if the label is invisible.

Returns

True if the label of the shape is visible.

See Also

showLabel, hideLabel

isVisible

boolean isVisible()

Returns true if the shape is visible, or false if the shape is invisible.

Returns

True if the shape is visible.

See Also

show, hide

redraw

redraw()

Redraw the shape.

setHint

setHint(string hint)

Sets a new hint to the shape.

Parameters

hintA new hint to the shape.

See Also

getHint, setLabel, getLabel

setLabel

setLabel(string label)

Sets a new label to the shape.

Parameters

labelA new label to the shape.

See Also

getLabel, setHint, getHint

show

show()

Shows the shape above the map.

See Also

hide

showLabel

showLabel()

Shows the label of the shape.

See Also

hideLabel

Shape Types

Shape. MARKER

Shape.MARKER

A Marker type.

Shape. POLYGON

Shape.POLYGON

A Polygon type.

Shape. POLYLINE

Shape.POLYLINE

A Polyline type.

Shape. CIRCLE

Shape.CIRCLE

A Circle type.
Inheritance: Layer > LayersCollection > LayersManager
Shape()
The Shape constructor.
redraw()
Redraw the shape.
Shape Types getType()
Returns the shape type.
show()
Shows the shape above the map.
hide()
Hides the shape from the map.
boolean isVisible()
Returns true if the shape is visible, or false if the shape is invisible.
setHint(string hint)
Sets a new hint to the shape.
string getHint()
Returns the hint of the shape.
setLabel(string label)
Sets a new label to the shape.
string getLabel()
Returns the label of the shape.
showLabel()
Shows the label of the shape.
hideLabel()
Hides the label of the shape.
boolean isLabelVisible()
Returns true if the label of the shape is visible, or false if the label is invisible.
Shape.MARKER
A Marker type.
Shape.POLYGON
A Polygon type.
Shape.POLYLINE
A Polyline type.
Shape.CIRCLE
A Circle type.