@graphty/graphty-element / session / FieldDescriptor
Interface: FieldDescriptor ​
Defined in: graphty-element/src/catalog/types.ts:361
One field a result publishes, per element or for the graph as a whole.
Properties ​
interpretation? ​
optionalinterpretation?:FieldInterpretation
Defined in: graphty-element/src/catalog/types.ts:370
How to read the value, for a quality score whose number alone means little.
kind ​
kind:
"node"|"edge"|"graph"
Defined in: graphty-element/src/catalog/types.ts:365
measurement? ​
optionalmeasurement?:Measurement
Defined in: graphty-element/src/catalog/types.ts:376
What the field's values measure, declared by the algorithm. A partition's group field is "categorical" by construction. Absent, the element reads strings and booleans as categorical and numbers as quantitative.
name ​
name:
string
Defined in: graphty-element/src/catalog/types.ts:362
normalization? ​
optionalnormalization?:string
Defined in: graphty-element/src/catalog/types.ts:368
path ​
path:
string
Defined in: graphty-element/src/catalog/types.ts:377
plainName ​
plainName:
string
Defined in: graphty-element/src/catalog/types.ts:363
technicalName ​
technicalName:
string
Defined in: graphty-element/src/catalog/types.ts:364
type ​
type:
"string"|"number"|"boolean"|"integer"|"table"
Defined in: graphty-element/src/catalog/types.ts:366
unit? ​
optionalunit?:string
Defined in: graphty-element/src/catalog/types.ts:367