Format3D module
- class Format3D.Format3D
Bases:
XlsObject,IFormat3D,ICloneParentRepresents 3D formatting for Excel objects.
This class provides properties and methods to manipulate 3D formatting effects for Excel objects such as shapes, charts, and other elements. It allows control over bevels, lighting, materials, extrusion, and contours to create sophisticated 3D visual effects.
- property BevelBottomHeight: float
Gets the height of the bottom bevel in points.
- Returns:
The height of the bottom bevel in points.
- Return type:
float
- property BevelBottomType: XLSXChartBevelType
Gets the bevel type for the bottom surface of the 3D object.
- Returns:
An enumeration value representing the bevel type for the bottom surface.
- Return type:
XLSXChartBevelType
- property BevelBottomWidth: float
Gets the width of the bottom bevel in points.
- Returns:
The width of the bottom bevel in points.
- Return type:
float
- property BevelTopHeight: float
Gets the height of the top bevel in points.
- Returns:
The height of the top bevel in points.
- Return type:
float
- property BevelTopType: XLSXChartBevelType
Gets the bevel type for the top surface of the 3D object.
- Returns:
An enumeration value representing the bevel type for the top surface.
- Return type:
XLSXChartBevelType
- property BevelTopWidth: float
Gets the width of the top bevel in points.
- Returns:
The width of the top bevel in points.
- Return type:
float
- Clone(parent: SpireObject) SpireObject
Creates a clone of this Format3D object.
- Parameters:
parent (SpireObject) – The parent object for the cloned Format3D object.
- Returns:
A new Format3D object that is a copy of this instance.
- Return type:
SpireObject
- property ContourColor: Color
Gets the color of the contour effect.
- Returns:
A Color object representing the contour color.
- Return type:
Color
- property ContourWidth: float
Gets the width of the contour effect in points.
- Returns:
The contour width in points.
- Return type:
float
- property ExtrusionColor: Color
Gets the color of the extrusion effect.
- Returns:
A Color object representing the extrusion color.
- Return type:
Color
- property ExtrusionHeight: float
Gets the extrusion height of the 3D object in points.
- Returns:
The extrusion height in points.
- Return type:
float
- property LightingAngle: float
Gets the angle of the lighting effect in degrees.
- Returns:
The lighting angle in degrees.
- Return type:
float
- property LightingType: XLSXChartLightingType
Gets the lighting type applied to the 3D object.
- Returns:
An enumeration value representing the lighting type.
- Return type:
XLSXChartLightingType
- property MaterialType: XLSXChartMaterialType
Gets the material type of the 3D object.
- Returns:
An enumeration value representing the material type.
- Return type:
XLSXChartMaterialType