supervision-js
    Preparing search index...

    Interface MediaInteractionOptions

    The renderer supplies viewportScale from its own viewport.

    interface MediaInteractionOptions {
        preferTopmost?: boolean;
        padding?: number;
        polylinePadding?: number;
        keypointPadding?: number;
        edgePadding?: number;
        maskMediaDimensions?: { width: number; height: number };
        includeLocked?: boolean;
        includeMasks?: boolean;
        filter?: (detection: Detection, detectionIndex: number) => boolean;
        mode?: MediaInteractionMode;
        onHover?: (pick: DetectionPickResult | null) => void;
        onSelect?: (pick: DetectionPickResult | null) => void;
        multiSelect?: boolean;
        onSelectionChange?: (picks: readonly DetectionPickResult[]) => void;
        onMarqueeChange?: (
            rect: { x: number; y: number; width: number; height: number } | null,
        ) => void;
    }

    Hierarchy

    Index
    preferTopmost? padding? polylinePadding? keypointPadding? edgePadding? maskMediaDimensions? includeLocked? includeMasks? filter? mode? onHover? onSelect? multiSelect? onSelectionChange? onMarqueeChange?
    preferTopmost?: boolean

    Pick editable geometry by zIndex, then frame order, rather than area. Rects accompanying masks or paths are bounds, not independent box targets; mask fills stay below vector geometry. Defaults to false.

    padding?: number
    polylinePadding?: number
    keypointPadding?: number
    edgePadding?: number
    maskMediaDimensions?: { width: number; height: number }

    Media dimensions used to map media-space points into mask raster space.

    includeLocked?: boolean
    includeMasks?: boolean
    filter?: (detection: Detection, detectionIndex: number) => boolean
    mode?: MediaInteractionMode
    onHover?: (pick: DetectionPickResult | null) => void
    onSelect?: (pick: DetectionPickResult | null) => void

    Reports selection identity changes. A stable, frame-unique detection id may keep rendering as selected across later frames without re-emitting this callback. The pick is the immutable frame snapshot where the selection event occurred; use the detection id with the active frame when current geometry is required.

    multiSelect?: boolean
    onSelectionChange?: (picks: readonly DetectionPickResult[]) => void

    Reports selection membership changes, not per-frame geometry updates for stable detection ids. Each pick is the snapshot that produced that membership event.

    onMarqueeChange?: (
        rect: { x: number; y: number; width: number; height: number } | null,
    ) => void

    Settings
    Member Visibility

    On This Page
    Properties