Hiyve Components - v1.0.0
    Preparing search index...

    Interface AnnotationCanvasProps

    interface AnnotationCanvasProps {
        clearAllPermission?: AnnotationPermission;
        isOwner: boolean;
        isSharer: boolean;
        localUserId: string;
        permission?: AnnotationPermission;
        shareId: string;
        style?: CSSProperties;
        sync?: UseAnnotationSyncResult;
        tool: AnnotationTool | null;
        videoRef: RefObject<HTMLVideoElement | null>;
    }
    Index

    Properties

    clearAllPermission? isOwner isSharer localUserId permission? shareId style? sync? tool videoRef

    Properties

    clearAllPermission?: AnnotationPermission
    isOwner: boolean
    isSharer: boolean
    localUserId: string
    permission?: AnnotationPermission
    shareId: string
    style?: CSSProperties

    Optional inline style override — merged onto the SVG container.

    sync?: UseAnnotationSyncResult

    Optional pre-built sync result. When omitted, the canvas creates its own internal useAnnotationSync against shareId / localUserId. Pass one in to share state with a sibling toolbar.

    tool: AnnotationTool | null

    Active tool. null puts the canvas in read-only mode (events pass through to the underlying video).

    videoRef: RefObject<HTMLVideoElement | null>

    Ref to the <video> element to overlay. The canvas tracks its content rect via useVideoContentRect so strokes always sit on the rendered video (not the letterbox bands).

    Settings

    Member Visibility

    On This Page

    Properties