From d0ab48c82279d365d71a71546c3aea07675ae09d Mon Sep 17 00:00:00 2001 From: J-January <42738188+J-January@users.noreply.github.com> Date: Wed, 9 Jan 2019 11:08:23 +0800 Subject: [PATCH 1/3] Update ShapeCollection.AddGeometricShape Update the parameters. --- reference/excel/shapecollection.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/reference/excel/shapecollection.md b/reference/excel/shapecollection.md index e956f7c54..62cdd7abe 100644 --- a/reference/excel/shapecollection.md +++ b/reference/excel/shapecollection.md @@ -18,7 +18,7 @@ None | Method | Return Type |Description| Req. Set| |:---------------|:--------|:----------|:----| -|[addGeometricShape(geometricShapeType: string, left: double, top: double, width: double, height: double)](#addgeometricshapegeometricshapetype-string-left-double-top-double-width-double-height-double)|[Shape](shape.md)|Adds a geometric shape to worksheet. Returns a Shape object that represents the new shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)| +|[addGeometricShape(geometricShapeType: string)](#addgeometricshapegeometricshapetype-string)|[Shape](shape.md)|Adds a geometric shape to worksheet. Returns a Shape object that represents the new shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |[addGroup(values: ()[])](#addgroupvalues-)|[Shape](shape.md)|Group a subset of shapes in a worksheet. Returns a Shape object that represents the new group of shapes.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |[addImage(base64ImageString: string)](#addimagebase64imagestring-string)|[Shape](shape.md)|Creates an image from a base64 string and adds it to worksheet. Returns the Shape object that represents the new Image.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |[addLine(startLeft: double, startTop: double, endLeft: double, endTop: double, connectorType: string)](#addlinestartleft-double-starttop-double-endleft-double-endtop-double-connectortype-string)|[Shape](shape.md)|Adds a line to worksheet. Returns a Shape object that represents the new line.|[beta](../requirement-sets/excel-api-requirement-sets.md)| @@ -32,22 +32,18 @@ None ## Method Details -### addGeometricShape(geometricShapeType: string, left: double, top: double, width: double, height: double) +### addGeometricShape(geometricShapeType: string) Adds a geometric shape to worksheet. Returns a Shape object that represents the new shape. #### Syntax ```js -shapeCollectionObject.addGeometricShape(geometricShapeType, left, top, width, height); +shapeCollectionObject.addGeometricShape(geometricShapeType); ``` #### Parameters | Parameter | Type |Description| |:---------------|:--------|:----------| |geometricShapeType|string|Represents the geometric type of the shape.| -|left|double|The distance, in points, from the left side of the shape to the left side of the worksheet.| -|top|double| The distance, in points, from the top edge of the shape to the top of the worksheet.| -|width|double|The width, in points, of the shape.| -|height|double|The height, in points, of the shape.| #### Returns [Shape](shape.md) From e7cc21fc0987ce6ecdda76def34b3720fb7fafee Mon Sep 17 00:00:00 2001 From: J-January <42738188+J-January@users.noreply.github.com> Date: Wed, 9 Jan 2019 14:46:42 +0800 Subject: [PATCH 2/3] Update shape.md Fix typo --- reference/excel/shape.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/excel/shape.md b/reference/excel/shape.md index 98c313bea..7f8a20826 100644 --- a/reference/excel/shape.md +++ b/reference/excel/shape.md @@ -11,12 +11,12 @@ Represents a generic shape object in the worksheet. |height|double|Represents the height, in points, of the shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |id|string|Represents the shape identifier. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |left|double|The distance, in points, from the left side of the shape to the left of the worksheet.|[beta](../requirement-sets/excel-api-requirement-sets.md)| -|level{|int|Represents the level of the specified shape. Level 0 means the shape is not part of any group, level 1 means the shape is part of a top-level group, etc. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| +|level|int|Represents the level of the specified shape. Level 0 means the shape is not part of any group, level 1 means the shape is part of a top-level group, etc. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |lockAspectRatio|bool|Represents if the aspect ratio locked, in boolean, of the shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |name|string|Represents the name of the shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |rotation|int|Represents the rotation, in degrees, of the shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |top|double|The distance, in points, from the top edge of the shape to the top of the worksheet.|[beta](../requirement-sets/excel-api-requirement-sets.md)| -|visible{|bool|Represents the visibility, in boolean, of the specified shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)| +|visible|bool|Represents the visibility, in boolean, of the specified shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |width|double|Represents the width, in points, of the shape.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |zOrderPosition|int|Returns the position of the specified shape in the z-order, the very bottom shape's z-order value is 0. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| @@ -32,7 +32,7 @@ _See property access [examples.](#property-access-examples)_ |image|[Image](image.md)|Returns the image for the shape object. Error will be thrown, if the shape object is other shape type (Like, GeometricShape, SmartArt, etc.) rather than Image. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |line|[Line](line.md)|Returns the line object for the shape object. Error will be thrown, if the shape object is other shape type (Like, GeometricShape, SmartArt, etc.) rather than Image. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |lineFormat|[ShapeLineFormat](shapelineformat.md)|Returns the line formatting of the shape object. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| -|parentGroup{|[Shape](shape.md)|Represents the parent group of the specified shape. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| +|parentGroup|[Shape](shape.md)|Represents the parent group of the specified shape. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |placement|[Placement](placement.md)|Represents the placment, value that represents the way the object is attached to the cells below it.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |textFrame|[TextFrame](textframe.md)|Returns the textFrame object of a shape. Read only. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |type|string|Returns the type of the specified shape. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| From f7b44a5a8bb88446162674bee80d776f45c3991c Mon Sep 17 00:00:00 2001 From: J-January <42738188+J-January@users.noreply.github.com> Date: Wed, 9 Jan 2019 14:49:10 +0800 Subject: [PATCH 3/3] Update textframe.md Update TextRange comments. --- reference/excel/textframe.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/excel/textframe.md b/reference/excel/textframe.md index dd4b1a4da..eac68757c 100644 --- a/reference/excel/textframe.md +++ b/reference/excel/textframe.md @@ -22,7 +22,7 @@ _See property access [examples.](#property-access-examples)_ |horizontalOverflow|[ShapeTextHorzOverflowType](shapetexthorzoverflowtype.md)|Represents the horizontal overflow type of the text frame.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |orientation|[ShapeTextOrientationType](shapetextorientationtype.md)|Represents the text orientation of the text frame.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |readingOrder|[ShapeTextReadingOrder](shapetextreadingorder.md)|Represents the reading order of the text frame, RTL or LTR.|[beta](../requirement-sets/excel-api-requirement-sets.md)| -|textRange|[TextRange](textrange.md)|Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). For API not supported shape types or special fill type with inconsistent transparencies, return null. For example, gradient fill type could have inconsistent transparencies. Read-only.|[beta](../requirement-sets/excel-api-requirement-sets.md)| +|textRange|[TextRange](textrange.md)|Represents the text range in the text frame.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |verticalAlignment|[ShapeTextVerticalAlignType](shapetextverticalaligntype.md)|Represents the vertical alignment of the text frame.|[beta](../requirement-sets/excel-api-requirement-sets.md)| |verticalOverflow|[ShapeTextVertOverflowType](shapetextvertoverflowtype.md)|Represents the vertical overflow type of the text frame.|[beta](../requirement-sets/excel-api-requirement-sets.md)|