Paramètres XLSForm

Des paramètres supplémentaires peuvent être utilisés pour certains types de question dans XLSForm afin de contrôler le style et le comportement des questions d’une enquête. Dans certains cas, ces paramètres complètent les apparences prises en charge par un type de question. Les tableaux ci-dessous fournissent une vue d’ensemble des paramètres pouvant être utilisés dans XLSForm, ainsi que la colonne de la feuille de calcul de l’enquête qui accepte chaque paramètre. Tous les paramètres ne peuvent pas être utilisés à la fois dans l’application de terrain et dans l’application Web ArcGIS Survey123. Pour plus d’informations sur le support disponible pour l’application de terrain et pour l’application Web, référez-vous à la documentation spécifique à chaque paramètre.

Il est possible d’ajouter plusieurs paramètres pour une question à une même colonne en les séparant par des espaces. Par exemple, une question geoshape (géoforme) peut posséder les paramètres map, method, lineColor, et fillColor dans la colonne body::esri:style, comme suit :

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

Généralités

Le tableau suivant contient les paramètres XLSForm pouvant être utilisés avec différents types de question. Référez-vous à la description de chaque paramètre pour savoir quels types de question prennent en charge son utilisation. Ces paramètres sont uniquement pris en charge dans l’application de terrain.

Colonne XLSFormParamètreDescription
bind::esri:parameterscalculationMode

Contrôle quand est effectué le calcul dans une question.

Types de question : text | decimal | integer | note | date | time | dateTime | select_one | select_multiple | geopoint | calculate | hidden

Valeurs : auto | manual | always | whenEmpty

Exemples :

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

Spécifie le texte qui s’affiche dans la zone de saisie de la question lorsque la question est vide.

Types de question : text | integer | decimal | select_one (avec l’apparence renseignement automatique) | barcode

Valeurs : @[hint] | @[guidance_hint]

Exemples :

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

Sonore

La table suivante contient les paramètres XLSForm pouvant être utilisés avec le type de question audio. Ces paramètres sont uniquement pris en charge dans l’application de terrain sauf indication contraire dans la description.

Colonne XLSFormParamètreDescription
bind::esri:parameterscodec

Spécifie le codec préféré d’un enregistrement audio. Vous pouvez fournir plusieurs codecs en les séparant par des virgules. Le premier codec compatible avec l’appareil sera utilisé.

Valeur : <codec name>

Exemple :

codec=amr-nb,aac
fileName

Indique le nom de fichier.

Valeurs : <expression>

Ce paramètre n’est pris en charge que dans l’application Web.

Exemples :

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

Spécifie la durée maximum en secondes d’un enregistrement audio. La durée par défaut dans l’application Web est 600 (10 minutes).

Valeur : <seconds>

Exemple :

max-duration=45
max-size

Spécifie la taille de fichier maximale en mégaoctets d’un enregistrement audio. La taille par défaut dans l’application de terrain est 10 Mo.

Valeur : <megabytes>

Exemple :

max-size=5

Code à barres

Le tableau suivant contient les paramètres XLSForm pouvant être utilisés avec le type de question barecode (code à barres) : Ces paramètres sont uniquement pris en charge dans l’application de terrain.

Colonne XLSFormParamètreDescription
body::esri:style

barcodeType

Indiquez les types de codes à barres numérisables par les utilisateurs. Vous pouvez fournir plusieurs types en les séparant par des virgules. Lorsque le paramètre barcodeType n’est pas défini, tous les types de codes à barres pris en charge peuvent être numérisés, sauf aztec, code39, datamatrix, maxicode et pdf417.

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

  • all - Tous les types pris en charge, sauf code39 et pdf417.
  • 1d - Tous les types unidimensionnels, sauf code39.
  • 2d - Tous les types bidimensionnels, pdf417.

Types unidimensionnels : codabar | code128 | code39 | code93 | ean13 | ean8 | itf | upca | upce | upceanextension

Types bidimensionnels : aztec | datamatrix | maxicode | pdf417 | qrcode | rss14 | rssexpanded

Exemples :

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

Fichier

La table suivante contient les paramètres XLSForm pouvant être utilisés avec le type de question file (fichier).

Colonne XLSFormParamètreDescription
bind::esri:parametersfileName

Indique le nom de fichier.

Valeurs : <expression>

Ce paramètre n’est pris en charge que dans l’application Web.

Exemples :

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

Spécifie la taille maximum de fichier en mégaoctets. La taille par défaut est 10 Mo.

Valeur : <megabytes>

Ce paramètre est pris en charge dans l’application de terrain et l’application Web.

Exemple :

max-size=5

Groupes

La table suivante contient les paramètres XLSForm pouvant être utilisés avec le type de question begin group (commencer un groupe). Ces paramètres sont uniquement pris en charge dans l’application de terrain.

Colonne XLSFormParamètreDescription
body::esri:style

backgroundColor

borderColor

Définit les couleurs d’arrière-plan et de bordure pour un groupe ou une page. Pour plus d’informations, reportez-vous à la rubrique Couleurs des groupes, des pages et des répétitions.

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

Exemples :

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

layout

Définit le style de mise en page de la grille pour un groupe.

Valeurs : dynamic-grid | fixed-grid

Exemple :

layout=fixed-grid

Images

La table suivante contient les paramètres XLSForm pouvant être utilisés avec le type de question image. Ces paramètres sont uniquement pris en charge dans l’application de terrain sauf indication contraire dans la description.

Colonne XLSFormParamètreDescription
bind::esri:parametersallowAdds

Désactive l’ajout de nouvelles images lors de la modification d’enregistrements existants.

Valeur : false

Exemple :

allowAdds=false
fileName

Indique le nom de fichier.

Valeurs : <expression>

Ce paramètre est également pris en charge dans l’application Web.

Exemples :

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

Spécifie la taille maximum de fichier en mégaoctets. La taille par défaut est 10 Mo.

Valeur : <megabytes>

Ce paramètre est également pris en charge dans l’application Web.

Exemple :

max-size=5

smartAnnotation

Pour une question de type image avec l’apparence annotate, génère automatiquement les graphiques d’annotation des étiquettes et des emprises autour des objets détectés. Ajoutez ces propriétés pour définir le style et la mise en forme de l’annotation.

Propriété obligatoire : <model_name>

Propriétés facultatives : minScore | cameraPreview | label | class | boundingBoxes | outlineWidth | fontSize | font | bold | italic

Exemples :

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

smartAttributes

Exécute la classification d’images ou la détection d’objets, puis utilise les résultats EXIF dans l’enquête.

Propriété obligatoire : <model_name>

Propriétés facultatives : minScore | cameraPreview | label | class

Exemples :

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

redaction

Générez automatiquement ou ajoutez manuellement les emprises, puis appliquez des effets d’édition à la région cible.

Propriété obligatoire : <model_name> | @faces | @manual

Propriétés facultatives : minScore | cameraPreview | label | class | effect | symbol | fillColor | scale

Exemples :

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

Spécifie la position d’un filigrane d’image. Ajouter des propriétés pour définir le contenu et la mise en forme. Pour plus d’informations, consultez la rubrique Filigranes.

Propriétés : text | color | outlineColor | outlineWidth | haloColor | size | font | bold | italic | margin | image | imageSize

Exemples :

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

Indique si les utilisateurs peuvent mettre à jour manuellement le nom de fichier.

Valeurs : true | false

Exemple :

allowRename=false
fileNameVisible

Indique si le nom de fichier est visible dans l’enquête.

Valeurs : true | false

Exemple :

fileNameVisible=true
footerText

Pour une question image avec l’apparence signature, spécifiez le texte à afficher en bas de la fenêtre contextuelle de signature. Si aucune valeur n’est spécifiée, l’astuce de la question s’affichera en dessous de la signature. Ceci peut être changé en astuce de la question avec footerText=@[hint].

Valeurs : <none> | @[hint]

Exemples :

footerText
footerText=@[hint]
method

Spécifie la méthode de capture pour une question image. La valeur map n’est prise en charge que pour les questions image avec l’apparence annoter.

Ce paramètre est également pris en charge dans l’application Web.

Valeurs : browse | camera | map

Exemples :

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

Pour une question image avec apparence dessin ou annoter, spécifiez une palette d’outils de dessin personnalisée.

Valeur : <palette name>

Exemple :

palette=SiteLayout
previewHeight

Définit la hauteur de l’aperçu de l’image une fois l’image sélectionnée. Utilisez previewHeight=0 si vous souhaitez que l’aperçu de votre image occupe la taille maximale sans espace vierge inutile.

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

Exemples :

previewHeight=3lines
previewHeight=120pixels
parametersmax-pixels

Pour une question image, définissez la taille maximum de l’image sur le bord le plus long, préservant les proportions d’origine.

Pour une question image avec l’apparence signature, spécifiez la largeur maximum de la fenêtre contextuelle de signature.

Pour une question image avec l’apparence dessin, définissez la zone d’affichage sur une image carrée (1:1).

Ce paramètre est également pris en charge dans l’application Web.

Valeur : <pixels>

Exemples :

max-pixels=1500
max-pixels=400

Questions de type carte

La table suivante contient les paramètres XLSForm pouvant être utilisés avec les types de question geopoint (géopoint), geotrace (géotrace) et geoshape (géoforme). Ces paramètres sont uniquement pris en charge dans l’application de terrain sauf indication contraire dans la description.

Colonne XLSFormParamètreDescription
body::esri:styleheight

Définit la hauteur de l’aperçu de la carte.

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

Exemples :

previewHeight=6lines
previewHeight=250pixels

lineColor²

fillColor³

Spécifie les couleurs de ligne et de remplissage pour l’entité linéaire ou surfacique. Ceci s’applique à l’aperçu de la carte dans Survey123 uniquement. Pour plus d’informations, reportez-vous à la rubrique Options de style.

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

Exemple :

lineColor=Black 
fillColor=#9EFFF5
lineWidth²

Spécifie la largeur de ligne en pixels pour l’entité linéaire ou surfacique. Ceci s’applique à l’aperçu de la carte dans Survey123 uniquement.

Valeur : <pixels>

Exemples :

lineWidth=3
map

Définit un fond de carte par défaut.

Ce paramètre est également pris en charge dans l’application Web.

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

Exemples :

map="World Topography"
map=de26a3cf4cc9451298ea173c4b324736

mapTools

Contrôle les outils cartographiques qui sont disponibles pour les questions de type géopoint, géotrace et géoforme.

Ce paramètre n’est pris en charge que dans l’application de terrain.

Valeurs : search | mapSwitcher | zoom | home | locate

Exemples :

mapTools=zoom
mapTools=search,locate

method²

Spécifie la méthode de capture. Si vous utilisez la méthode des sommets, vous pouvez configurer des paramètres supplémentaires.

Ce paramètre est également pris en charge dans l’application Web.

Valeurs : sketch | vertex

Valeurs supplémentaires pour le sommet, applicables uniquement dans l'application de terrain : streaming | beep | haptic | edit

Exemples :

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

Spécifiez le niveau minimal auquel la géométrie peut être capturée.

Ce paramètre n’est pris en charge que dans l’application Web.

Valeur : <integer>

Exemple :

minCaptureZoomLevel=17

overlay

Afficher les emplacements des points à partir de la première question de type géopoint d’une répétition sur tout autre géopoint, géoforme ou géotrace dans votre enquête. Ajouter des propriétés pour définir le contenu et le style.

Valeur : <repeat name>

Propriétés : view | preview | icon | iconColor | iconOutlineColor | iconSize | label | labelColor | labelOutlineColor | fontSize

Exemples :

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

precision

Spécifiez le nombre de décimales qui seront capturées dans la question de type carte et affichées dans le volet des réponses individuelles dans l’enquête. Si ce paramètre n’est pas défini, toutes les décimales disponibles sont capturées dans la question de type carte, mais seules six sont affichées dans le volet des réponses individuelles.

Ce paramètre n’est pris en charge que dans l’application Web.

Valeur : <integer>

Exemple :

precision=4

snapMode

Spécifie le comportement de la capture. Les points peuvent être capturés sur d’autres entités, et les lignes et les polygones peuvent être capturés sur d’autres entités ou sur eux-mêmes. Uniquement disponible si method=vertex.

Ce paramètre n’est pris en charge que dans l’application Web.

Valeurs : feature | self²

Exemple :

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

Spécifie un fichier .png à utiliser comme symbole ponctuel sur la carte. Ajouter des propriétés pour définir la position et l’échelle.

Valeur : <file name>.png

Propriétés : x | y | scale

Exemple :

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

¹Uniquement pris en charge par le type de question geopoint (géopoint).

²Uniquement pris en charge par les types de question geoshape (géoforme) et geotrace (géotrace).

³Uniquement pris en charge par le type de question geoshape (géoforme).

Questions à choix multiples

La table suivante contient les paramètres XLSForm pouvant être utilisés avec les types de question select_one (choix unique), select_multiple (choix multiples) et rank (classement). Ce paramètre est pris en charge dans l’application de terrain et l’application Web.

Colonne XLSFormParamètreDescription
parametersrandomize

Rendre aléatoire l’ordre des choix dans une liste de choix

Valeurs : true

Exemple :

randomize=true

Plage

La table suivante contient les paramètres XLSForm pouvant être utilisés avec le type de question range (plage). Ces paramètres sont pris en charge dans l’application de terrain et l’application Web.

Colonne XLSFormParamètreDescription

body::esri:style

startColor

endColor

color

Spécifie la couleur du curseur au début et à la fin de la plage. Utilisez le paramètre color pour spécifier la couleur utilisée pour remplir l’espace entre la position de départ du curseur et la valeur sélectionnée. Les paramètres doivent être séparés par un espace. Pour plus d’informations, reportez-vous à la rubrique Options de style.

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

Exemples :

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

paramètres

start

end

step

Spécifiez les valeurs de départ, de fin et d’étapes du curseur de plage. Les paramètres doivent être séparés par un espace. Pour plus d’informations, reportez-vous à la rubrique Paramètres de plage.

Valeurs : <integer> | <decimal>

Exemples :

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

Répétitions

La table suivante contient les paramètres XLSForm pouvant être utilisés avec le type de question begin repeat (commencer une répétition). Ces paramètres sont uniquement pris en charge dans l’application de terrain.

Colonne XLSFormParamètreDescription
bind::esri:parametersallowAdds

Permet l’ajout de nouveaux enregistrements de répétition.

Valeurs : true | false

Exemple :

allowAdds=true
allowUpdates

Permet de modifier les enregistrements de répétition existants.

Valeurs : true | false

Exemple :

allowUpdates=false
query

Permet d’afficher dans le formulaire les enregistrements de répétition existants. Spécifie des paramètres de requête supplémentaires pour filtrer les enregistrements disponibles.

Valeurs : <none> | "SQL statement"

Exemples :

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

backgroundColor

borderColor

Définit les couleurs d’arrière-plan et de bordure pour une répétition. Pour plus d’informations, reportez-vous à la rubrique Couleurs des groupes, des pages et des répétitions.

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

Exemples :

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

Texte

La table suivante contient les paramètres XLSForm pouvant être utilisés avec le type de question text (texte). Ces paramètres sont uniquement pris en charge dans l’application de terrain sauf indication contraire dans la description.

Colonne XLSFormParamètreDescription
bind::esri:parametersgeocode

Pour une question texte avec apparence géocode, définissez le localisateur à partir duquel renvoyer les résultats géocodés lorsque l’apparence géocode est utilisée.

Ce paramètre est également pris en charge dans l’application Web.

Valeur : <locator item ID>

Exemple :

geocode=36ff9e8c13e042a58cfce4ad87f55d19

mesure

Pour une question de type texte avec l’apparence télémètre, définissez les mesures à enregistrer dans la question. Mettez la liste des valeurs entre guillemets si certaines valeurs contiennent des espaces.

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

Exemples :

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

Pour une question de type texte avec une apparence multiligne, définissez la hauteur initiale de la zone de texte. La hauteur de la zone de texte augmentera de façon à accueillir le texte de la réponse.

Valeur : <number of lines>

Exemple :

defaultHeight=5
indicator

Pour une question texte avec apparence géocode, autorise les résultats géocodés à indiquer la direction et la distance par rapport à l’emplacement actuel de l’appareil.

Valeurs : direction | distance | none

Exemples :

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

Pour une question texte avec apparence géocode, spécifie le nombre maximum de résultats pouvant être renvoyés. La valeur par défaut est 6.

Valeur : <number of results>

Ce paramètre est également pris en charge dans l’application Web.

Exemple :

maxResults=10
proximity

Pour une question texte avec apparence géocode, spécifie si les résultats géocodés ne montrent que les résultats se trouvant dans un rayon défini par rapport à la position de l’appareil.

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

Exemples :

proximity=3km
proximity=1000ft
suggestions

Pour une question Texte avec apparence Géocode, modifie la manière dont les suggestions s’affichent. La valeur par défaut est yes (oui).

Valeurs : yes | no

Exemple :

suggestions=no

Télémètre

Le tableau suivant contient le paramètre XLSForm pouvant être utilisé avec les types de questions text (texte), decimal (décimal) et integer (entier) pour extraire les valeurs d’un télémètre. Ces paramètres sont uniquement pris en charge dans l’application de terrain sauf indication contraire dans la description.

Colonne XLSFormParamètreDescription
bind::esri:parameters

mesure

Pour une question de type texte avec l’apparence télémètre, définissez les mesures à enregistrer dans la question. Mettez la liste des valeurs entre guillemets si certaines valeurs contiennent des espaces.

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

Exemples :

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