Zum Hauptinhalt springen

remove()

Beschreibung

Entfernt das angegebene Element oder, wenn die Methode ohne Argumente aufgerufen wird, alle Elemente aus der Auswahlliste

Verwendung

remove({
id: string | number
}): boolean;

//oder

remove(): boolean;

Parameter

Die Methode kann als Argument ein Objekt mit dem folgenden Parameter akzeptieren:

  • id - (erforderlich) die ID des Elements, das aus der Auswahlliste entfernt werden soll

Rückgabewert

Die Methode gibt true zurück, wenn die Abwahl eines Elements oder das Leeren der Liste erfolgreich war

Beispiel

// Ein Diagram muss mit der Option "select:true" erstellt werden
const diagram = new dhx.Diagram("diagram_container", {
select: true
});
// Daten werden geladen
diagram.data.parse(data);

console.log(diagram.selection.getIds()); // -> ["1", "2", "3"]
diagram.selection.remove({ id: "3" }); // -> gibt true zurück, wenn das Element abgewählt wurde
console.log(diagram.selection.getIds()); // -> ["1", "2"]

Wenn die Methode ohne Argumente aufgerufen wird, leert sie die Auswahlliste:

// Ein Diagram muss mit der Option "select:true" erstellt werden
const diagram = new dhx.Diagram("diagram_container", {
select: true
});
// Daten werden geladen
diagram.data.parse(data);

console.log(diagram.selection.getIds()); // -> ["1", "2", "3"]
// Entfernt alle Elemente aus der Auswahlliste
diagram.selection.remove();
console.log(diagram.selection.getIds()); // -> []

Changelog: Aktualisiert in v6.0

Verwandte Artikel:

Verwandtes Beispiel: Diagram. Selection. Elementauswahl