アダプティブ式の事前構築済みの関数

[アーティクル]
12/26/2023

この記事の対象: SDK v4

この記事では、使用可能な構築済みの関数を汎用別に一覧で示します。事前構築済みの関数と式の構文で使用される演算子については、「演算子」を参照してください。

事前構築済みの式は、次の関数の型に分かれます。

String
コレクション
論理比較
Conversion
計算
日付
Timex
URI 解析
オブジェクトの操作と構築
正規表現
型チェック

また、一覧をアルファベット順で表示することもできます。

文字列関数

機能	説明
length	文字列の長さを返します。
replace	部分文字列を指定した文字列で置換し、更新された文字列を返します。この関数は、大文字小文字を区別します。
replaceIgnoreCase	部分文字列を指定した文字列で置換し、更新された文字列を返します。この関数では、大文字と小文字が区別されません。
split	指定した区切り記号に基づいて部分文字列を含む配列を返します。
substring	文字列から文字を返します。
toLower	省略可能なロケール形式で小文字の文字列を返します。
toUpper	省略可能なロケール形式で大文字の文字列を返します。
trim	文字列から先頭と末尾の空白を削除します。
addOrdinal	入力番号の序数を返します。
endsWith	文字列が特定の部分文字列で終わっているかどうかを調べます。部分文字列が見つかった場合は `true` を返し、見つからない場合は `false` を返します。この関数では、大文字と小文字が区別されません。
startsWith	文字列が特定の部分文字列で始まっているかどうかを調べます。部分文字列が見つかった場合は `true` を返し、見つからない場合は `false` を返します。この関数では、大文字と小文字が区別されません。
countWord	指定した文字列の単語数を返します。
concat	2 つ以上の文字列を結合し、結果の文字列を返します。
newGuid	新しい Guid 文字列を返します。
indexOf	部分文字列の開始位置またはインデックス値を返します。または、指定したオブジェクトを検索し、一覧全体の中で部分文字列が最初に出現した箇所の 0 から始まるインデックスを返します。この関数は、大文字と小文字を区別せず、インデックスは値 0 から始まります。
lastIndexOf	部分文字列の開始位置または最後の出現箇所のインデックス値を返します。または、指定したオブジェクトを検索し、一覧の要素の範囲内で部分文字列が最後に出現した箇所の 0 から始まるインデックスを返します。この関数は、大文字と小文字を区別せず、インデックスは値 0 から始まります。
sentenceCase	文字列内の最初の単語の最初の文字を省略可能なローカル形式で大文字にします。
titleCase	省略可能なロケール形式で文字列内の各単語の最初の文字を大文字にします。
reverse	文字列または配列内の要素の順序を反転させます。

コレクション関数

機能	説明
contains	文字列内で項目を検索したり、配列内で項目を検索したり、複合オブジェクトでパラメーターを検索したりするために動作します。例: contains('hello world', 'hello') contains(createArray('1','2'), '1') contains(json("{'foo':'bar'}"), 'foo')
first	コレクションから最初の項目を返します。
join	配列のすべての項目を含み、各文字が "区切り記号" で区切られた文字列を返します。例: join(createArray('a','b'), '.') = "a.b"
last	コレクションから最後の項目を返します。
count	コレクション内の項目数を返します。
foreach	各要素を演算し、新しいコレクションを返します。
union	指定した複数のコレクションの "すべての" 項目を含む 1 つのコレクションを返します。
skip	コレクションの先頭から項目を削除し、残りの項目を返します。
take	コレクションの先頭から項目を返します。
intersection	指定したコレクションすべてに共通する項目 "のみ" を含むコレクションを返します。
subArray	指定した開始位置と終了位置から部分配列を返します。インデックス値は 0 から始まります。
選択	各要素を演算し、変換された要素の新しいコレクションを返します。
where	各要素をフィルター処理し、特定の条件に一致する、フィルター処理された要素の新しいコレクションを返します。
sortBy	コレクション内の要素を昇順に並べ替え、並べ替えられたコレクションを返します。
sortByDescending	コレクション内の要素を降順に並べ替え、並べ替えられたコレクションを返します。
indicesAndValues	配列またはオブジェクトを、インデックスと値のプロパティを含むオブジェクトの配列に変換します。
flatten	非配列値を含む配列に、配列をフラット化します。
unique	配列からすべての重複を削除します。
任意	シーケンスのいずれかの要素が条件を満たしているかどうかを調べます。
all	シーケンス内のすべての要素が条件を満たしているかどうかを調べます。
reverse	文字列または配列内の要素の順序を反転させます。
merge	配列内の複数の JSON オブジェクトまたは項目を結合します。

論理比較関数

機能	説明
、	論理 AND。指定したすべての式が true と評価された場合は true を返します。
equals	等価の比較。指定した値が等しい場合は true を返します。
空	ターゲットが空であるかどうかを調べます。
greater	超過の比較。 1 番目の値の方が大きい場合は `true` を返し、小さい場合は `false` を返します。
greaterOrEquals	超過または等価の比較。 1 番目の値の方が大きいか等しい場合は `true` を返し、1 番目の値の方が小さい場合は `false` を返します。
if	式が true か false かを調べます。結果に基づき、指定された値を返します。
less	未満の比較演算。 1 番目の値の方が小さい場合は `true` を返し、1 番目の値の方が大きい場合は `false` を返します。
lessOrEquals	未満または等価の比較演算。 1 番目の値の方が小さいか等しい場合は `true` を返し、1 番目の値の方が大きい場合は `false` を返します。
not	論理 NOT 演算子。式が false の場合は `true` を返し、true の場合は `false` を返します。
or	論理または操作。少なくとも 1 つの式が true の場合は `true` を返し、すべての式が false の場合は `false` を返します。
exists	真実性を表す式を評価します。

変換関数

機能	説明
float	指定された文字列の浮動小数点表現を返します。
int	指定した文字列の整数表現を返します。
string	指定した値の文字列バージョンを省略可能なロケール形式で返します。
bool	指定した文字列のブール値表現を返します。
createArray	複数の入力から配列を作成します。
json	文字列または XML の JSON (JavaScript Object Notation) 型の値またはオブジェクトを返します。
base64	文字列またはバイト配列の base64 エンコードバージョンを返します。
base64ToBinary	base64 エンコード文字列のバイナリバージョンを返します。
base64ToString	base64 エンコード文字列の文字列バージョンを返します。
[バイナリ]	入力値のバイナリバージョンを返します。
dataUri	入力値の URI を返します。
dataUriToBinary	データ URI のバイナリバージョンを返します。
dataUriToString	データ URI の文字列バージョンを返します。
uriComponent	URL の安全でない文字がエスケープ文字に置き換えられた、入力値の URI エンコードバージョンを返します。
uriComponentToString	URI エンコード文字列の文字列バージョンを返します。
xml	文字列の XML バージョンを返します。
formatNumber	指定した小数部の桁数に最も近い数値に値を書式設定し、省略可能な指定されたロケールを設定します。
jsonStringify	値の JSON 文字列を返します。
stringOrValue 文字列補間をラップして実際の値を取得します。たとえば、`stringOrValue('${1}')` は数値 1 を返し、`stringOrValue('${1} item')` は文字列 "1 item" を返します。

数学関数

機能	説明
abs	指定された数値の絶対値を返します。
add	数学の AND。 2 つの数値を加算 (純粋な数値の場合) または 2 つ以上の文字列を連結した結果を返します。
div	数学の除算。 2 つの数値を除算した結果の整数値を返します。
max	コレクションから最大値を返します。
min	コレクションから最小値を返します。
mod	2 つの数値を除算した剰余を返します。
mul	数学の乗算。 2 つの数値を乗算した積を返します。
rand	指定した最小値と最大値の間の乱数を返します。
sqrt	指定された数値の平方根を返します。
sub	数学の減算。 1 番目の数値から 2 番目の数値を減算して、結果を返します。
sum	配列内の数値の合計を返します。
範囲	指定した整数から始まる整数の配列を返します。
exp	ある数値を別の数値で累乗して返します。
average	数値配列の平均値を返します。
floor	指定した数以下の数のうち、最大の整数値を返します。
ceiling	指定した数以上の数のうち、最小の整数値を返します。
round	最も近い整数、または指定された小数点以下の桁数に値を丸めます。

日付と時刻関数

機能	説明
addDays	省略可能な形式で、指定されたタイムスタンプに指定された日数を加算します。
addHours	省略可能なロケール形式で、指定されたタイムスタンプに指定された時間数を加算します。
addMinutes	省略可能なロケール形式で、指定されたタイムスタンプに指定された分数を加算します。
addSeconds	指定したタイムスタンプに、指定した秒数を加算します。
dayOfMonth	指定したタイムスタンプまたは Timex 式の月の日付を返します。
dayOfWeek	指定したタイムスタンプの曜日を返します。
dayOfYear	指定したタイムスタンプが年の何日目かを返します。
formatDateTime	省略可能なロケール形式でタイムスタンプを返します。
formatEpoch	UNIX エポック時間 (Unix 時間、POSIX 時間) からオプションのロケール形式でタイムスタンプを返します。
formatTicks	省略可能なロケール形式でタイムスタンプを返します。
subtractFromTime	省略可能なロケール形式でタイムスタンプから時間単位の数を減算します。
utcNow	現在のタイムスタンプを省略可能なロケール形式で文字列として返します。
dateReadBack	date-time ライブラリを使用して、日付を読み上げます。
month	指定したタイムスタンプの月を返します。
date	指定したタイムスタンプの日付を返します。
year	指定したタイムスタンプの年を返します。
getTimeOfDay	指定したタイムスタンプの時刻を返します。
getFutureTime	現在のタイムスタンプを指定された時間単位を加えた省略可能なロケール形式で返します。
getPastTime	指定された時間単位を差し引いた、省略可能なロケール形式で現在のタイムスタンプを返します。
addToTime	オプションのロケール形式でタイムスタンプに時間単位の数を追加します。
convertFromUTC	オプションのロケール形式でタイムスタンプを協定世界時 (UTC) から変換します。
convertToUTC	オプションのロケール形式でタイムスタンプを協定世界時 (UTC) に変換します。
startOfDay	省略可能なロケール形式でタイムスタンプの開始日を返します。
startOfHour	省略可能なロケール形式でタイムスタンプの開始時間を返します。
startOfMonth	省略可能なロケール形式でタイムスタンプの開始月を返します。
ticks	指定したタイムスタンプのティックプロパティの値を返します。
ticksToDays	ティックプロパティ値を日数に変換します。
ticksToHours	ティックプロパティ値を時間数に変換します。
ticksToMinutes	ティックプロパティ値を分数に変換します。
dateTimeDiff	2 つのタイムスタンプ間の差をティックで返します。
getPreviousViableDate	現在の日付とオプションで指定されたタイムゾーンに基づいて、Timex 式の以前の実行可能な日付を返します。
getNextViableDate	現在の日付と必要に応じて指定されたタイムゾーンに基づいて、Timex 式の次に実行可能な日付を返します。
getPreviousViableTime	現在の時刻と必要に応じて指定されたタイムゾーンに基づいて、Timex 式の前に以前の時刻を返します。
getNextViableTime	現在の時刻と必要に応じて指定されたタイムゾーンに基づいて、Timex 式の次に実行可能な時刻を返します。

Timex 関数

機能	説明
isPresent	TimexProperty または Timex 式が現在を示す場合は true を返します。
isDuration	TimexProperty または Timex 式が期間を示す場合は true を返します。
isTime	TimexProperty または Timex 式が時刻を示す場合は true を返します。
isDate	TimexProperty または Timex 式が日付を示す場合は true を返します。
isTimeRange	TimexProperty または Timex 式が時間の範囲を示す場合は true を返します。
isDateRange	TimexProperty または Timex 式が日付の範囲を示す場合は true を返します。
isDefinite	TimexProperty または Timex 式が限定的な日付を示す場合は true を返します。
解決	有効な時刻を参照している場合は、指定された TimexProperty または Timex 式の文字列を返します。有効な時刻には、時間、分、秒が含まれます。

URI 解析関数

機能	説明
uriHost	URI (Uniform Resource Identifier) のホストの値を返します。
uriPath	URI (Uniform Resource Identifier) のパスの値を返します。
uriPathAndQuery	URI (Uniform Resource Identifier) のパスの値とクエリの値を返します。
uriPort	URI (Uniform Resource Identifier) のポートの値を返します。
uriQuery	URI (Uniform Resource Identifier) のクエリの値を返します。
uriScheme	URI (Uniform Resource Identifier) のスキームの値を返します。

オブジェクトの操作と構築の関数

機能	説明
addProperty	JSON オブジェクトにプロパティとその値、または名前と値のペアを追加し、更新されたオブジェクトを返します。
removeProperty	JSON オブジェクトからプロパティを削除し、更新されたオブジェクトを返します。
setProperty	JSON オブジェクトのプロパティの値を設定し、更新されたオブジェクトを返します。
getProperty	指定したプロパティまたはルートプロパティの値を JSON オブジェクトから返します。
coalesce	1 つまたは複数のパラメーターから、最初の null 以外の値を返します。
xPath	XML で XPath (XML Path Language) 式と一致するノードまたは値を調べて、一致するノードまたは値を返します。
jPath	パス式に一致するノードまたは値があるかどうかについて JSON または JSON 文字列を調べ、一致するノードを返します。
setPathToValue	特定のパスの値を設定し、値を返します。

正規表現関数

機能	説明
isMatch	文字列が共通の正規表現パターンに一致する場合は true を返します。

型チェック関数

機能	説明
EOL	行末 (EOL) シーケンステキストを返します。
isInteger	指定した入力が整数の場合は true を返します。
isFloat	指定した入力が浮動小数点数の場合は true を返します。
isBoolean	指定した入力がブール値の場合は true を返します。
isArray	指定した入力が配列の場合は true を返します。
isObject	指定した入力がオブジェクトの場合は true を返します。
isDateTime	指定した入力 UTC ISO 形式のタイムスタンプの場合は true を返します。
isString	指定した入力が文字列の場合は true を返します。

事前構築済みの関数をアルファベット順に並べ替える

abs

指定された数値の絶対値を返します。

abs(<number>)

パラメーター	必須	タイプ	Description
<number>	はい	数値	絶対値を取得する数

戻り値	Type	説明設定
<result>	数値	絶対値を計算した結果。

使用例

これらの例では、次の絶対値を計算します。

abs(3.12134)
abs(-3.12134)

そして、どちらも 3.12134 という結果を返します。

add

2 つ以上の数値を加算 (純粋な数値の場合) または 2 つ以上の文字列を連結 (その他の場合) した結果を返します。

add(<item1>, <item2>, ...)

パラメーター	必須	タイプ	説明
<item1>、<item2>、...	はい	任意	項目

戻り値	Type	説明
<result-sum>	数値または文字列	指定した数値を加算した結果、または結合の結果。

例

この例は、指定した数値を加算します。

add(1, 1.5)

そして、2.5 という結果を返します。

この例は、指定した項目を連結します。

add('hello',null)
add('hello','world')

次の結果を返します

hello
helloworld

addDays

オプションのロケール形式でタイムスタンプに日数を追加します。

addDays('<timestamp>', <days>, '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。タイムスタンプは、標準 UTC ISO 形式である必要があります。 YYYY-MM-DDTHH:mm:ss.fffZ
<days>	はい	integer	追加する正または負の日数
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<updated-timestamp>	string	タイムスタンプに指定した日数を加えた値

例 1

この例は、指定したタイムスタンプに 10 日を加算します。

addDays('2018-03-15T13:00:00.000Z', 10)

そして、2018-03-25T00:00:00.000Z という結果を返します。

例 2

この例は、指定したタイムスタンプから 5 日を減算します。

addDays('2018-03-15T00:00:00.000Z', -5)

そして、2018-03-10T00:00:00.000Z という結果を返します。

例 3

次の例では、de-DE ロケールの指定されたタイムスタンプに 1 日を追加します。

addDays('2018-03-15T13:00:00.000Z', 1, '', 'de-dE')

そして、16.03.18 13:00:00 という結果を返します。

addHours

オプションのロケール形式でタイムスタンプに時間数を追加します。

addHours('<timestamp>', <hours>, '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<hours>	はい	integer	追加する正または負の時間数
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<updated-timestamp>	string	タイムスタンプに指定した時間数を加えた値

例 1

この例は、指定したタイムスタンプに 10 時間を加算します。

addHours('2018-03-15T00:00:00.000Z', 10)

そして、2018-03-15T10:00:00.000Z という結果を返します。

例 2

この例は、指定したタイムスタンプから 5 時間を減算します。

addHours('2018-03-15T15:00:00.000Z', -5)

そして、2018-03-15T10:00:00.000Z という結果を返します。

例 3

この例では、de-DE ロケールで指定されたタイムスタンプに 2 時間を追加します。

addHours('2018-03-15T13:00:00.000Z', 2, '', 'de-DE')

そして、15.03.18 15:00:00 という結果を返します。

addMinutes

オプションのロケール形式でタイムスタンプに分数を追加します。

addMinutes('<timestamp>', <minutes>, '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<minutes>	はい	integer	追加する正または負の分数
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<updated-timestamp>	string	タイムスタンプに指定した分数を加えた値

例 1

この例は、指定したタイムスタンプに 10 分を加算します。

addMinutes('2018-03-15T00:10:00.000Z', 10)

そして、2018-03-15T00:20:00.000Z という結果を返します。

例 2

この例は、指定したタイムスタンプから 5 分を減算します。

addMinutes('2018-03-15T00:20:00.000Z', -5)

そして、2018-03-15T00:15:00.000Z という結果を返します。

例 3

この例では、de-DE ロケールで指定されたタイムスタンプに 30 分を追加します。

addMinutes('2018-03-15T00:00:00.000Z', 30, '', 'de-DE')

そして、15.03.18 13:30:00 という結果を返します。

addOrdinal

入力番号の序数を返します。

addOrdinal(<number>)

パラメーター	必須	タイプ	Description
<number>	はい	integer	序数に変換する数値

戻り値	Type	説明設定
<result>	string	入力番号から変換された序数

例

addOrdinal(11)
addOrdinal(12)
addOrdinal(13)
addOrdinal(21)
addOrdinal(22)
addOrdinal(23)

そして、それぞれ次の結果を返します。

11 番目
12 番目
13 番目
21 番目
22 番目
23 番目

addProperty

JSON オブジェクトにプロパティとその値または名前と値のペアを追加し、更新されたオブジェクトを返します。実行時にオブジェクトが既に存在する場合、関数でエラーがスローされます。

addProperty('<object>', '<property>', value)

パラメーター	必須	タイプ	内容
<object>	はい	オブジェクト	プロパティを追加する JSON オブジェクト
<property>	はい	string	追加するプロパティの名前
<value>	はい	任意	プロパティの値。

戻り値	Type	説明
<updated-object>	オブジェクト	新しいプロパティを追加した後の更新された JSON オブジェクト

例

この例では、accountNumber プロパティが customerProfile オブジェクトに追加されます。このオブジェクトは、json() 関数で JSON に変換されます。この関数は、newGuid() 関数によって生成された値を代入し、更新されたオブジェクトを返します。

addProperty(json('customerProfile'), 'accountNumber', newGuid())

addSeconds

タイムスタンプに秒数を加算します。

addSeconds('<timestamp>', <seconds>, '<format>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<seconds>	はい	integer	追加する正または負の秒数
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。

戻り値	Type	説明
<updated-timestamp>	string	タイムスタンプに指定した秒数を加えた値

例 1

この例は、指定したタイムスタンプに 10 秒を加算します。

addSeconds('2018-03-15T00:00:00.000Z', 10)

そして、2018-03-15T00:00:10.000Z という結果を返します。

例 2

この例は、指定したタイムスタンプから 5 秒を減算します。

addSeconds('2018-03-15T00:00:30.000Z', -5)

そして、2018-03-15T00:00:25.000Z という結果を返します。

addToTime

オプションのロケール形式でタイムスタンプに時間単位の数を追加します。 getFutureTime() もご覧ください。

addToTime('<timestamp>', '<interval>', <timeUnit>, '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<interval>	はい	integer	追加する指定した時間単位の数
<timeUnit>	はい	string	interval と共に使用する時間単位。使用可能な単位は、"Second"、"Minute"、"Hour"、"Day"、"Week"、"Month"、"Year" です。
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<updated-timestamp>	string	タイムスタンプに、指定した形式で指定した時間単位数を加算した値。

例 1

この例は、指定したタイムスタンプに 1 日を加算します。

addToTime('2018-01-01T00:00:00.000Z', 1, 'Day')

そして、2018-01-02T00:00:00.000Z という結果を返します。

例 2

この例は、指定したタイムスタンプに 2 週間を加算します。

addToTime('2018-01-01T00:00:00.000Z', 2, 'Week', 'MM-DD-YY')

そして、'MM-DD-YY' 形式で、01-15-18 という結果を返します。

すべて

シーケンス内のすべての要素が条件を満たしているかどうかを調べます。

all(<sequence>, <item>, <condition>)

パラメーター	必須	タイプ	説明
<sequence>	はい	オブジェクト	評価されるシーケンス。
<item>	はい	string	シーケンスで評価する要素を参照します。
<condition>	はい	式 (expression)	条件を評価する式。

戻り値	Type	説明
true または false	Boolean	すべての要素が条件を満たす場合に `true` を返します。少なくとも 1 つが返されない場合、`false` を返します。

使用例

これらの例では、シーケンスのすべての要素が条件を満たしているかどうかを調べます。

all(createArray(1, 'cool'), item, isInteger(item))
all(createArray(1, 2), item => isInteger(item))

そして、それぞれ次の結果を返します。

シーケンス内の両方の項目が整数ではないので、false。
シーケンス内の両方の項目が整数であるため、true。

and

すべての式が true かどうかを調べます。すべての式が true の場合は true を返し、少なくとも 1 つの式が false の場合は false を返します。

and(<expression1>, <expression2>, ...)

パラメーター	必須	タイプ	説明
<expression1>, <expression2>, ...	はい	Boolean	調べる式

戻り値	Type	説明
true または false	Boolean	すべての式が true の場合は `true` を返します。少なくとも 1 つの式が false の場合は `false` を返します。

例 1

これらの例は、指定したブール値がすべて true かどうかを調べます。

and(true, true)
and(false, true)
and(false, false)

そして、それぞれ次の結果を返します。

両方の式が true なので、関数は true を返します。
1 つの式が false なので、関数は false を返します。
両方の式が false なので、関数は false を返します。

例 2

これらの例は、指定した式がすべて true かどうかを調べます。

and(equals(1, 1), equals(2, 2))
and(equals(1, 1), equals(1, 2))
and(equals(1, 2), equals(1, 3))

そして、それぞれ次の結果を返します。

両方の式が true なので、関数は true を返します。
1 つの式が false なので、関数は false を返します。
両方の式が false なので、関数は false を返します。

任意

シーケンス内の任意の要素が条件を満たしているかどうかを調べます。

all(<sequence>, <item>, <condition>)

パラメーター	必須	タイプ	説明
<sequence>	はい	オブジェクト	評価されるシーケンス。
<item>	はい	string	シーケンスで評価する要素を参照します。
<condition>	はい	式 (expression)	条件を評価する式。

戻り値	Type	説明
true または false	Boolean	すべての要素がその条件を満たす場合に `true` を返します。少なくとも 1 つが返されない場合、`false` を返します。

使用例

これらの例では、シーケンスのすべての要素が条件を満たしているかどうかを調べます。

any(createArray(1, 'cool'), item, isInteger(item))
any(createArray('first', 'cool'), item => isInteger(item))

そして、それぞれ次の結果を返します。

シーケンス内の少なくとも 1 つの項目が整数であるため、true
シーケンス内のどちらの項目も整数ではないので、false。

average

数値配列の平均値を返します。

average(<numericArray>)

パラメーター	必須	タイプ	説明
<numericArray>	はい	番号の配列	平均を計算する入力配列

戻り値	Type	説明
<average-of-array>	数値	指定した配列の平均値

例

この例では、createArray() 内の配列の平均が計算されます。

average(createArray(1,2,3))

そして、2 という結果が返されます。

base64

文字列またはバイト配列の base64 エンコードバージョンを返します。

base64('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	文字列またはバイト配列	入力文字列

戻り値	Type	説明
<base64-string>	string	入力文字列の base64 エンコードバージョン

例 1

この例では、hello という文字列が base64 エンコード文字列に変換されます。

base64('hello')

そして、"aGVsbG8=" という結果が返されます。

例 2

この例では byteArr、new byte[] { 3, 5, 1, 12 } と等しくなります。

base64('byteArr')

そして、"AwUBDA==" という結果が返されます。

base64ToBinary

base64 エンコード文字列のバイナリ配列を返します。

base64ToBinary('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	変換する base64 エンコード文字列

戻り値	Type	説明
<binary-for-base64-string>	byte array	base64 エンコード文字列のバイナリバージョン

例

この例では、AwUBDA== という base64 エンコード文字列がバイナリ文字列に変換されます。

base64ToBinary('AwUBDA==')

そして、new byte[] { 3, 5, 1, 12 } という結果が返されます。

base64ToString

base64 エンコード文字列の文字列バージョンを返し、実質的に base64 の文字列をデコードします。

base64ToString('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	デコードする base64 エンコード文字列

戻り値	Type	説明
<decoded-base64-string>	string	base64 エンコード文字列の文字列バージョン

例

この例では、aGVsbG8= という base64 エンコード文字列がデコード文字列に変換されます。

base64ToString('aGVsbG8=')

そして、hello という結果が返されます。

バイナリ

文字列のバイナリバージョンを返します。

binary('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	変換する文字列

戻り値	Type	説明
<binary-for-input-value>	byte array	指定した文字列のバイナリバージョン

例

この例では、hello という文字列がバイナリ文字列に変換されます。

binary('hello')

そして、new byte[] { 104, 101, 108, 108, 111 } という結果が返されます。

[bool]

値のブール値バージョンを返します。

bool(<value>)

パラメーター	必須	タイプ	説明
<value>	はい	任意	変換する値

戻り値	Type	説明
true または false	Boolean	指定した値のブール値バージョン

例

これらの例は、指定した値をブール値に変換します。

bool(1)
bool(0)

そして、それぞれ次の結果を返します。

true
false

ceiling

指定した数以下の数のうち、最大の整数値を返します。

ceiling('<number>')

パラメーター	必須	タイプ	Description
<number>	はい	数値	入力番号

戻り値	Type	説明
<整数値>	integer	入力数値以上の最大の整数値。

例

この例では、数値 10.333 以下の最大の整数値を返します。

ceiling(10.333)

整数の 11 が返されます。

coalesce

1 つまたは複数のパラメーターから、最初の null 以外の値を返します。空の文字列、空の配列、空のオブジェクトは null ではありません。

coalesce(<object**1>, <object**2>, ...)

パラメーター	必須	タイプ	説明
<object1>>、<<object2>>、...	はい	任意 (混合型は使用可能)	null かどうか調べる 1 つまたは複数の項目

戻り値	Type	説明
<first-non-null-item>	任意	null ではない最初の項目または値。すべてのパラメーターが null の場合、この関数は null を返します。

例

これらの例は、指定した値から最初の null 以外の値を返し、すべての値が null のときは null を返します。

coalesce(null, true, false)
coalesce(null, 'hello', 'world')
coalesce(null, null, null)

そして、それぞれ次の値を返します。

true
hello
null

concat

2 つ以上のオブジェクトを結合し、結合されたオブジェクトをリストまたは文字列で返します。

concat('<text1>', '<text2>', ...)

パラメーター	必須	タイプ	説明
<object1>, <object2>, ...	はい	任意	少なくとも 2 つのオブジェクトを連結します。

戻り値	Type	説明
<object1object2...>	文字列またはリスト。	連結された文字列またはリスト。 Null 値はスキップされます。

予想戻り値:

すべての項目がリストの場合は、リストが返されます。
リストではない項目が存在する場合は、文字列が返されます。
値が null の場合はスキップされ、連結されません。

例

この例では、文字列 Hello と World が結合されます。

concat('Hello', 'World')

そして、HelloWorld という結果が返されます。

例 2

次の例では、リスト [1、2] と [3、4] を結合します。

concat([1,2],[3,4])

そして、[1, 2, 3, 4] という結果が返されます。

例 3

次の例では、さまざまな型のオブジェクトを結合します。

concat('a', 'b', 1, 2)
concat('a', [1,2])

そして、それぞれ次の結果を返します。

文字列 ab12。
オブジェクト aSystem.Collections.Generic.List 1[System.Object]。これは読み取り不可能であり、回避するのが最善です。

例 4

これらの例では、オブジェクトを結合すると次の null のようになります。

concat([1,2], null)
concat('a', 1, null)

そして、それぞれ次の結果を返します。

リスト [1、2]。
文字列 a1。

contains

コレクションに特定の項目があるかどうかを確認します。項目が見つかった場合は true を返し、見つからない場合は false を返します。この関数は、大文字小文字を区別します。

contains('<collection>', '<value>')
contains([<collection>], '<value>')

この関数は次のコレクション型で動作します。

"文字列" からの "部分文字列" の検索
"配列" からの "値" の検索
"ディクショナリ" からの "キー" の検索

パラメーター	必須	タイプ	説明
<collection>	はい	文字列、配列、ディクショナリ	調べるコレクション
<value>	はい	それぞれ、文字列、配列、ディクショナリ	検索する項目

戻り値	Type	説明
true または false	Boolean	項目が見つかった場合は `true` を返します。項目が見つからない場合は `false` を返します。

例 1

この例では、文字列 hello world の部分文字列 world が調べられます。

contains('hello world', 'world')

そして、true という結果が返されます。

例 2

この例では、文字列 hello world の部分文字列 universe が調べられます。

contains('hello world', 'universe')

そして、false という結果が返されます。

count

コレクション内の項目の数を返します。

count('<collection>')
count([<collection>])

パラメーター	必須	タイプ	説明
<collection>	はい	文字列または配列	項目を数えるコレクション

戻り値	Type	説明
<length-or-count>	integer	コレクション内の項目数

例:

これらの例は、次のコレクション内の項目の数をカウントします。

count('abcd')
count(createArray(0, 1, 2, 3))

そして、どちらも 4 という結果を返します。

countWord

文字列の単語数を返します

countWord('<text>')

パラメーター	必須	タイプ	説明
<text>	はい	string	数える文字列

戻り値	Type	説明
<count>	integer	文字列の単語数

例

この例では、文字列 hello world の単語数が数えられます。

countWord("hello word")

そして、2 という結果が返されます。

convertFromUTC

省略可能なロケール形式のタイムスタンプを協定世界時 (UTC) からターゲットタイムゾーンに変換します。

convertFromUTC('<timestamp>', '<destinationTimeZone>', '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<destinationTimeZone>	はい	string	ターゲットタイムゾーンの名前。 Windows と IANA タイムゾーンがサポートされています。
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプのデフォルトの形式は "o" 形式、yyyy-MM-ddTHH:mm:ss.fffffffK で、ISO 8601 に準拠しています。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<converted-timestamp>	string	ターゲットタイムゾーンに変換されたタイムスタンプ

例:

これらの例は、UTC から太平洋標準時に変換します。

convertFromUTC('2018-02-02T02:00:00.000Z', 'Pacific Standard Time', 'MM-DD-YY')
convertFromUTC('2018-02-02T02:00:00.000Z', 'Pacific Standard Time')

そして、それぞれ次の結果を返します。

02-01-18
2018-01-01T18:00:00.0000000

例 2

次の例では、en-US ロケールのタイムスタンプを UTC から太平洋標準時に変換します。

convertFromUTC('2018-01-02T02:00:00.000Z', 'Pacific Standard Time', 'D', 'en-US')

2018 年 1 月 1 日月曜日の結果を返します。

convertToUTC

省略可能なロケール形式のタイムスタンプをソースタイムゾーンから協定世界時 (UTC) に変換します。

convertToUTC('<timestamp>', '<sourceTimeZone>', '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<sourceTimeZone>	はい	string	ターゲットタイムゾーンの名前。 Windows と IANA タイムゾーンがサポートされています。
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<converted-timestamp>	string	ターゲットタイムゾーンに変換されたタイムスタンプ

例

この例では、タイムスタンプを太平洋標準時から UTC に変換します。

convertToUTC('01/01/2018 00:00:00', 'Pacific Standard Time')

そして、2018-01-01T08:00:00.000Z という結果を返します。

例 2

次の例では、de-DE ロケールのタイムスタンプを太平洋標準時から UTC に変換します。

convertToUTC('01/01/2018 00:00:00', 'Pacific Standard Time', '', 'de-DE')

そして、01.01.18 08:00:00 という結果を返します。

createArray

複数の入力から配列を作成して返します。

createArray('<object1>', '<object2>', ...)

パラメーター	必須	タイプ	説明
<object1>, <object2>, ...	はい	任意、ただし混合は使用不可	配列を作成する少なくとも 2 つの項目

戻り値	Type	説明
[<object1>, <object2>, ...]	配列	すべての入力項目から作成された配列

例

この例では、次の入力から配列が作成されます。

createArray('h', 'e', 'l', 'l', 'o')

そして、[h ,e, l, l, o] という結果が返されます。

dataUri

文字列のデータ URI (Uniform Resource Identifier) を返します。

dataUri('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	変換する文字列

戻り値	Type	説明
[<date-uri>]	string	入力文字列に対するデータ URI

例

dataUri('hello')

data:text/plain;charset=utf-8;base64,aGVsbG8= という結果を返します。

dataUriToBinary

データ URI (Uniform Resource Identifier) のバイナリバージョンを返します。

dataUriToBinary('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	変換するデータ URI

戻り値	Type	説明
[<binary-for-data-uri>]	byte array	データ URI のバイナリバージョン

例

この例では、次のデータ URI のバイナリバージョンが作成されます。

dataUriToBinary('aGVsbG8=')

そして、new byte[] { 97, 71, 86, 115, 98, 71, 56, 61 } という結果が返されます。

dataUriToString

データ URI (Uniform Resource Identifier) の文字列バージョンを返します。

dataUriToString('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	変換するデータ URI

戻り値	Type	説明
[<string-for-data-uri>]	string	データ URI の文字列バージョン

例

この例では、次のデータ URI の文字列が作成されます。

dataUriToString('data:text/plain;charset=utf-8;base64,aGVsbG8=')

そして、hello という結果が返されます。

日付

m/dd/yyyy 形式で、指定したタイムスタンプの日付を返します。

date('<timestramp>')

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。

戻り値	Type	説明
<date>	string	指定したタイムスタンプの日付

date('2018-03-15T13:00:00.000Z')

3-15-2018 という結果を返します。

dateReadBack

date-time ライブラリを使用して、日付を読み上げます。

dateReadBack('<currentDate>', '<targetDate>')

パラメーター	必須	タイプ	説明
<currentDate>	はい	string	現在の日付を含む文字列
<targetDate>	はい	string	ターゲットの日付を含む文字列

戻り値	Type	説明
<date-readback>	string	現在の日付とターゲットの日付の間の読み上げ

例 1

dateReadBack('2018-03-15T13:00:00.000Z', '2018-03-16T13:00:00.000Z')

明日という結果を返します。

dateTimeDiff

2 つのタイムスタンプ間の差をティックで返します。

dateTimeDiff('<timestamp1>', '<timestamp2>')

パラメーター	必須	タイプ	説明
<timestamp1>	はい	string	比較する最初のタイムスタンプ文字列
<timestamp2>	はい	string	比較する 2 番目のタイムスタンプ文字列

戻り値	Type	説明
<ticks>	数値	2 つのタイムスタンプ間のティックの違い

例 1

この例では、2 つのタイムスタンプ間の差をティックで返します。

dateTimeDiff('2019-01-01T08:00:00.000Z','2018-01-01T08:00:00.000Z')

そして、数値 315360000000000 を返します。

例 2

この例では、2 つのタイムスタンプ間の差をティックで返します。

dateTimeDiff('2018-01-01T08:00:00.000Z', '2019-01-01T08:00:00.000Z')

結果 -315360000000000 を返します。この値は負の数です。

dayOfMonth

タイムスタンプから月の日付を返します。

dayOfMonth('<timestamp>')

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。

戻り値	Type	説明
<day-of-month>	integer	指定したタイムスタンプの月の日付

例

この例では、次のタイムスタンプから月の日付の数値が返されます。

dayOfMonth('2018-03-15T13:27:36Z')

そして、15 という結果が返されます。

dayOfWeek

タイムスタンプから曜日を返します。

dayOfWeek('<timestamp>')

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。

戻り値	Type	説明
<day-of-week>	integer	指定したタイムスタンプからの曜日。日曜日は 0、月曜日は 1 などです。

例

この例では、次のタイムスタンプから曜日の数値が返されます。

dayOfWeek('2018-03-15T13:27:36Z')

そして、3 という結果が返されます。

dayOfYear

タイムスタンプから年の何日目かを返します。

dayOfYear('<timestamp>')

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。

戻り値	Type	説明
<day-of-year>	integer	指定したタイムスタンプの年初からの通算日数

例

この例では、次のタイムスタンプから年の何日目かが返されます。

dayOfYear('2018-03-15T13:27:36Z')

そして、74 という結果が返されます。

div

2 つの数値を除算した結果の整数値を返します。剰余を返すには、mod() に関する記事を参照してください。

div(<dividend>, <divisor>)

パラメーター	必須	タイプ	説明
<dividend>	はい	数値	divisor によって除算される値。
<divisor>	はい	数値	dividend を除算する値。 0 にすることはできません。

戻り値	Type	説明
<quotient-result>	数値	1 番目の数値を 2 番目の数値で除算した結果

例

どちらの例も、1 番目の数値を 2 番目の数値で除算します。

div(10, 5)
div(11, 5)

そして、2 という結果を返します。

Javascript と .NET SDK の間には、ある程度のギャップがあります。たとえば、次の式は、Javascript と .NET SDK で異なる結果を返します。

パラメーターの 1 つが float の場合、.NET SDK では結果も FLOAT になります。

例

div(11.2, 2)

5.6 という結果を返します。

パラメーターの 1 つが float の場合、結果は Javascript SDK を使用した INT になります。

例

div(11.2, 2)

5 という結果を返します。

Javascript で結果の小数点以下の桁数を特定の数だけ保持する回避策は、このような式を使用することです。たとえば、小数点以下 3 桁を保持するには、次のようにします。

float(concat(string(div(a, b)),'.',string(mod(div(a*1000, b), 1000))))

空

インスタンスが空かどうかを調べます。入力が空の場合は true を返します。空であることは、以下を意味します。

入力が null または未定義です
入力が null または空の文字列です
入力がゼロサイズのコレクションです
入力が、プロパティのないオブジェクトです。

empty('<instance>')
empty([<instance>])

パラメーター	必須	タイプ	説明
<instance>	はい	任意	確認するインスタンス。

戻り値	Type	説明
true または false	Boolean	インスタンスが空の場合、`true` を返します。

例

これらの例は、指定したインスタンスが空であるかどうかを調べます。

empty('')
empty('abc')
empty([1])
empty(null)

そして、それぞれ次の結果を返します。

空の文字列を渡しているので、関数は true を返します。
文字列 abc を渡しているので、関数は false を返します。
1 つの項目を含むコレクションを渡しているので、関数は false を返します。
null オブジェクトを渡しているので、関数は true を返します。

endsWith

文字列が特定の部分文字列で終わっているかどうかを調べます。部分文字列が見つかった場合は true を返し、見つからない場合は false を返します。この関数では、大文字と小文字が区別されません。

endsWith('<text>', '<searchText>')

パラメーター	必須	タイプ	説明
<text>	はい	string	調べる文字列。
<searchText>	はい	string	検索する末尾の部分文字列

戻り値	Type	説明
true または false	Boolean	末尾の部分文字列が見つかった場合は `true` を返します。見つからない場合は `false` を返します。

例 1

この例では、文字列 hello world が文字列 world で終わっているかどうかが調べられます。

endsWith('hello world', 'world')

そして、true という結果が返されます。

例 2

この例では、文字列 hello world が文字列 universe で終わっているかどうかが調べられます。

endsWith('hello world', 'universe')

そして、false という結果が返されます。

EOL

行末 (EOL) シーケンステキストを返します。

EOL()

戻り値	Type	説明
<IsOSPlatform>	string	Windows では \r\n を返し、Mac と Linux では \n を返します。

例

次の例では、行シーケンステキストの末尾をチェックします。

EOL()

そして、次の文字列を返します。

Windows: \r\n
Mac または Linux: \n

equals

両方の値、式、またはオブジェクトが等しいかどうかを調べます。両方が等しい場合は true を返し、等しくない場合は false を返します。

equals('<object1>', '<object2>')

パラメーター	必須	タイプ	説明
<object1>, <object2>	はい	任意	比較する値、式、またはオブジェクト

戻り値	Type	説明
true または false	Boolean	両方が等しい場合は `true` を返します。等しくない場合は `false` を返します。

例

これらの例は、指定した入力が等しいかどうかを調べます。

equals(true, 1)
equals('abc', 'abcd')

そして、それぞれ次の結果を返します。

両方の値が等しいので、関数は true を返します。
両方の値が等しくないので、関数は false を返します。

exists

真実性を表す式を評価します。

exists(expression)

パラメーター	必須	タイプ	説明
式 (expression)	はい	式 (expression)	真実性を評価する式

戻り値	Type	説明
<"true または false">	Boolean	式を評価した結果

例

これらの例は、foo = {"bar":"value"} の真実性を評価します。

exists(foo.bar)
exists(foo.bar2)

そして、それぞれ次の結果を返します。

true
false

exp

ある数値を別の数値で累乗して返します。

exp(realNumber, exponentNumber)

パラメーター	必須	タイプ	説明
realNumber	はい	数値	その指数を計算する実数
exponentNumber	はい	数値	指数の数値

戻り値	Type	説明
<result-exp>	数値	`realNumber` の指数を計算した結果

例

この例は、指数を計算します。

exp(2, 2)

そして、4 という結果を返します。

first

文字列または配列から最初の項目を返します。

first('<collection>')
first([<collection>])

パラメーター	必須	タイプ	説明
<collection>	はい	文字列または配列	最初の項目を検索するコレクション

戻り値	Type	説明
<first-collection-item>	任意	コレクション内の最初の項目

例

これらの例は、次のコレクション内の最初の項目を検索します。

first('hello')
first(createArray(0, 1, 2))

そして、それぞれ次の結果を返します。

flatten

配列を非配列値にフラット化します。必要に応じて、フラット化する最大の深さを設定できます。

flatten([<collection>], '<depth>')

パラメーター	必須	タイプ	説明
<collection>	はい	array	フラット化するコレクション
<depth>	いいえ	数値	フラット化する最大の深さ。既定値は無限大です。

戻り値	Type	説明
<new-collection>	配列	要素が指定した深さまでフラット化されて非配列となった新しいコレクション

例 1

この例では、次の配列がフラット化されます。

flatten(createArray(1, createArray(2), createArray(createArray(3, 4), createArray(5, 6)))

そして、[1, 2, 3, 4, 5, 6] という結果が返されます。

例 2

この例では、配列が 1 の深さにフラット化されます。

flatten(createArray(1, createArray(2), createArray(createArray(3, 4), createArray(5, 6)), 1)

そして、[1, 2, [3, 4], [5, 6]] という結果が返されます。

float

浮動小数点数の文字列バージョンを浮動小数点数に変換します。この関数は、ロジックアプリなどのアプリにカスタムパラメーターを渡す場合にのみ使用できます。文字列を float に変換できない場合は、例外がスローされます。

float('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	変換後の有効な浮動小数点数を含む文字列

戻り値	Type	説明
<float-value>	float	指定した文字列の浮動小数点数

例

この例では、文字列の float バージョンを変換します。

float('10.333')

そして、float 10.333 を返します。

floor

指定した数以下の数のうち、最大の整数値を返します。

floor('<number>')

パラメーター	必須	タイプ	Description
<number>	はい	数値	入力番号

戻り値	Type	説明
<整数値>	integer	入力数値以下の最大の整数値

例

次の例では、数値 10.333 の床の値を計算します。

floor(10.333)

整数の 10 が返されます。

foreach

各要素を演算し、新しいコレクションを返します。

foreach([<collection/instance>], <iteratorName>, <function>)

パラメーター	必須	タイプ	説明
<collection/instance>	はい	配列またはオブジェクト	項目を含むコレクション
<iteratorName>	はい	反復子名	Arrow 関数のキー項目
<function>	はい	式 (expression)	`iteratorName` を含む関数

戻り値	Type	説明
<new-collection>	配列	各要素が関数によって評価された新しいコレクション

例 1

この例では、新しいコレクションが生成されます。

foreach(createArray(0, 1, 2, 3), x, x + 1)

そして、[1, 2, 3, 4] という結果が返されます。

例 2

これらの例では、新しいコレクションが生成されます。

foreach(json("{'name': 'jack', 'age': '15'}"), x, concat(x.key, ':', x.value))
foreach(json("{'name': 'jack', 'age': '15'}"), x=> concat(x.key, ':', x.value))

そして、['name:jack', 'age:15'] という結果が返されます。 2 番目の式は ラムダ式であり、より読みやすいと感じるユーザーがいることに注意してください。

formatDateTime

省略可能なロケール形式でタイムスタンプを返します。

formatDateTime('<timestamp>', '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<reformatted-timestamp>	string	指定した形式に更新されたタイムスタンプ。

例 1

この例は、タイムスタンプを指定した形式に変換します。

formatDateTime('03/15/2018 12:00:00', 'yyyy-MM-ddTHH:mm:ss')

そして、2018-03-15T12:00:00 という結果を返します。

例 2

この例では、 de-DE ロケールのタイムスタンプを変換します。

formatDateTime('2018-03-15', '', 'de-DE')

そして、15.03.18 00:00:00 という結果を返します。

formatEpoch

UNIX 時間 (エポック時間、POSIX 時間、UNIX エポック時間とも呼ばれます) から指定された形式で、省略可能のロケール形式でタイムスタンプを返します。

formatEpoch('<epoch>', '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<epoch>	はい	数値	エポック番号
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<reformatted-timestamp>	string	指定した形式に更新されたタイムスタンプ。

例

この例は、Unix タイムスタンプを指定した形式に変換します。

formatEpoch(1521118800, 'yyyy-MM-ddTHH:mm:ss.fffZ)'

そして、2018-03-15T12:00:00.000Z という結果を返します。

例

次の例では、de-DE ロケールの Unix タイムスタンプを変換します。

formatEpoch(1521118800, '', 'de-DE')

そして、15.03.18 13:00:00 という結果を返します。

formatNumber

指定した小数部の桁数と省略可能な指定されたロケールに値を書式設定します。

formatNumber('<number>', '<precision-digits>', '<locale>'?)

パラメーター	必須	タイプ	Description
<number>	はい	数値	入力番号
<precision-digits>	はい	integer	指定された小数桁数
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<return-value>	数値	指定した小数部の桁数と指定したロケールで書式設定された入力の戻り値

例 1

次の例では、数値 10.333 を 2 桁の小数部に書式設定します。

formatNumber(10.333, 2)

そして、10.33 という文字列の結果が返されます。

例 2

これらの例では、en-US ロケールの指定した桁数に数値を書式設定します。

formatNumber(12.123, 2, 'en-US')
formatNumber(1.551, 2, 'en-US')
formatNumber(12.123, 4, 'en-US')

そして、それぞれ次の結果を返します。

12.12
1.55
12.1230

formatTicks

ティックから指定された形式で、省略可能なロケール形式のタイムスタンプを返します。

formatTicks('<ticks>', '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<epoch>	はい	数値 (または、JavaScript では bigint)	ティック番号
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<reformatted-timestamp>	string	指定した形式に更新されたタイムスタンプ。

例 1

この例は、ティックを指定した形式に変換します。

formatTicks(637243624200000000, 'yyyy-MM-ddTHH:mm:ss.fffZ')

そして、2020-05-06T11:47:00.000Z という結果を返します。

例 2

この例では、ティックを de-DE ロケールで指定された形式に変換します。

formatTicks(637243624200000000, '', 'de-DE')

そして、06.05.20 11:47:00 という結果を返します。

getFutureTime

現在のタイムスタンプを指定された時間単位を加えた省略可能なロケール形式で返します。

getFutureTime(<interval>, <timeUnit>, '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<interval>	はい	integer	加算する特定の時間単位数
<timeUnit>	はい	string	interval と共に使用する時間単位。使用可能な単位は、"Second"、"Minute"、"Hour"、"Day"、"Week"、"Month"、"Year" です。
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<updated-timestamp>	string	現在のタイムスタンプに指定した時間単位数を加えた値

例 1

現在のタイムスタンプが 2019-03-01T00:00:00.000Z であるものとします。次の例は、そのタイムスタンプに 5 日を加算します。

getFutureTime(2, 'Week')

そして、2019-03-15T00:00:00.000Z という結果を返します。

例 2

現在のタイムスタンプが 2018-03-01T00:00:00.000Z であるものとします。次の例は、タイムスタンプに 5 日を加算し、結果を MM-DD-YY 形式に変換します。

getFutureTime(5, 'Day', 'MM-DD-YY')

そして、03-06-18 という結果が返されます。

例 3

現在のタイムスタンプが 2020-05-01T00:00:00.000Z で、ロケールが de-DE であるとします。以下の例では、タイムスタンプに 1 日を追加します。

getFutureTime(1,'Day', '', 'de-DE')

そして、02.05.20 00:00:00 という結果を返します。

getNextViableDate

現在の日付と必要に応じて指定されたタイムゾーンに基づいて、Timex 式の次に実行可能な日付を返します。

getNextViableDate(<timexString>, <timezone>?)

パラメーター	必須	タイプ	説明
<timexString>	はい	string	評価する日付の Timex 文字列。
<timezone>	いいえ	string	省略可能なタイムゾーン。

戻り値	Type	説明
<nextViableTime>	string	次に実行可能な日付。

使用例

日付が 2020-06-12 で、現在の時刻が 15:42:21 であるとします。

これらの例では、上記の日付と時刻に基づいて、次に実行可能な日付の次の Timex 文字列を評価します。

getPreviousViableDate("XXXX-12-20", "America/Los_Angeles")
getPreviousViableDate("XXXX-02-29")

そして、次の文字列をそれぞれ返します。

2020-12-20
2024-02-29

getNextViableTime

現在の時刻と必要に応じて指定されたタイムゾーンに基づいて、Timex 式の次に実行可能な時刻を返します。

getNextViableTime(<timexString>, <timezone>?)

パラメーター	必須	タイプ	説明
<timexString>	はい	string	評価する時刻の Timex 文字列。
<timezone>	いいえ	string	省略可能なタイムゾーン。

戻り値	Type	説明
<nextViableTime>	string	次に実行できる時間。

使用例

日付が 2020-06-12 で、現在の時刻が 15:42:21 であるとします。

これらの例では、上記の日時に基づいて、次に実行可能な時刻の次の Timex 文字列を評価します。

getNextViableTime("TXX:12:14", "Asia/Tokyo")
getNextViableTime("TXX:52:14")

そして、次の文字列をそれぞれ返します。

T16:12:14
T15:52:14

getPastTime

現在のタイムスタンプから指定した時刻単位を引いて返します。

getPastTime(<interval>, <timeUnit>, '<format>'?)

パラメーター	必須	タイプ	説明
<interval>	はい	integer	減算する指定した時間単位の数
<timeUnit>	はい	string	interval と共に使用する時間単位。使用可能な単位は、"Second"、"Minute"、"Hour"、"Day"、"Week"、"Month"、"Year" です。
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。

戻り値	Type	説明
<updated-timestamp>	string	現在のタイムスタンプから指定した時間単位数を引いた値

例 1

現在のタイムスタンプが 2018-02-01T00:00:00.000Z であるものとします。この例は、そのタイムスタンプから 5 日を減算します。

getPastTime(5, 'Day')

そして、2019-01-27T00:00:00.000Z という結果を返します。

例 2

現在のタイムスタンプが 2018-03-01T00:00:00.000Z であるものとします。この例では、MM-DD-YY 形式のタイムスタンプに 5 日を減算します。

getPastTime(5, 'Day', 'MM-DD-YY')

そして、02-26-18 という結果が返されます。

例 3

現在のタイムスタンプが 2020-05-01T00:00:00.000Z で、ロケールが de-DE であるとします。次の例では、タイムスタンプから 1 日が減算されます。

getPastTime(1,'Day', '', 'de-DE')

そして、31.04.20 00:00:00 という結果を返します。

getPreviousViableDate

現在の日付とオプションで指定されたタイムゾーンに基づいて、Timex 式の以前の実行可能な日付を返します。

getPreviousViableDate(<timexString>, <timezone>?)

パラメーター	必須	タイプ	説明
<timexString>	はい	string	評価する日付の Timex 文字列。
<timezone>	いいえ	string	省略可能なタイムゾーン。

戻り値	Type	説明
<previousViableDate>	string	以前の実行可能な日付。

使用例

日付が 2020-06-12 で、現在の時刻が 15:42:21 であるとします。

これらの例では、上記の日付と時刻に基づいて、以前の実行可能な日付の次の Timex 文字列を評価します。

getPreviousViableDate("XXXX-12-20", "Eastern Standard Time")
getPreviousViableDate("XXXX-02-29")

そして、次の文字列をそれぞれ返します。

2019-12-20
2020-02-29

getPreviousViableTime

現在の日付とオプションで指定されたタイムゾーンに基づいて、Timex 式の以前の実行可能な時刻を返します。

getPreviousViableTime(<timexString>, <timezone>?)

パラメーター	必須	タイプ	説明
<timexString>	はい	string	評価する時刻の Timex 文字列。
<timezone>	いいえ	string	省略可能なタイムゾーン。

戻り値	Type	説明
<previousViableTime>	string	以前の実行可能な時刻。

使用例

日付が 2020-06-12 で、現在の時刻が 15:42:21 であるとします。

これらの例では、上記の日時に基づいて、以前の実行可能な時刻の次の Timex 文字列を評価します。

getPreviousViableTime("TXX:52:14")
getPreviousViableTime("TXX:12:14", 'Europe/London')

そして、次の文字列をそれぞれ返します。

T14:52:14
T15:12:14

getProperty

指定したプロパティまたはルートプロパティの値を JSON オブジェクトから返します。

指定されたプロパティの値を返します

getProperty(<JSONObject>, '<propertyName>')

パラメーター	必須	タイプ	説明
<JSONObject>	はい	オブジェクト	JSON オブジェクトには、プロパティとプロパティの両方の値が含まれています。
<propertyName>	いいえ	string	値にアクセスする省略可能なプロパティの名前。

戻り値	Type	説明
値	string	JSON オブジェクト内の指定されたプロパティの値。

例

次の JSON オブジェクトがあるとします。

{
   "a:b" : "a:b value",
   "c":
   {
        "d": "d key"
    }
}

これらの例は、上記の JSON オブジェクトから指定されたプロパティを取得します。

getProperty({"a:b": "value"}, 'a:b')
getProperty(c, 'd')

そして、次の文字列をそれぞれ返します。

a:b value
d 鍵

ルートプロパティを返す

getProperty('<propertyName>')

パラメーター	必須	タイプ	説明
<propertyName>	はい	string	ルートメモリスコープから値にアクセスする省略可能なプロパティの名前。

戻り値	Type	説明
値	string	JSON オブジェクトのルートプロパティの値。

例

次の JSON オブジェクトがあるとします。

{
   "a:b" : "a:b value",
   "c":
   {
        "d": "d key"
    }
}

この例では、上記の JSON オブジェクトからルートプロパティを取得します。

getProperty("a:b")

そして、文字列 a:b value を返します。

getTimeOfDay

指定したタイムスタンプの時刻を返します。

getTimeOfDay('<timestamp>')

返される時刻は、次の文字列のいずれかです。

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	指定したタイムスタンプを含む文字列

戻り値	Type	説明
<time-of-day>	string	指定したタイムスタンプの時刻

時刻に関連付けられている文字列を以下に示します。

時刻	タイムスタンプ
midnight	午前 12:00
朝	午前 12:01 から午後 11:59
午後	午後 12:00
夜	午後 6:00 から午後 10:00
night	午後 10:01 から午後 11:59

例

getTimeOfDay('2018-03-15T08:00:00.000Z')

朝という結果を返します。

greater

1 番目の値が 2 番目の値より大きいかどうかを調べます。 1 番目の値の方が大きい場合は true を返し、小さい場合は false を返します。

greater(<value>, <compareTo>)
greater('<value>', '<compareTo>')

パラメーター	必須	タイプ	説明
<value>	はい	整数、浮動小数点数、文字列	2 番目の値より大きいかどうかを調べる 1 番目の値
<compareTo>	はい	それぞれ、整数、浮動小数点数、文字列	比較する値

戻り値	Type	説明
true または false	Boolean	1 番目の値が 2 番目の値より大きい場合は `true` を返します。 1 番目の値が 2 番目の値以下の場合は `false` を返します。

例

これらの例は、1 番目の値が 2 番目の値より大きいかどうかを調べます。

greater(10, 5)
greater('apple', 'banana')

そして、それぞれ次の結果を返します。

true
false

greaterOrEquals

1 番目の値が 2 番目の値以上かどうかを調べます。 1 番目の値の方が大きいか等しい場合は true を返し、1 番目の値の方が小さい場合は false を返します。

greaterOrEquals(<value>, <compareTo>)
greaterOrEquals('<value>', '<compareTo>')

パラメーター	必須	タイプ	説明
<value>	はい	整数、浮動小数点数、文字列	2 番目の値以上かどうかを調べる 1 番目の値。
<compareTo>	はい	それぞれ、整数、浮動小数点数、文字列	比較する値

戻り値	Type	説明
true または false	Boolean	1 番目の値が 2 番目の値以上の場合は `true` を返します。 1 番目の値が 2 番目の値より小さい場合は `false` を返します。

例

これらの例は、1 番目の値が 2 番目の値以上かどうかを調べます。

greaterOrEquals(5, 5)
greaterOrEquals('apple', 'banana')

そして、それぞれ次の結果を返します。

true
false

if

式が true か false かを調べます。結果に基づき、指定された値を返します。

if(<expression>, <valueIfTrue>, <valueIfFalse>)

パラメーター	必須	タイプ	説明
<expression>	はい	Boolean	調べる式。
<valueIfTrue>	はい	任意	式が true の場合に返す値
<valueIfFalse>	はい	任意	式が false の場合に返す値

戻り値	Type	説明
<specified-return-value>	任意	式が `true` か `false` かに基づいて返すように指定した値

例

この例では、equals(1,1) が true かどうかが評価されます。

if(equals(1, 1), 'yes', 'no')

そして、指定した式が true を返すため、はいが返されます。それ以外の場合、この例はいいえを返します。

indexOf

部分文字列の開始位置またはインデックス値を返します。この関数は、大文字と小文字を区別せず、インデックスは値 0 から始まります。

indexOf('<text>', '<searchText>')

パラメーター	必須	タイプ	説明
<text>	はい	文字列または配列	検索する部分文字列を含む文字列
<searchText>	はい	string	検索する部分文字列

戻り値	Type	説明
<index-value>	integer	指定した部分文字列の開始位置またはインデックス値。
文字列が見つからない場合は、値 -1 を返します。

例 1

この例では、文字列 hello world の部分文字列 world の開始インデックス値が検索されます。

indexOf('hello world', 'world')

そして、6 という結果が返されます。

例 2

この例では、配列 ['abc', 'def', 'ghi'] の部分文字列 def の開始インデックス値が検索されます。

indexOf(createArray('abc', 'def', 'ghi'), 'def')

そして、1 という結果が返されます。

indicesAndValues

配列またはオブジェクトを、インデックス (現在のインデックス) と値のプロパティを含むオブジェクトの配列に変換します。配列の場合、インデックスは配列内の位置です。オブジェクトの場合は、値のキーです。

indicesAndValues('<collection or object>')

パラメーター	必須	タイプ	説明
<collection or object>	はい	配列またはオブジェクト	元の配列またはオブジェクト

戻り値	Type	説明
<collection>	配列	新しい配列。各項目には、配列内の位置またはオブジェクトのキーを含むインデックス、および対応する値という 2 つのプロパティがあります。

例 1

たとえば、{ items: ["zero", "one", "two"] } という一覧があるとします。次の関数は、その一覧を受け取ります。

indicesAndValues(items)

そして、新しい一覧を返します。

[
  {
    index: 0,
    value: 'zero'
  },
  {
    index: 1,
    value: 'one'
  },
  {
    index: 2,
    value: 'two'
  }
]

例 2

たとえば、{ items: ["zero", "one", "two"] } という一覧があるとします。次の関数は、その一覧を受け取ります。

where(indicesAndValues(items), elt, elt.index >= 1)

そして、新しい一覧を返します。

[
  {
    index: 1,
    value: 'one'
  },
  {
    index: 2,
    value: 'two'
  }
]

例 3

たとえば、{ items: ["zero", "one", "two"] } という一覧があるとします。次の関数は、その一覧を受け取ります。

join(foreach(indicesAndValues(items), item, item.value), ',')

そして、zero,one,two という結果を返します。この式は、join(items, ',') と同じ効果があります。

例 4

たとえば、オブジェクト { user: {name: 'jack', age: 20} があるとします。次の関数は、そのオブジェクトを受け取ります。

indicesAndValues(user)

そして、新しいオブジェクトを返します。

[
  {
    index: 'name',
    value: 'jack'
  },
  {
    index: 'age',
    value: 20
  }
]

int

文字列の整数バージョンを返します。文字列を整数に変換できない場合は、例外がスローされます。

int('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	変換する文字列

戻り値	Type	説明
<integer-result>	integer	指定した文字列の整数バージョン

例

この例では、文字列 10 の整数バージョンが作成されます。

int('10')

そして、整数 10 という結果が返されます。

intersection

指定したコレクションすべてに共通する項目 "のみ" を含むコレクションを返します。結果に含まれるためには、この関数に渡されるすべてのコレクションに項目が含まれる必要があります。 1 つまたは複数の項目が同じ名前である場合は、その名前を持つ最後の項目が結果に含まれます。

intersection([<collection1>], [<collection2>], ...)
intersection('<collection1>', '<collection2>', ...)

パラメーター	必須	タイプ	説明
<collection1>、<collection2>	はい	配列またはオブジェクト、ただし両方は不可	共通項目を抽出するコレクション

戻り値	Type	説明
<common-items>	それぞれ、配列またはオブジェクト	指定したコレクションすべてに共通する項目のみを含むコレクション

例

この例では、次の配列全体で共通する項目が検索されます。

intersection(createArray(1, 2, 3), createArray(101, 2, 1, 10), createArray(6, 8, 1, 2))

そして、その項目 [1, 2] を含む配列が返されます。

isArray

指定した入力が配列の場合は true を返します。

isArray('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	任意	テスト対象の入力

戻り値	Type	説明
<Boolean-result>	Boolean	指定した入力が配列の場合は `true` を返し、配列でない場合は `false` を返します。

使用例

次の例は、入力が配列かどうかを調べます。

isArray('hello')
isArray(createArray('hello', 'world'))

そして、それぞれ次の結果を返します。

入力が文字列なので、関数は false を返します。
入力が配列なので、関数は true を返します。

isBoolean

指定した入力がブール値の場合は true を返します。

isBoolean('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	任意	テスト対象の入力

戻り値	Type	説明
<Boolean-result>	Boolean	指定した入力がブール値の場合は `true` を返し、ブール値でない場合は `false` を返します。

使用例

次の例は、入力がブール値かどうかを調べます。

isBoolean('hello')
isBoolean(32 > 16)

そして、それぞれ次の結果を返します。

入力が文字列なので、関数は false を返します。
入力がブール値なので、関数は true を返します。

isDate

指定した TimexProperty または Timex 式が有効な日付を示す場合は true を返します。有効な日付には、月と dayOfMonth が含まれるか、dayOfWeek が含まれます。

isDate('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	オブジェクトまたは文字列	入力 TimexProperty オブジェクト、または Timex 式の文字列。

戻り値	Type	説明
<boolean-result>	Boolean	入力が有効な日付を示す場合は `true` を返し、日付が無効な場合は `false` を返します。

使用例

これらの例は、次の入力が有効な日付かどうかを調べます。

isDate('2020-12')
isDate('xxxx-12-21')

そして、次の結果を返します。

false
true

isDateRange

指定した TimexProperty または Timex 式が有効な日付の範囲を示す場合は true を返します。

isDateRange('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	オブジェクトまたは文字列	入力 TimexProperty オブジェクト、Timex 式の文字列。

戻り値	Type	説明
<boolean-result>	Boolean	指定した入力が有効な日付の範囲を示す場合は `true` を返し、有効な日付の範囲でない場合は `false` を返します。

使用例

これらの例は、次の入力が有効な日付の範囲かどうかを調べます。

isDateRange('PT30M')
isDateRange('2012-02')

そして、次の結果を返します。

false
true

isDateTime

指定した入力が UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) のタイムスタンプ文字列の場合は true を返します。

isDateTime('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	任意	テスト対象の入力

戻り値	Type	説明
<Boolean-result>	Boolean	指定した入力が UTC ISO 形式のタイムスタンプ文字列の場合は `true` を返し、UTC ISO 形式のタイムスタンプ文字列でない場合は `false` を返します。

使用例

次の例は、入力が UTC ISO 形式の文字列かどうかを調べます。

isDateTime('hello world!')
isDateTime('2019-03-01T00:00:00.000Z')

そして、それぞれ次の結果を返します。

入力が文字列なので、関数は false を返します。
入力が UTC ISO 形式の文字列なので、関数は true を返します。

isDefinite

指定した TimexProperty または Timex 式が有効な日付を示す場合は true を返します。有効な日付には、年、月、dayOfMonth が含まれます。

isDefinite('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	オブジェクトまたは文字列	入力 TimexProperty オブジェクト、Timex 式の文字列。

戻り値	Type	説明
<boolean-result>	Boolean	指定した入力が有効な完全な日付を示す場合は `true` を返し、有効な完全な日付を示さない場合は `false` を返します。

使用例

validFullDate = new TimexProperty ("2020-02-20") という TimexProperty オブジェクトがあり、Now プロパティを true に設定しているとします。次の例は、オブジェクトが有効な完全な日付を示すかどうかを調べます。

isDefinite('xxxx-12-21')
isDefinite(validFullDate)

そして、それぞれ次の結果を返します。

false
true

isDuration

指定した TimexProperty または Timex 式が有効な期間を示す場合は true を返します。

isDuration('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	オブジェクトまたは文字列	入力 TimexProperty オブジェクト、Timex 式の文字列。

戻り値	Type	説明
<boolean-result>	Boolean	入力が有効な期間を示す場合は `true` を返し、入力が有効な期間を示さない場合は `false` を返します。

使用例

次の例は、次の入力が有効な期間を示すかどうかを調べます。

isDuration('PT30M')
isDuration('2012-02')

そして、それぞれ次の結果を返します。

true
false

isFloat

指定した入力が浮動小数点数の場合は true を返します。 C# と JavaScript の連携により、剰余 1 の残り 0 以外を含む数値は、浮動小数点数として扱われます。

isFloat('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	任意	テスト対象の入力

戻り値	Type	説明
<Boolean-result>	Boolean	指定した入力が浮動小数点数の場合は `true` を返し、入力が浮動小数点数でない場合は `false` を返します。

使用例

次の例は、入力が浮動小数点数かどうかを調べます。

isFloat('hello world!')
isFloat(1.0)
isFloat(12.01)

そして、それぞれ次の結果を返します。

入力が文字列なので、関数は false を返します。
入力には 0 と等しい剰余が含まれるため、関数は false を返します。
入力は浮動小数点数であるため、関数は true を返します。

isInteger

指定した入力が整数の場合は true を返します。 C# と JavaScript の連携により、剰余 1 の残り 0 を含む数値は、整数として扱われます。

isInteger('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	任意	テスト対象の入力

戻り値	Type	説明
<Boolean-result>	Boolean	入力が整数であることを示します

使用例

次の例は、入力が整数かどうかを調べます。

isInteger('hello world!')
isInteger(1.0)
isInteger(12)

そして、それぞれ次の結果を返します。

入力が文字列なので、関数は false を返します。
入力には 0 と等しい剰余が含まれるため、関数は true を返します。
入力が整数なので、関数は true を返します。

isMatch

指定した文字列が、指定した正規表現パターンに一致する場合は true を返します。

isMatch('<target**string>', '<pattern>')

パラメーター	必須	タイプ	説明
<targetstring>	はい	string	一致する文字列
<pattern>	はい	string	正規表現パターン

戻り値	Type	説明
<Boolean-result>	Boolean	指定した文字列が、共通の正規表現パターンに一致する場合は `true` を返し、このパターンに一致しない場合は `false` を返します。

使用例

次の例は、入力が、指定した正規表現パターンと一致するかどうかを調べます。

isMatch('ab', '^[a-z]{1,2}$')
isMatch('FUTURE', '(?i)fortune|future')
isMatch('12abc34', '([0-9]+)([a-z]+)([0-9]+)')
isMatch('abacaxc', 'ab.*?c')

そして、同じ結果である true を返します。

isObject

指定した入力が複合オブジェクトの場合は true を返し、プリミティブオブジェクトの場合は false を返します。プリミティブオブジェクトには、文字列、数値、ブール値が含まれます。複合型 (クラスなど) には、プロパティが含まれます。

isObject('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	任意	テスト対象の入力

戻り値	Type	説明
<Boolean-result>	Boolean	指定した入力が複合オブジェクトの場合は `true` を返し、プリミティブオブジェクトの場合は `false` を返します。

使用例

次の例は、指定した入力がオブジェクトかどうかを調べます。

isObject('hello world!')
isObject({userName: "Sam"})

そして、それぞれ次の結果を返します。

入力が文字列なので、関数は false を返します。
入力がオブジェクトなので、関数は true を返します。

isPresent

指定した TimexProperty または Timex 式が現在を示す場合は true を返します。

isPresent('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	オブジェクトまたは文字列	入力 TimexProperty オブジェクト、Timex 式の文字列

戻り値	Type	説明
<boolean-result>	Boolean	入力が現在を示す場合は `true` を返し、現在を示さない場合は false を返します。

"例" validNow = new TimexProperty() { Now = true } という TimexProperty オブジェクトがあり、Now プロパティを true に設定しているとします。次の例は、次の入力が現在を示すかどうかを調べます。

isPresent('PT30M')
isPresent(validNow)

そして、それぞれ次の結果を返します。

false
true

isString

指定した入力が文字列の場合は true を返します。

isString('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	任意	テスト対象の入力

戻り値	Type	説明
<Boolean-result>	Boolean	指定した入力が文字列の場合は `true` を返し、文字列でない場合は `false` を返します。

使用例

次の例は、指定した入力が文字列かどうかを調べます。

isString('hello world!')
isString(3.14)

そして、それぞれ次の結果を返します。

入力が文字列なので、関数は true を返します。
入力が float なので、関数は false を返します。

isTime

指定した TimexProperty または Timex 式が有効な時刻を示す場合は true を返します。有効な時刻には、時間、分、秒が含まれます。

isTime('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	オブジェクトまたは文字列	入力 TimexProperty オブジェクト、Timex 式の文字列

戻り値	Type	説明
<boolean-result>	Boolean	入力が有効な時刻を示す場合は `true` を返し、入力が有効な時刻を示さない場合は `false` を返します。

使用例

これらの例は、次の入力が有効な時刻を示すかどうかを調べます。

isTime('PT30M')
isTime('2012-02-21T12:30:45')

そして、それぞれ次の結果を返します。

false
true

isTimeRange

指定した TimexProperty または Timex 式が有効な時間の範囲を示す場合は true を返します。有効な時間の範囲には、partOfDay が含まれます。

isTime('<input>')

パラメーター	必須	タイプ	説明
<input>	はい	オブジェクトまたは文字列	入力 TimexProperty オブジェクト、Timex 式の文字列。

戻り値	Type	説明
<boolean-result>	Boolean	入力が有効な時間の範囲を示す場合は `true` を返し、入力が有効な時間の範囲を示さない場合は `false` を返します。

使用例

validTimeRange = new TimexProperty() { PartOfDay = "morning" } という TimexProperty オブジェクトがあり、Now プロパティを true に設定しているとします。これらの例は、次の入力が有効な時間の範囲かどうかを調べます。

isTimeRange('PT30M')
isTimeRange(validTimeRange)

そして、それぞれ次の結果を返します。

false
true

join

配列のすべての項目が含まれており、各文字が "区切り記号" で区切られた文字列を返します。

join([<collection>], '<delimiter>')

パラメーター	必須	タイプ	説明
<collection>	はい	array	結合する項目を含む配列
<delimiter>	はい	string	結果の文字列内の各文字の間に挿入される区切り記号

戻り値	Type	説明
<char1><delimiter><char2><delimiter>...	string	指定した配列内のすべての項目から作成された結果の文字列

例

この例は、指定した文字 . で区切られた、次の配列のすべての項目を含む文字列を作成します。

join(createArray('a', 'b', 'c'), '.')

そして、a.b.c という結果が返されます。

jPath

パス式に一致するノードまたは値があるかどうかについて JSON または JSON 文字列を調べて、一致するノードを返します。

jPath(<json>, '<path>')

パラメーター	必須	タイプ	説明
<json>	はい	任意	パス式の値に一致するノードまたは値を検索する JSON オブジェクトまたは文字列
<path>	はい	任意	一致する JSON ノードまたは値の検索に使用するパス式

戻り値	Type	説明
[ <json-node>]	配列	指定したパス式と一致する JSON ノードまたは値の一覧

"C# の例"

次の JSON があるとします。

{
    "Stores": [
        "Lambton Quay",
        "Willis Street"
    ],
    "Manufacturers": [
        {
            "Name": "Acme Co",
            "Products": [
                {
                    "Name": "Anvil",
                    "Price": 50
                }
            ]
        },
        {
            "Name": "Contoso",
            "Products": [
                {
                    "Name": "Elbow Grease",
                    "Price": 99.95
                },
                {
                    "Name": "Headlight Fluid",
                    "Price": 4
                }
            ]
        }
    ]
}

パス式は、$..Products[?(@.Price >= 50)].Name です。

jPath(jsonStr, path)

そして、["Anvil", "Elbow Grease"] という結果を返します。

Javascript の例

次の JSON があるとします。

{
    "automobiles": [
        {
            "maker": "Nissan",
            "model": "Teana",
            "year": 2011
        },
        {
            "maker": "Honda",
            "model": "Jazz",
            "year": 2010
        },
        {
            "maker": "Honda",
            "model": "Civic",
            "year": 2007
        },
        {
            "maker": "Toyota",
            "model": "Yaris",
            "year": 2008
        },
        {
            "maker": "Honda",
            "model": "Accord",
            "year": 2011
        }
    ],
    "motorcycles": [
        {
            "maker": "Honda",
            "model": "ST1300",
            "year": 2012
        }
    ]
}

パス式は .automobiles{.maker === "Honda" && .year > 2009}.model です。

jPath(jsonStr, path)

そして、['Jazz', 'Accord'] という結果を返します。

json

文字列または XML の JSON (JavaScript Object Notation) 型の値またはオブジェクトを返します。

json('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	文字列または XML	変換する文字列または XML

戻り値	Type	説明
<JSON-result>	string	指定した文字列または XML から作成された結果の JSON オブジェクト。

例 1

この例では、文字列が JSON に変換されます。

json('{"fullName": "Sophia Owen"}')

そして、結果が返されます。

{
  "fullName": "Sophia Owen"
}

例 2

この例では、XML が JSON に変換されます。

json(xml('<?xml version="1.0"?> <root> <person id='1'> <name>Sophia Owen</name> <occupation>Engineer</occupation> </person> </root>'))

そして、結果が返されます。

{
   "?xml": { "@version": "1.0" },
   "root": {
      "person": [ {
         "@id": "1",
         "name": "Sophia Owen",
         "occupation": "Engineer"
      } ]
   }
}

jsonStringify

値の JSON 文字列を返します。

パラメーター	必須	タイプ	説明
<value>	はい	オブジェクト	JSON 文字列に変換するオブジェクト

戻り値	Type	説明
<JSON-result>	string	結果の JSON 文字列。

使用例

これらの例は、JSON 文字列に変換されたオブジェクトを示しています。

jsonStringify(null)
jsonStringify({a:'b'})

そして、それぞれ次の文字列の結果を返します。

[Null]
{"a":"b"}

last

コレクションから最後の項目を返します。

last('<collection>')
last([<collection>])

パラメーター	必須	タイプ	説明
<collection>	はい	文字列または配列	最後の項目を検索するコレクション

戻り値	Type	説明
<last-collection-item>	それぞれ、文字列または配列	コレクション内の最後の項目

例

これらの例は、以下のコレクション内の最後の項目を検索します。

last('abcd')
last(createArray(0, 1, 2, 3))

そして、それぞれ次の結果を返します。

lastIndexOf

部分文字列の最後の出現箇所の開始位置またはインデックス値を返します。この関数は、大文字と小文字を区別せず、インデックスは値 0 から始まります。

lastIndexOf('<text>', '<searchText>')

パラメーター	必須	タイプ	説明
<text>	はい	文字列または配列	検索する部分文字列を含む文字列
<searchText>	はい	string	検索する部分文字列

戻り値	Type	説明
<ending-index-value>	integer	指定した部分文字列の最後の出現箇所の開始位置またはインデックス値。文字列が見つからない場合は、値 -1 を返します。

例 1

この例では、文字列 hello world の部分文字列 world の最後の出現箇所の開始インデックス値が検索されます。

lastIndexOf('hello world', 'world')

そして、6 という結果が返されます。

例 2

この例では、配列 ['abc', 'def', 'ghi', 'def'] の部分文字列 def の最後の出現箇所の開始インデックス値が検索されます。

lastIndexOf(createArray('abc', 'def', 'ghi', 'def'), 'def')

そして、3 という結果が返されます。

length

文字列の長さを返します。

length('<str>')

パラメーター	必須	タイプ	説明
<str>	はい	string	長さを計算する文字列

戻り値	Type	説明
<length>	integer	この文字列の長さ

使用例

これらの例は、文字列の長さを取得します。

length('hello')
length('hello world')

そして、それぞれ次の結果を返します。

less

1 番目の値が 2 番目の値より小さいかどうかを調べます。 1 番目の値の方が小さい場合は true を返し、1 番目の値の方が大きい場合は false を返します。

less(<value>, <compareTo>)
less('<value>', '<compareTo>')

パラメーター	必須	タイプ	説明
<value>	はい	整数、浮動小数点数、文字列	2 番目の値より小さいかどうかを調べる 1 番目の値
<compareTo>	はい	それぞれ、整数、浮動小数点数、文字列	比較する項目

戻り値	Type	説明
true または false	Boolean	1 番目の値が 2 番目の値より小さい場合は `true` を返します。 1 番目の値が 2 番目の値以上の場合は `false` を返します。

使用例

これらの例は、1 番目の値が 2 番目の値より小さいかどうかを調べます。

less(5, 10)
less('banana', 'apple')

そして、それぞれ次の結果を返します。

true
false

lessOrEquals

1 番目の値が 2 番目の値以下かどうかを調べます。 1 番目の値の方が小さいか等しい場合は true を返し、1 番目の値の方が大きい場合は false を返します。

lessOrEquals(<value>, <compareTo>)
lessOrEquals('<value>', '<compareTo>')

パラメーター	必須	タイプ	説明
<value>	はい	整数、浮動小数点数、文字列	2 番目の値以下かどうかを調べる 1 番目の値。
<compareTo>	はい	それぞれ、整数、浮動小数点数、文字列	比較する項目

戻り値	Type	説明
true または false	Boolean	1 番目の値が 2 番目の値以下の場合は `true` を返します。 1 番目の値が 2 番目の値より大きい場合は `false` を返します。

例

これらの例は、1 番目の値が 2 番目の値以下かどうかを調べます。

lessOrEquals(10, 10)
lessOrEquals('apply', 'apple')

そして、それぞれ次の結果を返します。

true
false

最大

一覧または配列から最大値を返します。一覧または配列には、両端が含まれます。

max(<number1>, <number2>, ...)
max([<number1>, <number2>, ...])

パラメーター	必須	タイプ	説明
<number1>, <number2>, ...	はい	数値	最大値を取得する数値のセット
[<number1>, <number2>, ...]	はい	数値の配列	最大値を取得する数値の配列

戻り値	Type	説明
<max-value>	数値	指定した配列内または数値セット内で最大の値

使用例

これらの例は、数値のセットと配列から最大値を取得します。

max(1, 2, 3)
max(createArray(1, 2, 3))

そして、3 という結果を返します。

merge

複数の JSON オブジェクトまたはオブジェクトの配列を結合します。

merge(<json1>, <json2>, ...)

パラメーター	必須	タイプ	説明
<json1>、 <json2>、...	はい	オブジェクトまたは配列	結合する JSON オブジェクトまたは配列のセット。

戻り値	Type	説明設定
<result>	オブジェクト	連結された JSON オブジェクトまたは連結された配列オブジェクト。

使用例

次の JSON オブジェクトがあるとします。

json1 = @"{
            'FirstName': 'John',
            'LastName': 'Smith',
            'Enabled': false,
            'Roles': [ 'User' ]
          }"
json2 =@"{
            'Enabled': true,
            'Roles': [ 'User', 'Admin' ]
          }"

この例では、JSON オブジェクトをマージします。

string(merge(json(json1), json(json2)))

そして、結果のオブジェクト {"FirstName":"John","LastName":"Smith","Enabled":true,"Roles":["User","Admin"]} を返します。

たとえば、オブジェクトとオブジェクトのリストを組み合わせたいとします。次の例では、JSON オブジェクトとオブジェクトの配列を連結します。

merge({k1:'v1'}, [{k2:'v2'}, {k3: 'v3'}], {k4:'v4'})

次に、オブジェクト { "k1": "v1"、"k2": "v2"、"k3": "v3"、"k4": "v4" } を返します。

最小

数値のセットまたは配列から最小の値を返します。

min(<number1>, <number2>, ...)
min([<number1>, <number2>, ...])

パラメーター	必須	タイプ	説明
<number1>, <number2>, ...	はい	数値	最小値を取得する数値のセット
[<number1>, <number2>, ...]	はい	数値の配列	最小値を取得する数値の配列

戻り値	Type	説明
<min-value>	数値	指定した配列内または数値セット内の最小値

使用例

これらの例は、数値のセットと配列で最小の値を取得します。

min(1, 2, 3)
min(createArray(1, 2, 3))

そして、1 という結果を返します。

mod

2 つの数値を除算した剰余を返します。整数の結果を取得するには、div() をご覧ください。

mod(<dividend>, <divisor>)

パラメーター	必須	タイプ	説明
<dividend>	はい	数値	divisor によって除算される値。
<divisor>	はい	数値	dividend を除算する値。 0 にすることはできません。

戻り値	Type	説明
<modulo-result>	数値	1 番目の数値を 2 番目の数値で除算した剰余

例

この例は、1 番目の数値を 2 番目の数値で除算します。

mod(3, 2)

そして、1 という結果が返されます。

月

指定したタイムスタンプの月を返します。

month('<timestamp>')

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。

戻り値	Type	説明
<number-of-month>	integer	指定したタイムスタンプの月の番号

例

month('2018-03-15T13:01:00.000Z')

そして、3 という結果を返します。

mul

2 つの数値を乗算した積を返します。

mul(<multiplicand1>, <multiplicand2>)

パラメーター	必須	タイプ	説明
<multiplicand1>	はい	整数または浮動小数点数	multiplicand2 と乗算する値
<multiplicand2>	はい	整数または浮動小数点数	multiplicand1 と乗算する値

戻り値	Type	説明
<product-result>	整数または浮動小数点数	1 番目の数値と 2 番目の数値を乗算した積

使用例

これらの例は、1 番目の数値と 2 番目の数値を乗算します。

mul(1, 2)
mul(1.5, 2)

そして、それぞれ次の結果を返します。

newGuid

新しい Guid 文字列を返します。

newGuid()

戻り値	Type	説明
<Guid-string>	string	新しい Guid 文字列であり、長さは 36 で、xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx のように表されます

例

newGuid()

そして、xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx の形式に従って結果を返します。

not

式が false かどうかを調べます。式が false の場合は true を返し、true の場合は false を返します。

not(<expression>)

パラメーター	必須	タイプ	説明
<expression>	はい	Boolean	調べる式。

戻り値	Type	説明
true または false	Boolean	式が false の場合は `true` を返します。式が true の場合は `false` を返します。

例 1

これらの例は、指定した式が false かどうかを調べます。

not(false)
not(true)

そして、それぞれ次の結果を返します。

式が false なので、関数は true を返します。
式が true なので、関数は false を返します。

例 2

これらの例は、指定した式が false かどうかを調べます。

not(equals(1, 2))
not(equals(1, 1))

そして、それぞれ次の結果を返します。

式が false なので、関数は true を返します。
式が true なので、関数は false を返します。

または

少なくとも 1 つの式が true かどうかを調べます。少なくとも 1 つの式が true の場合は true を返し、すべての式が false の場合は false を返します。

or(<expression1>, <expression2>, ...)

パラメーター	必須	タイプ	説明
<expression1>, <expression2>, ...	はい	Boolean	調べる式

戻り値	Type	説明
true または false	Boolean	少なくとも 1 つの式が true の場合は `true` を返します。すべての式が false の場合は `false` を返します。

例 1

これらの例は、少なくとも 1 つの式が true かどうかを調べます。

or(true, false)
or(false, false)

そして、それぞれ次の結果を返します。

少なくとも 1 つの式が true なので、関数は true を返します。
両方の式が false なので、関数は false を返します。

例 2

これらの例は、少なくとも 1 つの式が true かどうかを調べます。

or(equals(1, 1), equals(1, 2))
or(equals(1, 2), equals(1, 3))

そして、それぞれ次の結果を返します。

少なくとも 1 つの式が true なので、関数は true を返します。
両方の式が false なので、関数は false を返します。

rand

指定した範囲からランダムな整数を返します。開始側の端のみを含みます。

rand(<minValue>, <maxValue>)

パラメーター	必須	タイプ	説明
<minValue>	はい	integer	範囲に含まれる最小の整数
<maxValue>	はい	integer	関数が返すことのできる範囲内で最も大きい整数の次の整数

戻り値	Type	説明
<random-result>	integer	指定した範囲から返されるランダムな整数

例

この例は、指定した範囲 (最大値は除きます) からランダムな整数を取得します。

rand(1, 5)

そして、結果として 1、2、3、または 4 を返します。

range

指定した整数から始まる整数の配列を返します。

range(<startIndex>, <count>)

パラメーター	必須	タイプ	説明
<startIndex>	はい	integer	最初の項目として配列を開始する整数値
<count>	はい	integer	配列内の整数の数

戻り値	Type	説明
<range-result>	integer	指定したインデックスから始まる整数の配列

例

この例では、指定したインデックス 1 から始まり、指定した整数の数 4 を含む、整数の配列が作成されます。

range(1, 4)

そして、[1, 2, 3, 4] という結果が返されます。

removeProperty

オブジェクトからプロパティを削除し、更新されたオブジェクトを返します。

removeProperty(<object>, '<property>')

パラメーター	必須	タイプ	内容
<object>	はい	オブジェクト	プロパティを削除する JSON オブジェクト
<property>	はい	string	削除するプロパティの名前

戻り値	Type	説明
<updated-object>	オブジェクト	指定したプロパティを含まない更新された JSON オブジェクト

例

この例では、customerProfile オブジェクトから accountLocation プロパティを削除し、json() 関数で JSON に変換された後、更新されたオブジェクトが返されます。

removeProperty(json('customerProfile'), 'accountLocation')

replace

部分文字列を指定した文字列で置換し、結果の文字列を返します。この関数は、大文字と小文字を区別します。

replace('<text>', '<oldText>', '<newText>')

パラメーター	必須	タイプ	説明
<text>	はい	string	置換する部分文字列を含む文字列
<oldText>	はい	string	置換前の部分文字列
<newText>	はい	string	置換後の文字列

戻り値	Type	説明
<updated-text>	string	部分文字列を置換した後の更新された文字列。部分文字列が見つからない場合、関数は元の文字列を返します。

例 1

この例では、文字列 the old string の部分文字列 old を検索し、old が new に置換されます。

replace('the old string', 'old', 'new')

結果は、文字列 the new string になります。

例 2

エスケープ文字を処理する場合、式エンジンでは非エスケープが処理されます。この関数は、文字列をエスケープ文字に置換します。

replace('hello\"', '\"', '\n')
replace('hello\n', '\n', '\\\\')
@"replace('hello\\', '\\', '\\\\')"
@"replace('hello\n', '\n', '\\\\')"

そして、それぞれ次の結果を返します。

hello\n
hello\\
@"hello\\"
@"hello\\"

replaceIgnoreCase

部分文字列を指定した文字列で置換し、結果の文字列を返します。この関数では、大文字と小文字が区別されません。

replaceIgnoreCase('<text>', '<oldText>', '<newText>')

パラメーター	必須	タイプ	説明
<text>	はい	string	置換する部分文字列を含む文字列
<oldText>	はい	string	置換前の部分文字列
<newText>	はい	string	置換後の文字列

戻り値	Type	説明
<updated-text>	string	部分文字列を置換した後の更新された文字列。部分文字列が見つからない場合は、元の文字列を返します。

例

この例では、文字列 the old string の部分文字列 old を検索し、old が new に置換されます。

replace('the old string', 'old', 'new')

そして、the new string という結果が返されます。

解決

有効な時刻を参照している場合は、指定された TimexProperty または Timex 式の文字列を返します。有効な時刻には、時間、分、秒が含まれます。

resolve('<timestamp')

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。

戻り値	Type	説明
<return>	string	評価された TimexProperty または Timex 式の文字列。

使用例

これらの例は、指定された文字列が有効な時刻を参照しているかどうかを示しています。

resolve(T14)
resolve(2020-12-20)
resolve(2020-12-20T14:20)

そして、それぞれ次の結果を返します。

14:00:00
2020-12-20
2020-12-20 14:20:00

リバース

文字列または配列内の要素の順序を反転させます。

reverse(<value>)

パラメーター	必須	タイプ	説明
<value>	はい	文字列または配列	反転する配列の文字列。

戻り値	Type	説明
<return>	文字列または配列	文字列または配列の反転された要素。

使用例

これらの例では、文字列または配列の要素を逆にします。

reverse(hello)
reverse(concat(hello,world))

そして、それぞれ次の値を返します。

-文字列 olleh。 -文字列 dlrowolleh。

round

最も近い整数、または指定された小数点以下の桁数に値を丸めます。

round('<number>', '<precision-digits>')

パラメーター	必須	タイプ	Description
<number>	はい	数値	入力番号
<precision-digits>	いいえ	integer	指定された小数桁数。既定値は 0 です。

戻り値	Type	説明
<return-value>	数値	指定した小数部の桁数で丸められた入力の戻り値

例 1

この例では、数値 10.333 を丸めます。

round(10.333)

そして、数値 10 を返します。

例 2

この例では、数値 10.3313 を 2 桁の小数部に丸めます。

round(10.3313, 2)

そして、数値 10.33 を返します。

SELECT…

各要素を演算し、変換された要素の新しいコレクションを返します。

select([<collection/instance>], <iteratorName>, <function>)

パラメーター	必須	タイプ	説明
<collection/instance>	はい	array	項目を含むコレクション
<iteratorName>	はい	反復子名	キー項目
<function>	はい	式 (expression)	`iteratorName` を含めることができる関数

戻り値	Type	説明
<new-collection>	配列	各要素が関数によって評価された新しいコレクション

例 1

この例では、新しいコレクションが生成されます。

select(createArray(0, 1, 2, 3), x, x + 1)

そして、[1, 2, 3, 4] という結果が返されます。

例 2

これらの例では、新しいコレクションが生成されます。

select(json("{'name': 'jack', 'age': '15'}"), x, concat(x.key, ':', x.value))
select(json("{'name': 'jack', 'age': '15'}"), x=> concat(x.key, ':', x.value))

sentenceCase

省略可能なロケール形式で、文字列内の最初の単語の最初の文字を大文字にします。

sentenceCase('<text>', '<locale>'?)

パラメーター	必須	タイプ	説明
<text>	はい	string	元の文字列。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
結果文字列	string	文の大文字と小文字の結果を返します

例 1

次の例では、文字列の最初の文字を大文字にします。

sentenceCase('a')
sentenceCase('abc def')
sentenceCase('aBC dEF')

そして、それぞれ次の結果を返します。

A
Abc def
Abc def

例 2

次の例では、指定したロケール形式の文字列の最初の文字を大文字にします。

sentenceCase('a', 'fr-FR')
sentenceCase('abc', 'en-US')
sentenceCase('aBC', 'fr-FR')

そして、それぞれ次の結果を返します。

A
Abc
Abc

setPathToValue

指定したプロパティの値を JSON オブジェクトから取得します。

setPathToValue(<path>, <value>)

パラメーター	必須	タイプ	説明
<Path>	はい	オブジェクト	設定するパス
<value>	はい	オブジェクト	パスに設定する値

戻り値	Type	説明
value	オブジェクト	設定される値

例 1

次の例は、値 1 をパスに設定します。

setPathToValue(path.x, 1)

そして、1 という結果が返されます。 path.x は 1 に設定されます。

例 2

次の例は、値を設定します。

setPathToValue(path.array[0], 7) + path.array[0]

そして、14 という結果を返します。

setProperty

オブジェクトのプロパティの値を設定し、更新されたオブジェクトを返します。新しいプロパティを追加するには、この関数、または addProperty() 関数を使用します。

setProperty(<object>, '<property>', <value>)

パラメーター	必須	タイプ	内容
<object>	はい	オブジェクト	プロパティを設定する JSON オブジェクト
<property>	はい	string	設定するプロパティの名前
<value>	はい	任意	指定したプロパティに設定する値

戻り値	Type	説明
<updated-object>	オブジェクト	プロパティが設定された更新後の JSON オブジェクト

例

この例では、customerProfile オブジェクトの accountNumber プロパティが設定されます。オブジェクトは、json() 関数で JSON に変換されます。この関数は、newGuid() 関数によって生成された値を代入し、更新された JSON オブジェクトを返します。

setProperty(json('customerProfile'), 'accountNumber', newGuid())

skip

コレクションの先頭から項目を削除し、"他のすべて" の項目を返します。

skip([<collection>], <count>)

パラメーター	必須	タイプ	説明
<collection>	はい	array	項目を削除するコレクション
<count>	はい	integer	先頭から削除する項目の数を示す正の整数

戻り値	Type	説明
<updatedCollection>	配列	指定した項目を削除した後の更新されたコレクション

例

この例では、指定した配列の先頭から 1 つの項目 (番号 1) が削除されます。

skip(createArray(0, 1, 2, 3), 1)

そして、残りの項目を含む配列 [1,2,3] が返されます。

sortBy

コレクション内の要素を昇順に並べ替え、並べ替えられたコレクションを返します。

sortBy([<collection>], '<property>')

パラメーター	必須	タイプ	説明
<collection>	はい	文字列または配列	並べ替えるコレクション
<property>	いいえ	string	設定されている場合は、コレクション内のオブジェクト要素の特定のプロパティで並べ替えます

戻り値	Type	説明
<new-collection>	配列	要素が並べ替えられた新しいコレクション

例 1

この例では、次のコレクションの並べ替えが生成されます。

sortBy(createArray(1, 2, 0, 3))

そして、[0, 1, 2, 3] という結果を返します。

例 2

次のコレクションがあるとします。

{
  'nestedItems': [
    {'x': 2},
    {'x': 1},
    {'x': 3}
  ]
}

この例では、x オブジェクトプロパティに基づいて、並べ替えられた新しいコレクションが生成されます。

sortBy(nestedItems, 'x')

そして、結果が返されます。

{
  'nestedItems': [
    {'x': 1},
    {'x': 2},
    {'x': 3}
  ]
}

sortByDescending

コレクション内の要素を降順に並べ替え、並べ替えられたコレクションを返します。

sortBy([<collection>], '<property>')

パラメーター	必須	タイプ	説明
<collection>	はい	文字列または配列	並べ替えるコレクション
<property>	いいえ	string	設定されている場合は、コレクション内のオブジェクト要素の特定のプロパティで並べ替えます

戻り値	Type	説明
<new-collection>	配列	要素が並べ替えられた新しいコレクション

例 1

この例では、並べ替えられた新しいコレクションが生成されます。

sortByDescending(createArray(1, 2, 0, 3))

そして、[3, 2, 1, 0] という結果を返します。

例 2

次のコレクションがあるとします。

{
  'nestedItems': [
    {'x': 2},
    {'x': 1},
    {'x': 3}
  ]
}

この例では、x オブジェクトプロパティに基づいて、並べ替えられた新しいコレクションが生成されます。

sortByDescending(nestedItems, 'x')

返される結果:

{
  'nestedItems': [
    {'x': 3},
    {'x': 2},
    {'x': 1}
  ]
}

split

元の文字列で指定された区切り文字に基づいて、コンマで区切られた部分文字列を含む配列を返します。

split('<text>', '<delimiter>'?)

パラメーター	必須	タイプ	説明
<text>	はい	string	元の文字列で指定した区切り記号に基づいて部分文字列に分割する文字列。テキストが null 値の場合は、空の文字列として取得されます。
<delimiter>	いいえ	string	区切り記号として使用する、元の文字列内の文字。区切り記号が指定されていない場合、または区切り記号が null 値の場合、既定値は空の文字列になります。

戻り値	Type	説明
[<substring1>,<substring2>,...]	配列	コンマで区切られた、元の文字列からの部分文字列を含む配列

使用例

これらの例では、指定した区切り記号の文字に基づいて、指定した文字列から部分文字列を含む配列を作成します。

split('a**b**c', '**')
split('hello', '')
split('', 'e')
split('', '')
split('hello')

そして、それぞれ次の配列を結果として返します。

["a", "b", "c"]
["h", "e", "l", "l", "o"]
["h", "e", "l", "l", "o"]

sqrt

指定された数値の平方根を返します。

sqrt(<number>)

パラメーター	必須	タイプ	Description
<number>	はい	数値	平方根を取得する数値

戻り値	Type	説明設定
<result>	数値	平方根を計算した結果。

使用例

これらの例では、次の指定した数値の平方根を計算します。

sqrt(9)
sqrt(0)

そして、それぞれ次の結果を返します。

startOfDay

省略可能なロケール形式でタイムスタンプの開始日を返します。

startOfDay('<timestamp>', '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
'<updated-timestamp>'	string	指定したタイムスタンプの日の午前 0 時を表す日時文字列

例 1

この例では、その日の開始が取得されます。

startOfDay('2018-03-15T13:30:30.000Z')

そして、2018-03-15T00:00:00.000Z という結果が返されます。

例 2

次の例では、ロケール fr-FR で日の開始を検索します。

startOfDay('2018-03-15T13:30:30.000Z', '', 'fr-FR')

そして、15/03/2018 00:00:00 という結果を返します。

startOfHour

省略可能なロケール形式でタイムスタンプの開始時間を返します。

startOfHour('<timestamp>', '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
'<updated-timestamp>'	string	指定したタイムスタンプの日の午前 0 時 00 分を表す日時文字列

例 1

この例では、その時刻の開始が取得されます。

startOfHour('2018-03-15T13:30:30.000Z')

そして、2018-03-15T13:00:00.000Z という結果が返されます。

例 2

次の例では、ロケール fr-FR を使用して時間の開始を検索します。

startOfHour('2018-03-15T13:30:30.000Z', '', 'fr-FR')

そして、15/03/2018 13:00:00 という結果を返します。

startOfMonth

省略可能なロケール形式でタイムスタンプの開始月を返します。

startOfMonth('<timestamp>', '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
'<updated-timestamp>'	string	指定したタイムスタンプの月の最初の日の午前 0 時を表す文字列

例 1

この例では、その月の開始が取得されます。

startOfMonth('2018-03-15T13:30:30.000Z')

そして、2018-03-01T00:00:00.000Z という結果が返されます。

例 2

この例では、ロケール fr-FR で開始月を検索します。

startOfMonth('2018-03-15T13:30:30.000Z', '', 'fr-FR')

そして、01/03/2018 00:00:00 という結果を返します。

startsWith

文字列が特定の部分文字列で始まっているかどうかを調べます。部分文字列が見つかった場合は true を返し、見つからない場合は false を返します。この関数では、大文字と小文字が区別されません。

startsWith('<text>', '<searchText>')

パラメーター	必須	タイプ	説明
<text>	はい	string	調べる文字列。
<searchText>	はい	string	検索する先頭の部分文字列

戻り値	Type	説明
true または false	Boolean	先頭の部分文字列が見つかった場合は `true` を返します。見つからない場合は `false` を返します。

例 1

この例では、文字列 hello world が文字列 hello で始まっているかどうかが調べられます。

startsWith('hello world', 'hello')

そして、true という結果が返されます。

例 2

この例では、文字列 hello world が文字列 greeting で始まっているかどうかが調べられます。

startsWith('hello world', 'greeting')

そして、false という結果が返されます。

string

省略可能なロケール形式で値の文字列バージョンを返します。

string(<value>, '<locale>'?)

パラメーター	必須	タイプ	説明
<value>	はい	任意	変換する値
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<string-value>	string	指定した値の文字列バージョン

例 1

この例では、数値 10 の文字列バージョンが作成されます。

string(10)

そして、10 という文字列の結果が返されます。

例 2

この例では、指定した JSON オブジェクトの文字列が作成され、二重引用符 (") のエスケープ文字として、バックスラッシュ文字 (\\) が使われます。

string( { "name": "Sophie Owen" } )

そして、結果 { "name": "Sophie Owen" } を返します。

例 3

次の例では、特定のロケールで数値 10 の文字列バージョンを作成します。

string(100.1, 'fr-FR')
string(100.1, 'en-US')

そして、次の文字列をそれぞれ返します。

100,1
100.1

stringOrValue

文字列補間をラップして実際の値を取得します。たとえば、stringOrValue('${1}') は数値 1 を返し、 stringOrValue('${1} item') は文字列 "1 item" を返します。

stringOrValue(<string>)

パラメーター	必須	タイプ	説明
<string>	はい	string	実際の値を取得する文字列。

戻り値	Type	説明設定
<result>	任意	指定した文字列の実際の値を取得した結果。

使用例

これらの例では、文字列から実際の値を取得します。

stringOrValue('${one}')
stringOrValue('${one} item')

そして、それぞれ次の結果を返します。

数値 1.0。
文字列 1 項目。

sub

1 番目の数値から 2 番目の数値を減算して、結果を返します。

sub(<minuend>, <subtrahend>)

パラメーター	必須	タイプ	説明
<minuend>	はい	数値	subtrahend を引く数値
<subtrahend>	はい	数値	minuend から引く数値

戻り値	Type	説明設定
<result>	数値	1 番目の数値から 2 番目の数値を減算した結果

例

この例は、1 番目の数値から 2 番目の数値を減算します。

sub(10.3, .3)

そして、10 という結果を返します。

subArray

指定した開始位置と終了位置から部分配列を返します。インデックス値は 0 から始まります。

subArray(<Array>, <startIndex>, <endIndex>)

パラメーター	必須	タイプ	説明
<array>	はい	array	部分配列の作成元となる配列
<startIndex>	はい	integer	開始位置またはインデックス値として使用する 0 以上の正の数
<endIndex>	はい	integer	終了位置またはインデックス値として使用する 0 以上の正の数

戻り値	Type	説明
<subarray-result>	配列	ソース文字列で指定したインデックス位置から始まる、指定した項目数を含む部分配列

例

この例では、指定された配列から部分配列が作成されます。

subArray(createArray('H','e','l','l','o'), 2, 5)

そして、["l", "l", "o"] という結果が返されます。

substring

指定した位置またはインデックスから始まる、文字列から文字を返します。インデックス値は 0 から始まります。

substring('<text>', <startIndex>, <length>)

パラメーター	必須	タイプ	説明
<text>	はい	string	部分文字列の作成元となる文字列
<startIndex>	はい	integer	開始位置またはインデックス値として使用する部分配列 0 以上の正の数
<length>	はい	integer	部分文字列の正の数の文字の部分配列

戻り値	Type	説明
<substring-result>	string	ソース文字列の指定したインデックス位置から始まる、指定した文字数を含む部分文字列

例

この例は、指定した文字列のインデックス値 6 から始まる 5 文字を含む部分文字列を作成します。

substring('hello world', 6, 5)

そして、world という結果を返します。

subtractFromTime

省略可能なロケール形式でタイムスタンプから時間単位の数を減算します。 getPastTime() に関する記事も参照してください。

subtractFromTime('<timestamp>', <interval>, '<timeUnit>', '<format>'?, '<locale>'?)

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。
<interval>	はい	integer	減算する指定した時間単位の数
<timeUnit>	はい	string	interval と共に使用する時間単位。使用可能な単位は、"Second"、"Minute"、"Hour"、"Day"、"Week"、"Month"、"Year" です。
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<updated-timestamp>	string	タイムスタンプから指定した時間単位数を引いた値

例 1

この例では、次のタイムスタンプから 1 日が減算されます。

subtractFromTime('2018-01-02T00:00.000Z', 1, 'Day')

そして、2018-01-01T00:00:00.000Z という結果を返します。

例 2

この例では、D 形式を使用してタイムスタンプから 1 日を減算します。

subtractFromTime('2018-01-02T00:00.000Z', 1, 'Day', 'D')

2018 年 1 月 1 日月曜日の結果を返します。

例 3

次の例では、de-DE ロケールのタイムスタンプから 1 時間を減算します。

subtractFromTime('2018-03-15T13:00:00.000Z', 1, 'Hour', '', 'de-DE')

そして、15.03.18 12:00:00 という結果を返します。

sum

一覧で数値を加算した結果を返します。

sum([<list of numbers>])

パラメーター	必須	タイプ	説明
[<list of numbers>]	はい	数値の配列	加算する数値

戻り値	Type	説明
<result-sum>	数値	指定した数値を加算した結果

例

この例は、指定した数値を加算します。

sum(createArray(1, 1.5))

そして、2.5 という結果を返します。

take

コレクションの先頭から項目を返します。

take('<collection>', <count>)
take([<collection>], <count>)

パラメーター	必須	タイプ	説明
<collection>	はい	文字列または配列	項目を取得するコレクション
<count>	はい	integer	先頭から取得する項目の数を示す正の整数

戻り値	Type	説明
<subset> または [<subset>]	それぞれ文字列、配列	元のコレクションの先頭から取得された指定個数の項目を含む文字列または配列

例

これらの例は、次のコレクションの先頭から指定した数の項目を取得します。

take('abcde', 3)
take(createArray(0, 1, 2, 3, 4), 3)

そして、それぞれ次の結果を返します。

abc
[0, 1, 2]

ticks

指定したタイムスタンプのティックプロパティの値を返します。ティックは、100 ナノ秒の間隔です。

ticks('<timestamp>')

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプの文字列

戻り値	Type	説明
<ticks-number>	整数 (Javascript では bigint)	指定したタイムスタンプからのティック数

例

この例では、タイムスタンプをそのティックプロパティに変換します。

ticks('2018-01-01T08:00:00.000Z')

そして、636503904000000000 という結果を返します。

ticksToDays

ティックプロパティ値を日数に変換します。

ticksToDays('ticks')

パラメーター	必須	タイプ	説明
<ticks>	はい	integer	変換するティック・プロパティ値

戻り値	Type	説明
<number-of-days>	数値	ティックプロパティ値から換算された日数

例

この例では、ティックプロパティの値を日数に変換します。

ticksToDays(2193385800000000)

そして、数値 2538.64097222 を返します。

ticksToHours

ティックプロパティ値を時間数に変換します。

ticksToHours('ticks')

パラメーター	必須	タイプ	説明
<ticks>	はい	Integer	変換するティック・プロパティ値

戻り値	Type	説明
<number-of-hours>	数値	ティックプロパティ値から換算された時間数

例

この例では、ティックプロパティの値を時間数に変換します。

ticksToHours(2193385800000000)

そして、数値 60927.383333333331 を返します。

ticksToMinutes

ティックプロパティ値を分数に変換します。

ticksToMinutes('ticks')

パラメーター	必須	タイプ	説明
<ticks>	はい	integer	変換するティック・プロパティ値

戻り値	Type	説明
<number-of-minutes>	数値	ティックプロパティ値から換算された分数

例

この例では、ティックプロパティ値を分数に変換します。

ticksToMinutes(2193385800000000)

そして、数値 3655643.0185 を返します。

titleCase

省略可能なローカル形式で、文字列内の各単語の最初の文字を大文字にします。

titleCase('<text>', '<locale>'?)

パラメーター	必須	タイプ	説明
<text>	はい	string	元の文字列。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
結果文字列	string	タイトルケースの結果

例 1

次の例では、文字列内の各単語の最初の文字を大文字にします。

titleCase('a')
titleCase('abc def')
titleCase('aBC dEF')

そして、それぞれ次の結果を返します。

A
Abc Def
Abc Def

例 2

次の例では、en-US 形式の文字列の最初の文字を大文字にします。

titleCase('a', 'en-US')
titleCase('aBC dEF', 'en-US')

そして、それぞれ次の結果を返します。

A
Abc Def

toLower

省略可能なロケール形式で小文字の文字列を返します。文字列内の文字に小文字バージョンがない場合、その文字は返される文字列に変更されないまま残ります。

toLower('<text>', '<locale>'?)

パラメーター	必須	タイプ	説明
<text>	はい	string	小文字形式で返される文字列
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<lowercase-text>	string	元の文字列の小文字形式

例 1

この例では、文字列が小文字に変換されます。

toLower('Hello World')

そして、hello world という結果が返されます。

例 2

この例では、fr-FR 形式で文字列を小文字に変換します。

toUpper('Hello World', 'fr-FR')

そして、hello world という結果が返されます。

toUpper

省略可能なロケール形式で大文字の文字列を返します。文字列内の文字に大文字バージョンがない場合、その文字は返される文字列に変更されないまま残ります。

toUpper('<text>', '<locale>'?)

パラメーター	必須	タイプ	説明
<text>	はい	string	大文字形式で返される文字列
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<uppercase-text>	string	元の文字列の大文字形式

例 1

この例では、文字列が大文字に変換されます。

toUpper('Hello World')

そして、HELLO WORLD という結果が返されます。

例 2

次の例では、fr-FR 形式で文字列を大文字に変換します。

toUpper('Hello World', 'fr-FR')

そして、HELLO WORLD という結果が返されます。

trim

文字列から先頭と末尾の空白を削除し、更新された文字列を返します。

trim('<text>')

パラメーター	必須	タイプ	説明
<text>	はい	string	先頭と末尾に削除する空白を含む文字列

戻り値	Type	説明
<updatedText>	string	先頭または末尾の空白が削除された、元の文字列の更新バージョン

例

この例では、文字列 " Hello World " から先頭と末尾の空白が削除されます。

trim(' Hello World  ')

そして、トリミングして、Hello World という結果が返されます。

union

指定した複数のコレクションの "すべての" 項目を含む 1 つのコレクションを返します。この関数に渡されるいずれかのコレクションに含まれる項目は、結果にも含まれます。 1 つまたは複数の項目が同じ名前である場合は、その名前を持つ最後の項目が結果に含まれます。

union('<collection1>', '<collection2>', ...)
union([<collection1>], [<collection2>], ...)

パラメーター	必須	タイプ	説明
<collection1>, <collection2>, ...	はい	配列またはオブジェクト、ただし両方は不可	"すべての" 項目を取得するコレクション

戻り値	Type	説明
<updatedCollection>	それぞれ、配列またはオブジェクト	指定したコレクションのすべての項目を含むコレクション。重複はありません。

例

この例では、次のコレクションからすべての項目が取得されます。

union(createArray(1, 2, 3), createArray(1, 2, 10, 101))

そして、[1, 2, 3, 10, 101] という結果が返されます。

unique

配列からすべての重複を削除します。

unique([<collection>])

パラメーター	必須	タイプ	説明
<collection>	はい	array	変更するコレクション

戻り値	Type	説明
<new-collection>	配列	重複する要素が削除された新しいコレクション

例 1

この例では、次の配列から重複する要素が削除されます。

unique(createArray(1, 2, 1))

そして、[1, 2] という結果が返されます。

uriComponent

URI (Uniform Resource Identifier) コンポーネントのバイナリバージョンを返します。

uriComponent('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	URI エンコード形式に変換する文字列

戻り値	Type	説明
<encoded-uri>	string	エスケープ文字が使われている URI エンコード文字列

例

この例では、文字列の URI エンコードバージョンが作成されます。

uriComponent('https://contoso.com')

そして、http%3A%2F%2Fcontoso.com という結果が返されます。

uriComponentToString

URI (Uniform Resource Identifier) エンコード文字列の文字列バージョンを返します。実質的に、URI エンコード文字列をデコードします。

uriComponentToString('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	デコードする URI エンコード文字列

戻り値	Type	説明
<binary-for-encoded-uri>	string	URI エンコード文字列のデコードバージョン

例

この例では、URI エンコード文字列のデコード文字列バージョンが作成されます。

uriComponentToString('http%3A%2F%2Fcontoso.com')

そして、https://contoso.com という結果が返されます。

uriHost

URI (Unified Resource Identifier) のホストの値を返します。

uriHost('<uri>')

パラメーター	必須	タイプ	説明
<uri>	はい	string	必要なホストの値を含む URI

戻り値	Type	説明
<host-value>	string	指定した URI のホストの値

例

この例では、次の URI のホストの値が検索されます。

uriHost('https://www.localhost.com:8080')

そして、www.localhost.com という結果が返されます。

uriPath

URI (Unified Resource Identifier) のパスの値を返します。

uriPath('<uri>')

パラメーター	必須	タイプ	説明
<uri>	はい	string	必要なパスの値を含む URI

戻り値	Type	説明
<path-value>	string	指定した URI のパスの値

例

この例では、次の URI のパスの値が検索されます。

uriPath('http://www.contoso.com/catalog/shownew.htm?date=today')

そして、/catalog/shownew.htm という結果が返されます。

uriPathAndQuery

URI (Unified Resource Identifier) のパスとクエリの値を返します。

uriPathAndQuery('<uri>')

パラメーター	必須	タイプ	説明
<uri>	はい	string	必要なパスとクエリの値を含む URI

戻り値	Type	説明
<path-query-value>	string	指定した URI のパスとクエリの値

例

この例では、次の URI のパスとクエリの値が検索されます。

uriPathAndQuery('http://www.contoso.com/catalog/shownew.htm?date=today')

そして、/catalog/shownew.htm?date=today という結果が返されます。

uriPort

URI (Unified Resource Identifier) のポートの値を返します。

uriPort('<uri>')

パラメーター	必須	タイプ	説明
<uri>	はい	string	必要なパスの値を含む URI

戻り値	Type	説明
<port-value>	string	指定した URI のポートの値

例

この例では、次の URI のポートの値が検索されます。

uriPort('http://www.localhost:8080')

そして、8080 という結果が返されます。

uriQuery

URI (Unified Resource Identifier) のクエリの値を返します。

uriQuery('<uri>')

パラメーター	必須	タイプ	説明
<uri>	はい	string	必要なクエリの値を含む URI

戻り値	Type	説明
<query-value>	string	指定した URI のクエリの値

例

この例では、次の URI のクエリの値が検索されます。

uriQuery('http://www.contoso.com/catalog/shownew.htm?date=today')

そして、?date=today という結果が返されます。

uriScheme

URI (Unified Resource Identifier) のスキームの値を返します。

uriScheme('<uri>')

パラメーター	必須	タイプ	説明
<uri>	はい	string	必要なクエリの値を含む URI

戻り値	Type	説明
<scheme-value>	string	指定した URI のスキームの値

例

この例では、次の URI のスキームの値が検索されます。

uriQuery('http://www.contoso.com/catalog/shownew.htm?date=today')

そして、http という結果が返されます。

utcNow

現在のタイムスタンプを省略可能なロケール形式で文字列として返します。

utcNow('<format>', '<locale>'?)

必要に応じて、<format> パラメーターで異なる形式を指定できます。

パラメーター	必須	タイプ	説明
<format>	いいえ	string	カスタムの書式パターン。タイムスタンプの既定の形式は、ISO 8601 に準拠した UTC ISO 形式 (YYYY-MM-DDTHH:mm:ss.fffZ) です。
<locale>	いいえ	string	カルチャ情報の省略可能なロケール

戻り値	Type	説明
<current-timestamp>	string	現在の日付と時刻

例 1

日時が 2018 年 4 月 15 日、午後 1 時 00 分 00 秒であるものとします。この例は、タイムスタンプを取得します。

utcNow()

そして、2018-04-15T13:00:00.000Z という結果を返します。

例 2

日時が 2018 年 4 月 15 日、午後 1 時 00 分 00 秒であるものとします。この例では、省略可能な D 形式を使用して、現在のタイムスタンプが取得されます。

utcNow('D')

そして、2018 年 4 月 15 日、日曜日という結果が返されます。

例 3

日時が 2018 年 4 月 15 日、午後 1 時 00 分 00 秒であるものとします。この例では、de-DE ロケールを使用して現在のタイムスタンプを取得します。

utcNow('', 'de-DE')

そして、15.04.18 13:00:00 という結果を返します。

where

各要素をフィルター処理し、特定の条件に一致する、フィルター処理された要素の新しいコレクションを返します。

where([<collection/instance>], <iteratorName>, <function>)

パラメーター	必須	タイプ	説明
<collection/instance>	はい	array	項目を含むコレクション
<iteratorName>	はい	反復子名	キー項目
<function>	はい	式 (expression)	項目をフィルター処理するために使用される条件関数

戻り値	Type	説明
<new-collection/new-object>	配列/文字列	各要素が関数によってフィルター処理された新しいコレクション

例 1

この例では、新しいコレクションが生成されます。

where(createArray(0, 1, 2, 3), x, x > 1)

そして、[2, 3] という結果を返します。

例 2

これらの例では、新しいコレクションが生成されます。

where(json("{'name': 'jack', 'age': '15'}"), x, x.value == 'jack')
where(json("{'name': 'jack', 'age': '15'}"), x=> x.value == 'jack')

xml

JSON オブジェクトを含む文字列の XML バージョンを返します。

xml('<value>')

パラメーター	必須	タイプ	説明
<value>	はい	string	変換する JSON オブジェクトを含む文字列。 JSON オブジェクトのルートプロパティは 1 つに限る必要があり、配列にはできません。二重引用符 (") のエスケープ文字として、\ を使います。

戻り値	Type	説明
<xml-version>	オブジェクト	指定した文字列または JSON オブジェクトのエンコードされた XML

例 1

この例では、JSON オブジェクトを含む文字列の XML バージョンが作成されます。

xml(json('{ \"name\": \"Sophia Owen\" }'))

そして、結果の XML が返されます。

<name>Sophia Owen</name>

例 2

以下に示すような、person JSON オブジェクトがあるとします。次に例を示します。

{
  "person": {
    "name": "Sophia Owen",
    "city": "Seattle"
  }
}

この例では、この JSON オブジェクトを含む文字列の XML が作成されます。

xml(json('{\"person\": {\"name\": \"Sophia Owen\", \"city\": \"Seattle\"}}'))

そして、結果の XML が返されます。

<person>
  <name>Sophia Owen</name>
  <city>Seattle</city>
<person

xPath

XML で XPath (XML Path Language) 式と一致するノードまたは値を調べて、一致するノードまたは値を返します。 XPath 式 (XPath と呼びます) は、XML コンテンツ内のノードまたは計算値を選択できるように、XML ドキュメント構造内の移動を補助します。

xPath('<xml>', '<xpath>')

パラメーター	必須	タイプ	説明
<xml>	はい	任意	XPath 式の値に一致するノードまたは値を検索する XML 文字列
<xPath>	はい	任意	一致する XML ノードまたは値の検索に使用する XPath 式

戻り値	Type	説明
<xml-node>	XML	1 つのノードだけが指定した XPath 式と一致するときの XML ノード
<value>	任意	1 つの値だけが指定した XPath 式と一致するときの XML ノードの値
<[<xml-node1>, <xml-node2>, ...] -または- [<value1>、<value2>, ...]>	配列	指定した XPath 式と一致する XML ノードまたは値の配列

例 1

この例は、指定した引数内の <name></name> ノードと一致するノードを検索し、一致するノードの値の配列を返します。

xPath(items, '/produce/item/name')

引数には、この XML を含む items の文字列が含まれます。

"<?xml version="1.0"?> <produce> <item> <name>Gala</name> <type>apple</type> <count>20</count> </item> <item> <name>Honeycrisp</name> <type>apple</type> <count>10</count> </item> </produce>"

次に示すのは、<name></name> と一致するノードを含む結果の配列です。

[ <name>Gala</name>, <name>Honeycrisp</name> ]

例 2

例 1 に続き、この例では <count></count> ノードと一致するノードを検索し、sum() 関数を使用して、それらのノードの値を追加します。

xPath(xml(parameters('items')), 'sum(/produce/item/count)')

そして、30 という結果を返します。

year

指定したタイムスタンプの年を返します。

year('<timestamp>')

パラメーター	必須	タイプ	説明
<タイムスタンプ>	はい	string	タイムスタンプを含む文字列。

戻り値	Type	説明
<year>	integer	指定したタイムスタンプの年

例

この例では、年のタイムスタンプが評価されます。

year('2018-03-15T00:00:00.000Z')

そして、2018 という結果が返されます。

次の方法で共有

アダプティブ式の事前構築済みの関数

文字列関数

コレクション関数

論理比較関数

変換関数

数学関数

日付と時刻関数

Timex 関数

URI 解析関数

オブジェクトの操作と構築の関数

正規表現関数

型チェック関数

事前構築済みの関数をアルファベット順に並べ替える

abs

add

addDays

addHours

addMinutes

addOrdinal

addProperty

addSeconds

addToTime

すべて

and

任意

average

base64

base64ToBinary

base64ToString

バイナリ

[bool]

ceiling

coalesce

concat

contains

count

countWord

convertFromUTC

convertToUTC

createArray

dataUri

dataUriToBinary

dataUriToString

日付

dateReadBack

dateTimeDiff

dayOfMonth

dayOfWeek

dayOfYear

div

空

endsWith

EOL

equals

exists

exp

first

flatten

float

floor

foreach

formatDateTime

formatEpoch

formatNumber

formatTicks

getFutureTime

getNextViableDate

getNextViableTime

getPastTime

getPreviousViableDate

getPreviousViableTime

getProperty

指定されたプロパティの値を返します

ルート プロパティを返す

getTimeOfDay

greater

greaterOrEquals

if

indexOf

ルートプロパティを返す