Skip to main content

Home > @jsplumbtoolkit/browser-ui > Surface > setOverlaysVisible

Surface.setOverlaysVisible() method#

Sets the visible state of the overlays specified by obj

Signature:

setOverlaysVisible(obj: FilterableDataset | ArrayLike<Edge> | Edge, state: boolean, ...ids: Array<string>): void;

Parameters#

ParameterTypeDescription
objFilterableDataset | ArrayLike<Edge> | EdgeAn edge, array of edges, Selection or Path.
statebooleanTrue to make the object(s) visible, false to make them invisible.
idsArray<string>Optional list of overlay ids to operate on. Without this, all overlays on each edge in obj are targeted.

Returns:

void