ws.objects

get(id: string): Promise<FloatingObjectHandle | null>;

Get a floating object handle by ID. Returns null if not found.

getInfo(id: string): Promise<FloatingObjectInfo | null>;

Get summary info (with spatial fields) for a floating object. Returns null if not found.

list(): Promise<FloatingObjectHandle[]>;

List all floating objects on the sheet.

removeMany(ids: string[]): Promise<number>;

Remove multiple floating objects. Returns count of successfully removed.

remove(id: string): Promise<boolean>;

Remove a single floating object by ID. Returns true if removed.

bringToFront(id: string): Promise<void>;

Bring a floating object to the front (highest z-order).

sendToBack(id: string): Promise<void>;

Send a floating object to the back (lowest z-order).

bringForward(id: string): Promise<void>;

Bring a floating object forward by one layer.

sendBackward(id: string): Promise<void>;

Send a floating object backward by one layer.

update(objectId: string, updates: Record<string, unknown>): Promise<void>;

Update arbitrary properties of a floating object.

convertToWordArt(objectId: string, warpPreset?: TextWarpPreset): Promise<void>;

Convert a text box to decorative text by applying text-effect styling.

convertToTextBox(objectId: string): Promise<void>;

Convert decorative text back to a regular text box by removing text-effect styling.

computeObjectBounds(objectId: string): Promise<ObjectBounds | null>;

Compute pixel bounding box for a floating object (async — uses ComputeBridge).

computeAllObjectBounds(): Promise<Map<string, ObjectBounds>>;

Batch-compute pixel bounds for all floating objects on this sheet.

group(ids: string[]): Promise<string>;

Group multiple floating objects. Returns the group ID.

ungroup(groupId: string): Promise<void>;

Ungroup a floating object group.