ExcelScript.Workbook interface

A pasta de trabalho é o objeto de nível superior que inclui os objetos workbook relacionados, como planilhas, tabelas, intervalos, etc.

Métodos

addBinding(range, bindingType, id)

Adiciona uma nova associação a um intervalo específico.

addBindingFromNamedItem(name, bindingType, id)

Adiciona uma nova associação com base em um item nomeado na pasta de trabalho. Se o item nomeado fizer referência a várias áreas, o erro "InvalidReference" será retornado.

addBindingFromSelection(bindingType, id)

Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, o erro "InvalidReference" será retornado.

addComment(cellAddress, content, contentType)

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

addCustomXmlPart(xml)

Adiciona uma nova parte XML personalizada à pasta de trabalho.

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.

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.

addPivotTableStyle(name, makeUniqueName)

Cria uma Tabela Dinâmica em branco com o nome especificado.

addPredefinedCellStyle(name)

Adiciona um novo estilo para o conjunto.

addSlicer(slicerSource, sourceField, slicerDestination)

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

addSlicerStyle(name, makeUniqueName)

Cria um SlicerStyle em branco com o nome especificado.

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.

addTableStyle(name, makeUniqueName)

Cria um TableStyle em branco com o nome especificado.

addTimelineStyle(name, makeUniqueName)

Cria um TimelineStyle em branco com o nome especificado.

addWorksheet(name)

Adiciona uma nova planilha à pasta de trabalho. A planilha será adicionada ao final das planilhas existentes. Se você quiser ativar a planilha recém-adicionada, chame “.activate()” nela.

getActiveCell()

Obtém a célula ativa no momento da pasta de trabalho.

getActiveChart()

Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver nenhum gráfico ativo, um objeto nulo será retornado.

getActiveSlicer()

Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver segmentação de dados ativa, um objeto nulo será retornado.

getActiveWorksheet()

Obtém a planilha ativa no momento na pasta de trabalho.

getApplication()

Representa a instância do aplicativo Excel que contém esta pasta de trabalho.

getAutoSave()

Especifica se a pasta de trabalho está no modo de salvamento automático.

getBinding(id)

Obtém um objeto binding pela ID. Se o objeto binding não existir, retornará um objeto null.

getBindings()

Representa uma coleção de ligações que fazem parte da pasta de trabalho.

getCalculationEngineVersion()

Retorna um número sobre a versão do Mecanismo de Cálculo do Excel.

getChartDataPointTrack()

True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. False se os gráficos acompanham o índice dos pontos de dados.

getComment(commentId)

Obtém um comentário da coleção com base em seu ID.

getCommentByCell(cellAddress)

Obtém o comentário da célula especificada.

getCommentByReplyId(replyId)

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

getComments()

Representa uma coleção de comentários associados à pasta de trabalho.

getCustomXmlPart(id)

Obtém uma parte XML personalizada com base em sua ID. Se o CustomXmlPart não existir, a propriedade isNull do objeto Return será true.

getCustomXmlPartByNamespace(namespaceUri)

Obtém uma nova coleção com escopo de partes XML personalizadas cujos namespaces correspondem ao namespace especificado.

getCustomXmlParts()

Representa a coleção de partes XML personalizadas contidas por esta pasta de trabalho.

getDefaultPivotTableStyle()

Obtém a Tabela Dinâmica padrão para o escopo do objeto pai.

getDefaultSlicerStyle()

Obtém o padrão SlicerStyle para o escopo do objeto pai.

getDefaultTableStyle()

Obtém o padrão TableStyle para o escopo do objeto pai.

getDefaultTimelineStyle()

Obtém o padrão TimelineStyle para o escopo do objeto pai.

getFirstWorksheet(visibleOnly)

Obtém a primeira planilha na coleção.

getIsDirty()

Especifica se foram feitas alterações desde a última vez em que a pasta de trabalho foi salva. Você pode definir essa propriedade como true se quiser fechar uma pasta de trabalho modificada sem salvá-la ou ser solicitado a salvá-la.

getLastWorksheet(visibleOnly)

Obtém a última planilha na coleção.

getName()

Obtém o nome da pasta de trabalho.

getNamedItem(name)

Obtém um objeto NamedItem usando seu nome. Se o objeto getNamedItem não existir, retornará um objeto null.

getNames()

Representa uma coleção de itens denominados de escopo da pasta de trabalho (chamados intervalos e constantes).

getPivotTable(name)

Obtém uma Tabela Dinâmica por nome. Se a tabela dinâmica não existir, retornará um objeto null.

getPivotTables()

Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.

getPivotTableStyle(name)

Obtém um PivotTableStyle por nome. Se PivotTableStyle não existir, retornará um objeto null.

getPivotTableStyles()

Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.

getPredefinedCellStyle(name)

Obtém um estilo por nome.

getPredefinedCellStyles()

Representa uma coleção de estilos associados à pasta de trabalho.

getPreviouslySaved()

Especifica se a pasta de trabalho já foi salva localmente ou online.

getProperties()

Obtém as propriedades da pasta de trabalho.

getProtection()

Retorna o objeto de proteção de uma pasta de trabalho.

getReadOnly()

True se a pasta de trabalho estiver aberta no modo somente leitura.

getSelectedRange()

Obtém o intervalo único selecionado atualmente da pasta de trabalho. Se houver vários intervalos selecionados, este método gerará um erro.

getSelectedRanges()

Obtém um ou mais intervalos atualmente selecionados da pasta de trabalho. Ao contrário de getSelectedRange(), esse método retorna um objeto RangeAreas que representa todos os intervalos selecionados.

getSlicer(key)

Obtém uma segmentação de dados usando seu nome ou id. Se a ela não existir, retornará um objeto null.

getSlicers()

Representa uma coleção de segmentações de dados associados à pasta de trabalho.

getSlicerStyle(name)

Obtém uma SlicerStyle por nome. Se o SlicerStyle não existir, retornará um objeto null.

getSlicerStyles()

Representa uma coleção de SlicerStyles associados à pasta de trabalho.

getTable(key)

Obtém uma tabela pelo nome ou ID. Se a tabela não existir, retornará um objeto null.

getTables()

Representa uma coleção de tabelas associadas à pasta de trabalho.

getTableStyle(name)

Obtém um TableStyle por nome. Se o TableStyle não existir, retornará um objeto null.

getTableStyles()

Representa uma coleção de TableStyles associadas à pasta de trabalho.

getTimelineStyle(name)

Obtém uma TimelineStyle por nome. Se o TimelineStyle não existir, retornará um objeto null.

getTimelineStyles()

Representa uma coleção de TimelineStyles associados à pasta de trabalho.

getUsePrecisionAsDisplayed()

True se os cálculos dessa pasta de trabalho forem efetuados usando apenas a precisão dos números conforme forem exibidos. Os dados perderão permanentemente a precisão ao mudar essa propriedade de false para true.

getWorksheet(key)

Obtém um objeto worksheet usando o Nome ou ID dele. Se a planilha não existir, retornará um objeto null.

getWorksheets()

Representa uma coleção de planilhas associadas à pasta de trabalho.

refreshAllDataConnections()

Atualiza todas as conexões de dados.

refreshAllPivotTables()

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

setChartDataPointTrack(chartDataPointTrack)

True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. False se os gráficos acompanham o índice dos pontos de dados.

setDefaultPivotTableStyle(newDefaultStyle)

Define a Tabela Dinâmica padrão para uso no escopo do objeto pai.

setDefaultSlicerStyle(newDefaultStyle)

Define o padrão SlicerStyle para uso no escopo do objeto pai.

setDefaultTableStyle(newDefaultStyle)

Define a TableStyle padrão para uso no escopo do objeto pai..

setDefaultTimelineStyle(newDefaultStyle)

Define o padrão TimelineStyle para uso no escopo do objeto pai.

setIsDirty(isDirty)

Especifica se foram feitas alterações desde a última vez em que a pasta de trabalho foi salva. Você pode definir essa propriedade como true se quiser fechar uma pasta de trabalho modificada sem salvá-la ou ser solicitado a salvá-la.

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)

True se os cálculos dessa pasta de trabalho forem efetuados usando apenas a precisão dos números conforme forem exibidos. Os dados perderão permanentemente a precisão ao mudar essa propriedade de false para true.

Detalhes do método

addBinding(range, bindingType, id)

Adiciona uma nova associação a um intervalo específico.

addBinding(
            range: Range | string,
            bindingType: BindingType,
            id: string
        ): Binding;

Parâmetros

range
Range | string

Intervalo para vincular a associação. Pode ser um objeto Range do Excel ou uma cadeia de caracteres. Se for uma cadeia de caracteres, deve conter o endereço completo, incluindo o nome da planilha

bindingType
BindingType

Tipo de associação. Consulte ExcelScript. BindingType.

id
string

Nome da associação.

Retornos

addBindingFromNamedItem(name, bindingType, id)

Adiciona uma nova associação com base em um item nomeado na pasta de trabalho. Se o item nomeado fizer referência a várias áreas, o erro "InvalidReference" será retornado.

addBindingFromNamedItem(
            name: string,
            bindingType: BindingType,
            id: string
        ): Binding;

Parâmetros

name
string

Nome do qual deseja criar a associação.

bindingType
BindingType

Tipo de associação. Consulte ExcelScript. BindingType.

id
string

Nome da associação.

Retornos

addBindingFromSelection(bindingType, id)

Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias áreas, o erro "InvalidReference" será retornado.

addBindingFromSelection(bindingType: BindingType, id: string): Binding;

Parâmetros

bindingType
BindingType

Tipo de associação. Consulte ExcelScript. BindingType.

id
string

Nome da associação.

Retornos

addComment(cellAddress, content, contentType)

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

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

Parâmetros

cellAddress
Range | string

A célula à qual o comentário é adicionado. Pode ser um objeto Range ou uma cadeia de caracteres. Se for uma cadeia de caracteres, ela deve conter o endereço completo, incluindo o nome da planilha. Um InvalidArgument erro será acionado se o intervalo fornecido for maior que uma célula.

content
CommentRichContent | string

O conteúdo do comentário. Pode ser um objeto String ou CommentRichContent. As cadeias de caracteres são usadas para texto sem formatação. Os objetos CommentRichContent permitem outros recursos de comentários, como menção.

contentType
ContentType

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

Retornos

addCustomXmlPart(xml)

Adiciona uma nova parte XML personalizada à pasta de trabalho.

addCustomXmlPart(xml: string): CustomXmlPart;

Parâmetros

xml
string

Conteúdo XML. Deve ser um fragmento XML válido.

Retornos

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
Range | string

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

comment
string

Opcional. O comentário associado ao item nomeado.

Retornos

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 nomeado.

Retornos

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
Range | string | Table

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

destination
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

addPivotTableStyle(name, makeUniqueName)

Cria uma Tabela Dinâmica em branco com o nome especificado.

addPivotTableStyle(
            name: string,
            makeUniqueName?: boolean
        ): PivotTableStyle;

Parâmetros

name
string

O nome exclusivo para o novo PivotTable. Lançará uma exceção de argumento inválida se o nome já estiver em uso.

makeUniqueName
boolean

Opcional, o padrão é false. Se true, acrescentará números ao nome para torná-lo exclusivo, se necessário.

Retornos

addPredefinedCellStyle(name)

Adiciona um novo estilo para o conjunto.

addPredefinedCellStyle(name: string): void;

Parâmetros

name
string

Nome do estilo a ser adicionado.

Retornos

void

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 | PivotTable | Table

A fonte de dados na qual o novo slicer será baseado. Pode ser um objeto PivotTable, um objeto Table ou uma cadeia de caracteres. Quando um objeto PivotTable é passado, a fonte de dados é a fonte do objeto PivotTable. Quando um objeto Table é passado, a fonte de dados é o objeto Table. Quando uma cadeia de caracteres é passada, ela é interpretada como o nome/ID de uma tabela dinâmica.

sourceField
string | PivotField | number | TableColumn

O campo na fonte de dados a ser filtrado. Pode ser um objeto PivotField, um objeto TableColumn, a ID de um PivotField ou a ID/nome de TableColumn.

slicerDestination
string | Worksheet

Opcional. A planilha na qual a nova segmentação de trabalho será criada. Pode ser um objeto Worksheet ou o nome/ID de uma planilha. Esse parâmetro pode ser omitido se a coleção slicer for recuperada da planilha.

Retornos

addSlicerStyle(name, makeUniqueName)

Cria um SlicerStyle em branco com o nome especificado.

addSlicerStyle(name: string, makeUniqueName?: boolean): SlicerStyle;

Parâmetros

name
string

O nome exclusivo do novo SlicerStyle. Lançará uma exceção de argumento inválida se o nome já estiver em uso.

makeUniqueName
boolean

Opcional, o padrão é false. Se true, acrescentará números ao nome para torná-lo exclusivo, se necessário.

Retornos

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
Range | string

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

hasHeaders
boolean

Valor booliano que indica se os dados que estão sendo importados têm rótulos de coluna. Se a origem não contiver cabeçalhos (ou seja, quando essa propriedade estiver definida como falso), o Excel gerará automaticamente um cabeçalho, deslocando os dados uma linha para baixo.

Retornos

addTableStyle(name, makeUniqueName)

Cria um TableStyle em branco com o nome especificado.

addTableStyle(name: string, makeUniqueName?: boolean): TableStyle;

Parâmetros

name
string

O nome exclusivo do novo TableStyle. Lançará uma exceção de argumento inválida se o nome já estiver em uso.

makeUniqueName
boolean

Opcional, o padrão é false. Se true, acrescentará números ao nome para torná-lo exclusivo, se necessário.

Retornos

addTimelineStyle(name, makeUniqueName)

Cria um TimelineStyle em branco com o nome especificado.

addTimelineStyle(name: string, makeUniqueName?: boolean): TimelineStyle;

Parâmetros

name
string

O nome exclusivo para o novo timelinestyle. Lançará uma exceção de argumento inválida se o nome já estiver em uso.

makeUniqueName
boolean

Opcional, o padrão é false. Se true, acrescentará números ao nome para torná-lo exclusivo, se necessário.

Retornos

addWorksheet(name)

Adiciona uma nova planilha à pasta de trabalho. A planilha será adicionada ao final das planilhas existentes. Se você quiser ativar a planilha recém-adicionada, chame “.activate()” nela.

addWorksheet(name?: string): Worksheet;

Parâmetros

name
string

Opcional. O nome da planilha a ser adicionada. Se especificado, o nome deve ser exclusivo. Se não especificado, o Excel determina o nome da nova planilha.

Retornos

getActiveCell()

Obtém a célula ativa no momento da pasta de trabalho.

getActiveCell(): Range;

Retornos

Exemplos

/**
 * This script logs the value of the current active cell. 
 * If multiple cells are selected, the top-leftmost cell will be logged.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current active cell in the workbook.
  let cell = workbook.getActiveCell();
  console.log(`The current cell's value is ${cell.getValue()}`);
}

getActiveChart()

Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver nenhum gráfico ativo, um objeto nulo será retornado.

getActiveChart(): Chart;

Retornos

getActiveSlicer()

Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver segmentação de dados ativa, um objeto nulo será retornado.

getActiveSlicer(): Slicer;

Retornos

getActiveWorksheet()

Obtém a planilha ativa no momento na pasta de trabalho.

getActiveWorksheet(): Worksheet;

Retornos

getApplication()

Representa a instância do aplicativo Excel que contém esta pasta de trabalho.

getApplication(): Application;

Retornos

getAutoSave()

Especifica se a pasta de trabalho está no modo de salvamento automático.

getAutoSave(): boolean;

Retornos

boolean

getBinding(id)

Obtém um objeto binding pela ID. Se o objeto binding não existir, retornará um objeto null.

getBinding(id: string): Binding | undefined;

Parâmetros

id
string

ID do objeto de associação a ser recuperado.

Retornos

Binding | undefined

getBindings()

Representa uma coleção de ligações que fazem parte da pasta de trabalho.

getBindings(): Binding[];

Retornos

getCalculationEngineVersion()

Retorna um número sobre a versão do Mecanismo de Cálculo do Excel.

getCalculationEngineVersion(): number;

Retornos

number

getChartDataPointTrack()

True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. False se os gráficos acompanham o índice dos pontos de dados.

getChartDataPointTrack(): boolean;

Retornos

boolean

getComment(commentId)

Obtém um comentário da coleção com base em seu ID.

getComment(commentId: string): Comment;

Parâmetros

commentId
string

O identificador para o comentário.

Retornos

getCommentByCell(cellAddress)

Obtém o comentário da célula especificada.

getCommentByCell(cellAddress: Range | string): Comment;

Parâmetros

cellAddress
Range | string

A célula na qual o comentário está. Pode ser um objeto Range ou uma cadeia de caracteres. Se for uma cadeia de caracteres, ela deve conter o endereço completo, incluindo o nome da planilha. Um InvalidArgument erro será acionado se o intervalo fornecido for maior que uma célula.

Retornos

getCommentByReplyId(replyId)

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

getCommentByReplyId(replyId: string): Comment;

Parâmetros

replyId
string

O identificador de resposta de comentário.

Retornos

getComments()

Representa uma coleção de comentários associados à pasta de trabalho.

getComments(): Comment[];

Retornos

getCustomXmlPart(id)

Obtém uma parte XML personalizada com base em sua ID. Se o CustomXmlPart não existir, a propriedade isNull do objeto Return será true.

getCustomXmlPart(id: string): CustomXmlPart | undefined;

Parâmetros

id
string

ID do objeto a ser recuperado.

Retornos

CustomXmlPart | undefined

getCustomXmlPartByNamespace(namespaceUri)

Obtém uma nova coleção com escopo de partes XML personalizadas cujos namespaces correspondem ao namespace especificado.

getCustomXmlPartByNamespace(namespaceUri: string): CustomXmlPart[];

Parâmetros

namespaceUri
string

Este deve ser um URI de esquema totalmente qualificado; por exemplo, " http://schemas.contoso.com/review/1.0 ".

Retornos

getCustomXmlParts()

Representa a coleção de partes XML personalizadas contidas por esta pasta de trabalho.

getCustomXmlParts(): CustomXmlPart[];

Retornos

getDefaultPivotTableStyle()

Obtém a Tabela Dinâmica padrão para o escopo do objeto pai.

getDefaultPivotTableStyle(): PivotTableStyle;

Retornos

getDefaultSlicerStyle()

Obtém o padrão SlicerStyle para o escopo do objeto pai.

getDefaultSlicerStyle(): SlicerStyle;

Retornos

getDefaultTableStyle()

Obtém o padrão TableStyle para o escopo do objeto pai.

getDefaultTableStyle(): TableStyle;

Retornos

getDefaultTimelineStyle()

Obtém o padrão TimelineStyle para o escopo do objeto pai.

getDefaultTimelineStyle(): TimelineStyle;

Retornos

getFirstWorksheet(visibleOnly)

Obtém a primeira planilha na coleção.

getFirstWorksheet(visibleOnly?: boolean): Worksheet;

Parâmetros

visibleOnly
boolean

Opcional. Se true, só considera planilhas visíveis, ignorando as ocultas.

Retornos

getIsDirty()

Especifica se foram feitas alterações desde a última vez em que a pasta de trabalho foi salva. Você pode definir essa propriedade como true se quiser fechar uma pasta de trabalho modificada sem salvá-la ou ser solicitado a salvá-la.

getIsDirty(): boolean;

Retornos

boolean

getLastWorksheet(visibleOnly)

Obtém a última planilha na coleção.

getLastWorksheet(visibleOnly?: boolean): Worksheet;

Parâmetros

visibleOnly
boolean

Opcional. Se true, só considera planilhas visíveis, ignorando as ocultas.

Retornos

getName()

Obtém o nome da pasta de trabalho.

getName(): string;

Retornos

string

getNamedItem(name)

Obtém um objeto NamedItem usando seu nome. Se o objeto getNamedItem não existir, retornará um objeto null.

getNamedItem(name: string): NamedItem | undefined;

Parâmetros

name
string

NamedItem Name.

Retornos

NamedItem | undefined

getNames()

Representa uma coleção de itens denominados de escopo da pasta de trabalho (chamados intervalos e constantes).

getNames(): NamedItem[];

Retornos

getPivotTable(name)

Obtém uma Tabela Dinâmica por nome. Se a tabela dinâmica não existir, retornará um objeto null.

getPivotTable(name: string): PivotTable | undefined;

Parâmetros

name
string

Nome da Tabela Dinâmica a ser recuperada.

Retornos

PivotTable | undefined

getPivotTables()

Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.

getPivotTables(): PivotTable[];

Retornos

getPivotTableStyle(name)

Obtém um PivotTableStyle por nome. Se PivotTableStyle não existir, retornará um objeto null.

getPivotTableStyle(name: string): PivotTableStyle | undefined;

Parâmetros

name
string

Nome do PivotTable a ser recuperado.

Retornos

PivotTableStyle | undefined

getPivotTableStyles()

Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.

getPivotTableStyles(): PivotTableStyle[];

Retornos

getPredefinedCellStyle(name)

Obtém um estilo por nome.

getPredefinedCellStyle(name: string): PredefinedCellStyle;

Parâmetros

name
string

Nome do estilo a ser recuperado.

Retornos

getPredefinedCellStyles()

Representa uma coleção de estilos associados à pasta de trabalho.

getPredefinedCellStyles(): PredefinedCellStyle[];

Retornos

getPreviouslySaved()

Especifica se a pasta de trabalho já foi salva localmente ou online.

getPreviouslySaved(): boolean;

Retornos

boolean

getProperties()

Obtém as propriedades da pasta de trabalho.

getProperties(): DocumentProperties;

Retornos

getProtection()

Retorna o objeto de proteção de uma pasta de trabalho.

getProtection(): WorkbookProtection;

Retornos

getReadOnly()

True se a pasta de trabalho estiver aberta no modo somente leitura.

getReadOnly(): boolean;

Retornos

boolean

getSelectedRange()

Obtém o intervalo único selecionado atualmente da pasta de trabalho. Se houver vários intervalos selecionados, este método gerará um erro.

getSelectedRange(): Range;

Retornos

getSelectedRanges()

Obtém um ou mais intervalos atualmente selecionados da pasta de trabalho. Ao contrário de getSelectedRange(), esse método retorna um objeto RangeAreas que representa todos os intervalos selecionados.

getSelectedRanges(): RangeAreas;

Retornos

getSlicer(key)

Obtém uma segmentação de dados usando seu nome ou id. Se a ela não existir, retornará um objeto null.

getSlicer(key: string): Slicer | undefined;

Parâmetros

key
string

Nome ou ID da segmentação de, a ser recuperada.

Retornos

Slicer | undefined

getSlicers()

Representa uma coleção de segmentações de dados associados à pasta de trabalho.

getSlicers(): Slicer[];

Retornos

Slicer[]

getSlicerStyle(name)

Obtém uma SlicerStyle por nome. Se o SlicerStyle não existir, retornará um objeto null.

getSlicerStyle(name: string): SlicerStyle | undefined;

Parâmetros

name
string

Nome do SlicerStyle a ser recuperado.

Retornos

SlicerStyle | undefined

getSlicerStyles()

Representa uma coleção de SlicerStyles associados à pasta de trabalho.

getSlicerStyles(): SlicerStyle[];

Retornos

getTable(key)

Obtém uma tabela pelo nome ou ID. Se a tabela não existir, retornará um objeto null.

getTable(key: string): Table | undefined;

Parâmetros

key
string

Nome ou ID da tabela a ser recuperada.

Retornos

Table | undefined

getTables()

Representa uma coleção de tabelas associadas à pasta de trabalho.

getTables(): Table[];

Retornos

Table[]

getTableStyle(name)

Obtém um TableStyle por nome. Se o TableStyle não existir, retornará um objeto null.

getTableStyle(name: string): TableStyle | undefined;

Parâmetros

name
string

Nome do TableStyle a ser recuperado.

Retornos

TableStyle | undefined

getTableStyles()

Representa uma coleção de TableStyles associadas à pasta de trabalho.

getTableStyles(): TableStyle[];

Retornos

getTimelineStyle(name)

Obtém uma TimelineStyle por nome. Se o TimelineStyle não existir, retornará um objeto null.

getTimelineStyle(name: string): TimelineStyle | undefined;

Parâmetros

name
string

Nome do timelinestyle a ser recuperado.

Retornos

TimelineStyle | undefined

getTimelineStyles()

Representa uma coleção de TimelineStyles associados à pasta de trabalho.

getTimelineStyles(): TimelineStyle[];

Retornos

getUsePrecisionAsDisplayed()

True se os cálculos dessa pasta de trabalho forem efetuados usando apenas a precisão dos números conforme forem exibidos. Os dados perderão permanentemente a precisão ao mudar essa propriedade de false para true.

getUsePrecisionAsDisplayed(): boolean;

Retornos

boolean

getWorksheet(key)

Obtém um objeto worksheet usando o Nome ou ID dele. Se a planilha não existir, retornará um objeto null.

getWorksheet(key: string): Worksheet | undefined;

Parâmetros

key
string

O Nome ou ID da planilha.

Retornos

Worksheet | undefined

getWorksheets()

Representa uma coleção de planilhas associadas à pasta de trabalho.

getWorksheets(): Worksheet[];

Retornos

Exemplos

/**
 * This script logs the names of all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();

  // Get a list of all the worksheet names.
  let names = sheets.map ((sheet) => sheet.getName());

  // Write in the console all the worksheet names and the total count.
  console.log(names);
  console.log(`Total worksheets inside of this workbook: ${sheets.length}`);
}

refreshAllDataConnections()

Atualiza todas as conexões de dados.

refreshAllDataConnections(): void;

Retornos

void

refreshAllPivotTables()

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

refreshAllPivotTables(): void;

Retornos

void

setChartDataPointTrack(chartDataPointTrack)

True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. False se os gráficos acompanham o índice dos pontos de dados.

setChartDataPointTrack(chartDataPointTrack: boolean): void;

Parâmetros

chartDataPointTrack
boolean

Retornos

void

setDefaultPivotTableStyle(newDefaultStyle)

Define a Tabela Dinâmica padrão para uso no escopo do objeto pai.

setDefaultPivotTableStyle(
            newDefaultStyle: PivotTableStyle | string
        ): void;

Parâmetros

newDefaultStyle
PivotTableStyle | string

O objeto PivotTable ou o nome do objeto PivotTable que deve ser o novo padrão.

Retornos

void

setDefaultSlicerStyle(newDefaultStyle)

Define o padrão SlicerStyle para uso no escopo do objeto pai.

setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;

Parâmetros

newDefaultStyle
SlicerStyle | string

O objeto SlicerStyle ou o nome do objeto SlicerStyle que deve ser o novo padrão.

Retornos

void

setDefaultTableStyle(newDefaultStyle)

Define a TableStyle padrão para uso no escopo do objeto pai..

setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;

Parâmetros

newDefaultStyle
TableStyle | string

O objeto TableStyle ou o nome do objeto TableStyle que deve ser o novo padrão.

Retornos

void

setDefaultTimelineStyle(newDefaultStyle)

Define o padrão TimelineStyle para uso no escopo do objeto pai.

setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;

Parâmetros

newDefaultStyle
TimelineStyle | string

O objeto timelinestyle ou o nome do objeto timelinestyle que deve ser o novo padrão.

Retornos

void

setIsDirty(isDirty)

Especifica se foram feitas alterações desde a última vez em que a pasta de trabalho foi salva. Você pode definir essa propriedade como true se quiser fechar uma pasta de trabalho modificada sem salvá-la ou ser solicitado a salvá-la.

setIsDirty(isDirty: boolean): void;

Parâmetros

isDirty
boolean

Retornos

void

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)

True se os cálculos dessa pasta de trabalho forem efetuados usando apenas a precisão dos números conforme forem exibidos. Os dados perderão permanentemente a precisão ao mudar essa propriedade de false para true.

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;

Parâmetros

usePrecisionAsDisplayed
boolean

Retornos

void