AggregationConfig

interface AggregationConfig<A extends Annotation>

This defines the parameters for a call to an Annotation aggregration function.

Type parameters

  • A: Annotation

Properties

annotations

annotations: A []

The list of Annotations to be aggregated.

criterion

criterion: (a: A, b: A): boolean

The comparison function that serves as the criterion for aggregation.

idPrefix

idPrefix: undefined | string

The ID prefix for each resulting AnnotationGroup. E.g. if the idPrefix “group” is supplied, the resulting groups will have IDs of the form: “group-1,” “group-2,” etc.