IChart

IChart class

Represents an graphic chart on a slide.

The IChart type exposes the following members:

Properties

NameDescription
plot_visible_cells_onlyDetermines whether the only visible cells are plotted. False to plot both visible and hidden cells.
Read/write bool.
display_blanks_asReturns or sets the way to plot blank cells on a chart.
Read/write DisplayBlanksAsType.
chart_dataReturns information about the linked or embedded data associated with a chart.
Read-only IChartData.
has_titleDetermines whether a chart has a visible title.
Read/write bool.
chart_titleReturns or sets a chart title
Read-only IChartTitle.
has_data_tableDetermines whether a chart has a data table.
Read/write bool.
has_legendDetermines whether a chart has a legend.
Read/write bool.
legendReturns or sets a legend for a chart.
Read-only ILegend.
chart_data_tableReturns a data table of a chart.
Read-only IDataTable.
styleReturns or sets the chart style.
Read/write StyleType.
typeReturns or sets the chart type.
Read/write ChartType.
plot_areaRepresents the plot area of a chart.
Read-only IChartPlotArea.
rotation_3dReturns a 3D rotation of a chart.
Read-only IRotation3D.
back_wallReturns an object which allows to change format of the back wall of a 3D chart.
Read-only IChartWall.
side_wallReturns an object which allows to change format of the side wall of a 3D chart.
Read-only IChartWall.
floorReturns an object which allows to change format of the floor of a 3D chart.
Read-only IChartWall.
user_shapesSpecify the shapes drawn on top of the chart.
Read-only IGroupShape.
axesProvide access to chart axes.
Read-only IAxesManager.
show_data_labels_over_maximumSpecifies data labels over the maximum of the chart shall be shown.
Read/write bool.
has_rounded_cornersSpecifies the chart area shall have rounded corners.
Read/write bool.
as_i_graphical_objectAllows to get base IGraphicalObject interface.
Read-only IGraphicalObject.
as_i_formatted_text_containerAllows to get base IFormattedTextContainer interface.
Read-only IFormattedTextContainer.
as_i_override_themeableReturns IOverrideThemeable interface.
Read-only IOverrideThemeable.
shape_lockReturns shape’s locks.
Read-only IBaseShapeLock.
graphical_object_lockReturns shape’s locks.
Read-only IGraphicalObjectLock.
as_i_shapeAllows to get base IShape interface.
Read-only IShape.
is_text_holderDetermines whether the shape is TextHolder.
Read-only bool.
placeholderReturns the placeholder for a shape.
Read-only IPlaceholder.
custom_dataReturns the shape’s custom data.
Read-only ICustomData.
raw_frameReturns or sets the raw shape frame’s properties.
Read/write IShapeFrame.
frameReturns or sets the shape frame’s properties.
Read/write IShapeFrame.
line_formatReturns the LineFormat object that contains line formatting properties for a shape.
Read-only ILineFormat.
three_d_formatReturns the ThreeDFormat object that contains line formatting properties for a shape.
Read-only IThreeDFormat.
effect_formatReturns the EffectFormat object which contains pixel effects applied to a shape.
Read-only IEffectFormat.
fill_formatReturns the FillFormat object that contains fill formatting properties for a shape.
Read-only IFillFormat.
hiddenDetermines whether the shape is hidden.
Read/write bool.
z_order_positionReturns the position of a shape in the z-order.
Shapes[0] returns the shape at the back of the z-order,
and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order.
Read-only
connection_site_countReturns the number of connection sites on the shape.
Read-only
rotationReturns or sets the number of degrees the specified shape is rotated around
the z-axis. A positive value indicates clockwise rotation; a negative value
indicates counterclockwise rotation.
Read/write
xReturns or sets the x-coordinate of the upper-left corner of the shape.
Read/write
yReturns or sets the y-coordinate of the upper-left corner of the shape.
Read/write
widthReturns or sets the width of the shape.
Read/write
heightReturns or sets the height of the shape.
Read/write
alternative_textReturns or sets the alternative text associated with a shape.
Read/write string.
alternative_text_titleReturns or sets the title of alternative text associated with a shape.
Read/write string.
nameReturns or sets the name of a shape.
Read/write string.
is_decorativeGets or sets ‘Mark as decorative’ option
Reed/write bool.
unique_idGets unique shape identifier in presentation scope.
Read-only int.
See also office_interop_shape_id for getting unique shape identifier in slide scope.
office_interop_shape_idGets unique shape identifier in slide scope.
Read-only int.
See also unique_id for getting unique shape identifier in presentation scope.
is_groupedDetermines whether the shape is grouped.
Read-only bool.
black_white_modeProperty specifies how a shape will render in black-and-white display mode..
Read/write BlackWhiteMode.
parent_groupReturns parent GroupShape object if shape is grouped. Otherwise returns null.
Read-only IGroupShape.
as_i_hyperlink_containerAllows to get base IHyperlinkContainer interface.
Read-only IHyperlinkContainer.
slideReturns the base slide.
Read-only IBaseSlide.
as_i_presentation_componentAllows to get base IPresentationComponent interface.
Read-only IPresentationComponent.
presentationReturns the presentation.
Read-only IPresentation.
hyperlink_clickReturns or sets the hyperlink defined for mouse click.
Read/write IHyperlink.
hyperlink_mouse_overReturns or sets the hyperlink defined for mouse over.
Read/write IHyperlink.
hyperlink_managerHyperlinks manager
Read-only IHyperlinkManager.
text_formatReturns chart text format.
Read-only IChartTextFormat.
as_i_chart_componentReturns IChartComponent interface.
Read-only IChartComponent.
chartReturns the chart.
Read-only IChart.
theme_managerReturns override theme manager.
Read-only IOverrideThemeManager.
as_i_themeableReturns IThemeable interface.
Read-only IThemeable.

Methods

NameDescription
get_thumbnail()Returns shape thumbnail.
ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.
get_thumbnail(bounds, scale_x, scale_y)Returns shape thumbnail.
write_as_svg(stream)Saves content of Shape as SVG file.
write_as_svg(stream, svg_options)Saves content of Shape as SVG file.
validate_chart_layout()Calculates actual values of chart elements. Actual values inlude position of elements that implement IActualLayout interface
(IActualLayout.ActualX, IActualLayout.ActualY, IActualLayout.ActualWidth, IActualLayout.ActualHeight)
and actual axes values (IAxis.ActualMaxValue, IAxis.ActualMinValue, IAxis.ActualMajorUnit, IAxis.ActualMinorUnit,
IAxis.ActualMajorUnitScale, IAxis.ActualMinorUnitScale)
add_placeholder(placeholder_to_copy_from)Adds a new placeholder if there is no and sets placeholder properties to a specified one.
remove_placeholder()Defines that this shape isn’t a placeholder.
get_base_placeholder()Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from).
create_theme_effective()Returns an effective theme for this themeable object.

See Also