Skip to content

ws.smartArt

WorksheetSmartArt

21 methods

add

Promise<SmartArtObject>
add(config: SmartArtConfig): Promise<SmartArtObject>;
ParameterTypeRequired
configSmartArtConfigrequired

Add a diagram to the sheet. Returns the created floating object.

get

Promise<SmartArtDiagram | null>
get(objectId: string): Promise<SmartArtDiagram | null>;
ParameterTypeRequired
objectIdstringrequired

Get a diagram by object ID, or null if not found.

has

Promise<boolean>
has(objectId: string): Promise<boolean>;
ParameterTypeRequired
objectIdstringrequired

Check if a diagram exists by object ID.

getCount

Promise<number>
getCount(): Promise<number>;

Get the total number of diagrams on this sheet.

remove

Promise<void>
remove(objectId: string): Promise<void>;
ParameterTypeRequired
objectIdstringrequired

Remove a diagram by object ID.

list

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

List all diagrams on the sheet.

clear

Promise<void>
clear(): Promise<void>;

Remove all diagrams from the sheet.

duplicate

Promise<string>
duplicate(objectId: string): Promise<string>;
ParameterTypeRequired
objectIdstringrequired

Duplicate a diagram. Returns the new object ID.

addNode

Promise<NodeId>
addNode(
    objectId: string,
    text: string,
    position: NodePosition,
    referenceNodeId: NodeId | null,
  ): Promise<NodeId>;
ParameterTypeRequired
objectIdstringrequired
textstringrequired
positionNodePositionrequired
referenceNodeIdNodeId | nullrequired

Add a node to a diagram. Returns the new node ID.

removeNode

Promise<void>
removeNode(objectId: string, nodeId: NodeId): Promise<void>;
ParameterTypeRequired
objectIdstringrequired
nodeIdNodeIdrequired

Remove a node from a diagram.

updateNode

Promise<void>
updateNode(
    objectId: string,
    nodeId: NodeId,
    updates: Partial<SmartArtNode>,
  ): Promise<void>;
ParameterTypeRequired
objectIdstringrequired
nodeIdNodeIdrequired
updatesPartial<SmartArtNode>required

Update a node's properties.

moveNode

Promise<void>
moveNode(objectId: string, nodeId: NodeId, direction: NodeMoveDirection): Promise<void>;
ParameterTypeRequired
objectIdstringrequired
nodeIdNodeIdrequired
directionNodeMoveDirectionrequired

Move a node in the hierarchy.

getNode

Promise<SmartArtNode | undefined>
getNode(
    objectId: string,
    nodeId: NodeId,
  ): Promise<SmartArtNode | undefined>;
ParameterTypeRequired
objectIdstringrequired
nodeIdNodeIdrequired

Get a node by ID.

getDiagram

Promise<SmartArtDiagram | null>
getDiagram(objectId: string): Promise<SmartArtDiagram | null>;
ParameterTypeRequired
objectIdstringrequired

@deprecated Use `get(objectId)` instead. Will be removed in a future release.

getDiagramsOnSheet

Promise<SmartArtDiagram[]>
getDiagramsOnSheet(): Promise<SmartArtDiagram[]>;

@deprecated Use `list()` instead. Will be removed in a future release.

changeLayout

Promise<void>
changeLayout(objectId: string, newLayoutId: string): Promise<void>;
ParameterTypeRequired
objectIdstringrequired
newLayoutIdstringrequired

Change the diagram layout.

changeQuickStyle

Promise<void>
changeQuickStyle(objectId: string, quickStyleId: string): Promise<void>;
ParameterTypeRequired
objectIdstringrequired
quickStyleIdstringrequired

Change the quick style.

changeColorTheme

Promise<void>
changeColorTheme(objectId: string, colorThemeId: string): Promise<void>;
ParameterTypeRequired
objectIdstringrequired
colorThemeIdstringrequired

Change the color theme.

getComputedLayout

Promise<ComputedLayout | undefined>
getComputedLayout(
    objectId: string,
  ): Promise<ComputedLayout | undefined>;
ParameterTypeRequired
objectIdstringrequired

Get the computed layout for a diagram. Returns cached result if valid.

invalidateLayout

void
invalidateLayout(objectId: string): void;
ParameterTypeRequired
objectIdstringrequired

Invalidate the cached layout for a diagram.

invalidateAllLayouts

void
invalidateAllLayouts(): void;

Invalidate all cached layouts.