Class Polyline

Classdesc

Feature format for reading and writing data in the Encoded Polyline Algorithm Format.

Param: opt_options

Optional configuration object.

Api

stable

Hierarchy

Constructors

constructor

Methods

decodeDeltas decodeFloats encodeDeltas encodeFloats readFeature readFeatures readGeometry readProjection writeGeometry

Constructors

constructor

Methods

Static decodeDeltas

  • decodeDeltas(encoded, stride, opt_factor?): number[]

  • Decode a list of n-dimensional points from an encoded string

    Parameters

    • encoded: string

      An encoded string.

    • stride: number

      The number of dimension of the points in the encoded string.

    • Optional opt_factor: number

      The factor by which the resulting numbers will be divided. Default is 1e5.

    Returns number[]

    A list of n-dimensional points.

    Api

Static decodeFloats

  • decodeFloats(encoded, opt_factor?): number[]

  • Decode a list of floating point numbers from an encoded string

    Parameters

    • encoded: string

      An encoded string.

    • Optional opt_factor: number

      The factor by which the result will be divided. Default is 1e5.

    Returns number[]

    A list of floating point numbers.

    Api

Static encodeDeltas

  • encodeDeltas(numbers, stride, opt_factor?): string

  • Encode a list of n-dimensional points and return an encoded string

    Attention: This function will modify the passed array!

    Parameters

    • numbers: number[]

      A list of n-dimensional points.

    • stride: number

      The number of dimension of the points in the list.

    • Optional opt_factor: number

      The factor by which the numbers will be multiplied. The remaining decimal places will get rounded away. Default is 1e5.

    Returns string

    The encoded string.

    Api

Static encodeFloats

  • encodeFloats(numbers, opt_factor?): string

  • Encode a list of floating point numbers and return an encoded string

    Attention: This function will modify the passed array!

    Parameters

    • numbers: number[]

      A list of floating point numbers.

    • Optional opt_factor: number

      The factor by which the numbers will be multiplied. The remaining decimal places will get rounded away. Default is 1e5.

    Returns string

    The encoded string.

    Api

readFeature

  • readFeature(source, opt_options?): ov2D3D.MapClient.ol.Feature

  • Read the feature from the Polyline source. The coordinates are assumed to be in two dimensions and in latitude, longitude order.

    Parameters

    • source: string | Object | Node | Document

      Source.

    • Optional opt_options: ReadOptions

      Read options.

    Returns ov2D3D.MapClient.ol.Feature

    Feature.

    Function

    Api

    stable

readFeatures

  • readFeatures(source, opt_options?): ov2D3D.MapClient.ol.Feature[]

  • Read the feature from the source. As Polyline sources contain a single feature, this will return the feature in an array.

    Parameters

    • source: string | Object | Node | Document

      Source.

    • Optional opt_options: ReadOptions

      Read options.

    Returns ov2D3D.MapClient.ol.Feature[]

    Features.

    Function

    Api

    stable

readGeometry

readProjection

  • readProjection(source): Projection

  • Read the projection from a Polyline source.

    Parameters

    • source: string | Object | Node | Document

      Source.

    Returns Projection

    Projection.

    Function

    Api

    stable

writeGeometry

  • writeGeometry(geometry, opt_options?): string

  • Write a single geometry in Polyline format.

    Parameters

    Returns string

    Geometry.

    Function

    Api

    stable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc