urbi-exhibitions
Version:
40 lines (39 loc) • 1.89 kB
TypeScript
import { FitBoundsOptions, HtmlMarkerOptions } from '@2gis/mapgl/types';
import { IPinCar } from './types';
interface IUsePinCarProps {
/**
* Параметры маркета. В особенности важно указать html.
*/
markerOptions: Omit<HtmlMarkerOptions, 'coordinates'>;
/**
* Функция срабатывает при добавлении или удалении пин автомобиля.
* Полезно для отслеживания вместе с статусом isPinCarMode и построения маршрута.
*/
onChange?: (pinCar: IPinCar, destinationId: string, isPinCarMode: boolean) => void;
disabled?: boolean;
/**
* Формат даты для истечения срока действия.
* Дефолтное значение YYYY-MM-DD, что означает учитывания только на уровне "дня".
* Можно передать чтобы учитывались часы или даже минуты.
*/
expireDateFormat?: string;
fitBoundsOptions?: FitBoundsOptions;
}
interface IUsePinCarReturn {
isPinCarMode: boolean;
pinCar: IPinCar | null;
/**
* Возвращаемая функция для добавления автомобиля.
*/
addCar: (coordinates: number[]) => void;
/**
* Возвращаемая функция для удаления автомобиля.
*/
removeCar: VoidFunction;
/**
* Фукнция, которая изменяет видимость карты, подстраивая ее под координаты автомобиля.
*/
toggleCarMode: VoidFunction;
}
export declare const usePinMyCar: ({ markerOptions, fitBoundsOptions, disabled, expireDateFormat, onChange, }: IUsePinCarProps) => IUsePinCarReturn;
export {};