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
| Parameter | Type | Description |
|---|---|---|
| obj | FilterableDataset | ArrayLike<Edge> | Edge | An edge, array of edges, Selection or Path. |
| state | boolean | True to make the object(s) visible, false to make them invisible. |
| ids | Array<string> | Optional list of overlay ids to operate on. Without this, all overlays on each edge in obj are targeted. |
Returns:
void