YMapDefaultSchemeLayer

Класс YMapDefaultSchemeLayer — это визуальный компонент, который загружает данные схемы карты из определенного источника и добавляет их на карту.

В зависимости от параметра layers слой может отображать:

  • ground — всю схему в растровой версии, слой земли в векторной версии;
  • buildings — слой строений в векторной версии;
  • icons — слой иконок в векторной версии;
  • labels — слой подписей в векторной версии.

Создание слоя

Например, этот код загрузит данные и добавит на карту слой типа «схема» в растровой версии:

const schema = new YMapDefaultSchemeLayer({type: 'ground'});

map.addChild(schema);

Данный код загрузит данные и добавит на карту все слои типа «схема» со всеми источниками данных:

const schema = new YMapDefaultSchemeLayer({theme: 'light'});

map.addChild(schema);

Примечание

В этом примере конструктор слоя получает на вход только цветовую тему, остальные параметры используются по умолчанию из YMapDefaultSchemeLayer.defaultProps

Создание слоя с выбранными схемами

Класс YMapDefaultSchemeLayer можно использовать только в качестве загрузчика данных, тогда отображать загруженные данные можно точечно с помощью YMapLayer:

// Инициализируйте невидимый YMapDefaultSchemeLayer.
// Он скрыт, потому что используется только для загрузки данных.
const schema = YMapDefaultSchemeLayer({theme: 'light', visible: false, source: 'scheme'});

// Добавьте его на карту.
map.addChild(schema);

// Затем добавьте на карту несколько YMapLayer, указав для каждого из них,
// какие данные из YMapDefaultSchemeLayer отображать.
map.addChild(new YMapLayer({zIndex: 1, source: 'scheme', type: 'ground'}))
map.addChild(new YMapLayer({zIndex: 2, source: 'scheme', type: 'labels'}))
map.addChild(new YMapLayer({zIndex: 3, source: 'scheme', type: 'buildings'}))
map.addChild(new YMapLayer({zIndex: 4, source: 'scheme', type: 'icons'}))

Конструктор

new YMapDefaultSchemeLayer(props, options?)

Параметры конструктора

Параметр

Тип

Описание

props

YMapDefaultSchemeLayerProps

Значение входных props.

options

ComplexOptions<YMap>

Опциональные параметры объекта.

Унаследовано от

YMapComplexEntity.constructor

Props

YMapDefaultSchemeLayerProps: Object

Параметры

Имя

Тип

Описание

clampMapZoom?

boolean

Разрешает ограничение масштаба карты. Если вы хотите, чтобы масштаб слоя не блокировался при достижении максимального значения, вы можете установить для этого поля значение false. Это может потребоваться, например, когда ваши собственные слои работают в масштабе, превышающем 21.

const defaultSchemeLayer = new YMapDefaultSchemeLayer({clampMapZoom: false}); map.addChild(defaultSchemeLayer);

See example https://yandex.ru/dev/jsapi30/doc/ru/examples/cases/over-zoom Default

true

customization?

VectorCustomization

Настройка векторных тайлов.

layers?

Partial<Record<YMapDefaultSchemeLayerType, Partial<YMapLayerProps>>>

Параметры слоев.

source?

string

Название для источника.

theme?

"dark" | "light"

Тема, применяемая к схеме Deprecated вместо этого используйте YMapProps тема prop в YMap

visible?

boolean

Следует показывать слои Deprecated используя вместо них YMapDefaultSchemeLayerProps слои.

Методы

update

update(changedProps): void

Метод обновления параметров.

Параметры

Параметр

Тип

Описание

changedProps

Partial<YMapDefaultSchemeLayerProps>

Новые значения props.

Возвращается

void

Унаследовано от

YMapComplexEntity.update

Предыдущая
Следующая