Edit

Share via

Word.Interfaces.ThreeDimensionalFormatUpdateData interface

Package:
word

An interface for updating data on the ThreeDimensionalFormat object, for use in threeDimensionalFormat.set({ ... }).

Properties

bevelBottomDepth

Specifies the depth of the bottom bevel.
bevelBottomInset

Specifies the inset size for the bottom bevel.
bevelBottomType

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

Specifies the depth of the top bevel.
bevelTopInset

Specifies the inset size for the top bevel.
bevelTopType

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

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

Specifies the width of the contour of a shape.
depth

Specifies the depth of the shape's extrusion.
extrusionColor

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

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.
fieldOfView

Specifies the amount of perspective for a shape.
isPerspective

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.
isVisible

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

Specifies the angle of the lighting.
presetLighting

Specifies a LightRigType value that represents the lighting preset.
presetLightingDirection

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

Specifies the intensity of the extrusion lighting.
presetMaterial

Specifies the extrusion surface material.
projectText

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

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

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

Specifies the z-axis rotation of the camera.
z

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

Property Details

bevelBottomDepth

Specifies the depth of the bottom bevel.

bevelBottomDepth?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

bevelBottomInset

Specifies the inset size for the bottom bevel.

bevelBottomInset?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

bevelBottomType

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

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

Remarks

[ API set: WordApiDesktop 1.3 ]

bevelTopDepth

Specifies the depth of the top bevel.

bevelTopDepth?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

bevelTopInset

Specifies the inset size for the top bevel.

bevelTopInset?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

bevelTopType

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

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

Remarks

[ API set: WordApiDesktop 1.3 ]

contourColor

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

contourColor?: Word.Interfaces.ColorFormatUpdateData;

Property Value

Word.Interfaces.ColorFormatUpdateData

Remarks

[ API set: WordApiDesktop 1.3 ]

contourWidth

Specifies the width of the contour of a shape.

contourWidth?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

depth

Specifies the depth of the shape's extrusion.

depth?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

extrusionColor

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

extrusionColor?: Word.Interfaces.ColorFormatUpdateData;

Property Value

Word.Interfaces.ColorFormatUpdateData

Remarks

[ API set: WordApiDesktop 1.3 ]

extrusionColorType

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

Word.ExtrusionColorType | "mixed" | "automatic" | "custom"

Remarks

[ API set: WordApiDesktop 1.3 ]

fieldOfView

Specifies the amount of perspective for a shape.

fieldOfView?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

isPerspective

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

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

isVisible

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

isVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

lightAngle

Specifies the angle of the lighting.

lightAngle?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

presetLighting

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

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"

Remarks

[ API set: WordApiDesktop 1.3 ]

presetLightingDirection

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

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

Remarks

[ API set: WordApiDesktop 1.3 ]

presetLightingSoftness

Specifies the intensity of the extrusion lighting.

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

Property Value

Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"

Remarks

[ API set: WordApiDesktop 1.3 ]

presetMaterial

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

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

Remarks

[ API set: WordApiDesktop 1.3 ]

projectText

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

projectText?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

rotationX

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

rotationX?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

rotationY

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

rotationY?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

rotationZ

Specifies the z-axis rotation of the camera.

rotationZ?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

z

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

z?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]