Параметры

Некоторые типы вопросов в XLSForm имеют дополнительные настройки, позволяющие контролировать стиль и поведение вопросов. В некоторых случах эти параметры дополняют представления, поддерживающиеся вопросами. Не все параметры поддерживаются во всех приложениях для отправки данных (Survey123 Mobile, приложение для полевых работ Survey123 и ​​веб-приложение Survey123). Для получения дополнительной информации о поддержке приложения обратитесь к таблицам параметров ниже, которые организованы по типу вопроса и столбцу XLSForm на листе опроса, принимающем каждый параметр.

Вы можете добавить несколько параметров вопроса в один и тот же столбец, разделив параметры пробелами. Например, вопрос дипазона может иметь параметры startColor, endColor и color в столбце body::esri:style, как показано ниже:

startColor=Orange endColor=White color=#FF6347

Общие

В этом разделе описаны параметры, которые можно использовать в столбцах XLSForm bind::esri:parameters и body::esri:style для различных типов вопросов.

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

bind::esri:parameters

ПараметрОписаниеПриложение для отправки
calculationMode

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

Значения: auto | manual | always | whenEmpty

Примеры:

calculationMode=manual
calculationMode=always

Веб-приложение

Полевое приложение

В следующей таблице описаны параметры, которые можно использовать в столбце XLSForm body::esri:style для вопросов следующих типов: текст, целое число, десятичное число, выбрать один (с автозаполнением), выбрать несколько (с автозаполнением)* и штрихкод.

body::esri:style

ПараметрОписаниеПриложение для отправки
placeholderText

Укажите текст, который появляется в области ввода когда вопрос пуст.

Значения: @[hint] | @[guidance_hint]

Примеры:

placeholderText=@[hint]
placeholderText=@[guidance_hint]

Survey123 Mobile

Полевое приложение

*Поддерживается только в Survey123 Mobile.

Аудио

В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm bind::esri:parameters для вопроса типа аудио.

bind::esri:parameters

ПараметрОписаниеПриложение для отправки
кодек

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

Значение: <codec name>

Пример:

codec=amr-nb,aac

Survey123 Mobile

Полевое приложение

fileName

Определяет имя файла.

Значения: <expression>

Примеры:

fileName=concat("JobID-", ${job_id})
fileName=concat(${asset_id}, "_", 
  format-date(now(), "%Y%m%d%H%M%S"))

Веб-приложение

max-duration

Задает максимальное время записи аудио, в секундах. Значение длительности по умолчанию в веб-приложении равно 600 (10 минут).

Значение: <seconds>

Пример:

max-duration=45

Survey123 Mobile

Веб-приложение

Полевое приложение

max-size

Задает максимальный размер файла аудиозаписи в мегабайтах. Размер по умолчанию в полевом приложении - 10 МБ.

Значение: <megabytes>

Пример:

max-size=5

Survey123 Mobile

Полевое приложение

Штрих-код

В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm body::esri:style для вопроса типа штрихкод.

body::esri:style

ПараметрОписаниеПриложение для отправки

barcodeType

Задает типы штрих-кодов, которые могут сканировать пользователи. Можно ввести несколько типов, разделенных запятыми. Когда параметр barcodeType не указан, можно сканировать все поддерживаемые типы штрих-кодов, за исключением aztec, code39, datamatrix, maxicode и pdf417.

Значения: all | 1d | 2d | <barcode types>

  • all - все поддерживаемые типы, за исключением code39 и pdf417.
  • 1d - все одномерные типы, за исключением code39.
  • 2d - все двумерные типы, за исключением pdf417.

Одномерные типы: codabar | code128 | code39 | code93 | ean13 | ean8 | itf | upca | upce | upceanextension

Двумерные типы: aztec | datamatrix | maxicode | pdf417 | qrcode | rss14 | rssexpanded

Примеры:

barcodeType=qrcode,aztec,code128
barcodeType=ean8,itf
barcodeType=2d
barcodeType=pdf417

Полевое приложение

Файл

В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm bind::esri:parameters для вопроса типа файл.

bind::esri:parameters

ПараметрОписаниеПриложение для отправки
fileName

Определяет имя файла.

Значения: <expression>

Примеры:

fileName=concat("JobID-", ${job_id})
fileName=concat(${asset_id}, "_", 
  format-date(now(), "%Y%m%d%H%M%S"))

Веб-приложение

max-size

Задайте максимальный размер файла в мегабайтах. По умолчанию 10МБ.

Значение: <megabytes>

Пример:

max-size=5

Веб-приложение

Группы

В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm body::esri:style для вопроса типа начало группы.

body::esri:style

ПараметрОписаниеПриложение для отправки

backgroundColor

borderColor

Задает цвета фона и границы для группы или страницы. Дополнительные сведения см. в разделе Цвета групп, страниц и повторов.

Значения: <HTML color name> | <hex color code>

Примеры:

backgroundColor=LightBlue
borderColor=#4682B4
backgroundColor=#C7FFC7 borderColor=#3C6D9E

Survey123 Mobile

Полевое приложение

layout

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

Значения: dynamic-grid | fixed-grid

Пример:

layout=fixed-grid

Полевое приложение

Изображения

В этом разделе описаны параметры, которые можно использовать в указанных столбцах XLSForm для вопросов типа изображение.

.В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm bind::esri:parameters.

bind::esri:parameters

ПараметрОписаниеПриложение для отправки
allowAdds

Отключает добавление новых изображений при редактировании имеющихся записей.

Значение: false

Пример:

allowAdds=false

Полевое приложение

fileName

Определяет имя файла.

Значения: <expression>

Примеры:

fileName=concat("JobID-", ${job_id})
fileName=concat(${asset_id}, "_", 
  format-date(now(), "%Y%m%d%H%M%S"))

Веб-приложение

Полевое приложение

max-size

Задайте максимальный размер файла в мегабайтах. По умолчанию 10МБ.

Значение: <megabytes>

Пример:

max-size=5

Веб-приложение

smartAnnotation

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

Обязательное свойство: <model_name>

Дополнительные свойства: minScore | cameraPreview | label | class | boundingBoxes | outlineWidth | fontSize | font | bold | italic

Примеры:

smartAnnotation=modelname
  &cameraPreview=true&minScore=0.52
smartAnnotation=modelname&
  cameraPreview=true&minScore=0.52
  &class=classname1,classname2
  &label=false&bold=true

Полевое приложение

smartAttributes

Выполните операцию обнаружения объектов или классификации изображений и используйте результаты EXIF в своем опросе.

Обязательное свойство: <model_name>

Дополнительные свойства: minScore | cameraPreview | label | class

Примеры:

smartAttributes=modelname
  &cameraPreview=true&minScore=0.45
smartAttributes=modelname
  &cameraPreview=true
  &class=classname1,classname2
  &label=false

Полевое приложение

redaction

Автоматически создает или вручную добавляет ограничивающие прямоугольники и применяет эффекты исправления к целевой области.

Обязательное свойство: <model_name> | @faces | @manual

Дополнительные свойства: minScore | cameraPreview | label | class | effect | symbol | fillColor | scale

Примеры:

redaction=modelname
  &cameraPreview=true&effect=blur
redaction=@manual&effect=blockout
redaction=@faces&cameraPreview=true
  &class=classname1,classname2
  &label=false@effect=symbol&symbol=🐻

Полевое приложение

watermark

topLeftWatermark

topCenterWatermark

topRightWatermark

leftCenterWatermark

centerWatermark

rightCenterWatermark

bottomLeftWatermark

bottomCenterWatermark

bottomRightWatermark

Задает расположение водяного знака изображения. Присоединение свойств для задания контента и форматирования. Дополнительные сведения см. в разделе Водяные знаки.

Свойства: text | color | outlineColor | outlineWidth | haloColor | size | font | bold | italic | margin | image | imageSize

Примеры:

watermark="Example Text
  &outlineColor=White"
bottomLeftWatermark="Example Text
  &bold=true"
topRightWatermark="@[latitude longitude]
  &size=20"

Полевое приложение

В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm body::esri:style для вопроса типа изображение.

body::esri:style

ПараметрОписаниеПриложение для отправки
allowRename

Определяет, могут ли пользователи редактировать имя файла вручную.

Значения: true | false

Пример:

allowRename=false

Полевое приложение

fileNameVisible

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

Значения: true | false

Пример:

fileNameVisible=true

Полевое приложение

footerText

Для вопросов типа image с оформлением signature, укажите текст, отображающийся внизу всплывающего окна подписи. Если значение не задано, подсказка к вопросу появится ниже подписи. Ее можно заменить на подсказку вопроса, используя footerText=@[hint].

Значения: <none> | @[hint]

Примеры:

footerText
footerText=@[hint]

Survey123 Mobile

Полевое приложение

method

Задайте метод получения для вопросов типа изображение. Значение map поддерживается только для вопросов типа image с оформлением annotate.

Значения: browse | camera | map

Примеры:

method=camera
method=map
method=browse,camera,map

Веб-приложение

Полевое приложение

palette

Для вопросов типа Изображение с оформлением draw или annotate, укажите собственную палитру инструментов рисования.

Значение: <palette name>

Пример:

palette=SiteLayout

Полевое приложение

previewHeight

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

Значения: <lines> | <lines>lines | <percentage of screen height>% | <pixels>pixels

Примеры:

previewHeight=3lines
previewHeight=120pixels

Полевое приложение

В таблице ниже описан параметр, который можно использовать в столбце XLSForm parameters для вопроса типа изображение.

parameters

ПараметрОписаниеПриложение для отправки
max-pixels

Для вопроса типа image, задайте максимальный размер изображения по большей стороне, с сохранением соотношения сторон.

Для вопросов типа image с оформлением signature, укажите максимальную ширину всплывающего окна подписи.

Для вопроса типа image c оформлением draw задайте канву для квадратного изображения (1:1).

Значение: <pixels>

Примеры:

max-pixels=1500
max-pixels=400

Веб-приложение

Полевое приложение

Вопросы по карте

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

.В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm bind::esri:parameters.

bind::esri:parameters

ПараметрОписаниеПриложение для отправки

геокодировать

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

Значение: <locator item ID>

Пример:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

Веб-приложение

Полевое приложение

В следующей таблице описаны параметры, которые можно использовать в столбце XLSForm body::esri:style для вопросов типа геоточка, геотрассировка и геоформа.

body::esri:style

ПараметрОписаниеПриложение для отправки
height

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

Значения: <lines> | <lines>lines | <percentage of screen height>% | <pixels>pixels

Примеры:

previewHeight=6lines
previewHeight=250pixels

Полевое приложение

lineColor2

fillColor3

Задает цвета линий и заливки для линейных и полигональных объектов. Применяется только к предварительному просмотру карты в Survey123. Дополнительные сведения см. в разделе Символы геометрии.

Значения: <HTML color name> | <hex color code>

Пример:

lineColor=Black 
fillColor=#9EFFF5

Survey123 Mobile

Полевое приложение

lineWidth2

Задает ширину линии в пикселах для линейных и полигональных объектов. Применяется только к предварительному просмотру карты в Survey123.

Значение: <pixels>

Примеры:

lineWidth=3

Survey123 Mobile

Полевое приложение

map

Задает базовую карту по умолчанию.

Значения: <map name> | <map item ID>

Примеры:

map="World Topography"
map=de26a3cf4cc9451298ea173c4b324736

Веб-приложение

Полевое приложение

mapTools

Контролирует инструменты карты, доступные для вопросов типа геоточка, геотрассировка и геоформа.

Значения: search | mapSwitcher | zoom | home | locate

Примеры:

mapTools=zoom
mapTools=search,locate

Полевое приложение

method2

Задает метод захвата. При выборе метода захвата вершин можно задать дополнительные параметры.

Значения: sketch | vertex

Дополнительные значения для вершины, применимые только в полевом приложении: streaming | beep | haptic | edit

Примеры:

method=vertex
method=vertex,streaming
method=vertex,streaming,haptic

Веб-приложение

Полевое приложение

minCaptureZoomLevel

Задает минимальный уровень, при котором возможен захват геометрии.

Значение: <integer>

Пример:

minCaptureZoomLevel=17

Веб-приложение

overlay

Отображение точечных местоположений из первого в повторе вопроса типа геоточка в других вопросах типа geopoint, geoshape или geotrace в опросе. Присоединение свойств для задания контента и стиля.

Значение: <repeat name>

Свойства: view | preview | icon | iconColor | iconOutlineColor | iconSize | label | labelColor | labelOutlineColor | fontSize

Примеры:

overlay=campsites&preview=true
overlay=hydrants&label=asset_id&icon=hydrant&iconColor=Red

Полевое приложение

precision

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

Значение: <integer>

Пример:

precision=4

Веб-приложение

snapMode

Задает поведение замыкания. Точки могут быть замкнуты на другие объекты, а линии и полигоны могут быть замкнуты на другие объекты или сами на себя. Доступно только при method=vertex.

Значения: feature | self2

Пример:

snapMode=feature
snapMode=self
snapMode=self,feature

Веб-приложение

symbol1

Укажите файл .png для использования в качестве маркера точки на карте. Присоединение свойств для задания положения и масштаба.

Значение: <file name>.png

Свойства: x | y | scale

Пример:

symbol=meter.png?x=0.6&y=0.1&scale=1.5

Полевое приложение

1 — поддерживается только вопросами типа геоточка.

2 — поддерживается только вопросами типа геоформа и геотрассировка.

3 — поддерживается только вопросами типа геоформа.

Вопросы с несколькими вариантами ответов

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

parameters

ПараметрОписаниеПриложение для отправки
randomize

Произвольный порядок ответов в списке вариантов.

Значения: true

Пример:

randomize=true

Веб-приложение

Полевое приложение

Диапазон

В этом разделе описаны параметры, которые можно использовать в указанных столбцах XLSForm для вопросов типа диапазон. При комбинировании параметры должны быть разделены пробелом.

.В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm body::esri:style. Для получения более подробной информации см. раздел Опции стиля.

body::esri:style

ПараметрОписаниеПриложение для отправки

startColor

endColor

color

Укажите цвета для бегунка диапазона:

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

Значения: <HTML color name> | <hex color code>

Примеры:

startColor=Blue endColor=Red
startColor=Orange endColor=White color=#FF6347
endColor=#262626 color=Yellow

Survey123 Mobile

Веб-приложение

Полевое приложение

В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm parameters для вопроса типа диапазон. Более подробную информацию см. в разделе Параметры бегунка диапазона.

parameters

ПараметрОписаниеПриложение для отправки

start

end

step

Укажите значения начала, конца и шага диапазона бегунка.

Значения: <integer> | <decimal>

Примеры:

start=0 end=50 step=5
start=10.25 end=1 step=0.25

Survey123 Mobile

Веб-приложение

Полевое приложение

Повторы

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

.В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm bind::esri:parameters.

bind::esri:parameters

ПараметрОписаниеПриложение для отправки
allowAdds

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

Значения: true | false

Пример:

allowAdds=true

Полевое приложение

allowUpdates

Позволяет редактировать имеющиеся записи повтора.

Значения: true | false

Пример:

allowUpdates=false

Полевое приложение

query

Позволяет отображать имеющиеся записи повтора в форме. Задает дополнительные параметры запроса для фильтрации доступных записей.

Значения: <none> | "SQL statement"

Примеры:

query
query="severity='high'"

Полевое приложение

В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm body::esri:style для вопроса типа начало повтора.

body::esri:style

ПараметрОписаниеПриложение для отправки

backgroundColor

borderColor

Задает цвета фона и границы для повтора. Дополнительные сведения см. в разделе Цвета групп, страниц и повторов.

Значения: <HTML color name> | <hex color code>

Примеры:

backgroundColor=LightBlue
borderColor=#4682B4
backgroundColor=#C7FFC7 borderColor=#3C6D9E

Survey123 Mobile

Полевое приложение

addRecordMode

Для повтора с табличным оформлением задайте режим работы кнопки Добавить запись и опцию Копировать в новую запись в табличном представлении. По умолчанию – row. Если значение равно row, новая запись добавляется в табличное представление. Если значение равно form, новая запись открывается в представлении формы.

Значения: row | form

Пример:

addRecordMode=form

Survey123 Mobile

editInFormView

Для повтора с табличным отображением покажите или скройте опцию Редактировать в представлении формы в табличном представлении. По умолчанию – true.

Примечание:

При возникновении ошибок в повторе включена опция Редактировать в представлении формы, даже если для параметра editInFormView задано false.

Значения: true | false

Пример:

editInFormView=false

Survey123 Mobile

copyToNewRecord

Для повтора с табличным оформлением покажите или скройте опцию Копировать в новую запись в табличном представлении. Эта опция позволяет пользователям дублировать запись в повторе. По умолчанию – true. Параметр addRecordMode определяет способ добавления дублирующейся записи.

Значения: true | false

Пример:

copyToNewRecord=true

Survey123 Mobile

editInTabularView

Для повтора с табличным оформлением включите или отключите опцию редактирования в табличном представлении. По умолчанию – true. Если значение равно false, все ячейки в табличном представлении становятся доступными только для чтения.

Значения: true | false

Пример:

editInTabularView=false

Survey123 Mobile

В таблице ниже описан параметр, который можно использовать в столбце XLSForm body::esri:style для вопросов в табличных повторах.

body::esri:style

ПараметрОписаниеПриложение для отправки

showInTabularView

Для повтора с табличным оформлением покажите вопрос как столбец в табличном представлении. По умолчанию – false.

Значения: true | false

Пример:

showInTabularView=true

Survey123 Mobile

Текст

В этом разделе описаны параметры, которые можно использовать в указанных столбцах XLSForm для вопросов типа текст.

.В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm bind::esri:parameters.

bind::esri:parameters

ПараметрОписаниеПриложение для отправки
геокодировать

Для текстового вопроса с оформлением geocode задайте локатор для возврата результатов геокодирования при использовании этого типа оформления.

Значение: <locator item ID>

Пример:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

Веб-приложение

Полевое приложение

В таблице ниже описаны параметры, которые можно использовать в столбце XLSForm body::esri:style для вопроса типа текст.

body::esri:style

ПараметрОписаниеПриложение для отправки
defaultHeight

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

Значение: <number of lines>

Пример:

defaultHeight=5

Полевое приложение

indicator

Для текстовых вопросов с оформлением geocode позволяет отображать в результатах геокодирования направление и расстояние от текущего расположения устройства.

Значения: direction | distance | none

Примеры:

indicator=none
indicator=direction
indicator=direction,distance

Полевое приложение

maxResults

Для текстового вопроса с оформлением geocode задайте максимальное число возвращаемых результатов. По умолчанию это значение равно 6.

Значение: <number of results>

Пример:

maxResults=10

Веб-приложение

Полевое приложение

близость

Для текстового вопроса с оформлением geocode задайте, будут ли в результатах геокодирования отображаться только данные в пределах определенного радиуса от местоположения устройства.

Значения: <distance>m | km | ft | mi | yd

Примеры:

proximity=3km
proximity=1000ft

Полевое приложение

suggestions

Для текстового вопроса с геокодированием измените способ заполнения предложений. По умолчанию задано Да.

Значения: yes | no

Пример:

suggestions=no

Полевое приложение

Дальномер

В следующей таблице описан параметр, который можно использовать в столбце XLSForm bind::esri:parameters с вопросами типа текст, десятично и целочисленное, чтобы извлекать значения из дальномера.

bind::esri:parameters

ПараметрОписаниеПриложение для отправки

measurement

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

Значения: height | azimuth | horizontalDistance | slopeDistance | inclination | multipleHeights

Примеры:

measurement=height
measurement=height,azimuth,horizontalDistance
measurement="multipleHeights,Height 1,Height 2"

Полевое приложение