Class GeometryCollection

on

once

simplifyTransformedInternal

un

addChangeListener

• addChangeListener(key, listener): void

• Parameters

  • key: string

    Key name.
  • listener: Listener

    Listener.

  Returns void

addEventListener

• addEventListener(type, listener): void

• Parameters

  • type: string

    Type.
  • listener: Listener

    Listener.

  Returns void

applyTransform

• applyTransform(transformFn): void

• Apply a transform function to the coordinates of the geometry. The geometry is modified in place. If you do not want the geometry modified in place, first clone() it and then use this function on the clone.

  Parameters

  • transformFn: TransformFunction

    Transform function. Called with a flat array of geometry coordinates.

  Returns void

  Abstract

changed

• changed(): void

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

  Returns void

  Api

closestPointXY

• closestPointXY(x, y, closestPoint, minSquaredDistance): number

• Parameters

  • x: number

    X.
  • y: number

    Y.
  • closestPoint: Coordinate

    Closest point.
  • minSquaredDistance: number

    Minimum squared distance.

  Returns number

  Minimum squared distance.

  Abstract

containsXY

• containsXY(x, y): boolean

• Parameters

  • x: number

    X.
  • y: number

    Y.

  Returns boolean

  Contains (x, y).

dispatchEvent

• dispatchEvent(event): undefined | boolean

• 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

  • event: string | BaseEvent

    Event object.

  Returns undefined | boolean

  false if anyone called preventDefault on the event object or if any of the listeners returned false.

  Api

dispose

• dispose(): void

• Clean up.

  Returns void

get

• get(key): any

• Gets a value.

  Parameters

  • key: string

    Key name.

  Returns any

  Value.

  Api

getClosestPoint

• getClosestPoint(point, closestPoint?): Coordinate

• Return the closest point of the geometry to the passed point as module:ol/coordinate~Coordinate coordinate.

  Parameters

  • point: Coordinate

    Point.
  • Optional closestPoint: Coordinate

    Closest point.

  Returns Coordinate

  Closest point.

  Api

getExtent

• getExtent(extent?): Extent

• Get the extent of the geometry.

  Parameters

  • Optional extent: Extent

    Extent.

  Returns Extent

  extent Extent.

  Api

getKeys

• getKeys(): string[]

• Get a list of object property names.

  Returns string[]

  List of property names.

  Api

getListeners

• getListeners(type): undefined | Listener[]

• Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

  Parameters

  • type: string

    Type.

  Returns undefined | Listener[]

  Listeners.

getProperties

• getProperties(): {
      [x: string]: any;
  }

• Get an object of all property names and values.

  Returns {
      [x: string]: any;
  }

  Object.

  • [x: string]: any

  Api

getPropertiesInternal

• getPropertiesInternal(): null | {
      [x: string]: any;
  }

• Get an object of all property names and values.

  Returns null | {
      [x: string]: any;
  }

  Object.

getRevision

• getRevision(): number

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

  Returns number

  Revision.

  Api

getType

• getType(): Type

• Get the type of this geometry.

  Returns Type

  Geometry type.

  Abstract

hasListener

• hasListener(type?): boolean

• Parameters

  • Optional type: string

    Type. If not provided, true will be returned if this event target has any listeners.

  Returns boolean

  Has listeners.

hasProperties

• hasProperties(): boolean

• Returns boolean

  The object has properties.

intersectsCoordinate

• intersectsCoordinate(coordinate): boolean

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

  Parameters

  • coordinate: Coordinate

    Coordinate.

  Returns boolean

  Contains coordinate.

  Api

intersectsExtent

• intersectsExtent(extent): boolean

• Test if the geometry and the passed extent intersect.

  Parameters

  • extent: Extent

    Extent.

  Returns boolean

  true if the geometry and the extent intersect.

  Abstract

notify

• notify(key, oldValue): void

• Parameters

  • key: string

    Key name.
  • oldValue: any

    Old value.

  Returns void

removeChangeListener

• removeChangeListener(key, listener): void

• Parameters

  • key: string

    Key name.
  • listener: Listener

    Listener.

  Returns void

removeEventListener

• removeEventListener(type, listener): void

• Parameters

  • type: string

    Type.
  • listener: Listener

    Listener.

  Returns void

rotate

• rotate(angle, anchor): void

• 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

• scale(sx, sy?, anchor?): void

• 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 sy: number

    The scaling factor in the y-direction (defaults to sx).
  • Optional anchor: Coordinate

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

  Returns void

  Abstract

  Api

set

• set(key, value, silent?): void

• Sets a value.

  Parameters

  • key: string

    Key name.
  • value: any

    Value.
  • Optional silent: boolean

    Update without triggering an event.

  Returns void

  Api

setProperties

• setProperties(values, silent?): void

• 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: {
        [x: string]: any;
    }

    Values.

    • [x: string]: any

  • Optional silent: boolean

    Update without triggering an event.

  Returns void

  Api

simplify

• simplify(tolerance): Geometry

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

  Parameters

  • tolerance: number

    The tolerance distance for simplification.

  Returns Geometry

  A new, simplified version of the original geometry.

  Api

simplifyTransformed

• simplifyTransformed(squaredTolerance, transform?): Geometry

• Get a transformed and simplified version of the geometry.

  Parameters

  • squaredTolerance: number

    Squared tolerance.
  • Optional transform: TransformFunction

    Optional transform function.

  Returns Geometry

  Simplified geometry.

  Abstract

transform

• transform(source, destination): Geometry

• 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

  • source: ProjectionLike

    The current projection. Can be a string identifier or a module:ol/proj/Projection~Projection object.
  • destination: ProjectionLike

    The desired projection. Can be a string identifier or a module:ol/proj/Projection~Projection object.

  Returns Geometry

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

  Api

translate

• translate(deltaX, deltaY): void

• Translate the geometry. This modifies the geometry coordinates in place. If instead you want a new geometry, first clone() this geometry.

  Parameters

  • deltaX: number

    Delta X.
  • deltaY: number

    Delta Y.

  Returns void

  Abstract

  Api

unset

• unset(key, silent?): void

• Unsets a property.

  Parameters

  • key: string

    Key name.
  • Optional silent: boolean

    Unset without triggering an event.

  Returns void

  Api