Skip to main content

AnnotationCandidatesListProps

@fovea/annotation-tool


@fovea/annotation-tool / components/AnnotationCandidatesList / AnnotationCandidatesListProps

Interface: AnnotationCandidatesListProps

Defined in: src/components/AnnotationCandidatesList.tsx:36

Props for AnnotationCandidatesList component.

Properties

frames

frames: FrameDetections[]

Defined in: src/components/AnnotationCandidatesList.tsx:44

Detection results from the API.


initialConfidenceThreshold?

optional initialConfidenceThreshold: number

Defined in: src/components/AnnotationCandidatesList.tsx:77

Initial confidence threshold filter (0-1).

Default

0.3

onAccept()?

optional onAccept: (detection, frameNumber) => void

Defined in: src/components/AnnotationCandidatesList.tsx:63

Callback when a detection is accepted.

Parameters

detection

Detection

frameNumber

number

Returns

void


onReject()?

optional onReject: (detection, frameNumber) => void

Defined in: src/components/AnnotationCandidatesList.tsx:67

Callback when a detection is rejected.

Parameters

detection

Detection

frameNumber

number

Returns

void


personaId?

optional personaId: string

Defined in: src/components/AnnotationCandidatesList.tsx:49

Persona ID for type-based annotations. If provided, candidates are converted to TypeAnnotations.


showThumbnails?

optional showThumbnails: boolean

Defined in: src/components/AnnotationCandidatesList.tsx:72

Show frame thumbnails with bounding box overlays.

Default

false

typeCategory?

optional typeCategory: "entity" | "role" | "event"

Defined in: src/components/AnnotationCandidatesList.tsx:59

Type category for type-based annotations. Required if personaId is provided.


typeId?

optional typeId: string

Defined in: src/components/AnnotationCandidatesList.tsx:54

Type ID for type-based annotations. Required if personaId is provided.


videoId

videoId: string

Defined in: src/components/AnnotationCandidatesList.tsx:40

Video identifier for the detections.