ExcelScript.Worksheet interface

Referência

Pacote:: ExcelScript

Uma planilha do Excel é uma grade de células. Ela pode conter dados, tabelas, gráficos, etc.

Comentários

Exemplos

/**
 * This script creates a new worksheet named "Plum" and sets its tab color to purple.
 */
function main(workbook: ExcelScript.Workbook) {
  const newSheet = workbook.addWorksheet("Plum")
  newSheet.setTabColor("purple");
}

Métodos

activate()	Ative a planilha na interface do usuário do Excel.
addChart(type, sourceData, seriesBy)	Cria um novo gráfico.
addComment(cellAddress, content, contentType)	Cria um novo comentário com o conteúdo fornecido na célula especificada. É `InvalidArgument` apresentado um erro se o intervalo fornecido for maior do que uma célula.
addGeometricShape(geometricShapeType)	Adiciona uma forma geométrica à planilha. Devolve um `Shape` objeto que representa a nova forma.
addGroup(values)	Um subconjunto de formas na planilha do conjunto de grupos. Devolve um `Shape` objeto que representa o novo grupo de formas.
addHorizontalPageBreak(pageBreakRange)	Adiciona uma quebra de página antes da célula superior esquerda do intervalo especificado.
addImage(base64ImageString)	Cria uma imagem de uma cadeia de caracteres na base 64 e a adiciona à planilha. Devolve o `Shape` objeto que representa a nova imagem.
addLine(startLeft, startTop, endLeft, endTop, connectorType)	Adiciona uma linha à planilha. Devolve um `Shape` objeto que representa a nova linha.
addNamedItem(name, reference, comment)	Adiciona um novo nome à coleção do escopo fornecido.
addNamedItemFormulaLocal(name, formula, comment)	Adiciona um novo nome à coleção de escopo fornecido usando a localidade do usuário para a fórmula.
addNamedSheetView(name)	Cria uma nova vista de folha com o nome especificado.
addPivotTable(name, source, destination)	Adicione uma tabela dinâmica com base nos dados de origem especificados e insira-a na célula superior esquerda do intervalo de destino.
addSlicer(slicerSource, sourceField, slicerDestination)	Adiciona uma nova segmentação de dados à pasta de trabalho.
addTable(address, hasHeaders)	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.
addTextBox(text)	Adiciona uma caixa de texto na planilha com o texto fornecido como conteúdo. Devolve um `Shape` objeto que representa a nova caixa de texto.
addVerticalPageBreak(pageBreakRange)	Adiciona uma quebra de página antes da célula superior esquerda do intervalo especificado.
addWorksheetCustomProperty(key, value)	Adiciona uma nova propriedade personalizada que mapeia à chave fornecida. Esta ação substitui as propriedades personalizadas existentes por essa chave.
calculate(markAllDirty)	Calcula todas as células em uma planilha.
copy(positionType, relativeTo)	Copia uma folha de cálculo e coloca-a na posição especificada.
delete()	Exclui a planilha da pasta de trabalho. Tenha em atenção que se a visibilidade da folha de cálculo estiver definida como "VeryHidden", a operação de eliminação falhará com uma exceção `InvalidOperation` . Primeiro, deve alterar a visibilidade para oculta ou visível antes de a eliminar.
enterTemporaryNamedSheetView()	Cria e ativa uma nova vista de folha temporária. As vistas temporárias são removidas ao fechar a aplicação, ao sair da vista temporária com o método de saída ou ao mudar para outra vista de folha. A vista de folha temporária também pode ser acedida com a cadeia vazia (""), se a vista temporária existir.
exitActiveNamedSheetView()	Sai da vista de folha atualmente ativa.
findAll(text, criteria)	Localiza todas as ocorrências da cadeia especificada com base nos critérios especificados e devolve-as como um `RangeAreas` objeto, composto por um ou mais intervalos retangulares.
getActiveNamedSheetView()	Obtém a vista de folha de cálculo atualmente ativa.
getAutoFilter()	Representa o `AutoFilter` objeto da folha de cálculo.
getCell(row, column)	Obtém o `Range` objeto que contém a única célula com base nos números de linha e coluna. A célula pode estar fora dos limites do respetivo intervalo principal, desde que permaneça na grelha da folha de cálculo.
getChart(name)	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, este método devolve `undefined`.
getCharts()	Devolve uma coleção de gráficos que fazem parte da folha de cálculo.
getComment(commentId)	Obtém um comentário da coleção com base em seu ID. Se o objeto de comentário não existir, este método devolve `undefined`.
getCommentByCell(cellAddress)	Obtém o comentário da célula especificada. Se não existir nenhum comentário na célula, é gerado um erro.
getCommentByReplyId(replyId)	Obtém o comentário ao qual a resposta especificada está ligada.
getComments()	Retorna um conjunto de todos os objetos Comments na planilha.
getCustomProperties()	Obtém uma coleção de propriedades personalizadas ao nível da folha de cálculo.
getEnableCalculation()	Determina se o Excel deve recalcular a folha de cálculo quando necessário. Verdadeiro se o Excel recalcular a folha de cálculo quando necessário. False se o Excel não recalcular a planilha.
getFreezePanes()	Obtém um objeto que pode ser utilizado para manipular painéis congelados na folha de cálculo.
getHorizontalPageBreaks()	Obtém a coleção de quebra de página horizontal da planilha. Esta coleção contém apenas quebras de página manuais.
getId()	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.
getName()	O nome de exibição da planilha. O nome tem de ter menos de 32 carateres.
getNamedItem(name)	Obtém um `NamedItem` objeto com o respetivo nome. Se o objeto não existir, este método devolve `undefined`.
getNamedSheetView(key)	Obtém uma vista de folha com o respetivo nome. Se o objeto de vista de folha não existir, este método devolve `undefined`.
getNamedSheetViews()	Devolve uma coleção de vistas de folha que estão presentes na folha de cálculo.
getNames()	Coleção de nomes com escopo para a planilha atual.
getNext(visibleOnly)	Obtém a folha de cálculo que se segue a esta. Se não existirem folhas de cálculo a seguir a esta, este método devolve `undefined`.
getPageLayout()	Obtém o `PageLayout` objeto da folha de cálculo.
getPivotTable(name)	Obtém uma Tabela Dinâmica por nome. Se a tabela dinâmica não existir, este método devolve `undefined`.
getPivotTables()	Coleção de Tabelas Dinâmicas que fazem parte da planilha.
getPosition()	A posição baseada em zero da planilha na pasta de trabalho.
getPrevious(visibleOnly)	Obtém a folha de cálculo que precede esta. Se não existirem folhas de cálculo anteriores, este método devolve `undefined`.
getProtection()	Devolve o objeto de proteção de folha para uma folha de cálculo.
getRange(address)	Obtém o `Range` objeto, representando um único bloco retangular de células, especificado pelo endereço ou nome.
getRangeByIndexes(startRow, startColumn, rowCount, columnCount)	Obtém o `Range` objeto a começar num índice de linha e índice de colunas específico e abrange um determinado número de linhas e colunas.
getRanges(address)	Obtém o `RangeAreas` objeto, representando um ou mais blocos de intervalos retangulares, especificados pelo endereço ou nome.
getShape(key)	Obtém uma forma com o respetivo nome ou ID. Se o objeto da forma não existir, este método devolve `undefined`.
getShapes()	Retorna a coleção de todos os objetos Shape na planilha.
getShowGridlines()	Especifica se as linhas de grelha estão visíveis para o utilizador.
getShowHeadings()	Especifica se os cabeçalhos estão visíveis para o utilizador.
getSlicer(key)	Obtém uma segmentação de dados com o respetivo nome ou ID. Se a segmentação de dados não existir, este método devolve `undefined`.
getSlicers()	Devolve uma coleção de segmentações de dados que fazem parte da folha de cálculo.
getStandardHeight()	Retorna a altura padrão de todas as linhas na planilha, em pontos.
getStandardWidth()	Especifica a largura padrão (predefinida) de todas as colunas na folha de cálculo. 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).
getTabColor()	A cor do separador da folha de cálculo. Ao obter a cor do separador, se a folha de cálculo for invisível, o valor será `null`. Se a folha de cálculo estiver visível, mas a cor do separador estiver definida como automática, será devolvida uma cadeia vazia. Caso contrário, a propriedade será definida como uma cor, no formato #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, utilize uma cadeia vazia para definir uma cor "automática" ou uma cor real.
getTabId()	Devolve um valor que representa esta folha de cálculo que pode ser lida por Open Office XML. Trata-se de um valor inteiro, diferente de `worksheet.id` (que devolve um identificador exclusivo global) e `worksheet.name` (que devolve um valor como "Folha1").
getTable(key)	Obtém uma tabela pelo nome ou ID. Se a tabela não existir, este método devolve `undefined`.
getTables()	Coleção de tabelas que fazem parte da planilha.
getUsedRange(valuesOnly)
getVerticalPageBreaks()	Obtém a coleção de quebra de página vertical da planilha. Esta coleção contém apenas quebras de página manuais.
getVisibility()	A visibilidade da planilha.
getWorksheetCustomProperty(key)	Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Se a propriedade personalizada não existir, este método devolve `undefined`.
refreshAllPivotTables()	Atualiza todas as tabelas dinâmicas da coleção.
removeAllHorizontalPageBreaks()	Redefine todas as quebras de página manuais na coleção.
removeAllVerticalPageBreaks()	Redefine todas as quebras de página manuais na coleção.
replaceAll(text, replacement, criteria)	Localiza e substitui a cadeia de caracteres fornecida com base nos critérios especificados na planilha atual.
setEnableCalculation(enableCalculation)	Determina se o Excel deve recalcular a folha de cálculo quando necessário. Verdadeiro se o Excel recalcular a folha de cálculo quando necessário. False se o Excel não recalcular a planilha.
setName(name)	O nome de exibição da planilha. O nome tem de ter menos de 32 carateres.
setPosition(position)	A posição baseada em zero da planilha na pasta de trabalho.
setShowGridlines(showGridlines)	Especifica se as linhas de grelha estão visíveis para o utilizador.
setShowHeadings(showHeadings)	Especifica se os cabeçalhos estão visíveis para o utilizador.
setStandardWidth(standardWidth)	Especifica a largura padrão (predefinida) de todas as colunas na folha de cálculo. 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).
setTabColor(tabColor)	A cor do separador da folha de cálculo. Ao obter a cor do separador, se a folha de cálculo for invisível, o valor será `null`. Se a folha de cálculo estiver visível, mas a cor do separador estiver definida como automática, será devolvida uma cadeia vazia. Caso contrário, a propriedade será definida como uma cor, no formato #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, utilize uma cadeia vazia para definir uma cor "automática" ou uma cor real.
setVisibility(visibility)	A visibilidade da planilha.
showOutlineLevels(rowLevels, columnLevels)	Mostra grupos de linhas ou colunas pelos respetivos níveis hierárquico. Descreve grupos e resume uma lista de dados na folha de cálculo. Os `rowLevels` parâmetros e `columnLevels` especificam quantos níveis do destaque serão apresentados. O intervalo de argumentos aceitável está entre 0 e 8. Um valor de 0 não altera a apresentação atual. Um valor maior do que o número atual de níveis apresenta todos os níveis.

Detalhes do método

activate()

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

activate(): void;

Retornos

void

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

addChart(type, sourceData, seriesBy)

Cria um novo gráfico.

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

Parâmetros

type: ExcelScript.ChartType

Representa o tipo de um gráfico. Veja ExcelScript.ChartType para obter detalhes.

sourceData: ExcelScript.Range

O Range objeto correspondente aos dados de origem.

seriesBy: ExcelScript.ChartSeriesBy

Opcional. Especifica a forma como as colunas ou linhas são usadas como série de dados no gráfico. Veja ExcelScript.ChartSeriesBy para obter detalhes.

Retornos

ExcelScript.Chart

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

addComment(cellAddress, content, contentType)

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

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

Parâmetros

cellAddress: ExcelScript.Range | string

A célula à qual o comentário é adicionado. Pode ser um Range objeto ou uma cadeia. Se for uma cadeia, tem de conter o endereço completo, incluindo o nome da folha. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do que uma célula.

content: ExcelScript.CommentRichContent | string

O conteúdo do comentário. Isto pode ser uma cadeia ou CommentRichContent objeto. As cadeias são utilizadas para texto simples. CommentRichContent os objetos permitem outras funcionalidades de comentários, como menções.

contentType: ExcelScript.ContentType

Opcional. O tipo de conteúdo contido no comentário. O valor predefinido é enum ContentType.Plain.

Retornos

ExcelScript.Comment

addGeometricShape(geometricShapeType)

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

addGeometricShape(geometricShapeType: GeometricShapeType): Shape;

Parâmetros

geometricShapeType: ExcelScript.GeometricShapeType

Representa o tipo da forma geométrica. Veja ExcelScript.GeometricShapeType para obter detalhes.

Retornos

ExcelScript.Shape

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

addGroup(values)

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

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

Parâmetros

values: Array<string | ExcelScript.Shape>

Uma matriz de IDs de formas ou objetos de forma.

Retornos

ExcelScript.Shape

addHorizontalPageBreak(pageBreakRange)

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

addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;

Parâmetros

pageBreakRange: ExcelScript.Range | string

O intervalo imediatamente após a quebra de página a adicionar.

Retornos

ExcelScript.PageBreak

addImage(base64ImageString)

Cria uma imagem de uma cadeia de caracteres na base 64 e a adiciona à planilha. Devolve o Shape objeto que representa a nova imagem.

addImage(base64ImageString: string): Shape;

Parâmetros

base64ImageString: string

Uma cadeia codificada com base64 que representa uma imagem no formato JPEG ou PNG.

Retornos

ExcelScript.Shape

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

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

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

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

Parâmetros

startLeft: number

A distância, em pontos, desde o início da linha até ao lado esquerdo da folha de cálculo.

startTop: number

A distância, em pontos, desde o início da linha até à parte superior da folha de cálculo.

endLeft: number

A distância, em pontos, do fim da linha à esquerda da folha de cálculo.

endTop: number

A distância, em pontos, do fim da linha até à parte superior da folha de cálculo.

connectorType: ExcelScript.ConnectorType

Representa o tipo de conector. Veja ExcelScript.ConnectorType para obter detalhes.

Retornos

ExcelScript.Shape

addNamedItem(name, reference, comment)

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

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

Parâmetros

name: string

O nome do item nomeado.

reference: ExcelScript.Range | string

A fórmula ou o intervalo ao qual o nome fará referência.

comment: string

Opcional. O comentário associado ao item com nome.

Retornos

ExcelScript.NamedItem

addNamedItemFormulaLocal(name, formula, comment)

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

name: string

O nome do item nomeado.

formula: string

A fórmula na localidade do usuário à qual o nome se referirá.

comment: string

Opcional. O comentário associado ao item com nome.

Retornos

ExcelScript.NamedItem

addNamedSheetView(name)

Cria uma nova vista de folha com o nome especificado.

addNamedSheetView(name: string): NamedSheetView;

Parâmetros

name: string

O nome da vista de folha a ser criada. Gera um erro quando o nome fornecido já existe, está vazio ou é um nome reservado pela folha de cálculo.

Retornos

ExcelScript.NamedSheetView

addPivotTable(name, source, destination)

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

name: string

O nome da nova tabela dinâmica.

source: ExcelScript.Range | string | ExcelScript.Table

Os dados de origem da nova tabela dinâmica podem ser um intervalo (ou um endereço de cadeia, incluindo o nome da folha de cálculo) ou uma tabela.

destination: ExcelScript.Range | string

A célula no canto superior esquerdo do intervalo de destino do relatório de tabela dinâmica (o intervalo na planilha em que o relatório resultante será inserido).

Retornos

ExcelScript.PivotTable

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

addSlicer(slicerSource, sourceField, slicerDestination)

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

slicerSource: string | ExcelScript.PivotTable | ExcelScript.Table

A origem de dados na qual a nova segmentação de dados será baseada. Pode ser um PivotTable objeto, um Table objeto ou uma cadeia. Quando um objeto de tabela dinâmica é transmitido, a origem de dados é a origem do PivotTable objeto. Quando um Table objeto é transmitido, a origem de dados é o Table objeto . Quando uma cadeia é transmitida, é interpretada como o nome ou ID de uma tabela dinâmica ou tabela.

sourceField: string | ExcelScript.PivotField | number | ExcelScript.TableColumn

O campo na origem de dados pelo qual filtrar. Pode ser um PivotField objeto, um TableColumn objeto, o ID de um PivotField ou o nome ou ID de um TableColumn.

slicerDestination: string | ExcelScript.Worksheet

Opcional. A folha de cálculo na qual a nova segmentação de dados será criada. Pode ser um Worksheet objeto ou o nome ou ID de uma folha de cálculo. Este parâmetro pode ser omitido se a coleção de segmentação de dados for obtida a partir de uma folha de cálculo.

Retornos

ExcelScript.Slicer

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

addTable(address, hasHeaders)

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

address: ExcelScript.Range | string

Um Range objeto ou um endereço de cadeia ou nome do intervalo que representa a origem de dados. Se o endereço não contiver o nome de uma planilha, a folha ativa no momento será usada.

hasHeaders: boolean

Um valor booleano que indica se os dados que estão a ser importados têm etiquetas de coluna. Se a origem não contiver cabeçalhos (ou seja, quando esta propriedade estiver definida como false), o Excel irá gerar automaticamente um cabeçalho e deslocar os dados para baixo uma linha.

Retornos

ExcelScript.Table

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

addTextBox(text)

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

addTextBox(text?: string): Shape;

Parâmetros

text: string

Representa o texto que será apresentado na caixa de texto criada.

Retornos

ExcelScript.Shape

addVerticalPageBreak(pageBreakRange)

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

addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;

Parâmetros

pageBreakRange: ExcelScript.Range | string

O intervalo imediatamente após a quebra de página a adicionar.

Retornos

ExcelScript.PageBreak

addWorksheetCustomProperty(key, value)

Adiciona uma nova propriedade personalizada que mapeia à chave fornecida. Esta ação substitui as propriedades personalizadas existentes por essa chave.

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

Parâmetros

key: string

A chave que identifica o objeto de propriedade personalizada. Não é sensível a maiúsculas e minúsculas. A chave está limitada a 255 carateres (os valores maiores causarão um InvalidArgument erro.)

value: string

O valor desta propriedade personalizada.

Retornos

ExcelScript.WorksheetCustomProperty

calculate(markAllDirty)

Calcula todas as células em uma planilha.

calculate(markAllDirty: boolean): void;

Parâmetros

markAllDirty: boolean

É verdade, marcar tudo como sujo.

Retornos

void

copy(positionType, relativeTo)

Copia uma folha de cálculo e coloca-a na posição especificada.

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

Parâmetros

positionType: ExcelScript.WorksheetPositionType

A localização no livro para colocar a folha de cálculo criada recentemente. O valor predefinido é "Nenhum", que insere a folha de cálculo no início da folha de cálculo.

relativeTo: ExcelScript.Worksheet

A folha de cálculo existente que determina a posição da folha de cálculo recentemente criada. Isto só é necessário se positionType for "Antes" ou "Depois".

Retornos

ExcelScript.Worksheet

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

delete()

Exclui a planilha da pasta de trabalho. Tenha em atenção que se a visibilidade da folha de cálculo estiver definida como "VeryHidden", a operação de eliminação falhará com uma exceção InvalidOperation . Primeiro, deve alterar a visibilidade para oculta ou visível antes de a eliminar.

delete(): void;

Retornos

void

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

enterTemporaryNamedSheetView()

Cria e ativa uma nova vista de folha temporária. As vistas temporárias são removidas ao fechar a aplicação, ao sair da vista temporária com o método de saída ou ao mudar para outra vista de folha. A vista de folha temporária também pode ser acedida com a cadeia vazia (""), se a vista temporária existir.

enterTemporaryNamedSheetView(): NamedSheetView;

Retornos

ExcelScript.NamedSheetView

exitActiveNamedSheetView()

Sai da vista de folha atualmente ativa.

exitActiveNamedSheetView(): void;

Retornos

void

findAll(text, criteria)

Localiza todas as ocorrências da cadeia especificada com base nos critérios especificados e devolve-as como um RangeAreas objeto, composto por um ou mais intervalos retangulares.

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

Parâmetros

text: string

A cadeia a localizar.

criteria: ExcelScript.WorksheetSearchCriteria

Critérios de pesquisa adicionais, incluindo se a pesquisa precisa de corresponder a toda a célula ou ser sensível a maiúsculas e minúsculas.

Retornos

ExcelScript.RangeAreas

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

getActiveNamedSheetView()

Obtém a vista de folha de cálculo atualmente ativa.

getActiveNamedSheetView(): NamedSheetView;

Retornos

ExcelScript.NamedSheetView

getAutoFilter()

Representa o AutoFilter objeto da folha de cálculo.

getAutoFilter(): AutoFilter;

Retornos

ExcelScript.AutoFilter

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

getCell(row, column)

Obtém o Range objeto que contém a única célula com base nos números de linha e coluna. A célula pode estar fora dos limites do respetivo intervalo principal, desde que permaneça na grelha da folha de cálculo.

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

Parâmetros

row: number

O número da linha da célula a ser recuperada. Indexados com zero.

column: number

O número da coluna da célula a ser recuperada. Indexados com zero.

Retornos

ExcelScript.Range

getChart(name)

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, este método devolve undefined.

getChart(name: string): Chart | undefined;

Parâmetros

name: string

Nome do gráfico a recuperar.

Retornos

ExcelScript.Chart | undefined

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

getCharts()

Devolve uma coleção de gráficos que fazem parte da folha de cálculo.

getCharts(): Chart[];

Retornos

ExcelScript.Chart[]

getComment(commentId)

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

getComment(commentId: string): Comment | undefined;

Parâmetros

commentId: string

O identificador do comentário.

Retornos

ExcelScript.Comment | undefined

getCommentByCell(cellAddress)

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

getCommentByCell(cellAddress: Range | string): Comment;

Parâmetros

cellAddress: ExcelScript.Range | string

A célula na qual o comentário se encontra. Pode ser um Range objeto ou uma cadeia. Se for uma cadeia, tem de conter o endereço completo, incluindo o nome da folha. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do que uma célula.

Retornos

ExcelScript.Comment

getCommentByReplyId(replyId)

Obtém o comentário ao qual a resposta especificada está ligada.

getCommentByReplyId(replyId: string): Comment;

Parâmetros

replyId: string

O identificador da resposta a comentários.

Retornos

ExcelScript.Comment

getComments()

Retorna um conjunto de todos os objetos Comments na planilha.

getComments(): Comment[];

Retornos

ExcelScript.Comment[]

getCustomProperties()

Obtém uma coleção de propriedades personalizadas ao nível da folha de cálculo.

getCustomProperties(): WorksheetCustomProperty[];

Retornos

ExcelScript.WorksheetCustomProperty[]

getEnableCalculation()

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

getEnableCalculation(): boolean;

Retornos

boolean

getFreezePanes()

Obtém um objeto que pode ser utilizado para manipular painéis congelados na folha de cálculo.

getFreezePanes(): WorksheetFreezePanes;

Retornos

ExcelScript.WorksheetFreezePanes

getHorizontalPageBreaks()

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

ExcelScript.PageBreak[]

getId()

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

string

getName()

O nome de exibição da planilha. O nome tem de ter menos de 32 carateres.

getName(): string;

Retornos

string

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

getNamedItem(name)

Obtém um NamedItem objeto com o respetivo nome. Se o objeto não existir, este método devolve undefined.

getNamedItem(name: string): NamedItem | undefined;

Parâmetros

name: string

Nome nameitem.

Retornos

ExcelScript.NamedItem | undefined

getNamedSheetView(key)

Obtém uma vista de folha com o respetivo nome. Se o objeto de vista de folha não existir, este método devolve undefined.

getNamedSheetView(key: string): NamedSheetView | undefined;

Parâmetros

key: string

O nome sensível às maiúsculas e minúsculas da vista de folha. Utilize a cadeia vazia ("") para obter a vista de folha temporária, se a vista temporária existir.

Retornos

ExcelScript.NamedSheetView | undefined

getNamedSheetViews()

Devolve uma coleção de vistas de folha que estão presentes na folha de cálculo.

getNamedSheetViews(): NamedSheetView[];

Retornos

ExcelScript.NamedSheetView[]

getNames()

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

getNames(): NamedItem[];

Retornos

ExcelScript.NamedItem[]

getNext(visibleOnly)

Obtém a folha de cálculo que se segue a esta. Se não existirem folhas de cálculo a seguir a esta, este método devolve undefined.

getNext(visibleOnly?: boolean): Worksheet;

Parâmetros

visibleOnly: boolean

Opcional. Se true, considera apenas folhas de cálculo visíveis, ignorando quaisquer folhas ocultas.

Retornos

ExcelScript.Worksheet

getPageLayout()

Obtém o PageLayout objeto da folha de cálculo.

getPageLayout(): PageLayout;

Retornos

ExcelScript.PageLayout

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

getPivotTable(name)

Obtém uma Tabela Dinâmica por nome. Se a tabela dinâmica não existir, este método devolve undefined.

getPivotTable(name: string): PivotTable | undefined;

Parâmetros

name: string

Nome da Tabela Dinâmica a ser recuperada.

Retornos

ExcelScript.PivotTable | undefined

getPivotTables()

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

getPivotTables(): PivotTable[];

Retornos

ExcelScript.PivotTable[]

getPosition()

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

getPosition(): number;

Retornos

number

getPrevious(visibleOnly)

Obtém a folha de cálculo que precede esta. Se não existirem folhas de cálculo anteriores, este método devolve undefined.

getPrevious(visibleOnly?: boolean): Worksheet;

Parâmetros

visibleOnly: boolean

Opcional. Se true, considera apenas folhas de cálculo visíveis, ignorando quaisquer folhas ocultas.

Retornos

ExcelScript.Worksheet

getProtection()

Devolve o objeto de proteção de folha para uma folha de cálculo.

getProtection(): WorksheetProtection;

Retornos

ExcelScript.WorksheetProtection

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

getRange(address)

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

address: string

Opcional. A cadeia que representa o endereço ou nome do intervalo. Por exemplo, "A1:B2". Caso não seja especificado, todo o intervalo da planilha será retornado.

Retornos

ExcelScript.Range

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

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Obtém o Range objeto a começar num índice de linha e índice de colunas específico e abrange um determinado número de linhas e colunas.

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

Parâmetros

startRow: number

Linha inicial (indexada a zero).

startColumn: number

Coluna Inicial (indexada a zero).

rowCount: number

Número de linhas a incluir no intervalo.

columnCount: number

Número de colunas a incluir no intervalo.

Retornos

ExcelScript.Range

getRanges(address)

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

address: string

Opcional. Uma cadeia que contém os endereços separados por vírgulas ou separados por ponto e vírgula ou nomes dos intervalos individuais. Por exemplo, "A1:B2, A5:B5" ou "A1:B2; A5:B5". Se não for especificado, é devolvido um RangeAreas objeto para toda a folha de cálculo.

Retornos

ExcelScript.RangeAreas

getShape(key)

Obtém uma forma com o respetivo nome ou ID. Se o objeto da forma não existir, este método devolve undefined.

getShape(key: string): Shape | undefined;

Parâmetros

key: string

O nome ou ID da forma a obter.

Retornos

ExcelScript.Shape | undefined

getShapes()

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

getShapes(): Shape[];

Retornos

ExcelScript.Shape[]

getShowGridlines()

Especifica se as linhas de grelha estão visíveis para o utilizador.

getShowGridlines(): boolean;

Retornos

boolean

getShowHeadings()

Especifica se os cabeçalhos estão visíveis para o utilizador.

getShowHeadings(): boolean;

Retornos

boolean

getSlicer(key)

Obtém uma segmentação de dados com o respetivo nome ou ID. Se a segmentação de dados não existir, este método devolve undefined.

getSlicer(key: string): Slicer | undefined;

Parâmetros

key: string

Nome ou ID da segmentação de dados a obter.

Retornos

ExcelScript.Slicer | undefined

getSlicers()

Devolve uma coleção de segmentações de dados que fazem parte da folha de cálculo.

getSlicers(): Slicer[];

Retornos

ExcelScript.Slicer[]

getStandardHeight()

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

getStandardHeight(): number;

Retornos

number

getStandardWidth()

Especifica a largura padrão (predefinida) de todas as colunas na folha de cálculo. 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

number

getTabColor()

A cor do separador da folha de cálculo. Ao obter a cor do separador, se a folha de cálculo for invisível, o valor será null. Se a folha de cálculo estiver visível, mas a cor do separador estiver definida como automática, será devolvida uma cadeia vazia. Caso contrário, a propriedade será definida como uma cor, no formato #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, utilize uma cadeia vazia para definir uma cor "automática" ou uma cor real.

getTabColor(): string;

Retornos

string

getTabId()

Devolve um valor que representa esta folha de cálculo que pode ser lida por Open Office XML. Trata-se de um valor inteiro, diferente de worksheet.id (que devolve um identificador exclusivo global) e worksheet.name (que devolve um valor como "Folha1").

getTabId(): number;

Retornos

number

getTable(key)

Obtém uma tabela pelo nome ou ID. Se a tabela não existir, este método devolve undefined.

getTable(key: string): Table | undefined;

Parâmetros

key: string

Nome ou ID da tabela a ser recuperada.

Retornos

ExcelScript.Table | undefined

getTables()

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

getTables(): Table[];

Retornos

ExcelScript.Table[]

getUsedRange(valuesOnly)

getUsedRange(valuesOnly?: boolean): Range;

Parâmetros

valuesOnly: boolean

Opcional. Considera apenas as células com valores como células usadas.

Retornos

ExcelScript.Range

getVerticalPageBreaks()

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

ExcelScript.PageBreak[]

getVisibility()

A visibilidade da planilha.

getVisibility(): SheetVisibility;

Retornos

ExcelScript.SheetVisibility

getWorksheetCustomProperty(key)

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

getWorksheetCustomProperty(
            key: string
        ): WorksheetCustomProperty | undefined;

Parâmetros

key: string

A chave que identifica o objeto de propriedade personalizada. Não é sensível a maiúsculas e minúsculas.

Retornos

ExcelScript.WorksheetCustomProperty | undefined

refreshAllPivotTables()

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

refreshAllPivotTables(): void;

Retornos

void

removeAllHorizontalPageBreaks()

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

removeAllHorizontalPageBreaks(): void;

Retornos

void

removeAllVerticalPageBreaks()

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

removeAllVerticalPageBreaks(): void;

Retornos

void

replaceAll(text, replacement, criteria)

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

text: string

Cadeia a localizar.

replacement: string

A cadeia que substitui a cadeia original.

criteria: ExcelScript.ReplaceCriteria

Critérios de substituição adicionais.

Retornos

number

setEnableCalculation(enableCalculation)

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

setEnableCalculation(enableCalculation: boolean): void;

Parâmetros

enableCalculation: boolean

Retornos

void

setName(name)

O nome de exibição da planilha. O nome tem de ter menos de 32 carateres.

setName(name: string): void;

Parâmetros

name: string

Retornos

void

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

setPosition(position)

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

setPosition(position: number): void;

Parâmetros

position: number

Retornos

void

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

setShowGridlines(showGridlines)

Especifica se as linhas de grelha estão visíveis para o utilizador.

setShowGridlines(showGridlines: boolean): void;

Parâmetros

showGridlines: boolean

Retornos

void

setShowHeadings(showHeadings)

Especifica se os cabeçalhos estão visíveis para o utilizador.

setShowHeadings(showHeadings: boolean): void;

Parâmetros

showHeadings: boolean

Retornos

void

setStandardWidth(standardWidth)

setStandardWidth(standardWidth: number): void;

Parâmetros

standardWidth: number

Retornos

void

setTabColor(tabColor)

setTabColor(tabColor: string): void;

Parâmetros

tabColor: string

Retornos

void

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

setVisibility(visibility)

A visibilidade da planilha.

setVisibility(visibility: SheetVisibility): void;

Parâmetros

visibility: ExcelScript.SheetVisibility

Retornos

void

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

showOutlineLevels(rowLevels, columnLevels)

Mostra grupos de linhas ou colunas pelos respetivos níveis hierárquico. Descreve grupos e resume uma lista de dados na folha de cálculo. Os rowLevels parâmetros e columnLevels especificam quantos níveis do destaque serão apresentados. O intervalo de argumentos aceitável está entre 0 e 8. Um valor de 0 não altera a apresentação atual. Um valor maior do que o número atual de níveis apresenta todos os níveis.

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

Parâmetros

rowLevels: number

O número de níveis de linha de um destaque a apresentar.

columnLevels: number

O número de níveis de coluna de um destaque a apresentar.

Retornos

void

Compartilhar via

ExcelScript.Worksheet interface

Comentários

Exemplos

Métodos

Detalhes do método

activate()

Retornos

Exemplos

addChart(type, sourceData, seriesBy)

Parâmetros

Retornos

Exemplos

addComment(cellAddress, content, contentType)

Parâmetros

Retornos

addGeometricShape(geometricShapeType)

Parâmetros

Retornos

Exemplos

addGroup(values)

Parâmetros

Retornos

addHorizontalPageBreak(pageBreakRange)

Parâmetros

Retornos

addImage(base64ImageString)

Parâmetros

Retornos

Exemplos

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

Parâmetros

Retornos

addNamedItem(name, reference, comment)

Parâmetros

Retornos

addNamedItemFormulaLocal(name, formula, comment)

Parâmetros

Retornos

addNamedSheetView(name)

Parâmetros

Retornos

addPivotTable(name, source, destination)

Parâmetros

Retornos

Exemplos

addSlicer(slicerSource, sourceField, slicerDestination)

Parâmetros

Retornos

Exemplos

addTable(address, hasHeaders)

Parâmetros

Retornos

Exemplos

addTextBox(text)

Parâmetros

Retornos

addVerticalPageBreak(pageBreakRange)

Parâmetros

Retornos

addWorksheetCustomProperty(key, value)

Parâmetros

Retornos

calculate(markAllDirty)

Parâmetros

Retornos

copy(positionType, relativeTo)

Parâmetros

Retornos

Exemplos

delete()

Retornos

Exemplos

enterTemporaryNamedSheetView()

Retornos

exitActiveNamedSheetView()

Retornos

findAll(text, criteria)

Parâmetros

Retornos