SheetXL - v0.3.20
    Preparing search index...

    Interface IChart

    Interface for working with Charts.

    PLACEHOLDER - This is under development and not made public yet.

    interface IChart {
        isIModel: true;
        addListeners(listeners: IListeners, options?: IListener.Options): Remove;
        beginCommit(options?: string | OperationOptions): ITransaction;
        close(): void;
        delete(options?: OperationOptions): void;
        doBatch<R = any>(
            callback: (commit: ICommit) => R | Promise<R>,
            options?: string | OperationOptions,
        ): R | Promise<R>;
        getDescription(): string;
        getType(): string;
        getUUID(): string;
        isClosed(): boolean;
        isDeleted(): boolean;
        isReadOnly(): boolean;
        toJSON(toResourceId?: (resource: IResource) => number): JSON;
    }

    Hierarchy

    • IModel
      • IChart
    Index

    Properties

    isIModel

    Methods

    addListeners beginCommit close delete? doBatch getDescription getType getUUID? isClosed isDeleted isReadOnly toJSON

    Properties

    isIModel: true

    For runtime type checking.

    Methods

    • Add Listeners.

      Parameters

      Returns Remove

      IListener.ISource.addListeners

    • Batches all 'transactional' changes until they have all be committed or rolled back.

      Parameters

      • Optionaloptions: string | OperationOptions

        Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.

      Returns ITransaction

      Any changes that are made to this object will be reflected in the local record but not committed to the transactional store until the batch is popped.

      Useful for operations that are longer running but generally not recommended as it keeps a transaction open. doBatch is the preferred option.

    • Close the record and cleans resources. Can't be undone.

      Returns void

    • Delete the item.

      Parameters

      Returns void

      Not all objects can be deleted.

    • Provides a mechanism to perform a set of operations in a batch.

      Type Parameters

      • R = any

      Parameters

      • callback: (commit: ICommit) => R | Promise<R>

        A callback that performs multiple operations all within the same transaction.

      • Optionaloptions: string | OperationOptions

        Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.

      Returns R | Promise<R>

    • Returns string

    • Returns an immutable type string.

      Returns string

    • A unique identifier for the record. This will never change.

      Returns string

      This enables the record to be identified across transactions and users in a collaborative environment.

    • Returns true if no more operations are allowed.

      Returns boolean

    • If the model unable to be modified.

      Returns boolean

    • If the model unable to be modified.

      Returns boolean

    • Parameters

      • OptionaltoResourceId: (resource: IResource) => number

      Returns JSON

    Settings

    Member Visibility

    On This Page

    Properties
    Methods