@sheetxl/sdk 0.7.21 → 0.7.23-beta.2

package/types/src/movable/IMovable.d.ts

@@ -0,0 +1,327 @@
+import { Bounds, Point, ReferenceableClipboard } from '@sheetxl/utils';
+import { ITypes } from '../type';
+import { ITransaction } from '../transaction';
+import { IResource } from '../resource';
+import { IListener } from '../listener';
+import { IModel } from '../model';
+import { ICellRange } from '../cellRange';
+import { IHistory } from '../history';
+import { IAnchored } from '../anchored';
+import { IMovableCollection } from './IMovableCollection';
+/**
+ * Capabilities for working with graphical elements that can be
+ * arbitrarily placed (floated) within a virtual 'canvas'.
+ *
+ * Encompasses objects like images, charts, shapes, and custom widgets.
+ *
+ * Key features include:
+ * - Inserting, positioning, resizing, and scaling movables.
+ * - Grouping and layering multiple movables.
+ * - Loading, saving, and copy/pasting movables.
+ */
+export interface IMovable extends IAnchored, ITransaction.ITransactional, IHistory.ISnapshotSource<IMovable.SnapshotDestination, IMovable, Bounds> {
+    /**
+     * Returns the range this movable is anchored to.
+     *
+     * @remarks
+     * A movable occupies exactly one rectangle, which is why the singular lives here rather than on
+     * {@link IAnchored}. Invalid, never `null`, once the movable is no longer anchored.
+     */
+    getRange(options?: ICellRange.GetRangeOptions): ICellRange;
+    /**
+     * Returns the content of the movable.
+     */
+    getContent<T extends IModel>(): T;
+    /**
+     * Selects the current movable.
+     *
+     * @returns An async boolean indicating the movable was selected.
+     */
+    select(options?: IMovable.SelectOptions): Promise<boolean>;
+    /**
+     * Remove the movable the current selection.
+     * @returns A flag indicating if it was previously in the selection.
+     */
+    unselect: () => boolean;
+    /**
+     * Returns a flag indicating if the movable is selected.
+     */
+    isSelected: () => boolean;
+    /**
+     * Set the absolution position of a movable in pixels.
+     * @param bounds The new bounds.
+     *
+     * @remarks
+     * If only some of the points are provided then only those will be moved.
+     */
+    setBounds(bounds: Partial<Bounds>, options?: ITransaction.OperationOptions): IMovable;
+    /**
+     * Scroll the movable into the viewport.
+     *
+     * @returns A promise that resolve to a `boolean` when the scroll is complete.
+     *
+     * @remarks
+     * This will return when the scroll view is loaded but before any scroll animations have started or finished.
+     */
+    scrollIntoView: (options?: globalThis.ScrollIntoViewOptions | boolean) => Promise<boolean>;
+    /**
+     * Returns the absolute bounds of the movable object in pixels or `null` if not yet laid out.
+     */
+    getBounds(): Bounds | null;
+    /**
+     * Set the name for a movable object.
+     *
+     * @param name The name of the IMovable.
+     */
+    setName(name: string): IMovable;
+    /**
+     * @see
+     * {@link setName}
+     *
+     * @returns The name or `null` if the movable has been deleted.
+     */
+    getName(): string | null;
+    /**
+     * This is the alternative text use for assistive technologies.
+     */
+    setDescription(description: string | null): IMovable;
+    /**
+     * @see
+     * {@link setDescription}
+     *
+     * @returns The description or `null` if none has been set (or the movable has been deleted).
+     */
+    getDescription(): string | null;
+    /**
+     * If true then the movable object is hidden.
+     */
+    setHidden(hidden: boolean): IMovable;
+    /**
+     * @see
+     * {@link setHidden}
+     */
+    isHidden(): boolean;
+    /**
+     * Set the rotation in degrees.
+     */
+    setRotation(rotation: number): IMovable;
+    /**
+     * @see
+     * {@link setHidden}
+     */
+    getRotation(): number;
+    /**
+     * If true then the aspect should be maintained during resize if using the corners or if
+     * the api only specifies one dimension.
+     *
+     * @remarks
+     * Lock aspect ratio will have different default values depending on the movable type.
+     */
+    setLockAspectRatio(locked: boolean): IMovable;
+    /**
+     * @see
+     * {@link setLockAspectRatio}
+     */
+    isLockAspectRatio(): boolean;
+    /**
+     * Ses the anchor type.
+     */
+    setAnchorType(anchorType: IAnchored.Type): IMovable;
+    /**
+     * The order in the z plane. To adjust this use the move methods.
+     */
+    getZIndex(): number;
+    /**
+     * Move movable to the back in the zIndex.
+     */
+    moveToBack(): this;
+    /**
+     * Move movable backward one layer in the zIndex.
+     */
+    moveBackward(): this;
+    /**
+     * Move movable to the font in the zIndex.
+     */
+    moveToFront(): this;
+    /**
+     * Move movable forward one layer in the zIndex.
+     */
+    moveForward(): this;
+    /**
+     * Add Listeners.
+     *
+     * @see
+     * {@link IListener.ISource.addListeners}
+     */
+    addListeners(listeners: IMovable.IListeners, options?: IListener.Options): IListener.Remove;
+    /**
+     * If defined this will be called when the containing sheet is being
+     * serialized.
+     */
+    toJSON?(toResourceId?: (resource: IResource) => number | null): IMovable.JSON;
+    /**
+     * For runtime type checking.
+     */
+    readonly isIMovable: true;
+}
+/**
+ * {@inheritDoc IMovable}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IMovable}
+ */
+export declare namespace IMovable {
+    /**
+     * Extends {@link ITypes.SelectOptions} to include options for `IMovable`.
+     */
+    interface SelectOptions extends ITypes.SelectOptions {
+        /**
+         * Flag to indicate the the movable should be added to the selection
+         * or should replace the existing selection.
+         *
+         * @remarks
+         * Setting this to true is the equivalent of press the Ctrl in the UI.
+         */
+        addToSelection?: boolean;
+    }
+    /**
+     * `Events` for {@link IMovable} events.
+     */
+    interface Events extends IAnchored.Events {
+        /**
+         * Called when the isSelect status has changed.
+         */
+        onSelectionChange?(source: IMovable): void;
+        /**
+         * Called when the name has changed.
+         */
+        onNameChange?(source: IMovable): void;
+        /**
+         * Called when selection changes.
+         */
+        onBoundsChange?(source: IMovable): void;
+        /**
+         * Called when the anchor type is updated.
+         */
+        onAnchorTypeChange?(source: IMovable): void;
+        /**
+         * Called when any property has changed.
+         */
+        onAnyChange?(source: IMovable): void;
+        /**
+         * Request that the movable become focused.
+         *
+         * @returns A promise indicating if the focus was honored.
+         *
+         * @remarks
+         * This should only be handled by one consumer.
+         */
+        onRequestFocus?(source: IMovable): Promise<boolean>;
+    }
+    interface IListeners extends IListener.Callbacks<IMovable, IMovable.Events> {
+    }
+    /**
+     * Provides destination details for the Snapshot when using {@link IHistory.ISnapshot.copyTo}.
+     */
+    interface SnapshotDestination {
+        /**
+         * The movable collection to copy to.
+         */
+        movables: IMovableCollection;
+        /**
+         * The bounds to copy to.
+         */
+        bounds: Bounds;
+    }
+    interface ISnapshot extends IHistory.ISnapshot<IMovable.SnapshotDestination, IMovable, Bounds> {
+        /**
+         * Called when the movable is copied to a new container.
+         */
+        copyTo(destination: IMovable.SnapshotDestination, options?: IMovable.CopyOptions): Promise<Bounds> | Bounds;
+    }
+    interface CopyOptions extends ReferenceableClipboard.CopyOptions {
+        /** {@inheritDoc IMovable.SelectOptions} */
+        autoSelect?: boolean | IMovable.SelectOptions;
+    }
+    interface OffsetCoords extends Partial<Point> {
+        /** The row index */
+        r?: number;
+        /** The column index */
+        c?: number;
+    }
+    interface AnchorOffset {
+        tl: OffsetCoords;
+        br: OffsetCoords;
+    }
+    interface ClientData {
+        /**
+         * disable selection on movable elements when the sheet is protected
+         * @defaultValue false
+         */
+        fLocksWithSheet?: boolean;
+        /**
+         * print movable elements when printing the sheet
+         * @defaultValue true
+         */
+        fPrintsWithSheet?: boolean;
+    }
+    interface ContentJSON<J> {
+        /**
+         * Identifies the type of movable object.
+         *
+         * @remarks
+         * This must align to a known movable object type. Defined in the IEmbeddedDrawing interface.
+         */
+        type: string;
+        /**
+         * Underlying json.
+         */
+        json: J;
+    }
+    interface JSON<J = any> {
+        /**
+         * The anchor for the movable object.
+         */
+        anchor: IMovable.AnchorOffset;
+        /**
+         * The content of the movable object.
+         */
+        content: ContentJSON<J>;
+        /**
+         * The behavior of how the movable resizes as the anchor/cells change.
+         */
+        anchorType?: IAnchored.Type;
+        /**
+         * The name of the movable object.
+         */
+        name?: string;
+        /**
+         * This is the alternative text use for assistive technologies.
+         *
+         * @defaultValue null
+         */
+        description?: string;
+        /**
+         * If true then the movable object is hidden.
+         *
+         * @defaultValue false
+         */
+        hidden?: boolean;
+        /**
+         * The rotation in degrees.
+         *
+         * @defaultValue 0
+         */
+        rotation?: number;
+        /**
+         * Whether resizing should keep the aspect ratio.
+         */
+        lockAspect?: boolean;
+        /**
+         * lock specific fields*/
+        locks?: any;
+        clientData?: IMovable.ClientData;
+    }
+}
+//# sourceMappingURL=IMovable.d.ts.map

package/types/src/movable/IMovable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMovable.d.ts","sourceRoot":"","sources":["../../../../src/movable/IMovable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAEtF,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;;;;;;;;;GAUG;AAKH,MAAM,WAAW,QAAS,SAAQ,SAAS,EAAE,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,EAAE,MAAM,CAAC;IAChJ;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,UAAU,CAAC;IAC3D;;OAEG;IACH,UAAU,CAAC,CAAC,SAAS,MAAM,KAAK,CAAC,CAAC;IAClC;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3D;;;OAGG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC;IAC1B;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,QAAQ,CAAC;IACtF;;;;;;;OAOG;IACH,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,qBAAqB,GAAG,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3F;;OAEG;IACH,SAAS,IAAI,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAChC;;;;;OAKG;IACH,OAAO,IAAI,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC;IACrD;;;;;OAKG;IACH,cAAc,IAAI,MAAM,GAAG,IAAI,CAAC;IAChC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,CAAC;IACrC;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAC;IACxC;;;OAGG;IACH,WAAW,IAAI,MAAM,CAAC;IACtB;;;;;;OAMG;IACH,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC9C;;;OAGG;IACH,iBAAiB,IAAI,OAAO,CAAC;IAC7B;;OAEG;IACH,aAAa,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,GAAG,QAAQ,CAAC;IACpD;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IACnB;;OAEG;IACH,YAAY,IAAI,IAAI,CAAC;IACrB;;OAEG;IACH,WAAW,IAAI,IAAI,CAAC;IACpB;;OAEG;IACH,WAAW,IAAI,IAAI,CAAC;IACpB;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;IAC5F;;;OAGG;IACH,MAAM,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC9E;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,yBAAiB,QAAQ,CAAC;IAExB;;OAEG;IACH,UAAiB,aAAc,SAAQ,MAAM,CAAC,aAAa;QACzD;;;;;;WAMG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,MAAO,SAAQ,SAAS,CAAC,MAAM;QAC9C;;WAEG;QACH,iBAAiB,CAAC,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAAC;QAC3C;;WAEG;QACH,YAAY,CAAC,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAAC;QACtC;;WAEG;QACH,cAAc,CAAC,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAAC;QACxC;;WAEG;QACH,kBAAkB,CAAC,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAAC;QAC5C;;WAEG;QACH,WAAW,CAAC,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAAC;QACrC;;;;;;;WAOG;QACH,cAAc,CAAC,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;KACrD;IAED,UAAiB,UAAW,SAAQ,SAAS,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;KAAG;IAErF;;OAEG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,QAAQ,EAAE,kBAAkB,CAAC;QAC7B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAA;KACf;IAED,UAAiB,SAAU,SAAQ,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,EAAE,MAAM,CAAC;QACnG;;WAEG;QACH,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;KAC7G;IAED,UAAiB,WAAY,SAAQ,sBAAsB,CAAC,WAAW;QACrE,2CAA2C;QAC3C,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC;KAC/C;IAED,UAAiB,YAAa,SAAQ,OAAO,CAAC,KAAK,CAAC;QAClD,oBAAoB;QACpB,CAAC,CAAC,EAAE,MAAM,CAAC;QACX,uBAAuB;QACvB,CAAC,CAAC,EAAE,MAAM,CAAA;KACX;IAED,UAAiB,YAAY;QAC3B,EAAE,EAAE,YAAY,CAAC;QACjB,EAAE,EAAE,YAAY,CAAC;KAClB;IAED,UAAiB,UAAU;QACzB;;;WAGG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B;;;WAGG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B;IAED,UAAiB,WAAW,CAAC,CAAC;QAC5B;;;;;WAKG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,IAAI,EAAE,CAAC,CAAC;KACT;IAED,UAAiB,IAAI,CAAC,CAAC,GAAC,GAAG;QACzB;;WAEG;QACH,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC;QAC9B;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;QACvB;;WAEG;QAEH,UAAU,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC;QAC5B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;;;WAIG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB;iCACyB;QACzB,KAAK,CAAC,EAAE,GAAG,CAAC;QAEZ,UAAU,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC;KAClC;CAEF"}

package/types/src/movable/IMovableCollection.d.ts

@@ -0,0 +1,129 @@
+import { Bounds } from '@sheetxl/utils';
+import { ICollection } from '../type';
+import { IAnchored } from '../anchored';
+import { IResource, IResourceCollection } from '../resource';
+import { IListener } from '../listener';
+import { ICellRange } from '../cellRange';
+import { IMovable } from './IMovable';
+import { ITransaction } from '../transaction';
+/**
+ * Holds a collection of IMovables.
+ */
+export interface IMovableCollection extends ICollection<IMovable>, IListener.ISource<IMovableCollection> {
+    /**
+     * Add a resource to the movable collection.
+     *
+     * @param options {@link IMovableCollection.AddOptions}
+     * @returns A new {@link IMovable}.
+     */
+    add(options?: IMovableCollection.AddOptions): Promise<IMovable>;
+    /**
+     * Returns movables that match the filter criteria.
+     *
+     * @param options {@link IMovableCollection.GetItemsOptions}
+     * @returns An Array of {@link IMovable}.
+     *
+     * @remarks
+     * If no filter criteria is provided, all items will be returned.
+     */
+    getItems(options?: IMovableCollection.GetItemsOptions): IMovable[];
+    /**
+     * Update all of the selected movable in a single transaction
+     */
+    updateSelected(update: (movable: IMovable) => void, action?: string): void;
+    /**
+     * Add a picture to the current sheet.
+     * Returns an IMovable with an Picture that can be used to manipulate the picture or remove it.
+     *
+     * @param picture This can be either string to a url, a Resource or an IResource.AddOptions
+     * @param options {@link IMovableCollection.AddOptions}
+     * @returns A Promise that will resolve to the new Movable.
+     */
+    addPicture(picture: string | IResource | IResourceCollection.AddOptions, options?: IMovableCollection.AddOptions): Promise<IMovable>;
+    /**
+     * Add Listeners.
+     *
+     * @see
+     * {@link IListener.ISource.addListeners}
+     */
+    addListeners(listeners: ICollection.IListeners, options?: IListener.Options): IListener.Remove;
+}
+/**
+ * {@inheritDoc IMovableCollection}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IMovableCollection}
+ */
+export declare namespace IMovableCollection {
+    /**
+     * Options for filtering a collection of movables.
+     */
+    interface GetItemsOptions extends ICollection.GetItemsOptions {
+        /**
+         * If provided, the search will be limited to items that intersect the range.
+         * @remarks
+        */
+        address?: ICellRange.Address;
+        /**
+         * Indicate if items that are in hidden headers or marked as hidden should be returned.
+         * @defaultValue false
+         */
+        ignoreHidden?: boolean;
+        /**
+         * The type to search for. If not provided all items will be returned.
+        */
+        type?: string | string[];
+        /**
+         * Only find items in this bounds.
+         * @defaultValue Search all
+         */
+        bounds?: Bounds;
+        /**
+         * Only return items that are completely contained with the search bounds.
+         * @defaultValue false
+         */
+        fullyContained?: boolean;
+    }
+    /**
+     * Options for adding a movable to the collection.
+     */
+    interface AddOptions<J = any> extends ITransaction.OperationOptions {
+        /**
+         * The type of movable to add.
+         */
+        type?: string;
+        /**
+         * Initial json value.
+         */
+        json?: J;
+        /**
+         * If a referenceId is provided then the movable will be linked to the resource.
+         * @param resourceId
+         * @returns IResource
+         */
+        fromResourceId?: (resourceId: number) => IResource;
+        /**
+         * The boundary for the movable object in pixels.
+         */
+        bounds?: Partial<Bounds>;
+        /**
+         * Placement hint used only when {@link bounds} is omitted. `'viewport'` centers the (default-sized)
+         * movable in the visible viewport via {@link ISheet.IListeners.onRequestViewport}, falling back to the
+         * default cursor placement when no viewport responds (headless). Omit ⇒ default cursor placement.
+         */
+        autoPlace?: 'viewport';
+        /**
+         * The behavior of how the movable resizes as the anchor/cells change.
+         */
+        anchorType?: IAnchored.Type;
+        /**
+         * If unspecified no selection will occur.
+         *
+         * @remarks
+         * Overrides the default autoSelect to include {@link IMovable.SelectOptions} options.
+         */
+        autoSelect?: boolean | IMovable.SelectOptions;
+    }
+}
+//# sourceMappingURL=IMovableCollection.d.ts.map

package/types/src/movable/IMovableCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMovableCollection.d.ts","sourceRoot":"","sources":["../../../../src/movable/IMovableCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAkGnD;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,kBAAkB,CAAC;IACtG;;;;;OAKG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAChE;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC,eAAe,GAAG,QAAQ,EAAE,CAAC;IACnE;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3E;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,kBAAkB,CAAC,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrI;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;CAChG;AAED;;;;;;GAMG;AACH,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,eAAgB,SAAQ,WAAW,CAAC,eAAe;QAClE;;;UAGE;QACF,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;QAC7B;;;WAGG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB;;UAEE;QACF,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;WAGG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,UAAU,CAAC,CAAC,GAAC,GAAG,CAAE,SAAQ,YAAY,CAAC,gBAAgB;QAGtE;;WAEG;QAEH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QAEH,IAAI,CAAC,EAAE,CAAC,CAAC;QACT;;;;WAIG;QAEH,cAAc,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,SAAS,CAAC;QAEnD;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB;;;;WAIG;QACH,SAAS,CAAC,EAAE,UAAU,CAAC;QACvB;;WAEG;QAEH,UAAU,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC;QAC5B;;;;;WAKG;QACH,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC;KAC/C;CAEF"}

package/types/src/movable/IMovableSelection.d.ts

@@ -0,0 +1,49 @@
+import { IListener } from '../listener';
+import { IMovable } from './IMovable';
+/**
+ * Manages a selection of `IMovable`s.
+ */
+export interface IMovableSelection extends IListener.ISource<IMovableSelection> {
+    /**
+     * The movable selection.
+     */
+    getMovableSelection(): readonly IMovable[];
+    /**
+     * Select a movable object.
+     *
+     * @param movables
+     * @param addToSelection
+     */
+    selectMovables(movables: readonly IMovable[], addToSelection?: boolean): this;
+    /**
+     * Returns the movable from the selection.
+     *
+     * @param movables
+     */
+    unselectMovables(movables: IMovable[]): this;
+    /**
+     * Add Listeners.
+     *
+     * @see
+     * {@link IListener.ISource.addListeners}
+     */
+    addListeners(listeners: IMovableSelection.IListeners, options?: IListener.Options): IListener.Remove;
+}
+/**
+ * {@inheritDoc IMovableSelection}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IMovableSelection}
+ */
+export declare namespace IMovableSelection {
+    interface Events {
+        /**
+         * Called when the selection has changed.
+         */
+        onMovableSelectionChange?(source: IMovableSelection): void;
+    }
+    interface IListeners extends IListener.Callbacks<IMovableSelection, IMovableSelection.Events> {
+    }
+}
+//# sourceMappingURL=IMovableSelection.d.ts.map

package/types/src/movable/IMovableSelection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMovableSelection.d.ts","sourceRoot":"","sources":["../../../../src/movable/IMovableSelection.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;GAEG;AAIH,MAAM,WAAW,iBAAkB,SAAQ,SAAS,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAC7E;;OAEG;IACH,mBAAmB,IAAI,SAAS,QAAQ,EAAE,CAAC;IAC3C;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,SAAS,QAAQ,EAAE,EAAE,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9E;;;;OAIG;IACH,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAC7C;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,iBAAiB,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;CACtG;AAED;;;;;;GAMG;AACH,yBAAiB,iBAAiB,CAAC;IAEjC,UAAiB,MAAM;QACrB;;WAEG;QACH,wBAAwB,CAAC,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAC;KAC5D;IAED,UAAiB,UAAW,SAAQ,SAAS,CAAC,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,MAAM,CAAC;KAAG;CACxG"}