DataSource class

Пакет:

azure-maps-control

Класс источника данных, упрощающий управление данными фигур, которые будут отображаться на карте. Источник данных должен быть добавлен в слой, прежде чем он будет виден на карте. Класс DataSource можно использовать с SymbolLayer, LineLayer, PolygonLayer, BubbleLayer и HeatMapLayer.

Extends

Source<DataSourceEvents>

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

DataSource(string, DataSourceOptions)

Класс источника данных, упрощающий управление данными фигур, которые будут отображаться на карте. Источник данных должен быть добавлен в слой, прежде чем он будет виден на карте. Класс DataSource можно использовать с SymbolLayer, LineLayer, PolygonLayer, BubbleLayerи HeatMapLayer.

Методы

add(FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, number)	Добавляет фигуры в источник данных. Объекты GeoJSON будут заключены в класс Shape, чтобы упростить управление ими. При необходимости укажите индекс для вставки признака между другими фигурами или компонентами в слоях.
clear()	Удаляет все данные из источника данных.
dispose()	Очищает все ресурсы, потребляемые этим объектом.
getClusterChildren(number)	Извлекает дочерние элементы заданного кластера на следующем уровне масштабирования. Это может быть сочетание фигур и вложенных кластеров. Подкластерами будут функции со свойствами, соответствующими Свойствам ClusteredProperties.
getClusterExpansionZoom(number)	Вычисляет уровень масштабирования, при котором кластер начинает расширяться или разбиваться на части.
getClusterLeaves(number, number, number)	Извлекает фигуры, находящиеся в кластере.
getOptions()	Возвращает параметры, используемые источником данных.
getShapeById(string | number)	Извлекает фигуру с указанным идентификатором. Если в источнике данных нет фигуры с указанным идентификатором, возвращается значение NULL.
getShapes()	Возвращает все фигуры, которые находятся в источнике данных.
importDataFromUrl(string)	Загружает документ GeoJSON и импортирует его данные в источник данных. Документ GeoJSON должен находиться в том же домене или быть доступен с помощью CORS.
remove(number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)	Удаляет одну или несколько фигур из источника данных. Если передается строка, предполагается, что она является идентификатором. При передаче числа удаляет фигуру по указанному индексу.
removeById(number | string | Array<number | string>)	Удаляет одну или несколько фигур из источника данных на основе его идентификатора.
setOptions(DataSourceOptions)	Задает параметры источника данных. Источник данных сохранит текущие значения для любого параметра, не указанного в предоставленных параметрах.
setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)	Перезаписывает все фигуры в источнике данных новым массивом фигур.
toJson()	Возвращает коллекцию признаков GeoJSON, которая содержит все данные фигуры, которые содержатся в источнике данных.

Наследуемые методы

getId()

Возвращает идентификатор источника данных.

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

DataSource(string, DataSourceOptions)

Класс источника данных, упрощающий управление данными фигур, которые будут отображаться на карте. Источник данных должен быть добавлен в слой, прежде чем он будет виден на карте. Класс DataSource можно использовать с SymbolLayer, LineLayer, PolygonLayer, BubbleLayerи HeatMapLayer.

new DataSource(id?: string, options?: DataSourceOptions)

Параметры

id

string

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

options

DataSourceOptions

параметры для источника данных.

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

add(FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, number)

Добавляет фигуры в источник данных. Объекты GeoJSON будут заключены в класс Shape, чтобы упростить управление ими. При необходимости укажите индекс для вставки признака между другими фигурами или компонентами в слоях.

function add(data: FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, index?: number)

Параметры

data

FeatureCollection | Feature<Geometry, any> | Geometry | GeometryCollection | Shape | Array<Feature<Geometry, any> | Geometry | Shape>

index

number

clear()

Удаляет все данные из источника данных.

function clear()

dispose()

Очищает все ресурсы, потребляемые этим объектом.

function dispose()

getClusterChildren(number)

Извлекает дочерние элементы заданного кластера на следующем уровне масштабирования. Это может быть сочетание фигур и вложенных кластеров. Подкластерами будут функции со свойствами, соответствующими Свойствам ClusteredProperties.

function getClusterChildren(clusterId: number): Promise<Array<Feature<atlas.data.Geometry, ClusteredProperties | any> | Shape>>

Параметры

clusterId

number

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

Promise<Array<Feature<Geometry, ClusteredProperties | any> | Shape>>

getClusterExpansionZoom(number)

Вычисляет уровень масштабирования, при котором кластер начинает расширяться или разбиваться на части.

function getClusterExpansionZoom(clusterId: number): Promise<number>

Параметры

clusterId

number

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

Promise<number>

getClusterLeaves(number, number, number)

Извлекает фигуры, находящиеся в кластере.

function getClusterLeaves(clusterId: number, limit: number, offset: number): Promise<Array<Feature<atlas.data.Geometry, any> | Shape>>

Параметры

clusterId

number

limit

number

Максимальное количество возвращаемых функций. Установите значение Бесконечность, чтобы вернуть все фигуры.

offset

number

Количество фигур, которые нужно пропустить. Позволяет просматривать фигуры в кластере.

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

Promise<Array<Feature<Geometry, any> | Shape>>

getOptions()

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

function getOptions(): DataSourceOptions

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

DataSourceOptions

getShapeById(string | number)

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

function getShapeById(id: string | number): Shape

Параметры

id

string | number

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

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

Shape

getShapes()

Возвращает все фигуры, которые находятся в источнике данных.

function getShapes(): Shape[]

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

Shape[]

importDataFromUrl(string)

Загружает документ GeoJSON и импортирует его данные в источник данных. Документ GeoJSON должен находиться в том же домене или быть доступен с помощью CORS.

function importDataFromUrl(url: string): Promise<void>

Параметры

url

string

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

Promise<void>

remove(number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)

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

function remove(shape: number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)

Параметры

shape

number | string | Shape | Feature<Geometry, any> | Array<number | string | Shape | Feature<Geometry, any>>

Фигуры, идентификаторы фигур или признаки, которые необходимо удалить

removeById(number | string | Array<number | string>)

Удаляет одну или несколько фигур из источника данных на основе его идентификатора.

function removeById(id: number | string | Array<number | string>)

Параметры

id

number | string | Array<number | string>

setOptions(DataSourceOptions)

Задает параметры источника данных. Источник данных сохранит текущие значения для любого параметра, не указанного в предоставленных параметрах.

function setOptions(options: DataSourceOptions)

Параметры

options

DataSourceOptions

Объект DataSourceOptions для задания

setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)

Перезаписывает все фигуры в источнике данных новым массивом фигур.

function setShapes(shape: FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)

Параметры

shape

FeatureCollection | Array<Feature<Geometry, any> | Geometry | Shape>

новые фигуры для обновления

toJson()

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

function toJson(): FeatureCollection

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

FeatureCollection

Сведения о наследуемом методе

getId()

Возвращает идентификатор источника данных.

function getId(): string

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

string

Наследуется отSource.getId