List 関数

[アーティクル]
04/06/2023

これらの関数を使用すると、リスト値の作成と操作を行えます。

Information

名前	Description
List.Count	リスト内の項目の数を返します。
List.NonNullCount	リスト内の項目の数を返します。null 値は除外されます
List.IsEmpty	リストが空かどうかを返します。

[選択]

名前	Description
List.Alternate	数、省略可能な repeatInterval、省略可能なオフセットに基づいて、元のリストから代替される項目を含むリストを返します。
List.Buffer	リストをメモリ内にバッファーします。この呼び出しの結果は安定したリストになります。つまり、数と項目順が決定されます。
List.Distinct	重複を削除して、リストをフィルター処理します。省略可能な式条件値を指定して、等値比較を制御できます。各等値グループの最初の値が選択されます。
List.FindText	レコードフィールドを含む、値のリスト内で、テキスト値を検索します。
List.First	リスト内の最初の値を返します。リストが空の場合は、指定された既定値を返します。リスト内の最初の項目を返します。リストが空の場合は、省略可能な既定値を返します。リストが空で、既定値が指定されていない場合、関数は null を返します。
List.FirstN	返す項目の数、または `countOrCondition` に限定条件が指定されると、リスト内の最初の項目セットを返します。
List.InsertRange	入力リスト内の指定されたインデックスの位置に値の項目を挿入します。
List.IsDistinct	リストが一意であるかどうかを返します。
List.Last	返す項目の数、または `countOrCondition` に限定条件が指定されると、リスト内の最後の項目セットを返します。
List.LastN	返す項目の数または限定条件が指定されると、リスト内の最後の項目セットを返します。
List.MatchesAll	リスト内のすべての項目が条件を満たしている場合に true を返します。
List.MatchesAny	リスト内のいずれかの項目が条件を満たしている場合に true を返します。
List.Positions	入力リストに対して位置のリストを返します。
List.Range	オフセットの位置から始まる、count 個の項目を返します。
List.Select	条件に一致する項目を選択します。
List.Single	リスト内の単一項目を返します。リストに複数の項目がある場合は、`Expression.Error` をスローします。
List.SingleOrDefault	リストから単一項目を返します。
List.Skip	リストの最初の項目をスキップします。空のリストが指定されると、空のリストを返します。この関数では、省略可能なパラメーター `countOrCondition` を受け取り、複数の値のスキップをサポートします。

変換関数

名前	Description
List.Accumulate	リストから結果を累積します。この関数は、初期値のシードから開始し、アキュムレータ関数を適用し、最終的な結果を返します。
List.Combine	リストのリストを 1 つのリストにマージします。
List.ConformToPageReader	この関数は、内部での使用のみを意図しています。
List.RemoveRange	オフセットの位置から count 個の項目を削除したリストを返します。既定のカウントは 1 です。
List.RemoveFirstN	リストの最初の要素から、指定された数の要素を削除したリストを返します。削除されるエレメントの数は、省略可能なパラメーター `countOrCondition` によって決まります。
List.RemoveItems	`list1` から、`list2` に存在する項目を削除し、新しいリストを返します。
List.RemoveLastN	リストの最後の要素から、指定された数の要素を削除したリストを返します。削除されるエレメントの数は、省略可能なパラメーター `countOrCondition` によって決まります。
List.Repeat	入力リストの内容をカウント回数分繰り返すリストを返します。
List.ReplaceRange	リストのインデックスの位置から、count 個の値を `replaceWith` リストに置き換えたリストを返します。
List.RemoveMatchingItems	リスト内で、指定された値が出現するすべての箇所を削除します。
List.RemoveNulls	リストから null 値を削除します。
List.ReplaceMatchingItems	提供された `equationCriteria` を使用して、リスト内の既存値の出現箇所を新しい値に置き換えます。古い値と新しい値は、`replacements` パラメーターによって提供されます。省略可能な式条件値を指定して、等値比較を制御できます。置換操作と式条件の詳細については、「パラメーターの値」を参照してください。
List.ReplaceValue	値のリスト内で値を検索し、出現した値をそれぞれ置換値に置き換えます。
List.Reverse	リスト内の項目を逆順にしたリストを返します。
List.Split	指定されたリストを、指定されたページサイズを使用してリストのリストに分割します。
List.Transform	リスト内の各項目に対して関数を実行し、新しいリストを返します。
List.TransformMany	入力リストから射影された要素を含むリストを返します。

メンバーシップ関数

すべての値が等しいかどうかをテストできるため、異種のリストを操作できる関数です。

名前	説明
List.AllTrue	リスト内のすべての式が true の場合に true を返します
List.AnyTrue	リスト内のいずれかの式が true の場合に true を返します
List.Contains	値がリスト内で見つかった場合に true を返します。
List.ContainsAll	値のすべての項目がリスト内で見つかった場合に true を返します。
List.ContainsAny	値のいずれかの項目がリスト内で見つかった場合に true を返します。
List.PositionOf	リスト内で値が最初に出現する場所を検索し、その位置を返します。
List.PositionOfAny	値リスト内でいずれかの値が最初に出現する場所を検索し、その位置を返します。

操作の設定

名前	説明
List.Difference	リスト 1 の項目のうち、リスト 2 内に出現しない項目を返します。重複する値はサポートされています。
List.Intersect	リストのリストで、個々のリストから、項目の積集合 (交差) のリストを返します。重複する値はサポートされています。
List.Union	リストのリストで、個々のリストから、項目の和集合のリストを返します。返されるリストには、入力リスト内のすべての項目が含まれます。重複する値は、和集合の中に含まれます。
List.Zip	同じ位置にある項目を結合したリストのリストを返します。

順序

順序付け関数は、比較を実行します。比較対象のすべての値が相互に比較できる必要があります。つまり、データ型がすべて同じである必要があります (または、常に最小値を比較する null を含む)。それ以外の場合は、Expression.Error がスローされます。

比較可能なデータ型は次のとおりです。

Number
Duration
DateTime
Text
論理
[Null]

名前	説明
List.Max	リスト内の最大の項目を返します。リストが空の場合は、省略可能な既定値を返します。
List.MaxN	リスト内の最大値を返します。返す値の数またはフィルター条件を指定する必要があります。
List.Median	リストから中央値の項目を返します。
List.Min	リスト内の最小の項目を返します。リストが空の場合は、省略可能な既定値を返します。
List.MinN	リスト内の最小値を返します。返す値の数またはフィルター条件を指定できます。
List.Sort	比較条件を使用して並べ替えられたリストを返します。
List.Percentile	指定された確率に対応する 1 つまたは複数のサンプルのパーセンタイルを返します。

平均値

Numbers、DateTimes、および Durations の同種のリストを操作する関数です。

名前	説明
List.Average	リストから、そのリスト内に指定されたデータ型の値の平均値を返します。
List.Mode	リスト内で最も多く出現する項目を 1 つ返します。
List.Modes	最も多く出現する項目をすべて返します。
List.StandardDeviation	値のリストから標準偏差を返します。 List.StandardDeviation は、サンプルベースの推定を実行します。 Numbers の結果は数値、DateTimes と Durations の結果は期間になります。

加算

Numbers または Durations の同種のリストを操作する関数です。

名前	説明
List.Sum	リストから合計を返します。

数値

数値のみを操作する関数です。

名前	説明
List.Covariance	2 つのリストの共分散を数値として返します。
List.Product	数値のリストから積を返します。

ジェネレーター

値のリストを生成する関数です。

名前	説明
List.Dates	count 個の date 値のリストを返します。開始値から始まり、値ごとに増分を加算します。
List.DateTimes	count 個の datetime 値のリストを返します。開始値から始まり、値ごとに増分を加算します。
List.DateTimeZones	count 個の datetimezone 値のリストを返します。開始値から始まり、値ごとに増分を加算します。
List.Durations	count 個の durations 値のリストを返します。開始値から始まり、値ごとに増分を加算します。
List.Generate	値の一覧を生成します。
List.Numbers	count 個の数値のリストを返します。初期値から始まり、増分を加算します。増分値は 1 です。
List.Random	count 個の乱数のリストを返します。シードパラメーターは省略可能です。
List.Times	開始値から始まる count 個の時間値のリストを返します。

パラメーターの値

出現の指定

並べ替え順序

Order.Ascending = 0;
Order.Descending = 1;

式の条件

リスト値の式の条件は、次のいずれかで指定できます。

次のいずれかの関数の値:
- 等値条件を適用するためのリストの値を決定するキーセレクター。
- 適用する比較の種類を指定ために使用される比較関数。組み込みの比較関数を指定することができます。「比較関数」のセクションを参照してください。
次を含むリストの値:
- 厳密に 2 つの項目。
- 1 番目の要素は、上記で指定したキーセレクターです
- 2 番目の要素は、上記で指定した比較演算子です。

詳細と例については、「List.Distinct」を参照してください。

比較条件

比較条件は、次のいずれかの値として指定できます。

並べ替え順序を指定する数値。詳細については、「並べ替え順序」を参照してください
並べ替えに使用するキーを計算するには、引数が 1 つの関数を使用できます。
キーと制御順序の両方を選択するには、キーと順序を含むリストを比較条件として指定できます。
比較を完全に制御するには、引数が 2 つである関数を使用できます。これにより、左右の入力の関係によって、-1、0、または 1 が返されます。 Value.Compare は、このロジックを委任するために使用できるメソッドです。

詳細と例については、「List.Sort」を参照してください。

置換操作

置換操作は、リスト値によって指定されます。リストの各項目は次を満たす必要があります。

厳密に 2 つの項目のリスト値。
1 番目の項目は、リスト内の古い値で、置き換えの対象です。
2 番目の項目は、リスト内の古い値のすべての出現箇所から置き換えられる新しい値です。