Shape class

Paket:

azure-maps-control

En hjälpklass som omsluter en geometri eller funktion och gör det enkelt att uppdatera och underhålla.

Extends

EventEmitter<ShapeEvents>

Konstruktorer

Shape(atlas.data.Geometry, string | number, any)	Skapar ett shape-objekt och initierar det med angiven geometri, ID och egenskaper.
Shape(Feature<atlas.data.Geometry, any>)	Skapar ett formobjekt och initierar det med den angivna funktionen.

Metoder

addProperty(string, any)	Lägger till eller uppdaterar ett befintligt egenskapsvärde i formen.
getBounds()	Hämtar formens avgränsningsruta
getCircleCoordinates()	Om formen är en cirkel får den sina koordinater. Annars returneras null.
getCoordinates()	Hämtar formens koordinater.
getId()	Hämtar formens ID.
getProperties()	Hämtar egenskaperna för formen.
getType()	Returnerar en sträng som anger vilken typ av geometri den här formen innehåller.
isCircle()	Anger om den inneslutna formen är en cirkel, definierad av den utökade GeoJSON-specifikationen som stöds av Azure Maps. Utökad specifikation
isRectangle()	Anger om den inneslutna formen är en rektangel som definieras av den utökade GeoJSON-specifikationen som stöds av Azure Maps. Utökad specifikation
setCoordinates(Position | Position[] | Position[][] | Position[][][])	Uppdateringar formens koordinater
setProperties(any)	Anger egenskaperna för formen. Skriver över alla befintliga egenskaper.
toJson()	Returnerar en GeoJSON-funktion som representerar formen.

Konstruktorinformation

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

Skapar ett shape-objekt och initierar det med angiven geometri, ID och egenskaper.

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

Parametrar

data

Geometry

ett geometriobjekt

id

string | number

ett unikt ID som användaren tilldelar formen. Om det inte anges tilldelas ett unikt ID-värde till det.

properties

any

Användardefinierade egenskaper för formen.

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

Skapar ett formobjekt och initierar det med den angivna funktionen.

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

Parametrar

data

Feature<Geometry, any>

ett geometriobjekt

Metodinformation

addProperty(string, any)

Lägger till eller uppdaterar ett befintligt egenskapsvärde i formen.

function addProperty(key: string, value: any)

Parametrar

key

string

value

any

getBounds()

Hämtar formens avgränsningsruta

function getBounds(): BoundingBox

Returer

BoundingBox

getCircleCoordinates()

Om formen är en cirkel får den sina koordinater. Annars returneras null.

function getCircleCoordinates(): Position[]

Returer

Position[]

getCoordinates()

Hämtar formens koordinater.

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

Returer

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

getId()

Hämtar formens ID.

function getId(): string | number

Returer

string | number

getProperties()

Hämtar egenskaperna för formen.

function getProperties(): any

Returer

any

getType()

Returnerar en sträng som anger vilken typ av geometri den här formen innehåller.

function getType(): string

Returer

string

isCircle()

Anger om den inneslutna formen är en cirkel, definierad av den utökade GeoJSON-specifikationen som stöds av Azure Maps. Utökad specifikation

function isCircle(): boolean

Returer

boolean

isRectangle()

Anger om den inneslutna formen är en rektangel som definieras av den utökade GeoJSON-specifikationen som stöds av Azure Maps. Utökad specifikation

function isRectangle(): boolean

Returer

boolean

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

Uppdateringar formens koordinater

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

Parametrar

coords

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

Punkt: Position, LineString: Position[], Polygon: Position[][], MultiPoint: Position[], MultiLineString: Position[][], MultiPolygon: Position[][]

setProperties(any)

Anger egenskaperna för formen. Skriver över alla befintliga egenskaper.

function setProperties(properties: any)

Parametrar

properties

any

toJson()

Returnerar en GeoJSON-funktion som representerar formen.

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

Returer

Feature<Geometry, any>