Class LineString

Classdesc

Linestring geometry.

Api

Hierarchy (view full)

Constructors

constructor

Properties

disposed flatCoordinates layout on once simplifiedGeometryMaxMinSquaredTolerance simplifiedGeometryRevision simplifyTransformedInternal stride un

Methods

addChangeListener addEventListener appendCoordinate applyProperties applyTransform changed clone closestPointXY computeExtent containsXY dispatchEvent dispose disposeInternal forEachSegment get getClosestPoint getCoordinateAt getCoordinateAtM getCoordinates getExtent getFirstCoordinate getFlatCoordinates getFlatMidpoint getKeys getLastCoordinate getLayout getLength getListeners getProperties getPropertiesInternal getRevision getSimplifiedGeometry getSimplifiedGeometryInternal getStride getType hasListener hasProperties intersectsCoordinate intersectsExtent notify onInternal onceInternal removeChangeListener removeEventListener rotate scale set setCoordinates setFlatCoordinates setLayout setProperties simplify simplifyTransformed transform translate unInternal unset

Constructors

constructor

  • new LineString(coordinates, layout?): LineString

  • Parameters

    • coordinates: number[] | Coordinate[]

      Coordinates. For internal use, flat coordinates in combination with layout are also accepted.

    • Optional layout: GeometryLayout

      Layout.

    Returns LineString

Properties

Protected disposed

disposed: boolean

The object has already been disposed.

Protected flatCoordinates

flatCoordinates: number[]

Protected layout

layout: GeometryLayout

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

Protected simplifiedGeometryMaxMinSquaredTolerance

simplifiedGeometryMaxMinSquaredTolerance: number

Protected simplifiedGeometryRevision

simplifiedGeometryRevision: number

simplifyTransformedInternal

simplifyTransformedInternal: ((...arg0) => any)

Get a transformed and simplified version of the geometry.

Type declaration

    • (...arg0): any

    • Parameters

      • Rest ...arg0: any[]

      Returns any

Abstract

Returns

Simplified geometry.

Protected stride

stride: number

un

un: ObjectOnSignature<void>

Methods

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

appendCoordinate

  • appendCoordinate(coordinate): void

  • Append the passed coordinate to the coordinates of the linestring.

    Parameters

    • coordinate: Coordinate

      Coordinate.

    Returns void

    Api

Protected applyProperties

  • applyProperties(source): void
  • Protected

    Apply any properties from another object without triggering events.

    Parameters

    • source: Object

      The source object.

    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

clone

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

Protected computeExtent

  • computeExtent(extent): Extent
  • Protected

    Parameters

    • extent: Extent

      Extent.

    Returns Extent

    extent Extent.

    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

Protected disposeInternal

  • disposeInternal(): void
  • Protected

    Extension point for disposable objects.

    Returns void

forEachSegment

  • forEachSegment<T, S>(callback): boolean | T

  • Iterate over each segment, calling the provided callback. If the callback returns a truthy value the function returns that value immediately. Otherwise the function returns false.

    Type Parameters

    • T
    • S

    Parameters

    • callback: ((this, arg1, arg2) => T)

      Function called for each segment. The function will receive two arguments, the start and end coordinates of the segment.

        • (this, arg1, arg2): T

        • Parameters

          • this: S
          • arg1: Coordinate
          • arg2: Coordinate

          Returns T

    Returns boolean | T

    Value.

    Api

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

getCoordinateAt

  • getCoordinateAt(fraction, dest?): Coordinate

  • Return the coordinate at the provided fraction along the linestring. The fraction is a number between 0 and 1, where 0 is the start of the linestring and 1 is the end.

    Parameters

    • fraction: number

      Fraction.

    • Optional dest: Coordinate

      Optional coordinate whose values will be modified. If not provided, a new coordinate will be returned.

    Returns Coordinate

    Coordinate of the interpolated point.

    Api

getCoordinateAtM

  • getCoordinateAtM(m, extrapolate?): null | Coordinate

  • Returns the coordinate at m using linear interpolation, or null if no such coordinate exists.

    extrapolate controls extrapolation beyond the range of Ms in the MultiLineString. If extrapolate is true then Ms less than the first M will return the first coordinate and Ms greater than the last M will return the last coordinate.

    Parameters

    • m: number

      M.

    • Optional extrapolate: boolean

      Extrapolate. Default is false.

    Returns null | Coordinate

    Coordinate.

    Api

getCoordinates

  • getCoordinates(): Coordinate[]

  • Return the coordinates of the linestring.

    Returns Coordinate[]

    Coordinates.

    Api

getExtent

  • getExtent(extent?): Extent

  • Get the extent of the geometry.

    Parameters

    • Optional extent: Extent

      Extent.

    Returns Extent

    extent Extent.

    Api

getFirstCoordinate

  • getFirstCoordinate(): Coordinate

  • Return the first coordinate of the geometry.

    Returns Coordinate

    First coordinate.

    Api

getFlatCoordinates

  • getFlatCoordinates(): number[]

  • Returns number[]

    Flat coordinates.

getFlatMidpoint

  • getFlatMidpoint(): number[]

  • Returns number[]

    Flat midpoint.

getKeys

  • getKeys(): string[]

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

getLastCoordinate

  • getLastCoordinate(): Coordinate

  • Return the last coordinate of the geometry.

    Returns Coordinate

    Last point.

    Api

getLayout

  • getLayout(): GeometryLayout

  • Return the import("./Geometry.js").GeometryLayout layout of the geometry.

    Returns GeometryLayout

    Layout.

    Api

getLength

  • getLength(): number

  • Return the length of the linestring on projected plane.

    Returns number

    Length (on projected plane).

    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

getSimplifiedGeometry

  • getSimplifiedGeometry(squaredTolerance): SimpleGeometry

  • Create a simplified version of this geometry using the Douglas Peucker algorithm.

    Parameters

    • squaredTolerance: number

      Squared tolerance.

    Returns SimpleGeometry

    Simplified geometry.

Protected getSimplifiedGeometryInternal

getStride

  • getStride(): number

  • Returns number

    Stride.

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

Protected onInternal

  • onInternal(type, listener): EventsKey | EventsKey[]
  • Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: ((arg0) => unknown)

      Listener.

        • (arg0): unknown

        • Parameters

          • arg0: Event | BaseEvent

          Returns unknown

    Returns EventsKey | EventsKey[]

    Event key.

Protected onceInternal

  • onceInternal(type, listener): EventsKey | EventsKey[]
  • Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: ((arg0) => unknown)

      Listener.

        • (arg0): unknown

        • Parameters

          • arg0: Event | BaseEvent

          Returns unknown

    Returns EventsKey | EventsKey[]

    Event key.

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

setCoordinates

  • setCoordinates(coordinates, layout?): void

  • Set the coordinates of the linestring.

    Parameters

    • coordinates: Coordinate[]

      Coordinates.

    • Optional layout: GeometryLayout

      Layout.

    Returns void

    Api

setFlatCoordinates

  • setFlatCoordinates(layout, flatCoordinates): void

  • Parameters

    • layout: GeometryLayout

      Layout.

    • flatCoordinates: number[]

      Flat coordinates.

    Returns void

Protected setLayout

  • setLayout(layout, coordinates, nesting): void
  • Protected

    Parameters

    • layout: undefined | GeometryLayout

      Layout.

    • coordinates: any[]

      Coordinates.

    • nesting: number

      Nesting.

    Returns void

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

Protected unInternal

  • unInternal(type, listener): void
  • Protected

    Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      Type.

    • listener: ((arg0) => unknown)

      Listener.

        • (arg0): unknown

        • Parameters

          • arg0: Event | BaseEvent

          Returns unknown

    Returns void

unset

  • unset(key, silent?): void

  • Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optional silent: boolean

      Unset without triggering an event.

    Returns void

    Api

Settings

Member Visibility

On This Page

constructordisposedflatCoordinateslayoutononcesimplifiedGeometryMaxMinSquaredTolerancesimplifiedGeometryRevisionsimplifyTransformedInternalstrideunaddChangeListeneraddEventListenerappendCoordinateapplyPropertiesapplyTransformchangedcloneclosestPointXYcomputeExtentcontainsXYdispatchEventdisposedisposeInternalforEachSegmentgetgetClosestPointgetCoordinateAtgetCoordinateAtMgetCoordinatesgetExtentgetFirstCoordinategetFlatCoordinatesgetFlatMidpointgetKeysgetLastCoordinategetLayoutgetLengthgetListenersgetPropertiesgetPropertiesInternalgetRevisiongetSimplifiedGeometrygetSimplifiedGeometryInternalgetStridegetTypehasListenerhasPropertiesintersectsCoordinateintersectsExtentnotifyonInternalonceInternalremoveChangeListenerremoveEventListenerrotatescalesetsetCoordinatessetFlatCoordinatessetLayoutsetPropertiessimplifysimplifyTransformedtransformtranslateunInternalunset