Shape class

Pacote:

azure-maps-control

Uma classe auxiliar que encapsula uma Geometria ou Recurso e facilita a atualização e a manutenção.

Extends

EventEmitter<ShapeEvents>

Construtores

Shape(atlas.data.Geometry, string | number, any)	Constrói um objeto Shape e o inicializa com a Geometria, a ID e as propriedades especificadas.
Shape(Feature<atlas.data.Geometry, any>)	Constrói um objeto Shape e o inicializa com o recurso especificado.

Métodos

addProperty(string, any)	Adiciona ou atualiza um valor de propriedade existente na forma.
getBounds()	Obtém a caixa delimitadora da forma
getCircleCoordinates()	Se a forma for um círculo, isso obterá suas coordenadas. Caso contrário, retornará nulo.
getCoordinates()	Obtém as coordenadas da forma.
getId()	Obtém a ID da forma.
getProperties()	Obtém as propriedades da forma.
getType()	Retorna uma cadeia de caracteres que indica o tipo de geometria que essa forma contém.
isCircle()	Indica se a forma contida é um Círculo, definido pela especificação GeoJSON estendida compatível com Azure Mapas. Especificação Estendida
isRectangle()	Indica se a forma contida é um Retângulo, definido pela especificação GeoJSON estendida compatível com Azure Mapas. 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()	Retorna um recurso GeoJSON que representa a forma.

Detalhes do construtor

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

Constrói um objeto Shape e o inicializa com a Geometria, a ID e as propriedades especificadas.

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

Parâmetros

data

Geometry

um objeto Geometry

id

string | number

uma ID exclusiva que o usuário atribui à forma. Se não for fornecido, um valor de ID exclusivo será atribuído a ele.

properties

any

Propriedades definidas pelo usuário para a forma.

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

Constrói um objeto Shape e o inicializa com o recurso especificado.

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

Parâmetros

data

Feature<Geometry, any>

um objeto Geometry

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

Obtém a caixa delimitadora da forma

function getBounds(): BoundingBox

Retornos

BoundingBox

getCircleCoordinates()

Se a forma for um círculo, isso obterá suas coordenadas. Caso contrário, retornará nulo.

function getCircleCoordinates(): Position[]

Retornos

Position[]

getCoordinates()

Obtém as coordenadas da forma.

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

Retornos

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

getId()

Obtém a ID da forma.

function getId(): string | number

Retornos

string | number

getProperties()

Obtém as propriedades da forma.

function getProperties(): any

Retornos

any

getType()

Retorna uma cadeia de caracteres que indica o tipo de geometria que essa forma contém.

function getType(): string

Retornos

string

isCircle()

Indica se a forma contida é um Círculo, definido pela especificação GeoJSON estendida compatível com Azure Mapas. Especificação Estendida

function isCircle(): boolean

Retornos

boolean

isRectangle()

Indica se a forma contida é um Retângulo, definido pela especificação GeoJSON estendida compatível com Azure Mapas. Especificação Estendida

function isRectangle(): boolean

Retornos

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: Position[], Polygon: Position[][], MultiPoint: Position[], MultiLineString: Position[][], MultiPolygon: Position[][]

setProperties(any)

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

function setProperties(properties: any)

Parâmetros

properties

any

toJson()

Retorna um recurso GeoJSON que representa a forma.

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

Retornos

Feature<Geometry, any>