supervision-js
    Preparing search index...

    Interface BaseLabelStyleOptions

    interface BaseLabelStyleOptions {
        background?: DetectionStyleValue<
            Partial<LabelBackgroundStyle>
            | undefined,
            AnnotationStyleContext,
        >;
        includeConfidence?: boolean;
        offset?: DetectionStyleValue<
            LabelOffsetStyle
            | null
            | undefined,
            AnnotationStyleContext,
        >;
        offsetY?: number;
        placement?: DetectionStyleValue<LabelPlacement, AnnotationStyleContext>;
        text?: DetectionStyleValue<string | undefined, AnnotationStyleContext>;
        textStyle?: DetectionStyleValue<
            Partial<LabelTextStyle>
            | undefined,
            AnnotationStyleContext,
        >;
        shouldRender?: DetectionStylePredicate<AnnotationStyleContext>;
        visibilityMode?: LabelVisibilityMode;
    }
    Index
    background? includeConfidence? offset? offsetY? placement? text? textStyle? shouldRender? visibilityMode?
    background?: DetectionStyleValue<
        Partial<LabelBackgroundStyle>
        | undefined,
        AnnotationStyleContext,
    >

    Label background style. Pass a resolver for per-class label backgrounds.

    includeConfidence?: boolean

    Include confidence percentage in the default label text.

    offset?: DetectionStyleValue<
        LabelOffsetStyle
        | null
        | undefined,
        AnnotationStyleContext,
    >

    Label offset in media pixels. Pass a resolver for per-detection label placement.

    offsetY?: number

    Compatibility shorthand for offset: { y }.

    Prefer offset for new code.

    placement?: DetectionStyleValue<LabelPlacement, AnnotationStyleContext>

    Label placement relative to the detection rectangle.

    Optional Readonlytext

    text?: DetectionStyleValue<string | undefined, AnnotationStyleContext>

    Custom label text. Return undefined to fall back to the default class label.

    textStyle?: DetectionStyleValue<
        Partial<LabelTextStyle>
        | undefined,
        AnnotationStyleContext,
    >

    Label text style. Pass a resolver for per-class text colors or sizes.

    shouldRender?: DetectionStylePredicate<AnnotationStyleContext>

    Return false to skip rendering a detection in this label style.

    visibilityMode?: LabelVisibilityMode

    Settings
    Member Visibility

    On This Page
    Properties