Skip to content

pranko17/react-native-yamap-plus-lite

 
 

Repository files navigation

React Native Yandex Maps lite (Яндекс Карты)

Форк библиотеки react-native-yamap-plus, разработанной Qudaeo

Библиотека для интеграции MapKit SDK в React Native

Установка

yarn add react-native-yamap-plus-lite

Использование карт

Инициализировать карты

Для этого лучше всего зайти в корневой файл приложения, например App.js, и добавить инициализацию:

import { YamapInstance } from "react-native-yamap-plus-lite";

YamapInstance.init(API_KEY);

Изменение языка карт

import { YamapInstance } from "react-native-yamap-plus-lite";

const currentLocale = await YamapInstance.getLocale();
YamapInstance.setLocale("en_US"); // 'ru_RU' или другие
YamapInstance.resetLocale();
  • getLocale(): Promise<string> - возвращает используемый язык карт;

  • setLocale(locale: string): Promise<void> - установить язык карт;

  • resetLocale(): Promise<void> - использовать для карт язык системы.

ВАЖНО!

  1. Для Android изменение языка карт вступит в силу только после перезапуска приложения.
  2. Для iOS методы изменения языка можно вызывать только до первого рендера карты. Также нельзя повторно вызывать метод, если язык уже изменялся (можно только после перезапуска приложения), иначе изменения приняты не будут, а в терминал будет выведено сообщение с предупреждением. В коде при этом не будет информации об ошибке.

Использование компонента

import React from "react";
import { Yamap } from "react-native-yamap-plus-lite";

const Map = () => {
  return (
    <Yamap
      userLocationIcon={{
        uri: "https://www.clipartmax.com/png/middle/180-1801760_pin-png.png",
      }}
      initialRegion={{
        lat: 50,
        lon: 50,
        zoom: 10,
        azimuth: 80,
        tilt: 100,
      }}
      style={{ flex: 1 }}
    />
  );
};

Основные типы

interface Point {
  lat: Number;
  lon: Number;
}

interface ScreenPoint {
  x: number;
  y: number;
}

interface MapLoaded {
  renderObjectCount: number;
  curZoomModelsLoaded: number;
  curZoomPlacemarksLoaded: number;
  curZoomLabelsLoaded: number;
  curZoomGeometryLoaded: number;
  tileMemoryUsage: number;
  delayedGeometryLoaded: number;
  fullyAppeared: number;
  fullyLoaded: number;
}

interface InitialRegion {
  lat: number;
  lon: number;
  zoom?: number;
  azimuth?: number;
  tilt?: number;
}

type CameraUpdateReason = "APPLICATION" | "GESTURES";

interface CameraPosition {
  azimuth: number;
  finished: boolean;
  point: Point;
  reason: CameraUpdateReason;
  tilt: number;
  zoom: number;
}

type VisibleRegion = {
  bottomLeft: Point;
  bottomRight: Point;
  topLeft: Point;
  topRight: Point;
};

type YamapSuggest = {
  title: string;
  subtitle?: string;
  uri?: string;
};

type YamapCoords = {
  lon: number;
  lat: number;
};

type YamapSuggestWithCoords = {
  lon: number;
  lat: number;
  title: string;
  subtitle?: string;
  uri?: string;
};

type YandexLogoPosition = {
  horizontal: "left" | "center" | "right";
  vertical: "top" | "bottom";
};

type YandexLogoPadding = {
  horizontal?: number;
  vertical?: number;
};

Доступные props для компонента MapView:

Название Тип Стандартное значение Описание
showUserPosition boolean true Отслеживание геоданных и отображение позиции пользователя
followUser boolean true слежение камеры за пользователем
userLocationIcon ImageSource false Иконка для позиции пользователя. Доступны те же значения что и у компонента Image из React Native
userLocationIconScale number 1 Масштабирование иконки пользователя
initialRegion InitialRegion Изначальное местоположение карты при загрузке
interactive boolean true Интерактивная ли карта (перемещение по карте, отслеживание нажатий)
nightMode boolean false Использование ночного режима
onMapLoaded function Колбек на загрузку карты
onCameraPositionChange function Колбек на изменение положения камеры
onCameraPositionChangeEnd function Колбек при завершении изменения положения камеры
onMapPress function Событие нажития на карту. Возвращает координаты точки на которую нажали
onMapLongPress function Событие долгого нажития на карту. Возвращает координаты точки на которую нажали
userLocationAccuracyFillColor string Цвет фона зоны точности определения позиции пользователя
userLocationAccuracyStrokeColor string Цвет границы зоны точности определения позиции пользователя
userLocationAccuracyStrokeWidth number Толщина зоны точности определения позиции пользователя
scrollGesturesEnabled boolean true Включены ли жесты скролла
zoomGesturesEnabled boolean true Включены ли жесты зума
tiltGesturesEnabled boolean true Включены ли жесты наклона камеры двумя пальцами
rotateGesturesEnabled boolean true Включены ли жесты поворота камеры
fastTapEnabled boolean true Убрана ли задержка в 300мс при клике/тапе
clusterColor string 'red' Цвет фона метки-кластера
logoPosition YandexLogoPosition {} Позиция логотипа Яндекса на карте
logoPadding YandexLogoPadding {} Отступ логотипа Яндекса на карте
mapType string 'vector' Тип карты
mapStyle string {} Стили карты согласно документации

Доступные методы для компонента MapView:

  • fitMarkers(points: Point[]): void - подобрать положение камеры, чтобы вместить указанные маркеры (если возможно);
  • fitAllMarkers(): void - подобрать положение камеры, чтобы вместить все маркеры (если возможно);
  • setCenter(center: { lon: number, lat: number }, zoom: number = 10, azimuth: number = 0, tilt: number = 0, duration: number = 0, animation: Animation = Animation.SMOOTH) - устанавливает камеру в точку с заданным zoom, поворотом по азимуту и наклоном карты (tilt). Можно параметризовать анимацию: длительность и тип. Если длительность установить 0, то переход будет без анимации. Возможные типы анимаций Animation.SMOOTH и Animation.LINEAR;
  • setZoom(zoom: number, duration: number, animation: Animation) - изменить текущий zoom карты. Параметры duration и animation работают по аналогии с setCenter;
  • getCameraPosition(callback: (position: CameraPosition) => void) - запрашивает положение камеры и вызывает переданный колбек с текущим значением;
  • getVisibleRegion(callback: (region: VisibleRegion) => void) - запрашивает видимый регион и вызывает переданный колбек с текущим значением;
  • setTrafficVisible(isVisible: boolean): void - включить/отключить отображение слоя с пробками на картах;
  • getScreenPoints(point: Point[], callback: (result: {screenPoints: ScreenPoint[]}) => void) - получить кооординаты на экране (x и y) по координатам маркеров;
  • getWorldPoints(screenPoint: ScreenPoint[], callback: (result: {worldPoints: Point[]}) => void) - получить координаты точек (lat и lon) по координатам на экране.

ВАЖНО

  • Компонент карт стилизуется, как и View из React Native. Если карта не отображается, после инициализации с валидным ключем API, вероятно необходимо прописать стиль, который опишет размеры компонента (height + width или flex);
  • При использовании изображений из JS (через require('./img.png')) в дебаге и релизе на Android могут быть разные размеры маркера. Рекомендуется проверять рендер в релизной сборке.

Отображение примитивов

Marker

import { Yamap, Marker } from "react-native-yamap-plus-lite";

<Yamap>
  <Marker point={{ lat: 50, lon: 50 }} />
</Yamap>;

Доступные props для примитива Marker:

Название Тип Описание
point Point Координаты точки для отображения маркера
scale number Масштабирование иконки маркера. Не работает если использовать children у маркера
source ImageSource Данные для изображения маркера
children ReactElement Рендер маркера как компонента
onPress function Действие при нажатии/клике
anchor { x: number, y: number } Якорь иконки маркера. Координаты принимают значения от 0 до 1
zIndex number Отображение элемента по оси Z
visible boolean Отображение маркера на карте
handled boolean Включение(false)/отключение(true) всплытия события нажатия для родителя default:true

Доступные методы для примитива Marker:

  • animatedMoveTo(point: Point, duration: number) - плавное изменение позиции маркера;
  • animatedRotateTo(angle: number, duration: number) - плавное вращение маркера.

Circle

import { Yamap, Circle } from "react-native-yamap-plus-lite";

<Yamap>
  <Circle center={{ lat: 50, lon: 50 }} radius={300} />
</Yamap>;

Доступные props для примитива Circle:

Название Тип Описание
center Point Координаты центра круга
radius number Радиус круга в метрах
fillColor string Цвет заливки
strokeColor string Цвет границы
strokeWidth number Толщина границы
onPress function Действие при нажатии/клике
zIndex number Отображение элемента по оси Z
handled boolean Включение(false)/отключение(true) всплытия события нажатия для родителя default:true

Polyline

import { Yamap, Polyline } from "react-native-yamap-plus-lite";

<Yamap>
  <Polyline
    points={[
      { lat: 50, lon: 50 },
      { lat: 50, lon: 20 },
      { lat: 20, lon: 20 },
    ]}
  />
</Yamap>;

Доступные props для примитива Polyline:

Название Тип Описание
points Point[] Массив точек линии
strokeColor string Цвет линии
strokeWidth number Толщина линии
outlineColor string Цвет обводки
outlineWidth number Толщина обводки
dashLength number Длина штриха
dashOffset number Отступ первого штриха от начала полилинии
gapLength number Длина разрыва между штрихами
onPress function Действие при нажатии/клике
zIndex number Отображение элемента по оси Z
handled boolean Включение(false)/отключение(true) всплытия события нажатия для родителя default:true

Polygon

import { Yamap, Polygon } from "react-native-yamap-plus-lite";

<Yamap>
  <Polygon
    points={[
      { lat: 50, lon: 50 },
      { lat: 50, lon: 20 },
      { lat: 20, lon: 20 },
    ]}
  />
</Yamap>;

Доступные props для примитива Polygon:

Название Тип Описание
points Point[] Массив точек линии
fillColor string Цвет заливки
strokeColor string Цвет границы
strokeWidth number Толщина границы
innerRings (Point[])[] Массив полилиний, которые образуют отверстия в полигоне
onPress function Действие при нажатии/клике
zIndex number Отображение элемента по оси Z
handled boolean Включение(false)/отключение(true) всплытия события нажатия для родителя default:true

Использование компонента ClusteredYamap

import React from "react";
import { ClusteredYamap } from "react-native-yamap-plus-lite";

const Map = () => {
  return (
    <ClusteredYamap
      clusterColor="red"
      clusteredMarkers={[
        {
          point: {
            lat: 56.754215,
            lon: 38.622504,
          },
          data: {},
        },
        {
          point: {
            lat: 56.754215,
            lon: 38.222504,
          },
          data: {},
        },
      ]}
      renderMarker={(info, index) => <Marker key={index} point={info.point} />}
      style={{ flex: 1 }}
    />
  );
};

Использование с Expo

Для подключения нативного модуля в приложение с expo используйте expo prebuild. Он выполнит eject и сгенерирует привычные папки android и ios с нативным кодом. Это позволит использовать любую библиотеку так же, как и приложение с react native cli.

Проблемы

  1. В никоторых случаях в симуляторе ios может крашиться приложение с ошибкой failed assertion `The following Metal object is being destroyed while still required to be alive by the command buffer

Решение: In Xcode, in the "Product" Menu, go to "Scheme", then "Edit Scheme...". In the left panel select "Run (Debug)" and in Diagnostic tab uncheck "API Validation" under Metal settings.

About

Библиотека для интеграции Yandex MapKit SDK в React Native

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Kotlin 43.7%
  • Objective-C 40.2%
  • TypeScript 13.7%
  • Ruby 1.0%
  • JavaScript 0.8%
  • Swift 0.6%