@graphty/graphty-element / catalog / CatalogApi
Interface: CatalogApi ​
Defined in: graphty-element/src/catalog/types.ts:1277
The catalogue: everything the element can offer, as data.
session.catalog implements every method here except the ones named in DeprecatedCatalogMethod, which nothing implements yet.
Methods ​
algorithms() ​
algorithms(): readonly
AlgorithmDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:1278
Returns ​
readonly AlgorithmDescriptor[]
applicable() ​
applicable(): readonly
MetricAvailability[]
Defined in: graphty-element/src/catalog/types.ts:1306
The metrics that can run on this graph. A runtime query, not a static list.
Returns ​
readonly MetricAvailability[]
Deprecated ​
Not implemented; metrics() carries available and reason for the same question. Removed at the next major release unless it is implemented first (issue #334).
cameras() ​
cameras(): readonly
CameraDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:1282
Returns ​
readonly CameraDescriptor[]
formats() ​
formats(): readonly
FormatDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:1280
Returns ​
readonly FormatDescriptor[]
functions() ​
functions(): readonly
FunctionDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:1294
Returns ​
readonly FunctionDescriptor[]
Deprecated ​
Not implemented. Removed at the next major release unless it is implemented first (issue #332).
layouts() ​
layouts(): readonly
LayoutDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:1279
Returns ​
readonly LayoutDescriptor[]
logSinks() ​
logSinks(): readonly
LogSinkDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:1283
Returns ​
readonly LogSinkDescriptor[]
metrics() ​
metrics(): readonly
MetricAvailability[]
Defined in: graphty-element/src/catalog/types.ts:1300
Returns ​
readonly MetricAvailability[]
optionsFor() ​
optionsFor(
key,scope?):Promise<readonlyOptionDescriptor[]>
Defined in: graphty-element/src/catalog/types.ts:1324
The options for one algorithm or layout, with data-dependent bounds resolved for a scope.
A bound written as an OptionBound reference (or as the bare reference string) comes back as the number measured over the scope, and a "node-id" or "node-set" option comes back with values: one choice per node in the scope, its value and label the node id as a string. Every other field is the static descriptor's.
Parameters ​
key ​
"radial" | "degree" | "betweenness" | "closeness" | "pagerank" | "eigenvector" | "katz" | "hits" | "louvain" | "leiden" | "label-propagation" | "components" | "shortest-path" | "all-pairs-distance" | "all-paths" | "max-flow" | "min-cut" | "k-core" | "clustering-coefficient" | "girvan-newman" | "bfs" | "dfs" | "kruskal" | "prim" | "bipartite-matching" | "link-prediction" | "markov-clustering" | "spectral-clustering" | "hierarchical-clustering" | "astar" | "edge-betweenness" | string & object | "force" | "force-2d" | "circular" | "hierarchical" | "grid" | "shell" | "spectral" | "bipartite" | "layers" | "fixed" | "random"
An algorithm key, looked for first, or a layout id.
scope? ​
What to measure; the session's default run scope when absent.
Returns ​
Promise<readonly OptionDescriptor[]>
The options, in declaration order.
Throws ​
E_UNKNOWN_ALGORITHM when no algorithm or layout is registered under key.
palettes() ​
palettes(): readonly
PaletteDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:1281
Returns ​
readonly PaletteDescriptor[]
scales() ​
scales(): readonly
ScaleDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:1284
Returns ​
readonly ScaleDescriptor[]
themes() ​
themes(): readonly
ThemeDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:1289
Returns ​
readonly ThemeDescriptor[]
Deprecated ​
Not implemented. Removed at the next major release unless it is implemented first (issue #331).
timeAttributes() ​
timeAttributes(): readonly
AttributeDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:1299
Returns ​
readonly AttributeDescriptor[]
Deprecated ​
Not implemented. Removed at the next major release unless it is implemented first (issue #333).
validate() ​
validate(
query,o?):QueryValidation
Defined in: graphty-element/src/catalog/types.ts:1311
Parameters ​
query ​
string
o? ​
kind? ​
"filter" | "selector" | "formula"
Returns ​
Deprecated ​
Not implemented. Removed at the next major release unless it is implemented first (issue #335).