XLSForm パラメーター

XLSForm の一部の質問タイプには、調査内の質問のスタイルや振舞いをコントロールできる追加のパラメーターが用意されています。 場合によっては、これらのパラメーターが、質問タイプがサポートする表示設定を補完します。 次の表は、XLSForm で使用できるパラメーターおよび各パラメーターを使用できる survey ワークシートの列の概要を示します。 すべてのパラメーターが、ArcGIS Survey123 フィールド アプリと Web アプリの両方でサポートされているとは限りません。 フィールド アプリと Web アプリのサポートの詳細については、各パラメーターのドキュメント トピックをご参照ください。

質問のパラメーターをスペースで区切ることで、同じ列に複数のパラメーターを追加できます。 たとえば、[geoshape] の質問では、[body::esri:style] 列に、次のように mapmethodlineColorfillColor パラメーターを指定できます。

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 (オートコンプリートの表示設定) | barcode

値: @[hint] | @[guidance_hint]

例:

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

オーディオ

次の表は、[audio] の質問タイプで使用できる XLSForm パラメーターを示します。 これらのパラメーターは、説明で特に指示のない限り、フィールド アプリでのみサポートされます。

XLSForm の列パラメーター説明
bind::esri:parameterscodec

オーディオを記録する優先コーデックを指定します。 複数のコーデックは、カンマで区切って指定できます。 デバイスと互換性がある最初のコーデックが使用されます。

値: <codec name>

例:

codec=amr-nb,aac
fileName

ファイル名を指定します。

値: <expression>

このパラメーターは、Web アプリでのみサポートされます。

例:

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

オーディオを記録する最大期間を秒で指定します。 Web アプリのデフォルト期間は 600 (10 分) です。

値: <seconds>

例:

max-duration=45
max-size

オーディオを記録する最大ファイル サイズをメガバイトで指定します。 フィールド アプリのデフォルト サイズは 10 MB です。

値: <megabytes>

例:

max-size=5

バーコード

次の表は、[barcode] の質問タイプで使用できる XLSForm パラメーターを示します。 これらのパラメーターは、フィールド アプリでのみサポートされます。

XLSForm の列パラメーター説明
body::esri:style

barcodeType

ユーザーがスキャンできるバーコードのタイプを指定します。 カンマで区切って複数のタイプを指定できます。 barcodeType パラメーターを指定しなかった場合、azteccode39datamatrixmaxicodepdf417 を除く全サポート対象バーコード タイプをスキャンできます。

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

  • all - サポート対象の全タイプ (code39pdf417 は対象外)
  • 1d - 1 次元の全タイプ (code39 は対象外)
  • 2d - 2 次元の全タイプ (pdf417 は対象外)

1 次元タイプ: codabar | code128 | code39 | code93 | ean13 | ean8 | itf | upca | upce | upceanextension

2 次元タイプ: aztec | datamatrix | maxicode | pdf417 | qrcode | rss14 | rssexpanded

例:

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

ファイル

次の表は、[file] の質問タイプで使用できる XLSForm パラメーターを示します。

XLSForm の列パラメーター説明
bind::esri:parametersfileName

ファイル名を指定します。

値: <expression>

このパラメーターは、Web アプリでのみサポートされます。

例:

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

最大ファイル サイズをメガバイトで指定します。 デフォルトは 10 MB です。

値: <megabytes>

このパラメーターは、フィールド アプリと Web アプリでサポートされます。

例:

max-size=5

グループ

次の表は、[begin group] の質問タイプで使用できる XLSForm パラメーターを示します。 これらのパラメーターは、フィールド アプリでのみサポートされます。

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

画像

次の表は、[image] の質問タイプで使用できる XLSForm パラメーターを示します。 これらのパラメーターは、説明で特に指示のない限り、フィールド アプリでのみサポートされます。

XLSForm の列パラメーター説明
bind::esri:parametersallowAdds

既存のレコードを編集する際の新しい画像の追加を無効にします。

値: false

例:

allowAdds=false
fileName

ファイル名を指定します。

値: <expression>

このパラメーターは、Web アプリでもサポートされます。

例:

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

最大ファイル サイズをメガバイトで指定します。 デフォルトは 10 MB です。

値: <megabytes>

このパラメーターは、Web アプリでもサポートされます。

例:

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

署名の表示設定が指定された画像の質問に対し、署名のポップアップ下部に表示するテキストを指定します。 値が指定されないと、署名の下に質問のガイダンス ヒントが表示されます。 これは、footerText=@[hint] を使用して質問のヒントに変更できます。

値: <none> | @[hint]

例:

footerText
footerText=@[hint]
method

画像の質問の取得方法を指定します。 値 map は、アノテーションの表示設定が指定された画像の質問でのみサポートされます。

このパラメーターは、Web アプリでもサポートされます。

値: browse | camera | map

例:

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

描画またはアノテーションの表示設定が指定された画像の質問に、カスタム描画ツール パレットを指定します。

値: <palette name>

例:

palette=SiteLayout
previewHeight

画像が選択された後の画像プレビューの高さを設定します。 画像プレビューを不要な空白なしで最大にするには previewHeight=0 を使用します。

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

例:

previewHeight=3lines
previewHeight=120pixels
parametersmax-pixels

画像の質問に対し、元の縦横比を維持したまま、画像の長辺の最大サイズを設定します。

署名の表示設定が指定された画像の質問に対し、署名のポップアップの最大幅を設定します。

描画の表示設定が指定された画像の質問に対し、キャンバスを正方形 (1:1) の画像に設定します。

このパラメーターは、Web アプリでもサポートされます。

値: <pixels>

例:

max-pixels=1500
max-pixels=400

マップの質問

次の表は、[geopoint][geotrace]、および [geoshape] の質問タイプで使用できる 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

デフォルト ベースマップを設定します。

このパラメーターは、Web アプリでもサポートされます。

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

例:

map="World Topography"
map=de26a3cf4cc9451298ea173c4b324736

mapTools

ジオポイント、ジオトレース、ジオシェープの各質問で利用できるマップ ツールを制御します。

このパラメーターはフィールド アプリでのみサポートされています。

値: search | mapSwitcher | zoom | home | locate

例:

mapTools=zoom
mapTools=search,locate

method²

取得方法を指定します。 頂点方法を使用している場合、追加パラメーターを設定できます。

このパラメーターは、Web アプリでもサポートされます。

値: sketch | vertex

頂点の追加の値、フィールド アプリにのみ適用: streaming | beep | haptic | edit

例:

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

ジオメトリを取得できる最小レベルを指定します。

このパラメーターは、Web アプリでのみサポートされます。

値: <integer>

例:

minCaptureZoomLevel=17

overlay

調査の他のジオポイント、ジオシェープ、またはジオトレースの質問の繰り返し内で最初のジオポイントの質問からのポイントの位置を表示します。 内容とスタイルを定義するプロパティを追加します。

値: <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

調査のマップ質問で取得され、個々の回答パネルに表示される小数点以下桁数を指定します。 このパラメーターを設定しなかった場合、マップ質問で利用可能なすべての小数点以下桁数が取得されますが、個々の回答パネルには小数点以下 6 桁までしか表示されません。

このパラメーターは、Web アプリでのみサポートされます。

値: <integer>

例:

precision=4

snapMode

スナップの振舞いを指定します。 ポイントを他のフィーチャにスナップさせたり、ラインやポリゴンを他のフィーチャまたはそれ自体にスナップさせたりすることができます。 method=vertex の場合にのみ使用できます。

このパラメーターは、Web アプリでのみサポートされます。

値: 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] の質問タイプでのみサポートされます。

複数の選択肢の質問

次の表は、[select_one][select_multiple]、および [rank] の質問タイプで使用できる XLSForm パラメーターを示します。 このパラメーターは、フィールド アプリと Web アプリでサポートされます。

XLSForm の列パラメーター説明
parametersrandomize

選択リストの選択肢の順序をランダムにします。

値: true

例:

randomize=true

範囲

次の表は、[range] の質問タイプで使用できる XLSForm パラメーターを示します。 これらのパラメーターは、フィールド アプリと Web アプリでサポートされます。

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

繰り返し

次の表は、[begin repeat] の質問タイプで使用できる 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

テキスト

次の表は、[text] の質問タイプで使用できる XLSForm パラメーターを示します。 これらのパラメーターは、説明で特に指示のない限り、フィールド アプリでのみサポートされます。

XLSForm の列パラメーター説明
bind::esri:parametersgeocode

ジオコードの表示設定が指定されたテキストの質問に対し、ジオコードの表示設定を使用時にジオコーディングされた結果を返すためのロケーターを設定します。

このパラメーターは、Web アプリでもサポートされます。

値: <locator item ID>

例:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

計測

表示設定が距離計のテキスト質問の場合、質問に格納する計測値を設定します。 値にスペースが含まれている場合は値のリストを引用符で囲みます。

値: 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

ジオコードの表示設定が指定されたテキストの質問に対し、ジオコーディングされた結果に、デバイスの現在位置からの方向と距離を表示するよう設定します。

値: direction | distance | none

例:

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

ジオコードの表示設定が指定されたテキストの質問に対し、返される結果の最大数を指定します。 デフォルトは 6 です。

値: <number of results>

このパラメーターは、Web アプリでもサポートされます。

例:

maxResults=10
proximity

ジオコードの表示設定が指定されたテキストの質問で、ジオコーディングされた結果に、デバイスの位置から特定の半径内の結果のみを表示するかどうかを指定します。

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

例:

proximity=3km
proximity=1000ft
suggestions

ジオコードの表示設定が指定されたテキストの質問に対し、ユーザーの検索入力時に表示される候補を無効にします。

値: no

例:

suggestions=no

距離計

次の表は、[text][decimal][integer] の質問タイプで使用して距離計から値を取得できる XLSForm パラメーターをまとめたものです。 これらのパラメーターは、説明で特に指示のない限り、フィールド アプリでのみサポートされます。

XLSForm の列パラメーター説明
bind::esri:parameters

計測

表示設定が距離計のテキスト質問の場合、質問に格納する計測値を設定します。 値にスペースが含まれている場合は値のリストを引用符で囲みます。

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

例:

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