Word.Interfaces.ThreeDimensionalFormatUpdateData interface
An interface for updating data on the ThreeDimensionalFormat object, for use in threeDimensionalFormat.set({ ... }).
Properties
| bevel |
Specifies the depth of the bottom bevel. |
| bevel |
Specifies the inset size for the bottom bevel. |
| bevel |
Specifies a |
| bevel |
Specifies the depth of the top bevel. |
| bevel |
Specifies the inset size for the top bevel. |
| bevel |
Specifies a |
| contour |
Returns a |
| contour |
Specifies the width of the contour of a shape. |
| depth | Specifies the depth of the shape's extrusion. |
| extrusion |
Returns a |
| extrusion |
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. |
| field |
Specifies the amount of perspective for a shape. |
| is |
Specifies |
| is |
Specifies if the specified object, or the formatting applied to it, is visible. |
| light |
Specifies the angle of the lighting. |
| preset |
Specifies a |
| preset |
Specifies the position of the light source relative to the extrusion. |
| preset |
Specifies the intensity of the extrusion lighting. |
| preset |
Specifies the extrusion surface material. |
| project |
Specifies whether text on a shape rotates with shape. |
| 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
bevelBottomInset
Specifies the inset size for the bottom bevel.
bevelBottomInset?: number;Property Value
number
Remarks
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
bevelTopDepth
Specifies the depth of the top bevel.
bevelTopDepth?: number;Property Value
number
Remarks
bevelTopInset
Specifies the inset size for the top bevel.
bevelTopInset?: number;Property Value
number
Remarks
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
contourColor
Returns a ColorFormat object that represents color of the contour of a shape.
contourColor?: Word.Interfaces.ColorFormatUpdateData;Property Value
Remarks
contourWidth
Specifies the width of the contour of a shape.
contourWidth?: number;Property Value
number
Remarks
depth
Specifies the depth of the shape's extrusion.
depth?: number;Property Value
number
Remarks
extrusionColor
Returns a ColorFormat object that represents the color of the shape's extrusion.
extrusionColor?: Word.Interfaces.ColorFormatUpdateData;Property Value
Remarks
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
fieldOfView
Specifies the amount of perspective for a shape.
fieldOfView?: number;Property Value
number
Remarks
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
isVisible
Specifies if the specified object, or the formatting applied to it, is visible.
isVisible?: boolean;Property Value
boolean
Remarks
lightAngle
Specifies the angle of the lighting.
lightAngle?: number;Property Value
number
Remarks
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
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
presetLightingSoftness
Specifies the intensity of the extrusion lighting.
presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright";Property Value
Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"
Remarks
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
projectText
Specifies whether text on a shape rotates with shape. true rotates the text.
projectText?: boolean;Property Value
boolean
Remarks
rotationX
Specifies the rotation of the extruded shape around the x-axis in degrees.
rotationX?: number;Property Value
number
Remarks
rotationY
Specifies the rotation of the extruded shape around the y-axis in degrees.
rotationY?: number;Property Value
number
Remarks
rotationZ
Specifies the z-axis rotation of the camera.
rotationZ?: number;Property Value
number
Remarks
z
Specifies the position on the z-axis for the shape.
z?: number;Property Value
number