Shape class

Pacote:

azure-maps-control

Uma classe de ajudante que envolve uma Geometria ou Recurso e facilita a atualização e manutenção.

Extends

EventEmitter<ShapeEvents>

Construtores

Shape(atlas.data.Geometry, string | number, any)	Constrói um objeto de forma e inicializa-o com a geometria, iD e propriedades especificadas.
Shape(Feature<atlas.data.Geometry, any>)	Constrói um objeto de forma e inicializa-o com a função especificada.

Métodos

addProperty(string, any)	Adiciona ou atualiza um valor de propriedade existente na forma.
getBounds()	Recebe a caixa de delimitação da forma
getCircleCoordinates()	Se a forma é um círculo, isto recebe as suas coordenadas. Caso contrário, retorna nulo.
getCoordinates()	Obtém as coordenadas da forma.
getId()	Obtém a identificação da forma.
getProperties()	Obtém as propriedades da forma.
getType()	Devolve uma corda indicando o tipo de geometria que esta forma contém.
isCircle()	Indica se a forma contida é um Círculo, definido pela especificação de GeoJSON estendida suportada por Azure Maps. Especificação estendida
isRectangle()	Indica se a forma contida é um Retângulo, definido pela especificação geoJSON estendida suportada por Azure Maps. Especificação estendida
setCoordinates(Position | Position[] | Position[][] | Position[][][])	Atualizações as coordenadas da forma
setProperties(any)	Define as propriedades na forma. Substitui todas as propriedades existentes.
toJson()	Devolve uma funcionalidade GeoJSON que representa a forma.

Detalhes do Construtor

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

Constrói um objeto de forma e inicializa-o com a geometria, iD e propriedades especificadas.

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

Parâmetros

data

Geometry

um objeto de geometria

id

string | number

uma identificação única que o utilizador atribui à forma. Se não for fornecido, será atribuído um valor único de identificação.

properties

any

Propriedades definidas pelo utilizador para a forma.

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

Constrói um objeto de forma e inicializa-o com a função especificada.

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

Parâmetros

data

Feature<Geometry, any>

um objeto de geometria

Detalhes de Método

addProperty(string, any)

Adiciona ou atualiza um valor de propriedade existente na forma.

function addProperty(key: string, value: any)

Parâmetros

key

string

value

any

getBounds()

Recebe a caixa de delimitação da forma

function getBounds(): BoundingBox

Devoluções

BoundingBox

getCircleCoordinates()

Se a forma é um círculo, isto recebe as suas coordenadas. Caso contrário, retorna nulo.

function getCircleCoordinates(): Position[]

Devoluções

Position[]

getCoordinates()

Obtém as coordenadas da forma.

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

Devoluções

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

getId()

Obtém a identificação da forma.

function getId(): string | number

Devoluções

string | number

getProperties()

Obtém as propriedades da forma.

function getProperties(): any

Devoluções

any

getType()

Devolve uma corda indicando o tipo de geometria que esta forma contém.

function getType(): string

Devoluções

string

isCircle()

Indica se a forma contida é um Círculo, definido pela especificação de GeoJSON estendida suportada por Azure Maps. Especificação estendida

function isCircle(): boolean

Devoluções

boolean

isRectangle()

Indica se a forma contida é um Retângulo, definido pela especificação geoJSON estendida suportada por Azure Maps. Especificação estendida

function isRectangle(): boolean

Devoluções

boolean

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

Atualizações as coordenadas da forma

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

Parâmetros

coords

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

Ponto: Posição, LineString: Posição[], Polygon: Posição[], MultiPoint: Posição[], MultiLineString: Posição[], MultiPolygon: Posição[][]]

setProperties(any)

Define as propriedades na forma. Substitui todas as propriedades existentes.

function setProperties(properties: any)

Parâmetros

properties

any

toJson()

Devolve uma funcionalidade GeoJSON que representa a forma.

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

Devoluções

Feature<Geometry, any>