@itwin/unified-selection/lib/cjs/unified-selection/SelectionChangeEvent.d.ts

Package for managing unified selection in iTwin.js applications.

import { Selectables } from "./Selectable.js";
import { SelectionStorage } from "./SelectionStorage.js";
/**
 * The type of selection change.
 * @public
 */
export type StorageSelectionChangeType = 
/** Added to selection. */
"add"
/** Removed from selection. */
 | "remove"
/** Selection was replaced. */
 | "replace"
/** Selection was cleared. */
 | "clear";
/**
 * The event object that is sent when the selection changes.
 *
 * **Warning:** Used in public API as an input to consumer-supplied callback. Not expected to be created / extended
 * by package consumers, may be supplemented with required attributes any time.
 *
 * @see `StorageSelectionChangesListener`
 * @public
 */
export interface StorageSelectionChangeEventArgs {
    /** The name of the selection source which caused the selection change. */
    source: string;
    /** Level of the selection. */
    level: number;
    /** The selection change type. */
    changeType: StorageSelectionChangeType;
    /** Selectables affected by this selection change event. */
    selectables: Selectables;
    /** iModel key with which the selection is associated with. */
    imodelKey: string;
    /**
     * iModel key with which the selection is associated with.
     * @deprecated in 0.2. Use `imodelKey` instead.
     */
    iModelKey: string;
    /** The timestamp of when the selection change happened. */
    timestamp: Date;
    /** The selection storage where the event happened. */
    storage: SelectionStorage;
}
/**
 * An interface for selection change listeners.
 * @public
 */
export type StorageSelectionChangesListener = (
/** Arguments for the selection change event */
args: StorageSelectionChangeEventArgs, 
/** Unused. Temporarily left to avoid a breaking change. */
_?: any) => void;
//# sourceMappingURL=SelectionChangeEvent.d.ts.map