Partager via


Excel.ShapeCollection class

Représente une collection de toutes les formes de la feuille de calcul.

Extends

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Propriétés

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

items

Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

addGeometricShape(geometricShapeType)

Ajoute une forme géométrique à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle forme.

addGeometricShape(geometricShapeTypeString)

Ajoute une forme géométrique à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle forme.

addGroup(values)

Groupes un sous-ensemble de formes dans la feuille de calcul de cette collection de sites. Renvoie un Shape objet qui représente le nouveau groupe de formes.

addImage(base64ImageString)

Crée une image à partir d’une chaîne encodée en Base64 et l’ajoute à la feuille de calcul. Renvoie l’objet Shape qui représente la nouvelle image.

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Ajoute une ligne à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle ligne.

addLine(startLeft, startTop, endLeft, endTop, connectorTypeString)

Ajoute une ligne à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle ligne.

addLocalImageReference(address)

Crée une référence pour l’image locale stockée dans l’adresse de cellule et l’affiche sous la forme d’une forme flottante sur les cellules.

addSvg(xml)

Crée un graphique de fichiers SVG (SVG) à partir d’une chaîne XML et il est ajouté à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle image.

addTextBox(text)

Ajoute une zone de texte à la feuille de calcul avec le texte fourni en tant que le contenu. Renvoie un Shape objet qui représente la nouvelle zone de texte.

getCount()

Renvoie le nombre de graphiques dans la feuille de calcul.

getItem(key)

Obtient une forme à l’aide de son nom ou de son ID.

getItemAt(index)

Obtient une forme en fonction de sa position dans la collection.

getItemOrNullObject(key)

Obtient une forme à l’aide de son nom ou de son ID. Si l’objet shape n’existe pas, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.ShapeCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ShapeCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

items

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.Shape[];

Valeur de propriété

Détails de la méthode

addGeometricShape(geometricShapeType)

Ajoute une forme géométrique à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle forme.

addGeometricShape(geometricShapeType: Excel.GeometricShapeType): Excel.Shape;

Paramètres

geometricShapeType
Excel.GeometricShapeType

Représente le type de la forme géométrique. Pour plus d’informations, consultez Excel.GeometricShapeType .

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// 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.hexagon);
    shape.left = 5;
    shape.top = 5;
    shape.height = 175;
    shape.width = 200;
    await context.sync();
});

addGeometricShape(geometricShapeTypeString)

Ajoute une forme géométrique à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle forme.

addGeometricShape(geometricShapeTypeString: "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"): Excel.Shape;

Paramètres

geometricShapeTypeString

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

Représente le type de la forme géométrique. Pour plus d’informations, consultez Excel.GeometricShapeType .

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

addGroup(values)

Groupes un sous-ensemble de formes dans la feuille de calcul de cette collection de sites. Renvoie un Shape objet qui représente le nouveau groupe de formes.

addGroup(values: Array<string | Shape>): Excel.Shape;

Paramètres

values

Array<string | Excel.Shape>

Tableau d’ID de forme ou d’objets de forme.

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// 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 square = sheet.shapes.getItem("Square");
    const pentagon = sheet.shapes.getItem("Pentagon");
    const octagon = sheet.shapes.getItem("Octagon");

    const shapeGroup = sheet.shapes.addGroup([square, pentagon, octagon]);
    shapeGroup.name = "Group";
    console.log("Shapes grouped");

    await context.sync();
});

addImage(base64ImageString)

Crée une image à partir d’une chaîne encodée en Base64 et l’ajoute à la feuille de calcul. Renvoie l’objet Shape qui représente la nouvelle image.

addImage(base64ImageString: string): Excel.Shape;

Paramètres

base64ImageString

string

Chaîne encodée en Base64 représentant une image au format JPEG ou PNG.

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml

const myFile = <HTMLInputElement>document.getElementById("selectedFile");
const reader = new FileReader();

reader.onload = (event) => {
    Excel.run((context) => {
        const startIndex = reader.result.toString().indexOf("base64,");
        const myBase64 = reader.result.toString().substr(startIndex + 7);
        const sheet = context.workbook.worksheets.getItem("Shapes");
        const image = sheet.shapes.addImage(myBase64);
        image.name = "Image";
        return context.sync();
    });
};

// Read in the image file as a data URL.
reader.readAsDataURL(myFile.files[0]);

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Ajoute une ligne à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle ligne.

addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType): Excel.Shape;

Paramètres

startLeft

number

Distance, en points, entre le début de la ligne et le côté gauche de la feuille de calcul.

startTop

number

Distance, en points, entre le début de la ligne et le haut de la feuille de calcul.

endLeft

number

Distance, en points, entre la fin de la ligne et la gauche de la feuille de calcul.

endTop

number

Distance, en points, entre la fin de la ligne et le haut de la feuille de calcul.

connectorType
Excel.ConnectorType

Représente le type de connecteur. Pour plus d’informations, consultez Excel.ConnectorType .

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// 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.addLine(200, 50, 300, 150, Excel.ConnectorType.straight);
    line.name = "StraightLine";
    await context.sync();
});

addLine(startLeft, startTop, endLeft, endTop, connectorTypeString)

Ajoute une ligne à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle ligne.

addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorTypeString?: "Straight" | "Elbow" | "Curve"): Excel.Shape;

Paramètres

startLeft

number

Distance, en points, entre le début de la ligne et le côté gauche de la feuille de calcul.

startTop

number

Distance, en points, entre le début de la ligne et le haut de la feuille de calcul.

endLeft

number

Distance, en points, entre la fin de la ligne et la gauche de la feuille de calcul.

endTop

number

Distance, en points, entre la fin de la ligne et le haut de la feuille de calcul.

connectorTypeString

"Straight" | "Elbow" | "Curve"

Représente le type de connecteur. Pour plus d’informations, consultez Excel.ConnectorType .

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

addLocalImageReference(address)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Crée une référence pour l’image locale stockée dans l’adresse de cellule et l’affiche sous la forme d’une forme flottante sur les cellules.

addLocalImageReference(address: string): Excel.Shape;

Paramètres

address

string

Adresse de la cellule qui contient l’image locale.

Retours

Objet Shape associé à la forme flottante.

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

addSvg(xml)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Crée un graphique de fichiers SVG (SVG) à partir d’une chaîne XML et il est ajouté à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle image.

addSvg(xml: string): Excel.Shape;

Paramètres

xml

string

Chaîne XML qui représente le SVG.

Retours

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

addTextBox(text)

Ajoute une zone de texte à la feuille de calcul avec le texte fourni en tant que le contenu. Renvoie un Shape objet qui représente la nouvelle zone de texte.

addTextBox(text?: string): Excel.Shape;

Paramètres

text

string

Représente le texte qui sera affiché dans la zone de texte créée.

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const textbox = shapes.addTextBox("A box with text");
    textbox.left = 100;
    textbox.top = 100;
    textbox.height = 20;
    textbox.width = 175;
    textbox.name = "Textbox";
    await context.sync();
});

getCount()

Renvoie le nombre de graphiques dans la feuille de calcul.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getItem(key)

Obtient une forme à l’aide de son nom ou de son ID.

getItem(key: string): Excel.Shape;

Paramètres

key

string

Nom ou ID de la forme à récupérer.

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getItemAt(index)

Obtient une forme en fonction de sa position dans la collection.

getItemAt(index: number): Excel.Shape;

Paramètres

index

number

Index de base zéro de la forme à récupérer.

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getItemOrNullObject(key)

Obtient une forme à l’aide de son nom ou de son ID. Si l’objet shape n’existe pas, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemOrNullObject(key: string): Excel.Shape;

Paramètres

key

string

Nom ou ID de la forme à récupérer.

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.ShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ShapeCollection;

Paramètres

options

Excel.Interfaces.ShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.ShapeCollection;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ShapeCollection;

Paramètres

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.ShapeCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ShapeCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.ShapeCollectionData;

Retours