GlideList2 (g_list): クライアント
GlideList2 API には、リストをカスタマイズするためのメソッドが用意されています (v2)。
変数 g_list は、指定されたリストオブジェクトにアクセスするために使用されます。g_list変数は、関連リストフォームリンクの UI アクションでは使用できません。これは、リストフォームリンクの UI アクションで使用できます。
これらのメソッドは、UI コンテキストメニューと UI アクションで使用されます。
これらの方法のいくつかは ネクストエクスペリエンス UI フレームワーク で利用できます。詳細については、次を参照してください。 GlideList (ネクストエクスペリエンス UI フレームワーク).
GlideList2 - addFilter(文字列フィルター)
リストクエリフィルターに単一の用語を追加します。
| 名前 | タイプ | 説明 |
|---|---|---|
| フィルター | 文字列 | 標準の Glide 形式でエンコードされたクエリ文字列。「 エンコードされたクエリ文字列」を参照してください。 |
| タイプ | 説明 |
|---|---|
| なし |
g_list.addFilter("active=true");
GlideList2 - get(オブジェクト DOMelement)
指定されたアイテムを含むリストの GlideList2 オブジェクトを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| DOMelement | オブジェクト | GlideList2 オブジェクトが必要なリストの DOM 要素 ID。 |
| タイプ | 説明 |
|---|---|
| オブジェクト | GlideList2 オブジェクト、見つからない場合は null。 |
GlideList2:get(文字列 ListID)
指定されたリストの GlideList2 オブジェクトを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| ListID | 文字列 | GlideList2 オブジェクトが必要なリスト ID。 |
| タイプ | 説明 |
|---|---|
| オブジェクト | GlideList2 オブジェクト、見つからない場合は null。 |
function assignLabelActionViaLookupModal(tableName, listId) {
var list = GlideList2.get(listId);
if (!list)
return;
assignLabelViaLookup(tableName, sysIds, list.getView());
}
GlideList2:getChecked()
関連付けられたリストでチェックされているアイテムのsys_idsのカンマ区切りリストを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストでチェックされているアイテムのsys_idsのカンマ区切りリスト。返されたアイテムの実行が許可されているかどうかをチェックして判断しません。 |
function removeLabelActionViaLookupModal(tableName, listId) {
var list = GlideList2.get(listId);
if (!list)
return;
var sysIds = list.getChecked();
if (!sysIds)
return;
removeLabelViaLookup(tableName, sysIds);
}
GlideList2:getFixedQuery()
固定クエリを返します。
固定クエリは、ブレッドクラムから削除できない (つまり、ユーザーに対して固定されている) クエリの部分です。これは、アプリケーションモジュールの sysparm_fixed_query パラメーターを含めることによって指定されます。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストの固定クエリ文字列。 |
var list = GlideList2.get(container.readAttribute('list_id'));
var filter = this._getFilter(element);
var fixedQuery = list.getFixedQuery();
if (fixedQuery)
filter = fixedQuery + "^" + filter;
GlideList2:getGroupBy()
リストのグループ化に使用されるフィールドまたはカンマ区切りのフィールドリストを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストをグループ化するために使用されるフィールドまたはカンマ区切りのフィールドリスト。 |
function runFilterV2Lists(name, filter) {
var list = GlideList2.get(name);
if (list) {
var groupBy = list.getGroupBy();
if (groupBy)
filter += "^" + groupBy;
list.setFilterAndRefresh(filter);
}
}
GlideList2:getListName()
リストの名前 (通常はテーブル名) を返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リスト名 (通常はテーブル名)。 |
var list = GlideList2.get(name);
var listName = list.getListName();
GlideList2:getOrderBy()
リストの順序付けに使用する最初のフィールドを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストを並べ替えるフィールド。リストが順序付けされていない場合は空です。 |
var list = GlideList2.get(listId);
if (!list)
return;
var orderBy = list.getOrderBy();
GlideList2:getParentTable()
関連リストの親テーブル (フォームに関連付けられたテーブル) の名前を返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | 親テーブル名。 |
for (var id in GlideLists2) {
var list = GlideLists2[id];
if (list.getTableName() == listTableName && list.getParentTable() == tableName)
return list.getContainer();
}
GlideList2 - getQuery(ブール値 orderBy, ブール値 groupBy, ブール値固定, ブール値すべて)
リストのエンコードされたクエリ文字列を返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| orderBy | ブーリアン | オプション。結果に orderBy を含めるかどうかを示すフラグ。 有効な値:
デフォルト値:false |
| groupBy | ブーリアン | オプション。結果に groupBy を含めるかどうかを示すフラグ。 有効な値:
デフォルト値:false |
| fixed | ブーリアン | オプション。結果に固定クエリを含めるかどうかを示すフラグ。 有効な値:
デフォルト値:false |
| すべて | ブーリアン | デフォルト。orderBy、groupBy、および固定クエリを結果に含めるかどうかを示すフラグ。 有効な値:
デフォルト:true |
| タイプ | 説明 |
|---|---|
| 文字列 | リストのエンコードされたクエリ文字列。 |
var list = GlideList2.get(this.listID);
var ajax = new GlideAjax("AJAXJellyRunner", "AJAXJellyRunner.do");
ajax.addParam("sysparm_query_encoded", list.getQuery({groupby: true, orderby: true}));
ajax.addParam("sysparm_table", list.getTableName());
ajax.addParam("sysparm_view", list.getView());
GlideList2:getRelated()
関連リストを親フォームに関連付ける関連リストフィールドを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストを親フォームに接続するフィールド。 |
var list = GlideList2.get(name);
var related = list.getRelated();
if (related)
ajax.addParam("sysparm_is_related_list", "true");
GlideList2:getTableName()
リストのテーブル名を返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストのテーブル名を返します。 |
GlideList2.getListsForTable = function(table) {
var lists = [];
for (var id in GlideLists2) {
var list = GlideLists2[id];
if (list.getTableName() == table)
lists.push(list);
}
return lists;
}
GlideList2:getView()
リストの表示に使用するビューを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | ビューの名前。 |
function assignLabelActionViaLookupModal(tableName, listId) {
var list = GlideList2.get(listId);
if (!list)
return;
assignLabelViaLookup(tableName, sysIds, list.getView());
}
GlideList2:getTitle()
リストのタイトルを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストのタイトル。 |
var list = GlideList2.get(name);
var listTitle = list.getTitle();
GlideList2:isUserList()
リストメカニックを選択し、リストレイアウトを変更することによって、ユーザーがリストをカスタマイズした場合は true を返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| ブーリアン | リストレイアウトが変更された場合は True。 |
var list = GlideList2.get(listId);
if (!list)
return;
if (list.isUserList())
var tableName = list.getTableName();
GlideList2 - refresh(Number firstRow, String additionalParms)
リストを更新します。リストフィルターの orderBy 部分は無視されるため、リストは更新時に自然な順序が使用されます。
| 名前 | タイプ | 説明 |
|---|---|---|
| 最初の行 | 番号 | リストに表示される最初の行。 デフォルト:現在のビューの最初の行。 |
| additionalParms | 文字列 | リスト更新要求とともに送信されるオプションの名前と値のペア 。 |
| タイプ | 説明 |
|---|---|
| なし |
$timeout(function() {
if (GlideList.lists) {
var list = GlideList.get(name);
if (list) {
if (sortBy) {
if (sortDirection == 'ASC')
list.sort(sortBy);
else
list.sortDescending(sortBy);
}
list.refresh();
}
}
}
GlideList2 - refreshWithOrderBy(数値、firstRow、文字列、説明)
リストを更新します。リストフィルターの orderBy 部分は、リストに指定されている場合に含まれます。
| 名前 | タイプ | 説明 |
|---|---|---|
| 最初の行 | 番号 | リストに表示される最初の行。 デフォルト:現在のビューの最初の行。 |
| description | 文字列 | オプション リスト更新要求とともに送信される名前と値のペア。 |
| タイプ | 説明 |
|---|---|
| なし |
ga.getXML(function(serverResponse) {
var response = serverResponse.responseXML.getElementsByTagName("response")[0];
if (response) {
var list = GlideList2.getByName("backlog_stories");
list.refreshWithOrderBy();
var status = response.getAttribute('status');
$j('html, body').animate({scrollTop: $j("#"+data.record.sys_id).offset().top},500);
if (status == 'failure') {
alert('${gs.getMessage("Story cannot be created. Team is not associated with any project.")}');
}
}
}
GlideList2 - setFilter(文字列フィルター)
クエリ文字列の orderBy 部分と groupBy 部分を無視して、リストのエンコードされたクエリ文字列を設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| フィルター | 文字列 | 標準の Glide 形式でエンコードされたクエリ文字列。「 エンコードされたクエリ文字列」を参照してください。 |
| タイプ | 説明 |
|---|---|
| なし |
list = GlideList2.get($(side+"ContentDivRelease").select(".list_div")[0].getAttribute("id"));
if (list) {
list.setFilter("active=true");
list.refresh(1);
}
GlideList2 - setFilterAndRefresh(文字列フィルター)
指定されている場合は orderBy と groupBy を含む、リストのエンコードされたクエリ文字列を設定し、新しいフィルターを使用してリストを更新します。
| 名前 | タイプ | 説明 |
|---|---|---|
| フィルター | 文字列 | エンコードされたクエリ文字列。 |
| タイプ | 説明 |
|---|---|
| なし |
function updateListFilter(projectID) {
var list = GlideList2.getByName("backlog_stories");
var fixedQuery = $('hdn_additional_filters').value;
if(!projectID) {
list.setFilterAndRefresh(fixedQuery + "^ORDERBYteam_index");
list.setOrderBy("team_index");
}
}
GlideList2 - setFirstRow(番号 rowNum)
リストが更新されたときにリストに表示される最初の行を設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| 行番号 | 番号 | 表示する最初の行の行番号。 |
| タイプ | 説明 |
|---|---|
| なし |
var nextRow = 0;
var rowsPerPage = 20;
var list = GlideList2.get(listId);
if (!list)
return;
list.setFirstRow(nextRow);
nextRow = nextRow + rowsPerPage;
GlideList2:setGroupBy(文字列 groupBy)
単一フィールドのリスト groupBy 基準を設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| groupBy | 文字列 | リストの groupBy 基準。 |
| タイプ | 説明 |
|---|---|
| なし |
function runContextAction(listId) {
var g_list = GlideList2.get(listId);
g_list.setGroupBy('');
g_list.refresh(1);
}
GlideList2:setOrderBy(文字列 orderBy)
リストの orderBy 基準を設定します。
単一の順番フィールドの場合は、 orderBy フィールドまたは orderByDesc フィールドを使用します。 複数のフィールドの場合は、 orderByField1^orderByField2^orderByField3 を使用します。 orderBy は昇順を指定し、orderByDesc は降順を指定します。これらのプリフィックス文字列はオプションです。指定しない場合は、 orderBy がデフォルトの順序になります。
| 名前 | タイプ | 説明 |
|---|---|---|
| orderBy | 文字列 | 単一または複数の orderBy フィールド。 |
| タイプ | 説明 |
|---|---|
| なし |
updateOrderBy: function(orderBy){
var list = GlideList2.get(this.listID);
if (list)
list.setOrderBy(orderBy);
};
GlideList2 - setRowsPerPage(行数)
表示するページあたりの行数を設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| rows | 番号 | 表示する行数。 |
| タイプ | 説明 |
|---|---|
| なし |
link: function(scope) {
var list = GlideList2.get(scope.listId);
list.setRowsPerPage(scope.maxRows);
list.setFilterAndRefresh(scope.tableQuery);
}
GlideList2:showHideGroups (ブール値、showFlag)
リスト内のすべてのグループを表示または非表示にし、グループの現在の折りたたみ/展開状態をユーザー設定として保存します。
| 名前 | タイプ | 説明 |
|---|---|---|
| showFlag | ブーリアン | true の場合、リスト内のグループが表示されます。 |
| タイプ | 説明 |
|---|---|
| なし |
function showHideAllGroups(showFlag) {
var list = GlideList2.get(listId);
if (!list)
return;
list.showHideGroups(showFlag);
}
GlideList2:showHideList(ブール値:showFlag)
リストを表示または非表示にし、リストの現在の折りたたみ/展開状態をユーザー設定として保存します。
| 名前 | タイプ | 説明 |
|---|---|---|
| showFlag | ブーリアン | true の場合、リストが表示されます。 |
| タイプ | 説明 |
|---|---|
| なし |
GlideList2.toggleAll = function(expandFlag) {
for (var id in GlideLists2) {
var list = GlideLists2[id];
list.showHideList(expandFlag);
}
GlideList2 - sort(文字列フィールド)
リストを昇順でソートし、フィールドを orderBy 列として設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| フィールド | 文字列 | リストをソートするために使用するフィールド。 |
| タイプ | 説明 |
|---|---|
| なし |
$timeout(function() {
if (GlideList.lists) {
var list = GlideList.get(name);
if (list) {
if (sortBy) {
if (sortDirection == 'ASC')
list.sort(sortBy);
else
list.sortDescending(sortBy);
}
list.refresh();
}
}
}
GlideList2 - sortDescending(文字列フィールド, 数値金額)
リスト内の単一のフィールドを降順でソートし、そのフィールドを orderByDescField 列として設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| フィールド | 文字列 | リストをソートするために使用するフィールド。 |
| タイプ | 説明 |
|---|---|
| なし |
$timeout(function() {
if (GlideList.lists) {
var list = GlideList.get(name);
if (list) {
if (sortBy) {
if (sortDirection == 'ASC')
list.sort(sortBy);
else
list.sortDescending(sortBy);
}
list.refresh();
}
}
}
GlideList2:toggleList()
リストの表示を切り替え、リストの現在の折りたたみ/展開状態をユーザー設定として保存します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| なし |
var list = GlideList2.get(listId);
if (!list)
return;
list.toggleList();
GlideList2:toggleListNoPref()
リストの表示を切り替えますが、リストの現在の折りたたみ/展開状態はユーザー設定として保存されません。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| なし |
var list = GlideList2.get(listId);
if (!list)
return;
list.toggleListNoPref();