YMapGeolocationControl

Класс YMapGeolocationControl — позволяет определить местоположение пользователя путем вызова стандартной геолокационной функции браузера и/или по IP-адресу пользователя.

Примечание

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

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

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

Добавление кнопки геолокации:

const map = new YMap(element, {
  location: {center: [37.588144, 55.733842], zoom: 14}
});

const controls = new YMapControls();
controls.addChild(new YMapGeolocationControl());

map.addChild(controls);

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

Конструктор

new YMapGeolocationControl(props: YMapGeolocationControlProps)

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

Параметр

Тип

Описание

props

YMapGeolocationControlProps

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

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

YMapGroupEntity.constructor

Props

type YMapGeolocationControlProps = {
    /** Обратный вызов запроса геолокации */
    onGeolocatePosition?: (position: LngLat) => void;
    /** Обратный вызов ошибки запроса геолокации */
    onGeolocateError?: () => void;
    /** Идентификатор источника данных для геолокационной метки */
    source?: string;
    /** Функция анимации изменения местоположения на карте. */
    easing?: EasingFunctionDescription;
    /** Продолжительность анимации местоположения на карте. */
    duration?: number;
    /** Масштаб карты после геолокации. */
    zoom?: number;
    /** Опции для {@link ymaps3.geolocation.getPosition} */
    positionOptions?: PositionOptions;
};
declare const defaultProps: Readonly<{
    duration: 500;
    positionOptions: {
        enableHighAccuracy: boolean;
        timeout: number;
        maximumAge: number;
    };
}>;
type DefaultProps = typeof defaultProps;

Параметры

Параметр

Тип

Описание

duration?

number

Продолжительность анимации местоположения на карте.

easing?

EasingFunctionDescription

Функция анимации изменения местоположения на карте.

onGeolocatePosition?

(position: LngLat) => void

Обратный вызов запроса геолокации.

source?

string

Идентификатор источника данных для геолокационной метки.

zoom?

number

Масштаб карты после определения местоположения.

Методы

addChild

addChild(child, index?): YMapGeolocationControl

Параметры

Параметр

Тип

child

YMapEntity<unknown, {}>

index?

number

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

YMapGeolocationControl

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

YMapGroupEntity.addChild

removeChild

removeChild(child): YMapGeolocationControl

Параметры

Параметр

Тип

child

YMapEntity<unknown, {}>

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

YMapGeolocationControl

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

YMapGroupEntity.removeChild

update

update(changedProps): void

Параметры

Параметр

Тип

Описание

changedProps

Partial<YMapGeolocationControlProps>

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

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

void

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

YMapGroupEntity.update

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