Black Trigram (흑괘) - Korean Martial Arts Combat Simulator API - v0.6.9
    Preparing search index...

    Interface VitalPointOverlayControlsProps

    Props for VitalPointOverlayControls component

    interface VitalPointOverlayControlsProps {
        animated: boolean;
        isMobile?: boolean;
        onAnimatedChange: (animated: boolean) => void;
        onRegionFilterChange: (filter: BodyRegionFilter) => void;
        onScaleChange: (scale: number) => void;
        onSearchQueryChange?: (query: string) => void;
        onSeverityFiltersChange: (filters: VitalPointSeverity[]) => void;
        onShowLabelsChange: (show: boolean) => void;
        onVisibleChange: (visible: boolean) => void;
        regionFilter: BodyRegionFilter;
        scale: number;
        screenPosition?: {
            bottom?: string;
            left?: string;
            right?: string;
            top?: string;
        };
        searchQuery?: string;
        severityFilters: VitalPointSeverity[];
        showLabels: boolean;
        visible: boolean;
    }
    Index

    Properties

    animated isMobile? onAnimatedChange onRegionFilterChange onScaleChange onSearchQueryChange? onSeverityFiltersChange onShowLabelsChange onVisibleChange regionFilter scale screenPosition? searchQuery? severityFilters showLabels visible

    Properties

    animated: boolean

    Whether animations are enabled

    isMobile?: boolean

    Whether on mobile device

    onAnimatedChange: (animated: boolean) => void

    Callback when animation state changes

    onRegionFilterChange: (filter: BodyRegionFilter) => void

    Callback when region filter changes

    onScaleChange: (scale: number) => void

    Callback when scale changes

    onSearchQueryChange?: (query: string) => void

    Callback when search query changes

    onSeverityFiltersChange: (filters: VitalPointSeverity[]) => void

    Callback when severity filters change

    onShowLabelsChange: (show: boolean) => void

    Callback when label visibility changes

    onVisibleChange: (visible: boolean) => void

    Callback when visibility changes

    regionFilter: BodyRegionFilter

    Current region filter

    scale: number

    Marker scale multiplier

    screenPosition?: {
        bottom?: string;
        left?: string;
        right?: string;
        top?: string;
    }

    Screen position for the control panel.

    All values must be valid CSS position values, such as "20px", "10%", "1rem", or "auto". These are applied directly to the style of the Html overlay container.

    Type Declaration

    • Optionalbottom?: string

      CSS bottom position (e.g., "20px", "10%", "1rem", "auto")

    • Optionalleft?: string

      CSS left position (e.g., "20px", "10%", "1rem", "auto")

    • Optionalright?: string

      CSS right position (e.g., "20px", "10%", "1rem", "auto")

    • Optionaltop?: string

      CSS top position (e.g., "20px", "10%", "1rem", "auto")

    searchQuery?: string

    Current search query

    severityFilters: VitalPointSeverity[]

    Current severity filters

    showLabels: boolean

    Whether labels are shown

    visible: boolean

    Whether overlay is currently visible

    Settings

    Member Visibility

    On This Page

    Properties