ShapeCollection (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.CollectionBase
- - com.aspose.cells.ShapeCollection

All Implemented Interfaces:: java.lang.Iterable

public class ShapeCollection
extends CollectionBase

Represents all the shape in a worksheet/chart.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
 
         //get ShapeCollection
         ShapeCollection shapes = workbook.getWorksheets().get(0).getShapes();
 
         //do your business
 
         //Save the excel file.
         workbook.save("result.xlsx");

Method Summary

Methods
Modifier and Type	Method and Description
`Shape`	`addActiveXControl(int type, int topRow, int top, int leftColumn, int left, int width, int height)` Creates an Activex Control.
`ArcShape`	`addArc(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a ArcShape to the worksheet.
`Shape`	`addAutoShape(int type, int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a AutoShape to the worksheet.
`Shape`	`addAutoShapeInChart(int type, int top, int left, int height, int width)` Adds a AutoShape to the chart.
`Button`	`addButton(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a Button to the worksheet.
`CheckBox`	`addCheckBox(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a checkbox to the worksheet.
`ComboBox`	`addComboBox(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a ComboBox to the worksheet.
`Shape`	`addCopy(Shape sourceShape, int topRow, int top, int leftColumn, int left)` Adds and copy a shape to the worksheet.
`TextBox`	`addEquation(int topRow, int top, int leftColumn, int left, int height, int width)` Add an equation object to the worksheet.
`Shape`	`addFreeFloatingShape(int type, int top, int left, int height, int width, byte[] imageData, boolean isOriginalSize)` Adds a free floating shape to the worksheet.Only applies for line/image shape.
`Shape`	`addFreeform(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width, ShapePath[] paths)` Adds a freeform shape to the worksheet.
`GroupBox`	`addGroupBox(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a GroupBox to the worksheet.
`Picture`	`addIcons(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width, byte[] imageByteData, byte[] compatibleImageData)` Adds svg image.
`Label`	`addLabel(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a Label to the worksheet.
`Label`	`addLabelInChart(int top, int left, int height, int width)` Adds a label to the chart.
`LineShape`	`addLine(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a LineShape to the worksheet.
`Picture`	`addLinkedPicture(int upperLeftRow, int upperLeftColumn, int height, int width, java.lang.String sourceFullName)` Add a linked picture.
`ListBox`	`addListBox(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a ListBox to the worksheet.
`OleObject`	`addOleObject(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width, byte[] imageData)` Adds an OleObject.
`OleObject`	`addOleObjectWithLinkedImage(int upperLeftRow, int upperLeftColumn, int height, int width, java.lang.String sourceFullName)` Add a linked picture.
`Oval`	`addOval(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a Oval to the worksheet.
`Picture`	`addPicture(int upperLeftRow, int upperLeftColumn, java.io.InputStream stream, int widthScale, int heightScale)` Adds a picture to the collection.
`Picture`	`addPicture(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, java.io.InputStream stream)` Adds a picture to the collection.
`Picture`	`addPictureInChart(int top, int left, java.io.InputStream stream, int widthScale, int heightScale)` Adds a picture to the chart.
`RadioButton`	`addRadioButton(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a RadioButton to the worksheet.
`RectangleShape`	`addRectangle(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a RectangleShape to the worksheet.
`ScrollBar`	`addScrollBar(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a ScrollBar to the worksheet.
`Shape`	`addShape(int type, int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a Shape to the worksheet.
`Shape`	`addShapeInChart(int type, int placement, int left, int top, int right, int bottom)` Add a shape to chart .All unit is 1/4000 of chart area.
`Shape`	`addShapeInChart(int type, int placement, int left, int top, int right, int bottom, byte[] imageData)` Add a shape to chart .All unit is 1/4000 of chart area.
`Shape`	`addShapeInChartByScale(int type, int placement, double left, double top, double right, double bottom)` Add a shape to chart.
`Shape`	`addShapeInChartByScale(int type, int placement, double left, double top, double right, double bottom, byte[] imageData)` Add a shape to chart .All unit is 1/4000 of chart area.
`Picture`	`addSignatureLine(int upperLeftRow, int upperLeftColumn, SignatureLine signatureLine)` Adds a Signature Line to the worksheet.
`Spinner`	`addSpinner(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a Spinner to the worksheet.
`Picture`	`addSvg(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width, byte[] svgData, byte[] compatibleImageData)` Adds svg image.
`TextBox`	`addTextBox(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds a text box to the worksheet.
`TextBox`	`addTextBoxInChart(int top, int left, int height, int width)` Adds a textbox to the chart.
`Shape`	`addTextEffect(int effect, java.lang.String text, java.lang.String fontName, int size, boolean fontBold, boolean fontItalic, int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Inserts a WordArt object.
`Shape`	`addTextEffectInChart(int effect, java.lang.String text, java.lang.String fontName, int size, boolean fontBold, boolean fontItalic, int top, int left, int height, int width)` Inserts a WordArt object to the chart
`Shape`	`addWordArt(int style, java.lang.String text, int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width)` Adds preset WordArt since Excel 2007.s
`void`	`clear()` Clear all shapes in the worksheet.
`void`	`copyCommentsInRange(ShapeCollection shapes, CellArea ca, int destRow, int destColumn)` Copy all comments in the range.
`void`	`copyInRange(ShapeCollection sourceShapes, CellArea ca, int destRow, int destColumn, boolean isContained)` Copy shapes in the range to destination range.
`void`	`deleteInRange(CellArea ca)` Delete shapes in the range.Comment shapes will not be deleted.
`void`	`deleteShape(Shape shape)` Delete a shape.
`Shape`	`get(int index)` Gets the `Shape` object at the specific index in the list.
`Shape`	`get(java.lang.String name)` Gets the `Shape` object by the name of the shape.
`GroupShape`	`group(Shape[] groupItems)` Group the shapes.
`void`	`remove(Shape shape)` Remove the shape.
`void`	`removeAt(int index)` Remove the shape.
`void`	`ungroup(GroupShape group)` Ungroups the shape items.
`void`	`updateSelectedValue()` Update the selected value by the value of the linked cell or range of the shape.

Methods inherited from class com.aspose.cells.CollectionBase
add, contains, getCount, indexOf, iterator

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - get
```
public Shape get(int index)
```
    Gets the Shape object at the specific index in the list.
    Example
```
 
         //get the first shape
         Shape shape = shapes.get(0);
 
```
    Overrides:
    
    get in class CollectionBase
    
    Parameters:
    index - The index.
    
    Returns:
  - get
```
public Shape get(java.lang.String name)
```
    Gets the Shape object by the name of the shape.
    Example
```
 
         //add a shape
         shapes.addRectangle(2, 0, 2, 0, 130, 130);
         //get the shape by the name.
         Shape shape1 = shapes.get("Rectangle 1");
         if(shape1 != null)
         {
             //Got the shape named 'Rectangle 1'.
         }
 
```
    Parameters:
    name - The name of the shape.
    
    Returns:
  - addCopy
```
public Shape addCopy(Shape sourceShape,
            int topRow,
            int top,
            int leftColumn,
            int left)
```
    Adds and copy a shape to the worksheet.
    Example
```
 
         //add a shape
         RectangleShape rectangle = shapes.addRectangle(2, 0, 2, 0, 130, 130);
         //Adds and copies a shape.
         shapes.addCopy(rectangle, 7, 0, 7, 0);
 
```
    Parameters:
    sourceShape - Source shape.
    topRow - The top row index.
    top - Represents the vertical offset from its top row, in unit of pixel.
    leftColumn - The left column index.
    left - Represents the horizontal offset from its left column, in unit of pixel.
    
    Returns:
    The new Shape object.
  - addCheckBox
```
public CheckBox addCheckBox(int upperLeftRow,
                   int top,
                   int upperLeftColumn,
                   int left,
                   int height,
                   int width)
```
    Adds a checkbox to the worksheet.
    Example
```
 
         //add a CheckBox
         CheckBox checkBox = shapes.addCheckBox(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of checkbox from its top row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of textbox from its left column, in unit of pixel.
    height - Height of textbox, in unit of pixel.
    width - Width of textbox, in unit of pixel.
    
    Returns:
    The new CheckBox object index.
  - addTextBox
```
public TextBox addTextBox(int upperLeftRow,
                 int top,
                 int upperLeftColumn,
                 int left,
                 int height,
                 int width)
```
    Adds a text box to the worksheet.
    Example
```
 
         //add a TextBox
         TextBox textBox = shapes.addTextBox(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of textbox from its top row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of textbox from its left column, in unit of pixel.
    height - Represents the height of textbox, in unit of pixel.
    width - Represents the width of textbox, in unit of pixel.
    
    Returns:
    A TextBox object.
  - addEquation
```
public TextBox addEquation(int topRow,
                  int top,
                  int leftColumn,
                  int left,
                  int height,
                  int width)
```
    Add an equation object to the worksheet.
    
    Parameters:
    topRow - The top row index.
    top - The vertical offset its top row, in unit of pixel.
    leftColumn - The left column index.
    left - The horizontal offset from its left column, in unit of pixel.
    height - The height of equation, in unit of pixel.
    width - The width of equation, in unit of pixel.
    
    Returns:
  - addSpinner
```
public Spinner addSpinner(int upperLeftRow,
                 int top,
                 int upperLeftColumn,
                 int left,
                 int height,
                 int width)
```
    Adds a Spinner to the worksheet.
    Example
```
 
         //add a spinner
         Spinner spinner = shapes.addSpinner(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of Spinner from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of Spinner from its left column, in unit of pixel.
    height - Represents the height of Spinner, in unit of pixel.
    width - Represents the width of Spinner, in unit of pixel.
    
    Returns:
    A Spinner object.
  - addScrollBar
```
public ScrollBar addScrollBar(int upperLeftRow,
                     int top,
                     int upperLeftColumn,
                     int left,
                     int height,
                     int width)
```
    Adds a ScrollBar to the worksheet.
    Example
```
 
         //add a scroll bar
         ScrollBar scrollBar = shapes.addScrollBar(1, 0, 1, 0, 100, 20);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of ScrollBar from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of ScrollBar from its left column, in unit of pixel.
    height - Represents the height of ScrollBar, in unit of pixel.
    width - Represents the width of ScrollBar, in unit of pixel.
    
    Returns:
    A ScrollBar object.
  - addRadioButton
```
public RadioButton addRadioButton(int upperLeftRow,
                         int top,
                         int upperLeftColumn,
                         int left,
                         int height,
                         int width)
```
    Adds a RadioButton to the worksheet.
    Example
```
 
         //add a radio button
         RadioButton radioButton = shapes.addRadioButton(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of RadioButton from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of RadioButton from its left column, in unit of pixel.
    height - Represents the height of RadioButton, in unit of pixel.
    width - Represents the width of RadioButton, in unit of pixel.
    
    Returns:
    A RadioButton object.
  - addListBox
```
public ListBox addListBox(int upperLeftRow,
                 int top,
                 int upperLeftColumn,
                 int left,
                 int height,
                 int width)
```
    Adds a ListBox to the worksheet.
    Example
```
 
         //add a list box
         ListBox listBox = shapes.addListBox(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of ListBox from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of ListBox from its left column, in unit of pixel.
    height - Represents the height of ListBox, in unit of pixel.
    width - Represents the width of ListBox, in unit of pixel.
    
    Returns:
    A ListBox object.
  - addComboBox
```
public ComboBox addComboBox(int upperLeftRow,
                   int top,
                   int upperLeftColumn,
                   int left,
                   int height,
                   int width)
```
    Adds a ComboBox to the worksheet.
    Example
```
 
         //add a combo box
         ComboBox comboBox = shapes.addComboBox(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of ComboBox from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of ComboBox from its left column, in unit of pixel.
    height - Represents the height of ComboBox, in unit of pixel.
    width - Represents the width of ComboBox, in unit of pixel.
    
    Returns:
    A ComboBox object.
  - addGroupBox
```
public GroupBox addGroupBox(int upperLeftRow,
                   int top,
                   int upperLeftColumn,
                   int left,
                   int height,
                   int width)
```
    Adds a GroupBox to the worksheet.
    Example
```
 
         //add a group box
         GroupBox groupBox = shapes.addGroupBox(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of GroupBox from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of GroupBox from its left column, in unit of pixel.
    height - Represents the height of GroupBox, in unit of pixel.
    width - Represents the width of GroupBox, in unit of pixel.
    
    Returns:
    A GroupBox object.
  - addButton
```
public Button addButton(int upperLeftRow,
               int top,
               int upperLeftColumn,
               int left,
               int height,
               int width)
```
    Adds a Button to the worksheet.
    Example
```
 
         //add a button
         Button button = shapes.addButton(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of Button from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of Button from its left column, in unit of pixel.
    height - Represents the height of Button, in unit of pixel.
    width - Represents the width of Button, in unit of pixel.
    
    Returns:
    A Button object.
  - addLabel
```
public Label addLabel(int upperLeftRow,
             int top,
             int upperLeftColumn,
             int left,
             int height,
             int width)
```
    Adds a Label to the worksheet.
    Example
```
 
         //add a label
         Label label = shapes.addLabel(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of Label from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of Label from its left column, in unit of pixel.
    height - Represents the height of Label, in unit of pixel.
    width - Represents the width of Label, in unit of pixel.
    
    Returns:
    A Label object.
  - addLabelInChart
```
public Label addLabelInChart(int top,
                    int left,
                    int height,
                    int width)
```
    Adds a label to the chart.
    
    Parameters:
    top - Represents the vertical offset of label from the upper left corner in units of 1/4000 of the chart area.
    left - Represents the vertical offset of label from the upper left corner in units of 1/4000 of the chart area.
    height - Represents the height of label, in units of 1/4000 of the chart area.
    width - Represents the width of label, in units of 1/4000 of the chart area.
    
    Returns:
    A new Label object.
  - addTextBoxInChart
```
public TextBox addTextBoxInChart(int top,
                        int left,
                        int height,
                        int width)
```
    Adds a textbox to the chart.
    
    Parameters:
    top - Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area.
    left - Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area.
    height - Represents the height of textbox, in units of 1/4000 of the chart area.
    width - Represents the width of textbox, in units of 1/4000 of the chart area.
    
    Returns:
    A TextBox object.
  - addTextEffectInChart
```
public Shape addTextEffectInChart(int effect,
                         java.lang.String text,
                         java.lang.String fontName,
                         int size,
                         boolean fontBold,
                         boolean fontItalic,
                         int top,
                         int left,
                         int height,
                         int width)
```
    Inserts a WordArt object to the chart
    
    Parameters:
    effect - MsoPresetTextEffect. The mso preset text effect type.
    text - The WordArt text.
    fontName - The font name.
    size - The font size
    fontBold - Indicates whether font is bold.
    fontItalic - Indicates whether font is italic.
    top - Represents the vertical offset of shape from the upper left corner in units of 1/4000 of the chart area.
    left - Represents the vertical offset of shape from the upper left corner in units of 1/4000 of the chart area.
    height - Represents the height of shape, in units of 1/4000 of the chart area.
    width - Represents the width of shape, in units of 1/4000 of the chart area.
    
    Returns:
    Returns a Shape object that represents the new WordArt object.
  - addTextEffect
```
public Shape addTextEffect(int effect,
                  java.lang.String text,
                  java.lang.String fontName,
                  int size,
                  boolean fontBold,
                  boolean fontItalic,
                  int upperLeftRow,
                  int top,
                  int upperLeftColumn,
                  int left,
                  int height,
                  int width)
```
    Inserts a WordArt object.
    Example
```
 
         //add a WordArt
         Shape wordArt1 = shapes.addTextEffect(MsoPresetTextEffect.TEXT_EFFECT_10, "WordArt", "arial", 18, false, false, 3, 0, 3, 0, 200, 50);
 
```
    Parameters:
    effect - MsoPresetTextEffect. The mso preset text effect type.
    text - The WordArt text.
    fontName - The font name.
    size - The font size
    fontBold - Indicates whether font is bold.
    fontItalic - Indicates whether font is italic.
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of shape from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of shape from its left column, in unit of pixel.
    height - Represents the height of shape, in unit of pixel.
    width - Represents the width of shape, in unit of pixel.
    
    Returns:
    Returns a Shape object that represents the new WordArt object.
  - addWordArt
```
public Shape addWordArt(int style,
               java.lang.String text,
               int upperLeftRow,
               int top,
               int upperLeftColumn,
               int left,
               int height,
               int width)
```
    Adds preset WordArt since Excel 2007.s
    Example
```
 
         //add a WordArt
         Shape wordArt2 = shapes.addWordArt(PresetWordArtStyle.WORD_ART_STYLE_1, "WordArt", 3, 0, 3, 0, 50, 200);
 
```
    Parameters:
    style - PresetWordArtStyle. The preset WordArt Style.
    text - The text.
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of shape from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of shape from its left column, in unit of pixel.
    height - Represents the height of shape, in unit of pixel.
    width - Represents the width of shape, in unit of pixel.
    
    Returns:
  - addRectangle
```
public RectangleShape addRectangle(int upperLeftRow,
                          int top,
                          int upperLeftColumn,
                          int left,
                          int height,
                          int width)
```
    Adds a RectangleShape to the worksheet.
    Example
```
 
         // add a rectangle
         RectangleShape rectangleShape = shapes.addRectangle(2, 0, 2, 0, 130, 130);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of RectangleShape from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of RectangleShape from its left column, in unit of pixel.
    height - Represents the height of RectangleShape, in unit of pixel.
    width - Represents the width of RectangleShape, in unit of pixel.
    
    Returns:
    A RectangleShape object.
  - addOval
```
public Oval addOval(int upperLeftRow,
           int top,
           int upperLeftColumn,
           int left,
           int height,
           int width)
```
    Adds a Oval to the worksheet.
    Example
```
 
         //add a oval
         Oval oval = shapes.addOval(1, 0, 1, 0, 50, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of Oval from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of Oval from its left column, in unit of pixel.
    height - Represents the height of Oval, in unit of pixel.
    width - Represents the width of Oval, in unit of pixel.
    
    Returns:
    A Oval object.
  - addLine
```
public LineShape addLine(int upperLeftRow,
                int top,
                int upperLeftColumn,
                int left,
                int height,
                int width)
```
    Adds a LineShape to the worksheet.
    Example
```
 
         // add a line object
         LineShape lineShape = shapes.addLine(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of LineShape from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of LineShape from its left column, in unit of pixel.
    height - Represents the height of LineShape, in unit of pixel.
    width - Represents the width of LineShape, in unit of pixel.
    
    Returns:
    A LineShape object.
  - addFreeFloatingShape
```
public Shape addFreeFloatingShape(int type,
                         int top,
                         int left,
                         int height,
                         int width,
                         byte[] imageData,
                         boolean isOriginalSize)
```
    Adds a free floating shape to the worksheet.Only applies for line/image shape.
    Example
```
 
         //add a line
         Shape floatingShape_Line = shapes.addFreeFloatingShape(MsoDrawingType.LINE, 100, 100, 100, 50, null, false);
         //add a picture
         byte[] imageData = null;
         FileInputStream fs = new FileInputStream("image.jpg");
         try //JAVA: was using
         {
             int len = (int)fs.available();
             imageData = new byte[len];
             fs.read(imageData, 0, len);
         }
         finally { if (fs != null) fs.close(); }
         Shape floatingShape_Picture = shapes.addFreeFloatingShape(MsoDrawingType.PICTURE, 200, 100, 100, 50, imageData, false);
 
```
    Parameters:
    type - MsoDrawingType. The shape type.
    top - Represents the vertical offset of shape from the worksheet's top row, in unit of pixel.
    left - Represents the horizontal offset of shape from the worksheet's left column, in unit of pixel.
    height - Represents the height of LineShape, in unit of pixel.
    width - Represents the width of LineShape, in unit of pixel.
    imageData - The image data,only applies for the picture.
    isOriginalSize - Whether the shape use original size if the shape is image.
    
    Returns:
  - addShapeInChart
```
public Shape addShapeInChart(int type,
                    int placement,
                    int left,
                    int top,
                    int right,
                    int bottom,
                    byte[] imageData)
```
    Add a shape to chart .All unit is 1/4000 of chart area.
    
    Parameters:
    type - MsoDrawingType. The drawing type.
    placement - PlacementType. the placement type.
    left - In unit of 1/4000 chart area width.
    top - In unit of 1/4000 chart area height.
    right - In unit of 1/4000 chart area width.
    bottom - In unit of 1/4000 chart area height.
    imageData - If the shape is not a picture or ole object,imageData should be null.
  - addShapeInChart
```
public Shape addShapeInChart(int type,
                    int placement,
                    int left,
                    int top,
                    int right,
                    int bottom)
```
    Add a shape to chart .All unit is 1/4000 of chart area.
    
    Parameters:
    type - MsoDrawingType. The drawing type.
    placement - PlacementType. the placement type.
    left - In unit of 1/4000 chart area width.
    top - In unit of 1/4000 chart area height.
    right - In unit of 1/4000 chart area width.
    bottom - In unit of 1/4000 chart area height.
  - addShapeInChartByScale
```
public Shape addShapeInChartByScale(int type,
                           int placement,
                           double left,
                           double top,
                           double right,
                           double bottom)
```
    Add a shape to chart. All unit is percent scale of chart area.
    
    Parameters:
    type - MsoDrawingType. The drawing type.
    placement - PlacementType. the placement type.
    left - Unit is percent scale of chart area width.
    top - Unit is percent scale of chart area height.
    right - Unit is percent scale of chart area width.
    bottom - Unit is percent scale of chart area height.
  - addShapeInChartByScale
```
public Shape addShapeInChartByScale(int type,
                           int placement,
                           double left,
                           double top,
                           double right,
                           double bottom,
                           byte[] imageData)
```
    Add a shape to chart .All unit is 1/4000 of chart area.
    
    Parameters:
    type - MsoDrawingType. The drawing type.
    placement - PlacementType. the placement type.
    left - Unit is percent scale of chart area width.
    top - Unit is percent scale of chart area height.
    right - Unit is percent scale of chart area width.
    bottom - Unit is percent scale of chart area height.
    imageData - If the shape is not a picture or ole object,imageData should be null.
  - addArc
```
public ArcShape addArc(int upperLeftRow,
              int top,
              int upperLeftColumn,
              int left,
              int height,
              int width)
```
    Adds a ArcShape to the worksheet.
    Example
```
 
         //add a arc
         ArcShape arcShape = shapes.addArc(1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of ArcShape from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of ArcShape from its left column, in unit of pixel.
    height - Represents the height of ArcShape, in unit of pixel.
    width - Represents the width of ArcShape, in unit of pixel.
    
    Returns:
    A ArcShape object.
  - addShape
```
public Shape addShape(int type,
             int upperLeftRow,
             int top,
             int upperLeftColumn,
             int left,
             int height,
             int width)
```
    Adds a Shape to the worksheet.
    Remarks
    The type could not be Chart/Comment/Picture/OleObject/Polygon/DialogBox
    Example
```
 
         //Add a shape of the specified type
         Shape shapeByType = shapes.addShape(MsoDrawingType.CELLS_DRAWING, 1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    type - MsoDrawingType. Mso drawing type.
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of Shape from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of Shape from its left column, in unit of pixel.
    height - Represents the height of Shape, in unit of pixel.
    width - Represents the width of Shape, in unit of pixel.
    
    Returns:
    A Shape object.
  - addAutoShape
```
public Shape addAutoShape(int type,
                 int upperLeftRow,
                 int top,
                 int upperLeftColumn,
                 int left,
                 int height,
                 int width)
```
    Adds a AutoShape to the worksheet.
    Remarks
    The type could not be Chart/Comment/Picture/OleObject/Polygon/DialogBox
    Example
```
 
         //Adds a AutoShape to the worksheet.
         Shape autoShape = shapes.addAutoShape(AutoShapeType.CUBE, 1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    type - AutoShapeType. Auto shape type.
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of Shape from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of Shape from its left column, in unit of pixel.
    height - Represents the height of Shape, in unit of pixel.
    width - Represents the width of Shape, in unit of pixel.
    
    Returns:
    A Shape object.
  - addAutoShapeInChart
```
public Shape addAutoShapeInChart(int type,
                        int top,
                        int left,
                        int height,
                        int width)
```
    Adds a AutoShape to the chart.
    Remarks
    The type could not be Chart/Comment/Picture/OleObject/Polygon/DialogBox
    
    Parameters:
    type - AutoShapeType. Auto shape type.
    top - Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area.
    left - Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area.
    height - Represents the height of textbox, in units of 1/4000 of the chart area.
    width - Represents the width of textbox, in units of 1/4000 of the chart area.
    
    Returns:
    Returns a shape object.
  - addActiveXControl
```
public Shape addActiveXControl(int type,
                      int topRow,
                      int top,
                      int leftColumn,
                      int left,
                      int width,
                      int height)
```
    Creates an Activex Control.
    Example
```
 
         //add an ActiveX control
         Shape activeXControl = shapes.addActiveXControl(com.aspose.cells.ControlType.CHECK_BOX, 1, 0, 1, 0, 100, 50);
 
```
    Parameters:
    type - ControlType. The type of the control.
    topRow - Upper left row index.
    top - Represents the vertical offset of Shape from its left row, in unit of pixel.
    leftColumn - Upper left column index.
    left - Represents the horizontal offset of Shape from its left column, in unit of pixel.
    height - Represents the height of Shape, in unit of pixel.
    width - Represents the width of Shape, in unit of pixel.
    
    Returns:
  - addPicture
```
public Picture addPicture(int upperLeftRow,
                 int upperLeftColumn,
                 int lowerRightRow,
                 int lowerRightColumn,
                 java.io.InputStream stream)
```
    Adds a picture to the collection.
    
    Parameters:
    upperLeftRow - Upper left row index.
    upperLeftColumn - Upper left column index.
    lowerRightRow - Lower right row index
    lowerRightColumn - Lower right column index
    stream - Stream object which contains the image data.
    
    Returns:
    Picture Picture object.
  - addPicture
```
public Picture addPicture(int upperLeftRow,
                 int upperLeftColumn,
                 java.io.InputStream stream,
                 int widthScale,
                 int heightScale)
```
    Adds a picture to the collection.
    
    Parameters:
    upperLeftRow - Upper left row index.
    upperLeftColumn - Upper left column index.
    stream - Stream object which contains the image data.
    widthScale - Scale of image width, a percentage.
    heightScale - Scale of image height, a percentage.
    
    Returns:
    Picture Picture object.
  - addSvg
```
public Picture addSvg(int upperLeftRow,
             int top,
             int upperLeftColumn,
             int left,
             int height,
             int width,
             byte[] svgData,
             byte[] compatibleImageData)
```
    Adds svg image.
    Example
```
 
         // add a svg
         FileInputStream fs = new FileInputStream("image.svg");
         try //JAVA: was using
         {
             int len = (int)fs.available();
             byte[] imageData = new byte[len];
             fs.read(imageData, 0, len);
             Picture picture = shapes.addSvg(4, 0, 5, 0, -1, -1, imageData, null);
         }
         finally { if (fs != null) fs.close(); }
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of shape from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - The horizontal offset of shape from its left column, in unit of pixel.
    height - The height of shape, in unit of pixel.
    width - The width of shape, in unit of pixel.
    svgData - The svg image data.
    compatibleImageData - Converted image data from svg in order to be compatible with Excel 2016 or lower versions.
    
    Returns:
  - addIcons
```
public Picture addIcons(int upperLeftRow,
               int top,
               int upperLeftColumn,
               int left,
               int height,
               int width,
               byte[] imageByteData,
               byte[] compatibleImageData)
```
    Adds svg image.
    Example
```
 
         //add icon
         FileInputStream fs = new FileInputStream("icon.svg");
         try //JAVA: was using
         {
             int len = (int)fs.available();
             byte[] imageData = new byte[len];
             fs.read(imageData, 0, len);
             Picture picture = shapes.addIcons(4, 0, 5, 0, -1, -1, imageData, null);
         }
         finally { if (fs != null) fs.close(); }
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of shape from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - The horizontal offset of shape from its left column, in unit of pixel.
    height - The height of shape, in unit of pixel.
    width - The width of shape, in unit of pixel.
    imageByteData - The image byte data.
    compatibleImageData - Converted image data from svg in order to be compatible with Excel 2016 or lower versions.
    
    Returns:
  - addLinkedPicture
```
public Picture addLinkedPicture(int upperLeftRow,
                       int upperLeftColumn,
                       int height,
                       int width,
                       java.lang.String sourceFullName)
```
    Add a linked picture.
    
    Parameters:
    upperLeftRow - Upper left row index.
    upperLeftColumn - Upper left column index.
    height - The height of the shape. In unit of pixels
    width - The width of the shape. In unit of pixels
    sourceFullName - The path and name of the source file for the linked image
    
    Returns:
    Picture Picture object.
  - addOleObjectWithLinkedImage
```
public OleObject addOleObjectWithLinkedImage(int upperLeftRow,
                                    int upperLeftColumn,
                                    int height,
                                    int width,
                                    java.lang.String sourceFullName)
```
    Add a linked picture.
    
    Parameters:
    upperLeftRow - Upper left row index.
    upperLeftColumn - Upper left column index.
    height - The height of the shape. In unit of pixels
    width - The width of the shape. In unit of pixels
    sourceFullName - The path and name of the source file for the linked image
    
    Returns:
    Picture Picture object.
  - addPictureInChart
```
public Picture addPictureInChart(int top,
                        int left,
                        java.io.InputStream stream,
                        int widthScale,
                        int heightScale)
```
    Adds a picture to the chart.
    
    Parameters:
    top - Represents the vertical offset of shape from the upper left corner in units of 1/4000 of the chart area.
    left - Represents the horizontal offset of shape from the upper left corner in units of 1/4000 of the chart area.
    stream - Stream object which contains the image data.
    widthScale - Scale of image width, a percentage.
    heightScale - Scale of image height, a percentage.
    
    Returns:
    Returns a Picture object.
  - addOleObject
```
public OleObject addOleObject(int upperLeftRow,
                     int top,
                     int upperLeftColumn,
                     int left,
                     int height,
                     int width,
                     byte[] imageData)
```
    Adds an OleObject.
    Example
```
 
         FileInputStream fs = new FileInputStream("image.jpg");
         try //JAVA: was using
         {
             int len = (int)fs.available();
             byte[] imageData = new byte[len];
             fs.read(imageData, 0, len);
             OleObject oleObject = shapes.addOleObject(4, 0, 5, 0, 300, 500, imageData);
         }
         finally { if (fs != null) fs.close(); }
 
```
    Parameters:
    upperLeftRow -
    top -
    upperLeftColumn -
    left -
    height -
    width -
    imageData -
    
    Returns:
  - copyCommentsInRange
```
public void copyCommentsInRange(ShapeCollection shapes,
                       CellArea ca,
                       int destRow,
                       int destColumn)
```
    Copy all comments in the range.
    Example
```
 
         CommentCollection comments = workbook.getWorksheets().get(0).getComments();
 
         //Add comment to cell A1
         int commentIndex = comments.add(0, 0);
         Comment comment = comments.get(commentIndex);
         comment.setNote("First note.");
         comment.getFont().setName("Times New Roman");
 
         //Add comment to cell B2
         comments.add("B2");
         comment = comments.get("B2");
         comment.setNote("Second note.");
 
         CellArea area1 = new CellArea();
         area1.StartColumn = 1;
         area1.StartRow = 1;
         area1.EndColumn = 5;
         area1.EndRow = 4;
 
         //copy
         shapes.copyCommentsInRange(shapes, area1, 5, 1);
 
```
    Parameters:
    shapes - The source shapes.
    ca - The source range.
    destRow - The dest range start row.
    destColumn - The dest range start column.
  - copyInRange
```
public void copyInRange(ShapeCollection sourceShapes,
               CellArea ca,
               int destRow,
               int destColumn,
               boolean isContained)
```
    Copy shapes in the range to destination range.
    Example
```
 
         //add a shape
         shapes.addRectangle(2, 0, 2, 0, 130, 130);
         CellArea area2 = new CellArea();
         area2.StartColumn = 1;
         area2.StartRow = 1;
         area2.EndColumn = 5;
         area2.EndRow = 11;
 
         //copy
         shapes.copyInRange(shapes, area2, 12, 1, false);
 
```
    Parameters:
    sourceShapes - Source shapes.
    ca - The source range.
    destRow - The dest row index of the dest range.
    destColumn - The dest column of the dest range.
    isContained - Whether only copy the shapes which are contained in the range. If true,only copies the shapes in the range. Otherwise,it works as MS Office.
  - deleteInRange
```
public void deleteInRange(CellArea ca)
```
    Delete shapes in the range.Comment shapes will not be deleted.
    Example
```
 
         //add first shape
         shapes.addRectangle(2, 0, 2, 0, 50, 50);
         //add second shape
         shapes.addRectangle(6, 0, 2, 0, 30, 30);
 
         CellArea area3 = new CellArea();
         area3.StartColumn = 0;
         area3.StartRow = 5;
         area3.EndColumn = 5;
         area3.EndRow = 8;
 
         //del
         shapes.deleteInRange(area3);
 
```
    Parameters:
    ca - The range.If the shapes are contained in the range, they will be removed.
  - deleteShape
```
public void deleteShape(Shape shape)
```
    Delete a shape. If the shape is in the group or is a comment shape, it will not be deleted.
    Example
```
 
         //add first shape
         Shape firstShape = shapes.addRectangle(2, 0, 2, 0, 50, 50);
         //add second shape
         Shape secondShape = shapes.addRectangle(6, 0, 2, 0, 30, 30);
         //del
         shapes.deleteShape(firstShape);
 
```
    Parameters:
    shape -
  - group
```
public GroupShape group(Shape[] groupItems)
```
    Group the shapes.
    Remarks
    The shape in the groupItems should not be grouped. The shape must be in this Shapes collection.
    Example
```
 
         //add first shape
         shapes.addRectangle(2, 0, 2, 0, 50, 50);
         //add second shape
         shapes.addRectangle(6, 0, 2, 0, 30, 30);
 
         Shape[] shapesArr = new Shape[] { shapes.get(0), shapes.get(1) };
         GroupShape groupShape = shapes.group(shapesArr);
 
```
    Parameters:
    groupItems - the group items.
    
    Returns:
    Return the group shape.
  - ungroup
```
public void ungroup(GroupShape group)
```
    Ungroups the shape items.
    Remarks
    If the group shape is grouped by another group shape,nothing will be done.
    Example
```
 
         //add first shape
         shapes.addRectangle(2, 0, 2, 0, 50, 50);
         //add second shape
         shapes.addRectangle(6, 0, 2, 0, 30, 30);
 
         //group
         Shape[] shapesArr = new Shape[] { shapes.get(0), shapes.get(1) };
         GroupShape groupShape = shapes.group(shapesArr);
 
         //ungroup
         shapes.ungroup(groupShape);
 
```
    Parameters:
    group - The group shape.
  - removeAt
```
public void removeAt(int index)
```
    Remove the shape.
    Example
```
 
         //add first shape
         shapes.addRectangle(2, 0, 2, 0, 50, 50);
         //add second shape
         shapes.addRectangle(6, 0, 2, 0, 30, 30);
 
         //remove 
         shapes.removeAt(0);
 
```
    Overrides:
    
    removeAt in class CollectionBase
    
    Parameters:
    index - The index of the shape.
  - remove
```
public void remove(Shape shape)
```
    Remove the shape.
    Example
```
 
         //add first shape
         shapes.addRectangle(2, 0, 2, 0, 50, 50);
         //add second shape
         shapes.addRectangle(6, 0, 2, 0, 30, 30);
 
         //get the shape
         Shape s = shapes.get("Rectangle 1");// or shapes[0];
         if (s != null)
         {
             //remove 
             shapes.remove(s);
         }
 
```
    Parameters:
    shape -
  - clear
```
public void clear()
```
    Clear all shapes in the worksheet.
    Example
```
 
         if (shapes.getCount() > 0)
         {
             shapes.clear();
         }
 
```
    Overrides:
    
    clear in class CollectionBase
  - updateSelectedValue
```
public void updateSelectedValue()
```
    Update the selected value by the value of the linked cell or range of the shape.
  - addFreeform
```
public Shape addFreeform(int upperLeftRow,
                int top,
                int upperLeftColumn,
                int left,
                int height,
                int width,
                ShapePath[] paths)
```
    Adds a freeform shape to the worksheet.
    Remarks
    Notice: That the width and height in the parameters can be any positive integer values, not the total width and height of the ShapePath array specified by 鈥檖aths'. The relationship between them is a scale-fill relationship, that is, each ShapePath object will be scaled according to the width and height. Therefore, when there are multiple objects in the 'paths', each ShapePath object needs to be designed reasonably to meet expectations. When there is only one ShapePath object and there are no other requirements, passing the object's width and height as parameter values 鈥嬧€媔s a good solution.
    Example
```
 
         //Custom figure
         ShapePath shapePath = new ShapePath();
         shapePath.moveTo(60, 45);
         shapePath.arcTo(25, 25, 0, 270);
         shapePath.close();
 
         shapePath.moveTo(60, 20);
         shapePath.lineTo(110, 70);
         shapePath.lineTo(125, 155.5f);
         shapePath.arcTo(35.5f, 35.5f, 0, 270);
         shapePath.close();
 
         shapePath.moveTo(150, 45);
         shapePath.arcTo(25, 25, 0, 270);
 
         int shapePathW = shapePath.getWidthPixel();
         int shapePathH = shapePath.getHeightPixel();
 
         ShapePath shapePath1 = new ShapePath();
         shapePath1.moveTo(0, 0);
         shapePath1.cubicBezierTo(48.24997f, 0.6844f,
                             96.5f, -7.148871f,
                             130, 11.517795f);
         shapePath1.cubicBezierTo(163.5f, 30.18446f,
                             182.24997f, 75.351f,
                             201, 120.517795f);
         shapePath1.moveTo(150, 80);
         shapePath1.arcTo(25, 25, 0, 270);
 
         if (shapePath1.getWidthPixel() > shapePathW)
             {
         shapePathW = shapePath1.getWidthPixel();
         }
 
         if (shapePath1.getHeightPixel() > shapePathH)
         {
         shapePathH = shapePath1.getHeightPixel();
         }
 
         //Notice: shapePathH and shapePathH can be any positive integer values, here we just simply set them.
 
         //Insert custom figure into worksheet
         shapes.addFreeform(1, 0, 1, 0, shapePathH, shapePathW, new ShapePath[] { shapePath, shapePath1});
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    top - Represents the vertical offset of freeform shape from its left row, in unit of pixel.
    upperLeftColumn - Upper left column index.
    left - Represents the horizontal offset of freeform shape from its left column, in unit of pixel.
    height - Represents the height of freeform shape, in unit of pixel.
    width - Represents the width of freeform shape, in unit of pixel.
    paths - Represents a user-defined path
    
    Returns:
    A freeform shape.
  - addSignatureLine
```
public Picture addSignatureLine(int upperLeftRow,
                       int upperLeftColumn,
                       SignatureLine signatureLine)
```
    Adds a Signature Line to the worksheet.
    Example
```
 
         SignatureLine wSignatureLine = new SignatureLine();
         wSignatureLine.setAllowComments(true);
         wSignatureLine.setEmail("example@example.com");
         wSignatureLine.setInstructions("Sign to confirm the excel content.");
         wSignatureLine.setLine(true);
         wSignatureLine.setShowSignedDate(true);
         wSignatureLine.setSigner("User");
         wSignatureLine.setTitle("tester");
         //wSignatureLine.SignatureLineType = SignatureType.Stamp;
         Picture signatureLine1 = shapes.addSignatureLine(0, 0, wSignatureLine);
 
```
    Parameters:
    upperLeftRow - Upper left row index.
    upperLeftColumn - Upper left column index.
    signatureLine - Represents a signature line object.
    
    Returns:

Class ShapeCollection

Method Summary

Methods inherited from class com.aspose.cells.CollectionBase

Methods inherited from class java.lang.Object

Method Detail

get

get

addCopy

addCheckBox

addTextBox

addEquation

addSpinner

addScrollBar

addRadioButton

addListBox

addComboBox

addGroupBox

addButton

addLabel

addLabelInChart

addTextBoxInChart

addTextEffectInChart

addTextEffect

addWordArt

addRectangle

addOval

addLine

addFreeFloatingShape

addShapeInChart

addShapeInChart

addShapeInChartByScale

addShapeInChartByScale

addArc

addShape

addAutoShape

addAutoShapeInChart

addActiveXControl

addPicture

addPicture

addSvg

addIcons

addLinkedPicture

addOleObjectWithLinkedImage

addPictureInChart

addOleObject

copyCommentsInRange

copyInRange

deleteInRange

deleteShape

group

ungroup

removeAt

remove

clear

updateSelectedValue

addFreeform

addSignatureLine