SheetXL - v1.0.2
    Preparing search index...

    Interface IOptionButton

    An option button: one of a group, of which one is chosen. Content type 'optionButton'.

    interface IOptionButton {
        isIFormControl: true;
        isIModel: true;
        acceptFlip?(flip: Flip): Flip;
        acceptRotation?(degrees: number): number;
        addListeners(listeners: IListeners, options?: IListener.Options): Remove;
        beginCommit(options?: string | ITransaction.OperationOptions): ITransaction;
        close(): void;
        delete(options?: ITransaction.OperationOptions): void;
        doBatch<R = any>(
            callback: (commit: ICommit) => R | Promise<R>,
            options?: string | ITransaction.OperationOptions,
        ): R | Promise<R>;
        getCaption(): string | null;
        getConnections?(
            width: number,
            height: number,
            options?: ConnectionsOptions,
        ): readonly Connection[] | null;
        getDefaultAnchorType?(): IAnchored.Type;
        getDescription(): string | null;
        getFont(): Font | null;
        getId(): string;
        getLinkedCell(): string | null;
        getLinkedRange(): ICellRange | null;
        getMacro(): string | null;
        getMovable(): IMovable | null;
        getName?(): string | null;
        getReferences(): ICellRanges | null;
        getShapeId(): number | null;
        getType(): string;
        getTypeDescription(): string;
        getVersionId(): number;
        isChecked(): boolean;
        isClosed(): boolean;
        isDefaultLockAspectRatio?(): boolean;
        isDeleted(): boolean;
        isReadOnly(): boolean;
        setCaption(
            caption: string | null,
            options?: ITransaction.OperationOptions,
        ): this;
        setChecked(checked: boolean, options?: ITransaction.OperationOptions): this;
        setDescription(description: string | null): this;
        setLinkedCell(
            address: string | null,
            options?: ITransaction.OperationOptions,
        ): this;
        setMacro(
            macro: string | null,
            options?: ITransaction.OperationOptions,
        ): this;
        setName?(name: string): this;
        toJSON(
            toResourceId?: (resource: IResource) => number | null,
        ): IFormControl.JSON | null;
    }

    Hierarchy (View Summary)

    Index
    isIFormControl isIModel
    acceptFlip? acceptRotation? addListeners beginCommit close delete doBatch getCaption getConnections? getDefaultAnchorType? getDescription getFont getId getLinkedCell getLinkedRange getMacro getMovable getName? getReferences getShapeId getType getTypeDescription getVersionId isChecked isClosed isDefaultLockAspectRatio? isDeleted isReadOnly setCaption setChecked setDescription setLinkedCell setMacro setName? toJSON
    isIFormControl: true

    For runtime type checking.

    isIModel: true

    For runtime type checking.

    • The flip this content takes when asked to mirror as flip states.

      Parameters

      Returns Flip

      Defined by content that can be mirrored, such as a shape or a picture; absent, the content cannot: a frame dragged through its opposite edge is moved there but not mirrored, as Excel does with a chart. Must be pure, as acceptRotation is. A connector may accept each axis on its own.

    • The rotation this content takes when asked to turn by degrees, clockwise.

      Parameters

      • degrees: number

      Returns number

      Defined by content that can be turned, such as a shape or a picture; absent, the content cannot and no rotate handle is offered. Must be pure: it is asked throughout a gesture to draw its preview, and the answer is what the movable stores.

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

      Parameters

      • Optionaloptions: string | ITransaction.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

    • 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 | ITransaction.OperationOptions

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

      Returns R | Promise<R>

      Writes are tracked automatically: a batch that performs no state updates (a read-only batch) is elided — the commit id is unchanged, no events fire, and nothing is added to the undo stack or commit log.

    • Returns the text written on the control, or null if it has none.

      Returns string | null

    • The points a connector's end may be glued to, in a width by height frame of this content, before the frame is placed.

      Parameters

      Returns readonly Connection[] | null

      Absent, the four edge midpoints — top, left, bottom, right, numbered in that order, each leaving straight out — as Excel offers on a picture, a chart, a slicer or a control. A shape is the exception and answers its geometry's own sites (a triangle's three, a connector's none); a group answers none, since Excel glues to a group's members and never to the group. Must be synchronous: null means the content cannot answer yet and will call options.onReady when it can.

    • Returns the alternative text used by assistive technologies, or null if none has been set.

      Returns string | null

    • Returns the font the caption is drawn in, or null when the control has not said.

      Returns Font | null

    • 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. The id is store-issued (IStore.create); the store keys all state by it.

    • Returns the address of the cell the control's state lives in, or null if it has none.

      Returns string | null

      It follows the cell through inserts, deletes and moves, and reads #REF! once the cell is deleted. A cell on the control's own sheet has no sheet name ($A$1); one on another sheet has its sheet's (Data!$A$1).

    • Returns the name of the macro the control runs when used, or null if it has none.

      Returns string | null

      Any kind may run one: a button when clicked, a check box when toggled, a scroll bar when moved.

    • Returns the name, or null if the content has none.

      Returns string | null

      Not defined for content that is never named.

    • Returns the cells the content names - a chart's series, a control's linked cell, a slicer's column - or null when it names none.

      Returns ICellRanges | null

      Not where the movable sits: that is IMovable.getRange. The references are formulas the calculation engine holds, so they follow the cells they name through inserts, deletes, cuts, sheet renames and undo, and ContentEvents.onReferencesChange is announced when they have. A reference to deleted cells is left out. Without a running engine the references read as they were set.

    • Returns the id of the shape that draws this control, or null if it has none.

      Returns number | null

      The link to the shape in the sheet's legacy drawing, which is what keeps the two over the same cells when rows and columns move.

    • Returns an immutable type string.

      Returns string

    • Returns a label for the kind of content, such as Chart or Picture.

      Returns string

    • Every committed update gives the record a new, strictly increasing version id.

      Returns number

      Used with getId to uniquely identify a version of the record.

      The id is an identity, not a per-record count: ids are drawn from a single store-wide sequence bumped once per commit, so all records written in the same commit share an id and a given record's ids increase but are not sequential.

      Records are immutable so a restore/revert doesn't change them — it repoints, and the version id reported is the one for the snapshot the store is currently at. Version ids are never reused: a write after an undo receives an id higher than any previously issued, so a stale reader can always detect the change.

    • Returns true if this is the chosen button of its group.

      Returns boolean

    • Returns true if no more operations are allowed.

      Returns boolean

    • Whether a movable of this content keeps its aspect ratio when resized from a corner, when it states no lock of its own.

      Returns boolean

      Absent, it does not. A picture does.

    • If the model unable to be modified.

      Returns boolean

    • If the model unable to be modified.

      Returns boolean

    • Set the alternative text used by assistive technologies.

      Parameters

      • description: string | null

      Returns this

    • Set the name.

      Parameters

      • name: string

        The name of the content.

      Returns this

    Settings
    Member Visibility

    On This Page
    Properties
    Methods