Chart
Chart class
Represents an graphic chart on a slide.
addPlaceholder
| Name | Description |
|---|
| addPlaceholder(Placeholder) | Adds a new placeholder if there is no and sets placeholder properties to a specified one. |
Parameters:
| Name | Type | Description |
|---|
| placeholderToCopyFrom | Placeholder | Placeholder to copy content from. |
Result:
Placeholder
createThemeEffective
| Name | Description |
|---|
| createThemeEffective() | Returns an effective theme for this chart. |
Result:
ThemeEffectiveData
getAlternativeText
| Name | Description |
|---|
| getAlternativeText() | Returns or sets the alternative text associated with a shape. Read/write String. |
Result:
String
getAlternativeTextTitle
| Name | Description |
|---|
| getAlternativeTextTitle() | Returns or sets the title of alternative text associated with a shape. Read/write String. |
Result:
String
getAxes
| Name | Description |
|---|
| getAxes() | Provide access to chart axes. Read-only IAxesManager. |
Result:
AxesManager
getBackWall
| Name | Description |
|---|
| getBackWall() | Returns an object which allows to change format of the back wall of a 3D chart. Read-only IChartWall. |
Result:
ChartWall
getBasePlaceholder
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| getBlackWhiteMode() | Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode. |
Result:
byte
getChart
| Name | Description |
|---|
| getChart() | |
Result:
Chart
getChartData
| Name | Description |
|---|
| getChartData() | Returns information about the linked or embedded data associated with a chart. Read-only IChartData. |
Result:
ChartData
getChartDataTable
| Name | Description |
|---|
| getChartDataTable() | Returns a data table of a chart. Read-only IDataTable. |
Result:
DataTable
getChartTitle
| Name | Description |
|---|
| getChartTitle() | Returns or sets a chart title. Read-only IChartTitle. |
Result:
ChartTitle
getConnectionSiteCount
| Name | Description |
|---|
| getConnectionSiteCount() | Returns the number of connection sites on the shape. Read-only int. |
Result:
int
getCustomData
| Name | Description |
|---|
| getCustomData() | Returns the shape’s custom data. Read-only ICustomData. |
Result:
CustomData
getDisplayBlanksAs
| Name | Description |
|---|
| getDisplayBlanksAs() | Returns or sets the way to plot blank cells on a chart. Read/write DisplayBlanksAsType. |
Result:
int
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| getFloor() | Returns an object which allows to change format of the floor of a 3D chart. Read-only IChartWall. |
Result:
ChartWall
getFrame
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| getGraphicalObjectLock() | Returns shape’s locks. Read-only IGraphicalObjectLock. |
Result:
GraphicalObjectLock
getHeight
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| getHidden() | Determines whether the shape is hidden. Read/write boolean. |
Result:
boolean
getHyperlinkClick
| Name | Description |
|---|
| getHyperlinkClick() | Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink. |
Result:
Hyperlink
getHyperlinkManager
| Name | Description |
|---|
| getHyperlinkManager() | Returns the hyperlink manager. Read-only IHyperlinkManager. |
Result:
HyperlinkManager
getHyperlinkMouseOver
| Name | Description |
|---|
| getHyperlinkMouseOver() | Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink. |
Result:
Hyperlink
getLegend
| Name | Description |
|---|
| getLegend() | Returns or sets a legend for a chart. Read-only ILegend. |
Result:
Legend
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| getParent_Immediate() | |
getPlaceholder
| Name | Description |
|---|
| getPlaceholder() | Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only IPlaceholder. |
Result:
Placeholder
getPlotArea
| Name | Description |
|---|
| getPlotArea() | Represents the plot area of a chart. Read-only IChartPlotArea. |
Result:
ChartPlotArea
getPlotVisibleCellsOnly
| Name | Description |
|---|
| getPlotVisibleCellsOnly() | Determines whether the only visible cells are plotted. False to plot both visible and hidden cells. Read/write boolean. |
Result:
boolean
getPresentation
| Name | Description |
|---|
| getPresentation() | Returns the parent presentation of a slide. Read-only IPresentation. |
Result:
Presentation
getRawFrame
| Name | Description |
|---|
| getRawFrame() | Returns or sets the raw shape frame’s properties. Read/write IShapeFrame. |
Result:
ShapeFrame
getRotation
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| getRotation3D() | Returns a 3D rotation of a chart. Read-only IRotation3D. |
Result:
Rotation3D
getShapeLock
| Name | Description |
|---|
| getShapeLock() | Returns shape’s locks. Read-only IBaseShapeLock. |
Result:
BaseShapeLock, PictureFrameLock, AutoShapeLock, GraphicalObjectLock, GroupShapeLock, ConnectorLock
getShowDataLabelsOverMaximum
| Name | Description |
|---|
| getShowDataLabelsOverMaximum() | Specifies data labels over the maximum of the chart shall be shown. Read/write boolean. |
Result:
boolean
getSideWall
| Name | Description |
|---|
| getSideWall() | Returns an object which allows to change format of the side wall of a 3D chart. Read-only IChartWall. |
Result:
ChartWall
getSlide
| Name | Description |
|---|
| getSlide() | Returns the parent slide of a shape. Read-only IBaseSlide. |
Result:
Slide, MasterNotesSlide, BaseSlide, MasterSlide, LayoutSlide, MasterHandoutSlide, NotesSlide
getStyle
| Name | Description |
|---|
| getStyle() | Returns or sets the chart style. Read/write StyleType. |
Result:
int
getTextFormat
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| getThemeManager() | Returns theme manager. Read-only IOverrideThemeManager. |
Result:
LayoutSlideThemeManager, ChartThemeManager, BaseOverrideThemeManager, NotesSlideThemeManager, SlideThemeManager
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| getThumbnail() | Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default. |
Result:
BufferedImage
getThumbnail
| Name | Description |
|---|
| getThumbnail(int, float, float) | Returns shape thumbnail. |
Parameters:
| Name | Type | Description |
|---|
| bounds | int | Shape thumbnail bounds type. |
| scaleX | float | X scale |
| scaleY | float | Y scale |
Result:
BufferedImage
getType
| Name | Description |
|---|
| getType() | Returns or sets the chart type. Read/write ChartType. |
Result:
int
getUniqueId
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| getUserShapes() | Specify the shapes drawn on top of the chart. Read-only IGroupShape. |
Result:
GroupShape
getWidth
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| hasDataTable() | Determines whether a chart has a data table. Read/write boolean. |
Result:
boolean
hasLegend
| Name | Description |
|---|
| hasLegend() | Determines whether a chart has a legend. Read/write boolean. |
Result:
boolean
hasRoundedCorners
| Name | Description |
|---|
| hasRoundedCorners() | Specifies the chart area shall have rounded corners. Read/write boolean. |
Result:
boolean
hasTitle
| Name | Description |
|---|
| hasTitle() | Determines whether a chart has a visible title. Read/write boolean. |
Result:
boolean
isGrouped
| Name | Description |
|---|
| isGrouped() | Determines whether the shape is grouped. Read-only boolean. Property ( #getParentGroup) returns parent GroupShape object if shape is grouped. |
Result:
boolean
isTextHolder
| Name | Description |
|---|
| isTextHolder() | Determines whether the shape is TextHolder_PPT. Read-only boolean. |
Result:
boolean
removePlaceholder
| Name | Description |
|---|
| removePlaceholder() | Defines that this shape isn’t a placeholder. |
setAlternativeText
| Name | Description |
|---|
| setAlternativeText(String) | Returns or sets the alternative text associated with a shape. Read/write String. |
setAlternativeTextTitle
| Name | Description |
|---|
| setAlternativeTextTitle(String) | Returns or sets the title of alternative text associated with a shape. Read/write String. |
setBlackWhiteMode
| Name | Description |
|---|
| setBlackWhiteMode(byte) | Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode. |
setDataTable
| Name | Description |
|---|
| setDataTable(boolean) | Determines whether a chart has a data table. Read/write boolean. |
setDisplayBlanksAs
| Name | Description |
|---|
| setDisplayBlanksAs(int) | Returns or sets the way to plot blank cells on a chart. Read/write DisplayBlanksAsType. |
setFrame
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| setHidden(boolean) | Determines whether the shape is hidden. Read/write boolean. |
setHyperlinkClick
| Name | Description |
|---|
| setHyperlinkClick(Hyperlink) | Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink. |
setHyperlinkMouseOver
| Name | Description |
|---|
| setHyperlinkMouseOver(Hyperlink) | Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink. |
setLegend
| Name | Description |
|---|
| setLegend(boolean) | Determines whether a chart has a legend. Read/write boolean. |
setName
| Name | Description |
|---|
| setName(String) | Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String. |
setPlotVisibleCellsOnly
| Name | Description |
|---|
| setPlotVisibleCellsOnly(boolean) | Determines whether the only visible cells are plotted. False to plot both visible and hidden cells. Read/write boolean. |
setRawFrame
| Name | Description |
|---|
| setRawFrame(ShapeFrame) | Returns or sets the raw shape frame’s properties. Read/write IShapeFrame. |
setRotation
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| setRoundedCorners(boolean) | Specifies the chart area shall have rounded corners. Read/write boolean. |
setShowDataLabelsOverMaximum
| Name | Description |
|---|
| setShowDataLabelsOverMaximum(boolean) | Specifies data labels over the maximum of the chart shall be shown. Read/write boolean. |
setStyle
| Name | Description |
|---|
| setStyle(int) | Returns or sets the chart style. Read/write StyleType. |
setTitle
| Name | Description |
|---|
| setTitle(boolean) | Determines whether a chart has a visible title. Read/write boolean. |
setType
| Name | Description |
|---|
| setType(int) | Returns or sets the chart type. Read/write ChartType. |
setWidth
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| writeAsSvgToBytes () | Saves content of Shape as SVG file. |
Result:
Bytes[]
writeAsSvgToBytes
| Name | Description |
|---|
| writeAsSvgToBytes (SVGOptions) | Saves content of Shape as SVG file. |
Parameters:
| Name | Type | Description |
|---|
| svgOptions | SVGOptions | SVG generation options |
Result:
Bytes[]