Skip to main content

structureSort

Sorting function to arrange structures by stage, positionAssignments count (size) then stageSequence Used internally to order Compass structures

import { tools } from 'tods-competition-factory';
const sortedStructures = drawDefinition.structures.sort(tools.structureSort);

Optionally pass configuration object.​

Mode 'finishing positions' sorts MAIN stage structures by participant final positions first, followwed by PLAY_OFF, CONSOLATION, QUALIFYING and finally VOLUNTARY_CONSOLATION. NOTE: Compass directions are all considered MAIN stage.

import { drawDefinitionConstants, tools } from 'tods-competition-factory';
const { FINISHING_POSITIONS } = drawDefinitionConstants;

const sortedStructures = drawDefinition.structures.sort((a, b) =>
  tools.structureSort(a, b, { mode: FINISHING_POSITIONS }),
);

Mode 'aggregate event structures' is for use when structures from multiple drawDefinitions, potentially across multiple events, have been aggregated. Sorts MAIN stageSequence: 1 first, then PLAY_OFF structures, remaining MAIN stageSequences, followed by CONSOLATION, QUALIFYING and finally VOLUNTARY_CONSOLATION.

import { drawDefinitionConstants, tools } from 'tods-competition-factory';
const { AGGREGATE_EVENT_STRUCTURES } = drawDefinitionConstants;

const sortedStructures = drawDefinition.structures.sort((a, b) =>
  tools.structureSort(a, b, { mode: AGGREGATE_EVENT_STRUCTURES }),
);