ExcelScript.Worksheet interface

Ative a planilha na interface do usuário do Excel.

activate(): void;

Retornos

Exemplos

/**
 * 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.`);
  }
}

Cria um novo gráfico.

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

Parâmetros

Retornos

Exemplos

/**
 * 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");
}

Cria um novo comentário com o conteúdo fornecido na célula especificada. Um InvalidArgument erro será gerado se o intervalo fornecido for maior do que uma célula.

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

Parâmetros

Retornos

Adiciona uma forma geométrica à planilha. Retorna um Shape objeto que representa a nova forma.

addGeometricShape(geometricShapeType: GeometricShapeType): Shape;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Um subconjunto de formas na planilha do conjunto de grupos. Retorna um Shape objeto que representa o novo grupo de formas.

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

Parâmetros

Retornos

Adiciona uma quebra de página antes da célula superior esquerda do intervalo especificado.

addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;

Parâmetros

Retornos

Cria uma imagem de uma cadeia de caracteres codificada em Base64 e a adiciona à planilha. Retorna o Shape objeto que representa a nova imagem.

addImage(base64ImageString: string): Shape;

Parâmetros

Retornos

Exemplos

/**
 * 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;
}

Adiciona uma linha à planilha. Retorna um Shape objeto que representa a nova linha.

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

Parâmetros

Retornos

Adiciona um novo nome à coleção do escopo fornecido.

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

Parâmetros

Retornos

Adiciona um novo nome à coleção de escopo fornecido usando a localidade do usuário para a fórmula.

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

Parâmetros

Retornos

Cria um novo modo de exibição de planilha com o nome fornecido.

addNamedSheetView(name: string): NamedSheetView;

Parâmetros

Retornos

Adicione uma Tabela Dinâmica com base nos dados de origem especificados e insira-a na célula superior esquerda do intervalo de destino.

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

Parâmetros

Retornos

Exemplos

/**
 * 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();
}

Adiciona uma nova segmentação de dados à pasta de trabalho.

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

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Cria uma nova tabela. O objeto de intervalo ou endereço de origem determina a planilha à qual a tabela será adicionada. Se a tabela não puder ser adicionada (por exemplo, porque o endereço é inválido ou a tabela se sobreporia a outra), será gerado um erro.

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

Parâmetros

Retornos

Exemplos

/**
 * 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 }]);
}

Adiciona uma caixa de texto na planilha com o texto fornecido como conteúdo. Retorna um Shape objeto que representa a nova caixa de texto.

addTextBox(text?: string): Shape;

Parâmetros

Retornos

Adiciona uma quebra de página antes da célula superior esquerda do intervalo especificado.

addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;

Parâmetros

Retornos

Adiciona uma nova propriedade personalizada que mapeia para a chave fornecida. Isso substitui as propriedades personalizadas existentes por essa chave.

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

Parâmetros

Retornos

Calcula todas as células em uma planilha.

calculate(markAllDirty: boolean): void;

Parâmetros

Retornos

Copia uma planilha e a coloca na posição especificada.

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

Parâmetros

Retornos

Exemplos

/**
 * 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()}`);
}

Exclui a planilha da pasta de trabalho. Observe que se a visibilidade da planilha for definida como "VeryHidden", a operação de exclusão falhará com uma InvalidOperation exceção. Primeiro, você deve alterar sua visibilidade para oculto ou visível antes de excluí-lo.

delete(): void;

Retornos

Exemplos

/**
 * 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();
}

Cria e ativa uma nova exibição de planilha temporária. As exibições temporárias são removidas ao fechar o aplicativo, sair da exibição temporária com o método de saída ou alternar para outra exibição de planilha. A exibição de planilha temporária também pode ser acessada com a cadeia de caracteres vazia (""), se a exibição temporária existir.

enterTemporaryNamedSheetView(): NamedSheetView;

Retornos

Sai da visualização de planilha ativa no momento.

exitActiveNamedSheetView(): void;

Retornos

Localiza todas as ocorrências da cadeia de caracteres especificada com base nos critérios especificados e as retorna como um RangeAreas objeto, compreendendo um ou mais intervalos retangulares.

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

Parâmetros

Retornos

Exemplos

/**
 * 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");
}

Obtém o modo de exibição de planilha ativo no momento da planilha.

getActiveNamedSheetView(): NamedSheetView;

Retornos

Representa o AutoFilter objeto da planilha.

getAutoFilter(): AutoFilter;

Retornos

Exemplos

/**
 * 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
  });
}

Obtém o Range objeto que contém a única célula com base em números de linha e coluna. A célula pode estar fora dos limites de seu intervalo pai, desde que permaneça dentro da grade da planilha.

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

Parâmetros

Retornos

Obtém um gráfico usando o respectivo nome. Quando houver vários gráficos com o mesmo nome, o sistema retornará o primeiro deles. Se o gráfico não existir, esse método retornará undefined.

getChart(name: string): Chart | undefined;

Parâmetros

Retornos

Exemplos

/**
 * 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");
}

Retorna uma coleção de gráficos que fazem parte da planilha.

getCharts(): Chart[];

Retornos

Obtém um comentário da coleção com base em seu ID. Se o objeto de comentário não existir, esse método retornará undefined.

getComment(commentId: string): Comment | undefined;

Parâmetros

Retornos

Obtém o comentário da célula especificada. Se não houver nenhum comentário na célula, um erro será gerado.

getCommentByCell(cellAddress: Range | string): Comment;

Parâmetros

Retornos

Obtém o comentário ao qual a resposta fornecida está conectada.

getCommentByReplyId(replyId: string): Comment;

Parâmetros

Retornos

Retorna um conjunto de todos os objetos Comments na planilha.

getComments(): Comment[];

Retornos

Obtém uma coleção de propriedades personalizadas no nível da planilha.

getCustomProperties(): WorksheetCustomProperty[];

Retornos

Determina se o Excel deve recalcular a planilha quando necessário. Verdadeiro se o Excel recalcular a planilha quando necessário. False se o Excel não recalcular a planilha.

getEnableCalculation(): boolean;

Retornos

Obtém um objeto que pode ser usado para manipular painéis congelados na planilha.

getFreezePanes(): WorksheetFreezePanes;

Retornos

Obtém a coleção de quebra de página horizontal da planilha. Esta coleção contém apenas quebras de página manuais.

getHorizontalPageBreaks(): PageBreak[];

Retornos

Retorna um valor que identifica de forma exclusiva a planilha em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a planilha seja renomeada ou movida.

getId(): string;

Retornos

O nome de exibição da planilha. O nome deve ter menos de 32 caracteres.

getName(): string;

Retornos

Exemplos

/**
 * 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);
}

Obtém um NamedItem objeto usando seu nome. Se o objeto não existir, esse método retornará undefined.

getNamedItem(name: string): NamedItem | undefined;

Parâmetros

Retornos

Obtém uma exibição de planilha usando seu nome. Se o objeto de exibição de planilha não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true.

getNamedSheetView(key: string): NamedSheetView | undefined;

Parâmetros

Retornos

Retorna uma coleção de modos de exibição de planilha que estão presentes na planilha.

getNamedSheetViews(): NamedSheetView[];

Retornos

Coleção de nomes com escopo para a planilha atual.

getNames(): NamedItem[];

Retornos

Obtém a planilha seguinte a esta. Se não houver planilhas após esta, esse método retornará undefined.

getNext(visibleOnly?: boolean): Worksheet;

Parâmetros

Retornos

Obtém o PageLayout objeto da planilha.

getPageLayout(): PageLayout;

Retornos

Exemplos

/**
 * 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);
  });
}

Obtém uma Tabela Dinâmica por nome. Se a Tabela Dinâmica não existir, esse método retornará undefined.

getPivotTable(name: string): PivotTable | undefined;

Parâmetros

Retornos

Coleção de Tabelas Dinâmicas que fazem parte da planilha.

getPivotTables(): PivotTable[];

Retornos

A posição baseada em zero da planilha na pasta de trabalho.

getPosition(): number;

Retornos

Obtém a planilha que antecede esta. Se não houver planilhas anteriores, esse método retornará undefined.

getPrevious(visibleOnly?: boolean): Worksheet;

Parâmetros

Retornos

Retorna o objeto de proteção da planilha para uma planilha.

getProtection(): WorksheetProtection;

Retornos

Exemplos

/**
 * 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);
}

Obtém o Range objeto, representando um único bloco retangular de células, especificado pelo endereço ou nome.

getRange(address?: string): Range;

Parâmetros

Retornos

Exemplos

/**
 * 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());
}

Faz com que o Range objeto comece em um determinado índice de linha e índice de coluna, e abrangendo um determinado número de linhas e colunas.

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

Parâmetros

Retornos

Obtém o RangeAreas objeto, representando um ou mais blocos de intervalos retangulares, especificados pelo endereço ou nome.

getRanges(address?: string): RangeAreas;

Parâmetros

Retornos

Obtém uma forma usando seu nome ou ID. Se o objeto de forma não existir, esse método retornará undefined.

getShape(key: string): Shape | undefined;

Parâmetros

Retornos

Retorna a coleção de todos os objetos Shape na planilha.

getShapes(): Shape[];

Retornos

Especifica se os ícones de tipo de dados estão visíveis na planilha. Por padrão, os ícones de tipo de dados ficam visíveis.

getShowDataTypeIcons(): boolean;

Retornos

Especifica se as linhas de grade são visíveis para o usuário.

getShowGridlines(): boolean;

Retornos

Especifica se os títulos são visíveis para o usuário.

getShowHeadings(): boolean;

Retornos

Obtém uma segmentação usando seu nome ou ID. Se a segmentação não existir, esse método retornará undefined.

getSlicer(key: string): Slicer | undefined;

Parâmetros

Retornos

Retorna uma coleção de segmentações de dados que fazem parte da planilha.

getSlicers(): Slicer[];

Retornos

Retorna a altura padrão de todas as linhas na planilha, em pontos.

getStandardHeight(): number;

Retornos

Especifica a largura padrão (padrão) de todas as colunas na planilha. Uma unidade de largura de coluna equivale à largura de um caractere no estilo Normal. Para fontes proporcionais, será usada a largura do caractere 0 (zero).

getStandardWidth(): number;

Retornos

A cor da guia da planilha. Ao recuperar a cor da guia, se a planilha estiver invisível, o valor será null. Se a planilha estiver visível, mas a cor da guia estiver definida como automática, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor no formato #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, use uma string vazia para definir uma cor "automática" ou uma cor real caso contrário.

getTabColor(): string;

Retornos

Retorna um valor que representa essa planilha que pode ser lido pelo Open Office XML. Este é um valor inteiro, que é diferente de worksheet.id (que retorna um identificador global exclusivo) e worksheet.name (que retorna um valor como "Sheet1").

getTabId(): number;

Retornos

Obtém uma tabela pelo nome ou ID. Se a tabela não existir, esse método retornará undefined.

getTable(key: string): Table | undefined;

Parâmetros

Retornos

Coleção de tabelas que fazem parte da planilha.

getTables(): Table[];

Retornos

O intervalo usado é o menor intervalo que abrange todas as células que têm um valor ou uma formatação atribuída a elas. Se toda a planilha estiver em branco, esse método retornará undefined.

getUsedRange(valuesOnly?: boolean): Range;

Parâmetros

Retornos

Obtém a coleção de quebra de página vertical da planilha. Esta coleção contém apenas quebras de página manuais.

getVerticalPageBreaks(): PageBreak[];

Retornos

A visibilidade da planilha.

getVisibility(): SheetVisibility;

Retornos

Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Se a propriedade personalizada não existir, esse método retornará undefined.

getWorksheetCustomProperty(
            key: string
        ): WorksheetCustomProperty | undefined;

Parâmetros

Retornos

Atualiza todas as tabelas dinâmicas da coleção.

refreshAllPivotTables(): void;

Retornos

Redefine todas as quebras de página manuais na coleção.

removeAllHorizontalPageBreaks(): void;

Retornos

Redefine todas as quebras de página manuais na coleção.

removeAllVerticalPageBreaks(): void;

Retornos

Localiza e substitui a cadeia de caracteres fornecida com base nos critérios especificados na planilha atual.

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

Parâmetros

Retornos

Determina se o Excel deve recalcular a planilha quando necessário. Verdadeiro se o Excel recalcular a planilha quando necessário. False se o Excel não recalcular a planilha.

setEnableCalculation(enableCalculation: boolean): void;

Parâmetros

Retornos

O nome de exibição da planilha. O nome deve ter menos de 32 caracteres.

setName(name: string): void;

Parâmetros

Retornos

Exemplos

/**
 * 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');
}

A posição baseada em zero da planilha na pasta de trabalho.

setPosition(position: number): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
}

Especifica se os ícones de tipo de dados estão visíveis na planilha. Por padrão, os ícones de tipo de dados ficam visíveis.

setShowDataTypeIcons(showDataTypeIcons: boolean): void;

Parâmetros

Retornos

Especifica se as linhas de grade são visíveis para o usuário.

setShowGridlines(showGridlines: boolean): void;

Parâmetros

Retornos

Especifica se os títulos são visíveis para o usuário.

setShowHeadings(showHeadings: boolean): void;

Parâmetros

Retornos

Especifica a largura padrão (padrão) de todas as colunas na planilha. Uma unidade de largura de coluna equivale à largura de um caractere no estilo Normal. Para fontes proporcionais, será usada a largura do caractere 0 (zero).

setStandardWidth(standardWidth: number): void;

Parâmetros

Retornos

A cor da guia da planilha. Ao recuperar a cor da guia, se a planilha estiver invisível, o valor será null. Se a planilha estiver visível, mas a cor da guia estiver definida como automática, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor no formato #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, use uma string vazia para definir uma cor "automática" ou uma cor real caso contrário.

setTabColor(tabColor: string): void;

Parâmetros

Retornos

Exemplos

/**
 * 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");
  }
}

A visibilidade da planilha.

setVisibility(visibility: SheetVisibility): void;

Parâmetros

Retornos

Exemplos

/**
 * 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);
  });
}

Mostra grupos de linha ou coluna por seus níveis de estrutura de tópicos. Descreve grupos e resume uma lista de dados na planilha. Os rowLevels parâmetros and columnLevels especificam quantos níveis da estrutura de tópicos serão exibidos. O intervalo de argumentos aceitável está entre 0 e 8. Um valor de 0 não altera a exibição atual. Um valor maior que o número atual de níveis exibe todos os níveis.

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

Parâmetros

Retornos