Graphty

Appearance

@graphty/graphty-element / session / LoadReport

Interface: LoadReport ​

Defined in: graphty-element/src/data/report.ts:128

An ImportReport plus two facts a reader checks before and after a load: session.data.lastImport() and LoadDraft.report() both return it.

Extends ​

Properties ​

counts ​

readonly counts: object

Defined in: graphty-element/src/data/report.ts:42

The numbers that used to be one, and disagreed.

edgeRecords ​

readonly edgeRecords: number

Edge records handed over, however many of them became edges.

edges ​

readonly edges: number

Edges the graph holds after the load.

nodeRecords ​

readonly nodeRecords: number

Node records handed over, which is fewer than nodes when an edge named an endpoint the file never declared as a node of its own.

nodes ​

readonly nodes: number

Nodes the graph holds after the load.

rejected ​

readonly rejected: number

Records that became nothing: an edge record whose endpoint ids the store would not take, and a node record with no usable id (absent, null, or not a string or a finite number). LoadDraft.rows(id, { only: "rejected" }) lists them before a load.

Inherited from ​

ImportReport.counts

duplicates ​

readonly duplicates: object

Defined in: graphty-element/src/data/report.ts:141

Node rows whose id an earlier node row of the same load already gave: rows is how many such rows there are, and ids the distinct ids, in the order they first repeated. What became of them is LoadChoices.duplicateIds; under "refuse" a load refuses with E_DUPLICATE_ID and a report counts them here. Counted for CSV and JSON node records; a graph file (GraphML, GEXF, GML, ...) has a repeated id folded by its parser before the element sees it, so it is not counted.

ids ​

readonly ids: readonly (string | number)[]

rows ​

readonly rows: number

edgeIdentity ​

readonly edgeIdentity: object

Defined in: graphty-element/src/data/report.ts:78

How a set, a style layer or a saved reference will find the edges this load stored again: by the file's own edge id, or, without one, by position among the edges of the same pair. A reference by position matches a different edge if a later file lists that pair's edges in another order, which is why the report says how many there are.

byId ​

readonly byId: number

Edges stored with a file id.

byPosition ​

readonly byPosition: number

Edges stored without one, matched by position among their pair's edges.

idPath ​

readonly idPath: string | null

The record key file ids were read at (knownFields.edgeIdPath), or null when none is configured.

Inherited from ​

ImportReport.edgeIdentity

endpoints ​

readonly endpoints: object

Defined in: graphty-element/src/data/report.ts:33

Which record keys named the endpoints, and how that was decided.

resolvedFrom ​

readonly resolvedFrom: EndpointSpelling

Which spelling answered, or "declared" when the caller named the columns.

source ​

readonly source: string

The JMESPath expression the source endpoint was read with.

target ​

readonly target: string

The JMESPath expression the target endpoint was read with.

Inherited from ​

ImportReport.endpoints

errors ​

readonly errors: readonly LoadError[]

Defined in: graphty-element/src/data/report.ts:149

Every problem the load met, in the order met, at most the source's errorLimit of them: the source's own (a GraphML or GEXF file that breaks off, a CSV row it could not read), then the records the graph refused. Empty for a clean load. A recognisable graph file that breaks off keeps what was read before the break, and its "parse-error" entry carries the line it broke on.

format ​

readonly format: string

Defined in: graphty-element/src/data/report.ts:31

The data source that read the file, or "records" for pushed data.

Inherited from ​

ImportReport.format

policy ​

readonly policy: DuplicatePolicy

Defined in: graphty-element/src/data/report.ts:64

The repeat policy that was in force.

Inherited from ​

ImportReport.policy

repeated ​

readonly repeated: RepeatedEdgeCounts

Defined in: graphty-element/src/data/report.ts:62

What happened to the records that named a pair the graph already held.

Inherited from ​

ImportReport.repeated

tooLarge ​

readonly tooLarge: TooLargeDetails | null

Defined in: graphty-element/src/data/report.ts:132

The details E_TOO_LARGE would carry; null when the load fits. Always null after a real load, which refuses instead.

unmatched ​

readonly unmatched: object

Defined in: graphty-element/src/data/report.ts:130

Edge rows naming a node no node row (nor the graph, for a merge) held, and how many distinct such names.

rows ​

readonly rows: number

values ​

readonly values: number

weights ​

readonly weights: object

Defined in: graphty-element/src/data/report.ts:66

Where each edge's weight came from.

attribute ​

readonly attribute: string | null

The record key weights were read from, or null when no record carried one.

resolvedFrom ​

readonly resolvedFrom: "none" | "path" | "legacy"

"path" for the configured key, "legacy" for the value fallback, "none" for neither.

Inherited from ​

ImportReport.weights