Graphty

Appearance

@graphty/graphty-element / session / EdgePageOptions

Interface: EdgePageOptions ​

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

Which edges a page holds: RecordPageOptions, plus the edges at one node.

Extends ​

Properties ​

columns? ​

readonly optional columns?: readonly ResultColumn[]

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

Run results to read for the page's records, returned as RecordPage.columns in the same order. The records themselves are unchanged.

Inherited from ​

RecordPageOptions.columns

limit? ​

readonly optional limit?: number

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

The most records the page holds; Infinity reads to the end. Default 100.

Inherited from ​

RecordPageOptions.limit

matching? ​

readonly optional matching?: object

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

Only the records that match a text, as selection.apply({ text, mode }) matches it: a node by its id and its attribute values, an edge by its id, its two endpoints' ids and its attribute values. With no mode the text may carry one as a prefix (exact:, regex:, <attribute>:); otherwise it is found anywhere, ignoring case. Combines with scope, sort and columns; total counts the matches. Selects nothing.

ts
session.data.nodePage({ matching: { text: "jav" }, limit: 30 }); // Javert, ...

mode? ​

readonly optional mode?: SelectionTextMode

text ​

readonly text: string

Inherited from ​

RecordPageOptions.matching

offset? ​

readonly optional offset?: number

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

The position of the page's first record in the ordered list. Default 0.

Inherited from ​

RecordPageOptions.offset

scope? ​

readonly optional scope?: ScopeInput

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

Which records: any scope, such as "selection" or { set: id }. Default "graph".

Inherited from ​

RecordPageOptions.scope

sort? ​

readonly optional sort?: ResultSort | RecordSort

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

The order. Absent, records come in the graph's own order: the order they were added, which an edit never changes -- a removed record leaves a gap that closes, an added one goes last. Records that sort equal keep that order too.

Inherited from ​

RecordPageOptions.sort

touching? ​

readonly optional touching?: NodeId

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

Only the edges with this node at one end or both.