Перейти к основному содержимому

class

ActivityTracker

Extends: Hashable
public static func == (lhs: ActivityTracker, rhs: ActivityTracker) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init(
platformContext: Context,
model: Model,
speedBound: Double = 4.2,
timeThreshold: TimeInterval = 20
)

Расширение навигатора, которое отслеживает активность пользователя и выдает сигнал, когда пользователь перестал пользоваться навигатором и его можно выключить.

Parameters

platformContext

Контекст.

model

Модель навигатора, состояние которого отслеживается.

speedBound

Верхняя граница скорости в м/с, при превышении которой в состоянии Finished навигатора считается, что навигатор активен, т.е. движение продолжается.

timeThreshold

TimeInterval

Время, в течение которого в состоянии Finished навигатора отслеживается скорость движения ниже пороговой для определения состояния неактивности навигатора. Если в течение этого времени скорость движения меньше установленного порога или нет данных о локации и скорости, навигатор считается неактивным.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var stopChannel

StatefulChannel<Bool>

Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.

var stop

Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.

AlternativeRouteSelector

Выбор альтернативного маршрута.

Extends: Hashable
public static func == (lhs: AlternativeRouteSelector, rhs: AlternativeRouteSelector) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func selectAlternativeRoute(
trafficRoute: TrafficRoute
)

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

Parameters

trafficRoute

Альтернативный маршрут, который должен быть выбран в качестве текущего активного маршрута.

AlternativeRoutesProviderSettings

Настройки поиска альтернативных маршрутов и маршрута лучше.

Extends: Hashable
public static func == (lhs: AlternativeRoutesProviderSettings, rhs: AlternativeRoutesProviderSettings) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var alternativeRoutesEnabled

Флаг включения/выключения предложения альтернативных маршрутов. По умолчанию предложение альтернативных маршрутов включено.

var betterRouteEnabled

Флаг включения/выключения предложения маршрута лучше. По умолчанию предложение маршрута лучше включено.

var routeSearchDelay

Задержка перед поиском альтернативных маршрутов при старте поездки по маршруту или после перехода на какой-либо другой маршрут. Должна быть не меньше 5 секунд. По умолчанию 20 секунд.

var onAlternativeRoutesSuggestedRouteSearchDelay

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

var betterRouteTimeCostThreshold

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

var betterRouteLengthThreshold

Минимальная суммарная длина рёбер маршрута, которые отличаются между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.

var routerType

Тип поисковика для поиска альтернативных маршрутов.

AnimationSettings

Настройки анимаций объектов карты. Применяются для слоев стилей, в которых указан источник модели. Например, такими слоями являются слои с типами “3D model” и “Directional model”. Индекс анимации должен быть обязательно указан для анимированной модели.

Extends: Hashable
public static func == (lhs: AnimationSettings, rhs: AnimationSettings) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var animationIndex

Int32?

Индекс текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, никакая анимация не проигрывается.

var animationName

Название текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано, никакая анимация не проигрывается.

var sceneIndex

Int32?

Индекс текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, используется сцена по умолчанию, которая определена в самой модели.

var sceneName

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

var animationRepeatCount

Int32?

Количество повторений анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, анимация будет проигрываться бесконечно.

var animationSpeed

Float?

Скорость проигрывания анимации модели. Если null, то используется значение из стилей. Значения больше единицы ускоряют проигрывание, меньше замедляют. Если в стилях значение не задано, используется скорость по умолчанию.

Attributes

Интерфейс для управления свойствами объекта карты.

Extends: Hashable
public static func == (lhs: Attributes, rhs: Attributes) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func setAttributeValue(
name: String,
value: AttributeValue
)

Установка свойства.

Parameters

name

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

value

Значение.

public nonisolated func setAttributeValues(
values: [String: AttributeValue],
attributesToRemove: [String] = []
)

Установка набора свойств. Сначала удаляются свойства attributes_to_remove, затем добавляются свойства values. Если свойство с таким названием уже было добавлено, то оно заменяется.

Parameters

values

String[ : ]

Набор пар “имя”:“значение” для добавляемых свойства.

attributesToRemove

Список имён свойств, которые нужно удалить.

public nonisolated func removeAttribute(
name: String
)

Удаление свойства.

Parameters

name

Имя свойства для удаления.

public nonisolated func getAttributeValue(
name: String
) -> AttributeValue

Получение свойства.

Parameters

name

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

Returns
Properties

var attributeNames

Получение списка свойств.

var changed

Channel<[String]>

Получение канала, уведомляющего об изменении свойств.

AudioSettings

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

Extends: Hashable
public static func == (lhs: AudioSettings, rhs: AudioSettings) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public static nonisolated func `get`(
context: Context
) -> AudioSettings?

Настройки аудио. Null, если аудио драйвер недоступен.

Parameters

context

Returns
Properties

var volume

Уровень громкости звука (0-100).

var mute

Проигрывание звука отключено.

var audioFocusPolicy

Поведения звуков других приложений при запрошенном фокусе.

BaseCamera

Камера.

Extends: Hashable
public static func == (lhs: BaseCamera, rhs: BaseCamera) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func clone() -> BaseCamera

Создание копии текущей камеры.

Returns
public nonisolated func setPosition(
position: CameraPosition
) throws

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

Parameters
public nonisolated func changePosition(
positionChange: CameraPositionChange
) throws

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

Parameters

positionChange

public nonisolated func setZoomRestrictions(
zoomRestrictions: CameraZoomRestrictions
) throws

Функция устанавливает новый диапазон ограничений уровня масштабирования.

Parameters

zoomRestrictions

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

public nonisolated func setPositionPoint(
positionPoint: CameraPositionPoint
) throws

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

Parameters

positionPoint

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

public nonisolated func setViewPoint(
viewPoint: CameraViewPoint?
) throws

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

Parameters

viewPoint

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

Properties

var projection

Проекция.

var position

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

var zoomRestrictions

Получение актуальных ограничений уровня масштабирования.

var deviceDensity

Получение отношения DPI к базовому DPI устройства.

var size

Получение размера области просмотра.

var padding

Получение текущих отступов от краёв экрана.

var positionPoint

Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).

var viewPoint

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

var visibleArea

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

var visibleRect

Объемлющий прямоугольник видимой области карты.

var maxTiltRestriction

(any StyleZoomToTiltRelation)?

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

var viewportRestriction

Получение ограничения на область видимости.

var changed

Channel<CameraChange>

Получение причин изменения состояния камеры.
Измененные свойства доступны в соответствующих каналах.

BearingFollowController

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

public convenience init(
bearingSource: BearingSource,
animationDuration: TimeInterval = 1,
valueThreshold: Bearing = Bearing(value: 1)
)

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

Parameters

bearingSource

источник информации о направлении.

animationDuration

TimeInterval

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

valueThreshold

неотрицательное пороговое значение учитываемого изменения реального направления.

BoolRouteLongAttribute

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

Extends: Hashable
public static func == (lhs: BoolRouteLongAttribute, rhs: BoolRouteLongAttribute) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func entry(
point: RoutePoint
) -> BoolRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters
public nonisolated func entries(
begin: RoutePoint,
end: RoutePoint
) -> [BoolRouteLongEntry]

Элементы, частично или полностью покрываемые отрезком [begin, end].

Parameters
Properties

var size

Количество элементов.

var isEmpty

Элементы отсутствуют.

var first

Первый элемент.

var last

Последний элемент.

var entries

Все элементы.

BufferedChannel

Extends: Channel<Value>
Properties

var value

Value?

Camera

Камера для запуска перемещения карты и настроек слежения.

Extends: BaseCamera
Methods
public nonisolated func move(
moveController: CameraMoveController
) -> Future<CameraAnimatedMoveResult>

Запуск перемещения карты.
Сбрасывает текущий режим слежения карты и прерывает обработку жестов.

Parameters

moveController

Контроллер анимированного перемещения камеры.

Returns
Future<>
public nonisolated func move(
position: CameraPosition,
time: TimeInterval = 0.3,
animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>

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

Parameters

position

Конечная позиция камеры.

time

TimeInterval

Время, выделенное на перемещение карты.

animationType

Тип анимации при перемещении камеры.

Returns
Future<>
public nonisolated func move(
point: GeoPoint,
zoom: Zoom,
tilt: Tilt?,
bearing: Bearing,
time: TimeInterval = 0.3,
animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>

Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.

Parameters

point

точка конечной позиции камеры

zoom

уровень масштабирования в конечной позиции камеры

tilt

наклон в конечной позиции камеры или пустое значение, если нужно в зависимости от активного режима слежения использовать значение из follow controller’а или текущее значение

bearing

поворот в конечной позиции камеры

time

TimeInterval

время, выделенное на перемещение карты

animationType

тип анимации при перемещении камеры

Returns
Future<>
public nonisolated func processMovementAndStop()

Установка позиции камеры в соответствие с текущим временем и прекращение анимированного перемещения.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за позицией, уровнем масштабирования и направлением.

public nonisolated func setBehaviour(
behaviour: CameraBehaviour
)

Смена режима слежения камеры. Если новый режим более ограниченный, чем текущий, вызов прервёт перелёт и обработку жестов.

Parameters
public nonisolated func addFollowController(
followController: FollowController
)

Добавление контроллера слежения.

Parameters

followController

public nonisolated func removeFollowController(
followController: FollowController
)

Удаление контроллера слежения.

Parameters

followController

public nonisolated func setCustomFollowController(
followController: CustomFollowController
)

Добавление контроллера слежения, реализованного на платформе.

Parameters

followController

public nonisolated func removeCustomFollowController()

Удаление контроллера слежения, реализованного на платформе.

func setPosition(point: GeoPoint, zoom: Zoom) throws
Parameters

point

zoom

func setPosition(point: GeoPoint) throws
Parameters
func sinkOnStatefulChangesOnMainThread<T: Sendable>(
reason: CameraChangeReasonOptionSet,
receiveValue: @escaping @Sendable (T) -> Void
) -> Cancellable

Подписаться на получение результата из Channel с указанием типа изменения на main очереди. При подписке получает начальное значение из Camera, соответствующему переданному CameraChangeReasonOptionSet.

Parameters
func sinkOnStatefulChanges<T: Sendable>(
on queue: DispatchQueue,
reason: CameraChangeReasonOptionSet,
receiveValue: @escaping @Sendable (T) -> Void
) -> Cancellable

Подписаться на получение результата из Channel с указанием типа изменения на заданной очереди. При подписке получает начальное значение из Camera, соответствующему переданному CameraChangeReasonOptionSet.

Parameters

queue

DispatchQueue

reason

Returns
Properties

var state

Получение актуального состояния камеры.

var behaviour

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

CameraNotifier

Предупреждает о попадании в зону действия дорожной камеры.

Extends: Hashable
public static func == (lhs: CameraNotifier, rhs: CameraNotifier) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init(
model: Model
)

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

Parameters

model

Модель навигатора, состояние которого отслеживается.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var cameraProgressChannel

StatefulChannel<CameraProgressInfo?>

Прогресс прохождения зоны действия дорожной камеры.

var cameraProgress

Прогресс прохождения зоны действия дорожной камеры.

CameraRouteAttribute

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

Extends: Hashable
public static func == (lhs: CameraRouteAttribute, rhs: CameraRouteAttribute) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func entries(
begin: RoutePoint,
end: RoutePoint
) -> [CameraRouteEntry]

Элементы, попадающие в отрезок [begin, end).

Parameters
public nonisolated func findNearBackward(
point: RoutePoint
) -> CameraRouteEntry?

Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.

Parameters
public nonisolated func findNearForward(
point: RoutePoint
) -> CameraRouteEntry?

Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.

Parameters
Properties

var size

Количество элементов.

var isEmpty

Элементы отсутствуют.

var first

Первый элемент.

var last

Последний элемент.

var entries

Все элементы.

CameraTransactionGuard

Extends: Hashable
public static func == (lhs: CameraTransactionGuard, rhs: CameraTransactionGuard) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

CancelEvent

Событие отмены текущего действия.

Extends: Event
public convenience init()

Cancellable

A cancellation token for a running operation.

Implements: ICancellable
public init(
cancel: @escaping () -> Void,
release: @escaping () -> Void = {}
)
public convenience init()

Make a cancellation token that cancels nothing.

public static func ==(lhs: Cancellable, rhs: Cancellable) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func cancel()

May be called any number of times from any queue.

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

CategoriesPage

Страница результатов запроса категорий.

Extends: Hashable
public static func == (lhs: CategoriesPage, rhs: CategoriesPage) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func fetchPrevPage() -> Future<CategoriesPage?>

Получить предыдущую страницу результатов.

public nonisolated func fetchNextPage() -> Future<CategoriesPage?>

Получить следующую страницу результатов.

Properties

var items

Категории этой страницы.

Category

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

Extends: Hashable
public static func == (lhs: Category, rhs: Category) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var id

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

var type

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

var name

Название категории.

var title

Заголовок для отображения в UI.
при отсутствии может быть пустой строкой.

var caption

Короткая подпись к иконке для отображения в UI.
при отсутствии может быть пустой строкой.

var seoName

SEO-синоним.
при отсутствии может быть пустой строкой.

var keyword

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

var tag

Уникальное имя, которое можно использовать как часть имени файла-иконки.
при отсутствии может быть пустой строкой.

var iconUrl

Ссылка на изображение.
при отсутствии может быть пустой строкой.

var suggestIcon

Иконка категории для выдачи suggest.
при отсутствии может быть пустой строкой.

var parentId

Идентификатор родительской категории.
при отсутствии может быть пустой строкой.

var branchCount

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

var orgCount

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

var geoCount

Количество геообъектов в данной категории.

var isReviewableOnFlamp

Разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru.

var children

Дочерние категории.

CategoryGetByIdsQueryBuilder

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

Extends: Hashable
public static func == (lhs: CategoryGetByIdsQueryBuilder, rhs: CategoryGetByIdsQueryBuilder) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init(
ids: [RubricId]
)

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

Parameters
Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func setGeoContext(
geoContext: CategoryGeoContext?
) -> CategoryGetByIdsQueryBuilder

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

Parameters
public nonisolated func setLocale(
locale: Locale?
) -> CategoryGetByIdsQueryBuilder

Задать локаль для запроса категорий.

Parameters
public nonisolated func build() -> CategoryQuery

Сформировать запрос категорий.

CategoryListQueryBuilder

Построитель запроса списка категорий.

Extends: Hashable
public static func == (lhs: CategoryListQueryBuilder, rhs: CategoryListQueryBuilder) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init()

Начать построение запроса списка категорий.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func setParentId(
parentId: RubricId?
) -> CategoryListQueryBuilder

Задать родителя для запроса списка категорий.

Parameters
public nonisolated func setSortType(
sortType: CategorySortType
) -> CategoryListQueryBuilder

Задать сортировку для запроса списка категорий.

Parameters
public nonisolated func setGeoContext(
geoContext: CategoryGeoContext?
) -> CategoryListQueryBuilder

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

Parameters
public nonisolated func setPageSize(
pageSize: UInt32
) -> CategoryListQueryBuilder

Задать размер страницы.

Parameters
public nonisolated func setLocale(
locale: Locale?
) -> CategoryListQueryBuilder

Задать локаль для запроса категорий.

Parameters
public nonisolated func build() -> CategoryQuery

Сформировать запрос категорий.

CategoryQuery

Запрос категорий.

Extends: Hashable
public static func == (lhs: CategoryQuery, rhs: CategoryQuery) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

CategorySearchQueryBuilder

Построитель запроса поиска категорий по тексту.

Extends: Hashable
public static func == (lhs: CategorySearchQueryBuilder, rhs: CategorySearchQueryBuilder) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init(
queryText: String
)

Начать построение запроса поиска категорий по тексту.

Parameters

queryText

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func setGeoContext(
geoContext: CategoryGeoContext?
) -> CategorySearchQueryBuilder

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

Parameters
public nonisolated func setPageSize(
pageSize: UInt32
) -> CategorySearchQueryBuilder

Задать размер страницы.

Parameters
public nonisolated func setLocale(
locale: Locale?
) -> CategorySearchQueryBuilder

Задать локаль для запроса категорий.

Parameters
public nonisolated func build() -> CategoryQuery

Сформировать запрос категорий.

Channel

public static func == (lhs: Channel<Value>, rhs: Channel<Value>) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

func sinkOnMainThread(_ receiveValue: @Sendable @escaping (Value) -> Void) -> Cancellable

Получение результата Channel на main очереди. Сам канал срабатывает на другой очереди и передает результат на main очередь.

func sink(on queue: DispatchQueue, receiveValue: @Sendable @escaping (Value) -> Void) -> Cancellable

Получение результата Channel на заданной очереди. Сам канал срабатывает на другой очереди и передает результат на заданную очередь.

Parameters

queue

DispatchQueue
Returns

CheckableGroupedItem

Единичный элемент из GroupCheckableItem.

Extends: Hashable
public static func == (lhs: CheckableGroupedItem, rhs: CheckableGroupedItem) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var text

Получение текстового описания элемента.

var values

Получение списка значений, по которым происходит фильтрация. Обычно одно значение.

var isChecked

Получение состояния элемента.

CheckableItem

Базовое представление отмечаемого элемента из CheckableItemsGroup.

Extends: Hashable
public static func == (lhs: CheckableItem, rhs: CheckableItem) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var type

Получение типа отмечаемого элемента.

var filterType

Получение списка фильтров, описывающих текущее состояние виджета. Может быть использован при формировании поискового запроса.

CheckableItemsGroup

Виджет для представления группы отмечаемых элементов.

Extends: Widget
Properties

var items

Получение группы элементов виджета.

Checkbox

Виджет-чекбокс.

Extends: Widget
Properties

var filterType

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

var checkedText

Получение текста подписи для “отмеченного” чекбокса.

var uncheckedText

Получение текста подписи для “неотмеченного” чекбокса.

var values

Получение списка значений, по которым происходит фильтрация. Обычно одно значение.

var isChecked

Получение состояния виджета.

Circle

Окружность.

public convenience init(
options: CircleOptions
) throws
Parameters
Methods
public nonisolated func setPosition(
position: GeoPoint
) throws

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

Parameters

position

public nonisolated func setRadius(
radius: Meter
) throws

Установка радиуса окружности.

Parameters

radius

Properties

var position

Местоположение центра окружности.

var radius

Радиус окружности.

var color

Цвет заливки окружности.

var strokeWidth

Ширина линии границы окружности.

var strokeColor

Цвет границы окружности.

var dashedStrokeOptions

Получение параметров пунктирной обводки

ClusterObject

Кластер объектов.

Extends: