Interface ReferenceImages

interface ReferenceImages {
    clear(): void;
    pick(
        x: number,
        y: number,
        options?: PickOptions,
    ): Promise<ReferenceImageHit | null>;
    remove(id: string): void;
    set(input: ReferenceImageInput, signal?: AbortSignal): Promise<void>;
}

Index

Methods

clear pick remove set

Methods

clear

clear(): void

Returns void

pick

pick(
    x: number,
    y: number,
    options?: PickOptions,
): Promise<ReferenceImageHit | null>
CSS canvas coordinates; hidden, locked and scene-occluded references do not hit.
Parameters
- x: number
- y: number
- Optionaloptions: PickOptions
Returns Promise<ReferenceImageHit | null>

remove

remove(id: string): void
Parameters
- id: string
Returns void

set

set(input: ReferenceImageInput, signal?: AbortSignal): Promise<void>
Borrows the bitmap for upload; the caller retains ownership of the source.
Parameters
- input: ReferenceImageInput
- Optionalsignal: AbortSignal
Returns Promise<void>