Параметры XLSForm

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

Вы можете добавить несколько параметров вопроса в один и тот же столбец, разделив параметры пробелами. Например, вопрос геоформы может иметь параметры map, method, lineColor и fillColor в столбце body::esri:style, как показано ниже:

map="Imagery Hybrid" method=vertex lineColor=#DC143C fillColor=LightYellow

Общие

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

Столбец XLSFormПараметрОписание
bind::esri:parameterscalculationMode

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

Типы вопросов: text | decimal | integer | note | date | time | dateTime | select_one | select_multiple | geopoint | calculate | hidden

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

Примеры:

calculationMode=manual
calculationMode=always
body::esri:styleplaceholderText

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

Типы вопросов: text | integer | decimal | select_one (с оформлением autocomplete) | barcode

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

Примеры:

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

Аудио

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

Столбец XLSFormПараметрОписание
bind::esri:parameterscodec

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

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

Пример:

codec=amr-nb,aac
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
max-size

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

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

Пример:

max-size=5

Штрих-код

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

Столбец XLSFormПараметрОписание
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, которые можно использовать с вопросом типа Файл.

Столбец XLSFormПараметрОписание
bind::esri:parametersfileName

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

Значения: <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, которые можно использовать с типом вопроса begin group. Эти параметры есть только в полевом приложении.

Столбец XLSFormПараметрОписание
body::esri:style

backgroundColor

borderColor

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

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

Примеры:

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

layout

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

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

Пример:

layout=fixed-grid

Изображения

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

Столбец XLSFormПараметрОписание
bind::esri:parametersallowAdds

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

Значение: 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"
body::esri:styleallowRename

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

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

Пример:

allowRename=false
fileNameVisible

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

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

Пример:

fileNameVisible=true
footerText

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

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

Примеры:

footerText
footerText=@[hint]
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
parametersmax-pixels

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

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

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

Этот параметр поддерживается и веб-приложением.

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

Примеры:

max-pixels=1500
max-pixels=400

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

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

Столбец XLSFormПараметрОписание
body::esri:styleheight

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

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

Примеры:

previewHeight=6lines
previewHeight=250pixels

lineColor²

fillColor³

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

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

Пример:

lineColor=Black 
fillColor=#9EFFF5
lineWidth²

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

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

Примеры:

lineWidth=3
map

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

Этот параметр поддерживается и веб-приложением.

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

Примеры:

map="World Topography"
map=de26a3cf4cc9451298ea173c4b324736

mapTools

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

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

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

Примеры:

mapTools=zoom
mapTools=search,locate

method²

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

Этот параметр поддерживается и веб-приложением.

Значения: 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 | self²

Пример:

snapMode=feature
snapMode=self
snapMode=self,feature
symbol¹

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

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

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

Пример:

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

¹Поддерживается только вопросами типа geopoint.

²Поддерживается только типами вопросов geoshape и geotrace.

¹Поддерживается только вопросами типа geoshape.

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

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

Столбец XLSFormПараметрОписание
parametersrandomize

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

Значения: true

Пример:

randomize=true

Диапазон

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

Столбец XLSFormПараметрОписание

body::esri:style

startColor

endColor

color

Укажите цвет бегунка в начале и в конце диапазона. Используйте параметр color, чтобы задать цвет, который используется для заполнения пространства между началом бегунка и выбранным значением. Параметры должны быть разделены пробелом. Для получения более подробной информации см. раздел Опции стиля.

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

Примеры:

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

параметры

start

end

step

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

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

Примеры:

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

Повторы

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

Столбец XLSFormПараметрОписание
bind::esri:parametersallowAdds

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

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

Пример:

allowAdds=true
allowUpdates

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

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

Пример:

allowUpdates=false
query

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

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

Примеры:

query
query="severity='high'"
body::esri:style

backgroundColor

borderColor

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

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

Примеры:

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

Текст

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

Столбец XLSFormПараметрОписание
bind::esri:parametersgeocode

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

Этот параметр поддерживается и веб-приложением.

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

Пример:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

measurement

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

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

Примеры:

measurement=height
measurement=height,azimuth,horizontalDistance
measurement="multipleHeights,Height 1,Height 2"
body::esri:styledefaultHeight

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

Значение: <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
proximity

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

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

Примеры:

proximity=3km
proximity=1000ft
suggestions

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

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

Пример:

suggestions=no

Дальномер

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

Столбец XLSFormПараметрОписание
bind::esri:parameters

measurement

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

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

Примеры:

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