Parámetros de XLSForm

Ciertos tipos de preguntas de XLSForm presentan parámetros adicionales que le permiten controlar el estilo o el comportamiento de las preguntas de una encuesta. En algunos casos, estos parámetros complementan las apariencias que admite un tipo de pregunta. Las tablas que aparecen a continuación ofrecen una visión general de los parámetros que puede utilizar en XLSForm, así como la columna de la hoja de cálculo de la encuesta que acepta cada parámetro. No todos los parámetros son compatibles tanto con la aplicación de campo de ArcGIS Survey123 como con la aplicación web. Para más información acerca de la compatibilidad con la aplicación de campo y la aplicación web, consulte el tema de la documentación de cada parámetro.

Puede agregar varios parámetros para una pregunta a la misma columna separando los parámetros con espacios. Por ejemplo, una pregunta geoshape puede tener los parámetros map, method, lineColor y fillColor en la columna body::esri:style, tal como se muestra a continuación:

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

General

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con distintos tipos de pregunta. Consulte la descripción de cada parámetro para ver la lista de tipos de preguntas que lo admiten. Estos parámetros solo se admiten en la aplicación de campo.

Columna de XLSFormParámetroDescripción
bind::esri:parameterscalculationMode

Controla cuándo se realiza el cálculo de una pregunta.

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

Valores: auto | manual | always | whenEmpty

Ejemplos:

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

Especifica el texto que aparece en el área de entrada de la pregunta cuando ésta está vacía.

Tipos de preguntas: text | integer | decimal | select_one (con apariencia autocomplete) | barcode

Valores: @[hint] | @[guidance_hint]

Ejemplos:

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

Audio

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con el tipo de pregunta audio. Estos parámetros solo se admiten en la aplicación de campo, a menos que se indique lo contrario en la descripción.

Columna de XLSFormParámetroDescripción
bind::esri:parameterscodec

Especifique el códec preferido de una grabación de audio. Se pueden proporcionar varios códecs separados por comas. Se utilizará el primer códec que sea compatible con el dispositivo.

Valor: <codec name>

Ejemplo:

codec=amr-nb,aac
fileName

Especifique el nombre de archivo.

Valores: <expression>

Este parámetro solo se admite en la aplicación web.

Ejemplos:

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

Especifica la duración máxima en segundos de una grabación de audio. La duración predeterminada en la aplicación web es 600 (10 minutos).

Valor: <seconds>

Ejemplo:

max-duration=45
max-size

Especifique el tamaño de archivo máximo de una grabación de audio en megabytes. El tamaño predeterminado en la aplicación de campo es de 10 MB.

Valor: <megabytes>

Ejemplo:

max-size=5

Código de barras

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con el tipo de pregunta barcode. Estos parámetros solo se admiten en la aplicación de campo.

Columna de XLSFormParámetroDescripción
body::esri:style

barcodeType

Especifique los tipos de códigos de barras que pueden escanear los usuarios. Se pueden proporcionar varios tipos, separados por comas. Cuando no se proporciona el parámetro barcodeType, se pueden escanear todos los tipos de códigos de barras admitidos, excepto aztec, code39, datamatrix, maxicode y pdf417.

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

  • all: todos los tipos admitidos excepto code39 y pdf417.
  • 1d: todos los tipos unidimensionales excepto code39.
  • 2d: todos los tipos bidimensionales excepto pdf417.

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

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

Ejemplos:

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

Archivo

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con el tipo de pregunta file.

Columna de XLSFormParámetroDescripción
bind::esri:parametersfileName

Especifique el nombre de archivo.

Valores: <expression>

Este parámetro solo se admite en la aplicación web.

Ejemplos:

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

Especifica el tamaño máximo del archivo en megabytes. El valor predeterminado es de 10 MB.

Valor: <megabytes>

Este parámetro es compatible con la aplicación de campo y la aplicación web.

Ejemplo:

max-size=5

Grupos

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con el tipo de pregunta begin group. Estos parámetros solo se admiten en la aplicación de campo.

Columna de XLSFormParámetroDescripción
body::esri:style

backgroundColor

borderColor

Especifica los colores de fondo y de los bordes de un grupo o una página. Para obtener más información, consulte Colores de grupos, páginas y repeticiones.

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

Ejemplos:

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

layout

Especifica el estilo de diseño de la cuadrícula de un grupo.

Valores: dynamic-grid | fixed-grid

Ejemplo:

layout=fixed-grid

Imágenes

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con el tipo de pregunta image. Estos parámetros solo se admiten en la aplicación de campo, a menos que se indique lo contrario en la descripción.

Columna de XLSFormParámetroDescripción
bind::esri:parametersallowAdds

Deshabilita la adición de nuevas imágenes al editar los registros existentes.

Valor: false

Ejemplo:

allowAdds=false
fileName

Especifique el nombre de archivo.

Valores: <expression>

Este parámetro también se admite en la aplicación web.

Ejemplos:

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

Especifica el tamaño máximo del archivo en megabytes. El valor predeterminado es de 10 MB.

Valor: <megabytes>

Este parámetro también se admite en la aplicación web.

Ejemplo:

max-size=5

smartAnnotation

Para una pregunta de imagen con apariencia annotate, genera automáticamente gráficos de anotación de etiquetas y cuadros delimitadores alrededor de los objetos detectados. Incorpore estas propiedades para definir el estilo y el formato de la anotación.

Propiedad requerida: <model_name>

Propiedades opcionales: minScore | cameraPreview | label | class | boundingBoxes | outlineWidth | fontSize | font | bold | italic

Ejemplos:

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

smartAttributes

Realice la detección de objetos o la clasificación de imágenes y utilice los resultados EXIF en su encuesta.

Propiedad requerida: <model_name>

Propiedades opcionales: minScore | cameraPreview | label | class

Ejemplos:

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

redaction

Genere automáticamente o agregue manualmente cuadros delimitadores y aplique efectos de edición en el área objetivo.

Propiedad requerida: <model_name> | @faces | @manual

Propiedades opcionales: minScore | cameraPreview | label | class | effect | symbol | fillColor | scale

Ejemplos:

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

Especifica la posición de una marca de agua de imagen. Incorpora propiedades para definir el contenido y el formato. Para más información, véase Marcas de agua.

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

Ejemplos:

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

Especifique si los usuarios pueden editar el nombre de archivo de forma manual.

Valores: true | false

Ejemplo:

allowRename=false
fileNameVisible

Especifique si el nombre de archivo está visible en la encuesta.

Valores: true | false

Ejemplo:

fileNameVisible=true
footerText

En el caso de una pregunta image con apariencia signature, especifique el texto que debe aparecer en la parte inferior de la ventana emergente de la firma. Si no se especifica ningún valor, las sugerencias de orientación de la pregunta aparecerán debajo de la firma. Esto se puede cambiar a las sugerencias de la pregunta utilizando footerText=@[hint].

Valores: <none> | @[hint]

Ejemplos:

footerText
footerText=@[hint]
method

Especifique el método de captura para las preguntas image. El valor map solo se admite para las preguntas image con apariencia annotate.

Este parámetro también se admite en la aplicación web.

Valores: browse | camera | map

Ejemplos:

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

En el caso de una pregunta image con apariencia annotate, especifique una paleta de herramientas de dibujo personalizada.

Valor: <palette name>

Ejemplo:

palette=SiteLayout
previewHeight

Define la altura de la vista previa de la imagen una vez seleccionada esta. Use previewHeight=0 si desea que su vista previa de imagen tenga el máximo tamaño sin ningún espacio vacío innecesario.

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

Ejemplos:

previewHeight=3lines
previewHeight=120pixels
parametersmax-pixels

En el caso de las preguntas image, define el tamaño máximo de la imagen en el borde más largo, conservando la relación de aspecto original.

En el caso de una pregunta image con apariencia signature, define la anchura máxima de la ventana emergente de la firma.

En el caso de las preguntas image con apariencia draw, cambia el lienzo a una imagen cuadrada (1:1).

Este parámetro también se admite en la aplicación web.

Valor: <pixels>

Ejemplos:

max-pixels=1500
max-pixels=400

Preguntas de mapa

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con los tipos de pregunta geopoint, geotrace y geoshape. Estos parámetros solo se admiten en la aplicación de campo, a menos que se indique lo contrario en la descripción.

Columna de XLSFormParámetroDescripción
body::esri:styleheight

Define la altura de la vista previa de mapa.

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

Ejemplos:

previewHeight=6lines
previewHeight=250pixels

lineColor²

fillColor³

Especifica los colores de línea y de relleno de la entidad de línea o polígono. Se aplica solo a la vista previa del mapa en Survey123. Para obtener más información, consulte Opciones de estilo.

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

Ejemplo:

lineColor=Black 
fillColor=#9EFFF5
lineWidth²

Especifica el ancho de línea en píxeles de la entidad de línea o polígono. Se aplica solo a la vista previa del mapa en Survey123.

Valor: <pixels>

Ejemplos:

lineWidth=3
map

Define un mapa base predeterminado.

Este parámetro también se admite en la aplicación web.

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

Ejemplos:

map="World Topography"
map=de26a3cf4cc9451298ea173c4b324736

mapTools

Controle las herramientas de mapas que están disponibles para preguntas geopoint, geotrace, y geoshape.

Este parámetro solo se admite en la aplicación de campo.

Valores: search | mapSwitcher | zoom | home | locate

Ejemplos:

mapTools=zoom
mapTools=search,locate

method²

Especifica el método de captura. Cuando se utiliza el método de vértice, es posible configurar los parámetros adicionales.

Este parámetro también se admite en la aplicación web.

Valores: sketch | vertex

Valores adicionales para vértice, aplicables solo en la aplicación de campo: streaming | beep | haptic | edit

Ejemplos:

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

Especifique el nivel mínimo en el que se puede capturar geometría.

Este parámetro solo se admite en la aplicación web.

Valor: <integer>

Ejemplo:

minCaptureZoomLevel=17

overlay

Muestra las ubicaciones de los puntos de la primera pregunta geopoint de una repetición en cualquier otra pregunta geopoint, geoshape o geotrace de su encuesta. Incorpora propiedades para definir el contenido y el estilo.

Valor: <repeat name>

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

Ejemplos:

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

precision

Especifique el número de posiciones decimales que se capturarán en la pregunta de mapa y que se mostrarán en el panel de respuesta individual de la encuesta. Si este parámetro no está configurado, todas las posiciones decimales disponibles se capturan en la pregunta de mapa, pero solo se muestran seis posiciones decimales en el panel de respuesta individual.

Este parámetro solo se admite en la aplicación web.

Valor: <integer>

Ejemplo:

precision=4

snapMode

Especifique el comportamiento de alineación. Los puntos se pueden alinear a otras entidades, y las líneas y polígonos se pueden alinear a otras entidades o a sí mismos. Solo está disponible si method=vertex.

Este parámetro solo se admite en la aplicación web.

Valores: feature | self²

Ejemplo:

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

Especifique un archivo .png para utilizarlo como marcador de puntos en el mapa. Incorpore propiedades para definir la posición y la escala.

Valor: <file name>.png

Propiedades: x | y | scale

Ejemplo:

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

¹Admitido únicamente con el tipo de pregunta geopoint.

²Admitido únicamente con los tipos de pregunta geoshape y geotrace.

¹Admitido únicamente con el tipo de pregunta geoshape.

Preguntas de varias opciones

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con los tipos de pregunta select_one, select_multiple y rank. Este parámetro es compatible con la aplicación de campo y la aplicación web.

Columna de XLSFormParámetroDescripción
parametersrandomize

Ordenar aleatoriamente las opciones de una lista de opciones.

Valores: true

Ejemplo:

randomize=true

Rango

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con el tipo de pregunta range. Estos parámetros son compatibles con la aplicación de campo y la aplicación web.

Columna de XLSFormParámetroDescripción

body::esri:style

startColor

endColor

color

Especifica el color del control deslizante al principio y al final del rango. Utilice el parámetro color para especificar el color que se utiliza para rellenar el espacio entre el inicio del control deslizante y el valor seleccionado. Los parámetros deben estar separados por espacios. Para obtener más información, consulte Opciones de estilo.

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

Ejemplos:

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

parámetros

start

end

step

Especifique los valores inicial, final y de paso del control deslizante de rango. Los parámetros deben estar separados por espacios. Para obtener más información, consulte Parámetros de rango.

Valores: <integer> | <decimal>

Ejemplos:

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

Repeticiones

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con el tipo de pregunta begin repeat. Estos parámetros solo se admiten en la aplicación de campo.

Columna de XLSFormParámetroDescripción
bind::esri:parametersallowAdds

Permite agregar nuevos registros de repetición.

Valores: true | false

Ejemplo:

allowAdds=true
allowUpdates

Permite modificar los registros de repetición existentes.

Valores: true | false

Ejemplo:

allowUpdates=false
query

Permite mostrar los registros repetidos existentes en el formulario. Especifique parámetros de consulta adicionales para filtrar los registros disponibles.

Valores: <none> | "SQL statement"

Ejemplos:

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

backgroundColor

borderColor

Especifica los colores de fondo y de los bordes de una repetición. Para obtener más información, consulte Colores de grupos, páginas y repeticiones.

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

Ejemplos:

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

Texto

La siguiente tabla contiene los parámetros de XLSForm que puede utilizar con el tipo de pregunta text. Estos parámetros solo se admiten en la aplicación de campo, a menos que se indique lo contrario en la descripción.

Columna de XLSFormParámetroDescripción
bind::esri:parametersgeocode

En el caso de las preguntas text con apariencia geocode, define el localizador desde el que se devolverán los resultados geocodificados cuando utilice la apariencia geocode.

Este parámetro también se admite en la aplicación web.

Valor: <locator item ID>

Ejemplo:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

medición

Para una pregunta de texto con apariencia de telémetro, establezca qué mediciones se almacenarán en la pregunta. Encierre la lista de valores entre comillas si los valores incluyen espacios.

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

Ejemplos:

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

Para una pregunta de texto con apariencia multiline, defina la altura inicial del cuadro de texto. La altura del cuadro de texto aumenta para adaptarse al texto de la respuesta.

Valor: <number of lines>

Ejemplo:

defaultHeight=5
indicator

En el caso de las preguntas text con apariencia geocode, permite que los resultados geocodificados muestren la dirección y la distancia desde la ubicación actual del dispositivo.

Valores: direction | distance | none

Ejemplos:

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

En el caso de las preguntas text con apariencia geocode, especifique el número máximo de resultados a devolver. El valor predeterminado es 6.

Valor: <number of results>

Este parámetro también se admite en la aplicación web.

Ejemplo:

maxResults=10
proximity

En el caso de las preguntas text con apariencia geocode, especifica si los resultados geocodificados solo muestran resultados dentro de un determinado radio de la ubicación del dispositivo.

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

Ejemplos:

proximity=3km
proximity=1000ft
suggestions

En el caso de las preguntas de texto con apariencia geocode, cambie la forma en que se rellenan las sugerencias. La opción predeterminada es Sí.

Valores: yes | no

Ejemplo:

suggestions=no

Telémetro

La siguiente tabla contiene el parámetro XLSForm, que puede usar con los tipos de pregunta de texto, decimal y entero para recuperar valores de un telémetro. Estos parámetros solo se admiten en la aplicación de campo, a menos que se indique lo contrario en la descripción.

Columna de XLSFormParámetroDescripción
bind::esri:parameters

medición

Para una pregunta de texto con apariencia de telémetro, establezca qué mediciones se almacenarán en la pregunta. Encierre la lista de valores entre comillas si los valores incluyen espacios.

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

Ejemplos:

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