Version: Current

foundation-layout.foundationlayout.removeitems

FoundationLayout.removeItems() method

Removes all instances of a specified registered item from the layout.

Signature:

removeItems(registration: string, force?: boolean): number;

Parameter	Type	Description
registration	string	string of the registration ID
force	boolean	(Optional) if set to true then the item will be removed even if it is not closable. Defaults to false, which is the same behaviour as the close button on the header.

Returns:

number

number of items removed

Does not remove the registration from the layout system. Has a side affect of setting all tab views to be viewing the first tab in the stack.