XlsChartFrameFormat module

class XlsChartFrameFormat.XlsChartFrameFormat

Bases: XlsObject, IChartFrameFormat, IChartFillBorder

property BackGroundColor: Color

property BackGroundColorObject: OColor

property BackGroundKnownColor: ExcelColors

property Border: IChartBorder

<summary>

Gets chart border. Read only.

</summary>

Clear()

Clone(parent: SpireObject) → XlsChartFrameFormat

property Fill: IShapeFill

<summary>

Represents XlsFill gradient format. Read only.

<example>The following code illustrates the use of Fill property: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart and set range IChart chart = worksheet.Charts.Add(); chart.DataRange = worksheet.Range[“B2:C6”]; //Set chart type chart.ChartType = ExcelChartType.Column3DClustered; //Gets fill options for the chart element IShapeFill fillChart = chart.ChartArea.Fill; fillChart.FillType = ShapeFillType.Gradient; fillChart.BackColor = Color.FromArgb(205, 217, 234); fillChart.ForeColor = Color.White; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

property ForeGroundColor: Color

property ForeGroundColorObject: OColor

property ForeGroundKnownColor: ExcelColors

property Format3D: Format3D

<summary>

Gets the chart3 D properties.

<example>The following code illustrates the use of Shadow property: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart and set range IChart chart = worksheet.Charts.Add(); chart.DataRange = worksheet.Range[“B2:C6”]; //Set chart type chart.ChartType = ExcelChartType.Column3DClustered; //Gets shadow formatting properties for the chart element ChartShadow shadowChart = chart.ChartArea.Shadow; shadowChart.ShadowPrespectiveType = XLSXChartPrespectiveType.Below; shadowChart.Color = Color.Aqua; shadowChart.Blur = 22; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

<value>The chart3 D properties.</value>

property HasFormat3D: bool

property HasInterior: bool

<summary>

Indicates whether interior object was created. Read-only.

</summary>

property HasLineProperties: bool

<summary>

Indicates whether border formatting object was created. Read-only.

</summary>

property HasManualLayout: bool

property HasShadow: bool

property Height: int

<summary>

Y-size. 1/4000 of chart plot. IsHMode Shall set to True

</summary>

property InnerLayoutTarget: bool

property Interior: IChartInterior

property IsAutoPosition: bool

<summary>

Calculates position automatically.

</summary>

property IsAutoSize: bool

<summary>

Calculates size automatically.

</summary>

property IsAutomaticFormat: bool

property IsBorderCornersRound: bool

<summary>

Gets or sets if border corners is round.

</summary>

property IsHMode: bool

<summary>

false value Specifies that the Height shall be interpreted

as the Bottom of the chart element..

</summary>

property IsWMode: bool

<summary>

false value Specifies that the Width shall be interpreted

as the Right of the chart element..

</summary>

property IsXMode: bool

<summary>

true value Specifies that the X shall be interpreted

as the Left of the chart element..

</summary>

property IsYMode: bool

<summary>

true value Specifies that the Y shall be interpreted

as the Top of the chart element..

</summary>

property LineProperties: XlsChartBorder

<summary>

Gets chart border. Read-only.

</summary>

property Pattern: ExcelPatternType

property RectangleStyle: RectangleStyleType

SetDefaultValues(bAutoSize: bool, bIsInteriorGray: bool)

property Shadow: ChartShadow

<summary>

Gets the shadow properties.

<example>The following code illustrates the use of Shadow property: <code>

//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create chart and set range IChart chart = worksheet.Charts.Add(); chart.DataRange = worksheet.Range[“B2:C6”]; //Set chart type chart.ChartType = ExcelChartType.Column3DClustered; //Gets shadow formatting properties for the chart element ChartShadow shadowChart = chart.ChartArea.Shadow; shadowChart.ShadowPrespectiveType = XLSXChartPrespectiveType.Below; shadowChart.Color = Color.Aqua; shadowChart.Blur = 22; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

<value>The shadow properties.</value>

property Visible: bool

property Width: int

<summary>

X-size. 1/4000 of chart plot. IsWMode Shall set to True

</summary>

property X: int

<summary>

X-position of upper-left corner. 1/4000 of chart plot.

IsXMode Shall set to True

</summary>

property Y: int

<summary>

Y-position of upper-left corner. 1/4000 of chart plot.

IsYMode Shall set to True

</summary>