FSheetShape

A shape attached to a worksheet. Use this class to control its cell anchoring, and the inherited FShape methods for geometry, styling, text, and other shape operations.

Access

Access through:

• FWorksheet.insertShape()
• FWorksheet.getShape()
• FWorksheet.getShapes()

Inheritance

Extends FShape. Its inherited members are available on this object.

Setup

Register @univerjs-pro/sheets-shape or a preset that includes it. In plugin mode, import @univerjs-pro/sheets-shape/facade. Additional methods below require their listed plugin packages. See Facade setup.

@univerjs-pro/sheets-shape

FSheetShape.getPlacement

Returns this Shape's current Sheet placement.

Position is OneCell (from + width + height), Both is TwoCell (from + to), and None is an absolute Sheet rectangle.

getPlacement(): ISheetDrawingPlacement | null

Returns

The current placement, or null when the Shape no longer exists.

Examples

const workbook = univerAPI.getActiveWorkbook()const worksheet = workbook?.getActiveSheet()const shape = worksheet?.getShapes()[0]console.log(shape?.getPlacement())

Types: ISheetDrawingPlacement

Package: @univerjs-pro/sheets-shape · Type definitions

FSheetShape.setPlacement

Updates this Shape's Sheet placement through SetSheetDrawingPlacementCommand.

Use exact markers when the caller owns the cell relationship. Use { kind, bounds } when the caller owns a rectangle and wants Univer to infer the markers from the current Sheet grid. Position is appropriate for a fixed-size object that moves with its start cell; Both is appropriate when both position and size follow the grid; None is appropriate for a free absolute object.

setPlacement(placement: ISheetDrawingPlacementInput): boolean

Parameters

• placement — Required. Exact markers or model-space bounds with an explicit anchor type.

Returns

Whether the command succeeded.

Examples

Position inferred from bounds

shape.setPlacement({  kind: univerAPI.Enum.SheetDrawingAnchorType.Position,  bounds: { left: 120, top: 80, width: 240, height: 120 },})

Position with exact marker

shape.setPlacement({  kind: univerAPI.Enum.SheetDrawingAnchorType.Position,  from: { row: 2, column: 2, rowOffset: 8, columnOffset: 8 },  width: 240,  height: 120,})

Both inferred from bounds

shape.setPlacement({  kind: univerAPI.Enum.SheetDrawingAnchorType.Both,  bounds: { left: 120, top: 80, width: 360, height: 180 },})

Both with exact markers

shape.setPlacement({  kind: univerAPI.Enum.SheetDrawingAnchorType.Both,  from: { row: 2, column: 2, rowOffset: 8, columnOffset: 8 },  to: { row: 8, column: 6, rowOffset: 0, columnOffset: 0 },})

Absolute

shape.setPlacement({  kind: univerAPI.Enum.SheetDrawingAnchorType.None,  left: 640,  top: 96,  width: 240,  height: 120,})

Types: ISheetDrawingPlacementInput

Package: @univerjs-pro/sheets-shape · Type definitions

FSheetShape.setPosition

Sets the Shape position from a zero-based Sheet cell anchor and pixel offsets.

setPosition(anchorRowPos: number, anchorColPos: number, rowOffset: number, columnOffset: number): this

Parameters

• anchorRowPos — Required. Row containing the Shape's top edge.
• anchorColPos — Required. Column containing the Shape's left edge.
• rowOffset — Required. Vertical pixel offset from the row's top edge.
• columnOffset — Required. Horizontal pixel offset from the column's left edge.

Returns

This Shape, for chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.RoundRect,})fShape.setPosition(6, 6, 10, 10)

Package: @univerjs-pro/sheets-shape · Type definitions