Graphty

Appearance

@graphty/graphty-element / session / RESULT_SHAPE_CONTRACTS

Variable: RESULT_SHAPE_CONTRACTS ​

const RESULT_SHAPE_CONTRACTS: object

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

The ten result shapes and the fields each one publishes.

satisfies Record<ResultShape, ...> is what keeps this table and the shape union from drifting: a shape with no entry fails to compile, and so does an entry for a shape that does not exist.

Type Declaration ​

category-table ​

readonly category-table: object

category-table.edgeFields ​

readonly edgeFields: readonly [] = []

category-table.graphFields ​

readonly graphFields: readonly ["categories"]

category-table.headlineScalar ​

readonly headlineScalar: false = false

category-table.layer ​

readonly layer: "encoding" = "encoding"

category-table.nodeFields ​

readonly nodeFields: readonly ["category", "score", "rank"]

category-table.optionalGraphFields ​

readonly optionalGraphFields: readonly [] = []

category-table.primaryField ​

readonly primaryField: "category" = "category"

category-table.shape ​

readonly shape: "category-table" = "category-table"

community ​

readonly community: object

community.edgeFields ​

readonly edgeFields: readonly [] = []

community.graphFields ​

readonly graphFields: readonly ["groupCount", "sizes"]

community.headlineScalar ​

readonly headlineScalar: false = false

community.layer ​

readonly layer: "encoding" = "encoding"

community.nodeFields ​

readonly nodeFields: readonly ["group", "groupSize"]

community.optionalGraphFields ​

readonly optionalGraphFields: readonly ["modularity"]

community.primaryField ​

readonly primaryField: "group" = "group"

community.shape ​

readonly shape: "community" = "community"

edge-metric ​

readonly edge-metric: object

edge-metric.edgeFields ​

readonly edgeFields: readonly ["value", "rank", "percentile"]

edge-metric.graphFields ​

readonly graphFields: readonly ["min", "max", "median", "mean", "measured", "normalization", "tiedAtMin"]

edge-metric.headlineScalar ​

readonly headlineScalar: false = false

edge-metric.layer ​

readonly layer: "encoding" = "encoding"

edge-metric.nodeFields ​

readonly nodeFields: readonly [] = []

edge-metric.optionalGraphFields ​

readonly optionalGraphFields: readonly [] = []

edge-metric.primaryField ​

readonly primaryField: "value" = "value"

edge-metric.shape ​

readonly shape: "edge-metric" = "edge-metric"

edge-set ​

readonly edge-set: object

edge-set.edgeFields ​

readonly edgeFields: readonly ["in"]

edge-set.graphFields ​

readonly graphFields: readonly ["count"]

edge-set.headlineScalar ​

readonly headlineScalar: true = true

edge-set.layer ​

readonly layer: "highlight" = "highlight"

edge-set.nodeFields ​

readonly nodeFields: readonly [] = []

edge-set.optionalGraphFields ​

readonly optionalGraphFields: readonly [] = []

edge-set.primaryField ​

readonly primaryField: "in" = "in"

edge-set.shape ​

readonly shape: "edge-set" = "edge-set"

fact ​

readonly fact: object

fact.edgeFields ​

readonly edgeFields: readonly [] = []

fact.graphFields ​

readonly graphFields: readonly [] = []

fact.headlineScalar ​

readonly headlineScalar: false = false

fact.layer ​

readonly layer: "none" = "none"

fact.nodeFields ​

readonly nodeFields: readonly [] = []

fact.optionalGraphFields ​

readonly optionalGraphFields: readonly [] = []

fact.primaryField ​

readonly primaryField: null = null

fact.shape ​

readonly shape: "fact" = "fact"

layered-grouping ​

readonly layered-grouping: object

layered-grouping.edgeFields ​

readonly edgeFields: readonly [] = []

layered-grouping.graphFields ​

readonly graphFields: readonly ["levelCount", "sizes"]

layered-grouping.headlineScalar ​

readonly headlineScalar: false = false

layered-grouping.layer ​

readonly layer: "encoding" = "encoding"

layered-grouping.nodeFields ​

readonly nodeFields: readonly ["level", "levelSize"]

layered-grouping.optionalGraphFields ​

readonly optionalGraphFields: readonly [] = []

layered-grouping.primaryField ​

readonly primaryField: "level" = "level"

layered-grouping.shape ​

readonly shape: "layered-grouping" = "layered-grouping"

node-metric ​

readonly node-metric: object

node-metric.edgeFields ​

readonly edgeFields: readonly [] = []

node-metric.graphFields ​

readonly graphFields: readonly ["min", "max", "median", "mean", "measured", "normalization", "tiedAtMin"]

node-metric.headlineScalar ​

readonly headlineScalar: false = false

node-metric.layer ​

readonly layer: "encoding" = "encoding"

node-metric.nodeFields ​

readonly nodeFields: readonly ["value", "rank", "percentile"]

node-metric.optionalGraphFields ​

readonly optionalGraphFields: readonly [] = []

node-metric.primaryField ​

readonly primaryField: "value" = "value"

node-metric.shape ​

readonly shape: "node-metric" = "node-metric"

node-set ​

readonly node-set: object

node-set.edgeFields ​

readonly edgeFields: readonly [] = []

node-set.graphFields ​

readonly graphFields: readonly ["count"]

node-set.headlineScalar ​

readonly headlineScalar: true = true

node-set.layer ​

readonly layer: "highlight" = "highlight"

node-set.nodeFields ​

readonly nodeFields: readonly ["in"]

node-set.optionalGraphFields ​

readonly optionalGraphFields: readonly [] = []

node-set.primaryField ​

readonly primaryField: "in" = "in"

node-set.shape ​

readonly shape: "node-set" = "node-set"

pair-list ​

readonly pair-list: object

pair-list.edgeFields ​

readonly edgeFields: readonly [] = []

pair-list.graphFields ​

readonly graphFields: readonly ["pairs"]

pair-list.headlineScalar ​

readonly headlineScalar: false = false

pair-list.layer ​

readonly layer: "none" = "none"

pair-list.nodeFields ​

readonly nodeFields: readonly [] = []

pair-list.optionalGraphFields ​

readonly optionalGraphFields: readonly [] = []

pair-list.primaryField ​

readonly primaryField: "pairs" = "pairs"

pair-list.shape ​

readonly shape: "pair-list" = "pair-list"

path ​

readonly path: object

path.edgeFields ​

readonly edgeFields: readonly ["onPath"]

path.graphFields ​

readonly graphFields: readonly ["length", "cost", "hops"]

path.headlineScalar ​

readonly headlineScalar: false = false

path.layer ​

readonly layer: "highlight" = "highlight"

path.nodeFields ​

readonly nodeFields: readonly ["onPath", "order"]

path.optionalGraphFields ​

readonly optionalGraphFields: readonly [] = []

path.primaryField ​

readonly primaryField: "onPath" = "onPath"

path.shape ​

readonly shape: "path" = "path"

temporal ​

readonly temporal: object

temporal.edgeFields ​

readonly edgeFields: readonly [] = []

temporal.graphFields ​

readonly graphFields: readonly ["steps", "series", "rates", "changeThreshold"]

temporal.headlineScalar ​

readonly headlineScalar: false = false

temporal.layer ​

readonly layer: "none" = "none"

temporal.nodeFields ​

readonly nodeFields: readonly [] = []

temporal.optionalGraphFields ​

readonly optionalGraphFields: readonly [] = []

temporal.primaryField ​

readonly primaryField: "series" = "series"

temporal.shape ​

readonly shape: "temporal" = "temporal"