Skip to main content

struct

ActiveLevelMode​

Режим отображения этажного плана.

new ActiveLevelMode({ index: bigint })
Parameters

index

bigint
Returns
Properties

index​

bigint

Индекс этажа в векторе IIndoorBuilding::levels().

Address​

Адрес в виде набора отдельных компонентов.

new Address({ addressComment: string | null, buildingCode: string | null, buildingId: BuildingId | null, buildingName: string | null, components: AddressComponent[], drillDown: AddressAdmDiv[], fiasCode: string | null, postCode: string | null })
Parameters

addressComment

string|null

buildingCode

string|null

buildingId

buildingName

string|null

components

drillDown

fiasCode

string|null

postCode

string|null
Returns
Properties

addressComment​

string|null

Комментарий к адресу. Пример: "301 офис; 9 этаж"

buildingCode​

string|null

Уникальный почтовый код здания.

buildingId​

Уникальный идентификатор здания.

buildingName​

string|null

Название здания.

components​

Полный адрес объекта может содержать несколько отдельных адресных компонент.

drillDown​

Набор объектов административного деления, в которых находится описываемый объект.

fiasCode​

string|null

Код ФИАС объекта.

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

postCode​

string|null

Почтовый индекс.

AddressAdmDiv​

Объект административного деления.

new AddressAdmDiv({ name: string, type: string })
Parameters

name

string

type

string
Returns
Properties

name​

string

type​

string

Тип административной единицы. Один из следующих:

  • country — страна
  • region — регион (область/край/республика и т.п.)
  • district_area — район области
  • city — город
  • settlement — населённый пункт
  • division — округ
  • district — район
  • living_area — жилмассив, микрорайон
  • place — место

AddressLocation​

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

new AddressLocation({ comment: string })
Parameters

comment

string
Returns
Properties

comment​

string

Словесное описание местоположения строения.

AddressNumber​

В некоторых населённых пунктах обозначается только номер дома, без улицы (например, Краснообск).

new AddressNumber({ fiasCode: string | null, number: string })
Parameters

fiasCode

string|null

number

string
Returns
Properties

fiasCode​

string|null

Код ФИАС улицы.

number​

string

Номер дома, включая дроби и буквенные обозначения. Возможно, имя собственное, если так принято.

AddressStreet​

Обычный адрес, есть улица и номер дома.

new AddressStreet({ fiasCode: string | null, number: string, street: string })
Parameters

fiasCode

string|null

number

string

street

string
Returns
Properties

fiasCode​

string|null

Код ФИАС улицы.

number​

string

Номер дома, включая дроби, корпусы и буквенные обозначения.

street​

string

Название улицы.

Aggregate​

Обобщенное описание станции зарядки автомобилей.

new Aggregate({ connectorsFree: number, connectorsTotal: number, isActive: boolean, isBusy: boolean, power: number })
Parameters

connectorsFree

number

connectorsTotal

number

isActive

boolean

isBusy

boolean

power

number
Returns
Properties

connectorsFree​

number

Количество доступных коннекторов.

connectorsTotal​

number

Общее количество коннекторов (кроме недоступных).

isActive​

boolean

Статус активности. true, если есть хотя бы один доступный, зарезервированный или на зарядке коннектор.

isBusy​

boolean

Статус занятости. true, если половина или более коннекторов заняты.

power​

number

Максимальная мощность из всех коннекторов.

Anchor​

Точка привязки изображения (0, 0) - левый верхний угол, (1, 1) - правый нижний

new Anchor({ x?: number, y?: number })
Parameters

x?

number

y?

number
Returns
Properties

x​

number

Default: 0.5

y​

number

Default: 0.5

ApartmentRange​

Диапазон квартир.

new ApartmentRange({ end?: string | null, start: string })
Parameters

end?

string|null

start

string
Returns
Properties

end​

string|null

Окончание диапазона. Если отсутствует, то диапазон состоит из одного значения start. Иначе это арифметическая прогрессия от start до end с шагом 1. Default: null

start​

string

Начало диапазона/хранимое значение. На текущий момент возможны только числовые значения, а квартиры с суффиксами в данных пока отсутствуют.

Attribute​

Дополнительный атрибут. Пример: { tag: "hotel_room_internet", name: "Бесплатный интернет в номерах" }

new Attribute({ tag: string, value: string })
Parameters

tag

string

value

string
Returns
Properties

tag​

string

Тег.

value​

string

Значение.

AuthorInfo​

Информация об авторе события или фотографии.

new AuthorInfo({ name: string, type: AuthorType })
Parameters

name

string

type

Returns
Properties

name​

string

Строка, содержащая имя пользователя, добавившего событие или фотографию.

  • Имя пользователя в случае, если автор является авторизированным пользователем и согласился на отображение своего имени.
  • Пустая строка для анонимного пользователя или пользователя, отказавшегося от отображения своего имени.

type​

Категория автора контента.

Bearing​

Угол между направлением на один объект и на другой объект, либо между направлением на объект и север. Угол отсчитывается по часовой стрелке. Диапазон значений [0°, 360°].

new Bearing({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

Borders​

Описывает набор непрерывного упорядоченных значений.

new Borders({ currentMax?: number | null, currentMin?: number | null, isLg: boolean, max: number, min: number, snapping: number | null, value: string })
Parameters

currentMax?

number|null

currentMin?

number|null

isLg

boolean

max

number

min

number

snapping

number|null

value

string
Returns
Properties

currentMax​

number|null

Текущее установленное максимальное значение.

Default: null

currentMin​

number|null

Текущее установленное минимальное значение.

Default: null

isLg​

boolean

Признак использования логарифмической шкалы.

max​

number

Верхняя граница набора значений.

min​

number

Нижняя граница набора значений.

snapping​

number|null

Задаёт притяжку до значения, кратного этому числу.

value​

string

Значение, по которым происходит фильтрация.

BranchesInfo​

Информация о связанных организациях.

new BranchesInfo({ count?: number })
Parameters

count?

number
Returns
Properties

count​

number

Количество связанных объектов. Default: 0

BuildingId​

Идентификатор здания.

new BuildingId({ value?: bigint })
Parameters

value?

bigint
Returns
Properties

value​

bigint

Default: 0n

BuildingInfo​

Информация о здании.

new BuildingInfo({ buildingId: BuildingId, buildingLevels: BuildingLevels | null, buildingName: string | null, floorsInfo: FloorsInfo | null, purposeCode: PurposeCode | null, purposeName: string | null })
Parameters

buildingId

buildingLevels

buildingName

string|null

floorsInfo

purposeCode

purposeName

string|null
Returns
Properties

buildingId​

Уникальный идентификатор здания.

buildingLevels​

Информация об этажных планах здания.

buildingName​

string|null

Собственное имя здания.

floorsInfo​

Информация о количестве этажей в здании.

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

purposeCode​

Код назначения здания.

purposeName​

string|null

Описание назначения здания.

BuildingLevels​

Информация об этажных планах здания.

new BuildingLevels({ defaultLevelId: LevelId, levels: LevelInfo[] })
Parameters

defaultLevelId

levels

Returns
Properties

defaultLevelId​

Идентификатор этажного плана по умолчанию.

levels​

Все этажные планы здания.

BySystem​

new BySystem({ dark: MapTheme, light: MapTheme })
Parameters

dark

light

Returns
Properties

CameraBehaviour​

Режим слежения камеры.

Режимы камеры деградируются по следующим правилам:

  • смещение карты сбрасывает слежение за позицией (включая слежение за направлением и стилевым уровнем масштабирования) события: DirectMapShiftEvent, MapShiftBeginEvent, DirectMapRotationEvent с указанием центра события, DirectMapScalingEvent с указанием центра события, ScaleMapEvent с указанием центра события
  • поворот карты относительно точки позиции отбрасывает Bearing события: MapRotationBeginEvent, RotateMapToNorthEvent, DirectMapRotationEvent без центра события
  • изменение масштаба относительно точки позиции отбрасывает StyleZoom события: MapScalingBeginEvent, DirectMapScalingEvent без центра события, ScaleMapEvent без центра события
  • наклон отбрасывает Tilt события: DirectMapTiltEvent
new CameraBehaviour({ position: FollowPosition | null, tilt?: FollowTilt })
Parameters
Properties

position​

tilt​

Default: FollowTilt.Off

CameraBehaviourChange​

Изменение режима слежения.

new CameraBehaviourChange({ changeReason?: CameraBehaviourChangeReason, newBehaviour: CameraBehaviour })
Parameters
Properties

changeReason​

Причина изменения режима слежения. Default: CameraBehaviourChangeReason.Application

newBehaviour​

Новый режим слежения.

CameraChange​

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

new CameraChange({ changeReasons: EnumSet<CameraChangeReason> })
Parameters
Properties

changeReasons​

Причины (набор флагов) изменения состояния камеры.

CameraPosition​

Позиция камеры.

new CameraPosition({ bearing?: Bearing, point: GeoPoint, tilt?: Tilt, zoom: Zoom })
Parameters

bearing?

point

tilt?

zoom

Returns
Properties

bearing​

Угол поворота направления взгляда по горизонтали относительно направления на север. Отсчитывается по часовой стрелке, в градусах. Default: new Bearing({ value: 0.0 })

point​

Точка местности, которая находится в точке позиции камеры (см. ICamera::position_point()).

tilt​

Угол наклона направления взгляда по вертикали. Default: new Tilt({ value: 0.0 })

0 - надир (смотрим вертикально вниз), максимальное значение - 60 градусов.

zoom​

Уровень масштабирования. 0 - это весь мир, вписанный в квадрат 256x256 логических пикселей (см. LogicalPixel)

CameraPositionChange​

Описание изменения части параметров позиции камеры.

new CameraPositionChange({ bearing?: Bearing | null, point?: GeoPoint | null, tilt?: Tilt | null, zoom?: Zoom | null })
Parameters

bearing?

Bearing|null

point?

tilt?

Tilt|null

zoom?

Zoom|null
Returns
Properties

bearing​

Bearing|null

Default: null

point​

Default: null

tilt​

Tilt|null

Default: null

zoom​

Zoom|null

Default: null

CameraPositionPoint​

Относительная экранная позиция точки, к которой привязана камера.

Область экрана задаётся padding'ами. x - отступ от левого края области экрана, y - отступ от верхнего края Допустимый интервал значений отступов (0.0f, 1.0f) 0,0 - левый верхний угол области экрана, 1,1 - правый нижний

new CameraPositionPoint({ x?: number, y?: number })
Parameters

x?

number

y?

number
Returns
Properties

x​

number

Default: 0.5

y​

number

Default: 0.5

CameraViewPoint​

Относительная экранная позиция точки, в которую направлен взгляд камеры.

Допустимый интервал значений отступов (0.0f, 1.0f) 0,0 - левый верхний угол вьюпорта, 1,1 - правый нижний

new CameraViewPoint({ x?: number, y?: number })
Parameters

x?

number

y?

number
Returns
Properties

x​

number

Default: 0.5

y​

number

Default: 0.5

CameraZoomRestrictions​

Допустимый диапазон изменения уровня масштабирования.

new CameraZoomRestrictions({ maxZoom?: Zoom, minZoom?: Zoom })
Parameters

maxZoom?

minZoom?

Returns
Properties

maxZoom​

Максимальный масштаб ограничен величиной 20. Default: new Zoom({ value: 20.0 })

minZoom​

Минимальный уровень масштабирования должен быть меньше максимального. Default: new Zoom({ value: 2.0 })

CertificateFromAsset​

SSL-сертификат из asset-а.

new CertificateFromAsset({ path: string })
Parameters

path

string
Returns
Properties

path​

string

Путь относительно корневой директории asset-ов.

CertificateFromFile​

SSL-сертификат из файла.

new CertificateFromFile({ path: string })
Parameters

path

string
Returns
Properties

path​

string

Путь к файлу.

ChargingStation​

Атрибуты для электрозаправок.

new ChargingStation({ aggregate: Aggregate, connectors: Connector[] })
Parameters

aggregate

connectors

Returns
Properties

aggregate​

connectors​

CircleOptions​

Параметры для создания геометрического объекта карты типа "Окружность".

new CircleOptions({ color?: Color, dashedStrokeOptions?: DashedStrokeCircleOptions | null, levelId?: LevelId | null, position: GeoPoint, radius: Meter, strokeColor?: Color, strokeWidth?: LogicalPixel, userData?: object | null, visible?: boolean, zIndex?: ZIndex })
Parameters

color?

dashedStrokeOptions?

levelId?

LevelId|null

position

radius

strokeColor?

strokeWidth?

userData?

object|null

visible?

boolean

zIndex?

Returns
Properties

color​

Цвет заливки. Default: new Color({ })

dashedStrokeOptions​

Параметры пунктирной границы. Default: null

levelId​

LevelId|null

Привязка к поэтажному плану здания. Default: null

position​

Географическая позиция.

radius​

Радиус в метрах.

strokeColor​

Цвет линии границы окружности. Default: new Color({ })

strokeWidth​

Ширина линии границы окружности. Default: new LogicalPixel({ value: 0.0 })

userData​

object|null

Пользовательские данные (не используются внутри SDK, нужны только для пользователя API). Default: null

visible​

boolean

Флаг видимости. Default: true

zIndex​

Уровень отрисовки объекта. Default: new ZIndex({ value: 0 })

Closed​

Закрыто.

new Closed({ reason: ClosedReason, timeUntilOpen: Duration | null })
Parameters

reason

timeUntilOpen

Returns
Properties

reason​

Причина, по которой организация закрыта.

timeUntilOpen​

Время до открытия. Отсутствует, если организация закрыта навсегда.

ClosingHours​

Интервал, когда заведение закрыто.

new ClosingHours({ interval: WeekTimeInterval, reason: ClosedReason })
Parameters
Properties

interval​

Временной интервал.

reason​

Причина закрытия.

ClosingSoon​

Скоро закроется.

new ClosingSoon({ reason: ClosedReason, timeUntilClose: Duration })
Parameters

reason

timeUntilClose

Returns
Properties

reason​

Причина, по которой организация будет закрыта.

timeUntilClose​

Время до закрытия.

ClusterOptions​

Параметры маркера кластера.

new ClusterOptions({ attributes: [string, AttributeValue][], userData?: object | null })
Parameters

attributes

[string, AttributeValue][]

userData?

object|null
Returns
Properties

attributes​

[string, AttributeValue][]

Атрибуты кластера.

userData​

object|null

Пользовательские данные. Возвращаются в IClusterObject. Default: null

Color​

Цвет

new Color({ argb?: number })
Parameters

argb?

number
Returns
Properties

argb​

number

Default: 4278190080

CommonRecognizeSettings​

Общие настройки распознавания жестов.

new CommonRecognizeSettings({ interGestureTimeout?: Duration })
Parameters

interGestureTimeout?

Returns
Properties

interGestureTimeout​

Таймаут между распознаваемыми жестами. Используется для предотвращения ложных срабатываний в конце жеста. Default: Duration.ofMilliseconds(50)

Connector​

new Connector({ power: number, price: number, status: StatusType, type: string })
Parameters

power

number

price

number

status

type

string
Returns
Properties

power​

number

Мощность зарядки в кВт.

price​

number

Стоимость за один кВт·ч.

status​

Статус.

type​

string

Тип коннектора.

ContactInfo​

Способ связаться с организацией.

new ContactInfo({ comment: string | null, displayText: string, type: string, value: string })
Parameters

comment

string|null

displayText

string

type

string

value

string
Returns
Properties

comment​

string|null

Уточняющая информация о контакте.

displayText​

string

Значение контакта для вывода на экран.

type​

string

Тип контакта. Один из следующих:

  • email — электронная почта
  • website — сайт
  • phone — телефон
  • fax — факс
  • pobox — абонентский ящик
  • icq
  • jabber
  • skype
  • vkontakte
  • twitter
  • odnoklassniki
  • youtube
  • linkedin
  • googleplus
  • pinterest
  • whatsapp
  • viber
  • telegram

value​

string

Техническое значение контакта. В зависимости от типа контакта имеет следующую семантику:

  • email — адрес почты
  • website — полный url
  • phone — номер телефона в международном формате, например: "+73831234567"
  • fax — номер телефона в международном формате, например: "+73831234567"
  • pobox — адрес почтового ящика
  • icq — идентификатор пользователя
  • jabber — идентификатор пользователя
  • skype — идентификатор пользователя
  • vkontakte — полный url
  • twitter — полный url
  • odnoklassniki — полный url
  • youtube — полный url
  • linkedin — полный url
  • googleplus — полный url
  • pinterest — полный url
  • whatsapp — полный url
  • viber — полный url
  • telegram — полный url

DashedPolygonOptions​

Параметры пунктирного контура полигона.

new DashedPolygonOptions({ dashLength?: LogicalPixel, dashSpaceLength?: LogicalPixel })
Parameters

dashLength?

dashSpaceLength?

Returns
Properties

dashLength​

Длина пунктира. Default: new LogicalPixel({ value: 5.0 })

dashSpaceLength​

Длина межпунктирного расстояния. Default: new LogicalPixel({ value: 2.0 })

DashedPolylineOptions​

Параметры пунктирной полилинии.

new DashedPolylineOptions({ dashLength?: LogicalPixel, dashSpaceLength?: LogicalPixel })
Parameters

dashLength?

dashSpaceLength?

Returns
Properties

dashLength​

Длина пунктира. Default: new LogicalPixel({ value: 5.0 })

dashSpaceLength​

Длина межпунктирного расстояния. Default: new LogicalPixel({ value: 2.0 })

DashedStrokeCircleOptions​

new DashedStrokeCircleOptions({ dashLength?: LogicalPixel, dashSpaceLength?: LogicalPixel })
Parameters

dashLength?

dashSpaceLength?

Returns
Properties

dashLength​

Длина пунктира. Default: new LogicalPixel({ value: 5.0 })

dashSpaceLength​

Длина межпунктирного расстояния. Default: new LogicalPixel({ value: 2.0 })

DayTime​

Момент времени внутри дня.

new DayTime({ hours: number, minutes: number })
Parameters

hours

number

minutes

number
Returns
Properties

hours​

number

Часы, 0-23.

minutes​

number

Минуты, 0-59.

DefaultRasterUrlTemplate​

new DefaultRasterUrlTemplate({ urlTemplate: string })
Parameters

urlTemplate

string
Returns
Properties

urlTemplate​

string

DeviceDensity​

Множитель, который вычисляется как отношение DPI к базовому DPI устройства.

В Android соответствует resources.displayMetrics.density В iOS соответствует nativeScale

должен быть положительным.

new DeviceDensity({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

DevicePpi​

Разрешающая способность дисплея устройства, в пикселях на дюйм.

должна быть положительной.

new DevicePpi({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

DgisObjectId​

new DgisObjectId({ entranceId?: bigint, objectId?: bigint })
Parameters

entranceId?

bigint

objectId?

bigint
Returns
Properties

entranceId​

bigint

Стабильный числовой идентификатор входа/подъезда для объекта object_id. Default: 0n

Нулевой идентификатор означает что вход/подъезд не задан.

objectId​

bigint

Стабильный числовой идентификатор объекта. Default: 0n

Нулевой идентификатор не соответствует ни одному объекту.

DirectoryFilter​

Фильтры для справочника.

new DirectoryFilter({ dynamic: DynamicFilter[], workTime: WorkTimeFilter | null })
Parameters
Properties

dynamic​

Динамические фильтры.

workTime​

Фильтр по времени работы.

DragBeginData​

Данные о начале перетаскивания: точка старта перемещения и перемещаемый объект.

new DragBeginData({ item: RenderedObject, point: ScreenPoint })
Parameters

Elevation​

Неотрицательная высота точки над поверхностью в метрах.

new Elevation({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

EntranceGeometry​

Геометрии для отображения входа на карте.

new EntranceGeometry({ entrancePoints: GeoPoint[], entrancePolylines: GeoPoint[][] })
Parameters

entrancePoints

entrancePolylines

Returns
Properties

entrancePoints​

Местоположение входа.

entrancePolylines​

Геометрии стрелок, указывающих на вход.

EntranceInfo​

Информация о входе в здание.

new EntranceInfo({ apartmentRanges: ApartmentRange[], buildingNumber: string | null, entranceNumber: string | null, geometry: EntranceGeometry | null, id: DgisObjectId, porchName: string | null, porchNumber: string | null })
Parameters

apartmentRanges

buildingNumber

string|null

entranceNumber

string|null

geometry

id

porchName

string|null

porchNumber

string|null
Returns
Properties

apartmentRanges​

Номера квартир, относящихся к подъезду.

buildingNumber​

string|null

Номер дома, к которому относится вход.

entranceNumber​

string|null

Номер входа на станцию. Будет содержать информацию для объекта с типом ObjectType.StationEntrance.

geometry​

Геометрии для отображения входа на карте.

id​

Идентификатор объекта входа.

porchName​

string|null

Непустое имя подъезда. Заполняется только для подъездов. Может принимать значения имени подъезда (например "Подъезд 1") или номера здания, если подъезд имеет собственный адрес.

porchNumber​

string|null

Непустой номер подъезда. Заполняется только для подъездов. Может принимать значения номера подъезда (например "1") или номера здания, если подъезд имеет собственный адрес.

Fixed​

new Fixed({ theme: MapTheme })
Parameters

theme

Returns
Properties

FlagFilter​

Фильтр - флаг.

new FlagFilter({ displayName: string, flagValue: boolean | null, tagName: string })
Parameters

displayName

string

flagValue

boolean|null

tagName

string
Returns
Properties

displayName​

string

Название фильтра для отображения.

Зависит от языка выдачи. Не все названия могут быть переведены.

flagValue​

boolean|null

Значение флага.

tagName​

string

Тэг фильтра.

FloorInfo​

Информация об этажном плане для маркера - элемента поисковой выдачи.

new FloorInfo({ buildingId: BuildingId, levelId: LevelId })
Parameters

buildingId

levelId

Returns
Properties

buildingId​

Идентификатор здания.

levelId​

Идентификатор этажного плана.

FloorsInfo​

Информация об этажности объекта.

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

new FloorsInfo({ groundCount?: number, groundMinCount: number | null, undergroundCount: number | null })
Parameters

groundCount?

number

groundMinCount

number|null

undergroundCount

number|null
Returns
Properties

groundCount​

number

Количество надземный этажей (для домов переменной этажности — максимальное количество надземных этажей). Default: 0

groundMinCount​

number|null

Минимальное количество надземных этажей (для домов переменной этажности).

undergroundCount​

number|null

Количество подземных этажей

FollowPosition​

Настройки слежения за позицией.

new FollowPosition({ bearing?: FollowBearing, styleZoom?: FollowStyleZoom })
Parameters
Properties

bearing​

Default: FollowBearing.Off

styleZoom​

Default: FollowStyleZoom.Off

FormattedAddress​

Человекочитаемое представление адреса.

new FormattedAddress({ addressComment: string | null, drilldownAddress: string | null, postCode: string | null, streetAddress: string | null })
Parameters

addressComment

string|null

drilldownAddress

string|null

postCode

string|null

streetAddress

string|null
Returns
Properties

addressComment​

string|null

Комментарий к адресу. Пример: "301 офис; 9 этаж".

drilldownAddress​

string|null

Адрес из дриллдауна. Пример: "Новосибирск, Кировский район".

postCode​

string|null

Почтовый индекс объекта с кодом здания, если есть. Пример: "630088", "630007/XBVJF8".

streetAddress​

string|null

Адрес внутри населённого пункта. Пример: "Николаева, 11".

Fps​

Frames per second, частота кадров.

new Fps({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0

GeoPoint​

Точка в сферической системе координат, которая совместно с геодезической системой координат (например, WGS84) указывает на точку на поверхности Земли. Данная структура не привязана к конкретной геодезической системе координат. Но данный модуль содержит свободные функции, которые оперируют данной структурой уже в конкретной в системе координат (в какой именно см. в документации к функциям).

new GeoPoint({ latitude: Latitude, longitude: Longitude })
Parameters

latitude

longitude

Returns
Properties

latitude​

longitude​

isGeoPointValid​

boolean

GeoPointWithElevation​

Точка в географической системе координат (широта, долгота, возвышение).

возвышение (Elevation) в метрах над поверхностью, а не над уровнем моря.

new GeoPointWithElevation({ elevation?: Elevation, latitude: Latitude, longitude: Longitude })
Parameters

elevation?

latitude

longitude

Returns
Properties

elevation​

Default: new Elevation({ value: 0.0 })

latitude​

longitude​

GeoRect​

Прямоугольная область в сферической системе координат (например, WGS84). Данная структура не привязана к конкретной геодезической системе координат.

new GeoRect({ northEastPoint: GeoPoint, southWestPoint: GeoPoint })
Parameters

northEastPoint

southWestPoint

Returns
Methods
containsPoint(point: GeoPoint): boolean
Parameters

point

Returns
boolean
containsRect(rect2: GeoRect): boolean
Parameters

rect2

Returns
boolean
expandPoint(point: GeoPoint): GeoRect
Parameters

point

Returns
expandRect(rect2: GeoRect): GeoRect
Parameters

rect2

Returns
intersects(rect2: GeoRect): boolean
Parameters

rect2

Returns
boolean
Properties

northEastPoint​

Северо-восточная точка, правая верхняя граница прямоугольника.

southWestPoint​

Юго-западная точка, левая нижняя граница прямоугольника.

isDegenerate​

boolean

isGeoRectValid​

boolean

GestureActionEventCenter​

Выполнить жест относительно геометрического центра множества точек постановки пальцев.

new GestureActionEventCenter(__namedParameters: {  })
Parameters

__namedParameters

{ }
Returns

GestureActionMapPosition​

Выполнить жест относительно точки позиции карты.

new GestureActionMapPosition(__namedParameters: {  })
Parameters

__namedParameters

{ }
Returns

GestureActionTargetGeoPoint​

Выполнить жест относительно геопозиции target_geo_point.

new GestureActionTargetGeoPoint({ targetGeoPoint: GeoPoint })
Parameters
Properties

targetGeoPoint​

GradientPolylineOptions​

Параметры градиентной полилинии.

new GradientPolylineOptions({ borderColor?: Color, borderWidth?: LogicalPixel, colorIndices: number[], colors: Color[], gradientLength?: LogicalPixel, secondBorderColor?: Color, secondBorderWidth?: LogicalPixel })
Parameters

borderColor?

borderWidth?

colorIndices

number[]

colors

gradientLength?

secondBorderColor?

secondBorderWidth?

Returns
Properties

borderColor​

Цвет окантовки. Default: new Color({ })

borderWidth​

Ширина границы линии. Default: new LogicalPixel({ value: 0.0 })

colorIndices​

number[]

Индексы цветов градиентной полилинии. Количество индексов должно быть на 1 меньше количества точек полилинии.

colors​

Палитра цветов градиентной полилинии.

gradientLength​

Длина градиентной линии. Default: new LogicalPixel({ value: 1.0 })

secondBorderColor​

Цвет второй окантовки. Default: new Color({ })

secondBorderWidth​

Ширина второй границы линии. Default: new LogicalPixel({ value: 0.0 })

GroupItem​

Элемент объединенной карточки, содержащий информацию об объекте.

new GroupItem({ id: DgisObjectId, type: ObjectType })
Parameters
Properties

id​

Идентификатор объекта.

type​

Тип объекта.

HttpHeader​

new HttpHeader({ name: string, value: string })
Parameters

name

string

value

string
Returns
Properties

name​

string

value​

string

HttpOptions​

Опции Http-клиента.

new HttpOptions({ cacheMaxSize?: bigint | null, cacheStoragePath?: string | null, certificates?: Certificate[] | null, proxy?: HttpProxyOptions | null, timeout?: Duration, useCache?: boolean })
Parameters

cacheMaxSize?

bigint|null

cacheStoragePath?

string|null

certificates?

proxy?

timeout?

useCache?

boolean
Returns
Properties

cacheMaxSize​

bigint|null

Максимальный размер HTTP-кеша в байтах. Если не указан, по умолчанию максимальный размер HTTP кэша составляет 300 Мб. Default: null

cacheStoragePath​

string|null

Путь к каталогу верхнего уровня для основного файлового хранилища HTTP кэша. Файловое хранилище будет находиться в подкаталоге http_cache в данном каталоге. Если путь не указан, будет использоваться директория по умолчанию. Default: null

certificates​

Сертификаты в PEM-формате. Если не заданы, используются системные + поставляемые вместе с SDK. Default: null

proxy​

Настройки proxy. Default: null

timeout​

Таймаут для HTTP-запросов. Default: Duration.ofMilliseconds(15000)

useCache​

boolean

Использовать HTTP кэш. Default: true

HttpProxyOptions​

Настройки proxy.

new HttpProxyOptions({ host: string, port?: number })
Parameters

host

string

port?

number
Returns
Properties

host​

string

port​

number

Default: 0

HttpRequest​

Структура для представления HTTP запроса.

new HttpRequest({ body?: number[] | null, headers?: HttpHeader[], method?: HttpMethod, url: string })
Parameters

body?

number[]|null

headers?

method?

url

string
Returns
Properties

body​

number[]|null

Тело запроса. По умолчанию отсутствует. Default: null

headers​

Заголовки запроса. По умолчанию пусто. Default: []

method​

Метод HTTP запроса. По умолчанию GET. Default: HttpMethod.GET

url​

string

Строковое представление URL запроса.

HttpResponse​

Структура для представления ответа на HTTP запрос.

тело ответа хранится и обрабатывается отдельно.

new HttpResponse({ headers: HttpHeader[], statusCode: HttpStatusCode })
Parameters
Properties

headers​

Заголовки ответа.

statusCode​

HTTP статус код ответа от сервера.

HttpStatusCode​

HTTP статус код ответа.

new HttpStatusCode({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0

ImageData​

Данные изображения: размер, формат и бинарные данные.

new ImageData({ data: number[], format: ImageFormat, size: ScreenSize })
Parameters

data

number[]

format

size

Returns
Properties

data​

number[]

format​

size​

IsOpenAllDay​

Работает круглосуточно в указанный день недели. Если день не указан - проверяется сегодняшний день.

new IsOpenAllDay({ weekDay: WeekDay | null })
Parameters

weekDay

WeekDay|null
Returns
Properties

weekDay​

WeekDay|null

IsOpenNow​

Открыто сейчас.

new IsOpenNow(__namedParameters: {  })
Parameters

__namedParameters

{ }
Returns

KeyFromAsset​

Ключ из asset-а. Для Android это директория assets. Для iOS это директория Bundle.main.

new KeyFromAsset({ path: string })
Parameters

path

string
Returns
Properties

path​

string

Путь относительно корневой директории asset-ов.

KeyFromFile​

Ключ из файла.

new KeyFromFile({ path: string })
Parameters

path

string
Returns
Properties

path​

string

Путь к файлу.

KeyFromString​

Ключ из строки.

new KeyFromString({ contents: string })
Parameters

contents

string
Returns
Properties

contents​

string

Содержимое.

LabelingPriority​

Приоритет лейблинга.

new LabelingPriority({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0

Latitude​

Географическая широта.

new Latitude({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

LevelId​

Идентификатор этажного плана.

new LevelId({ value?: bigint })
Parameters

value?

bigint
Returns
Properties

value​

bigint

Default: 0n

LevelInfo​

Информация об этаже здания.

new LevelInfo({ id: LevelId | null, linkedLevelIds: LevelId[], name: string })
Parameters

id

LevelId|null

linkedLevelIds

name

string
Returns
Properties

id​

LevelId|null

Идентификатор этажного плана.

linkedLevelIds​

Идентификаторы связанных этажных планов.

name​

string

Название этажа.

Locale​

Локаль.

new Locale({ language: string, region: string })
Parameters

language

string

region

string
Returns
Methods
toLocalePosix(): string
Returns
string
makeLocale(localeStr: string): Locale | null
Parameters

localeStr

string
Returns
Localenull
Properties

language​

string

Код языка, описанный в стандарте ISO 639-1,

region​

string

Код страны, описанный в стандарте ISO 3166-1.

Location​

new Location({ altitude: LocationFuzzyDouble | null, coordinates: LocationCoordinates, course: LocationCourse | null, groundSpeed: LocationFuzzyDouble | null, source: string, timestamp?: Duration })
Parameters

altitude

coordinates

course

groundSpeed

source

string

timestamp?

Returns
Properties

altitude​

coordinates​

course​

groundSpeed​

source​

string

timestamp​

Default: Duration.ofMilliseconds(0)

LocationCoordinates​

new LocationCoordinates({ accuracy: number, value: GeoPoint })
Parameters

accuracy

number

value

Returns
Properties

accuracy​

number

value​

LocationCourse​

new LocationCourse({ accuracy: Bearing | null, value: Bearing })
Parameters

accuracy

Bearing|null

value

Returns
Properties

accuracy​

Bearing|null

value​

LocationFuzzyDouble​

new LocationFuzzyDouble({ accuracy: number | null, value: number })
Parameters

accuracy

number|null

value

number
Returns
Properties

accuracy​

number|null

value​

number

LogicalPixel​

Пиксель, размер которого не зависит от плотности экрана.

1 логический пиксель соответствует 1 / (базовый ppi) дюйма. Базовый PPI зависит от устройства и вычисляется из отношения DevicePpi/DeviceDensity. DevicePpi и DeviceDensity, в свою очередь, задаются с ОС через интерфейс карты. Для Android LogicalPixel соответствует dp, для iOS - point'у.

new LogicalPixel({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

LogMessage​

Сообщение, записываемое в лог.

new LogMessage({ file: string, level: LogLevel, line: number, text: string })
Parameters

file

string

level

line

number

text

string
Returns
Properties

file​

string

Имя файла, в котором было записано сообщение.

level​

Уровень логирования.

line​

number

Номер строки, в которой было записано сообщение.

text​

string

Содержимое сообщения.

LogOptions​

Настройки логирования.

new LogOptions({ customLevel?: LogLevel, customSink?: LogSink | null, systemLevel?: LogLevel })
Parameters

customLevel?

customSink?

LogSink|null

systemLevel?

Returns
Properties

customLevel​

Уровень логирования в пользовательский приемник. Default: LogLevel.Warning

customSink​

LogSink|null

Пользовательский приемник логирования. Default: null

systemLevel​

Уровень логирования в системный лог. Default: LogLevel.Warning

Longitude​

Географическая долгота.

new Longitude({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

MapControllerOptions​

new MapControllerOptions({ attributes?: [string, AttributeValue][], fontIconSizeMultiplier?: number | null, graphicsPreset?: GraphicsPreset | null, mapAppearance?: MapAppearance | null, maxFps?: Fps | null, position?: CameraPosition | null, positionPoint?: CameraPositionPoint | null, powerSavingMaxFps?: Fps | null, sources?: Source[], style?: Style | null, styleFile?: File | null, zoomRestrictions?: CameraZoomRestrictions | null })
Parameters

attributes?

[string, AttributeValue][]

fontIconSizeMultiplier?

number|null

graphicsPreset?

mapAppearance?

maxFps?

Fps|null

position?

positionPoint?

powerSavingMaxFps?

Fps|null

sources?

style?

Style|null

styleFile?

File|null

zoomRestrictions?

Returns
Properties

attributes​

[string, AttributeValue][]

Атрибуты карты, применяемые при создании. Default: []

fontIconSizeMultiplier​

number|null

Множитель размера иконок и шрифтов. Не задано: множитель не применяется. Default: null

graphicsPreset​

Графический пресет качества. Не задано: пресет по умолчанию. Default: null

mapAppearance​

Выбор темы внутри выбранного стиля карты с учётом окружения. Default: null

maxFps​

Fps|null

Ограничение частоты кадров. Не задано: ограничения нет. Default: null

position​

Начальная позиция камеры. Не задано: позиция по умолчанию. Default: null

positionPoint​

Относительное расположение точки местоположения карты в пространстве вида камеры. Default: null

powerSavingMaxFps​

Fps|null

Ограничение частоты кадров в режиме энергосбережения. Не задано: ограничения нет. Default: null

sources​

Источники данных, добавляемые на карту при создании. Default: []

style​

Style|null

Cтиль карты. Не задано: используется стиль по умолчанию. Default: null

styleFile​

File|null

Файл стиля карты. Не задано: используется стиль по умолчанию. Default: null

zoomRestrictions​

Начальный допустимый диапазон изменения уровня масштабирования. Не задано: диапазон по умолчанию. Default: null

MapDirection​

Угол поворота объекта относительно направления на север, в градусах, отсчитывается по часовой стрелке.

new MapDirection({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

MapId​

Идентификатор экземпляра карты, уникальный в рамках процесса.

new MapId({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0

MapTheme​

Тема для использования в карте.

new MapTheme({ loadingBackground: Color, name: string })
Parameters

loadingBackground

name

string
Returns
Properties

loadingBackground​

Цвет подложки, используемый до загрузки стилей и отображения подложки карты. В темах по умолчанию соответствует цвету подложки карты по умолчанию.

name​

string

Код стиля из редактора стилей.

defaultDarkTheme​

defaultTheme​

MarkedUpText​

Размеченный текст.

new MarkedUpText({ matchedParts: MarkedUpTextSpan[], text: string })
Parameters

matchedParts

text

string
Returns
Properties

matchedParts​

Набор непересекающихся Span в порядке их расположения в строке text, описывающих части, совпадающие с пользовательским запросом.

text​

string

Текст.

MarkedUpTextSpan​

Описывает поднабор байтов строки text.

new MarkedUpTextSpan({ length: bigint, offset: bigint })
Parameters

length

bigint

offset

bigint
Returns
Properties

length​

bigint

offset​

bigint

MarkerOptions​

Параметры маркера.

new MarkerOptions({ anchor?: Anchor, animatedAppearance?: boolean, draggable?: boolean, icon: Image | null, iconAnimationMode?: AnimationMode, iconMapDirection?: MapDirection | null, iconOpacity?: Opacity, iconWidth?: LogicalPixel, labelingPriority?: LabelingPriority, levelId?: LevelId | null, position: GeoPointWithElevation, suppressOnOverlap?: boolean, text?: string | null, textStyle?: TextStyle | null, userData?: object | null, visible?: boolean, zIndex?: ZIndex })
Parameters

anchor?

animatedAppearance?

boolean

draggable?

boolean

icon

Image|null

iconAnimationMode?

iconMapDirection?

iconOpacity?

iconWidth?

labelingPriority?

levelId?

LevelId|null

position

suppressOnOverlap?

boolean

text?

string|null

textStyle?

userData?

object|null

visible?

boolean

zIndex?

Returns
Properties

anchor​

Default: new Anchor({ x: 0.5, y: 0.5 })

animatedAppearance​

boolean

Анимировать ли появление. Default: true

draggable​

boolean

Default: false

icon​

Image|null

iconAnimationMode​

Режим анимации. Default: AnimationMode.Normal

iconMapDirection​

Default: null

iconOpacity​

Default: new Opacity({ value: 1.0 })

iconWidth​

Целевая ширина, используемая для масштабирования. Default: new LogicalPixel({ value: 0.0 })

labelingPriority​

Приоритет лейблинга иконки маркера. Default: new LabelingPriority({ value: 0 })

levelId​

LevelId|null

Привязка к поэтажному плану здания. Default: null

position​

suppressOnOverlap​

boolean

Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов). Default: false

text​

string|null

Default: null

textStyle​

Default: null

userData​

object|null

Default: null

visible​

boolean

Default: true

zIndex​

Уровень отрисовки объекта. Default: new ZIndex({ value: 0 })

Meter​

Длина/расстояние в метрах.

new Meter({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

ModelMapObjectOptions​

Параметры модели.

new ModelMapObjectOptions({ data: ModelData | null, levelId?: LevelId | null, mapDirection?: MapDirection | null, opacity?: Opacity, position: GeoPointWithElevation, size: ModelSize, userData?: object | null, visible?: boolean })
Parameters

data

levelId?

LevelId|null

mapDirection?

opacity?

position

size

userData?

object|null

visible?

boolean
Returns
Properties

data​

Данные.

levelId​

LevelId|null

Привязка к поэтажному плану здания. Default: null

mapDirection​

Угол поворота модели на карте относительно направления на север, по часовой стрелке. Default: null

opacity​

Прозрачность. Default: new Opacity({ value: 1.0 })

position​

Местоположение.

size​

Целевая ширина, используемая для масштабирования.

userData​

object|null

Пользовательские данные. Default: null

visible​

boolean

Видимость. Default: true

ModelScale​

Коэффициент масштабирования модели. Подбирается вручную. Значение варьируется от 0.0 до 64.0.

new ModelScale({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

MultiTouchRecognizeSettings​

Настройки распознавания касания несколькими пальцами.

new MultiTouchRecognizeSettings({ multiTouchShiftThresholdMm?: number })
Parameters

multiTouchShiftThresholdMm?

number
Returns
Properties

multiTouchShiftThresholdMm​

number

Порог сдвига взвешенного среднего точек, в миллиметрах, преодоление которого говорит о начале сдвига несколькими пальцами. Default: 7.0

MyLocationControllerSettings​

Настройки контроллера перемещения маркера геопозиции.

new MyLocationControllerSettings({ animationDuration?: Duration, bearingSource?: BearingSource | null, bearingThreshold?: Bearing, coordinatesThreshold?: Meter })
Parameters

animationDuration?

bearingSource?

bearingThreshold?

coordinatesThreshold?

Returns
Properties

animationDuration​

Неотрицательная длительность изменения реального направления. Default: Duration.ofMilliseconds(1000)

bearingSource​

Источник направления. Если отсутствует, будет отображаться маркер без направления. Default: 0

bearingThreshold​

Неотрицательное пороговое значение учитываемого изменения реального направления. Default: new Bearing({ value: 1.0 })

coordinatesThreshold​

Неотрицательное пороговое значение учитываемого изменения реальной позиции и её точности. Default: new Meter({ value: 0.1 })

NearestPlatform​

Информация о платформе.

new NearestPlatform({ color: Color | null, headingTo: string | null, id: DgisObjectId, name: string, transitionType: NearestPlatformTransitionType | null })
Parameters

color

Color|null

headingTo

string|null

id

name

string

transitionType

Returns
Properties

color​

Color|null

Цветовое кодирование маршрута.

headingTo​

string|null

Описание направления остановочной платформы.

id​

Уникальный идентификатор остановочной платформы.

name​

string

Название остановки.

transitionType​

Тип перехода.

NearestStation​

Информация о станции.

new NearestStation({ color: Color | null, distance?: number, id: DgisObjectId, internalTransition?: boolean, name: string, routeTypes: PublicTransportRouteType[] })
Parameters

color

Color|null

distance?

number

id

internalTransition?

boolean

name

string

routeTypes

Returns
Properties

color​

Color|null

Цветовое кодирование маршрута.

distance​

number

Расстояние от описываемого объекта до ближайшей остановочной платформы данной остановки в метрах. Default: 0

id​

Уникальный идентификатор остановки.

internalTransition​

boolean

Существует ли внутренний переход на эту станцию из описываемого объекта. Default: false

name​

string

Название остановки.

routeTypes​

Типы транспорта, проходящие через эту остановку.

Opacity​

Непрозрачность - от 0.0 (полная прозрачность) до 1.0 (полная непрозрачность).

new Opacity({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

Opened​

Открыто.

new Opened({ timeUntilClose: Duration | null })
Parameters

timeUntilClose

Returns
Properties

timeUntilClose​

Время до закрытия. Отсутствует у круглосуточных организаций.

OpeningHours​

Часы работы организации.

new OpeningHours({ isOpen24x7: boolean, weekClosingHours: ClosingHours[][], weekOpeningHours: WeekTimeInterval[][] })
Parameters

isOpen24x7

boolean

weekClosingHours

weekOpeningHours

Returns
Properties

isOpen24x7​

boolean

Признак, что организация работает круглосуточно.

weekClosingHours​

Нерабочие интервалы для каждого дня недели, начиная с понедельника.

weekOpeningHours​

Часы работы для каждого дня недели, начиная с понедельника.

OpeningSoon​

Скоро откроется.

new OpeningSoon({ timeUntilOpen: Duration })
Parameters

timeUntilOpen

Returns
Properties

timeUntilOpen​

Время до открытия.

OrderedValue​

Описывает одно значение из набора.

new OrderedValue({ text: string | null, value: string })
Parameters

text

string|null

value

string
Returns
Properties

text​

string|null

Название значения.

value​

string

Значение, по которым происходит фильтрация.

OrderedValues​

Описывает набор дискретных упорядоченных значений.

new OrderedValues({ currentMaxIndex?: bigint | null, currentMinIndex?: bigint | null, values: OrderedValue[] })
Parameters

currentMaxIndex?

bigint|null

currentMinIndex?

bigint|null

values

Returns
Properties

currentMaxIndex​

bigint|null

Индекс текущего установленного максимального значения.

Default: null

currentMinIndex​

bigint|null

Индекс текущего установленного минимального значения.

Default: null

values​

Набор значений. Упорядочен по возрастанию.

OrgId​

Идентификатор организации.

new OrgId({ value?: bigint })
Parameters

value?

bigint
Returns
Properties

value​

bigint

Default: 0n

OrgInfo​

Информация об организации.

new OrgInfo({ branchCount: number, id: OrgId, name: string | null })
Parameters

branchCount

number

id

name

string|null
Returns
Properties

branchCount​

number

Количество филиалов организации.

id​

Уникальный идентификатор организации.

name​

string|null

Название организации.

OverviewMode​

Режим обзорного вида здания (модель или мастер-план).

new OverviewMode(__namedParameters: {  })
Parameters

__namedParameters

{ }
Returns

Padding​

Отступы от краёв камеры.

Задаётся от краёв внутрь, в физических пикселях. Отступы влияют на:

  • точку позиции;
  • анимированное перемещение карты;
  • расположение динамических объектов карты (например баблы маршрутов).
new Padding({ bottom?: number, left?: number, right?: number, top?: number })
Parameters

bottom?

number

left?

number

right?

number

top?

number
Returns
Properties

bottom​

number

Отступ снизу внутрь. Default: 0

left​

number

Отступ слева внутрь. Default: 0

right​

number

Отступ справа внутрь. Default: 0

top​

number

Отступ сверху внутрь. Default: 0

ParkingCapacity​

Вместимость парковки.

new ParkingCapacity({ specialSpaces: SpecialSpace[], total: string | null })
Parameters

specialSpaces

total

string|null
Returns
Properties

specialSpaces​

Описание особых мест для парковки.

total​

string|null

Общая вместимость парковки, машиномест.

ParkingInfo​

Общая информация о парковке.

new ParkingInfo({ access: ParkingAccess, capacity: ParkingCapacity | null, forTrucks: boolean, isIncentive: boolean, isPaid: boolean, levelCount: number | null, pavingType: ParkingPavingType | null, purpose: ParkingPurpose, type: ParkingType | null })
Parameters

access

capacity

forTrucks

boolean

isIncentive

boolean

isPaid

boolean

levelCount

number|null

pavingType

purpose

type

Returns
Properties

access​

Тип доступа.

capacity​

Вместимость.

forTrucks​

boolean

Есть места для грузовиков.

isIncentive​

boolean

Является ли парковка перехватывающей.

isPaid​

boolean

Является ли парковка платной.

levelCount​

number|null

Количество уровней.

pavingType​

Тип покрытия.

purpose​

Назначение.

type​

Тип.

PlatformHeading​

Информация о направлении устройста, которую отдает платформа.

new PlatformHeading({ heading: LocationCourse, timestamp: Duration })
Parameters
Properties

heading​

Направление.

timestamp​

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

PolygonOptions​

Параметры полигона.

new PolygonOptions({ color?: Color, contours: GeoPoint[][], dashedPolygonOptions?: DashedPolygonOptions | null, elevation?: Elevation | null, levelId?: LevelId | null, strokeColor?: Color, strokeWidth?: LogicalPixel, userData?: object | null, visible?: boolean, zIndex?: ZIndex })
Parameters

color?

contours

dashedPolygonOptions?

elevation?

levelId?

LevelId|null

strokeColor?

strokeWidth?

userData?

object|null

visible?

boolean

zIndex?

Returns
Properties

color​

Default: new Color({ })

contours​

dashedPolygonOptions​

Параметры пунктирного контура полигона. Default: null

elevation​

Высота полигона над поверхностью в метрах. Default: null

levelId​

LevelId|null

Привязка к поэтажному плану здания. Default: null

strokeColor​

Default: new Color({ })

strokeWidth​

Default: new LogicalPixel({ value: 0.0 })

userData​

object|null

Default: null

visible​

boolean

Default: true

zIndex​

Уровень отрисовки объекта. Default: new ZIndex({ value: 0 })

PolylineOptions​

Параметры полилинии.

new PolylineOptions({ color?: Color, dashedPolylineOptions?: DashedPolylineOptions | null, elevation?: Elevation | null, erasedPart?: number, gradientPolylineOptions?: GradientPolylineOptions | null, levelId?: LevelId | null, points: GeoPoint[], userData?: object | null, visible?: boolean, width?: LogicalPixel, zIndex?: ZIndex })
Parameters

color?

dashedPolylineOptions?

elevation?

erasedPart?

number

gradientPolylineOptions?

levelId?

LevelId|null

points

userData?

object|null

visible?

boolean

width?

zIndex?

Returns
Properties

color​

Основной цвет полилинии. Default: new Color({ })

dashedPolylineOptions​

Параметры пунктирной полилинии. Default: null

Пунктирная градиентная линия в данный момент не поддерживается, поэтому если в PolylineOptions присутствуют и dashed_polyline_options, и gradient_polyline_options, то dashed_polyline_options будут проигнорированы при создании полилинии.

elevation​

Высота полилинии над поверхностью в метрах. Default: null

erasedPart​

number

Доля стёртой части полилинии, должна быть в диапазоне [0; 1] Default: 0.0

gradientPolylineOptions​

Параметры градиентной полилинии. Default: null

Пунктирная градиентная линия в данный момент не поддерживается, поэтому если в PolylineOptions присутствуют и dashed_polyline_options, и gradient_polyline_options, то dashed_polyline_options будут проигнорированы при создании полилинии.

levelId​

LevelId|null

Привязка к поэтажному плану здания. Default: null

points​

Точки полилинии.

userData​

object|null

Пользовательские данные. Default: null

visible​

boolean

Видимость полилинии. Default: true

width​

Ширина полилинии. Default: new LogicalPixel({ value: 1.0 })

zIndex​

Уровень отрисовки объекта. Default: new ZIndex({ value: 0 })

PublicTransportDirectoryPlatformDepartureInfo​

Справочная информация об отправлении с платформы.

new PublicTransportDirectoryPlatformDepartureInfo({ departureTime?: DayTime, platformId: DgisObjectId })
Parameters
Properties

departureTime​

Точное время проезда транспорта в формате HH:MM (в локальном для объекта часовом поясе). Default: new DayTime({ hours: 0, minutes: 0 })

platformId​

Идентификатор платформы.

PublicTransportDirectoryRouteDirectionNamesInfo​

Информация о наименованиях начальной и конечной остановках маршрута.

new PublicTransportDirectoryRouteDirectionNamesInfo({ fromName: string, toName: string })
Parameters

fromName

string

toName

string
Returns
Properties

fromName​

string

Начальная остановка маршрута.

toName​

string

Конечная остановка маршрута.

PublicTransportDirectoryRouteInfo​

Справочная информация о маршруте общественного транспорта.

new PublicTransportDirectoryRouteInfo({ color: Color | null, directions: PublicTransportRouteDirection[], fromToStationNames: PublicTransportDirectoryRouteDirectionNamesInfo | null, id: DgisObjectId, name: string, routeType: PublicTransportRouteType })
Parameters
Properties

color​

Color|null

Цветовое кодирование маршрута.

directions​

Направления маршрута. Для остановочной платформы (тип ObjectType.StationPlatform) может не содержать информацию о направлениях, которые проходят через платформу. Для получения направлений необходимо сделать поисковой запрос с идентификатором маршрута.

fromToStationNames​

Информация о наименованиях начальной и конечной остановках маршрута.

id​

Идентификатор маршрута.

name​

string

Название маршрута.

routeType​

Тип маршрута.

PublicTransportDirectoryRouteScheduleInfo​

Справочная информация о расписаниях платформ и направлений на маршруте.

new PublicTransportDirectoryRouteScheduleInfo({ fullDayPlatforms: [PublicTransportRouteDirectionId, [DgisObjectId, PublicTransportPlatformSchedule[]][]][], intervalTrips: [PublicTransportRouteDirectionId, PublicTransportIntervalSchedule][], nearTrips: [PublicTransportRouteDirectionId, [DgisObjectId, PublicTransportNearTripSchedule][]][] })
Parameters

fullDayPlatforms

[PublicTransportRouteDirectionId, [DgisObjectId, PublicTransportPlatformSchedule[]][]][]

intervalTrips

[PublicTransportRouteDirectionId, PublicTransportIntervalSchedule][]

nearTrips

[PublicTransportRouteDirectionId, [DgisObjectId, PublicTransportNearTripSchedule][]][]
Returns
Properties

fullDayPlatforms​

[PublicTransportRouteDirectionId, [DgisObjectId, PublicTransportPlatformSchedule[]][]][]

Расписания для платформ до конца дня.

intervalTrips​

[PublicTransportRouteDirectionId, PublicTransportIntervalSchedule][]

Ближайшие интервальные расписания для направлений.

nearTrips​

[PublicTransportRouteDirectionId, [DgisObjectId, PublicTransportNearTripSchedule][]][]

Ближайшие рейсы для направлений до конечной платформы.

PublicTransportDirectoryScheduleInfo​

Справочная информация о расписаниях платформ и направлений.

new PublicTransportDirectoryScheduleInfo({ fullDayPlatforms: [DgisObjectId, [PublicTransportRouteDirectionId, PublicTransportPlatformSchedule[]][]][], nearTrips: [DgisObjectId, [PublicTransportRouteDirectionId, PublicTransportNearTripSchedule][]][], routeSchedules: [DgisObjectId, PublicTransportDirectoryRouteScheduleInfo][] })
Parameters

fullDayPlatforms

[DgisObjectId, [PublicTransportRouteDirectionId, PublicTransportPlatformSchedule[]][]][]

nearTrips

[DgisObjectId, [PublicTransportRouteDirectionId, PublicTransportNearTripSchedule][]][]

routeSchedules

[DgisObjectId, PublicTransportDirectoryRouteScheduleInfo][]
Returns
Properties

fullDayPlatforms​

[DgisObjectId, [PublicTransportRouteDirectionId, PublicTransportPlatformSchedule[]][]][]

Расписания для платформы по маршутам до конца дня. Поле будет заполнено для объекта типа ObjectType.StationPlatform.

Массив с объектами PublicTransportPlatformSchedule представляет последовательность расписаний, следующих друг за другом. Например:

  1. Транспорт отправляется с периодом в 2 минуты (period) начиная с 1747353600 (start_time) и заканчивая 1747360800 (finish_time)
  2. Далее отправляется по расписанию в 12:15 - precise_time, 12:30 и 13:00

nearTrips​

[DgisObjectId, [PublicTransportRouteDirectionId, PublicTransportNearTripSchedule][]][]

Ближайшие рейсы для направлений по маршрутам до конечной платформы. Поле будет заполнено для объекта типа ObjectType.StationPlatform.

routeSchedules​

[DgisObjectId, PublicTransportDirectoryRouteScheduleInfo][]

Справочная информация о расписаниях платформ и направлений для маршрутов.

PublicTransportIntervalSchedule​

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

new PublicTransportIntervalSchedule({ period?: number, workHours: PublicTransportIntervalWorkingHours | null })
Parameters
Properties

period​

number

Период следования транспорта в минутах. Default: 0

workHours​

Время действия интервального расписания.

PublicTransportIntervalWorkingHours​

Время действия интервального расписания.

new PublicTransportIntervalWorkingHours({ finishTime?: bigint, finishTimeUtc?: bigint, startTime?: bigint, startTimeUtc?: bigint })
Parameters

finishTime?

bigint

finishTimeUtc?

bigint

startTime?

bigint

startTimeUtc?

bigint
Returns
Properties

finishTime​

bigint

Время окончания действия интервального расписания (в локальном для объекта часовом поясе) в системе UNIX. Default: 0n

finishTimeUtc​

bigint

Время окончания действия интервального расписания в системе UNIX по UTC. Default: 0n

startTime​

bigint

Время начала действия интервального расписания (в локальном для объекта часовом поясе) в системе UNIX. Default: 0n

startTimeUtc​

bigint

Время начала действия интервального расписания в системе UNIX по UTC. Default: 0n

PublicTransportNearTripSchedule​

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

new PublicTransportNearTripSchedule({ period: number | null, platformTimes: PublicTransportDirectoryPlatformDepartureInfo[] })
Parameters
Properties

period​

number|null

Период следования транспорта в минутах.

platformTimes​

Расписание отправлений для платформ.

PublicTransportPlatform​

Справочная информация об остановочной платформе.

new PublicTransportPlatform({ description: string | null, id: DgisObjectId, name: string, position: GeoPoint | null, stationId: DgisObjectId, transitions: PublicTransportPlatformTransition[] })
Parameters

description

string|null

id

name

string

position

stationId

transitions

Returns
Properties

description​

string|null

Краткое описание места расположения остановочной платформы.

id​

Идентификатор остановочной платформы.

name​

string

Название остановки.

position​

Позиция.

stationId​

Идентификатор остановки. Например, автобусная остановка или станция метро, на которой находится платформа, или любая другая остановка.

transitions​

Справочная информация о других маршрутах общественного транспорта, на которые можно пересесть на данной остановочной платформе.

PublicTransportPlatformSchedule​

Расписание платформы.

new PublicTransportPlatformSchedule({ schedule: PublicTransportSchedule, startTime?: bigint, startTimeUtc?: bigint })
Parameters

schedule

startTime?

bigint

startTimeUtc?

bigint
Returns
Properties

schedule​

Расписание следования транспорта.

startTime​

bigint

Время наступления события (в локальном для объекта часовом поясе). Default: 0n

startTimeUtc​

bigint

Время наступления события в UTC. Default: 0n

PublicTransportPlatformTransition​

Справочная информация о маршруте общественного транспорта, на который можно пересесть на остановочной платформе.

new PublicTransportPlatformTransition({ color: Color | null, routeId: DgisObjectId, routeName: string, routeType: PublicTransportRouteType, stationId: DgisObjectId, stationName: string })
Parameters

color

Color|null

routeId

routeName

string

routeType

stationId

stationName

string
Returns
Properties

color​

Color|null

Цветовое кодирование маршрута.

routeId​

Идентификатор связанного маршрута.

routeName​

string

Название связанного маршрута.

routeType​

Тип маршрута.

stationId​

Идентификатор остановки.

stationName​

string

Название остановки или станции.

PublicTransportPreciseSchedule​

Точное расписание проезда общественного транспорта через платформу.

new PublicTransportPreciseSchedule({ nextTrips: bigint[], nextTripsUtc: bigint[], preciseTime: DayTime })
Parameters

nextTrips

bigint[]

nextTripsUtc

bigint[]

preciseTime

Returns
Properties

nextTrips​

bigint[]

Массив с временем следующих рейсов (в локальном для объекта часовом поясе).

nextTripsUtc​

bigint[]

Массив с временем следующих рейсов в UTC.

preciseTime​

Точное время проезда транспорта в формате HH:MM (в локальном для объекта часовом поясе).

PublicTransportRouteDirection​

Направление маршрута общественного транспорта.

new PublicTransportRouteDirection({ geometry: PublicTransportRouteGeometry | null, id: PublicTransportRouteDirectionId, platforms: PublicTransportPlatform[], type: PublicTransportRouteDirectionType })
Parameters
Properties

geometry​

Геометрия направления маршрута.

id​

Идентификатор направления маршрута.

platforms​

Последовательность остановочных платформ маршрута.

type​

Тип направления маршрута.

PublicTransportRouteDirectionId​

Идентификатор направления маршрута общественного транспорта.

new PublicTransportRouteDirectionId({ value?: bigint })
Parameters
Properties

value​

bigint

Default: 0n

PublicTransportRouteGeometry​

Геометрия направления маршрута общественного транспорта.

new PublicTransportRouteGeometry({ centroid: GeoPoint | null, line: PolylineGeometry })
Parameters
Properties

centroid​

Визуальный центр геометрии объекта.

line​

Линия маршрута.

PurposeCode​

Код назначения здания.

new PurposeCode({ value?: bigint })
Parameters

value?

bigint
Returns
Properties

value​

bigint

Default: 0n

RangeFilter​

Фильтр диапазонов значений.

new RangeFilter({ displayName: string, maxValue: number, minValue: number, tagName: string })
Parameters

displayName

string

maxValue

number

minValue

number

tagName

string
Returns
Properties

displayName​

string

Название фильтра для отображения.

Зависит от языка выдачи. Не все названия могут быть переведены.

maxValue​

number

Максимальное значение диапазона.

minValue​

number

Минимальное значение диапазона.

tagName​

string

Тэг фильтра.

RenderedObject​

Отображаемый объект карты.

new RenderedObject({ item: MapObject, levelId?: LevelId | null, source: Source })
Parameters

item

levelId?

LevelId|null

source

Returns
Properties

item​

Объект карты.

levelId​

LevelId|null

Идентификатор этажного плана здания, на котором расположен объект. Default: null

source​

Источник данных, содержащий объект карты.

RenderedObjectInfo​

Подробная информация об отображаемом объекте карты.

new RenderedObjectInfo({ closestMapPoint: GeoPointWithElevation, closestViewportPoint: ScreenPoint, item: RenderedObject })
Parameters

closestMapPoint

closestViewportPoint

item

Returns
Properties

closestMapPoint​

Ближайшая точка объекта в координатах карты.

closestViewportPoint​

Ближайшая точка объекта в координатах экрана.

item​

Отображаемый объект карты.

Reviews​

Отзывы.

new Reviews({ count?: number, countWithStars?: number, rating?: number })
Parameters

count?

number

countWithStars?

number

rating?

number
Returns
Properties

count​

number

Количество отзывов. Default: 0

countWithStars​

number

Общее количество оценок (включая отзывы без текста). Default: 0

rating​

number

Рейтинг в диапазоне от 0 до 5. Default: 0.0

RoadCameraInfo​

Информация о камере.

new RoadCameraInfo({ purposes: EnumSet<CameraPurpose>, speedLimit: number | null })
Parameters

purposes

speedLimit

number|null
Returns
Properties

purposes​

Назначения камеры.

Могут отсутствовать, если нет информации, или если камеру добавил пользователь.

speedLimit​

number|null

Ограничение скорости в км/ч.

На текущий момент доступно только для камер, контролирующих скорость и среднюю скорость на участке.

Может отсутствовать и для камер контроля скорости, если значение неизвестно.

RoadEventActionInfo​

Информация о действии.

new RoadEventActionInfo({ count: number | null, state: RoadEventActionState })
Parameters

count

number|null

state

Returns
Properties

count​

number|null

Количество действий, применённых к событию всеми пользователями (только для пользовательских событий).

state​

Состояние действия.

RoadEventFilterData​

Данные о дорожном событии, используемые для фильтрации.

new RoadEventFilterData({ finishTime: TimePoint | null, startTime: TimePoint | null, type: RoadEventType })
Parameters

finishTime

startTime

type

Returns
Properties

finishTime​

Время окончания.

startTime​

Время начала.

type​

Тип события.

RotationKinematicSettings​

new RotationKinematicSettings({ angleThreshold?: number, decelerationCoefficient?: number, enabled?: boolean, initialBackwardAngularSpeed?: number, maxInitialForwardAngularSpeed?: number })
Parameters

angleThreshold?

number

decelerationCoefficient?

number

enabled?

boolean

initialBackwardAngularSpeed?

number

maxInitialForwardAngularSpeed?

number
Returns
Properties

angleThreshold​

number

Порог углового отклонения (в радианах), при превышении которого карта продолжает вращение в направлении жеста. Если меньше — движется в сторону исходного положения. Default: 0.05

decelerationCoefficient​

number

Коэффициент затухания вращения после окончания жеста. Чем выше значение, тем быстрее замедляется вращение. Default: 10.0

enabled​

boolean

Включает или отключает кинематику вращения. Если установлено в false, вращение мгновенно останавливается после окончания жеста, все остальные параметры игнорируются. Default: true

initialBackwardAngularSpeed​

number

Начальная угловая скорость возврата карты в исходное положение (в радианах в секунду). Default: 0.4

maxInitialForwardAngularSpeed​

number

Максимальная начальная угловая скорость после окончания жеста (в радианах в секунду). Default: 5.0

RotationRecognizeSettings​

Настройки распознавания вращения.

new RotationRecognizeSettings({ rotationThreshold: RotationRecognizeThresholds, rotationThresholdInScaling: RotationRecognizeThresholds })
Parameters
Properties

rotationThreshold​

Пороги перехода к вращению, если масштабирование не активно.

rotationThresholdInScaling​

Пороги перехода к вращению, если масштабирование активно.

RotationRecognizeThresholds​

new RotationRecognizeThresholds({ angleDiffDeg?: number, distanceDiffMm?: number })
Parameters

angleDiffDeg?

number

distanceDiffMm?

number
Returns
Properties

angleDiffDeg​

number

Порог изменения угла, в градусах, преодоление которого говорит о начале вращения. Default: 5.0

distanceDiffMm​

number

Порог среднего радиального сдвига точек, в миллиметрах, преодоление которого говорит о начале вращения. Default: 5.0

RubricId​

Идентификатор рубрики.

new RubricId({ value?: bigint })
Parameters

value?

bigint
Returns
Properties

value​

bigint

Default: 0n

ScalingKinematicSettings​

new ScalingKinematicSettings({ decelerationCoefficient?: number, enabled?: boolean, maxInitialForwardZoomSpeed?: number, zoomThreshold?: number })
Parameters

decelerationCoefficient?

number

enabled?

boolean

maxInitialForwardZoomSpeed?

number

zoomThreshold?

number
Returns
Properties

decelerationCoefficient​

number

Коэффициент затухания масштабирования после окончания жеста. Чем выше значение, тем быстрее замедляется масштабирование. Default: 14.0

enabled​

boolean

Включает или отключает кинематику масштабирования. Если установлено в false, масштабирование мгновенно останавливается после окончания жеста, и все остальные параметры игнорируются. Default: true

maxInitialForwardZoomSpeed​

number

Максимальная начальная скорость после окончания жеста (dgis::map::Zoom в секунду). Default: 14.0

zoomThreshold​

number

Порог отклонения dgis::map::Zoom, при превышении которого карта продолжает масштабирование в направлении жеста. Если меньше — движется в сторону исходного положения. Default: 0.05

ScalingRecognizeSettings​

Настройки распознавания масштабирования. Коэффициент масштабирования рассчитывается как отношения расстояния между точками после перемещения и исходным расстоянием.

new ScalingRecognizeSettings({ disableZoom?: boolean, scaleLogDiffPerMm?: number, scaleRatioThreshold?: number, scaleRatioThresholdInRotation?: number, zoomScaleRatio?: number })
Parameters

disableZoom?

boolean

scaleLogDiffPerMm?

number

scaleRatioThreshold?

number

scaleRatioThresholdInRotation?

number

zoomScaleRatio?

number
Returns
Properties

disableZoom​

boolean

Отключение жестов ZoomEvent и DirectMapScaleEvent. Default: false

scaleLogDiffPerMm​

number

Разница логарифмов масштабов при смещении на 1 мм. на экране. Default: 0.05

scaleRatioThreshold​

number

Порог коэффициента масштабирования, преодоление которого говорит о начале масштабирования. Используется, если вращение неактивно. Множитель должен выйти за пределы (1 / scale_ratio_threshold, scale_ratio_threshold). Default: 1.1

scaleRatioThresholdInRotation​

number

Порог коэффициента масштабирования, преодоление которого говорит о начале масштабирования. Используется, если вращение активно. Множитель должен выйти за пределы (1 / scale_ratio_threshold_in_rotation, scale_ratio_threshold_in_rotation). Default: 1.2

zoomScaleRatio​

number

Отношение логарифмов старого и нового масштабов при обработке мгновенного события изменения масштаба. Default: 2.0

Schedule​

Расписание действия дорожного события.

new Schedule({ finishTime: TimePoint | null, startTime: TimePoint | null, weekTimeIntervals: WeekTimeInterval[] })
Parameters

finishTime

startTime

weekTimeIntervals

Returns
Properties

finishTime​

Время начала действия. Отсутствует, если неизвестно.

startTime​

Время начала действия. Отсутствует, если неизвестно.

weekTimeIntervals​

Интервалы работы внутри недели.

Интервалы упорядочены по времени.

Первый интервал может начинаться с прошлой недели.

ScreenDistance​

Расстояние между объектами на экране в миллиметрах.

не может быть отрицательным

new ScreenDistance({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

ScreenPoint​

Точка в экранных координатах.

Направления осей: x - вправо, y - вниз. (0.0, 0.0) - левый верхний угол левого верхнего пикселя. Целая часть координаты - номер пикселя, дробная - относительное местоположение в пикселе.

new ScreenPoint({ x?: number, y?: number })
Parameters

x?

number

y?

number
Returns
Properties

x​

number

Default: 0.0

y​

number

Default: 0.0

ScreenShift​

Смещение карты по горизонтали и вертикали в координатном пространстве экрана.

Положительное направление смещения: dx - вправо, dy - вниз.

new ScreenShift({ dx?: number, dy?: number })
Parameters

dx?

number

dy?

number
Returns
Properties

dx​

number

Default: 0.0

dy​

number

Default: 0.0

ScreenSize​

Размер в пикселях.

new ScreenSize({ height?: number, width?: number })
Parameters

height?

number

width?

number
Returns
Properties

height​

number

Default: 0

width​

number

Default: 0

SearchHistoryPage​

new SearchHistoryPage({ filter?: EnumSet<SearchHistoryFilter>, limit?: bigint, offset?: bigint })
Parameters

filter?

limit?

bigint

offset?

bigint
Returns
Properties

filter​

Default: EnumSet.of(SearchHistoryFilter)

limit​

bigint

Default: 100n

offset​

bigint

Default: 0n

SearchSettings​

new SearchSettings({ saveInHistory?: boolean })
Parameters

saveInHistory?

boolean
Returns
Properties

saveInHistory​

boolean

Default: false

SimpleClusterOptions​

Параметры маркера кластера простых (simple) объектов-маркеров.

new SimpleClusterOptions({ anchor?: Anchor, animatedAppearance?: boolean, icon: Image | null, iconAnimationMode?: AnimationMode, iconMapDirection?: MapDirection | null, iconOpacity?: Opacity, iconWidth?: LogicalPixel, labelingPriority?: LabelingPriority, suppressOnOverlap?: boolean, text?: string | null, textStyle?: TextStyle | null, userData?: object | null, zIndex?: ZIndex })
Parameters

anchor?

animatedAppearance?

boolean

icon

Image|null

iconAnimationMode?

iconMapDirection?

iconOpacity?

iconWidth?

labelingPriority?

suppressOnOverlap?

boolean

text?

string|null

textStyle?

userData?

object|null

zIndex?

Returns
Properties

anchor​

Default: new Anchor({ x: 0.5, y: 0.5 })

animatedAppearance​

boolean

Анимировать ли появление. Default: true

icon​

Image|null

iconAnimationMode​

Режим анимации. Default: AnimationMode.Normal

iconMapDirection​

Default: null

iconOpacity​

Default: new Opacity({ value: 1.0 })

iconWidth​

Целевая ширина, используемая для масштабирования. Default: new LogicalPixel({ value: 0.0 })

labelingPriority​

Приоритет лейблинга иконки маркера. Default: new LabelingPriority({ value: 0 })

suppressOnOverlap​

boolean

Скрывать ли иконку при наложении с другими объектами (маркеры, подписи других объектов). Default: false

text​

string|null

Default: null

textStyle​

Default: null

userData​

object|null

Default: null

zIndex​

Уровень отрисовки объекта. Default: new ZIndex({ value: 0 })

SortingFilter​

Фильтр сортировки.

new SortingFilter({ displayName: string, tagName: string })
Parameters

displayName

string

tagName

string
Returns
Properties

displayName​

string

Название фильтра для отображения.

Зависит от языка выдачи. Не все названия могут быть переведены.

tagName​

string

Тэг фильтра.

SpecialSpace​

Особое место для парковки.

new SpecialSpace({ count: string | null, name: string, type: SpecialSpaceType })
Parameters

count

string|null

name

string

type

Returns
Properties

count​

string|null

Количество мест такого типа на парковке.

name​

string

Локализованное название особого места.

type​

StorageOptions​

Опции хранилища оффлайн данных.

new StorageOptions({ downloadStoragePath?: string | null })
Parameters

downloadStoragePath?

string|null
Returns
Properties

downloadStoragePath​

string|null

Путь к каталогу верхнего уровня для основного хранилища загрузок. Файловое хранилище будет находиться в подкаталоге downloads в данном каталоге. Если путь не указан, будет использоваться директория по умолчанию. Default: null

StyleLayerId​

Идентификатор слоя стиля.

new StyleLayerId({ id: string })
Parameters

id

string
Returns
Properties

id​

string

StyleZoom​

Стилевой уровень масштабирования.

Задаётся в редакторе стилей и отличается от обычного уровня масштабирования тем, что для одного StyleZoom масштаб карты одинаков независимо от широты. Однако, при Zoom < 9 или при latitude > 60 градусов StyleZoom == Zoom и масштаб карты на разных широтах отличается.

StyleZoom не может быть отрицательным.

new StyleZoom({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

SystemCertificate​

Системный SSL-сертификат.

new SystemCertificate(__namedParameters: {  })
Parameters

__namedParameters

{ }
Returns

TextStyle​

Настройки внешнего вида текста.

new TextStyle({ color?: Color, fontName?: string | null, fontSize?: LogicalPixel, labelingPriority?: LabelingPriority, strokeColor?: Color, strokeWidth?: LogicalPixel, suppressOnOverlap?: boolean, textHorizontalAlignment?: TextHorizontalAlignment, textOffset?: LogicalPixel, textPlacement?: TextPlacement })
Parameters

color?

fontName?

string|null

fontSize?

labelingPriority?

strokeColor?

strokeWidth?

suppressOnOverlap?

boolean

textHorizontalAlignment?

textOffset?

textPlacement?

Returns
Properties

color​

Default: new Color({ })

fontName​

string|null

Default: null

fontSize​

Default: new LogicalPixel({ value: 8.0 })

labelingPriority​

Приоритет лейблинга текста. Default: new LabelingPriority({ value: 0 })

strokeColor​

Default: new Color({ argb: 4294967295 })

strokeWidth​

Default: new LogicalPixel({ value: 0.35 })

suppressOnOverlap​

boolean

Скрывать ли текст при наложении с другими объектами (маркеры, подписи других объектов). Default: true

textHorizontalAlignment​

Default: TextHorizontalAlignment.Auto

textOffset​

Default: new LogicalPixel({ value: 0.0 })

textPlacement​

Default: TextPlacement.BottomCenter

Tilt​

Угол наклона в градусах, где 0 - надир (смотрим вертикально вниз), 90 - горизонт спереди.

Допустимыми считаются значения в интервале от #tilt_min до #tilt_max градусов. В случаях, когда точка позиции камеры расположена ближе к нижнему краю экрана, значение может быть дополнительно уменьшено.

new Tilt({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0

TiltKinematicSettings​

new TiltKinematicSettings({ decelerationCoefficient?: number, enabled?: boolean, initialForwardSpeedMultiplier?: number, maxInitialForwardAngularSpeed?: number, maxTiltAdditionalBorder?: Tilt, minTiltAdditionalBorder?: Tilt, tiltThreshold?: number })
Parameters

decelerationCoefficient?

number

enabled?

boolean

initialForwardSpeedMultiplier?

number

maxInitialForwardAngularSpeed?

number

maxTiltAdditionalBorder?

minTiltAdditionalBorder?

tiltThreshold?

number
Returns
Properties

decelerationCoefficient​

number

Коэффициент затухания наклона после окончания жеста. Чем выше значение, тем быстрее замедляется наклон. Default: 7.0

enabled​

boolean

Включает или отключает кинематику наклона. Если установлено в false, наклон мгновенно останавливается после окончания жеста, все остальные параметры игнорируются. Default: true

initialForwardSpeedMultiplier​

number

Множитель начальной скорости наклона. Default: 0.7

maxInitialForwardAngularSpeed​

number

Максимальная начальная угловая скорость наклона после окончания жеста (в радианах в секунду). При вычисоении скорости сначала производится умножение на initial_forward_speed_multiplier, а затем применяется ограничение. Default: 50.0

maxTiltAdditionalBorder​

Default: new Tilt({ value: 3.0 })

minTiltAdditionalBorder​

Default: new Tilt({ value: 0.0 })

tiltThreshold​

number

Порог углового отклонения (в радианах), при превышении которого карта продолжает наклоняться в направлении жеста. Если меньше — движется в сторону исходного положения. Default: 0.04

TiltRecognizeSettings​

Настройки распознавания наклона.

new TiltRecognizeSettings({ horizontalSwerveDeg?: number, lenOnDegreeMm?: number, maxParallelsDeviationDeg?: number, thresholdMm?: number, verticalSwerveDeg?: number })
Parameters

horizontalSwerveDeg?

number

lenOnDegreeMm?

number

maxParallelsDeviationDeg?

number

thresholdMm?

number

verticalSwerveDeg?

number
Returns
Properties

horizontalSwerveDeg​

number

Максимально допустимый угол, в градусах, отклонения линии постановки пальцев от горизонта для вертикального свайпа. Default: 20.0

lenOnDegreeMm​

number

Расстояние, в миллиметрах, на которое нужно сдвинуть пальцы по экрану, чтобы изменить угол наклона камеры на 1 градус. Отрицательное значение приведет к инверсии направления, значение 0 недопустимо. Default: 1.0

maxParallelsDeviationDeg​

number

Максимально допустимый угол между векторами, в градусах, преодоление которого говорит о нарушении сонаправленности. Default: 16.0

thresholdMm​

number

Порог сдвига взвешенного среднего точек в миллиметрах, преодоление которого говорит о начале наклона. Default: 1.1

verticalSwerveDeg​

number

Максимально допустимый угол, в градусах, отклонения направления свайпа от вертикальной линии. Default: 10.0

TradeLicense​

Лицензия организации.

new TradeLicense({ endDate: string, legalForm: string, license: string, type: string })
Parameters

endDate

string

legalForm

string

license

string

type

string
Returns
Properties

endDate​

string

Дата, до которой действует лицензия.

Пустая строка означает отсутствие этого значения в данных.

legalForm​

string

Форма собственности компании.

Пустая строка означает отсутствие этого значения в данных.

license​

string

Номер.

type​

string

Тип.

Пустая строка означает отсутствие этого значения в данных.

TrafficControlState​

Состояние элемента управления видимостью пробок.

new TrafficControlState({ score: number | null, status?: TrafficControlStatus })
Parameters

score

number|null

status?

Returns
Properties

score​

number|null

Балл пробок. Отображается в виде надписи на контроле. Если отсутствует, отображается иконка-заглушка.

status​

Статус, в зависимости от которого меняется внешний вид элемента управления. Default: TrafficControlStatus.Hidden

TrafficScore​

Оценка пробок.

new TrafficScore({ state?: TrafficScoreState, value: number | null })
Parameters

state?

value

number|null
Returns
Properties

state​

Актуальность значения. Default: TrafficScoreState.Pending

value​

number|null

Значение в баллах. Как правило, значения находятся в диапазоне от 1 до 10. Пустое значение, если информация ещё не получена, либо уже устарела, либо недоступна для заданного местоположения.

UIMarkerInfo​

Идентификатор объекта с подписью.

new UIMarkerInfo({ label: string | null, objectId: DgisObjectId })
Parameters

label

string|null

objectId

Returns
Properties

label​

string|null

objectId​

VendorConfigFromAsset​

Переопределение настроек SDK через указание пути к asset-у приложения. Для Android это директория assets. Для iOS это директория Bundle.main.

new VendorConfigFromAsset({ path: string })
Parameters

path

string
Returns
Properties

path​

string

Путь относительно корневой директории asset-ов.

VendorConfigFromFile​

Переопределение настроек SDK через указание пути к файлу в файловой системе устройства.

new VendorConfigFromFile({ path: string })
Parameters

path

string
Returns
Properties

path​

string

Путь к файлу.

VendorConfigFromString​

Переопределение настроек SDK через указание содержимого файла.

new VendorConfigFromString({ contents: string })
Parameters

contents

string
Returns
Properties

contents​

string

Содержимое файла переопределения настроек.

WeekTime​

Момент времени внутри недели.

new WeekTime({ time: DayTime, weekDay: WeekDay })
Parameters

time

weekDay

Returns
Properties

time​

Время.

weekDay​

День недели.

WeekTimeInterval​

Интервал времени в течение недели.

new WeekTimeInterval({ finishTime: WeekTime, startTime: WeekTime })
Parameters

finishTime

startTime

Returns
Properties

finishTime​

Время окончания.

startTime​

Время начала.

WmsRasterUrlTemplate​

new WmsRasterUrlTemplate({ urlTemplate: string })
Parameters

urlTemplate

string
Returns
Properties

urlTemplate​

string

WorkStatus​

Статус работы.

new WorkStatus({ breakHint: string | null, openStatus: OpenStatus, openStatusHint: string, scheduleHint: string | null })
Parameters

breakHint

string|null

openStatus

openStatusHint

string

scheduleHint

string|null
Returns
Properties

breakHint​

string|null

Текстовая подсказка о текущем или ближайшем перерыве. Например: "Обед до 14:00", "Перерыв до 11:30".

openStatus​

Статус.

openStatusHint​

string

Тескотовое подсказка по текущему статусу. Например: "Откроется через 15 минут", "Сегодня 10:00–22:00", "Ежедневно 09:00–21:00", "Открыто", "Закроется через 15 минут", "Закрыто", "Обед до 14:00", "Перерыв до 16:15".

scheduleHint​

string|null

Текстовая подсказка по расписанию работы. Например: "Сегодня 10:00–22:00", "Ежедневно 09:00–21:00", "Сегодня закрыто"

ZIndex​

Индекс, задающий порядок отрисовки объектов в рамках слоя.

new ZIndex({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0

Zoom​

Уровень масштабирования.

Zoom = 0 это такой масштаб, при котором весь мир вписан в квадрат 256x256 логических пикселей (см. LogicalPixel) Zoom = 1 это такой масштаб, при котором весь мир вписан в квадрат 512x512 логических пикселей Масштаб пропорционален величине 2^Zoom.

Zoom не может быть отрицательным.

new Zoom({ value?: number })
Parameters

value?

number
Returns
Properties

value​

number

Default: 0.0