ThreeDFormat

ThreeDFormat class

Represents a shape’s three-dimensional formatting.

class ThreeDFormat;

Methods

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

getBottomBevelWidth()

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)

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()

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)

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()

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)

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()

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)

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()

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)

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()

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)

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()

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)

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()

Gets and sets the contour color on a shape.

getContourColor() : CellsColor;

Returns

CellsColor

setContourColor(CellsColor)

Gets and sets the contour color on a shape.

setContourColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getContourWidth()

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

getContourWidth() : number;

setContourWidth(number)

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()

Gets the extrusion color on a shape.

getExtrusionColor() : CellsColor;

Returns

CellsColor

setExtrusionColor(CellsColor)

Gets the extrusion color on a shape.

setExtrusionColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getExtrusionHeight()

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

getExtrusionHeight() : number;

setExtrusionHeight(number)

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()

Defines the distance from ground for the 3D shape.

getZ() : number;

setZ(number)

Defines the distance from ground for the 3D shape.

setZ(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLightAngle()

Gets and sets the angle of the extrusion lights.

getLightAngle() : number;

setLightAngle(number)

Gets and sets the angle of the extrusion lights.

setLightAngle(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLighting()

Gets and sets type of light rig.

getLighting() : LightRigType;

Returns

LightRigType

setLighting(LightRigType)

Gets and sets type of light rig.

setLighting(value: LightRigType) : void;

Parameters:

Parameter	Type	Description
value	LightRigType	The value to set.

getLightingDirection()

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

getLightingDirection() : LightRigDirectionType;

Returns

LightRigDirectionType

setLightingDirection(LightRigDirectionType)

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()

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

getPerspective() : number;

setPerspective(number)

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()

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

getRotationX() : number;

setRotationX(number)

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()

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

getRotationY() : number;

setRotationY(number)

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()

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

getRotationZ() : number;

setRotationZ(number)

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()

Gets and sets the extrusion preset camera type.

getPresetCameraType() : PresetCameraType;

Returns

PresetCameraType

setPresetCameraType(PresetCameraType)

Gets and sets the extrusion preset camera type.

setPresetCameraType(value: PresetCameraType) : void;

Parameters:

Parameter	Type	Description
value	PresetCameraType	The value to set.

getHashCode()

Gets hashcode.

getHashCode() : number;

equals(object)

equals(obj: object) : boolean;

Parameters:

Parameter	Type	Description
obj	object

isNull()

Checks whether the implementation object is null.

isNull() : boolean;