Shape
Source: aspose.
Contains elements that define a shape in a Master, Page, or group shape element.
Methods
- toImageStream(shape, stream, options)
- toPdfStream(shape, stream)
- bringForward()
- bringToFront()
- centerDrawing()
- connectedShapes(flag, categoryFilter)
- convertToGroup()
- copy()
- dependsOnShapes()
- getActiveXControl()
- getActs()
- getAlign()
- getChars()
- getClippingPath()
- getConnectionABCDs()
- getConnections()
- getConnectorRule()
- getConnectorsType()
- getControlData()
- getControls()
- getData1()
- getData2()
- getData3()
- getDel()
- getDiagram()
- getDisplayText()
- getEvent()
- getFields()
- getFill()
- getFillStyle()
- getForeign()
- getForeignData()
- getGeoms()
- getGroup()
- getHelp()
- getHyperlinks()
- getID()
- getImage()
- getInheritChars()
- getInheritFill()
- getInheritGeoms()
- getInheritGroup()
- getInheritLine()
- getInheritParas()
- getInheritProps()
- getInheritTextBlock()
- getInheritUsers()
- getLayerMem()
- getLayout()
- getLine()
- getLineStyle()
- getMaster()
- getMasterShape()
- getMisc()
- getName()
- getNameU()
- getOneD()
- getPage()
- getParas()
- getParentShape()
- getProps()
- getProtection()
- getPureText()
- getRelationFlag()
- getRelationShapeCollection()
- getRootShape()
- getScratchs()
- getShapes()
- getSmartTagDefs()
- getTabsCollection()
- getText()
- getTextBlock()
- getTextStyle()
- getTextXForm()
- getThreeDFormat()
- getTwoD()
- getType()
- getUniqueID()
- getUsers()
- getXForm()
- getXForm1D()
- getZOrderIndex()
- gluedShapes(flag, categoryFilter, otherShape)
- isConnected(shape)
- isContain()
- isGlued(shape)
- isInGroup()
- isIntersect()
- isTextEmpty()
- move(dX, dY)
- moveTo(newPinX, newPinY)
- refreshData()
- replaceText()
- sendBackward()
- sendToBack()
- setAngle(angle)
- setClippingPath()
- setConnectorsType()
- setData1()
- setData2()
- setData3()
- setDel()
- setDiagram()
- setEvent()
- setFillStyle()
- setHeight(height)
- setID()
- setLineStyle()
- setMaster()
- setMasterShape()
- setName()
- setNameU()
- setPage()
- setParentShape()
- setPresetTheme()
- setPresetThemeQuickStyle()
- setPresetThemeStyleMatrics(styleIndex, colorIndex)
- setPresetThemeVariant()
- setProps()
- setText()
- setTextStyle()
- setTwoD()
- setType()
- setWidth(width)
- setXForm()
- setXForm1D()
- toHTML(imageFile, options)
- toHTML(stream, options)
- toImage(imageFile, options)
- toImage(stream, options)
- toPdf(fileName)
- toSvg(fileName)
- ungroup()
new Shape()
Constructor.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("RetrieveShapeInfo.vsd");
for (it = diagram.getPages().getPage("Page-2").getShapes().iterator(); it.hasNext();) {
shape = it.next();
// Display information about the shapes
console.log("Shape ID : " + shape.getID());
console.log("Name : " + shape.getName());
console.log("Master Shape : " + shape.getMaster().getName());
}Methods
toImageStream(shape, stream, options)
Creates the shape image and saves it to a stream in the specified format.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
var fs = require("fs");
var diagram = new aspose.diagram.Diagram("example.vsdx");
var page = diagram.getPages().getPage("Page-1");
var shape = page.getShapes().getShape(1);
var writeStream = fs.createWriteStream("output.png");
var options = new aspose.diagram.ImageSaveOptions(aspose.diagram.SaveFileFormat.PNG);
aspose.diagram.Shape.toImageStream(shape, writeStream, options);Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
shape |
|
The shape object to save |
|
|
stream |
WritableStream |
|
The stream |
|
options |
|
ImageSaveOptions |
toPdfStream(shape, stream)
Creates the shape pdf and saves it to a stream.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
var fs = require("fs");
var diagram = new aspose.diagram.Diagram("example.vsdx");
var page = diagram.getPages().getPage("Page-1");
var shape = page.getShapes().getShape(1);
var writeStream = fs.createWriteStream("output.pdf");
aspose.diagram.Shape.toPdfStream(shape, writeStream);Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
shape |
|
The shape object to save |
|
|
stream |
WritableStream |
|
The stream |
bringForward()
Brings the shape forward one position in the z-order.
bringToFront()
Brings the shape to the front of the z-order.
centerDrawing()
Center the shape with respect to the extent of the page
connectedShapes(flag, categoryFilter) → Array of long
Returns an array that contains the identifiers (IDs) of the shapes that are connected to the shape.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("AddingNewShape.vsdx");
// get shape by id
shape = diagram.getPages().getPage("Page-3").getShapes().getShape(16);
// get connected shapes
connectedShapeIds = shape.connectedShapes(aspose.diagram.ConnectedShapesFlags.CONNECTED_SHAPES_ALL_NODES, null);
for (let i = 0; i < connectedShapeIds.length; i++) {
shape = diagram.getPages().getPage("Page-3").getShapes().getShape(connectedShapeIds[i]);
console.log("ID: " + shape.getID() + "\t\t Name: " + shape.getName());
}Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
flag |
Number |
|
ConnectedShapesFlags |
|
categoryFilter |
String |
|
Filters the array of returned shape IDs by limiting it to the IDs of shapes that match the specified category |
- Returns
-
Array of longIDs arraylong.
convertToGroup()
Converts a selection or an object from another application (a linked or embedded object) to a group.
copy()
dependsOnShapes() → Array of long
Returns an array that contains the identifiers of the shapes that are depends on a shape.
- Returns
-
Array of longIDs arraylong.
getActiveXControl()
Gets the ActiveX control.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("VisioActiveXControls.vsdx");
// get a Visio page by name
page = diagram.getPages().getPage("Page-1");
// get a shape by ID
shape = page.getShapes().getShape(1);
// get an ActiveX control
activex = shape.getActiveXControl();
// set width of the command button control
activex.setWidth(4);
// set height of the command button control
activex.setHeight(4);
// set caption of the command button control
activex.setCaption("Test Button");
diagram.save("out-RetrieveActiveXControl.vsdx", aspose.diagram.SaveFileFormat.VSDX);getActs()
Contains a collection of Act elements.
getAlign()
Indicates the alignment of a shape with respect to the guide or guide point to which the shape is glued. The Align element appears only for shapes that are glued to guides or guide points.
getChars()
Contains a collection of Char elements.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("ApplyFontOnText.vsdx");
sourceShape = null;
// get page by name
page = diagram.getPages().getPage("Page-1");
// get shape by ID
shape = page.getShapes().getShape(1);
// clear shape text values and chars
shape.getText().getValue().clear();
shape.getChars().clear();
// mark character run and add text
shape.getText().getValue().add(new aspose.diagram.Cp(0));
shape.getText().getValue().add(new aspose.diagram.Txt("TextStyle_Regular\n"));
shape.getText().getValue().add(new aspose.diagram.Cp(1));
shape.getText().getValue().add(new aspose.diagram.Txt("TextStyle_Bold_Italic\n"));
shape.getText().getValue().add(new aspose.diagram.Cp(2));
shape.getText().getValue().add(new aspose.diagram.Txt("TextStyle_Underline_Italic\n"));
shape.getText().getValue().add(new aspose.diagram.Cp(3));
shape.getText().getValue().add(new aspose.diagram.Txt("TextStyle_Bold_Italic_Underline"));
// add formatting characters
shape.getChars().add(new aspose.diagram.Char());
shape.getChars().add(new aspose.diagram.Char());
shape.getChars().add(new aspose.diagram.Char());
shape.getChars().add(new aspose.diagram.Char());
// set properties e.g. color, font, size and style etc.
shape.getChars().get(0).setIX(0);
shape.getChars().get(0).getColor().setValue("#FF0000");
shape.getChars().get(0).getFont().setValue(4);
shape.getChars().get(0).getSize().setValue(0.22);
shape.getChars().get(0).getStyle().setValue(aspose.diagram.StyleValue.UNDEFINED);
// set properties e.g. color, font, size and style etc.
shape.getChars().get(1).setIX(1);
shape.getChars().get(1).getColor().setValue("#FF00FF");
shape.getChars().get(1).getFont().setValue(4);
shape.getChars().get(1).getSize().setValue(0.22);
shape.getChars().get(1).getStyle().setValue(aspose.diagram.StyleValue.BOLD |aspose.diagram. StyleValue.ITALIC);
// set properties e.g. color, font, size and style etc.
shape.getChars().get(2).setIX(2);
shape.getChars().get(2).getColor().setValue("#00FF00");
shape.getChars().get(2).getFont().setValue(4);
shape.getChars().get(2).getSize().setValue(0.22);
shape.getChars().get(2).getStyle().setValue(aspose.diagram.StyleValue.UNDERLINE | aspose.diagram.StyleValue.ITALIC);
// set properties e.g. color, font, size and style etc.
shape.getChars().get(3).setIX(3);
shape.getChars().get(3).getColor().setValue("#3333FF");
shape.getChars().get(3).getFont().setValue(4);
shape.getChars().get(3).getSize().setValue(0.22);
shape.getChars().get(3).getStyle().setValue(aspose.diagram.StyleValue.BOLD | aspose.diagram.StyleValue.ITALIC | aspose.diagram.StyleValue.UNDERLINE);
diagram.save("out-ApplyFontOnText.vsdx", aspose.diagram.SaveFileFormat.VSDX);getClippingPath()
getConnectionABCDs()
Contains a collection of ConnectionABCD elements.
getConnections()
Contains a collection of Connection elements.
getConnectorRule() → ConnectorRule
Returns a connectorRule that contains the shape id and connecton that are connected to the shape.
- Returns
-
ConnectorRuleConnectorRule.
getConnectorsType()
Get Connectors type
getControlData()
Gets the data of control.
getControls()
Contains a collection of Control elements.
getData1()
Contains an arbitrary string value that is used to supply additional information about a shape.
getData2()
Contains an arbitrary string value that is used to supply additional information about a shape.
getData3()
Contains an arbitrary string value that is used to supply additional information about a shape.
getDel()
A flag indicating whether the element is deleted locally. A value of 1 indicates that the element is deleted locally. The value of the property is BOOL integer constant.
getDiagram()
Root element of Visio objects hierarchy.
getDisplayText()
Get the text displayed on the interface
getEvent()
Contains elements that specify formulas that control shape events.
getFields()
Contains a collection of Field elements.
getFill()
Contains the current fill formatting values for the shape and the shape's drop shadow, including pattern, foreground color, and background color.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("RetrieveShapeInfo.vsd");
// Find a particular shape and update its foreground color and background color
for (it = diagram.getPages().get(0).getShapes().iterator(); it.hasNext();) {
shape = it.next();
if (shape.getNameU().toLowerCase() == "process") {
shape.getFill().getFillForegnd().setValue("#ebf8df");
shape.getFill().getFillBkgnd().setValue("#dff8eb");
}
}
diagram.save("out-SetFillData.vsdx", aspose.diagram.SaveFileFormat.VSDX);getFillStyle()
StyleSheet from which this shape inherits fill formatting.
getForeign()
Contains elements specifying the width and height of an object from another program used in a Microsoft Visio document. Also includes elements specifying the distance the object's image is offset within its borders.
getForeignData()
Contains a MIME (Multipurpose Internet Mail Extensions) encoded BLOB of picture data, such as Windows metafile, bitmap, or OLE data.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
fs = require("fs");
diagram = new aspose.diagram.Diagram("ExtractAllImagesFromPage.vsd");
// Enter page index i.e. 0 for first one
for (var it = diagram.getPages().getPage(0).getShapes().iterator(); it.hasNext();) {
shape = it.next();
// Filter shapes by type Foreign
if (shape.getType() == aspose.diagram.TypeValue.FOREIGN) {
output = fs.writeFileSync("out" + shape.getID() + ".bmp", shape.getForeignData().getValue());
}
}getGeoms()
Contains a collection of Geom elements.
getGroup()
Contains elements that control how you add shapes to a group, move members of a group, and select groups.
getHelp()
Contains elements specifying the Shape element's Help file topic and copyright information.
getHyperlinks()
Contains a collection of Hyperlink elements.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("Hyperlinks.vsdx");
// get page by name
var page = diagram.getPages().getPage("Page-1");
// get shape by ID
var shape = page.getShapes().getShape(1);
// get hyperlink collection
var hyperlinks = shape.getHyperlinks();
// iterate through the hyperlinks
for (var it = hyperlinks.iterator(); it.hasNext();) {
hyperlink = it.next();
console.log("Address: " + hyperlink.getAddress().getValue());
console.log("Sub Address: " + hyperlink.getSubAddress().getValue());
console.log("Description: " + hyperlink.getDescription().getValue());
}getID()
The unique ID of the element within its parent element.
getImage()
Contains the gamma, brightness, contrast, blur, sharpen, denoise, and transparency values for a bitmap.
getInheritChars()
Contains the char values for the shape inherit by the master shape.
getInheritFill()
Contains the fill formatting values for the shape inherit by the parent style and the master shape.
getInheritGeoms()
Contains the Geoms values for the shape inherit by the master shape.
getInheritGroup()
getInheritLine()
Contains the line formatting values for the shape inherit by the parent style and the master shape.
getInheritParas()
Contains the paras for the shape inherit by the parent style and the master shape.
getInheritProps()
Contains the props for the shape inherit by the master shape.
getInheritTextBlock()
Contains the textblock values for the shape inherit by the parent style and the master shape.
getInheritUsers()
Contains the users for the shape inherit by the master shape.
getLayerMem()
Contains the LayerMember element, which specifies each layer to which the shape is assigned.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("Layers.vsdx");
shapes = diagram.getPages().getPage("Page-1").getShapes();
// iterate through the shapes
for (var it = shapes.iterator(); it.hasNext();) {
shape = it.next();
if (shape.getName().toLowerCase() == "shape1") {
// Add shape1 in first two layers. Here "0;1" are indexes of the
// layers
layer = shape.getLayerMem();
layer.getLayerMember().setValue("0;1");
} else if (shape.getName().toLowerCase() == "shape2") {
// Remove shape2 from all the layers
layer = shape.getLayerMem();
layer.getLayerMember().setValue("");
} else if (shape.getName().toLowerCase() == "shape3") {
// Add shape3 in first layer. Here "0" is index of the first
// layer
layer = shape.getLayerMem();
layer.getLayerMember().setValue("0");
}
}
// save diagram
diagram.save("out-ConfigureShapeLayers.vsdx", aspose.diagram.SaveFileFormat.VSDX);getLayout()
Contains elements that control shape placement and connector routing settings.
getLine()
Contains elements that control line attributes for a shape, such as pattern, weight, and color. These elements determine whether the line ends are formatted (for example, with an arrowhead), the size of line end formats, radius of the rounding circle applied to the line, and line cap style (round or square).
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("RetrieveShapeInfo.vsd");
// get a shape by id
shape = diagram.getPages().getPage("Page-2").getShapes().getShape(1);
// set line dash type by index
shape.getLine().getLinePattern().setValue(4);
// set line weight, defualt in PT
shape.getLine().getLineWeight().setValue(2);
// set color of the shape's line
shape.getLine().getLineColor().getUfe().setF("RGB(95,108,53)");
// set line rounding, default in inch
shape.getLine().getRounding().setValue(0.3125);
// set line caps
shape.getLine().getLineCap().setValue(aspose.diagram.BOOL.TRUE);
// set line color transparency in percent
shape.getLine().getLineColorTrans().setValue(50);
// add arrows to the connector or curve shapes
// select arrow type by index
shape.getLine().getBeginArrow().setValue(4);
shape.getLine().getEndArrow().setValue(4);
// set arrow size
shape.getLine().getBeginArrowSize().setValue(aspose.diagram.ArrowSizeValue.SMALL);
shape.getLine().getBeginArrowSize().setValue(aspose.diagram.ArrowSizeValue.SMALL);
diagram.save("out-SetLineData.vsdx", aspose.diagram.SaveFileFormat.VSDX);getLineStyle()
StyleSheet from which this shape inherits line formatting
getMaster()
The Master from which the shape inherits its data.
getMasterShape()
This attribute may only be present in shapes that are members of a group shape, and the group is an instance of a master. The attribute contains an ID that references the corresponding sub-shape in the master.
getMisc()
Contains elements specifying the Shape element's Help file topic and copyright information.
getName()
The name of the element.
getNameU()
The universal name of the element.
getOneD()
Determines whether the shape behaves as a one-dimensional (1-D) object. Read-only.
getPage()
Root element of Visio objects hierarchy.
getParas()
Contains a collection of Para elements.
getParentShape()
Shape's parent.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("AddingNewShape.vsdx");
// get a sub-shape by page name, group shape ID, and then sub-shape ID
shape = diagram.getPages().getPage("Page-3").getShapes().getShape(13).getShapes().getShape(2);
parentShape = shape.getParentShape();
console.log("Parent Shape's Properties:");
console.log("Shape ID: " + parentShape.getID());
console.log("Shape Name: " + parentShape.getName());
console.log("Shape Type: " + parentShape.getType());getProps()
Contains a collection of Prop elements.
getProtection()
Locking helps prevent inadvertent changes to the shape but does not prevent Microsoft Visio from resetting values in other circumstances. It also does not protect against changes made in the ShapeSheet window.
getPureText()
Get the text string
getRelationFlag()
Returns RelationFlag that represents the relationship of one shape to another shape.
getRelationShapeCollection()
Returns RelationShapeCollection that represents the relationshapes of one shape.
getRootShape()
Returns the top-level shape of an instance if this shape is part of a master instance. Read-only.
getScratchs()
Contains a collection of Scratch elements.
getShapes()
Contains a collection of Shape elements.
getSmartTagDefs()
Contains a collection of SmartTagDef elements.
getTabsCollection()
Contains a collection of Tab elements.
getText()
Contains the text of a shape.
getTextBlock()
Contains elements that specify the alignment, margins, and default tab stop positions of text in a shape's text block.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("TextBoxes.vsdx");
// get the page by its name
page1 = diagram.getPages().getPage("Page-1");
// get shape by its ID
shape = page1.getShapes().getShape(1);
// set orientation angle
margin = new aspose.diagram.DoubleValue(4, aspose.diagram.MeasureConst.PT);
// set left, right, top and bottom margins of the shape's text block
shape.getTextBlock().setLeftMargin(margin);
shape.getTextBlock().setRightMargin(margin);
shape.getTextBlock().setTopMargin(margin);
shape.getTextBlock().setBottomMargin(margin);
// set the text direction
shape.getTextBlock().getTextDirection().setValue(aspose.diagram.TextDirectionValue.VERTICAL);
// set the text alignment
shape.getTextBlock().getVerticalAlign().setValue(aspose.diagram.VerticalAlignValue.MIDDLE);
// set the text block background color
shape.getTextBlock().getTextBkgnd().getUfe().setF("RGB(95,108,53)");
// set the background color transparency in percent
shape.getTextBlock().getTextBkgndTrans().setValue(50);
// set the distance between default tab stops for the selected shape.
shape.getTextBlock().getDefaultTabStop().setValue(2);
diagram.save("out-FormatShapeTextBlockSection.vsdx", aspose.diagram.SaveFileFormat.VSDX);getTextStyle()
StyleSheet from which this shape inherits text formatting.
getTextXForm()
Contains elements that specify positioning information about a shape's text block.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("TextBoxes.vsdx");
// get shape
shape = diagram.getPages().getPage("Page-1").getShapes().getShape(1);
// set text position at the bottom,
// TxtLocPinY = "TxtHeight*1" and TxtPinY = "Height*0"
shape.getTextXForm().getTxtLocPinY().setValue(shape.getTextXForm().getTxtHeight().getValue());
shape.getTextXForm().getTxtPinY().setValue(0);
// set orientation angle
angleDeg = 0;
angleRad = (Math.PI / 180) * angleDeg;
shape.getTextXForm().getTxtAngle().setValue(angleRad);
diagram.save("out-SetShapeTextPositionAtBottom.vsdx", aspose.diagram.SaveFileFormat.VSDX);getThreeDFormat()
Gets the ThreeDFormat.
getTwoD()
Determines whether the shape behaves as a two-dimensional (2-D) object.
getType()
The type of a shape. It may be one of the following values: Group, Shape, Guide, or Foreign. The value of the property is TypeValue integer constant.
getUniqueID()
A GUID (globally unique identifier) assigned to the shape.
getUsers()
Contains a collection of User elements.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("TextBoxes.vsdx");
// get page by name
page = diagram.getPages().getPage("Page-1");
// get shape by id
shape = page.getShapes().getShape(2);
// extract user defined cells of the shape
for (it = shape.getUsers().iterator(); it.hasNext();) {
user = it.next();
console.log(user.getName() + ": " + user.getValue().getVal());
}getXForm()
Contains elements specifying general positioning information about a shape.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("RetrieveShapeInfo.vsd");
// Find a particular shape and update its foreground color and background color
for (it = diagram.getPages().get(0).getShapes().iterator(); it.hasNext();) {
shape = it.next();
if (shape.getNameU().toLowerCase() == "process") {
shape.getXForm().getPinX().setValue(5);
shape.getXForm().getPinY().setValue(5);
}
}
diagram.save("out-SetXFormdata.vsdx", aspose.diagram.SaveFileFormat.VSDX);getXForm1D()
Contains x- and y-coordinates of the begin point and end point of a 1-D shape. This element appears for 1-D shapes only.
getZOrderIndex()
Returns the index of a shape in the z-order except the guide shape.
gluedShapes(flag, categoryFilter, otherShape) → Array of long
Returns an array that contains the identifiers of the shapes that are glued to a shape.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("RetrieveShapeInfo.vsd");
// get shape by an ID
shape = diagram.getPages().getPage("Page-2").getShapes().getShape(1);
// get all glued 1D shapes
gluedShapeIds = shape.gluedShapes(aspose.diagram.GluedShapesFlags.GLUED_SHAPES_ALL_1_D, null, null);
// display shape ID and name
for (let i = 0; i < gluedShapeIds.length; i++) {
shape = diagram.getPages().get(0).getShapes().getShape(gluedShapeIds[i]);
console.log("ID: " + shape.getID() + "\t\t Name: " + shape.getName());
}Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
flag |
Number |
|
GluedShapesFlags |
|
categoryFilter |
String |
|
Filters the array of returned shape IDs by limiting it to the IDs of shapes that match the specified category |
|
otherShape |
|
Optional: additional shape to which returned shapes must also be glued, can be |
- Returns
-
Array of longIDs arraylong.
isConnected(shape)
Indicates whether this two shapes are connected.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("RetrieveShapeInfo.vsd");
// get Visio page by name
page = diagram.getPages().getPage("Page-2");
// get Visio shapes by ids
ShapedOne = page.getShapes().getShape(1);
ShapedTwo = page.getShapes().getShape(2);
// determine whether shapes are connected
connected = ShapedOne.isConnected(ShapedTwo);
console.log("Shapes are connected: " + connected);
// determine whether shapes are glued
glued = ShapedOne.isGlued(ShapedTwo);
console.log("Shapes are Glued: " + glued);Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
shape |
|
shape |
isContain()
Indicates whether this shape is contain another shape.
isGlued(shape)
Indicates whether this two shapes are glued.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
shape |
|
shape |
isInGroup()
Indicates whether this shape is in a group shape.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("AddingNewShape.vsdx");
// get a sub-shape by page name, group shape ID, and then sub-shape ID
shape = diagram.getPages().getPage("Page-3").getShapes().getShape(13).getShapes().getShape(2);
console.log("Is it in a Group: " + shape.isInGroup());isIntersect()
Indicates whether this shape is intersect another shape.
isTextEmpty()
Indicate the shape has text and the text is empty or not.
move(dX, dY)
Moves shape on the dX and dY inches from current position.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("GroupShapes.vsdx");
// get page by name
page = diagram.getPages().getPage("Page-3");
// get shape by id
shape = page.getShapes().getShape(16);
// move shape from its position, it adds values in coordinates
shape.move(1, 1);
diagram.save("out-MoveVisioShape.vsdx", aspose.diagram.SaveFileFormat.VSDX);Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
dX |
Number |
|
X offset |
|
dY |
Number |
|
Y offset |
moveTo(newPinX, newPinY)
Moves shape on new absolute position on the page.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
newPinX |
Number |
|
New x-coordinate of the shape's pin (center of rotation) in relation to the origin of its parent. |
|
newPinY |
Number |
|
New y-coordinate of the shape's pin (center of rotation) in relation to the origin of its parent. |
refreshData()
Refreshes shape's position including xform ,connection and geom when changing shape's text or other's . We will gather shape's data such as shape's text then calculate shape's position. This method is only used to refresh shape's data .
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("AddingNewShape.vsdx");
// get page by name
page = diagram.getPages().getPage("Page-2");
// Add master with stencil file path and master id
masterName = "Rectangle";
// Add master with stencil file path and master name
diagram.addMaster("BasicShapes.vss", masterName);
// page indexing starts from 0
PageIndex = 1;
width = 2, height = 2, pinX = 4.25, pinY = 4.5;
// Add a new rectangle shape
rectangleId = diagram.addShape(pinX, pinY, width, height, masterName, PageIndex);
// set shape properties
rectangle = page.getShapes().getShape(rectangleId);
rectangle.getXForm().getPinX().setValue(5);
rectangle.getXForm().getPinY().setValue(5);
rectangle.setType(aspose.diagram.TypeValue.SHAPE);
rectangle.getText().getValue().add(new aspose.diagram.Txt("Aspose Diagram"));
rectangle.setTextStyle(diagram.getStyleSheets().get(3));
rectangle.getLine().getLineColor().setValue("#ff0000");
rectangle.getLine().getLineWeight().setValue(0.03);
rectangle.getLine().getRounding().setValue(0.1);
rectangle.getFill().getFillBkgnd().setValue("#ff00ff");
rectangle.getFill().getFillForegnd().setValue("#ebf8df");
rectangle.refreshData();
diagram.save("out-AddShape.vsdx", aspose.diagram.SaveFileFormat.VSDX);replaceText()
Replace the text string of a shape .
sendBackward()
Moves the shape back one position in the z-order.
sendToBack()
Moves the shape to the back of the z-order.
setAngle(angle)
Sets new angle of shape. The angle's unit is radian.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("RetrieveShapeInfo.vsd");
shape = diagram.getPages().getPage("Page-2").getShapes().getShape(2);
// Add a shape and set the angle
shape.setAngle(190);
diagram.save("out-RotateVisioShape.vsdx", aspose.diagram.SaveFileFormat.VSDX);Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
angle |
Number |
|
New angle which unit is radian not degree |
setClippingPath()
setConnectorsType()
Set Connectors type
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("RetrieveShapeInfo.vsd");
// get a dynamic connector type shape by id
shape = diagram.getPages().getPage("Page-2").getShapes().getShape(3);
// set dynamic connector appearance
shape.setConnectorsType(aspose.diagram.ConnectorsTypeValue.STRAIGHT_LINES);
diagram.save("out-SetConnectorAppearance.vsdx", aspose.diagram.SaveFileFormat.VSDX);setData1()
Contains an arbitrary string value that is used to supply additional information about a shape.
setData2()
Contains an arbitrary string value that is used to supply additional information about a shape.
setData3()
Contains an arbitrary string value that is used to supply additional information about a shape.
setDel()
A flag indicating whether the element is deleted locally. A value of 1 indicates that the element is deleted locally. The value of the property is BOOL integer constant.
setDiagram()
Root element of Visio objects hierarchy.
setEvent()
Contains elements that specify formulas that control shape events.
setFillStyle()
StyleSheet from which this shape inherits fill formatting.
setHeight(height)
Sets new height of shape.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
height |
Number |
|
New height |
setID()
The unique ID of the element within its parent element.
setLineStyle()
StyleSheet from which this shape inherits line formatting
setMaster()
The Master from which the shape inherits its data.
setMasterShape()
This attribute may only be present in shapes that are members of a group shape, and the group is an instance of a master. The attribute contains an ID that references the corresponding sub-shape in the master.
setName()
The name of the element.
setNameU()
The universal name of the element.
setPage()
Root element of Visio objects hierarchy.
setParentShape()
Shape's parent.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("AddingNewShape.vsdx");
// get a sub-shape by page name, group shape ID, and then sub-shape ID
shape = diagram.getPages().getPage("Page-3").getShapes().getShape(13).getShapes().getShape(2);
parentShape = shape.getParentShape();
console.log("Parent Shape's Properties:");
console.log("Shape ID: " + parentShape.getID());
console.log("Shape Name: " + parentShape.getName());
console.log("Shape Type: " + parentShape.getType());setPresetTheme()
Apply a preset theme to this shape The value of the property is PresetThemeValue integer constant.
setPresetThemeQuickStyle()
Apply a preset theme variant quickstyle to this shape The value of the property is PresetQuickStyleValue integer constant.
setPresetThemeStyleMatrics(styleIndex, colorIndex)
pply a preset theme variant quickstyle to this shape, like theme styles options in shape styles dropdown list
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
styleIndex |
Number |
|
PresetStyleMatricsValue |
|
colorIndex |
Number |
|
PresetColorMatricsValue |
setPresetThemeVariant()
Apply a preset theme variant to this shape The value of the property is PresetThemeVariantValue integer constant.
setProps()
Contains a collection of Prop elements.
setText()
Contains the text of a shape.
setTextStyle()
StyleSheet from which this shape inherits text formatting.
setTwoD()
Determines whether the shape behaves as a two-dimensional (2-D) object.
setType()
The type of a shape. It may be one of the following values: Group, Shape, Guide, or Foreign. The value of the property is TypeValue integer constant.
setWidth(width)
Sets new width of shape.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
width |
Number |
|
New width |
setXForm()
Contains elements specifying general positioning information about a shape.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("RetrieveShapeInfo.vsd");
// Find a particular shape and update its foreground color and background color
for (it = diagram.getPages().get(0).getShapes().iterator(); it.hasNext();) {
shape = it.next();
if (shape.getNameU().toLowerCase() == "process") {
shape.getXForm().getPinX().setValue(5);
shape.getXForm().getPinY().setValue(5);
}
}
diagram.save("out-SetXFormdata.vsdx", aspose.diagram.SaveFileFormat.VSDX);setXForm1D()
Contains x- and y-coordinates of the begin point and end point of a 1-D shape. This element appears for 1-D shapes only.
toHTML(imageFile, options)
Creates the html and saves it to a file.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
imageFile |
|
|
The file name with full path. |
|
options |
|
html save options |
toHTML(stream, options)
Creates the shape html and saves it to a stream in the specified format.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
stream |
OutputStream |
|
The output stream. |
|
options |
|
Addtional html creation options |
toImage(imageFile, options)
Creates the shape image and saves it to a file. The extension of the file name determines the format of the image. The format of the image is specified by using the extension of the file name. For example, if you specify "myfile.png", then the image will be saved in the PNG format. The following file extensions are recognized: .bmp, .gif, .png, .jpg, .jpeg, .tiff, .tif, .emf.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
imageFile |
String |
|
The image file name with full path. |
|
options |
|
Additional image creation options |
toImage(stream, options)
Creates the shape image and saves it to a stream in the specified format.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
stream |
OutputStream |
|
The output stream. |
|
options |
|
Additional image creation options |
toPdf(fileName)
Saves the shape to a pdf file.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
fileName |
String |
|
the pdf file name with full path |
toSvg(fileName)
Saves the shape to a svg file.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
fileName |
|
|
the svg file name with full path |
ungroup()
Ungroup Shape