Word.ThreeDimensionalFormat class

Specifies the depth of the bottom bevel.

bevelBottomDepth: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the inset size for the bottom bevel.

bevelBottomInset: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies a BevelType value that represents the bevel type for the bottom bevel.

bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the depth of the top bevel.

bevelTopDepth: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the inset size for the top bevel.

bevelTopInset: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies a BevelType value that represents the bevel type for the top bevel.

bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Returns a ColorFormat object that represents color of the contour of a shape.

readonly contourColor: Word.ColorFormat;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the width of the contour of a shape.

contourWidth: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the depth of the shape's extrusion.

depth: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns a ColorFormat object that represents the color of the shape's extrusion.

readonly extrusionColor: Word.ColorFormat;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill.

extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the amount of perspective for a shape.

fieldOfView: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies true if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, false if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point.

isPerspective: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies if the specified object, or the formatting applied to it, is visible.

isVisible: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the angle of the lighting.

lightAngle: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns a PresetCamera value that represents the camera presets.

readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion).

readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies a LightRigType value that represents the lighting preset.

presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the position of the light source relative to the extrusion.

presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the intensity of the extrusion lighting.

presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the extrusion surface material.

presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns the preset extrusion format.

readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies whether text on a shape rotates with shape. true rotates the text.

projectText: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the rotation of the extruded shape around the x-axis in degrees.

rotationX: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the rotation of the extruded shape around the y-axis in degrees.

rotationY: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the z-axis rotation of the camera.

rotationZ: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the position on the z-axis for the shape.

z: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Horizontally rotates a shape on the x-axis. The number of degrees to rotate.

incrementRotationHorizontal(increment: number): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Vertically rotates a shape on the y-axis. The number of degrees to rotate.

incrementRotationVertical(increment: number): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Changes the rotation around the x-axis. The number of degrees to rotate.

incrementRotationX(increment: number): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Changes the rotation around the y-axis. The number of degrees to rotate.

incrementRotationY(increment: number): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Rotates a shape on the z-axis. The number of degrees to rotate.

incrementRotationZ(increment: number): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.ThreeDimensionalFormat;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.ThreeDimensionalFormat;

Parameters

Returns

Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0.

resetRotation(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.ThreeDimensionalFormat): void;

Parameters

Returns

Sets the direction of the extrusion's sweep path.

setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sets the direction of the extrusion's sweep path.

setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sets the camera preset for the shape. The preset camera type.

setPresetCamera(presetCamera: Word.PresetCamera): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sets the camera preset for the shape. The preset camera type.

setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sets the preset extrusion format. The preset format.

setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sets the preset extrusion format. The preset format.

setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.ThreeDimensionalFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.ThreeDimensionalFormatData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.ThreeDimensionalFormatData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.ThreeDimensionalFormat;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.ThreeDimensionalFormat;

Returns