ScaleLine~ScaleLine

import ScaleLine from 'ol/control/ScaleLine.js';

Контрол, отображающий приблизительные расстояния по оси y, вычисленные для центра области просмотра. Для конформных проекций (например, EPSG:3857, по умолчанию проекция просмотра в OpenLayers), масштаб действителен для всех направлений. Линия масштаба не будет отображаться, если расстояние по оси y пикселя в центре области просмотра не может быть вычислено в проекции просмотра. По умолчанию линия масштаба отображается в левом нижнем углу карты, но это можно изменить, используя CSS-селектор .ol-scale-line. При указании bar как true, вместо линии масштаба будет отображена шкала. Для декартовых измерений линии масштаба необходимо установить метод getPointResolution вашей проекции, чтобы он просто возвращал входное значение, например, projection.setGetPointResolution(r => r);

new ScaleLine(options) control/ScaleLine.js, line 78

Имя	Тип	Описание
`className`	string \| undefined	Имя класса CSS. По умолчанию это `ol-scale-bar` при настройке с `bar: true`. В противном случае по умолчанию это `ol-scale-line`.
`minWidth`	number (по умолчанию 64)	Минимальная ширина в пикселях при OGC-значении dpi по умолчанию. Ширина будет скорректирована для соответствия используемому значению dpi.
`maxWidth`	number \| undefined	Максимальная ширина в пикселях при OGC-значении dpi по умолчанию. Ширина будет скорректирована для соответствия используемому значению dpi.
`render`	function \| undefined	Функция, вызываемая, когда контрол должен быть перерисован. Она вызывается в коллбеке `requestAnimationFrame`.
`target`	HTMLElement \| string \| undefined	Укажите целевой элемент, если вы хотите отобразить контрол вне области просмотра карты.
`units`	Units (по умолчанию 'metric')	Единицы измерения.
`bar`	boolean (по умолчанию false)	Отображать шкалы вместо линии.
`steps`	number (по умолчанию 4)	Количество шагов, которое должна использовать шкала. Для лучших результатов используйте четные числа. Применяется только в случае, если `bar` равно `true`.
`text`	boolean (по умолчанию false)	Отображать текстовую шкалу сверху шкалы. Применяется только в случае, если `bar` равно `true`.
`dpi`	number \| undefined	dpi выходного устройства, например, принтера. Применяется только если `bar` равно `true`. Если undefined, предполагается значение OGC по умолчанию для размеров пикселей экрана в 0,28 мм.

События:

change (BaseEvent) — Общее событие изменения. Срабатывает, когда счётчик ревизий увеличивается.
change:units (ObjectEvent)
error (BaseEvent) — Общее событие ошибки. Срабатывает при возникновении ошибки.
propertychange (ObjectEvent) — Срабатывает при изменении свойства.

Расширяет

Control

Наблюдаемые свойства

Имя	Тип	Настраиваемое	ObjectEvent тип	Описание
`units`	Units	да	`change:units`	Единицы измерения, используемые в линии масштаба.

Методы

changed() унаследованный Observable.js, строка 68

Увеличивает счётчик ревизий и отправляет событие «change».

dispatchEvent(event){boolean | undefined} унаследованный events/Target.js, строка 85

Отправляет событие и вызывает все обработчики, которые слушают события этого типа. Параметр события может быть строкой или объектом с свойством type.

Имя	Тип	Описание
`event`	BaseEvent \| строка	Объект события.

Возвращает:

false, если кто-то вызвал preventDefault в объекте события или если какой-либо из обработчиков вернул false.

get(key){*} унаследованный Object.js, строка 135

Получает значение.

Имя	Тип	Описание
`key`	строка	Имя ключа.

Возвращает:

Значение.

getKeys(){Array.<string>} унаследованный Object.js, строка 148

Получить список имён свойств объекта.

Возвращает:

Список имён свойств.

getMap(){Карта | null} унаследованный control/Control.js, строка 104

Получить карту, связанную с этим элементом управления.

Возвращает:

Карта.

getProperties(){Object.<string, *>} унаследованный Object.js, строка 157

Получить объект со всеми именами и значениями свойств.

Возвращает:

Объект.

getRevision(){number} унаследованный Observable.js, строка 79

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

Возвращает:

Номер ревизии.

getUnits(){Единицы} control/ScaleLine.js, строка 198

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

Возвращает:

Используемые единицы измерения в шкале.

on(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 152

Прослушивание событий определённого типа.

Имя	Тип	Описание
`type`	строка \| Array.<строка>	Тип события или массив типов событий.
`listener`	функция	Функция-обработчик.

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 164

Прослушивание события определённого типа один раз.

Имя	Тип	Описание
`type`	строка \| Array.<строка>	Тип события или массив типов событий.
`listener`	функция	Функция-обработчик.

Возвращает:

set(key, value, silent) унаследованный Object.js, строка 215

Устанавливает значение.

Имя	Тип	Описание
`key`	строка	Имя ключа.
`value`	*	Значение.
`silent`	boolean \| undefined	Обновить без срабатывания события.

setDpi(dpi) control/ScaleLine.js, строка 224

Укажите разрешение dpi устройства вывода, например, принтера.

Имя	Тип	Описание
`dpi`	число \| undefined	Разрешение dpi устройства вывода.

setMap(map) унаследованный control/Control.js, строка 116

Удалить элемент управления из текущей карты и прикрепить его к новой карте. Передайте null, чтобы просто удалить элемент управления из текущей карты. Подклассы могут настраивать обработчики событий, чтобы получать уведомления о изменениях карты здесь.

Имя	Тип	Описание
`map`	Карта \| null	Карта.

setProperties(values, silent) унаследованный Object.js, строка 235

Устанавливает набор пар ключ-значение. Обратите внимание, что это изменяет все существующие свойства и добавляет новые (не удаляет любые существующие свойства).

Имя	Тип	Описание
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновление без срабатывания события.

setTarget(target) унаследованный control/Control.js, строка 155

Эта функция используется для установки целевого элемента для элемента управления. Она не имеет эффекта, если вызывается после добавления элемента управления на карту (т. е. после того, как setMap был вызван на элементе управления). Если target не задан в параметрах, переданных конструктору элемента управления, и если setTarget не был вызван, то элемент управления добавляется к контейнеру наложения карты.

Имя	Тип	Описание
`target`	HTMLElement \| string	Цель.

setUnits(units) control/ScaleLine.js, строка 215

Установите единицы измерения, используемые в масштабной линейке.

Имя	Тип	Описание
`units`	Единицы	Единицы измерения, используемые в масштабной линейке.

un(type, listener) унаследованный Observable.js, строка 173

Отписаться от определенного типа события.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

unset(key, silent) унаследованный Object.js, строка 259

Удаляет свойство.

Имя	Тип	Описание
`key`	string	Имя ключа.
`silent`	boolean \| undefined	Удаление без срабатывания события.