Handles

Method Overview

Method Details

add(handles, groupKey)

Adds a group of handles.

Parameters

handles WatchHandle|WatchHandle[]|Collection<WatchHandle> An array or collection handles to group.

groupKey * optional Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Handles.remove(). If no key is provided the handles are added to a default group.

Example

let handles = new Handles();

handles.add(handle); // added to the default group
handles.add([handle1, handle2]); // added to the default group

handles.add(handle, "handle-group");
handles.add([handle1, handle2], "other-handle-group");

destroy()

Destroys the object, removing all the handles.

has(groupKey){Boolean}

Returns true if a group exists for the provided group key, false otherwise.

Parameter

groupKey * group handle key

Returns

Type	Description
Boolean

remove(groupKey)

Removes a group of handles.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

let handles = new Handles();

handles.remove(); // removes handles from default group

handles.remove("handle-group");
handles.remove("other-handle-group");

removeAll()

Removes all handles.

Type Definitions

Handle

A handle to a highlight call result. The handle can be used to remove the installed highlight.

Property

remove Function Removes the handle.