DataCropCollectionFeatureOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
| algorithm | 地形アルゴリズムの名称 |
| algorithm |
地形アルゴリズムのパラメータ |
| asset |
バンドとしての資産 |
| asset |
資産バンドごとのインデックス(コマ区切りインデックス、例:「image|1,2,3」は「image」と名付けられた資産のバンド1、2、3を使うことを意味します) |
| assets | アセットの名前。 |
| bbox | バウンディングボックス(西、南、東、北)。 |
| bidx | データセットバンドインデックス |
| collection | STAC コレクション ID |
| color |
リオカラーフォーミュラ(情報: https://github.com/mapbox/rio-color) |
| color |
JSONでエンコードされたカスタムカラーマップ |
| color |
カラーマップ名 |
| coordinate |
入力座標の座標基準系。 既定値は |
| crs | 座標基準系。 |
| datetime | 日付/時間または間隔 (オープンまたはクローズ)。 日付と時刻の式は RFC 3339 に準拠しています。 オープンインターバルはダブルドットで表されます。 例:
フィーチャに複数の時間プロパティがある場合、範囲を決定するために 1 つの時間プロパティのみを使用するか、関連するすべての時間プロパティを決定するかは、サーバーの決定に委ねられます。 |
| destination |
出力座標基準系。 |
| exit |
ジオメトリが完全にカバーされたらすぐに戻ります(デフォルトはTrue)。 |
| expression | アセット間のバンド数式 |
| format | 出力画像フォーマット。 |
| height | 出力画像の高さ(ピクセル単位) |
| ids | アイテムIDの配列。 |
| items |
ジオメトリごとにN個のアイテムが揃ったらすぐに戻ります(デフォルトは100です)。 |
| max |
幅と高さの制限が設定されていない場合の画像出力サイズ制限。 |
| no |
内部の Nodata 値を上書きする |
| pixel |
ピクセル選択法。 |
| query | アイテムのフィルタリング用JSONクエリ表現。 |
| reproject | WarpKernelリサンプリングアルゴリズム(再投影時のみ使用)。 既定値は |
| resampling | リサンプリング方法。 |
| rescale | カンマ (',') 区切り 最小,最大範囲。 複数のバンドに複数の時間を設定できます。 |
| return |
出力データにマスクを追加します。 |
| scan |
N個のアイテムをスキャンしたらすぐに返却してください(デフォルトは10000です)。 |
| sel | 次元名を使ったXarrayインデックス作成 |
| sel |
不正確なマッチに使うXarrayインデックス方法。 |
| skip |
前の項目の下に表示されるものは完全にスキップしてください(デフォルトはTrueに設定)。 |
| sortby | ソート式(例:+/-プロパティ)。 |
| subdataset |
資産内のサブデータセットバンドのインデックス。 |
| subdataset |
資産内のサブデータセットの名前です。 |
| time |
長いリクエストを避けるためにN秒後に戻ります(デフォルトは5)。 |
| unscale | 内部スケールまたはオフセットを適用 |
| width | 出力画像の幅(ピクセル単位)について |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
algorithm
地形アルゴリズムの名称
algorithm?: string
プロパティ値
string
algorithmParams
地形アルゴリズムのパラメータ
algorithmParams?: string
プロパティ値
string
assetAsBand
バンドとしての資産
assetAsBand?: boolean
プロパティ値
boolean
assetBandIndices
資産バンドごとのインデックス(コマ区切りインデックス、例:「image|1,2,3」は「image」と名付けられた資産のバンド1、2、3を使うことを意味します)
assetBandIndices?: string[]
プロパティ値
string[]
assets
アセットの名前。
assets?: string[]
プロパティ値
string[]
bbox
バウンディングボックス(西、南、東、北)。
bbox?: string
プロパティ値
string
bidx
データセットバンドインデックス
bidx?: number[]
プロパティ値
number[]
collection
STAC コレクション ID
collection?: string
プロパティ値
string
colorFormula
colorMap
JSONでエンコードされたカスタムカラーマップ
colorMap?: string
プロパティ値
string
colorMapName
カラーマップ名
colorMapName?: string
プロパティ値
string
coordinateReferenceSystem
入力座標の座標基準系。 既定値は epsg:4326 です。
coordinateReferenceSystem?: string
プロパティ値
string
crs
座標基準系。
crs?: string
プロパティ値
string
datetime
日付/時間または間隔 (オープンまたはクローズ)。 日付と時刻の式は RFC 3339 に準拠しています。 オープンインターバルはダブルドットで表されます。
例:
- 日時: "2018-02-12T23:20:50Z"
- クローズドインターバル: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
- オープンインターバル: "2018-02-12T00:00:00Z/.." または "../2018-03-18T12:31:12Z"
datetime の値と交差する時間プロパティを持つフィーチャのみが選択されます。
フィーチャに複数の時間プロパティがある場合、範囲を決定するために 1 つの時間プロパティのみを使用するか、関連するすべての時間プロパティを決定するかは、サーバーの決定に委ねられます。
datetime?: string
プロパティ値
string
destinationCrs
出力座標基準系。
destinationCrs?: string
プロパティ値
string
exitWhenFull
ジオメトリが完全にカバーされたらすぐに戻ります(デフォルトはTrue)。
exitWhenFull?: boolean
プロパティ値
boolean
expression
アセット間のバンド数式
expression?: string
プロパティ値
string
format
出力画像フォーマット。
format?: string
プロパティ値
string
height
出力画像の高さ(ピクセル単位)
height?: number
プロパティ値
number
ids
アイテムIDの配列。
ids?: string
プロパティ値
string
itemsLimit
ジオメトリごとにN個のアイテムが揃ったらすぐに戻ります(デフォルトは100です)。
itemsLimit?: number
プロパティ値
number
maxSize
幅と高さの制限が設定されていない場合の画像出力サイズ制限。
maxSize?: number
プロパティ値
number
noData
内部の Nodata 値を上書きする
noData?: string
プロパティ値
string
pixelSelection
ピクセル選択法。
pixelSelection?: string
プロパティ値
string
query
アイテムのフィルタリング用JSONクエリ表現。
query?: string
プロパティ値
string
reproject
WarpKernelリサンプリングアルゴリズム(再投影時のみ使用)。 既定値は nearest です。
reproject?: string
プロパティ値
string
resampling
リサンプリング方法。
resampling?: string
プロパティ値
string
rescale
カンマ (',') 区切り 最小,最大範囲。 複数のバンドに複数の時間を設定できます。
rescale?: string[]
プロパティ値
string[]
returnMask
出力データにマスクを追加します。
returnMask?: boolean
プロパティ値
boolean
scanLimit
N個のアイテムをスキャンしたらすぐに返却してください(デフォルトは10000です)。
scanLimit?: number
プロパティ値
number
sel
次元名を使ったXarrayインデックス作成 {dimension}={value}。
sel?: string[]
プロパティ値
string[]
selMethod
不正確なマッチに使うXarrayインデックス方法。
selMethod?: string
プロパティ値
string
skipCovered
前の項目の下に表示されるものは完全にスキップしてください(デフォルトはTrueに設定)。
skipCovered?: boolean
プロパティ値
boolean
sortby
ソート式(例:+/-プロパティ)。
sortby?: string
プロパティ値
string
subdatasetBands
資産内のサブデータセットバンドのインデックス。
subdatasetBands?: number[]
プロパティ値
number[]
subdatasetName
資産内のサブデータセットの名前です。
subdatasetName?: string
プロパティ値
string
timeLimit
長いリクエストを避けるためにN秒後に戻ります(デフォルトは5)。
timeLimit?: number
プロパティ値
number
unscale
内部スケールまたはオフセットを適用
unscale?: boolean
プロパティ値
boolean
width
出力画像の幅(ピクセル単位)について
width?: number
プロパティ値
number
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLike
プロパティ値
OperationOptions.abortSignal から継承された
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallback
プロパティ値
OperationOptions.onResponse から継承された
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptions
プロパティ値
OperationOptions.requestOptions から継承された
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptions
プロパティ値
OperationOptions.tracingOptions から継承された