XlsChartShape module

class XlsChartShape.XlsChartShape

Bases: XlsShape, IChartShape

AddShapeInChart(type: ExcelShapeType, placement: ResizeBehaveType, left: int, top: int, height: int, width: int) → IShape

property AutoScaling: bool

property BottomRow: int

property CategoryAxisTitle: str

<summary>

Title of the category axis.

</summary>

property ChartArea: IChartFrameFormat

property ChartSubTitle: str

<summary>

Gets the chart’s sub-title. Only for ODS format file.

</summary>

property ChartTitle: str

<summary>

Represents the title of the specified chart.

</summary>

property ChartTitleArea: IChartTextArea

property ChartType: ExcelChartType

property CheckBoxes: ICheckBoxes

property CodeName: str

property ComboBoxes: IComboBoxes

property DataRange: IXLSRange

<summary>

DataRange for the chart series.

</summary>

property DataTable: IChartDataTable

property DepthPercent: int

property DisplayAxisFieldButtons: bool

property DisplayBlanksAs: ChartPlotEmptyType

property DisplayEntireFieldButtons: bool

property DisplayLegendFieldButtons: bool

property DisplayValueFieldButtons: bool

property Elevation: int

<summary>

Returns or sets the elevation of the 3-D chart view, in degrees (?0 to +90 degrees).

<example>The following code illustrates how to set Rotation for 3-D charts: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Add data worksheet.Range[“A1”].Text = “Jan”;

worksheet.Range[“B1”].Text = “Feb”; worksheet.Range[“C1”].Text = “Mar”; worksheet.Range[“A2”].Text = “10”; worksheet.Range[“B2”].Text = “20”; worksheet.Range[“C2”].Text = “30”;

//Create chart and range Chart chart = worksheet.Charts.Add(); chart.DataRange = worksheet.Range[“A1:C2”]; //Set Chart elevation chart.ChartType = ExcelChartType.Column3DClustered; chart.Elevation = 50; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

property Floor: IChartWallOrFloor

property GapDepth: int

property HasChartArea: bool

<summary>

Indicates whether chart has chart area.

</summary>

property HasChartTitle: bool

<summary>

Indicates wheather the chart has title

</summary>

property HasDataTable: bool

<summary>

True if the chart has a data table.

<example>The following code illustrates how data table can be set for charts: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Add data worksheet.Range[“A1”].Text = “Jan”;

worksheet.Range[“B1”].Text = “Feb”; worksheet.Range[“C1”].Text = “Mar”; worksheet.Range[“A2”].Text = “10”; worksheet.Range[“B2”].Text = “20”; worksheet.Range[“C2”].Text = “30”;

//Create chart and range Chart chart = worksheet.Charts.Add(); chart.DataRange = worksheet.Range[“A1:C2”]; //Set Chart data table chart.HasDataTable = true; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

property HasFloor: bool

<summary>

Gets value indicating whether floor object was created.

</summary>

property HasLegend: bool

<summary>

True if the chart has a legend object.

<example>The following code illustrates how to set HasLegend property: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Add data worksheet.Range[“A1”].Text = “Jan”;

worksheet.Range[“B1”].Text = “Feb”; worksheet.Range[“C1”].Text = “Mar”; worksheet.Range[“A2”].Text = “10”; worksheet.Range[“B2”].Text = “20”; worksheet.Range[“C2”].Text = “30”;

//Create chart and range Chart chart = worksheet.Charts.Add(); chart.DataRange = worksheet.Range[“A1:C2”]; //Set hasLegend chart.HasLegend = false; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

property HasPivotTable: bool

<summary>

Indicates whether contains pivot table.

</summary>

property HasPlotArea: bool

property HasWalls: bool

<summary>

Gets value indicating whether floor object was created.

</summary>

property HeightPercent: int

property IsRightToLeft: bool

<summary>

Indicates whether chart is displayed right to left.

</summary>

property LeftColumn: int

property Legend: IChartLegend

property PageSetup: IChartPageSetup

property Perspective: int

<summary>

Returns or sets the perspective for the 3-D chart view (0 to 100).

<example>The following code illustrates how to set Perspective for the charts: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Add data worksheet.Range[“A1”].Text = “Jan”;

worksheet.Range[“B1”].Text = “Feb”; worksheet.Range[“C1”].Text = “Mar”; worksheet.Range[“A2”].Text = “10”; worksheet.Range[“B2”].Text = “20”; worksheet.Range[“C2”].Text = “30”;

//Create chart and range Chart chart = worksheet.Charts.Add(); chart.DataRange = worksheet.Range[“A1:C2”]; //Set Chart perspective chart.ChartType = ExcelChartType.Column3DClustered; chart.Perspective = 70; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

property PivotChartType: ExcelChartType

property PivotTable: PivotTable

property PlotArea: IChartFrameFormat

property PlotVisibleOnly: bool

property PrimaryCategoryAxis: IChartCategoryAxis

property PrimaryFormats: XlsChartFormatCollection

<summary>

Returns chart format collection in primary axis.

</summary>

property PrimarySerieAxis: IChartSeriesAxis

property PrimaryValueAxis: IChartValueAxis

RefreshChart()

property RightAngleAxes: bool

property RightColumn: int

property Rotation: int

<summary>

Returns or sets the rotation of the 3-D chart view

(the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees).

<example>The following code illustrates how to set Rotation for 3-D charts: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Add data worksheet.Range[“A1”].Text = “Jan”;

worksheet.Range[“B1”].Text = “Feb”; worksheet.Range[“C1”].Text = “Mar”; worksheet.Range[“A2”].Text = “10”; worksheet.Range[“B2”].Text = “20”; worksheet.Range[“C2”].Text = “30”;

//Create chart and range Chart chart = worksheet.Charts.Add(); chart.DataRange = worksheet.Range[“A1:C2”]; //Set Chart rotation chart.ChartType = ExcelChartType.Column3DClustered; chart.Rotation = 50; //Save to file workbook.SaveToFile(“Chart.xlsx”); </code> </example>

</summary>

property SecondaryCategoryAxis: IChartCategoryAxis

property SecondaryCategoryAxisTitle: str

property SecondaryFormats: XlsChartFormatCollection

<summary>

Returns chart format collection in secondary axis.

</summary>

property SecondaryValueAxis: IChartValueAxis

property SecondaryValueAxisTitle: str

<summary>

Title of the secondary value axis.

</summary>

property SeriesAxisTitle: str

<summary>

Title of the series axis.

</summary>

property SeriesDataFromRange: bool

property Shapes: IShapes

property ShowReportFilterFieldButtons: bool

property SizeWithWindow: bool

property SupportWallsAndFloor: bool

<summary>

Indicates whether this chart supports walls and floor. Read-only.

</summary>

property TextBoxes: ITextBoxes

property TopRow: int

property ValueAxisTitle: str

<summary>

Title of the value axis.

</summary>

property Walls: IChartWallOrFloor

property WallsAndGridlines2D: bool

property XPos: float

property YPos: float