Skip to content

@graphty/graphty-element / session / VisibilityChange

Interface: VisibilityChange ​

Defined in: graphty-element/src/session/visibility/VisibilityApi.ts:156

What one visibility change was, as an event carries it.

filterKind names WHAT PRODUCED THIS CHANGE, not what state the model is in: the filter's kind for a filter, "window" for a time window, "context" for the context flag, and "none" when the producer was cleared.

Extends ​

Properties ​

cause ​

readonly cause: HistoryCause

Defined in: graphty-element/src/session/visibility/VisibilityApi.ts:160

Whether an edit, an undo, a redo, a restore or a rolled-back transaction made it.


durationMs ​

readonly durationMs: number

Defined in: graphty-element/src/session/visibility/VisibilityApi.ts:146

How long the pass took, in milliseconds.

Inherited from ​

FilterResult.durationMs


filterKind ​

readonly filterKind: string

Defined in: graphty-element/src/session/visibility/VisibilityApi.ts:158

What produced this change.


total ​

readonly total: object

Defined in: graphty-element/src/session/visibility/VisibilityApi.ts:131

How many elements the graph holds.

edges ​

readonly edges: number

Edges in the graph.

nodes ​

readonly nodes: number

Nodes in the graph.

Inherited from ​

FilterResult.total


unresolvedPaths ​

readonly unresolvedPaths: readonly string[]

Defined in: graphty-element/src/session/visibility/VisibilityApi.ts:144

The paths nothing in this session answered.

Matching nothing is a LEGITIMATE answer for a filter, so an unanswerable path is reported beside the counts instead of thrown: a consumer can say "0 matched -- data.rank is not an attribute on this graph" rather than showing a confident empty screen.

Inherited from ​

FilterResult.unresolvedPaths


visible ​

readonly visible: object

Defined in: graphty-element/src/session/visibility/VisibilityApi.ts:124

How many elements are visible now.

edges ​

readonly edges: number

Visible edges.

nodes ​

readonly nodes: number

Visible nodes.

Inherited from ​

FilterResult.visible