Partager via


Shape class

Classe d’assistance qui encapsule une géométrie ou une fonctionnalité et facilite la mise à jour et la maintenance.

Extends

Constructeurs

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

Construit un objet Shape et l’initialise avec la géométrie, l’ID et les propriétés spécifiés.

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

Construit un objet Shape et l’initialise avec la fonctionnalité spécifiée.

Méthodes

addProperty(string, any)

Ajoute ou met à jour une valeur de propriété existante dans la forme.

getBounds()

Obtient le cadre englobant de la forme

getCircleCoordinates()

Si la forme est un cercle, elle obtient ses coordonnées. Sinon, retourne null.

getCoordinates()

Obtient les coordonnées de la forme.

getId()

Obtient l’ID de la forme.

getProperties()

Obtient les propriétés de la forme.

getType()

Retourne une chaîne indiquant le type de géométrie que contient cette forme.

isCircle()

Indique si la forme contenue est un cercle, défini par la spécification GeoJSON étendue prise en charge par Azure Maps. Spécification étendue

isRectangle()

Indique si la forme contenue est un rectangle, défini par la spécification GeoJSON étendue prise en charge par Azure Maps. Spécification étendue

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

Mises à jour les coordonnées de la forme

setProperties(any)

Définit les propriétés de la forme. Remplace toutes les propriétés existantes.

toJson()

Renvoie une fonctionnalité GeoJSON qui représente la forme.

Détails du constructeur

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

Construit un objet Shape et l’initialise avec la géométrie, l’ID et les propriétés spécifiés.

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

Paramètres

data
Geometry

un objet Geometry

id

string | number

ID unique que l’utilisateur attribue à la forme. Si elle n’est pas fournie, une valeur d’ID unique lui est affectée.

properties

any

Propriétés définies par l’utilisateur pour la forme.

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

Construit un objet Shape et l’initialise avec la fonctionnalité spécifiée.

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

Paramètres

data

Feature<Geometry, any>

un objet Geometry

Détails de la méthode

addProperty(string, any)

Ajoute ou met à jour une valeur de propriété existante dans la forme.

function addProperty(key: string, value: any)

Paramètres

key

string

value

any

getBounds()

Obtient le cadre englobant de la forme

function getBounds(): BoundingBox

Retours

getCircleCoordinates()

Si la forme est un cercle, elle obtient ses coordonnées. Sinon, retourne null.

function getCircleCoordinates(): Position[]

Retours

getCoordinates()

Obtient les coordonnées de la forme.

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

Retours

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

getId()

Obtient l’ID de la forme.

function getId(): string | number

Retours

string | number

getProperties()

Obtient les propriétés de la forme.

function getProperties(): any

Retours

any

getType()

Retourne une chaîne indiquant le type de géométrie que contient cette forme.

function getType(): string

Retours

string

isCircle()

Indique si la forme contenue est un cercle, défini par la spécification GeoJSON étendue prise en charge par Azure Maps. Spécification étendue

function isCircle(): boolean

Retours

boolean

isRectangle()

Indique si la forme contenue est un rectangle, défini par la spécification GeoJSON étendue prise en charge par Azure Maps. Spécification étendue

function isRectangle(): boolean

Retours

boolean

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

Mises à jour les coordonnées de la forme

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

Paramètres

coords

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

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

setProperties(any)

Définit les propriétés de la forme. Remplace toutes les propriétés existantes.

function setProperties(properties: any)

Paramètres

properties

any

toJson()

Renvoie une fonctionnalité GeoJSON qui représente la forme.

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

Retours