Skip to content

@graphty/graphty-element / session / SetOffer

Interface: SetOffer ​

Defined in: graphty-element/src/session/sets/types.ts:133

A set a finished run's result offers: community 3, level 2, the path. Using it as a scope, { define: offer.definition }, writes nothing; createFrom or createPath keeps it.

Offers come from the result's shape, never from the algorithm, so a registered algorithm's result offers what a built-in one of the same shape does.

Properties ​

definition ​

readonly definition: SetDefinition

Defined in: graphty-element/src/session/sets/types.ts:153

Usable at once as a scope, { define: offer.definition }: a rule over the one held item.


edges? ​

readonly optional edges?: number

Defined in: graphty-element/src/session/sets/types.ts:145

Filled only when this execution's edge-count pass is already cached; offers never runs it.


followable ​

readonly followable: boolean

Defined in: graphty-element/src/session/sets/types.ts:151

The item may be followed across re-runs (not a partition group).


item ​

readonly item: ResultItem

Defined in: graphty-element/src/session/sets/types.ts:135

The item, with the execution it was read from.


label ​

readonly label: string

Defined in: graphty-element/src/session/sets/types.ts:137

"Community 3 (1,204 nodes)", "On path", "Level 2".


nodes? ​

readonly optional nodes?: number

Defined in: graphty-element/src/session/sets/types.ts:143

How many nodes it holds. Present for an offer read induced, counted from the result's own values. For an offer read listed (an edge set, a path), whose nodes include its edges' endpoints, filled only once the edge-count pass is cached.


path ​

readonly path: boolean

Defined in: graphty-element/src/session/sets/types.ts:149

A path offer: createPath accepts it and keeps its order.


reading ​

readonly reading: EdgeReading

Defined in: graphty-element/src/session/sets/types.ts:147

Which edges come with its nodes: induced for a group, listed for an edge set or a path.