[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

IShapes

Interface IShapes

All Superinterfaces:
Iterable<IShape>
public interface IShapes extends Iterable<IShape>
A collection of all the IShape objects on the specified sheet.

  • Method Details

    • getRange

      IShapeRange getRange(String[] index)
      Returns a ShapeRange object that represents a subset of the shapes in a Shapes collection.

    • getRange

      IShapeRange getRange(int[] index)
      Returns a ShapeRange object that represents a subset of the shapes in a Shapes collection.

    • get

      IShape get(int index)
      Returns a single object from a collection.
      Parameters:
      index - Required int. The index number for the object.

    • get

      IShape get(String name)
      Returns a single object from a collection.
      Parameters:
      name - Required string. The name for the object.

    • getCount

      int getCount()
      Returns the number of objects in the collection.

    • addChart

      IShape addChart(ChartType chartType, double left, double top, double width, double height)
      Creates a chart at the specified location on the active sheet.
      Parameters:
      chartType - The chart type
      left - The distance, in points, from the left edge of the object to theleft edge of column A (on a worksheet) or the left edge of the chart area (on a chart).
      top - The distance, in points, from the top edge of the top most shapein the shape range to the top edge of the worksheet.
      width - The width, in points, of the object
      height - The height, in points, of the object
      Returns:
      The IShape object.

    • addChart

      IShape addChart(ChartType chartType, IRange range)
      Creates a chart at the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Parameters:
      chartType - The chart type
      range - The target range of the current sheet.
      Returns:
      The IShape object.

    • addChart

      IShape addChart(String name, ChartType chartType, double left, double top, double width, double height)
      Creates a chart at the specified location on the active sheet.
      Parameters:
      name - * The chart name
      chartType - The chart type
      left - The distance, in points, from the left edge of the object to theleft edge of column A (on a worksheet) or the left edge of the chart area (on a chart).
      top - The distance, in points, from the top edge of the top most shapein the shape range to the top edge of the worksheet.
      width - The width, in points, of the object
      height - The height, in points, of the object
      Returns:
      The IShape object.

    • addChart

      IShape addChart(String name, ChartType chartType, IRange range)
      Creates a chart at the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Parameters:
      name - * The chart name
      chartType - The chart type
      range - The target range of the current sheet.

    • addPicture

      IShape addPicture(String filename, double left, double top, double width, double height) throws IOException
      Creates a picture from an existing file. Returns the IShape objectthat represents the new picture.
      Parameters:
      filename - The file from which the object is to be created
      left - The position (in points) of the upper-left corner of the picturerelative to the upper-left corner of the document.
      top - The position (in points) of the upper-left corner of the picturerelative to the top of the document.
      width - The width of the picture, in points.
      height - The height of the picture, in points.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addPicture

      IShape addPicture(String filename, IRange range) throws IOException
      Creates a picture from an existing file at the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Returns the IShape object that represents the new picture.

      Parameters:
      filename - The file from which the object is to be created
      range - The target range of the current sheet.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addPicture

      IShape addPicture(String name, String filename, double left, double top, double width, double height) throws IOException
      Creates a picture from an existing file. Returns the IShape objectthat represents the new picture.
      Parameters:
      name - The picture name
      filename - The file from which the object is to be created
      left - The position (in points) of the upper-left corner of the picturerelative to the upper-left corner of the document.
      top - The position (in points) of the upper-left corner of the picturerelative to the top of the document.
      width - The width of the picture, in points.
      height - The height of the picture, in points.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addPicture

      IShape addPicture(String name, String filename, IRange range) throws IOException
      Creates a picture from an existing file at the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Returns the IShape object that represents the new picture.

      Parameters:
      name - The picture name
      filename - The file from which the object is to be created
      range - The target range of the current sheet.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addPicture

      IShape addPicture(InputStream stream, ImageType type, double left, double top, double width, double height) throws IOException
      Creates a picture from an existing stream. Returns the IShape objectthat represents the new picture.
      Parameters:
      stream - The stream from which the object is to be created.
      type - Specifies the type of picture to create.
      left - The position (in points) of the upper-left corner of the picturerelative to the upper-left corner of the document.
      top - The position (in points) of the upper-left corner of the picturerelative to the top of the document.
      width - The width of the picture, in points.
      height - The height of the picture, in points.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addPicture

      IShape addPicture(InputStream stream, ImageType type, IRange range) throws IOException
      Creates a picture from an existing stream at the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Returns the IShape object that represents the new picture.

      Parameters:
      stream - The stream from which the object is to be created.
      type - Specifies the type of picture to create.
      range - The target range of the current sheet.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addPicture

      IShape addPicture(String name, InputStream stream, ImageType type, double left, double top, double width, double height) throws IOException
      Creates a picture from an existing stream. Returns the IShape objectthat represents the new picture.
      Parameters:
      name - The picture name
      stream - The stream from which the object is to be created.
      type - Specifies the type of picture to create.
      left - The position (in points) of the upper-left corner of the picturerelative to the upper-left corner of the document.
      top - The position (in points) of the upper-left corner of the picturerelative to the top of the document.
      width - The width of the picture, in points.
      height - The height of the picture, in points.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addPicture

      IShape addPicture(String name, InputStream stream, ImageType type, IRange range) throws IOException
      Creates a picture from an existing stream at the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Returns the IShape object that represents the new picture.

      Parameters:
      name - The picture name
      stream - The stream from which the object is to be created.
      type - Specifies the type of picture to create.
      range - The target range of the current sheet.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addShape

      IShape addShape(AutoShapeType type, double left, double top, double width, double height)
      Returns the IShape object that represents the new AutoShape in aworksheet.
      Parameters:
      type - Specifies the type of AutoShape to create.
      left - The position (in points) of the upper-left corner of theAutoShape's boundary box relative to the upper-left corner of the document.
      top - The position (in points) of the upper-left corner of theAutoShape's boundary box relative to the upper-left corner of the document.
      width - The width and height of the AutoShape's boundary box, in points.
      height - The width and height of the AutoShape's boundary box, in points.
      Returns:
      The IShape object.

    • addShape

      IShape addShape(AutoShapeType type, IRange range)
      Returns the IShape object that represents the new AutoShapeat the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Parameters:
      type - Specifies the type of AutoShape to create.
      range - The target range of the current sheet.
      Returns:
      The IShape object.

    • addShape

      IShape addShape(String name, AutoShapeType type, double left, double top, double width, double height)
      Returns the IShape object that represents the new AutoShape in aworksheet.
      Parameters:
      name - The shape name
      type - Specifies the type of AutoShape to create.
      left - The position (in points) of the upper-left corner of theAutoShape's boundary box relative to the upper-left corner of the document.
      top - The position (in points) of the upper-left corner of theAutoShape's boundary box relative to the upper-left corner of the document.
      width - The width and height of the AutoShape's boundary box, in points.
      height - The width and height of the AutoShape's boundary box, in points.
      Returns:
      The IShape object.

    • addShape

      IShape addShape(String name, AutoShapeType type, IRange range)
      Returns the IShape object that represents the new AutoShapeat the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Parameters:
      name - The shape name
      type - Specifies the type of AutoShape to create.
      range - The target range of the current sheet.
      Returns:
      The IShape object.

    • addConnector

      IShape addConnector(ConnectorType type, double beginX, double beginY, double endX, double endY)
      Creates a connector. Returns the IShape object that represents thenew connector.
      Parameters:
      type - The connector type to add.
      beginX - The horizontal position (in points) of the connector's startingpoint relative to the upper-left corner of the document.
      beginY - The vertical position (in points) of the connector's startingpoint relative to the upper-left corner of the document.
      endX - The horizontal position (in points) of the connector's end pointrelative to the upper-left corner of the document.
      endY - The veritcal position (in points) of the connector's end pointrelative to the upper-left corner of the document.
      Returns:
      The IShape object.

    • addConnector

      IShape addConnector(ConnectorType type, IRange range)
      Creates a connector at the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Returns the IShape object that represents the new connector.

      Parameters:
      type - The connector type to add.
      range - The target range of the current sheet.
      Returns:
      The IShape object.

    • addConnector

      IShape addConnector(String name, ConnectorType type, double beginX, double beginY, double endX, double endY)
      Creates a connector. Returns the IShape object that represents thenew connector.
      Parameters:
      name - The connector name
      type - The connector type to add.
      beginX - The horizontal position (in points) of the connector's startingpoint relative to the upper-left corner of the document.
      beginY - The vertical position (in points) of the connector's startingpoint relative to the upper-left corner of the document.
      endX - The horizontal position (in points) of the connector's end pointrelative to the upper-left corner of the document.
      endY - The veritcal position (in points) of the connector's end pointrelative to the upper-left corner of the document.
      Returns:
      The IShape object.

    • addConnector

      IShape addConnector(String name, ConnectorType type, IRange range)
      Creates a connector at the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Returns the IShape object that represents the new connector.

      Parameters:
      name - The connector name
      type - The connector type to add.
      range - The target range of the current sheet.
      Returns:
      The IShape object.

    • addChartInPixel

      IShape addChartInPixel(ChartType chartType, double left, double top, double width, double height)
      Creates a chart at the specified location on the active sheet.
      Parameters:
      chartType - The chart type
      left - The distance, in pixels, from the left edge of the object to theleft edge of column A (on a worksheet) or the left edge of the chart area (on a chart).
      top - The distance, in pixels, from the top edge of the top most shape inthe shape range to the top edge of the worksheet.
      width - The width, in pixels, of the object
      height - The height, in pixels, of the object
      Returns:
      The IShape object.

    • addChartInPixel

      IShape addChartInPixel(String name, ChartType chartType, double left, double top, double width, double height)
      Creates a chart at the specified location on the active sheet.
      Parameters:
      name - The chart name
      chartType - The chart type
      left - The distance, in pixels, from the left edge of the object to theleft edge of column A (on a worksheet) or the left edge of the chart area (on a chart).
      top - The distance, in pixels, from the top edge of the top most shape inthe shape range to the top edge of the worksheet.
      width - The width, in pixels, of the object
      height - The height, in pixels, of the object
      Returns:
      The IShape object.

    • addPictureInPixel

      IShape addPictureInPixel(String filename, double left, double top, double width, double height) throws IOException
      Creates a picture from an existing file. Returns the IShape objectthat represents the new picture.
      Parameters:
      filename - The file from which the object is to be created
      left - The position (in pixels) of the upper-left corner of the picturerelative to the upper-left corner of the document.
      top - The position (in pixels) of the upper-left corner of the picturerelative to the top of the document.
      width - The width of the picture, in pixels.
      height - The height of the picture, in pixels.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addPictureInPixel

      IShape addPictureInPixel(String name, String filename, double left, double top, double width, double height) throws IOException
      Creates a picture from an existing file. Returns the IShape objectthat represents the new picture.
      Parameters:
      name - The picture name
      filename - The file from which the object is to be created
      left - The position (in pixels) of the upper-left corner of the picturerelative to the upper-left corner of the document.
      top - The position (in pixels) of the upper-left corner of the picturerelative to the top of the document.
      width - The width of the picture, in pixels.
      height - The height of the picture, in pixels.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addPictureInPixel

      IShape addPictureInPixel(InputStream stream, ImageType type, double left, double top, double width, double height) throws IOException
      Creates a picture from an existing stream. Returns the IShape objectthat represents the new picture.
      Parameters:
      stream - The stream from which the object is to be created.
      type - Specifies the type of picture to create.
      left - The position (in pixels) of the upper-left corner of the picturerelative to the upper-left corner of the document.
      top - The position (in pixels) of the upper-left corner of the picturerelative to the top of the document.
      width - The width of the picture, in pixels.
      height - The height of the picture, in pixels.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addPictureInPixel

      IShape addPictureInPixel(String name, InputStream stream, ImageType type, double left, double top, double width, double height) throws IOException
      Creates a picture from an existing stream. Returns the IShape objectthat represents the new picture.
      Parameters:
      name - The picture name
      stream - The stream from which the object is to be created.
      type - Specifies the type of picture to create.
      left - The position (in pixels) of the upper-left corner of the picturerelative to the upper-left corner of the document.
      top - The position (in pixels) of the upper-left corner of the picturerelative to the top of the document.
      width - The width of the picture, in pixels.
      height - The height of the picture, in pixels.
      Returns:
      The IShape object.
      Throws:
      IOException

    • addShapeInPixel

      IShape addShapeInPixel(AutoShapeType type, double left, double top, double width, double height)
      Returns the IShape object that represents the new AutoShape in aworksheet.
      Parameters:
      type - Specifies the type of AutoShape to create.
      left - The position (in pixels) of the upper-left corner of theAutoShape's boundary box relative to the upper-left corner of the document.
      top - The position (in pixels) of the upper-left corner of theAutoShape's boundary box relative to the upper-left corner of the document.
      width - The width and height of the AutoShape's boundary box, in pixels.
      height - The width and height of the AutoShape's boundary box, in pixels.
      Returns:
      The IShape object.

    • addShapeInPixel

      IShape addShapeInPixel(String name, AutoShapeType type, double left, double top, double width, double height)
      Returns the IShape object that represents the new AutoShape in aworksheet.
      Parameters:
      name - The shape name
      type - Specifies the type of AutoShape to create.
      left - The position (in pixels) of the upper-left corner of theAutoShape's boundary box relative to the upper-left corner of the document.
      top - The position (in pixels) of the upper-left corner of theAutoShape's boundary box relative to the upper-left corner of the document.
      width - The width and height of the AutoShape's boundary box, in pixels.
      height - The width and height of the AutoShape's boundary box, in pixels.
      Returns:
      The IShape object.

    • addConnectorInPixel

      IShape addConnectorInPixel(ConnectorType type, float beginX, float beginY, float endX, float endY)
      Creates a connector. Returns the IShape object that represents thenew connector.
      Parameters:
      type - The connector type to add.
      beginX - The horizontal position (in pixels) of the connector's startingpoint relative to the upper-left corner of the document.
      beginY - The vertical position (in pixels) of the connector's startingpoint relative to the upper-left corner of the document.
      endX - The horizontal position (in pixels) of the connector's end pointrelative to the upper-left corner of the document.
      endY - The veritcal position (in pixels) of the connector's end pointrelative to the upper-left corner of the document.
      Returns:
      The IShape object.

    • addConnectorInPixel

      IShape addConnectorInPixel(String name, ConnectorType type, float beginX, float beginY, float endX, float endY)
      Creates a connector. Returns the IShape object that represents thenew connector.
      Parameters:
      name - The connector name
      type - The connector type to add.
      beginX - The horizontal position (in pixels) of the connector's startingpoint relative to the upper-left corner of the document.
      beginY - The vertical position (in pixels) of the connector's startingpoint relative to the upper-left corner of the document.
      endX - The horizontal position (in pixels) of the connector's end pointrelative to the upper-left corner of the document.
      endY - The veritcal position (in pixels) of the connector's end pointrelative to the upper-left corner of the document.
      Returns:
      The IShape object.

    • addCameraPicture

      IShape addCameraPicture(String reference, double left, double top)
      Creates a picture from reference range. Returns the IShape object that represents the new picture.
      Parameters:
      reference - The range of the picture generated from
      left - The position (in points) of the upper-left cornerof the picture relative to the upper-left corner of the document.
      top - The position (in points) of the upper-left cornerof the picture relative to the top of the document.
      Returns:
      The IShape object.

    • addCameraPicture

      IShape addCameraPicture(String reference, double left, double top, double width, double height)
      Creates a picture from reference range. Returns the IShape object that represents the new picture.
      Parameters:
      reference - The range of the picture generated from
      left - The position (in points) of the upper-left cornerof the picture relative to the upper-left corner of the document.
      top - The position (in points) of the upper-left cornerof the picture relative to the top of the document.
      width - The width and height of the AutoShape's boundary box, in points.
      height - The width and height of the AutoShape's boundary box, in points.
      Returns:
      The IShape object.

    • addCameraPicture

      IShape addCameraPicture(String reference, IRange range)
      Creates a picture from reference range to the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Returns the IShape object that represents the new picture.

      Parameters:
      reference - The range of the picture generated from
      range - The target range of the current sheet.
      Returns:
      The IShape object.

    • addCameraPicture

      IShape addCameraPicture(String reference, String name, double left, double top)
      Creates a picture from reference range.Returns the IShape object that represents the new picture.
      Parameters:
      reference - The range of the picture generated from
      name - The picture name
      left - The position (in points) of the upper-left cornerof the picture relative to the upper-left corner of the document.
      top - The position (in points) of the upper-left cornerof the picture relative to the top of the document.
      Returns:
      The IShape object.

    • addCameraPicture

      IShape addCameraPicture(String reference, String name, double left, double top, double width, double height)
      Creates a picture from reference range.Returns the IShape object that represents the new picture.
      Parameters:
      reference - The range of the picture generated from
      name - The picture name
      left - The position (in points) of the upper-left cornerof the picture relative to the upper-left corner of the document.
      top - The position (in points) of the upper-left cornerof the picture relative to the top of the document.
      width - The width and height of the AutoShape's boundary box, in points.
      height - The width and height of the AutoShape's boundary box, in points.
      Returns:
      The IShape object.

    • addCameraPicture

      IShape addCameraPicture(String reference, String name, IRange range)
      Creates a picture from reference range to the specified range on the current sheet.

      The sheet of targetRange and the sheet of the shape being added must be the same sheet.

      Returns the IShape object that represents the new picture.

      Parameters:
      reference - The range of the picture generated from
      name - The picture name
      range - The target range of the current sheet.
      Returns:
      The IShape object.