@graphty/graphty-element / session / MarkSpec
Interface: MarkSpec ​
Defined in: graphty-element/src/session/styles/StylesApi.ts:303
What mark() is asked for: a run that named a subset, and the channel values its chosen elements are painted with.
The same fields as HighlightSpec, except that set is required: a mark is an ordinary layer that writes exactly the channels it names, and nothing about it follows the element's highlight colour.
Extends ​
Properties ​
field? ​
readonlyoptionalfield?:string
Defined in: graphty-element/src/session/styles/StylesApi.ts:272
The field that says which elements were chosen. Defaults to the shape's primary field.
Inherited from ​
name? ​
readonlyoptionalname?:string
Defined in: graphty-element/src/session/styles/StylesApi.ts:274
What to call the layer. Defaults to the run's label.
Inherited from ​
run ​
readonlyrun:RunRef
Defined in: graphty-element/src/session/styles/StylesApi.ts:270
The run, its awaited result, or its bare id. All three are what a caller has in hand.
Inherited from ​
set ​
readonlyset:StaticStyle
Defined in: graphty-element/src/session/styles/StylesApi.ts:308
What a chosen element is painted. Channels of the half the run did not choose are ignored, so a route's set may name node and edge channels together.