Shape class

Пакет:

azure-maps-control

Вспомогательный класс, который создает оболочку геометрии или компонента и упрощает обновление и обслуживание.

Extends

EventEmitter<ShapeEvents>

Конструкторы

Shape(atlas.data.Geometry, string | number, any)	Создает объект Shape и инициализирует его с указанными геометрией, идентификатором и свойствами.
Shape(Feature<atlas.data.Geometry, any>)	Создает объект Shape и инициализирует его с помощью указанного компонента.

Методы

addProperty(string, any)	Добавляет или обновляет существующее значение свойства в фигуре.
getBounds()	Возвращает ограничивающий прямоугольник фигуры
getCircleCoordinates()	Если фигура является кругом, она получает свои координаты. В противном случае возвращает значение NULL.
getCoordinates()	Возвращает координаты фигуры.
getId()	Возвращает идентификатор фигуры.
getProperties()	Возвращает свойства фигуры.
getType()	Возвращает строку, указывающую тип геометрии, которая содержится в фигуре.
isCircle()	Указывает, является ли содержащаяся фигура кругом, определяемой расширенной спецификацией GeoJSON, поддерживаемой Azure Maps. Расширенная спецификация
isRectangle()	Указывает, является ли содержащаяся фигура прямоугольником, определенным расширенной спецификацией GeoJSON, поддерживаемой Azure Maps. Расширенная спецификация
setCoordinates(Position | Position[] | Position[][] | Position[][][])	Обновления координаты фигуры
setProperties(any)	Задает свойства фигуры. Перезаписывает все существующие свойства.
toJson()	Возвращает функцию GeoJSON, представляющую фигуру.

Сведения о конструкторе

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

Создает объект Shape и инициализирует его с указанными геометрией, идентификатором и свойствами.

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

Параметры

data

Geometry

объект Geometry

id

string | number

уникальный идентификатор, который пользователь присваивает фигуре. Если оно не указано, ему будет присвоено уникальное значение идентификатора.

properties

any

Определяемые пользователем свойства фигуры.

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

Создает объект Shape и инициализирует его с помощью указанного компонента.

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

Параметры

data

Feature<Geometry, any>

объект Geometry

Сведения о методе

addProperty(string, any)

Добавляет или обновляет существующее значение свойства в фигуре.

function addProperty(key: string, value: any)

Параметры

key

string

value

any

getBounds()

Возвращает ограничивающий прямоугольник фигуры

function getBounds(): BoundingBox

Возвращаемое значение

BoundingBox

getCircleCoordinates()

Если фигура является кругом, она получает свои координаты. В противном случае возвращает значение NULL.

function getCircleCoordinates(): Position[]

Возвращаемое значение

Position[]

getCoordinates()

Возвращает координаты фигуры.

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

Возвращаемое значение

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

getId()

Возвращает идентификатор фигуры.

function getId(): string | number

Возвращаемое значение

string | number

getProperties()

Возвращает свойства фигуры.

function getProperties(): any

Возвращаемое значение

any

getType()

Возвращает строку, указывающую тип геометрии, которая содержится в фигуре.

function getType(): string

Возвращаемое значение

string

isCircle()

Указывает, является ли содержащаяся фигура кругом, определяемой расширенной спецификацией GeoJSON, поддерживаемой Azure Maps. Расширенная спецификация

function isCircle(): boolean

Возвращаемое значение

boolean

isRectangle()

Указывает, является ли содержащаяся фигура прямоугольником, определенным расширенной спецификацией GeoJSON, поддерживаемой Azure Maps. Расширенная спецификация

function isRectangle(): boolean

Возвращаемое значение

boolean

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

Обновления координаты фигуры

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

Параметры

coords

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

Точка: Position, LineString: Position[], Polygon: Position[][], MultiPoint: Position[], MultiLineString: Position[][], MultiPolygon: Position[][]

setProperties(any)

Задает свойства фигуры. Перезаписывает все существующие свойства.

function setProperties(properties: any)

Параметры

properties

any

toJson()

Возвращает функцию GeoJSON, представляющую фигуру.

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

Возвращаемое значение

Feature<Geometry, any>