Chart

Chart class

Represents an graphic chart on a slide.

addPlaceholder

NameDescription
addPlaceholder(Placeholder)Adds a new placeholder if there is no and sets placeholder properties to a specified one.

Parameters:

NameTypeDescription
placeholderToCopyFromPlaceholderPlaceholder to copy content from.

Result: Placeholder


createThemeEffective

NameDescription
createThemeEffective()Returns an effective theme for this chart.

Result: ThemeEffectiveData


getAlternativeText

NameDescription
getAlternativeText()Returns or sets the alternative text associated with a shape. Read/write String.

Result: String


getAlternativeTextTitle

NameDescription
getAlternativeTextTitle()Returns or sets the title of alternative text associated with a shape. Read/write String.

Result: String


getAxes

NameDescription
getAxes()Provide access to chart axes. Read-only IAxesManager.

Result: AxesManager


getBackWall

NameDescription
getBackWall()Returns an object which allows to change format of the back wall of a 3D chart. Read-only IChartWall.

Result: ChartWall


getBasePlaceholder

NameDescription
getBasePlaceholder()Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from). A null is returned if the current shape is not inherited.

Result: SummaryZoomSection, AutoShape, AudioFrame, OleObjectFrame, SummaryZoomFrame, ZoomFrame, GraphicalObject, PictureFrame, ZoomObject, VideoFrame, GeometryShape, SmartArtShape, SmartArt, Ink, Chart, GroupShape, Table, SectionZoomFrame, Shape, LegacyDiagram, Connector


getBlackWhiteMode

NameDescription
getBlackWhiteMode()Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.

Result: byte


getChart

NameDescription
getChart()

Result: Chart


getChartData

NameDescription
getChartData()Returns information about the linked or embedded data associated with a chart. Read-only IChartData.

Result: ChartData


getChartDataTable

NameDescription
getChartDataTable()Returns a data table of a chart. Read-only IDataTable.

Result: DataTable


getChartTitle

NameDescription
getChartTitle()Returns or sets a chart title. Read-only IChartTitle.

Result: ChartTitle


getConnectionSiteCount

NameDescription
getConnectionSiteCount()Returns the number of connection sites on the shape. Read-only int.

Result: int


getCustomData

NameDescription
getCustomData()Returns the shape’s custom data. Read-only ICustomData.

Result: CustomData


getDisplayBlanksAs

NameDescription
getDisplayBlanksAs()Returns or sets the way to plot blank cells on a chart. Read/write DisplayBlanksAsType.

Result: int


getEffectFormat

NameDescription
getEffectFormat()Returns the EffectFormat object which contains pixel effects applied to a shape. Note: can return null for certain types of shapes which don’t have effect properties. Read-only IEffectFormat.

Result: EffectFormat


getFillFormat

NameDescription
getFillFormat()Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don’t have fill properties. Read-only IFillFormat.

Result: FillFormat


getFloor

NameDescription
getFloor()Returns an object which allows to change format of the floor of a 3D chart. Read-only IChartWall.

Result: ChartWall


getFrame

NameDescription
getFrame()Returns or sets the shape frame’s properties. Read/write IShapeFrame. Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

Result: ShapeFrame


getGraphicalObjectLock

NameDescription
getGraphicalObjectLock()Returns shape’s locks. Read-only IGraphicalObjectLock.

Result: GraphicalObjectLock


getHeight

NameDescription
getHeight()Returns or sets the height of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float


getHidden

NameDescription
getHidden()Determines whether the shape is hidden. Read/write boolean.

Result: boolean


getHyperlinkClick

NameDescription
getHyperlinkClick()Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.

Result: Hyperlink


getHyperlinkManager

NameDescription
getHyperlinkManager()Returns the hyperlink manager. Read-only IHyperlinkManager.

Result: HyperlinkManager


getHyperlinkMouseOver

NameDescription
getHyperlinkMouseOver()Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.

Result: Hyperlink


getLegend

NameDescription
getLegend()Returns or sets a legend for a chart. Read-only ILegend.

Result: Legend


getLineFormat

NameDescription
getLineFormat()Returns the LineFormat object that contains line formatting properties for a shape. Note: can return null for certain types of shapes which don’t have line properties. Read-only ILineFormat.

Result: LineFormat


getName

NameDescription
getName()Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.

Result: String


getOfficeInteropShapeId

NameDescription
getOfficeInteropShapeId()Gets unique shape identifier in slide scope. Read-only long. See also ( #getUniqueId) for getting unique shape identifier in presentation scope.

Result: long


getParentGroup

NameDescription
getParentGroup()Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape. Property ( #isGrouped) determines whether the shape is grouped.

Result: GroupShape


getParent_Immediate

NameDescription
getParent_Immediate()

getPlaceholder

NameDescription
getPlaceholder()Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only IPlaceholder.

Result: Placeholder


getPlotArea

NameDescription
getPlotArea()Represents the plot area of a chart. Read-only IChartPlotArea.

Result: ChartPlotArea


getPlotVisibleCellsOnly

NameDescription
getPlotVisibleCellsOnly()Determines whether the only visible cells are plotted. False to plot both visible and hidden cells. Read/write boolean.

Result: boolean


getPresentation

NameDescription
getPresentation()Returns the parent presentation of a slide. Read-only IPresentation.

Result: Presentation


getRawFrame

NameDescription
getRawFrame()Returns or sets the raw shape frame’s properties. Read/write IShapeFrame.

Result: ShapeFrame


getRotation

NameDescription
getRotation()Returns 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 float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float


getRotation3D

NameDescription
getRotation3D()Returns a 3D rotation of a chart. Read-only IRotation3D.

Result: Rotation3D


getShapeLock

NameDescription
getShapeLock()Returns shape’s locks. Read-only IBaseShapeLock.

Result: BaseShapeLock, PictureFrameLock, AutoShapeLock, GraphicalObjectLock, GroupShapeLock, ConnectorLock


getShowDataLabelsOverMaximum

NameDescription
getShowDataLabelsOverMaximum()Specifies data labels over the maximum of the chart shall be shown. Read/write boolean.

Result: boolean


getSideWall

NameDescription
getSideWall()Returns an object which allows to change format of the side wall of a 3D chart. Read-only IChartWall.

Result: ChartWall


getSlide

NameDescription
getSlide()Returns the parent slide of a shape. Read-only IBaseSlide.

Result: Slide, MasterNotesSlide, BaseSlide, MasterSlide, LayoutSlide, MasterHandoutSlide, NotesSlide


getStyle

NameDescription
getStyle()Returns or sets the chart style. Read/write StyleType.

Result: int


getTextFormat

NameDescription
getTextFormat()Returns chart text format. The property is not applicable for the following types: ChartType#Treemap, ChartType#Sunburst, ChartType#Waterfall, ChartType#Histogram, ChartType#Funnel, ChartType#BoxAndWhisker. Read-only IChartTextFormat.

Result: ChartTextFormat


getThemeManager

NameDescription
getThemeManager()Returns theme manager. Read-only IOverrideThemeManager.

Result: LayoutSlideThemeManager, ChartThemeManager, BaseOverrideThemeManager, NotesSlideThemeManager, SlideThemeManager


getThreeDFormat

NameDescription
getThreeDFormat()Returns the ThreeDFormat object that 3d effect properties for a shape. Note: can return null for certain types of shapes which don’t have 3d properties. Read-only IThreeDFormat.

Result: ThreeDFormat


getThumbnail

NameDescription
getThumbnail()Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.

Result: BufferedImage


getThumbnail

NameDescription
getThumbnail(int, float, float)Returns shape thumbnail.

Parameters:

NameTypeDescription
boundsintShape thumbnail bounds type.
scaleXfloatX scale
scaleYfloatY scale

Result: BufferedImage


getType

NameDescription
getType()Returns or sets the chart type. Read/write ChartType.

Result: int


getUniqueId

NameDescription
getUniqueId()Gets unique shape identifier in presentation scope. Read-only long. See also ( #getOfficeInteropShapeId) for getting unique shape identifier in slide scope.

Result: long


getUserShapes

NameDescription
getUserShapes()Specify the shapes drawn on top of the chart. Read-only IGroupShape.

Result: GroupShape


getWidth

NameDescription
getWidth()Returns or sets the width of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float


getX

NameDescription
getX()Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float


getY

NameDescription
getY()Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float


getZOrderPosition

NameDescription
getZOrderPosition()Returns 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 int.

Result: int


hasDataTable

NameDescription
hasDataTable()Determines whether a chart has a data table. Read/write boolean.

Result: boolean


hasLegend

NameDescription
hasLegend()Determines whether a chart has a legend. Read/write boolean.

Result: boolean


hasRoundedCorners

NameDescription
hasRoundedCorners()Specifies the chart area shall have rounded corners. Read/write boolean.

Result: boolean


hasTitle

NameDescription
hasTitle()Determines whether a chart has a visible title. Read/write boolean.

Result: boolean


isGrouped

NameDescription
isGrouped()Determines whether the shape is grouped. Read-only boolean. Property ( #getParentGroup) returns parent GroupShape object if shape is grouped.

Result: boolean


isTextHolder

NameDescription
isTextHolder()Determines whether the shape is TextHolder_PPT. Read-only boolean.

Result: boolean


removePlaceholder

NameDescription
removePlaceholder()Defines that this shape isn’t a placeholder.

setAlternativeText

NameDescription
setAlternativeText(String)Returns or sets the alternative text associated with a shape. Read/write String.

setAlternativeTextTitle

NameDescription
setAlternativeTextTitle(String)Returns or sets the title of alternative text associated with a shape. Read/write String.

setBlackWhiteMode

NameDescription
setBlackWhiteMode(byte)Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.

setDataTable

NameDescription
setDataTable(boolean)Determines whether a chart has a data table. Read/write boolean.

setDisplayBlanksAs

NameDescription
setDisplayBlanksAs(int)Returns or sets the way to plot blank cells on a chart. Read/write DisplayBlanksAsType.

setFrame

NameDescription
setFrame(ShapeFrame)Returns or sets the shape frame’s properties. Read/write IShapeFrame. Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

setHeight

NameDescription
setHeight(float)Returns or sets the height of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

setHidden

NameDescription
setHidden(boolean)Determines whether the shape is hidden. Read/write boolean.

setHyperlinkClick

NameDescription
setHyperlinkClick(Hyperlink)Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.

setHyperlinkMouseOver

NameDescription
setHyperlinkMouseOver(Hyperlink)Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.

setLegend

NameDescription
setLegend(boolean)Determines whether a chart has a legend. Read/write boolean.

setName

NameDescription
setName(String)Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.

setPlotVisibleCellsOnly

NameDescription
setPlotVisibleCellsOnly(boolean)Determines whether the only visible cells are plotted. False to plot both visible and hidden cells. Read/write boolean.

setRawFrame

NameDescription
setRawFrame(ShapeFrame)Returns or sets the raw shape frame’s properties. Read/write IShapeFrame.

setRotation

NameDescription
setRotation(float)Returns 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 float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

setRoundedCorners

NameDescription
setRoundedCorners(boolean)Specifies the chart area shall have rounded corners. Read/write boolean.

setShowDataLabelsOverMaximum

NameDescription
setShowDataLabelsOverMaximum(boolean)Specifies data labels over the maximum of the chart shall be shown. Read/write boolean.

setStyle

NameDescription
setStyle(int)Returns or sets the chart style. Read/write StyleType.

setTitle

NameDescription
setTitle(boolean)Determines whether a chart has a visible title. Read/write boolean.

setType

NameDescription
setType(int)Returns or sets the chart type. Read/write ChartType.

setWidth

NameDescription
setWidth(float)Returns or sets the width of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

setX

NameDescription
setX(float)Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

setY

NameDescription
setY(float)Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

validateChartLayout

NameDescription
validateChartLayout()Calculates actual values of chart elements. The actual values include 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)

writeAsSvgToBytes

NameDescription
writeAsSvgToBytes ()Saves content of Shape as SVG file.

Result: Bytes[]


writeAsSvgToBytes

NameDescription
writeAsSvgToBytes (SVGOptions)Saves content of Shape as SVG file.

Parameters:

NameTypeDescription
svgOptionsSVGOptionsSVG generation options

Result: Bytes[]