Appearance

@graphty/graphty-element / index / SourceSample

Interface: SourceSample ​

Defined in: graph-io/dist/src/sources/types.d.ts:294

A public example a source offers. Experimental.

Properties ​

counts? ​

readonly optional counts?: object

Defined in: graph-io/dist/src/sources/types.d.ts:311

How big it is.

edges? ​

readonly optional edges?: number

How many edges.

nodes? ​

readonly optional nodes?: number

How many nodes.

endpoint? ​

readonly optional endpoint?: string

Defined in: graph-io/dist/src/sources/types.d.ts:302

The endpoint, when not the source's default.

id ​

readonly id: string

Defined in: graph-io/dist/src/sources/types.d.ts:296

Its id ("neo4j-movies").

params ​

readonly params: Readonly<Record<string, unknown>>

Defined in: graph-io/dist/src/sources/types.d.ts:300

The params that load it.

plainName ​

readonly plainName: string

Defined in: graph-io/dist/src/sources/types.d.ts:298

Its default name; catalog data.

publicLogin? ​

readonly optional publicLogin?: object

Defined in: graph-io/dist/src/sources/types.d.ts:304

A login the service publishes for everyone; never stored.

password ​

readonly password: string

The password, published by the service for everyone.

username ​

readonly username: string

The user name.

whole? ​

readonly optional whole?: boolean

Defined in: graph-io/dist/src/sources/types.d.ts:318

false: too big to load whole; start from a neighborhood.