Parâmetros

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. Nem todos os parâmetros são suportados em todos os aplicativos de envio (Survey123 Mobile, o aplicativo de campo Survey123 e aplicativo web Survey123). Para mais informações sobre o suporte do aplicativo, consulte as tabelas de parâmetros abaixo, organizadas por tipo de pergunta e a coluna do XLSForm na planilha da pesquisa que aceita 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 range pode ter os parâmetros startColor, endColor e color na coluna body::esri:style, como segue:

startColor=Orange endColor=White color=#FF6347

Geral

Esta seção descreve os parâmetros que você pode usar nas colunas bind::esri:parameters e body::esri:style do XLSForm para diversos tipos de pergunta.

A tabela a seguir descreve o parâmetro que você pode usar na coluna bind::esri:parameters do XLSForm para os tipos de pergunta text, integer, decimal, note, date, time, dateTime, select_one, select_multiple, geopoint, calculate e hidden.

bind::esri:parameters

ParâmetroDescriçãoAplicativo de envio
calculationMode

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

Valores: auto | manual | always | whenEmpty

Exemplos:

calculationMode=manual
calculationMode=always

Aplicativo da web

Aplicativo de campo

A tabela a seguir descreve o parâmetro que você pode usar na coluna body::esri:style do XLSForm para os tipos de pergunta text, integer, decimal, select_one (com a aparência autocomplete), select_multiple (com a aparência autocomplete)*, e barcode.

body::esri:style

ParâmetroDescriçãoAplicativo de envio
placeholderText

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

Valores: @[hint] | @[guidance_hint]

Exemplos:

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

Survey123 Mobile

Aplicativo de campo

*Suportado somente pelo Survey123 Mobile

Áudio

A tabela a seguir descreve os parâmetros que você pode usar na coluna bind::esri:parameters do XLSForm para o tipo de pergunta audio.

bind::esri:parameters

ParâmetroDescriçãoAplicativo de envio
codec

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

Survey123 Mobile

Aplicativo de campo

fileName

Especifique o nome do arquivo.

Valores: <expression>

Exemplos:

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

Aplicativo da web

duração máxima

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

Survey123 Mobile

Aplicativo da web

Aplicativo de campo

tamanho máximo

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

Survey123 Mobile

Aplicativo de campo

Código de barras

A tabela a seguir descreve os parâmetros que você pode usar na coluna body::esri:style do XLSForm para o tipo de pergunta barcode.

body::esri:style

ParâmetroDescriçãoAplicativo de envio

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

Aplicativo de campo

Arquivo

A tabela a seguir descreve os parâmetros que você pode usar na coluna bind::esri:parameters do XLSForm para o tipo de pergunta file.

bind::esri:parameters

ParâmetroDescriçãoAplicativo de envio
fileName

Especifique o nome do arquivo.

Valores: <expression>

Exemplos:

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

Aplicativo da web

max-size

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

Valor: <megabytes>

Exemplo:

max-size=5

Aplicativo da web

Grupos

A tabela a seguir descreve os parâmetros que você pode usar na coluna body::esri:style do XLSForm para o tipo de pergunta begin group.

body::esri:style

ParâmetroDescriçãoAplicativo de envio

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

Survey123 Mobile

Aplicativo de campo

layout

Defina o estilo de layout de grade para um grupo.

Valores: dynamic-grid | fixed-grid

Exemplo:

layout=fixed-grid

Aplicativo de campo

Imagens

Esta seção descreve os parâmetros que você pode usar nas colunas do XLSForm especificadas para o tipo de pergunta image.

A tabela a seguir descreve os parâmetros que você pode usar na coluna bind::esri:parameters do XLSForm.

bind::esri:parameters

ParâmetroDescriçãoAplicativo de envio
allowAdds

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

Valor: false

Exemplo:

allowAdds=false

Aplicativo de campo

fileName

Especifique o nome do arquivo.

Valores: <expression>

Exemplos:

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

Aplicativo da web

Aplicativo de campo

tamanho máximo

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

Valor: <megabytes>

Exemplo:

max-size=5

Aplicativo da web

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

Aplicativo de campo

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

Aplicativo de campo

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=🐻

Aplicativo de campo

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"

Aplicativo de campo

A tabela a seguir descreve os parâmetros que você pode usar na coluna body::esri:style do XLSForm para o tipo de pergunta image.

body::esri:style

ParâmetroDescriçãoAplicativo de envio
allowRename

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

Valores: true | false

Exemplo:

allowRename=false

Aplicativo de campo

fileNameVisible

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

Valores: true | false

Exemplo:

fileNameVisible=true

Aplicativo de campo

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]

Survey123 Mobile

Aplicativo de campo

método

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.

Valores: browse | camera | map

Exemplos:

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

Aplicativo da web

Aplicativo de campo

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

Aplicativo de campo

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

Aplicativo de campo

A tabela a seguir descreve o parâmetro que você pode usar na coluna parameters do XLSForm para o tipo de pergunta image.

parameters

ParâmetroDescriçãoAplicativo de envio
max-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).

Valor: <pixels>

Exemplos:

max-pixels=1500
max-pixels=400

Aplicativo da web

Aplicativo de campo

Perguntas de mapa

A tabela a seguir descreve os parâmetros que você pode utilizar nas colunas do XLSForm especificadas para os tipos de pergunta geopoint, geotrace e geoshape.

A tabela a seguir descreve o parâmetro que você pode usar na coluna bind::esri:parameters do XLSForm.

bind::esri:parameters

ParâmetroDescriçãoAplicativo de envio

geocodificar

Defina o localizador para retornar resultados geocodificados.

Valor: <locator item ID>

Exemplo:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

Aplicativo da web

Aplicativo de campo

A tabela a seguir descreve os parâmetros que você pode utilizar na coluna body::esri:style do XLSForm para os tipos de pergunta geopoint, geotrace e geoshape.

body::esri:style

ParâmetroDescriçãoAplicativo de envio
height

Defina a altura da visualização do mapa.

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

Exemplos:

previewHeight=6lines
previewHeight=250pixels

Aplicativo de campo

lineColor2

fillColor3

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 Simbologia da geometria.

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

Exemplo:

lineColor=Black 
fillColor=#9EFFF5

Survey123 Mobile

Aplicativo de campo

lineWidth2

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

Survey123 Mobile

Aplicativo de campo

map

Definir um mapa base padrão.

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

Exemplos:

map="World Topography"
map=de26a3cf4cc9451298ea173c4b324736

Aplicativo da web

Aplicativo de campo

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.

Valores: search | mapSwitcher | zoom | home | locate

Exemplos:

mapTools=zoom
mapTools=search,locate

Aplicativo de campo

method2

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

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

Aplicativo da web

Aplicativo de campo

minCaptureZoomLevel

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

Valor: <integer>

Exemplo:

minCaptureZoomLevel=17

Aplicativo da web

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

Aplicativo de campo

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.

Valor: <integer>

Exemplo:

precision=4

Aplicativo da web

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.

Valores: feature | self2

Exemplo:

snapMode=feature
snapMode=self
snapMode=self,feature

Aplicativo da web

symbol1

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

Aplicativo de campo

1—suportado apenas com o tipo de pergunta de ponto geográfico.

2—suportado apenas com o tipo de pergunta de forma geográfica e traçado geográfico.

3—suportado apenas com o tipo de pergunta de forma geográfica.

Perguntas de múltipla escolha

A tabela a seguir descreve o parâmetro que você pode usar na coluna parameters do XLSForm para os tipos de pergunta select_one, select_multiple e rank.

parameters

ParâmetroDescriçãoAplicativo de envio
randomizar

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

Valores: true

Exemplo:

randomize=true

Aplicativo da web

Aplicativo de campo

Intervalo

Esta seção descreve os parâmetros que você pode usar nas colunas do XLSForm especificadas para o tipo de pergunta range. Ao combinar, os parâmetros devem ser separados por um espaço.

A tabela a seguir descreve os parâmetros que você pode usar na coluna body::esri:style do XLSForm. Para obter mais informações, consulte Opções de estilo.

body::esri:style

ParâmetroDescriçãoAplicativo de envio

startColor

endColor

color

Especifique as cores para o controle deslizante de intervalo:

  • Cor do controle deslizante no início do intervalo.
  • Cor do controle deslizante no final do intervalo.
  • Cor que preenche o espaço entre o início do controle deslizante e o valor selecionado.

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

Exemplos:

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

Survey123 Mobile

Aplicativo da web

Aplicativo de campo

A tabela a seguir descreve os parâmetros que você pode usar na coluna parameters do XLSForm para o tipo de pergunta range. Para mais informações, consulte Parâmetros do controle deslizante de intervalo.

parameters

ParâmetroDescriçãoAplicativo de envio

start

end

step

Especifique os valores inicial, final e de etapa do controle deslizante de intervalo.

Valores: <integer> | <decimal>

Exemplos:

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

Survey123 Mobile

Aplicativo da web

Aplicativo de campo

Repetições

Esta seção descreve os parâmetros que você pode usar nas colunas do XLSForm especificadas para o tipo de pergunta begin repeat.

A tabela a seguir descreve os parâmetros que você pode usar na coluna bind::esri:parameters do XLSForm.

bind::esri:parameters

ParâmetroDescriçãoAplicativo de envio
allowAdds

Permitir que novos registros repetidos sejam adicionados.

Valores: true | false

Exemplo:

allowAdds=true

Aplicativo de campo

allowUpdates

Permitir que os registros repetidos existentes sejam modificados.

Valores: true | false

Exemplo:

allowUpdates=false

Aplicativo de campo

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'"

Aplicativo de campo

A tabela a seguir descreve os parâmetros que você pode usar na coluna body::esri:style do XLSForm para o tipo de pergunta begin repeat.

body::esri:style

ParâmetroDescriçãoAplicativo de envio

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

Survey123 Mobile

Aplicativo de campo

addRecordMode

Para uma repetição com aparência tabular, especifique o modo para o botão Adicionar registro e a opção Copiar para novo registro na visualização tabular. O padrão é row. Quando o valor é row, o novo registro é anexado à visualização tabular. Quando o valor é form, o novo registro é aberto na visualização de formulário.

Valores: row | form

Exemplo:

addRecordMode=form

Survey123 Mobile

editInFormView

Para uma repetição com aparência tabular, mostre ou oculte a opção Editar na visualização de formulário na visualização tabular. O padrão é true.

Anotação:

Quando a repetição apresenta erros, a opção Editar na visualização de formulário é habilitada mesmo quando o parâmetro editInFormView está definido como false.

Valores: true | false

Exemplo:

editInFormView=false

Survey123 Mobile

copyToNewRecord

Para uma repetição com aparência tabular, mostre ou oculte a opção Copiar para novo registro na visualização tabular. Esta opção permite aos usuários duplicar um registro na repetição. O padrão é true. O parâmetro addRecordMode determina como o registro duplicado é adicionado.

Valores: true | false

Exemplo:

copyToNewRecord=true

Survey123 Mobile

editInTabularView

Para uma repetição com aparência tabular, habilite ou desabilite a edição na visualização tabular. O padrão é true. Quando o valor é false, todas as células na visualização tabular são de somente leitura.

Valores: true | false

Exemplo:

editInTabularView=false

Survey123 Mobile

A tabela a seguir descreve o parâmetro que você pode usar na coluna body::esri:style do XLSForm para perguntas em repetições tabulares.

body::esri:style

ParâmetroDescriçãoAplicativo de envio

showInTabularView

Para uma repetição com aparência tabular, mostre a pergunta como uma coluna na visualização tabular. O padrão é false.

Valores: true | false

Exemplo:

showInTabularView=true

Survey123 Mobile

Texto

Esta seção descreve os parâmetros que você pode usar nas colunas do XLSForm especificadas para o tipo de pergunta text.

A tabela a seguir descreve os parâmetros que você pode usar na coluna bind::esri:parameters do XLSForm.

bind::esri:parameters

ParâmetroDescriçãoAplicativo de envio
geocodificar

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.

Valor: <locator item ID>

Exemplo:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

Aplicativo da web

Aplicativo de campo

A tabela a seguir descreve os parâmetros que você pode usar na coluna body::esri:style do XLSForm para o tipo de pergunta text.

body::esri:style

ParâmetroDescriçãoAplicativo de envio
defaultHeight

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

Aplicativo de campo

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

Aplicativo de campo

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>

Exemplo:

maxResults=10

Aplicativo da web

Aplicativo de campo

proximidade

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

Aplicativo de campo

sugestões

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

Aplicativo de campo

Telêmetro

A tabela a seguir descreve o parâmetro que você pode usar na coluna bind::esri:parameters do XLSForm para os tipos de pergunta text, integer e decimal, para obter valores de um medidor de distância a laser.

bind::esri:parameters

ParâmetroDescriçãoAplicativo de envio

medição

Para uma pergunta de texto, decimal ou inteiro com aparência de telêmetro, defina quais medidas 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"

Aplicativo de campo