SearchInsideGeometryOptions interface
Параметры поиска внутри геометрии
Свойства
| extended |
Индексы, для которых расширенные почтовые коды должны быть включены в результаты |
| index |
Разделенный запятыми список индексов, которые должны использоваться для поиска. Порядок элементов не имеет значения. Доступные индексы:
|
| language | Язык, в котором должны быть возвращены результаты поиска. |
Унаследованные свойства
| abort |
Сигнал, который можно использовать для прерывания запросов. |
| category |
Разделенный запятыми список идентификаторов наборов категорий, которые можно использовать для ограничения результата определенным категориями интересов. Порядок идентификаторов не имеет значения. При указании нескольких идентификаторов категорий возвращаются только pois, принадлежащие (по крайней мере) одной из категорий из предоставленного списка. Список поддерживаемых категорий можно найти с помощью API категорий POI. Примеры использования: |
| localized |
Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. |
| on |
Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз. |
| operating |
Часы работы для POI (точки интереса). |
| request |
Параметры, используемые при создании и отправке HTTP-запросов для этой операции. |
| serializer |
Параметры переопределения поведения сериализации и десериализации. |
| top | Максимальное количество возвращаемых ответов. По умолчанию: 10, минимум: 1 и максимум: 100 |
| tracing |
Параметры, используемые при включении трассировки. |
Сведения о свойстве
extendedPostalCodesFor
Индексы, для которых расширенные почтовые коды должны быть включены в результаты
extendedPostalCodesFor?: string[]
Значение свойства
string[]
indexFilter
Разделенный запятыми список индексов, которые должны использоваться для поиска. Порядок элементов не имеет значения. Доступные индексы:
- Addr = интерполяция диапазона адресов,
- geo = география, PAD = адреса точек,
- POI = точки интереса, Str = Street,
- Xstr = перекрестные улицы (пересечения)
indexFilter?: string[]
Значение свойства
string[]
language
Язык, в котором должны быть возвращены результаты поиска.
language?: string
Значение свойства
string
Сведения об унаследованном свойстве
abortSignal
Сигнал, который можно использовать для прерывания запросов.
abortSignal?: AbortSignalLike
Значение свойства
наследуется от OperationOptions.abortSignal
categoryFilter
Разделенный запятыми список идентификаторов наборов категорий, которые можно использовать для ограничения результата определенным категориями интересов. Порядок идентификаторов не имеет значения. При указании нескольких идентификаторов категорий возвращаются только pois, принадлежащие (по крайней мере) одной из категорий из предоставленного списка. Список поддерживаемых категорий можно найти с помощью API категорий POI.
Примеры использования: categorySet=7315(Поиск достопримечательностей из категории Ресторан) categorySet=7315025,7315017(Поиск достопримечательностей категории Итальянский или Французский ресторан)
categoryFilter?: number[]
Значение свойства
number[]
Наследуется отSearchGeometryBaseOptions.categoryFilter
localizedMapView
Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов.
localizedMapView?: string
Значение свойства
string
Унаследовано отSearchGeometryBaseOptions.localizedMapView
onResponse
Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
onResponse?: RawResponseCallback
Значение свойства
наследуется от OperationOptions.onResponse
operatingHours
Часы работы для POI (точки интереса).
operatingHours?: string
Значение свойства
string
Наследуется отSearchGeometryBaseOptions.operatingHours
requestOptions
Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
requestOptions?: OperationRequestOptions
Значение свойства
наследуется от OperationOptions.requestOptions
serializerOptions
Параметры переопределения поведения сериализации и десериализации.
serializerOptions?: SerializerOptions
Значение свойства
наследуется от OperationOptions.serializerOptions
top
Максимальное количество возвращаемых ответов. По умолчанию: 10, минимум: 1 и максимум: 100
top?: number
Значение свойства
number
Унаследовано отSearchGeometryBaseOptions.top
tracingOptions
Параметры, используемые при включении трассировки.
tracingOptions?: OperationTracingOptions
Значение свойства
наследуется от OperationOptions.tracingOptions