Format3D

Format3D class

This class specifies the 3D shape properties for a chart element or shape.

class Format3D;

Properties

PropertyTypeDescription
topBevelBevelReadonly. Gets the Bevel object that holds the properties associated with defining a bevel on the top or front face of a shape.
surfaceMaterialTypePresetMaterialTypeGets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. Default value is PresetMaterialType.WarmMatte.
surfaceLightingTypeLightRigTypeGets and sets the lighting type which is to be applied to the scene of the shape. Default value is LightRigType.ThreePoint.
lightingAnglenumberGets and sets the lighting angle. Range from 0 to 359.9 degrees.

Methods

MethodDescription
getTopBevel()@deprecated. Please use the ’topBevel’ property instead. Gets the Bevel object that holds the properties associated with defining a bevel on the top or front face of a shape.
getSurfaceMaterialType()@deprecated. Please use the ‘surfaceMaterialType’ property instead. Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. Default value is PresetMaterialType.WarmMatte.
setSurfaceMaterialType(PresetMaterialType)@deprecated. Please use the ‘surfaceMaterialType’ property instead. Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. Default value is PresetMaterialType.WarmMatte.
getSurfaceLightingType()@deprecated. Please use the ‘surfaceLightingType’ property instead. Gets and sets the lighting type which is to be applied to the scene of the shape. Default value is LightRigType.ThreePoint.
setSurfaceLightingType(LightRigType)@deprecated. Please use the ‘surfaceLightingType’ property instead. Gets and sets the lighting type which is to be applied to the scene of the shape. Default value is LightRigType.ThreePoint.
getLightingAngle()@deprecated. Please use the ’lightingAngle’ property instead. Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
setLightingAngle(number)@deprecated. Please use the ’lightingAngle’ property instead. Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
hasTopBevelData()Indicates if the shape has top bevel data.
isNull()Checks whether the implementation object is null.

topBevel

Readonly. Gets the Bevel object that holds the properties associated with defining a bevel on the top or front face of a shape.

topBevel : Bevel;

surfaceMaterialType

Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. Default value is PresetMaterialType.WarmMatte.

surfaceMaterialType : PresetMaterialType;

surfaceLightingType

Gets and sets the lighting type which is to be applied to the scene of the shape. Default value is LightRigType.ThreePoint.

surfaceLightingType : LightRigType;

lightingAngle

Gets and sets the lighting angle. Range from 0 to 359.9 degrees.

lightingAngle : number;

getTopBevel()

@deprecated. Please use the ’topBevel’ property instead. Gets the Bevel object that holds the properties associated with defining a bevel on the top or front face of a shape.

getTopBevel() : Bevel;

Returns

Bevel

getSurfaceMaterialType()

@deprecated. Please use the ‘surfaceMaterialType’ property instead. Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. Default value is PresetMaterialType.WarmMatte.

getSurfaceMaterialType() : PresetMaterialType;

Returns

PresetMaterialType

setSurfaceMaterialType(PresetMaterialType)

@deprecated. Please use the ‘surfaceMaterialType’ property instead. Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. Default value is PresetMaterialType.WarmMatte.

setSurfaceMaterialType(value: PresetMaterialType) : void;

Parameters:

ParameterTypeDescription
valuePresetMaterialTypeThe value to set.

getSurfaceLightingType()

@deprecated. Please use the ‘surfaceLightingType’ property instead. Gets and sets the lighting type which is to be applied to the scene of the shape. Default value is LightRigType.ThreePoint.

getSurfaceLightingType() : LightRigType;

Returns

LightRigType

setSurfaceLightingType(LightRigType)

@deprecated. Please use the ‘surfaceLightingType’ property instead. Gets and sets the lighting type which is to be applied to the scene of the shape. Default value is LightRigType.ThreePoint.

setSurfaceLightingType(value: LightRigType) : void;

Parameters:

ParameterTypeDescription
valueLightRigTypeThe value to set.

getLightingAngle()

@deprecated. Please use the ’lightingAngle’ property instead. Gets and sets the lighting angle. Range from 0 to 359.9 degrees.

getLightingAngle() : number;

setLightingAngle(number)

@deprecated. Please use the ’lightingAngle’ property instead. Gets and sets the lighting angle. Range from 0 to 359.9 degrees.

setLightingAngle(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

hasTopBevelData()

Indicates if the shape has top bevel data.

hasTopBevelData() : boolean;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;