Shape class

套件:

azure-maps-control

包裝 Geometry 或 Feature 的協助程式類別，可讓您輕鬆地更新和維護。

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()	取得圖形的識別碼。
getProperties()	取得圖形的屬性。
getType()	傳回字串，指出此圖形包含的幾何類型。
isCircle()	指出包含的圖形是否為 Circle，由Azure 地圖服務支援的擴充 GeoJSON 規格所定義。 擴充規格
isRectangle()	指出包含的圖形是否為 Rectangle，由Azure 地圖服務支援的擴充 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

使用者指派給圖形的唯一識別碼。 如果未提供，則會將唯一識別碼值指派給它。

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()

取得圖形的識別碼。

function getId(): string | number

傳回

string | number

getProperties()

取得圖形的屬性。

function getProperties(): any

傳回

any

getType()

傳回字串，指出此圖形包含的幾何類型。

function getType(): string

傳回

string

isCircle()

指出包含的圖形是否為 Circle，由Azure 地圖服務支援的擴充 GeoJSON 規格所定義。 擴充規格

function isCircle(): boolean

傳回

boolean

isRectangle()

指出包含的圖形是否為 Rectangle，由Azure 地圖服務支援的擴充 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>