Skip to content
Mog is in active development. The GitHub repo, SDK packages, and community channels are not yet available. Follow for launch updates

ws.shapes

WorksheetShapeCollection

4 methods

get

Promise<ShapeHandle | null>
get(id: string): Promise<ShapeHandle | null>;
ParameterTypeRequired
idstringrequired

list

Promise<ShapeHandle[]>
list(): Promise<ShapeHandle[]>;

add

Promise<ShapeHandle>
add(config: ShapeConfig): Promise<ShapeHandle>;
ParameterTypeRequired
configShapeConfigrequired

getItemAt

Promise<ShapeHandle | null>
getItemAt(index: number): Promise<ShapeHandle | null>;
ParameterTypeRequired
indexnumberrequired

Get a shape by zero-based index. Returns null if index is out of range.