Interface UseFileAnnotationsResult

interface UseFileAnnotationsResult {
    getMarkersForFile: (fileId: string) => FileTimelineMarker[];
    getRegionsForFile: (fileId: string) => FileRegion[];
    handleMarkerAdd: (fileId: string, marker: FileTimelineMarker) => void;
    handleMarkerChange: (fileId: string, marker: FileTimelineMarker) => void;
    handleMarkerDelete: (fileId: string, markerId: string) => void;
    handleRegionChange: (fileId: string, region: FileRegion) => void;
    handleRegionDelete: (fileId: string, regionId: string) => void;
}

Properties

getMarkersForFile: (fileId: string) => FileTimelineMarker[]

Get all markers for a file by its ID.

getRegionsForFile: (fileId: string) => FileRegion[]

Get all named regions for a file by its ID.

handleMarkerAdd: (fileId: string, marker: FileTimelineMarker) => void

Add a new marker to a file. Enriches with authorId/authorName/createdAt.

handleMarkerChange: (fileId: string, marker: FileTimelineMarker) => void

Update an existing marker on a file.

handleMarkerDelete: (fileId: string, markerId: string) => void

Delete a marker from a file by marker ID.

handleRegionChange: (fileId: string, region: FileRegion) => void

Create or update a named region on a file.

handleRegionDelete: (fileId: string, regionId: string) => void

Delete a named region from a file by region ID.