GlideList2 (g_list) : client

L’API GlideList2 fournit des méthodes pour personnaliser les listes (v2).

La variable g_list est utilisée pour accéder à un objet de liste spécifié. La variable g_list n’est pas disponible pour l’action d’interface utilisateur de lien du formulaire des listes connexes. Il est disponible pour l’action d’interface utilisateur de lien du formulaire de listes.

Ces méthodes sont utilisées dans les menus contextuels et les actions d’interface utilisateur.

Plusieurs de ces méthodes sont disponibles dans Cadre de travail de l'interface utilisateur Next Experience. Pour plus de détails, voir GlideList (Cadre de travail de l'interface utilisateur Next Experience).

GlideList2 : addFilter(filtre de chaîne)

Ajoute un terme unique au filtre de requête de liste.

Tableau 1. Paramètres

Nom	Type	Description
filtre	Chaîne	Chaîne de requête codée au format Glide standard. Voir Chaînes de requête codées.

Tableau 2. Renvoie

Type	Description
nul

g_list.addFilter("active=true");

GlideList2 : get(Object DOMelement)

Renvoie l’objet GlideList2 pour la liste qui contient l’élément spécifié.

Tableau 3. Paramètres

Nom	Type	Description
DOMelement	Objet	L’ID de l’élément DOM pour la liste pour laquelle vous voulez l’objet GlideList2 .

Tableau 4. Renvoie

Type	Description
Objet	Objet GlideList2 ou nul si introuvable.

GlideList2 : get(String ListID)

Renvoie l’objet GlideList2 pour la liste spécifiée.

Tableau 5. Paramètres

Nom	Type	Description
ListID	Chaîne	ID de liste pour lequel vous souhaitez l’objet GlideList2 .

Tableau 6. Renvoie

Type	Description
Objet	Objet GlideList2 ou nul si introuvable.

function assignLabelActionViaLookupModal(tableName, listId) {
	var list = GlideList2.get(listId);
	if (!list)
		return;

	assignLabelViaLookup(tableName, sysIds, list.getView());
}

GlideList2 : getChecked()

Renvoie une liste séparée par des virgules des sys_ids pour les éléments qui sont enregistrés dans la liste associée.

Tableau 7. Paramètres

Nom	Type	Description
aucun

Tableau 8. Renvoie

Type	Description
Chaîne	Liste séparée par des virgules des sys_ids pour les éléments qui sont vérifiés dans la liste. Ne vérifie pas que les éléments retournés peuvent être exécutés.

function removeLabelActionViaLookupModal(tableName, listId) {
  var list = GlideList2.get(listId);
  if (!list)
    return;

  var sysIds = list.getChecked();
  if (!sysIds)
    return;

  removeLabelViaLookup(tableName, sysIds);
}

GlideList2 : getFixedQuery()

Renvoie la requête fixe.

Une requête fixe est la partie de la requête qui ne peut pas être supprimée du fil d’Ariane (c’est-à-dire qu’elle est fixe pour l’utilisateur). Cela se spécifie en incluant un sysparm_fixed_query paramètre pour le module d’application.

Tableau 9. Paramètres

Nom	Type	Description
aucun

Tableau 10. Renvoie

Type	Description
Chaîne	Chaîne de requête fixe pour la liste.

var list = GlideList2.get(container.readAttribute('list_id'));
var filter = this._getFilter(element);
var fixedQuery = list.getFixedQuery();
if (fixedQuery)
  filter = fixedQuery + "^" + filter;

GlideList2 : getGroupBy()

Renvoie la liste des champs ou des champs séparés par des virgules utilisés pour regrouper la liste.

Tableau 11. Paramètres

Nom	Type	Description
aucun

Tableau 12. Renvoie

Type	Description
Chaîne	Liste des champs séparés par des champs ou séparés par des virgules utilisés pour regrouper la liste.

function runFilterV2Lists(name, filter) {
  var list = GlideList2.get(name);	
    if (list) {
      var groupBy = list.getGroupBy();
      if (groupBy)  
        filter += "^" + groupBy;
		
        list.setFilterAndRefresh(filter);
    }
}

GlideList2 : getListName()

Renvoie le nom de la liste, qui est généralement le nom de la table.

Tableau 13. Paramètres

Nom	Type	Description
aucun

Tableau 14. Renvoie

Type	Description
Chaîne	Nom de la liste (généralement le nom de la table).

var list = GlideList2.get(name);	
var listName = list.getListName();

GlideList2 : getOrderBy()

Renvoie le premier champ utilisé pour organiser la liste.

Tableau 15. Paramètres

Nom	Type	Description
aucun

Tableau 16. Renvoie

Type	Description
Chaîne	Champ selon lequel trier la liste. Vide si la liste n’est pas ordonnée.

var list = GlideList2.get(listId);
if (!list)
  return;
var orderBy = list.getOrderBy();

GlideList2 : getParentTable()

Renvoie le nom de la table parente d’une liste connexe (la table associée au formulaire).

Tableau 17. Paramètres

Nom	Type	Description
aucun

Tableau 18. Renvoie

Type	Description
Chaîne	Nom de la table parente.

for (var id in GlideLists2) {
  var list = GlideLists2[id];
  if (list.getTableName() == listTableName && list.getParentTable() == tableName)
    return list.getContainer();
}

GlideList2 : getQuery(Boolean orderBy, Boolean groupBy, Boolean fixed, Boolean all)

Renvoie la chaîne de requête codée pour la liste.

Tableau 19. Paramètres

Nom	Type	Description
orderBy	Booléen	Facultatif. Marqueur indiquant s’il faut inclure orderBy dans les résultats. Valeurs valides : vrai : inclure orderBy dans les résultats. false : n’incluez pas orderBy dans les résultats. Valeur par défaut : false
groupBy	Booléen	Facultatif. Marqueur indiquant s’il faut inclure groupBy dans les résultats. Valeurs valides : true : inclure groupBy dans les résultats. false : n’incluez pas groupBy dans les résultats. Valeur par défaut : false
fixe	Booléen	Facultatif. Marqueur indiquant s’il faut inclure une requête fixe dans les résultats. Valeurs valides : vrai : inclure la requête fixe dans les résultats. faux : n’incluez pas de requête fixe dans les résultats. Valeur par défaut : false
tous	Booléen	Faire défaut. Marqueur indiquant s’il faut inclure orderBy, groupBy et la requête fixe dans les résultats. Valeurs valides : true : inclure orderBy, groupBy et la requête fixe dans les résultats. faux : n’incluez pas les trois options dans les résultats. Par défaut : true

Tableau 20. Renvoie

Type	Description
Chaîne	Chaîne de requête codée pour la liste.

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()

Renvoie le champ de liste connexe qui associe la liste connexe au formulaire parent.

Tableau 21. Paramètres

Nom	Type	Description
aucun

Tableau 22. Renvoie

Type	Description
Chaîne	Champ qui relie la liste au formulaire parent.

var list = GlideList2.get(name);
var related = list.getRelated();
if (related) 
  ajax.addParam("sysparm_is_related_list", "true");

GlideList2 : getTableName()

Renvoie le nom de table de la liste.

Tableau 23. Paramètres

Nom	Type	Description
aucun

Tableau 24. Renvoie

Type	Description
Chaîne	Renvoie le nom de table de la liste.

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()

Renvoie la vue utilisée pour afficher la liste.

Tableau 25. Paramètres

Nom	Type	Description
aucun

Tableau 26. Renvoie

Type	Description
Chaîne	Nom de la vue.

function assignLabelActionViaLookupModal(tableName, listId) {
	var list = GlideList2.get(listId);
	if (!list)
		return;

	assignLabelViaLookup(tableName, sysIds, list.getView());
}

GlideList2 : getTitle()

Renvoie le titre de la liste.

Tableau 27. Paramètres

Nom	Type	Description
aucun

Tableau 28. Renvoie

Type	Description
Chaîne	Le titre de la liste.

var list = GlideList2.get(name);	
var listTitle = list.getTitle();

GlideList2 : isUserList()

Renvoie la valeur true si la liste a été personnalisée par l’utilisateur en choisissant les mécanismes de liste et en modifiant la mise en page de la liste.

Tableau 29. Paramètres

Nom	Type	Description
aucun

Tableau 30. Renvoie

Type	Description
Booléen	Vrai si la mise en page de la liste a été modifiée.

var list = GlideList2.get(listId);
if (!list)
  return;
if (list.isUserList())
  var tableName = list.getTableName();

GlideList2 : refresh(Numéro, première ligne, chaîne, additionalParms)

Actualise la liste. La orderBy partie du filtre de liste est ignorée afin que la liste utilise son ordre naturel lorsqu’elle est actualisée.

Tableau 31. Paramètres

Nom	Type	Description
première ligne	Numéro	Première ligne à apparaître dans la liste. Par défaut : première ligne de la vue actuelle.
supplémentaireParms	Chaîne	Paires nom-valeur facultatives soumises avec la demande d’actualisation de la liste.

Tableau 32. Renvoie

Type	Description
nul

$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(Numéro, première ligne, description de la chaîne)

Actualise la liste. La orderBy partie du filtre de liste est incluse si elle est spécifiée pour la liste.

Tableau 33. Paramètres

Nom	Type	Description
première ligne	Numéro	Première ligne à apparaître dans la liste. Par défaut : première ligne de la vue actuelle.
description	Chaîne	Paires nom-valeur facultatives soumises avec la demande d’actualisation de la liste.

Tableau 34. Renvoie

Type	Description
nul

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(filtre de chaîne)

Définit la chaîne de requête codée pour la liste, en ignorant les orderBy parties et groupBy de la chaîne de requête.

Tableau 35. Paramètres

Nom	Type	Description
filtre	Chaîne	Chaîne de requête codée au format Glide standard. Voir Chaînes de requête codées.

Tableau 36. Renvoie

Type	Description
nul

list = GlideList2.get($(side+"ContentDivRelease").select(".list_div")[0].getAttribute("id"));
if (list) {
  list.setFilter("active=true");
  list.refresh(1);
 }

GlideList2 : setFilterAndRefresh(filtre de chaîne)

Définit la chaîne de requête codée pour la liste, y compris le orderBy et groupBy si spécifié, puis actualise la liste à l’aide du nouveau filtre.

Tableau 37. Paramètres

Nom	Type	Description
filtre	Chaîne	Chaîne de requête codée.

Tableau 38. Renvoie

Type	Description
nul

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(Number rowNum)

Définit la première ligne qui apparaît dans la liste lorsque celle-ci est actualisée.

Tableau 39. Paramètres

Nom	Type	Description
Num. de ligne	Numéro	Numéro de ligne de la première ligne à afficher.

Tableau 40. Renvoie

Type	Description
nul

var nextRow = 0;
var rowsPerPage = 20;
var list = GlideList2.get(listId);
if (!list)
  return;
list.setFirstRow(nextRow);
nextRow = nextRow + rowsPerPage;

GlideList2 : setGroupBy (chaîne groupBy)

Définit les critères de liste groupBy pour un seul champ.

Tableau 41. Paramètres

Nom	Type	Description
groupBy	Chaîne	Les groupBy critères de la liste.

Tableau 42. Renvoie

Type	Description
nul

function runContextAction(listId) {
  var g_list = GlideList2.get(listId);
  g_list.setGroupBy('');
  g_list.refresh(1);
}

GlideList2 : setOrderBy(String orderBy)

Définit les orderBy critères de la liste.

Pour un champ d’ordre unique par, utilisez orderBy champ ou orderByDesc champ. Pour plusieurs champs, utilisez orderByField1^orderByField2^orderByField3. orderBy spécifie l’ordre croissant et orderByDesc spécifie l’ordre décroissant. Ces chaînes de préfixe sont facultatives. S’il n’est pas spécifié, orderBy il s’agit de l’ordre par défaut.

Tableau 43. Paramètres

Nom	Type	Description
orderBy	Chaîne	Champs orderBy uniques ou multiples.

Tableau 44. Renvoie

Type	Description
nul

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            updateOrderBy: function(orderBy){
  var list = GlideList2.get(this.listID);
  if (list)
    list.setOrderBy(orderBy);
};

GlideList2 : setRowsPerPage(Nombre de lignes)

Définit le nombre de lignes par page à afficher.

Tableau 45. Paramètres

Nom	Type	Description
lignes	Numéro	Nombre de lignes à afficher.

Tableau 46. Renvoie

Type	Description
nul

link: function(scope) {
  var list = GlideList2.get(scope.listId);
  list.setRowsPerPage(scope.maxRows);
  list.setFilterAndRefresh(scope.tableQuery);
}

GlideList2 : showHideGroups(booléen showFlag)

Affiche ou masque tous les groupes dans la liste et enregistre l’état réduit/étendu actuel des groupes selon les préférences de l’utilisateur.

Tableau 47. Paramètres

Nom	Type	Description
showFlag	Booléen	Si la valeur est vrai, affiche les groupes au sein de la liste.

Tableau 48. Renvoie

Type	Description
nul

function showHideAllGroups(showFlag) {
  var list = GlideList2.get(listId);
  if (!list)
    return;
  list.showHideGroups(showFlag);
}

GlideList2 : showHideList(booléen showFlag)

Affiche ou masque la liste et enregistre l’état réduit/développé actuel de la liste selon les préférences de l’utilisateur.

Tableau 49. Paramètres

Nom	Type	Description
showFlag	Booléen	Si vrai, affiche la liste.

Tableau 50. Renvoie

Type	Description
nul

GlideList2.toggleAll = function(expandFlag) {
for (var id in GlideLists2) {
  var list = GlideLists2[id];
list.showHideList(expandFlag);
}

GlideList2 : tri (champ de chaîne)

Trie la liste par ordre croissant et définit le champ sous forme de orderBy colonne.

Tableau 51. Paramètres

Nom	Type	Description
champ	Chaîne	Champ à utiliser pour trier la liste.

Tableau 52. Renvoie

Type	Description
nul

$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(champ de chaîne, montant du numéro)

Trie un seul champ de la liste par ordre décroissant et définit le champ en tant orderByDescField que colonne.

Tableau 53. Paramètres

Nom	Type	Description
champ	Chaîne	Champ à utiliser pour trier la liste.

Tableau 54. Renvoie

Type	Description
nul

$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()

Active/désactive l’affichage de la liste et enregistre l’état réduit/développé actuel de la liste selon les préférences de l’utilisateur.

Tableau 55. Paramètres

Nom	Type	Description
aucun

Tableau 56. Renvoie

Type	Description
nul

var list = GlideList2.get(listId);
if (!list)
  return;
list.toggleList();

GlideList2 : toggleListNoPref()

Active/désactive l’affichage de la liste, mais n’enregistre pas l’état réduit/développé actuel de la liste selon les préférences de l’utilisateur.

Tableau 57. Paramètres

Nom	Type	Description
aucun

Tableau 58. Renvoie

Type	Description
nul

var list = GlideList2.get(listId);
if (!list)
  return;
list.toggleListNoPref();