changeId()

changes the id of an element of a data collection

Usage

type Id = string | number;
changeId(id: Id, newId?: Id, silent?: boolean): Id;

Parameters:

• id: Id - the old id of an item
• newId?: Id - optional, the new id; auto-generated if not set
• silent?: boolean - optional, if set to true, the method will not trigger the change event; otherwise, false

Returns:

The new id of the item, or the original id if the change was rejected.

Example

// changing the id of an item
component.data.changeId("1", "22"); // -> "22"

// the new id is generated automatically
const generatedId = component.data.changeId("22");

// changing the id without triggering the change event
component.data.changeId(generatedId, "33", true);

The method leaves the item as is, shows a warning in the browser console and returns the original id in the following cases:

• the collection has no item with the id id
• an item with the newId id already exists
• newId is not a valid id, that is, neither a number nor a non-empty string
• the data is grouped

Change log:

• The return value and the checks for grouped data and an invalid new id were added in v9.4
• The method was added in v6.4