Class KML

Classdesc

Feature format for reading and writing data in the KML format.

Note that the KML format uses the URL() constructor. Older browsers such as IE which do not support this will need a URL polyfill to be loaded before use.

Param: opt_options

Options.

Api

stable

Hierarchy

Constructors

constructor

Methods

readFeature readFeatures readName readNetworkLinks readProjection writeFeatures writeFeaturesNode

Constructors

constructor

  • new KML(opt_options?): ov2D3D.MapClient.ol.format.KML

  • Parameters

    Returns ov2D3D.MapClient.ol.format.KML

    Classdesc

    Feature format for reading and writing data in the KML format.

    Note that the KML format uses the URL() constructor. Older browsers such as IE which do not support this will need a URL polyfill to be loaded before use.

    Api

    stable

Methods

readFeature

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

  • Read the first feature from a KML source. MultiGeometries are converted into GeometryCollections if they are a mix of geometry types, and into MultiPoint/ MultiLineString/MultiPolygon if they are all of the same type.

    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 all features from a KML source. MultiGeometries are converted into GeometryCollections if they are a mix of geometry types, and into MultiPoint/ MultiLineString/MultiPolygon if they are all of the same type.

    Parameters

    • source: string | Object | Node | Document

      Source.

    • Optional opt_options: ReadOptions

      Read options.

    Returns ov2D3D.MapClient.ol.Feature[]

    Features.

    Function

    Api

    stable

readName

  • readName(source): string

  • Read the name of the KML.

    Parameters

    • source: string | Node | Document

      Souce.

    Returns string

    Name.

    Api

    stable

readNetworkLinks

  • readNetworkLinks(source): Object[]

  • Read the network links of the KML.

    Parameters

    • source: string | Node | Document

      Source.

    Returns Object[]

    Network links.

    Api

readProjection

  • readProjection(source): Projection

  • Read the projection from a KML source.

    Parameters

    • source: string | Object | Node | Document

      Source.

    Returns Projection

    Projection.

    Function

    Api

    stable

writeFeatures

  • writeFeatures(features, opt_options?): string

  • Encode an array of features in the KML format. GeometryCollections, MultiPoints, MultiLineStrings, and MultiPolygons are output as MultiGeometries.

    Parameters

    Returns string

    Result.

    Function

    Api

    stable

writeFeaturesNode

  • writeFeaturesNode(features, opt_options?): Node

  • Encode an array of features in the KML format as an XML node. GeometryCollections, MultiPoints, MultiLineStrings, and MultiPolygons are output as MultiGeometries.

    Parameters

    Returns Node

    Node.

    Api

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc