Parâmetros XLSForm

Alguns tipos de perguntas no XLSForm têm parâmetros adicionais que permitem controlar o estilo ou o comportamento das perguntas em uma pesquisa. Em alguns casos, esses parâmetros complementam as aparências que um tipo de pergunta suporta. As tabelas abaixo fornecem uma visão geral dos parâmetros que você pode usar no XLSForm e a coluna na planilha de pesquisa que aceita cada parâmetro. Nem todos os parâmetros são compatíveis com o aplicativo de campo e o aplicativo web do ArcGIS Survey123. Para obter mais informações sobre o suporte a aplicativos de campo e aplicativos da web, consulte o tópico de documentação de cada parâmetro.

Você pode adicionar vários parâmetros para uma pergunta à mesma coluna separando os parâmetros com espaços. Por exemplo, uma pergunta forma geográfica pode ter os parâmetros map, method, lineColor e fillColor na coluna body::esri:style, do seguinte modo:

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

Geral

A tabela a seguir contém os parâmetros XLSForm que você pode usar com vários tipos de perguntas. Consulte a descrição de cada parâmetro para obter a lista de tipos de perguntas que o suportam. Esses parâmetros são suportados apenas no aplicativo de campo.

Coluna XLSFormParâmetroDescrição
bind::esri:parameterscalculationMode

Controle quando o cálculo em uma pergunta é calculado.

Tipos de perguntas: text | decimal | integer | note | date | time | dateTime | select_one | select_multiple | geopoint | calculate | hidden

Valores: auto | manual | always | whenEmpty

Exemplos:

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

Especifique o texto que aparece na área de entrada da pergunta quando a pergunta está vazia.

Tipos de perguntas: text | integer | decimal | select_one (com aparência de preenchimento automático) | barcode

Valores: @[hint] | @[guidance_hint]

Exemplos:

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

Áudio

A tabela a seguir contém os parâmetros de XLSForm que você pode usar com o tipo de pergunta de audio. Esses parâmetros são suportados apenas no aplicativo de campo, a menos que indicado de outra forma na descrição.

Coluna XLSFormParâmetroDescrição
bind::esri:parameterscodec

Especifique o codec preferido para uma gravação de áudio. Vários codecs podem ser fornecidos, separados por vírgulas. O primeiro codec compatível com o dispositivo será usado.

Valor: <codec name>

Exemplo:

codec=amr-nb,aac
fileName

Especifique o nome do arquivo.

Valores: <expression>

Este parâmetro é suportado apenas no aplicativo da web.

Exemplos:

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

Especifique a duração máxima em segundos para uma gravação de áudio. A duração padrão no aplicativo web é 600 (10 minutos).

Valor: <seconds>

Exemplo:

max-duration=45
max-size

Especifique o tamanho máximo do arquivo em megabytes para uma gravação de áudio. O tamanho padrão no aplicativo de campo é 10 MB.

Valor: <megabytes>

Exemplo:

max-size=5

Código de barras

A tabela a seguir contém os parâmetros XLSForm que você pode usar com o tipo de pergunta de código de barras. Esses parâmetros são suportados apenas no aplicativo de campo.

Coluna XLSFormParâmetroDescrição
body::esri:style

barcodeType

Especifique os tipos de códigos de barras que os usuários podem digitalizar. Vários tipos podem ser fornecidos, separados por vírgulas. Quando o parâmetro barcodeType não é fornecido, todos os tipos de código de barras suportados podem ser lidos, exceto aztec, code39, datamatrix, maxicode e pdf417.

Valores: all | 1d | 2d | <barcode types>

  • all—Todos os tipos suportados, exceto code39 e pdf417.
  • 1d—Todos os tipos unidimensionais, exceto code39.
  • 2d—Todos os tipos bidimensionais, exceto pdf417.

Tipos unidimensionais: codabar | code128 | code39 | code93 | ean13 | ean8 | itf | upca | upce | upceanextension

Tipos bidimensionais: aztec | datamatrix | maxicode | pdf417 | qrcode | rss14 | rssexpanded

Exemplos:

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

Arquivo

A tabela a seguir contém os parâmetros de XLSForm que você pode usar com o tipo de pergunta de file:

Coluna XLSFormParâmetroDescrição
bind::esri:parametersfileName

Especifique o nome do arquivo.

Valores: <expression>

Este parâmetro é suportado apenas no aplicativo da web.

Exemplos:

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

Especifique o tamanho máximo do arquivo em megabytes. O padrão é 10 MB.

Valor: <megabytes>

Este parâmetro tem suporte no aplicativo de campo e no aplicativo da web.

Exemplo:

max-size=5

Grupos

A tabela a seguir contém os parâmetros de XLSForm que você pode usar com o tipo de pergunta begin group: Esses parâmetros são suportados apenas no aplicativo de campo.

Coluna XLSFormParâmetroDescrição
body::esri:style

backgroundColor

borderColor

Defina as cores do plano de fundo e da borda de um grupo ou página. Para obter mais informações, consulte Grupo, página e cores repetidas.

Valores: <HTML color name> | <hex color code>

Exemplos:

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

layout

Defina o estilo de layout de grade para um grupo.

Valores: dynamic-grid | fixed-grid

Exemplo:

layout=fixed-grid

Imagens

A tabela a seguir contém os parâmetros XLSForm que você pode usar com o tipo de pergunta de image: Esses parâmetros são suportados apenas no aplicativo de campo, a menos que indicado de outra forma na descrição.

Coluna XLSFormParâmetroDescrição
bind::esri:parametersallowAdds

Desabilite a adição de novas imagens ao editar registros existentes.

Valor: false

Exemplo:

allowAdds=false
fileName

Especifique o nome do arquivo.

Valores: <expression>

Esse parâmetro também é compatível com o aplicativo da web.

Exemplos:

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

Especifique o tamanho máximo do arquivo em megabytes. O padrão é 10 MB.

Valor: <megabytes>

Esse parâmetro também é compatível com o aplicativo da web.

Exemplo:

max-size=5

smartAnnotation

Para uma pergunta de imagem com aparência anotar, gera automaticamente gráficos de anotação de rótulos e caixas delimitadoras ao redor dos objetos detectados. Anexe essas propriedades para definir o estilo e a formatação da anotação.

Propriedade exigida: <model_name>

Propriedades opcionais: minScore | cameraPreview | label | class | boundingBoxes | outlineWidth | fontSize | font | bold | italic

Exemplos:

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

smartAttributes

Realize detecção de objetos ou classificação de imagens e use os resultados EXIF ​​em sua pesquisa.

Propriedade exigida: <model_name>

Propriedades opcionais: minScore | cameraPreview | label | class

Exemplos:

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

redaction

Gere automaticamente ou adicione manualmente caixas delimitadoras e aplique efeitos de edição na região de destino.

Propriedade exigida: <model_name> | @faces | @manual

Propriedades opcionais: minScore | cameraPreview | label | class | effect | symbol | fillColor | scale

Exemplos:

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

Especifique a posição de uma marca d'água de imagem. Anexe propriedades para definir o conteúdo e a formatação. Para obter mais informações, consulte Marcas d'água.

Propriedades: text | color | outlineColor | outlineWidth | haloColor | size | font | bold | italic | margin | image | imageSize

Exemplos:

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

Especifique se os usuários podem editar manualmente o nome do arquivo.

Valores: true | false

Exemplo:

allowRename=false
fileNameVisible

Especifique se o nome do arquivo é visível na pesquisa.

Valores: true | false

Exemplo:

fileNameVisible=true
footerText

Para uma pergunta de imagem com aparência de assinatura, especifique o texto a ser exibido na parte inferior do pop-up de assinatura. Se nenhum valor for especificado, a dica de orientação da pergunta aparecerá abaixo da assinatura. Isso pode ser alterado para a dica da pergunta usando footerText=@[hint].

Valores: <none> | @[hint]

Exemplos:

footerText
footerText=@[hint]
method

Especifique o método de captura para uma pergunta de imagem. O valor map somente é compatível com perguntas de imagem com aparência de anotação.

Esse parâmetro também é compatível com o aplicativo da web.

Valores: browse | camera | map

Exemplos:

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

Para uma pergunta de imagem com aparência de desenho ou anotação, especifique uma paleta de ferramentas de desenho personalizada.

Valor: <palette name>

Exemplo:

palette=SiteLayout
previewHeight

Defina a altura da visualização da imagem após a imagem ser selecionada. Utilize previewHeight=0 se você desejar que sua visualização de imagem seja do tamanho máximo sem o espaço em branco desnecessário.

Valores: <lines> | <lines>lines | <percentage of screen height>% | <pixels>pixels

Exemplos:

previewHeight=3lines
previewHeight=120pixels
parametersmax-pixels

Para uma pergunta de imagem, defina o tamanho máximo da imagem na borda mais longa, preservando a proporção original.

Para uma pergunta de imagem com aparência de assinatura, defina a largura máxima do pop-up de assinatura.

Para uma pergunta de imagem com aparência de desenho, defina a tela para uma imagem quadrada (1:1).

Esse parâmetro também é compatível com o aplicativo da web.

Valor: <pixels>

Exemplos:

max-pixels=1500
max-pixels=400

Perguntas de mapa

A tabela a seguir contém os parâmetros de XLSForm que você pode usar com os tipos de pergunta geopoint, geotrace e geoshape. Esses parâmetros são suportados apenas no aplicativo de campo, a menos que indicado de outra forma na descrição.

Coluna XLSFormParâmetroDescrição
body::esri:styleheight

Defina a altura da visualização do mapa.

Valores: <lines> | <lines>lines | <percentage of screen height>% | <pixels>pixels

Exemplos:

previewHeight=6lines
previewHeight=250pixels

lineColor²

fillColor³

Especifique as cores de linha e preenchimento para a feição de linha ou polígono. Isso se aplica à visualização do mapa somente no Survey123. Para obter mais informações, consulte Opções de estilo.

Valores: <HTML color name> | <hex color code>

Exemplo:

lineColor=Black 
fillColor=#9EFFF5
lineWidth²

Especifique a largura da linha em pixels para a feição de linha ou polígono. Isso se aplica à visualização do mapa somente no Survey123.

Valor: <pixels>

Exemplos:

lineWidth=3
map

Definir um mapa base padrão.

Esse parâmetro também é compatível com o aplicativo da web.

Valores: <map name> | <map item ID>

Exemplos:

map="World Topography"
map=de26a3cf4cc9451298ea173c4b324736

mapTools

Controle as ferramentas de mapa que estão disponíveis para questões de ponto geográfico, traço geográfico e forma geográfica.

Este parâmetro é suportado apenas no aplicativo de campo.

Valores: search | mapSwitcher | zoom | home | locate

Exemplos:

mapTools=zoom
mapTools=search,locate

method²

Especifique o método de captura. Ao usar o método de vértice, parâmetros adicionais podem ser definidos.

Esse parâmetro também é compatível com o aplicativo da web.

Valores: sketch | vertex

Valores adicionais para vértice, aplicáveis ​​apenas no aplicativo de campo: streaming | beep | haptic | edit

Exemplos:

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

Especifique o nível mínimo no qual a geometria pode ser capturada.

Este parâmetro é suportado apenas no aplicativo da web.

Valor: <integer>

Exemplo:

minCaptureZoomLevel=17

overlay

Exiba localizações de pontos da primeira pergunta de ponto geográfico em uma repetição em qualquer outra pergunta de ponto geográfico, forma geográfica ou traçado geográfico em sua pesquisa. Acrescente propriedades para definir o conteúdo e o estilo.

Valor: <repeat name>

Propriedades: view | preview | icon | iconColor | iconOutlineColor | iconSize | label | labelColor | labelOutlineColor | fontSize

Exemplos:

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

precision

Especifique o número de casas decimais que serão capturadas na pergunta do mapa e mostradas no painel de resposta individual da pesquisa. Quando este parâmetro não está definido, todas as casas decimais disponíveis são capturadas na pergunta do mapa, mas apenas seis casas decimais serão mostradas no painel de resposta individual.

Este parâmetro é suportado apenas no aplicativo da web.

Valor: <integer>

Exemplo:

precision=4

snapMode

Especifique o comportamento de ajuste. Pontos podem ser ajustados a outras feições e linhas e polígonos podem ser ajustados a outras feições ou a si mesmos. Disponível apenas quando method=vertex.

Este parâmetro é suportado apenas no aplicativo da web.

Valores: feature | self²

Exemplo:

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

Especifique um arquivo .png para usar como marcador de ponto no mapa. Anexe propriedades para definir a posição e a escala.

Valor: <file name>.png

Propriedades: x | y | scale

Exemplo:

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

¹Compatível apenas com o tipo de pergunta de ponto geográfico.

²Compatível apenas com os tipos de pergunta forma geográfica e traçado geográfico.

³Compatível apenas com o tipo de pergunta de forma geográfica.

Perguntas de múltipla escolha

A tabela a seguir contém os parâmetros de XLSForm que você pode usar com tipos de perguntas select_one, select_multiple e rank: Este parâmetro tem suporte no aplicativo de campo e no aplicativo da web.

Coluna XLSFormParâmetroDescrição
parametersrandomize

Randomize a ordem das escolhas em uma lista de opções.

Valores: true

Exemplo:

randomize=true

Intervalo

A tabela a seguir contém os parâmetros de XLSForm que você pode usar com o tipo de pergunta range: Esses parâmetros são suportados no aplicativo de campo e no aplicativo da web.

Coluna XLSFormParâmetroDescrição

body::esri:style

startColor

endColor

color

Especifique a cor do controle deslizante no início e no final do intervalo.≠ Use o parâmetro color para especificar a cor usada para preencher o espaço entre o início do controle deslizante e o valor selecionado. Os parâmetros devem ser separados por um espaço. Para obter mais informações, consulte Opções de estilo.

Valores: <HTML color name> | <hex color code>

Exemplos:

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

parametros

start

end

step

Especifique os valores inicial, final e de etapa do controle deslizante de intervalo. Os parâmetros devem ser separados por um espaço. Para mais informações, consulte Parâmetros de intervalo.

Valores: <integer> | <decimal>

Exemplos:

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

Repetições

A tabela a seguir contém os parâmetros de XLSForm que você pode usar com o tipo de pergunta begin repeat: Esses parâmetros são suportados apenas no aplicativo de campo.

Coluna XLSFormParâmetroDescrição
bind::esri:parametersallowAdds

Permitir que novos registros repetidos sejam adicionados.

Valores: true | false

Exemplo:

allowAdds=true
allowUpdates

Permitir que os registros repetidos existentes sejam modificados.

Valores: true | false

Exemplo:

allowUpdates=false
query

Permitir que os registros repetidos existentes sejam mostrados no formulário. Especifique parâmetros de consulta adicionais para filtrar os registros disponíveis.

Valores: <none> | "SQL statement"

Exemplos:

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

backgroundColor

borderColor

Defina as cores do plano de fundo e da borda para uma repetição. Para obter mais informações, consulte Grupo, página e cores repetidas.

Valores: <HTML color name> | <hex color code>

Exemplos:

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

Texto

A tabela a seguir contém os parâmetros de XLSForm que você pode usar com o tipo de pergunta text: Esses parâmetros são suportados apenas no aplicativo de campo, a menos que indicado de outra forma na descrição.

Coluna XLSFormParâmetroDescrição
bind::esri:parametersgeocode

Para uma pergunta de texto com aparência de geocódigo, defina o localizador para retornar resultados geocodificados ao usar a aparência de geocódigo.

Esse parâmetro também é compatível com o aplicativo da web.

Valor: <locator item ID>

Exemplo:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

medição

Para uma pergunta de texto com aparência de telêmetro, defina quais medições serão armazenadas na pergunta. Coloque a lista de valores entre aspas se os valores incluírem espaços.

Valores: height | azimuth | horizontalDistance | slopeDistance | inclination | multipleHeights

Exemplos:

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

Para uma pergunta de texto com aparência de várias linhas, defina a altura inicial da caixa de texto. A altura da caixa de texto aumentará para acomodar o texto de resposta.

Valor: <number of lines>

Exemplo:

defaultHeight=5
indicator

Para uma pergunta de texto com aparência de geocódigo, permita que os resultados geocodificados mostrem a direção e a distância da localização atual do dispositivo.

Valores: direction | distance | none

Exemplos:

indicator=none
indicator=direction
indicator=direction,distance
maxResults

Para uma pergunta de texto com aparência de geocódigo, especifique o número máximo de resultados a serem retornados. O padrão é 6.

Valor: <number of results>

Esse parâmetro também é compatível com o aplicativo da web.

Exemplo:

maxResults=10
proximity

Para uma pergunta de texto com aparência de geocódigo, especifique se os resultados geocodificados mostram apenas resultados dentro de um determinado raio da localização do dispositivo.

Valores: <distance>m | km | ft | mi | yd

Exemplos:

proximity=3km
proximity=1000ft
suggestions

Para uma pergunta de texto com aparência de geocódigo, altere a maneira como as sugestões são preenchidas. O padrão é Sim.

Valores: yes | no

Exemplo:

suggestions=no

Telêmetro

A tabela a seguir contém o parâmetro XLSForm que você pode usar com o tipos de perguntas texto, decimal e inteiro para recuperar valores de um telêmetro. Esses parâmetros são suportados apenas no aplicativo de campo, a menos que indicado de outra forma na descrição.

Coluna XLSFormParâmetroDescrição
bind::esri:parameters

medição

Para uma pergunta de texto com aparência de telêmetro, defina quais medições serão armazenadas na pergunta. Coloque a lista de valores entre aspas se os valores incluírem espaços.

Valores: height | azimuth | horizontalDistance | slopeDistance | inclination | multipleHeights

Exemplos:

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