Excel.Shape class
Stellt ein generisches Formobjekt im Arbeitsblatt dar. Ein Shape kann ein geometrisches Shape, eine Linie, eine Gruppe von Shapes usw. sein. Weitere Informationen zum Formobjektmodell finden Sie unter Arbeiten mit Formen mithilfe der Excel-JavaScript-API.
- Extends
Hinweise
Verwendet von
- Excel.GeometricShape: Form
- Excel.GroupShapeCollection: getItem, getItemAt, getItemOrNullObject, Elemente
- Excel.Image: Form
- Excel.Line: beginConnectedShape, connectBeginShape, connectEndShape, endConnectedShape, shape
- Excel.ShapeCollection: addGeometricShape, addGroup, addImage, addLine, addLocalImageReference, addSvg, addTextBox, getItem, getItemAt, getItemOrNullObject, items
- Excel.ShapeGroup: Form
- Excel.Workbook: getActiveShape, getActiveShapeOrNullObject
Eigenschaften
| alt |
Gibt den alternativen Beschreibungstext für ein |
| alt |
Gibt den alternativen Titeltext für ein |
| connection |
Gibt die Anzahl der Verbindungsseiten für diese Form zurück. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| display |
Ruft den Anzeigenamen der Form ab. Ein neu erstelltes Shape hat einen generierten Namen, der lokalisiert ist und möglicherweise nicht mit seinem |
| fill | Gibt die Füllungsformatierung dieser Form zurück. |
| geometric |
Gibt die der Form zugeordnete geometrische Form zurück. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "GeometricShape" ist. |
| geometric |
Gibt den geometrischen Formtyp dieser geometrischen Form an. Weitere Informationen findest du hier |
| group | Gibt die der Form zugeordnete Formgruppe zurück. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "GroupShape" ist. |
| height | Gibt die Höhe des Shapes in Punkten an. Löst eine |
| id | Gibt den Formbezeichner an. |
| image | Gibt das Bild zurück, das der Form zugeordnet ist. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "Image" ist. |
| left | Der Abstand in Punkten von der linken Seite der Form zur linken Seite des Arbeitsblatts. Löst eine |
| level | Gibt die Ebene der angegebenen Form an. Beispielsweise bedeutet die Ebene 0, dass die Form nicht Teil von Gruppen ist, die Ebene 1 bedeutet, die Form ist Teil einer Gruppe der obersten Ebene, und die Ebene 2 bedeutet, dass die Form Teil einer Untergruppe der obersten Ebene ist. |
| line | Gibt die Linie zurück, die der Form zugeordnet ist. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "Line" ist. |
| line |
Gibt die Linienformatierung dieser Form zurück. |
| lock |
Gibt an, ob das Seitenverhältnis dieses Shapes gesperrt ist. |
| name | Gibt den Namen der Form an. |
| parent |
Gibt die übergeordnete Gruppe dieses Shapes an. |
| placement | Stellt dar, wie das Objekt an die Zellen darunter angefügt ist. |
| rotation | Gibt die Drehung der Form in Grad an. |
| text |
Gibt das textFrame-Objekt dieser Form zurück. |
| top | Der Abstand in Punkten zwischen der oberen Kante der Form und der oberen Kante der Arbeitsmappe. Löst eine |
| type | Gibt den Typ dieser Form zurück. Weitere Informationen findest du hier |
| visible | Gibt an, ob das Shape sichtbar ist. |
| width | Gibt die Breite des Shapes in Punkten an. Löst eine |
| z |
Gibt die Position der angegebenen Form in der Z-Reihenfolge an, wobei 0 den Boden des Reihenfolgestapels darstellt. |
Methoden
| copy |
Kopiert ein Objekt und fügt es |
| delete() | Entfernt die Form aus dem Arbeitsblatt. |
| get |
Konvertiert die Form in ein Bild und gibt das Bild als Base64-codierte Zeichenfolge zurück. Der DPI-Wert ist 96. Die einzigen unterstützten Formate sind |
| get |
Konvertiert die Form in ein Bild und gibt das Bild als Base64-codierte Zeichenfolge zurück. Der DPI-Wert ist 96. Die einzigen unterstützten Formate sind |
| increment |
Verschiebt die Form horizontal um die angegebene Punktanzahl. |
| increment |
Dreht die Form um die angegebene Gradzahl um die Z-Achse. Verwenden Sie die |
| increment |
Verschiebt die Form vertikal um die angegebene Anzahl von Punkten. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| scale |
Skaliert die Höhe der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert. |
| scale |
Skaliert die Höhe der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert. |
| scale |
Skaliert die Breite der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Breite skaliert. |
| scale |
Skaliert die Breite der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Breite skaliert. |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| set |
Verschiebt de angegebene Form in der Z-Reihenfolge der Sammlung nach oben oder unten, wodurch sie vor oder hinter anderen Formen zu liegen kommt. |
| set |
Verschiebt de angegebene Form in der Z-Reihenfolge der Sammlung nach oben oder unten, wodurch sie vor oder hinter anderen Formen zu liegen kommt. |
| toJSON() | Überschreibt die JavaScript-Methode |
Ereignisse
| on |
Tritt ein, wenn die Form aktiviert wird. |
| on |
Tritt ein, wenn die Form deaktiviert wird. |
Details zur Eigenschaft
altTextDescription
Gibt den alternativen Beschreibungstext für ein Shape Objekt an.
altTextDescription: string;
Eigenschaftswert
string
Hinweise
altTextTitle
Gibt den alternativen Titeltext für ein Shape Objekt an.
altTextTitle: string;
Eigenschaftswert
string
Hinweise
connectionSiteCount
Gibt die Anzahl der Verbindungsseiten für diese Form zurück.
readonly connectionSiteCount: number;
Eigenschaftswert
number
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;
Eigenschaftswert
displayName
Ruft den Anzeigenamen der Form ab. Ein neu erstelltes Shape hat einen generierten Namen, der lokalisiert ist und möglicherweise nicht mit seinem nameübereinstimmt. In diesem Szenario können Sie diese API verwenden, um den Namen abzurufen, der auf der Benutzeroberfläche angezeigt wird.
readonly displayName: string;
Eigenschaftswert
string
Hinweise
fill
Gibt die Füllungsformatierung dieser Form zurück.
readonly fill: Excel.ShapeFill;
Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml
await Excel.run(async (context) => {
// Apply a solid fill color to the shape.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const shapeFill: Excel.ShapeFill = badge.fill;
shapeFill.setSolidColor("#FFE08A");
await context.sync();
});
geometricShape
Gibt die der Form zugeordnete geometrische Form zurück. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "GeometricShape" ist.
readonly geometricShape: Excel.GeometricShape;
Eigenschaftswert
Hinweise
geometricShapeType
Gibt den geometrischen Formtyp dieser geometrischen Form an. Weitere Informationen findest du hier Excel.GeometricShapeType . Gibt zurück null , wenn der Formtyp nicht "GeometricShape" ist.
geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
Eigenschaftswert
Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"
Hinweise
group
Gibt die der Form zugeordnete Formgruppe zurück. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "GroupShape" ist.
readonly group: Excel.ShapeGroup;
Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-groups.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shapeGroup = sheet.shapes.getItem("Group").group;
shapeGroup.ungroup();
console.log("Shapes ungrouped");
await context.sync();
});
height
Gibt die Höhe des Shapes in Punkten an. Löst eine InvalidArgument Ausnahme aus, wenn sie mit einem negativen Wert oder Null als Eingabe festgelegt wurde.
height: number;
Eigenschaftswert
number
Hinweise
id
Gibt den Formbezeichner an.
readonly id: string;
Eigenschaftswert
string
Hinweise
image
Gibt das Bild zurück, das der Form zugeordnet ist. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "Image" ist.
readonly image: Excel.Image;
Eigenschaftswert
Hinweise
left
Der Abstand in Punkten von der linken Seite der Form zur linken Seite des Arbeitsblatts. Löst eine InvalidArgument Ausnahme aus, wenn sie mit einem negativen Wert als Eingabe festgelegt wird.
left: number;
Eigenschaftswert
number
Hinweise
level
Gibt die Ebene der angegebenen Form an. Beispielsweise bedeutet die Ebene 0, dass die Form nicht Teil von Gruppen ist, die Ebene 1 bedeutet, die Form ist Teil einer Gruppe der obersten Ebene, und die Ebene 2 bedeutet, dass die Form Teil einer Untergruppe der obersten Ebene ist.
readonly level: number;
Eigenschaftswert
number
Hinweise
line
Gibt die Linie zurück, die der Form zugeordnet ist. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "Line" ist.
readonly line: Excel.Line;
Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml
await Excel.run(async (context) => {
const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
const line = shapes.getItem("StraightLine").line;
line.beginArrowheadLength = Excel.ArrowheadLength.long;
line.beginArrowheadWidth = Excel.ArrowheadWidth.wide;
line.beginArrowheadStyle = Excel.ArrowheadStyle.oval;
line.endArrowheadLength = Excel.ArrowheadLength.long;
line.endArrowheadWidth = Excel.ArrowheadWidth.wide;
line.endArrowheadStyle = Excel.ArrowheadStyle.triangle;
await context.sync();
});
lineFormat
Gibt die Linienformatierung dieser Form zurück.
readonly lineFormat: Excel.ShapeLineFormat;
Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml
await Excel.run(async (context) => {
// Load and log the shape's fill and outline properties.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
badge.fill.load(["foregroundColor", "transparency", "type"]);
badge.lineFormat.load(["color", "dashStyle", "style", "transparency", "visible", "weight"]);
await context.sync();
console.log("Badge fill: " + JSON.stringify(badge.fill));
console.log("Badge line format: " + JSON.stringify(badge.lineFormat));
});
lockAspectRatio
Gibt an, ob das Seitenverhältnis dieses Shapes gesperrt ist.
lockAspectRatio: boolean;
Eigenschaftswert
boolean
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shape = sheet.shapes.getItem("Octagon")
shape.lockAspectRatio = true;
shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize);
await context.sync();
});
name
parentGroup
Gibt die übergeordnete Gruppe dieses Shapes an.
readonly parentGroup: Excel.Shape;
Eigenschaftswert
Hinweise
placement
Stellt dar, wie das Objekt an die Zellen darunter angefügt ist.
placement: Excel.Placement | "TwoCell" | "OneCell" | "Absolute";
Eigenschaftswert
Excel.Placement | "TwoCell" | "OneCell" | "Absolute"
Hinweise
rotation
Gibt die Drehung der Form in Grad an.
rotation: number;
Eigenschaftswert
number
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.triangle);
shape.left = 100;
shape.top = 300;
shape.height = 150;
shape.width = 200;
shape.rotation = 45;
shape.fill.clear();
await context.sync();
});
textFrame
Gibt das textFrame-Objekt dieser Form zurück.
readonly textFrame: Excel.TextFrame;
Eigenschaftswert
Hinweise
top
Der Abstand in Punkten zwischen der oberen Kante der Form und der oberen Kante der Arbeitsmappe. Löst eine InvalidArgument Ausnahme aus, wenn sie mit einem negativen Wert als Eingabe festgelegt wird.
top: number;
Eigenschaftswert
number
Hinweise
type
Gibt den Typ dieser Form zurück. Weitere Informationen findest du hier Excel.ShapeType .
readonly type: Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
Eigenschaftswert
Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line"
Hinweise
visible
Gibt an, ob das Shape sichtbar ist.
visible: boolean;
Eigenschaftswert
boolean
Hinweise
width
Gibt die Breite des Shapes in Punkten an. Löst eine InvalidArgument Ausnahme aus, wenn sie mit einem negativen Wert oder Null als Eingabe festgelegt wurde.
width: number;
Eigenschaftswert
number
Hinweise
zOrderPosition
Gibt die Position der angegebenen Form in der Z-Reihenfolge an, wobei 0 den Boden des Reihenfolgestapels darstellt.
readonly zOrderPosition: number;
Eigenschaftswert
number
Hinweise
Details zur Methode
copyTo(destinationSheet)
Kopiert ein Objekt und fügt es Shape ein. Die eingefügte Form wird an dieselbe Pixelposition wie diese Form kopiert.
copyTo(destinationSheet?: Worksheet | string): Excel.Shape;
Parameter
- destinationSheet
-
Excel.Worksheet | string
Das Blatt, in das das Formobjekt eingefügt wird. Der Standardwert ist das Arbeitsblatt der kopierten Form.
Gibt zurück
Hinweise
delete()
Entfernt die Form aus dem Arbeitsblatt.
delete(): void;
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml
await Excel.run(async (context) => {
context.workbook.worksheets.getItemOrNullObject("Shapes").delete();
const sheet = context.workbook.worksheets.add("Shapes");
const shapes = sheet.shapes;
// load all the shapes in the collection without loading their properties
shapes.load("items/$none");
await context.sync();
shapes.items.forEach((shape) => shape.delete());
await context.sync();
});
getAsImage(format)
Konvertiert die Form in ein Bild und gibt das Bild als Base64-codierte Zeichenfolge zurück. Der DPI-Wert ist 96. Die einzigen unterstützten Formate sind Excel.PictureFormat.BMP, Excel.PictureFormat.PNG, Excel.PictureFormat.JPEGund Excel.PictureFormat.GIF.
getAsImage(format: Excel.PictureFormat): OfficeExtension.ClientResult<string>;
Parameter
- format
- Excel.PictureFormat
Gibt das Format des Images an.
Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shape = sheet.shapes.getItem("Image");
const result = shape.getAsImage(Excel.PictureFormat.png);
await context.sync();
const imageString = result.value;
// Your add-in would save this string as a .png file.
console.log("The image's Base64-encoded string: " + imageString);
});
getAsImage(format)
Konvertiert die Form in ein Bild und gibt das Bild als Base64-codierte Zeichenfolge zurück. Der DPI-Wert ist 96. Die einzigen unterstützten Formate sind Excel.PictureFormat.BMP, Excel.PictureFormat.PNG, Excel.PictureFormat.JPEGund Excel.PictureFormat.GIF.
getAsImage(format: "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"): OfficeExtension.ClientResult<string>;
Parameter
- format
-
"UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"
Gibt das Format des Images an.
Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
incrementLeft(increment)
Verschiebt die Form horizontal um die angegebene Punktanzahl.
incrementLeft(increment: number): void;
Parameter
- increment
-
number
Das Inkrement in Punkten, in dem die Form horizontal verschoben wird. Ein positiver Wert verschiebt das Shape nach rechts, ein negativer Wert verschiebt es nach links. Wenn das Blatt von rechts nach links ausgerichtet ist, ist dies umgekehrt: Bei positiven Werten wird die Form nach links verschoben, bei negativen Werten nach rechts.
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shape = sheet.shapes.getItem("Square")
shape.incrementLeft(-25);
await context.sync();
});
incrementRotation(increment)
Dreht die Form um die angegebene Gradzahl um die Z-Achse. Verwenden Sie die rotation Eigenschaft, um die absolute Drehung der Form festzulegen.
incrementRotation(increment: number): void;
Parameter
- increment
-
number
Um wie viel Grad die Form gedreht wird. Bei einem positiven Wert wird die Form im Uhrzeigersinn gedreht, bei einem negativen Wert wird sie gegen den Uhrzeigersinn gedreht.
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shape = sheet.shapes.getItem("Image");
shape.incrementRotation(180);
await context.sync();
});
incrementTop(increment)
Verschiebt die Form vertikal um die angegebene Anzahl von Punkten.
incrementTop(increment: number): void;
Parameter
- increment
-
number
Das Inkrement in Punkten, in dem die Form vertikal verschoben wird. Ein positiver Wert verschiebt das Shape nach unten, ein negativer Wert nach oben.
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shape = sheet.shapes.getItem("Pentagon")
shape.incrementTop(25);
await context.sync();
});
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Excel.Interfaces.ShapeLoadOptions): Excel.Shape;
Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Excel.Shape;
Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Shape;
Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
scaleHeight(scaleFactor, scaleType, scaleFrom)
Skaliert die Höhe der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert.
scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom): void;
Parameter
- scaleFactor
-
number
Gibt das Verhältnis zwischen der Höhe der Form nach der Änderung ihrer Größe und der aktuellen oder ursprünglichen Höhe an.
- scaleType
- Excel.ShapeScaleType
Gibt an, ob die Form relativ zu ihrer ursprünglichen oder aktuellen Größe skaliert wird. Die Option zur ursprünglichen Größenskalierung funktioniert nur für Bilder.
- scaleFrom
- Excel.ShapeScaleFrom
Optional. Gibt an, welcher Teil der Form beim Skalieren die Position beibehält. Wenn er weggelassen wird, stellt er die obere linke Ecke der Form dar, wobei seine Position beibehalten wird.
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shape = sheet.shapes.getItem("Octagon")
shape.lockAspectRatio = true;
shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize);
await context.sync();
});
scaleHeight(scaleFactor, scaleType, scaleFrom)
Skaliert die Höhe der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert.
scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;
Parameter
- scaleFactor
-
number
Gibt das Verhältnis zwischen der Höhe der Form nach der Änderung ihrer Größe und der aktuellen oder ursprünglichen Höhe an.
- scaleType
-
"CurrentSize" | "OriginalSize"
Gibt an, ob die Form relativ zu ihrer ursprünglichen oder aktuellen Größe skaliert wird. Die Option zur ursprünglichen Größenskalierung funktioniert nur für Bilder.
- scaleFrom
-
"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"
Optional. Gibt an, welcher Teil der Form beim Skalieren die Position beibehält. Wenn er weggelassen wird, stellt er die obere linke Ecke der Form dar, wobei seine Position beibehalten wird.
Gibt zurück
void
Hinweise
scaleWidth(scaleFactor, scaleType, scaleFrom)
Skaliert die Breite der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Breite skaliert.
scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom): void;
Parameter
- scaleFactor
-
number
Gibt das Verhältnis zwischen der Breite der Form nach der Änderung ihrer Größe und der aktuellen oder ursprünglichen Breite an.
- scaleType
- Excel.ShapeScaleType
Gibt an, ob die Form relativ zu ihrer ursprünglichen oder aktuellen Größe skaliert wird. Die Option zur ursprünglichen Größenskalierung funktioniert nur für Bilder.
- scaleFrom
- Excel.ShapeScaleFrom
Optional. Gibt an, welcher Teil der Form beim Skalieren die Position beibehält. Wenn er weggelassen wird, stellt er die obere linke Ecke der Form dar, wobei seine Position beibehalten wird.
Gibt zurück
void
Hinweise
scaleWidth(scaleFactor, scaleType, scaleFrom)
Skaliert die Breite der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Breite skaliert.
scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;
Parameter
- scaleFactor
-
number
Gibt das Verhältnis zwischen der Breite der Form nach der Änderung ihrer Größe und der aktuellen oder ursprünglichen Breite an.
- scaleType
-
"CurrentSize" | "OriginalSize"
Gibt an, ob die Form relativ zu ihrer ursprünglichen oder aktuellen Größe skaliert wird. Die Option zur ursprünglichen Größenskalierung funktioniert nur für Bilder.
- scaleFrom
-
"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"
Optional. Gibt an, welcher Teil der Form beim Skalieren die Position beibehält. Wenn er weggelassen wird, stellt er die obere linke Ecke der Form dar, wobei seine Position beibehalten wird.
Gibt zurück
void
Hinweise
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parameter
- properties
- Excel.Interfaces.ShapeUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.Shape): void;
Parameter
- properties
- Excel.Shape
Gibt zurück
void
setZOrder(position)
Verschiebt de angegebene Form in der Z-Reihenfolge der Sammlung nach oben oder unten, wodurch sie vor oder hinter anderen Formen zu liegen kommt.
setZOrder(position: Excel.ShapeZOrder): void;
Parameter
- position
- Excel.ShapeZOrder
Wo das Shape im Stapel in z-Reihenfolge relativ zu den anderen Shapes verschoben werden soll. Weitere Informationen findest du hier Excel.ShapeZOrder .
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shape = sheet.shapes.getItem("Octagon")
shape.setZOrder(Excel.ShapeZOrder.sendBackward);
await context.sync();
});
setZOrder(position)
Verschiebt de angegebene Form in der Z-Reihenfolge der Sammlung nach oben oder unten, wodurch sie vor oder hinter anderen Formen zu liegen kommt.
setZOrder(position: "BringToFront" | "BringForward" | "SendToBack" | "SendBackward"): void;
Parameter
- position
-
"BringToFront" | "BringForward" | "SendToBack" | "SendBackward"
Wo das Shape im Stapel in z-Reihenfolge relativ zu den anderen Shapes verschoben werden soll. Weitere Informationen findest du hier Excel.ShapeZOrder .
Gibt zurück
void
Hinweise
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.Shape Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.ShapeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.ShapeData;
Gibt zurück
Details zum Ereignis
onActivated
Tritt ein, wenn die Form aktiviert wird.
readonly onActivated: OfficeExtension.EventHandlers<Excel.ShapeActivatedEventArgs>;
Ereignistyp
Hinweise
onDeactivated
Tritt ein, wenn die Form deaktiviert wird.
readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ShapeDeactivatedEventArgs>;