GlideList2 (g_list)  – Client

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 8 Minuten Lesedauer
  • Die GlideList2- API bietet Methoden zum Anpassen von Listen (v2).

    Die Variable g_list wird verwendet, um auf ein angegebenes Listenobjekt zuzugreifen. Die g_list-Variable steht für die UI Action des Formular-Links der verknüpften Listen nicht zur Verfügung. Es steht für die UI Action des Formular-Links der Listen zur Verfügung.

    Diese Methoden werden in UI-Kontextmenüs und UI Actions verwendet.

    Mehrere dieser Methoden sind in Next Experience UI Frameworkverfügbar. Einzelheiten finden Sie unter GlideListe (Next Experience UI Framework).

    GlideList2 – addFilter(String filter)

    Fügt dem Listenabfragefilter einen einzelnen Begriff hinzu.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    filter Zeichenfolge Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe Codierte Abfragezeichenfolgen.
    Tabelle : 2. Ausgabe
    Typ Beschreibung
    void
    g_list.addFilter("active=true");

    GlideList2 – get(Object DOMelement)

    Gibt das GlideList2-Objekt für die Liste zurück, die das angegebene Element enthält.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    DOMelement Objekt DOM-Element-ID für die Liste, für die Sie das GlideList2-Objekt benötigen.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Objekt Das GlideList2-Objekt oder NULL, falls nicht gefunden.

    GlideList2 – get(String ListID)

    Gibt das GlideList2-Objekt für die angegebene Liste zurück.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    ListID Zeichenfolge ID für die Liste, für die Sie das GlideList2-Objekt benötigen.
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Objekt Das GlideList2-Objekt oder NULL, falls nicht gefunden.
    function assignLabelActionViaLookupModal(tableName, listId) {
    	var list = GlideList2.get(listId);
    	if (!list)
    		return;
    
    	assignLabelViaLookup(tableName, sysIds, list.getView());
    }

    GlideList2 – getChecked()

    Gibt eine durch Kommas getrennte Liste der sys_ids für die Elemente zurück, die in der zugehörigen Liste aktiviert sind.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Kommagetrennte Liste mit sys_ids für die Elemente, die in der Liste geprüft werden. Überprüft nicht, ob die zurückgegebenen Elemente ausgeführt werden dürfen.
    function removeLabelActionViaLookupModal(tableName, listId) {
      var list = GlideList2.get(listId);
      if (!list)
        return;
    
      var sysIds = list.getChecked();
      if (!sysIds)
        return;
    
      removeLabelViaLookup(tableName, sysIds);
    }

    GlideList2 – getFixedQuery()

    Gibt die feste Abfrage zurück.

    Eine feste Abfrage ist der Teil der Abfrage, der nicht aus dem Breadcrumb entfernt werden kann (d. h. für den Benutzer festgelegt). Sie wird durch Einschließen des Parameters sysparm_fixed_query für das Anwendungsmodul angegeben.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Feste Abfragezeichenfolge für die 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()

    Gibt das Feld oder die kommagetrennte Liste mit Feldern zurück, die zum Gruppieren der Liste verwendet werden.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Feld oder kommagetrennte Liste mit Feldern, die zum Gruppieren der Liste verwendet werden.
    function runFilterV2Lists(name, filter) {
      var list = GlideList2.get(name);	
        if (list) {
          var groupBy = list.getGroupBy();
          if (groupBy)  
            filter += "^" + groupBy;
    		
            list.setFilterAndRefresh(filter);
        }
    }

    GlideList2 – getListName()

    Gibt den Namen der Liste zurück, normalerweise den Tabellennamen.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Listenname (normalerweise der Tabellenname).
    var list = GlideList2.get(name);	
    var listName = list.getListName();
    

    GlideList2 – getOrderBy()

    Gibt das erste Feld zurück, das zum Sortieren der Liste verwendet wird.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Das Feld, nach dem die Liste sortiert werden soll. Leer, wenn die Liste nicht sortiert ist.
    var list = GlideList2.get(listId);
    if (!list)
      return;
    var orderBy = list.getOrderBy();

    GlideList2 – getParentTable()

    Gibt den Namen der übergeordneten Tabelle für eine verknüpfte Liste zurück (die dem Formular zugeordnete Tabelle).

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Name der übergeordneten Tabelle.
    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)

    Gibt die codierte Abfragezeichenfolge für die Liste zurück.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    orderBy Boolean Optional. Kennzeichnung, die angibt, ob orderBy in Ergebnisse aufgenommen werden soll.
    Gültige Werte:
    • „wahr“: orderBy in Ergebnisse einbeziehen.
    • „falsch“: orderBy nicht in Ergebnisse einbeziehen.

    Standardwert: false

    groupBy Boolean Optional. Kennzeichnung, die angibt, ob groupBy in Ergebnisse eingeschlossen werden soll.
    Gültige Werte:
    • „wahr“: Schließt „groupBy“ in Ergebnisse ein.
    • „falsch“: „groupBy“ nicht in Ergebnisse einbeziehen.

    Standardwert: false

    fixed Boolean Optional. Kennzeichnung, die angibt, ob die feste Abfrage in die Ergebnisse eingeschlossen werden soll.
    Gültige Werte:
    • wahr: Feste Abfrage in Ergebnisse einbeziehen.
    • „falsch“: Feste Abfrage nicht in Ergebnisse einbeziehen.

    Standardwert: false

    alle Boolean Standard Kennzeichnung, die angibt, ob orderBy, groupBy und fixed query in die Ergebnisse aufgenommen werden sollen.
    Gültige Werte:
    • „wahr“: Schließt orderBy, groupBy und feste Abfrage in Ergebnisse ein.
    • „falsch“: Alle drei Optionen werden nicht in Ergebnisse aufgenommen.

    Standardwert: true

    Tabelle : 20. Ausgabe
    Typ Beschreibung
    Zeichenfolge Codierte Abfragezeichenfolge für die 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()

    Gibt das verknüpfte Listenfeld zurück, das die verknüpfte Liste dem übergeordneten Formular zuordnet.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Feld, das die Liste mit dem übergeordneten Formular verbindet.
    var list = GlideList2.get(name);
    var related = list.getRelated();
    if (related) 
      ajax.addParam("sysparm_is_related_list", "true");

    GlideList2 – getTableName()

    Gibt den Tabellennamen für die Liste zurück.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Gibt den Tabellennamen für die Liste zurück.
    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()

    Gibt die Ansicht zurück, mit der die Liste angezeigt wurde.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 26. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Name der Ansicht.
    function assignLabelActionViaLookupModal(tableName, listId) {
    	var list = GlideList2.get(listId);
    	if (!list)
    		return;
    
    	assignLabelViaLookup(tableName, sysIds, list.getView());
    }

    GlideList2 – getTitle()

    Gibt den Listentitel zurück.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 28. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Listentitel.
    var list = GlideList2.get(name);	
    var listTitle = list.getTitle();
    

    GlideList2 – isUserList()

    Gibt true zurück, wenn die Liste vom Benutzer durch Auswahl des Listenmechanismus und Änderung des Listenlayouts personalisiert wurde.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 30. Ergebnisse
    Typ Beschreibung
    Boolean „True“, wenn das Listenlayout geändert wurde.
    var list = GlideList2.get(listId);
    if (!list)
      return;
    if (list.isUserList())
      var tableName = list.getTableName();

    GlideList2 – refresh(Number firstRow, String additionalParms)

    Aktualisiert die Liste. Der Teil orderBy des Listenfilters wird ignoriert, sodass die Liste beim Aktualisieren ihre natürliche Reihenfolge verwendet.

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    firstRow Nummer Die erste Zeile, die in der Liste angezeigt wird.

    Standard: Erste Zeile der aktuellen Ansicht.

    additionalParms Zeichenfolge Optionale Name-Wert-Paare, die mit der Listenaktualisierungsanforderung übermittelt werden.
    Tabelle : 32. Ausgabe
    Typ Beschreibung
    void
    $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(Number firstRow, String description)

    Aktualisiert die Liste. Der Teil orderBy des Listenfilters wird eingeschlossen, wenn er für die Liste angegeben ist.

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    firstRow Nummer Die erste Zeile, die in der Liste angezeigt wird.

    Standard: Erste Zeile der aktuellen Ansicht.

    Beschreibung Zeichenfolge Optionale Name-Wert-Paare, die mit der Listenaktualisierungsanforderung übermittelt werden.
    Tabelle : 34. Ausgabe
    Typ Beschreibung
    void
    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(String filter)

    Legt die codierte Abfragezeichenfolge für die Liste fest und ignoriert die Teile orderBy und groupBy in der Abfragezeichenfolge.

    Tabelle : 35. Parameter
    Name Typ Beschreibung
    filter Zeichenfolge Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe Codierte Abfragezeichenfolgen.
    Tabelle : 36. Ausgabe
    Typ Beschreibung
    void
    list = GlideList2.get($(side+"ContentDivRelease").select(".list_div")[0].getAttribute("id"));
    if (list) {
      list.setFilter("active=true");
      list.refresh(1);
     }

    GlideList2 – setFilterAndRefresh(String filter)

    Legt die codierte Abfragezeichenfolge für die Liste fest, einschließlich orderBy und groupBy, falls angegeben, und aktualisiert dann die Liste mit dem neuen Filter.

    Tabelle : 37. Parameter
    Name Typ Beschreibung
    filter Zeichenfolge Codierte Abfragezeichenfolge.
    Tabelle : 38. Ergebnisse
    Typ Beschreibung
    void
    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)

    Legt die erste Zeile fest, die in der Liste angezeigt wird, wenn die Liste aktualisiert wird.

    Tabelle : 39. Parameter
    Name Typ Beschreibung
    rowNum Zahl Zeilennummer der ersten anzuzeigenden Zeile.
    Tabelle : 40. Ergebnisse
    Typ Beschreibung
    void
    var nextRow = 0;
    var rowsPerPage = 20;
    var list = GlideList2.get(listId);
    if (!list)
      return;
    list.setFirstRow(nextRow);
    nextRow = nextRow + rowsPerPage;
    

    GlideList2 – setGroupBy(String groupBy)

    Legt die Kriterien der Liste groupBy für ein einzelnes Feld fest.

    Tabelle : 41. Parameter
    Name Typ Beschreibung
    groupBy Zeichenfolge Die groupBy -Kriterien für die Liste.
    Tabelle : 42. Ausgabe
    Typ Beschreibung
    void
    function runContextAction(listId) {
      var g_list = GlideList2.get(listId);
      g_list.setGroupBy('');
      g_list.refresh(1);
    }

    GlideList2 – setOrderBy(String orderBy)

    Legt die Kriterien orderBy für die Liste fest.

    Verwenden Sie für ein einzelnes Feld vom Typ „Sortieren nach“ das Feld orderBy oder das Feld orderByDesc. Verwenden Sie für mehrere Felder orderByField1^orderByField2^orderByField3. orderBy gibt die aufsteigende Reihenfolge und orderByDesc die absteigende Reihenfolge an. Diese Präfixzeichenfolgen sind optional. Wenn nicht angegeben, ist orderBy die Standardreihenfolge.

    Tabelle : 43. Parameter
    Name Typ Beschreibung
    orderBy Zeichenfolge Einzelnes oder mehrere orderBy-Felder.
    Tabelle : 44. Ausgabe
    Typ Beschreibung
    void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateOrderBy: function(orderBy){
      var list = GlideList2.get(this.listID);
      if (list)
        list.setOrderBy(orderBy);
    };

    GlideList2 – setRowsPerPage(Number rows)

    Legt die Anzahl der anzuzeigenden Zeilen pro Seite fest.

    Tabelle : 45. Parameter
    Name Typ Beschreibung
    rows Nummer Die Anzahl der anzuzeigenden Zeilen.
    Tabelle : 46. Ergebnisse
    Typ Beschreibung
    void
    link: function(scope) {
      var list = GlideList2.get(scope.listId);
      list.setRowsPerPage(scope.maxRows);
      list.setFilterAndRefresh(scope.tableQuery);
    }

    GlideList2 – showHideGroups(Boolean showFlag)

    Zeigt alle Gruppen in der Liste an oder blendet sie aus und speichert den aktuellen reduzierten/erweiterten Status der Gruppen als Benutzervoreinstellung.

    Tabelle : 47. Parameter
    Name Typ Beschreibung
    showFlag Boolean Bei true werden die Gruppen in der Liste angezeigt.
    Tabelle : 48. Ergebnisse
    Typ Beschreibung
    void
    function showHideAllGroups(showFlag) {
      var list = GlideList2.get(listId);
      if (!list)
        return;
      list.showHideGroups(showFlag);
    }

    GlideList2 – showHideList(Boolean showFlag)

    Zeigt die Liste an oder blendet sie aus und speichert den aktuellen reduzierten/erweiterten Status der Liste als Benutzervoreinstellung.

    Tabelle : 49. Parameter
    Name Typ Beschreibung
    showFlag Boolean Bei true wird die Liste angezeigt.
    Tabelle : 50. Ergebnisse
    Typ Beschreibung
    void
    GlideList2.toggleAll = function(expandFlag) {
    for (var id in GlideLists2) {
      var list = GlideLists2[id];
    list.showHideList(expandFlag);
    }

    GlideList2 – sort(String field)

    Sortiert die Liste in aufsteigender Reihenfolge und legt das Feld als orderBy -Spalte fest.

    Tabelle : 51. Parameter
    Name Typ Beschreibung
    Feld Zeichenfolge Feld zum Sortieren der Liste.
    Tabelle : 52. Ausgabe
    Typ Beschreibung
    void
    $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(String field, Number amount)

    Sortiert ein einzelnes Feld in der Liste in absteigender Reihenfolge und legt das Feld als Spalte orderByDescField fest.

    Tabelle : 53. Parameter
    Name Typ Beschreibung
    field Zeichenfolge Feld zum Sortieren der Liste.
    Tabelle : 54. Ergebnisse
    Typ Beschreibung
    void
    $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()

    Schaltet die Anzeige der Liste um und speichert den aktuellen reduzierten/erweiterten Status der Liste als Benutzervoreinstellung.

    Tabelle : 55. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 56. Ergebnisse
    Typ Beschreibung
    void
    var list = GlideList2.get(listId);
    if (!list)
      return;
    list.toggleList();

    GlideList2 – toggleListNoPref()

    Schaltet die Anzeige der Liste um, aber speichert den aktuellen reduzierten/erweiterten Status der Liste als Benutzervoreinstellung nicht.

    Tabelle : 57. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 58. Ergebnisse
    Typ Beschreibung
    void
    var list = GlideList2.get(listId);
    if (!list)
      return;
    list.toggleListNoPref();