Skip to main content

getItem()

Description

Returns the object of the specified selected item or of the last selected item when called without arguments

Usage

getItem({
id: string | number
}): object;

//or

getItem(): object;

Parameters

The method takes as an argument an object with the following parameter:

  • id - (required) the id of the item in question

Returns

The method returns the object of the specified item, if it is in the selection list, or the object of the last selected item, if called without arguments

Example

// a diagram must be created with the "select:true" option
const diagram = new dhx.Diagram("diagram_container", {
select: true
});
// loading data
diagram.data.parse(data);

console.log(diagram.selection.getIds()); // -> ["1", "2", "3"]
// getting the last selected item
const item = diagram.selection.getItem();
// -> {id: "3", text: "Technical Director", title: "Jerry Wagner"}

// getting the selected item by id
const item = diagram.selection.getItem({ id: "1" });
// -> {id: "1", text: "Chairman & CEO", title: "Henry Bennett"}

// trying to get an item which is not in the selection list
const item = diagram.selection.getItem({ id: "4" });
// -> returns undefined, since there is no item with the specified id in the selection list

Change log: Updated in v6.0

Related articles:

Related samples: Diagram. Selection. Item selection