Shape class

Paquete:

azure-maps-control

Una clase auxiliar que encapsula una geometría o característica y facilita la actualización y el mantenimiento.

Extends

EventEmitter<ShapeEvents>

Constructores

Shape(atlas.data.Geometry, string | number, any)	Construye un objeto Shape y lo inicializa con las propiedades Geometry, ID y especificadas.
Shape(Feature<atlas.data.Geometry, any>)	Construye un objeto Shape e inicializa con la característica especificada.

Métodos

addProperty(string, any)	Agrega o actualiza un valor de propiedad existente en la forma.
getBounds()	Obtiene el cuadro de límite de la forma.
getCircleCoordinates()	Si la forma es un círculo, obtiene sus coordenadas. De lo contrario, devuelve null.
getCoordinates()	Obtiene las coordenadas de la forma.
getId()	Obtiene el identificador de la forma.
getProperties()	Obtiene las propiedades de la forma.
getType()	Devuelve una cadena que indica el tipo de geometría que contiene esta forma.
isCircle()	Indica si la forma contenida es un círculo, definido por la especificación extendida de GeoJSON compatible con Azure Maps. Especificación extendida
isRectangle()	Indica si la forma contenida es un rectángulo, definido por la especificación extendida de GeoJSON compatible con Azure Maps. Especificación extendida
setCoordinates(Position | Position[] | Position[][] | Position[][][])	Novedades las coordenadas de la forma
setProperties(any)	Establece las propiedades de la forma. Sobrescribe todas las propiedades existentes.
toJson()	Devuelve una característica GeoJSON que representa la forma.

Detalles del constructor

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

Construye un objeto Shape y lo inicializa con las propiedades Geometry, ID y especificadas.

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

Parámetros

data

Geometry

un objeto Geometry

id

string | number

identificador único que el usuario asigna a la forma. Si no se proporciona, se le asignará un valor de identificador único.

properties

any

Propiedades definidas por el usuario para la forma.

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

Construye un objeto Shape e inicializa con la característica especificada.

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

Parámetros

data

Feature<Geometry, any>

un objeto Geometry

Detalles del método

addProperty(string, any)

Agrega o actualiza un valor de propiedad existente en la forma.

function addProperty(key: string, value: any)

Parámetros

key

string

value

any

getBounds()

Obtiene el cuadro de límite de la forma.

function getBounds(): BoundingBox

Devoluciones

BoundingBox

getCircleCoordinates()

Si la forma es un círculo, obtiene sus coordenadas. De lo contrario, devuelve null.

function getCircleCoordinates(): Position[]

Devoluciones

Position[]

getCoordinates()

Obtiene las coordenadas de la forma.

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

Devoluciones

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

getId()

Obtiene el identificador de la forma.

function getId(): string | number

Devoluciones

string | number

getProperties()

Obtiene las propiedades de la forma.

function getProperties(): any

Devoluciones

any

getType()

Devuelve una cadena que indica el tipo de geometría que contiene esta forma.

function getType(): string

Devoluciones

string

isCircle()

Indica si la forma contenida es un círculo, definido por la especificación extendida de GeoJSON compatible con Azure Maps. Especificación extendida

function isCircle(): boolean

Devoluciones

boolean

isRectangle()

Indica si la forma contenida es un rectángulo, definido por la especificación extendida de GeoJSON compatible con Azure Maps. Especificación extendida

function isRectangle(): boolean

Devoluciones

boolean

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

Novedades las coordenadas de la forma

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

Parámetros

coords

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

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

setProperties(any)

Establece las propiedades de la forma. Sobrescribe todas las propiedades existentes.

function setProperties(properties: any)

Parámetros

properties

any

toJson()

Devuelve una característica GeoJSON que representa la forma.

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

Devoluciones

Feature<Geometry, any>