YMapMiniMap

Класс YMapMiniMap — это элемент управления, который создает уменьшенную версию основной карты. По сути, это обзорная карта, которая помогает ориентироваться в пространстве и видеть общую картину.

Основные характеристики:

  • По умолчанию масштаб уменьшен на 5 по сравнению с основной картой.
  • Позволяет быстро оценить расположение объектов на большой территории.

Мини-карта особенно полезна при работе с большими территориями, когда нужно быстро понять, где находится текущая область просмотра относительно всей карты.

Примечание

Данный класс является компонентом пакета @yandex/ymaps3-minimap и предоставляет дополнительную функциональность в JS API, которая не входит в основное API.

Для подключения пакета воспользуйтесь инструкцией.

Пример использования

const minimap = new YMapMiniMap({
  size: [128, 90],
  zoomOffset: 5,
  collapsed: false,
  onButtonClick: () => {
      collapsed = !collapsed;
      minimap.update({collapsed});
  }
});

 <YMapMiniMap size= {[128, 90]}
   zoomOffset= {5}
   collapsed= {false}
   onButtonClick= {() => {
       collapsed = !collapsed
       minimap.update({collapsed})
  }}
 </YMapMiniMap>

 <YMapMiniMap :size= "[128, 90]"
   :zoomOffset= "5"
   :collapsed= "false",
   :onButtonClick= "() => {
       collapsed = !collapsed
       minimap.update({collapsed})
  }"
 </YMapMiniMap>

Подробный пример

Конструктор

new YMapMiniMap(props: YMapMiniMapProps)

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

Параметр

Тип

Описание

props

YMapMiniMap

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

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

YMapGroupEntity.constructor

Props

export interface YMapMiniMapProps {
    /** Размер мини-карты. */
    size?: [number, number];
    /** Разница в масштабе между мини-картой и основной. */
    zoomOffset?: number;
    /** Диапазон масштабирования мини-карты. Может использоваться для настройки уровня масштабирования. */
    zoomRange?: {
        min: number;
        max: number;
    };
    /** Границы видимой области основной карты на мини-карте. */
    showBounds?: boolean;
    /** Управление основной картой через интерфейс мини-карты. Перемещение мини-карты приведет к перемещению основной карты. */
    controllable?: boolean;
    /** Состояние мини-карты: свернутая или развернутая. */
    collapsed?: boolean;
    /** Элемент управления для сворачивания/разворачивания мини-карты. */
    showCollapsedControl?: boolean;
    /** Стиль для отображения многоугольника видимых границ области основной карты на мини-карте. */
    boundsDrawingStyle?: DrawingStyle;
    /** Первоначальные координаты центра и уровня зума мини-карты, если требуется. */
    location?: YMapLocationRequest;
    /** Обработчик клика на кнопку управления сворачиванием мини-карты. */
    onCollapsedChange?: (collapse: boolean) => void;
    /** Камера с мини-картой, если требуется. По умолчанию камера с мини-картой совпадает с камерой основной карты. */
    camera?: YMapCameraRequest;
}

Параметры

Параметр

Тип

Значение по умолчанию

Описание

size

[number, number]

[128, 90]

Размер мини-карты в пикселях.

zoomOffset

number

5

Разница в масштабе между мини-картой и основной.

zoomRange

{min: number; max: number}

Диапазон масштабирования мини-карты. Может использоваться для настройки уровня масштабирования.

showBounds

boolean

true

Границы видимой области основной карты на мини-карте.

controllable

boolean

true

Управление основной картой через интерфейс мини-карты. Перемещение мини-карты приведет к перемещению основной карты.

collapsed

boolean

false

Состояние мини-карты: свернутая или развернутая.

showCollapsedControl

boolean

true

Элемент управления для сворачивания/разворачивания мини-карты.

boundsDrawingStyle

DrawingStyle

Стиль для отображения многоугольника видимых границ области основной карты на мини-карте.

location

YMapLocationRequest

Первоначальные координаты центра и уровня зума мини-карты, если требуется.

onButtonClick

function

Кнопку управления сворачиванием мини-карты.

camera

YMapCameraRequest

Камера с мини-картой, если требуется. По умолчанию камера с мини-картой совпадает с камерой основной карты.

Методы

_onAttach

_onAttach(): void

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

void

Переопределяет

YMapGroupEntity.__onAttach

_onUpdate

_onUpdate(props: Partial, oldProps: YMapMiniMapProps): void

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

void

Переопределяет

YMapGroupEntity._onUpdate

_onDetach

_onDetach(): void

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

void

Переопределяет

YMapGroupEntity._onDetach

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