SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IContent

    What a movable draws: a chart, a picture, a shape, a slicer, a control.

    Content owns what identifies it, and the movable owns where it is drawn. Content can exist with no movable: a picture used as a sheet background is not placed by one.

    The movable owns its placement (bounds, rotation, flip) but the content says which of these it can take: a kind that defines acceptRotation can be turned and one that defines acceptFlip can be mirrored. A kind that defines neither, such as a chart, is placed by its bounds alone.

    interface IContent {
        acceptFlip?(flip: Flip): Flip;
        acceptRotation?(degrees: number): number;
        delete(options?: ITransaction.OperationOptions): void;
        getDescription(): string | null;
        getId(): string;
        getMovable(): IMovable | null;
        getName?(): string | null;
        getType(): string;
        getTypeDescription(): string;
        isDeleted(): boolean;
        setDescription(description: string | null): this;
        setName?(name: string): this;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    acceptFlip? acceptRotation? delete getDescription getId getMovable getName? getType getTypeDescription isDeleted setDescription setName?

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

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

      Returns string | null

    • Returns the id of the content.

      Returns string

    • Returns the movable that places the content on the sheet, or null if it is not placed by one.

      Returns IMovable | null

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

      Returns string | null

      Not defined for content that is never named.

    • Returns an immutable type string.

      Returns string

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

      Returns string

    • Returns true if the content has been deleted.

      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
    Methods