SourceManager interface

Диспетчер источников элемента управления картой. Предоставляется через свойство sources атласа. Класс Map. Не может быть создан пользователем.

Методы

add(Source | Source[])

Добавляет один или несколько источников данных на карту. Карта должна быть готова, прежде чем можно будет добавить источник. Используйте метод map.events.add с типом события ready.

clear()

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

getById(string)

Извлекает источник с указанным идентификатором.

getFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string)

Возвращает состояние компонента.

getRenderedShapes(string | Source, Expression, string)

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

getSources()

Извлекает все источники, добавленные на карту.

isSourceLoaded(string | Source)

Возвращает логическое значение, указывающее, загружен ли источник.

remove(string | Source | Array<string | Source>)

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

removeFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string, string)

Удаляет состояние или одно ключевое значение состояния компонента.

setFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, object, string)

Задает состояние компонента путем передачи объекта пары "ключ-значение".

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

add(Source | Source[])

Добавляет один или несколько источников данных на карту. Карта должна быть готова, прежде чем можно будет добавить источник. Используйте метод map.events.add с типом события ready.

function add(source: Source | Source[])

Параметры

source

Source | Source[]

clear()

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

function clear()

getById(string)

Извлекает источник с указанным идентификатором.

function getById(id: string): Source

Параметры

id

string

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

getFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string)

Возвращает состояние компонента.

function getFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, sourceLayer?: string): object

Параметры

feature

string | Shape | Feature<Geometry, any>

идентификатор компонента

source

string | Source

идентификатор источника

sourceLayer

string

идентификатор слоя

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

object

getRenderedShapes(string | Source, Expression, string)

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

function getRenderedShapes(source: string | Source, filter?: Expression, sourceLayer?: string): Array<Feature<atlas.data.Geometry, any> | Shape>

Параметры

source

string | Source

источник для запроса

filter
Expression

фильтр для ограничения запроса

sourceLayer

string

слой, на котором сопоставляются фигуры и признаки;

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

Array<Feature<Geometry, any> | Shape>

getSources()

Извлекает все источники, добавленные на карту.

function getSources(): Source[]

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

Source[]

isSourceLoaded(string | Source)

Возвращает логическое значение, указывающее, загружен ли источник.

function isSourceLoaded(source: string | Source): boolean

Параметры

source

string | Source

Идентификатор источника или объекта Source.

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

boolean

remove(string | Source | Array<string | Source>)

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

function remove(source: string | Source | Array<string | Source>)

Параметры

source

string | Source | Array<string | Source>

removeFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, string, string)

Удаляет состояние или одно ключевое значение состояния компонента.

function removeFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, sourceLayer?: string, key?: string)

Параметры

feature

string | Shape | Feature<Geometry, any>

идентификатор компонента

source

string | Source

идентификатор источника

sourceLayer

string

идентификатор слоя

key

string

ключ в состоянии функции для обновления;

setFeatureState(string | Shape | Feature<atlas.data.Geometry, any>, string | Source, object, string)

Задает состояние компонента путем передачи объекта пары "ключ-значение".

function setFeatureState(feature: string | Shape | Feature<atlas.data.Geometry, any>, source: string | Source, state: object, sourceLayer?: string)

Параметры

feature

string | Shape | Feature<Geometry, any>

идентификатор компонента

source

string | Source

идентификатор источника

state

object

sourceLayer

string

идентификатор слоя