トップへ戻る

パラメーター

このトピックの内容

  1. 一般
  2. オーディオ
  3. バーコード
  4. ファイル
  5. グループ
  6. 画像
  7. マップの質問
  8. 複数の選択肢の質問
  9. 範囲
  10. 繰り返し
  11. テキスト
  12. 距離計

XLSForm の一部の質問タイプには、調査内の質問のスタイルや動作をコントロールできる追加のパラメーターが用意されています。 場合によっては、これらのパラメーターが、質問タイプがサポートする表示設定を補完します。 すべてのパラメーターがすべての送信アプリ (Survey123 Mobile、Survey123 のフィールド アプリ、Survey123 の Web アプリ) でサポートされているとは限りません。 アプリのサポートの詳細については、以下のパラメーター テーブルをご参照ください。これは、質問タイプ、および各パラメーターを受け付ける調査ワークシートの XLSForm 列ごとに整理されています。

質問のパラメーターをスペースで区切ることで、同じ列に複数のパラメーターを追加できます。 たとえば、[range] の質問は、以下のとおり、body::esri:style 列に startColor、endColor、color のパラメーターを指定できます。

startColor=Orange endColor=White color=#FF6347

一般

このセクションでは、複数の質問タイプに対し bind::esri:parameters と body::esri:style の XLSForm 列で使用できるパラメーターについて説明します。

以下の表では、[text]、[integer]、[decimal]、[note]、[date]、[time]、[dateTime]、[select_one]、[select_multiple]、[geopoint]、[calculate]、[hidden] の質問タイプに対して bind::esri:parameters の XLSForm 列で使用できるパラメーターについて説明しています。

bind::esri:parameters

パラメーター説明送信アプリ
calculationMode

質問内の計算がいつ計算されるかをコントロールします。

値: auto | manual | always | whenEmpty

例:

calculationMode=manual
calculationMode=always

Web アプリ

フィールド アプリ

以下の表では、[text]、[integer]、[decimal]、[select_one] (autocomplete の表示設定を使用)、[select_multiple] (autocomplete の表示設定を使用)*、[barcode] の質問タイプに対して body::esri:style の XLSForm 列で使用できるパラメーターについて説明しています。

body::esri:style

パラメーター説明送信アプリ
placeholderText

質問が空の場合、質問の入力エリアに表示されるテキストを指定します。

値: @[hint] | @[guidance_hint]

例:

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

Survey123 Mobile

フィールド アプリ

* Survey123 Mobile でのみサポートされています。

オーディオ

以下の表では、[audio] の質問タイプに対して bind::esri:parameters の XLSForm 列で使用できるパラメーターについて説明しています。

bind::esri:parameters

パラメーター説明送信アプリ
codec

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

値: <codec name>

例:

codec=amr-nb,aac

Survey123 Mobile

フィールド アプリ

fileName

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

値: <expression>

例:

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

Web アプリ

max-duration

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

値: <seconds>

例:

max-duration=45

Survey123 Mobile

Web アプリ

フィールド アプリ

max-size

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

値: <megabytes>

例:

max-size=5

Survey123 Mobile

フィールド アプリ

バーコード

以下の表では、[barcode] の質問タイプに対して body::esri:style の XLSForm 列で使用できるパラメーターについて説明しています。

body::esri:style

パラメーター説明送信アプリ

barcodeType

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

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

  • all - サポート対象の全タイプ (code39 と pdf417 は対象外)
  • 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] の質問タイプに対して bind::esri:parameters の XLSForm 列で使用できるパラメーターについて説明しています。

bind::esri:parameters

パラメーター説明送信アプリ
fileName

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

値: <expression>

例:

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

Web アプリ

max-size

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

値: <megabytes>

例:

max-size=5

Web アプリ

グループ

以下の表では、[begin group] の質問タイプに対して body::esri:style の XLSForm 列で使用できるパラメーターについて説明しています。

body::esri:style

パラメーター説明送信アプリ

backgroundColor

borderColor

グループまたはページの背景色と枠線色を設定します。 詳細については、「グループ、ページ、繰り返しの色」をご参照ください。

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

例:

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

Survey123 Mobile

フィールド アプリ

layout

グループのグリッド レイアウト スタイルを設定します。

値: dynamic-grid | fixed-grid

例:

layout=fixed-grid

フィールド アプリ

画像

このセクションでは、[image] 質問タイプに対し指定された XLSForm 列で使用できるパラメーターについて説明します。

以下の表では、bind::esri:parameters の XLSForm 列で使用できるパラメーターについて説明しています。

bind::esri:parameters

パラメーター説明送信アプリ
allowAdds

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

値: false

例:

allowAdds=false

フィールド アプリ

fileName

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

値: <expression>

例:

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

Web アプリ

フィールド アプリ

max-size

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

値: <megabytes>

例:

max-size=5

Web アプリ

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"

フィールド アプリ

以下の表では、[image] の質問タイプに対して body::esri:style の XLSForm 列で使用できるパラメーターについて説明しています。

body::esri:style

パラメーター説明送信アプリ
allowRename

ユーザーがファイル名を手動で編集できるかどうかを指定します。

値: true | false

例:

allowRename=false

フィールド アプリ

fileNameVisible

ファイルの名前を調査で表示するかどうかを指定します。

値: true | false

例:

fileNameVisible=true

フィールド アプリ

footerText

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

値: <none> | @[hint]

例:

footerText
footerText=@[hint]

Survey123 Mobile

フィールド アプリ

method

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

値: browse | camera | map

例:

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

Web アプリ

フィールド アプリ

palette

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

値: <palette name>

例:

palette=SiteLayout

フィールド アプリ

previewHeight

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

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

例:

previewHeight=3lines
previewHeight=120pixels

フィールド アプリ

以下の表では、[image] の質問タイプに対して parameters の XLSForm 列で使用できるパラメーターについて説明しています。

parameters

パラメーター説明送信アプリ
max-pixels

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

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

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

値: <pixels>

例:

max-pixels=1500
max-pixels=400

Web アプリ

フィールド アプリ

マップの質問

以下の表は、[geopoint]、[geotrace]、および [geoshape] の質問タイプについて指定された XLSForm で使用できるパラメーターについて説明しています。

以下の表では、bind::esri:parameters の XLSForm 列で使用できるパラメーターについて説明しています。

bind::esri:parameters

パラメーター説明送信アプリ

geocode

ジオコーディングされた結果を返すためのロケーターを設定します。

値: <locator item ID>

例:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

Web アプリ

フィールド アプリ

以下の表は、[geopoint]、[geotrace]、および [geoshape] の質問タイプについて指定された body::esri:style の XLSForm で使用できるパラメーターについて説明しています。

body::esri:style

パラメーター説明送信アプリ
height

マップ プレビューの高さを設定します。

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

例:

previewHeight=6lines
previewHeight=250pixels

フィールド アプリ

lineColor2

fillColor3

ラインまたはポリゴン フィーチャのラインまたは塗りつぶしの色を指定します。 これは、Survey123 のマップ プレビューにのみ適用されます。 詳細については、「ジオメトリー シンボル」をご参照ください。

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

例:

lineColor=Black 
fillColor=#9EFFF5

Survey123 Mobile

フィールド アプリ

lineWidth2

ラインまたはポリゴン フィーチャのライン幅をピクセルで指定します。 これは、Survey123 のマップ プレビューにのみ適用されます。

値: <pixels>

例:

lineWidth=3

Survey123 Mobile

フィールド アプリ

map

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

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

例:

map="World Topography"
map=de26a3cf4cc9451298ea173c4b324736

Web アプリ

フィールド アプリ

mapTools

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

値: search | mapSwitcher | zoom | home | locate

例:

mapTools=zoom
mapTools=search,locate

フィールド アプリ

method2

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

値: sketch | vertex

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

例:

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

Web アプリ

フィールド アプリ

minCaptureZoomLevel

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

値: <integer>

例:

minCaptureZoomLevel=17

Web アプリ

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 桁までしか表示されません。

値: <integer>

例:

precision=4

Web アプリ

snapMode

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

値: feature | self2

例:

snapMode=feature
snapMode=self
snapMode=self,feature

Web アプリ

symbol1

マップのポイント マーカーとして使用する .png ファイルを指定します。 位置と縮尺を定義するプロパティを追加します。

値: <file name>.png

プロパティ: x | y | scale

例:

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

フィールド アプリ

1 - [geopoint] の質問タイプでのみサポートされます。

2 - [geoshape] および [geotrace] の質問タイプでのみサポートされます。

3 - [geoshape] の質問タイプでのみサポートされます。

複数の選択肢の質問

以下の表は、[select_one]、[select_multiple]、および [rank] の質問タイプに対し parameters の XLSForm 列で使用できるパラメーターについて説明しています。

parameters

パラメーター説明送信アプリ
randomize

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

値: true

例:

randomize=true

Web アプリ

フィールド アプリ

範囲

このセクションでは、[range] 質問タイプに対し指定された XLSForm 列で使用できるパラメーターについて説明します。 パラメーターを結合する場合は、スペースで区切る必要があります。

以下の表では、body::esri:style の XLSForm 列で使用できるパラメーターについて説明しています。 詳細については、「スタイル オプション」をご参照ください。

body::esri:style

パラメーター説明送信アプリ

startColor

endColor

color

以下の範囲スライダーの色を指定します。

  • 範囲の開始位置のスライダーの色。
  • 範囲の終了位置のスライダーの色。
  • スライダーの開始位置と選択した値の間のスペースを塗りつぶす色。

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

例:

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

Survey123 Mobile

Web アプリ

フィールド アプリ

以下の表では、[range] の質問タイプに対して parameters の XLSForm 列で使用できるパラメーターについて説明しています。 詳細については、「範囲スライダーのパラメーター」をご参照ください。

parameters

パラメーター説明送信アプリ

start

end

step

範囲スライダーの開始、終了、ステップの値を指定します。

値: <integer> | <decimal>

例:

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

Survey123 Mobile

Web アプリ

フィールド アプリ

繰り返し

このセクションでは、[begin repeat] 質問タイプに対し指定された XLSForm 列で使用できるパラメーターについて説明します。

以下の表では、bind::esri:parameters の XLSForm 列で使用できるパラメーターについて説明しています。

bind::esri:parameters

パラメーター説明送信アプリ
allowAdds

新しい繰り返しレコードの追加を許可します。

値: true | false

例:

allowAdds=true

フィールド アプリ

allowUpdates

既存の繰り返しレコードの修正を許可します。

値: true | false

例:

allowUpdates=false

フィールド アプリ

query

既存の繰り返しレコードのフォームへの表示を許可します。 使用できるレコードをフィルタリングするための追加のクエリー パラメーターを指定します。

値: <none> | "SQL statement"

例:

query
query="severity='high'"

フィールド アプリ

以下の表では、[begin repeat] の質問タイプに対して body::esri:style の XLSForm 列で使用できるパラメーターについて説明しています。

body::esri:style

パラメーター説明送信アプリ

backgroundColor

borderColor

繰り返しの背景色と枠線色を設定します。 詳細については、「グループ、ページ、繰り返しの色」をご参照ください。

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

例:

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

Survey123 Mobile

フィールド アプリ

addRecordMode

表示設定がテーブル形式の繰り返しについて、テーブル ビューの [レコードの追加] ボタンと [新しいレコードにコピー] オプションのモードを指定します。 デフォルトは row です。 値が row の場合、新しいレコードがテーブル ビューに追加されます。 値が form の場合、新しいレコードがフォーム ビューで開きます。

値: row | form

例:

addRecordMode=form

Survey123 Mobile

editInFormView

表示設定がテーブル形式の繰り返しについて、テーブル ビューの [フォーム ビューで編集] オプションを表示するか、非表示にします。 デフォルトは true です。

注意:

繰り返しにエラーがある場合は、editInFormView パラメーターが false に設定されていても、[フォーム ビューで編集] オプションが有効になります。

値: true | false

例:

editInFormView=false

Survey123 Mobile

copyToNewRecord

表示設定がテーブル形式の繰り返しについて、テーブル ビューの [新しいレコードにコピー] オプションを表示するか、非表示にします。 このオプションを使用すると、ユーザーが繰り返し内でレコードを複製できます。 デフォルトは true です。 addRecordMode パラメーターにより、複製レコードがどのように追加されるかが決まります。

値: true | false

例:

copyToNewRecord=true

Survey123 Mobile

editInTabularView

表示設定がテーブル形式の繰り返しについて、テーブル ビュー内での編集を有効化または無効化します。 デフォルトは true です。 この値が false の場合、テーブル ビュー内のすべてのセルが読み取り専用となります。

値: true | false

例:

editInTabularView=false

Survey123 Mobile

以下の表では、テーブル形式の繰り返し内の質問対して body::esri:style の XLSForm 列で使用できるパラメーターについて説明しています。

body::esri:style

パラメーター説明送信アプリ

showInTabularView

表示設定がテーブル形式の繰り返しについて、テーブル ビューの列として質問を表示します。 デフォルトは false です。

値: true | false

例:

showInTabularView=true

Survey123 Mobile

テキスト

このセクションでは、[text] 質問タイプに対し指定された XLSForm 列で使用できるパラメーターについて説明します。

以下の表では、bind::esri:parameters の XLSForm 列で使用できるパラメーターについて説明しています。

bind::esri:parameters

パラメーター説明送信アプリ
geocode

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

値: <locator item ID>

例:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

Web アプリ

フィールド アプリ

以下の表では、[text] の質問タイプに対して body::esri:style の XLSForm 列で使用できるパラメーターについて説明しています。

body::esri:style

パラメーター説明送信アプリ
defaultHeight

複数行の表示設定があるテキストの質問の場合、テキスト ボックスの初期の高さを設定します。 テキスト ボックスの高さは、回答テキストが収まるように高くなります。

値: <number of lines>

例:

defaultHeight=5

フィールド アプリ

indicator

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

値: direction | distance | none

例:

indicator=none
indicator=direction
indicator=direction,distance

フィールド アプリ

maxResults

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

値: <number of results>

例:

maxResults=10

Web アプリ

フィールド アプリ

近接

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

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

例:

proximity=3km
proximity=1000ft

フィールド アプリ

suggestions

ジオコードの表示設定が指定されたテキストの質問に対し、候補が設定される方法を変更します。 デフォルトは「はい」です。

値: yes | no

例:

suggestions=no

フィールド アプリ

距離計

以下の表は、[text]、[integer]、[decimal] の質問タイプで使用して rangefinder から値を取得できる bind::esri:parameters の XLSForm 列で使用できるパラメーターについて説明しています。

bind::esri:parameters

パラメーター説明送信アプリ

measurement

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

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

例:

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

フィールド アプリ

このトピックへのフィードバック

このトピックの内容
  1. 一般
  2. オーディオ
  3. バーコード
  4. ファイル
  5. グループ
  6. 画像
  7. マップの質問
  8. 複数の選択肢の質問
  9. 範囲
  10. 繰り返し
  11. テキスト
  12. 距離計