Excel.Interfaces.ShapeData interface

Paket:
excel

Eine Schnittstelle, die die durch Aufrufen shape.toJSON()zurückgegebenen Daten beschreibt.

Eigenschaften

altTextDescription

Gibt den alternativen Beschreibungstext für ein Shape Objekt an.
altTextTitle

Gibt den alternativen Titeltext für ein Shape Objekt an.
connectionSiteCount

Gibt die Anzahl der Verbindungsseiten für diese Form zurück.
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.
fill

Gibt die Füllungsformatierung dieser Form zurück.
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.
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.
id

Gibt den Formbezeichner an.
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.
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.
lineFormat

Gibt die Linienformatierung dieser Form zurück.
lockAspectRatio

Gibt an, ob das Seitenverhältnis dieses Shapes gesperrt ist.
name

Gibt den Namen der Form an.
placement

Stellt dar, wie das Objekt an die Zellen darunter angefügt ist.
rotation

Gibt die Drehung der Form in Grad an.
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.
type

Gibt den Typ dieser Form zurück. Weitere Informationen findest du hier Excel.ShapeType .
visible

Gibt an, ob das Shape sichtbar ist.
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.
zOrderPosition

Gibt die Position der angegebenen Form in der Z-Reihenfolge an, wobei 0 den Boden des Reihenfolgestapels darstellt.

Details zur Eigenschaft

altTextDescription

Gibt den alternativen Beschreibungstext für ein Shape Objekt an.

altTextDescription?: string;

Eigenschaftswert

string

Hinweise

[API-Satz: ExcelApi 1.9]

altTextTitle

Gibt den alternativen Titeltext für ein Shape Objekt an.

altTextTitle?: string;

Eigenschaftswert

string

Hinweise

[API-Satz: ExcelApi 1.9]

connectionSiteCount

Gibt die Anzahl der Verbindungsseiten für diese Form zurück.

connectionSiteCount?: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.9]

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.

displayName?: string;

Eigenschaftswert

string

Hinweise

[API-Satz: ExcelApi 1.15]

fill

Gibt die Füllungsformatierung dieser Form zurück.

fill?: Excel.Interfaces.ShapeFillData;

Eigenschaftswert

Excel.Interfaces.ShapeFillData

Hinweise

[API-Satz: ExcelApi 1.9]

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

[API-Satz: ExcelApi 1.9]

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

[API-Satz: ExcelApi 1.9]

id

Gibt den Formbezeichner an.

id?: string;

Eigenschaftswert

string

Hinweise

[API-Satz: ExcelApi 1.9]

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

[API-Satz: ExcelApi 1.9]

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.

level?: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.9]

lineFormat

Gibt die Linienformatierung dieser Form zurück.

lineFormat?: Excel.Interfaces.ShapeLineFormatData;

Eigenschaftswert

Excel.Interfaces.ShapeLineFormatData

Hinweise

[API-Satz: ExcelApi 1.9]

lockAspectRatio

Gibt an, ob das Seitenverhältnis dieses Shapes gesperrt ist.

lockAspectRatio?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

name

Gibt den Namen der Form an.

name?: string;

Eigenschaftswert

string

Hinweise

[API-Satz: ExcelApi 1.9]

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

[API-Satz: ExcelApi 1.10]

rotation

Gibt die Drehung der Form in Grad an.

rotation?: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.9]

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

[API-Satz: ExcelApi 1.9]

type

Gibt den Typ dieser Form zurück. Weitere Informationen findest du hier Excel.ShapeType .

type?: Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";

Eigenschaftswert

Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line"

Hinweise

[API-Satz: ExcelApi 1.9]

visible

Gibt an, ob das Shape sichtbar ist.

visible?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

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

[API-Satz: ExcelApi 1.9]

zOrderPosition

Gibt die Position der angegebenen Form in der Z-Reihenfolge an, wobei 0 den Boden des Reihenfolgestapels darstellt.

zOrderPosition?: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.9]