supervision-js
    Preparing search index...

    Interface BasePercentageBarStyleOptions

    interface BasePercentageBarStyleOptions {
        value?: DetectionStyleValue<number, AnnotationStyleContext>;
        height?: DetectionStyleValue<number, AnnotationStyleContext>;
        width?: DetectionStyleValue<number | undefined, AnnotationStyleContext>;
        placement?: DetectionStyleValue<
            PercentageBarPlacement,
            AnnotationStyleContext,
        >;
        offset?: DetectionStyleValue<
            { x?: number; y?: number }
            | null
            | undefined,
            AnnotationStyleContext,
        >;
        offsetY?: number;
        background?: DetectionStyleValue<
            Partial<FillStyle>
            | null,
            AnnotationStyleContext,
        >;
        fill?: DetectionStyleValue<
            Partial<FillStyle>
            | null,
            AnnotationStyleContext,
        >;
        border?: DetectionStyleValue<
            Partial<StrokeStyle>
            | null,
            AnnotationStyleContext,
        >;
        shouldRender?: DetectionStylePredicate<AnnotationStyleContext>;
    }
    Index
    value? height? width? placement? offset? offsetY? background? fill? border? shouldRender?
    value?: DetectionStyleValue<number, AnnotationStyleContext>

    Numeric value resolver in [0, 1]. Defaults to detection.confidence ?? 0.

    height?: DetectionStyleValue<number, AnnotationStyleContext>

    Bar height in media pixels. Defaults to 8.

    width?: DetectionStyleValue<number | undefined, AnnotationStyleContext>

    Explicit bar width in media pixels. Defaults to the detection rectangle width.

    placement?: DetectionStyleValue<PercentageBarPlacement, AnnotationStyleContext>

    Placement relative to the detection bounding box. Defaults to top.

    offset?: DetectionStyleValue<
        { x?: number; y?: number }
        | null
        | undefined,
        AnnotationStyleContext,
    >

    Bar offset in media pixels.

    offsetY?: number

    Compatibility shorthand for offset: { y }.

    background?: DetectionStyleValue<
        Partial<FillStyle>
        | null,
        AnnotationStyleContext,
    >

    Background container fill. Pass null to disable the background.

    fill?: DetectionStyleValue<Partial<FillStyle> | null, AnnotationStyleContext>

    Progress fill style. Pass a resolver for per-class or dynamic colors.

    border?: DetectionStyleValue<
        Partial<StrokeStyle>
        | null,
        AnnotationStyleContext,
    >

    Outer border stroke. Pass null or omit to disable.

    shouldRender?: DetectionStylePredicate<AnnotationStyleContext>

    Return false to skip rendering a detection in this percentage bar style.

    Settings
    Member Visibility

    On This Page
    Properties