你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Shape class

参考

包:: azure-maps-control

一个帮助程序类，用于包装几何图形或特征，并使其易于更新和维护。

Extends: EventEmitter<ShapeEvents>

构造函数

Shape(atlas.data.Geometry, string \| number, any)	构造 Shape 对象，并使用指定的 Geometry、ID 和属性初始化它。
Shape(Feature<atlas.data.Geometry, any>)	构造 Shape 对象，并使用指定的功能初始化它。

方法

addProperty(string, any)	在形状中添加或更新现有属性值。
getBounds()	获取形状的边界框
getCircleCoordinates()	如果形状为圆，则获取其坐标。否则返回 null。
getCoordinates()	获取形状的坐标。
getId()	获取形状的 ID。
getProperties()	获取形状的属性。
getType()	返回一个字符串，指示此形状包含的几何图形的类型。
isCircle()	指示包含的形状是否为圆圈，由Azure Maps支持的扩展 GeoJSON 规范定义。扩展规格
isRectangle()	指示包含的形状是否为矩形，由Azure Maps支持的扩展 GeoJSON 规范定义。扩展规格
setCoordinates(Position \| Position[] \| Position[][] \| Position[][][])	汇报形状的坐标
setProperties(any)	设置形状上的属性。覆盖所有现有属性。
toJson()	返回表示形状的 GeoJSON 特征。

构造函数详细信息

Shape(atlas.data.Geometry, string | number, any)

构造 Shape 对象，并使用指定的 Geometry、ID 和属性初始化它。

new Shape(data: atlas.data.Geometry, id?: string | number, properties?: any)

参数

data: Geometry

Geometry 对象

id: string | number

用户分配给形状的唯一 ID。如果未提供，则会为其分配唯一 ID 值。

properties: any

用户定义的形状属性。

Shape(Feature<atlas.data.Geometry, any>)

构造 Shape 对象，并使用指定的功能初始化它。

new Shape(data: Feature<atlas.data.Geometry, any>)

参数

data: Feature<Geometry, any>

Geometry 对象

方法详细信息

addProperty(string, any)

在形状中添加或更新现有属性值。

function addProperty(key: string, value: any)

参数

key: string

value: any

getBounds()

获取形状的边界框

function getBounds(): BoundingBox

BoundingBox

getCircleCoordinates()

如果形状为圆，则获取其坐标。否则返回 null。

function getCircleCoordinates(): Position[]

Position[]

getCoordinates()

获取形状的坐标。

function getCoordinates(): Position | Position[] | Position[][] | Position[][][]

Position | Position[] | Position[][] | Position[][][]

getId()

获取形状的 ID。

function getId(): string | number

string | number

getProperties()

获取形状的属性。

function getProperties(): any

any

getType()

返回一个字符串，指示此形状包含的几何图形的类型。

function getType(): string

string

isCircle()

指示包含的形状是否为圆圈，由Azure Maps支持的扩展 GeoJSON 规范定义。扩展规格

function isCircle(): boolean

boolean

isRectangle()

指示包含的形状是否为矩形，由Azure Maps支持的扩展 GeoJSON 规范定义。扩展规格

function isRectangle(): boolean

boolean

setCoordinates(Position | Position[] | Position[][] | Position[][][])

汇报形状的坐标

function setCoordinates(coords: Position | Position[] | Position[][] | Position[][][])

参数

coords: Position | Position[] | Position[][] | Position[][][]

Point： Position， LineString： Position[]， Polygon： Position[][]， MultiPoint： Position[]， MultiLineString： Position[][]， MultiPolygon： Position[]]

setProperties(any)

设置形状上的属性。覆盖所有现有属性。

function setProperties(properties: any)

参数

properties: any

toJson()

返回表示形状的 GeoJSON 特征。

function toJson(): Feature<atlas.data.Geometry, any>

Feature<Geometry, any>

通过