@sheetxl/sdk 0.8.0-beta.7 → 0.8.0-beta.9

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

@@ -1,55 +0,0 @@
-import { IResource, IResourceCollection } from '../resource';
-import { IEmbeddedPart } from '../io';
-import { IControl } from './IControl';
-import { AbstractMovableContent } from './AbstractMovableContent';
-interface State extends AbstractMovableContent.State {
-    data?: IControl.JSON;
-}
-/**
- * Implementation for {@link IControl}.
- */
-export declare class Control extends AbstractMovableContent<State, IControl.JSON> implements IControl {
-    /**
-     * The part describing the control. Held beside {@link State.data} rather than in it because the
-     * resources it may carry are model references, not JSON, and have to be re-persisted per save.
-     */
-    protected _part: IEmbeddedPart | null;
-    constructor(options: Control.ConstructorOptions);
-    /** {@inheritDoc IModel.getType} */
-    getType(): string;
-    /** {@inheritDoc IControl.getShapeId} */
-    getShapeId(): number | null;
-    /** {@inheritDoc IControl.getXML} */
-    getXML(): string | null;
-    /** {@inheritDoc Movable.Content.toJSON} */
-    toJSON(toResourceId?: (resource: IResource) => number | null): IControl.JSON | null;
-    /** {@inheritDoc IMovable.IContent.getTypeDescription} */
-    getTypeDescription(): string;
-    /** {@inheritDoc IControl.isIControl} */
-    get isIControl(): true;
-}
-/**
- * Interfaces for creating `Control` items.
- *
- * @see
- * ### **Interface**
- *
- * {@link Control}
- */
-export declare namespace Control {
-    /**
-     * Options for creating a Control.
-     */
-    interface ConstructorOptions extends AbstractMovableContent.ConstructorOptions<IControl.JSON> {
-        /**
-         * Returns an IResource from the resourceId or null if not found.
-         */
-        fromResourceId?: (resourceId: number) => IResource;
-        /**
-         * Useful for load/save/copying.
-         */
-        beginPersistResource: () => IResourceCollection.IPersistScope<IResource.JSON>;
-    }
-}
-export {};
-//# sourceMappingURL=Control.d.ts.map

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

@@ -1,86 +0,0 @@
-import { IListener } from '../listener';
-import { ITransaction } from '../transaction';
-import { IResource } from '../resource';
-import { IModel } from '../model';
-import { IEmbeddedPart } from '../io';
-import { IMovable } from './IMovable';
-/**
- * Interface for working with form controls — a button, a checkbox, a scrollbar placed on a sheet.
- *
- * **PLACEHOLDER** - This is under development and not made public yet.
- */
-export interface IControl extends IModel, IMovable.IContent {
-    /**
-     * Returns the id of the shape that draws this control, or `null` if it has none.
-     *
-     * @remarks
-     * The shape lives in the sheet's legacy drawing, which is still opaque markup — this is the only
-     * link between the two, and it is what lets the shape be kept over the same cells as the control
-     * when rows and columns move.
-     */
-    getShapeId(): number | null;
-    /**
-     * Returns the markup of the part describing the control, or `null` if none was captured.
-     *
-     * @remarks
-     * Read-only, and the one escape hatch for what the control does not model yet: it is the
-     * `<formControlPr>` the control was read from — its kind, its linked cell, its macro. It will be
-     * removed when the control is modeled.
-     */
-    getXML(): string | null;
-    toJSON(toResourceId?: (resource: IResource) => number | null): IControl.JSON | null;
-    /**
-     * Deletes the control, and with it the movable that places it.
-     */
-    delete(options?: ITransaction.OperationOptions): void;
-    /** For runtime type checking. */
-    readonly isIControl: true;
-}
-/**
- * {@inheritDoc IControl}
- * @see
- * ### **Interface**
- *
- * {@link IControl}
- */
-export declare namespace IControl {
-    interface JSON {
-        /**
-         * The id of the shape that draws this control.
-         *
-         * @see {@link IControl.getShapeId}
-         */
-        shapeId?: number;
-        /**
-         * The control's own properties, as they were read.
-         *
-         * @remarks
-         * Opaque. What they describe — a button's macro, a checkbox's linked cell — has no model yet,
-         * so they are held as they were read and written back unchanged. The position is *not* among
-         * them: it is the movable's own anchor, and is written from that.
-         */
-        props?: Record<string, string>;
-        /**
-         * Anything else the properties contained, as markup.
-         *
-         * @remarks
-         * Empty for every control this version has seen — a control's properties are attributes and an
-         * anchor, and the anchor is the movable's. Kept so a producer that writes more than that does
-         * not lose it.
-         */
-        xml?: string;
-        /**
-         * The part describing what kind of control this is and how it behaves.
-         *
-         * @remarks
-         * A control is drawn by a shape in the sheet's legacy drawing ({@link ISheet.LegacyDrawingJSON})
-         * and described by a part of its own; this is that part.
-         */
-        part?: IEmbeddedPart.JSON;
-    }
-    interface Events extends IModel.Events {
-    }
-    interface IListeners extends IListener.Callbacks<IControl, IControl.Events> {
-    }
-}
-//# sourceMappingURL=IControl.d.ts.map

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

@@ -1,30 +0,0 @@
-import { IListener } from '../listener';
-import { IResource } from '../resource';
-import { IModel } from '../model';
-/**
- * Interface for working with Groups.
- *
- * @remarks
- * **PLACEHOLDER**
- */
-export interface IGroup extends IModel {
-    toJSON(toResourceId?: (resource: IResource) => number): IGroup.JSON;
-    getDescription(): string;
-}
-/**
- * {@inheritDoc IGroup}
- * @see
- * ### **Interface**
- *
- * {@link IGroup}
- */
-export declare namespace IGroup {
-    interface JSON {
-        grpSp?: any;
-    }
-    interface Events extends IModel.Events {
-    }
-    interface IListeners extends IListener.Callbacks<IGroup, IGroup.Events> {
-    }
-}
-//# sourceMappingURL=IGroup.d.ts.map

package/types/src/shape/_ShapeXml.d.ts

@@ -1,28 +0,0 @@
-/**
- * Reads the two facts a shape's captured DrawingML fragment can answer without a model behind
- * it: the text written on the shape, and its preset geometry.
- *
- * @remarks
- * An imported shape is kept as the source's markup ({@link IShape.JSON.xml}) and replayed on
- * save, so this is a reader over a small fragment, not an XML library: elements, attributes and
- * character data, matched by LOCAL name — prefixes are the producer's choice (`xdr:sp` and `a:t`
- * are only Excel's). The fragment is a few kilobytes and was already parsed once, as part of a
- * whole document, by the reader that captured it.
- */
-/** What {@link readShapeXml} answers with. */
-export interface ShapeXmlFacts {
-    /** The root element's local name: `sp`, `cxnSp` or `grpSp`. */
-    element: string;
-    /** `prstGeom/@prst`, `'custom'` for a `custGeom`, or `null` when the fragment states neither. */
-    geometry: string | null;
-    /** The plain text, or `null` when the fragment has no text body at all. */
-    text: string | null;
-}
-/**
- * Reads a captured shape fragment.
- *
- * @param xml The fragment as captured on import.
- * @returns `null` when `xml` holds no element.
- */
-export declare const readShapeXml: (xml: string) => ShapeXmlFacts | null;
-//# sourceMappingURL=_ShapeXml.d.ts.map