Classdesc

Polygon geometry.

Param: coordinates

Coordinates.

Param: opt_layout

Layout.

Api

stable

Hierarchy

Constructors

Methods

  • Append the passed linear ring to this polygon.

    Parameters

    Returns void

    Api

    stable

  • Increases the revision counter and dispatches a 'change' event.

    Returns void

    Api

  • Make a complete copy of the geometry.

    Returns ol.geom.Polygon

    Clone.

    Api

    stable

  • Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

    Parameters

    Returns void

    Function

    Api

  • Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

    stable

  • Return the area of the polygon on projected plane.

    Returns number

    Area (on projected plane).

    Api

    stable

  • Get the coordinate array for this geometry. This array has the structure of a GeoJSON coordinate array for polygons.

    Parameters

    • Optional opt_right: boolean

      Orient coordinates according to the right-hand rule (counter-clockwise for exterior and clockwise for interior rings). If false, coordinates will be oriented according to the left-hand rule (clockwise for exterior and counter-clockwise for interior rings). By default, coordinate orientation will depend on how the geometry was constructed.

    Returns Coordinate[][]

    Coordinates.

    Api

    stable

  • Get the extent of the geometry.

    Parameters

    • Optional opt_extent: Extent

      Extent.

    Returns Extent

    extent Extent.

    Api

    stable

  • Return an interior point of the polygon.

    Returns ol.geom.Point

    Interior point.

    Api

    stable

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

    stable

  • Return the Nth linear ring of the polygon geometry. Return null if the given index is out of range. The exterior linear ring is available at index 0 and the interior rings at index 1 and beyond.

    Parameters

    • index: number

      Index.

    Returns LinearRing

    Linear ring.

    Api

    stable

  • Return the number of rings of the polygon, this includes the exterior ring and any interior rings.

    Returns number

    Number of rings.

    Api

  • Return the linear rings of the polygon.

    Returns LinearRing[]

    Linear rings.

    Api

    stable

  • Get an object of all property names and values.

    Returns {
        [k: string]: any;
    }

    Object.

    • [k: string]: any

    Api

    stable

  • Get the version number for this object. Each time the object is modified, its version number will be incremented.

    Returns number

    Revision.

    Api

  • Returns true if this geometry includes the specified coordinate. If the coordinate is on the boundary of the geometry, returns false.

    Parameters

    Returns boolean

    Contains coordinate.

    Api

  • Parameters

    Returns boolean

    Inherit Doc

    Api

    stable

  • Listen for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

    Api

    stable

  • Listen once for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

    Api

    stable

  • Rotate the geometry around a given coordinate. This modifies the geometry coordinates in place.

    Parameters

    • angle: number

      Rotation angle in radians.

    • anchor: Coordinate

      The rotation center.

    Returns void

    Abstract

    Api

  • Scale the geometry (with an optional origin). This modifies the geometry coordinates in place.

    Parameters

    • sx: number

      The scaling factor in the x-direction.

    • Optional opt_sy: number

      The scaling factor in the y-direction (defaults to sx).

    • Optional opt_anchor: Coordinate

      The scale origin (defaults to the center of the geometry extent).

    Returns void

    Abstract

    Api

  • Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

  • Set the coordinates of the polygon.

    Parameters

    Returns void

    Api

    stable

  • Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

    Parameters

    • values: {
          [k: string]: any;
      }

      Values.

      • [k: string]: any
    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

  • Create a simplified version of this geometry. For linestrings, this uses the the Douglas Peucker algorithm. For polygons, a quantization-based simplification is used to preserve topology.

    Parameters

    • tolerance: number

      The tolerance distance for simplification.

    Returns ol.geom.Geometry

    A new, simplified version of the original geometry.

    Function

    Api

  • Transform each coordinate of the geometry from one coordinate reference system to another. The geometry is modified in place. For example, a line will be transformed to a line and a circle to a circle. If you do not want the geometry modified in place, first clone() it and then use this function on the clone.

    Parameters

    Returns ol.geom.Geometry

    This geometry. Note that original geometry is modified in place.

    Api

    stable

  • Parameters

    • deltaX: number
    • deltaY: number

    Returns void

    Inherit Doc

    Api

    stable

  • Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object which was used as this by the listener.

    Returns void

    Api

    stable

  • Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Function

    Api

    stable

  • Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optional opt_silent: boolean

      Unset without triggering an event.

    Returns void

    Api

    stable

  • Create an approximation of a circle on the surface of a sphere.

    Parameters

    • sphere: Sphere

      The sphere.

    • center: Coordinate

      Center ([lon, lat] in degrees).

    • radius: number

      The great-circle distance from the center to the polygon vertices.

    • Optional opt_n: number

      Optional number of vertices for the resulting polygon. Default is 32.

    Returns ol.geom.Polygon

    The "circular" polygon.

    Api

    stable

  • Create a regular polygon from a circle.

    Parameters

    • circle: ol.geom.Circle

      Circle geometry.

    • Optional opt_sides: number

      Number of sides of the polygon. Default is 32.

    • Optional opt_angle: number

      Start angle for the first vertex of the polygon in radians. Default is 0.

    Returns ol.geom.Polygon

    Polygon geometry.

    Api

  • Create a polygon from an extent. The layout used is XY.

    Parameters

    Returns ol.geom.Polygon

    The polygon.

    Api

  • Removes an event listener using the key returned by on() or once().

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Api

    stable

Generated using TypeDoc