ThreeDFormat

ThreeDFormat class

Represents a shape’s three-dimensional formatting.

class ThreeDFormat;

Properties

Property	Type	Description
bottomBevelWidth	number	Gets and sets the width of the bottom bevel, or how far into the shape it is applied. In unit of Points.
bottomBevelHeight	number	Gets and sets the height of the bottom bevel, or how far into the shape it is applied. In unit of Points.
bottomBevelType	BevelType	Gets and sets the type of the bottom bevel, or how far into the shape it is applied. In unit of Points.
topBevelWidth	number	Gets and sets the width of the top bevel, or how far into the shape it is applied. In unit of Points.
topBevelHeight	number	Gets and sets the height of the top bevel, or how far into the shape it is applied. In unit of Points.
topBevelType	BevelType	Gets and sets the type of the top bevel, or how far into the shape it is applied. In unit of Points.
material	PresetMaterialType	Represents the preset material which is combined with the lighting properties to give the final look and feel of a shape.
contourColor	CellsColor	Gets and sets the contour color on a shape.
contourWidth	number	Gets and sets the contour width on the shape, in unit of points.
extrusionColor	CellsColor	Gets the extrusion color on a shape.
extrusionHeight	number	Gets and sets the extrusion height of the applied to the shape, in unit of points.
z	number	Defines the distance from ground for the 3D shape.
lightAngle	number	Gets and sets the angle of the extrusion lights.
lighting	LightRigType	Gets and sets type of light rig.
lightingDirection	LightRigDirectionType	Gets and sets the direction from which the light rig is oriented in relation to the scene.
perspective	number	Gets and sets the angle at which a ThreeDFormat object can be viewed.
rotationX	number	Gets and sets the rotation of the extruded shape around the x-axis in degrees.
rotationY	number	Gets and sets the rotation of the extruded shape around the y-axis in degrees.
rotationZ	number	Gets and sets the rotation of the extruded shape around the z-axis in degrees.
presetCameraType	PresetCameraType	Gets and sets the extrusion preset camera type.

Methods

Method	Description
getBottomBevelWidth()	@deprecated. Please use the ‘bottomBevelWidth’ property instead. Gets and sets the width of the bottom bevel, or how far into the shape it is applied. In unit of Points.
setBottomBevelWidth(number)	@deprecated. Please use the ‘bottomBevelWidth’ property instead. Gets and sets the width of the bottom bevel, or how far into the shape it is applied. In unit of Points.
getBottomBevelHeight()	@deprecated. Please use the ‘bottomBevelHeight’ property instead. Gets and sets the height of the bottom bevel, or how far into the shape it is applied. In unit of Points.
setBottomBevelHeight(number)	@deprecated. Please use the ‘bottomBevelHeight’ property instead. Gets and sets the height of the bottom bevel, or how far into the shape it is applied. In unit of Points.
getBottomBevelType()	@deprecated. Please use the ‘bottomBevelType’ property instead. Gets and sets the type of the bottom bevel, or how far into the shape it is applied. In unit of Points.
setBottomBevelType(BevelType)	@deprecated. Please use the ‘bottomBevelType’ property instead. Gets and sets the type of the bottom bevel, or how far into the shape it is applied. In unit of Points.
getTopBevelWidth()	@deprecated. Please use the ’topBevelWidth’ property instead. Gets and sets the width of the top bevel, or how far into the shape it is applied. In unit of Points.
setTopBevelWidth(number)	@deprecated. Please use the ’topBevelWidth’ property instead. Gets and sets the width of the top bevel, or how far into the shape it is applied. In unit of Points.
getTopBevelHeight()	@deprecated. Please use the ’topBevelHeight’ property instead. Gets and sets the height of the top bevel, or how far into the shape it is applied. In unit of Points.
setTopBevelHeight(number)	@deprecated. Please use the ’topBevelHeight’ property instead. Gets and sets the height of the top bevel, or how far into the shape it is applied. In unit of Points.
getTopBevelType()	@deprecated. Please use the ’topBevelType’ property instead. Gets and sets the type of the top bevel, or how far into the shape it is applied. In unit of Points.
setTopBevelType(BevelType)	@deprecated. Please use the ’topBevelType’ property instead. Gets and sets the type of the top bevel, or how far into the shape it is applied. In unit of Points.
getMaterial()	@deprecated. Please use the ‘material’ property instead. Represents the preset material which is combined with the lighting properties to give the final look and feel of a shape.
setMaterial(PresetMaterialType)	@deprecated. Please use the ‘material’ property instead. Represents the preset material which is combined with the lighting properties to give the final look and feel of a shape.
getContourColor()	@deprecated. Please use the ‘contourColor’ property instead. Gets and sets the contour color on a shape.
setContourColor(CellsColor)	@deprecated. Please use the ‘contourColor’ property instead. Gets and sets the contour color on a shape.
getContourWidth()	@deprecated. Please use the ‘contourWidth’ property instead. Gets and sets the contour width on the shape, in unit of points.
setContourWidth(number)	@deprecated. Please use the ‘contourWidth’ property instead. Gets and sets the contour width on the shape, in unit of points.
getExtrusionColor()	@deprecated. Please use the ’extrusionColor’ property instead. Gets the extrusion color on a shape.
setExtrusionColor(CellsColor)	@deprecated. Please use the ’extrusionColor’ property instead. Gets the extrusion color on a shape.
getExtrusionHeight()	@deprecated. Please use the ’extrusionHeight’ property instead. Gets and sets the extrusion height of the applied to the shape, in unit of points.
setExtrusionHeight(number)	@deprecated. Please use the ’extrusionHeight’ property instead. Gets and sets the extrusion height of the applied to the shape, in unit of points.
getZ()	@deprecated. Please use the ‘z’ property instead. Defines the distance from ground for the 3D shape.
setZ(number)	@deprecated. Please use the ‘z’ property instead. Defines the distance from ground for the 3D shape.
getLightAngle()	@deprecated. Please use the ’lightAngle’ property instead. Gets and sets the angle of the extrusion lights.
setLightAngle(number)	@deprecated. Please use the ’lightAngle’ property instead. Gets and sets the angle of the extrusion lights.
getLighting()	@deprecated. Please use the ’lighting’ property instead. Gets and sets type of light rig.
setLighting(LightRigType)	@deprecated. Please use the ’lighting’ property instead. Gets and sets type of light rig.
getLightingDirection()	@deprecated. Please use the ’lightingDirection’ property instead. Gets and sets the direction from which the light rig is oriented in relation to the scene.
setLightingDirection(LightRigDirectionType)	@deprecated. Please use the ’lightingDirection’ property instead. Gets and sets the direction from which the light rig is oriented in relation to the scene.
getPerspective()	@deprecated. Please use the ‘perspective’ property instead. Gets and sets the angle at which a ThreeDFormat object can be viewed.
setPerspective(number)	@deprecated. Please use the ‘perspective’ property instead. Gets and sets the angle at which a ThreeDFormat object can be viewed.
getRotationX()	@deprecated. Please use the ‘rotationX’ property instead. Gets and sets the rotation of the extruded shape around the x-axis in degrees.
setRotationX(number)	@deprecated. Please use the ‘rotationX’ property instead. Gets and sets the rotation of the extruded shape around the x-axis in degrees.
getRotationY()	@deprecated. Please use the ‘rotationY’ property instead. Gets and sets the rotation of the extruded shape around the y-axis in degrees.
setRotationY(number)	@deprecated. Please use the ‘rotationY’ property instead. Gets and sets the rotation of the extruded shape around the y-axis in degrees.
getRotationZ()	@deprecated. Please use the ‘rotationZ’ property instead. Gets and sets the rotation of the extruded shape around the z-axis in degrees.
setRotationZ(number)	@deprecated. Please use the ‘rotationZ’ property instead. Gets and sets the rotation of the extruded shape around the z-axis in degrees.
getPresetCameraType()	@deprecated. Please use the ‘presetCameraType’ property instead. Gets and sets the extrusion preset camera type.
setPresetCameraType(PresetCameraType)	@deprecated. Please use the ‘presetCameraType’ property instead. Gets and sets the extrusion preset camera type.
isNull()	Checks whether the implementation object is null.
getHashCode()	Gets hashcode.
equals(Object)

bottomBevelWidth

Gets and sets the width of the bottom bevel, or how far into the shape it is applied. In unit of Points.

bottomBevelWidth : number;

bottomBevelHeight

Gets and sets the height of the bottom bevel, or how far into the shape it is applied. In unit of Points.

bottomBevelHeight : number;

bottomBevelType

Gets and sets the type of the bottom bevel, or how far into the shape it is applied. In unit of Points.

bottomBevelType : BevelType;

topBevelWidth

Gets and sets the width of the top bevel, or how far into the shape it is applied. In unit of Points.

topBevelWidth : number;

topBevelHeight

Gets and sets the height of the top bevel, or how far into the shape it is applied. In unit of Points.

topBevelHeight : number;

topBevelType

Gets and sets the type of the top bevel, or how far into the shape it is applied. In unit of Points.

topBevelType : BevelType;

material

Represents the preset material which is combined with the lighting properties to give the final look and feel of a shape.

material : PresetMaterialType;

contourColor

Gets and sets the contour color on a shape.

contourColor : CellsColor;

contourWidth

Gets and sets the contour width on the shape, in unit of points.

contourWidth : number;

extrusionColor

Gets the extrusion color on a shape.

extrusionColor : CellsColor;

extrusionHeight

Gets and sets the extrusion height of the applied to the shape, in unit of points.

extrusionHeight : number;

z

Defines the distance from ground for the 3D shape.

z : number;

lightAngle

Gets and sets the angle of the extrusion lights.

lightAngle : number;

lighting

Gets and sets type of light rig.

lighting : LightRigType;

lightingDirection

Gets and sets the direction from which the light rig is oriented in relation to the scene.

lightingDirection : LightRigDirectionType;

perspective

Gets and sets the angle at which a ThreeDFormat object can be viewed.

perspective : number;

rotationX

Gets and sets the rotation of the extruded shape around the x-axis in degrees.

rotationX : number;

rotationY

Gets and sets the rotation of the extruded shape around the y-axis in degrees.

rotationY : number;

rotationZ

Gets and sets the rotation of the extruded shape around the z-axis in degrees.

rotationZ : number;

presetCameraType

Gets and sets the extrusion preset camera type.

presetCameraType : PresetCameraType;

getBottomBevelWidth()

@deprecated. Please use the ‘bottomBevelWidth’ property instead. Gets and sets the width of the bottom bevel, or how far into the shape it is applied. In unit of Points.

getBottomBevelWidth() : number;

setBottomBevelWidth(number)

@deprecated. Please use the ‘bottomBevelWidth’ property instead. Gets and sets the width of the bottom bevel, or how far into the shape it is applied. In unit of Points.

setBottomBevelWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getBottomBevelHeight()

@deprecated. Please use the ‘bottomBevelHeight’ property instead. Gets and sets the height of the bottom bevel, or how far into the shape it is applied. In unit of Points.

getBottomBevelHeight() : number;

setBottomBevelHeight(number)

@deprecated. Please use the ‘bottomBevelHeight’ property instead. Gets and sets the height of the bottom bevel, or how far into the shape it is applied. In unit of Points.

setBottomBevelHeight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getBottomBevelType()

@deprecated. Please use the ‘bottomBevelType’ property instead. Gets and sets the type of the bottom bevel, or how far into the shape it is applied. In unit of Points.

getBottomBevelType() : BevelType;

Returns

BevelType

setBottomBevelType(BevelType)

@deprecated. Please use the ‘bottomBevelType’ property instead. Gets and sets the type of the bottom bevel, or how far into the shape it is applied. In unit of Points.

setBottomBevelType(value: BevelType) : void;

Parameters:

Parameter	Type	Description
value	BevelType	The value to set.

getTopBevelWidth()

@deprecated. Please use the ’topBevelWidth’ property instead. Gets and sets the width of the top bevel, or how far into the shape it is applied. In unit of Points.

getTopBevelWidth() : number;

setTopBevelWidth(number)

@deprecated. Please use the ’topBevelWidth’ property instead. Gets and sets the width of the top bevel, or how far into the shape it is applied. In unit of Points.

setTopBevelWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTopBevelHeight()

@deprecated. Please use the ’topBevelHeight’ property instead. Gets and sets the height of the top bevel, or how far into the shape it is applied. In unit of Points.

getTopBevelHeight() : number;

setTopBevelHeight(number)

@deprecated. Please use the ’topBevelHeight’ property instead. Gets and sets the height of the top bevel, or how far into the shape it is applied. In unit of Points.

setTopBevelHeight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTopBevelType()

@deprecated. Please use the ’topBevelType’ property instead. Gets and sets the type of the top bevel, or how far into the shape it is applied. In unit of Points.

getTopBevelType() : BevelType;

Returns

BevelType

setTopBevelType(BevelType)

@deprecated. Please use the ’topBevelType’ property instead. Gets and sets the type of the top bevel, or how far into the shape it is applied. In unit of Points.

setTopBevelType(value: BevelType) : void;

Parameters:

Parameter	Type	Description
value	BevelType	The value to set.

getMaterial()

@deprecated. Please use the ‘material’ property instead. Represents the preset material which is combined with the lighting properties to give the final look and feel of a shape.

getMaterial() : PresetMaterialType;

Returns

PresetMaterialType

setMaterial(PresetMaterialType)

@deprecated. Please use the ‘material’ property instead. Represents the preset material which is combined with the lighting properties to give the final look and feel of a shape.

setMaterial(value: PresetMaterialType) : void;

Parameters:

Parameter	Type	Description
value	PresetMaterialType	The value to set.

getContourColor()

@deprecated. Please use the ‘contourColor’ property instead. Gets and sets the contour color on a shape.

getContourColor() : CellsColor;

Returns

CellsColor

setContourColor(CellsColor)

@deprecated. Please use the ‘contourColor’ property instead. Gets and sets the contour color on a shape.

setContourColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getContourWidth()

@deprecated. Please use the ‘contourWidth’ property instead. Gets and sets the contour width on the shape, in unit of points.

getContourWidth() : number;

setContourWidth(number)

@deprecated. Please use the ‘contourWidth’ property instead. Gets and sets the contour width on the shape, in unit of points.

setContourWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getExtrusionColor()

@deprecated. Please use the ’extrusionColor’ property instead. Gets the extrusion color on a shape.

getExtrusionColor() : CellsColor;

Returns

CellsColor

setExtrusionColor(CellsColor)

@deprecated. Please use the ’extrusionColor’ property instead. Gets the extrusion color on a shape.

setExtrusionColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getExtrusionHeight()

@deprecated. Please use the ’extrusionHeight’ property instead. Gets and sets the extrusion height of the applied to the shape, in unit of points.

getExtrusionHeight() : number;

setExtrusionHeight(number)

@deprecated. Please use the ’extrusionHeight’ property instead. Gets and sets the extrusion height of the applied to the shape, in unit of points.

setExtrusionHeight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getZ()

@deprecated. Please use the ‘z’ property instead. Defines the distance from ground for the 3D shape.

getZ() : number;

setZ(number)

@deprecated. Please use the ‘z’ property instead. Defines the distance from ground for the 3D shape.

setZ(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLightAngle()

@deprecated. Please use the ’lightAngle’ property instead. Gets and sets the angle of the extrusion lights.

getLightAngle() : number;

setLightAngle(number)

@deprecated. Please use the ’lightAngle’ property instead. Gets and sets the angle of the extrusion lights.

setLightAngle(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLighting()

@deprecated. Please use the ’lighting’ property instead. Gets and sets type of light rig.

getLighting() : LightRigType;

Returns

LightRigType

setLighting(LightRigType)

@deprecated. Please use the ’lighting’ property instead. Gets and sets type of light rig.

setLighting(value: LightRigType) : void;

Parameters:

Parameter	Type	Description
value	LightRigType	The value to set.

getLightingDirection()

@deprecated. Please use the ’lightingDirection’ property instead. Gets and sets the direction from which the light rig is oriented in relation to the scene.

getLightingDirection() : LightRigDirectionType;

Returns

LightRigDirectionType

setLightingDirection(LightRigDirectionType)

@deprecated. Please use the ’lightingDirection’ property instead. Gets and sets the direction from which the light rig is oriented in relation to the scene.

setLightingDirection(value: LightRigDirectionType) : void;

Parameters:

Parameter	Type	Description
value	LightRigDirectionType	The value to set.

getPerspective()

@deprecated. Please use the ‘perspective’ property instead. Gets and sets the angle at which a ThreeDFormat object can be viewed.

getPerspective() : number;

setPerspective(number)

@deprecated. Please use the ‘perspective’ property instead. Gets and sets the angle at which a ThreeDFormat object can be viewed.

setPerspective(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getRotationX()

@deprecated. Please use the ‘rotationX’ property instead. Gets and sets the rotation of the extruded shape around the x-axis in degrees.

getRotationX() : number;

setRotationX(number)

@deprecated. Please use the ‘rotationX’ property instead. Gets and sets the rotation of the extruded shape around the x-axis in degrees.

setRotationX(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getRotationY()

@deprecated. Please use the ‘rotationY’ property instead. Gets and sets the rotation of the extruded shape around the y-axis in degrees.

getRotationY() : number;

setRotationY(number)

@deprecated. Please use the ‘rotationY’ property instead. Gets and sets the rotation of the extruded shape around the y-axis in degrees.

setRotationY(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getRotationZ()

@deprecated. Please use the ‘rotationZ’ property instead. Gets and sets the rotation of the extruded shape around the z-axis in degrees.

getRotationZ() : number;

setRotationZ(number)

@deprecated. Please use the ‘rotationZ’ property instead. Gets and sets the rotation of the extruded shape around the z-axis in degrees.

setRotationZ(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getPresetCameraType()

@deprecated. Please use the ‘presetCameraType’ property instead. Gets and sets the extrusion preset camera type.

getPresetCameraType() : PresetCameraType;

Returns

PresetCameraType

setPresetCameraType(PresetCameraType)

@deprecated. Please use the ‘presetCameraType’ property instead. Gets and sets the extrusion preset camera type.

setPresetCameraType(value: PresetCameraType) : void;

Parameters:

Parameter	Type	Description
value	PresetCameraType	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getHashCode()

Gets hashcode.

getHashCode() : number;

equals(Object)

equals(obj: Object) : boolean;

Parameters:

Parameter	Type	Description
obj	Object