类:文本要素

ol/format/TextFeature~文本要素


抽象基类;通常仅用于创建子类,而不应在应用程序中实例化。 文本要素格式的基类。

子类

继承

方法

readFeature(source, options){Feature}

从源中读取要素。

Name Type 描述
source 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<Feature>}

从源中读取要素。

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

数据源.

options

Read options.

Name Type 描述
dataProjection ProjectionLike | undefined

所读取数据的投影。若未提供,投影将从数据中推导(如可能)或dataProjection若已指定格式,则使用该格式。如果无法从数据中推导出投影,并且未提供……dataProjection若已指定格式,则要素将不会被重投影。

extent Extent | undefined

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

featureProjection ProjectionLike | undefined

由格式读取器生成的要素几何投影。若未提供,要素将使用该投影返回。dataProjection.

返回:
要素。

readGeometry(source, options){Geometry}

从数据源读取几何数据。

Name Type 描述
source 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.

返回:
几何.

readProjection(source){Projection | undefined}

从源读取投影。

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

数据源.

返回:
投影.

writeFeature(feature, options){string}

将要素编码为字符串。

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}

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

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}

创建单个几何。

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

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

返回:
几何.