ExcelScript.Worksheet interface

Active la feuille de calcul dans l’interface utilisateur Excel.

activate(): void;

Retours

Exemples

/**
 * This script switches the active view to a worksheet named "Data", if it exists.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet exists.
  let dataWorksheet = workbook.getWorksheet("Data");
  if (dataWorksheet) {
    // Switch to the "Data" worksheet.
    dataWorksheet.activate();
  } else {
    console.log(`No worksheet named "Data" in this workbook.`);
  }
}

Crée un graphique.

addChart(
            type: ChartType,
            sourceData: Range,
            seriesBy?: ChartSeriesBy
        ): Chart;

Paramètres

Retours

Exemples

/**
 * This sample creates a column-clustered chart based on the current worksheet's data.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the data range.
  let range = selectedSheet.getUsedRange();

  // Insert a chart using the data on the current worksheet.
  let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);

  // Name the chart for easy access in other scripts.
  chart.setName("ColumnChart");
}

Crée un nouveau commentaire avec le contenu donné sur la cellule donnée. Une InvalidArgument erreur est générée si la plage fournie est supérieure à une cellule.

addComment(
            cellAddress: Range | string,
            content: CommentRichContent | string,
            contentType?: ContentType
        ): Comment;

Paramètres

Retours

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

addGeometricShape(geometricShapeType: GeometricShapeType): Shape;

Paramètres

Retours

Exemples

/**
 * This script creates a hexagon shape on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const hexagon: ExcelScript.Shape = 
    currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
  
  // Set the hexagon size to 40x40 pixels.
  hexagon.setHeight(40);
  hexagon.setWidth(40);

  // Position the hexagon at [100,100] pixels.
  hexagon.setLeft(100);
  hexagon.setTop(100);
}

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>): Shape;

Paramètres

Retours

Ajoute un saut de page avant la cellule en haut à gauche de la plage spécifiée.

addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;

Paramètres

Retours

Crée une image à partir d’une chaîne en base 64 et il est ajouté à la feuille de calcul. Renvoie l’objet Shape qui représente la nouvelle image.

addImage(base64ImageString: string): Shape;

Paramètres

Retours

Exemples

/**
 * This sample copies an image from a URL. 
 * This could be used to copy photos that a colleague stored in a shared folder to a related workbook.
 */
async function main(workbook: ExcelScript.Workbook) {
  // Fetch the image from a URL.
  const link = "https://raw.githubusercontent.com/OfficeDev/office-scripts-docs/master/docs/images/git-octocat.png";
  const response = await fetch(link);

  // Store the response as an ArrayBuffer, since it is a raw image file.
  const data = await response.arrayBuffer();

  // Convert the image data into a base64-encoded string.
  const image = convertToBase64(data);

  // Add the image to the current worksheet.
  workbook.getActiveWorksheet().addImage(image);
}

/**
 * Converts an ArrayBuffer containing a .png image into a base64-encoded string.
 */
function convertToBase64(input: ArrayBuffer) {
  const uInt8Array = new Uint8Array(input);
  const count = uInt8Array.length;

  // Allocate the necessary space up front.
  const charCodeArray = new Array<string>(count) 
  
  // Convert every entry in the array to a character.
  for (let i = count; i >= 0; i--) { 
    charCodeArray[i] = String.fromCharCode(uInt8Array[i]);
  }

  // Convert the characters to base64.
  const base64 = btoa(charCodeArray.join(''));
  return base64;
}

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?: ConnectorType
        ): Shape;

Paramètres

Retours

Ajoute un nouveau nom à la collection de l’étendue donnée.

addNamedItem(
            name: string,
            reference: Range | string,
            comment?: string
        ): NamedItem;

Paramètres

Retours

Ajoute un nouveau nom à la collection de l’étendue donnée à l’aide des paramètres régionaux de l’utilisateur pour la formule.

addNamedItemFormulaLocal(
            name: string,
            formula: string,
            comment?: string
        ): NamedItem;

Paramètres

Retours

Crée une vue feuille avec le nom donné.

addNamedSheetView(name: string): NamedSheetView;

Paramètres

Retours

Ajoutez un tableau croisé dynamique basé sur les données sources spécifiées et insérez-le dans la cellule supérieure gauche de la plage de destination.

addPivotTable(
            name: string,
            source: Range | string | Table,
            destination: Range | string
        ): PivotTable;

Paramètres

Retours

Exemples

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));

  // Switch to the new worksheet.
  newSheet.activate();
}

Ajoute un nouveau segment au classeur.

addSlicer(
            slicerSource: string | PivotTable | Table,
            sourceField: string | PivotField | number | TableColumn,
            slicerDestination?: string | Worksheet
        ): Slicer;

Paramètres

Retours

Exemples

/**
 * This script adds a slicer for an existing PivotTable on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable from the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const pivot = currentSheet.getPivotTables()[0];

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const slicer = currentSheet.addSlicer(
    pivot, /* The table or PivotTale to be sliced. */
    pivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  slicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  slicer.setLeft(400);
}

Crée une table. L’objet de plage ou l’adresse source détermine la feuille de calcul sous laquelle la table sera ajoutée. Si la table ne peut pas être ajoutée (par exemple, parce que l’adresse n’est pas valide ou que la table chevauche une autre table), une erreur est générée.

addTable(address: Range | string, hasHeaders: boolean): Table;

Paramètres

Retours

Exemples

/**
 * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Create a table with the used cells.
  let usedRange = selectedSheet.getUsedRange();
  let newTable = selectedSheet.addTable(usedRange, true);

  // Sort the table using the first column.
  newTable.getSort().apply([{ key: 0, ascending: true }]);
}

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): Shape;

Paramètres

Retours

Ajoute un saut de page avant la cellule en haut à gauche de la plage spécifiée.

addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;

Paramètres

Retours

Ajoute une nouvelle propriété personnalisée qui correspond à la clé fournie. Cette opération remplace les propriétés personnalisées existantes par cette clé.

addWorksheetCustomProperty(
            key: string,
            value: string
        ): WorksheetCustomProperty;

Paramètres

Retours

Calcule toutes les cellules d’une feuille de calcul.

calculate(markAllDirty: boolean): void;

Paramètres

Retours

Copie une feuille de calcul et la place à la position spécifiée.

copy(
            positionType?: WorksheetPositionType,
            relativeTo?: Worksheet
        ): Worksheet;

Paramètres

Retours

Exemples

/**
 * This script duplicates a worksheet named "Template". 
 * The new worksheet is added after the template.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the worksheet named "Template".
  let template = workbook.getWorksheet("Template");

  // Copy the worksheet.
  let newSheet = template.copy(
    ExcelScript.WorksheetPositionType.after,
    template
  );

  // Name the worksheet using the current date.
  let date = new Date(Date.now());
  newSheet.setName(`${date.toDateString()}`);
}

Supprime la feuille de calcul du classeur. Notez que si la visibilité de la feuille de calcul est définie sur « VeryHidden », l’opération de suppression échoue avec une InvalidOperation exception. Vous devez d’abord modifier sa visibilité sur masquée ou visible avant de la supprimer.

delete(): void;

Retours

Exemples

/**
 * The following scripts removes the first worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first worksheet.
  let sheet = workbook.getWorksheets()[0];

  // Remove that worksheet from the workbook.
  sheet.delete();
}

Crée et active une nouvelle vue de feuille temporaire. Les vues temporaires sont supprimées lors de la fermeture de l’application, de la sortie de la vue temporaire avec la méthode de sortie ou du basculement vers une autre vue feuille. La vue feuille temporaire est également accessible avec la chaîne vide («  »), si l’affichage temporaire existe.

enterTemporaryNamedSheetView(): NamedSheetView;

Retours

Quitte l’affichage feuille actuellement actif.

exitActiveNamedSheetView(): void;

Retours

Recherche toutes les occurrences de la chaîne donnée en fonction des critères spécifiés et les renvoie en tant qu’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires.

findAll(text: string, criteria: WorksheetSearchCriteria): RangeAreas;

Paramètres

Retours

Exemples

/**
 * This script searches through a worksheet and finds cells containing "No". 
 * Those cells are filled with the color red.
 * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let worksheet = workbook.getActiveWorksheet();
  let noCells = worksheet.findAll("No", { completeMatch: true });

  // Set the fill color to red.
  noCells.getFormat().getFill().setColor("red");
}

Obtient l’affichage feuille actuellement actif de la feuille de calcul.

getActiveNamedSheetView(): NamedSheetView;

Retours

Représente l’objet AutoFilter de la feuille de calcul.

getAutoFilter(): AutoFilter;

Retours

Exemples

/**
 * This script creates an autoFilter on the worksheet that filters out rows based on column values. 
 * The autoFilter filters to only include rows that have a value in column D in the top 10 percentile 
 * (of column D values).
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const dataRange = currentSheet.getUsedRange();

  // Add a filter that will only show the rows with the top 10% of values in column D
  // (index 3, assuming the used range spans from at least A:D).
  currentSheet.getAutoFilter().apply(dataRange, 3, {
    criterion1: "10",
    filterOn: ExcelScript.FilterOn.topPercent
  });
}

Obtient l’objet Range contenant la cellule unique en fonction des numéros de ligne et de colonne. La cellule peut se trouver en dehors des limites de sa plage parente, tant qu’elle reste dans la grille de feuille de calcul.

getCell(row: number, column: number): Range;

Paramètres

Retours

Extrait un graphique à l’aide de son nom. Si plusieurs graphiques portent le même nom, c’est le premier d’entre eux qui est renvoyé. Si le graphique n’existe pas, cette méthode retourne undefined.

getChart(name: string): Chart | undefined;

Paramètres

Retours

Exemples

/**
 * This sample moves an existing chart to a specific place on the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();
  
  // Get an existing chart named "ColumnChart".
  let chart = selectedSheet.getChart("ColumnChart");

  // Place the chart over the range "F1:L13".
  chart.setPosition("F1", "L13");
}

Retourne une collection de graphiques qui font partie de la feuille de calcul.

getCharts(): Chart[];

Retours

Obtient un commentaire à partir de la collection de sites en fonction de son ID. Si l’objet comment n’existe pas, cette méthode retourne undefined.

getComment(commentId: string): Comment | undefined;

Paramètres

Retours

Obtient le commentaire à partir de la cellule spécifiée. S’il n’y a aucun commentaire dans la cellule, une erreur est générée.

getCommentByCell(cellAddress: Range | string): Comment;

Paramètres

Retours

Obtient le commentaire auquel la réponse donnée est connectée.

getCommentByReplyId(replyId: string): Comment;

Paramètres

Retours

Renvoie une collection de tous les objets Lecteur sur l’ordinateur.

getComments(): Comment[];

Retours

Obtient une collection de propriétés personnalisées au niveau de la feuille de calcul.

getCustomProperties(): WorksheetCustomProperty[];

Retours

Détermine si Excel doit recalculer la feuille de calcul si nécessaire. True si Excel recalcule la feuille de calcul si nécessaire. Elle a la valeur False si Excel ne recalcule pas la feuille.

getEnableCalculation(): boolean;

Retours

Obtient un objet qui peut être utilisé pour manipuler des volets figés dans la feuille de calcul.

getFreezePanes(): WorksheetFreezePanes;

Retours

Obtient la collection de saut de page horizontal pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.

getHorizontalPageBreaks(): PageBreak[];

Retours

Renvoie une valeur qui permet d’identifier la feuille de calcul de façon unique dans un classeur donné. La valeur de l’identificateur reste identique, même lorsque la feuille de calcul est renommée ou déplacée.

getId(): string;

Retours

Nom complet de la feuille de calcul. Le nom doit comporter moins de 32 caractères.

getName(): string;

Retours

Exemples

/**
 * This sample gets all the worksheet names in the workbook.
 * It then logs those names to the console.
 */
function main(workbook: ExcelScript.Workbook) {
    // Create an array to hold the worksheet names.
    let worksheetNames = [];

    // Iterate over the worksheet collection in the workbook.
    for (let worksheet of workbook.getWorksheets()) {
        worksheetNames.push(worksheet.getName());
    }

    // Log the array of worksheet names.
    console.log(worksheetNames);
}

Obtient un NamedItem objet à l’aide de son nom. Si l’objet n’existe pas, cette méthode retourne undefined.

getNamedItem(name: string): NamedItem | undefined;

Paramètres

Retours

Obtient une vue de feuille à l’aide de son nom. Si l’objet en mode Feuille n’existe pas, cette méthode retourne undefined.

getNamedSheetView(key: string): NamedSheetView | undefined;

Paramètres

Retours

Retourne une collection d’affichages feuille qui sont présents dans la feuille de calcul.

getNamedSheetViews(): NamedSheetView[];

Retours

Collection de noms inclus dans l’étendue de la feuille de calcul active.

getNames(): NamedItem[];

Retours

Obtient la feuille de calcul qui suit celle-ci. Si aucune feuille de calcul ne suit celle-ci, cette méthode retourne undefined.

getNext(visibleOnly?: boolean): Worksheet;

Paramètres

Retours

Obtient l’objet PageLayout de la feuille de calcul.

getPageLayout(): PageLayout;

Retours

Exemples

/**
 * This script sets the printing orientation for the entire workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();

    // Print every page with a landscape orientation.
    pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
  });
}

Obtient un tableau croisé dynamique par nom. Si le tableau croisé dynamique n’existe pas, cette méthode retourne undefined.

getPivotTable(name: string): PivotTable | undefined;

Paramètres

Retours

Collection de tableaux croisés dynamiques qui font partie de la feuille de calcul.

getPivotTables(): PivotTable[];

Retours

Position de la feuille de calcul au sein du classeur (sur une base zéro).

getPosition(): number;

Retours

Obtient la feuille de calcul qui précède celle-ci. S’il n’existe aucune feuille de calcul précédente, cette méthode retourne undefined.

getPrevious(visibleOnly?: boolean): Worksheet;

Paramètres

Retours

Renvoie l’objet de protection de feuille pour une feuille de calcul.

getProtection(): WorksheetProtection;

Retours

Exemples

/**
 * This script protects cells from being selected on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the protection settings for the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const sheetProtection = currentSheet.getProtection();

  // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
  let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
    selectionMode: ExcelScript.ProtectionSelectionMode.none
  }

  // Apply the given protection options.
  sheetProtection.protect(protectionOptions);
}

Obtient l’objet Range , qui représente un seul bloc rectangulaire de cellules, spécifié par l’adresse ou le nom.

getRange(address?: string): Range;

Paramètres

Retours

Exemples

/**
 * This sample reads the value of A1 and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the value of cell A1.
  let range = selectedSheet.getRange("A1");
  
  // Print the value of A1.
  console.log(range.getValue());
}

Obtient l’objet Range commençant à un index de ligne et d’un index de colonne particuliers, et couvrant un certain nombre de lignes et de colonnes.

getRangeByIndexes(
            startRow: number,
            startColumn: number,
            rowCount: number,
            columnCount: number
        ): Range;

Paramètres

Retours

Obtient l’objet RangeAreas , qui représente un ou plusieurs blocs de plages rectangulaires, spécifiés par l’adresse ou le nom.

getRanges(address?: string): RangeAreas;

Paramètres

Retours

Obtient une forme à l’aide de son nom ou de son ID. Si l’objet shape n’existe pas, cette méthode retourne undefined.

getShape(key: string): Shape | undefined;

Paramètres

Retours

Renvoie une collection de tous les objets Forme sur la feuille de calcul.

getShapes(): Shape[];

Retours

Spécifie si le quadrillage est visible par l’utilisateur.

getShowGridlines(): boolean;

Retours

Spécifie si les titres sont visibles par l’utilisateur.

getShowHeadings(): boolean;

Retours

Obtient un segment à l’aide de son nom ou de son ID. Si le segment n’existe pas, cette méthode retourne undefined.

getSlicer(key: string): Slicer | undefined;

Paramètres

Retours

Retourne une collection de segments qui font partie de la feuille de calcul.

getSlicers(): Slicer[];

Retours

Renvoie la hauteur standard (par défaut) de toutes les lignes dans la feuille de calcul, en points.

getStandardHeight(): number;

Retours

Spécifie la largeur standard (par défaut) de toutes les colonnes de la feuille de calcul. Une unité de largeur de colonne est égale à la largeur d'un caractère du style Normal. Dans le cas des polices proportionnelles, la largeur du caractère 0 (zéro) est utilisée.

getStandardWidth(): number;

Retours

Couleur d’onglet de la feuille de calcul. Lors de la récupération de la couleur de l’onglet, si la feuille de calcul est invisible, la valeur est null. Si la feuille de calcul est visible, mais que la couleur de l’onglet est définie sur auto, une chaîne vide est retournée. Sinon, la propriété sera définie sur une couleur, au format #RRGGBB (par exemple, « FFA500 »). Lorsque vous définissez la couleur, utilisez une chaîne vide pour définir une couleur « auto » ou une couleur réelle dans le cas contraire.

getTabColor(): string;

Retours

Retourne une valeur représentant cette feuille de calcul qui peut être lue par Open Office XML. Il s’agit d’une valeur entière, qui est différente de worksheet.id (qui retourne un identificateur global unique) et worksheet.name (qui retourne une valeur telle que « Sheet1 »).

getTabId(): number;

Retours

Obtient un tableau à l’aide de son nom ou de son ID. Si la table n’existe pas, cette méthode retourne undefined.

getTable(key: string): Table | undefined;

Paramètres

Retours

Collection de tableaux qui font partie de la feuille de calcul.

getTables(): Table[];

Retours

getUsedRange(valuesOnly?: boolean): Range;

Paramètres

Retours

Obtient la collection de saut de page vertical pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.

getVerticalPageBreaks(): PageBreak[];

Retours

Visibilité de la feuille de calcul.

getVisibility(): SheetVisibility;

Retours

Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse. Si la propriété personnalisée n’existe pas, cette méthode retourne undefined.

getWorksheetCustomProperty(
            key: string
        ): WorksheetCustomProperty | undefined;

Paramètres

Retours

Actualise tous les tableaux croisés dynamiques de la collection.

refreshAllPivotTables(): void;

Retours

Redéfinit tous les sauts de page de la collection.

removeAllHorizontalPageBreaks(): void;

Retours

Redéfinit tous les sauts de page de la collection.

removeAllVerticalPageBreaks(): void;

Retours

Détecte et remplace la chaîne donnée basée sur les critères spécifiés dans la plage active.

replaceAll(
            text: string,
            replacement: string,
            criteria: ReplaceCriteria
        ): number;

Paramètres

Retours

Détermine si Excel doit recalculer la feuille de calcul si nécessaire. True si Excel recalcule la feuille de calcul si nécessaire. Elle a la valeur False si Excel ne recalcule pas la feuille.

setEnableCalculation(enableCalculation: boolean): void;

Paramètres

Retours

Nom complet de la feuille de calcul. Le nom doit comporter moins de 32 caractères.

setName(name: string): void;

Paramètres

Retours

Exemples

/**
 * This sample renames a worksheet from "Sheet1" to "SALES".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a worksheet named "Sheet1".
  const sheet = workbook.getWorksheet('Sheet1'); 

  // Set its name to SALES.
  sheet.setName('SALES');
}

Position de la feuille de calcul au sein du classeur (sur une base zéro).

setPosition(position: number): void;

Paramètres

Retours

Exemples

/**
 * This sample sets the worksheet named "SALES" as the first sheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a worksheet named "SALES".
  const sheet = workbook.getWorksheet('SALES'); 
  // Position the worksheet at the beginning of the workbook.
  sheet.setPosition(0);
}

Spécifie si le quadrillage est visible par l’utilisateur.

setShowGridlines(showGridlines: boolean): void;

Paramètres

Retours

Spécifie si les titres sont visibles par l’utilisateur.

setShowHeadings(showHeadings: boolean): void;

Paramètres

Retours

Spécifie la largeur standard (par défaut) de toutes les colonnes de la feuille de calcul. Une unité de largeur de colonne est égale à la largeur d'un caractère du style Normal. Dans le cas des polices proportionnelles, la largeur du caractère 0 (zéro) est utilisée.

setStandardWidth(standardWidth: number): void;

Paramètres

Retours

Couleur d’onglet de la feuille de calcul. Lors de la récupération de la couleur de l’onglet, si la feuille de calcul est invisible, la valeur est null. Si la feuille de calcul est visible, mais que la couleur de l’onglet est définie sur auto, une chaîne vide est retournée. Sinon, la propriété sera définie sur une couleur, au format #RRGGBB (par exemple, « FFA500 »). Lorsque vous définissez la couleur, utilisez une chaîne vide pour définir une couleur « auto » ou une couleur réelle dans le cas contraire.

setTabColor(tabColor: string): void;

Paramètres

Retours

Exemples

/**
 * This script sets the tab color of every worksheet in the workbook to red.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();
  
  // Set the tab color of each worksheet to a random color.
  for (let sheet of sheets) {    
    // Set the color of the current worksheet's tab to red.
    sheet.setTabColor("red");
  }
}

Visibilité de la feuille de calcul.

setVisibility(visibility: SheetVisibility): void;

Paramètres

Retours

Exemples

/**
 * This script unhides all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Iterate over each worksheet.
  workbook.getWorksheets().forEach((worksheet) => {
    // Set the worksheet visibility to visible.
    worksheet.setVisibility(ExcelScript.SheetVisibility.visible);
  });
}

Affiche les groupes de lignes ou de colonnes selon leurs niveaux hiérarchiques. Présente les groupes et résume une liste de données dans la feuille de calcul. Les rowLevels paramètres et columnLevels spécifient le nombre de niveaux du plan qui seront affichés. La plage d’arguments acceptables est comprise entre 0 et 8. La valeur 0 ne modifie pas l’affichage actuel. Une valeur supérieure au nombre actuel de niveaux affiche tous les niveaux.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Paramètres

Retours