Interface IShape

All Superinterfaces:: IContainer

All Known Subinterfaces:: IBackgroundPicture

public interface IShape extends IContainer

Represents an object in the drawing layer, such as an AutoShape, chart, connector, or picture.

An IShape is a member of the IShapes collection and provides the common shape API for positioning, sizing, grouping, formatting, and accessing specialized shape features such as charts, controls, and connectors.


 IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 10, 10, 120, 60);
 shape.setName("SalesBox");
 shape.setRotation(15);

Method Summary

Modifier and Type

Method

Description

void

delete()

Deletes the object.

IShape

duplicate()

Duplicates the shape and returns a reference to the new copy.

void

fromJson(String json)

Loads the shape from the specified JSON string.

IAdjustments

getAdjustments()

Gets a collection of adjustment values for the specified AutoShape or connector.

String

getAlternativeText()

Gets the descriptive (alternative) text string for the specified shape object.

AutoShapeType

getAutoShapeType()

Gets the shape type for the specified IShape object.

IRange

getBottomRightCell()

Gets the IRange object that represents the cell that lies under the lower-right corner of the object.

IChart

getChart()

Returns an object that represents the IChart contained in this shape.

boolean

getConnector()

Gets whether the specified shape is a connector.

IConnectorFormat

getConnectorFormat()

Returns the IConnectorFormat object that contains connector formatting properties.

IControl

getControl()

Gets the associated control.

boolean

getDecorative()

Returns the decorative flag for the specified shape object.

IFillFormat

getFill()

Returns the IFillFormat object that contains fill formatting properties for the specified chart or shape.

String

getFormula()

Gets the formula of the current shape.

IGroupShapes

getGroupItems()

Gets the IGroupShapes object that represents the individual shapes in the specified group.

boolean

getHasChart()

Returns information if the IShape contains a chart.

IHyperlink

getHyperlink()

Returns a IHyperlink object that represents the hyperlink for the shape.

boolean

getIsPrintable()

Gets whether the object should be printed.

ILineFormat

getLine()

Returns the ILineFormat object that contains line formatting properties for the specified shape.

boolean

getLocked()

Gets whether the object is locked.

String

getName()

Returns the name of the object.

IWorksheet

getParent()

Gets the shape's parent sheet.

IShape

getParentGroup()

Returns the IShape object that represents the common parent shape of a child shape or a range of child shapes.

IPictureFormat

getPictureFormat()

Returns the IPictureFormat object that contains picture formatting properties for the specified shape.

Placement

getPlacement()

Returns the way the object is attached to the cells below it.

double

getRotation()

Returns the rotation of the shape in degrees.

ITextFrame

getTextFrame()

Returns the ITextFrame object that contains the text and font style properties for the specified shape.

IThreeDFormat

getThreeD()

Returns the IThreeDFormat object that contains 3-D effect formatting properties for the specified shape.

String

getTitle()

Gets the title of the alternative text associated with the specified shape.

IRange

getTopLeftCell()

Returns the IRange object that represents the cell that lies under the upper-left corner of the specified object.

ShapeType

getType()

Returns the shape type.

boolean

getVisible()

Gets whether the object is visible.

int

getZOrderPosition()

Gets the position of the specified shape in the z-order.

void

setAlternativeText(String alternativeText)

Sets the descriptive (alternative) text string for the specified shape object.

void

setAutoShapeType(AutoShapeType value)

Sets the shape type for the specified IShape object.

void

setDecorative(boolean value)

Sets the decorative flag for the specified shape object.

void

setFormula(String formula)

Sets the formula of the current shape.

void

setIsPrintable(boolean value)

Sets whether the object should be printed.

void

setLocked(boolean value)

Sets whether the object is locked.

void

setName(String value)

Sets the name of the object.

void

setPlacement(Placement value)

Sets the way the object is attached to the cells below it.

void

setRotation(double value)

Sets the rotation of the shape in degrees.

void

setTitle(String value)

Sets the title of the alternative text associated with the specified shape.

void

setVisible(boolean value)

Sets whether the object is visible.

void

toImage(OutputStream stream, ImageType imageType)

Saves the shape to the specified image stream.

void

toImage(OutputStream stream, ImageType imageType, ImageSaveOptions options)

Saves the shape to the specified image stream.

void

toImage(String fileName)

Saves the shape to the specified image file.

void

toImage(String fileName, ImageSaveOptions options)

Saves the shape to the specified image file using options.

String

toJson()

Generates a JSON string from the shape.

IShapeRange

ungroup()

Ungroups any grouped shapes in the specified shape or range of shapes.

void

zOrder(ZOrderType zOrderType)

Moves the specified shape in front of or behind other shapes in the collection (that is, changes the shape's position in the z-order).

Methods inherited from interface com.grapecity.documents.excel.drawing.IContainer
getHeight, getHeightInPixel, getLeft, getLeftInPixel, getTop, getTopInPixel, getWidth, getWidthInPixel, setHeight, setHeightInPixel, setLeft, setLeftInPixel, setTop, setTopInPixel, setWidth, setWidthInPixel

Method Details
- getControl
  
  IControl getControl()
  Gets the associated control.
  Returns the control hosted by this shape. If the shape is not a control, this method returns null.
  
  IScrollBar scrollBar = worksheet.getControls().addScrollBar(50, 20, 120, 20); IShape controlShape = scrollBar.getShapeRange().get(0); IControl control = controlShape.getControl();
  Returns:
  
  The associated control, or null if the shape is not a control.
- ungroup
  
  IShapeRange ungroup()
  Ungroups any grouped shapes in the specified shape or range of shapes. Disassembles pictures and OLE objects within the specified shape or range of shapes.
  IShape rectangle = worksheet.getShapes().addShape("rectangle", AutoShapeType.Rectangle, 20, 20, 80, 50); IShape oval = worksheet.getShapes().addShape("oval", AutoShapeType.Oval, 40, 40, 80, 50); IShape groupShape = worksheet.getShapes().getRange(new int[] {0, 1}).group(); IShapeRange ungroupedShapes = groupShape.ungroup(); int count = ungroupedShapes.getCount();
  Returns:
  
  An IShapeRange object that represents the ungrouped shapes.
- getParent
  
  IWorksheet getParent()
  Gets the shape's parent sheet.
  Returns the IWorksheet that contains this shape.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); IWorksheet parent = shape.getParent(); String sheetName = parent.getName();
  Returns:
  
  The IWorksheet that contains the shape.
- getName
  
  String getName()
  Returns the name of the object.
  Use this method to get the current name assigned to the shape.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setName("SalesBox"); String name = shape.getName();
  Returns:
  
  The name of the object.
- setName
  
  void setName(String value)
  Sets the name of the object.
  Use this method to assign a name to the shape.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setName("SalesBox");
  Parameters:
  
  value - The name of the object.
- getTopLeftCell
  
  IRange getTopLeftCell()
  Returns the IRange object that represents the cell that lies under the upper-left corner of the specified object.
  Use this method to identify the worksheet cell beneath the shape's upper-left corner.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); IRange range = shape.getTopLeftCell(); String address = range.getAddress();
  Returns:
  
  The IRange object that represents the cell under the upper-left corner of the specified object.
- getBottomRightCell
  
  IRange getBottomRightCell()
  Gets the IRange object that represents the cell that lies under the lower-right corner of the object.
  This property can be used to determine which worksheet cell is covered by the shape's lower-right corner.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); IRange range = shape.getBottomRightCell(); String address = range.getAddress();
  Returns:
  
  The IRange object that represents the cell that lies under the lower-right corner of the object.
- getTitle
  
  String getTitle()
  Gets the title of the alternative text associated with the specified shape. This applies to chart, shape, picture, linked picture, slicer, and group shape objects.
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setTitle("SalesBox"); String title = shape.getTitle();
  Returns:
  
  The title of the alternative text associated with the specified shape.
- setTitle
  
  void setTitle(String value)
  Sets the title of the alternative text associated with the specified shape. This applies to chart, shape, picture, linked picture, slicer, and group shape objects.
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setTitle("SalesBox");
  Parameters:
  
  value - The title of the alternative text associated with the specified shape.
- getRotation
  
  double getRotation()
  Returns the rotation of the shape in degrees.
  Use this method to get the current rotation angle applied to the shape.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setRotation(15); double rotation = shape.getRotation();
  Returns:
  
  The rotation of the shape, in degrees.
- setRotation
  
  void setRotation(double value)
  Sets the rotation of the shape in degrees.
  Use this method to update the current rotation angle applied to the shape.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setRotation(15);
  Parameters:
  
  value - The rotation of the shape, in degrees.
- getChart
  
  IChart getChart()
  Returns an object that represents the IChart contained in this shape.
  Use getHasChart() to determine whether this shape contains a chart before calling this method.
  
  IShape shape = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 240, 160); IChart chart = shape.getChart(); ChartType chartType = chart.getChartType();
  Returns:
  
  The IChart contained in this shape.
- getAutoShapeType
  
  AutoShapeType getAutoShapeType()
  Gets the shape type for the specified IShape object.
  This method is available for AutoShapes other than lines, freeform drawings, and connectors.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); AutoShapeType shapeType = shape.getAutoShapeType();
  Returns:
  
  The AutoShapeType of the shape.
- setAutoShapeType
  
  void setAutoShapeType(AutoShapeType value)
  Sets the shape type for the specified IShape object.
  This method is available for AutoShapes other than lines, freeform drawings, and connectors.
  
  Use this method to change one AutoShape type to another supported AutoShapeType.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setAutoShapeType(AutoShapeType.RoundedRectangle);
  Parameters:
  
  value - The AutoShape type to apply to the shape.
- getAlternativeText
  
  String getAlternativeText()
  Gets the descriptive (alternative) text string for the specified shape object. This applies to chart, shape, picture, linked picture, slicer, controls, and group shape objects.
  Use this method to read the accessibility description currently assigned to the shape. To update the description, use setAlternativeText(String). If the shape is marked as decorative by using getDecorative(), the returned text can be an empty string.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setAlternativeText("Company logo"); String alternativeText = shape.getAlternativeText();
  Returns:
  
  The alternative text string for the shape.
- setAlternativeText
  
  void setAlternativeText(String alternativeText)
  Sets the descriptive (alternative) text string for the specified shape object. This applies to chart, shape, picture, linked picture, slicer, controls, and group shape objects. Passing an empty string clears the decorative flag for the shape.
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setAlternativeText("Company logo"); String alternativeText = shape.getAlternativeText();
  Parameters:
  
  alternativeText - The alternative text string for the shape.
- getDecorative
  
  boolean getDecorative()
  Returns the decorative flag for the specified shape object.
  This applies to chart, shape, picture, linked picture, slicer, and group shape objects. A decorative shape is intended for visual presentation rather than screen reader description. Use setDecorative(boolean) to change this flag. When the decorative flag is set to true, the shape's alternative text and title are cleared, so getAlternativeText() and getTitle() can return empty strings.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.RoundedRectangle, 20, 20, 160, 80); shape.setAlternativeText("Company logo"); shape.setTitle("SalesBox"); shape.setDecorative(true); boolean decorative = shape.getDecorative(); String alternativeText = shape.getAlternativeText(); String title = shape.getTitle();
  Returns:
  
  true if the specified shape is decorative; otherwise, false.
- setDecorative
  
  void setDecorative(boolean value)
  Sets the decorative flag for the specified shape object.
  Setting value to true marks the shape as decorative and clears the shape's alternative text and title. Use this when the shape is intended only for visual presentation and should not expose screen reader description text.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.RoundedRectangle, 20, 20, 160, 80); shape.setAlternativeText("Company logo"); shape.setTitle("SalesBox"); shape.setDecorative(true); boolean decorative = shape.getDecorative(); String alternativeText = shape.getAlternativeText(); String title = shape.getTitle();
  Parameters:
  
  value - True if the specified shape is decorative.
- getConnector
  
  boolean getConnector()
  Gets whether the specified shape is a connector.
  Use this method to determine whether connector-specific APIs such as getConnectorFormat() apply to the shape.
  
  IShape shape = worksheet.getShapes().addConnector(ConnectorType.Straight, 20, 20, 120, 60); boolean isConnector = shape.getConnector();
  Returns:
  
  true if the specified shape is a connector; otherwise, false.
- getConnectorFormat
  
  IConnectorFormat getConnectorFormat()
  Returns the IConnectorFormat object that contains connector formatting properties.
  Applies to IShape objects that represent connectors.
  
  IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 20, 20, 120, 80); IConnectorFormat connectorFormat = connector.getConnectorFormat(); connectorFormat.setType(ConnectorType.Elbow);
  Returns:
  
  The IConnectorFormat object that contains connector formatting properties.
- getFill
  
  IFillFormat getFill()
  Returns the IFillFormat object that contains fill formatting properties for the specified chart or shape.
  Use the returned IFillFormat object to configure fill settings such as solid fill, gradient fill, pattern, texture, color, and transparency.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); IFillFormat fill = shape.getFill(); fill.solid(); fill.getColor().setRGB(Color.GetBlue());
  Returns:
  
  The IFillFormat object that contains fill formatting properties for the specified chart or shape.
- getHasChart
  
  boolean getHasChart()
  Returns information if the IShape contains a chart.
  Use this method to determine whether getChart() can be used to access a chart contained in the shape.
  
  IShape shape = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 240, 160); boolean hasChart = shape.getHasChart();
  Returns:
  
  true if the shape contains a chart; otherwise, false.
- getLine
  
  ILineFormat getLine()
  Returns the ILineFormat object that contains line formatting properties for the specified shape.
  Use the returned object to access and modify the shape's line appearance, such as weight, dash style, color, and transparency.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); ILineFormat line = shape.getLine(); line.setWeight(2); line.setDashStyle(LineDashStyle.Dash);
  Returns:
  
  The ILineFormat object that contains line formatting properties for the specified shape.
- getParentGroup
  
  IShape getParentGroup()
  Returns the IShape object that represents the common parent shape of a child shape or a range of child shapes.
  IShape rectangle = worksheet.getShapes().addShape("rectangle", AutoShapeType.Rectangle, 20, 20, 80, 50); IShape oval = worksheet.getShapes().addShape("oval", AutoShapeType.Oval, 40, 40, 80, 50); IShape groupShape = worksheet.getShapes().getRange(new int[] {0, 1}).group(); IShape childShape = groupShape.getGroupItems().get(0); IShape parentGroup = childShape.getParentGroup();
  Returns:
  
  The parent group shape, or null if this shape is not inside a group.
- getGroupItems
  
  IGroupShapes getGroupItems()
  Gets the IGroupShapes object that represents the individual shapes in the specified group.
  Use IGroupShapes.get(int) or IGroupShapes.get(String) to retrieve a single shape from the group.
  
  IShape rectangle = worksheet.getShapes().addShape("rectangle", AutoShapeType.Rectangle, 20, 20, 80, 50); IShape oval = worksheet.getShapes().addShape("oval", AutoShapeType.Oval, 40, 40, 80, 50); IShape groupShape = worksheet.getShapes().getRange(new int[] {0, 1}).group(); IGroupShapes groupItems = groupShape.getGroupItems(); IShape shape = groupItems.get("oval");
  Returns:
  
  The IGroupShapes object that contains the individual shapes in the group.
- getPictureFormat
  
  IPictureFormat getPictureFormat()
  Returns the IPictureFormat object that contains picture formatting properties for the specified shape.
  Use the returned object to access picture-specific settings such as transparency, brightness, contrast, and cropping.
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); IShape picture = worksheet.getShapes().addCameraPicture("=$A$1:$B$2", 20, 20); IPictureFormat pictureFormat = picture.getPictureFormat(); pictureFormat.setTransparency(0.5);
  Returns:
  
  The IPictureFormat object that contains picture formatting properties for the specified shape.
- getTextFrame
  
  ITextFrame getTextFrame()
  Returns the ITextFrame object that contains the text and font style properties for the specified shape.
  Use the returned text frame to access and modify the shape's text content, font formatting, and text layout settings.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); ITextFrame textFrame = shape.getTextFrame(); textFrame.getTextRange().setText("Sales"); textFrame.getTextRange().getFont().setBold(true);
  Returns:
  
  The ITextFrame object for the specified shape.
- getPlacement
  
  Placement getPlacement()
  Returns the way the object is attached to the cells below it.
  The returned value indicates whether the shape moves and sizes with cells, moves with cells only, or remains free floating.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setPlacement(Placement.Move); Placement placement = shape.getPlacement();
  Returns:
  
  The Placement value that specifies how the object is attached to the cells below it.
- setPlacement
  
  void setPlacement(Placement value)
  Sets the way the object is attached to the cells below it.
  Use a Placement value to control whether the shape moves and resizes with cells, moves with cells, or remains free floating.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setPlacement(Placement.MoveAndSize);
  Parameters:
  
  value - The Placement value that specifies how the object is attached to cells.
- getThreeD
  
  IThreeDFormat getThreeD()
  Returns the IThreeDFormat object that contains 3-D effect formatting properties for the specified shape.
  Use the returned object to read or modify settings such as extrusion depth, rotation, perspective, and 3-D visibility for the shape.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); IThreeDFormat threeD = shape.getThreeD(); threeD.setDepth(12);
  Returns:
  
  The IThreeDFormat object that contains the shape's 3-D effect formatting properties.
- getType
  
  ShapeType getType()
  Returns the shape type.
  Use this method to determine the general category of the shape, such as preset shape ( ShapeType.AutoShape), ShapeType.Chart, ShapeType.Picture, ShapeType.TextBox, or ShapeType.Line.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); ShapeType type = shape.getType();
  Returns:
  
  The ShapeType that identifies the general category of the shape.
- getVisible
  
  boolean getVisible()
  Gets whether the object is visible.
  This property indicates whether the shape is displayed on the worksheet.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setVisible(false); boolean visible = shape.getVisible();
  Returns:
  
  true if the object is visible; otherwise, false.
- setVisible
  
  void setVisible(boolean value)
  Sets whether the object is visible.
  This property indicates whether the shape is displayed on the worksheet.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setVisible(false);
  Parameters:
  
  value - true if the object is visible; otherwise, false.
- getIsPrintable
  
  boolean getIsPrintable()
  Gets whether the object should be printed.
  This property indicates whether the shape is included when the worksheet is printed or exported to a printable output such as PDF.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setIsPrintable(false); boolean isPrintable = shape.getIsPrintable();
  Returns:
  
  true if the object should be printed; otherwise, false.
- setIsPrintable
  
  void setIsPrintable(boolean value)
  Sets whether the object should be printed.
  This property indicates whether the shape is included when the worksheet is printed or exported to a printable output such as PDF.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setIsPrintable(false);
  Parameters:
  
  value - true if the object should be printed; otherwise, false.
- getLocked
  
  boolean getLocked()
  Gets whether the object is locked.
  Returns true if the object is locked, or false if the object can be modified when the worksheet is protected.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setLocked(true); boolean locked = shape.getLocked();
  Returns:
  
  true if the object is locked; otherwise, false.
- setLocked
  
  void setLocked(boolean value)
  Sets whether the object is locked.
  Sets true if the object is locked, or false if the object can be modified when the worksheet is protected.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setLocked(true);
  Parameters:
  
  value - true if the object is locked; otherwise, false.
- getZOrderPosition
  
  int getZOrderPosition()
  Gets the position of the specified shape in the z-order.
  Use this method to retrieve the current stacking position of a shape relative to other shapes in the same worksheet. This is typically used after calling zOrder(ZOrderType) to inspect the updated order.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); int zOrderPosition = shape.getZOrderPosition();
  Returns:
  
  The position of the shape in the z-order.
- getFormula
  
  String getFormula()
  Gets the formula of the current shape.
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setFormula("=A1"); String formula = shape.getFormula();
  Returns:
  
  The formula.
- setFormula
  
  void setFormula(String formula)
  Sets the formula of the current shape.
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setFormula("=A1");
  Parameters:
  
  formula - The formula to set.
- delete
  
  void delete()
  Deletes the object.
  Use this method to remove a shape object from the worksheet drawing layer.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.getTextFrame().getTextRange().setText("Hello"); shape.delete();
- duplicate
  
  IShape duplicate()
  Duplicates the shape and returns a reference to the new copy.
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.getTextFrame().getTextRange().setText("Hello"); IShape copiedShape = shape.duplicate(); copiedShape.getTextFrame().getTextRange().setText("Hello Copy");
  Returns:
  
  A reference to the duplicated shape.
- zOrder
  
  void zOrder(ZOrderType zOrderType)
  Moves the specified shape in front of or behind other shapes in the collection (that is, changes the shape's position in the z-order).
  Use getZOrderPosition() to determine the current z-order position of a shape. If the z-order of a shape is changed, the index of the shape in the worksheet's shapes collection also changes.
  
  IShape rectangle = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); IShape oval = worksheet.getShapes().addShape(AutoShapeType.Oval, 40, 30, 120, 60); rectangle.zOrder(ZOrderType.BringForward);
  Parameters:
  
  zOrderType - The z-order command that specifies where to move the shape relative to the other shapes. This value is required.
- getAdjustments
  
  IAdjustments getAdjustments()
  Gets a collection of adjustment values for the specified AutoShape or connector.
  Adjustment values control editable geometry points for shapes that support adjustments. The available adjustment points depend on the current shape type.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Chevron, 10, 10, 120, 80); IAdjustments adjustments = shape.getAdjustments(); double value = adjustments.get(0); adjustments.set(0, value * 0.8);
  Returns:
  
  An IAdjustments collection that provides access to the shape's adjustment values.
- getHyperlink
  
  IHyperlink getHyperlink()
  Returns a IHyperlink object that represents the hyperlink for the shape.
  Use this method to access the hyperlink attached to the shape and inspect or update properties such as its address, subaddress, screen tip, or display text.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Oval, 1, 1, 200, 100); shape.getTextFrame().getTextRange().getParagraphs().add("Open Mescius"); worksheet.getHyperlinks().add(shape, "https://developer.mescius.com/", null, "Click to Open", "MESCIUS"); IHyperlink hyperlink = shape.getHyperlink(); String address = hyperlink.getAddress();
  Returns:
  
  The IHyperlink object that represents the hyperlink for the shape.
- toImage
  
  void toImage(String fileName)
  Saves the shape to the specified image file.
  The generated image displays the rectangular worksheet area enclosed by the shape. This method can be used with shapes such as AutoShapes, pictures, slicers, and charts.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Oval, 20, 20, 160, 80); String imagePath = "ShapeToImage.png"; shape.toImage(imagePath);
  Parameters:
  
  fileName - The output image file.
- toImage
  
  void toImage(String fileName, ImageSaveOptions options)
  Saves the shape to the specified image file using options.
  The generated image displays the rectangular worksheet area enclosed by the shape. This method can be used with shapes such as AutoShapes, pictures, slicers, and charts. Use options to control how the output image is generated.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Oval, 20, 20, 160, 80); ImageSaveOptions options = new ImageSaveOptions(); options.setScaleX(2.0); String imagePath = "ShapeToImage.png"; shape.toImage(imagePath, options);
  Parameters:
  
  fileName - The output image file.
  
  options - The options for output image.
- toImage
  
  void toImage(OutputStream stream, ImageType imageType)
  Saves the shape to the specified image stream.
  Use imageType to control the output format of the generated image. To customize the exported image, use toImage(OutputStream,ImageType,ImageSaveOptions).
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setName("SalesBox"); ByteArrayOutputStream stream = new ByteArrayOutputStream(); shape.toImage(stream, ImageType.PNG);
  Parameters:
  
  stream - The output image stream to receive the generated image. Must not be null.
  
  imageType - Specifies the type of image to create. Must not be null.
- toImage
  
  void toImage(OutputStream stream, ImageType imageType, ImageSaveOptions options)
  Saves the shape to the specified image stream.
  Use this method to export the current shape as an image in the specified format. The generated image is written to the provided OutputStream.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); ByteArrayOutputStream stream = new ByteArrayOutputStream(); ImageSaveOptions options = new ImageSaveOptions(); shape.toImage(stream, ImageType.PNG, options);
  Parameters:
  
  stream - The output image stream.
  
  imageType - Specifies the type of image to create.
  
  options - The options for output image. Can be null.
- fromJson
  
  void fromJson(String json)
  Loads the shape from the specified JSON string.
  Use toJson() to generate a JSON string for a shape and apply it to another shape with this method.
  
  IShape sourceShape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); sourceShape.getTextFrame().getTextRange().setText("Hello"); String json = sourceShape.toJson(); IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 160, 20, 120, 60); shape.fromJson(json);
  Parameters:
  
  json - The JSON string that represents a shape.
- toJson
  
  String toJson()
  Generates a JSON string from the shape.
  The returned JSON can be used with fromJson(String) to create a shape from the serialized shape definition.
  
  IShape shape = worksheet.getShapes().addShape(AutoShapeType.Rectangle, 20, 20, 120, 60); shape.setName("SalesBox"); String json = shape.toJson();
  Returns:
  
  The JSON string that represents the shape.

Interface IShape

Method Summary

Methods inherited from interface com.grapecity.documents.excel.drawing.IContainer

Method Details

getControl

ungroup

getParent

getName

setName

getTopLeftCell

getBottomRightCell

getTitle

setTitle

getRotation

setRotation

getChart

getAutoShapeType

setAutoShapeType

getAlternativeText

setAlternativeText

getDecorative

setDecorative

getConnector

getConnectorFormat

getFill

getHasChart

getLine

getParentGroup

getGroupItems

getPictureFormat

getTextFrame

getPlacement

setPlacement

getThreeD

getType

getVisible

setVisible

getIsPrintable

setIsPrintable

getLocked

setLocked

getZOrderPosition

getFormula

setFormula

delete

duplicate

zOrder

getAdjustments

getHyperlink

toImage

toImage

toImage

toImage

fromJson

toJson