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

図形の 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

a 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>

a 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>