Excel.Interfaces.ShapeData interface

Interface décrivant les données renvoyées en appelant shape.toJSON().

Remarques

Utilisateur

Propriétés

altTextDescription

Spécifie le texte de description alternatif d’un Shape objet.

altTextTitle

Spécifie le texte de remplacement du titre d’un Shape objet.

connectionSiteCount

Renvoie le nombre de sites de connexion sur la forme spécifiée.

displayName

Obtient le nom d’affichage de la forme. Une forme nouvellement créée a un nom généré localisé qui peut ne pas correspondre à son name. Dans ce scénario, vous pouvez utiliser cette API pour obtenir le nom qui s’affiche dans l’interface utilisateur.

fill

Renvoie la mise en forme de remplissage de cette forme.

geometricShapeType

Spécifie le type de forme géométrique de cette forme géométrique. Pour Excel.GeometricShapeType plus de détails. Retourne null si le type de forme n’est pas « GeometricShape ».

height

Spécifie la hauteur, en points, de la forme. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative ou égale à zéro.

id

Spécifie l’identificateur de forme.

left

La distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative.

level

Spécifie le niveau de la forme spécifiée. Par exemple, un niveau de 0 signifie que la forme ne fait pas partie d’un groupe, un niveau de la forme 1 signifie fait partie d’un groupe de niveau supérieur et un niveau de 2, la forme fait partie d’un groupe sous-blocs de niveau supérieur.

lineFormat

Renvoie la mise en forme de ligne de cette forme.

lockAspectRatio

Indique si les proportions de cette forme sont verrouillées.

name

Spécifie le nom de la forme.

placement

Représente la manière dont l’objet est attaché aux cellules en dessous.

rotation

Spécifie la rotation, en degrés, de la forme.

top

La distance, en points, du bord supérieur de l’objet au bord supérieur de la feuille de calcul. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative.

type

Renvoie le type de cette forme. Pour Excel.ShapeType plus de détails.

visible

Indique si la forme est visible.

width

Spécifie la largeur, en points, de la forme. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative ou égale à zéro.

zOrderPosition

Renvoie la position de la forme spécifiée dans l’ordre z, valeur z de commande de la forme tout en bas est égal à 0.

Détails de la propriété

altTextDescription

Spécifie le texte de description alternatif d’un Shape objet.

altTextDescription?: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

altTextTitle

Spécifie le texte de remplacement du titre d’un Shape objet.

altTextTitle?: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

connectionSiteCount

Renvoie le nombre de sites de connexion sur la forme spécifiée.

connectionSiteCount?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

displayName

Obtient le nom d’affichage de la forme. Une forme nouvellement créée a un nom généré localisé qui peut ne pas correspondre à son name. Dans ce scénario, vous pouvez utiliser cette API pour obtenir le nom qui s’affiche dans l’interface utilisateur.

displayName?: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.15

fill

Renvoie la mise en forme de remplissage de cette forme.

fill?: Excel.Interfaces.ShapeFillData;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

geometricShapeType

Spécifie le type de forme géométrique de cette forme géométrique. Pour Excel.GeometricShapeType plus de détails. Retourne null si le type de forme n’est pas « GeometricShape ».

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";

Valeur de propriété

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"

Remarques

Jeu d’API : ExcelApi 1.9

height

Spécifie la hauteur, en points, de la forme. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative ou égale à zéro.

height?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

id

Spécifie l’identificateur de forme.

id?: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

left

La distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative.

left?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

level

Spécifie le niveau de la forme spécifiée. Par exemple, un niveau de 0 signifie que la forme ne fait pas partie d’un groupe, un niveau de la forme 1 signifie fait partie d’un groupe de niveau supérieur et un niveau de 2, la forme fait partie d’un groupe sous-blocs de niveau supérieur.

level?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

lineFormat

Renvoie la mise en forme de ligne de cette forme.

lineFormat?: Excel.Interfaces.ShapeLineFormatData;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

lockAspectRatio

Indique si les proportions de cette forme sont verrouillées.

lockAspectRatio?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

name

Spécifie le nom de la forme.

name?: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

placement

Représente la manière dont l’objet est attaché aux cellules en dessous.

placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute";

Valeur de propriété

Excel.Placement | "TwoCell" | "OneCell" | "Absolute"

Remarques

Jeu d’API : ExcelApi 1.10

rotation

Spécifie la rotation, en degrés, de la forme.

rotation?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

top

La distance, en points, du bord supérieur de l’objet au bord supérieur de la feuille de calcul. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative.

top?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

type

Renvoie le type de cette forme. Pour Excel.ShapeType plus de détails.

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

Valeur de propriété

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

Remarques

Jeu d’API : ExcelApi 1.9

visible

Indique si la forme est visible.

visible?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

width

Spécifie la largeur, en points, de la forme. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative ou égale à zéro.

width?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

zOrderPosition

Renvoie la position de la forme spécifiée dans l’ordre z, valeur z de commande de la forme tout en bas est égal à 0.

zOrderPosition?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9