@graphty/graphty-element / extend / communityFields

Function: communityFields()

communityFields(value): readonly FieldDescriptor[]

Defined in: graphty-element/src/algorithms/metrics/fields.ts:128

Build the fields every community result publishes: the group, and the sizes and count the element derives from it; modularity only when asked for, because only a method that scores its own partition may publish one. A run fills what communityFieldSpecs lists.

Parameters

value

What one group is called, and whether the method publishes modularity.

modularity?

boolean

Whether the method scores its partition with modularity.

plainName

string

What one group is called in plain words, such as "Community".

technicalName

string

What a paper calls the grouping.

Returns

readonly FieldDescriptor[]

The uniform field list for the community shape.