类:TopoJSON

ol/format/TopoJSON~拓扑JSON


import TopoJSON from 'ol/format/TopoJSON.js';

用于读取TopoJSON格式数据的要素格式。

new TopoJSON(options)

Name Type 描述
dataProjection ProjectionLike (defaults to 'EPSG:4326')

默认数据投影。

layerName string | undefined

设置TopoJSON拓扑的名称objects将子级作为指定名称的要素属性。即当设置为'layer',例如拓扑结构

{
  "type": "Topology",
  "objects": {
    "example": {
      "type": "GeometryCollection",
      "geometries": []
    }
  }
}

将生成具有属性的要素'layer'设置为'example'若未设置,则不会向要素添加任何属性。

layers Array.<string> | undefined

TopoJSON 拓扑的名称objects用于指定从中读取要素的子元素。如果未提供,则从所有子元素中读取要素。

继承

方法

readFeature(source, options){FeatureType | Array.<FeatureType>} inherited

读取一个要素。仅适用于单个要素。使用 readFeatures 读取要素集合。

Name Type 描述
source ArrayBuffer | Document | Element | Object | string

数据源.

options

Read options.

Name Type 描述
dataProjection ProjectionLike | undefined

所读取数据的投影。若未指定,投影将自数据推导(如可能)或dataProjection格式的指定(若已设置)。若投影无法从数据中推导,且若无dataProjection若格式已设置,则要素不会被重新投影。

extent Extent | undefined

读取中瓦片的地图单位范围。仅当读取以瓦片像素作为几何单位的数据时才需要此设置。配置后,将显示一个dataProjection使用TILE_PIXELS作为units和瓦片的像素范围作为extent需提供。

featureProjection ProjectionLike | undefined

格式阅读器所创建要素几何图形的投影。若未提供,要素将以该投影返回。dataProjection.

返回:
要素.

readFeatures(source, options){Array.<FeatureType>} inherited

读取所有要素。支持单个要素和要素集合。

Name Type 描述
source ArrayBuffer | Document | Element | Object | string

数据源.

options

Read options.

Name Type 描述
dataProjection ProjectionLike | undefined

所读取数据的投影。 若未指定,将尝试从数据中推断投影(如可行),或dataProjection格式被指定(如果已设置)。如果投影无法从数据中推导出,并且如果没有dataProjection当设置为该格式时,要素不会被重新投影。

extent Extent | undefined

当前读取瓦片的地图单位范围。仅当读取以瓦片像素作为几何单位的数据时才需要此设置。配置后,将出现一个dataProjection使用TILE_PIXELS作为units以及瓦片的像素范围为extent需提供。

featureProjection ProjectionLike | undefined

由格式读取器创建的要素几何图形所使用的投影。如果未提供,要素将以此投影返回。dataProjection.

返回:
要素。

readGeometry(source, options){Geometry} inherited

读取几何。

Name Type 描述
source ArrayBuffer | Document | Element | Object | string

数据源.

options

Read options.

Name Type 描述
dataProjection ProjectionLike | undefined

读取数据的投影。如果未提供,投影将从数据(如果可能)或默认投影推导。dataProjection格式的指定(如果已设置)。如果投影无法从数据中推导,并且如果没有dataProjection设置为格式后,要素将不会被重新投影。

extent Extent | undefined

以地图单位表示的正在读取的瓦片范围。仅当读取以瓦片像素作为几何单位的数据时才需要此设置。配置后,将出现一个dataProjection使用TILE_PIXELS作为units以及瓦片的像素范围为extent需提供。

featureProjection ProjectionLike | undefined

格式阅读器所创建要素几何图形的投影。若未提供,要素将使用该投影返回。dataProjection.

返回:
几何.

读取投影。

Name Type 描述
source ArrayBuffer | Document | Element | Object | string

数据源.

返回:
投影.

writeFeature(feature, options){string} inherited

将要素编码为字符串。

Name Type 描述
feature Feature

要素.

options

Write options.

Name Type 描述
dataProjection ProjectionLike | undefined

写入数据的投影。若未提供,则dataProjection格式的分配(若已设置)。若未设置dataProjection如果格式已设置,要素将以该格式返回。featureProjection.

featureProjection ProjectionLike | undefined

将被格式写入器序列化的要素几何图形的投影。如果未提供,则假定几何图形位于dataProjection如果已设置;换句话说,它们不会被变换。

rightHanded boolean | undefined

在编写几何图形时,需遵循线性环方向的右手定则。据此,多边形的外环应为逆时针方向,内环为顺时针方向。默认情况下,坐标将按构造时提供的顺序进行序列化。如果true,将遵循右手定则。如果false将采用左手法则(外环顺时针,内环逆时针)。请注意,并非所有格式都支持此功能。GeoJSON格式在写入几何对象时使用此属性。

decimals number | undefined

坐标的最大小数位数。坐标在内部以浮点数形式存储,但浮点运算可能产生小数位数过多的坐标,通常不希望出现在输出中。在此处设置数值以对坐标进行舍入。此设置还可确保读入的坐标在写回时能保持相同的小数位数。默认不进行舍入。

返回:
编码要素。

writeFeatures(features, options){string} inherited

将要素数组编码为字符串。

Name Type 描述
features Array<Feature>

要素。

options

Write options.

Name Type 描述
dataProjection ProjectionLike | undefined

待写入数据的投影。如果未提供,则dataProjection格式被指定(如果已设置)。如果没有dataProjection当格式设置后,要素将按该格式返回。featureProjection.

featureProjection ProjectionLike | undefined

供格式编写器序列化的要素几何图形的投影。若未提供,则假定几何图形位于dataProjection如果已设置;换言之,它们不会被转换。

rightHanded boolean | undefined

在编写几何图形时,需遵循线性环方向的右手定则,即多边形的外环为逆时针方向,内环为顺时针方向。默认情况下,坐标将按构造时提供的顺序进行序列化。如果true,将应用右手定则。如果false采用左手法则(外环顺时针,内环逆时针)。请注意,并非所有格式都支持此规则。GeoJSON 格式在写入几何图形时会使用该属性。

decimals number | undefined

坐标的最大小数位数设置。坐标在内部以浮点数形式存储,但浮点运算可能生成具有大量小数位的坐标,这些在输出中通常是不必要的。在此处设置一个数值以对坐标进行舍入。此外,这还可确保读取的坐标能够以相同的小数位数写回。默认情况下不进行舍入。

返回:
编码要素。

writeGeometry(geometry, options){string} inherited

将几何编码为字符串。

Name Type 描述
geometry Geometry

几何.

options

Write options.

Name Type 描述
dataProjection ProjectionLike | undefined

所写入数据的投影。若未提供,则dataProjection格式被指定(如果已设置)。如果没有。dataProjection若格式已设定,要素将以该格式返回。featureProjection.

featureProjection ProjectionLike | undefined

将被格式写入器序列化的要素几何的投影。如果未提供,则假定几何位于dataProjection如果已设置;换言之,它们不会被转换。

rightHanded boolean | undefined

在创建几何图形时,需遵循线性环的右手定则。这表示多边形的外环应为逆时针方向,而内环应为顺时针方向。默认情况下,坐标将按照构造时提供的顺序进行序列化。如果true将应用右手定则。如果false将采用左手法则(外环顺时针,内环逆时针)。注意,并非所有格式都支持此属性。GeoJSON 格式在写入几何图形时确实使用此属性。

decimals number | undefined

坐标的最大小数位数。坐标在内部以浮点数形式存储,但浮点运算可能生成具有大量小数位的坐标,这在输出中通常是不希望的。在此处设置一个数值以对坐标进行舍入。还可用于确保读入的坐标在写回时能保持相同的小数位数。默认情况下不进行舍入。

返回:
几何编码。