Interface IPolygon
- All Superinterfaces:
ICefObjectWrapper
,ICefObjRef
,IComponentMouseDragEventObject
,IEditableObject
,IOptionedMapObject<provided.mixedData.MixedDataDictionary>
,IPolyMouseEventObject
,IVisibleMapObject
- All Known Subinterfaces:
IPolygonWrapped
public interface IPolygon extends IVisibleMapObject, IEditableObject, IPolyMouseEventObject, IComponentMouseDragEventObject, IOptionedMapObject<provided.mixedData.MixedDataDictionary>
Represents a polygon drawn on the map
Corresponds to the Google Maps Javascript API google.maps.Polygon
A polygon is defined by one or more series of connected coordinates in an ordered sequence,
i.e. an IPath or IPathList of ILatLngs.
Additionally, polygons form a closed loop and define a filled region.
A polygons can be defined using multiple separate paths of points to create shapes
with holes for instance.
- Author:
- swong
-
Method Summary
Modifier and Type Method Description IPath<ILatLng>
getPath()
Retrieves the path of ILatLngs if only an IPath was used or the first IPath is an IPathList was used.IPathList<ILatLng>
getPaths()
Returns the paths for this polygon.void
setPath(IPath<ILatLng> path)
Set the path or the first path if an IPathList was used.void
setPaths(IPaths<ILatLng> paths)
Sets the path(s) of this polygonMethods inherited from interface provided.owlMaps.cefUtils.ICefObjectWrapper
addEvent, addEvent, call, callVoid, getCefId, getCefProperty, getWrappedCefObject, setCefProperty
Methods inherited from interface provided.owlMaps.mouse.IComponentMouseDragEventObject
setComponentMouseDragEvent
Methods inherited from interface provided.owlMaps.general.IEditableObject
getEditable, setEditable
Methods inherited from interface provided.owlMaps.general.IOptionedMapObject
setOptions
Methods inherited from interface provided.owlMaps.components.shapes.IPolyMouseEventObject
setPolyMouseEvent
Methods inherited from interface provided.owlMaps.general.IVisibleMapObject
getVisible, setVisible
-
Method Details
-
getPath
Retrieves the path of ILatLngs if only an IPath was used or the first IPath is an IPathList was used.- Returns:
- An IPath of ILatLngs
-
getPaths
Returns the paths for this polygon. If only one IPath was used, then an IPathList of only one IPath element is returned.- Returns:
- an IPaths of ILatLngs
-
setPath
Set the path or the first path if an IPathList was used.- Parameters:
path
- an IPath of ILatLngs
-
setPaths
Sets the path(s) of this polygon- Parameters:
paths
- An IPaths object of ILatLngs which could be either an IPath or an IPathList.
-