Appearance

@graphty/graphty-element / catalog / DatasetMeta

Interface: DatasetMeta ​

Defined in: graph-samples/dist/src/datasets/build.d.ts:5

What a dataset is, where it came from and under which terms.

Properties ​

attributes ​

readonly attributes: Readonly<Record<string, string>>

Defined in: graph-samples/dist/src/datasets/build.d.ts:27

The node columns, name to description.

bytes? ​

readonly optional bytes?: number

Defined in: graph-samples/dist/src/datasets/build.d.ts:38

The download size: the bytes of its .gsnp.gz file.

citation ​

readonly citation: string

Defined in: graph-samples/dist/src/datasets/build.d.ts:13

The reference to cite.

description ​

readonly description: string

Defined in: graph-samples/dist/src/datasets/build.d.ts:11

One or two sentences on what the nodes and edges are.

directed ​

readonly directed: boolean

Defined in: graph-samples/dist/src/datasets/build.d.ts:23

Whether the edges are directed.

edges ​

readonly edges: number

Defined in: graph-samples/dist/src/datasets/build.d.ts:21

The edge count.

groundTruth ​

readonly groundTruth: string | null

Defined in: graph-samples/dist/src/datasets/build.d.ts:29

The node column holding the ground-truth grouping, or null when there is none.

hosting? ​

readonly optional hosting?: "remote" | "bundled"

Defined in: graph-samples/dist/src/datasets/build.d.ts:36

Where the graph data lives. Every dataset is "remote": published on graphty.app and loaded with fetchDataset(name). "bundled" (the data inside the package) is no longer used.

license ​

readonly license: string

Defined in: graph-samples/dist/src/datasets/build.d.ts:17

The license as known, or "unclear" with what is known.

name ​

readonly name: string

Defined in: graph-samples/dist/src/datasets/build.d.ts:7

The dataset name: fetchDataset(name), and for the small ones the subpath @graphty/graph-samples/datasets/<name>.

nodes ​

readonly nodes: number

Defined in: graph-samples/dist/src/datasets/build.d.ts:19

The node count.

sha256? ​

readonly optional sha256?: string

Defined in: graph-samples/dist/src/datasets/build.d.ts:40

The checksum: the SHA-256 of its .gsnp.gz file, lowercase hex.

showcases ​

readonly showcases: readonly string[]

Defined in: graph-samples/dist/src/datasets/build.d.ts:31

The algorithms and layouts it shows off.

source ​

readonly source: string

Defined in: graph-samples/dist/src/datasets/build.d.ts:15

The URL the data was converted from.

thumbnail? ​

readonly optional thumbnail?: string

Defined in: graph-samples/dist/src/datasets/build.d.ts:46

A small picture of the graph (a 480 x 300 WebP with a transparent background, drawn by graphty-element): its file name beside the dataset's file, so its address is the dataset base URL plus this name. Absent when the dataset has none.

title ​

readonly title: string

Defined in: graph-samples/dist/src/datasets/build.d.ts:9

The human-readable title.

weighted ​

readonly weighted: boolean

Defined in: graph-samples/dist/src/datasets/build.d.ts:25

Whether the edges carry weights.