Show.Shape

Show.Shape is an object type of the Presentation module (Office.show(iframe)). 117 methods.

Generated from the SDK type definitions

Presentation · 10 object types · 586 methods · namespace Show. This reference is generated from the API document artifact (sdk-api-doc.html) produced with the SDK build. Descriptions are the editor's API comments as published. Pin the SDK and Office versions together and regenerate when either changes.

Remarks

Module: Presentation · Office.show(iframe) · namespace Show
Obtained from: Document.findShapes(slides, filter), Slide.duplicateShape(shapeProxy), Slide.duplicateShapes(shapeProxyList), Slide.findShapes(filter), Slide.getShape(index), Slide.getShapes(), Slide.insertShape(presetId, transform), Slide.insertTextBox(transform), Slide.ungroupShapes(shapeProxy), Group.getChildren(), Group.ungroup()
Every method returns a Promise; signatures use TypeScript notation.

Methods

Method	Description
`align(alignType)`	Aligns the shape relative to the slide.
`flip(direction)`	Flips the shape vertically or horizontally.
`getAdjustValues()`	Returns the adjust values defined on a regular shape and their adjustable ranges.
`getAlignH(range)`	Returns the representative paragraph's horizontal alignment.
`getAlignV()`	Returns the vertical text alignment.
`getBold(range)`	Returns whether the representative run is bold.
`getBulletStyle(range)`	Returns the bullet style of the representative paragraph.
`getEffects()`	Returns the effects applied to the shape.
`getFill()`	Returns the shape fill.
`getFirstLineIndent(range)`	Returns the representative paragraph's first-line indent (UI "first line").
`getFontFamily(range)`	Returns the font name of the representative run.
`getFontSize(range)`	Returns the font size (pt) of the representative run.
`getFontStyle(range)`	Returns the font style of the representative run (the first run the range touches).
`getHeight()`	Returns the shape's height.
`getHyperlink()`	Returns the hyperlink set on the shape.
`getItalic(range)`	Returns whether the representative run is italic.
`getLevel(range)`	Returns the representative paragraph's list level.
`getLineCap()`	Returns the line cap.
`getLineColor()`	Returns the line color.
`getLineDash()`	Returns the line dash type.
`getLineJoin()`	Returns the line join type.
`getLineSpacing(range)`	Returns the representative paragraph's line-spacing value.
`getLineSpacingType(range)`	Returns the representative paragraph's line-spacing type.
`getLineStyle()`	Returns the line style.
`getLineWidth()`	Returns the line width (pt).
`getMarginLeft(range)`	Returns the representative paragraph's left margin (UI "before text").
`getParagraphStyle(range)`	Returns the paragraph format of the representative paragraph (the first paragraph the range touches).
`getPlaceholderType()`	Returns the placeholder type of the shape.
`getPresetId()`	Returns the shape's OOXML preset id (prst).
`getRotation()`	Returns the rotation angle of the shape.
`getSpaceAfter(range)`	Returns the representative paragraph's space after (UI "below paragraph").
`getSpaceBefore(range)`	Returns the representative paragraph's space before (UI "above paragraph").
`getStrike(range)`	Returns the strikethrough type of the representative run.
`getText(range)`	Returns the text as plain text.
`getTextboxAutoFit()`	Returns the text-box auto-fit type.
`getTextColor(range)`	Returns the text color of the representative run.
`getTextHyperlink(range)`	Returns the hyperlink of a text span.
`getTransform()`	Returns the position, size, and rotation of the shape.
`getUnderline(range)`	Returns the underline type of the representative run.
`getWidth()`	Returns the shape's width.
`getX()`	Returns the shape's X coordinate.
`getY()`	Returns the shape's Y coordinate.
`getZOrderIndex()`	Returns the z-order index of the shape within its parent (the slide, or the group for a group child).
`hasText()`	Returns whether the shape contains text.
`insertSymbol(textOffset, symbol)`	Inserts a symbol (special character) at the given offset.
`insertText(text, textOffset)`	Inserts text.
`isChart()`	Checks whether this handle is a Chart (a type guard for union narrowing).
`isControl()`	Checks whether this handle is a Control (a type guard for union narrowing).
`isDiagram()`	Checks whether this handle is a Diagram (a type guard for union narrowing).
`isFlatTx()`	Returns whether the text stays flat during 3D rotation.
`isFlippedH()`	Returns whether the shape is flipped horizontally.
`isFlippedV()`	Returns whether the shape is flipped vertically.
`isGroup()`	Checks whether this handle is a Group (a type guard for union narrowing).
`isImage()`	Checks whether this handle is an Image (a type guard for union narrowing).
`isLine()`	Checks whether this handle is a Line (a type guard for union narrowing).
`isOleObject()`	Checks whether this handle is an OleObject (a type guard for union narrowing).
`isPlaceholder()`	Returns whether the shape is a placeholder (title, body frame, etc.).
`isShape()`	Checks whether this handle is a Shape (a type guard for union narrowing).
`isTable()`	Checks whether this handle is a Table (a type guard for union narrowing).
`moveBy(distance)`	Moves the shape by x, y relative to its current position.
`remove3d()`	Removes the shape's 3D effect.
`removeEffect(effectType)`	Removes an effect.
`removeFill()`	Removes the fill (noFill).
`removeHyperlink()`	Removes the shape's hyperlink.
`removeLineColor()`	Removes the line color (noFill).
`removeTextHyperlink(range)`	Removes the text's hyperlink.
`reorder(order)`	Changes the shape's z-order (forward/backward).
`set3d(scene3d, sp3d)`	Applies a 3D effect to the shape.
`setAdjustValue(name, value)`	Changes one adjust value of a regular shape.
`setAdjustValues(avList)`	Changes several adjust values of a plain shape at once.
`setAlignH(align, range)`	Sets the text's horizontal alignment.
`setAlignV(align)`	Sets the vertical text alignment.
`setBold(enabled, range)`	Sets bold text.
`setBulletStyle(bulletType, subType, startAt, range)`	Sets the bullet style.
`setEffects(effects)`	Applies an effects object returned by getEffects() as is.
`setFill(fill)`	Applies a fill object returned by getFill() as is.
`setFirstLineIndent(firstLineIndent, range)`	Sets the indent of the paragraph's first line (UI "First line").
`setFlatTx(enabled)`	Sets whether the text stays flat during 3D rotation.
`setFontFamily(fontFamily, range)`	Sets the font.
`setFontSize(fontSize, range)`	Sets the font size.
`setFontStyle(style, range)`	Sets the font style.
`setGlow(glow)`	Applies a glow effect.
`setGradientFill(type, stops, angle)`	Sets a gradient fill.
`setHeight(height)`	Sets the height of the shape.
`setHyperlink(hyperlink)`	Sets a hyperlink on the shape (symmetric with getHyperlink - the returned object can be passed back to copy a hyperlink).
`setImageFill(imageUrl, fillMode, alpha, detail)`	Sets an image fill.
`setInnerShadow(shadow)`	Applies an inner shadow.
`setItalic(enabled, range)`	Sets italic text.
`setLevel(level, range)`	Sets the list level (outline depth).
`setLineCap(lineCap)`	Sets the line cap.
`setLineColor(color, alpha)`	Sets the line color.
`setLineDash(lineDash)`	Sets the line style (dash).
`setLineGradient(type, stops, angle)`	Sets a gradient fill on the line (border).
`setLineJoin(lineJoin)`	Sets the line join type.
`setLineSpacing(lineSpacing, type, range)`	Sets the line spacing.
`setLineStyle(style)`	Applies a line-style object returned by getLineStyle() as-is (symmetric with getLineStyle - shape-to-shape line copy).
`setLineWidth(lineWidth)`	Sets the line width.
`setMarginLeft(marginLeft, range)`	Sets the left margin of the whole paragraph (UI "Before text").
`setOuterShadow(shadow)`	Applies an outer shadow.
`setParagraphStyle(style, range)`	Sets the paragraph format in one call.
`setPatternFill(preset, foreColor, backColor, foreAlpha, backAlpha)`	Sets a pattern fill.
`setReflection(reflection)`	Applies a reflection effect.
`setRotation(rotation)`	Sets the rotation angle of the shape as an absolute value.
`setSoftEdge(softEdge)`	Applies a soft edge effect.
`setSolidFill(color, alpha)`	Sets the shape fill to a solid color.
`setSpaceAfter(spaceAfter, range)`	Sets the space after the paragraph (UI "below paragraph").
`setSpaceBefore(spaceBefore, range)`	Sets the space before the paragraph (UI "above paragraph").
`setStrike(strike, range)`	Sets strikethrough text.
`setText(text, range)`	Sets the text.
`setTextboxAutoFit(autoAlignType)`	Sets the text box auto-fit type.
`setTextColor(color, range)`	Sets the text color.
`setTextHyperlink(hyperlink, range)`	Sets a hyperlink on the text (symmetric with getTextHyperlink - the returned object can be passed back to copy a link).
`setTransform(transform)`	Sets the position, size, and rotation of the shape in one call.
`setUnderline(underline, range)`	Sets underlined text.
`setWidth(width)`	Sets the width of the shape.
`setX(x)`	Sets the X coordinate of the shape as an absolute value.
`setY(y)`	Sets the Y coordinate of the shape as an absolute value.

Method details

`align(alignType)`

Aligns the shape relative to the slide. Ignored for shapes that cannot be moved. Group children also move relative to the slide, not within the group (same as the editor). If a child moves outside its group, the group grows to contain it.

align(alignType: AlignType): Promise<void>;

Parameters

Name	Type	Description
`alignType`	`AlignType`	Alignment type

Returns

Promise<void>

`flip(direction)`

Flips the shape vertically or horizontally. This toggles the current flip state; read whether it is currently flipped with isFlippedH()/isFlippedV(). Ignored for shapes that cannot be rotated. For a rotated shape the angle is mirrored as well (getRotation() becomes 360 - previous angle).

flip(direction: FlipDirection): Promise<void>;

Parameters

Name	Type	Description
`direction`	`FlipDirection`	Flip direction

Returns

Promise<void>

`getAdjustValues()`

Returns the adjust values defined on a regular shape and their adjustable ranges. The returned name is used by the adjust-value read and update APIs.

getAdjustValues(): Promise<AdjustValue[] | null>;

Returns

Promise<AdjustValue[] | null> - List of adjust values. null if the target shape is gone (e.g. deleted during collaboration)

`getAlignH(range)`

Returns the representative paragraph's horizontal alignment. (Symmetric with setAlignH.)

getAlignH(range?: TextRange): Promise<TextAlignH | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<TextAlignH | null> - Horizontal alignment. null if there is no text/paragraph

`getAlignV()`

Returns the vertical text alignment. (counterpart of setAlignV) TextAlignV is a numeric enum where TOP is 0, so check for a value with a null comparison, not a truthiness test.

getAlignV(): Promise<TextAlignV | null>;

Returns

Promise<TextAlignV | null> - Vertical alignment. null if there is no target text

`getBold(range)`

Returns whether the representative run is bold. (counterpart of setBold - the effective value including inheritance)

getBold(range?: TextRange): Promise<boolean | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<boolean | null> - Bold state. null if there is no target text or the span is invalid

`getBulletStyle(range)`

Returns the bullet style of the representative paragraph. The returned fields can be spread into setBulletStyle(type, subType, startAt). Values are the effective ones including layout/master inheritance; absent values (start number) and values that cannot be passed back (number types outside the presets) are left out. Picture bullets and characters outside the presets are read-only and cannot be applied as is. (see setBulletStyle for the constraints)

getBulletStyle(range?: TextRange): Promise<BulletStyle | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<BulletStyle | null> - Bullet style. null if there is no text/paragraph

`getEffects()`

Returns the effects applied to the shape. Only applied effects are included as keys. Each value has the same shape as the argument of the matching setter (setOuterShadow/setInnerShadow/setGlow/setSoftEdge/setReflection/set3d). alpha of shadows and glow is always included even when opaque (0); lengths (pt) and ratios (%) are rounded to one decimal place. If the document carries both outerShadow and innerShadow, both are included (the setters can set only one).

getEffects(): Promise<Effects | null>;

Returns

Promise<Effects | null> - Effect information. An empty object \{\} if no effect is applied; null if the target shape is gone (e.g. deleted during collaboration)

`getFill()`

Returns the shape fill. (counterpart of setFill - the returned object can be passed back as is) The per-type setters are setSolidFill/setGradientFill/setImageFill/setPatternFill/removeFill.

getFill(): Promise<Fill | null>;

Returns

Promise<Fill | null> - Fill information. \{ type: FillType.NONE \} for noFill; null if the target shape is gone (e.g. deleted during collaboration)

`getFirstLineIndent(range)`

Returns the representative paragraph's first-line indent (UI "first line"). (Symmetric with setFirstLineIndent.)

getFirstLineIndent(range?: TextRange): Promise<number | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<number | null> - First-line indent (pt, negative is a hanging indent). null if there is no text/paragraph

`getFontFamily(range)`

Returns the font name of the representative run. (counterpart of setFontFamily - the effective value including inheritance)

getFontFamily(range?: TextRange): Promise<string | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<string | null> - Font name. null if there is no target text or the span is invalid

`getFontSize(range)`

Returns the font size (pt) of the representative run. (counterpart of setFontSize - the effective value including inheritance)

getFontSize(range?: TextRange): Promise<number | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<number | null> - Font size (pt). null if there is no target text or the span is invalid

`getFontStyle(range)`

Returns the font style of the representative run (the first run the range touches). (counterpart of setFontStyle) The returned object can be passed as is to another object's setFontStyle. Properties without a value are left out. Values are the effective ones including layout/master/table-style inheritance, so values set directly on the run cannot be singled out.

getFontStyle(range?: TextRange): Promise<FontStyle | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<FontStyle | null> - Font style. An empty object \{\} if there is no run/style; null if the target text is gone (e.g. deleted during collaboration) or the span is invalid

`getHeight()`

Returns the shape's height. (Symmetric with setHeight.)

getHeight(): Promise<number | null>;

Returns

Promise<number | null> - Height (px). null if the target shape is gone

`getHyperlink()`

Returns the hyperlink set on the shape. The returned object can be passed straight to setHyperlink. null if an unsupported kind (run program, macro, etc.) is attached.

getHyperlink(): Promise<Hyperlink | null>;

Returns

Promise<Hyperlink | null> - Hyperlink information. null if there is no hyperlink (action)

`getItalic(range)`

Returns whether the representative run is italic. (counterpart of setItalic - the effective value including inheritance)

getItalic(range?: TextRange): Promise<boolean | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<boolean | null> - Italic state. null if there is no target text or the span is invalid

`getLevel(range)`

Returns the representative paragraph's list level. (Symmetric with setLevel.)

getLevel(range?: TextRange): Promise<number | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<number | null> - List level (1–9). null if there is no text/paragraph

`getLineCap()`

Returns the line cap. (Symmetric with setLineCap.)

getLineCap(): Promise<LineCap | null>;

Returns

Promise<LineCap | null> - Line cap. null if not set or the target shape is gone

`getLineColor()`

Returns the line color. (Symmetric with setLineColor. Use getLineStyle when you also need transparency.)

getLineColor(): Promise<string | null>;

Returns

Promise<string | null> - Line color (hex "#RRGGBB" - scheme colors are resolved to hex). null if there is no line or the target shape is gone

`getLineDash()`

Returns the line dash type. (Symmetric with setLineDash.)

getLineDash(): Promise<LineDash | null>;

Returns

Promise<LineDash | null> - Line dash type. null if it is not a LineDash enum value or the target shape is gone

`getLineJoin()`

Returns the line join type. (Symmetric with setLineJoin.)

getLineJoin(): Promise<LineJoin | null>;

Returns

Promise<LineJoin | null> - Line join (corner) type. null if not set or the target shape is gone

`getLineSpacing(range)`

Returns the representative paragraph's line-spacing value. (Symmetric with setLineSpacing.)

getLineSpacing(range?: TextRange): Promise<number | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<number | null> - Line spacing value (MULTIPLE: percent multiple, EXACT: pt). null if there is no text/paragraph

`getLineSpacingType(range)`

Returns the representative paragraph's line-spacing type. (Symmetric with setLineSpacing's type.)

getLineSpacingType(range?: TextRange): Promise<LineSpacingType | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<LineSpacingType | null> - Line spacing type. null if there is no text/paragraph

`getLineStyle()`

Returns the line style. (counterpart of setLineStyle - the returned object can be passed back as is) The individual setters are setLineColor/setLineGradient/setLineWidth/setLineDash/setLineCap/setLineJoin.

getLineStyle(): Promise<LineStyle | null>;

Returns

Promise<LineStyle | null> - Line style. null if the target shape is gone

`getLineWidth()`

Returns the line width (pt). (Symmetric with setLineWidth.)

getLineWidth(): Promise<number | null>;

Returns

Promise<number | null> - Line width (pt). Returned even when the line is noFill. null if the target shape is gone

`getMarginLeft(range)`

Returns the representative paragraph's left margin (UI "before text"). (Symmetric with setMarginLeft.)

getMarginLeft(range?: TextRange): Promise<number | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<number | null> - Left margin (pt). null if there is no text/paragraph

`getParagraphStyle(range)`

Returns the paragraph format of the representative paragraph (the first paragraph the range touches). (counterpart of setParagraphStyle) The returned object can be passed as is to another object's setParagraphStyle. Properties without a value are left out. Values are the effective ones including layout/master inheritance, so values set directly on the paragraph cannot be singled out, and passing them back to the same paragraph does not leave properties equal to the inherited value as direct settings. The list level is not included - it is an inherited preset, not a format value. (see getLevel)

getParagraphStyle(range?: TextRange): Promise<ParagraphStyle | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<ParagraphStyle | null> - Paragraph format. null if there is no text/paragraph

`getPlaceholderType()`

Returns the placeholder type of the shape.

getPlaceholderType(): Promise<PlaceholderType | null>;

Returns

Promise<PlaceholderType | null> - Placeholder type. null if the shape is not a placeholder or the target shape is gone

`getPresetId()`

Returns the shape's OOXML preset id (prst).

getPresetId(): Promise<string | null>;

Returns

Promise<string | null> - Preset id (prst); null if none

`getRotation()`

Returns the rotation angle of the shape. (counterpart of setRotation)

getRotation(): Promise<number | null>;

Returns

Promise<number | null> - Rotation angle (degrees). null if the target shape is gone

`getSpaceAfter(range)`

Returns the representative paragraph's space after (UI "below paragraph"). (Symmetric with setSpaceAfter.)

getSpaceAfter(range?: TextRange): Promise<number | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<number | null> - Space after the paragraph (pt). null if stored as a multiple (%) or there is no text

`getSpaceBefore(range)`

Returns the representative paragraph's space before (UI "above paragraph"). (Symmetric with setSpaceBefore.)

getSpaceBefore(range?: TextRange): Promise<number | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<number | null> - Space before the paragraph (pt). null if stored as a multiple (%) or there is no text

`getStrike(range)`

Returns the strikethrough type of the representative run. (counterpart of setStrike - the effective value including inheritance)

getStrike(range?: TextRange): Promise<Strike | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<Strike | null> - Strikethrough type. null if there is no target text or the span is invalid

`getText(range)`

Returns the text as plain text. Line breaks between paragraphs are kept, but the line break that ends the last paragraph is not a character and is not included ("" for empty text).

getText(range?: TextRange): Promise<string>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (UTF-16 code unit offsets) (default: the whole text)

Returns

Promise<string> - Text of the span (plain text). "" if there is no text model or the span is empty

`getTextboxAutoFit()`

Returns the text-box auto-fit type. (Symmetric with setTextboxAutoFit.)

getTextboxAutoFit(): Promise<AutoFitType | null>;

Returns

Promise<AutoFitType | null> - Auto-fit type. null if there is no target text

`getTextColor(range)`

Returns the text color of the representative run. (counterpart of setTextColor - the effective value including inheritance)

getTextColor(range?: TextRange): Promise<string | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<string | null> - Text color (hex "#RRGGBB" - scheme colors are resolved to hex). null if the fill is not solid, there is no target text, or the span is invalid

`getTextHyperlink(range)`

Returns the hyperlink of a text span. (counterpart of setTextHyperlink - the returned object can be passed back to copy the link) With range, the run containing the first character of that span is used; without range, the run containing the first character of the text. A hyperlink attached to the shape itself is read with getHyperlink.

getTextHyperlink(range?: TextRange): Promise<Hyperlink | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to query (default: the first character of the text)

Returns

Promise<Hyperlink | null> - Hyperlink information (the same Hyperlink object as getHyperlink). null if there is no link, no text, or the action is not exposed

`getTransform()`

Returns the position, size, and rotation of the shape. x/y are the top-left corner of the shape regardless of flip, so passing the returned value to another shape's setTransform places both shapes at the same spot. Values are rounded to the editor's input units - size to one decimal place, position to integers. The setters use the same units, so shapes placed more finely (e.g. imported documents) move by that amount when the value is passed back.

getTransform(): Promise<ShapeTransform | null>;

Returns

Promise<ShapeTransform | null> - Position, size, and rotation of the shape. null if the target shape is gone (e.g. deleted during collaboration)

`getUnderline(range)`

Returns the underline type of the representative run. (counterpart of setUnderline - the effective value including inheritance)

getUnderline(range?: TextRange): Promise<Underline | null>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to read (default: the whole text)

Returns

Promise<Underline | null> - Underline type. null if there is no target text or the span is invalid

`getWidth()`

Returns the shape's width. (Symmetric with setWidth.)

getWidth(): Promise<number | null>;

Returns

Promise<number | null> - Width (px). null if the target shape is gone

`getX()`

Returns the shape's X coordinate. (Symmetric with setX.)

getX(): Promise<number | null>;

Returns

Promise<number | null> - X coordinate (px). null if the target shape is gone

`getY()`

Returns the shape's Y coordinate. (Symmetric with setY.)

getY(): Promise<number | null>;

Returns

Promise<number | null> - Y coordinate (px). null if the target shape is gone

`getZOrderIndex()`

Returns the z-order index of the shape within its parent (the slide, or the group for a group child). 0 is the back; larger values are further to the front.

getZOrderIndex(): Promise<number | null>;

Returns

Promise<number | null> - z-order index. null if the target shape is gone

`hasText()`

Returns whether the shape contains text. Uses the same criterion the editor uses for empty text - true when there is only whitespace or two or more empty paragraphs (only line breaks), false when there is a single empty paragraph. Kinds without shape-level text (table, group, chart) are always false. (query tables per cell)

hasText(): Promise<boolean | null>;

Returns

Promise<boolean | null> - Whether text exists. null if the target shape is gone

`insertSymbol(textOffset, symbol)`

Inserts a symbol (special character) at the given offset.

insertSymbol(textOffset: number, symbol: string): Promise<void>;

Parameters

Name	Type	Description
`textOffset`	`number`	Insert position offset
`symbol`	`string`	special character to insert (no line break - use insertText to split paragraphs)

Returns

Promise<void>

`insertText(text, textOffset)`

Inserts text. The inserted characters take the run format of the character just before the insertion point.

insertText(text: string, textOffset?: number): Promise<void>;

Parameters

Name	Type	Description
`text`	`string`	Text to insert
`textOffset` (optional)	`number`	Insert position offset (default: end of the text)

Returns

Promise<void>

`isChart()`

Checks whether this handle is a Chart (a type guard for union narrowing). Synchronously inspects the SDK handle's internal discriminator - no postMessage round trip, no await needed.

isChart(): Promise<this is Chart>;

Returns

Promise<this is Chart>

`isControl()`

Checks whether this handle is a Control (a type guard for union narrowing). Synchronously inspects the SDK handle's internal discriminator - no postMessage round trip, no await needed.

isControl(): Promise<this is Control>;

Returns

Promise<this is Control>

`isDiagram()`

Checks whether this handle is a Diagram (a type guard for union narrowing). Synchronously inspects the SDK handle's internal discriminator - no postMessage round trip, no await needed.

isDiagram(): Promise<this is Diagram>;

Returns

Promise<this is Diagram>

`isFlatTx()`

Returns whether the text stays flat during 3D rotation. (counterpart of setFlatTx)

isFlatTx(): Promise<boolean | null>;

Returns

Promise<boolean | null> - Whether the text stays flat. null if the target shape is gone

`isFlippedH()`

Returns whether the shape is flipped horizontally. (calling flip(FlipDirection.HORIZONTAL) toggles this value)

isFlippedH(): Promise<boolean | null>;

Returns

Promise<boolean | null> - Horizontal flip state. null if the target shape is gone

`isFlippedV()`

Returns whether the shape is flipped vertically. (calling flip(FlipDirection.VERTICAL) toggles this value)

isFlippedV(): Promise<boolean | null>;

Returns

Promise<boolean | null> - Vertical flip state. null if the target shape is gone

`isGroup()`

Checks whether this handle is a Group (a type guard for union narrowing). Synchronously inspects the SDK handle's internal discriminator - no postMessage round trip, no await needed.

isGroup(): Promise<this is Group>;

Returns

Promise<this is Group>

`isImage()`

Checks whether this handle is an Image (a type guard for union narrowing). Synchronously inspects the SDK handle's internal discriminator - no postMessage round trip, no await needed.

isImage(): Promise<this is Image>;

Returns

Promise<this is Image>

`isLine()`

Checks whether this handle is a Line (a type guard for union narrowing). Synchronously inspects the SDK handle's internal discriminator - no postMessage round trip, no await needed.

isLine(): Promise<this is Line>;

Returns

Promise<this is Line>

`isOleObject()`

Checks whether this handle is an OleObject (a type guard for union narrowing). Synchronously inspects the SDK handle's internal discriminator - no postMessage round trip, no await needed.

isOleObject(): Promise<this is OleObject>;

Returns

Promise<this is OleObject>

`isPlaceholder()`

Returns whether the shape is a placeholder (title, body frame, etc.).

isPlaceholder(): Promise<boolean | null>;

Returns

Promise<boolean | null> - Placeholder state. null if the target shape is gone

`isShape()`

Checks whether this handle is a Shape (a type guard for union narrowing). Synchronously inspects the SDK handle's internal discriminator - no postMessage round trip, no await needed.

isShape(): Promise<this is Shape>;

Returns

Promise<this is Shape>

`isTable()`

Checks whether this handle is a Table (a type guard for union narrowing). Synchronously inspects the SDK handle's internal discriminator - no postMessage round trip, no await needed.

isTable(): Promise<this is Table>;

Returns

Promise<this is Table>

`moveBy(distance)`

Moves the shape by x, y relative to its current position. (Absolute placement is setX / setY.)

moveBy(distance: ShapeMoveDistance): Promise<void>;

Parameters

Name	Type	Description
`distance`	`ShapeMoveDistance`	Distance to move (px)

Returns

Promise<void>

`remove3d()`

Removes the shape's 3D effect.

remove3d(): Promise<void>;

Returns

Promise<void>

`removeEffect(effectType)`

Removes an effect. Does nothing if that effect is not applied. Only effects the shape holds directly are removed - effects inherited from the shape style (effectRef) cannot be removed, so getEffects() may report an effect that this call leaves untouched.

removeEffect(effectType: EffectType): Promise<void>;

Parameters

Name	Type	Description
`effectType`	`EffectType`	Effect type to remove

Returns

Promise<void>

`removeFill()`

Removes the fill (noFill).

removeFill(): Promise<void>;

Returns

Promise<void>

`removeHyperlink()`

Removes the shape's hyperlink.

removeHyperlink(): Promise<void>;

Returns

Promise<void>

`removeLineColor()`

Removes the line color (noFill).

removeLineColor(): Promise<void>;

Returns

Promise<void>

`removeTextHyperlink(range)`

Removes the text's hyperlink. (For a link on the shape itself, removeHyperlink.)

removeTextHyperlink(range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`range` (optional)	`TextRange`	Text span to clear (default: the whole text)

Returns

Promise<void>

`reorder(order)`

Changes the shape's z-order (forward/backward). Ignored if it is already at the target position.

reorder(order: ShapeZOrder): Promise<void>;

Parameters

Name	Type	Description
`order`	`ShapeZOrder`	Reorder type

Returns

Promise<void>

`set3d(scene3d, sp3d)`

Applies a 3D effect to the shape. An omitted scene3d or sp3d argument is not applied.

set3d(scene3d?: Scene3d, sp3d?: Sp3d): Promise<void>;

Parameters

Name	Type	Description
`scene3d` (optional)	`Scene3d`	Camera (rotation) settings. Not applied when omitted
`sp3d` (optional)	`Sp3d`	Extrusion (depth) settings. Not applied when omitted

Returns

Promise<void>

`setAdjustValue(name, value)`

Changes one adjust value of a regular shape. Use setAdjustValues to change several at once.

setAdjustValue(name: string, value: number): Promise<void>;

Parameters

Name	Type	Description
`name`	`string`	Adjust value name (from getAdjustValues)
`value`	`number`	Adjust value. Rounded to an integer and clamped to the minimum or maximum when outside the allowed range (not clamped when the range is unknown, e.g. min/max from getAdjustValues are null)

Returns

Promise<void>

`setAdjustValues(avList)`

Changes several adjust values of a plain shape at once.

setAdjustValues(avList: AdjustValueUpdate[]): Promise<void>;

Parameters

Name	Type	Description
`avList`	`AdjustValueUpdate[]`	List of adjust values to change

Returns

Promise<void>

`setAlignH(align, range)`

Sets the text's horizontal alignment. With range, applies only to the paragraphs that span covers.

setAlignH(align: TextAlignH, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`align`	`TextAlignH`	Horizontal alignment
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setAlignV(align)`

Sets the vertical text alignment. (counterpart of getAlignV)

setAlignV(align: TextAlignV): Promise<void>;

Parameters

Name	Type	Description
`align`	`TextAlignV`	Vertical alignment

Returns

Promise<void>

`setBold(enabled, range)`

Sets bold text.

setBold(enabled: boolean, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`enabled`	`boolean`	true: bold, false: off
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setBulletStyle(bulletType, subType, startAt, range)`

Sets the bullet style. (counterpart of getBulletStyle) Picture bullets (BulletType.BLIP) are a read-only type that cannot be applied and are rejected. Characters outside the CharType presets cannot be applied either (read-only, with no argument to receive them).

setBulletStyle(
  bulletType: Exclude<BulletType, "buBlip">,
  subType?: NumberedType | CharType,
  startAt?: number,
  range?: TextRange
): Promise<void>;

Parameters

Name	Type	Description
`bulletType`	`Exclude<BulletType, "buBlip">`	Bullet type
`subType` (optional)	`NumberedType \| CharType`	BulletType.AUTO_NUM: numbering type (default NumberedType.NUMBER_WITH_DOT), BulletType.CHAR: bullet character type (default CharType.DOT)
`startAt` (optional)	`number`	Start number (used only with BulletType.AUTO_NUM) (default: 1)
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setEffects(effects)`

Applies an effects object returned by getEffects() as is. (counterpart of getEffects - copies effects shape to shape) Only the included effect keys are applied through the matching setters; scene3d/sp3d are passed to set3d together. Existing effects on the target are not cleared - for an exact copy, remove them first with removeEffect/remove3d. Passing both outerShadow and innerShadow is not rejected; they are applied in order and only the later one remains.

setEffects(effects?: Effects): Promise<void>;

Parameters

Name	Type	Description
`effects` (optional)	`Effects`	Value returned by getEffects(). Changes nothing when omitted

Returns

Promise<void>

`setFill(fill)`

Applies a fill object returned by getFill() as is. (counterpart of getFill - copies a fill shape to shape) image reuses the embed from the query result, so it is restored only within the same document. An image without embed has no picture to apply and is rejected (use setImageFill for a new image).

setFill(fill?: Fill): Promise<void>;

Parameters

Name	Type	Description
`fill` (optional)	`Fill`	Value returned by getFill(). Changes nothing when omitted

Returns

Promise<void>

`setFirstLineIndent(firstLineIndent, range)`

Sets the indent of the paragraph's first line (UI "First line"). Lines from the second onward follow marginLeft. Positive indents, negative creates a hanging indent, 0 means no indent. To change the depth of a bulleted list, use setLevel.

setFirstLineIndent(firstLineIndent: number, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`firstLineIndent`	`number`	First-line indent (pt)
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setFlatTx(enabled)`

Sets whether the text stays flat during 3D rotation. (counterpart of isFlatTx)

setFlatTx(enabled: boolean): Promise<void>;

Parameters

Name	Type	Description
`enabled`	`boolean`	true keeps the text flat, false turns it off

Returns

Promise<void>

`setFontFamily(fontFamily, range)`

Sets the font.

setFontFamily(fontFamily: string, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`fontFamily`	`string`	Font name
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setFontSize(fontSize, range)`

Sets the font size.

setFontSize(fontSize: number, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`fontSize`	`number`	In pt
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setFontStyle(style, range)`

Sets the font style. For single properties prefer setBold/setItalic/setFontSize/setFontFamily/setTextColor.

setFontStyle(style: FontStyle, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`style`	`FontStyle`	Font style settings
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setGlow(glow)`

Applies a glow effect. (counterpart of getEffects().glow - the returned object can be passed back as is) Omitted fields are filled with defaults (see Glow for per-field defaults).

setGlow(glow?: Glow): Promise<void>;

Parameters

Name	Type	Description
`glow` (optional)	`Glow`	Glow settings

Returns

Promise<void>

`setGradientFill(type, stops, angle)`

Sets a gradient fill.

setGradientFill(
  type?: GradientType,
  stops?: { color: string; pos?: number; alpha?: number }[],
  angle?: number
): Promise<void>;

Parameters

Name	Type	Description
`type` (optional)	`GradientType`	Gradient type (lin/circle/rect/shape) (default: GradientType.LINEAR)
`stops` (optional)	`{ color: string; pos?: number; alpha?: number }[]`	Color stops. Distributed evenly when pos is omitted; alpha is transparency (0–100, 0 = opaque) (default: [{ color: "accent1", pos: 0 }, { color: "bg1", pos: 100 }])
`angle` (optional)	`number`	Gradient angle (used only for lin) (default: 45)

Returns

Promise<void>

`setHeight(height)`

Sets the height of the shape. Ignored for shapes that cannot be resized.

setHeight(height: number): Promise<void>;

Parameters

Name	Type	Description
`height`	`number`	Height (px, rounded to one decimal place)

Returns

Promise<void>

`setHyperlink(hyperlink)`

Sets a hyperlink on the shape (symmetric with getHyperlink - the returned object can be passed back to copy a hyperlink). An unsupported kind or an invalid target, such as a deleted slide, is ignored.

setHyperlink(hyperlink: Hyperlink): Promise<void>;

Parameters

Name	Type	Description
`hyperlink`	`Hyperlink`	The same Hyperlink object as returned by getHyperlink(). Ignored if type is missing

Returns

Promise<void>

`setImageFill(imageUrl, fillMode, alpha, detail)`

Sets an image fill.

setImageFill(
  imageUrl: string,
  fillMode?: ImageFillMode,
  alpha?: number,
  detail?: ImageFillDetail
): Promise<void>;

Parameters

Name	Type	Description
`imageUrl`	`string`	Image URL
`fillMode` (optional)	`ImageFillMode`	Image fill mode (default: ImageFillMode.STRETCH)
`alpha` (optional)	`number`	Transparency (0–100, 0 = opaque) (default: 0)
`detail` (optional)	`ImageFillDetail`	Detail options. offset/scale/mirror/align apply only when fillMode = ImageFillMode.TILE (default: {})

Returns

Promise<void> - Resolves once the image is uploaded and the fill is applied. Rejects with SHAPE_NOT_FOUND if the target shape is gone (including deletion during upload)

`setInnerShadow(shadow)`

Applies an inner shadow. (counterpart of getEffects().innerShadow - the returned object can be passed back as is) Omitted fields are filled with defaults (see InnerShadow for per-field defaults). A shape has one shadow - an existing outer shadow is replaced by the inner shadow.

setInnerShadow(shadow?: InnerShadow): Promise<void>;

Parameters

Name	Type	Description
`shadow` (optional)	`InnerShadow`	Shadow settings

Returns

Promise<void>

`setItalic(enabled, range)`

Sets italic text.

setItalic(enabled: boolean, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`enabled`	`boolean`	true: italic, false: off
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setLevel(level, range)`

Sets the list level (outline depth). Every paragraph the range touches gets the same level. Unlike the pt-based indents (setFirstLineIndent/setMarginLeft), the level selects an inherited preset, so changing it brings that level's bullet and font size along and overwrites marginLeft with the new level's value. A value set with setMarginLeft is discarded too, so call setLevel first when using both. (firstLineIndent is kept) Clamped to the range the target text allows (title objects have level 1 only).

setLevel(level: number, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`level`	`number`	List level (1 = top level to 9)
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setLineCap(lineCap)`

Sets the line cap.

setLineCap(lineCap: LineCap): Promise<void>;

Parameters

Name	Type	Description
`lineCap`	`LineCap`	Line cap

Returns

Promise<void>

`setLineColor(color, alpha)`

Sets the line color.

setLineColor(color: string, alpha?: number): Promise<void>;

Parameters

Name	Type	Description
`color`	`string`	hex (#RRGGBB) or scheme color
`alpha` (optional)	`number`	Transparency (0–100, 0 = opaque). Stored to three decimal places (default: keeps the current value)

Returns

Promise<void>

`setLineDash(lineDash)`

Sets the line style (dash).

setLineDash(lineDash: LineDash): Promise<void>;

Parameters

Name	Type	Description
`lineDash`	`LineDash`	Line dash style

Returns

Promise<void>

`setLineGradient(type, stops, angle)`

Sets a gradient fill on the line (border).

setLineGradient(
  type?: GradientType,
  stops?: { color: string; pos?: number; alpha?: number }[],
  angle?: number
): Promise<void>;

Parameters

Name	Type	Description
`type` (optional)	`GradientType`	Gradient type (lin/circle/rect/shape) (default: GradientType.LINEAR)
`stops` (optional)	`{ color: string; pos?: number; alpha?: number }[]`	Color stops. Distributed evenly when pos is omitted; alpha is transparency (0–100, 0 = opaque) (default: [{ color: "accent1", pos: 0 }, { color: "bg1", pos: 100 }])
`angle` (optional)	`number`	Gradient angle (used only for lin) (default: 45)

Returns

Promise<void>

`setLineJoin(lineJoin)`

Sets the line join type.

setLineJoin(lineJoin: LineJoin): Promise<void>;

Parameters

Name	Type	Description
`lineJoin`	`LineJoin`	Line join (corner) type

Returns

Promise<void>

`setLineSpacing(lineSpacing, type, range)`

Sets the line spacing. With range, applies only to the paragraphs that span touches. The unit of lineSpacing depends on the type - a percent multiple for MULTIPLE (150 = 1.5x), pt for EXACT.

setLineSpacing(lineSpacing: number, type?: LineSpacingType, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`lineSpacing`	`number`	Line spacing value (MULTIPLE: percent multiple, EXACT: pt)
`type` (optional)	`LineSpacingType`	Line spacing type (default: LineSpacingType.MULTIPLE)
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setLineStyle(style)`

Applies a line-style object returned by getLineStyle() as-is (symmetric with getLineStyle - shape-to-shape line copy).

setLineStyle(style?: LineStyle): Promise<void>;

Parameters

Name	Type	Description
`style` (optional)	`LineStyle`	Value returned by getLineStyle(). Changes nothing when omitted

Returns

Promise<void>

`setLineWidth(lineWidth)`

Sets the line width.

setLineWidth(lineWidth: number): Promise<void>;

Parameters

Name	Type	Description
`lineWidth`	`number`	Line width (pt)

Returns

Promise<void>

`setMarginLeft(marginLeft, range)`

Sets the left margin of the whole paragraph (UI "Before text"). To indent only the first line, use setFirstLineIndent.

setMarginLeft(marginLeft: number, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`marginLeft`	`number`	Left margin (pt)
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setOuterShadow(shadow)`

Applies an outer shadow. (counterpart of getEffects().outerShadow - the returned object can be passed back as is) Omitted fields are filled with defaults (see OuterShadow for per-field defaults). A shape has one shadow - an existing inner shadow is replaced by the outer shadow.

setOuterShadow(shadow?: OuterShadow): Promise<void>;

Parameters

Name	Type	Description
`shadow` (optional)	`OuterShadow`	Shadow settings

Returns

Promise<void>

`setParagraphStyle(style, range)`

Sets the paragraph format in one call. With range, applies only to the paragraphs that span touches. Only properties given a value change. null/undefined mean "no change", and there is no way yet to revert a set value to the inherited state. For single properties, prefer setLineSpacing/setMarginLeft/setFirstLineIndent/setSpaceBefore/setSpaceAfter. The list level is not included because changing it has side effects (bullet, font size). (see setLevel)

setParagraphStyle(style: ParagraphStyle, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`style`	`ParagraphStyle`	Paragraph format settings
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setPatternFill(preset, foreColor, backColor, foreAlpha, backAlpha)`

Sets a pattern fill. (round-trip counterpart of getFill)

setPatternFill(
  preset: PatternPreset,
  foreColor?: string,
  backColor?: string,
  foreAlpha?: number,
  backAlpha?: number
): Promise<void>;

Parameters

Name	Type	Description
`preset`	`PatternPreset`	Pattern preset (apiConstants.PatternPreset)
`foreColor` (optional)	`string`	Foreground color hex (#RRGGBB) or scheme color (defaults to theme accent 1) (default: "accent1")
`backColor` (optional)	`string`	Background color hex (#RRGGBB) or scheme color (defaults to theme background 1) (default: "bg1")
`foreAlpha` (optional)	`number`	Foreground transparency (0–100, 0 = opaque) (default: 0)
`backAlpha` (optional)	`number`	Background transparency (0–100, 0 = opaque) (default: 0)

Returns

Promise<void>

`setReflection(reflection)`

Applies a reflection effect. (counterpart of getEffects().reflection - the returned object can be passed back as is) Omitted fields are filled with defaults (see Reflection for per-field defaults).

setReflection(reflection?: Reflection): Promise<void>;

Parameters

Name	Type	Description
`reflection` (optional)	`Reflection`	Reflection settings

Returns

Promise<void>

`setRotation(rotation)`

Sets the rotation angle of the shape as an absolute value. Ignored for shapes that cannot be rotated. (counterpart of getRotation)

setRotation(rotation: number): Promise<void>;

Parameters

Name	Type	Description
`rotation`	`number`	Rotation angle (degrees)

Returns

Promise<void>

`setSoftEdge(softEdge)`

Applies a soft edge effect. (counterpart of getEffects().softEdge - the returned object can be passed back as is) Omitted fields are filled with defaults (see SoftEdge for per-field defaults).

setSoftEdge(softEdge?: SoftEdge): Promise<void>;

Parameters

Name	Type	Description
`softEdge` (optional)	`SoftEdge`	Soft edge settings

Returns

Promise<void>

`setSolidFill(color, alpha)`

Sets the shape fill to a solid color.

setSolidFill(color: string, alpha?: number): Promise<void>;

Parameters

Name	Type	Description
`color`	`string`	hex (#RRGGBB) or scheme color
`alpha` (optional)	`number`	Transparency (0–100, 0 = opaque). Stored to three decimal places (default: keeps the current value)

Returns

Promise<void>

`setSpaceAfter(spaceAfter, range)`

Sets the space after the paragraph (UI "below paragraph").

setSpaceAfter(spaceAfter: number, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`spaceAfter`	`number`	Space after the paragraph (pt)
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setSpaceBefore(spaceBefore, range)`

Sets the space before the paragraph (UI "above paragraph").

setSpaceBefore(spaceBefore: number, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`spaceBefore`	`number`	Space before the paragraph (pt)
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setStrike(strike, range)`

Sets strikethrough text.

setStrike(strike: Strike, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`strike`	`Strike`	Strikethrough type
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setText(text, range)`

Sets the text. Behaves as follows depending on the arguments.
no range: replaces the whole text with text
with range: replaces only that span with text
when text is an empty string (""), deletes the span instead of replacing it

setText(text: string, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`text`	`string`	Text to set. An empty string ("") deletes
`range` (optional)	`TextRange`	Text span to replace, where to = from + character count - 1 (0-based). E.g. all of "abc" = {from: 0, to: 2}, the "a" in "abc" = {from: 0, to: 0}. Offsets are UTF-16 code units, so a range that splits a surrogate pair covers the whole character rather than half of it (the same holds for the formatting setters that take a range) (default: the whole text)

Returns

Promise<void>

`setTextboxAutoFit(autoAlignType)`

Sets the text box auto-fit type. Does nothing if the type is already the same.

setTextboxAutoFit(autoAlignType: AutoFitType): Promise<void>;

Parameters

Name	Type	Description
`autoAlignType`	`AutoFitType`	Auto-fit type

Returns

Promise<void>

`setTextColor(color, range)`

Sets the text color.

setTextColor(color: string, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`color`	`string`	hex (#RRGGBB) or scheme color
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setTextHyperlink(hyperlink, range)`

Sets a hyperlink on the text (symmetric with getTextHyperlink - the returned object can be passed back to copy a link). Unlike setHyperlink, which links the whole shape, the link applies per text run and is shown with hyperlink formatting. An unsupported kind or an invalid target, such as a deleted slide, is ignored.

setTextHyperlink(hyperlink: Hyperlink, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`hyperlink`	`Hyperlink`	The same Hyperlink object as returned by getTextHyperlink(). Ignored if type is missing
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setTransform(transform)`

Sets the position, size, and rotation of the shape in one call. The value returned by getTransform() can be passed as is. (counterpart of getTransform) Only the fields given a value are applied, in the order size → position → rotation; omitted fields keep their current value. As with the individual setters, each field is ignored on shapes that do not support that operation (resize/move/rotate).

setTransform(transform?: Partial<ShapeTransform>): Promise<void>;

Parameters

Name	Type	Description
`transform` (optional)	`Partial<ShapeTransform>`	Position/size (px) · rotation (degrees)

Returns

Promise<void>

`setUnderline(underline, range)`

Sets underlined text.

setUnderline(underline: Underline, range?: TextRange): Promise<void>;

Parameters

Name	Type	Description
`underline`	`Underline`	Underline type
`range` (optional)	`TextRange`	Text span to apply to (default: the whole text)

Returns

Promise<void>

`setWidth(width)`

Sets the width of the shape. Ignored for shapes that cannot be resized.

setWidth(width: number): Promise<void>;

Parameters

Name	Type	Description
`width`	`number`	Width (px, rounded to one decimal place)

Returns

Promise<void>

`setX(x)`

Sets the X coordinate of the shape as an absolute value. Ignored for shapes that cannot be moved. (use moveBy for a relative move)

setX(x: number): Promise<void>;

Parameters

Name	Type	Description
`x`	`number`	X coordinate (px, rounded to an integer)

Returns

Promise<void>

`setY(y)`

Sets the Y coordinate of the shape as an absolute value. Ignored for shapes that cannot be moved.

setY(y: number): Promise<void>;

Parameters

Name	Type	Description
`y`	`number`	Y coordinate (px, rounded to an integer)

Returns

Promise<void>

Remarks
Methods
Method details

Remarks​

Methods​

Method details​

align(alignType)​

flip(direction)​

getAdjustValues()​

getAlignH(range)​

getAlignV()​

getBold(range)​

getBulletStyle(range)​

getEffects()​

getFill()​

getFirstLineIndent(range)​

getFontFamily(range)​

getFontSize(range)​

getFontStyle(range)​

getHeight()​

getHyperlink()​

getItalic(range)​

getLevel(range)​

getLineCap()​

getLineColor()​

getLineDash()​

getLineJoin()​

getLineSpacing(range)​

getLineSpacingType(range)​

getLineStyle()​

getLineWidth()​

getMarginLeft(range)​

getParagraphStyle(range)​

getPlaceholderType()​

getPresetId()​

getRotation()​

getSpaceAfter(range)​

getSpaceBefore(range)​

getStrike(range)​

getText(range)​

getTextboxAutoFit()​

getTextColor(range)​

getTextHyperlink(range)​

getTransform()​

getUnderline(range)​

getWidth()​

getX()​

getY()​

getZOrderIndex()​

hasText()​

insertSymbol(textOffset, symbol)​

insertText(text, textOffset)​

isChart()​

isControl()​

isDiagram()​

isFlatTx()​

isFlippedH()​

isFlippedV()​

isGroup()​

isImage()​

isLine()​

isOleObject()​

isPlaceholder()​

isShape()​

isTable()​

moveBy(distance)​

remove3d()​

removeEffect(effectType)​

removeFill()​

removeHyperlink()​

removeLineColor()​

removeTextHyperlink(range)​

reorder(order)​

set3d(scene3d, sp3d)​

setAdjustValue(name, value)​

setAdjustValues(avList)​

setAlignH(align, range)​

setAlignV(align)​

setBold(enabled, range)​

setBulletStyle(bulletType, subType, startAt, range)​

setEffects(effects)​

setFill(fill)​

setFirstLineIndent(firstLineIndent, range)​

Remarks

Methods

Method details

`align(alignType)`

`flip(direction)`

`getAdjustValues()`

`getAlignH(range)`

`getAlignV()`

`getBold(range)`

`getBulletStyle(range)`

`getEffects()`

`getFill()`

`getFirstLineIndent(range)`

`getFontFamily(range)`

`getFontSize(range)`

`getFontStyle(range)`

`getHeight()`

`getHyperlink()`

`getItalic(range)`

`getLevel(range)`

`getLineCap()`

`getLineColor()`

`getLineDash()`

`getLineJoin()`

`getLineSpacing(range)`

`getLineSpacingType(range)`

`getLineStyle()`

`getLineWidth()`

`getMarginLeft(range)`

`getParagraphStyle(range)`

`getPlaceholderType()`

`getPresetId()`

`getRotation()`

`getSpaceAfter(range)`

`getSpaceBefore(range)`

`getStrike(range)`

`getText(range)`

`getTextboxAutoFit()`

`getTextColor(range)`

`getTextHyperlink(range)`

`getTransform()`

`getUnderline(range)`

`getWidth()`

`getX()`

`getY()`

`getZOrderIndex()`

`hasText()`

`insertSymbol(textOffset, symbol)`

`insertText(text, textOffset)`

`isChart()`

`isControl()`

`isDiagram()`

`isFlatTx()`

`isFlippedH()`

`isFlippedV()`

`isGroup()`

`isImage()`

`isLine()`

`isOleObject()`

`isPlaceholder()`

`isShape()`

`isTable()`

`moveBy(distance)`

`remove3d()`

`removeEffect(effectType)`

`removeFill()`

`removeHyperlink()`

`removeLineColor()`

`removeTextHyperlink(range)`

`reorder(order)`

`set3d(scene3d, sp3d)`

`setAdjustValue(name, value)`

`setAdjustValues(avList)`

`setAlignH(align, range)`

`setAlignV(align)`

`setBold(enabled, range)`

`setBulletStyle(bulletType, subType, startAt, range)`

`setEffects(effects)`

`setFill(fill)`

`setFirstLineIndent(firstLineIndent, range)`