LayerHandle
Defined in: map/layer-handle.ts:8
A handle to one registered layer, returned by GeoMap.layer, Plot.layer, and
Plot.points. Lets you stream more data into the layer via append without
re-projecting or re-building the features already in it.
Type Parameters
Section titled “Type Parameters”D = unknown
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LayerHandle<
D>(engine,name,appendImpl):LayerHandle<D>
Defined in: map/layer-handle.ts:9
Parameters
Section titled “Parameters”engine
Section titled “engine”BaseEngine
string
The layer’s name.
appendImpl
Section titled “appendImpl”(items) => void
Returns
Section titled “Returns”LayerHandle<D>
Properties
Section titled “Properties”
readonlyname:string
Defined in: map/layer-handle.ts:12
The layer’s name.
Methods
Section titled “Methods”append()
Section titled “append()”append(
items):this
Defined in: map/layer-handle.ts:20
Append one item or a batch to this layer. Only the new items are built/projected; existing geometry is untouched. An empty batch is a no-op downstream.
Parameters
Section titled “Parameters”D | readonly D[]
Returns
Section titled “Returns”this
recolor()
Section titled “recolor()”recolor():
this
Defined in: map/layer-handle.ts:40
Re-apply this layer’s fill/stroke accessors (e.g. after mutating bound data).
Returns
Section titled “Returns”this
select()
Section titled “select()”select(
set):this
Defined in: map/layer-handle.ts:31
Select a set of this layer’s drawables — by id array, by a datum-typed predicate
(D is known from registration, unlike the engine-level select(name, …) whose datum
is caller-asserted), or null to clear. Delegates to BaseEngine.select: members
get the layer’s selection.selected style, the complement selection.others.
Parameters
Section titled “Parameters”readonly (string | number)[] | ((d, i) => boolean) | null
Returns
Section titled “Returns”this
setClip()
Section titled “setClip()”setClip(
clipTo?):this
Defined in: map/layer-handle.ts:46
Set or clear the clip mask for this layer.
Parameters
Section titled “Parameters”clipTo?
Section titled “clipTo?”string
Returns
Section titled “Returns”this