Javascript API Office Scripts Office Scripts

Dê a sua opinião sobre a experiência de download do PDF.
Referência da API de scripts do Office

Artigo • 07/04/2023
A API de Scripts do Office permite automatizar tarefas comuns no Excel. Use essa
documentação de referência para saber mais sobre as classes, métodos e outros tipos
disponíveis para seus scripts. Todos os objetos acessíveis por meio de Scripts do Office
podem ser encontrados na tabela de conteúdo à esquerda da página.
７ Observação
Se você estiver procurando as APIs JavaScript para desenvolver suplementos do

Office, visite a referência de API JavaScript de Suplementos do Office.
Classes comuns
A lista a seguir divide os conceitos básicos do modelo de objeto Scripts do Office. Isso
mostra as classes comuns e como elas se relacionam entre si.
Uma Pasta de trabalho contém uma ou mais Planilhas.

Uma Planilha concede acesso a células por meio de objetos de Intervalo.
Um Intervalo representa um grupo de células contíguas.
Os Intervalos são usados para criar e colocar Tabelas, Gráficos, Formas e outras
visualizações de dados ou objetos da organização.
Uma planilha contém matrizes preenchidas com os objetos presentes na planilha
individual.
Uma Pasta de Trabalho contém matrizes de alguns desses objetos de dados para
toda a Pasta de Trabalho.
Para obter mais informações sobre o modelo de objeto scripts do Office, visite
Fundamentos para Scripts do Office no Excel
Confira também
Sobre scripts do Office
Gravar, editar e criar scripts do Office no Excel
Fundamentos para scripts do Office no Excel
ExcelScript package
Referência
Interfaces
ﾉ Expandir a tabela
ExcelScript.Allow Representa um AllowEditRange objeto encontrado em uma planilha. Esse

EditRange objeto funciona com propriedades de proteção de planilha. Quando a
proteção de planilha está habilitada, um AllowEditRange objeto pode ser
usado para permitir a edição de um intervalo específico, mantendo a proteção
no restante da planilha.
ExcelScript.Allow A interface usada para construir campos opcionais do AllowEditRange objeto.

EditRange
Options
ExcelScript. Representa o aplicativo Excel que gerencia a pasta de trabalho.

Application
ExcelScript.Auto Representa o AutoFilter objeto. O AutoFilter transforma os valores na coluna

Filter do Excel em filtros específicos com base no conteúdo da célula.
ExcelScript.Basic Representa os critérios básicos de validação de dados de tipo.

DataValidation
ExcelScript. Representa uma associação do Office.js definida na pasta de trabalho.

Binding
ExcelScript.Cell Representa um formato condicional de valor celular.

ValueConditional
Format
ExcelScript.Chart Representa um objeto chart em uma pasta de trabalho.
ExcelScript.Chart Encapsula as propriedades de formato da área de gráfico geral.

AreaFormat
ExcelScript.Chart Representa os eixos de um gráfico.

Axes
ExcelScript.Chart Representa um único eixo em um gráfico.

Axis
ExcelScript.Chart Encapsula as propriedades de formato do eixo do gráfico.

AxisFormat
ExcelScript.Chart Representa o título de um eixo do gráfico.
AxisTitle
ExcelScript.Chart Representa a formatação do título do eixo do gráfico.

AxisTitleFormat
ExcelScript.Chart Encapsula as opções de bin para gráficos de histograma e gráficos de pareto.

BinOptions
ExcelScript.Chart Representa a formatação de borda de um elemento gráfico.

Border
ExcelScript.Chart Representa as propriedades de uma caixa e um gráfico de bigode.

Boxwhisker
Options
ExcelScript.Chart Representa o rótulo de dados de um ponto de gráfico.

DataLabel
ExcelScript.Chart Encapsula as propriedades de formato dos rótulos de dados do gráfico.

DataLabelFormat
ExcelScript.Chart Representa uma coleção de todos os rótulos de dados em um ponto do

DataLabels gráfico.
ExcelScript.Chart Representa o objeto de tabela de dados de um gráfico.

DataTable
ExcelScript.Chart Representa o formato de uma tabela de dados do gráfico.

DataTableFormat
ExcelScript.Chart Esse objeto representa os atributos das barras de erro de um gráfico.

ErrorBars
ExcelScript.Chart Encapsula as propriedades de formato para barras de erro do gráfico.

ErrorBarsFormat
ExcelScript.Chart Representa a formatação de preenchimento de um elemento do gráfico.

Fill
ExcelScript.Chart Esse objeto representa os atributos de fonte (como nome da fonte, tamanho
Font da fonte e cor) para um objeto gráfico.
ExcelScript.Chart Representa a substring em objetos relacionados ao gráfico que contêm texto,

FormatString como um ChartTitle objeto ou ChartAxisTitle objeto.
ExcelScript.Chart Representa linhas de grade principais ou secundárias em um eixo do gráfico.

Gridlines
ExcelScript.Chart Encapsula as propriedades de formato das linhas de grade do gráfico.

GridlinesFormat
ExcelScript.Chart Representa a legenda de um gráfico.
Legend
ExcelScript.Chart Representa a entrada da legenda em legendEntryCollection .

LegendEntry
ExcelScript.Chart Encapsula as propriedades de formato de uma legenda de gráfico.

LegendFormat
ExcelScript.Chart Encapsula as opções de formatação para elementos de linha.

LineFormat
ExcelScript.Chart Encapsula as propriedades de um gráfico de mapa de região.

MapOptions
ExcelScript.Chart Encapsula as opções de gráfico dinâmico.

PivotOptions
ExcelScript.Chart Esse objeto representa os atributos de uma área de plotagem do gráfico.

PlotArea
ExcelScript.Chart Representa as propriedades de formato para uma área de plotagem de

PlotAreaFormat gráfico.
ExcelScript.Chart Representa o ponto de uma série do gráfico.

Point
ExcelScript.Chart Representa o objeto de formatação para pontos de gráfico.

PointFormat
ExcelScript.Chart Representa uma série de um gráfico.

Series
ExcelScript.Chart Encapsula as propriedades de formato da série de gráficos

SeriesFormat
ExcelScript.Chart Representa um objeto ChartTitle de um gráfico.

Title
ExcelScript.Chart Fornece acesso às opções de formatação para um título de gráfico.

TitleFormat
ExcelScript.Chart Este objeto representa os atributos de um objeto de linha de tendência do

Trendline gráfico.
ExcelScript.Chart Representa as propriedades de formato para a linha de tendência do gráfico.

TrendlineFormat
ExcelScript.Chart Esse objeto representa os atributos de um objeto de rótulo de linha de

TrendlineLabel tendência do gráfico.
ExcelScript.Chart Encapsula as propriedades de formato para o rótulo de linha de tendência do
TrendlineLabel gráfico.
Format
ExcelScript.Color Representa os critérios de escala de cores para formatação condicional.

ScaleConditional
Format
ExcelScript. Representa um comentário na pasta de trabalho.

Comment
ExcelScript. Representa a entidade mencionada nos comentários.

Comment
Mention
ExcelScript. Representa uma resposta de comentário na pasta de trabalho.

CommentReply
ExcelScript. Representa o conteúdo contido em uma resposta de comentário ou

CommentRich comentário. O conteúdo rico incude a cadeia de caracteres de texto e
Content quaisquer outros objetos contidos no corpo do comentário, como menções.
ExcelScript. Representa uma regra de formato condicional de valor celular.

ConditionalCell
ValueRule
ExcelScript. Representa os critérios da escala de cores.

ConditionalColor
ScaleCriteria
ExcelScript. Representa um critério de escala de cores que contém um tipo, um valor e

ConditionalColor uma cor.
ScaleCriterion
ExcelScript. Representa um formato condicional para o lado negativo da barra de dados.

ConditionalData
BarNegative
Format
ExcelScript. Representa um formato condicional para o lado positivo da barra de dados.

ConditionalData
BarPositive
Format
ExcelScript. Representa um tipo de regra para uma barra de dados.

ConditionalData
BarRule
ExcelScript. Um objeto encapsulando o intervalo, o formato, a regra e outras propriedades

Conditional de um formato condicional.
Format
ExcelScript. Representa uma regra para todos os pares de regra/formato tradicionais.
Conditional
FormatRule
ExcelScript. Representa um critério de ícone que contém um tipo, um valor, um operador

ConditionalIcon e um ícone personalizado opcional, se não estiver usando um conjunto de
Criterion ícones.
ExcelScript. Representa a regra de formato condicional de critérios predefinidos.

Conditional
PresetCriteria
Rule
ExcelScript. Representa a borda de um objeto.

Conditional
RangeBorder
ExcelScript. Representa o plano de fundo de um objeto de intervalo condicional.

Conditional
RangeFill
ExcelScript. Este objeto representa os atributos de fonte (estilo de fonte, cor etc.) para um
Conditional objeto.
RangeFont
ExcelScript. Um objeto de formato encapsulando a fonte, o preenchimento, as bordas e

Conditional outras propriedades do intervalo de formatos condicionais.
RangeFormat
ExcelScript. Representa uma regra de formato condicional de valor celular.

ConditionalText
ComparisonRule
ExcelScript. Representa a regra do formato condicional superior/inferior.

ConditionalTop
BottomRule
ExcelScript. Fornece informações com base nas configurações atuais de cultura do

CultureInfo sistema. Isso inclui os nomes de cultura, a formatação de números e outras
configurações culturalmente dependentes.
ExcelScript. Representa um tipo de formato condicional personalizado.

Custom
Conditional
Format
ExcelScript. Representa os critérios de validação de dados personalizados.

CustomData
Validation
ExcelScript. Representa uma propriedade personalizada.
CustomProperty
ExcelScript. Representa um objeto de parte XML personalizado em uma pasta de trabalho.

CustomXmlPart
ExcelScript.Data Representa um tipo de barra de dados condicional do Excel.

BarConditional
Format
ExcelScript.Data Representa o Excel DataPivotHierarchy.

PivotHierarchy
ExcelScript.Data Representa a validação de dados aplicada ao intervalo atual.

Validation
ExcelScript.Data Representa as propriedades de alerta de erro para a validação de dados.

ValidationError
Alert
ExcelScript.Data Representa as propriedades de prompt do usuário para a validação de dados.

Validation
Prompt
ExcelScript.Data Uma regra de validação de dados contém diferentes tipos de validação de

ValidationRule dados. Você só pode usar um deles por vez de acordo com o
ExcelScript.DataValidationType .
ExcelScript.Date Representa os critérios de validação de dados de data.

TimeData
Validation
ExcelScript. Define o formato culturalmente apropriado de exibir números. Isso se baseia

DatetimeFormat nas configurações atuais de cultura do sistema.
Info
ExcelScript. Representa propriedades da pasta de trabalho.

Document
Properties
ExcelScript.Filter Gerencia a filtragem da coluna de uma tabela.
ExcelScript.Filter Representa os critérios de filtragem aplicados a uma coluna.

Criteria
ExcelScript.Filter Indica como filtrar uma data ao filtrar valores.

Datetime
ExcelScript.Filter Representa o Excel FilterPivotHierarchy.

PivotHierarchy
ExcelScript. Representa a proteção de formatação de um objeto range.
Format
Protection
ExcelScript. Representa uma forma geométrica dentro de uma planilha. Uma forma
GeometricShape geométrica pode ser um retângulo, seta de bloco, símbolo de equação, item
de fluxograma, star, faixa, chamada ou qualquer outra forma básica no Excel.
ExcelScript.HeaderFooter
ExcelScript.HeaderFooterGroup
ExcelScript.Icon Representa um ícone de célula.
ExcelScript.Icon Representa um critério de conjunto de ícones para formatação condicional.

SetConditional
Format
ExcelScript. Representa uma imagem na planilha. Para obter o objeto correspondente

Image Shape , use Image.getShape .
ExcelScript. Representa as configurações de cálculo iterativo.

Iterative
Calculation
ExcelScript.Line Representa uma linha dentro de uma planilha. Para obter o objeto
correspondente Shape , use Line.shape .
ExcelScript. Contém informações sobre uma pasta de trabalho vinculada. Se uma pasta de
LinkedWorkbook trabalho tiver links apontando para dados em outra pasta de trabalho, a
segunda pasta de trabalho será vinculada à primeira pasta de trabalho. Nesse
cenário, a segunda pasta de trabalho é chamada de "pasta de trabalho
vinculada".
ExcelScript.List Representa os critérios de validação de dados de lista.

DataValidation
ExcelScript. Representa um nome definido para um intervalo de células ou um valor. Os

NamedItem nomes podem ser objetos chamados primitivos (como visto no tipo abaixo),
objeto range ou uma referência a um intervalo. Use esse objeto para obter
um objeto de intervalo associado aos nomes.
ExcelScript. Representa um objeto que contém valores e tipos de um item nomeado.

NamedItemArray
Values
ExcelScript. Representa uma exibição de planilha nomeada de uma planilha. Uma exibição
NamedSheet de planilha armazena as regras de classificação e filtro para uma planilha
View específica. Cada exibição de planilha (até mesmo uma exibição temporária de
planilha) tem um nome exclusivo com escopo de planilha que é usado para
acessar o modo de exibição.
ExcelScript. Define o formato culturalmente apropriado de exibir números. Isso se baseia
NumberFormat nas configurações atuais de cultura do sistema.
Info
ExcelScript.PageBreak
ExcelScript.Page Representa configurações de layout e impressão que não dependem de

Layout nenhuma implementação específica da impressora. Essas configurações
incluem margens, orientação, numeração de página, linhas de título e a área
de impressão.
ExcelScript.Page Representa as opções nas margens de layout da página.

LayoutMargin
Options
ExcelScript.Page Representa propriedades de zoom de página.

LayoutZoom
Options
ExcelScript.Pivot Modelo configurável para um filtro de data a ser aplicado a um PivotField. O

DateFilter condition define quais critérios precisam ser definidos para que o filtro
opere.
ExcelScript.Pivot Representa o Excel PivotField.

Field
ExcelScript.Pivot Uma interface que representa todos os PivotFilters atualmente aplicados a um

Filters determinado PivotField.
ExcelScript.Pivot Representa o Excel PivotHierarchy.

Hierarchy
ExcelScript.Pivot Representa o Excel PivotItem.

Item
ExcelScript.Pivot Modelo configurável para um filtro de rótulo a ser aplicado a um PivotField. O

LabelFilter condition define quais critérios precisam ser definidos para que o filtro
opere.
ExcelScript.Pivot Representa o layout visual da Tabela Dinâmica.

Layout
ExcelScript.Pivot Modelo configurável para um filtro manual a ser aplicado a um PivotField. O

ManualFilter condition define quais critérios precisam ser definidos para que o filtro
opere.
ExcelScript.Pivot Representa uma Tabela Dinâmica do Excel.

Table
ExcelScript.Pivot Representa um estilo de Tabela Dinâmica, que define elementos de estilo por
TableStyle região de Tabela Dinâmica.
ExcelScript.Pivot Modelo configurável para um filtro de valor a ser aplicado a um PivotField. O
ValueFilter condition define quais critérios precisam ser definidos para que o filtro
opere.
ExcelScript. Um objeto encapsulando o formato de um estilo e outras propriedades.

PredefinedCell
Style
ExcelScript. Representa o formato condicional de critérios predefinidos, como valores

PresetCriteria acima da média, abaixo da média, exclusivos, contém em branco, nãoblank,
Conditional erro e noerror.
Format
ExcelScript.Query Representa uma consulta Power Query.
ExcelScript. O intervalo representa um conjunto de uma ou mais células contíguas, como

Range uma célula, uma linha, uma coluna ou um bloco de células.
ExcelScript. RangeAreas representa uma coleção de um ou mais intervalos retangulares na

RangeAreas mesma planilha.
ExcelScript. Representa a borda de um objeto.

RangeBorder
ExcelScript. Representa a tela de fundo de um objeto Range.

RangeFill
ExcelScript. Esse objeto representa os atributos de fonte de um objeto, como nome,

RangeFont tamanho, cor, dentre outros.
ExcelScript. Um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o

RangeFormat alinhamento e outras propriedades do intervalo.
ExcelScript. Representa as cadeias de caracteres necessárias para obter/definir um objeto

RangeHyperlink XHL (hiperlink).
ExcelScript. Gerencia operações de classificação em Range objetos.

RangeSort
ExcelScript. RangeView representa um conjunto de células visíveis do intervalo pai.

RangeView
ExcelScript. Representa os resultados de Range.removeDuplicates .

Remove
DuplicatesResult
ExcelScript. Representa os critérios de substituição a serem usados.

ReplaceCriteria
ExcelScript.Row Representa o Excel RowColumnPivotHierarchy.

ColumnPivot
Hierarchy
ExcelScript. Representa os critérios de pesquisa a serem usados.

SearchCriteria
ExcelScript. Representa um objeto de forma genérica na planilha. Uma forma pode ser
Shape uma forma geométrica, uma linha, um grupo de formas, etc.
ExcelScript. Representa a formatação de preenchimento de um objeto de forma.

ShapeFill
ExcelScript. Representa os atributos de fonte, como nome da fonte, tamanho da fonte e

ShapeFont cor, para o objeto de TextRange uma forma.
ExcelScript. Representa um grupo de formas dentro de uma planilha. Para obter o objeto
ShapeGroup correspondente Shape , use ShapeGroup.shape .
ExcelScript. Representa a formatação de linha para o objeto shape. Para imagens e formas
ShapeLine geométricas, a formatação de linha representa a borda da forma.
Format
ExcelScript.ShowAsRule
ExcelScript.Slicer Representa um Slicer objeto na pasta de trabalho.
ExcelScript.Slicer Representa um item de segmentação em uma segmentação.

Item
ExcelScript.Slicer Representa um estilo de segmentação, que define elementos de estilo por

Style região da segmentação.
ExcelScript.Sort Representa uma condição em uma operação de classificação.

Field
ExcelScript. Subtotais para o Campo Dinâmico.

Subtotals
ExcelScript.Table Representa uma tabela do Excel.
ExcelScript.Table Representa uma coluna em uma tabela.

Column
ExcelScript.Table Gerencia operações de classificação em Table objetos.

Sort
ExcelScript.Table Representa um estilo de tabela, que define os elementos de estilo por região
Style da tabela.
ExcelScript.Text Representa um formato condicional de texto específico.

Conditional
Format
ExcelScript.Text Representa o quadro de texto de um objeto shape.
Frame
ExcelScript.Text Contém o texto que é anexado a uma forma, bem como propriedades e
Range métodos para manipular o texto.
ExcelScript. Representa um TimelineStyle , que define elementos de estilo por região no

TimelineStyle linha do tempo.
ExcelScript.Top Representa um formato condicional superior/inferior.

Bottom
Conditional
Format
ExcelScript. A pasta de trabalho é o objeto de nível superior que contém objetos de pasta
Workbook de trabalho relacionados, como planilhas, tabelas e intervalos.
ExcelScript. Representa a proteção de um objeto de pasta de trabalho.

Workbook
Protection
ExcelScript. Representa uma coleção de um ou mais intervalos retangulares em várias

WorkbookRange planilhas.
Areas
ExcelScript. Uma planilha do Excel é uma grade de células. Ela pode conter dados, tabelas,
Worksheet gráficos, etc.
ExcelScript. Representa uma propriedade personalizada no nível da planilha.

Worksheet
CustomProperty
ExcelScript.WorksheetFreezePanes
ExcelScript. Representa a proteção de um objeto de planilha.

Worksheet
Protection
ExcelScript. Representa as opções de proteção da planilha.

Worksheet
Protection
Options
ExcelScript. Representa os critérios de pesquisa de planilha a serem usados.

Worksheet
SearchCriteria
Enumerações
ExcelScript. Função de agregação para o DataPivotHierarchy .

Aggregation
Function
ExcelScript.ArrowheadLength
ExcelScript.ArrowheadStyle
ExcelScript.ArrowheadWidth
ExcelScript.AutoFill O comportamento tipos quando AutoFill é usado em um intervalo na pasta

Type de trabalho.
ExcelScript.BindingType
ExcelScript.BorderIndex
ExcelScript.BorderLineStyle
ExcelScript.BorderWeight
ExcelScript.BuiltInStyle
ExcelScript.CalculationMode
ExcelScript. Representa o estado do cálculo em todo o aplicativo do Excel.

CalculationState
ExcelScript.CalculationType
ExcelScript.Chart Especifica o tipo do eixo de categoria.

AxisCategoryType
ExcelScript.ChartAxisDisplayUnit
ExcelScript.ChartAxisGroup
ExcelScript.ChartAxisPosition
ExcelScript.ChartAxisScaleType
ExcelScript.ChartAxisTickLabelPosition
ExcelScript.ChartAxisTickMark
ExcelScript.Chart Especifica a unidade de tempo dos eixos de gráfico e série de dados.

AxisTimeUnit
ExcelScript.ChartAxisType
ExcelScript.ChartBin Especifica o tipo de lixeira de um gráfico de histograma ou de uma série de
Type gráficos de pareto.
ExcelScript.Chart Representa o tipo de cálculo do quartil do layout da série de gráficos.

BoxQuartile Aplica-se apenas a uma caixa e ao gráfico de bigode.
Calculation
ExcelScript.ChartColorScheme
ExcelScript.ChartDataLabelPosition
ExcelScript.Chart Especifica o tipo de fonte de dados da série de gráficos.

DataSourceType
ExcelScript.ChartDisplayBlanksAs
ExcelScript.Chart Representa quais partes da barra de erros incluir.

ErrorBarsInclude
ExcelScript.Chart Representa o tipo de intervalo para barras de erro.

ErrorBarsType
ExcelScript.Chart Representa o estilo gradiente de uma série de gráficos. Isso só é aplicável

GradientStyle para gráficos de mapas de região.
ExcelScript.Chart Representa o tipo de estilo gradiente de uma série de gráficos. Isso só é

GradientStyleType aplicável para gráficos de mapas de região.
ExcelScript.ChartLegendPosition
ExcelScript.ChartLineStyle
ExcelScript.Chart Representa o nível de mapeamento de uma série de gráficos. Isso só se

MapAreaLevel aplica aos gráficos de mapa da região.
ExcelScript.Chart Representa o nível da região de um layout de série de gráficos. Isso só se

MapLabelStrategy aplica aos gráficos de mapa da região.
ExcelScript.Chart Representa o tipo de projeção de região de um layout de série de gráficos.

MapProjectionType Isso só se aplica aos gráficos de mapa da região.
ExcelScript.ChartMarkerStyle
ExcelScript.Chart Representa a estratégia de rótulo pai do layout da série de gráficos. Isso só

ParentLabel se aplica a gráficos de mapa de árvore
Strategy
ExcelScript.ChartPlotAreaPosition
ExcelScript.ChartPlotBy
ExcelScript.Chart Especifica se a série é por linhas ou por colunas. No Excel na área de

SeriesBy trabalho, a opção "auto" inspecionará a forma de dados de origem para
adivinhar automaticamente se os dados são por linhas ou colunas. Em Excel
na Web, "auto" simplesmente será padrão para "colunas".
ExcelScript.Chart Representa as dimensões ao obter valores de séries de gráficos.

SeriesDimension
ExcelScript.ChartSplitType
ExcelScript.Chart Representa o alinhamento horizontal do objeto especificado.

TextHorizontal
Alignment
ExcelScript.Chart Representa o alinhamento vertical do objeto especificado.

TextVertical
Alignment
ExcelScript.ChartTickLabelAlignment
ExcelScript.Chart Representa a posição do título do gráfico.

TitlePosition
ExcelScript.ChartTrendlineType
ExcelScript.ChartType
ExcelScript.ChartUnderlineStyle
ExcelScript.ClearApplyTo
ExcelScript. Representa o operador do tipo de formato condicional de texto.

ConditionalCell
ValueOperator
ExcelScript. Representa as opções de formato para um eixo de barra de dados.

ConditionalDataBar
AxisFormat
ExcelScript. Representa a direção da barra de dados dentro de uma célula.

ConditionalDataBar
Direction
ExcelScript. Representa os tipos de critério de cor para formatação condicional.

ConditionalFormat
ColorCriterionType
ExcelScript. Representa a direção de uma seleção.

ConditionalFormat
Direction
ExcelScript. Representa os tipos de formato condicional de ícone.

ConditionalFormat
IconRuleType
ExcelScript. Representa os critérios do tipo de formato condicional de critérios
ConditionalFormat predefinidos.
PresetCriterion
ExcelScript. Representa os tipos de valores de formato condicional.

ConditionalFormat
RuleType
ExcelScript.ConditionalFormatType
ExcelScript. Representa o operador para cada critério de ícone.

ConditionalIcon
CriterionOperator
ExcelScript.ConditionalRangeBorderIndex
ExcelScript.ConditionalRangeBorderLineStyle
ExcelScript.ConditionalRangeFontUnderlineStyle
ExcelScript. Representa o operador do tipo de formato condicional de texto.

ConditionalText
Operator
ExcelScript. Representa os critérios para o tipo de formato condicional acima/abaixo da

ConditionalTop média.
BottomCriterion
Type
ExcelScript.ConnectorType
ExcelScript.ContentType
ExcelScript.Data Representa o estilo de alerta de erro de validação de dados. O padrão é

ValidationAlertStyle Stop .
ExcelScript.Data Representa o enumeração do operador de validação de dados.

ValidationOperator
ExcelScript.Data Representa o enumeração de tipo de validação de dados.

ValidationType
ExcelScript.Date Enumerando todas as condições aceitas pelas quais um filtro de data pode
FilterCondition ser aplicado. Usado para configurar o tipo de PivotFilter que é aplicado ao
campo.
ExcelScript.DeleteShiftDirection
ExcelScript.DocumentPropertyType
ExcelScript.DynamicFilterCriteria
ExcelScript.FillPattern
ExcelScript.FilterDatetimeSpecificity
ExcelScript.FilterOn
ExcelScript.FilterOperator
ExcelScript. Especifica o tipo de forma de um GeometricShape objeto.

GeometricShape
Type
ExcelScript.GroupOption
ExcelScript.HeaderFooterState
ExcelScript.HorizontalAlignment
ExcelScript.IconSet
ExcelScript.ImageFittingMode
ExcelScript.Insert Determina a direção em que as células existentes serão deslocadas para

ShiftDirection acomodar o que está sendo inserido.
ExcelScript.KeyboardDirection
ExcelScript.Label Enumerando todas as condições aceitas pelas quais um filtro de rótulo

FilterCondition pode ser aplicado. Usado para configurar o tipo de PivotFilter que é
aplicado ao campo. PivotFilter.criteria.exclusive pode ser definido
para true inverter muitas dessas condições.
ExcelScript.LinkedDataTypeState
ExcelScript.Load Um enumeração que especifica a carga de consulta para o destino.

ToType
ExcelScript.NamedItemScope
ExcelScript.NamedItemType
ExcelScript.Number Representa uma categoria de formatos de número.

FormatCategory
ExcelScript.PageOrientation
ExcelScript.PaperType
ExcelScript.Picture O formato da imagem.

Format
ExcelScript.Pivot Representa o eixo do qual obter os PivotItems.

Axis
ExcelScript.Pivot Representa os critérios para o filtro de valores superior/inferior.
FilterTopBottom
Criterion
ExcelScript.Pivot Um enumeração simples que representa um tipo de filtro para um

FilterType PivotField.
ExcelScript.PivotLayoutType
ExcelScript. Especifica a maneira em que um objeto é anexado às suas células

Placement subjacentes.
ExcelScript.PrintComments
ExcelScript.PrintErrorType
ExcelScript.PrintMarginUnit
ExcelScript.PrintOrder
ExcelScript.ProtectionSelectionMode
ExcelScript.Query Um enumeração que especifica a mensagem de erro de carga de consulta.

Error
ExcelScript.RangeCopyType
ExcelScript.RangeUnderlineStyle
ExcelScript.RangeValueType
ExcelScript.ReadingOrder
ExcelScript.Search Especifica a direção da pesquisa.

Direction
ExcelScript.Shape Determina o tipo de dimensionamento automático permitido.

AutoSize
ExcelScript.Shape Especifica o tipo de preenchimento de uma forma.

FillType
ExcelScript.Shape O tipo de sublinhado aplicado a uma fonte.

FontUnderlineStyle
ExcelScript.Shape O estilo de traço para uma linha.

LineDashStyle
ExcelScript.Shape O estilo de uma linha.

LineStyle
ExcelScript.Shape Especifica qual parte da forma mantém sua posição quando a forma é
ScaleFrom dimensionada.
ExcelScript.Shape Especifica se a forma é dimensionada em relação ao tamanho original ou

ScaleType atual.
ExcelScript.Shape Especifica o alinhamento horizontal do quadro de texto em uma forma.

TextHorizontal
Alignment
ExcelScript.Shape Especifica o estouro horizontal do quadro de texto em uma forma.

TextHorizontal
Overflow
ExcelScript.Shape Especifica a orientação para o quadro de texto em uma forma.

TextOrientation
ExcelScript.Shape Especifica a ordem de leitura do quadro de texto em uma forma.

TextReadingOrder
ExcelScript.Shape Especifica o alinhamento vertical do quadro de texto em uma forma.

TextVertical
Alignment
ExcelScript.Shape Especifica o estouro vertical do quadro de texto em uma forma.

TextVertical
Overflow
ExcelScript.Shape Especifica o tipo de forma.

Type
ExcelScript.Shape Especifica para que local da ordem z uma forma deve ser movida, em
ZOrder relação às outras formas.
ExcelScript.SheetVisibility
ExcelScript.Show A função de cálculo ShowAs para o DataPivotField.

AsCalculation
ExcelScript.Slicer Especifica o comportamento de classificação de segmentação para

SortType Slicer.sortBy .
ExcelScript.SortBy Representa a direção de classificação.
ExcelScript.SortDataOption
ExcelScript.SortMethod
ExcelScript.SortOn Representa a parte da célula usada como critério de classificação.
ExcelScript.SortOrientation
ExcelScript.SpecialCellType
ExcelScript.SpecialCellValueType
ExcelScript.SubtotalLocationType
ExcelScript.Top Um enumeração simples para filtros superior/inferior para selecionar se

BottomSelection deve filtrar pela N superior ou n por cento inferior, número ou soma de
Type valores.
ExcelScript.Value Enumerando todas as condições aceitas pelas quais um filtro de valor pode
FilterCondition ser aplicado. Usado para configurar o tipo de PivotFilter que é aplicado ao
campo. PivotFilter.exclusive pode ser definido para true inverter muitas
dessas condições.
ExcelScript.VerticalAlignment
ExcelScript. Representa o modo de atualização dos links da pasta de trabalho.

WorkbookLinks
RefreshMode
ExcelScript. A posição de uma planilha relativa a outra planilha ou a toda a coleção de

WorksheetPosition planilhas.
Type
６ Colaborar conosco no
GitHub Comentários do Office Scripts
O Office Scripts é um projeto código aberto.
A fonte deste conteúdo pode
ser encontrada no GitHub, onde Selecione um link para fornecer
comentários:
você também pode criar e
revisar problemas e solicitações
 Abrir um problema de documentação
de pull. Para obter mais
informações, confira o nosso
 Fornecer comentários sobre o produto
guia para colaboradores.
ExcelScript.AggregationFunction enum
Referência
Pacote: ExcelScript
Função de agregação para o DataPivotHierarchy .
Comentários
Exemplos
TypeScript
/**
* This script changes how the data in a PivotTable is aggregated.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the first PivotTable in the workbook.
const pivotTable = workbook.getPivotTables()[0];
// Set the first data hierarchy to summarize with an average value,

instead of a sum.
const dataHierarchy = pivotTable.getDataHierarchies()[0];
dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average);
}
Campos
automatic O Excel selecionará automaticamente a agregação com base nos itens de

dados.
average Agregar usando a média dos dados, equivalente à função AVERAGE.
count Agregar usando a contagem de itens nos dados, equivalente à função

COUNTA.
countNumbers Agregar usando a contagem de números nos dados, equivalente à função

COUNT.
max Agregar usando o valor máximo dos dados, equivalente à função MAX.
min Agregar usando o valor mínimo dos dados, equivalente à função MIN.
product Agregar usando o produto dos dados, equivalente à função PRODUCT.
standardDeviation Agregar usando o desvio padrão dos dados, equivalente à função STDEV.
standardDeviationP Agregar usando o desvio padrão dos dados, equivalente à função STDEVP.
sum Agregar usando a soma dos dados, equivalente à função SUM.
unknown A função de agregação é desconhecida ou sem suporte.
variance Agregar usando a variação dos dados, equivalente à função VAR.
varianceP Agregar usando a variação dos dados, equivalente à função VARP.
comentários:
ExcelScript.ArrowheadLength enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script adds a line that goes from cell B2 to cell F4 on the current
worksheet.
*/
// Get the current worksheet.
const sheet = workbook.getActiveWorksheet();
// Get the ranges for the two cells.

const b2Range = sheet.getRange("B2");
const f4Range = sheet.getRange("F4");
// Add a straight line that connects the top-left corners of both cells.
const newShape = sheet.addLine(
b2Range.getLeft(),
b2Range.getTop(),
f4Range.getLeft(),
f4Range.getTop(),
ExcelScript.ConnectorType.straight);
// Add a long, open arrowhead to the end of the line, such that it points
at F4.
const line = newShape.getLine();
line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.open);
line.setEndArrowheadLength(ExcelScript.ArrowheadLength.long);
}
Campos
long
medium
short
Selecione um link para fornecer
ser encontrada no GitHub, onde
comentários:
ExcelScript.ArrowheadStyle enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
worksheet.
*/

b2Range.getLeft(),
b2Range.getTop(),
f4Range.getLeft(),
f4Range.getTop(),
// Add an open arrowhead to the end of the line, such that it points at
F4.
}
Campos
diamond
none
open
oval
stealth
triangle
comentários:
ExcelScript.ArrowheadWidth enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
worksheet.
*/

b2Range.getLeft(),
b2Range.getTop(),
f4Range.getLeft(),
f4Range.getTop(),
// Add a wide, triangular arrowhead to the end of the line, such that it
points at F4.
line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.triangle);
line.setEndArrowheadWidth(ExcelScript.ArrowheadWidth.wide);
}
Campos
medium
narrow
wide
comentários:
ExcelScript.AutoFillType enum
Referência
Pacote: ExcelScript
O comportamento tipos quando AutoFill é usado em um intervalo na pasta de trabalho.
Comentários
Exemplos
TypeScript
/**
* This script uses the autofill feature to complete a table with days of
the month.
* See https://support.microsoft.com/74e31bdd-d993-45da-aa82-35a236c5b5db
* for examples of autofill scenarios.
*/
// Get the current, active worksheet.
let currentWorksheet = workbook.getActiveWorksheet();
// Get the data range that shows the pattern.

let dataRange = currentWorksheet.getRange("C2:C3");
// Autofill the connected range. C2:C3 are filled in with dates. C4:C54
are blank.
dataRange.autoFill("C2:C54", ExcelScript.AutoFillType.fillDays);
}
Campos
fillCopy Preenche as células adjacentes com dados com base nos dados selecionados.
fillDays Uma versão de "FillSeries" para datas que baseia o padrão no dia do mês ou no
dia da semana, dependendo do contexto.
fillDefault Preenche as células adjacentes com base nos dados ao redor (o comportamento
padrão do AutoFill).
fillFormats Preenche as células adjacentes com os formatos selecionados.

fillMonths Uma versão de "FillSeries" para datas que baseia o padrão no mês.
fillSeries Preenche as células adjacentes com dados que seguem um padrão nas células
copiadas.
fillValues Preenche as células adjacentes com os valores selecionados.
fillWeekdays Uma versão de "FillSeries" para datas que baseia o padrão no dia da semana e
inclui apenas dias úteis.
fillYears Uma versão de "FillSeries" para datas que baseia o padrão no ano.
flashFill Preenche as células adjacentes usando o recurso de Preenchimento Flash do Excel.
growthTrend Uma versão de "FillSeries" para números que preenche os valores nas células
adjacentes de acordo com um modelo de tendência de crescimento.
linearTrend Uma versão de "FillSeries" para números que preenche os valores nas células
adjacentes de acordo com um modelo de tendência linear.
comentários:
ExcelScript.BindingType enum
Referência
Pacote: ExcelScript
Campos
range
table
text
comentários:
ExcelScript.BorderIndex enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script creates a border around a range.
*/
// Get the RangeFormat object for the range "B2:G10".
const currentSheet = workbook.getActiveWorksheet();
const rangeForBorder = currentSheet.getRange("B2:G10");
const format = rangeForBorder.getFormat();
// Get a RangeBorder object for each edge of the range and set the border
properties.
let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
edgeTop.setWeight(ExcelScript.BorderWeight.thick);
let edgeBottom =
format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
edgeBottom.setWeight(ExcelScript.BorderWeight.thick);
let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);

edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
edgeLeft.setWeight(ExcelScript.BorderWeight.thick);
let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);

edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
edgeRight.setWeight(ExcelScript.BorderWeight.thick);
}
Campos
diagonalDown
diagonalUp
edgeBottom
edgeLeft
edgeRight
edgeTop
insideHorizontal
insideVertical
comentários:
ExcelScript.BorderLineStyle enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
*/
properties.
let edgeBottom =


}
Campos
continuous
dash
dashDot
dashDotDot
dot
double
none
slantDashDot
comentários:
ExcelScript.BorderWeight enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
*/
properties.
let edgeBottom =


}
Campos
hairline
medium
thick
thin
comentários:
ExcelScript.BuiltInStyle enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script sets the cell style to "warning text"
* on every cell with a formula error.
*/
// Get the used range in the current worksheet.
const usedRange = sheet.getUsedRange();
// Get any cells that are displaying errors.

const errorCells = usedRange.getSpecialCells(
ExcelScript.SpecialCellType.formulas,
ExcelScript.SpecialCellValueType.errors
);
// Check if there are error cells before proceeding.

if (errorCells) {
// Use the built-in warning text style on the error cells.
errorCells.setPredefinedCellStyle(
ExcelScript.BuiltInStyle.warningText.toString()
);
} else {
console.log("No formula errors in the worksheet.");
}
}
Campos
accent1
accent1_20
accent1_40
accent1_60
accent2
accent2_20
accent2_40
accent2_60
accent3
accent3_20
accent3_40
accent3_60
accent4
accent4_20
accent4_40
accent4_60
accent5
accent5_20
accent5_40
accent5_60
accent6
accent6_20
accent6_40
accent6_60
bad
calculation
checkCell
comma
currency
emphasis1
emphasis2
emphasis3
explanatoryText
good
heading1
heading2
heading3
heading4
hlink
hlinkTrav
input
linkedCell
neutral
normal
note
output
percent
sheetTitle
total
warningText
wholeComma
wholeDollar
comentários:
revisar problemas e solicitações  Abrir um problema de documentação
informações, confira o nosso  Fornecer comentários sobre o produto
ExcelScript.CalculationMode enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script recalculates the used range of a specific worksheet.
*/
// Only recalculate if the calculation mode is not set to automatic.
if (workbook.getApplication().getCalculationMode() !==
ExcelScript.CalculationMode.automatic) {
// Get the used range from a worksheet named "Monthly Report".
const sheet = workbook.getWorksheet("Monthly Report");
const range = sheet.getUsedRange();
console.log(`Calculating ${range.getAddress()}`);
// Force all the used cells in that worksheet to calculate.

sheet.getUsedRange().calculate();
}
}
Campos
automatic O comportamento de recalculação padrão em que o Excel calcula novos

resultados de fórmula sempre que os dados relevantes são alterados.
automaticExceptTables Calcula novos resultados de fórmula sempre que os dados relevantes

são alterados, a menos que a fórmula esteja em uma tabela de dados.
manual Os cálculos ocorrem somente quando o usuário ou o suplemento

solicita.
comentários:
ExcelScript.CalculationState enum
Referência
Pacote: ExcelScript
Representa o estado do cálculo em todo o aplicativo do Excel.
Comentários
Exemplos
TypeScript
/**
* This script uses the fill color of the first cell to indicate the current
* calculation state of the workbook.
*/
// Get the first cell in the first worksheet.
const cell = workbook.getWorksheets()[0].getCell(0,0);
// Get that cell's fill object.

const cellFill = cell.getFormat().getFill();
// Set the cell fill based on the calculation state.

const calcState = workbook.getApplication().getCalculationState();
switch (calcState) {
case ExcelScript.CalculationState.pending:
cellFill.setColor("Red");
break;
case ExcelScript.CalculationState.calculating:
cellFill.setColor("Yellow");
break;
case ExcelScript.CalculationState.done:
cellFill.setColor("Green");
break;
}
}
Campos
calculating Cálculos em andamento.

done Cálculos concluídos.
pending Foram feitas alterações que dispararam o cálculo, mas ainda não foi realizado um
recálculo.
comentários:
ExcelScript.CalculationType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script fully recalculates the entire workbook.
* This code is useful when automatic recalculation is turned off
* but later parts of the script rely on updated values.
*/
function main(workbook: ExcelScript.Workbook, workbookURL: string) {
const application = workbook.getApplication();
application.calculate(ExcelScript.CalculationType.fullRebuild);
}
Campos
full Isso marcará todas as células como incorretas e as recalculará.
fullRebuild Isso reconstruirá a cadeia de dependência completa, marcará todas as células como
sujas e, em seguida, as recalculará.
recalculate Recalcula todas as células que o Excel marcou como sujas, isto é, dependentes de
dados voláteis ou alterados e células programaticamente marcadas como sujas.
comentários:
ExcelScript.ChartAxisCategoryType
enum
Referência
Pacote: ExcelScript
Especifica o tipo do eixo de categoria.
Campos
automatic O Excel controla o tipo de eixo.
dateAxis O eixo agrupa os dados em uma escala de tempo.
textAxis O eixo agrupa os dados por um conjunto arbitrário de categorias.
comentários:
ExcelScript.ChartAxisDisplayUnit enum
Referência
Pacote: ExcelScript
Campos
billions Isso definirá o eixo em unidades de bilhões.
custom Isso definirá o eixo em unidades de valor personalizado.
hundredMillions Isso definirá o eixo em unidades de centenas de milhões.
hundreds Isso definirá o eixo em unidades de centenas.
hundredThousands Isso definirá o eixo em unidades de centenas de milhares.
millions Isso definirá o eixo em unidades de milhões.
none Opção padrão. Isso redefinirá a unidade de exibição para o eixo e definirá o
rótulo de unidade invisível.
tenMillions Isso definirá o eixo em unidades de dezenas de milhões.
tenThousands Isso definirá o eixo em unidades de dezenas de milhares.
thousands Isso definirá o eixo em unidades de milhares.
trillions Isso definirá o eixo em unidades de trilhões.
comentários:
ExcelScript.ChartAxisGroup enum
Referência
Pacote: ExcelScript
Campos
primary
secondary
comentários:
ExcelScript.ChartAxisPosition enum
Referência
Pacote: ExcelScript
Campos
automatic
custom
maximum
minimum
comentários:
ExcelScript.ChartAxisScaleType enum
Referência
Pacote: ExcelScript
Campos
linear
logarithmic
comentários:
enum
Referência
Pacote: ExcelScript
Campos
high
low
nextToAxis
none
comentários:
ExcelScript.ChartAxisTickMark enum
Referência
Pacote: ExcelScript
Campos
cross
inside
none
outside
comentários:
ExcelScript.ChartAxisTimeUnit enum
Referência
Pacote: ExcelScript
Especifica a unidade de tempo dos eixos de gráfico e série de dados.
Campos
days
months
years
comentários:
ExcelScript.ChartAxisType enum
Referência
Pacote: ExcelScript
Campos
category O eixo exibe categorias.
invalid
series O eixo exibe séries de dados.
value O eixo exibe valores.
comentários:
ExcelScript.ChartBinType enum
Referência
Pacote: ExcelScript
Especifica o tipo de lixeira de um gráfico de histograma ou de uma série de gráficos de

pareto.
Campos
auto
binCount
binWidth
category
você também pode criar e comentários:
ExcelScript.ChartBoxQuartileCalculation
enum
Referência
Pacote: ExcelScript
Representa o tipo de cálculo do quartil do layout da série de gráficos. Aplica-se apenas

a uma caixa e ao gráfico de bigode.
Campos
exclusive
inclusive
comentários:
ExcelScript.ChartColorScheme enum
Referência
Pacote: ExcelScript
Campos
colorfulPalette1
colorfulPalette2
colorfulPalette3
colorfulPalette4
monochromaticPalette1
A fonte deste conteúdo pode O Office Scripts é um projeto código aberto.
de pull. Para obter mais  Abrir um problema de documentação
guia para colaboradores.  Fornecer comentários sobre o produto
enum
Referência
Pacote: ExcelScript
Campos
bestFit
bottom
callout
center
insideBase
insideEnd
invalid
left
none
outsideEnd
right
top
comentários:
ExcelScript.ChartDisplayBlanksAs enum
Referência
Pacote: ExcelScript
Campos
interplotted
notPlotted
zero
comentários:
ExcelScript.ChartErrorBarsInclude enum
Referência
Pacote: ExcelScript
Representa quais partes da barra de erros incluir.
Campos
both
minusValues
plusValues
comentários:
ExcelScript.ChartErrorBarsType enum
Referência
Pacote: ExcelScript
Representa o tipo de intervalo para barras de erro.
Comentários
Exemplos
TypeScript
/**
* This script adds error bars for the standard error of each chart series
point.
*/
// Get the range for the chart.
const worksheet = workbook.getWorksheet("Sample");
const dataRange = worksheet.getRange("A1:B15");
// Create a line chart.

const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange);
// For each series, add error bars for the standard error on each point.
const allSeries = chart.getSeries();
allSeries.forEach((series) => {
series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
series.getYErrorBars().setVisible(true);
});
}
Campos
custom
fixedValue
percent
stDev
stError
comentários:
ExcelScript.ChartGradientStyle enum
Referência
Pacote: ExcelScript
Representa o estilo gradiente de uma série de gráficos. Isso só é aplicável para gráficos
de mapas de região.
Campos
threePhaseColor
twoPhaseColor
ExcelScript.ChartGradientStyleType
enum
Referência
Pacote: ExcelScript
Representa o tipo de estilo gradiente de uma série de gráficos. Isso só é aplicável para
gráficos de mapas de região.
Campos
extremeValue
number
percent
ExcelScript.ChartLegendPosition enum
Referência
Pacote: ExcelScript
Campos
bottom
corner
custom
invalid
left
right
top
comentários:
ExcelScript.ChartLineStyle enum
Referência
Pacote: ExcelScript
Campos
automatic
continuous
dash
dashDot
dashDotDot
dot
grey25
grey50
grey75
none
roundDot
comentários:
ExcelScript.ChartMapAreaLevel enum
Referência
Pacote: ExcelScript
Representa o nível de mapeamento de uma série de gráficos. Isso só se aplica a gráficos

de mapa de região.
Campos
automatic
city
continent
country
county
dataOnly
state
world
ExcelScript.ChartMapLabelStrategy
enum
Referência
Pacote: ExcelScript
Representa o nível da região de um layout de série de gráficos. Isso só se aplica a

gráficos de mapa de região.
Campos
bestFit
none
showAll
ExcelScript.ChartMapProjectionType
enum
Referência
Pacote: ExcelScript
Representa o tipo de projeção de região de um layout de série de gráficos. Isso só se

aplica a gráficos de mapa de região.
Campos
albers
automatic
mercator
miller
robinson
ExcelScript.ChartMarkerStyle enum
Referência
Pacote: ExcelScript
Campos
automatic
circle
dash
diamond
dot
invalid
none
picture
plus
square
star
triangle
x
comentários:
ExcelScript.ChartParentLabelStrategy
enum
Referência
Pacote: ExcelScript
Representa a estratégia de rótulo pai do layout da série de gráficos. Isso só se aplica a

gráficos de mapa de árvore
Campos
banner
none
overlapping
ExcelScript.ChartPlotAreaPosition enum
Referência
Pacote: ExcelScript
Campos
automatic
custom
comentários:
ExcelScript.ChartPlotBy enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This sample performs the "Switch Row/Column" action on a chart named
"ColumnClusteredChart".
*/
let selectedSheet = workbook.getActiveWorksheet();
// Get an existing chart named "ColumnClusteredChart".

let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
// Switch the row and column for the chart's data source.
if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns)
{
// If the chart is grouped by columns, switch it to rows.
columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
} else {
// If the chart is grouped by rows, switch it to columns.
columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
}
}
Campos
columns
rows
comentários:
ExcelScript.ChartSeriesBy enum
Referência
Pacote: ExcelScript
Especifica se a série é por linhas ou por colunas. No Excel na área de trabalho, a opção
"auto" inspecionará a forma de dados de origem para adivinhar automaticamente se os
dados são por linhas ou colunas. Em Excel na Web, "auto" simplesmente será padrão
para "colunas".
Comentários
Exemplos
TypeScript
/**
* This script creates a clustered-column chart using an existing table.
*/
// Get the first table on the current worksheet.
const table = sheet.getTables()[0];
// Add a clustered-column chart that clusters the data based on the

columns in the table.
const chart = sheet.addChart(
ExcelScript.ChartType.columnClustered,
table.getRange(),
ExcelScript.ChartSeriesBy.columns
);
}
Campos
auto No Excel na área de trabalho, a opção "auto" inspecionará a forma de dados de origem
para adivinhar automaticamente se os dados são por linhas ou colunas. Em Excel na
Web, "auto" simplesmente será padrão para "colunas".
columns
rows
comentários:
ExcelScript.ChartSeriesDimension enum
Referência
Pacote: ExcelScript
Representa as dimensões ao obter valores de séries de gráficos.
Campos
bubbleSizes O eixo da série de gráficos para os tamanhos de bolhas em gráficos de bolhas.
categories O eixo da série de gráficos para as categorias.
values O eixo da série de gráficos para os valores.
xvalues O eixo da série de gráficos para os valores do eixo x em gráficos de dispersão e

bolhas.
yvalues O eixo da série de gráficos para os valores do eixo y em gráficos de dispersão e

bolhas.
comentários:
ExcelScript.ChartSplitType enum
Referência
Pacote: ExcelScript
Campos
splitByCustomSplit
splitByPercentValue
splitByPosition
splitByValue
comentários:
ExcelScript.ChartTextHorizontal
Alignment enum
Referência
Pacote: ExcelScript
Representa o alinhamento horizontal do objeto especificado.
Campos
center
distributed
justify
left
right
comentários:
ExcelScript.ChartTextVerticalAlignment
enum
Referência
Pacote: ExcelScript
Representa o alinhamento vertical do objeto especificado.
Campos
bottom
center
distributed
justify
top
comentários:
enum
Referência
Pacote: ExcelScript
Campos
center
left
right
comentários:
ExcelScript.ChartTitlePosition enum
Referência
Pacote: ExcelScript
Representa a posição do título do gráfico.
Campos
automatic
bottom
left
right
top
comentários:
ExcelScript.ChartTrendlineType enum
Referência
Pacote: ExcelScript
Campos
exponential
linear
logarithmic
movingAverage
polynomial
power
comentários:
ExcelScript.ChartType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This sample creates a column-clustered chart based on the current
worksheet's data.
*/
// 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");
}
Campos
area
areaStacked
areaStacked100
barClustered
barOfPie
barStacked
barStacked100
boxwhisker
bubble
bubble3DEffect
columnClustered
columnStacked
columnStacked100
coneBarClustered
coneBarStacked
coneBarStacked100
coneCol
coneColClustered
coneColStacked
coneColStacked100
cylinderBarClustered
cylinderBarStacked
cylinderBarStacked100
cylinderCol
cylinderColClustered
cylinderColStacked
cylinderColStacked100
doughnut
doughnutExploded
funnel
histogram
invalid
line
lineMarkers
lineMarkersStacked
lineMarkersStacked100
lineStacked
lineStacked100
pareto
pie
pieExploded
pieOfPie
pyramidBarClustered
pyramidBarStacked
pyramidBarStacked100
pyramidCol
pyramidColClustered
pyramidColStacked
pyramidColStacked100
radar
radarFilled
radarMarkers
regionMap
stockHLC
stockOHLC
stockVHLC
stockVOHLC
sunburst
surface
surfaceTopView
surfaceTopViewWireframe
surfaceWireframe
treemap
waterfall
xyscatter
xyscatterLines
xyscatterLinesNoMarkers
xyscatterSmooth
xyscatterSmoothNoMarkers
comentários:
ExcelScript.ChartUnderlineStyle enum
Referência
Pacote: ExcelScript
Campos
none
single
comentários:
ExcelScript.ClearApplyTo enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script removes any extra formatting that's been applied to a table.
* This leaves only the base table style effects.
* Any formatting outside of the table will be left as is.
*/
let worksheet = workbook.getActiveWorksheet();
let table = worksheet.getTables()[0];
// Get the range used by the table.

let range = table.getRange();
// Clear all the formatting that is not applied by the table and the table
style.
range.clear(ExcelScript.ClearApplyTo.formats);
}
Campos
all
contents Limpa o conteúdo do intervalo.
formats Limpa toda a formatação para o intervalo.
hyperlinks Limpa todos os hiperlinks, mas deixa todo o conteúdo e a formatação

intactos.
removeHyperlinks Remove hiperlinks e formatação para a célula, mas deixa o conteúdo,

formatos condicionais e validação de dados intactos.
comentários:
ExcelScript.ConditionalCellValue
Operator enum
Referência
Pacote: ExcelScript
Representa o operador do tipo de formato condicional de texto.
Comentários
Exemplos
TypeScript
/**
* This script applies conditional formatting to a range.
* That formatting is conditional upon the cell's numerical value.
* Any value between 50 and 75 will have the cell fill color changed and the
font made italic.
*/
// Get the range to format.
const ratingColumn = sheet.getRange("D2:D20");
// Add cell value conditional formatting.

const cellValueConditionalFormatting =
ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValu
e).getCellValue();
// Set the format to apply when the condition is met.

let format = cellValueConditionalFormatting.getFormat();
format.getFill().setColor("yellow");
format.getFont().setItalic(true);
// Create the condition, in this case when the cell value is between 50
and 75.
let rule: ExcelScript.ConditionalCellValueRule = {
formula1: "50",
formula2: "75",
operator: ExcelScript.ConditionalCellValueOperator.between
};
cellValueConditionalFormatting.setRule(rule);
}
Campos
between
equalTo
greaterThan
greaterThanOrEqual
invalid
lessThan
lessThanOrEqual
notBetween
notEqualTo
comentários:
ExcelScript.ConditionalDataBarAxis
Format enum
Referência
Pacote: ExcelScript
Representa as opções de formato para um eixo de barra de dados.
Campos
automatic
cellMidPoint
none
comentários:
ExcelScript.ConditionalDataBarDirection
enum
Referência
Pacote: ExcelScript
Representa a direção da barra de dados dentro de uma célula.
Campos
context
leftToRight
rightToLeft
comentários:
ExcelScript.ConditionalFormatColor
CriterionType enum
Referência
Pacote: ExcelScript
Representa os tipos de critério de cor para formatação condicional.
Comentários
Exemplos
TypeScript
/**
* This script applies a red, white, and blue color scale to the selected
range.
*/
// Get the selected range.
let selectedRange = workbook.getSelectedRange();
// Create a new conditional formatting object by adding one to the range.

let conditionalFormatting =
selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorSc
ale);
// Set the colors for the three parts of the scale: minimum, midpoint, and
maximum.
conditionalFormatting.getColorScale().setCriteria({
minimum: {
color:"#F8696B", /* A pale red. */
type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
},
midpoint: {
color: "#FCFCFF", /* Slightly off-white. */
formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentil
e
},
maximum: {
color: "#5A8AC6", /* A pale blue. */
type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
}
});
}
Campos
formula
highestValue
invalid
lowestValue
number
percent
percentile
comentários:
ExcelScript.ConditionalFormatDirection
enum
Referência
Pacote: ExcelScript
Representa a direção de uma seleção.
Campos
bottom
top
comentários:
ExcelScript.ConditionalFormatIconRule
Type enum
Referência
Pacote: ExcelScript
Representa os tipos de formato condicional de ícone.
Comentários
Exemplos
TypeScript
/**
* This script applies icon set conditional formatting to a range.
*/
// Get the range "A1:A5" on the current worksheet.
const range = sheet.getRange("A1:A5");
// Create icon set conditional formatting on the range.

const conditionalFormatting =
range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
// Use the "3 Traffic Lights (Unrimmed)" set.
conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTraffic
Lights1);
// Set the criteria to use a different icon for the bottom, middle, and
top thirds of the values in the range.
const criteria: ExcelScript.ConditionalIconCriterion[] = [
{
formula: '=0', operator:
ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
type: ExcelScript.ConditionalFormatIconRuleType.percent
},
{
},
{
}];
conditionalFormatting.getIconSet().setCriteria(criteria);
}
Campos
formula
invalid
number
percent
percentile
comentários:
ExcelScript.ConditionalFormatPreset
Criterion enum
Referência
Pacote: ExcelScript
Representa os critérios do tipo de formato condicional de critérios predefinidos.
Comentários
Exemplos
TypeScript
/**
* This script applies a conditional format that uses a preset criterion.
* Any cell in row 1 will have the color fill set to green if it is a
duplicate value
* (of anything else in row 1).
*/
// Get the range for row 1.
const formattedRange = sheet.getRange("1:1");
// Add new conditional formatting to that range.

const conditionalFormat = formattedRange.addConditionalFormat(
ExcelScript.ConditionalFormatType.presetCriteria);
// Set the conditional formatting to apply a green fill.

const presetFormat = conditionalFormat.getPreset();
presetFormat.getFormat().getFill().setColor("green");
// Set a rule to apply the conditional format when values are duplicated
in the range.
const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
};
presetFormat.setRule(duplicateRule);
}
Campos
aboveAverage
belowAverage
blanks
duplicateValues
equalOrAboveAverage
equalOrBelowAverage
errors
invalid
lastMonth
lastSevenDays
lastWeek
nextMonth
nextWeek
nonBlanks
nonErrors
oneStdDevAboveAverage
oneStdDevBelowAverage
thisMonth
thisWeek
threeStdDevAboveAverage
threeStdDevBelowAverage
today
tomorrow
twoStdDevAboveAverage
twoStdDevBelowAverage
uniqueValues
yesterday
comentários:
ExcelScript.ConditionalFormatRuleType
enum
Referência
Pacote: ExcelScript
Representa os tipos de valores de formato condicional.
Comentários
Exemplos
TypeScript
/**
* This script creates data bar conditional formatting on the selected
range.
* The scale of the data bar goes from 0 to 1000.
*/
const selected = workbook.getSelectedRange();
// Create new conditional formatting on the range.

const format =
selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
const dataBarFormat = format.getDataBar();
// Set the lower bound of the data bar formatting to be 0.

const lowerBound: ExcelScript.ConditionalDataBarRule = {
type: ExcelScript.ConditionalFormatRuleType.number,
formula: "0"
};
dataBarFormat.setLowerBoundRule(lowerBound);
// Set the upper bound of the data bar formatting to be 1000.

const upperBound: ExcelScript.ConditionalDataBarRule = {
formula: "1000"
};
dataBarFormat.setUpperBoundRule(upperBound);
}
Campos
automatic
formula
highestValue
invalid
lowestValue
number
percent
percentile
comentários:
enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
range.
*/
// Create a new conditional formatting object by adding one to the range.

selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorSc
ale);
// Set the colors for the three parts of the scale: minimum, midpoint, and
maximum.
minimum: {
},
midpoint: {
formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentil
e
},
maximum: {
}
});
}
Campos
cellValue
colorScale
containsText
custom
dataBar
iconSet
presetCriteria
topBottom
comentários:
ExcelScript.ConditionalIconCriterion
Operator enum
Referência
Pacote: ExcelScript
Representa o operador para cada critério de ícone.
Comentários
Exemplos
TypeScript
/**
*/

Lights1);
{
},
{
},
{
}];
}
Campos
greaterThan
greaterThanOrEqual
invalid
comentários:
ExcelScript.ConditionalRangeBorder
Index enum
Referência
Pacote: ExcelScript
Campos
edgeBottom
edgeLeft
edgeRight
edgeTop
comentários:
ExcelScript.ConditionalRangeBorderLine
Style enum
Referência
Pacote: ExcelScript
Campos
continuous
dash
dashDot
dashDotDot
dot
none
comentários:
ExcelScript.ConditionalRangeFont
UnderlineStyle enum
Referência
Pacote: ExcelScript
Campos
double
none
single
comentários:
ExcelScript.ConditionalTextOperator
enum
Referência
Pacote: ExcelScript
Representa o operador do tipo de formato condicional de texto.
Comentários
Exemplos
TypeScript
/**
* This script adds conditional formatting to the first column in the
worksheet.
* This formatting gives the cells a green fill if they have text starting
with "Excel".
*/
// Get the first column in the current worksheet.
const firstColumn = currentSheet.getRange("A:A");
// Add conditional formatting based on the text in the cells.

const textConditionFormat =
firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsT
ext).getTextComparison();
// Set the conditional format to provide a green fill.

textConditionFormat.getFormat().getFill().setColor("green");
// Apply the condition rule that the text begins with "Excel".
const textRule: ExcelScript.ConditionalTextComparisonRule = {
operator: ExcelScript.ConditionalTextOperator.beginsWith,
text: "Excel"
};
textConditionFormat.setRule(textRule);
}
Campos
beginsWith
contains
endsWith
invalid
notContains
comentários:
ExcelScript.ConditionalTopBottom
CriterionType enum
Referência
Pacote: ExcelScript
Representa os critérios para o tipo de formato condicional acima/abaixo da média.
Campos
bottomItems
bottomPercent
invalid
topItems
topPercent
comentários:
ExcelScript.ConnectorType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
worksheet.
*/

const line = sheet.addLine(
b2Range.getLeft(),
b2Range.getTop(),
f4Range.getLeft(),
f4Range.getTop(),
}
Campos
curve
elbow
straight
comentários:
ExcelScript.ContentType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This sample creates a comment that mentions a specific person.
* That person will get a notification and link to the workbook.
*/
// Get the first cell in the current worksheet.
const cell = currentSheet.getCell(0,0);
/* Create a CommentMention object for the comment.

*
* A CommentMention's properties are:
* `name`: The name of the person being mentioned.
* ìd`: The zero-based index of this mention in the comment.
* èmail`: The email address of the person being mentioned.
*/
const mention: ExcelScript.CommentMention = {
name: "Alex",
id: 0,
email: "alex@contoso.com"
};
/* Create comment content that uses the mention.

* The `<at id="0">` syntax embeds the mention with ID 0 in the comment
text.
* The name is displayed in the comment,
* while an email is sent to the given address.
*/
const content: ExcelScript.CommentRichContent = {
richContent: '<at id="0">' + mention.name + "</at> - Hello!",
mentions: [mention]
};
// Add the comment.

currentSheet.addComment(cell, content, ExcelScript.ContentType.mention);
}
Campos
mention Comente conteúdo contendo menções.
plain Indica um tipo de formato simples para o conteúdo do comentário.
comentários:
ExcelScript.DataValidationAlertStyle
enum
Referência
Pacote: ExcelScript
Representa o estilo de alerta de erro de validação de dados. O padrão é Stop .
Comentários
Exemplos
TypeScript
/**
* This script creates a data validation rule for the range B1:B5.
* All values in that range must be a positive number.
* Attempts to enter other values are blocked and an error message appears.
*/
// Get the range B1:B5 in the active worksheet.
const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
// Create a data validation rule to only allow positive numbers.

const positiveNumberValidation: ExcelScript.BasicDataValidation = {
formula1: "0",
operator: ExcelScript.DataValidationOperator.greaterThan
};
const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
wholeNumber: positiveNumberValidation
};
// Set the rule on the range.

const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
rangeDataValidation.setRule(positiveNumberOnlyRule);
// Create an alert to appear when data other than positive numbers are
entered.
const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
message: "Positive numbers only",
showAlert: true,
style: ExcelScript.DataValidationAlertStyle.stop,
title: "Invalid data"
};
rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
}
Campos
information
stop
warning
comentários:
ExcelScript.DataValidationOperator
enum
Referência
Pacote: ExcelScript
Representa o enumeração do operador de validação de dados.
Comentários
Exemplos
TypeScript
/**
*/

formula1: "0",
};
};

}
Campos
between
equalTo
greaterThan
greaterThanOrEqualTo
lessThan
lessThanOrEqualTo
notBetween
notEqualTo
comentários:
ExcelScript.DataValidationType enum
Referência
Pacote: ExcelScript
Representa o enumeração de tipo de validação de dados.
Comentários
Exemplos
TypeScript
/**
* This sample reads and logs the data validation type of the currently
selected range.
*/
// Get the currently selected range.
let range = workbook.getSelectedRange();
// Get the type (`DataValidationType`) of data validation applied to the

range.
let validationType = range.getDataValidation().getType();
/*
* Log the data validation type.
* If the range has a single value, it logs that type.
* If the range doesn't have data validation applied, it logs "None".
* If the range has multiple different types of data validation, it logs
"Inconsistent" or "MixedCriteria".
*/
console.log(validationType.toString());
}
Campos
custom O tipo de validação de dados personalizado.
date O tipo de validação de dados de data.
decimal O tipo de validação de dados decimais.

inconsistent Inconsistente significa que o intervalo tem validação de dados inconsistente,
indicando que há regras diferentes em células diferentes.
list O tipo de validação de dados de lista.
mixedCriteria Critérios mistos significam que o intervalo tem validação de dados presente em
algumas células, mas não em todas as células.
none Nenhum significa permitir qualquer valor, indicando que não há validação de
dados no intervalo.
textLength O tipo de validação de dados de comprimento de texto.
time O tipo de validação de dados de tempo.
wholeNumber O tipo de validação de dados de número inteiro.
comentários:
ExcelScript.DateFilterCondition enum
Referência
Pacote: ExcelScript
Enumerando todas as condições aceitas pelas quais um filtro de data pode ser aplicado.
Usado para configurar o tipo de PivotFilter que é aplicado ao campo.
Comentários
Exemplos
TypeScript
/**
* This script applies a filter to a PivotTable that filters out rows
* that aren't from this month.
*/
// Get the "Date Recorded" field to filter.
// The data in this field must be dates in order for the filter to work.
const pivot = workbook.getPivotTables()[0];
const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
const rowField = rowHierarchy.getFields()[0];
// Apply the date filter.

rowField.applyFilter({
dateFilter: {
// Setting the condition to `thisMonth` means items that are before or
// after this month will not be displayed.
condition: ExcelScript.DateFilterCondition.thisMonth
}
});
}
Campos
after A data é após a data do comparador.
Critérios necessários: { comparator }. Critérios opcionais: { wholeDays }.
afterOrEqualTo A data é posterior ou igual à data do comparador.

allDatesInPeriodApril A data é em abril.
allDatesInPeriodAugust A data é em agosto.
allDatesInPeriodDecember A data é em dezembro.
allDatesInPeriodFebruary A data é em fevereiro.
allDatesInPeriodJanuary A data é em janeiro.
allDatesInPeriodJuly A data é em julho.
allDatesInPeriodJune A data é em junho.
allDatesInPeriodMarch A data é em março.
allDatesInPeriodMay A data é em maio.
allDatesInPeriodNovember A data é em novembro.
allDatesInPeriodOctober A data é em outubro.
allDatesInPeriodQuarter1 A data está no trimestre 1.
allDatesInPeriodSeptember A data é em setembro.
before A data é antes da data do comparador.
beforeOrEqualTo A data é anterior ou igual à data do comparador.
between Entre lowerBound e upperBound datas.
Critérios necessários: { lowerBound , upperBound }. Critérios opcionais:

{ wholeDays , exclusive }.
equals É igual ao critério do comparador.
Critérios necessários: { comparator }. Critérios opcionais: { wholeDays ,

exclusive }.
lastMonth A data é mês passado.

lastQuarter A data é o último trimestre.
lastWeek A data foi na semana passada.
lastYear A data é do ano passado.
nextMonth A data será no próximo mês.
nextQuarter A data será no próximo trimestre.
nextWeek A data é na próxima semana.
nextYear A data será no ano que vem.
thisMonth A data é este mês.
thisQuarter A data é este trimestre.
thisWeek A data é esta semana.
thisYear A data é este ano.
today A data é hoje.
tomorrow A data é amanhã.
unknown DateFilterCondition é desconhecido ou sem suporte.
yearToDate A data está no mesmo ano até agora.
yesterday A data é ontem.
comentários:
ExcelScript.DeleteShiftDirection enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This sample creates a sample range, then deletes
* "A1" using different DeleteShiftDirection values.
*/
// Add sample data to better visualize the delete changes.
currentSheet.getRange("A1:D4").setValues([
[1,2,3,4],
[5,6,7,8],
[9,10,11,12],
[13,14,15,16]]);
// Delete A1 and shift the cells from the right to fill the space.
// The value being deleted is 1.
currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left);
// Delete A1 and shift the cells from the bottom to fill the space.
currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up);
// Log the sample range. The values should be:

/*
5, 3, 4, "",
9, 6, 7, 8,
13, 10, 11, 12,
"", 14, 15, 16
*/
console.log(currentSheet.getRange("A1:D4").getValues());
}
Campos
left
up
comentários:
enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script uses a custom property to set the value and formatting of a
cell.
* If the value of "Routing Number" is not set or is not a number, the cell
will be red.
*/
// Get the first cell from Sheet1.
const cell = workbook.getWorksheet("Sheet1").getCell(0,0);
// Get the "Routing Number" property.

const properties = workbook.getProperties();
const routingNumber = properties.getCustomProperty("Routing Number");
// If the property is missing or is not a number, change the formatting to

indicate a problem.
if (!routingNumber || routingNumber.getType() !=
ExcelScript.DocumentPropertyType.number) {
cell.getFormat().getFill().setColor("red");
}
// If the property exists, use it to set the value of A1.

if (routingNumber) {
cell.setValue(routingNumber.getValue());
}
}
Campos
boolean
date
float
number
string
comentários:
ExcelScript.DynamicFilterCriteria enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script applies a filter to a table that filters it
* to only show rows with dates from the previous month.
*/
// Get the table named "ReportTable".
const table = workbook.getTable("ReportTable");
// Get the column with the header "Date".

const dateColumn = table.getColumnByName("Date");
// Apply a dynamic filter to the column.

// `lastMonth` will only show rows with a date from the previous month.
dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriteria.
lastMonth);
}
Campos
aboveAverage
allDatesInPeriodApril
allDatesInPeriodAugust
allDatesInPeriodDecember
allDatesInPeriodFebruary
allDatesInPeriodJanuary
allDatesInPeriodJuly
allDatesInPeriodJune
allDatesInPeriodMarch
allDatesInPeriodMay
allDatesInPeriodNovember
allDatesInPeriodOctober
allDatesInPeriodQuarter1
allDatesInPeriodSeptember
belowAverage
lastMonth
lastQuarter
lastWeek
lastYear
nextMonth
nextQuarter
nextWeek
nextYear
thisMonth
thisQuarter
thisWeek
thisYear
today
tomorrow
unknown
yearToDate
yesterday
comentários:
ExcelScript.FillPattern enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script sets a black-checkered fill on the selected range.
*/
selected.getFormat().getFill().setPattern(ExcelScript.FillPattern.checker);
selected.getFormat().getFill().setPatternColor("black");
}
Campos
checker
crissCross
down
gray16
gray25
gray50
gray75
gray8
grid
horizontal
lightDown
lightHorizontal
lightUp
lightVertical
linearGradient
none
rectangularGradient
semiGray75
solid
up
vertical
comentários:
enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script applies a filter to a PivotTable that filters it
* to only show rows from between June 20th, 2022 and July 10th, 2022.
*/
// Create the filter's date boundaries.

let earliestDate: ExcelScript.FilterDatetime = {
date: "2022-06-20",
specificity: ExcelScript.FilterDatetimeSpecificity.day
};
let latestDate: ExcelScript.FilterDatetime = {
date: "2022-07-10",
};

dateFilter: {
condition: ExcelScript.DateFilterCondition.between,
lowerBound: earliestDate,
upperBound: latestDate
}
});
}
Campos
day
hour
minute
month
second
year
comentários:
ExcelScript.FilterOn enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script applies a filter to a table so that
* only rows with values in column 1 that start with "L" are shown.
*/
// Get the autoFilter of the first table in the current worksheet.
const table = workbook.getActiveWorksheet().getTables()[0];
const autoFilter = table.getAutoFilter();
// Filter to only include values that start with "L".

const filterCriteria: ExcelScript.FilterCriteria = {
filterOn: ExcelScript.FilterOn.custom,
criterion1: "L*"
};
// Apply the filter to column 1 (zero-based).

autoFilter.apply(table.getRange(), 1, filterCriteria);
}
Campos
bottomItems
bottomPercent
cellColor
custom
dynamic
fontColor
icon
topItems
topPercent
values
comentários:
ExcelScript.FilterOperator enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* The script filters rows from a table based on a numerical range.
*/
// Get the first table in the current worksheet.
const table = currentSheet.getTables()[0];
// Filter to only show rows with a value in the "Exam Score" column that
is
// greater than 0 and less than or equal to 60.
table.getColumnByName("Exam Score").getFilter().applyCustomFilter(">0", "
<=60", ExcelScript.FilterOperator.and);
}
Campos
and
or
comentários:
ExcelScript.GeometricShapeType enum
Referência
Pacote: ExcelScript
Especifica o tipo de forma de um GeometricShape objeto.
Comentários
Exemplos
TypeScript
/**
* This script creates a hexagon shape on the current worksheet.
*/
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);
}
Campos
accentBorderCallout1
accentCallout1
accentCallout2
accentCallout3
actionButtonBackPrevious
actionButtonBeginning
actionButtonBlank
actionButtonDocument
actionButtonEnd
actionButtonForwardNext
actionButtonHelp
actionButtonHome
actionButtonInformation
actionButtonMovie
actionButtonReturn
actionButtonSound
arc
bentArrow
bentUpArrow
bevel
blockArc
borderCallout1
borderCallout2
borderCallout3
bracePair
bracketPair
callout1
callout2
callout3
can
chartPlus
chartStar
chartX
chevron
chord
circularArrow
cloud
cloudCallout
corner
cornerTabs
cube
curvedDownArrow
curvedLeftArrow
curvedRightArrow
curvedUpArrow
decagon
diagonalStripe
diamond
dodecagon
donut
doubleWave
downArrow
downArrowCallout
ellipse
ellipseRibbon
ellipseRibbon2
flowChartAlternateProcess
flowChartCollate
flowChartConnector
flowChartDecision
flowChartDelay
flowChartDisplay
flowChartDocument
flowChartExtract
flowChartInputOutput
flowChartInternalStorage
flowChartMagneticDisk
flowChartMagneticDrum
flowChartMagneticTape
flowChartManualInput
flowChartManualOperation
flowChartMerge
flowChartMultidocument
flowChartOfflineStorage
flowChartOffpageConnector
flowChartOnlineStorage
flowChartOr
flowChartPredefinedProcess
flowChartPreparation
flowChartProcess
flowChartPunchedCard
flowChartPunchedTape
flowChartSort
flowChartSummingJunction
flowChartTerminator
foldedCorner
frame
funnel
gear6
gear9
halfFrame
heart
heptagon
hexagon
homePlate
horizontalScroll
irregularSeal1
irregularSeal2
leftArrow
leftArrowCallout
leftBrace
leftBracket
leftCircularArrow
leftRightArrow
leftRightArrowCallout
leftRightCircularArrow
leftRightRibbon
leftRightUpArrow
leftUpArrow
lightningBolt
lineInverse
mathDivide
mathEqual
mathMinus
mathMultiply
mathNotEqual
mathPlus
moon
nonIsoscelesTrapezoid
noSmoking
notchedRightArrow
octagon
parallelogram
pentagon
pie
pieWedge
plaque
plaqueTabs
plus
quadArrow
quadArrowCallout
rectangle
ribbon
ribbon2
rightArrow
rightArrowCallout
rightBrace
rightBracket
rightTriangle
round1Rectangle
round2DiagonalRectangle
round2SameRectangle
roundRectangle
smileyFace
snip1Rectangle
snip2DiagonalRectangle
snip2SameRectangle
snipRoundRectangle
squareTabs
star10
star12
star16
star24
star32
star4
star5
star6
star7
star8
stripedRightArrow
sun
swooshArrow
teardrop
trapezoid
triangle
upArrow
upArrowCallout
upDownArrow
upDownArrowCallout
uturnArrow
verticalScroll
wave
wedgeEllipseCallout
wedgeRectCallout
wedgeRRectCallout
comentários:
ExcelScript.GroupOption enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script creates a two-level column-based outline on Sheet1.
*/
// Group columns A-F in the worksheet named Sheet1.
const sheet = workbook.getWorksheet("Sheet1");
const firstLevel = sheet.getRange("A:F");
firstLevel.group(ExcelScript.GroupOption.byColumns);
// Create a second level to the outline by grouping subsections.

sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns);
sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns);
}
Campos
byColumns Agrupar por colunas.
byRows Agrupar por linhas.
comentários:
ExcelScript.HeaderFooterState enum
Referência
Pacote: ExcelScript
Campos
default Apenas um cabeçalho/rodapé geral é usado para todas as páginas impressas.
firstAndDefault Há um cabeçalho/rodapé de primeira página separado e um

cabeçalho/rodapé geral usado para todas as outras páginas.
firstOddAndEven Há um cabeçalho/rodapé de primeira página separado, em seguida, há um

cabeçalho/rodapé separado para páginas ímpares e uniformes.
oddAndEven Há um cabeçalho/rodapé diferente para páginas ímpares e uniformes.
comentários:
ExcelScript.HorizontalAlignment enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script centers the text in a table's header row cells.
*/
// Get the header range.

const headerRange = table.getHeaderRowRange();
// Set the horizontal text alignment to `center`.
headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignme
nt.center);
}
Campos
center
centerAcrossSelection
distributed
fill
general
justify
left
right
comentários:
ExcelScript.IconSet enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
*/

Lights1);
conditionalFormatting.getIconSet().setCriteria([
{
formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterTh
anOrEqual,
type:ExcelScript.ConditionalFormatIconRuleType.percent
},
{
formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterT
hanOrEqual,
type:ExcelScript.ConditionalFormatIconRuleType.percent},
{
hanOrEqual,
}]);
}
Campos
fiveArrows
fiveArrowsGray
fiveBoxes
fiveQuarters
fiveRating
fourArrows
fourArrowsGray
fourRating
fourRedToBlack
fourTrafficLights
invalid
threeArrows
threeArrowsGray
threeFlags
threeSigns
threeStars
threeSymbols
threeSymbols2
threeTrafficLights1
threeTrafficLights2
threeTriangles
ExcelScript.ImageFittingMode enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script returns an image of the first chart in the first worksheet.
* That image is 600x400 pixels and the chart will be
* stretched to fill those dimensions.
* The returned image can be used in a Power Automate flow.
*/
function main(workbook: ExcelScript.Workbook): string {
// Get the first chart in the first worksheet.
const firstSheet = workbook.getFirstWorksheet();
const firstChart = firstSheet.getCharts()[0];
// Get an image of the chart as a base64-encoded string.

const base64String = firstChart.getImage(
600, /* Width */
400, /* Height */
ExcelScript.ImageFittingMode.fill /* Fill to match the dimensions. */
);
return base64String;
}
Campos
fill
fit
fitAndCenter
comentários:
ExcelScript.InsertShiftDirection enum
Referência
Pacote: ExcelScript
Determina a direção em que as células existentes serão deslocadas para acomodar o

que está sendo inserido.
Comentários
Exemplos
TypeScript
/**
* This script inserts headers at the top of the worksheet.
*/
function main(workbook: ExcelScript.Workbook)
{
let currentSheet = workbook.getActiveWorksheet();
// Create headers for 3 columns.

let myHeaders = [["NAME", "ID", "ROLE"]];
// Add a blank first row and push existing data down a row.
let firstRow = currentSheet.getRange("1:1");
firstRow.insert(ExcelScript.InsertShiftDirection.down);
// Add the headers.

currentSheet.getRange("A1:C1").setValues(myHeaders);
}
Campos
down
right
comentários:
ExcelScript.KeyboardDirection enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script makes the font bold on all the contiguous cells between
* A1 and the bottom of the used range of the first column.
*/
{
// Get every cell that's used between A1 and the end of the column.
// This recreates the Ctrl+Shift+Down arrow key behavior.
let firstCell = selectedSheet.getRange("A1");
let firstColumn =
firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down);
// Set the font to bold in that range.

firstColumn.getFormat().getFont().setBold(true);
}
Campos
down
left
right
up
comentários:
ExcelScript.LabelFilterCondition enum
Referência
Pacote: ExcelScript
Enumerando todas as condições aceitas pelas quais um filtro de rótulo pode ser
aplicado. Usado para configurar o tipo de PivotFilter que é aplicado ao campo.
PivotFilter.criteria.exclusive pode ser definido para true inverter muitas dessas
condições.
Comentários
Exemplos
TypeScript
/**
* This script filters items that start with "L" from the "Type" field
* of the "Farm Sales" PivotTable.
*/
// Get the PivotTable.
const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm
Sales");
// Get the "Type" field.

const field = pivotTable.getHierarchy("Type").getPivotField("Type");
// Filter out any types that start with "L" (such as "Lemons" and
"Limes").
const filter: ExcelScript.PivotLabelFilter = {
condition: ExcelScript.LabelFilterCondition.beginsWith,
substring: "L",
exclusive: true
};
// Apply the label filter to the field.

field.applyFilter({ labelFilter: filter });
}
Campos
beginsWith O rótulo começa com o critério de substring.
Critérios necessários: { substring }. Critérios opcionais: { exclusive }.
between Entre lowerBound critérios e upperBound .
Critérios necessários: { lowerBound , upperBound }. Critérios opcionais:

{ exclusive }.
contains O rótulo contém critério de substring.
endsWith O rótulo termina com critério de substring.
Critérios necessários: { comparator }. Critérios opcionais: { exclusive }.
greaterThan Maior que o critério de comparador.
Critérios necessários: { comparator }.
greaterThanOrEqualTo Maior ou igual ao critério de comparador.
lessThan Critério inferior ao comparador.
lessThanOrEqualTo Menor ou igual a critério de comparador.
unknown LabelFilterCondition é desconhecido ou sem suporte.

comentários:
ExcelScript.LinkedDataTypeState enum
Referência
Pacote: ExcelScript
Campos
brokenLinkedData
disambiguationNeeded
fetchingData
none
validLinkedData
comentários:
ExcelScript.NamedItemScope enum
Referência
Pacote: ExcelScript
Campos
workbook
worksheet
comentários:
ExcelScript.NamedItemType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script looks for every named range with "Review" in the name
* and marks the range with a yellow fill.
*/
// Look at every named item in the workbook.
workbook.getNames().forEach((namedItem) => {
// Find names containing "Review".
if (namedItem.getName().includes("Review")) {
// Only change the fill color if the named item is a range (not a
formula).
let itemType: ExcelScript.NamedItemType = namedItem.getType();
if (itemType === ExcelScript.NamedItemType.range) {
// Set the range's fill color to yellow.
namedItem.getRange().getFormat().getFill().setColor("yellow");
}
}
});
}
Campos
array
boolean
double
error
integer
range
string
comentários:
ExcelScript.NumberFormatCategory
enum
Referência
Pacote: ExcelScript
Representa uma categoria de formatos de número.
Comentários
Exemplos
TypeScript
/**
* This script finds cells in a table column that are not formatted as
currency
* and sets the fill color to red.
*/
// Get the "Cost" column from the "Expenses" table.
const table = workbook.getTable("Expenses");
const costColumn = table.getColumnByName("Cost");
const costColumnRange = costColumn.getRangeBetweenHeaderAndTotal();
// Get the number format categories for the column's range.

const numberFormatCategories =
costColumnRange.getNumberFormatCategories();
// If any cell in the column doesn't have a currency format, make the cell
red.
numberFormatCategories.forEach((category, index) =>{
if (category[0] != ExcelScript.NumberFormatCategory.currency) {
costColumnRange.getCell(index,
0).getFormat().getFill().setColor("red");
}
});
}
Campos
accounting Os formatos de contabilidade alinham os símbolos de moeda e os pontos decimal
em uma coluna.
currency Conversor de Moedas formatos são usados para valores monetários gerais. Use
formatos de contabilidade para alinhar pontos decimais em uma coluna.
custom Um formato personalizado que não faz parte de nenhuma categoria.
date Os formatos de data exibem números de série de data e hora como valores de data.
Os formatos de data que começam com um asterisco (*) respondem a alterações
nas configurações regionais de data e hora especificadas para o sistema
operacional. Os formatos sem um asterisco não são afetados pelas configurações
do sistema operacional.
fraction Os formatos de fração exibem o valor da célula como um número inteiro com o
restante arredondado para o valor de fração mais próximo.
general As células de formato geral não têm um formato de número específico.
number O número é usado para exibição geral de números. Conversor de Moedas e a

contabilidade oferecem formatação especializada para valor monetário.
percentage Formatos percentuais multiplicam o valor da célula por 100 e exibem o resultado
com um símbolo percentual.
scientific Formatos científicos exibem o valor da célula como um número entre 1 e 10

multiplicado por uma potência de 10.
special Formatos especiais são úteis para acompanhar valores de lista e banco de dados.
text As células de formato de texto são tratadas como texto mesmo quando um número
está na célula. A célula é exibida exatamente como inserida.
time Os formatos de hora exibem números de série de data e hora como valores de data.
Os formatos de tempo que começam com um asterisco (*) respondem a alterações
nas configurações de data e hora regionais especificadas para o sistema
operacional. Os formatos sem um asterisco não são afetados pelas configurações
do sistema operacional.
comentários:
ExcelScript.PageOrientation enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script sets the printing orientation for the entire 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);
});
}
Campos
landscape
portrait
comentários:
ExcelScript.PaperType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script sets the page size for printing.
*/
// Print on 8.5"x11" paper.
pageLayout.setPaperSize(ExcelScript.PaperType.letter);
});
}
Campos
a3
a4
a4Small
a5
b4
b5
csheet
dsheet
envelope10
envelope11
envelope12
envelope14
envelope9
envelopeB4
envelopeB5
envelopeB6
envelopeC3
envelopeC4
envelopeC5
envelopeC6
envelopeC65
envelopeDL
envelopeItaly
envelopeMonarch
envelopePersonal
esheet
executive
fanfoldLegalGerman
fanfoldStdGerman
fanfoldUS
folio
ledger
legal
letter
letterSmall
note
paper10x14
paper11x17
quatro
statement
tabloid
comentários:
ExcelScript.PictureFormat enum
Referência
Pacote: ExcelScript
O formato da imagem.
Comentários
Exemplos
TypeScript
/**
* This script creates a star shape with the value from cell A1.
* It then returns the image as a base64-encoded string.
* This string would be used as part of a Power Automate flow to add the
image elsewhere.
*/
// Get the value of A1 from the worksheet named Sheet1.
const value = sheet.getRange("A1").getValue();
// Create a Shape object that looks like a 5-pointed star.

const star =
sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
// Set the text of star and make sure the shape fits the text.
const textFrame = star.getTextFrame();
textFrame.getTextRange().setText(value.toString());
textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitTex
t);
// Return the shape as a PNG image represented by a base64-encoded string.

return star.getAsImage(ExcelScript.PictureFormat.png);
}
Campos
bmp Imagem de bitmap.

gif Formato de intercâmbio de gráficos.
jpeg Grupo conjunto de especialistas fotográficos.
png Gráficos de rede portáteis.
svg Gráfico vetor escalonável.
unknown
comentários:
ExcelScript.PivotAxis enum
Referência
Pacote: ExcelScript
Representa o eixo do qual obter os PivotItems.
Campos
column O eixo da coluna.
data O eixo de dados.
filter O eixo do filtro.
row O eixo da linha.
unknown O eixo ou região é desconhecido ou sem suporte.
comentários:
ExcelScript.PivotFilterTopBottom
Criterion enum
Referência
Pacote: ExcelScript
Representa os critérios para o filtro de valores superior/inferior.
Campos
bottomItems
bottomPercent
bottomSum
invalid
topItems
topPercent
topSum
comentários:
ExcelScript.PivotFilterType enum
Referência
Pacote: ExcelScript
Um enumeração simples que representa um tipo de filtro para um PivotField.
Comentários
Exemplos
TypeScript
/**
* This script gets the "Type" field from the "Farms Sales" PivotTable
* and clears the value filter from it.
*/
// Get the PivotTable named "Farm Sales".
const pivot = workbook.getPivotTable("Farm Sales");

const typeField = pivot.getHierarchy("Type").getPivotField("Type");
// Clear the value filter (if there is one) from the field.
typeField.clearFilter(ExcelScript.PivotFilterType.value);
}
Campos
date Filtra PivotItems com uma data no lugar de um rótulo. Observação: um PivotField não
pode ter simultaneamente um filtro de rótulo e um filtro de data aplicado.
label Filtra PivotItems com base em seus rótulos. Observação: um PivotField não pode ter
simultaneamente um filtro de rótulo e um filtro de data aplicado.
manual Filtros específicos de PivotItems selecionados manualmente na Tabela Dinâmica.
unknown PivotFilterType é desconhecido ou sem suporte.
value Filtros com base no valor de um PivotItem em relação a um DataPivotHierarchy .

comentários:
ExcelScript.PivotLayoutType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script sets the layout of the "Farms Sales" PivotTable to the
"tabular"
* setting. This places the fields from the Rows area in separate columns.
*/
// Get the PivotLayout object.

const layout = pivot.getLayout();
// Set the layout type to "tabular".

layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
}
Campos
compact Um formulário compactado horizontalmente com rótulos do próximo campo na

mesma coluna.
outline Os itens dos campos internos estão na mesma linha que os itens e subtotais dos
campos externos estão sempre na parte inferior.
tabular Os itens dos campos internos estão sempre em uma nova linha em relação aos itens
dos campos externos.
Comentários do Office Scripts
GitHub O Office Scripts é um projeto código aberto.
A fonte deste conteúdo pode comentários:
você também pode criar e  Abrir um problema de documentação
de pull. Para obter mais  Fornecer comentários sobre o produto
ExcelScript.Placement enum
Referência
Pacote: ExcelScript
Especifica a maneira em que um objeto é anexado às suas células subjacentes.
Comentários
Exemplos
TypeScript
/**
* This script creates a diamond shape at cell C3.
* The shape moves and resizes as the grid underneath it changes.
*/
// Get cell C3 in the current worksheet.
const cell = sheet.getRange("C3");
// Create a diamond that slightly overlaps the cell C3.

const diamond =
sheet.addGeometricShape(ExcelScript.GeometricShapeType.diamond);
// Set each dimension so that the shape extends 5 pixels beyond the cell
borders.
diamond.setLeft(cell.getLeft() - 5);
diamond.setTop(cell.getTop() - 5);
diamond.setHeight(cell.getHeight() + 10);
diamond.setWidth(cell.getWidth() + 10);
// Set the placement of the shape so that it resizes and moves with the
grid.
diamond.setPlacement(ExcelScript.Placement.twoCell);
}
Campos
absolute O objeto é flutuante livre.
oneCell O objeto é movido com as células.

twoCell O objeto é movido e dimensionado com as células.
comentários:
ExcelScript.PrintComments enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script makes the comments print at the end of the worksheet
* when the workbook is printed.
*/
// Access every worksheet in the workbook.
workbook.getWorksheets().forEach(worksheet => {
// Get the page layout for each sheet.
const layout = worksheet.getPageLayout();
// Change the comment printing settings to print them at the end of the
sheet.
layout.setPrintComments(ExcelScript.PrintComments.endSheet);
});
}
Campos
endSheet Os comentários serão impressos como anotações finais no fim da planilha.
inPlace Os comentários serão impressos onde foram inseridos na planilha.
noComments Os comentários não serão impressos.
comentários:
ExcelScript.PrintErrorType enum
Referência
Pacote: ExcelScript
Campos
asDisplayed
blank
dash
notAvailable
comentários:
ExcelScript.PrintMarginUnit enum
Referência
Pacote: ExcelScript
Campos
centimeters Atribua as margens da página em centímetros.
inches Atribua as margens da página em polegadas.
points Atribua as margens da página em pontos. Um ponto é 1/72 de polegada.
comentários:
ExcelScript.PrintOrder enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script sets the print order for every worksheet in the workbook.
* The order of printed content will go over (e.g., left-to-right)
* then down (i.e., top-to-bottom).
*/
const layout: ExcelScript.PageLayout = worksheet.getPageLayout();
// Set the print order to over-then-down.

layout.setPrintOrder(ExcelScript.PrintOrder.overThenDown);
});
}
Campos
downThenOver Processa as linhas antes de processar as páginas ou campos de página à direita.
overThenDown Processa as páginas ou campos de página à direita antes de mover para baixo
nas linhas.
comentários:
enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script protects cells from being selected on the current worksheet.
*/
// Get the protection settings for the current worksheet.
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);
}
Campos
none A seleção não é permitida para células.
normal A seleção é permitida para todas as células.
unlocked A seleção é permitida apenas para células que não estão bloqueadas.
comentários:
ExcelScript.RangeCopyType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script copies all of the values from the current worksheet to a new
worksheet.
*/
// Get the used range on the current worksheet.
let usedRange = workbook.getActiveWorksheet().getUsedRange();
// Create a new worksheet with a default name.

let newSheet = workbook.addWorksheet();
// Copy the values from the used range to the new worksheet.
let copyType = ExcelScript.RangeCopyType.values; /* Change this to copy
different information, such as formats. */
let targetRange = newSheet.getRangeByIndexes(
usedRange.getRowIndex(),
usedRange.getColumnIndex(),
usedRange.getRowCount(),
usedRange.getColumnCount());
targetRange.copyFrom(usedRange, copyType);
// Switch the view to the new worksheet.

newSheet.activate();
}
Campos
all
formats
formulas
link
values
comentários:
ExcelScript.RangeUnderlineStyle enum
Referência
Pacote: ExcelScript
Campos
double
doubleAccountant
none
single
singleAccountant
comentários:
ExcelScript.RangeValueType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script formats rows in a worksheet based on the first value in that
row.
* If it's the boolean value TRUE, the row is bolded.
* If it's FALSE, nothing is changed.
* If the value type isn't a boolean, the row is italicized.
*/
// Get the used range in the active worksheet.
// Get the values in the first column.

const firstColumnValues = usedRange.getColumn(0).getValues();
// Look at the first cell in each row.

const rowCount = usedRange.getRowCount();
for (let i = 0; i < rowCount; i++) {
// Get the type of the first cell to make sure it's a boolean.
let firstValueType = usedRange.getCell(i, 0).getValueType();
// Set the bold or italic of the row as described earlier.

if (firstValueType === ExcelScript.RangeValueType.boolean) {
if (firstColumnValues[i][0] as boolean === true) {
usedRange.getRow(i).getFormat().getFont().setBold(true);
} else {
usedRange.getRow(i).getFormat().getFont().setBold(false);
}
} else {
usedRange.getRow(i).getFormat().getFont().setItalic(true);
}
}
}
Campos
boolean
double
empty
error
integer
richValue
string
unknown
comentários:
ExcelScript.ReadingOrder enum
Referência
Pacote: ExcelScript
Campos
context O sentido de leitura é determinado pelo idioma do primeiro caractere inserido. Se o

caractere de um idioma da direita para a esquerda for inserido primeiro, o sentido
de leitura será da direita para a esquerda. Se o caractere de um idioma da esquerda
para a direita for inserido primeiro, o sentido de leitura será da esquerda para a
direita.
leftToRight Ordem de leitura da esquerda para a direita
rightToLeft Ordem de leitura da direita para a esquerda
comentários:
ExcelScript.SearchDirection enum
Referência
Pacote: ExcelScript
Especifica a direção da pesquisa.
Comentários
Exemplos
TypeScript
/**
* This script searches for the next instance of the text "TK" on the
current worksheet.
* It then selects that cell and removes "TK" and all formatting from the
cell.
*/
let range = workbook.getActiveWorksheet().getUsedRange();
// Get the next cell that contains "TK".

let tkCell = range.find("TK", {
completeMatch: true, /* Don't match if the cell text only contains "TK"
as part of another string. */
matchCase: false,
searchDirection: ExcelScript.SearchDirection.forward /* Start at the
beginning of the range and go to later columns and rows. */
});
// Set focus on the found cell.

tkCell.select();
// Remove the "TK" text value from the cell, as well as any formatting
that may have been added.
tkCell.clear(ExcelScript.ClearApplyTo.all);
}
Campos
backwards Pesquise em ordem inversa.

forward Pesquise em ordem de encaminhamento.
comentários:
ExcelScript.ShapeAutoSize enum
Referência
Pacote: ExcelScript
Determina o tipo de dimensionamento automático permitido.
Comentários
Exemplos
TypeScript
/**
*/

const star =
t);
}
Campos
autoSizeMixed É usada uma combinação de esquemas de dimensionamento

automático.
autoSizeNone Sem dimensionamento automático.
autoSizeShapeToFitText A forma é ajustada ao texto.
autoSizeTextToFitShape O texto é ajustado à forma.

comentários:
ExcelScript.ShapeFillType enum
Referência
Pacote: ExcelScript
Especifica o tipo de preenchimento de uma forma.
Campos
gradient Preenchimento gradual.
mixed Preenchimento misto.
noFill Sem preenchimento.
pattern Preenchimento de padrão.
pictureAndTexture Preenchimento de imagem e textura.
solid Preenchimento sólido.
comentários:
ExcelScript.ShapeFontUnderlineStyle
enum
Referência
Pacote: ExcelScript
O tipo de sublinhado aplicado a uma fonte.
Campos
dash
dashHeavy
dashLong
dashLongHeavy
dotDash
dotDashHeavy
dotDotDash
dotDotDashHeavy
dotted
dottedHeavy
double
heavy
none
single
wavy
wavyDouble
wavyHeavy
comentários:
ExcelScript.ShapeLineDashStyle enum
Referência
Pacote: ExcelScript
O estilo de traço para uma linha.
Campos
dash
dashDot
dashDotDot
longDash
longDashDot
longDashDotDot
roundDot
solid
squareDot
systemDash
systemDashDot
systemDot
comentários:
ExcelScript.ShapeLineStyle enum
Referência
Pacote: ExcelScript
O estilo de uma linha.
Campos
single Linha única.
thickBetweenThin Linha grossa com uma linha fina de cada lado.
thickThin Linha grossa ao lado da linha fina. Para linhas horizontais, a linha grossa está
acima da linha fina. Para linhas verticais, a linha grossa é à esquerda da linha
fina.
thinThick Linha grossa ao lado da linha fina. Para linhas horizontais, a linha grossa está
abaixo da linha fina. Para linhas verticais, a linha grossa é à direita da linha
fina.
thinThin Duas linhas finas.
comentários:
ExcelScript.ShapeScaleFrom enum
Referência
Pacote: ExcelScript
Especifica qual parte da forma mantém sua posição quando a forma é dimensionada.
Campos
scaleFromBottomRight
scaleFromMiddle
scaleFromTopLeft
comentários:
ExcelScript.ShapeScaleType enum
Referência
Pacote: ExcelScript
Especifica se a forma é dimensionada em relação ao tamanho original ou atual.
Campos
currentSize
originalSize
comentários:
ExcelScript.ShapeTextHorizontal
Alignment enum
Referência
Pacote: ExcelScript
Especifica o alinhamento horizontal do quadro de texto em uma forma.
Campos
center
distributed
justify
justifyLow
left
right
thaiDistributed
comentários:
ExcelScript.ShapeTextHorizontal
Overflow enum
Referência
Pacote: ExcelScript
Especifica o estouro horizontal do quadro de texto em uma forma.
Campos
clip
overflow
comentários:
ExcelScript.ShapeTextOrientation enum
Referência
Pacote: ExcelScript
Especifica a orientação para o quadro de texto em uma forma.
Campos
eastAsianVertical
horizontal
mongolianVertical
vertical
vertical270
wordArtVertical
wordArtVerticalRTL
comentários:
ExcelScript.ShapeTextReadingOrder
enum
Referência
Pacote: ExcelScript
Especifica a ordem de leitura do quadro de texto em uma forma.
Campos
leftToRight
rightToLeft
comentários:
ExcelScript.ShapeTextVerticalAlignment
enum
Referência
Pacote: ExcelScript
Especifica o alinhamento vertical do quadro de texto em uma forma.
Campos
bottom
distributed
justified
middle
top
comentários:
ExcelScript.ShapeTextVerticalOverflow
enum
Referência
Pacote: ExcelScript
Especifica o estouro vertical do quadro de texto em uma forma.
Campos
clip Oculte texto que não se ajusta verticalmente no quadro de texto.
ellipsis Oculte texto que não se ajusta verticalmente no quadro de texto e adicione reticências
(...) ao final do texto visível.
overflow Permita que o texto exceda o quadro de texto verticalmente (pode ser partindo da
parte superior, inferior ou ambas, dependendo do alinhamento do texto).
comentários:
ExcelScript.ShapeType enum
Referência
Pacote: ExcelScript
Especifica o tipo de forma.
Campos
geometricShape
group
image
line
unsupported
comentários:
ExcelScript.ShapeZOrder enum
Referência
Pacote: ExcelScript
Especifica para que local da ordem z uma forma deve ser movida, em relação às outras
formas.
Campos
bringForward
bringToFront
sendBackward
sendToBack
ExcelScript.SheetVisibility enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script unhides all the worksheets in the workbook.
*/
// Iterate over each worksheet.
workbook.getWorksheets().forEach((worksheet) => {
// Set the worksheet visibility to visible.
worksheet.setVisibility(ExcelScript.SheetVisibility.visible);
});
}
Campos
hidden
veryHidden
visible
comentários:
ExcelScript.ShowAsCalculation enum
Referência
Pacote: ExcelScript
A função de cálculo ShowAs para o DataPivotField.
Campos
differenceFrom Diferença do campo Base especificado e do item Base.
index Calcula os valores da seguinte maneira: ((valor na célula) x (Total

total de grandes totais)) / ((Total da Grande Linha) x (Grand
Column Total))
none Nenhum cálculo é aplicado.
percentDifferenceFrom Diferença do campo Base especificado e do item Base.
percentOf Percentual do campo base especificado e do item Base.
percentOfColumnTotal Percentual do total de colunas.
percentOfGrandTotal Percentual do total.
percentOfParentColumnTotal Percentual do total de colunas para o campo Base especificado.
percentOfParentRowTotal Percentual do total da linha para o campo Base especificado.
percentOfParentTotal Percentual do total total para o campo Base especificado.
percentOfRowTotal Percentual do total da linha.
percentRunningTotal Percentual de execução total do campo Base especificado.
rankAscending Classificação crescente do campo Base especificado.
rankDecending Classificação decrescente do campo Base especificado.
runningTotal Executando o total do campo Base especificado.
unknown O cálculo é desconhecido ou sem suporte.

comentários:
ExcelScript.SlicerSortType enum
Referência
Pacote: ExcelScript
Especifica o comportamento de classificação de segmentação para Slicer.sortBy .
Campos
ascending Classificar itens de segmentação em ordem crescente por legendas de item.
dataSourceOrder Classificar itens de segmentação na ordem fornecida pela fonte de dados.
descending Classificar itens de segmentação em ordem decrescente por legendas de item.
comentários:
ExcelScript.SortBy enum
Referência
Pacote: ExcelScript
Representa a direção de classificação.
Campos
ascending Classificação crescente. Menor para maior ou de A a Z.
descending Classificação decrescente. Maior para menor ou Z para A.
comentários:
ExcelScript.SortDataOption enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script sorts a table based on the values in column 1.
* If the text of a column-1 value can be treated as a number,
* it will be sorted in numerical order, rather than Unicode order
* (so 123 will come before 12.3).
*/
// Create the sorting parameters.

const countSortField: ExcelScript.SortField = {
key: 1,
ascending: true,
dataOption: ExcelScript.SortDataOption.textAsNumber
};
// Apply the sort to the table.

const sort = table.getSort();
sort.apply([countSortField]);
}
Campos
normal
textAsNumber
comentários:
ExcelScript.SortMethod enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script sorts a range using the values in the first column.
*/
// Get the range (A1:D8) to sort from the current worksheet.
const worksheet = workbook.getActiveWorksheet();
const rangeToSort = worksheet.getRange("A1:D8");
// Create a SortField for text sorting.

let valueSort: ExcelScript.SortField = {
ascending: true,
key: 0, /* First column */
sortOn: ExcelScript.SortOn.value
};
// Apply the SortField to the range.

rangeToSort.getSort().apply(
[valueSort],
false, /* Don't let casing have an impact of sorting. */
true, /* The range has headers. */
ExcelScript.SortOrientation.rows,
ExcelScript.SortMethod.pinYin /* Use phonetic sorting for Chinese
characters. */
);
}
Campos
pinYin
strokeCount
comentários:
ExcelScript.SortOn enum
Referência
Pacote: ExcelScript
Representa a parte da célula usada como critério de classificação.
Comentários
Exemplos
TypeScript
/**
* This script sorts a range based on the color of the cells.
* It brings all red cells to the top of the range.
*/
// Create a SortField for color sorting.

// This sorts the rows based on the fill color of each row's cell in the
first column.
let colorSort: ExcelScript.SortField = {
ascending: true,
color: "FF0000", /* red */
key: 0,
sortOn: ExcelScript.SortOn.cellColor
};

rangeToSort.getSort().apply([colorSort]);
}
Campos
cellColor
fontColor
icon
value
comentários:
ExcelScript.SortOrientation enum
Referência
Pacote: ExcelScript
Campos
columns
rows
comentários:
ExcelScript.SpecialCellType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script finds and highlights all the cells in the current worksheet
that contain a formula.
*/
// Get the used range on the current sheet.
const usedRange = currentSheet.getUsedRange();
// Get the RangeAreas object for each cell with a formula.

const formulaCells =
usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);
// Add a light blue background to the cells containing formulas.

formulaCells.getFormat().getFill().setColor("#ADD8E6");
}
Campos
blanks Células sem conteúdo.
conditionalFormats Todas as células com formatos condicionais.
constants Células contendo constantes.
dataValidations Células com critérios de validação.
formulas Células contendo fórmulas.
sameConditionalFormat Células com o mesmo formato condicional que a primeira célula do

intervalo.
sameDataValidation Células com os mesmos critérios de validação de dados que a primeira
célula no intervalo.
visible Células visíveis.
comentários:
ExcelScript.SpecialCellValueType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script finds and bolds the text of cells containing strings (not
numbers or formulas).
*/
// Get the RangeAreas object for each cell with only text.
const textCells = usedRange.getSpecialCells(
ExcelScript.SpecialCellType.constants,
ExcelScript.SpecialCellValueType.text);
// Bold the text of those cells.

textCells.getFormat().getFont().setBold(true);
}
Campos
all Células que têm erros, valores boolianos, numéricos ou de cadeia de

caracteres.
errors Células que têm erros.
errorsLogical Células que têm erros ou valores boolianos.
errorsLogicalNumber Células que têm erros, valores boolianos ou numéricos.
errorsLogicalText Células que têm erros, boolianos ou valores de cadeia de caracteres.
errorsNumbers Células com erros ou valores numéricos.

errorsNumberText Células que têm erros, valores numéricos ou de cadeia de caracteres.
errorsText Células que têm erros ou valores de cadeia de caracteres.
logical Células que têm um valor booliano.
logicalNumbers Células que têm um valor booliano ou numérico.
logicalNumbersText Células que têm um valor booliano, numérico ou de cadeia de caracteres.
logicalText Células que têm um valor booliano ou de cadeia de caracteres.
numbers Células que têm um valor numérico.
numbersText Células que têm um valor numérico ou de cadeia de caracteres.
text Células que têm um valor de cadeia de caracteres.
comentários:
ExcelScript.SubtotalLocationType enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script displays group subtotals of the "Farms Sales" PivotTable.
*/

// Show all the subtotals at the bottom of each group.

layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
}
Campos
atBottom Os subtotais estão na parte inferior.
atTop Os subtotais estão na parte superior.
off Os subtotais estão desativados.
comentários:
ExcelScript.TopBottomSelectionType
enum
Referência
Pacote: ExcelScript
Um enumeração simples para filtros superior/inferior para selecionar se deseja filtrar

pela N superior ou n por cento inferior, número ou soma de valores.
Campos
items Filtre o número N superior/inferior dos itens medidos pelo valor escolhido.
percent Filtrar a porcentagem N superior/inferior dos itens, conforme medido pelo valor
escolhido.
sum Filtre a soma N superior/inferior, medida pelo valor escolhido.
ExcelScript.ValueFilterCondition enum
Referência
Pacote: ExcelScript
Enumerando todas as condições aceitas pelas quais um filtro de valor pode ser aplicado.
Usado para configurar o tipo de PivotFilter que é aplicado ao campo.
PivotFilter.exclusive pode ser definido para true inverter muitas dessas condições.
Comentários
Exemplos
TypeScript
/**
* This script applies a PivotValueFilter to the first row hierarchy in the
PivotTable.
*/
// Get the PivotTable on the current worksheet.
let sheet = workbook.getActiveWorksheet();
let pivotTable = sheet.getPivotTables()[0];
// Get the first row hierarchy to use as the field which gets filtered.
let rowHierarchy = pivotTable.getRowHierarchies()[0];
// Get the first data hierarchy to use as the values for filtering the
rows.
let dataHierarchy = pivotTable.getDataHierarchies()[0];
// Create a filter that excludes values greater than 500.

let filter: ExcelScript.PivotValueFilter = {
condition: ExcelScript.ValueFilterCondition.greaterThan,
comparator: 500,
value: dataHierarchy.getName()
};
// Apply the filter.

rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
valueFilter: filter
});
}
Campos
between Entre lowerBound critérios e upperBound .
Critérios necessários: { value , lowerBound , upperBound }. Critérios

opcionais: { exclusive }.
bottomN Na n inferior ( threshold ) [itens, percentual, soma] da categoria de valor.
Critérios necessários: { value , threshold , selectionType }.
Critérios necessários: { value , comparator }. Critérios opcionais:

{ exclusive }.
greaterThan Maior que o critério de comparador.
Critérios necessários: { value , comparator }.
greaterThanOrEqualTo Maior ou igual ao critério de comparador.
lessThan Critério inferior ao comparador.
lessThanOrEqualTo Menor ou igual a critério de comparador.
topN No N superior ( threshold ) [itens, percentual, soma] da categoria de

valor.
Critérios necessários: { value , threshold , selectionType }.
unknown ValueFilterCondition é desconhecido ou sem suporte.
ExcelScript.VerticalAlignment enum
Referência
Pacote: ExcelScript
Comentários
Exemplos
TypeScript
/**
* This script sets the vertical alignment formatting to "top"
* for every cell in the row.
*/
// Get row 1 for the current worksheet.
const firstRow = sheet.getRange("1:1");
// Set the vertical alignment formatting on the row.
firstRow.getFormat().setVerticalAlignment(ExcelScript.VerticalAlignment.top)
;
}
Campos
bottom
center
distributed
justify
top
ExcelScript.WorkbookLinksRefreshMode
enum
Referência
Pacote: ExcelScript
Representa o modo de atualização dos links da pasta de trabalho.
Comentários
Exemplos
TypeScript
/**
* This script refreshes all the links to external workbooks,
* if the linked workbook refresh mode is set to manual.
* To learn about linked workbooks, see
https://support.microsoft.com/office/create-an-external-reference-link-to-a-
cell-range-in-another-workbook-c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
*/
// Check the refresh mode.
if (workbook.getLinkedWorkbookRefreshMode() ===
ExcelScript.WorkbookLinksRefreshMode.manual) {
console.log("Refreshing workbook links");
// Trigger a refresh of linked workbook content.

workbook.refreshAllLinksToLinkedWorkbooks();
}
}
Campos
automatic Os links da pasta de trabalho são atualizados em um intervalo definido determinado

pelo aplicativo Excel.
manual Os links da pasta de trabalho são atualizados manualmente.

comentários:
ExcelScript.WorksheetPositionType
enum
Referência
Pacote: ExcelScript
A posição de uma planilha relativa a outra planilha ou a toda a coleção de planilhas.
Comentários
Exemplos
TypeScript
/**
* This script duplicates a worksheet named "Template".
* The new worksheet is added after the template.
*/
// 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()}`);
}
Campos
after
before
beginning
end
none
comentários:
ExcelScript.Application interface
Referência
Pacote: ExcelScript
Representa o aplicativo Excel que gerencia a pasta de trabalho.
Métodos
calculate(calculation Recalcula todas as pastas de trabalho abertas no Excel no momento.

Type)
getCalculationEngine Retorna a versão do mecanismo de cálculo do Excel usada para o último

Version() recálculo completo.
getCalculationMode() Retorna o modo de cálculo usado na pasta de trabalho, conforme

definido pelas constantes em ExcelScript.CalculationMode . Os valores
possíveis são: Automatic , em que o Excel controla o recálculo;
AutomaticExceptTables , em que o Excel controla o recálculo, mas ignora
as alterações nas tabelas; Manual , onde o cálculo é feito quando o
usuário solicita.
getCalculationState() Retorna o estado de cálculo do aplicativo. Confira

ExcelScript.CalculationState detalhes.
getCultureInfo() Fornece informações com base nas configurações atuais de cultura do

sistema. Isso inclui os nomes de cultura, a formatação de números e
outras configurações culturalmente dependentes.
getDecimalSeparator() Obtém a cadeia de caracteres usada como separador decimal para

valores numéricos. Isso se baseia nas configurações locais do Excel.
getIterative Retorna as configurações de cálculo iterativo. No Excel no Windows e no

Calculation() Mac, as configurações serão aplicadas ao Aplicativo Excel. Em Excel na
Web e em outras plataformas, as configurações serão aplicadas à pasta
de trabalho ativa.
getThousands Obtém a cadeia de caracteres usada para separar grupos de dígitos à

Separator() esquerda do decimal para valores numéricos. Isso se baseia nas
configurações locais do Excel.
getUseSystem Especifica se os separadores do sistema do Excel estão habilitados. Os

Separators() separadores do sistema incluem o separador decimal e milhares de
separadores.
setCalculation Retorna o modo de cálculo usado na pasta de trabalho, conforme
Mode(calculation definido pelas constantes em ExcelScript.CalculationMode . Os valores
Mode) possíveis são: Automatic , em que o Excel controla o recálculo;
AutomaticExceptTables , em que o Excel controla o recálculo, mas ignora
as alterações nas tabelas; Manual , onde o cálculo é feito quando o
usuário solicita.
Detalhes do método
calculate(calculationType)
Recalcula todas as pastas de trabalho abertas no Excel no momento.
TypeScript
calculate(calculationType: CalculationType): void;
Parâmetros
calculationType ExcelScript.CalculationType
Especifica o tipo de cálculo a usar. Confira ExcelScript.CalculationType detalhes.
Retornos
void
Exemplos
TypeScript
/**
* This script fully recalculates the entire workbook.
* This code is useful when automatic recalculation is turned off
* but later parts of the script rely on updated values.
*/
function main(workbook: ExcelScript.Workbook, workbookURL: string) {
const application = workbook.getApplication();
application.calculate(ExcelScript.CalculationType.fullRebuild);
}
getCalculationEngineVersion()
Retorna a versão do mecanismo de cálculo do Excel usada para o último recálculo
completo.
TypeScript
getCalculationEngineVersion(): number;
Retornos
number
getCalculationMode()
Retorna o modo de cálculo usado na pasta de trabalho, conforme definido pelas
constantes em ExcelScript.CalculationMode . Os valores possíveis são: Automatic ,
em que o Excel controla o recálculo; AutomaticExceptTables , em que o Excel controla
o recálculo, mas ignora as alterações nas tabelas; Manual , onde o cálculo é feito
quando o usuário solicita.
TypeScript
getCalculationMode(): CalculationMode;
Retornos
ExcelScript.CalculationMode
getCalculationState()
Retorna o estado de cálculo do aplicativo. Confira ExcelScript.CalculationState
detalhes.
TypeScript
getCalculationState(): CalculationState;
Retornos
ExcelScript.CalculationState
Exemplos
TypeScript
/**
* This script uses the fill color of the first cell to indicate the
current
* calculation state of the workbook.
*/
// Get the first cell in the first worksheet.
const cell = workbook.getWorksheets()[0].getCell(0,0);
// Get that cell's fill object.

const cellFill = cell.getFormat().getFill();
// Set the cell fill based on the calculation state.

const calcState = workbook.getApplication().getCalculationState();
switch (calcState) {
case ExcelScript.CalculationState.pending:
cellFill.setColor("Red");
break;
case ExcelScript.CalculationState.calculating:
cellFill.setColor("Yellow");
break;
case ExcelScript.CalculationState.done:
cellFill.setColor("Green");
break;
}
}
getCultureInfo()
Fornece informações com base nas configurações atuais de cultura do sistema. Isso
inclui os nomes de cultura, a formatação de números e outras configurações
culturalmente dependentes.
TypeScript
getCultureInfo(): CultureInfo;
Retornos
ExcelScript.CultureInfo
getDecimalSeparator()
Obtém a cadeia de caracteres usada como separador decimal para valores
numéricos. Isso se baseia nas configurações locais do Excel.
TypeScript
getDecimalSeparator(): string;
Retornos
string
getIterativeCalculation()
Retorna as configurações de cálculo iterativo. No Excel no Windows e no Mac, as
configurações serão aplicadas ao Aplicativo Excel. Em Excel na Web e em outras
plataformas, as configurações serão aplicadas à pasta de trabalho ativa.
TypeScript
getIterativeCalculation(): IterativeCalculation;
Retornos
ExcelScript.IterativeCalculation
getThousandsSeparator()
Obtém a cadeia de caracteres usada para separar grupos de dígitos à esquerda do
decimal para valores numéricos. Isso se baseia nas configurações locais do Excel.
TypeScript
getThousandsSeparator(): string;
Retornos
string
getUseSystemSeparators()
Especifica se os separadores do sistema do Excel estão habilitados. Os separadores
do sistema incluem o separador decimal e milhares de separadores.
TypeScript
getUseSystemSeparators(): boolean;
Retornos
boolean
setCalculationMode(calculationMode)
Retorna o modo de cálculo usado na pasta de trabalho, conforme definido pelas
constantes em ExcelScript.CalculationMode . Os valores possíveis são: Automatic ,
em que o Excel controla o recálculo; AutomaticExceptTables , em que o Excel controla
o recálculo, mas ignora as alterações nas tabelas; Manual , onde o cálculo é feito
quando o usuário solicita.
TypeScript
setCalculationMode(calculationMode: CalculationMode): void;
Parâmetros
calculationMode ExcelScript.CalculationMode
Retornos
void
comentários:
ExcelScript.AutoFilter interface
Referência
Pacote: ExcelScript
Representa o AutoFilter objeto. O AutoFilter transforma os valores na coluna do Excel

em filtros específicos com base no conteúdo da célula.
Comentários
Exemplos
TypeScript
/**
* 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 C
in the lowest 10 values
* (of column C values).
*/
const dataRange = currentSheet.getUsedRange();
const autoFilter = currentSheet.getAutoFilter();
// Add a filter that will only show the rows with the lowest 10 values in
column C
// (index 2, assuming the used range spans from at least A:C).
autoFilter.apply(dataRange, 2, {
criterion1: "10",
filterOn: ExcelScript.FilterOn.bottomItems
});
}
Métodos
apply(range, column Aplica o AutoFiltro a um intervalo. Isso filtra a coluna se o índice de

Index, criteria) coluna e os critérios de filtro forem especificados.
clearColumn Limpa os critérios de filtro de coluna do AutoFilter.

Criteria(columnIndex)
clearCriteria() Limpa os critérios de filtro e o estado de classificação do AutoFilter.
getCriteria() Uma matriz que contém todos os critérios de filtro no intervalo de

autofiltro.
getEnabled() Especifica se o AutoFilter está habilitado.
getIsDataFiltered() Especifica se o AutoFilter tem critérios de filtro.
getRange() Retorna o Range objeto que representa o intervalo ao qual o AutoFilter

se aplica. Se não houver nenhum Range objeto associado ao AutoFilter,
esse método retornará undefined .
reapply() Aplica o objeto AutoFilter especificado atualmente no intervalo.
remove() Remove o Filtro automático do intervalo.
Detalhes do método
apply(range, columnIndex, criteria)

Aplica o AutoFiltro a um intervalo. Isso filtra a coluna se o índice de coluna e os
critérios de filtro forem especificados.
TypeScript
apply(
range: Range | string,
columnIndex?: number,
criteria?: FilterCriteria
): void;
Parâmetros
range ExcelScript.Range | string
O intervalo no qual o AutoFilter será aplicado.
columnIndex number
O índice de coluna baseado em zero ao qual o AutoFilter é aplicado.
criteria ExcelScript.FilterCriteria
Os critérios de filtro.
Retornos
void
Exemplos
TypeScript
/**
* This script applies a filter to a table so that
* only rows with values in column 1 that start with "L" are shown.
*/
const autoFilter = table.getAutoFilter();
// Filter to only include values that start with "L".

filterOn: ExcelScript.FilterOn.custom,
criterion1: "L*"
};
// Apply the filter to column 1 (zero-based).

autoFilter.apply(table.getRange(), 1, filterCriteria);
}
clearColumnCriteria(columnIndex)
Limpa os critérios de filtro de coluna do AutoFilter.
TypeScript
clearColumnCriteria(columnIndex: number): void;
Parâmetros
columnIndex number
O índice de coluna baseado em zero, que representa qual filtro de coluna precisa ser
limpo. Se o valor do índice não tiver suporte (por exemplo, se o valor for um número
negativo ou se o valor for maior que o número de colunas disponíveis no intervalo),
um InvalidArgument erro será gerado.
Retornos
void
clearCriteria()
Limpa os critérios de filtro e o estado de classificação do AutoFilter.
TypeScript
clearCriteria(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script clears any applied criteria from the worksheet's
autoFilter.
*/
// Clear all the criteria currently applied to the autoFilter.

currentSheet.getAutoFilter().clearCriteria();
}
getCriteria()
Uma matriz que contém todos os critérios de filtro no intervalo de autofiltro.
TypeScript
getCriteria(): FilterCriteria[];
Retornos
ExcelScript.FilterCriteria[]
getEnabled()
Especifica se o AutoFilter está habilitado.
TypeScript
getEnabled(): boolean;
Retornos
boolean
getIsDataFiltered()
Especifica se o AutoFilter tem critérios de filtro.
TypeScript
getIsDataFiltered(): boolean;
Retornos
boolean
getRange()
Retorna o Range objeto que representa o intervalo ao qual o AutoFilter se aplica. Se
não houver nenhum Range objeto associado ao AutoFilter, esse método retornará
undefined .
TypeScript
getRange(): Range;
Retornos
ExcelScript.Range
reapply()
Aplica o objeto AutoFilter especificado atualmente no intervalo.
TypeScript
reapply(): void;
Retornos
void
remove()
Remove o Filtro automático do intervalo.
TypeScript
remove(): void;
Retornos
void
comentários:
ExcelScript.BasicDataValidation interface
Referência
Pacote: ExcelScript
Representa os critérios básicos de validação de dados de tipo.
Comentários
Exemplos
TypeScript
/**
*/

formula1: "0",
};
};

entered.
showAlert: true,
};
}
Propriedades
formula1 Especifica o operando à direita quando a propriedade do operador é definida como

um operador binário como GreaterThan (o operando à esquerda é o valor que o
usuário tenta inserir na célula). Com os operadores ternários Between e NotBetween,
especifica o operando de limite inferior. Por exemplo, definir a fórmula 1 a 10 e o
operador como GreaterThan significa que os dados válidos para o intervalo devem ser
maiores que 10. Ao definir o valor, ele pode ser passado como um número, um objeto
de intervalo ou uma fórmula de cadeia de caracteres (em que a cadeia de caracteres é
um número stringizado, uma referência de célula como "=A1" ou uma fórmula como
"=MIN(A1, B1)"). Ao recuperar o valor, ele sempre será retornado como uma fórmula
de cadeia de caracteres, por exemplo: "=10", "=A1", "=SUM(A1:B5)", etc.
formula2 Com os operadores ternários Between e NotBetween, especifica o operando de limite

superior. Não é usado com os operadores binários, como GreaterThan. Ao definir o
valor, ele pode ser passado como um número, um objeto de intervalo ou uma fórmula
de cadeia de caracteres (em que a cadeia de caracteres é um número stringizado, uma
referência de célula como "=A1" ou uma fórmula como "=MIN(A1, B1)"). Ao recuperar
o valor, ele sempre será retornado como uma fórmula de cadeia de caracteres, por
exemplo: "=10", "=A1", "=SUM(A1:B5)", etc.
operator O operador a ser usado para validar os dados.
Detalhes da propriedade
formula1
Especifica o operando à direita quando a propriedade do operador é definida como
especifica o operando de limite inferior. Por exemplo, definir a fórmula 1 a 10 e o
operador como GreaterThan significa que os dados válidos para o intervalo devem
ser maiores que 10. Ao definir o valor, ele pode ser passado como um número, um
objeto de intervalo ou uma fórmula de cadeia de caracteres (em que a cadeia de
caracteres é um número stringizado, uma referência de célula como "=A1" ou uma
fórmula como "=MIN(A1, B1)"). Ao recuperar o valor, ele sempre será retornado
como uma fórmula de cadeia de caracteres, por exemplo: "=10", "=A1",
"=SUM(A1:B5)", etc.
TypeScript
formula1: string | number | Range;
Valor da propriedade
string | number | ExcelScript.Range
formula2
Com os operadores ternários Between e NotBetween, especifica o operando de
limite superior. Não é usado com os operadores binários, como GreaterThan. Ao
definir o valor, ele pode ser passado como um número, um objeto de intervalo ou
uma fórmula de cadeia de caracteres (em que a cadeia de caracteres é um número
stringizado, uma referência de célula como "=A1" ou uma fórmula como "=MIN(A1,
B1)"). Ao recuperar o valor, ele sempre será retornado como uma fórmula de cadeia
de caracteres, por exemplo: "=10", "=A1", "=SUM(A1:B5)", etc.
TypeScript
formula2?: string | number | Range;
string | number | ExcelScript.Range
operator
O operador a ser usado para validar os dados.
TypeScript
operator: DataValidationOperator;
ExcelScript.Binding interface
Referência
Pacote: ExcelScript
Representa uma associação do Office.js definida na pasta de trabalho.
Métodos
delete() Especifica a associação.
getId() Representa o identificador de associação.
get Retorna o intervalo representado pela associação. Gerará um erro se a associação

Range() não for do tipo correto.
getTable() Retorna a tabela representada pela associação. Gerará um erro se a associação não
for do tipo correto.
getText() Retorna o texto representado pela associação. Gerará um erro se a associação não
getType() Retorna o tipo da associação. Confira ExcelScript.BindingType detalhes.
Detalhes do método
delete()
Especifica a associação.
TypeScript
delete(): void;
Retornos
void
getId()
Representa o identificador de associação.
TypeScript
getId(): string;
Retornos
string
getRange()
Retorna o intervalo representado pela associação. Gerará um erro se a associação
não for do tipo correto.
TypeScript
getRange(): Range;
Retornos
ExcelScript.Range
getTable()
Retorna a tabela representada pela associação. Gerará um erro se a associação não
TypeScript
getTable(): Table;
Retornos
ExcelScript.Table
getText()
Retorna o texto representado pela associação. Gerará um erro se a associação não
TypeScript
getText(): string;
Retornos
string
getType()
Retorna o tipo da associação. Confira ExcelScript.BindingType detalhes.
TypeScript
getType(): BindingType;
Retornos
ExcelScript.BindingType
comentários:
ExcelScript.CellValueConditionalFormat
interface
Referência
Pacote: ExcelScript
Representa um formato condicional de valor celular.
Comentários
Exemplos
TypeScript
/**
font made italic.
*/

const cellValueConditionalFormatting :
ExcelScript.CellValueConditionalFormat
=
e).getCellValue();
and 75.
formula1: "50",
formula2: "75",
};

}
Métodos
get Retorna um objeto de formato, encapsulando a fonte de formatos condicionais,

Format() preenchimento, bordas e outras propriedades.
getRule() Especifica o objeto de regra nesse formato condicional.
set Especifica o objeto de regra nesse formato condicional.

Rule(rule)
Detalhes do método
getFormat()
Retorna um objeto de formato, encapsulando a fonte de formatos condicionais,
preenchimento, bordas e outras propriedades.
TypeScript
getFormat(): ConditionalRangeFormat;
Retornos
ExcelScript.ConditionalRangeFormat
getRule()
Especifica o objeto de regra nesse formato condicional.
TypeScript
getRule(): ConditionalCellValueRule;
Retornos
ExcelScript.ConditionalCellValueRule
setRule(rule)
Especifica o objeto de regra nesse formato condicional.
TypeScript
setRule(rule: ConditionalCellValueRule): void;
Parâmetros
rule ExcelScript.ConditionalCellValueRule
Retornos
void
comentários:
ExcelScript.Chart interface
Referência
Pacote: ExcelScript
Representa um objeto chart em uma pasta de trabalho.
Métodos
activate() Ativa o gráfico na interface do usuário do Excel.
addChartSeries(name, Adiciona uma nova série para o conjunto. A nova série adicionada não
index) fica visível até que valores, valores de eixo x ou tamanhos de bolha
para ela sejam definidos (dependendo do tipo de gráfico).
delete() Exclui o objeto de gráfico.
getAxes() Representa os eixos de um gráfico.
getCategoryLabelLevel() Especifica uma constante de enumeração de nível de rótulo de

categoria de gráfico, referindo-se ao nível dos rótulos de categoria de
origem.
getChartType() Especifica o tipo do gráfico. Confira ExcelScript.ChartType detalhes.
getDataLabels() Representa os rótulos de dados no gráfico.
getDataTable() Obtém a tabela de dados no gráfico. Se o gráfico não permitir uma

tabela de dados, esse método retornará undefined .
getDisplayBlanksAs() Especifica a forma como as células em branco são plotadas em um

gráfico.
getFormat() Encapsula as propriedades de formato da área do gráfico.
getHeight() Especifica a altura, em pontos, do objeto gráfico.
getId() Id exclusiva do gráfico.
getImage(width, height, Processa o gráfico como uma imagem codificada em base64,

fittingMode) dimensionando o gráfico para se ajustar às dimensões especificadas. A
proporção é preservada como parte do redimensionamento.
getLeft() A distância, em pontos, da esquerda do gráfico à origem da planilha.
getLegend() Representa a legenda do gráfico.

getName() Especifica o nome de um objeto gráfico.
getPivotOptions() Encapsula as opções para um gráfico dinâmico.
getPlotArea() Representa a área de plotagem para o gráfico.
getPlotBy() Especifica a forma como as colunas ou linhas são usadas como série de
dados no gráfico.
getPlotVisibleOnly() Verdadeiro se apenas as células visíveis forem plotadas. Falso se ambas

as células visíveis e ocultas forem plotadas..
getSeries() Representa uma única série ou uma coleção de séries no gráfico.
getSeriesNameLevel() Especifica uma constante de enumeração de nível de série de gráficos,

referindo-se ao nível dos nomes da série de origem.
getShowAllField Especifica se é necessário exibir todos os botões de campo em um

Buttons() Gráfico Dinâmico.
getShowDataLabels Especifica se deve mostrar os rótulos de dados quando o valor é maior

OverMaximum() que o valor máximo no eixo de valor. Se o eixo de valor se tornar
menor que o tamanho dos pontos de dados, você poderá usar essa
propriedade para definir se deve mostrar os rótulos de dados. Essa
propriedade se aplica somente a gráficos 2D.
getStyle() Especifica o estilo do gráfico para o gráfico.
getTitle() Representa o título do gráfico especificado, incluindo o respectivo

texto, a visibilidade, a posição e a formatação.
getTop() Especifica a distância, em pontos, da borda superior do objeto até a

parte superior da linha 1 (em uma planilha) ou a parte superior da área
do gráfico (em um gráfico).
getWidth() Especifica a largura, em pontos, do objeto gráfico.
getWorksheet() A planilha que contém o gráfico atual.
setCategoryLabel Especifica uma constante de enumeração de nível de rótulo de

Level(categoryLabel categoria de gráfico, referindo-se ao nível dos rótulos de categoria de
Level) origem.
setChartType(chartType) Especifica o tipo do gráfico. Confira ExcelScript.ChartType detalhes.
setData(sourceData, Redefine os dados de origem do gráfico.

seriesBy)
setDisplayBlanks Especifica a forma como as células em branco são plotadas em um

As(displayBlanksAs) gráfico.
setHeight(height) Especifica a altura, em pontos, do objeto gráfico.

setLeft(left) A distância, em pontos, da esquerda do gráfico à origem da planilha.
setName(name) Especifica o nome de um objeto gráfico.
setPlotBy(plotBy) Especifica a forma como as colunas ou linhas são usadas como série de
dados no gráfico.
setPlotVisibleOnly(plot Verdadeiro se apenas as células visíveis forem plotadas. Falso se ambas

VisibleOnly) as células visíveis e ocultas forem plotadas..
setPosition(startCell, Posiciona o gráfico em relação às células na planilha.

endCell)
setSeriesName Especifica uma constante de enumeração de nível de série de gráficos,

Level(seriesNameLevel) referindo-se ao nível dos nomes da série de origem.
setShowAllField Especifica se é necessário exibir todos os botões de campo em um

Buttons(showAllField Gráfico Dinâmico.
Buttons)
setShowDataLabelsOver Especifica se deve mostrar os rótulos de dados quando o valor é maior

Maximum(showData que o valor máximo no eixo de valor. Se o eixo de valor se tornar
LabelsOverMaximum) menor que o tamanho dos pontos de dados, você poderá usar essa
propriedade para definir se deve mostrar os rótulos de dados. Essa
propriedade se aplica somente a gráficos 2D.
setStyle(style) Especifica o estilo do gráfico para o gráfico.
setTop(top) Especifica a distância, em pontos, da borda superior do objeto até a

parte superior da linha 1 (em uma planilha) ou a parte superior da área
do gráfico (em um gráfico).
setWidth(width) Especifica a largura, em pontos, do objeto gráfico.
Detalhes do método
activate()
Ativa o gráfico na interface do usuário do Excel.
TypeScript
activate(): void;
Retornos
void
addChartSeries(name, index)
Adiciona uma nova série para o conjunto. A nova série adicionada não fica visível até
que valores, valores de eixo x ou tamanhos de bolha para ela sejam definidos
(dependendo do tipo de gráfico).
TypeScript
addChartSeries(name?: string, index?: number): ChartSeries;
Parâmetros
name string
Opcional. Nome da série.
index number
Opcional. Valor de índice da série a ser adicionada. Indexados com zero.
Retornos
ExcelScript.ChartSeries
Exemplos
TypeScript
/**
* This sample produces a line chart with two series.
* The chart assumes data in A1:E5 that looks like this:
* Product Qtr1 Qtr2 Qtr3 Qtr4
* Frames 5000 7000 6544 4377
* Saddles 400 323 276 651
*/
// Establish the ranges to use.
const headerRange = sheet.getRange("A1:E1");
const firstSeriesRange = sheet.getRange("A2:E2");
const secondSeriesRange = sheet.getRange("A3:E3");
// Create the chart.

const lineChart = sheet.addChart(ExcelScript.ChartType.line,
headerRange);
// Add the first chart series.

const firstSeries = lineChart.addChartSeries();
firstSeries.setXAxisValues(headerRange);
firstSeries.setValues(firstSeriesRange);
// Add the second chart series.

const secondSeries = lineChart.addChartSeries();
secondSeries.setXAxisValues(headerRange);
secondSeries.setValues(secondSeriesRange);
}
delete()
Exclui o objeto de gráfico.
TypeScript
delete(): void;
Retornos
void
getAxes()
Representa os eixos de um gráfico.
TypeScript
getAxes(): ChartAxes;
Retornos
ExcelScript.ChartAxes
getCategoryLabelLevel()
Especifica uma constante de enumeração de nível de rótulo de categoria de gráfico,
referindo-se ao nível dos rótulos de categoria de origem.
TypeScript
getCategoryLabelLevel(): number;
Retornos
number
getChartType()
Especifica o tipo do gráfico. Confira ExcelScript.ChartType detalhes.
TypeScript
getChartType(): ChartType;
Retornos
getDataLabels()
Representa os rótulos de dados no gráfico.
TypeScript
getDataLabels(): ChartDataLabels;
Retornos
ExcelScript.ChartDataLabels
getDataTable()
Obtém a tabela de dados no gráfico. Se o gráfico não permitir uma tabela de dados,
TypeScript
getDataTable(): ChartDataTable;
Retornos
ExcelScript.ChartDataTable
getDisplayBlanksAs()
Especifica a forma como as células em branco são plotadas em um gráfico.
TypeScript
getDisplayBlanksAs(): ChartDisplayBlanksAs;
Retornos
ExcelScript.ChartDisplayBlanksAs
getFormat()
Encapsula as propriedades de formato da área do gráfico.
TypeScript
getFormat(): ChartAreaFormat;
Retornos
ExcelScript.ChartAreaFormat
getHeight()
Especifica a altura, em pontos, do objeto gráfico.
TypeScript
getHeight(): number;
Retornos
number
getId()
Id exclusiva do gráfico.
TypeScript
getId(): string;
Retornos
string
getImage(width, height, fittingMode)

Processa o gráfico como uma imagem codificada em base64, dimensionando o
gráfico para se ajustar às dimensões especificadas. A proporção é preservada como
parte do redimensionamento.
TypeScript
getImage(
width?: number,
height?: number,
fittingMode?: ImageFittingMode
): string;
Parâmetros
width number
Opcional. A largura desejada da imagem resultante.
height number
Opcional. A altura desejada da imagem resultante.
fittingMode ExcelScript.ImageFittingMode
Opcional. O método usado para escalar o gráfico para as dimensões especificadas
(se a altura e a largura forem definidas).
Retornos
string
Exemplos
TypeScript
/**
* This script returns an image of the first chart in the first
worksheet.
* That image is 600x400 pixels and the chart will be
* stretched to fill those dimensions.
* The returned image can be used in a Power Automate flow.
*/
function main(workbook: ExcelScript.Workbook): string {
// Get the first chart in the first worksheet.
const firstSheet = workbook.getFirstWorksheet();
const firstChart = firstSheet.getCharts()[0];
// Get an image of the chart as a base64-encoded string.

const base64String = firstChart.getImage(
600, /* Width */
400, /* Height */
ExcelScript.ImageFittingMode.fill /* Fill to match the dimensions. */
);
return base64String;
}
getLeft()
A distância, em pontos, da esquerda do gráfico à origem da planilha.
TypeScript
getLeft(): number;
Retornos
number
getLegend()
Representa a legenda do gráfico.
TypeScript
getLegend(): ChartLegend;
Retornos
ExcelScript.ChartLegend
getName()
Especifica o nome de um objeto gráfico.
TypeScript
getName(): string;
Retornos
string
getPivotOptions()
Encapsula as opções para um gráfico dinâmico.
TypeScript
getPivotOptions(): ChartPivotOptions;
Retornos
ExcelScript.ChartPivotOptions
getPlotArea()
Representa a área de plotagem para o gráfico.
TypeScript
getPlotArea(): ChartPlotArea;
Retornos
ExcelScript.ChartPlotArea
getPlotBy()
Especifica a forma como as colunas ou linhas são usadas como série de dados no
gráfico.
TypeScript
getPlotBy(): ChartPlotBy;
Retornos
ExcelScript.ChartPlotBy
Exemplos
TypeScript
/**
*/

let columnClusteredChart =
selectedSheet.getChart("ColumnClusteredChart");
if (columnClusteredChart.getPlotBy() ===
ExcelScript.ChartPlotBy.columns) {
} else {
}
}
getPlotVisibleOnly()
Verdadeiro se apenas as células visíveis forem plotadas. Falso se ambas as células
visíveis e ocultas forem plotadas..
TypeScript
getPlotVisibleOnly(): boolean;
Retornos
boolean
getSeries()
Representa uma única série ou uma coleção de séries no gráfico.
TypeScript
getSeries(): ChartSeries[];
Retornos
ExcelScript.ChartSeries[]
Exemplos
TypeScript
/**
* This sample sets the overlap of the columns in a chart named
*/

let chart = selectedSheet.getChart("ColumnClusteredChart");
// Set the overlap of every column of each series within a category.

let seriesList = chart.getSeries();
seriesList.forEach((series) => {
// An overlap of 25 means the columns have 25% of their length
overlapping with the adjacent columns in the same category.
series.setOverlap(25);
});
}
getSeriesNameLevel()
Especifica uma constante de enumeração de nível de série de gráficos, referindo-se
ao nível dos nomes da série de origem.
TypeScript
getSeriesNameLevel(): number;
Retornos
number
getShowAllFieldButtons()
Especifica se é necessário exibir todos os botões de campo em um Gráfico Dinâmico.
TypeScript
getShowAllFieldButtons(): boolean;
Retornos
boolean
getShowDataLabelsOverMaximum()
Especifica se deve mostrar os rótulos de dados quando o valor é maior que o valor
máximo no eixo de valor. Se o eixo de valor se tornar menor que o tamanho dos
pontos de dados, você poderá usar essa propriedade para definir se deve mostrar os
rótulos de dados. Essa propriedade se aplica somente a gráficos 2D.
TypeScript
getShowDataLabelsOverMaximum(): boolean;
Retornos
boolean
getStyle()
Especifica o estilo do gráfico para o gráfico.
TypeScript
getStyle(): number;
Retornos
number
getTitle()
Representa o título do gráfico especificado, incluindo o respectivo texto, a
visibilidade, a posição e a formatação.
TypeScript
getTitle(): ChartTitle;
Retornos
ExcelScript.ChartTitle
getTop()
Especifica a distância, em pontos, da borda superior do objeto até a parte superior
da linha 1 (em uma planilha) ou a parte superior da área do gráfico (em um gráfico).
TypeScript
getTop(): number;
Retornos
number
getWidth()
Especifica a largura, em pontos, do objeto gráfico.
TypeScript
getWidth(): number;
Retornos
number
getWorksheet()
A planilha que contém o gráfico atual.
TypeScript
getWorksheet(): Worksheet;
Retornos
ExcelScript.Worksheet
setCategoryLabelLevel(categoryLabelLevel)
Especifica uma constante de enumeração de nível de rótulo de categoria de gráfico,
referindo-se ao nível dos rótulos de categoria de origem.
TypeScript
setCategoryLabelLevel(categoryLabelLevel: number): void;
Parâmetros
categoryLabelLevel number
Retornos
void
setChartType(chartType)
Especifica o tipo do gráfico. Confira ExcelScript.ChartType detalhes.
TypeScript
setChartType(chartType: ChartType): void;
Parâmetros
chartType ExcelScript.ChartType
Retornos
void
setData(sourceData, seriesBy)
Redefine os dados de origem do gráfico.
TypeScript
setData(sourceData: Range, seriesBy?: ChartSeriesBy): void;
Parâmetros
sourceData ExcelScript.Range
O objeto range correspondente aos dados de origem.
seriesBy ExcelScript.ChartSeriesBy
gráfico. Pode ser um dos seguintes: Auto (padrão), Linhas e Colunas. Confira
ExcelScript.ChartSeriesBy detalhes.
Retornos
void
setDisplayBlanksAs(displayBlanksAs)
Especifica a forma como as células em branco são plotadas em um gráfico.
TypeScript
setDisplayBlanksAs(displayBlanksAs: ChartDisplayBlanksAs): void;
Parâmetros
displayBlanksAs ExcelScript.ChartDisplayBlanksAs
Retornos
void
setHeight(height)
Especifica a altura, em pontos, do objeto gráfico.
TypeScript
setHeight(height: number): void;
Parâmetros
height number
Retornos
void
setLeft(left)
A distância, em pontos, da esquerda do gráfico à origem da planilha.
TypeScript
setLeft(left: number): void;
Parâmetros
left number
Retornos
void
setName(name)
Especifica o nome de um objeto gráfico.
TypeScript
setName(name: string): void;
Parâmetros
name string
Retornos
void
Exemplos
TypeScript
/**
worksheet's data.
*/


let chart =
selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);

}
setPlotBy(plotBy)
gráfico.
TypeScript
setPlotBy(plotBy: ChartPlotBy): void;
Parâmetros
plotBy ExcelScript.ChartPlotBy
Retornos
void
Exemplos
TypeScript
/**
*/

let columnClusteredChart =
selectedSheet.getChart("ColumnClusteredChart");
if (columnClusteredChart.getPlotBy() ===
ExcelScript.ChartPlotBy.columns) {
} else {
}
}
setPlotVisibleOnly(plotVisibleOnly)
Verdadeiro se apenas as células visíveis forem plotadas. Falso se ambas as células
visíveis e ocultas forem plotadas..
TypeScript
setPlotVisibleOnly(plotVisibleOnly: boolean): void;
Parâmetros
plotVisibleOnly boolean
Retornos
void
setPosition(startCell, endCell)
Posiciona o gráfico em relação às células na planilha.
TypeScript
setPosition(startCell: Range | string, endCell?: Range | string): void;
Parâmetros
startCell ExcelScript.Range | string
A célula inicial. Esse é o local para o qual o gráfico será movido. A célula inicial é a
célula superior esquerda ou direita, dependendo das configurações de exibição do
usuário, da esquerda para a direita.
endCell ExcelScript.Range | string

Opcional. A célula final. Quando é especificada, a altura e a largura do gráfico são
definidas para cobrirem totalmente essa célula ou intervalo.
Retornos
void
Exemplos
TypeScript
/**
* This sample moves an existing chart to a specific place on the
worksheet.
*/
// Get an existing chart named "ColumnChart".

let chart = selectedSheet.getChart("ColumnChart");
// Place the chart over the range "F1:L13".

chart.setPosition("F1", "L13");
}
setSeriesNameLevel(seriesNameLevel)
Especifica uma constante de enumeração de nível de série de gráficos, referindo-se
ao nível dos nomes da série de origem.
TypeScript
setSeriesNameLevel(seriesNameLevel: number): void;
Parâmetros
seriesNameLevel number
Retornos
void
setShowAllFieldButtons(showAllFieldButtons)
Especifica se é necessário exibir todos os botões de campo em um Gráfico Dinâmico.
TypeScript
setShowAllFieldButtons(showAllFieldButtons: boolean): void;
Parâmetros
showAllFieldButtons boolean
Retornos
void
setShowDataLabelsOverMaximum(showDataLabelsOver
Maximum)
Especifica se deve mostrar os rótulos de dados quando o valor é maior que o valor
máximo no eixo de valor. Se o eixo de valor se tornar menor que o tamanho dos
pontos de dados, você poderá usar essa propriedade para definir se deve mostrar os
rótulos de dados. Essa propriedade se aplica somente a gráficos 2D.
TypeScript
setShowDataLabelsOverMaximum(showDataLabelsOverMaximum: boolean): void;
Parâmetros
showDataLabelsOverMaximum boolean
Retornos
void
setStyle(style)
Especifica o estilo do gráfico para o gráfico.
TypeScript
setStyle(style: number): void;
Parâmetros
style number
Retornos
void
setTop(top)
Especifica a distância, em pontos, da borda superior do objeto até a parte superior
da linha 1 (em uma planilha) ou a parte superior da área do gráfico (em um gráfico).
TypeScript
setTop(top: number): void;
Parâmetros
top number
Retornos
void
setWidth(width)
Especifica a largura, em pontos, do objeto gráfico.
TypeScript
setWidth(width: number): void;
Parâmetros
width number
Retornos
void
comentários:
ExcelScript.ChartAreaFormat interface
Referência
Pacote: ExcelScript
Encapsula as propriedades de formato da área de gráfico geral.
Métodos
getBorder() Representa o formato de borda da área do gráfico, que inclui cor,

estilo de linha e peso.
getColorScheme() Especifica o esquema de cores do gráfico.
getFill() Representa o formato de preenchimento de um objeto, que inclui

informações sobre a formatação da tela de fundo.
getFont() Representa os atributos de fonte do objeto atual, como nome,

tamanho, cor, dentre outros.
getRoundedCorners() Especifica se a área do gráfico do gráfico tem cantos arredondados.
setColorScheme(color Especifica o esquema de cores do gráfico.

Scheme)
setRounded Especifica se a área do gráfico do gráfico tem cantos arredondados.

Corners(roundedCorners)
Detalhes do método
getBorder()
Representa o formato de borda da área do gráfico, que inclui cor, estilo de linha e
peso.
TypeScript
getBorder(): ChartBorder;
Retornos
ExcelScript.ChartBorder
getColorScheme()
Especifica o esquema de cores do gráfico.
TypeScript
getColorScheme(): ChartColorScheme;
Retornos
ExcelScript.ChartColorScheme
getFill()
Representa o formato de preenchimento de um objeto, que inclui informações sobre
a formatação da tela de fundo.
TypeScript
getFill(): ChartFill;
Retornos
ExcelScript.ChartFill
getFont()
Representa os atributos de fonte do objeto atual, como nome, tamanho, cor, dentre
outros.
TypeScript
getFont(): ChartFont;
Retornos
ExcelScript.ChartFont
getRoundedCorners()
Especifica se a área do gráfico do gráfico tem cantos arredondados.
TypeScript
getRoundedCorners(): boolean;
Retornos
boolean
setColorScheme(colorScheme)
Especifica o esquema de cores do gráfico.
TypeScript
setColorScheme(colorScheme: ChartColorScheme): void;
Parâmetros
colorScheme ExcelScript.ChartColorScheme
Retornos
void
setRoundedCorners(roundedCorners)
Especifica se a área do gráfico do gráfico tem cantos arredondados.
TypeScript
setRoundedCorners(roundedCorners: boolean): void;
Parâmetros
roundedCorners boolean
Retornos
void
comentários:
ExcelScript.ChartAxes interface
Referência
Pacote: ExcelScript
Representa os eixos de um gráfico.
Métodos
getCategoryAxis() Representa o eixo de categoria em um gráfico.
getChartAxis(type, group) Retorna o eixo específico identificado por tipo e grupo.
getSeriesAxis() Representa o eixo da série de um gráfico 3D.
getValueAxis() Representa o eixo dos valores em um eixo.
Detalhes do método
getCategoryAxis()
Representa o eixo de categoria em um gráfico.
TypeScript
getCategoryAxis(): ChartAxis;
Retornos
ExcelScript.ChartAxis
getChartAxis(type, group)
Retorna o eixo específico identificado por tipo e grupo.
TypeScript
getChartAxis(type: ChartAxisType, group?: ChartAxisGroup): ChartAxis;

Parâmetros
type ExcelScript.ChartAxisType
Especifica o tipo de eixo. Confira ExcelScript.ChartAxisType detalhes.
group ExcelScript.ChartAxisGroup
Opcional. Especifica o grupo de eixos. Confira ExcelScript.ChartAxisGroup detalhes.
Retornos
getSeriesAxis()
Representa o eixo da série de um gráfico 3D.
TypeScript
getSeriesAxis(): ChartAxis;
Retornos
getValueAxis()
Representa o eixo dos valores em um eixo.
TypeScript
getValueAxis(): ChartAxis;
Retornos
ExcelScript.ChartAxis interface
Referência
Pacote: ExcelScript
Representa um único eixo em um gráfico.
Métodos
getAlignment() Especifica o alinhamento para o rótulo de tique de eixo especificado.

Confira ExcelScript.ChartTextHorizontalAlignment detalhes.
getAxisGroup() Especifica o grupo para o eixo especificado. Confira

ExcelScript.ChartAxisGroup detalhes.
getBaseTimeUnit() Especifica a unidade base do eixo de categoria especificado.
getCategoryType() Especifica o tipo de eixo de categoria.
getCustomDisplayUnit() Especifica o valor da unidade de exibição de eixo personalizado. Para

definir essa propriedade, use o SetCustomDisplayUnit(double)
método.
getDisplayUnit() Representa a unidade de exibição de eixo. Confira

ExcelScript.ChartAxisDisplayUnit detalhes.
getFormat() Representa a formatação de um objeto Chart, que inclui formatação

de linha e de fonte.
getHeight() Especifica a altura, em pontos, do eixo do gráfico. Retorna null se o

eixo não estiver visível.
getIsBetweenCategories() Especifica se o eixo de valor cruza o eixo de categoria entre

categorias.
getLeft() Especifica a distância, em pontos, da borda esquerda do eixo à

esquerda da área do gráfico. Retorna null se o eixo não estiver
visível.
getLinkNumberFormat() Especifica se o formato de número está vinculado às células. Se

true , o formato de número será alterado nos rótulos quando ele for
alterado nas células.
getLogBase() Especifica a base do logaritmo ao usar dimensionamentos

logarítmicos.
getMajorGridlines() Retorna um objeto que representa as principais linhas de grade para
o eixo especificado.
getMajorTickMark() Especifica o tipo de marca de tique principal para o eixo

especificado. Confira ExcelScript.ChartAxisTickMark detalhes.
getMajorTimeUnitScale() Especifica o valor de escala de unidade principal para o eixo de

categoria quando a categoryType propriedade é definida como
dateAxis .
getMajorUnit() Especifica o intervalo entre duas marcas principais de tique.
getMaximum() Especifica o valor máximo no eixo de valor.
getMinimum() Especifica o valor mínimo no eixo de valor.
getMinorGridlines() Retorna um objeto que representa as linhas de grade secundárias

para o eixo especificado.
getMinorTickMark() Especifica o tipo de marca de tique menor para o eixo especificado.

Confira ExcelScript.ChartAxisTickMark detalhes.
getMinorTimeUnitScale() Especifica o valor de escala de unidade menor para o eixo de

categoria quando a categoryType propriedade é definida como
dateAxis .
getMinorUnit() Especifica o intervalo entre duas marcas de tiques menores.
getMultiLevel() Especifica se um eixo é multinível.
getNumberFormat() Especifica o código de formato para o rótulo de tique de eixo.
getOffset() Especifica a distância entre os níveis de rótulos e a distância entre o

primeiro nível e a linha de eixo. O valor deve ser um inteiro de 0 a
1000.
getPosition() Especifica a posição de eixo especificada em que o outro eixo se

cruza. Confira ExcelScript.ChartAxisPosition detalhes.
getPositionAt() Especifica a posição do eixo em que o outro eixo se cruza. Você deve
usar o SetPositionAt(double) método para definir essa propriedade.
getReversePlotOrder() Especifica se o Excel plota pontos de dados de último para primeiro.
getScaleType() Especifica o tipo de escala do eixo de valor. Confira

ExcelScript.ChartAxisScaleType detalhes.
getShowDisplayUnit Especifica se o rótulo da unidade de exibição do eixo está visível.

Label()
getTextOrientation() Especifica o ângulo para o qual o texto é orientado para o rótulo de

tique do eixo do gráfico. O valor deve ser um inteiro de -90 a 90 ou
o inteiro 180 para texto orientado verticalmente.
getTickLabelPosition() Especifica a posição dos rótulos de marcas de escala no eixo

especificado. Confira ExcelScript.ChartAxisTickLabelPosition
detalhes.
getTickLabelSpacing() Especifica o número de categorias ou séries entre rótulos de marca

de tique-taque. Pode ter um valor de 1 a 31999.
getTickMarkSpacing() Especifica o número de categorias ou séries entre marcas de tique.
getTitle() Representa o título do eixo.
getTop() Especifica a distância, em pontos, da borda superior do eixo até a

parte superior da área do gráfico. Retorna null se o eixo não estiver
visível.
getType() Especifica o tipo de eixo. Confira ExcelScript.ChartAxisType

detalhes.
getVisible() Especifica se o eixo está visível.
getWidth() Especifica a largura, em pontos, do eixo do gráfico. Retorna null se

o eixo não estiver visível.
setAlignment(alignment) Especifica o alinhamento para o rótulo de tique de eixo especificado.

Confira ExcelScript.ChartTextHorizontalAlignment detalhes.
setBaseTimeUnit(base Especifica a unidade base do eixo de categoria especificado.

TimeUnit)
setCategoryNames(source Define todos os nomes de categoria para o eixo especificado.

Data)
setCategoryType(category Especifica o tipo de eixo de categoria.

Type)
setCustomDisplay Definirá a unidade de exibição de eixo a um valor personalizado.

Unit(value)
setDisplayUnit(display Representa a unidade de exibição de eixo. Confira

Unit) ExcelScript.ChartAxisDisplayUnit detalhes.
setIsBetweenCategories(is Especifica se o eixo de valor cruza o eixo de categoria entre

BetweenCategories) categorias.
setLinkNumberFormat(link Especifica se o formato de número está vinculado às células. Se

NumberFormat) true , o formato de número será alterado nos rótulos quando ele for
setLogBase(logBase) Especifica a base do logaritmo ao usar dimensionamentos

logarítmicos.
setMajorTickMark(major Especifica o tipo de marca de tique principal para o eixo
TickMark) especificado. Confira ExcelScript.ChartAxisTickMark detalhes.
setMajorTimeUnit Especifica o valor de escala de unidade principal para o eixo de

Scale(majorTimeUnitScale) categoria quando a categoryType propriedade é definida como
dateAxis .
setMajorUnit(majorUnit) Especifica o intervalo entre duas marcas principais de tique.
setMaximum(maximum) Especifica o valor máximo no eixo de valor.
setMinimum(minimum) Especifica o valor mínimo no eixo de valor.
setMinorTickMark(minor Especifica o tipo de marca de tique menor para o eixo especificado.

TickMark) Confira ExcelScript.ChartAxisTickMark detalhes.
setMinorTimeUnit Especifica o valor de escala de unidade menor para o eixo de

Scale(minorTimeUnitScale) categoria quando a categoryType propriedade é definida como
dateAxis .
setMinorUnit(minorUnit) Especifica o intervalo entre duas marcas de tiques menores.
setMultiLevel(multiLevel) Especifica se um eixo é multinível.
setNumber Especifica o código de formato para o rótulo de tique de eixo.

Format(numberFormat)
setOffset(offset) Especifica a distância entre os níveis de rótulos e a distância entre o

primeiro nível e a linha de eixo. O valor deve ser um inteiro de 0 a
1000.
setPosition(position) Especifica a posição de eixo especificada em que o outro eixo se

cruza. Confira ExcelScript.ChartAxisPosition detalhes.
setPositionAt(value) Define a posição de eixo especificada em que o outro eixo se cruza.
setReversePlot Especifica se o Excel plota pontos de dados de último para primeiro.

Order(reversePlotOrder)
setScaleType(scaleType) Especifica o tipo de escala do eixo de valor. Confira

ExcelScript.ChartAxisScaleType detalhes.
setShowDisplayUnit Especifica se o rótulo da unidade de exibição do eixo está visível.

Label(showDisplayUnit
Label)
setTextOrientation(text Especifica o ângulo para o qual o texto é orientado para o rótulo de

Orientation) tique do eixo do gráfico. O valor deve ser um inteiro de -90 a 90 ou
o inteiro 180 para texto orientado verticalmente.
setTickLabelPosition(tick Especifica a posição dos rótulos de marcas de escala no eixo

LabelPosition) especificado. Confira ExcelScript.ChartAxisTickLabelPosition
detalhes.
setTickLabelSpacing(tick Especifica o número de categorias ou séries entre rótulos de marca

LabelSpacing) de tique-taque. Pode ter um valor de 1 a 31999.
setTickMarkSpacing(tick Especifica o número de categorias ou séries entre marcas de tique.

MarkSpacing)
setVisible(visible) Especifica se o eixo está visível.
Detalhes do método
getAlignment()
Especifica o alinhamento para o rótulo de tique de eixo especificado. Confira
ExcelScript.ChartTextHorizontalAlignment detalhes.
TypeScript
getAlignment(): ChartTickLabelAlignment;
Retornos
getAxisGroup()
Especifica o grupo para o eixo especificado. Confira ExcelScript.ChartAxisGroup
detalhes.
TypeScript
getAxisGroup(): ChartAxisGroup;
Retornos
getBaseTimeUnit()
Especifica a unidade base do eixo de categoria especificado.
TypeScript
getBaseTimeUnit(): ChartAxisTimeUnit;
Retornos
ExcelScript.ChartAxisTimeUnit
getCategoryType()
Especifica o tipo de eixo de categoria.
TypeScript
getCategoryType(): ChartAxisCategoryType;
Retornos
ExcelScript.ChartAxisCategoryType
getCustomDisplayUnit()
Especifica o valor da unidade de exibição de eixo personalizado. Para definir essa
propriedade, use o SetCustomDisplayUnit(double) método.
TypeScript
getCustomDisplayUnit(): number;
Retornos
number
getDisplayUnit()
Representa a unidade de exibição de eixo. Confira
TypeScript
getDisplayUnit(): ChartAxisDisplayUnit;
Retornos
ExcelScript.ChartAxisDisplayUnit
getFormat()
Representa a formatação de um objeto Chart, que inclui formatação de linha e de
fonte.
TypeScript
getFormat(): ChartAxisFormat;
Retornos
ExcelScript.ChartAxisFormat
getHeight()
Especifica a altura, em pontos, do eixo do gráfico. Retorna null se o eixo não estiver
visível.
TypeScript
Retornos
number
getIsBetweenCategories()
Especifica se o eixo de valor cruza o eixo de categoria entre categorias.
TypeScript
getIsBetweenCategories(): boolean;
Retornos
boolean
getLeft()
Especifica a distância, em pontos, da borda esquerda do eixo à esquerda da área do
gráfico. Retorna null se o eixo não estiver visível.
TypeScript
getLeft(): number;
Retornos
number
getLinkNumberFormat()
Especifica se o formato de número está vinculado às células. Se true , o formato de
número será alterado nos rótulos quando ele for alterado nas células.
TypeScript
getLinkNumberFormat(): boolean;
Retornos
boolean
getLogBase()
Especifica a base do logaritmo ao usar dimensionamentos logarítmicos.
TypeScript
getLogBase(): number;
Retornos
number
getMajorGridlines()
Retorna um objeto que representa as principais linhas de grade para o eixo
especificado.
TypeScript
getMajorGridlines(): ChartGridlines;
Retornos
ExcelScript.ChartGridlines
getMajorTickMark()
Especifica o tipo de marca de tique principal para o eixo especificado. Confira
ExcelScript.ChartAxisTickMark detalhes.
TypeScript
getMajorTickMark(): ChartAxisTickMark;
Retornos
getMajorTimeUnitScale()
Especifica o valor de escala de unidade principal para o eixo de categoria quando a
categoryType propriedade é definida como dateAxis .
TypeScript
getMajorTimeUnitScale(): ChartAxisTimeUnit;
Retornos
getMajorUnit()
Especifica o intervalo entre duas marcas principais de tique.
TypeScript
getMajorUnit(): number;
Retornos
number
getMaximum()
Especifica o valor máximo no eixo de valor.
TypeScript
getMaximum(): number;
Retornos
number
getMinimum()
Especifica o valor mínimo no eixo de valor.
TypeScript
getMinimum(): number;
Retornos
number
getMinorGridlines()
Retorna um objeto que representa as linhas de grade secundárias para o eixo
especificado.
TypeScript
getMinorGridlines(): ChartGridlines;
Retornos
ExcelScript.ChartGridlines
getMinorTickMark()
Especifica o tipo de marca de tique menor para o eixo especificado. Confira
TypeScript
getMinorTickMark(): ChartAxisTickMark;
Retornos
getMinorTimeUnitScale()
Especifica o valor de escala de unidade menor para o eixo de categoria quando a
TypeScript
getMinorTimeUnitScale(): ChartAxisTimeUnit;
Retornos
getMinorUnit()
Especifica o intervalo entre duas marcas de tiques menores.
TypeScript
getMinorUnit(): number;
Retornos
number
getMultiLevel()
Especifica se um eixo é multinível.
TypeScript
getMultiLevel(): boolean;
Retornos
boolean
getNumberFormat()
Especifica o código de formato para o rótulo de tique de eixo.
TypeScript
getNumberFormat(): string;
Retornos
string
getOffset()
Especifica a distância entre os níveis de rótulos e a distância entre o primeiro nível e
a linha de eixo. O valor deve ser um inteiro de 0 a 1000.
TypeScript
getOffset(): number;
Retornos
number
getPosition()
Especifica a posição de eixo especificada em que o outro eixo se cruza. Confira
ExcelScript.ChartAxisPosition detalhes.
TypeScript
getPosition(): ChartAxisPosition;
Retornos
ExcelScript.ChartAxisPosition
getPositionAt()
Especifica a posição do eixo em que o outro eixo se cruza. Você deve usar o
SetPositionAt(double) método para definir essa propriedade.
TypeScript
getPositionAt(): number;
Retornos
number
getReversePlotOrder()
Especifica se o Excel plota pontos de dados de último para primeiro.
TypeScript
getReversePlotOrder(): boolean;
Retornos
boolean
getScaleType()
Especifica o tipo de escala do eixo de valor. Confira ExcelScript.ChartAxisScaleType
detalhes.
TypeScript
getScaleType(): ChartAxisScaleType;
Retornos
ExcelScript.ChartAxisScaleType
getShowDisplayUnitLabel()
Especifica se o rótulo da unidade de exibição do eixo está visível.
TypeScript
getShowDisplayUnitLabel(): boolean;
Retornos
boolean
getTextOrientation()
Especifica o ângulo para o qual o texto é orientado para o rótulo de tique do eixo do
gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado
verticalmente.
TypeScript
getTextOrientation(): number;
Retornos
number
getTickLabelPosition()
Especifica a posição dos rótulos de marcas de escala no eixo especificado. Confira
ExcelScript.ChartAxisTickLabelPosition detalhes.
TypeScript
getTickLabelPosition(): ChartAxisTickLabelPosition;
Retornos
getTickLabelSpacing()
Especifica o número de categorias ou séries entre rótulos de marca de tique-taque.
Pode ter um valor de 1 a 31999.
TypeScript
getTickLabelSpacing(): number;
Retornos
number
getTickMarkSpacing()
Especifica o número de categorias ou séries entre marcas de tique.
TypeScript
getTickMarkSpacing(): number;
Retornos
number
getTitle()
Representa o título do eixo.
TypeScript
getTitle(): ChartAxisTitle;
Retornos
ExcelScript.ChartAxisTitle
getTop()
Especifica a distância, em pontos, da borda superior do eixo até a parte superior da
área do gráfico. Retorna null se o eixo não estiver visível.
TypeScript
getTop(): number;
Retornos
number
getType()
Especifica o tipo de eixo. Confira ExcelScript.ChartAxisType detalhes.
TypeScript
getType(): ChartAxisType;
Retornos
ExcelScript.ChartAxisType
getVisible()
Especifica se o eixo está visível.
TypeScript
getVisible(): boolean;
Retornos
boolean
getWidth()
Especifica a largura, em pontos, do eixo do gráfico. Retorna null se o eixo não
estiver visível.
TypeScript
getWidth(): number;
Retornos
number
setAlignment(alignment)
Especifica o alinhamento para o rótulo de tique de eixo especificado. Confira
ExcelScript.ChartTextHorizontalAlignment detalhes.
TypeScript
setAlignment(alignment: ChartTickLabelAlignment): void;
Parâmetros
alignment ExcelScript.ChartTickLabelAlignment
Retornos
void
setBaseTimeUnit(baseTimeUnit)
Especifica a unidade base do eixo de categoria especificado.
TypeScript
setBaseTimeUnit(baseTimeUnit: ChartAxisTimeUnit): void;
Parâmetros
baseTimeUnit ExcelScript.ChartAxisTimeUnit
Retornos
void
setCategoryNames(sourceData)
Define todos os nomes de categoria para o eixo especificado.
TypeScript
setCategoryNames(sourceData: Range): void;
Parâmetros
O Range objeto correspondente aos dados de origem.
Retornos
void
setCategoryType(categoryType)
Especifica o tipo de eixo de categoria.
TypeScript
setCategoryType(categoryType: ChartAxisCategoryType): void;
Parâmetros
categoryType ExcelScript.ChartAxisCategoryType
Retornos
void
setCustomDisplayUnit(value)
Definirá a unidade de exibição de eixo a um valor personalizado.
TypeScript
setCustomDisplayUnit(value: number): void;
Parâmetros
value number
Valor personalizado da unidade de exibição.
Retornos
void
setDisplayUnit(displayUnit)
Representa a unidade de exibição de eixo. Confira
TypeScript
setDisplayUnit(displayUnit: ChartAxisDisplayUnit): void;
Parâmetros
displayUnit ExcelScript.ChartAxisDisplayUnit
Retornos
void
setIsBetweenCategories(isBetweenCategories)
Especifica se o eixo de valor cruza o eixo de categoria entre categorias.
TypeScript
setIsBetweenCategories(isBetweenCategories: boolean): void;
Parâmetros
isBetweenCategories boolean
Retornos
void
setLinkNumberFormat(linkNumberFormat)
TypeScript
setLinkNumberFormat(linkNumberFormat: boolean): void;
Parâmetros
linkNumberFormat boolean
Retornos
void
setLogBase(logBase)
Especifica a base do logaritmo ao usar dimensionamentos logarítmicos.
TypeScript
setLogBase(logBase: number): void;
Parâmetros
logBase number
Retornos
void
setMajorTickMark(majorTickMark)
Especifica o tipo de marca de tique principal para o eixo especificado. Confira
TypeScript
setMajorTickMark(majorTickMark: ChartAxisTickMark): void;
Parâmetros
majorTickMark ExcelScript.ChartAxisTickMark
Retornos
void
setMajorTimeUnitScale(majorTimeUnitScale)
Especifica o valor de escala de unidade principal para o eixo de categoria quando a
TypeScript
setMajorTimeUnitScale(majorTimeUnitScale: ChartAxisTimeUnit): void;
Parâmetros
majorTimeUnitScale ExcelScript.ChartAxisTimeUnit
Retornos
void
setMajorUnit(majorUnit)
Especifica o intervalo entre duas marcas principais de tique.
TypeScript
setMajorUnit(majorUnit: number): void;
Parâmetros
majorUnit number
Retornos
void
setMaximum(maximum)
Especifica o valor máximo no eixo de valor.
TypeScript
setMaximum(maximum: number): void;
Parâmetros
maximum number
Retornos
void
setMinimum(minimum)
Especifica o valor mínimo no eixo de valor.
TypeScript
setMinimum(minimum: number): void;
Parâmetros
minimum number
Retornos
void
setMinorTickMark(minorTickMark)
Especifica o tipo de marca de tique menor para o eixo especificado. Confira
TypeScript
setMinorTickMark(minorTickMark: ChartAxisTickMark): void;
Parâmetros
minorTickMark ExcelScript.ChartAxisTickMark
Retornos
void
setMinorTimeUnitScale(minorTimeUnitScale)
Especifica o valor de escala de unidade menor para o eixo de categoria quando a
TypeScript
setMinorTimeUnitScale(minorTimeUnitScale: ChartAxisTimeUnit): void;
Parâmetros
minorTimeUnitScale ExcelScript.ChartAxisTimeUnit
Retornos
void
setMinorUnit(minorUnit)
Especifica o intervalo entre duas marcas de tiques menores.
TypeScript
setMinorUnit(minorUnit: number): void;
Parâmetros
minorUnit number
Retornos
void
setMultiLevel(multiLevel)
Especifica se um eixo é multinível.
TypeScript
setMultiLevel(multiLevel: boolean): void;
Parâmetros
multiLevel boolean
Retornos
void
setNumberFormat(numberFormat)
Especifica o código de formato para o rótulo de tique de eixo.
TypeScript
setNumberFormat(numberFormat: string): void;
Parâmetros
numberFormat string
Retornos
void
setOffset(offset)
Especifica a distância entre os níveis de rótulos e a distância entre o primeiro nível e
a linha de eixo. O valor deve ser um inteiro de 0 a 1000.
TypeScript
setOffset(offset: number): void;
Parâmetros
offset number
Retornos
void
setPosition(position)
Especifica a posição de eixo especificada em que o outro eixo se cruza. Confira
ExcelScript.ChartAxisPosition detalhes.
TypeScript
setPosition(position: ChartAxisPosition): void;
Parâmetros
position ExcelScript.ChartAxisPosition
Retornos
void
setPositionAt(value)
Define a posição de eixo especificada em que o outro eixo se cruza.
TypeScript
setPositionAt(value: number): void;
Parâmetros
value number
Valor personalizado do ponto de cruzamento.
Retornos
void
setReversePlotOrder(reversePlotOrder)
Especifica se o Excel plota pontos de dados de último para primeiro.
TypeScript
setReversePlotOrder(reversePlotOrder: boolean): void;
Parâmetros
reversePlotOrder boolean
Retornos
void
setScaleType(scaleType)
Especifica o tipo de escala do eixo de valor. Confira ExcelScript.ChartAxisScaleType
detalhes.
TypeScript
setScaleType(scaleType: ChartAxisScaleType): void;
Parâmetros
scaleType ExcelScript.ChartAxisScaleType
Retornos
void
setShowDisplayUnitLabel(showDisplayUnitLabel)
Especifica se o rótulo da unidade de exibição do eixo está visível.
TypeScript
setShowDisplayUnitLabel(showDisplayUnitLabel: boolean): void;
Parâmetros
showDisplayUnitLabel boolean
Retornos
void
setTextOrientation(textOrientation)
Especifica o ângulo para o qual o texto é orientado para o rótulo de tique do eixo do
verticalmente.
TypeScript
setTextOrientation(textOrientation: number): void;
Parâmetros
textOrientation number
Retornos
void
setTickLabelPosition(tickLabelPosition)
Especifica a posição dos rótulos de marcas de escala no eixo especificado. Confira
ExcelScript.ChartAxisTickLabelPosition detalhes.
TypeScript
setTickLabelPosition(
tickLabelPosition: ChartAxisTickLabelPosition
): void;
Parâmetros
tickLabelPosition ExcelScript.ChartAxisTickLabelPosition
Retornos
void
setTickLabelSpacing(tickLabelSpacing)
Especifica o número de categorias ou séries entre rótulos de marca de tique-taque.
Pode ter um valor de 1 a 31999.
TypeScript
setTickLabelSpacing(tickLabelSpacing: number): void;
Parâmetros
tickLabelSpacing number
Retornos
void
setTickMarkSpacing(tickMarkSpacing)
Especifica o número de categorias ou séries entre marcas de tique.
TypeScript
setTickMarkSpacing(tickMarkSpacing: number): void;
Parâmetros
tickMarkSpacing number
Retornos
void
setVisible(visible)
Especifica se o eixo está visível.
TypeScript
setVisible(visible: boolean): void;
Parâmetros
visible boolean
Retornos
void
comentários:
ExcelScript.ChartAxisFormat interface
Referência
Pacote: ExcelScript
Encapsula as propriedades de formato do eixo do gráfico.
Métodos
getFill() Especifica a formatação de preenchimento do gráfico.
get Especifica os atributos de fonte (nome da fonte, tamanho da fonte, cor etc.) para um
Font() elemento do eixo do gráfico.
get Especifica a formatação de linha de gráfico.

Line()
Detalhes do método
getFill()
Especifica a formatação de preenchimento do gráfico.
TypeScript
Retornos
getFont()
Especifica os atributos de fonte (nome da fonte, tamanho da fonte, cor etc.) para um
elemento do eixo do gráfico.
TypeScript
Retornos
getLine()
Especifica a formatação de linha de gráfico.
TypeScript
getLine(): ChartLineFormat;
Retornos
ExcelScript.ChartLineFormat
ExcelScript.ChartAxisTitle interface
Referência
Pacote: ExcelScript
Representa o título de um eixo do gráfico.
Métodos
getFormat() Especifica a formatação do título do eixo do gráfico.
getText() Especifica o título do eixo.
getTextOrientation() Especifica o ângulo para o qual o texto é orientado para o título do eixo
do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180
para texto orientado verticalmente.
getVisible() Especifica se o título do eixo está visível.
setFormula(formula) Um valor de cadeia de caracteres que representa a fórmula do título do

eixo do gráfico usando a notação no estilo A1.
setText(text) Especifica o título do eixo.
setTextOrientation(text Especifica o ângulo para o qual o texto é orientado para o título do eixo
Orientation) do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180
para texto orientado verticalmente.
setVisible(visible) Especifica se o título do eixo está visível.
Detalhes do método
getFormat()
Especifica a formatação do título do eixo do gráfico.
TypeScript
getFormat(): ChartAxisTitleFormat;
Retornos
ExcelScript.ChartAxisTitleFormat
getText()
Especifica o título do eixo.
TypeScript
getText(): string;
Retornos
string
Especifica o ângulo para o qual o texto é orientado para o título do eixo do gráfico.
O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado
verticalmente.
TypeScript
Retornos
number
getVisible()
Especifica se o título do eixo está visível.
TypeScript
Retornos
boolean
setFormula(formula)
Um valor de cadeia de caracteres que representa a fórmula do título do eixo do
gráfico usando a notação no estilo A1.
TypeScript
setFormula(formula: string): void;
Parâmetros
formula string
Uma cadeia de caracteres que representa a fórmula a ser definida.
Retornos
void
setText(text)
Especifica o título do eixo.
TypeScript
setText(text: string): void;
Parâmetros
text string
Retornos
void
Especifica o ângulo para o qual o texto é orientado para o título do eixo do gráfico.
O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado
verticalmente.
TypeScript

Parâmetros
Retornos
void
setVisible(visible)
Especifica se o título do eixo está visível.
TypeScript
Parâmetros
visible boolean
Retornos
void
comentários:
ExcelScript.ChartAxisTitleFormat
interface
Referência
Pacote: ExcelScript
Representa a formatação do título do eixo do gráfico.
Métodos
get Especifica o formato de borda do título do eixo do gráfico, que inclui cor, estilo de
Border() linha e peso.
getFill() Especifica a formatação de preenchimento do título do eixo do gráfico.
getFont() Especifica os atributos de fonte do título do eixo do gráfico, como nome da fonte,
tamanho da fonte ou cor do objeto título do eixo do gráfico.
Detalhes do método
getBorder()
Especifica o formato de borda do título do eixo do gráfico, que inclui cor, estilo de
linha e peso.
TypeScript
Retornos
getFill()
Especifica a formatação de preenchimento do título do eixo do gráfico.
TypeScript
Retornos
getFont()
Especifica os atributos de fonte do título do eixo do gráfico, como nome da fonte,
tamanho da fonte ou cor do objeto título do eixo do gráfico.
TypeScript
Retornos
comentários:
ExcelScript.ChartBinOptions interface
Referência
Pacote: ExcelScript
Encapsula as opções de bin para gráficos de histograma e gráficos de pareto.
Métodos
getAllowOverflow() Especifica se o estouro da lixeira está habilitado em um gráfico de

histograma ou gráfico de pareto.
getAllowUnderflow() Especifica se o fluxo de entrada da lixeira está habilitado em um

gráfico de histograma ou gráfico de pareto.
getCount() Especifica a contagem de bin de um gráfico de histograma ou

gráfico de pareto.
getOverflowValue() Especifica o valor de estouro da lixeira de um gráfico de histograma

ou gráfico de pareto.
getType() Especifica o tipo da lixeira para um gráfico de histograma ou

gráfico de pareto.
getUnderflowValue() Especifica o valor do fluxo de subfluxo da lixeira de um gráfico de

getWidth() Especifica o valor da largura da lixeira de um gráfico de histograma

setAllowOverflow(allow Especifica se o estouro da lixeira está habilitado em um gráfico de

Overflow) histograma ou gráfico de pareto.
setAllowUnderflow(allow Especifica se o fluxo de entrada da lixeira está habilitado em um

Underflow) gráfico de histograma ou gráfico de pareto.
setCount(count) Especifica a contagem de bin de um gráfico de histograma ou

gráfico de pareto.
setOverflowValue(overflow Especifica o valor de estouro da lixeira de um gráfico de histograma

Value) ou gráfico de pareto.
setType(type) Especifica o tipo da lixeira para um gráfico de histograma ou

gráfico de pareto.
setUnderflow Especifica o valor do fluxo de subfluxo da lixeira de um gráfico de
Value(underflowValue) histograma ou gráfico de pareto.
setWidth(width) Especifica o valor da largura da lixeira de um gráfico de histograma

Detalhes do método
getAllowOverflow()
Especifica se o estouro da lixeira está habilitado em um gráfico de histograma ou
gráfico de pareto.
TypeScript
getAllowOverflow(): boolean;
Retornos
boolean
getAllowUnderflow()
Especifica se o fluxo de entrada da lixeira está habilitado em um gráfico de
TypeScript
getAllowUnderflow(): boolean;
Retornos
boolean
getCount()
Especifica a contagem de bin de um gráfico de histograma ou gráfico de pareto.
TypeScript
getCount(): number;
Retornos
number
getOverflowValue()
Especifica o valor de estouro da lixeira de um gráfico de histograma ou gráfico de
pareto.
TypeScript
getOverflowValue(): number;
Retornos
number
getType()
Especifica o tipo da lixeira para um gráfico de histograma ou gráfico de pareto.
TypeScript
getType(): ChartBinType;
Retornos
ExcelScript.ChartBinType
getUnderflowValue()
Especifica o valor do fluxo de subfluxo da lixeira de um gráfico de histograma ou
gráfico de pareto.
TypeScript
getUnderflowValue(): number;
Retornos
number
getWidth()
Especifica o valor da largura da lixeira de um gráfico de histograma ou gráfico de
pareto.
TypeScript
getWidth(): number;
Retornos
number
setAllowOverflow(allowOverflow)
Especifica se o estouro da lixeira está habilitado em um gráfico de histograma ou
gráfico de pareto.
TypeScript
setAllowOverflow(allowOverflow: boolean): void;
Parâmetros
allowOverflow boolean
Retornos
void
setAllowUnderflow(allowUnderflow)
Especifica se o fluxo de entrada da lixeira está habilitado em um gráfico de
TypeScript
setAllowUnderflow(allowUnderflow: boolean): void;

Parâmetros
allowUnderflow boolean
Retornos
void
setCount(count)
Especifica a contagem de bin de um gráfico de histograma ou gráfico de pareto.
TypeScript
setCount(count: number): void;
Parâmetros
count number
Retornos
void
setOverflowValue(overflowValue)
Especifica o valor de estouro da lixeira de um gráfico de histograma ou gráfico de
pareto.
TypeScript
setOverflowValue(overflowValue: number): void;
Parâmetros
overflowValue number
Retornos
void
setType(type)
Especifica o tipo da lixeira para um gráfico de histograma ou gráfico de pareto.
TypeScript
setType(type: ChartBinType): void;
Parâmetros
type ExcelScript.ChartBinType
Retornos
void
setUnderflowValue(underflowValue)
Especifica o valor do fluxo de subfluxo da lixeira de um gráfico de histograma ou
gráfico de pareto.
TypeScript
setUnderflowValue(underflowValue: number): void;
Parâmetros
underflowValue number
Retornos
void
setWidth(width)
Especifica o valor da largura da lixeira de um gráfico de histograma ou gráfico de
pareto.
TypeScript
Parâmetros
width number
Retornos
void
comentários:
ExcelScript.ChartBorder interface
Referência
Pacote: ExcelScript
Representa a formatação de borda de um elemento gráfico.
Métodos
clear() Limpa a formatação da borda de um elemento do gráfico.
getColor() Código de cor HTML que representa a cor das bordas no gráfico.
getLineStyle() Representa o estilo de linha da borda. Confira ExcelScript.ChartLineStyle

detalhes.
getWeight() Representa a espessura da borda, em pontos.
setColor(color) Código de cor HTML que representa a cor das bordas no gráfico.
setLineStyle(line Representa o estilo de linha da borda. Confira ExcelScript.ChartLineStyle

Style) detalhes.
setWeight(weight) Representa a espessura da borda, em pontos.
Detalhes do método
clear()
Limpa a formatação da borda de um elemento do gráfico.
TypeScript
clear(): void;
Retornos
void
getColor()
Código de cor HTML que representa a cor das bordas no gráfico.
TypeScript
getColor(): string;
Retornos
string
getLineStyle()
Representa o estilo de linha da borda. Confira ExcelScript.ChartLineStyle detalhes.
TypeScript
getLineStyle(): ChartLineStyle;
Retornos
getWeight()
Representa a espessura da borda, em pontos.
TypeScript
getWeight(): number;
Retornos
number
setColor(color)
Código de cor HTML que representa a cor das bordas no gráfico.
TypeScript
setColor(color: string): void;

Parâmetros
color string
Retornos
void
setLineStyle(lineStyle)
Representa o estilo de linha da borda. Confira ExcelScript.ChartLineStyle detalhes.
TypeScript
setLineStyle(lineStyle: ChartLineStyle): void;
Parâmetros
lineStyle ExcelScript.ChartLineStyle
Retornos
void
setWeight(weight)
Representa a espessura da borda, em pontos.
TypeScript
setWeight(weight: number): void;
Parâmetros
weight number
Retornos
void
comentários:
ExcelScript.ChartBoxwhiskerOptions
interface
Referência
Pacote: ExcelScript
Representa as propriedades de uma caixa e um gráfico de bigode.
Métodos
getQuartileCalculation() Especifica se o tipo de cálculo do quartil de um gráfico de

caixa e de bigode.
getShowInnerPoints() Especifica se os pontos internos são mostrados em uma caixa

e no gráfico de batedores.
getShowMeanLine() Especifica se a linha média é mostrada em um gráfico de

caixa e de bigode.
getShowMeanMarker() Especifica se o marcador médio é mostrado em um gráfico

de caixa e de bigode.
getShowOutlierPoints() Especifica se os pontos outlier são mostrados em um gráfico

de caixa e de bigode.
setQuartileCalculation(quartile Especifica se o tipo de cálculo do quartil de um gráfico de

Calculation) caixa e de bigode.
setShowInnerPoints(showInner Especifica se os pontos internos são mostrados em uma caixa

Points) e no gráfico de batedores.
setShowMeanLine(showMean Especifica se a linha média é mostrada em um gráfico de

Line) caixa e de bigode.
setShowMeanMarker(showMean Especifica se o marcador médio é mostrado em um gráfico

Marker) de caixa e de bigode.
setShowOutlierPoints(showOutlier Especifica se os pontos outlier são mostrados em um gráfico

Points) de caixa e de bigode.
Detalhes do método
getQuartileCalculation()
Especifica se o tipo de cálculo do quartil de um gráfico de caixa e de bigode.
TypeScript
getQuartileCalculation(): ChartBoxQuartileCalculation;
Retornos
ExcelScript.ChartBoxQuartileCalculation
getShowInnerPoints()
Especifica se os pontos internos são mostrados em uma caixa e no gráfico de
batedores.
TypeScript
getShowInnerPoints(): boolean;
Retornos
boolean
getShowMeanLine()
Especifica se a linha média é mostrada em um gráfico de caixa e de bigode.
TypeScript
getShowMeanLine(): boolean;
Retornos
boolean
getShowMeanMarker()
Especifica se o marcador médio é mostrado em um gráfico de caixa e de bigode.
TypeScript
getShowMeanMarker(): boolean;
Retornos
boolean
getShowOutlierPoints()
Especifica se os pontos outlier são mostrados em um gráfico de caixa e de bigode.
TypeScript
getShowOutlierPoints(): boolean;
Retornos
boolean
setQuartileCalculation(quartileCalculation)
Especifica se o tipo de cálculo do quartil de um gráfico de caixa e de bigode.
TypeScript
setQuartileCalculation(
quartileCalculation: ChartBoxQuartileCalculation
): void;
Parâmetros
quartileCalculation ExcelScript.ChartBoxQuartileCalculation
Retornos
void
setShowInnerPoints(showInnerPoints)
Especifica se os pontos internos são mostrados em uma caixa e no gráfico de
batedores.
TypeScript
setShowInnerPoints(showInnerPoints: boolean): void;
Parâmetros
showInnerPoints boolean
Retornos
void
setShowMeanLine(showMeanLine)
Especifica se a linha média é mostrada em um gráfico de caixa e de bigode.
TypeScript
setShowMeanLine(showMeanLine: boolean): void;
Parâmetros
showMeanLine boolean
Retornos
void
setShowMeanMarker(showMeanMarker)
Especifica se o marcador médio é mostrado em um gráfico de caixa e de bigode.
TypeScript
setShowMeanMarker(showMeanMarker: boolean): void;
Parâmetros
showMeanMarker boolean
Retornos
void
setShowOutlierPoints(showOutlierPoints)
Especifica se os pontos outlier são mostrados em um gráfico de caixa e de bigode.
TypeScript
setShowOutlierPoints(showOutlierPoints: boolean): void;
Parâmetros
showOutlierPoints boolean
Retornos
void
comentários:
ExcelScript.ChartDataLabel interface
Referência
Pacote: ExcelScript
Representa o rótulo de dados de um ponto de gráfico.
Métodos
getAutoText() Especifica se o rótulo de dados gera automaticamente o texto

apropriado com base no contexto.
getFormat() Representa o formato do rótulo de dados do gráfico.
getFormula() Valor de cadeia de caracteres que representa a fórmula do título do

rótulo de dados usando a notação no estilo A1.
getHeight() Retorna a altura, em pontos, do rótulo de dados do gráfico. O valor

será null se o rótulo de dados do gráfico não estiver visível.
getHorizontal Representa o alinhamento horizontal de rótulo de dados do gráfico.

Alignment() Confira ExcelScript.ChartTextHorizontalAlignment detalhes. Essa
propriedade é válida somente quando TextOrientation o rótulo de
dados é -90, 90 ou 180.
getLeft() Representa a distância, em pontos, da borda esquerda do rótulo de

dados do gráfico até a borda esquerda da área do gráfico. O valor será
null se o rótulo de dados do gráfico não estiver visível.
getLinkNumberFormat() Especifica se o formato de número está vinculado às células (para que

o formato de número seja alterado nos rótulos quando ele for
alterado nas células).
getNumberFormat() Valor de cadeia de caracteres que representa o código do formato do

rótulo de dados.
getPosition() Valor que representa a posição do rótulo de dados. Confira

ExcelScript.ChartDataLabelPosition detalhes.
getSeparator() Cadeia de caracteres que representa o separador usado para o rótulo

de dados em um gráfico.
getShowBubbleSize() Especifica se o tamanho da bolha do rótulo de dados está visível.
getShowCategory Especifica se o nome da categoria do rótulo de dados está visível.

Name()
getShowLegendKey() Especifica se a chave de legenda do rótulo de dados está visível.
getShowPercentage() Especifica se o percentual do rótulo de dados está visível.
getShowSeriesName() Especifica se o nome da série de rótulos de dados está visível.
getShowValue() Especifica se o valor do rótulo de dados está visível.
getText() Cadeia de caracteres que representa o texto do rótulo de dados em

um gráfico.
getTextOrientation() Representa o ângulo para o qual o texto é orientado para o rótulo de

dados do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro
180 para texto orientado verticalmente.
getTop() Representa a distância, em pontos, da borda superior do rótulo de

dados do gráfico até a borda superior da área do gráfico. O valor será
getVerticalAlignment() Representa o alinhamento vertical do rótulo de dados do gráfico.

Confira ExcelScript.ChartTextVerticalAlignment detalhes. Essa
propriedade é válida somente quando TextOrientation o rótulo de
dados é 0.
getWidth() Retorna a largura, em pontos, do rótulo de dados do gráfico. O valor

será null se o rótulo de dados do gráfico não estiver visível.
setAutoText(autoText) Especifica se o rótulo de dados gera automaticamente o texto

setFormula(formula) Valor de cadeia de caracteres que representa a fórmula do título do

rótulo de dados usando a notação no estilo A1.
setHorizontal Representa o alinhamento horizontal de rótulo de dados do gráfico.

Alignment(horizontal Confira ExcelScript.ChartTextHorizontalAlignment detalhes. Essa
Alignment) propriedade é válida somente quando TextOrientation o rótulo de
dados é -90, 90 ou 180.
setLeft(left) Representa a distância, em pontos, da borda esquerda do rótulo de

dados do gráfico até a borda esquerda da área do gráfico. O valor será
setLinkNumber Especifica se o formato de número está vinculado às células (para que

Format(linkNumber o formato de número seja alterado nos rótulos quando ele for
Format) alterado nas células).
setNumber Valor de cadeia de caracteres que representa o código do formato do

Format(numberFormat) rótulo de dados.
setPosition(position) Valor que representa a posição do rótulo de dados. Confira

setSeparator(separator) Cadeia de caracteres que representa o separador usado para o rótulo
de dados em um gráfico.
setShowBubble Especifica se o tamanho da bolha do rótulo de dados está visível.

Size(showBubbleSize)
setShowCategory Especifica se o nome da categoria do rótulo de dados está visível.

Name(showCategory
Name)
setShowLegend Especifica se a chave de legenda do rótulo de dados está visível.

Key(showLegendKey)
setShow Especifica se o percentual do rótulo de dados está visível.

Percentage(show
Percentage)
setShowSeries Especifica se o nome da série de rótulos de dados está visível.

Name(showSeriesName)
setShowValue(show Especifica se o valor do rótulo de dados está visível.

Value)
setText(text) Cadeia de caracteres que representa o texto do rótulo de dados em

um gráfico.
setTextOrientation(text Representa o ângulo para o qual o texto é orientado para o rótulo de

Orientation) dados do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro
180 para texto orientado verticalmente.
setTop(top) Representa a distância, em pontos, da borda superior do rótulo de

dados do gráfico até a borda superior da área do gráfico. O valor será
setVertical Representa o alinhamento vertical do rótulo de dados do gráfico.

Alignment(vertical Confira ExcelScript.ChartTextVerticalAlignment detalhes. Essa
Alignment) propriedade é válida somente quando TextOrientation o rótulo de
dados é 0.
Detalhes do método
getAutoText()
Especifica se o rótulo de dados gera automaticamente o texto apropriado com base
no contexto.
TypeScript
getAutoText(): boolean;
Retornos
boolean
getFormat()
Representa o formato do rótulo de dados do gráfico.
TypeScript
getFormat(): ChartDataLabelFormat;
Retornos
ExcelScript.ChartDataLabelFormat
getFormula()
Valor de cadeia de caracteres que representa a fórmula do título do rótulo de dados
usando a notação no estilo A1.
TypeScript
getFormula(): string;
Retornos
string
getHeight()
Retorna a altura, em pontos, do rótulo de dados do gráfico. O valor será null se o
rótulo de dados do gráfico não estiver visível.
TypeScript
Retornos
number
getHorizontalAlignment()
Representa o alinhamento horizontal de rótulo de dados do gráfico. Confira
ExcelScript.ChartTextHorizontalAlignment detalhes. Essa propriedade é válida
somente quando TextOrientation o rótulo de dados é -90, 90 ou 180.
TypeScript
getHorizontalAlignment(): ChartTextHorizontalAlignment;
Retornos
ExcelScript.ChartTextHorizontalAlignment
getLeft()
Representa a distância, em pontos, da borda esquerda do rótulo de dados do gráfico
até a borda esquerda da área do gráfico. O valor será null se o rótulo de dados do
gráfico não estiver visível.
TypeScript
getLeft(): number;
Retornos
number
Especifica se o formato de número está vinculado às células (para que o formato de
número seja alterado nos rótulos quando ele for alterado nas células).
TypeScript
Retornos
boolean
getNumberFormat()
Valor de cadeia de caracteres que representa o código do formato do rótulo de
dados.
TypeScript
Retornos
string
getPosition()
Valor que representa a posição do rótulo de dados. Confira
TypeScript
getPosition(): ChartDataLabelPosition;
Retornos
getSeparator()
Cadeia de caracteres que representa o separador usado para o rótulo de dados em
um gráfico.
TypeScript
getSeparator(): string;
Retornos
string
getShowBubbleSize()
Especifica se o tamanho da bolha do rótulo de dados está visível.
TypeScript
getShowBubbleSize(): boolean;
Retornos
boolean
getShowCategoryName()
Especifica se o nome da categoria do rótulo de dados está visível.
TypeScript
getShowCategoryName(): boolean;
Retornos
boolean
getShowLegendKey()
Especifica se a chave de legenda do rótulo de dados está visível.
TypeScript
getShowLegendKey(): boolean;
Retornos
boolean
getShowPercentage()
Especifica se o percentual do rótulo de dados está visível.
TypeScript
getShowPercentage(): boolean;
Retornos
boolean
getShowSeriesName()
Especifica se o nome da série de rótulos de dados está visível.
TypeScript
getShowSeriesName(): boolean;
Retornos
boolean
getShowValue()
Especifica se o valor do rótulo de dados está visível.
TypeScript
getShowValue(): boolean;
Retornos
boolean
getText()
Cadeia de caracteres que representa o texto do rótulo de dados em um gráfico.
TypeScript
getText(): string;
Retornos
string
Representa o ângulo para o qual o texto é orientado para o rótulo de dados do
verticalmente.
TypeScript
Retornos
number
getTop()
Representa a distância, em pontos, da borda superior do rótulo de dados do gráfico
até a borda superior da área do gráfico. O valor será null se o rótulo de dados do
TypeScript
getTop(): number;
Retornos
number
getVerticalAlignment()
Representa o alinhamento vertical do rótulo de dados do gráfico. Confira
ExcelScript.ChartTextVerticalAlignment detalhes. Essa propriedade é válida
somente quando TextOrientation o rótulo de dados é 0.
TypeScript
getVerticalAlignment(): ChartTextVerticalAlignment;
Retornos
getWidth()
Retorna a largura, em pontos, do rótulo de dados do gráfico. O valor será null se o
rótulo de dados do gráfico não estiver visível.
TypeScript
getWidth(): number;
Retornos
number
setAutoText(autoText)
Especifica se o rótulo de dados gera automaticamente o texto apropriado com base
no contexto.
TypeScript
setAutoText(autoText: boolean): void;
Parâmetros
autoText boolean
Retornos
void
setFormula(formula)
Valor de cadeia de caracteres que representa a fórmula do título do rótulo de dados
usando a notação no estilo A1.
TypeScript

Parâmetros
formula string
Retornos
void
setHorizontalAlignment(horizontalAlignment)
Representa o alinhamento horizontal de rótulo de dados do gráfico. Confira
ExcelScript.ChartTextHorizontalAlignment detalhes. Essa propriedade é válida
somente quando TextOrientation o rótulo de dados é -90, 90 ou 180.
TypeScript
setHorizontalAlignment(
horizontalAlignment: ChartTextHorizontalAlignment
): void;
Parâmetros
horizontalAlignment ExcelScript.ChartTextHorizontalAlignment
Retornos
void
setLeft(left)
Representa a distância, em pontos, da borda esquerda do rótulo de dados do gráfico
até a borda esquerda da área do gráfico. O valor será null se o rótulo de dados do
TypeScript
Parâmetros
left number
Retornos
void
TypeScript
Parâmetros
Retornos
void
Valor de cadeia de caracteres que representa o código do formato do rótulo de
dados.
TypeScript
Parâmetros
numberFormat string
Retornos
void
TypeScript
setPosition(position: ChartDataLabelPosition): void;
Parâmetros
position ExcelScript.ChartDataLabelPosition
Retornos
void
setSeparator(separator)
Cadeia de caracteres que representa o separador usado para o rótulo de dados em
um gráfico.
TypeScript
setSeparator(separator: string): void;
Parâmetros
separator string
Retornos
void
setShowBubbleSize(showBubbleSize)
TypeScript
setShowBubbleSize(showBubbleSize: boolean): void;
Parâmetros
showBubbleSize boolean
Retornos
void
setShowCategoryName(showCategoryName)
TypeScript
setShowCategoryName(showCategoryName: boolean): void;
Parâmetros
showCategoryName boolean
Retornos
void
setShowLegendKey(showLegendKey)
TypeScript
setShowLegendKey(showLegendKey: boolean): void;
Parâmetros
showLegendKey boolean
Retornos
void
setShowPercentage(showPercentage)
TypeScript
setShowPercentage(showPercentage: boolean): void;
Parâmetros
showPercentage boolean
Retornos
void
setShowSeriesName(showSeriesName)
TypeScript
setShowSeriesName(showSeriesName: boolean): void;
Parâmetros
showSeriesName boolean
Retornos
void
setShowValue(showValue)
TypeScript
setShowValue(showValue: boolean): void;
Parâmetros
showValue boolean
Retornos
void
setText(text)
Cadeia de caracteres que representa o texto do rótulo de dados em um gráfico.
TypeScript
Parâmetros
text string
Retornos
void
Representa o ângulo para o qual o texto é orientado para o rótulo de dados do
verticalmente.
TypeScript
Parâmetros
Retornos
void
setTop(top)
Representa a distância, em pontos, da borda superior do rótulo de dados do gráfico
até a borda superior da área do gráfico. O valor será null se o rótulo de dados do
TypeScript
Parâmetros
top number
Retornos
void
setVerticalAlignment(verticalAlignment)
ExcelScript.ChartTextVerticalAlignment detalhes. Essa propriedade é válida
somente quando TextOrientation o rótulo de dados é 0.
TypeScript
setVerticalAlignment(
verticalAlignment: ChartTextVerticalAlignment
): void;
Parâmetros
verticalAlignment ExcelScript.ChartTextVerticalAlignment
Retornos
void
comentários:
interface
Referência
Pacote: ExcelScript
Encapsula as propriedades de formato dos rótulos de dados do gráfico.
Métodos
get Representa o formato de borda, que inclui a espessura de cor e estilo de linha.
Border()
getFill() Representa o formato de preenchimento do rótulo de dados atual do gráfico.
getFont() Representa os atributos de fonte (como nome da fonte, tamanho da fonte e cor)
para um rótulo de dados do gráfico.
Detalhes do método
getBorder()
Representa o formato de borda, que inclui a espessura de cor e estilo de linha.
TypeScript
Retornos
getFill()
Representa o formato de preenchimento do rótulo de dados atual do gráfico.
TypeScript
Retornos
getFont()
Representa os atributos de fonte (como nome da fonte, tamanho da fonte e cor)
para um rótulo de dados do gráfico.
TypeScript
Retornos
comentários:
ExcelScript.ChartDataLabels interface
Referência
Pacote: ExcelScript
Representa uma coleção de todos os rótulos de dados em um ponto do gráfico.
Métodos
getAutoText() Especifica se os rótulos de dados geram automaticamente o texto

getFormat() Especifica o formato de rótulos de dados do gráfico, que inclui

preenchimento e formatação de fonte.
getHorizontal Especifica o alinhamento horizontal para o rótulo de dados do gráfico.

Alignment() Confira ExcelScript.ChartTextHorizontalAlignment detalhes. Essa
propriedade só é válida quando o TextOrientation rótulo de dados é
0.
getLinkNumberFormat() Especifica se o formato de número está vinculado às células. Se true ,

o formato de número será alterado nos rótulos quando ele for
getNumberFormat() Especifica o código de formato para rótulos de dados.
getPosition() Valor que representa a posição do rótulo de dados. Confira

getSeparator() Cadeia de caracteres que representa o separador usado para os

rótulos de dados em um gráfico.
getShowBubbleSize() Especifica se o tamanho da bolha do rótulo de dados está visível.
getShowCategory Especifica se o nome da categoria do rótulo de dados está visível.

Name()
getShowLegendKey() Especifica se a chave de legenda do rótulo de dados está visível.
getShowPercentage() Especifica se o percentual do rótulo de dados está visível.
getShowSeriesName() Especifica se o nome da série de rótulos de dados está visível.
getShowValue() Especifica se o valor do rótulo de dados está visível.

getTextOrientation() Representa o ângulo para o qual o texto é orientado para rótulos de
dados. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para
texto orientado verticalmente.
getVerticalAlignment() Representa o alinhamento vertical do rótulo de dados do gráfico.

Confira ExcelScript.ChartTextVerticalAlignment detalhes. Essa
propriedade só é válida quando TextOrientation o rótulo de dados é
-90, 90 ou 180.
setAutoText(autoText) Especifica se os rótulos de dados geram automaticamente o texto

setHorizontal Especifica o alinhamento horizontal para o rótulo de dados do gráfico.

Alignment(horizontal Confira ExcelScript.ChartTextHorizontalAlignment detalhes. Essa
Alignment) propriedade só é válida quando o TextOrientation rótulo de dados é
0.
setLinkNumber Especifica se o formato de número está vinculado às células. Se true ,

Format(linkNumber o formato de número será alterado nos rótulos quando ele for
Format) alterado nas células.
setNumber Especifica o código de formato para rótulos de dados.

Format(numberFormat)
setPosition(position) Valor que representa a posição do rótulo de dados. Confira

setSeparator(separator) Cadeia de caracteres que representa o separador usado para os

rótulos de dados em um gráfico.
setShowBubble Especifica se o tamanho da bolha do rótulo de dados está visível.

Size(showBubbleSize)
setShowCategory Especifica se o nome da categoria do rótulo de dados está visível.

Name(showCategory
Name)
setShowLegend Especifica se a chave de legenda do rótulo de dados está visível.

Key(showLegendKey)
setShow Especifica se o percentual do rótulo de dados está visível.

Percentage(show
Percentage)
setShowSeries Especifica se o nome da série de rótulos de dados está visível.

Name(showSeriesName)
setShowValue(show Especifica se o valor do rótulo de dados está visível.

Value)
setTextOrientation(text Representa o ângulo para o qual o texto é orientado para rótulos de
Orientation) dados. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para
setVertical Representa o alinhamento vertical do rótulo de dados do gráfico.

Alignment(vertical Confira ExcelScript.ChartTextVerticalAlignment detalhes. Essa
Alignment) propriedade só é válida quando TextOrientation o rótulo de dados é
-90, 90 ou 180.
Detalhes do método
getAutoText()
Especifica se os rótulos de dados geram automaticamente o texto apropriado com
base no contexto.
TypeScript
Retornos
boolean
getFormat()
Especifica o formato de rótulos de dados do gráfico, que inclui preenchimento e
formatação de fonte.
TypeScript
getFormat(): ChartDataLabelFormat;
Retornos
Especifica o alinhamento horizontal para o rótulo de dados do gráfico. Confira
ExcelScript.ChartTextHorizontalAlignment detalhes. Essa propriedade só é válida
quando o TextOrientation rótulo de dados é 0.
TypeScript
Retornos
TypeScript
Retornos
boolean
getNumberFormat()
Especifica o código de formato para rótulos de dados.
TypeScript
Retornos
string
getPosition()
TypeScript
getPosition(): ChartDataLabelPosition;
Retornos
getSeparator()
Cadeia de caracteres que representa o separador usado para os rótulos de dados em
um gráfico.
TypeScript
getSeparator(): string;
Retornos
string
getShowBubbleSize()
TypeScript
getShowBubbleSize(): boolean;
Retornos
boolean
getShowCategoryName()
TypeScript
getShowCategoryName(): boolean;
Retornos
boolean
getShowLegendKey()
TypeScript
getShowLegendKey(): boolean;
Retornos
boolean
getShowPercentage()
TypeScript
getShowPercentage(): boolean;
Retornos
boolean
getShowSeriesName()
TypeScript
getShowSeriesName(): boolean;
Retornos
boolean
getShowValue()
TypeScript
getShowValue(): boolean;
Retornos
boolean
Representa o ângulo para o qual o texto é orientado para rótulos de dados. O valor
deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado verticalmente.
TypeScript
Retornos
number
ExcelScript.ChartTextVerticalAlignment detalhes. Essa propriedade só é válida
quando TextOrientation o rótulo de dados é -90, 90 ou 180.
TypeScript
Retornos
Especifica se os rótulos de dados geram automaticamente o texto apropriado com
base no contexto.
TypeScript
Parâmetros
autoText boolean
Retornos
void
Especifica o alinhamento horizontal para o rótulo de dados do gráfico. Confira
ExcelScript.ChartTextHorizontalAlignment detalhes. Essa propriedade só é válida
quando o TextOrientation rótulo de dados é 0.
TypeScript
): void;
Parâmetros
Retornos
void
TypeScript
Parâmetros
Retornos
void
Especifica o código de formato para rótulos de dados.
TypeScript
Parâmetros
numberFormat string
Retornos
void
TypeScript
setPosition(position: ChartDataLabelPosition): void;
Parâmetros
position ExcelScript.ChartDataLabelPosition
Retornos
void
setSeparator(separator)
Cadeia de caracteres que representa o separador usado para os rótulos de dados em
um gráfico.
TypeScript
setSeparator(separator: string): void;
Parâmetros
separator string
Retornos
void
setShowBubbleSize(showBubbleSize)
TypeScript
setShowBubbleSize(showBubbleSize: boolean): void;
Parâmetros
showBubbleSize boolean
Retornos
void
setShowCategoryName(showCategoryName)
TypeScript
setShowCategoryName(showCategoryName: boolean): void;
Parâmetros
showCategoryName boolean
Retornos
void
setShowLegendKey(showLegendKey)
TypeScript
setShowLegendKey(showLegendKey: boolean): void;
Parâmetros
showLegendKey boolean
Retornos
void
setShowPercentage(showPercentage)
TypeScript
setShowPercentage(showPercentage: boolean): void;
Parâmetros
showPercentage boolean
Retornos
void
setShowSeriesName(showSeriesName)
TypeScript
setShowSeriesName(showSeriesName: boolean): void;
Parâmetros
showSeriesName boolean
Retornos
void
setShowValue(showValue)
TypeScript
setShowValue(showValue: boolean): void;
Parâmetros
showValue boolean
Retornos
void
Representa o ângulo para o qual o texto é orientado para rótulos de dados. O valor
TypeScript
Parâmetros
Retornos
void
ExcelScript.ChartTextVerticalAlignment detalhes. Essa propriedade só é válida
quando TextOrientation o rótulo de dados é -90, 90 ou 180.
TypeScript
): void;
Parâmetros
Retornos
void
comentários:
ExcelScript.ChartErrorBars interface
Referência
Pacote: ExcelScript
Esse objeto representa os atributos das barras de erro de um gráfico.
Métodos
getEndStyleCap() Especifica se as barras de erro têm um limite de estilo final.
getFormat() Especifica o tipo de formatação das barras de erro.
getInclude() Especifica quais partes das barras de erro devem ser incluídas.
getType() O tipo de intervalo marcado pelas barras de erro.
getVisible() Especifica se as barras de erro são exibidas.
setEndStyleCap(endStyleCap) Especifica se as barras de erro têm um limite de estilo final.
setInclude(include) Especifica quais partes das barras de erro devem ser incluídas.
setType(type) O tipo de intervalo marcado pelas barras de erro.
setVisible(visible) Especifica se as barras de erro são exibidas.
Detalhes do método
getEndStyleCap()
Especifica se as barras de erro têm um limite de estilo final.
TypeScript
getEndStyleCap(): boolean;
Retornos
boolean
getFormat()
Especifica o tipo de formatação das barras de erro.
TypeScript
getFormat(): ChartErrorBarsFormat;
Retornos
ExcelScript.ChartErrorBarsFormat
getInclude()
Especifica quais partes das barras de erro devem ser incluídas.
TypeScript
getInclude(): ChartErrorBarsInclude;
Retornos
ExcelScript.ChartErrorBarsInclude
getType()
O tipo de intervalo marcado pelas barras de erro.
TypeScript
getType(): ChartErrorBarsType;
Retornos
ExcelScript.ChartErrorBarsType
getVisible()
Especifica se as barras de erro são exibidas.
TypeScript
Retornos
boolean
setEndStyleCap(endStyleCap)
Especifica se as barras de erro têm um limite de estilo final.
TypeScript
setEndStyleCap(endStyleCap: boolean): void;
Parâmetros
endStyleCap boolean
Retornos
void
setInclude(include)
Especifica quais partes das barras de erro devem ser incluídas.
TypeScript
setInclude(include: ChartErrorBarsInclude): void;
Parâmetros
include ExcelScript.ChartErrorBarsInclude
Retornos
void
setType(type)
O tipo de intervalo marcado pelas barras de erro.
TypeScript
setType(type: ChartErrorBarsType): void;
Parâmetros
type ExcelScript.ChartErrorBarsType
Retornos
void
setVisible(visible)
Especifica se as barras de erro são exibidas.
TypeScript
Parâmetros
visible boolean
Retornos
void
comentários:
ExcelScript.ChartErrorBarsFormat
interface
Referência
Pacote: ExcelScript
Encapsula as propriedades de formato para barras de erro do gráfico.
Métodos
getLine() Representa a formatação de linha do gráfico.
Detalhes do método
getLine()
Representa a formatação de linha do gráfico.
TypeScript
Retornos
comentários:
ExcelScript.ChartFill interface
Referência
Pacote: ExcelScript
Representa a formatação de preenchimento de um elemento do gráfico.
Métodos
clear() Limpa a cor de preenchimento de um elemento de gráfico.
getSolidColor() Obtém a formatação de preenchimento de cor uniforme de um elemento de

gráfico.
setSolid Define a formatação de preenchimento de um elemento do gráfico com uma

Color(color) cor uniforme.
Detalhes do método
clear()
Limpa a cor de preenchimento de um elemento de gráfico.
TypeScript
clear(): void;
Retornos
void
getSolidColor()
Obtém a formatação de preenchimento de cor uniforme de um elemento de gráfico.
TypeScript
getSolidColor(): string;
Retornos
string
setSolidColor(color)
Define a formatação de preenchimento de um elemento do gráfico com uma cor
uniforme.
TypeScript
setSolidColor(color: string): void;
Parâmetros
color string
Código de cor HTML que representa a cor do plano de fundo, no formulário
#RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo,
"laranja").
Retornos
void
comentários:
ExcelScript.ChartFont interface
Referência
Pacote: ExcelScript
Esse objeto representa os atributos de fonte (como nome da fonte, tamanho da fonte e
cor) para um objeto gráfico.
Métodos
getBold() Representa o status da fonte em negrito.
getColor() Representação de código de cor HTML da cor do texto (por exemplo,

#FF0000 representa Vermelho).
getItalic() Representa o status da fonte em itálico.
getName() Nome da fonte (por exemplo, "Calibri")
getSize() Tamanho da fonte (por exemplo, 11)
getUnderline() Tipo de sublinhado aplicado à fonte. Confira

ExcelScript.ChartUnderlineStyle detalhes.
setBold(bold) Representa o status da fonte em negrito.
setColor(color) Representação de código de cor HTML da cor do texto (por exemplo,

setItalic(italic) Representa o status da fonte em itálico.
setName(name) Nome da fonte (por exemplo, "Calibri")
setSize(size) Tamanho da fonte (por exemplo, 11)
set Tipo de sublinhado aplicado à fonte. Confira

Underline(underline) ExcelScript.ChartUnderlineStyle detalhes.
Detalhes do método
getBold()
Representa o status da fonte em negrito.
TypeScript
getBold(): boolean;
Retornos
boolean
getColor()
Representação de código de cor HTML da cor do texto (por exemplo, #FF0000
representa Vermelho).
TypeScript
getColor(): string;
Retornos
string
getItalic()
Representa o status da fonte em itálico.
TypeScript
getItalic(): boolean;
Retornos
boolean
getName()
Nome da fonte (por exemplo, "Calibri")
TypeScript
getName(): string;
Retornos
string
getSize()
Tamanho da fonte (por exemplo, 11)
TypeScript
getSize(): number;
Retornos
number
getUnderline()
Tipo de sublinhado aplicado à fonte. Confira ExcelScript.ChartUnderlineStyle
detalhes.
TypeScript
getUnderline(): ChartUnderlineStyle;
Retornos
ExcelScript.ChartUnderlineStyle
setBold(bold)
Representa o status da fonte em negrito.
TypeScript
setBold(bold: boolean): void;
Parâmetros
bold boolean
Retornos
void
setColor(color)
TypeScript
Parâmetros
color string
Retornos
void
setItalic(italic)
Representa o status da fonte em itálico.
TypeScript
setItalic(italic: boolean): void;
Parâmetros
italic boolean
Retornos
void
setName(name)
Nome da fonte (por exemplo, "Calibri")
TypeScript
Parâmetros
name string
Retornos
void
setSize(size)
Tamanho da fonte (por exemplo, 11)
TypeScript
setSize(size: number): void;
Parâmetros
size number
Retornos
void
setUnderline(underline)
Tipo de sublinhado aplicado à fonte. Confira ExcelScript.ChartUnderlineStyle
detalhes.
TypeScript
setUnderline(underline: ChartUnderlineStyle): void;
Parâmetros
underline ExcelScript.ChartUnderlineStyle
Retornos
void
comentários:
ExcelScript.ChartFormatString interface
Referência
Pacote: ExcelScript
Representa a substring em objetos relacionados ao gráfico que contêm texto, como um

ChartTitle objeto ou ChartAxisTitle objeto.
Métodos
get Representa os atributos de fonte, como nome da fonte, tamanho da fonte e cor de um
Font() objeto de caracteres de gráfico.
Detalhes do método
getFont()
Representa os atributos de fonte, como nome da fonte, tamanho da fonte e cor de
um objeto de caracteres de gráfico.
TypeScript
Retornos
comentários:
ExcelScript.ChartGridlines interface
Referência
Pacote: ExcelScript
Representa linhas de grade principais ou secundárias em um eixo do gráfico.
Métodos
getFormat() Representa a formatação de linhas de grade do gráfico.
getVisible() Especifica se as linhas de grade do eixo estão visíveis.
setVisible(visible) Especifica se as linhas de grade do eixo estão visíveis.
Detalhes do método
getFormat()
Representa a formatação de linhas de grade do gráfico.
TypeScript
getFormat(): ChartGridlinesFormat;
Retornos
ExcelScript.ChartGridlinesFormat
getVisible()
Especifica se as linhas de grade do eixo estão visíveis.
TypeScript
Retornos
boolean
setVisible(visible)
Especifica se as linhas de grade do eixo estão visíveis.
TypeScript
Parâmetros
visible boolean
Retornos
void
comentários:
ExcelScript.ChartGridlinesFormat
interface
Referência
Pacote: ExcelScript
Encapsula as propriedades de formato das linhas de grade do gráfico.
Métodos
Detalhes do método
getLine()
TypeScript
Retornos
comentários:
ExcelScript.ChartLegend interface
Referência
Pacote: ExcelScript
Representa a legenda de um gráfico.
Métodos
getFormat() Representa a formatação de uma legenda de gráfico, que inclui a

formatação de fonte e de preenchimento.
getHeight() Especifica a altura, em pontos, da legenda no gráfico. O valor será null

se a legenda não estiver visível.
getLeft() Especifica o valor esquerdo, em pontos, da legenda no gráfico. O valor

será null se a legenda não estiver visível.
getLegendEntries() Representa uma coleção de legendEntries na legenda.
getOverlay() Especifica se a legenda do gráfico deve se sobrepor ao corpo principal

do gráfico.
getPosition() Especifica a posição da legenda no gráfico. Confira

ExcelScript.ChartLegendPosition detalhes.
getShowShadow() Especifica se a legenda tem uma sombra no gráfico.
getTop() Especifica a parte superior de uma legenda de gráfico.
getVisible() Especifica se a legenda do gráfico está visível.
getWidth() Especifica a largura, em pontos, da legenda no gráfico. O valor será

null se a legenda não estiver visível.
setHeight(height) Especifica a altura, em pontos, da legenda no gráfico. O valor será null

se a legenda não estiver visível.
setLeft(left) Especifica o valor esquerdo, em pontos, da legenda no gráfico. O valor

será null se a legenda não estiver visível.
setOverlay(overlay) Especifica se a legenda do gráfico deve se sobrepor ao corpo principal

do gráfico.
setPosition(position) Especifica a posição da legenda no gráfico. Confira

ExcelScript.ChartLegendPosition detalhes.
setShowShadow(show Especifica se a legenda tem uma sombra no gráfico.
Shadow)
setTop(top) Especifica a parte superior de uma legenda de gráfico.
setVisible(visible) Especifica se a legenda do gráfico está visível.
setWidth(width) Especifica a largura, em pontos, da legenda no gráfico. O valor será

null se a legenda não estiver visível.
Detalhes do método
getFormat()
Representa a formatação de uma legenda de gráfico, que inclui a formatação de
fonte e de preenchimento.
TypeScript
getFormat(): ChartLegendFormat;
Retornos
ExcelScript.ChartLegendFormat
getHeight()
Especifica a altura, em pontos, da legenda no gráfico. O valor será null se a legenda
não estiver visível.
TypeScript
Retornos
number
getLeft()
Especifica o valor esquerdo, em pontos, da legenda no gráfico. O valor será null se
a legenda não estiver visível.
TypeScript
getLeft(): number;
Retornos
number
getLegendEntries()
Representa uma coleção de legendEntries na legenda.
TypeScript
getLegendEntries(): ChartLegendEntry[];
Retornos
ExcelScript.ChartLegendEntry[]
getOverlay()
Especifica se a legenda do gráfico deve se sobrepor ao corpo principal do gráfico.
TypeScript
getOverlay(): boolean;
Retornos
boolean
getPosition()
Especifica a posição da legenda no gráfico. Confira ExcelScript.ChartLegendPosition
detalhes.
TypeScript
getPosition(): ChartLegendPosition;
Retornos
ExcelScript.ChartLegendPosition
getShowShadow()
Especifica se a legenda tem uma sombra no gráfico.
TypeScript
getShowShadow(): boolean;
Retornos
boolean
getTop()
Especifica a parte superior de uma legenda de gráfico.
TypeScript
getTop(): number;
Retornos
number
getVisible()
Especifica se a legenda do gráfico está visível.
TypeScript
Retornos
boolean
getWidth()
Especifica a largura, em pontos, da legenda no gráfico. O valor será null se a
legenda não estiver visível.
TypeScript
getWidth(): number;
Retornos
number
setHeight(height)
Especifica a altura, em pontos, da legenda no gráfico. O valor será null se a legenda
TypeScript
Parâmetros
height number
Retornos
void
setLeft(left)
Especifica o valor esquerdo, em pontos, da legenda no gráfico. O valor será null se
a legenda não estiver visível.
TypeScript

Parâmetros
left number
Retornos
void
setOverlay(overlay)
Especifica se a legenda do gráfico deve se sobrepor ao corpo principal do gráfico.
TypeScript
setOverlay(overlay: boolean): void;
Parâmetros
overlay boolean
Retornos
void
Especifica a posição da legenda no gráfico. Confira ExcelScript.ChartLegendPosition
detalhes.
TypeScript
setPosition(position: ChartLegendPosition): void;
Parâmetros
position ExcelScript.ChartLegendPosition
Retornos
void
setShowShadow(showShadow)
Especifica se a legenda tem uma sombra no gráfico.
TypeScript
setShowShadow(showShadow: boolean): void;
Parâmetros
showShadow boolean
Retornos
void
setTop(top)
Especifica a parte superior de uma legenda de gráfico.
TypeScript
Parâmetros
top number
Retornos
void
setVisible(visible)
Especifica se a legenda do gráfico está visível.
TypeScript
Parâmetros
visible boolean
Retornos
void
setWidth(width)
Especifica a largura, em pontos, da legenda no gráfico. O valor será null se a
legenda não estiver visível.
TypeScript
Parâmetros
width number
Retornos
void
comentários:
ExcelScript.ChartLegendEntry interface
Referência
Pacote: ExcelScript
Representa a entrada da legenda em legendEntryCollection .
Métodos
getHeight() Especifica a altura da entrada da legenda na legenda do gráfico.
getIndex() Especifica o índice da entrada de legenda na legenda do gráfico.
getLeft() Especifica o valor esquerdo de uma entrada de legenda de gráfico.
getTop() Especifica a parte superior de uma entrada de legenda do gráfico.
getVisible() Representa a visibilidade de uma entrada de legenda de gráfico.
getWidth() Representa a largura da entrada da legenda na legenda do gráfico.
setVisible(visible) Representa a visibilidade de uma entrada de legenda de gráfico.
Detalhes do método
getHeight()
Especifica a altura da entrada da legenda na legenda do gráfico.
TypeScript
Retornos
number
getIndex()
Especifica o índice da entrada de legenda na legenda do gráfico.
TypeScript
getIndex(): number;
Retornos
number
getLeft()
Especifica o valor esquerdo de uma entrada de legenda de gráfico.
TypeScript
getLeft(): number;
Retornos
number
getTop()
Especifica a parte superior de uma entrada de legenda do gráfico.
TypeScript
getTop(): number;
Retornos
number
getVisible()
Representa a visibilidade de uma entrada de legenda de gráfico.
TypeScript
Retornos
boolean
getWidth()
Representa a largura da entrada da legenda na legenda do gráfico.
TypeScript
getWidth(): number;
Retornos
number
setVisible(visible)
Representa a visibilidade de uma entrada de legenda de gráfico.
TypeScript
Parâmetros
visible boolean
Retornos
void
comentários:
ExcelScript.ChartLegendFormat
interface
Referência
Pacote: ExcelScript
Encapsula as propriedades de formato de uma legenda de gráfico.
Métodos
get Representa o formato de borda, que inclui a espessura de cor e estilo de linha.
Border()
getFill() Representa o formato de preenchimento de um objeto, que inclui informações sobre

getFont() Representa os atributos de fonte, como nome da fonte, tamanho da fonte e cor de
uma legenda de gráfico.
Detalhes do método
getBorder()
Representa o formato de borda, que inclui a espessura de cor e estilo de linha.
TypeScript
Retornos
getFill()
TypeScript
Retornos
getFont()
Representa os atributos de fonte, como nome da fonte, tamanho da fonte e cor de
uma legenda de gráfico.
TypeScript
Retornos
comentários:
ExcelScript.ChartLineFormat interface
Referência
Pacote: ExcelScript
Encapsula as opções de formatação para elementos de linha.
Métodos
clear() Limpa o formato de linha de um elemento de gráfico.
getColor() Código de cores HTML que representa a cor das linhas no gráfico.
getLineStyle() Representa o estilo de linha. Confira ExcelScript.ChartLineStyle

detalhes.
getWeight() Representa a espessura da linha, em pontos.
setColor(color) Código de cores HTML que representa a cor das linhas no gráfico.
setLineStyle(line Representa o estilo de linha. Confira ExcelScript.ChartLineStyle

Style) detalhes.
setWeight(weight) Representa a espessura da linha, em pontos.
Detalhes do método
clear()
Limpa o formato de linha de um elemento de gráfico.
TypeScript
clear(): void;
Retornos
void
getColor()
Código de cores HTML que representa a cor das linhas no gráfico.
TypeScript
getColor(): string;
Retornos
string
getLineStyle()
Representa o estilo de linha. Confira ExcelScript.ChartLineStyle detalhes.
TypeScript
getLineStyle(): ChartLineStyle;
Retornos
getWeight()
Representa a espessura da linha, em pontos.
TypeScript
Retornos
number
setColor(color)
Código de cores HTML que representa a cor das linhas no gráfico.
TypeScript

Parâmetros
color string
Retornos
void
setLineStyle(lineStyle)
Representa o estilo de linha. Confira ExcelScript.ChartLineStyle detalhes.
TypeScript
setLineStyle(lineStyle: ChartLineStyle): void;
Parâmetros
lineStyle ExcelScript.ChartLineStyle
Retornos
void
setWeight(weight)
Representa a espessura da linha, em pontos.
TypeScript
Parâmetros
weight number
Retornos
void
comentários:
ExcelScript.ChartMapOptions interface
Referência
Pacote: ExcelScript
Encapsula as propriedades de um gráfico de mapa de região.
Métodos
getLabelStrategy() Especifica a estratégia de rótulos de mapa de série de um gráfico

de mapa de região.
getLevel() Especifica o nível de mapeamento da série de um gráfico de mapa

da região.
getProjectionType() Especifica o tipo de projeção de série de um gráfico de mapa de

região.
setLabelStrategy(label Especifica a estratégia de rótulos de mapa de série de um gráfico

Strategy) de mapa de região.
setLevel(level) Especifica o nível de mapeamento da série de um gráfico de mapa

da região.
setProjectionType(projection Especifica o tipo de projeção de série de um gráfico de mapa de

Type) região.
Detalhes do método
getLabelStrategy()
Especifica a estratégia de rótulos de mapa de série de um gráfico de mapa de região.
TypeScript
getLabelStrategy(): ChartMapLabelStrategy;
Retornos
ExcelScript.ChartMapLabelStrategy
getLevel()
Especifica o nível de mapeamento da série de um gráfico de mapa da região.
TypeScript
getLevel(): ChartMapAreaLevel;
Retornos
ExcelScript.ChartMapAreaLevel
getProjectionType()
Especifica o tipo de projeção de série de um gráfico de mapa de região.
TypeScript
getProjectionType(): ChartMapProjectionType;
Retornos
ExcelScript.ChartMapProjectionType
setLabelStrategy(labelStrategy)
Especifica a estratégia de rótulos de mapa de série de um gráfico de mapa de região.
TypeScript
setLabelStrategy(labelStrategy: ChartMapLabelStrategy): void;
Parâmetros
labelStrategy ExcelScript.ChartMapLabelStrategy
Retornos
void
setLevel(level)
Especifica o nível de mapeamento da série de um gráfico de mapa da região.
TypeScript
setLevel(level: ChartMapAreaLevel): void;
Parâmetros
level ExcelScript.ChartMapAreaLevel
Retornos
void
setProjectionType(projectionType)
Especifica o tipo de projeção de série de um gráfico de mapa de região.
TypeScript
setProjectionType(projectionType: ChartMapProjectionType): void;
Parâmetros
projectionType ExcelScript.ChartMapProjectionType
Retornos
void
comentários:
ExcelScript.ChartPivotOptions interface
Referência
Pacote: ExcelScript
Encapsula as opções de gráfico dinâmico.
Métodos
getShowAxisField Especifica se é necessário exibir os botões de campo de eixo em um

Buttons() Gráfico Dinâmico. A showAxisFieldButtons propriedade corresponde ao
comando "Mostrar Botões de Campo do Eixo" na lista suspensa "Botões
de Campo" da guia "Analisar", que está disponível quando um Gráfico
Dinâmico é selecionado.
getShowLegendField Especifica se é necessário exibir os botões do campo legenda em um

Buttons() Gráfico Dinâmico.
getShowReportFilter Especifica se é necessário exibir os botões de campo de filtro de relatório

FieldButtons() em um Gráfico Dinâmico.
getShowValueField Especifica se é necessário exibir os botões de campo mostrar valor em

Buttons() um Gráfico Dinâmico.
setShowAxisField Especifica se é necessário exibir os botões de campo de eixo em um

Buttons(showAxisField Gráfico Dinâmico. A showAxisFieldButtons propriedade corresponde ao
Buttons) comando "Mostrar Botões de Campo do Eixo" na lista suspensa "Botões
de Campo" da guia "Analisar", que está disponível quando um Gráfico
Dinâmico é selecionado.
setShowLegendField Especifica se é necessário exibir os botões do campo legenda em um

Buttons(showLegend Gráfico Dinâmico.
FieldButtons)
setShowReportFilter Especifica se é necessário exibir os botões de campo de filtro de relatório

FieldButtons(show em um Gráfico Dinâmico.
ReportFilterField
Buttons)
setShowValueField Especifica se é necessário exibir os botões de campo mostrar valor em

Buttons(showValue um Gráfico Dinâmico.
FieldButtons)
Detalhes do método
getShowAxisFieldButtons()
Especifica se é necessário exibir os botões de campo de eixo em um Gráfico
Dinâmico. A showAxisFieldButtons propriedade corresponde ao comando "Mostrar
Botões de Campo do Eixo" na lista suspensa "Botões de Campo" da guia "Analisar",
que está disponível quando um Gráfico Dinâmico é selecionado.
TypeScript
getShowAxisFieldButtons(): boolean;
Retornos
boolean
getShowLegendFieldButtons()
Especifica se é necessário exibir os botões do campo legenda em um Gráfico
Dinâmico.
TypeScript
getShowLegendFieldButtons(): boolean;
Retornos
boolean
getShowReportFilterFieldButtons()
Especifica se é necessário exibir os botões de campo de filtro de relatório em um
Gráfico Dinâmico.
TypeScript
getShowReportFilterFieldButtons(): boolean;
Retornos
boolean
getShowValueFieldButtons()
Especifica se é necessário exibir os botões de campo mostrar valor em um Gráfico
Dinâmico.
TypeScript
getShowValueFieldButtons(): boolean;
Retornos
boolean
setShowAxisFieldButtons(showAxisFieldButtons)
Especifica se é necessário exibir os botões de campo de eixo em um Gráfico
Dinâmico. A showAxisFieldButtons propriedade corresponde ao comando "Mostrar
Botões de Campo do Eixo" na lista suspensa "Botões de Campo" da guia "Analisar",
que está disponível quando um Gráfico Dinâmico é selecionado.
TypeScript
setShowAxisFieldButtons(showAxisFieldButtons: boolean): void;
Parâmetros
showAxisFieldButtons boolean
Retornos
void
setShowLegendFieldButtons(showLegendFieldButtons)
Especifica se é necessário exibir os botões do campo legenda em um Gráfico
Dinâmico.
TypeScript
setShowLegendFieldButtons(showLegendFieldButtons: boolean): void;

Parâmetros
showLegendFieldButtons boolean
Retornos
void
setShowReportFilterFieldButtons(showReportFilterField
Buttons)
Especifica se é necessário exibir os botões de campo de filtro de relatório em um
Gráfico Dinâmico.
TypeScript
setShowReportFilterFieldButtons(
showReportFilterFieldButtons: boolean
): void;
Parâmetros
showReportFilterFieldButtons boolean
Retornos
void
setShowValueFieldButtons(showValueFieldButtons)
Especifica se é necessário exibir os botões de campo mostrar valor em um Gráfico
Dinâmico.
TypeScript
setShowValueFieldButtons(showValueFieldButtons: boolean): void;
Parâmetros
showValueFieldButtons boolean
Retornos
void
ExcelScript.ChartPlotArea interface
Referência
Pacote: ExcelScript
Esse objeto representa os atributos de uma área de plotagem do gráfico.
Métodos
getFormat() Especifica a formatação de uma área de plotagem de gráfico.
getHeight() Especifica o valor de altura de uma área de plotagem.
getInsideHeight() Especifica o valor de altura interna de uma área de plotagem.
getInsideLeft() Especifica o valor interno esquerdo de uma área de plotagem.
getInsideTop() Especifica o valor superior interno de uma área de plotagem.
getInsideWidth() Especifica o valor de largura interna de uma área de plotagem.
getLeft() Especifica o valor esquerdo de uma área de plotagem.
getPosition() Especifica a posição de uma área de plotagem.
getTop() Especifica o valor superior de uma área de plotagem.
getWidth() Especifica o valor de largura de uma área de plotagem.
setHeight(height) Especifica o valor de altura de uma área de plotagem.
setInsideHeight(insideHeight) Especifica o valor de altura interna de uma área de plotagem.
setInsideLeft(insideLeft) Especifica o valor interno esquerdo de uma área de plotagem.
setInsideTop(insideTop) Especifica o valor superior interno de uma área de plotagem.
setInsideWidth(insideWidth) Especifica o valor de largura interna de uma área de plotagem.
setLeft(left) Especifica o valor esquerdo de uma área de plotagem.
setPosition(position) Especifica a posição de uma área de plotagem.
setTop(top) Especifica o valor superior de uma área de plotagem.
setWidth(width) Especifica o valor de largura de uma área de plotagem.

Detalhes do método
getFormat()
Especifica a formatação de uma área de plotagem de gráfico.
TypeScript
getFormat(): ChartPlotAreaFormat;
Retornos
ExcelScript.ChartPlotAreaFormat
getHeight()
Especifica o valor de altura de uma área de plotagem.
TypeScript
Retornos
number
getInsideHeight()
Especifica o valor de altura interna de uma área de plotagem.
TypeScript
getInsideHeight(): number;
Retornos
number
getInsideLeft()
Especifica o valor interno esquerdo de uma área de plotagem.
TypeScript
getInsideLeft(): number;
Retornos
number
getInsideTop()
Especifica o valor superior interno de uma área de plotagem.
TypeScript
getInsideTop(): number;
Retornos
number
getInsideWidth()
Especifica o valor de largura interna de uma área de plotagem.
TypeScript
getInsideWidth(): number;
Retornos
number
getLeft()
Especifica o valor esquerdo de uma área de plotagem.
TypeScript
getLeft(): number;
Retornos
number
getPosition()
Especifica a posição de uma área de plotagem.
TypeScript
getPosition(): ChartPlotAreaPosition;
Retornos
ExcelScript.ChartPlotAreaPosition
getTop()
Especifica o valor superior de uma área de plotagem.
TypeScript
getTop(): number;
Retornos
number
getWidth()
Especifica o valor de largura de uma área de plotagem.
TypeScript
getWidth(): number;
Retornos
number
setHeight(height)
Especifica o valor de altura de uma área de plotagem.
TypeScript
Parâmetros
height number
Retornos
void
setInsideHeight(insideHeight)
Especifica o valor de altura interna de uma área de plotagem.
TypeScript
setInsideHeight(insideHeight: number): void;
Parâmetros
insideHeight number
Retornos
void
setInsideLeft(insideLeft)
Especifica o valor interno esquerdo de uma área de plotagem.
TypeScript
setInsideLeft(insideLeft: number): void;
Parâmetros
insideLeft number
Retornos
void
setInsideTop(insideTop)
Especifica o valor superior interno de uma área de plotagem.
TypeScript
setInsideTop(insideTop: number): void;
Parâmetros
insideTop number
Retornos
void
setInsideWidth(insideWidth)
Especifica o valor de largura interna de uma área de plotagem.
TypeScript
setInsideWidth(insideWidth: number): void;
Parâmetros
insideWidth number
Retornos
void
setLeft(left)
Especifica o valor esquerdo de uma área de plotagem.
TypeScript
Parâmetros
left number
Retornos
void
Especifica a posição de uma área de plotagem.
TypeScript
setPosition(position: ChartPlotAreaPosition): void;
Parâmetros
position ExcelScript.ChartPlotAreaPosition
Retornos
void
setTop(top)
Especifica o valor superior de uma área de plotagem.
TypeScript
Parâmetros
top number
Retornos
void
setWidth(width)
Especifica o valor de largura de uma área de plotagem.
TypeScript
Parâmetros
width number
Retornos
void
comentários:
ExcelScript.ChartPlotAreaFormat
interface
Referência
Pacote: ExcelScript
Representa as propriedades de formato para uma área de plotagem de gráfico.
Métodos
get Especifica os atributos de borda de uma área de gráfico.

Border()
getFill() Especifica o formato de preenchimento de um objeto, que inclui informações de

formatação em segundo plano.
Detalhes do método
getBorder()
Especifica os atributos de borda de uma área de gráfico.
TypeScript
Retornos
getFill()
Especifica o formato de preenchimento de um objeto, que inclui informações de
TypeScript
Retornos
comentários:
ExcelScript.ChartPoint interface
Referência
Pacote: ExcelScript
Representa o ponto de uma série do gráfico.
Métodos
getDataLabel() Retorna o rótulo de dados de um ponto de gráfico.
getFormat() Encapsula as propriedades de formato de um ponto do gráfico.
getHasDataLabel() Representa se um ponto de dados tem um rótulo de dados. Não

aplicável para gráficos de superfície.
getMarkerBackground Representação de código de cor HTML da cor de fundo do marcador

Color() de um ponto de dados (por exemplo, #FF0000 representa Vermelho).
getMarkerForeground Representação de código de cor HTML da cor do primeiro plano do

Color() marcador de um ponto de dados (por exemplo, #FF0000 representa
Vermelho).
getMarkerSize() Representa o tamanho do marcador de um ponto de dados.
getMarkerStyle() Representa estilo do marcador de um ponto de dados do gráfico.

Confira ExcelScript.ChartMarkerStyle detalhes.
getValue() Retorna o valor de um ponto do gráfico.
setHasDataLabel(hasData Representa se um ponto de dados tem um rótulo de dados. Não

Label) aplicável para gráficos de superfície.
setMarkerBackground Representação de código de cor HTML da cor de fundo do marcador

Color(markerBackground de um ponto de dados (por exemplo, #FF0000 representa Vermelho).
Color)
setMarkerForeground Representação de código de cor HTML da cor do primeiro plano do

Color(markerForeground marcador de um ponto de dados (por exemplo, #FF0000 representa
Color) Vermelho).
setMarkerSize(markerSize) Representa o tamanho do marcador de um ponto de dados.
setMarkerStyle(marker Representa estilo do marcador de um ponto de dados do gráfico.

Style) Confira ExcelScript.ChartMarkerStyle detalhes.
Detalhes do método
getDataLabel()
Retorna o rótulo de dados de um ponto de gráfico.
TypeScript
getDataLabel(): ChartDataLabel;
Retornos
ExcelScript.ChartDataLabel
getFormat()
Encapsula as propriedades de formato de um ponto do gráfico.
TypeScript
getFormat(): ChartPointFormat;
Retornos
ExcelScript.ChartPointFormat
getHasDataLabel()
Representa se um ponto de dados tem um rótulo de dados. Não aplicável para
gráficos de superfície.
TypeScript
getHasDataLabel(): boolean;
Retornos
boolean
getMarkerBackgroundColor()
Representação de código de cor HTML da cor de fundo do marcador de um ponto
de dados (por exemplo, #FF0000 representa Vermelho).
TypeScript
getMarkerBackgroundColor(): string;
Retornos
string
getMarkerForegroundColor()
Representação de código de cor HTML da cor do primeiro plano do marcador de um
ponto de dados (por exemplo, #FF0000 representa Vermelho).
TypeScript
getMarkerForegroundColor(): string;
Retornos
string
getMarkerSize()
Representa o tamanho do marcador de um ponto de dados.
TypeScript
getMarkerSize(): number;
Retornos
number
getMarkerStyle()
Representa estilo do marcador de um ponto de dados do gráfico. Confira
ExcelScript.ChartMarkerStyle detalhes.
TypeScript
getMarkerStyle(): ChartMarkerStyle;
Retornos
getValue()
Retorna o valor de um ponto do gráfico.
TypeScript
getValue(): number;
Retornos
number
setHasDataLabel(hasDataLabel)
Representa se um ponto de dados tem um rótulo de dados. Não aplicável para
gráficos de superfície.
TypeScript
setHasDataLabel(hasDataLabel: boolean): void;
Parâmetros
hasDataLabel boolean
Retornos
void
setMarkerBackgroundColor(markerBackgroundColor)
Representação de código de cor HTML da cor de fundo do marcador de um ponto
de dados (por exemplo, #FF0000 representa Vermelho).
TypeScript
setMarkerBackgroundColor(markerBackgroundColor: string): void;
Parâmetros
markerBackgroundColor string
Retornos
void
setMarkerForegroundColor(markerForegroundColor)
Representação de código de cor HTML da cor do primeiro plano do marcador de um
ponto de dados (por exemplo, #FF0000 representa Vermelho).
TypeScript
setMarkerForegroundColor(markerForegroundColor: string): void;
Parâmetros
markerForegroundColor string
Retornos
void
setMarkerSize(markerSize)
Representa o tamanho do marcador de um ponto de dados.
TypeScript
setMarkerSize(markerSize: number): void;
Parâmetros
markerSize number
Retornos
void
setMarkerStyle(markerStyle)
Representa estilo do marcador de um ponto de dados do gráfico. Confira
TypeScript
setMarkerStyle(markerStyle: ChartMarkerStyle): void;
Parâmetros
markerStyle ExcelScript.ChartMarkerStyle
Retornos
void
comentários:
ExcelScript.ChartPointFormat interface
Referência
Pacote: ExcelScript
Representa o objeto de formatação para pontos de gráfico.
Métodos
get Representa o formato de borda de um ponto de dados do gráfico, que inclui

Border() informações de cor, estilo e peso.
getFill() Representa o formato de preenchimento de um gráfico, que inclui informações de

Detalhes do método
getBorder()
Representa o formato de borda de um ponto de dados do gráfico, que inclui
informações de cor, estilo e peso.
TypeScript
Retornos
getFill()
Representa o formato de preenchimento de um gráfico, que inclui informações de
TypeScript
Retornos
comentários:
ExcelScript.ChartSeries interface
Referência
Pacote: ExcelScript
Representa uma série de um gráfico.
Comentários
Exemplos
TypeScript
/**
* This sample produces a line chart with two series.
* The chart assumes data in A1:E5 that looks like this:
* Product Qtr1 Qtr2 Qtr3 Qtr4
* Frames 5000 7000 6544 4377
* Saddles 400 323 276 651
*/
// Establish the ranges to use.
const headerRange = sheet.getRange("A1:E1");
const firstSeriesRange = sheet.getRange("A2:E2");
const secondSeriesRange = sheet.getRange("A3:E3");
// Create the chart.

const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);
// Add the first chart series.

const firstSeries = lineChart.addChartSeries();
firstSeries.setXAxisValues(headerRange);
firstSeries.setValues(firstSeriesRange);
// Add the second chart series.

const secondSeries = lineChart.addChartSeries();
secondSeries.setXAxisValues(headerRange);
secondSeries.setValues(secondSeriesRange);
}
Métodos
addChartTrendline(type) Adiciona uma nova linha de tendência ao conjunto de linha de
tendência.
delete() Exclui a série de gráfico.
getAxisGroup() Especifica o grupo da série especificada.
getBinOptions() Encapsula as opções de bin para gráficos de histograma e gráficos

de pareto.
getBoxwhiskerOptions() Encapsula as opções para os gráficos de caixa estreita.
getBubbleScale() Este pode ser um valor inteiro de 0 (zero) a 300, representando a

porcentagem do tamanho padrão. Esta propriedade só se aplica a
gráficos de bolhas.
getChartTrendline(index) Obtém um objeto trendline por índice, que é a ordem de inserção

na matriz de itens.
getChartType() Representa o tipo de gráfico de uma série. Confira

ExcelScript.ChartType detalhes.
getDataLabels() Representa uma coleção de todos os rótulos de dados da série.
getDimensionDataSource Obtém a representação de cadeia de caracteres da fonte de dados

String(dimension) da série de gráficos. A representação de cadeia de caracteres pode
ser informações como um endereço de célula.
getDimensionDataSource Obtém o tipo de fonte de dados da série de gráficos.

Type(dimension)
getDimension Obtém os valores de uma única dimensão da série de gráficos. Estes

Values(dimension) podem ser valores de categoria ou valores de dados, dependendo
da dimensão especificada e de como os dados são mapeados para a
série de gráficos.
getDoughnutHoleSize() Representa o tamanho do furo de rosca de uma série de gráficos.

Válido apenas em roscas e roscas explodidas. Lança um
InvalidArgument erro em gráficos inválidos.
getExplosion() Especifica o valor de explosão para uma fatia de gráfico de pizza ou

gráfico de donuts. Retorna 0 (zero) se não houver explosão (a ponta
da fatia está no centro da pizza).
getFiltered() Especifica se a série é filtrada. Não aplicável para gráficos de

superfície.
getFirstSliceAngle() Especifica o ângulo da primeira fatia de gráfico de pizza ou gráfico

de roscas, em graus (no sentido horário da vertical). Aplica-se
apenas a pizza, torta 3-D e gráficos de rosca.. Pode ser um valor de 0
a 360.
getFormat() Representa a formatação de uma série do gráfico, que inclui a
formatação de linha e de preenchimento.
getGapWidth() Representa a largura do espaçamento de uma série de gráfico.

Válido apenas em gráficos de barras e colunas, bem como classes
específicas de gráficos de linha e pizza. Gera uma exceção de
argumento inválida em gráficos inválidos.
getGradientMaximum Especifica a cor para o valor máximo de uma série de gráficos de

Color() mapa de região.
getGradientMaximum Especifica o tipo para o valor máximo de uma série de gráficos de

Type() mapa de região.
getGradientMaximum Especifica o valor máximo de uma série de gráficos de mapa de

Value() região.
getGradientMidpoint Especifica a cor do valor do ponto médio de uma série de gráficos

Color() de mapa de região.
getGradientMidpoint Especifica o tipo para o valor do ponto médio de uma série de

Type() gráficos de mapa da região.
getGradientMidpoint Especifica o valor do ponto médio de uma série de gráficos de mapa

Value() da região.
getGradientMinimum Especifica a cor do valor mínimo de uma série de gráficos de mapa

Color() de região.
getGradientMinimum Especifica o tipo para o valor mínimo de uma série de gráficos de

Type() mapa de região.
getGradientMinimum Especifica o valor mínimo de uma série de gráficos de mapa de

Value() região.
getGradientStyle() Especifica o estilo de gradiente da série de um gráfico de mapa de

região.
getHasDataLabels() Especifica se a série tem rótulos de dados.
getInvertColor() Especifica a cor de preenchimento para pontos de dados negativos

em uma série.
getInvertIfNegative() True se o Excel inverte o padrão no item quando ele corresponde a

um número negativo.
getMapOptions() Encapsula as opções para um gráfico de mapa de região.
getMarkerBackground Especifica a cor de fundo do marcador de uma série de gráficos.

Color()
getMarkerForeground Especifica a cor do marcador em primeiro plano de uma série de
Color() gráficos.
getMarkerSize() Especifica o tamanho do marcador de uma série de gráficos.
getMarkerStyle() Especifica o estilo de marcador de uma série de gráficos. Confira

getName() Especifica o nome de uma série em um gráfico. O comprimento do

nome não deve ser maior que 255 caracteres.
getOverlap() Especifica como barras e colunas são posicionadas. Pode ser um

valor entre -100 e 100. Se aplicam apenas às barras 2D e gráficos de
colunas 2D.
getParentLabelStrategy() Especifica a área de estratégia de rótulo pai da série para um gráfico

de mapa de árvore.
getPlotOrder() Especifica a ordem de plotagem de uma série de gráficos no grupo

de gráficos.
getPoints() Retorna uma coleção de todos os pontos da série.
getSecondPlotSize() Especifica o tamanho da seção secundária de um gráfico pie-of-pie

ou um gráfico bar-of-pie, como uma porcentagem do tamanho da
torta primária. Pode ser um valor de 5 de 200.
getShowConnectorLines() Especifica se as linhas do conector são mostradas em gráficos de

cascata.
getShowLeaderLines() Especifica se as linhas de líder são exibidas para cada rótulo de

dados na série.
getShowShadow() Especifica se a série tem uma sombra.
getSmooth() Especifica se a série é suave. Aplicável somente a gráficos de linha e

dispersão.
getSplitType() Especifica a forma como as duas seções de um gráfico pie-of-pie ou

um gráfico de barras de torta são divididas.
getSplitValue() Especifica o valor limite que separa duas seções de um gráfico pie-
of-pie ou um gráfico bar-of-pie.
getTrendlines() A coleção de linhas de tendência na série.
getVaryByCategories() True se o Excel atribuir uma cor ou padrão diferente a cada

marcador de dados. O gráfico deve conter apenas uma série.
getXErrorBars() Representa o objeto da barra de erros de uma série de gráficos.
getYErrorBars() Representa o objeto da barra de erros de uma série de gráficos.

setAxisGroup(axisGroup) Especifica o grupo da série especificada.
setBubbleScale(bubble Este pode ser um valor inteiro de 0 (zero) a 300, representando a

Scale) porcentagem do tamanho padrão. Esta propriedade só se aplica a
setBubbleSizes(source Define os tamanhos de bolha para uma série de gráficos. Funciona

Data) apenas para gráficos de bolhas.
setChartType(chartType) Representa o tipo de gráfico de uma série. Confira

ExcelScript.ChartType detalhes.
setDoughnutHole Representa o tamanho do furo de rosca de uma série de gráficos.

Size(doughnutHoleSize) Válido apenas em roscas e roscas explodidas. Lança um
InvalidArgument erro em gráficos inválidos.
setExplosion(explosion) Especifica o valor de explosão para uma fatia de gráfico de pizza ou

gráfico de donuts. Retorna 0 (zero) se não houver explosão (a ponta
da fatia está no centro da pizza).
setFiltered(filtered) Especifica se a série é filtrada. Não aplicável para gráficos de

superfície.
setFirstSliceAngle(firstSlice Especifica o ângulo da primeira fatia de gráfico de pizza ou gráfico

Angle) de roscas, em graus (no sentido horário da vertical). Aplica-se
apenas a pizza, torta 3-D e gráficos de rosca.. Pode ser um valor de 0
a 360.
setGapWidth(gapWidth) Representa a largura do espaçamento de uma série de gráfico.

Válido apenas em gráficos de barras e colunas, bem como classes
específicas de gráficos de linha e pizza. Gera uma exceção de
argumento inválida em gráficos inválidos.
setGradientMaximum Especifica a cor para o valor máximo de uma série de gráficos de

Color(gradientMaximum mapa de região.
Color)
setGradientMaximum Especifica o tipo para o valor máximo de uma série de gráficos de

Type(gradientMaximum mapa de região.
Type)
setGradientMaximum Especifica o valor máximo de uma série de gráficos de mapa de

Value(gradientMaximum região.
Value)
setGradientMidpoint Especifica a cor do valor do ponto médio de uma série de gráficos

Color(gradientMidpoint de mapa de região.
Color)
setGradientMidpoint Especifica o tipo para o valor do ponto médio de uma série de

Type(gradientMidpoint gráficos de mapa da região.
Type)
setGradientMidpoint Especifica o valor do ponto médio de uma série de gráficos de mapa

Value(gradientMidpoint da região.
Value)
setGradientMinimum Especifica a cor do valor mínimo de uma série de gráficos de mapa

Color(gradientMinimum de região.
Color)
setGradientMinimum Especifica o tipo para o valor mínimo de uma série de gráficos de

Type(gradientMinimum mapa de região.
Type)
setGradientMinimum Especifica o valor mínimo de uma série de gráficos de mapa de

Value(gradientMinimum região.
Value)
setGradientStyle(gradient Especifica o estilo de gradiente da série de um gráfico de mapa de

Style) região.
setHasDataLabels(hasData Especifica se a série tem rótulos de dados.

Labels)
setInvertColor(invertColor) Especifica a cor de preenchimento para pontos de dados negativos

em uma série.
setInvertIfNegative(invert True se o Excel inverte o padrão no item quando ele corresponde a

IfNegative) um número negativo.
setMarkerBackground Especifica a cor de fundo do marcador de uma série de gráficos.

Color(markerBackground
Color)
setMarkerForeground Especifica a cor do marcador em primeiro plano de uma série de

Color(markerForeground gráficos.
Color)
setMarkerSize(markerSize) Especifica o tamanho do marcador de uma série de gráficos.
setMarkerStyle(marker Especifica o estilo de marcador de uma série de gráficos. Confira

Style) ExcelScript.ChartMarkerStyle detalhes.
setName(name) Especifica o nome de uma série em um gráfico. O comprimento do

nome não deve ser maior que 255 caracteres.
setOverlap(overlap) Especifica como barras e colunas são posicionadas. Pode ser um

valor entre -100 e 100. Se aplicam apenas às barras 2D e gráficos de
colunas 2D.
setParentLabel Especifica a área de estratégia de rótulo pai da série para um gráfico

Strategy(parentLabel de mapa de árvore.
Strategy)
setPlotOrder(plotOrder) Especifica a ordem de plotagem de uma série de gráficos no grupo

de gráficos.
setSecondPlotSize(second Especifica o tamanho da seção secundária de um gráfico pie-of-pie

PlotSize) ou um gráfico bar-of-pie, como uma porcentagem do tamanho da
torta primária. Pode ser um valor de 5 de 200.
setShowConnector Especifica se as linhas do conector são mostradas em gráficos de

Lines(showConnector cascata.
Lines)
setShowLeaderLines(show Especifica se as linhas de líder são exibidas para cada rótulo de

LeaderLines) dados na série.
setShowShadow(show Especifica se a série tem uma sombra.

Shadow)
setSmooth(smooth) Especifica se a série é suave. Aplicável somente a gráficos de linha e

dispersão.
setSplitType(splitType) Especifica a forma como as duas seções de um gráfico pie-of-pie ou

um gráfico de barras de torta são divididas.
setSplitValue(splitValue) Especifica o valor limite que separa duas seções de um gráfico pie-
of-pie ou um gráfico bar-of-pie.
setValues(sourceData) Define os valores de uma série de gráficos. Para gráficos de

dispersão, ele se refere a valores de eixo y.
setVaryByCategories(vary True se o Excel atribuir uma cor ou padrão diferente a cada

ByCategories) marcador de dados. O gráfico deve conter apenas uma série.
setXAxisValues(source Define os valores do eixo x para uma série de gráficos.

Data)
Detalhes do método
addChartTrendline(type)
Adiciona uma nova linha de tendência ao conjunto de linha de tendência.
TypeScript
addChartTrendline(type?: ChartTrendlineType): ChartTrendline;

Parâmetros
type ExcelScript.ChartTrendlineType
Especifica o tipo de linha de tendência. O valor padrão é "Linear". Confira
ExcelScript.ChartTrendline detalhes.
Retornos
ExcelScript.ChartTrendline
delete()
Exclui a série de gráfico.
TypeScript
delete(): void;
Retornos
void
getAxisGroup()
Especifica o grupo da série especificada.
TypeScript
getAxisGroup(): ChartAxisGroup;
Retornos
getBinOptions()
Encapsula as opções de bin para gráficos de histograma e gráficos de pareto.
TypeScript
getBinOptions(): ChartBinOptions;
Retornos
ExcelScript.ChartBinOptions
getBoxwhiskerOptions()
Encapsula as opções para os gráficos de caixa estreita.
TypeScript
getBoxwhiskerOptions(): ChartBoxwhiskerOptions;
Retornos
ExcelScript.ChartBoxwhiskerOptions
getBubbleScale()
Este pode ser um valor inteiro de 0 (zero) a 300, representando a porcentagem do
tamanho padrão. Esta propriedade só se aplica a gráficos de bolhas.
TypeScript
getBubbleScale(): number;
Retornos
number
getChartTrendline(index)
Obtém um objeto trendline por índice, que é a ordem de inserção na matriz de itens.
TypeScript
getChartTrendline(index: number): ChartTrendline;
Parâmetros
index number
Representa a ordem de inserção na matriz de itens.
Retornos
ExcelScript.ChartTrendline
getChartType()
Representa o tipo de gráfico de uma série. Confira ExcelScript.ChartType detalhes.
TypeScript
getChartType(): ChartType;
Retornos
getDataLabels()
Representa uma coleção de todos os rótulos de dados da série.
TypeScript
getDataLabels(): ChartDataLabels;
Retornos
ExcelScript.ChartDataLabels
getDimensionDataSourceString(dimension)
Obtém a representação de cadeia de caracteres da fonte de dados da série de
gráficos. A representação de cadeia de caracteres pode ser informações como um
endereço de célula.
TypeScript
getDimensionDataSourceString(dimension: ChartSeriesDimension): string;
Parâmetros
dimension ExcelScript.ChartSeriesDimension
A dimensão do eixo de onde os dados são.
Retornos
string
getDimensionDataSourceType(dimension)
Obtém o tipo de fonte de dados da série de gráficos.
TypeScript
getDimensionDataSourceType(
dimension: ChartSeriesDimension
): ChartDataSourceType;
Parâmetros
Retornos
ExcelScript.ChartDataSourceType
getDimensionValues(dimension)
Obtém os valores de uma única dimensão da série de gráficos. Estes podem ser
valores de categoria ou valores de dados, dependendo da dimensão especificada e
de como os dados são mapeados para a série de gráficos.
TypeScript
getDimensionValues(dimension: ChartSeriesDimension): string[];
Parâmetros
Retornos
string[]
getDoughnutHoleSize()
Representa o tamanho do furo de rosca de uma série de gráficos. Válido apenas em
roscas e roscas explodidas. Lança um InvalidArgument erro em gráficos inválidos.
TypeScript
getDoughnutHoleSize(): number;
Retornos
number
getExplosion()
Especifica o valor de explosão para uma fatia de gráfico de pizza ou gráfico de
donuts. Retorna 0 (zero) se não houver explosão (a ponta da fatia está no centro da
pizza).
TypeScript
getExplosion(): number;
Retornos
number
getFiltered()
Especifica se a série é filtrada. Não aplicável para gráficos de superfície.
TypeScript
getFiltered(): boolean;
Retornos
boolean
getFirstSliceAngle()
Especifica o ângulo da primeira fatia de gráfico de pizza ou gráfico de roscas, em
graus (no sentido horário da vertical). Aplica-se apenas a pizza, torta 3-D e gráficos
de rosca.. Pode ser um valor de 0 a 360.
TypeScript
getFirstSliceAngle(): number;
Retornos
number
getFormat()
Representa a formatação de uma série do gráfico, que inclui a formatação de linha e
de preenchimento.
TypeScript
getFormat(): ChartSeriesFormat;
Retornos
ExcelScript.ChartSeriesFormat
getGapWidth()
Representa a largura do espaçamento de uma série de gráfico. Válido apenas em
gráficos de barras e colunas, bem como classes específicas de gráficos de linha e
pizza. Gera uma exceção de argumento inválida em gráficos inválidos.
TypeScript
getGapWidth(): number;
Retornos
number
getGradientMaximumColor()
Especifica a cor para o valor máximo de uma série de gráficos de mapa de região.
TypeScript
getGradientMaximumColor(): string;
Retornos
string
getGradientMaximumType()
Especifica o tipo para o valor máximo de uma série de gráficos de mapa de região.
TypeScript
getGradientMaximumType(): ChartGradientStyleType;
Retornos
getGradientMaximumValue()
Especifica o valor máximo de uma série de gráficos de mapa de região.
TypeScript
getGradientMaximumValue(): number;
Retornos
number
getGradientMidpointColor()
Especifica a cor do valor do ponto médio de uma série de gráficos de mapa de
região.
TypeScript
getGradientMidpointColor(): string;
Retornos
string
getGradientMidpointType()
Especifica o tipo para o valor do ponto médio de uma série de gráficos de mapa da
região.
TypeScript
getGradientMidpointType(): ChartGradientStyleType;
Retornos
getGradientMidpointValue()
Especifica o valor do ponto médio de uma série de gráficos de mapa da região.
TypeScript
getGradientMidpointValue(): number;
Retornos
number
getGradientMinimumColor()
Especifica a cor do valor mínimo de uma série de gráficos de mapa de região.
TypeScript
getGradientMinimumColor(): string;
Retornos
string
getGradientMinimumType()
Especifica o tipo para o valor mínimo de uma série de gráficos de mapa de região.
TypeScript
getGradientMinimumType(): ChartGradientStyleType;
Retornos
getGradientMinimumValue()
Especifica o valor mínimo de uma série de gráficos de mapa de região.
TypeScript
getGradientMinimumValue(): number;
Retornos
number
getGradientStyle()
Especifica o estilo de gradiente da série de um gráfico de mapa de região.
TypeScript
getGradientStyle(): ChartGradientStyle;
Retornos
ExcelScript.ChartGradientStyle
getHasDataLabels()
Especifica se a série tem rótulos de dados.
TypeScript
getHasDataLabels(): boolean;
Retornos
boolean
getInvertColor()
Especifica a cor de preenchimento para pontos de dados negativos em uma série.
TypeScript
getInvertColor(): string;
Retornos
string
getInvertIfNegative()
True se o Excel inverte o padrão no item quando ele corresponde a um número
negativo.
TypeScript
getInvertIfNegative(): boolean;
Retornos
boolean
getMapOptions()
Encapsula as opções para um gráfico de mapa de região.
TypeScript
getMapOptions(): ChartMapOptions;
Retornos
ExcelScript.ChartMapOptions
getMarkerBackgroundColor()
Especifica a cor de fundo do marcador de uma série de gráficos.
TypeScript
getMarkerBackgroundColor(): string;
Retornos
string
getMarkerForegroundColor()
Especifica a cor do marcador em primeiro plano de uma série de gráficos.
TypeScript
getMarkerForegroundColor(): string;
Retornos
string
getMarkerSize()
Especifica o tamanho do marcador de uma série de gráficos.
TypeScript
getMarkerSize(): number;
Retornos
number
getMarkerStyle()
Especifica o estilo de marcador de uma série de gráficos. Confira
TypeScript
getMarkerStyle(): ChartMarkerStyle;
Retornos
getName()
Especifica o nome de uma série em um gráfico. O comprimento do nome não deve
ser maior que 255 caracteres.
TypeScript
getName(): string;
Retornos
string
Exemplos
TypeScript
/**
* This sample logs the names of each of the chart series in a chart
named "ColumnClusteredChart".
*/

// Log the name of each chart series in the chart.

console.log(series.getName());
});
}
getOverlap()
Especifica como barras e colunas são posicionadas. Pode ser um valor entre -100 e
100. Se aplicam apenas às barras 2D e gráficos de colunas 2D.
TypeScript
getOverlap(): number;
Retornos
number
getParentLabelStrategy()
Especifica a área de estratégia de rótulo pai da série para um gráfico de mapa de
árvore.
TypeScript
getParentLabelStrategy(): ChartParentLabelStrategy;
Retornos
ExcelScript.ChartParentLabelStrategy
getPlotOrder()
Especifica a ordem de plotagem de uma série de gráficos no grupo de gráficos.
TypeScript
getPlotOrder(): number;
Retornos
number
getPoints()
Retorna uma coleção de todos os pontos da série.
TypeScript
getPoints(): ChartPoint[];
Retornos
ExcelScript.ChartPoint[]
getSecondPlotSize()
Especifica o tamanho da seção secundária de um gráfico pie-of-pie ou um gráfico
bar-of-pie, como uma porcentagem do tamanho da torta primária. Pode ser um
valor de 5 de 200.
TypeScript
getSecondPlotSize(): number;
Retornos
number
getShowConnectorLines()
Especifica se as linhas do conector são mostradas em gráficos de cascata.
TypeScript
getShowConnectorLines(): boolean;
Retornos
boolean
getShowLeaderLines()
Especifica se as linhas de líder são exibidas para cada rótulo de dados na série.
TypeScript
getShowLeaderLines(): boolean;
Retornos
boolean
getShowShadow()
Especifica se a série tem uma sombra.
TypeScript
Retornos
boolean
getSmooth()
Especifica se a série é suave. Aplicável somente a gráficos de linha e dispersão.
TypeScript
getSmooth(): boolean;
Retornos
boolean
getSplitType()
Especifica a forma como as duas seções de um gráfico pie-of-pie ou um gráfico de
barras de torta são divididas.
TypeScript
getSplitType(): ChartSplitType;
Retornos
ExcelScript.ChartSplitType
getSplitValue()
Especifica o valor limite que separa duas seções de um gráfico pie-of-pie ou um
gráfico bar-of-pie.
TypeScript
getSplitValue(): number;
Retornos
number
getTrendlines()
A coleção de linhas de tendência na série.
TypeScript
getTrendlines(): ChartTrendline[];
Retornos
ExcelScript.ChartTrendline[]
getVaryByCategories()
True se o Excel atribuir uma cor ou padrão diferente a cada marcador de dados. O
gráfico deve conter apenas uma série.
TypeScript
getVaryByCategories(): boolean;
Retornos
boolean
getXErrorBars()
Representa o objeto da barra de erros de uma série de gráficos.
TypeScript
getXErrorBars(): ChartErrorBars;
Retornos
ExcelScript.ChartErrorBars
getYErrorBars()
Representa o objeto da barra de erros de uma série de gráficos.
TypeScript
getYErrorBars(): ChartErrorBars;
Retornos
ExcelScript.ChartErrorBars
Exemplos
TypeScript
/**
* This script adds error bars for the standard error of each chart
series point.
*/
// Get the range for the chart.
const worksheet = workbook.getWorksheet("Sample");
const dataRange = worksheet.getRange("A1:B15");
// Create a line chart.

const chart = worksheet.addChart(ExcelScript.ChartType.line,
dataRange);
// For each series, add error bars for the standard error on each point
const allSeries = chart.getSeries();
allSeries.forEach((series) => {
series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
series.getYErrorBars().setVisible(true);
});
}
setAxisGroup(axisGroup)
Especifica o grupo da série especificada.
TypeScript
setAxisGroup(axisGroup: ChartAxisGroup): void;
Parâmetros
axisGroup ExcelScript.ChartAxisGroup
Retornos
void
setBubbleScale(bubbleScale)
Este pode ser um valor inteiro de 0 (zero) a 300, representando a porcentagem do
tamanho padrão. Esta propriedade só se aplica a gráficos de bolhas.
TypeScript
setBubbleScale(bubbleScale: number): void;
Parâmetros
bubbleScale number
Retornos
void
setBubbleSizes(sourceData)
Define os tamanhos de bolha para uma série de gráficos. Funciona apenas para
TypeScript
setBubbleSizes(sourceData: Range): void;

Parâmetros
Retornos
void
setChartType(chartType)
Representa o tipo de gráfico de uma série. Confira ExcelScript.ChartType detalhes.
TypeScript
setChartType(chartType: ChartType): void;
Parâmetros
chartType ExcelScript.ChartType
Retornos
void
setDoughnutHoleSize(doughnutHoleSize)
Representa o tamanho do furo de rosca de uma série de gráficos. Válido apenas em
roscas e roscas explodidas. Lança um InvalidArgument erro em gráficos inválidos.
TypeScript
setDoughnutHoleSize(doughnutHoleSize: number): void;
Parâmetros
doughnutHoleSize number
Retornos
void
setExplosion(explosion)
Especifica o valor de explosão para uma fatia de gráfico de pizza ou gráfico de
donuts. Retorna 0 (zero) se não houver explosão (a ponta da fatia está no centro da
pizza).
TypeScript
setExplosion(explosion: number): void;
Parâmetros
explosion number
Retornos
void
setFiltered(filtered)
Especifica se a série é filtrada. Não aplicável para gráficos de superfície.
TypeScript
setFiltered(filtered: boolean): void;
Parâmetros
filtered boolean
Retornos
void
setFirstSliceAngle(firstSliceAngle)
Especifica o ângulo da primeira fatia de gráfico de pizza ou gráfico de roscas, em
graus (no sentido horário da vertical). Aplica-se apenas a pizza, torta 3-D e gráficos
de rosca.. Pode ser um valor de 0 a 360.
TypeScript
setFirstSliceAngle(firstSliceAngle: number): void;
Parâmetros
firstSliceAngle number
Retornos
void
setGapWidth(gapWidth)
Representa a largura do espaçamento de uma série de gráfico. Válido apenas em
gráficos de barras e colunas, bem como classes específicas de gráficos de linha e
pizza. Gera uma exceção de argumento inválida em gráficos inválidos.
TypeScript
setGapWidth(gapWidth: number): void;
Parâmetros
gapWidth number
Retornos
void
setGradientMaximumColor(gradientMaximumColor)
Especifica a cor para o valor máximo de uma série de gráficos de mapa de região.
TypeScript
setGradientMaximumColor(gradientMaximumColor: string): void;
Parâmetros
gradientMaximumColor string
Retornos
void
setGradientMaximumType(gradientMaximumType)
Especifica o tipo para o valor máximo de uma série de gráficos de mapa de região.
TypeScript
setGradientMaximumType(
gradientMaximumType: ChartGradientStyleType
): void;
Parâmetros
gradientMaximumType ExcelScript.ChartGradientStyleType
Retornos
void
setGradientMaximumValue(gradientMaximumValue)
Especifica o valor máximo de uma série de gráficos de mapa de região.
TypeScript
setGradientMaximumValue(gradientMaximumValue: number): void;
Parâmetros
gradientMaximumValue number
Retornos
void
setGradientMidpointColor(gradientMidpointColor)
Especifica a cor do valor do ponto médio de uma série de gráficos de mapa de
região.
TypeScript
setGradientMidpointColor(gradientMidpointColor: string): void;
Parâmetros
gradientMidpointColor string
Retornos
void
setGradientMidpointType(gradientMidpointType)
Especifica o tipo para o valor do ponto médio de uma série de gráficos de mapa da
região.
TypeScript
setGradientMidpointType(
gradientMidpointType: ChartGradientStyleType
): void;
Parâmetros
gradientMidpointType ExcelScript.ChartGradientStyleType
Retornos
void
setGradientMidpointValue(gradientMidpointValue)
Especifica o valor do ponto médio de uma série de gráficos de mapa da região.
TypeScript
setGradientMidpointValue(gradientMidpointValue: number): void;
Parâmetros
gradientMidpointValue number
Retornos
void
setGradientMinimumColor(gradientMinimumColor)
Especifica a cor do valor mínimo de uma série de gráficos de mapa de região.
TypeScript
setGradientMinimumColor(gradientMinimumColor: string): void;
Parâmetros
gradientMinimumColor string
Retornos
void
setGradientMinimumType(gradientMinimumType)
Especifica o tipo para o valor mínimo de uma série de gráficos de mapa de região.
TypeScript
setGradientMinimumType(
gradientMinimumType: ChartGradientStyleType
): void;
Parâmetros
gradientMinimumType ExcelScript.ChartGradientStyleType
Retornos
void
setGradientMinimumValue(gradientMinimumValue)
Especifica o valor mínimo de uma série de gráficos de mapa de região.
TypeScript
setGradientMinimumValue(gradientMinimumValue: number): void;
Parâmetros
gradientMinimumValue number
Retornos
void
setGradientStyle(gradientStyle)
Especifica o estilo de gradiente da série de um gráfico de mapa de região.
TypeScript
setGradientStyle(gradientStyle: ChartGradientStyle): void;
Parâmetros
gradientStyle ExcelScript.ChartGradientStyle
Retornos
void
setHasDataLabels(hasDataLabels)
Especifica se a série tem rótulos de dados.
TypeScript
setHasDataLabels(hasDataLabels: boolean): void;
Parâmetros
hasDataLabels boolean
Retornos
void
setInvertColor(invertColor)
Especifica a cor de preenchimento para pontos de dados negativos em uma série.
TypeScript
setInvertColor(invertColor: string): void;
Parâmetros
invertColor string
Retornos
void
setInvertIfNegative(invertIfNegative)
True se o Excel inverte o padrão no item quando ele corresponde a um número
negativo.
TypeScript
setInvertIfNegative(invertIfNegative: boolean): void;
Parâmetros
invertIfNegative boolean
Retornos
void
setMarkerBackgroundColor(markerBackgroundColor)
Especifica a cor de fundo do marcador de uma série de gráficos.
TypeScript
setMarkerBackgroundColor(markerBackgroundColor: string): void;

Parâmetros
markerBackgroundColor string
Retornos
void
setMarkerForegroundColor(markerForegroundColor)
Especifica a cor do marcador em primeiro plano de uma série de gráficos.
TypeScript
setMarkerForegroundColor(markerForegroundColor: string): void;
Parâmetros
markerForegroundColor string
Retornos
void
setMarkerSize(markerSize)
Especifica o tamanho do marcador de uma série de gráficos.
TypeScript
setMarkerSize(markerSize: number): void;
Parâmetros
markerSize number
Retornos
void
setMarkerStyle(markerStyle)
Especifica o estilo de marcador de uma série de gráficos. Confira
TypeScript
setMarkerStyle(markerStyle: ChartMarkerStyle): void;
Parâmetros
markerStyle ExcelScript.ChartMarkerStyle
Retornos
void
setName(name)
Especifica o nome de uma série em um gráfico. O comprimento do nome não deve
ser maior que 255 caracteres.
TypeScript
Parâmetros
name string
Retornos
void
setOverlap(overlap)
Especifica como barras e colunas são posicionadas. Pode ser um valor entre -100 e
100. Se aplicam apenas às barras 2D e gráficos de colunas 2D.
TypeScript
setOverlap(overlap: number): void;

Parâmetros
overlap number
Retornos
void
Exemplos
TypeScript
/**
* This sample sets the overlap of the columns in a chart named
*/

// Set the overlap of every column of each series within a category.

// An overlap of 25 means the columns have 25% of their length
overlapping with the adjacent columns in the same category.
series.setOverlap(25);
});
}
setParentLabelStrategy(parentLabelStrategy)
Especifica a área de estratégia de rótulo pai da série para um gráfico de mapa de
árvore.
TypeScript
setParentLabelStrategy(
parentLabelStrategy: ChartParentLabelStrategy
): void;
Parâmetros
parentLabelStrategy ExcelScript.ChartParentLabelStrategy
Retornos
void
setPlotOrder(plotOrder)
Especifica a ordem de plotagem de uma série de gráficos no grupo de gráficos.
TypeScript
setPlotOrder(plotOrder: number): void;
Parâmetros
plotOrder number
Retornos
void
setSecondPlotSize(secondPlotSize)
Especifica o tamanho da seção secundária de um gráfico pie-of-pie ou um gráfico
bar-of-pie, como uma porcentagem do tamanho da torta primária. Pode ser um
valor de 5 de 200.
TypeScript
setSecondPlotSize(secondPlotSize: number): void;
Parâmetros
secondPlotSize number
Retornos
void
setShowConnectorLines(showConnectorLines)
Especifica se as linhas do conector são mostradas em gráficos de cascata.
TypeScript
setShowConnectorLines(showConnectorLines: boolean): void;
Parâmetros
showConnectorLines boolean
Retornos
void
setShowLeaderLines(showLeaderLines)
Especifica se as linhas de líder são exibidas para cada rótulo de dados na série.
TypeScript
setShowLeaderLines(showLeaderLines: boolean): void;
Parâmetros
showLeaderLines boolean
Retornos
void
Especifica se a série tem uma sombra.
TypeScript
Parâmetros
showShadow boolean
Retornos
void
setSmooth(smooth)
Especifica se a série é suave. Aplicável somente a gráficos de linha e dispersão.
TypeScript
setSmooth(smooth: boolean): void;
Parâmetros
smooth boolean
Retornos
void
setSplitType(splitType)
Especifica a forma como as duas seções de um gráfico pie-of-pie ou um gráfico de
barras de torta são divididas.
TypeScript
setSplitType(splitType: ChartSplitType): void;
Parâmetros
splitType ExcelScript.ChartSplitType
Retornos
void
setSplitValue(splitValue)
Especifica o valor limite que separa duas seções de um gráfico pie-of-pie ou um
gráfico bar-of-pie.
TypeScript
setSplitValue(splitValue: number): void;
Parâmetros
splitValue number
Retornos
void
setValues(sourceData)
Define os valores de uma série de gráficos. Para gráficos de dispersão, ele se refere a
valores de eixo y.
TypeScript
setValues(sourceData: Range): void;
Parâmetros
Retornos
void
setVaryByCategories(varyByCategories)
True se o Excel atribuir uma cor ou padrão diferente a cada marcador de dados. O
gráfico deve conter apenas uma série.
TypeScript
setVaryByCategories(varyByCategories: boolean): void;
Parâmetros
varyByCategories boolean
Retornos
void
setXAxisValues(sourceData)
Define os valores do eixo x para uma série de gráficos.
TypeScript
setXAxisValues(sourceData: Range): void;
Parâmetros
Retornos
void
comentários:
ExcelScript.ChartSeriesFormat interface
Referência
Pacote: ExcelScript
Encapsula as propriedades de formato da série de gráficos
Métodos
getFill() Representa o formato de preenchimento de uma série do gráfico, que inclui

get Representa a formatação de linha.

Line()
Detalhes do método
getFill()
Representa o formato de preenchimento de uma série do gráfico, que inclui
TypeScript
Retornos
getLine()
Representa a formatação de linha.
TypeScript
Retornos
comentários:
ExcelScript.ChartTitle interface
Referência
Pacote: ExcelScript
Representa um objeto ChartTitle de um gráfico.
Métodos
getFormat() Representa a formatação de um título do gráfico, que inclui a

formatação de fonte e de preenchimento.
getHeight() Representa a altura, em pontos, do título do gráfico. O valor será

null se o título do gráfico não estiver visível.
getHorizontalAlignment() Especifica o alinhamento horizontal para o título do gráfico.
getLeft() Especifica a distância, em pontos, da borda esquerda do título do

gráfico até a borda esquerda da área do gráfico. O valor será null se
o título do gráfico não estiver visível.
getOverlay() Especifica se o título do gráfico sobreporá o gráfico.
getPosition() Representa a posição de título do gráfico. Confira

ExcelScript.ChartTitlePosition detalhes.
getShowShadow() Representa um valor booliano que determina se o título do gráfico

tiver uma sombra.
getSubstring(start, length) Obtenha a substring de um título de gráfico. A quebra de linha '\n'

conta um caractere.
getText() Especifica o texto do título do gráfico.
getTextOrientation() Especifica o ângulo para o qual o texto é orientado para o título do

gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para
getTop() Especifica a distância, em pontos, da borda superior do título do

gráfico até a parte superior da área do gráfico. O valor será null se
getVerticalAlignment() Especifica o alinhamento vertical do título do gráfico. Confira

ExcelScript.ChartTextVerticalAlignment detalhes.
getVisible() Especifica se o título do gráfico está visível.

getWidth() Especifica a largura, em pontos, do título do gráfico. O valor será
null se o título do gráfico não estiver visível.
setFormula(formula) Define um valor de cadeia de caracteres que representa a fórmula do

título do eixo do gráfico usando a notação no estilo A1.
setHorizontal Especifica o alinhamento horizontal para o título do gráfico.

Alignment(horizontal
Alignment)
setLeft(left) Especifica a distância, em pontos, da borda esquerda do título do

gráfico até a borda esquerda da área do gráfico. O valor será null se
setOverlay(overlay) Especifica se o título do gráfico sobreporá o gráfico.
setPosition(position) Representa a posição de título do gráfico. Confira

ExcelScript.ChartTitlePosition detalhes.
setShowShadow(show Representa um valor booliano que determina se o título do gráfico

Shadow) tiver uma sombra.
setText(text) Especifica o texto do título do gráfico.
setTextOrientation(text Especifica o ângulo para o qual o texto é orientado para o título do

Orientation) gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para
setTop(top) Especifica a distância, em pontos, da borda superior do título do

gráfico até a parte superior da área do gráfico. O valor será null se
setVertical Especifica o alinhamento vertical do título do gráfico. Confira

Alignment(vertical ExcelScript.ChartTextVerticalAlignment detalhes.
Alignment)
setVisible(visible) Especifica se o título do gráfico está visível.
Detalhes do método
getFormat()
Representa a formatação de um título do gráfico, que inclui a formatação de fonte e
de preenchimento.
TypeScript
getFormat(): ChartTitleFormat;
Retornos
ExcelScript.ChartTitleFormat
getHeight()
Representa a altura, em pontos, do título do gráfico. O valor será null se o título do
TypeScript
Retornos
number
Especifica o alinhamento horizontal para o título do gráfico.
TypeScript
Retornos
getLeft()
Especifica a distância, em pontos, da borda esquerda do título do gráfico até a borda
esquerda da área do gráfico. O valor será null se o título do gráfico não estiver
visível.
TypeScript
getLeft(): number;
Retornos
number
getOverlay()
Especifica se o título do gráfico sobreporá o gráfico.
TypeScript
getOverlay(): boolean;
Retornos
boolean
getPosition()
Representa a posição de título do gráfico. Confira ExcelScript.ChartTitlePosition
detalhes.
TypeScript
getPosition(): ChartTitlePosition;
Retornos
ExcelScript.ChartTitlePosition
getShowShadow()
Representa um valor booliano que determina se o título do gráfico tiver uma
sombra.
TypeScript
Retornos
boolean
getSubstring(start, length)
Obtenha a substring de um título de gráfico. A quebra de linha '\n' conta um
caractere.
TypeScript
getSubstring(start: number, length: number): ChartFormatString;
Parâmetros
start number
Posição inicial da substring a ser recuperada. Indexados com zero.
length number
Comprimento da substring a ser recuperada.
Retornos
ExcelScript.ChartFormatString
getText()
Especifica o texto do título do gráfico.
TypeScript
getText(): string;
Retornos
string
Especifica o ângulo para o qual o texto é orientado para o título do gráfico. O valor
TypeScript
Retornos
number
getTop()
Especifica a distância, em pontos, da borda superior do título do gráfico até a parte
superior da área do gráfico. O valor será null se o título do gráfico não estiver
visível.
TypeScript
getTop(): number;
Retornos
number
Especifica o alinhamento vertical do título do gráfico. Confira
TypeScript
Retornos
getVisible()
Especifica se o título do gráfico está visível.
TypeScript
Retornos
boolean
getWidth()
Especifica a largura, em pontos, do título do gráfico. O valor será null se o título do
TypeScript
getWidth(): number;
Retornos
number
setFormula(formula)
Define um valor de cadeia de caracteres que representa a fórmula do título do eixo
do gráfico usando a notação no estilo A1.
TypeScript
Parâmetros
formula string
Uma cadeia de caracteres que representa a fórmula a ser definida.
Retornos
void
Especifica o alinhamento horizontal para o título do gráfico.
TypeScript
): void;
Parâmetros
Retornos
void
setLeft(left)
Especifica a distância, em pontos, da borda esquerda do título do gráfico até a borda
esquerda da área do gráfico. O valor será null se o título do gráfico não estiver
visível.
TypeScript
Parâmetros
left number
Retornos
void
setOverlay(overlay)
Especifica se o título do gráfico sobreporá o gráfico.
TypeScript
setOverlay(overlay: boolean): void;
Parâmetros
overlay boolean
Retornos
void
Representa a posição de título do gráfico. Confira ExcelScript.ChartTitlePosition
detalhes.
TypeScript
setPosition(position: ChartTitlePosition): void;
Parâmetros
position ExcelScript.ChartTitlePosition
Retornos
void
Representa um valor booliano que determina se o título do gráfico tiver uma
sombra.
TypeScript
Parâmetros
showShadow boolean
Retornos
void
setText(text)
Especifica o texto do título do gráfico.
TypeScript

Parâmetros
text string
Retornos
void
Especifica o ângulo para o qual o texto é orientado para o título do gráfico. O valor
TypeScript
Parâmetros
Retornos
void
setTop(top)
Especifica a distância, em pontos, da borda superior do título do gráfico até a parte
superior da área do gráfico. O valor será null se o título do gráfico não estiver
visível.
TypeScript
Parâmetros
top number
Retornos
void
Especifica o alinhamento vertical do título do gráfico. Confira
TypeScript
): void;
Parâmetros
Retornos
void
setVisible(visible)
Especifica se o título do gráfico está visível.
TypeScript
Parâmetros
visible boolean
Retornos
void
comentários:
ExcelScript.ChartTitleFormat interface
Referência
Pacote: ExcelScript
Fornece acesso às opções de formatação para um título de gráfico.
Métodos
get Representa o formato de borda do título do gráfico, que inclui cor, estilo de linha e
Border() peso.
getFill() Representa o formato de preenchimento de um objeto, que inclui informações sobre

getFont() Representa os atributos de fonte (como nome da fonte, tamanho da fonte e cor)
para um objeto.
Detalhes do método
getBorder()
Representa o formato de borda do título do gráfico, que inclui cor, estilo de linha e
peso.
TypeScript
Retornos
getFill()
TypeScript
Retornos
getFont()
Representa os atributos de fonte (como nome da fonte, tamanho da fonte e cor)
para um objeto.
TypeScript
Retornos
comentários:
ExcelScript.ChartTrendline interface
Referência
Pacote: ExcelScript
Este objeto representa os atributos de um objeto de linha de tendência do gráfico.
Métodos
delete() Deleta o objeto Trendline.
getBackwardPeriod() Representa o número de períodos que a linha de tendência se

estende para trás.
getFormat() Representa a formatação de uma linha de tendência do gráfico.
getForwardPeriod() Representa o número de períodos que a linha de tendência se

estende para frente.
getIntercept() Especifica o valor de interceptação da linha de tendência.
getLabel() Representa o rótulo de linha de tendência um gráfico.
getMovingAveragePeriod() Representa o período de uma linha de tendência do gráfico.

Aplicável somente às linhas de tendência com o tipo
MovingAverage .
getName() Representa o nome da linha de tendência. Pode ser definido como

um valor de cadeia de caracteres, um null valor representa valores
automáticos. O valor retornado sempre é uma cadeia de caracteres.
getPolynomialOrder() Representa a ordem de uma linha de tendência do gráfico.

Aplicável somente às linhas de tendência com o tipo Polynomial .
getShowEquation() Verdadeiro se a equação da linha de tendência for exibida no

gráfico.
getShowRSquared() True se o valor r-squared para a linha de tendência for exibido no

gráfico.
getType() Representa o tipo da linha de tendência de um gráfico.
setBackward Representa o número de períodos que a linha de tendência se

Period(backwardPeriod) estende para trás.
setForwardPeriod(forward Representa o número de períodos que a linha de tendência se
Period) estende para frente.
setIntercept(intercept) Especifica o valor de interceptação da linha de tendência.
setMovingAverage Representa o período de uma linha de tendência do gráfico.

Period(movingAverage Aplicável somente às linhas de tendência com o tipo
Period) MovingAverage .
setName(name) Representa o nome da linha de tendência. Pode ser definido como

um valor de cadeia de caracteres, um null valor representa valores
automáticos. O valor retornado sempre é uma cadeia de caracteres.
setPolynomial Representa a ordem de uma linha de tendência do gráfico.

Order(polynomialOrder) Aplicável somente às linhas de tendência com o tipo Polynomial .
setShowEquation(show Verdadeiro se a equação da linha de tendência for exibida no

Equation) gráfico.
setShowRSquared(show True se o valor r-squared para a linha de tendência for exibido no

RSquared) gráfico.
setType(type) Representa o tipo da linha de tendência de um gráfico.
Detalhes do método
delete()
Deleta o objeto Trendline.
TypeScript
delete(): void;
Retornos
void
getBackwardPeriod()
Representa o número de períodos que a linha de tendência se estende para trás.
TypeScript
getBackwardPeriod(): number;
Retornos
number
getFormat()
Representa a formatação de uma linha de tendência do gráfico.
TypeScript
getFormat(): ChartTrendlineFormat;
Retornos
ExcelScript.ChartTrendlineFormat
getForwardPeriod()
Representa o número de períodos que a linha de tendência se estende para frente.
TypeScript
getForwardPeriod(): number;
Retornos
number
getIntercept()
Especifica o valor de interceptação da linha de tendência.
TypeScript
getIntercept(): number;
Retornos
number
getLabel()
Representa o rótulo de linha de tendência um gráfico.
TypeScript
getLabel(): ChartTrendlineLabel;
Retornos
ExcelScript.ChartTrendlineLabel
getMovingAveragePeriod()
Representa o período de uma linha de tendência do gráfico. Aplicável somente às
linhas de tendência com o tipo MovingAverage .
TypeScript
getMovingAveragePeriod(): number;
Retornos
number
getName()
Representa o nome da linha de tendência. Pode ser definido como um valor de
cadeia de caracteres, um null valor representa valores automáticos. O valor
retornado sempre é uma cadeia de caracteres.
TypeScript
getName(): string;
Retornos
string
getPolynomialOrder()
Representa a ordem de uma linha de tendência do gráfico. Aplicável somente às
linhas de tendência com o tipo Polynomial .
TypeScript
getPolynomialOrder(): number;
Retornos
number
getShowEquation()
Verdadeiro se a equação da linha de tendência for exibida no gráfico.
TypeScript
getShowEquation(): boolean;
Retornos
boolean
getShowRSquared()
True se o valor r-squared para a linha de tendência for exibido no gráfico.
TypeScript
getShowRSquared(): boolean;
Retornos
boolean
getType()
Representa o tipo da linha de tendência de um gráfico.
TypeScript
getType(): ChartTrendlineType;
Retornos
ExcelScript.ChartTrendlineType
setBackwardPeriod(backwardPeriod)
Representa o número de períodos que a linha de tendência se estende para trás.
TypeScript
setBackwardPeriod(backwardPeriod: number): void;
Parâmetros
backwardPeriod number
Retornos
void
setForwardPeriod(forwardPeriod)
Representa o número de períodos que a linha de tendência se estende para frente.
TypeScript
setForwardPeriod(forwardPeriod: number): void;
Parâmetros
forwardPeriod number
Retornos
void
setIntercept(intercept)
Especifica o valor de interceptação da linha de tendência.
TypeScript
setIntercept(intercept: number): void;
Parâmetros
intercept number
Retornos
void
setMovingAveragePeriod(movingAveragePeriod)
Representa o período de uma linha de tendência do gráfico. Aplicável somente às
linhas de tendência com o tipo MovingAverage .
TypeScript
setMovingAveragePeriod(movingAveragePeriod: number): void;
Parâmetros
movingAveragePeriod number
Retornos
void
setName(name)
Representa o nome da linha de tendência. Pode ser definido como um valor de
cadeia de caracteres, um null valor representa valores automáticos. O valor
retornado sempre é uma cadeia de caracteres.
TypeScript

Parâmetros
name string
Retornos
void
setPolynomialOrder(polynomialOrder)
Representa a ordem de uma linha de tendência do gráfico. Aplicável somente às
linhas de tendência com o tipo Polynomial .
TypeScript
setPolynomialOrder(polynomialOrder: number): void;
Parâmetros
polynomialOrder number
Retornos
void
setShowEquation(showEquation)
Verdadeiro se a equação da linha de tendência for exibida no gráfico.
TypeScript
setShowEquation(showEquation: boolean): void;
Parâmetros
showEquation boolean
Retornos
void
setShowRSquared(showRSquared)
True se o valor r-squared para a linha de tendência for exibido no gráfico.
TypeScript
setShowRSquared(showRSquared: boolean): void;
Parâmetros
showRSquared boolean
Retornos
void
setType(type)
Representa o tipo da linha de tendência de um gráfico.
TypeScript
setType(type: ChartTrendlineType): void;
Parâmetros
type ExcelScript.ChartTrendlineType
Retornos
void
comentários:
ExcelScript.ChartTrendlineFormat
interface
Referência
Pacote: ExcelScript
Representa as propriedades de formato para a linha de tendência do gráfico.
Métodos
Detalhes do método
getLine()
TypeScript
Retornos
comentários:
ExcelScript.ChartTrendlineLabel
interface
Referência
Pacote: ExcelScript
Esse objeto representa os atributos de um objeto de rótulo de linha de tendência do

gráfico.
Métodos
getAutoText() Especifica se o rótulo de linha de tendência gera automaticamente o

texto apropriado com base no contexto.
getFormat() O formato do rótulo de linha de tendência do gráfico.
getFormula() Valor de cadeia de caracteres que representa a fórmula do rótulo de

linha de tendência do gráfico usando notação de estilo A1.
getHeight() Retorna a altura, em pontos, do rótulo de linha de tendência do

gráfico. O valor será null se o rótulo de linha de tendência do gráfico
getHorizontal Representa o alinhamento horizontal do rótulo de linha de tendência

Alignment() do gráfico. Confira ExcelScript.ChartTextHorizontalAlignment
detalhes. Essa propriedade é válida somente quando TextOrientation
um rótulo de linha de tendência é -90, 90 ou 180.
getLeft() Representa a distância, em pontos, da borda esquerda do rótulo de

linha de tendência do gráfico até a borda esquerda da área do gráfico.
O valor será null se o rótulo de linha de tendência do gráfico não
estiver visível.
getLinkNumberFormat() Especifica se o formato de número está vinculado às células (para que

o formato de número seja alterado nos rótulos quando ele for alterado
nas células).
getNumberFormat() Valor de cadeia de caracteres que representa o código de formato para

o rótulo de linha de tendência.
getText() Cadeia de caracteres que representa o texto do rótulo em um gráfico

de linha de tendência.
getTextOrientation() Representa o ângulo para o qual o texto é orientado para o rótulo de
linha de tendência do gráfico. O valor deve ser um inteiro de -90 a 90
ou o inteiro 180 para texto orientado verticalmente.
getTop() Representa a distância, em pontos, da borda superior do rótulo de

linha de tendência do gráfico até a parte superior da área do gráfico. O
valor será null se o rótulo de linha de tendência do gráfico não estiver
visível.
getVerticalAlignment() Representa o alinhamento vertical do rótulo de linha de tendência do

gráfico. Confira ExcelScript.ChartTextVerticalAlignment detalhes.
Essa propriedade é válida somente quando TextOrientation um rótulo
de linha de tendência é 0.
getWidth() Retorna a largura, em pontos, do rótulo de linha de tendência do

gráfico. O valor será null se o rótulo de linha de tendência do gráfico
setAutoText(autoText) Especifica se o rótulo de linha de tendência gera automaticamente o

texto apropriado com base no contexto.
setFormula(formula) Valor de cadeia de caracteres que representa a fórmula do rótulo de

linha de tendência do gráfico usando notação de estilo A1.
setHorizontal Representa o alinhamento horizontal do rótulo de linha de tendência

Alignment(horizontal do gráfico. Confira ExcelScript.ChartTextHorizontalAlignment
Alignment) detalhes. Essa propriedade é válida somente quando TextOrientation
um rótulo de linha de tendência é -90, 90 ou 180.
setLeft(left) Representa a distância, em pontos, da borda esquerda do rótulo de

linha de tendência do gráfico até a borda esquerda da área do gráfico.
O valor será null se o rótulo de linha de tendência do gráfico não
estiver visível.
setLinkNumber Especifica se o formato de número está vinculado às células (para que

Format(linkNumber o formato de número seja alterado nos rótulos quando ele for alterado
Format) nas células).
setNumber Valor de cadeia de caracteres que representa o código de formato para

Format(numberFormat) o rótulo de linha de tendência.
setText(text) Cadeia de caracteres que representa o texto do rótulo em um gráfico

de linha de tendência.
setTextOrientation(text Representa o ângulo para o qual o texto é orientado para o rótulo de

Orientation) linha de tendência do gráfico. O valor deve ser um inteiro de -90 a 90
ou o inteiro 180 para texto orientado verticalmente.
setTop(top) Representa a distância, em pontos, da borda superior do rótulo de

linha de tendência do gráfico até a parte superior da área do gráfico. O
valor será null se o rótulo de linha de tendência do gráfico não estiver
visível.
setVertical Representa o alinhamento vertical do rótulo de linha de tendência do

Alignment(vertical gráfico. Confira ExcelScript.ChartTextVerticalAlignment detalhes.
Alignment) Essa propriedade é válida somente quando TextOrientation um rótulo
de linha de tendência é 0.
Detalhes do método
getAutoText()
Especifica se o rótulo de linha de tendência gera automaticamente o texto
TypeScript
Retornos
boolean
getFormat()
O formato do rótulo de linha de tendência do gráfico.
TypeScript
getFormat(): ChartTrendlineLabelFormat;
Retornos
ExcelScript.ChartTrendlineLabelFormat
getFormula()
Valor de cadeia de caracteres que representa a fórmula do rótulo de linha de
tendência do gráfico usando notação de estilo A1.
TypeScript
Retornos
string
getHeight()
Retorna a altura, em pontos, do rótulo de linha de tendência do gráfico. O valor será
null se o rótulo de linha de tendência do gráfico não estiver visível.
TypeScript
Retornos
number
Representa o alinhamento horizontal do rótulo de linha de tendência do gráfico.
Confira ExcelScript.ChartTextHorizontalAlignment detalhes. Essa propriedade é
válida somente quando TextOrientation um rótulo de linha de tendência é -90, 90
ou 180.
TypeScript
Retornos
getLeft()
Representa a distância, em pontos, da borda esquerda do rótulo de linha de
tendência do gráfico até a borda esquerda da área do gráfico. O valor será null se o
rótulo de linha de tendência do gráfico não estiver visível.
TypeScript
getLeft(): number;
Retornos
number
TypeScript
Retornos
boolean
getNumberFormat()
Valor de cadeia de caracteres que representa o código de formato para o rótulo de
linha de tendência.
TypeScript
Retornos
string
getText()
Cadeia de caracteres que representa o texto do rótulo em um gráfico de linha de
tendência.
TypeScript
getText(): string;
Retornos
string
Representa o ângulo para o qual o texto é orientado para o rótulo de linha de
tendência do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para
TypeScript
Retornos
number
getTop()
Representa a distância, em pontos, da borda superior do rótulo de linha de
tendência do gráfico até a parte superior da área do gráfico. O valor será null se o
TypeScript
getTop(): number;
Retornos
number
Representa o alinhamento vertical do rótulo de linha de tendência do gráfico.
Confira ExcelScript.ChartTextVerticalAlignment detalhes. Essa propriedade é válida
somente quando TextOrientation um rótulo de linha de tendência é 0.
TypeScript
Retornos
getWidth()
Retorna a largura, em pontos, do rótulo de linha de tendência do gráfico. O valor
será null se o rótulo de linha de tendência do gráfico não estiver visível.
TypeScript
getWidth(): number;
Retornos
number
Especifica se o rótulo de linha de tendência gera automaticamente o texto
TypeScript
Parâmetros
autoText boolean
Retornos
void
setFormula(formula)
Valor de cadeia de caracteres que representa a fórmula do rótulo de linha de
tendência do gráfico usando notação de estilo A1.
TypeScript
Parâmetros
formula string
Retornos
void
Representa o alinhamento horizontal do rótulo de linha de tendência do gráfico.
Confira ExcelScript.ChartTextHorizontalAlignment detalhes. Essa propriedade é
válida somente quando TextOrientation um rótulo de linha de tendência é -90, 90
ou 180.
TypeScript
): void;
Parâmetros
Retornos
void
setLeft(left)
Representa a distância, em pontos, da borda esquerda do rótulo de linha de
tendência do gráfico até a borda esquerda da área do gráfico. O valor será null se o
TypeScript
Parâmetros
left number
Retornos
void
TypeScript
Parâmetros
Retornos
void
Valor de cadeia de caracteres que representa o código de formato para o rótulo de
linha de tendência.
TypeScript
Parâmetros
numberFormat string
Retornos
void
setText(text)
Cadeia de caracteres que representa o texto do rótulo em um gráfico de linha de
tendência.
TypeScript
Parâmetros
text string
Retornos
void
Representa o ângulo para o qual o texto é orientado para o rótulo de linha de
tendência do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para
TypeScript
Parâmetros
Retornos
void
setTop(top)
Representa a distância, em pontos, da borda superior do rótulo de linha de
tendência do gráfico até a parte superior da área do gráfico. O valor será null se o
TypeScript
Parâmetros
top number
Retornos
void
Representa o alinhamento vertical do rótulo de linha de tendência do gráfico.
Confira ExcelScript.ChartTextVerticalAlignment detalhes. Essa propriedade é válida
somente quando TextOrientation um rótulo de linha de tendência é 0.
TypeScript
): void;
Parâmetros
Retornos
void
ExcelScript.ChartTrendlineLabelFormat
interface
Referência
Pacote: ExcelScript
Encapsula as propriedades de formato para o rótulo de linha de tendência do gráfico.
Métodos
get Especifica o formato de borda, que inclui cor, estilo de linha e peso.
Border()
getFill() Especifica o formato de preenchimento do rótulo de linha de tendência do gráfico

atual.
getFont() Especifica os atributos de fonte (como nome da fonte, tamanho da fonte e cor) para
um rótulo de linha de tendência do gráfico.
Detalhes do método
getBorder()
Especifica o formato de borda, que inclui cor, estilo de linha e peso.
TypeScript
Retornos
getFill()
Especifica o formato de preenchimento do rótulo de linha de tendência do gráfico
atual.
TypeScript
Retornos
getFont()
Especifica os atributos de fonte (como nome da fonte, tamanho da fonte e cor) para
um rótulo de linha de tendência do gráfico.
TypeScript
Retornos
comentários:
ExcelScript.ColorScaleConditional
Format interface
Referência
Pacote: ExcelScript
Representa os critérios de escala de cores para formatação condicional.
Métodos
getCriteria() Os critérios da escala de cores. O ponto médio é opcional ao usar uma

escala de cores de dois pontos.
getThreeColor Se true , a escala de cores terá três pontos (mínimo, ponto médio, máximo),
Scale() caso contrário, terá dois (mínimo, máximo).
setCriteria(criteria) Os critérios da escala de cores. O ponto médio é opcional ao usar uma

escala de cores de dois pontos.
Detalhes do método
getCriteria()
Os critérios da escala de cores. O ponto médio é opcional ao usar uma escala de
cores de dois pontos.
TypeScript
getCriteria(): ConditionalColorScaleCriteria;
Retornos
ExcelScript.ConditionalColorScaleCriteria
getThreeColorScale()
Se true , a escala de cores terá três pontos (mínimo, ponto médio, máximo), caso
contrário, terá dois (mínimo, máximo).
TypeScript
getThreeColorScale(): boolean;
Retornos
boolean
setCriteria(criteria)
Os critérios da escala de cores. O ponto médio é opcional ao usar uma escala de
cores de dois pontos.
TypeScript
setCriteria(criteria: ConditionalColorScaleCriteria): void;
Parâmetros
criteria ExcelScript.ConditionalColorScaleCriteria
Retornos
void
comentários:
ExcelScript.Comment interface
Referência
Pacote: ExcelScript
Representa um comentário na pasta de trabalho.
Métodos
addComment Cria uma resposta de comentário para um comentário.

Reply(content, content
Type)
delete() Exclui o comentário e todas as respostas conectadas.
getAuthorEmail() Obtém o email do autor do comentário.
getAuthorName() Obtém o nome do autor do comentário.
getComment Retorna uma resposta de comentário identificada pela respectiva ID.

Reply(commentReplyId) Se o objeto de resposta de comentário não existir, esse método
retornará undefined .
getContent() O conteúdo do comentário. A cadeia de caracteres é texto simples.
getContentType() Obtém o tipo de conteúdo do comentário.
getCreationDate() Obtém o horário de criação do comentário. Retorna null se o

comentário foi convertido de uma nota, já que o comentário não tem
uma data de criação.
getId() Especifica o identificador de comentários.
getLocation() Obtém a célula em que esse comentário está localizado.
getMentions() Obtém as entidades (por exemplo, pessoas) que são mencionadas nos
comentários.
getReplies() Representa uma coleção de objetos de resposta associados ao

comentário.
getResolved() O thread de comentários status. Um valor de true significa que o

thread de comentário foi resolvido.
getRichContent() Obtém o conteúdo de comentários avançados (por exemplo, menções

em comentários). Essa cadeia de caracteres não deve ser exibida para
usuários finais. Seu suplemento só deve usá-lo para analisar conteúdo
de comentários avançados.
setContent(content) O conteúdo do comentário. A cadeia de caracteres é texto simples.
setResolved(resolved) O thread de comentários status. Um valor de true significa que o

thread de comentário foi resolvido.
update Atualizações o conteúdo do comentário com uma cadeia de caracteres

Mentions(contentWith especialmente formatada e uma lista de menções.
Mentions)
Detalhes do método
addCommentReply(content, contentType)
Cria uma resposta de comentário para um comentário.
TypeScript
addCommentReply(
content: CommentRichContent | string,
contentType?: ContentType
): CommentReply;
Parâmetros
content ExcelScript.CommentRichContent | string
O conteúdo do comentário. Isso pode ser uma cadeia de caracteres ou um
CommentRichContent objeto (por exemplo, para comentários com menções).
contentType ExcelScript.ContentType
Opcional. O tipo de conteúdo contido no comentário. O valor padrão é enumerar
ContentType.Plain .
Retornos
ExcelScript.CommentReply
delete()
Exclui o comentário e todas as respostas conectadas.
TypeScript
delete(): void;
Retornos
void
getAuthorEmail()
Obtém o email do autor do comentário.
TypeScript
getAuthorEmail(): string;
Retornos
string
getAuthorName()
Obtém o nome do autor do comentário.
TypeScript
getAuthorName(): string;
Retornos
string
getCommentReply(commentReplyId)
Retorna uma resposta de comentário identificada pela respectiva ID. Se o objeto de
resposta de comentário não existir, esse método retornará undefined .
TypeScript
getCommentReply(commentReplyId: string): CommentReply | undefined;

Parâmetros
commentReplyId string
O identificador da resposta de comentário.
Retornos
ExcelScript.CommentReply | undefined
getContent()
O conteúdo do comentário. A cadeia de caracteres é texto simples.
TypeScript
getContent(): string;
Retornos
string
getContentType()
Obtém o tipo de conteúdo do comentário.
TypeScript
getContentType(): ContentType;
Retornos
getCreationDate()
Obtém o horário de criação do comentário. Retorna null se o comentário foi
convertido de uma nota, já que o comentário não tem uma data de criação.
TypeScript
getCreationDate(): Date;
Retornos
Date
getId()
Especifica o identificador de comentários.
TypeScript
getId(): string;
Retornos
string
getLocation()
Obtém a célula em que esse comentário está localizado.
TypeScript
getLocation(): Range;
Retornos
ExcelScript.Range
getMentions()
Obtém as entidades (por exemplo, pessoas) que são mencionadas nos comentários.
TypeScript
getMentions(): CommentMention[];
Retornos
ExcelScript.CommentMention[]
getReplies()
Representa uma coleção de objetos de resposta associados ao comentário.
TypeScript
getReplies(): CommentReply[];
Retornos
ExcelScript.CommentReply[]
getResolved()
O thread de comentários status. Um valor de true significa que o thread de
comentário foi resolvido.
TypeScript
getResolved(): boolean;
Retornos
boolean
getRichContent()
Obtém o conteúdo de comentários avançados (por exemplo, menções em
comentários). Essa cadeia de caracteres não deve ser exibida para usuários finais. Seu
suplemento só deve usá-lo para analisar conteúdo de comentários avançados.
TypeScript
getRichContent(): string;
Retornos
string
setContent(content)
O conteúdo do comentário. A cadeia de caracteres é texto simples.
TypeScript
setContent(content: string): void;
Parâmetros
content string
Retornos
void
setResolved(resolved)
O thread de comentários status. Um valor de true significa que o thread de
comentário foi resolvido.
TypeScript
setResolved(resolved: boolean): void;
Parâmetros
resolved boolean
Retornos
void
updateMentions(contentWithMentions)
Atualizações o conteúdo do comentário com uma cadeia de caracteres
especialmente formatada e uma lista de menções.
TypeScript
updateMentions(contentWithMentions: CommentRichContent): void;
Parâmetros
contentWithMentions ExcelScript.CommentRichContent
O conteúdo do comentário. Isso contém uma cadeia de caracteres especialmente
formatada e uma lista de menções que serão analisadas na cadeia de caracteres
quando exibidas pelo Excel.
Retornos
void
comentários:
ExcelScript.CommentMention interface
Referência
Pacote: ExcelScript
Representa a entidade mencionada nos comentários.
Comentários
Exemplos
TypeScript
/**
* This sample creates a comment that mentions a specific person.
* That person will get a notification and link to the workbook.
*/
const cell = currentSheet.getCell(0,0);
/* Create a CommentMention object for the comment.

*
* ìd`: The zero-based index of this mention in the comment.
*/
const mention: ExcelScript.CommentMention = {
name: "Alex",
id: 0,
email: "alex@contoso.com"
};
/* Create comment content that uses the mention.

* The `<at id="0">` syntax embeds the mention with ID 0 in the comment
text.
*/
const content: ExcelScript.CommentRichContent = {
richContent: '<at id="0">' + mention.name + "</at> - Hello!",
mentions: [mention]
};
// Add the comment.

currentSheet.addComment(cell, content, ExcelScript.ContentType.mention);
}
Propriedades
email O endereço de email da entidade mencionada em um comentário.
id A ID da entidade. A ID corresponde a uma das IDs em CommentRichContent.richContent .
name O nome da entidade mencionada em um comentário.
email
O endereço de email da entidade mencionada em um comentário.
TypeScript
email: string;
string
id
A ID da entidade. A ID corresponde a uma das IDs em
CommentRichContent.richContent .
TypeScript
id: number;
number
name
O nome da entidade mencionada em um comentário.
TypeScript
name: string;
string
ExcelScript.CommentReply interface
Referência
Pacote: ExcelScript
Representa uma resposta de comentário na pasta de trabalho.
Métodos
delete() Exclui a resposta do comentário.
getAuthorEmail() Obtém o email do autor da resposta do comentário.
getAuthorName() Obtém o nome do autor da resposta do comentário.
getContent() O conteúdo da resposta de comentário. A cadeia de caracteres é texto

simples.
getContentType() O tipo de conteúdo da resposta.
getCreationDate() Obtém o horário de criação da resposta do comentário.
getId() Especifica o identificador de resposta de comentário.
getLocation() Obtém a célula em que essa resposta de comentário está localizada.
getMentions() As entidades (por exemplo, pessoas) mencionadas nos comentários.
getParentComment() Obtém o comentário pai desta resposta.
getResolved() O status da resposta de comentário. Um valor de true significa que a

resposta está no estado resolvido.
getRichContent() O conteúdo de comentários avançados (por exemplo, menciona nos

comentários). Essa cadeia de caracteres não deve ser exibida para
usuários finais. Seu suplemento só deve usá-lo para analisar conteúdo
de comentários avançados.
setContent(content) O conteúdo da resposta de comentário. A cadeia de caracteres é texto

simples.
update Atualizações o conteúdo do comentário com uma cadeia de caracteres

Mentions(contentWith especialmente formatada e uma lista de menções.
Mentions)
Detalhes do método
delete()
Exclui a resposta do comentário.
TypeScript
delete(): void;
Retornos
void
getAuthorEmail()
Obtém o email do autor da resposta do comentário.
TypeScript
getAuthorEmail(): string;
Retornos
string
getAuthorName()
Obtém o nome do autor da resposta do comentário.
TypeScript
getAuthorName(): string;
Retornos
string
getContent()
O conteúdo da resposta de comentário. A cadeia de caracteres é texto simples.
TypeScript
getContent(): string;
Retornos
string
getContentType()
O tipo de conteúdo da resposta.
TypeScript
getContentType(): ContentType;
Retornos
getCreationDate()
Obtém o horário de criação da resposta do comentário.
TypeScript
Retornos
Date
getId()
Especifica o identificador de resposta de comentário.
TypeScript
getId(): string;
Retornos
string
getLocation()
Obtém a célula em que essa resposta de comentário está localizada.
TypeScript
Retornos
ExcelScript.Range
getMentions()
As entidades (por exemplo, pessoas) mencionadas nos comentários.
TypeScript
getMentions(): CommentMention[];
Retornos
getParentComment()
Obtém o comentário pai desta resposta.
TypeScript
getParentComment(): Comment;
Retornos
ExcelScript.Comment
getResolved()
O status da resposta de comentário. Um valor de true significa que a resposta está
no estado resolvido.
TypeScript
getResolved(): boolean;
Retornos
boolean
getRichContent()
O conteúdo de comentários avançados (por exemplo, menciona nos comentários).
Essa cadeia de caracteres não deve ser exibida para usuários finais. Seu suplemento
só deve usá-lo para analisar conteúdo de comentários avançados.
TypeScript
getRichContent(): string;
Retornos
string
setContent(content)
O conteúdo da resposta de comentário. A cadeia de caracteres é texto simples.
TypeScript
setContent(content: string): void;
Parâmetros
content string
Retornos
void
updateMentions(contentWithMentions)
Atualizações o conteúdo do comentário com uma cadeia de caracteres
especialmente formatada e uma lista de menções.
TypeScript
updateMentions(contentWithMentions: CommentRichContent): void;
Parâmetros
contentWithMentions ExcelScript.CommentRichContent
O conteúdo do comentário. Isso contém uma cadeia de caracteres especialmente
formatada e uma lista de menções que serão analisadas na cadeia de caracteres
quando exibidas pelo Excel.
Retornos
void
comentários:
ExcelScript.CommentRichContent
interface
Referência
Pacote: ExcelScript
Representa o conteúdo contido em uma resposta de comentário ou comentário. O

conteúdo rico incude a cadeia de caracteres de texto e quaisquer outros objetos
contidos no corpo do comentário, como menções.
Propriedades
mentions Uma matriz que contém todas as entidades (por exemplo, pessoas) mencionadas no
comentário.
rich Especifica o conteúdo avançado do comentário (por exemplo, conteúdo de

Content comentários com menções, a primeira entidade mencionada tem um atributo de ID
de 0 e a segunda entidade mencionada tem um atributo ID de 1).
mentions
Uma matriz que contém todas as entidades (por exemplo, pessoas) mencionadas no
comentário.
TypeScript
mentions?: CommentMention[];
richContent
Especifica o conteúdo avançado do comentário (por exemplo, conteúdo de
comentários com menções, a primeira entidade mencionada tem um atributo de ID
de 0 e a segunda entidade mencionada tem um atributo ID de 1).
TypeScript
richContent: string;
string
Exemplos
TypeScript
/**
* This sample finds overdue work items in a table and
* lets their owners know with a comment that uses an @mention.
*
* This assumes the worksheet has a table with the columns:
* "Work Item", "Project", "Owner", "Due Date"
*/
// Get the "Owner" column range and values.

let table = currentSheet.getTables()[0];
let ownerColumnRange =
table.getColumn("Owner").getRangeBetweenHeaderAndTotal();
let ownerColumnValues = ownerColumnRange.getValues();
// Get the "Due Date" column range and values.

let dueDateColumnRange = table.getColumn("Due
Date").getRangeBetweenHeaderAndTotal();
let dueDateColumnValues = dueDateColumnRange.getValues();
// Look for overdue work items.

for (let row = 0; row < dueDateColumnValues.length; row++) {
/* Convert the Excel date into a JavaScript date.

* This is necessary because Excel and JavaScript store
* their dates as different numerical values.
*/
let dueDate = new Date(Math.round((dueDateColumnValues[row][0] as
number - 25569) * 86400 * 1000));
// Check if the current date is greater than the due date.

if (Date.now() > dueDate.valueOf()) {
/* Create a CommentMention object for the comment,
* based on the work item's owner.
*
* ìd`: The index of this mention in the comment.
* In this sample, "Owner: is also the user name for the
email.
*/
let mention = {
name: ownerColumnValues[row][0].toString(),
id: 0,
email: ownerColumnValues[row][0] + "@contoso.com"
};
/* Create the comment.

* The `<at id="0">` syntax embeds the mention in the comment text.
*
* The addComment parameters are:
* `cellAddress`: The location of the comment.
* `content`: The text of the comment and any embedded mentions.
* `contentType`: The type of comment ("Mention" or "Plain").
*/
currentSheet.addComment(
dueDateColumnRange.getCell(row, 0),
{
richContent: '<at id="0">' + mention.name + "</at> - Your work
item is overdue.",
mentions: [mention]
},
ExcelScript.ContentType.mention
);
}
}
}
comentários:
ExcelScript.ConditionalCellValueRule
interface
Referência
Pacote: ExcelScript
Representa uma regra de formato condicional de valor celular.
Comentários
Exemplos
TypeScript
/**
font made italic.
*/

e).getCellValue();
and 75.
formula1: "50",
formula2: "75",
};

}
Propriedades
formula1 A fórmula, se necessário, na qual avaliar a regra de formato condicional.
formula2 A fórmula, se necessário, na qual avaliar a regra de formato condicional.
operator O operador do formato condicional de valor celular.
formula1
A fórmula, se necessário, na qual avaliar a regra de formato condicional.
TypeScript
formula1: string;
string
formula2
TypeScript
formula2?: string;
string
operator
O operador do formato condicional de valor celular.
TypeScript
operator: ConditionalCellValueOperator;
ExcelScript.ConditionalCellValueOperator
comentários:
ExcelScript.ConditionalColorScale
Criteria interface
Referência
Pacote: ExcelScript
Representa os critérios da escala de cores.
Propriedades
maximum O ponto máximo do critério de escala de cores.
midpoint O ponto médio do critério de escala de cores, se a escala de cores for uma escala de
três cores.
minimum O ponto mínimo do critério de escala de cores.
maximum
O ponto máximo do critério de escala de cores.
TypeScript
maximum: ConditionalColorScaleCriterion;
ExcelScript.ConditionalColorScaleCriterion
midpoint
O ponto médio do critério de escala de cores, se a escala de cores for uma escala de
três cores.
TypeScript
midpoint?: ConditionalColorScaleCriterion;
minimum
O ponto mínimo do critério de escala de cores.
TypeScript
minimum: ConditionalColorScaleCriterion;
ExcelScript.ConditionalColorScale
Criterion interface
Referência
Pacote: ExcelScript
Representa um critério de escala de cores que contém um tipo, um valor e uma cor.
Propriedades
color Representação de código de cor HTML da cor da escala de cores (por exemplo,
formula Um número, uma fórmula ou null (se type for lowestValue ).
type No que a fórmula condicional do critério deve ser baseada.
color
Representação de código de cor HTML da cor da escala de cores (por exemplo,
TypeScript
color?: string;
string
formula
Um número, uma fórmula ou null (se type for lowestValue ).
TypeScript
formula?: string;
string
type
No que a fórmula condicional do critério deve ser baseada.
TypeScript
type: ConditionalFormatColorCriterionType;
ExcelScript.ConditionalFormatColorCriterionType
ExcelScript.ConditionalDataBarNegative
Format interface
Referência
Pacote: ExcelScript
Representa um formato condicional para o lado negativo da barra de dados.
Métodos
getBorderColor() Código de cor HTML que representa a cor da linha de borda, no

formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML
nomeada (por exemplo, "laranja"). O valor será "" (uma cadeia de
caracteres vazia) se nenhuma borda estiver presente ou definida.
getFillColor() Código de cor HTML que representa a cor de preenchimento, no

nomeada (por exemplo, "laranja").
getMatchPositive Especifica se a barra de dados negativa tem a mesma cor da borda que
BorderColor() a barra de dados positiva.
getMatchPositiveFill Especifica se a barra de dados negativa tem a mesma cor de

Color() preenchimento que a barra de dados positiva.
setBorderColor(border Código de cor HTML que representa a cor da linha de borda, no

Color) formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML
nomeada (por exemplo, "laranja"). O valor será "" (uma cadeia de
caracteres vazia) se nenhuma borda estiver presente ou definida.
setFillColor(fillColor) Código de cor HTML que representa a cor de preenchimento, no

setMatchPositive Especifica se a barra de dados negativa tem a mesma cor da borda que
BorderColor(match a barra de dados positiva.
PositiveBorderColor)
setMatchPositiveFill Especifica se a barra de dados negativa tem a mesma cor de

Color(matchPositiveFill preenchimento que a barra de dados positiva.
Color)
Detalhes do método
getBorderColor()
Código de cor HTML que representa a cor da linha de borda, no formulário
"laranja"). O valor será "" (uma cadeia de caracteres vazia) se nenhuma borda estiver
presente ou definida.
TypeScript
getBorderColor(): string;
Retornos
string
getFillColor()
Código de cor HTML que representa a cor de preenchimento, no formulário
"laranja").
TypeScript
getFillColor(): string;
Retornos
string
getMatchPositiveBorderColor()
Especifica se a barra de dados negativa tem a mesma cor da borda que a barra de
dados positiva.
TypeScript
getMatchPositiveBorderColor(): boolean;
Retornos
boolean
getMatchPositiveFillColor()
Especifica se a barra de dados negativa tem a mesma cor de preenchimento que a
barra de dados positiva.
TypeScript
getMatchPositiveFillColor(): boolean;
Retornos
boolean
setBorderColor(borderColor)
TypeScript
setBorderColor(borderColor: string): void;
Parâmetros
borderColor string
Retornos
void
setFillColor(fillColor)
"laranja").
TypeScript
setFillColor(fillColor: string): void;

Parâmetros
fillColor string
Retornos
void
setMatchPositiveBorderColor(matchPositiveBorderColor)
Especifica se a barra de dados negativa tem a mesma cor da borda que a barra de
dados positiva.
TypeScript
setMatchPositiveBorderColor(matchPositiveBorderColor: boolean): void;
Parâmetros
matchPositiveBorderColor boolean
Retornos
void
setMatchPositiveFillColor(matchPositiveFillColor)
Especifica se a barra de dados negativa tem a mesma cor de preenchimento que a
barra de dados positiva.
TypeScript
setMatchPositiveFillColor(matchPositiveFillColor: boolean): void;
Parâmetros
matchPositiveFillColor boolean
Retornos
void
comentários:
ExcelScript.ConditionalDataBarPositive
Format interface
Referência
Pacote: ExcelScript
Representa um formato condicional para o lado positivo da barra de dados.
Métodos
getBorderColor() Código de cor HTML que representa a cor da linha de borda, no formulário
#RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por
exemplo, "laranja"). O valor será "" (uma cadeia de caracteres vazia) se
nenhuma borda estiver presente ou definida.
getFillColor() Código de cor HTML que representa a cor de preenchimento, no formulário

exemplo, "laranja").
getGradientFill() Especifica se a barra de dados tem um gradiente.
setBorder Código de cor HTML que representa a cor da linha de borda, no formulário
Color(border #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por
Color) exemplo, "laranja"). O valor será "" (uma cadeia de caracteres vazia) se
nenhuma borda estiver presente ou definida.
setFillColor(fill Código de cor HTML que representa a cor de preenchimento, no formulário

Color) #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por
setGradient Especifica se a barra de dados tem um gradiente.

Fill(gradientFill)
Detalhes do método
getBorderColor()
TypeScript
getBorderColor(): string;
Retornos
string
getFillColor()
"laranja").
TypeScript
getFillColor(): string;
Retornos
string
getGradientFill()
Especifica se a barra de dados tem um gradiente.
TypeScript
getGradientFill(): boolean;
Retornos
boolean
setBorderColor(borderColor)
TypeScript
setBorderColor(borderColor: string): void;
Parâmetros
borderColor string
Retornos
void
setFillColor(fillColor)
"laranja").
TypeScript
setFillColor(fillColor: string): void;
Parâmetros
fillColor string
Retornos
void
setGradientFill(gradientFill)
Especifica se a barra de dados tem um gradiente.
TypeScript
setGradientFill(gradientFill: boolean): void;
Parâmetros
gradientFill boolean
Retornos
void
comentários:
ExcelScript.ConditionalDataBarRule
interface
Referência
Pacote: ExcelScript
Representa um tipo de regra para uma barra de dados.
Comentários
Exemplos
TypeScript
/**
range.
*/

const format =
const dataBarFormat: ExcelScript.DataBarConditionalFormat =
format.getDataBar();

formula: "0"
};

formula: "1000"
};
}
Propriedades
formula A fórmula, se necessário, na qual avaliar a regra da barra de dados.
type O tipo de regra para a barra de dados.
formula
A fórmula, se necessário, na qual avaliar a regra da barra de dados.
TypeScript
formula?: string;
string
type
O tipo de regra para a barra de dados.
TypeScript
type: ConditionalFormatRuleType;
ExcelScript.ConditionalFormatRuleType
comentários:
ExcelScript.ConditionalFormat interface
Referência
Pacote: ExcelScript
Um objeto encapsulando o intervalo, o formato, a regra e outras propriedades de um

formato condicional.
Métodos
delete() Exclui esse formato condicional.
getCellValue() Retorna as propriedades de formato condicional de valor celular se o formato

condicional atual for um CellValue tipo.
getColorScale() Retorna as propriedades de formato condicional de escala de cor se o formato

condicional atual for um ColorScale tipo.
getCustom() Retorna as propriedades de formato condicional personalizado se o formato

condicional atual for um tipo personalizado.
getDataBar() Retorna as propriedades da barra de dados se o formato condicional atual for

uma barra de dados.
getIconSet() Retorna as propriedades de formato condicional de conjunto de ícones se o

formato condicional atual for um IconSet tipo.
getId() A prioridade do formato condicional no atual ConditionalFormatCollection .
getPreset() Retorna o formato condicional de critérios predefinidos. Veja

ExcelScript.PresetCriteriaConditionalFormat para obter detalhes.
getPriority() A prioridade (ou índice) na coleção de formato condicional em que esse

formato condicional existe atualmente. Alterar isso também altera as
prioridades de outros formatos condicionais, para permitir uma ordem de
prioridade contígua. Use uma prioridade negativa para começar por trás.
Prioridades maiores que os limites receberão e definirão como a prioridade
máxima (ou mínima, se negativa). Observe também que, se você alterar a
prioridade, precisará buscar novamente uma nova cópia do objeto nesse novo
local de prioridade se quiser fazer mais alterações nele.
getRange() Retorna o intervalo ao qual o formato condicional é aplicado. Se o formato

condicional for aplicado a vários intervalos, esse método retornará undefined .
getRanges() Retorna o RangeAreas , composto por um ou mais intervalos retangulares, aos
quais o formato condicional é aplicado.
getStopIfTrue() Se as condições desse formato condicional forem atendidas, nenhum formato

de prioridade mais baixa terá efeito nessa célula. O valor está null em barras
de dados, conjuntos de ícones e dimensionamentos de cores, pois não há
nenhum conceito para StopIfTrue estes.
getText Retorna as propriedades específicas de formato condicional de texto se o

Comparison() formato condicional atual for um tipo de texto. Por exemplo, para formatar
células que correspondem à palavra "Texto".
getTopBottom() Retorna as propriedades de formato condicional superior/inferior se o formato

condicional atual for um TopBottom tipo. Por exemplo, para formatar os 10% ou
10 itens inferiores.
getType() Um tipo de formato condicional. Somente um pode ser definido por vez.
set A prioridade (ou índice) na coleção de formato condicional em que esse

Priority(priority) formato condicional existe atualmente. Alterar isso também altera as
prioridades de outros formatos condicionais, para permitir uma ordem de
prioridade contígua. Use uma prioridade negativa para começar por trás.
Prioridades maiores que os limites receberão e definirão como a prioridade
máxima (ou mínima, se negativa). Observe também que, se você alterar a
prioridade, precisará buscar novamente uma nova cópia do objeto nesse novo
local de prioridade se quiser fazer mais alterações nele.
setStop Se as condições desse formato condicional forem atendidas, nenhum formato

IfTrue(stop de prioridade mais baixa terá efeito nessa célula. O valor está null em barras
IfTrue) de dados, conjuntos de ícones e dimensionamentos de cores, pois não há
nenhum conceito para StopIfTrue estes.
Detalhes do método
delete()
Exclui esse formato condicional.
TypeScript
delete(): void;
Retornos
void
getCellValue()
Retorna as propriedades de formato condicional de valor celular se o formato
condicional atual for um CellValue tipo.
TypeScript
getCellValue(): CellValueConditionalFormat | undefined;
Retornos
ExcelScript.CellValueConditionalFormat | undefined
Exemplos
TypeScript
/**
* Any value between 50 and 75 will have the cell fill color changed and
the font made italic.
*/

ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellV
alue).getCellValue();
and 75.
formula1: "50",
formula2: "75",
};

}
getColorScale()
Retorna as propriedades de formato condicional de escala de cor se o formato
condicional atual for um ColorScale tipo.
TypeScript
getColorScale(): ColorScaleConditionalFormat | undefined;
Retornos
ExcelScript.ColorScaleConditionalFormat | undefined
Exemplos
TypeScript
/**
range.
*/
// Create a new conditional formatting object by adding one to the

range.
selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colo
rScale);
// Set the colors for the three parts of the scale: minimum, midpoint,
and maximum.
minimum: {
},
midpoint: {
formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percen
tile
},
maximum: {
}
});
}
getCustom()
Retorna as propriedades de formato condicional personalizado se o formato
condicional atual for um tipo personalizado.
TypeScript
getCustom(): CustomConditionalFormat | undefined;
Retornos
ExcelScript.CustomConditionalFormat | undefined
Exemplos
TypeScript
/**
* This script applies a custom conditional formatting to the selected
range.
* A light-green fill is applied to a cell if the value is larger than
the value in the row's previous column.
*/
// Get the selected cells.
// Apply a rule for positive change from the previous column.

let positiveChange =
selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cust
om);
positiveChange.getCustom().getFormat().getFill().setColor("lightgreen");
positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell
(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0,
0).getAddress()}`);
}
getDataBar()
Retorna as propriedades da barra de dados se o formato condicional atual for uma
barra de dados.
TypeScript
getDataBar(): DataBarConditionalFormat | undefined;
Retornos
ExcelScript.DataBarConditionalFormat | undefined
Exemplos
TypeScript
/**
range.
*/

const format =
const dataBarFormat = format.getDataBar();

formula: "0"
};

formula: "1000"
};
}
getIconSet()
Retorna as propriedades de formato condicional de conjunto de ícones se o formato
condicional atual for um IconSet tipo.
TypeScript
getIconSet(): IconSetConditionalFormat | undefined;
Retornos
ExcelScript.IconSetConditionalFormat | undefined
Exemplos
TypeScript
/**
*/

conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTraf
ficLights1);
conditionalFormatting.getIconSet().setCriteria([
{
formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greate
rThanOrEqual,
},
{
formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.great
erThanOrEqual,
{
formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.great
erThanOrEqual,
}]);
}
getId()
A prioridade do formato condicional no atual ConditionalFormatCollection .
TypeScript
getId(): string;
Retornos
string
getPreset()
Retorna o formato condicional de critérios predefinidos. Veja
ExcelScript.PresetCriteriaConditionalFormat para obter detalhes.
TypeScript
getPreset(): PresetCriteriaConditionalFormat | undefined;
Retornos
ExcelScript.PresetCriteriaConditionalFormat | undefined
Exemplos
TypeScript
/**
duplicate value
*/

// Set a rule to apply the conditional format when values are

duplicated in the range.
criterion:
ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
};
}
getPriority()
A prioridade (ou índice) na coleção de formato condicional em que esse formato
condicional existe atualmente. Alterar isso também altera as prioridades de outros
formatos condicionais, para permitir uma ordem de prioridade contígua. Use uma
prioridade negativa para começar por trás. Prioridades maiores que os limites
receberão e definirão como a prioridade máxima (ou mínima, se negativa). Observe
também que, se você alterar a prioridade, precisará buscar novamente uma nova
cópia do objeto nesse novo local de prioridade se quiser fazer mais alterações nele.
TypeScript
getPriority(): number;
Retornos
number
getRange()
Retorna o intervalo ao qual o formato condicional é aplicado. Se o formato
condicional for aplicado a vários intervalos, esse método retornará undefined .
TypeScript
getRange(): Range;
Retornos
ExcelScript.Range
getRanges()
Retorna o RangeAreas , composto por um ou mais intervalos retangulares, aos quais
o formato condicional é aplicado.
TypeScript
getRanges(): RangeAreas;
Retornos
ExcelScript.RangeAreas
getStopIfTrue()
Se as condições desse formato condicional forem atendidas, nenhum formato de
prioridade mais baixa terá efeito nessa célula. O valor está null em barras de dados,
conjuntos de ícones e dimensionamentos de cores, pois não há nenhum conceito
para StopIfTrue estes.
TypeScript
getStopIfTrue(): boolean;
Retornos
boolean
getTextComparison()
Retorna as propriedades específicas de formato condicional de texto se o formato
condicional atual for um tipo de texto. Por exemplo, para formatar células que
correspondem à palavra "Texto".
TypeScript
getTextComparison(): TextConditionalFormat | undefined;

Retornos
ExcelScript.TextConditionalFormat | undefined
Exemplos
TypeScript
/**
worksheet.
* This formatting gives the cells a green fill if they have text
starting with "Excel".
*/

firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.contai
nsText).getTextComparison();

text: "Excel"
};
}
getTopBottom()
Retorna as propriedades de formato condicional superior/inferior se o formato
condicional atual for um TopBottom tipo. Por exemplo, para formatar os 10% ou 10
itens inferiores.
TypeScript
getTopBottom(): TopBottomConditionalFormat | undefined;
Retornos
ExcelScript.TopBottomConditionalFormat | undefined
Exemplos
TypeScript
/**
* This script applies top/bottom conditional formatting to a range.
* The top 2 values in the range will have the cell fill color changed to
green.
*/
const sheet = workbook.getWorksheet("TopBottom");
const dataRange = sheet.getRange("B2:D5");
// Set the fill color to green for the top 2 values in the range.
const topBottomFormat = dataRange.addConditionalFormat(
ExcelScript.ConditionalFormatType.topBottom).getTopBottom();
topBottomFormat.getFormat().getFill().setColor("green");
topBottomFormat.setRule({
rank: 2, /* The numeric threshold. */
type: ExcelScript.ConditionalTopBottomCriterionType.topItems /* The
type of the top/bottom condition. */
});
}
getType()
Um tipo de formato condicional. Somente um pode ser definido por vez.
TypeScript
getType(): ConditionalFormatType;
Retornos
setPriority(priority)
A prioridade (ou índice) na coleção de formato condicional em que esse formato
condicional existe atualmente. Alterar isso também altera as prioridades de outros
formatos condicionais, para permitir uma ordem de prioridade contígua. Use uma
prioridade negativa para começar por trás. Prioridades maiores que os limites
receberão e definirão como a prioridade máxima (ou mínima, se negativa). Observe
também que, se você alterar a prioridade, precisará buscar novamente uma nova
cópia do objeto nesse novo local de prioridade se quiser fazer mais alterações nele.
TypeScript
setPriority(priority: number): void;
Parâmetros
priority number
Retornos
void
setStopIfTrue(stopIfTrue)
Se as condições desse formato condicional forem atendidas, nenhum formato de
prioridade mais baixa terá efeito nessa célula. O valor está null em barras de dados,
conjuntos de ícones e dimensionamentos de cores, pois não há nenhum conceito
para StopIfTrue estes.
TypeScript
setStopIfTrue(stopIfTrue: boolean): void;
Parâmetros
stopIfTrue boolean
Retornos
void
comentários:
ExcelScript.ConditionalFormatRule
interface
Referência
Pacote: ExcelScript
Representa uma regra para todos os pares de regra/formato tradicionais.
Métodos
getFormula() A fórmula, se necessário, na qual avaliar a regra de formato

condicional.
getFormulaLocal() A fórmula, se necessário, na qual avaliar a regra de formato

condicional no idioma do usuário.
setFormula(formula) A fórmula, se necessário, na qual avaliar a regra de formato

condicional.
setFormulaLocal(formula A fórmula, se necessário, na qual avaliar a regra de formato

Local) condicional no idioma do usuário.
Detalhes do método
getFormula()
TypeScript
Retornos
string
getFormulaLocal()
A fórmula, se necessário, na qual avaliar a regra de formato condicional no idioma
do usuário.
TypeScript
getFormulaLocal(): string;
Retornos
string
setFormula(formula)
TypeScript
Parâmetros
formula string
Retornos
void
setFormulaLocal(formulaLocal)
A fórmula, se necessário, na qual avaliar a regra de formato condicional no idioma
do usuário.
TypeScript
setFormulaLocal(formulaLocal: string): void;
Parâmetros
formulaLocal string
Retornos
void
ExcelScript.ConditionalIconCriterion
interface
Referência
Pacote: ExcelScript
Representa um critério de ícone que contém um tipo, um valor, um operador e um

ícone personalizado opcional, se não estiver usando um conjunto de ícones.
Comentários
Exemplos
TypeScript
/**
*/

Lights1);
{
},
{
},
{
}];
}
Propriedades
custom O ícone personalizado para o critério atual, se diferente do conjunto de ícones

Icon padrão, o restante null será retornado.
formula Um número ou uma fórmula, dependendo do tipo.
operator greaterThan ou greaterThanOrEqual para cada um dos tipos de regra para o formato
condicional de ícone.
type No que a fórmula condicional de ícone deve se basear.
customIcon
O ícone personalizado para o critério atual, se diferente do conjunto de ícones
padrão, o restante null será retornado.
TypeScript
customIcon?: Icon;
ExcelScript.Icon
formula
Um número ou uma fórmula, dependendo do tipo.
TypeScript
formula: string;
string
operator
greaterThan ou greaterThanOrEqual para cada um dos tipos de regra para o formato
condicional de ícone.
TypeScript
operator: ConditionalIconCriterionOperator;
ExcelScript.ConditionalIconCriterionOperator
type
No que a fórmula condicional de ícone deve se basear.
TypeScript
type: ConditionalFormatIconRuleType;
ExcelScript.ConditionalFormatIconRuleType
comentários:
ExcelScript.ConditionalPresetCriteria
Rule interface
Referência
Pacote: ExcelScript
Representa a regra de formato condicional de critérios predefinidos.
Comentários
Exemplos
TypeScript
/**
duplicate value
*/


in the range.
};
}
Propriedades
criterion O critério do formato condicional.
criterion
O critério do formato condicional.
TypeScript
criterion: ConditionalFormatPresetCriterion;
ExcelScript.ConditionalFormatPresetCriterion
comentários:
interface
Referência
Pacote: ExcelScript
Representa a borda de um objeto.
Métodos
getColor() Código de cor HTML que representa a cor da linha de borda, no formulário
getSide Valor constante que indica o lado específico da borda. Confira

Index() ExcelScript.ConditionalRangeBorderIndex detalhes.
getStyle() Uma das constantes de estilo de linha especificando o estilo de linha da borda.
Confira ExcelScript.BorderLineStyle detalhes.
set Código de cor HTML que representa a cor da linha de borda, no formulário
Color(color) #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por
set Uma das constantes de estilo de linha especificando o estilo de linha da borda.
Style(style) Confira ExcelScript.BorderLineStyle detalhes.
Detalhes do método
getColor()
"laranja").
TypeScript
getColor(): string;
Retornos
string
getSideIndex()
Valor constante que indica o lado específico da borda. Confira
ExcelScript.ConditionalRangeBorderIndex detalhes.
TypeScript
getSideIndex(): ConditionalRangeBorderIndex;
Retornos
ExcelScript.ConditionalRangeBorderIndex
getStyle()
Uma das constantes de estilo de linha especificando o estilo de linha da borda.
TypeScript
getStyle(): ConditionalRangeBorderLineStyle;
Retornos
ExcelScript.ConditionalRangeBorderLineStyle
setColor(color)
"laranja").
TypeScript
Parâmetros
color string
Retornos
void
setStyle(style)
TypeScript
setStyle(style: ConditionalRangeBorderLineStyle): void;
Parâmetros
style ExcelScript.ConditionalRangeBorderLineStyle
Retornos
void
comentários:
ExcelScript.ConditionalRangeFill
interface
Referência
Pacote: ExcelScript
Representa o plano de fundo de um objeto de intervalo condicional.
Métodos
clear() Redefine o preenchimento.
getColor() Código de cor HTML que representa a cor do preenchimento, no formulário

set Código de cor HTML que representa a cor do preenchimento, no formulário

Color(color) #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por
Detalhes do método
clear()
Redefine o preenchimento.
TypeScript
clear(): void;
Retornos
void
getColor()
Código de cor HTML que representa a cor do preenchimento, no formulário
"laranja").
TypeScript
getColor(): string;
Retornos
string
setColor(color)
Código de cor HTML que representa a cor do preenchimento, no formulário
"laranja").
TypeScript
Parâmetros
color string
Retornos
void
comentários:
interface
Referência
Pacote: ExcelScript
Este objeto representa os atributos de fonte (estilo de fonte, cor etc.) para um objeto.
Métodos
clear() Redefine os formatos de fonte.
getBold() Especifica se a fonte é em negrito.
getColor() Representação de código de cor HTML da cor do texto (por

exemplo, #FF0000 representa Vermelho).
getItalic() Especifica se a fonte é itálica.
getStrikethrough() Especifica o status strikethrough da fonte.
getUnderline() O tipo de sublinhado aplicado à fonte. Confira

ExcelScript.ConditionalRangeFontUnderlineStyle detalhes.
setBold(bold) Especifica se a fonte é em negrito.
setColor(color) Representação de código de cor HTML da cor do texto (por

setItalic(italic) Especifica se a fonte é itálica.
set Especifica o status strikethrough da fonte.

Strikethrough(strikethrough)
setUnderline(underline) O tipo de sublinhado aplicado à fonte. Confira

Detalhes do método
clear()
Redefine os formatos de fonte.
TypeScript
clear(): void;
Retornos
void
getBold()
Especifica se a fonte é em negrito.
TypeScript
getBold(): boolean;
Retornos
boolean
getColor()
TypeScript
getColor(): string;
Retornos
string
getItalic()
Especifica se a fonte é itálica.
TypeScript
Retornos
boolean
getStrikethrough()
Especifica o status strikethrough da fonte.
TypeScript
getStrikethrough(): boolean;
Retornos
boolean
getUnderline()
O tipo de sublinhado aplicado à fonte. Confira
TypeScript
getUnderline(): ConditionalRangeFontUnderlineStyle;
Retornos
ExcelScript.ConditionalRangeFontUnderlineStyle
setBold(bold)
Especifica se a fonte é em negrito.
TypeScript
Parâmetros
bold boolean
Retornos
void
setColor(color)
TypeScript
Parâmetros
color string
Retornos
void
setItalic(italic)
Especifica se a fonte é itálica.
TypeScript
Parâmetros
italic boolean
Retornos
void
setStrikethrough(strikethrough)
Especifica o status strikethrough da fonte.
TypeScript
setStrikethrough(strikethrough: boolean): void;
Parâmetros
strikethrough boolean
Retornos
void
O tipo de sublinhado aplicado à fonte. Confira
TypeScript
setUnderline(underline: ConditionalRangeFontUnderlineStyle): void;
Parâmetros
underline ExcelScript.ConditionalRangeFontUnderlineStyle
Retornos
void
comentários:
interface
Referência
Pacote: ExcelScript
Um objeto de formato encapsulando a fonte, o preenchimento, as bordas e outras

propriedades do intervalo de formatos condicionais.
Métodos
getBorders() Coleção de objetos de borda que se aplicam ao intervalo de formato

condicional geral.
getConditionalRange Obtém um objeto Border usando o respectivo nome.

Border(index)
getConditionalRange Obtém a borda inferior.

BorderBottom()
getConditionalRange Obtém a borda esquerda.

BorderLeft()
getConditionalRange Obtém a borda direita.

BorderRight()
getConditionalRange Obtém a borda superior.

BorderTop()
getFill() Retorna o objeto de preenchimento definido no intervalo de

formato condicional geral.
getFont() Retorna o objeto de fonte definido no intervalo de formato

condicional geral.
getNumberFormat() Representa o código de formato de número do Excel para o

intervalo determinado. Desmarcado se null for passado.
setNumber Representa o código de formato de número do Excel para o

Format(numberFormat) intervalo determinado. Desmarcado se null for passado.
Detalhes do método
getBorders()
Coleção de objetos de borda que se aplicam ao intervalo de formato condicional
geral.
TypeScript
getBorders(): ConditionalRangeBorder[];
Retornos
ExcelScript.ConditionalRangeBorder[]
getConditionalRangeBorder(index)
Obtém um objeto Border usando o respectivo nome.
TypeScript
getConditionalRangeBorder(
index: ConditionalRangeBorderIndex
): ConditionalRangeBorder;
Parâmetros
index ExcelScript.ConditionalRangeBorderIndex
Valor de índice do objeto Border a ser recuperado. Confira
ExcelScript.ConditionalRangeBorderIndex detalhes.
Retornos
getConditionalRangeBorderBottom()
Obtém a borda inferior.
TypeScript
getConditionalRangeBorderBottom(): ConditionalRangeBorder;
Retornos
getConditionalRangeBorderLeft()
Obtém a borda esquerda.
TypeScript
getConditionalRangeBorderLeft(): ConditionalRangeBorder;
Retornos
getConditionalRangeBorderRight()
Obtém a borda direita.
TypeScript
getConditionalRangeBorderRight(): ConditionalRangeBorder;
Retornos
getConditionalRangeBorderTop()
Obtém a borda superior.
TypeScript
getConditionalRangeBorderTop(): ConditionalRangeBorder;
Retornos
getFill()
Retorna o objeto de preenchimento definido no intervalo de formato condicional
geral.
TypeScript
getFill(): ConditionalRangeFill;
Retornos
ExcelScript.ConditionalRangeFill
getFont()
Retorna o objeto de fonte definido no intervalo de formato condicional geral.
TypeScript
getFont(): ConditionalRangeFont;
Retornos
getNumberFormat()
Representa o código de formato de número do Excel para o intervalo determinado.
Desmarcado se null for passado.
TypeScript
Retornos
string
Desmarcado se null for passado.
TypeScript
Parâmetros
numberFormat string
Retornos
void
comentários:
ExcelScript.ConditionalTextComparison
Rule interface
Referência
Pacote: ExcelScript
Representa uma regra de formato condicional de valor celular.
Comentários
Exemplos
TypeScript
/**
worksheet.
with "Excel".
*/


text: "Excel"
};
}
Propriedades
operator O operador do formato condicional de texto.
text O valor de texto do formato condicional.
operator
O operador do formato condicional de texto.
TypeScript
operator: ConditionalTextOperator;
ExcelScript.ConditionalTextOperator
text
O valor de texto do formato condicional.
TypeScript
text: string;
string
comentários:
ExcelScript.ConditionalTopBottomRule
interface
Referência
Pacote: ExcelScript
Representa a regra do formato condicional superior/inferior.
Comentários
Exemplos
TypeScript
/**
* This sample applies conditional formatting to the currently used range in
the worksheet.
* The conditional formatting is a pink fill for the 5 lowest values.
*/
// Get the used range in the worksheet.

// Set the fill color to pink for the lowest 5 values in the range.
let conditionalFormat =
range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
conditionalFormat.getTopBottom().getFormat().getFill().setColor("pink");
conditionalFormat.getTopBottom().setRule({
rank: 5, /* The numerical threshold. */
type: ExcelScript.ConditionalTopBottomCriterionType.bottomItems /* The
});
}
Propriedades
rank A classificação entre 1 e 1000 para classificações numéricas ou 1 e 100 para classificações
percentuais.
type Formatar valores com base na classificação superior ou inferior.
rank
A classificação entre 1 e 1000 para classificações numéricas ou 1 e 100 para
classificações percentuais.
TypeScript
rank: number;
number
type
Formatar valores com base na classificação superior ou inferior.
TypeScript
type: ConditionalTopBottomCriterionType;
ExcelScript.ConditionalTopBottomCriterionType
ExcelScript.CultureInfo interface
Referência
Pacote: ExcelScript
Fornece informações com base nas configurações atuais de cultura do sistema. Isso
inclui os nomes de cultura, a formatação de números e outras configurações
culturalmente dependentes.
Comentários
Exemplos
TypeScript
/**
* This script sets the value of a cell to a date string for January 2,
2023.
* It writes the day or month first in the string based on system settings.
*/
const cell = workbook.getActiveWorksheet().getCell(0,0);
// Get the date format.

const cultureInfo : ExcelScript.CultureInfo =
workbook.getApplication().getCultureInfo();
const systemDateTimeFormat : ExcelScript.DatetimeFormatInfo =
cultureInfo.getDatetimeFormat();
const shortDatePattern : string =
systemDateTimeFormat.getShortDatePattern();
// Determine if the date should start with the month or day.

if (shortDatePattern.startsWith("m")) {
cell.setValue("1/2/2023");
} else {
}
}
Métodos
getDatetime Define o formato culturalmente apropriado de exibir data e hora. Isso se baseia
Format() nas configurações atuais de cultura do sistema.
getName() Obtém o nome da cultura no formato languagecode2-country/regioncode2 (por

exemplo, "zh-cn" ou "en-us"). Isso se baseia nas configurações atuais do sistema.
getNumber Define o formato culturalmente apropriado de exibir números. Isso se baseia nas
Format() configurações atuais de cultura do sistema.
Detalhes do método
getDatetimeFormat()
Define o formato culturalmente apropriado de exibir data e hora. Isso se baseia nas
configurações atuais de cultura do sistema.
TypeScript
getDatetimeFormat(): DatetimeFormatInfo;
Retornos
ExcelScript.DatetimeFormatInfo
getName()
Obtém o nome da cultura no formato languagecode2-country/regioncode2 (por
exemplo, "zh-cn" ou "en-us"). Isso se baseia nas configurações atuais do sistema.
TypeScript
getName(): string;
Retornos
string
getNumberFormat()
Define o formato culturalmente apropriado de exibir números. Isso se baseia nas
TypeScript
getNumberFormat(): NumberFormatInfo;
Retornos
ExcelScript.NumberFormatInfo
comentários:
ExcelScript.CustomConditionalFormat
interface
Referência
Pacote: ExcelScript
Representa um tipo de formato condicional personalizado.
Comentários
Exemplos
TypeScript
/**
* This script applies a custom three-color conditional formatting to the
selected range.
* The three colors represent positive, negative, or no changes from the
values in the previous column.
*/
// Get the selected cells.
// Apply a rule for positive change from the previous column.

let positiveChange =
selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom)
;
positiveChange.getCustom().getFormat().getFill().setColor("lightgreen");
positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0,
0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0,
0).getAddress()}`);
// Apply a rule for negative change from the previous column.

let negativeChange =
;
negativeChange.getCustom().getFormat().getFill().setColor("pink");
negativeChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0,
0).getAddress()}<${selectedRange.getOffsetRange(0, -1).getCell(0,
0).getAddress()}`);
// Apply a rule for no change from the previous column.

let noChange =
;
noChange.getCustom().getFormat().getFill().setColor("lightyellow");
noChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0,
0).getAddress()}=${selectedRange.getOffsetRange(0, -1).getCell(0,
0).getAddress()}`);
}
Métodos

getRule() Especifica o Rule objeto nesse formato condicional.
Detalhes do método
getFormat()
TypeScript
Retornos
getRule()
Especifica o Rule objeto nesse formato condicional.
TypeScript
getRule(): ConditionalFormatRule;
Retornos
ExcelScript.ConditionalFormatRule
comentários:
ExcelScript.CustomDataValidation
interface
Referência
Pacote: ExcelScript
Representa os critérios de validação de dados personalizados.
Propriedades
formula Uma fórmula de validação de dados personalizados. Isso cria regras de entrada
especiais, como impedir duplicatas ou limitar o total em um intervalo de células.
formula
Uma fórmula de validação de dados personalizados. Isso cria regras de entrada
especiais, como impedir duplicatas ou limitar o total em um intervalo de células.
TypeScript
formula: string;
string
ExcelScript.CustomProperty interface
Referência
Pacote: ExcelScript
Representa uma propriedade personalizada.
Métodos
delete() Exclui a propriedade personalizada.
getKey() A chave da propriedade personalizada. A chave é limitada a 255 caracteres fora de

Excel na Web (chaves maiores são cortadas automaticamente para 255 caracteres
em outras plataformas).
getType() O tipo do valor usado para a propriedade personalizada.
getValue() O valor da propriedade personalizada. O valor é limitado a 255 caracteres fora do

Excel na Web (valores maiores são cortados automaticamente para 255 caracteres
set O valor da propriedade personalizada. O valor é limitado a 255 caracteres fora do

Value(value) Excel na Web (valores maiores são cortados automaticamente para 255 caracteres
Detalhes do método
delete()
Exclui a propriedade personalizada.
TypeScript
delete(): void;
Retornos
void
getKey()
A chave da propriedade personalizada. A chave é limitada a 255 caracteres fora de
Excel na Web (chaves maiores são cortadas automaticamente para 255 caracteres em
outras plataformas).
TypeScript
getKey(): string;
Retornos
string
getType()
O tipo do valor usado para a propriedade personalizada.
TypeScript
getType(): DocumentPropertyType;
Retornos
getValue()
O valor da propriedade personalizada. O valor é limitado a 255 caracteres fora do
TypeScript
getValue(): any;
Retornos
any
setValue(value)
O valor da propriedade personalizada. O valor é limitado a 255 caracteres fora do
TypeScript
setValue(value: any): void;
Parâmetros
value any
Retornos
void
comentários:
ExcelScript.CustomXmlPart interface
Referência
Pacote: ExcelScript
Representa um objeto de parte XML personalizado em uma pasta de trabalho.
Métodos
delete() Exclui a parte XML personalizada.
getId() A ID da parte XML personalizada.
getNamespaceUri() URI do namespace da parte XML personalizada.
getXml() Obtém o conteúdo XML completo da parte XML personalizada.
setXml(xml) Define o conteúdo XML completo da parte XML personalizada.
Detalhes do método
delete()
Exclui a parte XML personalizada.
TypeScript
delete(): void;
Retornos
void
getId()
A ID da parte XML personalizada.
TypeScript
getId(): string;
Retornos
string
getNamespaceUri()
URI do namespace da parte XML personalizada.
TypeScript
getNamespaceUri(): string;
Retornos
string
getXml()
Obtém o conteúdo XML completo da parte XML personalizada.
TypeScript
getXml(): string;
Retornos
string
setXml(xml)
Define o conteúdo XML completo da parte XML personalizada.
TypeScript
setXml(xml: string): void;
Parâmetros
xml string
Conteúdo XML para a parte.
Retornos
void
comentários:
ExcelScript.DataBarConditionalFormat
interface
Referência
Pacote: ExcelScript
Representa um tipo de barra de dados condicional do Excel.
Comentários
Exemplos
TypeScript
/**
range.
*/

const format =
const dataBarFormat: ExcelScript.DataBarConditionalFormat =
format.getDataBar();

formula: "0"
};

formula: "1000"
};
}
Métodos
getAxisColor() Código de cor HTML que representa a cor da linha Axis, no formulário
nenhum eixo estiver presente ou definido.
getAxisFormat() Representação de como o eixo é determinado para uma barra de dados do

Excel.
getBarDirection() Especifica a direção na qual o gráfico da barra de dados deve ser baseado.
getLowerBound A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável)
Rule() para uma barra de dados. O ConditionalDataBarRule objeto deve ser
definido como um objeto JSON (use x.lowerBoundRule = {...} em vez de
x.lowerBoundRule.formula = ... ).
getNegative Representação de todos os valores à esquerda do eixo em uma barra de

Format() dados do Excel.
getPositive Representação de todos os valores à direita do eixo em uma barra de dados

Format() do Excel.
getShowDataBar Se true , ocultar os valores das células em que a barra de dados é aplicada.
Only()
getUpperBound A regra para o que constitui o limite superior (e como calculá-lo, se

Rule() aplicável) para uma barra de dados. O ConditionalDataBarRule objeto deve
ser definido como um objeto JSON (use x.upperBoundRule = {...} em vez
de x.upperBoundRule.formula = ... ).
setAxisColor(axis Código de cor HTML que representa a cor da linha Axis, no formulário
Color) #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por
nenhum eixo estiver presente ou definido.
setAxisFormat(axis Representação de como o eixo é determinado para uma barra de dados do

Format) Excel.
setBar Especifica a direção na qual o gráfico da barra de dados deve ser baseado.
Direction(bar
Direction)
setLowerBound A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável)
Rule(lowerBound para uma barra de dados. O ConditionalDataBarRule objeto deve ser
Rule) definido como um objeto JSON (use x.lowerBoundRule = {...} em vez de
x.lowerBoundRule.formula = ... ).
setShowDataBar Se true , ocultar os valores das células em que a barra de dados é aplicada.
Only(showDataBar
Only)
setUpperBound A regra para o que constitui o limite superior (e como calculá-lo, se
Rule(upperBound aplicável) para uma barra de dados. O ConditionalDataBarRule objeto deve
Rule) ser definido como um objeto JSON (use x.upperBoundRule = {...} em vez
de x.upperBoundRule.formula = ... ).
Detalhes do método
getAxisColor()
Código de cor HTML que representa a cor da linha Axis, no formulário #RRGGBB
(por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").
O valor será "" (uma cadeia de caracteres vazia) se nenhum eixo estiver presente ou
definido.
TypeScript
getAxisColor(): string;
Retornos
string
getAxisFormat()
Representação de como o eixo é determinado para uma barra de dados do Excel.
TypeScript
getAxisFormat(): ConditionalDataBarAxisFormat;
Retornos
ExcelScript.ConditionalDataBarAxisFormat
getBarDirection()
Especifica a direção na qual o gráfico da barra de dados deve ser baseado.
TypeScript
getBarDirection(): ConditionalDataBarDirection;
Retornos
ExcelScript.ConditionalDataBarDirection
getLowerBoundRule()
A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável) para
uma barra de dados. O ConditionalDataBarRule objeto deve ser definido como um
objeto JSON (use x.lowerBoundRule = {...} em vez de x.lowerBoundRule.formula =
... ).
TypeScript
getLowerBoundRule(): ConditionalDataBarRule;
Retornos
getNegativeFormat()
Representação de todos os valores à esquerda do eixo em uma barra de dados do
Excel.
TypeScript
getNegativeFormat(): ConditionalDataBarNegativeFormat;
Retornos
ExcelScript.ConditionalDataBarNegativeFormat
getPositiveFormat()
Representação de todos os valores à direita do eixo em uma barra de dados do
Excel.
TypeScript
getPositiveFormat(): ConditionalDataBarPositiveFormat;
Retornos
ExcelScript.ConditionalDataBarPositiveFormat
getShowDataBarOnly()
Se true , ocultar os valores das células em que a barra de dados é aplicada.
TypeScript
getShowDataBarOnly(): boolean;
Retornos
boolean
getUpperBoundRule()
A regra para o que constitui o limite superior (e como calculá-lo, se aplicável) para
objeto JSON (use x.upperBoundRule = {...} em vez de x.upperBoundRule.formula =
... ).
TypeScript
getUpperBoundRule(): ConditionalDataBarRule;
Retornos
setAxisColor(axisColor)
Código de cor HTML que representa a cor da linha Axis, no formulário #RRGGBB
(por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").
O valor será "" (uma cadeia de caracteres vazia) se nenhum eixo estiver presente ou
definido.
TypeScript
setAxisColor(axisColor: string): void;
Parâmetros
axisColor string
Retornos
void
setAxisFormat(axisFormat)
Representação de como o eixo é determinado para uma barra de dados do Excel.
TypeScript
setAxisFormat(axisFormat: ConditionalDataBarAxisFormat): void;
Parâmetros
axisFormat ExcelScript.ConditionalDataBarAxisFormat
Retornos
void
setBarDirection(barDirection)
Especifica a direção na qual o gráfico da barra de dados deve ser baseado.
TypeScript
setBarDirection(barDirection: ConditionalDataBarDirection): void;
Parâmetros
barDirection ExcelScript.ConditionalDataBarDirection
Retornos
void
setLowerBoundRule(lowerBoundRule)
A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável) para
objeto JSON (use x.lowerBoundRule = {...} em vez de x.lowerBoundRule.formula =
... ).
TypeScript
setLowerBoundRule(lowerBoundRule: ConditionalDataBarRule): void;
Parâmetros
lowerBoundRule ExcelScript.ConditionalDataBarRule
Retornos
void
setShowDataBarOnly(showDataBarOnly)
Se true , ocultar os valores das células em que a barra de dados é aplicada.
TypeScript
setShowDataBarOnly(showDataBarOnly: boolean): void;
Parâmetros
showDataBarOnly boolean
Retornos
void
setUpperBoundRule(upperBoundRule)
A regra para o que constitui o limite superior (e como calculá-lo, se aplicável) para
objeto JSON (use x.upperBoundRule = {...} em vez de x.upperBoundRule.formula =
... ).
TypeScript
setUpperBoundRule(upperBoundRule: ConditionalDataBarRule): void;
Parâmetros
upperBoundRule ExcelScript.ConditionalDataBarRule
Retornos
void
comentários:
ExcelScript.DataPivotHierarchy interface
Referência
Pacote: ExcelScript
Representa o Excel DataPivotHierarchy.
Comentários
Exemplos
TypeScript
/**
* This sample sorts the rows of a PivotTable.
*/
// Get an existing PivotTable.
const pivotTable = workbook.getPivotTable("Farm Sales");
// Get the data hierarchy to use as the basis of the sort.

const valueFieldToSortOn: ExcelScript.DataPivotHierarchy =
pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");
// Get the row to sort.

const rowToSort: ExcelScript.RowColumnPivotHierarchy =
pivotTable.getRowHierarchy("Farm");
// Sort the "Farm" row's only field by the values in "Sum of Crates Sold
Wholesale".
rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending,
valueFieldToSortOn);
}
Métodos
getField() Retorna PivotFields associados a DataPivotHierarchy.
getId() ID do DataPivotHierarchy.
getName() Nome da DataPivotHierarchy.
getNumberFormat() Formato de número do DataPivotHierarchy.

getPosition() Posição da DataPivotHierarchy.
getShowAs() Especifica se os dados devem ser mostrados como um cálculo de

resumo específico.
getSummarizeBy() Especifica se todos os itens do DataPivotHierarchy são

mostrados.
setName(name) Nome da DataPivotHierarchy.
setNumberFormat(number Formato de número do DataPivotHierarchy.

Format)
setPosition(position) Posição da DataPivotHierarchy.
setShowAs(showAs) Especifica se os dados devem ser mostrados como um cálculo de

resumo específico.
setSummarizeBy(summarize Especifica se todos os itens do DataPivotHierarchy são

By) mostrados.
setToDefault() Redefina a DataPivotHierarchy para os valores padrão.
Detalhes do método
getField()
Retorna PivotFields associados a DataPivotHierarchy.
TypeScript
getField(): PivotField;
Retornos
ExcelScript.PivotField
getId()
ID do DataPivotHierarchy.
TypeScript
getId(): string;
Retornos
string
getName()
Nome da DataPivotHierarchy.
TypeScript
getName(): string;
Retornos
string
getNumberFormat()
Formato de número do DataPivotHierarchy.
TypeScript
Retornos
string
getPosition()
Posição da DataPivotHierarchy.
TypeScript
getPosition(): number;
Retornos
number
getShowAs()
Especifica se os dados devem ser mostrados como um cálculo de resumo específico.
TypeScript
getShowAs(): ShowAsRule;
Retornos
ExcelScript.ShowAsRule
getSummarizeBy()
Especifica se todos os itens do DataPivotHierarchy são mostrados.
TypeScript
getSummarizeBy(): AggregationFunction;
Retornos
ExcelScript.AggregationFunction
setName(name)
Nome da DataPivotHierarchy.
TypeScript
Parâmetros
name string
Retornos
void
Formato de número do DataPivotHierarchy.
TypeScript
Parâmetros
numberFormat string
Retornos
void
Posição da DataPivotHierarchy.
TypeScript
setPosition(position: number): void;
Parâmetros
position number
Retornos
void
setShowAs(showAs)
Especifica se os dados devem ser mostrados como um cálculo de resumo específico.
TypeScript
setShowAs(showAs: ShowAsRule): void;
Parâmetros
showAs ExcelScript.ShowAsRule
Retornos
void
setSummarizeBy(summarizeBy)
Especifica se todos os itens do DataPivotHierarchy são mostrados.
TypeScript
setSummarizeBy(summarizeBy: AggregationFunction): void;
Parâmetros
summarizeBy ExcelScript.AggregationFunction
Retornos
void
Exemplos
TypeScript
/**
* This script changes how the data in a PivotTable is aggregated.
*/
const pivotTable = workbook.getPivotTables()[0];
// Set the first data hierarchy to summarize with an average value,

instead of a sum.
const dataHierarchy = pivotTable.getDataHierarchies()[0];
dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average);
}
setToDefault()
Redefina a DataPivotHierarchy para os valores padrão.
TypeScript
setToDefault(): void;
Retornos
void
comentários:
ExcelScript.DataValidation interface
Referência
Pacote: ExcelScript
Representa a validação de dados aplicada ao intervalo atual.
Métodos
clear() Desfazer a validação de dados do intervalo atual.
getErrorAlert() Alerta de erro quando o usuário insere dados inválidos.
getIgnoreBlanks() Especifica se a validação de dados será executada em células em branco. O

padrão é true .
getInvalidCells() Retorna um RangeAreas objeto, que compreende um ou mais intervalos

retangulares, com valores de célula inválidos. Se todos os valores de célula
forem válidos, esse método retornará null .
getPrompt() Solicitar quando os usuários selecionarem uma célula.
getRule() Regra de validação de dados que contém diferentes tipos de critérios de

validação de dados.
getType() Tipo da validação de dados, consulte ExcelScript.DataValidationType para

obter detalhes.
getValid() Representa se todos os valores de célula são válidos de acordo com as

regras de validação de dados. Retorna true se todos os valores de célula
forem válidos ou false se todos os valores de célula forem inválidos.
Retorna null se houver valores de célula válidos e inválidos dentro do
intervalo.
setErrorAlert(error Alerta de erro quando o usuário insere dados inválidos.

Alert)
setIgnore Especifica se a validação de dados será executada em células em branco. O

Blanks(ignore padrão é true .
Blanks)
set Solicitar quando os usuários selecionarem uma célula.

Prompt(prompt)
setRule(rule) Regra de validação de dados que contém diferentes tipos de critérios de

Detalhes do método
clear()
Desfazer a validação de dados do intervalo atual.
TypeScript
clear(): void;
Retornos
void
getErrorAlert()
Alerta de erro quando o usuário insere dados inválidos.
TypeScript
getErrorAlert(): DataValidationErrorAlert;
Retornos
ExcelScript.DataValidationErrorAlert
getIgnoreBlanks()
Especifica se a validação de dados será executada em células em branco. O padrão é
true .
TypeScript
getIgnoreBlanks(): boolean;
Retornos
boolean
getInvalidCells()
Retorna um RangeAreas objeto, que compreende um ou mais intervalos
retangulares, com valores de célula inválidos. Se todos os valores de célula forem
válidos, esse método retornará null .
TypeScript
getInvalidCells(): RangeAreas;
Retornos
getPrompt()
Solicitar quando os usuários selecionarem uma célula.
TypeScript
getPrompt(): DataValidationPrompt;
Retornos
ExcelScript.DataValidationPrompt
getRule()
Regra de validação de dados que contém diferentes tipos de critérios de validação
de dados.
TypeScript
getRule(): DataValidationRule;
Retornos
ExcelScript.DataValidationRule
getType()
Tipo da validação de dados, consulte ExcelScript.DataValidationType para obter
detalhes.
TypeScript
getType(): DataValidationType;
Retornos
ExcelScript.DataValidationType
Exemplos
TypeScript
/**
* This sample reads and logs the data validation type of the currently
selected range.
*/
// Get the currently selected range.
// Get the type (`DataValidationType`) of data validation applied to

the range.
let validationType = range.getDataValidation().getType();
/*
* Log the data validation type.
* If the range has a single value, it logs that type.
* If the range doesn't have data validation applied, it logs "None".
* If the range has multiple different types of data validation, it
logs "Inconsistent" or "MixedCriteria".
*/
console.log(validationType.toString());
}
getValid()
Representa se todos os valores de célula são válidos de acordo com as regras de
validação de dados. Retorna true se todos os valores de célula forem válidos ou
false se todos os valores de célula forem inválidos. Retorna null se houver valores
de célula válidos e inválidos dentro do intervalo.
TypeScript
getValid(): boolean;
Retornos
boolean
setErrorAlert(errorAlert)
Alerta de erro quando o usuário insere dados inválidos.
TypeScript
setErrorAlert(errorAlert: DataValidationErrorAlert): void;
Parâmetros
errorAlert ExcelScript.DataValidationErrorAlert
Retornos
void
setIgnoreBlanks(ignoreBlanks)
Especifica se a validação de dados será executada em células em branco. O padrão é
true .
TypeScript
setIgnoreBlanks(ignoreBlanks: boolean): void;
Parâmetros
ignoreBlanks boolean
Retornos
void
setPrompt(prompt)
Solicitar quando os usuários selecionarem uma célula.
TypeScript
setPrompt(prompt: DataValidationPrompt): void;
Parâmetros
prompt ExcelScript.DataValidationPrompt
Retornos
void
Exemplos
TypeScript
/**
* This script creates a text prompt that's shown in C2:C8 when a user
enters the cell.
*/
// Get the data validation object for C2:C8 in the current worksheet.
let dataValidation =
selectedSheet.getRange("C2:C8").getDataValidation();
// Clear any previous validation to avoid conflicts.

dataValidation.clear();
// Create a prompt to remind users to only enter first names in this

column.
dataValidation.setPrompt({
showPrompt: true,
title: "First names only",
message: "Only enter the first name of the employee, not the full
name."
});
}
setRule(rule)
Regra de validação de dados que contém diferentes tipos de critérios de validação
de dados.
TypeScript
setRule(rule: DataValidationRule): void;
Parâmetros
rule ExcelScript.DataValidationRule
Retornos
void
Exemplos
TypeScript
/**
* Attempts to enter other values are blocked and an error message
appears.
*/

formula1: "0",
};
};

const rangeDataValidation =
positiveNumberOnlyCells.getDataValidation();
entered.
showAlert: true,
};
}
comentários:
ExcelScript.DataValidationErrorAlert
interface
Referência
Pacote: ExcelScript
Representa as propriedades de alerta de erro para a validação de dados.
Comentários
Exemplos
TypeScript
/**
*/

formula1: "0",
};
};

entered.
showAlert: true,
};
}
Propriedades
message Representa a mensagem de alerta de erro.
show Especifica se deve mostrar uma caixa de diálogo de alerta de erro quando um usuário
Alert insere dados inválidos. O padrão é true .
style O tipo de alerta de validação de dados, consulte

ExcelScript.DataValidationAlertStyle para obter detalhes.
title Representa o título da caixa de diálogo alerta de erro.
message
Representa a mensagem de alerta de erro.
TypeScript
message: string;
string
showAlert
Especifica se deve mostrar uma caixa de diálogo de alerta de erro quando um
usuário insere dados inválidos. O padrão é true .
TypeScript
showAlert: boolean;
boolean
style
O tipo de alerta de validação de dados, consulte
ExcelScript.DataValidationAlertStyle para obter detalhes.
TypeScript
style: DataValidationAlertStyle;
ExcelScript.DataValidationAlertStyle
title
Representa o título da caixa de diálogo alerta de erro.
TypeScript
title: string;
string
ExcelScript.DataValidationPrompt
interface
Referência
Pacote: ExcelScript
Representa as propriedades de prompt do usuário para a validação de dados.
Comentários
Exemplos
TypeScript
/**
* This script creates a text prompt that's shown in C2:C8 when a user
enters the cell.
*/
// Get the data validation object for C2:C8 in the current worksheet.
let dataValidation =
selectedSheet.getRange("C2:C8").getDataValidation();
// Clear any previous validation to avoid conflicts.

dataValidation.clear();
// Create a prompt to remind users to only enter first names in this

column.
const prompt: ExcelScript.DataValidationPrompt = {
showPrompt: true,
title: "First names only",
message: "Only enter the first name of the employee, not the full
name."
}
dataValidation.setPrompt(prompt);
}
Propriedades
message Especifica a mensagem do prompt.

show Especifica se um prompt é mostrado quando um usuário seleciona uma célula com
Prompt validação de dados.
title Especifica o título do prompt.
message
Especifica a mensagem do prompt.
TypeScript
message: string;
string
showPrompt
Especifica se um prompt é mostrado quando um usuário seleciona uma célula com
TypeScript
showPrompt: boolean;
boolean
title
Especifica o título do prompt.
TypeScript
title: string;
string
comentários:
ExcelScript.DataValidationRule interface
Referência
Pacote: ExcelScript
Uma regra de validação de dados contém diferentes tipos de validação de dados. Você
só pode usar um deles por vez de acordo com o ExcelScript.DataValidationType .
Propriedades
custom Critérios de validação de dados personalizados.
date Critérios de validação de dados de data.
decimal Critérios de validação de dados decimais.
list Critérios de validação de dados da lista.
textLength Critérios de validação de dados de comprimento de texto.
time Critérios de validação de dados de tempo.
wholeNumber Critérios de validação de dados de número inteiro.
custom
Critérios de validação de dados personalizados.
TypeScript
custom?: CustomDataValidation;
ExcelScript.CustomDataValidation
date
Critérios de validação de dados de data.
TypeScript
date?: DateTimeDataValidation;
ExcelScript.DateTimeDataValidation
decimal
Critérios de validação de dados decimais.
TypeScript
decimal?: BasicDataValidation;
ExcelScript.BasicDataValidation
list
Critérios de validação de dados da lista.
TypeScript
list?: ListDataValidation;
ExcelScript.ListDataValidation
Exemplos
TypeScript
/**
* This script creates a dropdown selection list for a cell.
* It uses the existing values of the selected range as the choices for
the list.
*/
// Get the values for data validation.
const selectedRange = workbook.getSelectedRange();
const rangeValues = selectedRange.getValues();
// Convert the values into a comma-delimited string.

let dataValidationListString = "";
rangeValues.forEach((rangeValueRow) => {
rangeValueRow.forEach((value) => {
dataValidationListString += value + ",";
});
});
// Clear the old range.

selectedRange.clear(ExcelScript.ClearApplyTo.contents);
// Apply the data validation to the first cell in the selected range.
const targetCell = selectedRange.getCell(0, 0);
const dataValidation = targetCell.getDataValidation();
// Set the content of the dropdown list.

let validationCriteria : ExcelScript.ListDataValidation = {
inCellDropDown: true,
source: dataValidationListString
};
let validationRule: ExcelScript.DataValidationRule = {
list: validationCriteria
};
dataValidation.setRule(validationRule);
}
textLength
Critérios de validação de dados de comprimento de texto.
TypeScript
textLength?: BasicDataValidation;
time
Critérios de validação de dados de tempo.
TypeScript
time?: DateTimeDataValidation;
wholeNumber
Critérios de validação de dados de número inteiro.
TypeScript
wholeNumber?: BasicDataValidation;
Exemplos
TypeScript
/**
* Attempts to enter other values are blocked and an error message
appears.
*/

formula1: "0",
};
};

const rangeDataValidation =
positiveNumberOnlyCells.getDataValidation();
entered.
showAlert: true,
};
}
comentários:
interface
Referência
Pacote: ExcelScript
Representa os critérios de validação de dados de data.
Comentários
Exemplos
TypeScript
/**
* This script sets a validation rule that only allows for certain dates to
be entered.
*/
// Get the range D2:D6 in the current worksheet.
const selectedSheet = workbook.getActiveWorksheet();
const range = selectedSheet.getRange("D2:D6");
// Set a validation rule to only allow values that are dates in the year
2023.
let dataValidation = range.getDataValidation();
const dateValidationRule: ExcelScript.DateTimeDataValidation = {
formula1: "1/1/2023",
formula2: "12/31/2023",
operator: ExcelScript.DataValidationOperator.between
};
dataValidation.setRule({ date: dateValidationRule});
// Set an appropriate error message.

dataValidation.setErrorAlert({
showAlert: true,
title: "2023 date required",
message: "Please enter a date in the year 2023.",
style: ExcelScript.DataValidationAlertStyle.stop
});
}
Propriedades
formula1 Especifica o operando à direita quando a propriedade do operador é definida como

especifica o operando de limite inferior. Ao definir o valor, ele pode ser passado como
uma Data, um objeto Range ou uma fórmula de cadeia de caracteres (em que a cadeia
de caracteres é uma data/hora com string no formato ISO8601, uma referência de
célula como "=A1" ou uma fórmula como "=MIN(A1, B1)"). Ao recuperar o valor, ele
sempre será retornado como uma fórmula de cadeia de caracteres, por exemplo:
"=10", "=A1", "=SUM(A1:B5)", etc.
formula2 Com os operadores ternários Between e NotBetween, especifica o operando de limite

superior. Não é usado com os operadores binários, como GreaterThan. Ao definir o
valor, ele pode ser passado como uma Data, um objeto Range ou uma cadeia de
caracteres (em que a cadeia de caracteres é uma data/hora com string no formato
ISO8601, uma referência de célula como "=A1" ou uma fórmula como "=MIN(A1,
B1)"). Ao recuperar o valor, ele sempre será retornado como uma fórmula de cadeia
de caracteres, por exemplo: "=10", "=A1", "=SUM(A1:B5)", etc.
operator O operador a ser usado para validar os dados.
formula1
Especifica o operando à direita quando a propriedade do operador é definida como
especifica o operando de limite inferior. Ao definir o valor, ele pode ser passado
como uma Data, um objeto Range ou uma fórmula de cadeia de caracteres (em que
a cadeia de caracteres é uma data/hora com string no formato ISO8601, uma
referência de célula como "=A1" ou uma fórmula como "=MIN(A1, B1)"). Ao
recuperar o valor, ele sempre será retornado como uma fórmula de cadeia de
caracteres, por exemplo: "=10", "=A1", "=SUM(A1:B5)", etc.
TypeScript
formula1: string | Date | Range;
string | Date | ExcelScript.Range
formula2
Com os operadores ternários Between e NotBetween, especifica o operando de
limite superior. Não é usado com os operadores binários, como GreaterThan. Ao
definir o valor, ele pode ser passado como uma Data, um objeto Range ou uma
cadeia de caracteres (em que a cadeia de caracteres é uma data/hora com string no
formato ISO8601, uma referência de célula como "=A1" ou uma fórmula como
"=MIN(A1, B1)"). Ao recuperar o valor, ele sempre será retornado como uma fórmula
de cadeia de caracteres, por exemplo: "=10", "=A1", "=SUM(A1:B5)", etc.
TypeScript
formula2?: string | Date | Range;
string | Date | ExcelScript.Range
operator
O operador a ser usado para validar os dados.
TypeScript
operator: DataValidationOperator;
ExcelScript.DatetimeFormatInfo
interface
Referência
Pacote: ExcelScript

Comentários
Exemplos
TypeScript
/**
* This script sets the value of a cell to a date string for January 2,
2023.
* It writes the day or month first in the string based on system settings.
*/
// Get the date format.

const cultureInfo : ExcelScript.CultureInfo =
workbook.getApplication().getCultureInfo();
const systemDateTimeFormat : ExcelScript.DatetimeFormatInfo =
cultureInfo.getDatetimeFormat();
const shortDatePattern : string =
systemDateTimeFormat.getShortDatePattern();
// Determine if the date should start with the month or day.

if (shortDatePattern.startsWith("m")) {
} else {
}
}
Métodos
getDate Obtém a cadeia de caracteres usada como separador de data. Isso se baseia
Separator() nas configurações atuais do sistema.
getLongDate Obtém a cadeia de caracteres de formato para um valor de data longa. Isso se
Pattern() baseia nas configurações atuais do sistema.
getLongTime Obtém a cadeia de caracteres de formato por um valor de longo tempo. Isso
Pattern() se baseia nas configurações atuais do sistema.
getShortDate Obtém a cadeia de caracteres de formato para um valor de data curta. Isso se
Pattern() baseia nas configurações atuais do sistema.
getTime Obtém a cadeia de caracteres usada como separador de tempo. Isso se baseia
Separator() nas configurações atuais do sistema.
Detalhes do método
getDateSeparator()
Obtém a cadeia de caracteres usada como separador de data. Isso se baseia nas
configurações atuais do sistema.
TypeScript
getDateSeparator(): string;
Retornos
string
Exemplos
TypeScript
/**
* This script writes the current date, month, and year.
* It uses the system's date separator character.
*/
// Get the date separation string.

const cultureInfo = workbook.getApplication().getCultureInfo();
const systemDateTimeFormat = cultureInfo.getDatetimeFormat();
const separator = systemDateTimeFormat.getDateSeparator();
// Get the current date.
const currentDate = new Date(Date.now());
// Write the date using the system's separator character.
cell.setValue(`${currentDate.getMonth()}${separator}${currentDate.getDate
()}${separator}${currentDate.getFullYear()}`);
}
getLongDatePattern()
Obtém a cadeia de caracteres de formato para um valor de data longa. Isso se baseia
nas configurações atuais do sistema.
TypeScript
getLongDatePattern(): string;
Retornos
string
Exemplos
TypeScript
/**
* This script returns the system's long date pattern.
* This could be used in a Power Automate flow to keep date formatting
consistent.
*/
function main(workbook: ExcelScript.Workbook) : string {
const dateTimeInfo = cultureInfo.getDatetimeFormat();
return dateTimeInfo.getLongDatePattern();
}
getLongTimePattern()
Obtém a cadeia de caracteres de formato por um valor de longo tempo. Isso se
baseia nas configurações atuais do sistema.
TypeScript
getLongTimePattern(): string;
Retornos
string
getShortDatePattern()
Obtém a cadeia de caracteres de formato para um valor de data curta. Isso se baseia
nas configurações atuais do sistema.
TypeScript
getShortDatePattern(): string;
Retornos
string
getTimeSeparator()
Obtém a cadeia de caracteres usada como separador de tempo. Isso se baseia nas
TypeScript
getTimeSeparator(): string;
Retornos
string
Exemplos
TypeScript
/**
* This script writes the current hour, minute, and second.
* It uses the system's time separator character.
*/
const cell = workbook.getActiveWorksheet().getCell(0, 0);
// Get the date separation string.

const systemDateTimeFormat = cultureInfo.getDatetimeFormat();
const separator = systemDateTimeFormat.getTimeSeparator();
// Get the current time.

const currentTime = new Date(Date.now());
// Write the date using the system's separator character.
cell.setValue(`${currentTime.getHours()}${separator}${currentTime.getMinu
tes()}${separator}${currentTime.getSeconds()}`);
}
comentários:
ExcelScript.DocumentProperties
interface
Referência
Pacote: ExcelScript
Representa propriedades da pasta de trabalho.
Comentários
Exemplos
TypeScript
/**
* This script creates a new worksheet that displays some of the document
properties.
*/
// Get the document properties.
const properties: ExcelScript.DocumentProperties =
workbook.getProperties();
// Create a new worksheet called "Metadata".

const newWorksheet = workbook.addWorksheet("Metadata");
// Create an array to store the string values of properties to save.

let values: string[][] = [];
values.push(["Creation Date", properties.getCreationDate().toString()]);
values.push(["Author", properties.getAuthor()]);
values.push(["Last Edited By", properties.getLastAuthor()]);
// Set the property values to a range on the new worksheet.

newWorksheet.getRange("A1:B3").setValues(values);
}
Métodos
addCustomProperty(key, Cria uma nova propriedade personalizada ou define uma existente.

value)
deleteAllCustom Exclui todas as propriedades personalizadas nesta coleção.
Properties()
getAuthor() O autor da pasta de trabalho.
getCategory() A categoria da pasta de trabalho.
getComments() Os comentários da pasta de trabalho.
getCompany() A empresa da pasta de trabalho.
getCreationDate() Obtém a data de criação da pasta de trabalho.
getCustom() Obtém a coleção de propriedades personalizadas da pasta de

trabalho.
getCustomProperty(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, esse método retornará undefined .
getKeywords() As palavras-chave da pasta de trabalho.
getLastAuthor() Obtém o último autor da pasta de trabalho.
getManager() O gerente da pasta de trabalho.
getRevisionNumber() Obtém o número de revisão da pasta de trabalho.
getSubject() O assunto da pasta de trabalho.
getTitle() O título da pasta de trabalho.
setAuthor(author) O autor da pasta de trabalho.
setCategory(category) A categoria da pasta de trabalho.
setComments(comments) Os comentários da pasta de trabalho.
setCompany(company) A empresa da pasta de trabalho.
setKeywords(keywords) As palavras-chave da pasta de trabalho.
setManager(manager) O gerente da pasta de trabalho.
setRevision Obtém o número de revisão da pasta de trabalho.

Number(revisionNumber)
setSubject(subject) O assunto da pasta de trabalho.
setTitle(title) O título da pasta de trabalho.

Detalhes do método
addCustomProperty(key, value)
Cria uma nova propriedade personalizada ou define uma existente.
TypeScript
addCustomProperty(key: string, value: any): CustomProperty;
Parâmetros
key string
Obrigatório. A chave da propriedade personalizada, que é insensibilidade de
maiúsculas de minúsculas. A chave é limitada a 255 caracteres fora de Excel na Web
(chaves maiores são cortadas automaticamente para 255 caracteres em outras
plataformas).
value any
Obrigatório. O valor da propriedade personalizada. O valor é limitado a 255
caracteres fora do Excel na Web (valores maiores são cortados automaticamente
para 255 caracteres em outras plataformas).
Retornos
ExcelScript.CustomProperty
Exemplos
TypeScript
/**
* This script adds a workbook-level custom property.
*/
// Get the property collection.
// Add a new property called "Project" with the value "FA".

properties.addCustomProperty("Project", "FA");
}
deleteAllCustomProperties()
Exclui todas as propriedades personalizadas nesta coleção.
TypeScript
deleteAllCustomProperties(): void;
Retornos
void
getAuthor()
O autor da pasta de trabalho.
TypeScript
getAuthor(): string;
Retornos
string
getCategory()
A categoria da pasta de trabalho.
TypeScript
getCategory(): string;
Retornos
string
getComments()
Os comentários da pasta de trabalho.
TypeScript
getComments(): string;
Retornos
string
getCompany()
A empresa da pasta de trabalho.
TypeScript
getCompany(): string;
Retornos
string
getCreationDate()
Obtém a data de criação da pasta de trabalho.
TypeScript
Retornos
Date
getCustom()
Obtém a coleção de propriedades personalizadas da pasta de trabalho.
TypeScript
getCustom(): CustomProperty[];
Retornos
ExcelScript.CustomProperty[]
getCustomProperty(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, esse método
TypeScript
getCustomProperty(key: string): CustomProperty | undefined;
Parâmetros
key string
Obrigatório. A chave que identifica o objeto de propriedade personalizado.
Retornos
ExcelScript.CustomProperty | undefined
Exemplos
TypeScript
/**
* This script gets a workbook-level custom property called "Project".
*/
// Get the property collection.
// Get the "Project" property.

const project = properties.getCustomProperty("Project");
// Show the property value in the console.

console.log(project.getValue());
}
getKeywords()
As palavras-chave da pasta de trabalho.
TypeScript
getKeywords(): string;
Retornos
string
getLastAuthor()
Obtém o último autor da pasta de trabalho.
TypeScript
getLastAuthor(): string;
Retornos
string
getManager()
O gerente da pasta de trabalho.
TypeScript
getManager(): string;
Retornos
string
getRevisionNumber()
Obtém o número de revisão da pasta de trabalho.
TypeScript
getRevisionNumber(): number;
Retornos
number
getSubject()
O assunto da pasta de trabalho.
TypeScript
getSubject(): string;
Retornos
string
getTitle()
O título da pasta de trabalho.
TypeScript
getTitle(): string;
Retornos
string
setAuthor(author)
O autor da pasta de trabalho.
TypeScript
setAuthor(author: string): void;
Parâmetros
author string
Retornos
void
setCategory(category)
A categoria da pasta de trabalho.
TypeScript
setCategory(category: string): void;
Parâmetros
category string
Retornos
void
setComments(comments)
Os comentários da pasta de trabalho.
TypeScript
setComments(comments: string): void;
Parâmetros
comments string
Retornos
void
setCompany(company)
A empresa da pasta de trabalho.
TypeScript
setCompany(company: string): void;
Parâmetros
company string
Retornos
void
setKeywords(keywords)
As palavras-chave da pasta de trabalho.
TypeScript
setKeywords(keywords: string): void;
Parâmetros
keywords string
Retornos
void
setManager(manager)
O gerente da pasta de trabalho.
TypeScript
setManager(manager: string): void;
Parâmetros
manager string
Retornos
void
setRevisionNumber(revisionNumber)
Obtém o número de revisão da pasta de trabalho.
TypeScript
setRevisionNumber(revisionNumber: number): void;
Parâmetros
revisionNumber number
Retornos
void
setSubject(subject)
O assunto da pasta de trabalho.
TypeScript
setSubject(subject: string): void;
Parâmetros
subject string
Retornos
void
setTitle(title)
O título da pasta de trabalho.
TypeScript
setTitle(title: string): void;
Parâmetros
title string
Retornos
void
comentários:
ExcelScript.Filter interface
Referência
Pacote: ExcelScript
Gerencia a filtragem da coluna de uma tabela.
Comentários
Exemplos
TypeScript
/**
* This script adds a table filter to only show the top 10% of values
* belonging to a particular column.
*/
// Get the filter for the "PageViews" table column.

const pageViewFilter : ExcelScript.Filter =
table.getColumnByName("PageViews").getFilter();
// Apply a filter to only show the rows in the top 10% of values in this
column.
pageViewFilter.applyTopPercentFilter(10);
}
Métodos
apply(criteria) Aplica os critérios de filtro determinados à coluna fornecida.
applyBottomItemsFilter(count) Aplica um filtro "Item Inferior" à coluna para obter o número de

elementos fornecido.
applyBottomPercent Aplica um filtro "Percentual Inferior" à coluna para obter a

Filter(percent) porcentagem de elementos fornecida.
applyCellColorFilter(color) Aplica um filtro "Cor da Célula" à coluna para obter a cor

fornecida.
applyCustomFilter(criteria1, Aplique um filtro "Ícone" à coluna para as cadeias de caracteres
criteria2, oper) de critérios fornecidas.
applyDynamicFilter(criteria) Aplica um filtro "Dinâmico" à coluna.
applyFontColorFilter(color) Aplica um filtro "Cor da Fonte" à coluna para obter a cor

fornecida.
applyIconFilter(icon) Aplique um filtro "Ícone" à coluna para o ícone determinado.
applyTopItemsFilter(count) Aplica um filtro "Item Superior" à coluna para obter o número

de elementos fornecido.
applyTopPercentFilter(percent) Aplica um filtro "Percentual Superior" à coluna para obter a

porcentagem de elementos fornecida.
applyValuesFilter(values) Aplica um filtro "Valores" à coluna para obter os valores

fornecidos.
clear() Limpa o filtro na coluna fornecida.
getCriteria() O filtro aplicado no momento à coluna fornecida.
Detalhes do método
apply(criteria)
Aplica os critérios de filtro determinados à coluna fornecida.
TypeScript
apply(criteria: FilterCriteria): void;
Parâmetros
criteria ExcelScript.FilterCriteria
O critério a ser aplicado.
Retornos
void
applyBottomItemsFilter(count)
Aplica um filtro "Item Inferior" à coluna para obter o número de elementos
fornecido.
TypeScript
applyBottomItemsFilter(count: number): void;
Parâmetros
count number
O número de elementos da parte inferior a serem mostrados.
Retornos
void
applyBottomPercentFilter(percent)
Aplica um filtro "Percentual Inferior" à coluna para obter a porcentagem de
elementos fornecida.
TypeScript
applyBottomPercentFilter(percent: number): void;
Parâmetros
percent number
A porcentagem de elementos da parte inferior a serem mostrados.
Retornos
void
applyCellColorFilter(color)
Aplica um filtro "Cor da Célula" à coluna para obter a cor fornecida.
TypeScript
applyCellColorFilter(color: string): void;

Parâmetros
color string
A cor de tela de fundo das células a serem mostradas.
Retornos
void
applyCustomFilter(criteria1, criteria2, oper)

Aplique um filtro "Ícone" à coluna para as cadeias de caracteres de critérios
fornecidas.
TypeScript
applyCustomFilter(
criteria1: string,
criteria2?: string,
oper?: FilterOperator
): void;
Parâmetros
criteria1 string
A primeira cadeia de caracteres de critérios.
criteria2 string
Opcional. A segunda cadeia de caracteres de critérios.
oper ExcelScript.FilterOperator
Opcional. O operador que descreve como os dois critérios são unidos.
Retornos
void
Exemplos
TypeScript
/**
* The script filters rows from a table based on numerical values.
*/
// Filter to only show rows with values in the "Sales" column that are
// greater than or equal to 2000.
table.getColumnByName("Sales").getFilter().applyCustomFilter(">=2000");
}
applyDynamicFilter(criteria)
Aplica um filtro "Dinâmico" à coluna.
TypeScript
applyDynamicFilter(criteria: DynamicFilterCriteria): void;
Parâmetros
criteria ExcelScript.DynamicFilterCriteria
O critério dinâmico a ser aplicado.
Retornos
void
Exemplos
TypeScript
/**
* This script applies a filter to a table that filters it
* to only show rows with dates from the previous month.
*/
// Get the table named "ReportTable".
const table = workbook.getTable("ReportTable");
// Get the column with the header "Date".

const dateColumn = table.getColumnByName("Date");
// Apply a dynamic filter to the column.

// `lastMonth` will only show rows with a date from the previous month.
dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriter
ia.lastMonth);
}
applyFontColorFilter(color)
Aplica um filtro "Cor da Fonte" à coluna para obter a cor fornecida.
TypeScript
applyFontColorFilter(color: string): void;
Parâmetros
color string
A cor da fonte das células a serem mostradas.
Retornos
void
applyIconFilter(icon)
Aplique um filtro "Ícone" à coluna para o ícone determinado.
TypeScript
applyIconFilter(icon: Icon): void;
Parâmetros
icon ExcelScript.Icon
Os ícones das células a serem mostrados.
Retornos
void
applyTopItemsFilter(count)
Aplica um filtro "Item Superior" à coluna para obter o número de elementos
fornecido.
TypeScript
applyTopItemsFilter(count: number): void;
Parâmetros
count number
O número de elementos da parte superior a serem mostrados.
Retornos
void
applyTopPercentFilter(percent)
Aplica um filtro "Percentual Superior" à coluna para obter a porcentagem de
elementos fornecida.
TypeScript
applyTopPercentFilter(percent: number): void;
Parâmetros
percent number
A porcentagem de elementos da parte superior a serem mostrados.
Retornos
void
applyValuesFilter(values)
Aplica um filtro "Valores" à coluna para obter os valores fornecidos.
TypeScript
applyValuesFilter(values: Array<string | FilterDatetime>): void;
Parâmetros
values Array<string | ExcelScript.FilterDatetime>
A lista de valores a serem mostrados. Isso deve ser uma matriz de cadeias de
caracteres ou uma matriz de ExcelScript.FilterDateTime objetos.
Retornos
void
Exemplos
TypeScript
/**
* This script applies a filter to a table so that it only shows rows
with "Needs Review" in the "Type" column.
*/
// Get the first table in the workbook.
const table = workbook.getTables()[0];
// Apply the filter to the "Type" column.

const typeColumn = table.getColumnByName("Type");
typeColumn.getFilter().applyValuesFilter(["Needs Review"]);
}
clear()
Limpa o filtro na coluna fornecida.
TypeScript
clear(): void;
Retornos
void
getCriteria()
O filtro aplicado no momento à coluna fornecida.
TypeScript
getCriteria(): FilterCriteria;
Retornos
ExcelScript.FilterCriteria
comentários:
ExcelScript.FilterCriteria interface
Referência
Pacote: ExcelScript
Representa os critérios de filtragem aplicados a uma coluna.
Propriedades
color A cadeia HTML de cor usada para filtrar células. Usado com cellColor e fontColor
filtragem.
criterion1 O primeiro critério usado para filtrar os dados. Usado como operador no caso de
custom filtragem. Por exemplo, ">50" para números maiores que 50 ou "=*s" para
valores que terminam em "s".
Usado como um número no caso de itens/percentuais superiores/inferiores (por

exemplo, "5" para os 5 itens superiores se filterOn estiver definido como
topItems ).
criterion2 O segundo critério usado para filtrar os dados. Usado apenas como operador no
caso de custom filtragem.
dynamic Os critérios dinâmicos do ExcelScript.DynamicFilterCriteria conjunto a ser

Criteria aplicado nesta coluna. Usado com dynamic filtragem.
filterOn A propriedade usada pelo filtro para determinar se os valores devem ficar visíveis.
icon O ícone usado para filtrar células. Usado com icon filtragem.
operator O operador usado para combinar o critério 1 e 2 ao usar custom a filtragem.
subField A propriedade usada pelo filtro para fazer um filtro rico em valores ricos.
values O conjunto de valores a serem usados como parte da values filtragem.
color
A cadeia HTML de cor usada para filtrar células. Usado com cellColor e fontColor
filtragem.
TypeScript
color?: string;
string
criterion1
O primeiro critério usado para filtrar os dados. Usado como operador no caso de
custom filtragem. Por exemplo, ">50" para números maiores que 50 ou "=*s" para
valores que terminam em "s".
Usado como um número no caso de itens/percentuais superiores/inferiores (por

exemplo, "5" para os 5 itens superiores se filterOn estiver definido como topItems ).
TypeScript
criterion1?: string;
string
Exemplos
TypeScript
/**
* 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 C in the lowest 10 values
* (of column C values).
*/
// Add a filter that will only show the rows with the lowest 10 values
in column C
// (index 2, assuming the used range spans from at least A:C).
criterion1: "10",
filterOn: ExcelScript.FilterOn.bottomItems
};
currentSheet.getAutoFilter().apply(dataRange, 2, filterCriteria);
}
criterion2
O segundo critério usado para filtrar os dados. Usado apenas como operador no
caso de custom filtragem.
TypeScript
criterion2?: string;
string
Exemplos
TypeScript
/**
* This script applies a filter to a table so that it only shows rows
with "Needs Review" in the "Type" column.
*/
// Apply the filter to the "Type" column.

const typeColumn = table.getColumnByName("Type");
typeColumn.getFilter().applyValuesFilter(["Needs Review"]);
}
dynamicCriteria
Os critérios dinâmicos do ExcelScript.DynamicFilterCriteria conjunto a ser
aplicado nesta coluna. Usado com dynamic filtragem.
TypeScript
dynamicCriteria?: DynamicFilterCriteria;
ExcelScript.DynamicFilterCriteria
filterOn
A propriedade usada pelo filtro para determinar se os valores devem ficar visíveis.
TypeScript
filterOn: FilterOn;
ExcelScript.FilterOn
icon
O ícone usado para filtrar células. Usado com icon filtragem.
TypeScript
icon?: Icon;
ExcelScript.Icon
operator
O operador usado para combinar o critério 1 e 2 ao usar custom a filtragem.
TypeScript
operator?: FilterOperator;
ExcelScript.FilterOperator
subField
A propriedade usada pelo filtro para fazer um filtro rico em valores ricos.
TypeScript
subField?: string;
string
values
O conjunto de valores a serem usados como parte da values filtragem.
TypeScript
values?: Array<string | FilterDatetime>;
Array<string | ExcelScript.FilterDatetime>
comentários:
ExcelScript.FilterDatetime interface
Referência
Pacote: ExcelScript
Indica como filtrar uma data ao filtrar valores.
Comentários
Exemplos
TypeScript
/**
*/

date: "2022-06-20",
};
date: "2022-07-10",
};

dateFilter: {
}
});
}
Propriedades
date A data no formato ISO8601 usada para filtrar os dados.
specificity Como a data específica deve ser usada para manter os dados. Por exemplo, se a data
for 2005-04-02 e a especificidade for definida como "mês", a operação de filtro
manterá todas as linhas com uma data no mês de abril de 2005.
date
A data no formato ISO8601 usada para filtrar os dados.
TypeScript
date: string;
string
specificity
Como a data específica deve ser usada para manter os dados. Por exemplo, se a data
for 2005-04-02 e a especificidade for definida como "mês", a operação de filtro
manterá todas as linhas com uma data no mês de abril de 2005.
TypeScript
specificity: FilterDatetimeSpecificity;
ExcelScript.FilterPivotHierarchy interface
Referência
Pacote: ExcelScript
Representa o Excel FilterPivotHierarchy.
Métodos
getEnableMultipleFilterItems() Determina se deseja permitir vários itens de filtro.
getFields() Retorna PivotFields associados a FilterPivotHierarchy.
getId() ID do FilterPivotHierarchy.
getName() Nome do FilterPivotHierarchy.
getPivotField(name) Obtém um PivotField pelo nome. Se o PivotField não

existir, esse método retornará undefined .
getPosition() Posição do FilterPivotHierarchy.
setEnableMultipleFilterItems(enable Determina se deseja permitir vários itens de filtro.

MultipleFilterItems)
setName(name) Nome do FilterPivotHierarchy.
setPosition(position) Posição do FilterPivotHierarchy.
setToDefault() Redefina a FilterPivotHierarchy para os valores padrão.
Detalhes do método
getEnableMultipleFilterItems()
Determina se deseja permitir vários itens de filtro.
TypeScript
getEnableMultipleFilterItems(): boolean;
Retornos
boolean
getFields()
Retorna PivotFields associados a FilterPivotHierarchy.
TypeScript
getFields(): PivotField[];
Retornos
ExcelScript.PivotField[]
getId()
ID do FilterPivotHierarchy.
TypeScript
getId(): string;
Retornos
string
getName()
Nome do FilterPivotHierarchy.
TypeScript
getName(): string;
Retornos
string
getPivotField(name)
Obtém um PivotField pelo nome. Se o PivotField não existir, esse método retornará
undefined .
TypeScript
getPivotField(name: string): PivotField | undefined;
Parâmetros
name string
Nome do PivotField a ser recuperado.
Retornos
ExcelScript.PivotField | undefined
getPosition()
Posição do FilterPivotHierarchy.
TypeScript
Retornos
number
setEnableMultipleFilterItems(enableMultipleFilterItems)
Determina se deseja permitir vários itens de filtro.
TypeScript
setEnableMultipleFilterItems(enableMultipleFilterItems: boolean): void;
Parâmetros
enableMultipleFilterItems boolean
Retornos
void
setName(name)
Nome do FilterPivotHierarchy.
TypeScript
Parâmetros
name string
Retornos
void
Posição do FilterPivotHierarchy.
TypeScript
Parâmetros
position number
Retornos
void
setToDefault()
Redefina a FilterPivotHierarchy para os valores padrão.
TypeScript
Retornos
void
comentários:
ExcelScript.FormatProtection interface
Referência
Pacote: ExcelScript
Representa a proteção de formatação de um objeto range.
Métodos
getFormulaHidden() Especifica se o Excel oculta a fórmula das células no intervalo. Um null

valor indica que todo o intervalo não tem uma configuração oculta de
fórmula uniforme.
getLocked() Especifica se o Excel bloqueia as células no objeto. Um null valor indica

que todo o intervalo não tem uma configuração de bloqueio uniforme.
setFormula Especifica se o Excel oculta a fórmula das células no intervalo. Um null

Hidden(formula valor indica que todo o intervalo não tem uma configuração oculta de
Hidden) fórmula uniforme.
setLocked(locked) Especifica se o Excel bloqueia as células no objeto. Um null valor indica

que todo o intervalo não tem uma configuração de bloqueio uniforme.
Detalhes do método
getFormulaHidden()
Especifica se o Excel oculta a fórmula das células no intervalo. Um null valor indica
que todo o intervalo não tem uma configuração oculta de fórmula uniforme.
TypeScript
getFormulaHidden(): boolean;
Retornos
boolean
getLocked()
Especifica se o Excel bloqueia as células no objeto. Um null valor indica que todo o
intervalo não tem uma configuração de bloqueio uniforme.
TypeScript
getLocked(): boolean;
Retornos
boolean
setFormulaHidden(formulaHidden)
Especifica se o Excel oculta a fórmula das células no intervalo. Um null valor indica
que todo o intervalo não tem uma configuração oculta de fórmula uniforme.
TypeScript
setFormulaHidden(formulaHidden: boolean): void;
Parâmetros
formulaHidden boolean
Retornos
void
setLocked(locked)
Especifica se o Excel bloqueia as células no objeto. Um null valor indica que todo o
intervalo não tem uma configuração de bloqueio uniforme.
TypeScript
setLocked(locked: boolean): void;
Parâmetros
locked boolean
Retornos
void
comentários:
ExcelScript.GeometricShape interface
Referência
Pacote: ExcelScript
Representa uma forma geométrica dentro de uma planilha. Uma forma geométrica
pode ser um retângulo, seta de bloco, símbolo de equação, item de fluxograma, estrela,
faixa, chamada ou qualquer outra forma básica no Excel.
Métodos
getId() Retorna o identificador de forma.
Detalhes do método
getId()
Retorna o identificador de forma.
TypeScript
getId(): string;
Retornos
string
comentários:
ExcelScript.HeaderFooter interface
Referência
Pacote: ExcelScript
Métodos
getCenter O rodapé central da planilha. Para aplicar a formatação de fonte ou inserir um

Footer() valor variável, use códigos de formato especificados aqui:
https://msdn.microsoft.com/library/bb225426.aspx .
getCenter O cabeçalho central da planilha. Para aplicar a formatação de fonte ou inserir

Header() um valor variável, use códigos de formato especificados aqui:
getLeftFooter() O rodapé esquerdo da planilha. Para aplicar a formatação de fonte ou inserir

um valor variável, use códigos de formato especificados aqui:
getLeftHeader() O cabeçalho esquerdo da planilha. Para aplicar a formatação de fonte ou

inserir um valor variável, use códigos de formato especificados aqui:
getRightFooter() O rodapé direito da planilha. Para aplicar a formatação de fonte ou inserir um

valor variável, use códigos de formato especificados aqui:
getRightHeader() O cabeçalho direito da planilha. Para aplicar a formatação de fonte ou inserir

um valor variável, use códigos de formato especificados aqui:
setCenter O rodapé central da planilha. Para aplicar a formatação de fonte ou inserir um

Footer(center valor variável, use códigos de formato especificados aqui:
Footer) https://msdn.microsoft.com/library/bb225426.aspx .
setCenter O cabeçalho central da planilha. Para aplicar a formatação de fonte ou inserir

Header(center um valor variável, use códigos de formato especificados aqui:
Header) https://msdn.microsoft.com/library/bb225426.aspx .
setLeftFooter(left O rodapé esquerdo da planilha. Para aplicar a formatação de fonte ou inserir

Footer) um valor variável, use códigos de formato especificados aqui:
setLeft O cabeçalho esquerdo da planilha. Para aplicar a formatação de fonte ou

Header(left inserir um valor variável, use códigos de formato especificados aqui:
setRight O rodapé direito da planilha. Para aplicar a formatação de fonte ou inserir um
Footer(right valor variável, use códigos de formato especificados aqui:
Footer) https://msdn.microsoft.com/library/bb225426.aspx .
setRight O cabeçalho direito da planilha. Para aplicar a formatação de fonte ou inserir

Header(right um valor variável, use códigos de formato especificados aqui:
Detalhes do método
getCenterFooter()
O rodapé central da planilha. Para aplicar a formatação de fonte ou inserir um valor
variável, use códigos de formato especificados aqui:
TypeScript
getCenterFooter(): string;
Retornos
string
getCenterHeader()
O cabeçalho central da planilha. Para aplicar a formatação de fonte ou inserir um
TypeScript
getCenterHeader(): string;
Retornos
string
getLeftFooter()
O rodapé esquerdo da planilha. Para aplicar a formatação de fonte ou inserir um
TypeScript
getLeftFooter(): string;
Retornos
string
getLeftHeader()
O cabeçalho esquerdo da planilha. Para aplicar a formatação de fonte ou inserir um
TypeScript
getLeftHeader(): string;
Retornos
string
getRightFooter()
O rodapé direito da planilha. Para aplicar a formatação de fonte ou inserir um valor
TypeScript
getRightFooter(): string;
Retornos
string
getRightHeader()
O cabeçalho direito da planilha. Para aplicar a formatação de fonte ou inserir um
TypeScript
getRightHeader(): string;
Retornos
string
setCenterFooter(centerFooter)
O rodapé central da planilha. Para aplicar a formatação de fonte ou inserir um valor
TypeScript
setCenterFooter(centerFooter: string): void;
Parâmetros
centerFooter string
Retornos
void
setCenterHeader(centerHeader)
O cabeçalho central da planilha. Para aplicar a formatação de fonte ou inserir um
TypeScript
setCenterHeader(centerHeader: string): void;
Parâmetros
centerHeader string
Retornos
void
setLeftFooter(leftFooter)
O rodapé esquerdo da planilha. Para aplicar a formatação de fonte ou inserir um
TypeScript
setLeftFooter(leftFooter: string): void;
Parâmetros
leftFooter string
Retornos
void
setLeftHeader(leftHeader)
O cabeçalho esquerdo da planilha. Para aplicar a formatação de fonte ou inserir um
TypeScript
setLeftHeader(leftHeader: string): void;
Parâmetros
leftHeader string
Retornos
void
setRightFooter(rightFooter)
O rodapé direito da planilha. Para aplicar a formatação de fonte ou inserir um valor
TypeScript
setRightFooter(rightFooter: string): void;
Parâmetros
rightFooter string
Retornos
void
setRightHeader(rightHeader)
O cabeçalho direito da planilha. Para aplicar a formatação de fonte ou inserir um
TypeScript
setRightHeader(rightHeader: string): void;
Parâmetros
rightHeader string
Retornos
void
interface
Referência
Pacote: ExcelScript
Métodos
getDefaultForAll O cabeçalho/rodapé geral, usado em todas as páginas, a menos que seja

Pages() especificada a página par/ímpar ou a primeira página.
getEvenPages() O cabeçalho/rodapé a ser usado para páginas pares, o cabeçalho/rodapé

ímpar deve ser especificado para páginas ímpares.
getFirstPage() O cabeçalho/rodapé da primeira página. Para todas as outras páginas, geral

ou par/ímpar é usado.
getOddPages() O cabeçalho/rodapé a ser usado para páginas ímpares, o cabeçalho/rodapé

par deve ser especificado para páginas pares.
getState() O estado pelo qual cabeçalhos/rodapés são definidos. Confira

ExcelScript.HeaderFooterState detalhes.
getUseSheet Obtém ou define um sinalizador indicando se os cabeçalhos/rodapés estão

Margins() alinhados com as margens da página que foram definidas nas opções de
layout de página da planilha.
getUseSheetScale() Obtém ou define um sinalizador que indica se os cabeçalhos/rodapés

devem ser dimensionados pela escala de porcentagem da página definida
nas opções de layout de página da planilha.
setState(state) O estado pelo qual cabeçalhos/rodapés são definidos. Confira

setUseSheet Obtém ou define um sinalizador indicando se os cabeçalhos/rodapés estão

Margins(useSheet alinhados com as margens da página que foram definidas nas opções de
Margins) layout de página da planilha.
setUseSheet Obtém ou define um sinalizador que indica se os cabeçalhos/rodapés

Scale(useSheet devem ser dimensionados pela escala de porcentagem da página definida
Scale) nas opções de layout de página da planilha.
Detalhes do método
getDefaultForAllPages()
O cabeçalho/rodapé geral, usado em todas as páginas, a menos que seja
especificada a página par/ímpar ou a primeira página.
TypeScript
getDefaultForAllPages(): HeaderFooter;
Retornos
getEvenPages()
O cabeçalho/rodapé a ser usado para páginas pares, o cabeçalho/rodapé ímpar deve
ser especificado para páginas ímpares.
TypeScript
getEvenPages(): HeaderFooter;
Retornos
getFirstPage()
O cabeçalho/rodapé da primeira página. Para todas as outras páginas, geral ou par/
ímpar é usado.
TypeScript
getFirstPage(): HeaderFooter;
Retornos
getOddPages()
O cabeçalho/rodapé a ser usado para páginas ímpares, o cabeçalho/rodapé par deve
ser especificado para páginas pares.
TypeScript
getOddPages(): HeaderFooter;
Retornos
getState()
O estado pelo qual cabeçalhos/rodapés são definidos. Confira
TypeScript
getState(): HeaderFooterState;
Retornos
ExcelScript.HeaderFooterState
getUseSheetMargins()
Obtém ou define um sinalizador indicando se os cabeçalhos/rodapés estão
alinhados com as margens da página que foram definidas nas opções de layout de
página da planilha.
TypeScript
getUseSheetMargins(): boolean;
Retornos
boolean
getUseSheetScale()
Obtém ou define um sinalizador que indica se os cabeçalhos/rodapés devem ser
dimensionados pela escala de porcentagem da página definida nas opções de layout
de página da planilha.
TypeScript
getUseSheetScale(): boolean;
Retornos
boolean
setState(state)
O estado pelo qual cabeçalhos/rodapés são definidos. Confira
TypeScript
setState(state: HeaderFooterState): void;
Parâmetros
state ExcelScript.HeaderFooterState
Retornos
void
setUseSheetMargins(useSheetMargins)
Obtém ou define um sinalizador indicando se os cabeçalhos/rodapés estão
alinhados com as margens da página que foram definidas nas opções de layout de
página da planilha.
TypeScript
setUseSheetMargins(useSheetMargins: boolean): void;
Parâmetros
useSheetMargins boolean
Retornos
void
setUseSheetScale(useSheetScale)
Obtém ou define um sinalizador que indica se os cabeçalhos/rodapés devem ser
dimensionados pela escala de porcentagem da página definida nas opções de layout
de página da planilha.
TypeScript
setUseSheetScale(useSheetScale: boolean): void;
Parâmetros
useSheetScale boolean
Retornos
void
comentários:
ExcelScript.Icon interface
Referência
Pacote: ExcelScript
Representa um ícone de célula.
Propriedades
index Especifica o índice do ícone no conjunto determinado.
set Especifica o conjunto do qual o ícone faz parte.
index
Especifica o índice do ícone no conjunto determinado.
TypeScript
index: number;
number
set
Especifica o conjunto do qual o ícone faz parte.
TypeScript
set: IconSet;
ExcelScript.IconSet
comentários:
ExcelScript.IconSetConditionalFormat
interface
Referência
Pacote: ExcelScript
Representa um critério de conjunto de ícones para formatação condicional.
Comentários
Exemplos
TypeScript
/**
*/

const iconSetFormat: ExcelScript.IconSetConditionalFormat =
conditionalFormatting.getIconSet();
iconSetFormat.setStyle(ExcelScript.IconSet.threeTrafficLights1);
iconSetFormat.setCriteria([
{
formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterTh
anOrEqual,
},
{
hanOrEqual,
{
hanOrEqual,
}]);
}
Métodos
getCriteria() Uma matriz de critérios e conjuntos de ícones para as regras e possíveis

ícones personalizados para ícones condicionais. Observe que, para o
primeiro critério, somente o ícone personalizado pode ser modificado,
enquanto tipo, fórmula e operador serão ignorados quando definido.
getReverseIcon Se true , inverte as ordens de ícone para o conjunto de ícones. Observe

Order() que isso não pode ser definido se os ícones personalizados forem usados.
getShowIconOnly() Se true , ocultar os valores e mostrar somente ícones.
getStyle() Se definido, exibe a opção de conjunto de ícones para o formato

condicional.
setCriteria(criteria) Uma matriz de critérios e conjuntos de ícones para as regras e possíveis

ícones personalizados para ícones condicionais. Observe que, para o
primeiro critério, somente o ícone personalizado pode ser modificado,
enquanto tipo, fórmula e operador serão ignorados quando definido.
setReverseIcon Se true , inverte as ordens de ícone para o conjunto de ícones. Observe

Order(reverseIcon que isso não pode ser definido se os ícones personalizados forem usados.
Order)
setShowIcon Se true , ocultar os valores e mostrar somente ícones.

Only(showIconOnly)
setStyle(style) Se definido, exibe a opção de conjunto de ícones para o formato

condicional.
Detalhes do método
getCriteria()
Uma matriz de critérios e conjuntos de ícones para as regras e possíveis ícones
personalizados para ícones condicionais. Observe que, para o primeiro critério,
somente o ícone personalizado pode ser modificado, enquanto tipo, fórmula e
operador serão ignorados quando definido.
TypeScript
getCriteria(): ConditionalIconCriterion[];
Retornos
ExcelScript.ConditionalIconCriterion[]
getReverseIconOrder()
Se true , inverte as ordens de ícone para o conjunto de ícones. Observe que isso não
pode ser definido se os ícones personalizados forem usados.
TypeScript
getReverseIconOrder(): boolean;
Retornos
boolean
getShowIconOnly()
Se true , ocultar os valores e mostrar somente ícones.
TypeScript
getShowIconOnly(): boolean;
Retornos
boolean
getStyle()
Se definido, exibe a opção de conjunto de ícones para o formato condicional.
TypeScript
getStyle(): IconSet;
Retornos
ExcelScript.IconSet
setCriteria(criteria)
Uma matriz de critérios e conjuntos de ícones para as regras e possíveis ícones
personalizados para ícones condicionais. Observe que, para o primeiro critério,
somente o ícone personalizado pode ser modificado, enquanto tipo, fórmula e
operador serão ignorados quando definido.
TypeScript
setCriteria(criteria: ConditionalIconCriterion[]): void;
Parâmetros
criteria ExcelScript.ConditionalIconCriterion[]
Retornos
void
setReverseIconOrder(reverseIconOrder)
Se true , inverte as ordens de ícone para o conjunto de ícones. Observe que isso não
pode ser definido se os ícones personalizados forem usados.
TypeScript
setReverseIconOrder(reverseIconOrder: boolean): void;
Parâmetros
reverseIconOrder boolean
Retornos
void
setShowIconOnly(showIconOnly)
Se true , ocultar os valores e mostrar somente ícones.
TypeScript
setShowIconOnly(showIconOnly: boolean): void;
Parâmetros
showIconOnly boolean
Retornos
void
setStyle(style)
Se definido, exibe a opção de conjunto de ícones para o formato condicional.
TypeScript
setStyle(style: IconSet): void;
Parâmetros
style ExcelScript.IconSet
Retornos
void
comentários:
ExcelScript.Image interface
Referência
Pacote: ExcelScript
Representa uma imagem na planilha. Para obter o objeto correspondente Shape , use
Image.getShape .
Comentários
Exemplos
TypeScript
/**
* This script transfers an image from one worksheet to another.
*/
// Get the worksheet with the image on it.
const firstWorksheet = workbook.getWorksheet("FirstSheet");
// Get the first image from the worksheet.

// If a script added the image, you could add a name to make it easier to
find.
let image: ExcelScript.Image;
firstWorksheet.getShapes().forEach((shape, index) => {
if (shape.getType() === ExcelScript.ShapeType.image) {
image = shape.getImage();
return;
}
});
// Copy the image to another worksheet.

image.getShape().copyTo("SecondSheet");
}
Métodos
getFormat() Retorna o formato da imagem.
getId() Especifica o identificador de forma do objeto de imagem.
getShape() Retorna o Shape objeto associado à imagem.

Detalhes do método
getFormat()
Retorna o formato da imagem.
TypeScript
getFormat(): PictureFormat;
Retornos
ExcelScript.PictureFormat
getId()
Especifica o identificador de forma do objeto de imagem.
TypeScript
getId(): string;
Retornos
string
getShape()
Retorna o Shape objeto associado à imagem.
TypeScript
getShape(): Shape;
Retornos
ExcelScript.Shape
comentários:
ExcelScript.IterativeCalculation interface
Referência
Pacote: ExcelScript
Representa as configurações de cálculo iterativo.
Métodos
getEnabled() True se o Excel usará a interação para resolver referências circulares.
getMaxChange() Especifica a quantidade máxima de alteração entre cada iteração à

medida que o Excel resolve referências circulares.
getMaxIteration() Especifica o número máximo de iterações que o Excel pode usar para
resolver uma referência circular.
setEnabled(enabled) True se o Excel usará a interação para resolver referências circulares.
setMaxChange(max Especifica a quantidade máxima de alteração entre cada iteração à

Change) medida que o Excel resolve referências circulares.
setMaxIteration(max Especifica o número máximo de iterações que o Excel pode usar para
Iteration) resolver uma referência circular.
Detalhes do método
getEnabled()
True se o Excel usará a interação para resolver referências circulares.
TypeScript
getEnabled(): boolean;
Retornos
boolean
getMaxChange()
Especifica a quantidade máxima de alteração entre cada iteração à medida que o
Excel resolve referências circulares.
TypeScript
getMaxChange(): number;
Retornos
number
getMaxIteration()
Especifica o número máximo de iterações que o Excel pode usar para resolver uma
referência circular.
TypeScript
getMaxIteration(): number;
Retornos
number
setEnabled(enabled)
True se o Excel usará a interação para resolver referências circulares.
TypeScript
setEnabled(enabled: boolean): void;
Parâmetros
enabled boolean
Retornos
void
setMaxChange(maxChange)
Especifica a quantidade máxima de alteração entre cada iteração à medida que o
Excel resolve referências circulares.
TypeScript
setMaxChange(maxChange: number): void;
Parâmetros
maxChange number
Retornos
void
setMaxIteration(maxIteration)
Especifica o número máximo de iterações que o Excel pode usar para resolver uma
referência circular.
TypeScript
setMaxIteration(maxIteration: number): void;
Parâmetros
maxIteration number
Retornos
void
ExcelScript.Line interface
Referência
Pacote: ExcelScript
Representa uma linha dentro de uma planilha. Para obter o objeto correspondente
Shape , use Line.shape .
Métodos
connectBeginShape(shape, Conecta o início do conector especificado a uma forma específica.

connectionSite)
connectEndShape(shape, Anexa o final do conector especificado a uma forma específica.

connectionSite)
disconnectBeginShape() Desconecta o início do conector especificado de uma forma.
disconnectEndShape() Desconecta o final do conector especificado de uma forma.
getBeginArrowheadLength() Representa o comprimento da ponta da seta no início da linha

especificada.
getBeginArrowheadStyle() Representa o estilo da ponta de seta no início da linha

especificada.
getBeginArrowheadWidth() Representa a largura da ponta da seta no início da linha

especificada.
getBeginConnectedShape() Representa a forma na qual o início da linha especificada está

conectado.
getBeginConnectedSite() Representa o site de conexão ao qual o início de um conector

está conectado. Retorna null quando o início da linha não é
anexado a nenhuma forma.
getConnectorType() Representa o tipo de conector de linha.
getEndArrowheadLength() Representa o comprimento da ponta de seta no final da linha

especificada.
getEndArrowheadStyle() Representa o estilo da ponta de seta no final da linha

especificada.
getEndArrowheadWidth() Representa a largura da ponta de seta no final da linha

especificada.
getEndConnectedShape() Representa a forma na qual o final da linha especificada está
conectado.
getEndConnectedSite() Representa o site de conexão ao qual o final de um conector está

conectado. Retorna null quando o final da linha não é anexado a
nenhuma forma.
getId() Especifica o identificador de forma.
getIsBeginConnected() Especifica se o início da linha especificada está conectado a uma

forma.
getIsEndConnected() Especifica se o final da linha especificada está conectado a uma

forma.
getShape() Retorna o Shape objeto associado à linha.
setBeginArrowhead Representa o comprimento da ponta da seta no início da linha

Length(beginArrowhead especificada.
Length)
setBeginArrowhead Representa o estilo da ponta de seta no início da linha

Style(beginArrowheadStyle) especificada.
setBeginArrowhead Representa a largura da ponta da seta no início da linha

Width(beginArrowhead especificada.
Width)
setConnectorType(connector Representa o tipo de conector de linha.

Type)
setEndArrowheadLength(end Representa o comprimento da ponta de seta no final da linha

ArrowheadLength) especificada.
setEndArrowheadStyle(end Representa o estilo da ponta de seta no final da linha

ArrowheadStyle) especificada.
setEndArrowheadWidth(end Representa a largura da ponta de seta no final da linha

ArrowheadWidth) especificada.
Detalhes do método
connectBeginShape(shape, connectionSite)
Conecta o início do conector especificado a uma forma específica.
TypeScript
connectBeginShape(shape: Shape, connectionSite: number): void;
Parâmetros
shape ExcelScript.Shape
A forma a ser conectada.
connectionSite number
O site de conexão na forma à qual o início do conector está anexado. Deve ser um
inteiro entre 0 (inclusivo) e a contagem de site de conexão da forma especificada
(exclusiva).
Retornos
void
connectEndShape(shape, connectionSite)
Anexa o final do conector especificado a uma forma específica.
TypeScript
connectEndShape(shape: Shape, connectionSite: number): void;
Parâmetros
shape ExcelScript.Shape
A forma a ser conectada.
connectionSite number
O site de conexão na forma à qual a extremidade do conector está anexada. Deve
ser um inteiro entre 0 (inclusivo) e a contagem de site de conexão da forma
especificada (exclusiva).
Retornos
void
disconnectBeginShape()
Desconecta o início do conector especificado de uma forma.
TypeScript
disconnectBeginShape(): void;
Retornos
void
disconnectEndShape()
Desconecta o final do conector especificado de uma forma.
TypeScript
disconnectEndShape(): void;
Retornos
void
getBeginArrowheadLength()
Representa o comprimento da ponta da seta no início da linha especificada.
TypeScript
getBeginArrowheadLength(): ArrowheadLength;
Retornos
getBeginArrowheadStyle()
Representa o estilo da ponta de seta no início da linha especificada.
TypeScript
getBeginArrowheadStyle(): ArrowheadStyle;
Retornos
getBeginArrowheadWidth()
Representa a largura da ponta da seta no início da linha especificada.
TypeScript
getBeginArrowheadWidth(): ArrowheadWidth;
Retornos
getBeginConnectedShape()
Representa a forma na qual o início da linha especificada está conectado.
TypeScript
getBeginConnectedShape(): Shape;
Retornos
ExcelScript.Shape
getBeginConnectedSite()
Representa o site de conexão ao qual o início de um conector está conectado.
Retorna null quando o início da linha não é anexado a nenhuma forma.
TypeScript
getBeginConnectedSite(): number;
Retornos
number
getConnectorType()
Representa o tipo de conector de linha.
TypeScript
getConnectorType(): ConnectorType;
Retornos
ExcelScript.ConnectorType
getEndArrowheadLength()
Representa o comprimento da ponta de seta no final da linha especificada.
TypeScript
getEndArrowheadLength(): ArrowheadLength;
Retornos
getEndArrowheadStyle()
Representa o estilo da ponta de seta no final da linha especificada.
TypeScript
getEndArrowheadStyle(): ArrowheadStyle;
Retornos
getEndArrowheadWidth()
Representa a largura da ponta de seta no final da linha especificada.
TypeScript
getEndArrowheadWidth(): ArrowheadWidth;
Retornos
getEndConnectedShape()
Representa a forma na qual o final da linha especificada está conectado.
TypeScript
getEndConnectedShape(): Shape;
Retornos
ExcelScript.Shape
getEndConnectedSite()
Representa o site de conexão ao qual o final de um conector está conectado.
Retorna null quando o final da linha não é anexado a nenhuma forma.
TypeScript
getEndConnectedSite(): number;
Retornos
number
getId()
Especifica o identificador de forma.
TypeScript
getId(): string;
Retornos
string
getIsBeginConnected()
Especifica se o início da linha especificada está conectado a uma forma.
TypeScript
getIsBeginConnected(): boolean;
Retornos
boolean
getIsEndConnected()
Especifica se o final da linha especificada está conectado a uma forma.
TypeScript
getIsEndConnected(): boolean;
Retornos
boolean
getShape()
Retorna o Shape objeto associado à linha.
TypeScript
getShape(): Shape;
Retornos
ExcelScript.Shape
setBeginArrowheadLength(beginArrowheadLength)
Representa o comprimento da ponta da seta no início da linha especificada.
TypeScript
setBeginArrowheadLength(beginArrowheadLength: ArrowheadLength): void;
Parâmetros
beginArrowheadLength ExcelScript.ArrowheadLength
Retornos
void
setBeginArrowheadStyle(beginArrowheadStyle)
Representa o estilo da ponta de seta no início da linha especificada.
TypeScript
setBeginArrowheadStyle(beginArrowheadStyle: ArrowheadStyle): void;
Parâmetros
beginArrowheadStyle ExcelScript.ArrowheadStyle
Retornos
void
setBeginArrowheadWidth(beginArrowheadWidth)
Representa a largura da ponta da seta no início da linha especificada.
TypeScript
setBeginArrowheadWidth(beginArrowheadWidth: ArrowheadWidth): void;
Parâmetros
beginArrowheadWidth ExcelScript.ArrowheadWidth
Retornos
void
setConnectorType(connectorType)
Representa o tipo de conector de linha.
TypeScript
setConnectorType(connectorType: ConnectorType): void;
Parâmetros
connectorType ExcelScript.ConnectorType
Retornos
void
setEndArrowheadLength(endArrowheadLength)
Representa o comprimento da ponta de seta no final da linha especificada.
TypeScript
setEndArrowheadLength(endArrowheadLength: ArrowheadLength): void;
Parâmetros
endArrowheadLength ExcelScript.ArrowheadLength
Retornos
void
setEndArrowheadStyle(endArrowheadStyle)
Representa o estilo da ponta de seta no final da linha especificada.
TypeScript
setEndArrowheadStyle(endArrowheadStyle: ArrowheadStyle): void;

Parâmetros
endArrowheadStyle ExcelScript.ArrowheadStyle
Retornos
void
setEndArrowheadWidth(endArrowheadWidth)
Representa a largura da ponta de seta no final da linha especificada.
TypeScript
setEndArrowheadWidth(endArrowheadWidth: ArrowheadWidth): void;
Parâmetros
endArrowheadWidth ExcelScript.ArrowheadWidth
Retornos
void
comentários:
ExcelScript.LinkedWorkbook interface
Referência
Pacote: ExcelScript
Contém informações sobre uma pasta de trabalho vinculada. Se uma pasta de trabalho
tiver links apontando para dados em outra pasta de trabalho, a segunda pasta de
trabalho será vinculada à primeira pasta de trabalho. Nesse cenário, a segunda pasta de
trabalho é chamada de "pasta de trabalho vinculada".
Métodos
break Faz uma solicitação para quebrar os links que apontam para a pasta de trabalho
Links() vinculada. Os links nas fórmulas são substituídos pelos dados buscados mais recentes.
O objeto atual LinkedWorkbook é invalidado e removido de LinkedWorkbookCollection .
refresh Faz uma solicitação para atualizar os dados recuperados da pasta de trabalho
Links() vinculada.
Detalhes do método
breakLinks()
Faz uma solicitação para quebrar os links que apontam para a pasta de trabalho
vinculada. Os links nas fórmulas são substituídos pelos dados buscados mais
recentes. O objeto atual LinkedWorkbook é invalidado e removido de
LinkedWorkbookCollection .
TypeScript
breakLinks(): void;
Retornos
void
refreshLinks()
Faz uma solicitação para atualizar os dados recuperados da pasta de trabalho
vinculada.
TypeScript
refreshLinks(): void;
Retornos
void
comentários:
ExcelScript.ListDataValidation interface
Referência
Pacote: ExcelScript
Representa os critérios de validação de dados de lista.
Comentários
Exemplos
TypeScript
/**
* This script creates a dropdown selection list for a cell.
* It uses the existing values of the selected range as the choices for the
list.
*/
const selectedRange = workbook.getSelectedRange();
const rangeValues = selectedRange.getValues();

});
});

const targetCell = selectedRange.getCell(0, 0);
const dataValidation = targetCell.getDataValidation();
// Set the content of the dropdown list.

let validationCriteria : ExcelScript.ListDataValidation = {
};
let validationRule: ExcelScript.DataValidationRule = {
list: validationCriteria
};
dataValidation.setRule(validationRule);
}
Propriedades
inCell Especifica se é necessário exibir a lista em uma lista suspensa de células. O padrão é
Drop true .
Down
source Origem da lista para validação de dados Ao definir o valor, ele pode ser passado
como um Range objeto ou uma cadeia de caracteres que contém um número
separado por vírgulas, booliano ou data.
inCellDropDown
Especifica se é necessário exibir a lista em uma lista suspensa de células. O padrão é
true .
TypeScript
inCellDropDown: boolean;
boolean
source
Origem da lista para validação de dados Ao definir o valor, ele pode ser passado
como um Range objeto ou uma cadeia de caracteres que contém um número
separado por vírgulas, booliano ou data.
TypeScript
source: string | Range;
string | ExcelScript.Range
comentários:
ExcelScript.NamedItem interface
Referência
Pacote: ExcelScript
Representa um nome definido para um intervalo de células ou um valor. Os nomes

podem ser objetos chamados primitivos (como visto no tipo abaixo), objeto range ou
uma referência a um intervalo. Use esse objeto para obter um objeto de intervalo
associado aos nomes.
Comentários
Exemplos
TypeScript
/**
* This script creates a named formula and uses it in another part of the
workbook.
*/
// Create a named item for a formula.
// This formula is the sum of the cells F2:F21 on Sheet1.
const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
"GrandTotal",
"=SUM(Sheet1!$F$2:$F$21)",
"The sum of table sums."
);
// Add this named formula to a new sheet in the workbook.

const otherSheet = workbook.addWorksheet();
otherSheet.getRange("A1").setFormula(namedItem.getFormula());
// Switch to the new worksheet.

otherSheet.activate();
}
Métodos
delete() Exclui o nome fornecido.
getArrayValues() Retorna um objeto que contém valores e tipos do item nomeado.

getComment() Especifica o comentário associado a esse nome.
getFormula() A fórmula do item nomeado. As fórmulas sempre começam com um sinal

igual ("=").
getName() O nome do objeto.
getRange() Retorna o objeto Range associado ao nome. Se o tipo do item nomeado

não for um intervalo, esse método retornará undefined .
getScope() Especifica se o nome está no escopo da pasta de trabalho ou de uma

planilha específica. Os valores possíveis são: Planilha, Pasta de Trabalho.
getType() Especifica o tipo do valor retornado pela fórmula do nome. Confira

ExcelScript.NamedItemType detalhes.
getValue() Representa o valor calculado pela fórmula do nome. Para um intervalo

nomeado, ele retornará o endereço de intervalo. Essa API retorna o
#VALUE! erro na interface do usuário do Excel se ele se refere a uma
função definida pelo usuário.
getVisible() Especifica se o objeto está visível.
getWorksheet() Retorna a planilha à qual o item nomeado está no escopo. Se o item

estiver no escopo da pasta de trabalho, esse método retornará undefined .
set Especifica o comentário associado a esse nome.

Comment(comment)
setFormula(formula) A fórmula do item nomeado. As fórmulas sempre começam com um sinal

igual ("=").
setVisible(visible) Especifica se o objeto está visível.
Detalhes do método
delete()
Exclui o nome fornecido.
TypeScript
delete(): void;
Retornos
void
getArrayValues()
Retorna um objeto que contém valores e tipos do item nomeado.
TypeScript
getArrayValues(): NamedItemArrayValues;
Retornos
ExcelScript.NamedItemArrayValues
getComment()
Especifica o comentário associado a esse nome.
TypeScript
getComment(): string;
Retornos
string
getFormula()
A fórmula do item nomeado. As fórmulas sempre começam com um sinal igual ("=").
TypeScript
Retornos
string
getName()
O nome do objeto.
TypeScript
getName(): string;
Retornos
string
getRange()
Retorna o objeto Range associado ao nome. Se o tipo do item nomeado não for um
intervalo, esse método retornará undefined .
TypeScript
getRange(): Range;
Retornos
ExcelScript.Range
getScope()
Especifica se o nome está no escopo da pasta de trabalho ou de uma planilha
específica. Os valores possíveis são: Planilha, Pasta de Trabalho.
TypeScript
getScope(): NamedItemScope;
Retornos
ExcelScript.NamedItemScope
getType()
Especifica o tipo do valor retornado pela fórmula do nome. Confira
ExcelScript.NamedItemType detalhes.
TypeScript
getType(): NamedItemType;
Retornos
ExcelScript.NamedItemType
Exemplos
TypeScript
/**
*/
formula).
}
}
});
}
getValue()
Representa o valor calculado pela fórmula do nome. Para um intervalo nomeado, ele
retornará o endereço de intervalo. Essa API retorna o #VALUE! erro na interface do
usuário do Excel se ele se refere a uma função definida pelo usuário.
TypeScript
getValue(): string | number;
Retornos
string | number
getVisible()
Especifica se o objeto está visível.
TypeScript
Retornos
boolean
getWorksheet()
Retorna a planilha à qual o item nomeado está no escopo. Se o item estiver no
escopo da pasta de trabalho, esse método retornará undefined .
TypeScript
getWorksheet(): Worksheet | undefined;
Retornos
ExcelScript.Worksheet | undefined
setComment(comment)
Especifica o comentário associado a esse nome.
TypeScript
setComment(comment: string): void;
Parâmetros
comment string
Retornos
void
setFormula(formula)
A fórmula do item nomeado. As fórmulas sempre começam com um sinal igual ("=").
TypeScript
Parâmetros
formula string
Retornos
void
setVisible(visible)
Especifica se o objeto está visível.
TypeScript
Parâmetros
visible boolean
Retornos
void
comentários:
ExcelScript.NamedItemArrayValues
interface
Referência
Pacote: ExcelScript
Representa um objeto que contém valores e tipos de um item nomeado.
Métodos
getTypes() Representa os tipos para cada item na matriz de itens nomeada
getValues() Representa os valores de cada item na matriz de itens nomeados.
Detalhes do método
getTypes()
Representa os tipos para cada item na matriz de itens nomeada
TypeScript
getTypes(): RangeValueType[][];
Retornos
ExcelScript.RangeValueType[][]
getValues()
Representa os valores de cada item na matriz de itens nomeados.
TypeScript
getValues(): (string | number | boolean)[][];

Retornos
(string | number | boolean)[][]
comentários:
ExcelScript.NamedSheetView interface
Referência
Pacote: ExcelScript
Representa uma exibição de planilha nomeada de uma planilha. Uma exibição de

planilha armazena as regras de classificação e filtro para uma planilha específica. Cada
exibição de planilha (até mesmo uma exibição temporária de planilha) tem um nome
exclusivo com escopo de planilha que é usado para acessar o modo de exibição.
Métodos
activate() Ativa essa exibição de planilha. Isso é equivalente ao uso de "Alternar para" na
interface do usuário do Excel.
delete() Remove a exibição da planilha da planilha.
duplicate(name) Cria uma cópia desse modo de exibição de planilha.
getName() Obtém ou define o nome da exibição da planilha. O nome de exibição de folha

temporária é a cadeia de caracteres vazia (""). Nomear o modo de exibição
usando a propriedade name faz com que a exibição da planilha seja salva.
setName(name) Obtém ou define o nome da exibição da planilha. O nome de exibição de folha

temporária é a cadeia de caracteres vazia (""). Nomear o modo de exibição
usando a propriedade name faz com que a exibição da planilha seja salva.
Detalhes do método
activate()
Ativa essa exibição de planilha. Isso é equivalente ao uso de "Alternar para" na
interface do usuário do Excel.
TypeScript
activate(): void;
Retornos
void
delete()
Remove a exibição da planilha da planilha.
TypeScript
delete(): void;
Retornos
void
duplicate(name)
Cria uma cópia desse modo de exibição de planilha.
TypeScript
duplicate(name?: string): NamedSheetView;
Parâmetros
name string
O nome da exibição de planilha duplicada. Se nenhum nome for fornecido, um será
gerado.
Retornos
ExcelScript.NamedSheetView
getName()
Obtém ou define o nome da exibição da planilha. O nome de exibição de folha
temporária é a cadeia de caracteres vazia (""). Nomear o modo de exibição usando a
propriedade name faz com que a exibição da planilha seja salva.
TypeScript
getName(): string;
Retornos
string
setName(name)
Obtém ou define o nome da exibição da planilha. O nome de exibição de folha
temporária é a cadeia de caracteres vazia (""). Nomear o modo de exibição usando a
propriedade name faz com que a exibição da planilha seja salva.
TypeScript
Parâmetros
name string
Retornos
void
comentários:
ExcelScript.NumberFormatInfo interface
Referência
Pacote: ExcelScript

Métodos
getNumber Obtém a cadeia de caracteres usada como separador decimal para valores
Decimal numéricos. Isso se baseia nas configurações atuais do sistema.
Separator()
getNumberGroup Obtém a cadeia de caracteres usada para separar grupos de dígitos à

Separator() esquerda do decimal para valores numéricos. Isso se baseia nas
Detalhes do método
getNumberDecimalSeparator()
Obtém a cadeia de caracteres usada como separador decimal para valores
numéricos. Isso se baseia nas configurações atuais do sistema.
TypeScript
getNumberDecimalSeparator(): string;
Retornos
string
getNumberGroupSeparator()
Obtém a cadeia de caracteres usada para separar grupos de dígitos à esquerda do
decimal para valores numéricos. Isso se baseia nas configurações atuais do sistema.
TypeScript
getNumberGroupSeparator(): string;
Retornos
string
ExcelScript.PageBreak interface
Referência
Pacote: ExcelScript
Métodos
delete() Exclui um objeto de quebra de página.
getCellAfterBreak() Obtém a primeira célula após a quebra de página.
getColumnIndex() Especifica o índice de coluna para a quebra de página.
Detalhes do método
delete()
Exclui um objeto de quebra de página.
TypeScript
delete(): void;
Retornos
void
getCellAfterBreak()
Obtém a primeira célula após a quebra de página.
TypeScript
getCellAfterBreak(): Range;
Retornos
ExcelScript.Range
getColumnIndex()
Especifica o índice de coluna para a quebra de página.
TypeScript
getColumnIndex(): number;
Retornos
number
ExcelScript.PageLayout interface
Referência
Pacote: ExcelScript
Representa configurações de layout e impressão que não dependem de nenhuma

implementação específica da impressora. Essas configurações incluem margens,
orientação, numeração de página, linhas de título e a área de impressão.
Comentários
Exemplos
TypeScript
/**
* This script sets some basic page layout settings for printing.
*/
const pageLayout : ExcelScript.PageLayout = sheet.getPageLayout();
// Turn off draft mode so images are printed.

pageLayout.setDraftMode(false);


});
}
Métodos
getBlackAndWhite() A opção de impressão em preto e branco da planilha.
getBottomMargin() A margem de página inferior da planilha a ser usada para

impressão em pontos.
getCenterHorizontally() O sinalizador central da planilha horizontalmente. Esse sinalizador
determina se a planilha será centralizada horizontalmente quando
for impressa.
getCenterVertically() O sinalizador central da planilha verticalmente. Esse sinalizador

determina se a planilha será centralizada verticalmente quando for
impressa.
getDraftMode() A opção de modo de rascunho da planilha. Se true , a folha será

impressa sem gráficos.
getFirstPageNumber() O primeiro número de página da planilha a ser impresso. Um null

valor representa a numeração de página "automática".
getFooterMargin() A margem de rodapé da planilha, em pontos, para uso ao imprimir.
getHeaderMargin() A margem de cabeçalho da planilha, em pontos, para uso ao

imprimir.
getHeadersFooters() Configuração de cabeçalho e rodapé da planilha.
getLeftMargin() A margem esquerda da planilha, em pontos, para uso ao imprimir.
getOrientation() A orientação da planilha da página.
getPaperSize() O tamanho do papel da planilha da página.
getPrintArea() Obtém o RangeAreas objeto, composto por um ou mais intervalos

retangulares, que representa a área de impressão da planilha. Se
não houver nenhuma área de impressão, esse método retornará
undefined .
getPrintComments() Especifica se os comentários da planilha devem ser exibidos ao

imprimir.
getPrintErrors() A opção de erros de impressão da planilha.
getPrintGridlines() Especifica se as linhas de grade da planilha serão impressas.
getPrintHeadings() Especifica se os títulos da planilha serão impressos.
getPrintOrder() Opção de ordem de impressão de página da planilha. Isso

especifica a ordem que será usada para processar o número de
página impresso.
getPrintTitleColumns() Obtém o objeto range que representa as colunas de título. Se não

estiver definido, esse método retornará undefined .
getPrintTitleRows() Obtém o objeto range representando as linhas do título. Se não

estiver definido, esse método retornará undefined .
getRightMargin() A margem direita da planilha, em pontos, para uso ao imprimir.

getTopMargin() A margem superior da planilha, em pontos, para uso ao imprimir.
getZoom() As opções de zoom de impressão da planilha. O

PageLayoutZoomOptions objeto deve ser definido como um objeto
JSON (use x.zoom = {...} em vez de x.zoom.scale = ... ).
setBlackAndWhite(black A opção de impressão em preto e branco da planilha.

AndWhite)
setBottomMargin(bottom A margem de página inferior da planilha a ser usada para

Margin) impressão em pontos.
setCenter O sinalizador central da planilha horizontalmente. Esse sinalizador

Horizontally(center determina se a planilha será centralizada horizontalmente quando
Horizontally) for impressa.
setCenterVertically(center O sinalizador central da planilha verticalmente. Esse sinalizador

Vertically) determina se a planilha será centralizada verticalmente quando for
impressa.
setDraftMode(draftMode) A opção de modo de rascunho da planilha. Se true , a folha será

impressa sem gráficos.
setFirstPageNumber(first O primeiro número de página da planilha a ser impresso. Um null

PageNumber) valor representa a numeração de página "automática".
setFooterMargin(footer A margem de rodapé da planilha, em pontos, para uso ao imprimir.

Margin)
setHeaderMargin(header A margem de cabeçalho da planilha, em pontos, para uso ao

Margin) imprimir.
setLeftMargin(leftMargin) A margem esquerda da planilha, em pontos, para uso ao imprimir.
setOrientation(orientation) A orientação da planilha da página.
setPaperSize(paperSize) O tamanho do papel da planilha da página.
setPrintArea(printArea) Define a área de impressão da planilha.
setPrintComments(print Especifica se os comentários da planilha devem ser exibidos ao

Comments) imprimir.
setPrintErrors(printErrors) A opção de erros de impressão da planilha.
setPrintGridlines(print Especifica se as linhas de grade da planilha serão impressas.

Gridlines)
setPrintHeadings(print Especifica se os títulos da planilha serão impressos.

Headings)
setPrintMargins(unit, Define as margens das páginas da planilha com unidades.
marginOptions)
setPrintOrder(printOrder) Opção de ordem de impressão de página da planilha. Isso

especifica a ordem que será usada para processar o número de
página impresso.
setPrintTitleColumns(print Define as colunas que contêm as células que serão repetidas à

TitleColumns) esquerda de cada página da planilha para impressão.
setPrintTitleRows(printTitle Define as linhas que contêm as células que serão repetidas na

Rows) parte de cada página da planilha para impressão.
setRightMargin(right A margem direita da planilha, em pontos, para uso ao imprimir.

Margin)
setTopMargin(topMargin) A margem superior da planilha, em pontos, para uso ao imprimir.
setZoom(zoom) As opções de zoom de impressão da planilha. O

PageLayoutZoomOptions objeto deve ser definido como um objeto
JSON (use x.zoom = {...} em vez de x.zoom.scale = ... ).
Detalhes do método
getBlackAndWhite()
A opção de impressão em preto e branco da planilha.
TypeScript
getBlackAndWhite(): boolean;
Retornos
boolean
getBottomMargin()
A margem de página inferior da planilha a ser usada para impressão em pontos.
TypeScript
getBottomMargin(): number;
Retornos
number
getCenterHorizontally()
O sinalizador central da planilha horizontalmente. Esse sinalizador determina se a
planilha será centralizada horizontalmente quando for impressa.
TypeScript
getCenterHorizontally(): boolean;
Retornos
boolean
getCenterVertically()
O sinalizador central da planilha verticalmente. Esse sinalizador determina se a
planilha será centralizada verticalmente quando for impressa.
TypeScript
getCenterVertically(): boolean;
Retornos
boolean
getDraftMode()
A opção de modo de rascunho da planilha. Se true , a folha será impressa sem
gráficos.
TypeScript
getDraftMode(): boolean;
Retornos
boolean
getFirstPageNumber()
O primeiro número de página da planilha a ser impresso. Um null valor representa
a numeração de página "automática".
TypeScript
getFirstPageNumber(): number | "";
Retornos
number | ""
getFooterMargin()
A margem de rodapé da planilha, em pontos, para uso ao imprimir.
TypeScript
getFooterMargin(): number;
Retornos
number
getHeaderMargin()
A margem de cabeçalho da planilha, em pontos, para uso ao imprimir.
TypeScript
getHeaderMargin(): number;
Retornos
number
getHeadersFooters()
Configuração de cabeçalho e rodapé da planilha.
TypeScript
getHeadersFooters(): HeaderFooterGroup;
Retornos
getLeftMargin()
A margem esquerda da planilha, em pontos, para uso ao imprimir.
TypeScript
getLeftMargin(): number;
Retornos
number
getOrientation()
A orientação da planilha da página.
TypeScript
getOrientation(): PageOrientation;
Retornos
ExcelScript.PageOrientation
getPaperSize()
O tamanho do papel da planilha da página.
TypeScript
getPaperSize(): PaperType;
Retornos
ExcelScript.PaperType
getPrintArea()
Obtém o RangeAreas objeto, composto por um ou mais intervalos retangulares, que
representa a área de impressão da planilha. Se não houver nenhuma área de
impressão, esse método retornará undefined .
TypeScript
getPrintArea(): RangeAreas;
Retornos
getPrintComments()
Especifica se os comentários da planilha devem ser exibidos ao imprimir.
TypeScript
getPrintComments(): PrintComments;
Retornos
ExcelScript.PrintComments
getPrintErrors()
A opção de erros de impressão da planilha.
TypeScript
getPrintErrors(): PrintErrorType;
Retornos
ExcelScript.PrintErrorType
getPrintGridlines()
Especifica se as linhas de grade da planilha serão impressas.
TypeScript
getPrintGridlines(): boolean;
Retornos
boolean
getPrintHeadings()
Especifica se os títulos da planilha serão impressos.
TypeScript
getPrintHeadings(): boolean;
Retornos
boolean
getPrintOrder()
Opção de ordem de impressão de página da planilha. Isso especifica a ordem que
será usada para processar o número de página impresso.
TypeScript
getPrintOrder(): PrintOrder;
Retornos
ExcelScript.PrintOrder
getPrintTitleColumns()
Obtém o objeto range que representa as colunas de título. Se não estiver definido,
TypeScript
getPrintTitleColumns(): Range;
Retornos
ExcelScript.Range
getPrintTitleRows()
Obtém o objeto range representando as linhas do título. Se não estiver definido,
TypeScript
getPrintTitleRows(): Range;
Retornos
ExcelScript.Range
getRightMargin()
A margem direita da planilha, em pontos, para uso ao imprimir.
TypeScript
getRightMargin(): number;
Retornos
number
getTopMargin()
A margem superior da planilha, em pontos, para uso ao imprimir.
TypeScript
getTopMargin(): number;
Retornos
number
getZoom()
As opções de zoom de impressão da planilha. O PageLayoutZoomOptions objeto deve
ser definido como um objeto JSON (use x.zoom = {...} em vez de x.zoom.scale =
... ).
TypeScript
getZoom(): PageLayoutZoomOptions;
Retornos
ExcelScript.PageLayoutZoomOptions
setBlackAndWhite(blackAndWhite)
A opção de impressão em preto e branco da planilha.
TypeScript
setBlackAndWhite(blackAndWhite: boolean): void;
Parâmetros
blackAndWhite boolean
Retornos
void
setBottomMargin(bottomMargin)
A margem de página inferior da planilha a ser usada para impressão em pontos.
TypeScript
setBottomMargin(bottomMargin: number): void;

Parâmetros
bottomMargin number
Retornos
void
setCenterHorizontally(centerHorizontally)
O sinalizador central da planilha horizontalmente. Esse sinalizador determina se a
planilha será centralizada horizontalmente quando for impressa.
TypeScript
setCenterHorizontally(centerHorizontally: boolean): void;
Parâmetros
centerHorizontally boolean
Retornos
void
setCenterVertically(centerVertically)
O sinalizador central da planilha verticalmente. Esse sinalizador determina se a
planilha será centralizada verticalmente quando for impressa.
TypeScript
setCenterVertically(centerVertically: boolean): void;
Parâmetros
centerVertically boolean
Retornos
void
setDraftMode(draftMode)
A opção de modo de rascunho da planilha. Se true , a folha será impressa sem
gráficos.
TypeScript
setDraftMode(draftMode: boolean): void;
Parâmetros
draftMode boolean
Retornos
void
Exemplos
TypeScript
/**
* This script turns off the print setting for draft mode.
*/
// Turn off draft mode so images are printed.

pageLayout.setDraftMode(false);
});
}
setFirstPageNumber(firstPageNumber)
O primeiro número de página da planilha a ser impresso. Um null valor representa
a numeração de página "automática".
TypeScript
setFirstPageNumber(firstPageNumber: number | ""): void;

Parâmetros
firstPageNumber number | ""
Retornos
void
setFooterMargin(footerMargin)
A margem de rodapé da planilha, em pontos, para uso ao imprimir.
TypeScript
setFooterMargin(footerMargin: number): void;
Parâmetros
footerMargin number
Retornos
void
setHeaderMargin(headerMargin)
A margem de cabeçalho da planilha, em pontos, para uso ao imprimir.
TypeScript
setHeaderMargin(headerMargin: number): void;
Parâmetros
headerMargin number
Retornos
void
setLeftMargin(leftMargin)
A margem esquerda da planilha, em pontos, para uso ao imprimir.
TypeScript
setLeftMargin(leftMargin: number): void;
Parâmetros
leftMargin number
Retornos
void
setOrientation(orientation)
A orientação da planilha da página.
TypeScript
setOrientation(orientation: PageOrientation): void;
Parâmetros
orientation ExcelScript.PageOrientation
Retornos
void
Exemplos
TypeScript
/**
*/

});
}
setPaperSize(paperSize)
O tamanho do papel da planilha da página.
TypeScript
setPaperSize(paperSize: PaperType): void;
Parâmetros
paperSize ExcelScript.PaperType
Retornos
void
Exemplos
TypeScript
/**
* This script sets the page size for printing.
*/
});
}
setPrintArea(printArea)
Define a área de impressão da planilha.
TypeScript
setPrintArea(printArea: Range | RangeAreas | string): void;

Parâmetros
printArea ExcelScript.Range | ExcelScript.RangeAreas | string
O intervalo ou intervalos do conteúdo a ser impresso.
Retornos
void
setPrintComments(printComments)
Especifica se os comentários da planilha devem ser exibidos ao imprimir.
TypeScript
setPrintComments(printComments: PrintComments): void;
Parâmetros
printComments ExcelScript.PrintComments
Retornos
void
Exemplos
TypeScript
/**
* This script makes the comments print at the end of the worksheet
* when the workbook is printed.
*/
const layout = worksheet.getPageLayout();
// Change the comment printing settings to print them at the end of

the sheet.
layout.setPrintComments(ExcelScript.PrintComments.endSheet);
});
}
setPrintErrors(printErrors)
A opção de erros de impressão da planilha.
TypeScript
setPrintErrors(printErrors: PrintErrorType): void;
Parâmetros
printErrors ExcelScript.PrintErrorType
Retornos
void
setPrintGridlines(printGridlines)
Especifica se as linhas de grade da planilha serão impressas.
TypeScript
setPrintGridlines(printGridlines: boolean): void;
Parâmetros
printGridlines boolean
Retornos
void
setPrintHeadings(printHeadings)
Especifica se os títulos da planilha serão impressos.
TypeScript
setPrintHeadings(printHeadings: boolean): void;
Parâmetros
printHeadings boolean
Retornos
void
setPrintMargins(unit, marginOptions)
Define as margens das páginas da planilha com unidades.
TypeScript
setPrintMargins(
unit: PrintMarginUnit,
marginOptions: PageLayoutMarginOptions
): void;
Parâmetros
unit ExcelScript.PrintMarginUnit
Unidade de medição para as margens fornecidas.
marginOptions ExcelScript.PageLayoutMarginOptions
Valores de margem a serem definidos. As margens não fornecidas permanecem
inalteradas.
Retornos
void
setPrintOrder(printOrder)
Opção de ordem de impressão de página da planilha. Isso especifica a ordem que
será usada para processar o número de página impresso.
TypeScript
setPrintOrder(printOrder: PrintOrder): void;
Parâmetros
printOrder ExcelScript.PrintOrder
Retornos
void
Exemplos
TypeScript
/**
* This script sets the print order for every worksheet in the workbook.
* The order of printed content will go over (e.g., left-to-right)
* then down (i.e., top-to-bottom).
*/
const layout: ExcelScript.PageLayout = worksheet.getPageLayout();
// Set the print order to over-then-down.

layout.setPrintOrder(ExcelScript.PrintOrder.overThenDown);
});
}
setPrintTitleColumns(printTitleColumns)
Define as colunas que contêm as células que serão repetidas à esquerda de cada
página da planilha para impressão.
TypeScript
setPrintTitleColumns(printTitleColumns: Range | string): void;
Parâmetros
printTitleColumns ExcelScript.Range | string
As colunas a serem repetidas à esquerda de cada página. O intervalo deve abranger
toda a coluna para ser válido.
Retornos
void
setPrintTitleRows(printTitleRows)
Define as linhas que contêm as células que serão repetidas na parte de cada página
da planilha para impressão.
TypeScript
setPrintTitleRows(printTitleRows: Range | string): void;
Parâmetros
printTitleRows ExcelScript.Range | string
As linhas a serem repetidas na parte superior de cada página. O intervalo deve
abranger toda a linha para ser válido.
Retornos
void
setRightMargin(rightMargin)
A margem direita da planilha, em pontos, para uso ao imprimir.
TypeScript
setRightMargin(rightMargin: number): void;
Parâmetros
rightMargin number
Retornos
void
setTopMargin(topMargin)
A margem superior da planilha, em pontos, para uso ao imprimir.
TypeScript
setTopMargin(topMargin: number): void;

Parâmetros
topMargin number
Retornos
void
setZoom(zoom)
As opções de zoom de impressão da planilha. O PageLayoutZoomOptions objeto deve
ser definido como um objeto JSON (use x.zoom = {...} em vez de x.zoom.scale =
... ).
TypeScript
setZoom(zoom: PageLayoutZoomOptions): void;
Parâmetros
zoom ExcelScript.PageLayoutZoomOptions
Retornos
void
comentários:
ExcelScript.PageLayoutMarginOptions
interface
Referência
Pacote: ExcelScript
Representa as opções nas margens de layout da página.
Propriedades
bottom Especifica a margem inferior do layout da página na unidade especificada para uso para
impressão.
footer Especifica a margem de rodapé do layout da página na unidade especificada para uso
para impressão.
header Especifica a margem de cabeçalho do layout da página na unidade especificada para

uso para impressão.
left Especifica a margem esquerda do layout da página na unidade especificada para uso
para impressão.
right Especifica a margem direita do layout da página na unidade especificada para uso para
impressão.
top Especifica a margem superior do layout da página na unidade especificada para uso
para impressão.
bottom
Especifica a margem inferior do layout da página na unidade especificada para uso
para impressão.
TypeScript
bottom?: number;
number
footer
Especifica a margem de rodapé do layout da página na unidade especificada para
TypeScript
footer?: number;
number
header
Especifica a margem de cabeçalho do layout da página na unidade especificada para
TypeScript
header?: number;
number
left
Especifica a margem esquerda do layout da página na unidade especificada para uso
para impressão.
TypeScript
left?: number;
number
right
Especifica a margem direita do layout da página na unidade especificada para uso
para impressão.
TypeScript
right?: number;
number
top
Especifica a margem superior do layout da página na unidade especificada para uso
para impressão.
TypeScript
top?: number;
number
comentários:
ExcelScript.PageLayoutZoomOptions
interface
Referência
Pacote: ExcelScript
Representa propriedades de zoom de página.
Propriedades
horizontalFit Número de páginas a ser horizontalmente ajustado. Esse valor pode ser null se
ToPages a escala de percentual for usada.
scale O valor do dimensionamento da página de impressão pode estar entre 10 e 400.

Esse valor pode ser null se o ajuste à página alta ou ampla for especificado.
verticalFit Número de páginas a ser verticalmente ajustado. Esse valor pode ser null se a
ToPages escala de percentual for usada.
horizontalFitToPages
Número de páginas a ser horizontalmente ajustado. Esse valor pode ser null se a
escala de percentual for usada.
TypeScript
horizontalFitToPages?: number;
number
scale
O valor do dimensionamento da página de impressão pode estar entre 10 e 400.
Esse valor pode ser null se o ajuste à página alta ou ampla for especificado.
TypeScript
scale?: number;
number
verticalFitToPages
Número de páginas a ser verticalmente ajustado. Esse valor pode ser null se a
escala de percentual for usada.
TypeScript
verticalFitToPages?: number;
number
comentários:
ExcelScript.PivotDateFilter interface
Referência
Pacote: ExcelScript
Modelo configurável para um filtro de data a ser aplicado a um PivotField. O condition

define quais critérios precisam ser definidos para que o filtro opere.
Propriedades
comparator O comparador é o valor estático ao qual outros valores são comparados. O tipo de
comparação é definido pela condição.
condition Especifica a condição do filtro, que define os critérios de filtragem necessários.
exclusive Se true , o filtro excluirá itens que atendam aos critérios. O padrão é false (filtro
para incluir itens que atendam aos critérios).
lowerBound O limite inferior do intervalo para a condição de between filtro.
upper O limite superior do intervalo para a condição de between filtro.

Bound
wholeDays Para equals , before , after e between condições de filtro, indica se as comparações
devem ser feitas como dias inteiros.
comparator
O comparador é o valor estático ao qual outros valores são comparados. O tipo de
comparação é definido pela condição.
TypeScript
comparator?: FilterDatetime;
ExcelScript.FilterDatetime
condition
Especifica a condição do filtro, que define os critérios de filtragem necessários.
TypeScript
condition: DateFilterCondition;
ExcelScript.DateFilterCondition
Exemplos
TypeScript
/**
*/
// The data in this field must be dates in order for the filter to
work.

dateFilter: {
// Setting the condition to `thisMonth` means items that are before
or
}
});
}
exclusive
Se true , o filtro excluirá itens que atendam aos critérios. O padrão é false (filtro
TypeScript
exclusive?: boolean;
boolean
lowerBound
O limite inferior do intervalo para a condição de between filtro.
TypeScript
lowerBound?: FilterDatetime;
Exemplos
TypeScript
/**
*/
work.

date: "2022-06-20",
};
date: "2022-07-10",
};

dateFilter: {
}
});
}
upperBound
O limite superior do intervalo para a condição de between filtro.
TypeScript
upperBound?: FilterDatetime;
wholeDays
Para equals , before , after e between condições de filtro, indica se as comparações
devem ser feitas como dias inteiros.
TypeScript
wholeDays?: boolean;
boolean
ExcelScript.PivotField interface
Referência
Pacote: ExcelScript
Representa o Excel PivotField.
Métodos
applyFilter(filter) Define um ou mais dos PivotFilters atuais do campo e aplica-os ao

campo. Se os filtros fornecidos forem inválidos ou não puderem
ser aplicados, uma exceção será gerada.
clearAllFilters() Limpa todos os critérios de todos os filtros do campo. Isso remove

qualquer filtragem ativa no campo.
clearFilter(filterType) Limpa todos os critérios existentes do filtro do campo do tipo

determinado (se um for aplicado no momento).
getFilters() Obtém todos os filtros atualmente aplicados no campo.
getId() ID do PivotField.
getItems() Retorna os PivotItems associados ao PivotField.
getName() Nome do PivotField.
getPivotItem(name) Obtém um PivotItem pelo nome. Se o PivotItem não existir, esse

método retornará undefined .
getShowAllItems() Determina se deseja mostrar todos os itens de PivotField.
getSubtotals() Subtotais de PivotField.
isFiltered(filterType) Verifica se há filtros aplicados no campo.
setName(name) Nome do PivotField.
setShowAllItems(showAll Determina se deseja mostrar todos os itens de PivotField.

Items)
setSubtotals(subtotals) Subtotais de PivotField.
sortByLabels(sortBy) Classifica o PivotField. Se um DataPivotHierarchy for especificado, a

classificação será aplicada com base nele, se a classificação não for
baseada no campo PivotField.
sortByValues(sortBy, values Classifica o Campo dinâmico por valores especificados em um
Hierarchy, pivotItemScope) determinado escopo. O escopo define quais valores específicos
serão usados para classificar quando houver vários valores da
mesma DataPivotHierarchy.
Detalhes do método
applyFilter(filter)
Define um ou mais dos PivotFilters atuais do campo e aplica-os ao campo. Se os
filtros fornecidos forem inválidos ou não puderem ser aplicados, uma exceção será
gerada.
TypeScript
applyFilter(filter: PivotFilters): void;
Parâmetros
filter ExcelScript.PivotFilters
Um PivotFilter específico configurado ou uma interface PivotFilters contendo vários
filtros configurados.
Retornos
void
Exemplos
TypeScript
/**
* This script applies a PivotValueFilter to the first row hierarchy in
the PivotTable.
*/
rows.

comparator: 500,
};

valueFilter: filter
});
}
clearAllFilters()
Limpa todos os critérios de todos os filtros do campo. Isso remove qualquer
filtragem ativa no campo.
TypeScript
clearAllFilters(): void;
Retornos
void
clearFilter(filterType)
Limpa todos os critérios existentes do filtro do campo do tipo determinado (se um
for aplicado no momento).
TypeScript
clearFilter(filterType: PivotFilterType): void;
Parâmetros
filterType ExcelScript.PivotFilterType
O tipo de filtro no campo do qual limpar todos os critérios.
Retornos
void
Exemplos
TypeScript
/**
* This script gets the "Type" field from the "Farms Sales" PivotTable
* and clears the value filter from it.
*/

const typeField = pivot.getHierarchy("Type").getPivotField("Type");
// Clear the value filter (if there is one) from the field.
typeField.clearFilter(ExcelScript.PivotFilterType.value);
}
getFilters()
Obtém todos os filtros atualmente aplicados no campo.
TypeScript
getFilters(): PivotFilters;
Retornos
ExcelScript.PivotFilters
getId()
ID do PivotField.
TypeScript
getId(): string;
Retornos
string
getItems()
Retorna os PivotItems associados ao PivotField.
TypeScript
getItems(): PivotItem[];
Retornos
ExcelScript.PivotItem[]
getName()
Nome do PivotField.
TypeScript
getName(): string;
Retornos
string
getPivotItem(name)
Obtém um PivotItem pelo nome. Se o PivotItem não existir, esse método retornará
undefined .
TypeScript
getPivotItem(name: string): PivotItem | undefined;
Parâmetros
name string
Nome do PivotItem a ser recuperado.
Retornos
ExcelScript.PivotItem | undefined
getShowAllItems()
Determina se deseja mostrar todos os itens de PivotField.
TypeScript
getShowAllItems(): boolean;
Retornos
boolean
getSubtotals()
Subtotais de PivotField.
TypeScript
getSubtotals(): Subtotals;
Retornos
ExcelScript.Subtotals
isFiltered(filterType)
Verifica se há filtros aplicados no campo.
TypeScript
isFiltered(filterType?: PivotFilterType): boolean;
Parâmetros
filterType ExcelScript.PivotFilterType
O tipo de filtro a ser marcar. Se nenhum tipo for fornecido, esse método marcar se
algum filtro for aplicado.
Retornos
boolean
setName(name)
Nome do PivotField.
TypeScript
Parâmetros
name string
Retornos
void
setShowAllItems(showAllItems)
Determina se deseja mostrar todos os itens de PivotField.
TypeScript
setShowAllItems(showAllItems: boolean): void;
Parâmetros
showAllItems boolean
Retornos
void
setSubtotals(subtotals)
Subtotais de PivotField.
TypeScript
setSubtotals(subtotals: Subtotals): void;
Parâmetros
subtotals ExcelScript.Subtotals
Retornos
void
sortByLabels(sortBy)
Classifica o PivotField. Se um DataPivotHierarchy for especificado, a classificação será
aplicada com base nele, se a classificação não for baseada no campo PivotField.
TypeScript
sortByLabels(sortBy: SortBy): void;
Parâmetros
sortBy ExcelScript.SortBy
Especifica se a classificação é feita em ordem crescente ou decrescente.
Retornos
void
sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Classifica o Campo dinâmico por valores especificados em um determinado escopo.
O escopo define quais valores específicos serão usados para classificar quando
houver vários valores da mesma DataPivotHierarchy.
TypeScript
sortByValues(
sortBy: SortBy,
valuesHierarchy: DataPivotHierarchy,
pivotItemScope?: Array<PivotItem | string>
): void;
Parâmetros
Especifica se a classificação é feita em ordem crescente ou decrescente.
valuesHierarchy ExcelScript.DataPivotHierarchy
Especifica a hierarquia de valores no eixo de dados a ser usado para classificação.
pivotItemScope Array<ExcelScript.PivotItem | string>

Os itens que devem ser usados para o escopo da classificação. Estes serão os itens
que compõem a linha ou coluna que você deseja classificar. Se uma cadeia de
caracteres for usada em vez de um PivotItem, a cadeia de caracteres representará a
ID do PivotItem. Se não houver outros itens além da hierarquia de dados no eixo em
que você deseja classificar, isso poderá estar vazio.
Retornos
void
Exemplos
TypeScript
/**
*/

const valueFieldToSortOn = pivotTable.getDataHierarchy("Sum of Crates
Sold Wholesale");

const rowToSort = pivotTable.getRowHierarchy("Farm");
// Sort the "Farm" row's only field by the values in "Sum of Crates
Sold Wholesale".
}
comentários:
ExcelScript.PivotFilters interface
Referência
Pacote: ExcelScript
Uma interface que representa todos os PivotFilters atualmente aplicados a um

determinado PivotField.
Propriedades
dateFilter O filtro de data aplicado atualmente do PivotField. Essa propriedade será null se
nenhum filtro de valor for aplicado.
labelFilter O filtro de rótulo aplicado atualmente do PivotField. Essa propriedade será null se
manual O filtro manual aplicado atualmente do PivotField. Essa propriedade será null se
Filter nenhum filtro de valor for aplicado.
valueFilter O filtro de valor aplicado atualmente do PivotField. Essa propriedade será null se
dateFilter
O filtro de data aplicado atualmente do PivotField. Essa propriedade será null se
TypeScript
dateFilter?: PivotDateFilter;
ExcelScript.PivotDateFilter
Exemplos
TypeScript
/**
*/
work.

dateFilter: {
// Setting the condition to `thisMonth` means items that are before
or
}
});
}
labelFilter
O filtro de rótulo aplicado atualmente do PivotField. Essa propriedade será null se
TypeScript
labelFilter?: PivotLabelFilter;
ExcelScript.PivotLabelFilter
Exemplos
TypeScript
/**
*/
Sales");

"Limes").
substring: "L",
exclusive: true
};

}
manualFilter
O filtro manual aplicado atualmente do PivotField. Essa propriedade será null se
TypeScript
manualFilter?: PivotManualFilter;
ExcelScript.PivotManualFilter
Exemplos
TypeScript
/**
* This script adds a manual filter to a PivotTable.
*/
{
// Get the hierarchy to use as the filter.

const location = pivot.getHierarchy("Location");
// Use "Location" as the FilterHierarchy.

pivot.addFilterHierarchy(location);
// Select items for the filter.

// Note that hierarchies and fields have a 1:1 relationship in Excel,
// so `getFields()[0]` always gets the correct field.
location.getFields()[0].applyFilter({
manualFilter: {
selectedItems: ["Seattle", "Chicago"]
}
});
}
valueFilter
O filtro de valor aplicado atualmente do PivotField. Essa propriedade será null se
TypeScript
valueFilter?: PivotValueFilter;
ExcelScript.PivotValueFilter
Exemplos
TypeScript
/**
* This script applies a PivotValueFilter to the first row hierarchy in
the PivotTable.
*/
rows.

comparator: 500,
};

valueFilter: filter
});
}
comentários:
ExcelScript.PivotHierarchy interface
Referência
Pacote: ExcelScript
Representa o Excel PivotHierarchy.
Comentários
Exemplos
TypeScript
/**
* 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".
*/
// Create a PivotTable based on a table in the current worksheet.
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"));
}
Métodos
getFields() Retorna PivotFields associados a PivotHierarchy.
getId() ID da PivotHierarchy.
getName() Nome do PivotHierarchy.
getPivot Obtém um PivotField pelo nome. Se o PivotField não existir, esse método
Field(name) retornará undefined .
setName(name) Nome do PivotHierarchy.
Detalhes do método
getFields()
Retorna PivotFields associados a PivotHierarchy.
TypeScript
Retornos
getId()
ID da PivotHierarchy.
TypeScript
getId(): string;
Retornos
string
getName()
Nome do PivotHierarchy.
TypeScript
getName(): string;
Retornos
string
getPivotField(name)
undefined .
TypeScript
Parâmetros
name string
Retornos
setName(name)
Nome do PivotHierarchy.
TypeScript
Parâmetros
name string
Retornos
void
comentários:
ExcelScript.PivotItem interface
Referência
Pacote: ExcelScript
Representa o Excel PivotItem.
Métodos
getId() ID do PivotItem.
getIsExpanded() Determina se o item está expandido para mostrar itens filho ou se ele
está recolhido e os itens filho estão ocultos.
getName() Nome do PivotItem.
getVisible() Especifica se o PivotItem está visível.
setIsExpanded(is Determina se o item está expandido para mostrar itens filho ou se ele
Expanded) está recolhido e os itens filho estão ocultos.
setName(name) Nome do PivotItem.
setVisible(visible) Especifica se o PivotItem está visível.
Detalhes do método
getId()
ID do PivotItem.
TypeScript
getId(): string;
Retornos
string
getIsExpanded()
Determina se o item está expandido para mostrar itens filho ou se ele está recolhido
e os itens filho estão ocultos.
TypeScript
getIsExpanded(): boolean;
Retornos
boolean
getName()
Nome do PivotItem.
TypeScript
getName(): string;
Retornos
string
getVisible()
Especifica se o PivotItem está visível.
TypeScript
Retornos
boolean
setIsExpanded(isExpanded)
Determina se o item está expandido para mostrar itens filho ou se ele está recolhido
e os itens filho estão ocultos.
TypeScript
setIsExpanded(isExpanded: boolean): void;
Parâmetros
isExpanded boolean
Retornos
void
setName(name)
Nome do PivotItem.
TypeScript
Parâmetros
name string
Retornos
void
setVisible(visible)
Especifica se o PivotItem está visível.
TypeScript
Parâmetros
visible boolean
Retornos
void
comentários:
ExcelScript.PivotLabelFilter interface
Referência
Pacote: ExcelScript
Modelo configurável para um filtro de rótulo a ser aplicado a um PivotField. O

condition define quais critérios precisam ser definidos para que o filtro opere.
Comentários
Exemplos
TypeScript
/**
*/
Sales");

"Limes").
substring: "L",
exclusive: true
};

}
Propriedades

lower O limite inferior do intervalo para a condição de between filtro. Observação: uma
Bound cadeia de caracteres numérica é tratada como um número ao ser comparada com
outras cadeias de caracteres numéricas.
substring A subconserção usada para beginsWith , endsWith e contains condições de filtro.
upper O limite superior do intervalo para a condição de between filtro. Observação: uma
Bound cadeia de caracteres numérica é tratada como um número ao ser comparada com
condition
TypeScript
condition: LabelFilterCondition;
ExcelScript.LabelFilterCondition
exclusive
TypeScript
boolean
lowerBound
O limite inferior do intervalo para a condição de between filtro. Observação: uma
cadeia de caracteres numérica é tratada como um número ao ser comparada com
TypeScript
lowerBound?: string;
string
substring
A subconserção usada para beginsWith , endsWith e contains condições de filtro.
TypeScript
substring?: string;
string
upperBound
O limite superior do intervalo para a condição de between filtro. Observação: uma
cadeia de caracteres numérica é tratada como um número ao ser comparada com
TypeScript
upperBound?: string;
string
comentários:
ExcelScript.PivotLayout interface
Referência
Pacote: ExcelScript
Representa o layout visual da Tabela Dinâmica.
Métodos
getAutoFormat() Especifica se a formatação será formatada automaticamente quando

for atualizada ou quando os campos forem movidos.
getBodyAndTotalRange() Retorna o intervalo onde residem os valores de dados da tabela

dinâmica.
getColumnLabelRange() Retorna o intervalo onde residem os rótulos de coluna da Tabela

Dinâmica.
getDataHierarchy(cell) Obtém o DataHierarchy que é usado para calcular o valor em um

intervalo especificado dentro da Tabela dinâmica.
getEnableFieldList() Especifica se a lista de campos pode ser mostrada na interface do

usuário.
getFilterAxisRange() Retorna o intervalo de área de filtro da Tabela Dinâmica.
getLayoutType() Essa propriedade indica o PivotLayoutType de todos os campos da

Tabela Dinâmica. Se os campos têm diferentes estados, ele será
nulo.
getPreserveFormatting() Especifica se a formatação é preservada quando o relatório é

atualizado ou recalculado por operações como pivotação,
classificação ou alteração de itens de campo de página.
getRange() Retorna o intervalo em que a Tabela Dinâmica existe, excluindo a

área de filtro.
getRowLabelRange() Retorna o intervalo onde residem os rótulos de linha da Tabela

Dinâmica.
getShowColumnGrand Especifica se o relatório de Tabela Dinâmica mostra totais grandes

Totals() para colunas.
getShowRowGrandTotals() Especifica se o relatório de Tabela Dinâmica mostra totais grandes

para linhas.
getSubtotalLocation() Essa propriedade indica o SubtotalLocationType de todos os
campos na Tabela Dinâmica. Se os campos tiverem estados
diferentes, este será null .
setAutoFormat(auto Especifica se a formatação será formatada automaticamente quando

Format) for atualizada ou quando os campos forem movidos.
setAutoSortOnCell(cell, Define a Tabela Dinâmica para classificar automaticamente usando a

sortBy) célula especificada para selecionar automaticamente todos os
critérios e contextos necessários. Funciona de maneira idêntica à
aplicação de uma autoclassificação da interface do usuário.
setEnableFieldList(enable Especifica se a lista de campos pode ser mostrada na interface do

FieldList) usuário.
setLayoutType(layoutType) Essa propriedade indica o PivotLayoutType de todos os campos da

Tabela Dinâmica. Se os campos têm diferentes estados, ele será
nulo.
setPreserve Especifica se a formatação é preservada quando o relatório é

Formatting(preserve atualizado ou recalculado por operações como pivotação,
Formatting) classificação ou alteração de itens de campo de página.
setShowColumnGrand Especifica se o relatório de Tabela Dinâmica mostra totais grandes

Totals(showColumnGrand para colunas.
Totals)
setShowRowGrand Especifica se o relatório de Tabela Dinâmica mostra totais grandes

Totals(showRowGrand para linhas.
Totals)
setSubtotal Essa propriedade indica o SubtotalLocationType de todos os

Location(subtotalLocation) campos na Tabela Dinâmica. Se os campos tiverem estados
diferentes, este será null .
Detalhes do método
getAutoFormat()
Especifica se a formatação será formatada automaticamente quando for atualizada
ou quando os campos forem movidos.
TypeScript
getAutoFormat(): boolean;
Retornos
boolean
getBodyAndTotalRange()
Retorna o intervalo onde residem os valores de dados da tabela dinâmica.
TypeScript
getBodyAndTotalRange(): Range;
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This sample finds the first PivotTable in the workbook and logs the
values in the "Grand Total" cells.
*/
let pivotTable = workbook.getPivotTables()[0];
// Get the names of each data column in the PivotTable.

let pivotColumnLabelRange =
pivotTable.getLayout().getColumnLabelRange();
// Get the range displaying the pivoted data.

let pivotDataRange = pivotTable.getLayout().getBodyAndTotalRange();
// Get the range with the "grand totals" for the PivotTable columns.
let grandTotalRange = pivotDataRange.getLastRow();
// Print each of the "Grand Totals" to the console.

grandTotalRange.getValues()[0].forEach((column, columnIndex) => {
console.log(`Grand total of ${pivotColumnLabelRange.getValues()[0]
[columnIndex]}: ${grandTotalRange.getValues()[0][columnIndex]}`);
// Example log: "Grand total of Sum of Crates Sold Wholesale: 11000"
});
}
getColumnLabelRange()
Retorna o intervalo onde residem os rótulos de coluna da Tabela Dinâmica.
TypeScript
getColumnLabelRange(): Range;
Retornos
ExcelScript.Range
getDataHierarchy(cell)
Obtém o DataHierarchy que é usado para calcular o valor em um intervalo
especificado dentro da Tabela dinâmica.
TypeScript
getDataHierarchy(cell: Range | string): DataPivotHierarchy;
Parâmetros
cell ExcelScript.Range | string
Uma única célula dentro do corpo de dados da Tabela Dinâmica.
Retornos
ExcelScript.DataPivotHierarchy
getEnableFieldList()
Especifica se a lista de campos pode ser mostrada na interface do usuário.
TypeScript
getEnableFieldList(): boolean;
Retornos
boolean
getFilterAxisRange()
Retorna o intervalo de área de filtro da Tabela Dinâmica.
TypeScript
getFilterAxisRange(): Range;
Retornos
ExcelScript.Range
getLayoutType()
Essa propriedade indica o PivotLayoutType de todos os campos da Tabela Dinâmica.
Se os campos têm diferentes estados, ele será nulo.
TypeScript
getLayoutType(): PivotLayoutType;
Retornos
ExcelScript.PivotLayoutType
getPreserveFormatting()
Especifica se a formatação é preservada quando o relatório é atualizado ou
recalculado por operações como pivotação, classificação ou alteração de itens de
campo de página.
TypeScript
getPreserveFormatting(): boolean;
Retornos
boolean
getRange()
Retorna o intervalo em que a Tabela Dinâmica existe, excluindo a área de filtro.
TypeScript
getRange(): Range;
Retornos
ExcelScript.Range
getRowLabelRange()
Retorna o intervalo onde residem os rótulos de linha da Tabela Dinâmica.
TypeScript
getRowLabelRange(): Range;
Retornos
ExcelScript.Range
getShowColumnGrandTotals()
Especifica se o relatório de Tabela Dinâmica mostra totais grandes para colunas.
TypeScript
getShowColumnGrandTotals(): boolean;
Retornos
boolean
getShowRowGrandTotals()
Especifica se o relatório de Tabela Dinâmica mostra totais grandes para linhas.
TypeScript
getShowRowGrandTotals(): boolean;
Retornos
boolean
getSubtotalLocation()
Essa propriedade indica o SubtotalLocationType de todos os campos na Tabela
Dinâmica. Se os campos tiverem estados diferentes, este será null .
TypeScript
getSubtotalLocation(): SubtotalLocationType;
Retornos
ExcelScript.SubtotalLocationType
setAutoFormat(autoFormat)
Especifica se a formatação será formatada automaticamente quando for atualizada
ou quando os campos forem movidos.
TypeScript
setAutoFormat(autoFormat: boolean): void;
Parâmetros
autoFormat boolean
Retornos
void
setAutoSortOnCell(cell, sortBy)
Define a Tabela Dinâmica para classificar automaticamente usando a célula
especificada para selecionar automaticamente todos os critérios e contextos
necessários. Funciona de maneira idêntica à aplicação de uma autoclassificação da
interface do usuário.
TypeScript
setAutoSortOnCell(cell: Range | string, sortBy: SortBy): void;
Parâmetros
cell ExcelScript.Range | string
Uma única célula a ser usada obtém os critérios de para aplicar a variedade
automática.
A direção do tipo.
Retornos
void
setEnableFieldList(enableFieldList)
Especifica se a lista de campos pode ser mostrada na interface do usuário.
TypeScript
setEnableFieldList(enableFieldList: boolean): void;
Parâmetros
enableFieldList boolean
Retornos
void
setLayoutType(layoutType)
Essa propriedade indica o PivotLayoutType de todos os campos da Tabela Dinâmica.
Se os campos têm diferentes estados, ele será nulo.
TypeScript
setLayoutType(layoutType: PivotLayoutType): void;

Parâmetros
layoutType ExcelScript.PivotLayoutType
Retornos
void
Exemplos
TypeScript
/**
"tabular"
* setting. This places the fields from the Rows area in separate
columns.
*/


}
setPreserveFormatting(preserveFormatting)
Especifica se a formatação é preservada quando o relatório é atualizado ou
recalculado por operações como pivotação, classificação ou alteração de itens de
campo de página.
TypeScript
setPreserveFormatting(preserveFormatting: boolean): void;
Parâmetros
preserveFormatting boolean
Retornos
void
setShowColumnGrandTotals(showColumnGrandTotals)
Especifica se o relatório de Tabela Dinâmica mostra totais grandes para colunas.
TypeScript
setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;
Parâmetros
showColumnGrandTotals boolean
Retornos
void
setShowRowGrandTotals(showRowGrandTotals)
Especifica se o relatório de Tabela Dinâmica mostra totais grandes para linhas.
TypeScript
setShowRowGrandTotals(showRowGrandTotals: boolean): void;
Parâmetros
showRowGrandTotals boolean
Retornos
void
setSubtotalLocation(subtotalLocation)
Essa propriedade indica o SubtotalLocationType de todos os campos na Tabela
Dinâmica. Se os campos tiverem estados diferentes, este será null .
TypeScript
setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;
Parâmetros
subtotalLocation ExcelScript.SubtotalLocationType
Retornos
void
Exemplos
TypeScript
/**
* This script displays group subtotals of the "Farms Sales" PivotTable.
*/

// Show all the subtotals at the bottom of each group.

layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
}
comentários:
ExcelScript.PivotManualFilter interface
Referência
Pacote: ExcelScript
Modelo configurável para um filtro manual a ser aplicado a um PivotField. O condition

Comentários
Exemplos
TypeScript
/**
*/
{



const cityFilter: ExcelScript.PivotManualFilter = {
};
// Apply the filter

// Note that hierarchies and fields have a 1:1 relationship in Excel, so
`getFields()[0]` always gets the correct field.
manualFilter: cityFilter
});
}
Propriedades
selected Uma lista de itens selecionados a serem filtrados manualmente. Estes devem ser
Items itens existentes e válidos do campo escolhido.
selectedItems
Uma lista de itens selecionados a serem filtrados manualmente. Estes devem ser
itens existentes e válidos do campo escolhido.
TypeScript
selectedItems?: (string | PivotItem)[];
(string | ExcelScript.PivotItem)[]
comentários:
ExcelScript.PivotTable interface
Referência
Pacote: ExcelScript
Representa uma Tabela Dinâmica do Excel.
Comentários
Exemplos
TypeScript
/**
* This script creates a PivotTable from an existing table and adds it to a
new worksheet.
*/


}
Métodos
addColumnHierarchy(pivot Adiciona o PivotHierarchy ao eixo atual. Se houver hierarquia em

Hierarchy) outro lugar na linha, coluna ou eixo de filtro, ele será removido
desse local.
addDataHierarchy(pivot Adiciona o PivotHierarchy ao eixo atual.

Hierarchy)
addFilterHierarchy(pivot Adiciona o PivotHierarchy ao eixo atual. Se houver hierarquia em
desse local.
addRowHierarchy(pivot Adiciona o PivotHierarchy ao eixo atual. Se houver hierarquia em

desse local.
delete() Exclui a Tabela Dinâmica.
getAllowMultipleFiltersPer Especifica se a Tabela Dinâmica permite a aplicação de vários

Field() PivotFilters em um determinado PivotField na tabela.
getColumnHierarchies() As hierarquias de pivô da coluna da Tabela Dinâmica.
getColumnHierarchy(name) Obtém um RowColumnPivotHierarchy por nome. Se o

RowColumnPivotHierarchy não existir, esse método retornará
undefined .
getDataHierarchies() As hierarquias dinâmicas de dados da Tabela Dinâmica.
getDataHierarchy(name) Obtém uma DataPivotHierarchy por nome. Se o

DataPivotHierarchy não existir, esse método retornará
undefined .
getEnableDataValueEditing() Especifica se a Tabela Dinâmica permite que valores no corpo

dos dados sejam editados pelo usuário.
getFilterHierarchies() As hierarquias de pivô do filtro da Tabela Dinâmica.
getFilterHierarchy(name) Obtém um FilterPivotHierarchy por nome. Se o

FilterPivotHierarchy não existir, esse método retornará
undefined .
getHierarchies() Hierarquias pivô da Tabela Dinâmica.
getHierarchy(name) Obtém o PivotHierarchy por nome. Se a PivotHierarchy não

getId() ID da Tabela Dinâmica.
getLayout() O PivotLayout descreve o layout e estrutura visual da Tabela

Dinâmica.
getName() Nome da Tabela Dinâmica.
getRowHierarchies() As hierarquias de pivô de linha da Tabela Dinâmica.
getRowHierarchy(name) Obtém um RowColumnPivotHierarchy por nome. Se o

RowColumnPivotHierarchy não existir, esse método retornará
undefined .
getUseCustomSortLists() Especifica se a Tabela Dinâmica usa listas personalizadas ao
classificar.
getWorksheet() A planilha que contém a Tabela Dinâmica atual.
refresh() Atualiza a Tabela Dinâmica.
removeColumnHierarchy(row Remove o PivotHierarchy do eixo atual.

ColumnPivotHierarchy)
removeDataHierarchy(Data Remove o PivotHierarchy do eixo atual.

PivotHierarchy)
removeFilterHierarchy(filter Remove o PivotHierarchy do eixo atual.

PivotHierarchy)
removeRowHierarchy(row Remove o PivotHierarchy do eixo atual.

ColumnPivotHierarchy)
setAllowMultipleFiltersPer Especifica se a Tabela Dinâmica permite a aplicação de vários

Field(allowMultipleFiltersPer PivotFilters em um determinado PivotField na tabela.
Field)
setEnableDataValue Especifica se a Tabela Dinâmica permite que valores no corpo

Editing(enableDataValue dos dados sejam editados pelo usuário.
Editing)
setName(name) Nome da Tabela Dinâmica.
setUseCustomSortLists(use Especifica se a Tabela Dinâmica usa listas personalizadas ao

CustomSortLists) classificar.
Detalhes do método
addColumnHierarchy(pivotHierarchy)
Adiciona o PivotHierarchy ao eixo atual. Se houver hierarquia em outro lugar na
linha, coluna ou eixo de filtro, ele será removido desse local.
TypeScript
addColumnHierarchy(
pivotHierarchy: PivotHierarchy
): RowColumnPivotHierarchy;
Parâmetros
pivotHierarchy ExcelScript.PivotHierarchy
Retornos
ExcelScript.RowColumnPivotHierarchy
Exemplos
TypeScript
/**
* This script adds a row hierarchy to the PivotTable on the current
worksheet.
* This assumes the source data has columns named
* "Type", "Classification", and "Sales".
*/
// Add the field "Type" to the PivotTable as a row hierarchy.

// Add the field "Classification" to the PivotTable as a column

hierarchy.
pivotTable.addColumnHierarchy(pivotTable.getHierarchy("Classification"));
// Add the field "Sales" to the PivotTable as a data hierarchy.

// By default, this displays the sums of the values in "Sales" based on
the "Type".
}
addDataHierarchy(pivotHierarchy)
Adiciona o PivotHierarchy ao eixo atual.
TypeScript
addDataHierarchy(pivotHierarchy: PivotHierarchy): DataPivotHierarchy;
Parâmetros
Retornos
ExcelScript.DataPivotHierarchy
Exemplos
TypeScript
/**
* This script creates a PivotTable from an existing table and adds it to
a new worksheet.
*/


}
addFilterHierarchy(pivotHierarchy)
TypeScript
addFilterHierarchy(
): FilterPivotHierarchy;
Parâmetros
Retornos
ExcelScript.FilterPivotHierarchy
Exemplos
TypeScript
/**
*/
{



// Note that hierarchies and fields have a 1:1 relationship in Excel,
// so `getFields()[0]` always gets the correct field.
manualFilter: {
}
});
}
addRowHierarchy(pivotHierarchy)
TypeScript
addRowHierarchy(
): RowColumnPivotHierarchy;
Parâmetros
Retornos
Exemplos
TypeScript
/**
a new worksheet.
*/


}
delete()
Exclui a Tabela Dinâmica.
TypeScript
delete(): void;
Retornos
void
getAllowMultipleFiltersPerField()
Especifica se a Tabela Dinâmica permite a aplicação de vários PivotFilters em um
determinado PivotField na tabela.
TypeScript
getAllowMultipleFiltersPerField(): boolean;
Retornos
boolean
getColumnHierarchies()
As hierarquias de pivô da coluna da Tabela Dinâmica.
TypeScript
getColumnHierarchies(): RowColumnPivotHierarchy[];
Retornos
ExcelScript.RowColumnPivotHierarchy[]
getColumnHierarchy(name)
Obtém um RowColumnPivotHierarchy por nome. Se o RowColumnPivotHierarchy
não existir, esse método retornará undefined .
TypeScript
getColumnHierarchy(name: string): RowColumnPivotHierarchy | undefined;
Parâmetros
name string
Nome da RowColumnPivotHierarchy a ser recuperada.
Retornos
ExcelScript.RowColumnPivotHierarchy | undefined
getDataHierarchies()
As hierarquias dinâmicas de dados da Tabela Dinâmica.
TypeScript
getDataHierarchies(): DataPivotHierarchy[];
Retornos
ExcelScript.DataPivotHierarchy[]
getDataHierarchy(name)
Obtém uma DataPivotHierarchy por nome. Se o DataPivotHierarchy não existir, esse
TypeScript
getDataHierarchy(name: string): DataPivotHierarchy | undefined;
Parâmetros
name string
Nome do DataPivotHierarchy a ser recuperado.
Retornos
ExcelScript.DataPivotHierarchy | undefined
getEnableDataValueEditing()
Especifica se a Tabela Dinâmica permite que valores no corpo dos dados sejam
editados pelo usuário.
TypeScript
getEnableDataValueEditing(): boolean;
Retornos
boolean
getFilterHierarchies()
As hierarquias de pivô do filtro da Tabela Dinâmica.
TypeScript
getFilterHierarchies(): FilterPivotHierarchy[];
Retornos
ExcelScript.FilterPivotHierarchy[]
getFilterHierarchy(name)
Obtém um FilterPivotHierarchy por nome. Se o FilterPivotHierarchy não existir, esse
TypeScript
getFilterHierarchy(name: string): FilterPivotHierarchy | undefined;
Parâmetros
name string
Nome do FilterPivotHierarchy a ser recuperado.
Retornos
ExcelScript.FilterPivotHierarchy | undefined
getHierarchies()
Hierarquias pivô da Tabela Dinâmica.
TypeScript
getHierarchies(): PivotHierarchy[];
Retornos
ExcelScript.PivotHierarchy[]
getHierarchy(name)
Obtém o PivotHierarchy por nome. Se a PivotHierarchy não existir, esse método
TypeScript
getHierarchy(name: string): PivotHierarchy | undefined;
Parâmetros
name string
Nome do PivotHierarchy a ser recuperado.
Retornos
ExcelScript.PivotHierarchy | undefined
getId()
ID da Tabela Dinâmica.
TypeScript
getId(): string;
Retornos
string
getLayout()
O PivotLayout descreve o layout e estrutura visual da Tabela Dinâmica.
TypeScript
getLayout(): PivotLayout;
Retornos
ExcelScript.PivotLayout
Exemplos
TypeScript
/**
"tabular"
* setting. This places the fields from the Rows area in separate
columns.
*/


}
getName()
Nome da Tabela Dinâmica.
TypeScript
getName(): string;
Retornos
string
getRowHierarchies()
As hierarquias de pivô de linha da Tabela Dinâmica.
TypeScript
getRowHierarchies(): RowColumnPivotHierarchy[];
Retornos
ExcelScript.RowColumnPivotHierarchy[]
getRowHierarchy(name)
Obtém um RowColumnPivotHierarchy por nome. Se o RowColumnPivotHierarchy
TypeScript
getRowHierarchy(name: string): RowColumnPivotHierarchy | undefined;
Parâmetros
name string
Nome da RowColumnPivotHierarchy a ser recuperada.
Retornos
ExcelScript.RowColumnPivotHierarchy | undefined
Exemplos
TypeScript
/**
*/

const valueFieldToSortOn = pivotTable.getDataHierarchy("Sum of Crates
Sold Wholesale");

const rowToSort = pivotTable.getRowHierarchy("Farm");
// Sort the "Farm" row's only field by the values in "Sum of Crates
Sold Wholesale".
}
getUseCustomSortLists()
Especifica se a Tabela Dinâmica usa listas personalizadas ao classificar.
TypeScript
getUseCustomSortLists(): boolean;
Retornos
boolean
getWorksheet()
A planilha que contém a Tabela Dinâmica atual.
TypeScript
Retornos
refresh()
Atualiza a Tabela Dinâmica.
TypeScript
refresh(): void;
Retornos
void
removeColumnHierarchy(rowColumnPivotHierarchy)
Remove o PivotHierarchy do eixo atual.
TypeScript
removeColumnHierarchy(
rowColumnPivotHierarchy: RowColumnPivotHierarchy
): void;
Parâmetros
rowColumnPivotHierarchy ExcelScript.RowColumnPivotHierarchy
Retornos
void
removeDataHierarchy(DataPivotHierarchy)
TypeScript
removeDataHierarchy(DataPivotHierarchy: DataPivotHierarchy): void;
Parâmetros
DataPivotHierarchy ExcelScript.DataPivotHierarchy
Retornos
void
removeFilterHierarchy(filterPivotHierarchy)
TypeScript
removeFilterHierarchy(filterPivotHierarchy: FilterPivotHierarchy): void;
Parâmetros
filterPivotHierarchy ExcelScript.FilterPivotHierarchy
Retornos
void
removeRowHierarchy(rowColumnPivotHierarchy)
TypeScript
removeRowHierarchy(
rowColumnPivotHierarchy: RowColumnPivotHierarchy
): void;
Parâmetros
rowColumnPivotHierarchy ExcelScript.RowColumnPivotHierarchy
Retornos
void
setAllowMultipleFiltersPerField(allowMultipleFiltersPer
Field)
Especifica se a Tabela Dinâmica permite a aplicação de vários PivotFilters em um
determinado PivotField na tabela.
TypeScript
setAllowMultipleFiltersPerField(
allowMultipleFiltersPerField: boolean
): void;
Parâmetros
allowMultipleFiltersPerField boolean
Retornos
void
setEnableDataValueEditing(enableDataValueEditing)
Especifica se a Tabela Dinâmica permite que valores no corpo dos dados sejam
editados pelo usuário.
TypeScript
setEnableDataValueEditing(enableDataValueEditing: boolean): void;

Parâmetros
enableDataValueEditing boolean
Retornos
void
setName(name)
Nome da Tabela Dinâmica.
TypeScript
Parâmetros
name string
Retornos
void
setUseCustomSortLists(useCustomSortLists)
Especifica se a Tabela Dinâmica usa listas personalizadas ao classificar.
TypeScript
setUseCustomSortLists(useCustomSortLists: boolean): void;
Parâmetros
useCustomSortLists boolean
Retornos
void
comentários:
ExcelScript.PivotTableStyle interface
Referência
Pacote: ExcelScript
Representa um estilo de Tabela Dinâmica, que define elementos de estilo por região de
Tabela Dinâmica.
Métodos
delete() Exclui o estilo de Tabela Dinâmica.
duplicate() Cria uma duplicata desse estilo de Tabela Dinâmica com cópias de todos os
elementos de estilo.
getName() Especifica o nome do estilo tabela dinâmica.
getReadOnly() Especifica se esse PivotTableStyle objeto é somente leitura.
set Especifica o nome do estilo tabela dinâmica.

Name(name)
Detalhes do método
delete()
Exclui o estilo de Tabela Dinâmica.
TypeScript
delete(): void;
Retornos
void
duplicate()
Cria uma duplicata desse estilo de Tabela Dinâmica com cópias de todos os
TypeScript
duplicate(): PivotTableStyle;
Retornos
ExcelScript.PivotTableStyle
getName()
Especifica o nome do estilo tabela dinâmica.
TypeScript
getName(): string;
Retornos
string
getReadOnly()
Especifica se esse PivotTableStyle objeto é somente leitura.
TypeScript
getReadOnly(): boolean;
Retornos
boolean
setName(name)
Especifica o nome do estilo tabela dinâmica.
TypeScript
Parâmetros
name string
Retornos
void
comentários:
ExcelScript.PivotValueFilter interface
Referência
Pacote: ExcelScript
Modelo configurável para um filtro de valor a ser aplicado a um PivotField. O condition

Comentários
Exemplos
TypeScript
/**
* This script applies a PivotValueFilter to the first row hierarchy in the
PivotTable.
*/
rows.

comparator: 500,
};

valueFilter: filter
});
}
Propriedades
comparator O comparador é o valor estático ao qual outros valores são comparados. O tipo de
comparação é definido pela condição. Por exemplo, se o comparador for "50" e a
condição for "maiorThan", todos os valores de item que não forem maiores que 50
serão removidos pelo filtro.
lowerBound O limite inferior do intervalo para a condição de between filtro.
selection Especifica se o filtro é para os itens N superior/inferior, N% superior/inferior ou

Type soma N superior/inferior.
threshold O número de limite "N" de itens, percentual ou soma a ser filtrada para uma
condição de filtro superior/inferior.
upper O limite superior do intervalo para a condição de between filtro.

Bound
value Nome do "valor" escolhido no campo pelo qual filtrar.
comparator
O comparador é o valor estático ao qual outros valores são comparados. O tipo de
comparação é definido pela condição. Por exemplo, se o comparador for "50" e a
condição for "maiorThan", todos os valores de item que não forem maiores que 50
serão removidos pelo filtro.
TypeScript
comparator?: number;
number
condition
TypeScript
condition: ValueFilterCondition;
ExcelScript.ValueFilterCondition
exclusive
TypeScript
boolean
lowerBound
O limite inferior do intervalo para a condição de between filtro.
TypeScript
lowerBound?: number;
number
selectionType
Especifica se o filtro é para os itens N superior/inferior, N% superior/inferior ou soma
N superior/inferior.
TypeScript
selectionType?: TopBottomSelectionType;
ExcelScript.TopBottomSelectionType
threshold
O número de limite "N" de itens, percentual ou soma a ser filtrada para uma
condição de filtro superior/inferior.
TypeScript
threshold?: number;
number
upperBound
O limite superior do intervalo para a condição de between filtro.
TypeScript
upperBound?: number;
number
value
Nome do "valor" escolhido no campo pelo qual filtrar.
TypeScript
value: string;
string
comentários:
ExcelScript.PredefinedCellStyle interface
Referência
Pacote: ExcelScript
Um objeto encapsulando o formato de um estilo e outras propriedades.
Métodos
delete() Exclui este estilo.
getAutoIndent() Especifica se o texto é recuado automaticamente quando o

alinhamento de texto em uma célula é definido como distribuição
igual.
getBorders() Uma coleção de quatro objetos de borda que representam o estilo

das quatro bordas.
getBuiltIn() Especifica se o estilo é um estilo interno.
getFill() O preenchimento do estilo.
getFont() Um Font objeto que representa a fonte do estilo.
getFormulaHidden() Especifica se a fórmula será ocultada quando a planilha estiver

protegida.
getHorizontalAlignment() Representa o alinhamento horizontal para o estilo. Confira

ExcelScript.HorizontalAlignment detalhes.
getIncludeAlignment() Especifica se o estilo inclui as propriedades de recuo automático,

alinhamento horizontal, alinhamento vertical, texto de envoltório,
nível de recuo e orientação de texto.
getIncludeBorder() Especifica se o estilo inclui as propriedades color, color index, line

style e weight border.
getIncludeFont() Especifica se o estilo inclui as propriedades de fonte em segundo

plano, negrito, cor, índice de cores, estilo de fonte, itálico, nome,
tamanho, strikethrough, subscript, superscript e sublinhar as
propriedades da fonte.
getIncludeNumber() Especifica se o estilo inclui a propriedade de formato de número.
getIncludePatterns() Especifica se o estilo inclui as propriedades interiores color, color

index, invert if negative, pattern, pattern color e pattern color index.
getIncludeProtection() Especifica se o estilo inclui as propriedades de proteção ocultas e
bloqueadas da fórmula.
getIndentLevel() Um número inteiro entre 0 e 250 que indica o nível de recuo do

estilo.
getLocked() Especifica se o objeto está bloqueado quando a planilha é

protegida.
getName() O nome do estilo.
getNumberFormat() O código de formatação de formato de número para o estilo.
getNumberFormatLocal() O código de formato localizado do formato numérico para o estilo.
getRangeBorder(index) Obtém um objeto Border usando o respectivo nome.
getRangeBorderTintAnd Especifica um duplo que clareia ou escure uma cor para bordas de
Shade() intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0
para a cor original. Um null valor indica que toda a coleção de
bordas não tem uma configuração uniforme tintAndShade .
getReadingOrder() A ordem de leitura para o estilo.
getShrinkToFit() Especifica se o texto reduz automaticamente para se encaixar na

largura da coluna disponível.
getTextOrientation() A orientação de texto para o estilo.
getVerticalAlignment() Especifica o alinhamento vertical para o estilo. Confira

ExcelScript.VerticalAlignment detalhes.
getWrapText() Especifica se o Excel encapsula o texto no objeto.
setAutoIndent(autoIndent) Especifica se o texto é recuado automaticamente quando o

alinhamento de texto em uma célula é definido como distribuição
igual.
setFormulaHidden(formula Especifica se a fórmula será ocultada quando a planilha estiver

Hidden) protegida.
setHorizontal Representa o alinhamento horizontal para o estilo. Confira

Alignment(horizontal ExcelScript.HorizontalAlignment detalhes.
Alignment)
setInclude Especifica se o estilo inclui as propriedades de recuo automático,

Alignment(include alinhamento horizontal, alinhamento vertical, texto de envoltório,
Alignment) nível de recuo e orientação de texto.
setIncludeBorder(include Especifica se o estilo inclui as propriedades color, color index, line

Border) style e weight border.
setIncludeFont(include Especifica se o estilo inclui as propriedades de fonte em segundo
Font) plano, negrito, cor, índice de cores, estilo de fonte, itálico, nome,
tamanho, strikethrough, subscript, superscript e sublinhar as
propriedades da fonte.
setIncludeNumber(include Especifica se o estilo inclui a propriedade de formato de número.

Number)
setIncludePatterns(include Especifica se o estilo inclui as propriedades interiores color, color

Patterns) index, invert if negative, pattern, pattern color e pattern color index.
setInclude Especifica se o estilo inclui as propriedades de proteção ocultas e

Protection(include bloqueadas da fórmula.
Protection)
setIndentLevel(indent Um número inteiro entre 0 e 250 que indica o nível de recuo do

Level) estilo.
setLocked(locked) Especifica se o objeto está bloqueado quando a planilha é

protegida.
setNumberFormat(number O código de formatação de formato de número para o estilo.

Format)
setNumberFormat O código de formato localizado do formato numérico para o estilo.

Local(numberFormatLocal)
setRangeBorderTintAnd Especifica um duplo que clareia ou escure uma cor para bordas de
Shade(rangeBorderTint intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0
AndShade) para a cor original. Um null valor indica que toda a coleção de
setReadingOrder(reading A ordem de leitura para o estilo.

Order)
setShrinkToFit(shrinkToFit) Especifica se o texto reduz automaticamente para se encaixar na

setTextOrientation(text A orientação de texto para o estilo.

Orientation)
setVertical Especifica o alinhamento vertical para o estilo. Confira

Alignment(vertical ExcelScript.VerticalAlignment detalhes.
Alignment)
setWrapText(wrapText) Especifica se o Excel encapsula o texto no objeto.
Detalhes do método
delete()
Exclui este estilo.
TypeScript
delete(): void;
Retornos
void
getAutoIndent()
Especifica se o texto é recuado automaticamente quando o alinhamento de texto em
uma célula é definido como distribuição igual.
TypeScript
getAutoIndent(): boolean;
Retornos
boolean
getBorders()
Uma coleção de quatro objetos de borda que representam o estilo das quatro
bordas.
TypeScript
getBorders(): RangeBorder[];
Retornos
ExcelScript.RangeBorder[]
getBuiltIn()
Especifica se o estilo é um estilo interno.
TypeScript
getBuiltIn(): boolean;
Retornos
boolean
getFill()
O preenchimento do estilo.
TypeScript
getFill(): RangeFill;
Retornos
ExcelScript.RangeFill
getFont()
Um Font objeto que representa a fonte do estilo.
TypeScript
getFont(): RangeFont;
Retornos
ExcelScript.RangeFont
getFormulaHidden()
Especifica se a fórmula será ocultada quando a planilha estiver protegida.
TypeScript
getFormulaHidden(): boolean;
Retornos
boolean
Representa o alinhamento horizontal para o estilo. Confira
TypeScript
getHorizontalAlignment(): HorizontalAlignment;
Retornos
getIncludeAlignment()
Especifica se o estilo inclui as propriedades de recuo automático, alinhamento
horizontal, alinhamento vertical, texto de envoltório, nível de recuo e orientação de
texto.
TypeScript
getIncludeAlignment(): boolean;
Retornos
boolean
getIncludeBorder()
Especifica se o estilo inclui as propriedades color, color index, line style e weight
border.
TypeScript
getIncludeBorder(): boolean;
Retornos
boolean
getIncludeFont()
Especifica se o estilo inclui as propriedades de fonte em segundo plano, negrito, cor,
índice de cores, estilo de fonte, itálico, nome, tamanho, strikethrough, subscript,
superscript e sublinhar as propriedades da fonte.
TypeScript
getIncludeFont(): boolean;
Retornos
boolean
getIncludeNumber()
Especifica se o estilo inclui a propriedade de formato de número.
TypeScript
getIncludeNumber(): boolean;
Retornos
boolean
getIncludePatterns()
Especifica se o estilo inclui as propriedades interiores color, color index, invert if
negative, pattern, pattern color e pattern color index.
TypeScript
getIncludePatterns(): boolean;
Retornos
boolean
getIncludeProtection()
Especifica se o estilo inclui as propriedades de proteção ocultas e bloqueadas da
fórmula.
TypeScript
getIncludeProtection(): boolean;
Retornos
boolean
getIndentLevel()
Um número inteiro entre 0 e 250 que indica o nível de recuo do estilo.
TypeScript
getIndentLevel(): number;
Retornos
number
getLocked()
Especifica se o objeto está bloqueado quando a planilha é protegida.
TypeScript
getLocked(): boolean;
Retornos
boolean
getName()
O nome do estilo.
TypeScript
getName(): string;
Retornos
string
getNumberFormat()
O código de formatação de formato de número para o estilo.
TypeScript
Retornos
string
getNumberFormatLocal()
O código de formato localizado do formato numérico para o estilo.
TypeScript
getNumberFormatLocal(): string;
Retornos
string
getRangeBorder(index)
TypeScript
getRangeBorder(index: BorderIndex): RangeBorder;

Parâmetros
index ExcelScript.BorderIndex
Valor de índice do objeto Border a ser recuperado. Confira ExcelScript.BorderIndex
detalhes.
Retornos
ExcelScript.RangeBorder
getRangeBorderTintAndShade()
Especifica um duplo que clareia ou escure uma cor para bordas de intervalo. O valor
é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null
valor indica que toda a coleção de bordas não tem uma configuração uniforme
tintAndShade .
TypeScript
getRangeBorderTintAndShade(): number;
Retornos
number
getReadingOrder()
A ordem de leitura para o estilo.
TypeScript
getReadingOrder(): ReadingOrder;
Retornos
getShrinkToFit()
Especifica se o texto reduz automaticamente para se encaixar na largura da coluna
disponível.
TypeScript
getShrinkToFit(): boolean;
Retornos
boolean
A orientação de texto para o estilo.
TypeScript
Retornos
number
Especifica o alinhamento vertical para o estilo. Confira
TypeScript
getVerticalAlignment(): VerticalAlignment;
Retornos
getWrapText()
Especifica se o Excel encapsula o texto no objeto.
TypeScript
getWrapText(): boolean;
Retornos
boolean
setAutoIndent(autoIndent)
Especifica se o texto é recuado automaticamente quando o alinhamento de texto em
uma célula é definido como distribuição igual.
TypeScript
setAutoIndent(autoIndent: boolean): void;
Parâmetros
autoIndent boolean
Retornos
void
setFormulaHidden(formulaHidden)
Especifica se a fórmula será ocultada quando a planilha estiver protegida.
TypeScript
setFormulaHidden(formulaHidden: boolean): void;
Parâmetros
formulaHidden boolean
Retornos
void
Representa o alinhamento horizontal para o estilo. Confira
TypeScript
setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;
Parâmetros
horizontalAlignment ExcelScript.HorizontalAlignment
Retornos
void
setIncludeAlignment(includeAlignment)
Especifica se o estilo inclui as propriedades de recuo automático, alinhamento
horizontal, alinhamento vertical, texto de envoltório, nível de recuo e orientação de
texto.
TypeScript
setIncludeAlignment(includeAlignment: boolean): void;
Parâmetros
includeAlignment boolean
Retornos
void
setIncludeBorder(includeBorder)
Especifica se o estilo inclui as propriedades color, color index, line style e weight
border.
TypeScript
setIncludeBorder(includeBorder: boolean): void;
Parâmetros
includeBorder boolean
Retornos
void
setIncludeFont(includeFont)
Especifica se o estilo inclui as propriedades de fonte em segundo plano, negrito, cor,
índice de cores, estilo de fonte, itálico, nome, tamanho, strikethrough, subscript,
superscript e sublinhar as propriedades da fonte.
TypeScript
setIncludeFont(includeFont: boolean): void;
Parâmetros
includeFont boolean
Retornos
void
setIncludeNumber(includeNumber)
Especifica se o estilo inclui a propriedade de formato de número.
TypeScript
setIncludeNumber(includeNumber: boolean): void;
Parâmetros
includeNumber boolean
Retornos
void
setIncludePatterns(includePatterns)
Especifica se o estilo inclui as propriedades interiores color, color index, invert if
negative, pattern, pattern color e pattern color index.
TypeScript
setIncludePatterns(includePatterns: boolean): void;
Parâmetros
includePatterns boolean
Retornos
void
setIncludeProtection(includeProtection)
Especifica se o estilo inclui as propriedades de proteção ocultas e bloqueadas da
fórmula.
TypeScript
setIncludeProtection(includeProtection: boolean): void;
Parâmetros
includeProtection boolean
Retornos
void
setIndentLevel(indentLevel)
Um número inteiro entre 0 e 250 que indica o nível de recuo do estilo.
TypeScript
setIndentLevel(indentLevel: number): void;
Parâmetros
indentLevel number
Retornos
void
setLocked(locked)
Especifica se o objeto está bloqueado quando a planilha é protegida.
TypeScript
setLocked(locked: boolean): void;
Parâmetros
locked boolean
Retornos
void
O código de formatação de formato de número para o estilo.
TypeScript
Parâmetros
numberFormat string
Retornos
void
setNumberFormatLocal(numberFormatLocal)
O código de formato localizado do formato numérico para o estilo.
TypeScript
setNumberFormatLocal(numberFormatLocal: string): void;
Parâmetros
numberFormatLocal string
Retornos
void
setRangeBorderTintAndShade(rangeBorderTintAnd
Shade)
tintAndShade .
TypeScript
setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;
Parâmetros
rangeBorderTintAndShade number
Retornos
void
setReadingOrder(readingOrder)
A ordem de leitura para o estilo.
TypeScript
setReadingOrder(readingOrder: ReadingOrder): void;

Parâmetros
readingOrder ExcelScript.ReadingOrder
Retornos
void
setShrinkToFit(shrinkToFit)
disponível.
TypeScript
setShrinkToFit(shrinkToFit: boolean): void;
Parâmetros
shrinkToFit boolean
Retornos
void
A orientação de texto para o estilo.
TypeScript
Parâmetros
Retornos
void
Especifica o alinhamento vertical para o estilo. Confira
TypeScript
setVerticalAlignment(verticalAlignment: VerticalAlignment): void;
Parâmetros
verticalAlignment ExcelScript.VerticalAlignment
Retornos
void
setWrapText(wrapText)
Especifica se o Excel encapsula o texto no objeto.
TypeScript
setWrapText(wrapText: boolean): void;
Parâmetros
wrapText boolean
Retornos
void
comentários:
ExcelScript.PresetCriteriaConditional
Format interface
Referência
Pacote: ExcelScript
Representa o formato condicional de critérios predefinidos, como valores acima da

média, abaixo da média, exclusivos, contém em branco, nãoblank, erro e noerror.
Comentários
Exemplos
TypeScript
/**
duplicate value
*/


const presetFormat: ExcelScript.PresetCriteriaConditionalFormat =
conditionalFormat.getPreset();
in the range.
};
}
Métodos

getRule() A regra da formatação condicional.
set A regra da formatação condicional.

Rule(rule)
Detalhes do método
getFormat()
TypeScript
Retornos
getRule()
A regra da formatação condicional.
TypeScript
getRule(): ConditionalPresetCriteriaRule;
Retornos
ExcelScript.ConditionalPresetCriteriaRule
setRule(rule)
TypeScript
setRule(rule: ConditionalPresetCriteriaRule): void;
Parâmetros
rule ExcelScript.ConditionalPresetCriteriaRule
Retornos
void
comentários:
ExcelScript.Range interface
Referência
Pacote: ExcelScript
O intervalo representa um conjunto de uma ou mais células contíguas, como uma

célula, uma linha, uma coluna ou um bloco de células.
Comentários
Exemplos
TypeScript
/**
* This script logs the address of the used range in the current worksheet.
*/
// Get the range containing all the cells with data or formatting.
let usedRange = currentWorksheet.getUsedRange();
// Log the range's address to the console.

console.log(usedRange.getAddress());
}
Métodos
addConditionalFormat(type) Adiciona um novo formato condicional à coleção na prioridade

de primeira/superior.
autoFill(destinationRange, auto Preenche um intervalo do intervalo atual até o intervalo de

FillType) destino usando a lógica autofill especificada. O intervalo de
destino pode ser null ou pode estender o intervalo de origem
horizontal ou verticalmente. Não há suporte para intervalos
discontiguos.
calculate() Calcula um intervalo de células em uma planilha.

clear(applyTo) Limpe valores de intervalo, formatação, preenchimento, bordas,
etc.
clearAllConditionalFormats() Limpa todos os formatos condicionais ativos no intervalo atual

especificado.
convertDataTypeToText() Converte as células de intervalo com tipos de dados em texto.
copyFrom(sourceRange, copy Copia dados de célula ou formatação do intervalo de origem

Type, skipBlanks, transpose) ou RangeAreas para o intervalo atual. O intervalo de destino
pode ser um tamanho diferente do intervalo de origem ou
RangeAreas . O destino será expandido automaticamente se for
menor que a origem. Observação: como a funcionalidade de
cópia na interface do usuário do Excel, se o intervalo de destino
for um múltiplo exato maior que o intervalo de origem em
linhas ou colunas, o conteúdo de origem será replicado várias
vezes. Por exemplo, uma cópia de intervalo 2x2 em um
intervalo de 2x6 resultará em três cópias do intervalo 2x2
original.
delete(shift) Exclui as células associadas ao intervalo.
find(text, criteria) Localiza certa cadeia de caracteres com base em critérios

especificados. Se o intervalo atual for maior que uma única
célula, a pesquisa será limitada a esse intervalo, caso contrário,
a pesquisa cobrirá toda a planilha a partir dessa célula. Se não
houver correspondências, esse método retornará undefined .
flashFill() Faz um Preenchimento Flash para o intervalo atual. O

Preenchimento Flash preenche automaticamente os dados
quando ele sente um padrão, portanto, o intervalo deve ser um
único intervalo de colunas e ter dados ao seu redor para
encontrar um padrão.
getAbsoluteResizedRange(num Obtém um Range objeto com a mesma célula superior

Rows, numColumns) esquerda que o objeto atual Range , mas com os números
especificados de linhas e colunas.
getAddress() Especifica a referência de intervalo no estilo A1. O valor do

endereço contém a referência da planilha (por exemplo,
"Sheet1! A1:B4").
getAddressLocal() Representa a referência de intervalo para o intervalo

especificado no idioma do usuário.
getBoundingRect(another Obtém o menor objeto de intervalo que abrange os intervalos

Range) determinados. Por exemplo, o GetBoundingRect de "B2:C5" e
"D10:E15" é "B2:E15".
getCell(row, column) Obtém o objeto de intervalo que contém a célula única com
base nos números de linha e de coluna. A célula pode estar
fora dos limites de seu intervalo pai, desde que permaneça
dentro da grade da planilha. A localização da célula retornada
está relacionada à célula superior esquerda do intervalo.
getCellCount() Especifica o número de células no intervalo. Essa API retornará

-1 se a contagem de células exceder 2^31-1 (2.147.483.647).
getColumn(column) Obtém uma coluna incluída no intervalo.
getColumnCount() Especifica o número total de colunas no intervalo.
getColumnHidden() Representa se todas as colunas no intervalo atual estiverem

ocultas. O valor é true quando todas as colunas em um
intervalo são ocultas. O valor é false quando nenhuma coluna
no intervalo está oculta. O valor é null quando algumas
colunas em um intervalo são ocultas e outras colunas no
mesmo intervalo não são ocultas.
getColumnIndex() Especifica o número de coluna da primeira célula no intervalo.

Indexados com zero.
getColumnsAfter(count) Obtém um determinado número de colunas à direita do objeto

atual Range .
getColumnsBefore(count) Obtém um determinado número de colunas à esquerda do

objeto atual Range .
getConditionalFormat(id) Retorna um formato condicional identificado por sua ID. Se o

objeto de formato condicional não existir, esse método
getConditionalFormats() A coleção do ConditionalFormats que cruza o intervalo.
getDataValidation() Retorna um objeto de validação de dados.
getDirectPrecedents() Retorna um WorkbookRangeAreas objeto que representa o

intervalo que contém todas as células precedentes diretas de
um intervalo especificado na mesma planilha ou em várias
planilhas.
getEntireColumn() Obtém um objeto que representa toda a coluna do intervalo

(por exemplo, se o intervalo atual representa as células
"B4:E11", ele getEntireColumn é um intervalo que representa as
colunas "B:E").
getEntireRow() Obtém um objeto que representa toda a linha do intervalo (por

exemplo, se o intervalo atual representa as células "B4:E11", ele
GetEntireRow é um intervalo que representa as linhas "4:11").
getExtendedRange(direction, Retorna um objeto de intervalo que inclui o intervalo atual e até

activeCell) a borda do intervalo, com base na direção fornecida. Isso
corresponde ao comportamento da chave Ctrl+Shift+Arrow no
Excel na interface do usuário do Windows.
getFormat() Retorna um objeto de formato que encapsula a fonte, o

preenchimento, as bordas, o alinhamento e outras
propriedades do intervalo.
getFormula() Representa a fórmula de célula na notação de estilo A1. Se o

intervalo contiver várias células, os dados da primeira célula
(representados pelo índice de linha 0 e índice de coluna de 0)
serão retornados.
getFormulaLocal() Representa a fórmula da célula na notação de estilo A1, na

linguagem do usuário e na localidade de formatação de
números. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês
seria "=SOMA(A1; 1,5)" em português. Se o intervalo contiver
várias células, os dados da primeira célula (representados pelo
índice de linha 0 e índice de coluna de 0) serão retornados.
getFormulaR1C1() Representa a fórmula de célula na notação no estilo R1C1. Se o

intervalo contiver várias células, os dados da primeira célula
serão retornados.
getFormulas() Representa a fórmula em notação A1. Se uma célula não tiver

fórmula, seu valor será retornado.
getFormulasLocal() Representa a fórmula em notação A1, na formatação de

número da localidade e no idioma do usuário. Por exemplo, a
fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em
português. Se uma célula não tiver fórmula, seu valor será
retornado.
getFormulasR1C1() Representa a fórmula em notação no estilo L1C1. Se uma célula

não tiver fórmula, seu valor será retornado.
getHasSpill() Representa se todas as células têm uma borda de despejo.

Retorna true se todas as células tiverem uma borda de
derramamento ou false se todas as células não tiverem uma
borda de derramamento. Retornará null se houver células com
e sem bordas de derramamento dentro do intervalo.
getHeight() Retorna a distância em pontos, para 100% de zoom, da borda

superior do intervalo até a borda inferior do intervalo.
getHidden() Representa se todas as células do intervalo atual estiverem

ocultas. O valor é true quando todas as células em um
intervalo são ocultas. O valor é false quando nenhuma célula
no intervalo está oculta. O valor é null quando algumas células
em um intervalo estão ocultas e outras células no mesmo
intervalo não estão ocultas.
getHyperlink() Representa o hiperlink para o intervalo atual.
getImage() Renderiza o intervalo como uma imagem png codificada com

base64.
getIntersection(anotherRange) Obtém o objeto de intervalo que representa a interseção

retangular dos intervalos determinados. Se nenhuma interseção
for encontrada, esse método retornará undefined .
getIsEntireColumn() Representa se o intervalo atual está em uma coluna inteira.
getIsEntireRow() Representa se o intervalo atual está em uma linha inteira.
getLastCell() Obtém a última célula do intervalo. Por exemplo, a última célula

de "B2:D5" é "D5".
getLastColumn() Obtém a última coluna do intervalo. Por exemplo, a última

coluna de "B2:D5" é "D2:D5".
getLastRow() Obtém a última linha do intervalo. Por exemplo, a última linha

de "B2:D5" é "B5:D5".
getLeft() Retorna a distância em pontos, para 100% de zoom, da borda

esquerda da planilha até a borda esquerda do intervalo.
getLinkedDataTypeState() Representa o estado do tipo de dados da célula.
getLinkedDataTypeStates() Representa o estado do tipo de dados de cada célula.
getMergedAreas() Retorna um RangeAreas objeto que representa as áreas

mescladas nesse intervalo. Observe que, se a contagem de
áreas mescladas nesse intervalo for superior a 512, esse
método não retornará o resultado. Se o RangeAreas objeto não
getNumberFormat() Representa o código de formato de número do Excel de célula

para o intervalo determinado. Se o intervalo contiver várias
células, os dados da primeira célula (representados pelo índice
de linha 0 e índice de coluna de 0) serão retornados.
getNumberFormatCategories() Representa a categoria de formato de número de cada célula.
getNumberFormatCategory() Especifica a categoria de formato numérico da primeira célula

no intervalo (representada pelo índice de linha 0 e índice de
coluna de 0).
getNumberFormatLocal() Representa o código de formato de número do Excel de célula

para o intervalo determinado, com base nas configurações de
idioma do usuário. O Excel não executa nenhuma coerção de
linguagem ou formato ao obter ou definir a numberFormatLocal
propriedade. Qualquer texto retornado usa as cadeias de
caracteres formatadas localmente com base no idioma
especificado nas configurações do sistema. Se o intervalo
contiver várias células, os dados da primeira célula
serão retornados.
getNumberFormats() Representa o código de formato de número do Excel para o

intervalo determinado.
getNumberFormatsLocal() Representa o código de formato de número do Excel para o

intervalo determinado, com base nas configurações de idioma
do usuário. O Excel não executa nenhuma coerção de
especificado nas configurações do sistema.
getOffsetRange(rowOffset, Obtém um objeto que representa um intervalo deslocado do

columnOffset) intervalo especificado. A dimensão do intervalo retornado
corresponde a esse intervalo. Se o intervalo resultante for
imposto para fora dos limites da grade da planilha, o sistema
gerará um erro.
getPivotTables(fullyContained) Obtém uma coleção com escopo de Tabelas Dinâmicas que se

sobrepõem ao intervalo.
getPredefinedCellStyle() Representa o estilo de intervalo atual. Se os estilos das células

forem inconsistentes, null serão retornados. Para estilos
personalizados, o nome do estilo será retornado. Para estilos
internos, uma cadeia de caracteres que representa um valor no
BuiltInStyle enum será retornada.
getRangeEdge(direction, active Retorna um objeto range que é a célula de borda da região de

Cell) dados que corresponde à direção fornecida. Isso corresponde
ao comportamento da chave Ctrl+Arrow no Excel na interface
do usuário do Windows.
getResizedRange(deltaRows, Obtém um Range objeto semelhante ao objeto atual Range ,

deltaColumns) mas com seu canto inferior direito expandido (ou contraído)
por algumas linhas e colunas.
getRow(row) Obtém uma linha contida no intervalo.
getRowCount() Retorna o número total de linhas no intervalo.
getRowHidden() Representa se todas as linhas no intervalo atual estiverem

ocultas. O valor é true quando todas as linhas em um intervalo
são ocultas. O valor é false quando nenhuma linha no
intervalo é oculta. O valor é null quando algumas linhas em
um intervalo estão ocultas e outras linhas no mesmo intervalo
não são ocultas.
getRowIndex() Representa o número de linhas da primeira célula no intervalo.
Indexados com zero.
getRowsAbove(count) Obtém um determinado número de linhas acima do objeto

atual Range .
getRowsBelow(count) Obtém um determinado número de linhas abaixo do objeto

atual Range .
getSavedAsArray() Representa se todas as células seriam salvas como uma fórmula

de matriz. Retorna true se todas as células fossem salvas como
uma fórmula de matriz ou false se todas as células não fossem
salvas como uma fórmula de matriz. Retorna null se algumas
células seriam salvas como uma fórmula de matriz e algumas
não seriam.
getSort() Representa a classificação de intervalo do intervalo atual.
getSpecialCells(cellType, cell Obtém o RangeAreas objeto, composto por um ou mais

ValueType) intervalos, que representa todas as células que correspondem
ao tipo e valor especificados. Se nenhuma célula especial for
encontrada, esse método retornará undefined .
getSpillingToRange() Obtém objeto range que contém o intervalo de despejo

quando chamado em uma célula âncora. Se o intervalo não for
uma célula de âncora ou o intervalo de derramamento não
puder ser encontrado, esse método retornará undefined .
getSpillParent() Obtém o objeto range que contém a célula âncora para a célula
que está sendo derramada. Se não for uma célula derramada
ou mais de uma célula for fornecida, esse método retornará
undefined .
getSurroundingRegion() Retorna um Range objeto que representa a região circundante

para a célula superior esquerda nesse intervalo. Uma região ao
redor é um intervalo limitado por qualquer combinação de
linhas e colunas em branco em relação a esse intervalo.
getTables(fullyContained) Obtém uma coleção de tabelas com escopo que se sobrepõe

ao intervalo.
getText() Representa o valor de texto do intervalo especificado. O valor

de texto não depende da largura da célula. A substituição pelo
sinal #, que ocorre na interface de usuário do Excel, não afeta o
valor de texto retornado pela API. Se o intervalo contiver várias
células, os dados da primeira célula (representados pelo índice
de linha 0 e índice de coluna de 0) serão retornados.
getTexts() Valores de texto do intervalo especificado. O valor de texto não

depende da largura da célula. A substituição de sinal de
número (#) que acontece na interface do usuário do Excel não
afetará o valor de texto retornado pela API.
getTop() Retorna a distância em pontos, para 100% de zoom, da borda

superior da planilha até a borda superior do intervalo.
getUsedRange(valuesOnly) Retorna o intervalo usado do objeto de intervalo determinado.

Se não houver células usadas no intervalo, esse método
getValue() Representa o valor bruto do intervalo especificado. Os dados

retornados podem ser dos tipos: cadeia de caracteres, número
ou booliano. Células que contêm um erro retornarão a cadeia
de caracteres de erro. Se o intervalo contiver várias células, os
dados da primeira célula (representados pelo índice de linha 0
e índice de coluna de 0) serão retornados.
getValues() Representa os valores brutos do intervalo especificado. Os

dados retornados podem ser uma cadeia de caracteres, número
ou booliano. Células que contêm um erro retornarão a cadeia
de caracteres de erro. Se o valor retornado começar com uma
adição ("+"), menos ("-"), ou sinal igual ("="), o Excel
interpretará esse valor como uma fórmula.
getValueType() Representa o tipo de dados na célula. Se o intervalo contiver

várias células, os dados da primeira célula (representados pelo
índice de linha 0 e índice de coluna de 0) serão retornados.
getValueTypes() Especifica o tipo de dados em cada célula.
getVisibleView() Representa as linhas visíveis do intervalo atual.
getWidth() Retorna a distância em pontos, para 100% de zoom, da borda

esquerda do intervalo até a borda direita do intervalo.
getWorksheet() A planilha que contém o intervalo atual.
group(groupOption) Agrupa colunas e linhas para um esboço.
hideGroupDetails(group Oculta os detalhes da linha ou do grupo de colunas.

Option)
insert(shift) Insere uma célula ou um intervalo de células na planilha, no

lugar desse intervalo, e desloca as outras células para liberar
espaço. Retorna um novo Range objeto no espaço agora em
branco.
merge(across) Mescla as células do intervalo em uma região da planilha.
moveTo(destinationRange) Move valores de célula, formatação e fórmulas do intervalo

atual para o intervalo de destino, substituindo as informações
antigas nessas células. O intervalo de destino será expandido
automaticamente se for menor que o intervalo atual. As células
no intervalo de destino que estão fora da área do intervalo
original não são alteradas.
removeDuplicates(columns, Remove valores duplicados do intervalo especificado pelas

includesHeader) colunas.
replaceAll(text, replacement, Localiza e substitui a cadeia de caracteres fornecida com base

criteria) nos critérios especificados no intervalo atual.
select() Seleciona o intervalo especificado na interface do usuário do

Excel.
setColumnHidden(column Representa se todas as colunas no intervalo atual estiverem

Hidden) ocultas. O valor é true quando todas as colunas em um
intervalo são ocultas. O valor é false quando nenhuma coluna
no intervalo está oculta. O valor é null quando algumas
colunas em um intervalo são ocultas e outras colunas no
mesmo intervalo não são ocultas.
setDirty() Define um intervalo a ser recalculado quando o próximo

recálculo ocorrer.
setFormula(formula) Define a fórmula da célula na notação de estilo A1. Se o

intervalo contiver várias células, cada célula no intervalo
determinado será atualizada com os dados de entrada.
setFormulaLocal(formulaLocal) Defina a fórmula da célula na notação no estilo A1, na

linguagem do usuário e na localidade de formatação de
números. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês
seria "=SOMA(A1; 1,5)" em português. Se o intervalo contiver
várias células, cada célula no intervalo determinado será
atualizada com os dados de entrada.
setFormulaR1C1(formulaR1C1) Define a fórmula da célula na notação no estilo R1C1. Se o

intervalo contiver várias células, cada célula no intervalo
setFormulas(formulas) Representa a fórmula em notação A1. Se uma célula não tiver

setFormulasLocal(formulas Representa a fórmula em notação A1, na formatação de

Local) número da localidade e no idioma do usuário. Por exemplo, a
fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em
retornado.
set Representa a fórmula em notação no estilo L1C1. Se uma célula

FormulasR1C1(formulasR1C1) não tiver fórmula, seu valor será retornado.
setHyperlink(hyperlink) Representa o hiperlink para o intervalo atual.

setNumberFormat(number Define o código de formato de número do Excel de célula para
Format) o intervalo determinado. Se o intervalo contiver várias células,
cada célula no intervalo determinado será atualizada com os
dados de entrada.
setNumberFormat Define o código de formato de número do Excel de célula para

Local(numberFormatLocal) o intervalo determinado, com base nas configurações de
idioma do usuário. O Excel não executa nenhuma coerção de
especificado nas configurações do sistema. Se o intervalo
contiver várias células, cada célula no intervalo determinado
será atualizada com os dados de entrada.
setNumberFormats(number Representa o código de formato de número do Excel para o

Formats) intervalo determinado.
setNumberFormats Representa o código de formato de número do Excel para o

Local(numberFormatsLocal) intervalo determinado, com base nas configurações de idioma
do usuário. O Excel não executa nenhuma coerção de
especificado nas configurações do sistema.
setPredefinedCell Representa o estilo de intervalo atual.

Style(predefinedCellStyle)
setRowHidden(rowHidden) Representa se todas as linhas no intervalo atual estiverem

ocultas. O valor é true quando todas as linhas em um intervalo
são ocultas. O valor é false quando nenhuma linha no
intervalo é oculta. O valor é null quando algumas linhas em
um intervalo estão ocultas e outras linhas no mesmo intervalo
não são ocultas.
setValue(value) Define o valor bruto do intervalo especificado. Os dados que

estão sendo definidos podem ser de cadeia de caracteres,
número ou booliano. null o valor será ignorado (não definido
ou substituído no Excel). Se o intervalo contiver várias células,
cada célula no intervalo determinado será atualizada com os
dados de entrada.
setValues(values) Define os valores brutos do intervalo especificado. Os dados

fornecidos podem ser uma cadeia de caracteres, número ou
booliano. Se o valor fornecido começar com uma adição ("+"),
menos ("-"), ou sinal igual ("="), o Excel interpretará esse valor
como uma fórmula.
showCard() Exibe o cartão para uma célula ativa se ele tiver um conteúdo
valioso.
showGroupDetails(group Mostra os detalhes da linha ou do grupo de colunas.

Option)
ungroup(groupOption) Desagrupa colunas e linhas para um esboço.
unmerge() Desfaz a mesclagem das células do intervalo em células

separadas.
Detalhes do método
addConditionalFormat(type)
Adiciona um novo formato condicional à coleção na prioridade de primeira/superior.
TypeScript
addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;
Parâmetros
type ExcelScript.ConditionalFormatType
O tipo de formato condicional que está sendo adicionado. Confira
ExcelScript.ConditionalFormatType detalhes.
Retornos
ExcelScript.ConditionalFormat
Exemplos
TypeScript
/**
* This sample applies conditional formatting to the currently used range
in the worksheet.
* The conditional formatting is a green fill for the top 10% of values.
*/
// Set the fill color to green for the top 10% of values in the range.
conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
rank: 10, // The percentage threshold.
type: ExcelScript.ConditionalTopBottomCriterionType.topPercent // The
type of the top/bottom condition.
});
}
autoFill(destinationRange, autoFillType)
Preenche um intervalo do intervalo atual até o intervalo de destino usando a lógica
autofill especificada. O intervalo de destino pode ser null ou pode estender o
intervalo de origem horizontal ou verticalmente. Não há suporte para intervalos
discontiguos.
TypeScript
autoFill(
destinationRange?: Range | string,
autoFillType?: AutoFillType
): void;
Parâmetros
destinationRange ExcelScript.Range | string
O intervalo de destino para AutoFill. Se o intervalo de destino for null , os dados
serão preenchidos com base nas células ao redor (que é o comportamento ao clicar
duas vezes no identificador de preenchimento de intervalo da interface do usuário).
autoFillType ExcelScript.AutoFillType
O tipo de AutoFill. Especifica como o intervalo de destino deve ser preenchido, com
base no conteúdo do intervalo atual. O padrão é "FillDefault".
Retornos
void
Exemplos
TypeScript
/**
* This script uses the autofill feature to complete a table.
* See https://support.microsoft.com/74e31bdd-d993-45da-aa82-35a236c5b5db
* for examples of autofill scenarios.
*/
// Get the data range that shows the pattern.

// Autofill the connected range. C2:C3 are filled in. C4:C14 are blank.
// This uses the default behavior to match a pattern with the table's
contents.
dataRange.autoFill("C2:C14");
}
calculate()
Calcula um intervalo de células em uma planilha.
TypeScript
calculate(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script recalculates the used range of a specific worksheet.
*/
// Only recalculate if the calculation mode is not set to automatic.
if (workbook.getApplication().getCalculationMode() !==
ExcelScript.CalculationMode.automatic) {
// Get the used range from a worksheet named "Monthly Report".
const sheet = workbook.getWorksheet("Monthly Report");
console.log(`Calculating ${range.getAddress()}`);
// Force all the used cells in that worksheet to calculate.

sheet.getUsedRange().calculate();
}
}
clear(applyTo)
Limpe valores de intervalo, formatação, preenchimento, bordas, etc.
TypeScript
clear(applyTo?: ClearApplyTo): void;
Parâmetros
applyTo ExcelScript.ClearApplyTo
Opcional. Determina o tipo de ação clara. Confira ExcelScript.ClearApplyTo
detalhes.
Retornos
void
Exemplos
TypeScript
/**
* This script removes all the formatting from the selected range.
*/
// Clear all the formatting in that range.

}
clearAllConditionalFormats()
Limpa todos os formatos condicionais ativos no intervalo atual especificado.
TypeScript
clearAllConditionalFormats(): void;
Retornos
void
convertDataTypeToText()
Converte as células de intervalo com tipos de dados em texto.
TypeScript
convertDataTypeToText(): void;
Retornos
void
copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copia dados de célula ou formatação do intervalo de origem ou RangeAreas para o
intervalo atual. O intervalo de destino pode ser um tamanho diferente do intervalo
de origem ou RangeAreas . O destino será expandido automaticamente se for menor
que a origem. Observação: como a funcionalidade de cópia na interface do usuário
do Excel, se o intervalo de destino for um múltiplo exato maior que o intervalo de
origem em linhas ou colunas, o conteúdo de origem será replicado várias vezes. Por
exemplo, uma cópia de intervalo 2x2 em um intervalo de 2x6 resultará em três
cópias do intervalo 2x2 original.
TypeScript
copyFrom(
sourceRange: Range | RangeAreas | string,
copyType?: RangeCopyType,
skipBlanks?: boolean,
transpose?: boolean
): void;
Parâmetros
sourceRange ExcelScript.Range | ExcelScript.RangeAreas | string
O intervalo de origem ou RangeAreas para copiar. Quando a origem RangeAreas tem
vários intervalos, seu formulário deve ser capaz de ser criado removendo linhas ou
colunas completas de um intervalo retangular.
copyType ExcelScript.RangeCopyType
O tipo de dados de célula ou formatação a ser copiado. O padrão é "Todos".
skipBlanks boolean
True se for ignorar células em branco no intervalo de origem. O padrão é false.
transpose boolean
True se para transpor as células no intervalo de destino. O padrão é false.
Retornos
void
Exemplos
TypeScript
/**
* This script copies a table from one worksheet to a new worksheet.
*/
// Get the worksheet named "TableTemplate".
let base = workbook.getWorksheet("TableTemplate");
// Get the range to be copied based on the first table.

let tableRange = base.getTables()[0].getRange();
// Get the area in a new worksheet for the new table.

let newWorksheet = workbook.addWorksheet();
let newRange = newWorksheet.getRangeByIndexes(0,0,
tableRange.getRowCount(), tableRange.getColumnCount());
// Copy the existing data into the new range.

newRange.copyFrom(tableRange);
}
delete(shift)
Exclui as células associadas ao intervalo.
TypeScript
delete(shift: DeleteShiftDirection): void;
Parâmetros
shift ExcelScript.DeleteShiftDirection
Especifica como deslocar as células. Confira ExcelScript.DeleteShiftDirection
detalhes.
Retornos
void
Exemplos
TypeScript
/**
* This sample creates a sample range, then deletes
* "A1" using different DeleteShiftDirection values.
*/
// Add sample data to better visualize the delete changes.
currentSheet.getRange("A1:D4").setValues([
[1,2,3,4],
[5,6,7,8],
[9,10,11,12],
[13,14,15,16]]);
// Delete A1 and shift the cells from the right to fill the space.
currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left)
;
// Delete A1 and shift the cells from the bottom to fill the space.
currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up);
// Log the sample range. The values should be:

/*
5, 3, 4, "",
9, 6, 7, 8,
13, 10, 11, 12,
"", 14, 15, 16
*/
console.log(currentSheet.getRange("A1:D4").getValues());
}
find(text, criteria)
Localiza certa cadeia de caracteres com base em critérios especificados. Se o
intervalo atual for maior que uma única célula, a pesquisa será limitada a esse
intervalo, caso contrário, a pesquisa cobrirá toda a planilha a partir dessa célula. Se
não houver correspondências, esse método retornará undefined .
TypeScript
find(text: string, criteria: SearchCriteria): Range;
Parâmetros
text string
A cadeia de caracteres a ser encontrada.
criteria ExcelScript.SearchCriteria
Critérios de pesquisa adicionais, incluindo a direção da pesquisa e se a pesquisa
precisa corresponder a toda a célula ou ser sensível a casos.
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This script searches through a table column and finds cells marked "no
change".
* Those cells have "no change" replaced with the value from the cell to
the left.
* This script uses Range.find instead of Worksheet.findAll
* to limit the search to a specific range.
*/
// Get the range of a table named "Orders".
let table = workbook.getTable("Orders");
let range = table.getColumnByName("March").getRange();
// Find all cells with the value "no change".
let cellToOverwrite = range.find("no change", { completeMatch: true });
while (cellToOverwrite) {
let cellToCopyFrom = cellToOverwrite.getOffsetRange(0,-1);
cellToOverwrite.setValue(cellToCopyFrom.getValue());
cellToOverwrite = range.find("no change", { completeMatch: true });
}
}
flashFill()
Faz um Preenchimento Flash para o intervalo atual. O Preenchimento Flash preenche
automaticamente os dados quando ele sente um padrão, portanto, o intervalo deve
ser um único intervalo de colunas e ter dados ao seu redor para encontrar um
padrão.
TypeScript
flashFill(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script uses the Flash Fill feature to complete a table.
* See https://support.microsoft.com/office/3f9bcf1e-db93-4890-94a0-
1578341f73f7
* for the example table.
*/
// Get the data range with a pattern and cells to fill. C2 is filled
in. C3:C6 are blank.
// Flash fill the connected range.

dataRange.flashFill();
}
getAbsoluteResizedRange(numRows, numColumns)
Obtém um Range objeto com a mesma célula superior esquerda que o objeto atual
Range , mas com os números especificados de linhas e colunas.
TypeScript
getAbsoluteResizedRange(numRows: number, numColumns: number): Range;
Parâmetros
numRows number
O número de linhas do novo tamanho de intervalo.
numColumns number
O número de colunas do novo tamanho de intervalo.
Retornos
ExcelScript.Range
getAddress()
Especifica a referência de intervalo no estilo A1. O valor do endereço contém a
referência da planilha (por exemplo, "Sheet1! A1:B4").
TypeScript
getAddress(): string;
Retornos
string
Exemplos
TypeScript
/**
* This script logs the address of the used range in each worksheet.
*/
// Iterate over every worksheet in the workbook.
// Get the used range for a single worksheet.
let range = sheet.getUsedRange();
// Print the address of the used range to the console.

console.log(range.getAddress());
});
}
getAddressLocal()
Representa a referência de intervalo para o intervalo especificado no idioma do
usuário.
TypeScript
getAddressLocal(): string;
Retornos
string
getBoundingRect(anotherRange)
Obtém o menor objeto de intervalo que abrange os intervalos determinados. Por
exemplo, o GetBoundingRect de "B2:C5" e "D10:E15" é "B2:E15".
TypeScript
getBoundingRect(anotherRange: Range | string): Range;
Parâmetros
anotherRange ExcelScript.Range | string
O objeto de intervalo, o endereço ou o nome do intervalo.
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This script gets the bounding range of two existing ranges and puts a
border around it.
*/
// Create two range objects for the sample.

let range1 = sheet.getRange("B2:C5");
let range2 = sheet.getRange("D10:E15");
// Get the rectangular range that fully includes both ranges.

let boundingRectangle = range1.getBoundingRect(range2);
// Add a border around the whole bounding range (B2:E15).

let format = boundingRectangle.getFormat();
format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScri
pt.BorderLineStyle.continuous); // Top border
format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelS
cript.BorderLineStyle.continuous); // Bottom border
format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScr
ipt.BorderLineStyle.continuous); // Left border
format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelSc
ript.BorderLineStyle.continuous); // Right border
}
getCell(row, column)
Obtém o objeto de intervalo que contém a célula única com base nos números de
linha e de coluna. A célula pode estar fora dos limites de seu intervalo pai, desde que
permaneça dentro da grade da planilha. A localização da célula retornada está
relacionada à célula superior esquerda do intervalo.
TypeScript
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
getCellCount()
Especifica o número de células no intervalo. Essa API retornará -1 se a contagem de
células exceder 2^31-1 (2.147.483.647).
TypeScript
getCellCount(): number;
Retornos
number
getColumn(column)
Obtém uma coluna incluída no intervalo.
TypeScript
getColumn(column: number): Range;
Parâmetros
column number
O número da coluna do intervalo a ser recuperado. Indexados com zero.
Retornos
ExcelScript.Range
getColumnCount()
Especifica o número total de colunas no intervalo.
TypeScript
getColumnCount(): number;
Retornos
number
Exemplos
TypeScript
/**
* This sample provides the count of negative numbers that are present
* in the used range of the current worksheet.
*/
// Get the working range.
let rowCount = usedRange.getRowCount();
let columnCount = usedRange.getColumnCount();
// Save the values locally to avoid repeatedly asking the workbook.

let usedRangeValues = usedRange.getValues();
// Start the negative number counter.

let negativeCount = 0;
// Iterate over the entire range looking for negative numbers.

for (let j = 0; j < columnCount; j++) {
if (usedRangeValues[i][j] < 0) {
negativeCount++;
}
}
}
// Log the negative number count to the console.

console.log(negativeCount);
}
getColumnHidden()
Representa se todas as colunas no intervalo atual estiverem ocultas. O valor é true
quando todas as colunas em um intervalo são ocultas. O valor é false quando
nenhuma coluna no intervalo está oculta. O valor é null quando algumas colunas
em um intervalo são ocultas e outras colunas no mesmo intervalo não são ocultas.
TypeScript
getColumnHidden(): boolean;
Retornos
boolean
getColumnIndex()
Especifica o número de coluna da primeira célula no intervalo. Indexados com zero.
TypeScript
getColumnIndex(): number;
Retornos
number
getColumnsAfter(count)
Obtém um determinado número de colunas à direita do objeto atual Range .
TypeScript
getColumnsAfter(count?: number): Range;
Parâmetros
count number
Opcional. O número de colunas a serem incluídas no intervalo resultante. Em geral,
use um número positivo para criar um intervalo fora do intervalo atual. Você
também pode usar um número negativo para criar um intervalo dentro do intervalo
atual. O valor padrão é 1.
Retornos
ExcelScript.Range
getColumnsBefore(count)
Obtém um determinado número de colunas à esquerda do objeto atual Range .
TypeScript
getColumnsBefore(count?: number): Range;
Parâmetros
count number
Opcional. O número de colunas a serem incluídas no intervalo resultante. Em geral,
Retornos
ExcelScript.Range
getConditionalFormat(id)
Retorna um formato condicional identificado por sua ID. Se o objeto de formato
condicional não existir, esse método retornará undefined .
TypeScript
getConditionalFormat(id: string): ConditionalFormat | undefined;
Parâmetros
id string
A ID do formato condicional.
Retornos
ExcelScript.ConditionalFormat | undefined
getConditionalFormats()
A coleção do ConditionalFormats que cruza o intervalo.
TypeScript
getConditionalFormats(): ConditionalFormat[];
Retornos
ExcelScript.ConditionalFormat[]
getDataValidation()
Retorna um objeto de validação de dados.
TypeScript
getDataValidation(): DataValidation;
Retornos
ExcelScript.DataValidation
Exemplos
TypeScript
/**
* This script creates a drop-down selection list for a cell. It uses the
existing values of the selected range as the choices for the list.
*/
let rangeValues = selectedRange.getValues();

});
});

let targetCell = selectedRange.getCell(0,0);
let dataValidation = targetCell.getDataValidation();
// Set the content of the drop-down list.
dataValidation.setRule({
list: {
}
});
}
getDirectPrecedents()
Retorna um WorkbookRangeAreas objeto que representa o intervalo que contém todas
as células precedentes diretas de um intervalo especificado na mesma planilha ou
em várias planilhas.
TypeScript
getDirectPrecedents(): WorkbookRangeAreas;
Retornos
ExcelScript.WorkbookRangeAreas
getEntireColumn()
Obtém um objeto que representa toda a coluna do intervalo (por exemplo, se o
intervalo atual representa as células "B4:E11", ele getEntireColumn é um intervalo
que representa as colunas "B:E").
TypeScript
getEntireColumn(): Range;
Retornos
ExcelScript.Range
getEntireRow()
Obtém um objeto que representa toda a linha do intervalo (por exemplo, se o
intervalo atual representa as células "B4:E11", ele GetEntireRow é um intervalo que
representa as linhas "4:11").
TypeScript
getEntireRow(): Range;
Retornos
ExcelScript.Range
getExtendedRange(direction, activeCell)
Retorna um objeto de intervalo que inclui o intervalo atual e até a borda do
intervalo, com base na direção fornecida. Isso corresponde ao comportamento da
chave Ctrl+Shift+Arrow no Excel na interface do usuário do Windows.
TypeScript
getExtendedRange(
direction: KeyboardDirection,
activeCell?: Range | string
): Range;
Parâmetros
direction ExcelScript.KeyboardDirection
A direção da célula ativa.
activeCell ExcelScript.Range | string

A célula ativa nesse intervalo. Por padrão, a célula ativa é a célula superior esquerda
do intervalo. Um erro será gerado se a célula ativa não estiver nesse intervalo.
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This script makes the font bold on all the contiguous cells between
* A1 and the bottom of the used range of the first column.
*/
{
// Get every cell that's used between A1 and the end of the column.
// This recreates the Ctrl+Shift+Down arrow key behavior.
let firstColumn =
firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down);
// Set the font to bold in that range.

firstColumn.getFormat().getFont().setBold(true);
}
getFormat()
Retorna um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o
alinhamento e outras propriedades do intervalo.
TypeScript
getFormat(): RangeFormat;
Retornos
ExcelScript.RangeFormat
Exemplos
TypeScript
/**
* This script gives the total row of a table a green color fill.
*/
let table = workbook.getTables()[0];
// Get the range for the total row of the table.

let totalRange = table.getTotalRowRange();
// Set the fill color to green.

totalRange.getFormat().getFill().setColor("green");
}
getFormula()
Representa a fórmula de célula na notação de estilo A1. Se o intervalo contiver várias
células, os dados da primeira célula (representados pelo índice de linha 0 e índice de
coluna de 0) serão retornados.
TypeScript
Retornos
string
Exemplos
TypeScript
/*
* This script sets a cell's formula,
* then displays how Excel stores the cell's formula and value
separately.
*/
// Set A1 to 2.
let a1 = selectedSheet.getRange("A1");
a1.setValue(2);
// Set B1 to the formula =(2*A1), which should equal 4.

let b1 = selectedSheet.getRange("B1")
b1.setFormula("=(2*A1)");
// Log the current results for `getFormula` and `getValue` at B1.

console.log(`B1 - Formula: ${b1.getFormula()} | Value:
${b1.getValue()}`);
}
getFormulaLocal()
Representa a fórmula da célula na notação de estilo A1, na linguagem do usuário e
na localidade de formatação de números. Por exemplo, a fórmula "=SUM(A1, 1.5)"
em inglês seria "=SOMA(A1; 1,5)" em português. Se o intervalo contiver várias
TypeScript
getFormulaLocal(): string;
Retornos
string
getFormulaR1C1()
Representa a fórmula de célula na notação no estilo R1C1. Se o intervalo contiver
várias células, os dados da primeira célula (representados pelo índice de linha 0 e
índice de coluna de 0) serão retornados.
TypeScript
getFormulaR1C1(): string;
Retornos
string
getFormulas()
Representa a fórmula em notação A1. Se uma célula não tiver fórmula, seu valor será
retornado.
TypeScript
getFormulas(): string[][];
Retornos
string[][]
getFormulasLocal()
Representa a fórmula em notação A1, na formatação de número da localidade e no
idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria
"=SOMA(A1; 1,5)" em português. Se uma célula não tiver fórmula, seu valor será
retornado.
TypeScript
getFormulasLocal(): string[][];
Retornos
string[][]
getFormulasR1C1()
Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver fórmula,
seu valor será retornado.
TypeScript
getFormulasR1C1(): string[][];
Retornos
string[][]
getHasSpill()
Representa se todas as células têm uma borda de despejo. Retorna true se todas as
células tiverem uma borda de derramamento ou false se todas as células não
tiverem uma borda de derramamento. Retornará null se houver células com e sem
bordas de derramamento dentro do intervalo.
TypeScript
getHasSpill(): boolean;
Retornos
boolean
getHeight()
Retorna a distância em pontos, para 100% de zoom, da borda superior do intervalo
até a borda inferior do intervalo.
TypeScript
Retornos
number
getHidden()
Representa se todas as células do intervalo atual estiverem ocultas. O valor é true
quando todas as células em um intervalo são ocultas. O valor é false quando
nenhuma célula no intervalo está oculta. O valor é null quando algumas células em
um intervalo estão ocultas e outras células no mesmo intervalo não estão ocultas.
TypeScript
getHidden(): boolean;
Retornos
boolean
getHyperlink()
Representa o hiperlink para o intervalo atual.
TypeScript
getHyperlink(): RangeHyperlink;
Retornos
ExcelScript.RangeHyperlink
Exemplos
TypeScript
/**
* This sample clears all of the hyperlinks from the current worksheet
* and removes the usual hyperlink formatting.
*/
function main(workbook: ExcelScript.Workbook, sheetName: string =
'Sheet1') {
// Get the active worksheet.
let sheet = workbook.getWorksheet(sheetName);
// Get the used range to operate on.

// For large ranges (over 10000 entries), consider splitting the
operation into batches for performance.
const targetRange = sheet.getUsedRange(true);
console.log(`Target Range to clear hyperlinks from:
${targetRange.getAddress()}`);
const rowCount = targetRange.getRowCount();

const colCount = targetRange.getColumnCount();
console.log(`Searching for hyperlinks in ${targetRange.getAddress()}
which contains ${(rowCount * colCount)} cells`);
// Go through each individual cell looking for a hyperlink.

// This allows us to limit the formatting changes to only the cells
with hyperlink formatting.
let clearedCount = 0;
for (let j = 0; j < colCount; j++) {
const cell = targetRange.getCell(i, j);
const hyperlink = cell.getHyperlink();
if (hyperlink) {
cell.clear(ExcelScript.ClearApplyTo.hyperlinks);
cell.getFormat().getFont().setUnderline(ExcelScript.RangeUnderlineStyle.n
one);
cell.getFormat().getFont().setColor('Black');
clearedCount++;
}
}
}
console.log(`Done. Cleared hyperlinks from ${clearedCount} cells`);

}
getImage()
Renderiza o intervalo como uma imagem png codificada com base64.
TypeScript
getImage(): string;
Retornos
string
getIntersection(anotherRange)
Obtém o objeto de intervalo que representa a interseção retangular dos intervalos
determinados. Se nenhuma interseção for encontrada, esse método retornará
undefined .
TypeScript
getIntersection(anotherRange: Range | string): Range;
Parâmetros
anotherRange ExcelScript.Range | string
O objeto Range ou o endereço do intervalo que será usado para determinar a
interseção de intervalos.
Retornos
ExcelScript.Range
getIsEntireColumn()
Representa se o intervalo atual está em uma coluna inteira.
TypeScript
getIsEntireColumn(): boolean;
Retornos
boolean
getIsEntireRow()
Representa se o intervalo atual está em uma linha inteira.
TypeScript
getIsEntireRow(): boolean;
Retornos
boolean
getLastCell()
Obtém a última célula do intervalo. Por exemplo, a última célula de "B2:D5" é "D5".
TypeScript
getLastCell(): Range;
Retornos
ExcelScript.Range
getLastColumn()
Obtém a última coluna do intervalo. Por exemplo, a última coluna de "B2:D5" é
"D2:D5".
TypeScript
getLastColumn(): Range;
Retornos
ExcelScript.Range
getLastRow()
Obtém a última linha do intervalo. Por exemplo, a última linha de "B2:D5" é "B5:D5".
TypeScript
getLastRow(): Range;
Retornos
ExcelScript.Range
getLeft()
Retorna a distância em pontos, para 100% de zoom, da borda esquerda da planilha
até a borda esquerda do intervalo.
TypeScript
getLeft(): number;
Retornos
number
getLinkedDataTypeState()
Representa o estado do tipo de dados da célula.
TypeScript
getLinkedDataTypeState(): LinkedDataTypeState;
Retornos
ExcelScript.LinkedDataTypeState
getLinkedDataTypeStates()
Representa o estado do tipo de dados de cada célula.
TypeScript
getLinkedDataTypeStates(): LinkedDataTypeState[][];
Retornos
ExcelScript.LinkedDataTypeState[][]
getMergedAreas()
Retorna um RangeAreas objeto que representa as áreas mescladas nesse intervalo.
Observe que, se a contagem de áreas mescladas nesse intervalo for superior a 512,
esse método não retornará o resultado. Se o RangeAreas objeto não existir, esse
TypeScript
getMergedAreas(): RangeAreas;
Retornos
getNumberFormat()
Representa o código de formato de número do Excel de célula para o intervalo
determinado. Se o intervalo contiver várias células, os dados da primeira célula
(representados pelo índice de linha 0 e índice de coluna de 0) serão retornados.
TypeScript
Retornos
string
getNumberFormatCategories()
Representa a categoria de formato de número de cada célula.
TypeScript
getNumberFormatCategories(): NumberFormatCategory[][];
Retornos
ExcelScript.NumberFormatCategory[][]
Exemplos
TypeScript
/**
* This script finds cells in a table column that are not formatted as
currency
* and sets the fill color to red.
*/
// Get the "Cost" column from the "Expenses" table.
const table = workbook.getTable("Expenses");
const costColumn = table.getColumnByName("Cost");
const costColumnRange = costColumn.getRangeBetweenHeaderAndTotal();
// Get the number format categories for the column's range.

const numberFormatCategories =
costColumnRange.getNumberFormatCategories();
// If any cell in the column doesn't have a currency format, make the
cell red.
numberFormatCategories.forEach((category, index) =>{
if (category[0] != ExcelScript.NumberFormatCategory.currency) {
costColumnRange.getCell(index,
0).getFormat().getFill().setColor("red");
}
});
}
getNumberFormatCategory()
Especifica a categoria de formato numérico da primeira célula no intervalo
(representada pelo índice de linha 0 e índice de coluna de 0).
TypeScript
getNumberFormatCategory(): NumberFormatCategory;
Retornos
ExcelScript.NumberFormatCategory
getNumberFormatLocal()
Representa o código de formato de número do Excel de célula para o intervalo
determinado, com base nas configurações de idioma do usuário. O Excel não
executa nenhuma coerção de linguagem ou formato ao obter ou definir a
numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de
caracteres formatadas localmente com base no idioma especificado nas

configurações do sistema. Se o intervalo contiver várias células, os dados da primeira
célula (representados pelo índice de linha 0 e índice de coluna de 0) serão
retornados.
TypeScript
getNumberFormatLocal(): string;
Retornos
string
getNumberFormats()
TypeScript
getNumberFormats(): string[][];
Retornos
string[][]
getNumberFormatsLocal()
Representa o código de formato de número do Excel para o intervalo determinado,
com base nas configurações de idioma do usuário. O Excel não executa nenhuma
coerção de linguagem ou formato ao obter ou definir a numberFormatLocal
propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas
localmente com base no idioma especificado nas configurações do sistema.
TypeScript
getNumberFormatsLocal(): string[][];
Retornos
string[][]
getOffsetRange(rowOffset, columnOffset)
Obtém um objeto que representa um intervalo deslocado do intervalo especificado.
A dimensão do intervalo retornado corresponde a esse intervalo. Se o intervalo
resultante for imposto para fora dos limites da grade da planilha, o sistema gerará
um erro.
TypeScript
getOffsetRange(rowOffset: number, columnOffset: number): Range;
Parâmetros
rowOffset number
O número de linhas (positivo, negativo ou 0) com base no qual o intervalo deve ser
deslocado. Valores positivos estão deslocados para baixo, e os valores negativos
para cima.
columnOffset number
O número de colunas (positivo, negativo ou 0) com base no qual o intervalo deve ser
deslocado. Valores positivos estão deslocados para a direita, e os valores negativos
para a esquerda.
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This script gets adjacent cells using relative references.
* Note that if the active cell is on the top row, part of the script
fails,
* because it references the cell above the currently selected one.
*/
// Get the currently active cell in the workbook.
let activeCell = workbook.getActiveCell();
console.log(`The active cell's address is:
${activeCell.getAddress()}`);
// Get the cell to the right of the active cell and set its value and
color.
let rightCell = activeCell.getOffsetRange(0,1);
rightCell.setValue("Right cell");
console.log(`The right cell's address is: ${rightCell.getAddress()}`);
rightCell.getFormat().getFont().setColor("Magenta");
rightCell.getFormat().getFill().setColor("Cyan");
// Get the cell to the above of the active cell and set its value and
color.
// Note that this operation will fail if the active cell is in the top
row.
let aboveCell = activeCell.getOffsetRange(-1, 0);
aboveCell.setValue("Above cell");
console.log(`The above cell's address is: ${aboveCell.getAddress()}`);
aboveCell.getFormat().getFont().setColor("White");
aboveCell.getFormat().getFill().setColor("Black");
}
getPivotTables(fullyContained)
Obtém uma coleção com escopo de Tabelas Dinâmicas que se sobrepõem ao
intervalo.
TypeScript
getPivotTables(fullyContained?: boolean): PivotTable[];
Parâmetros
fullyContained boolean
Se true , retornará apenas tabelas dinâmicas que estão totalmente contidas nos
limites de intervalo. O valor padrão é false .
Retornos
ExcelScript.PivotTable[]
getPredefinedCellStyle()
Representa o estilo de intervalo atual. Se os estilos das células forem inconsistentes,
null serão retornados. Para estilos personalizados, o nome do estilo será retornado.
Para estilos internos, uma cadeia de caracteres que representa um valor no

BuiltInStyle enum será retornada.
TypeScript
getPredefinedCellStyle(): string;
Retornos
string
getRangeEdge(direction, activeCell)
Retorna um objeto range que é a célula de borda da região de dados que
corresponde à direção fornecida. Isso corresponde ao comportamento da chave
Ctrl+Arrow no Excel na interface do usuário do Windows.
TypeScript
getRangeEdge(
direction: KeyboardDirection,
activeCell?: Range | string
): Range;
Parâmetros
direction ExcelScript.KeyboardDirection
A direção da célula ativa.
activeCell ExcelScript.Range | string

A célula ativa nesse intervalo. Por padrão, a célula ativa é a célula superior esquerda
do intervalo. Um erro será gerado se a célula ativa não estiver nesse intervalo.
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This script adds the value "Total" after the end of the first column.
*/
{
// Get the last used cell at the end of the column.

// This recreates the Ctrl+Down arrow key behavior.
let firstColumn =
selectedSheet.getRange("A1").getRangeEdge(ExcelScript.KeyboardDirection.d
own);
let cellAfter = firstColumn.getOffsetRange(1, 0);
// Set the value of the cell after the current end of the used column
to "Total".
cellAfter.setValue("Total");
}
getResizedRange(deltaRows, deltaColumns)
Obtém um Range objeto semelhante ao objeto atual Range , mas com seu canto
inferior direito expandido (ou contraído) por algumas linhas e colunas.
TypeScript
getResizedRange(deltaRows: number, deltaColumns: number): Range;
Parâmetros
deltaRows number
O número de linhas pelo qual expandir o canto inferior direito, referente ao intervalo
atual. Use um número positivo para expandir o intervalo ou um número negativo
para diminuí-lo.
deltaColumns number
O número de colunas pelas quais expandir o canto inferior direito, em relação ao
intervalo atual. Use um número positivo para expandir o intervalo ou um número
negativo para diminuí-lo.
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This script copies the formatting in the active cell to the
neighboring cells.
* Note that this script only works when the active cell isn't on an edge
of the worksheet.
*/
// Get the active cell.
let activeCell = workbook.getActiveCell();
// Get the cell that's one row above and one column to the left of the
active cell.
let cornerCell = activeCell.getOffsetRange(-1,-1);
// Get a range that includes all the cells surrounding the active cell.
let surroundingRange = cornerCell.getResizedRange(2, 2)
// Copy the formatting from the active cell to the new range.
surroundingRange.copyFrom(
activeCell, /* The source range. */
ExcelScript.RangeCopyType.formats /* What to copy. */
);
}
getRow(row)
Obtém uma linha contida no intervalo.
TypeScript
getRow(row: number): Range;
Parâmetros
row number
O número da linha do intervalo a ser recuperado. Indexados com zero.
Retornos
ExcelScript.Range
getRowCount()
Retorna o número total de linhas no intervalo.
TypeScript
getRowCount(): number;
Retornos
number
Exemplos
TypeScript
/**
* This sample provides the count of negative numbers that are present
* in the used range of the current worksheet.
*/
// Get the working range.
let rowCount = usedRange.getRowCount();
let columnCount = usedRange.getColumnCount();
// Save the values locally to avoid repeatedly asking the workbook.

let usedRangeValues = usedRange.getValues();
// Start the negative number counter.

let negativeCount = 0;
// Iterate over the entire range looking for negative numbers.

for (let j = 0; j < columnCount; j++) {
if (usedRangeValues[i][j] < 0) {
negativeCount++;
}
}
}
// Log the negative number count to the console.

console.log(negativeCount);
}
getRowHidden()
Representa se todas as linhas no intervalo atual estiverem ocultas. O valor é true
quando todas as linhas em um intervalo são ocultas. O valor é false quando
nenhuma linha no intervalo é oculta. O valor é null quando algumas linhas em um
intervalo estão ocultas e outras linhas no mesmo intervalo não são ocultas.
TypeScript
getRowHidden(): boolean;
Retornos
boolean
getRowIndex()
Representa o número de linhas da primeira célula no intervalo. Indexados com zero.
TypeScript
getRowIndex(): number;
Retornos
number
getRowsAbove(count)
Obtém um determinado número de linhas acima do objeto atual Range .
TypeScript
getRowsAbove(count?: number): Range;
Parâmetros
count number
Opcional. O número de linhas a serem incluídas no intervalo resultante. Em geral,
Retornos
ExcelScript.Range
getRowsBelow(count)
Obtém um determinado número de linhas abaixo do objeto atual Range .
TypeScript
getRowsBelow(count?: number): Range;
Parâmetros
count number
Opcional. O número de linhas a serem incluídas no intervalo resultante. Em geral,
Retornos
ExcelScript.Range
getSavedAsArray()
Representa se todas as células seriam salvas como uma fórmula de matriz. Retorna
true se todas as células fossem salvas como uma fórmula de matriz ou false se
todas as células não fossem salvas como uma fórmula de matriz. Retorna null se
algumas células seriam salvas como uma fórmula de matriz e algumas não seriam.
TypeScript
getSavedAsArray(): boolean;
Retornos
boolean
getSort()
Representa a classificação de intervalo do intervalo atual.
TypeScript
getSort(): RangeSort;
Retornos
ExcelScript.RangeSort
getSpecialCells(cellType, cellValueType)
Obtém o RangeAreas objeto, composto por um ou mais intervalos, que representa
todas as células que correspondem ao tipo e valor especificados. Se nenhuma célula
especial for encontrada, esse método retornará undefined .
TypeScript
getSpecialCells(
cellType: SpecialCellType,
cellValueType?: SpecialCellValueType
): RangeAreas;
Parâmetros
cellType ExcelScript.SpecialCellType
O tipo de células a serem incluídas.
cellValueType ExcelScript.SpecialCellValueType
Se cellType for constants ou formulas , esse argumento será usado para determinar
quais tipos de células incluir no resultado. Esses valores podem ser combinados para
retornar mais de um tipo. O padrão é selecionar todas as constantes ou as fórmulas,
independente do tipo.
Retornos
Exemplos
TypeScript
/**
* This sample gets all the blank cells in the current worksheet's used
range. It then highlights all those cells with a yellow background.
*/
// Get the current used range.
// Get all the blank cells.

let blankCells =
range.getSpecialCells(ExcelScript.SpecialCellType.blanks);
// Highlight the blank cells with a yellow background.
blankCells.getFormat().getFill().setColor("yellow");
}
getSpillingToRange()
Obtém objeto range que contém o intervalo de despejo quando chamado em uma
célula âncora. Se o intervalo não for uma célula de âncora ou o intervalo de
derramamento não puder ser encontrado, esse método retornará undefined .
TypeScript
getSpillingToRange(): Range;
Retornos
ExcelScript.Range
getSpillParent()
Obtém o objeto range que contém a célula âncora para a célula que está sendo
derramada. Se não for uma célula derramada ou mais de uma célula for fornecida,
TypeScript
getSpillParent(): Range;
Retornos
ExcelScript.Range
getSurroundingRegion()
Retorna um Range objeto que representa a região circundante para a célula superior
esquerda nesse intervalo. Uma região ao redor é um intervalo limitado por qualquer
combinação de linhas e colunas em branco em relação a esse intervalo.
TypeScript
getSurroundingRegion(): Range;
Retornos
ExcelScript.Range
getTables(fullyContained)
Obtém uma coleção de tabelas com escopo que se sobrepõe ao intervalo.
TypeScript
getTables(fullyContained?: boolean): Table[];
Parâmetros
Se true , retornará apenas tabelas totalmente contidas nos limites de intervalo. O
valor padrão é false .
Retornos
ExcelScript.Table[]
getText()
Representa o valor de texto do intervalo especificado. O valor de texto não depende
da largura da célula. A substituição pelo sinal #, que ocorre na interface de usuário
do Excel, não afeta o valor de texto retornado pela API. Se o intervalo contiver várias
TypeScript
getText(): string;
Retornos
string
getTexts()
Valores de texto do intervalo especificado. O valor de texto não depende da largura
da célula. A substituição de sinal de número (#) que acontece na interface do usuário
do Excel não afetará o valor de texto retornado pela API.
TypeScript
getTexts(): string[][];
Retornos
string[][]
getTop()
Retorna a distância em pontos, para 100% de zoom, da borda superior da planilha
até a borda superior do intervalo.
TypeScript
getTop(): number;
Retornos
number
getUsedRange(valuesOnly)
Retorna o intervalo usado do objeto de intervalo determinado. Se não houver células
usadas no intervalo, esse método retornará undefined .
TypeScript
getUsedRange(valuesOnly?: boolean): Range;
Parâmetros
valuesOnly boolean
Considera apenas as células com valores como células usadas.
Retornos
ExcelScript.Range
getValue()
Representa o valor bruto do intervalo especificado. Os dados retornados podem ser
dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro
retornarão a cadeia de caracteres de erro. Se o intervalo contiver várias células, os
dados da primeira célula (representados pelo índice de linha 0 e índice de coluna de
0) serão retornados.
TypeScript
getValue(): string | number | boolean;
Retornos
string | number | boolean
Exemplos
TypeScript
/**
* This sample reads the value of A1 and prints it to the console.
*/
// Get the value of cell A1.

let range = selectedSheet.getRange("A1");
// Print the value of A1.

console.log(range.getValue());
}
getValues()
Representa os valores brutos do intervalo especificado. Os dados retornados podem
ser uma cadeia de caracteres, número ou booliano. Células que contêm um erro
retornarão a cadeia de caracteres de erro. Se o valor retornado começar com uma
adição ("+"), menos ("-"), ou sinal igual ("="), o Excel interpretará esse valor como
uma fórmula.
TypeScript
Retornos
getValueType()
Representa o tipo de dados na célula. Se o intervalo contiver várias células, os dados
da primeira célula (representados pelo índice de linha 0 e índice de coluna de 0)
serão retornados.
TypeScript
getValueType(): RangeValueType;
Retornos
ExcelScript.RangeValueType
Exemplos
TypeScript
/**
* This script formats rows in a worksheet based on the first value in
that row.
* If it's the boolean value TRUE, the row is bolded.
* If it's FALSE, nothing is changed.
* If the value type isn't a boolean, the row is italicized.
*/
// Get the used range in the active worksheet.
// Get the values in the first column.

const firstColumnValues = usedRange.getColumn(0).getValues();
// Look at the first cell in each row.

const rowCount = usedRange.getRowCount();
// Get the type of the first cell to make sure it's a boolean.
let firstValueType = usedRange.getCell(i, 0).getValueType();
// Set the bold or italic of the row as described earlier.

if (firstValueType === ExcelScript.RangeValueType.boolean) {
if (firstColumnValues[i][0] as boolean === true) {
usedRange.getRow(i).getFormat().getFont().setBold(true);
} else {
usedRange.getRow(i).getFormat().getFont().setBold(false);
}
} else {
usedRange.getRow(i).getFormat().getFont().setItalic(true);
}
}
}
getValueTypes()
Especifica o tipo de dados em cada célula.
TypeScript
getValueTypes(): RangeValueType[][];
Retornos
getVisibleView()
Representa as linhas visíveis do intervalo atual.
TypeScript
getVisibleView(): RangeView;
Retornos
ExcelScript.RangeView
Exemplos
TypeScript
/**
* This script copies values and formatting from the
* visible range of a table in Sheet1 into Sheet2.
*/
// Get the filtered data from Sheet1.
const currentSheet = workbook.getWorksheet("Sheet1");
const visibleTableRange: ExcelScript.RangeView =
table.getRange().getVisibleView();
const source =
currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());
// Copy the data into the other sheet.

const otherSheet = workbook.getWorksheet("Sheet2");
const otherRangeCorner = otherSheet.getRange("A1");
otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}
getWidth()
Retorna a distância em pontos, para 100% de zoom, da borda esquerda do intervalo
até a borda direita do intervalo.
TypeScript
getWidth(): number;
Retornos
number
getWorksheet()
A planilha que contém o intervalo atual.
TypeScript
Retornos
group(groupOption)
Agrupa colunas e linhas para um esboço.
TypeScript
group(groupOption: GroupOption): void;
Parâmetros
groupOption ExcelScript.GroupOption
Especifica como o intervalo pode ser agrupado por linhas ou colunas. Um
InvalidArgument erro é gerado quando a opção de grupo difere da propriedade ou
isEntireColumn do isEntireRow intervalo (ou seja, range.isEntireRow é true e
groupOption é "ByColumns" ou range.isEntireColumn é true e groupOption é
"ByRows").
Retornos
void
Exemplos
TypeScript
/**
* This script creates a two-level column-based outline on Sheet1.
*/
// Group columns A-F in the worksheet named Sheet1.
const firstLevel = sheet.getRange("A:F");
firstLevel.group(ExcelScript.GroupOption.byColumns);
// Create a second level to the outline by grouping subsections.

sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns);
sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns);
}
hideGroupDetails(groupOption)
Oculta os detalhes da linha ou do grupo de colunas.
TypeScript
hideGroupDetails(groupOption: GroupOption): void;

Parâmetros
Especifica se deve ocultar os detalhes de linhas agrupadas ou colunas agrupadas.
Retornos
void
insert(shift)
Insere uma célula ou um intervalo de células na planilha, no lugar desse intervalo, e
desloca as outras células para liberar espaço. Retorna um novo Range objeto no
espaço agora em branco.
TypeScript
insert(shift: InsertShiftDirection): Range;
Parâmetros
shift ExcelScript.InsertShiftDirection
Especifica como deslocar as células. Confira ExcelScript.InsertShiftDirection
detalhes.
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This script inserts headers at the top of the worksheet.
*/
{
// Create headers for 3 columns.

let myHeaders = [["NAME", "ID", "ROLE"]];
// Add a blank first row and push existing data down a row.
let firstRow = currentSheet.getRange("1:1");
firstRow.insert(ExcelScript.InsertShiftDirection.down);
// Add the headers.

currentSheet.getRange("A1:C1").setValues(myHeaders);
}
merge(across)
Mescla as células do intervalo em uma região da planilha.
TypeScript
merge(across?: boolean): void;
Parâmetros
across boolean
Opcional. Defina true como mesclar células em cada linha do intervalo especificado
como células mescladas separadas. O valor padrão é false .
Retornos
void
moveTo(destinationRange)
Move valores de célula, formatação e fórmulas do intervalo atual para o intervalo de
destino, substituindo as informações antigas nessas células. O intervalo de destino
será expandido automaticamente se for menor que o intervalo atual. As células no
intervalo de destino que estão fora da área do intervalo original não são alteradas.
TypeScript
moveTo(destinationRange: Range | string): void;
Parâmetros
destinationRange ExcelScript.Range | string
destinationRange Especifica o intervalo para onde as informações nesse intervalo
serão movidas.
Retornos
void
removeDuplicates(columns, includesHeader)
Remove valores duplicados do intervalo especificado pelas colunas.
TypeScript
removeDuplicates(
columns: number[],
includesHeader: boolean
): RemoveDuplicatesResult;
Parâmetros
columns number[]
As colunas dentro do intervalo que podem conter duplicatas. Pelo menos uma
coluna precisa ser especificada. Indexados com zero.
includesHeader boolean
True se os dados de entrada contiverem cabeçalho. O padrão é false.
Retornos
ExcelScript.RemoveDuplicatesResult
replaceAll(text, replacement, criteria)

Localiza e substitui a cadeia de caracteres fornecida com base nos critérios
especificados no intervalo atual.
TypeScript
replaceAll(
text: string,
replacement: string,
criteria: ReplaceCriteria
): number;
Parâmetros
text string
Cadeia de caracteres a ser encontrada.
replacement string
A cadeia de caracteres que substitui a cadeia de caracteres original.
criteria ExcelScript.ReplaceCriteria
Critérios de substituição adicionais.
Retornos
number
Exemplos
TypeScript
/**
* This script searches through a table column and replaces
* cells marked "monthly special" with "parsnip".
* This script uses Range.replaceAll instead of Worksheet.replaceAll
* to limit the search to a specific range.
*/
// Get the range of a table named "Orders".
let table = workbook.getTable("Orders");
let range = table.getColumnByName("Vegetable").getRange();
// Change the value of any cells with the value "monthly special".
range.replaceAll("monthly special", "parsnip", {completeMatch: true});
}
select()
Seleciona o intervalo especificado na interface do usuário do Excel.
TypeScript
select(): void;
Retornos
void
setColumnHidden(columnHidden)
Representa se todas as colunas no intervalo atual estiverem ocultas. O valor é true
quando todas as colunas em um intervalo são ocultas. O valor é false quando
nenhuma coluna no intervalo está oculta. O valor é null quando algumas colunas
em um intervalo são ocultas e outras colunas no mesmo intervalo não são ocultas.
TypeScript
setColumnHidden(columnHidden: boolean): void;
Parâmetros
columnHidden boolean
Retornos
void
setDirty()
Define um intervalo a ser recalculado quando o próximo recálculo ocorrer.
TypeScript
setDirty(): void;
Retornos
void
setFormula(formula)
Define a fórmula da célula na notação de estilo A1. Se o intervalo contiver várias
células, cada célula no intervalo determinado será atualizada com os dados de
entrada.
TypeScript

Parâmetros
formula string
Retornos
void
Exemplos
TypeScript
/*
* This script sets a cell's formula,
* then displays how Excel stores the cell's formula and value
separately.
*/
// Set A1 to 2.
let a1 = selectedSheet.getRange("A1");
a1.setValue(2);
// Set B1 to the formula =(2*A1), which should equal 4.

let b1 = selectedSheet.getRange("B1")
b1.setFormula("=(2*A1)");
// Log the current results for `getFormula` and `getValue` at B1.

console.log(`B1 - Formula: ${b1.getFormula()} | Value:
${b1.getValue()}`);
}
setFormulaLocal(formulaLocal)
Defina a fórmula da célula na notação no estilo A1, na linguagem do usuário e na
localidade de formatação de números. Por exemplo, a fórmula "=SUM(A1, 1.5)" em
inglês seria "=SOMA(A1; 1,5)" em português. Se o intervalo contiver várias células,
cada célula no intervalo determinado será atualizada com os dados de entrada.
TypeScript
setFormulaLocal(formulaLocal: string): void;
Parâmetros
formulaLocal string
Retornos
void
setFormulaR1C1(formulaR1C1)
Define a fórmula da célula na notação no estilo R1C1. Se o intervalo contiver várias
células, cada célula no intervalo determinado será atualizada com os dados de
entrada.
TypeScript
setFormulaR1C1(formulaR1C1: string): void;
Parâmetros
formulaR1C1 string
Retornos
void
setFormulas(formulas)
retornado.
TypeScript
setFormulas(formulas: string[][]): void;
Parâmetros
formulas string[][]
Retornos
void
Exemplos
TypeScript
/**
* This script sets the values of a range, then adds SUM formulas to
calculate
* the totals for each row of that range.
*/
{
// Set the values of a range.

let values = [[1, 2, 4], [8, 16, 32], [64, 128, 256]];
let valueRange = currentSheet.getRange("A1:C3");
valueRange.setValues(values);
// Set the formulas of a range.

let formulas = [["=SUM(A1:C1)"], ["=SUM(A2:C2)"], ["=SUM(A3:C3)"]];
let formulaRange = currentSheet.getRange("D1:D3");
formulaRange.setFormulas(formulas);
}
setFormulasLocal(formulasLocal)
retornado.
TypeScript
setFormulasLocal(formulasLocal: string[][]): void;
Parâmetros
formulasLocal string[][]
Retornos
void
setFormulasR1C1(formulasR1C1)
TypeScript
setFormulasR1C1(formulasR1C1: string[][]): void;
Parâmetros
formulasR1C1 string[][]
Retornos
void
setHyperlink(hyperlink)
Representa o hiperlink para o intervalo atual.
TypeScript
setHyperlink(hyperlink: RangeHyperlink): void;
Parâmetros
hyperlink ExcelScript.RangeHyperlink
Retornos
void
Exemplos
TypeScript
/**
* This script inserts a hyperlink to the first cell of the last
worksheet in the workbook.
*/
let cell = workbook.getActiveCell();
// Get the last worksheet in the workbook.

// Note that this might be the current sheet if there's only one
worksheet.
let lastSheet = workbook.getLastWorksheet();
// Get sheet name.

let linkedSheetName = lastSheet.getName();
console.log(`Setting hyperlink of ${cell.getAddress()} to the
${linkedSheetName} sheet's A1 cell`);
// Set the text for the hyperlink.

let value = `Click to go to: ${linkedSheetName}`;
// Create the hyperlink using that cell's value.

cell.setHyperlink({
textToDisplay: value.toString(),
screenTip: `Navigate to ${linkedSheetName}`,
documentReference: `${linkedSheetName}!A1`
});
}
Define o código de formato de número do Excel de célula para o intervalo
determinado. Se o intervalo contiver várias células, cada célula no intervalo
TypeScript
Parâmetros
numberFormat string
Retornos
void
Exemplos
TypeScript
/**
* This script sets the number format in column C to show the data as a
percentage.
*/
// Set number format for column C to a percentage that rounds to the

nearest percentage point.
selectedSheet.getRange("C:C").setNumberFormat("0%");
}
setNumberFormatLocal(numberFormatLocal)
Define o código de formato de número do Excel de célula para o intervalo
determinado, com base nas configurações de idioma do usuário. O Excel não
executa nenhuma coerção de linguagem ou formato ao obter ou definir a
numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de
caracteres formatadas localmente com base no idioma especificado nas

configurações do sistema. Se o intervalo contiver várias células, cada célula no
intervalo determinado será atualizada com os dados de entrada.
TypeScript
setNumberFormatLocal(numberFormatLocal: string): void;
Parâmetros
numberFormatLocal string
Retornos
void
Exemplos
TypeScript
/**
* This script sets the number format in column D to show the data as a
percentage with a decimal.
*/
// Set number format for column D to a percentage that rounds to the

nearest tenth of a percentage.
selectedSheet.getRange("D:D").setNumberFormatLocal("0.0%");
}
setNumberFormats(numberFormats)
TypeScript
setNumberFormats(numberFormats: string[][]): void;
Parâmetros
numberFormats string[][]
Retornos
void
setNumberFormatsLocal(numberFormatsLocal)
Representa o código de formato de número do Excel para o intervalo determinado,
com base nas configurações de idioma do usuário. O Excel não executa nenhuma
coerção de linguagem ou formato ao obter ou definir a numberFormatLocal
propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas
localmente com base no idioma especificado nas configurações do sistema.
TypeScript
setNumberFormatsLocal(numberFormatsLocal: string[][]): void;
Parâmetros
numberFormatsLocal string[][]
Retornos
void
setPredefinedCellStyle(predefinedCellStyle)
Representa o estilo de intervalo atual.
TypeScript
setPredefinedCellStyle(predefinedCellStyle: string): void;
Parâmetros
predefinedCellStyle string
Retornos
void
setRowHidden(rowHidden)
Representa se todas as linhas no intervalo atual estiverem ocultas. O valor é true
quando todas as linhas em um intervalo são ocultas. O valor é false quando
nenhuma linha no intervalo é oculta. O valor é null quando algumas linhas em um
intervalo estão ocultas e outras linhas no mesmo intervalo não são ocultas.
TypeScript
setRowHidden(rowHidden: boolean): void;
Parâmetros
rowHidden boolean
Retornos
void
setValue(value)
Define o valor bruto do intervalo especificado. Os dados que estão sendo definidos
podem ser de cadeia de caracteres, número ou booliano. null o valor será ignorado
(não definido ou substituído no Excel). Se o intervalo contiver várias células, cada
célula no intervalo determinado será atualizada com os dados de entrada.
TypeScript
setValue(value: any): void;
Parâmetros
value any
Retornos
void
setValues(values)
Define os valores brutos do intervalo especificado. Os dados fornecidos podem ser
uma cadeia de caracteres, número ou booliano. Se o valor fornecido começar com
uma adição ("+"), menos ("-"), ou sinal igual ("="), o Excel interpretará esse valor
como uma fórmula.
TypeScript
setValues(values: (string | number | boolean)[][]): void;
Parâmetros
values (string | number | boolean)[][]
Retornos
void
Exemplos
TypeScript
/**
* This sample inserts some pre-loaded data into a range.
* It also shows how to get a range that fits the data.
*/
let currentCell = workbook.getActiveCell();
// Calculate the range needed to fit the given data.

let targetRange = currentCell.getResizedRange(DATA.length - 1,
DATA[0].length - 1);
// Set range values to the data.

targetRange.setValues(DATA);
// Autofit the columns so the worksheet is readable.

targetRange.getFormat().autofitColumns();
}
/*
* This sample's data is in a static 2-dimensional array.
* You could also get the input from other ranges or sources.
* Note that each row must have the same number of columns to be valid.
*/
const DATA = [
['Date', 'Salesperson', 'Product', 'Amount']
, ['3/2/2020', 'Anne', 'Pizza', '$1400']
, ['3/2/2020', 'Mariya', 'Pizza', '$1700']
, ['3/7/2020', 'Mark', 'Sandwiches', '$1010']
, ['3/24/2020', 'Anne', 'Pizza', '$750']
, ['3/28/2020', 'Mark', 'Salads', '$510']
, ['4/17/2020', 'Laura', 'Salads', '$900']
, ['4/17/2020', 'Mariya', 'Salads', '$1600']
, ['4/28/2020', 'Laura', 'Sandwiches', '$680']
];
showCard()
Exibe o cartão para uma célula ativa se ele tiver um conteúdo valioso.
TypeScript
showCard(): void;
Retornos
void
showGroupDetails(groupOption)
Mostra os detalhes da linha ou do grupo de colunas.
TypeScript
showGroupDetails(groupOption: GroupOption): void;

Parâmetros
Especifica se deve mostrar os detalhes de linhas agrupadas ou colunas agrupadas.
Retornos
void
ungroup(groupOption)
Desagrupa colunas e linhas para um esboço.
TypeScript
ungroup(groupOption: GroupOption): void;
Parâmetros
Especifica como o intervalo pode ser desagrupado por linhas ou colunas.
Retornos
void
unmerge()
Desfaz a mesclagem das células do intervalo em células separadas.
TypeScript
unmerge(): void;
Retornos
void
ExcelScript.RangeAreas interface
Referência
Pacote: ExcelScript
RangeAreas representa uma coleção de um ou mais intervalos retangulares na mesma
planilha.
Comentários
Exemplos
TypeScript
/**
* This script clears all the cells in the current worksheet that are
displaying errors.
*/
// Get the RangeAreas object for each cell with a formula error.
const errorCells =
usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas,
ExcelScript.SpecialCellValueType.errors);
// If there are any error cells, clear them.

if (errorCells) {
errorCells.clear();
}
}
Métodos
addConditional Adiciona um novo formato condicional à coleção na prioridade de

Format(type) primeira/superior.
calculate() Calcula todas as células no RangeAreas .
clear(applyTo) Limpa valores, formato, preenchimento, borda e outras propriedades

em cada uma das áreas que compõem esse RangeAreas objeto.
clearAllConditional Limpa todos os formatos condicionais ativos no intervalo atual

Formats() especificado.
convertDataTypeToText() Converte todas as células no RangeAreas com tipos de dados em

texto.
copyFrom(sourceRange, Copia dados de célula ou formatação do intervalo de origem ou

copyType, skipBlanks, RangeAreas para o atual RangeAreas . O destino RangeAreas pode ser
transpose) um tamanho diferente do intervalo de origem ou RangeAreas . O
destino será expandido automaticamente se for menor que a
origem.
getAddress() Retorna a RangeAreas referência no estilo A1. O valor do endereço

conterá o nome da planilha para cada bloco retangular de células
(por exemplo, "Sheet1! A1:B4, Sheet1! D1:D4").
getAddressLocal() Retorna a RangeAreas referência na localidade do usuário.
getAreaCount() Retorna o número de intervalos retangulares que compõem esse

RangeAreas objeto.
getAreas() Retorna uma coleção de intervalos retangulares que compõem esse

RangeAreas objeto.
getCellCount() Retorna o número de células no RangeAreas objeto, resumindo as

contagens de células de todos os intervalos retangulares individuais.
Retornará -1 se a contagem de células exceder 2^31-1
(2.147.483.647).
getConditionalFormat(id) Retorna um formato condicional identificado por sua ID. Se o objeto

de formato condicional não existir, esse método retornará
undefined .
getConditionalFormats() Retorna uma coleção de formatos condicionais que se cruzam com

todas as células deste RangeAreas objeto.
getDataValidation() Retorna um objeto de validação de dados para todos os intervalos

no RangeAreas .
getEntireColumn() Retorna um RangeAreas objeto que representa as colunas inteiras do

RangeAreas (por exemplo, se o atual RangeAreas representa as
células "B4:E11, H2", ele retorna um RangeAreas que representa
colunas "B:E, H:H").
getEntireRow() Retorna um RangeAreas objeto que representa as linhas inteiras do

RangeAreas (por exemplo, se o atual RangeAreas representa as
células "B4:E11", ele retorna um RangeAreas que representa linhas
"4:11").
getFormat() Retorna um RangeFormat objeto, encapsulando a fonte,
preenchimento, bordas, alinhamento e outras propriedades para
todos os intervalos no RangeAreas objeto.
getIntersection(another Retorna o RangeAreas objeto que representa a interseção dos

Range) intervalos determinados ou RangeAreas . Se nenhuma interseção for
encontrada, esse método retornará undefined .
getIsEntireColumn() Especifica se todos os intervalos neste RangeAreas objeto

representam colunas inteiras (por exemplo, "A:C, Q:Z").
getIsEntireRow() Especifica se todos os intervalos neste RangeAreas objeto

representam linhas inteiras (por exemplo, "1:3, 5:7").
getOffsetRangeAreas(row Retorna um RangeAreas objeto que é deslocado pela linha específica

Offset, columnOffset) e deslocamento de coluna. A dimensão do retornado RangeAreas
corresponderá ao objeto original. Se o resultado RangeAreas for
forçado fora dos limites da grade da planilha, um erro será gerado.
getPredefinedCellStyle() Representa o estilo para todos os intervalos neste RangeAreas

objeto. Se os estilos das células forem inconsistentes, null serão
retornados. Para estilos personalizados, o nome do estilo será
retornado. Para estilos internos, uma cadeia de caracteres que
representa um valor no BuiltInStyle enum será retornada.
getSpecialCells(cellType, Retorna um RangeAreas objeto que representa todas as células que

cellValueType) correspondem ao tipo e valor especificados. Se nenhuma célula
especial for encontrada que corresponda aos critérios, esse método
getTables(fullyContained) Retorna uma coleção de tabelas com escopo que se sobrepõe a

qualquer intervalo neste RangeAreas objeto.
getUsedRange Retorna o usado RangeAreas que compreende todas as áreas usadas

Areas(valuesOnly) de intervalos retangulares individuais no RangeAreas objeto. Se não
houver células usadas no RangeAreas , esse método retornará
undefined .
getWorksheet() Retorna a planilha para o atual RangeAreas .
setDirty() Define o RangeAreas a ser recalculado quando ocorrer o próximo

recálculo.
setPredefinedCell Representa o estilo para todos os intervalos neste RangeAreas

Style(predefinedCellStyle) objeto. Se os estilos das células forem inconsistentes, null serão
retornados. Para estilos personalizados, o nome do estilo será
retornado. Para estilos internos, uma cadeia de caracteres que
Detalhes do método
addConditionalFormat(type)
Adiciona um novo formato condicional à coleção na prioridade de primeira/superior.
TypeScript
addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;
Parâmetros
type ExcelScript.ConditionalFormatType
O tipo de formato condicional que está sendo adicionado. Confira
ExcelScript.ConditionalFormatType detalhes.
Retornos
ExcelScript.ConditionalFormat
calculate()
Calcula todas as células no RangeAreas .
TypeScript
calculate(): void;
Retornos
void
clear(applyTo)
Limpa valores, formato, preenchimento, borda e outras propriedades em cada uma
das áreas que compõem esse RangeAreas objeto.
TypeScript
clear(applyTo?: ClearApplyTo): void;

Parâmetros
applyTo ExcelScript.ClearApplyTo
Opcional. Determina o tipo de ação clara. Confira ExcelScript.ClearApplyTo
detalhes. O padrão é "Todos".
Retornos
void
Exemplos
TypeScript
/**
* This script clears all the cells in the current worksheet that are
displaying errors.
*/
// Get the RangeAreas object for each cell with a formula error.
const errorCells =
usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas,
ExcelScript.SpecialCellValueType.errors);
// If there are any error cells, clear them.

if (errorCells) {
errorCells.clear();
}
}
clearAllConditionalFormats()
Limpa todos os formatos condicionais ativos no intervalo atual especificado.
TypeScript
clearAllConditionalFormats(): void;
Retornos
void
convertDataTypeToText()
Converte todas as células no RangeAreas com tipos de dados em texto.
TypeScript
convertDataTypeToText(): void;
Retornos
void
copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copia dados de célula ou formatação do intervalo de origem ou RangeAreas para o
atual RangeAreas . O destino RangeAreas pode ser um tamanho diferente do intervalo
de origem ou RangeAreas . O destino será expandido automaticamente se for menor
que a origem.
TypeScript
copyFrom(
sourceRange: Range | RangeAreas | string,
copyType?: RangeCopyType,
skipBlanks?: boolean,
transpose?: boolean
): void;
Parâmetros
sourceRange ExcelScript.Range | ExcelScript.RangeAreas | string
O intervalo de origem ou RangeAreas para copiar. Quando a origem RangeAreas tem
vários intervalos, seu formulário deve ser capaz de ser criado removendo linhas ou
colunas completas de um intervalo retangular.
copyType ExcelScript.RangeCopyType
O tipo de dados de célula ou formatação a ser copiado. O padrão é "Todos".
skipBlanks boolean
True se para ignorar células em branco no intervalo de origem ou RangeAreas . O
padrão é false.
transpose boolean
True se para transpor as células no destino RangeAreas . O padrão é false.
Retornos
void
getAddress()
Retorna a RangeAreas referência no estilo A1. O valor do endereço conterá o nome
da planilha para cada bloco retangular de células (por exemplo, "Sheet1! A1:B4,
Sheet1! D1:D4").
TypeScript
getAddress(): string;
Retornos
string
getAddressLocal()
Retorna a RangeAreas referência na localidade do usuário.
TypeScript
getAddressLocal(): string;
Retornos
string
getAreaCount()
Retorna o número de intervalos retangulares que compõem esse RangeAreas objeto.
TypeScript
getAreaCount(): number;
Retornos
number
getAreas()
Retorna uma coleção de intervalos retangulares que compõem esse RangeAreas
objeto.
TypeScript
getAreas(): Range[];
Retornos
ExcelScript.Range[]
getCellCount()
Retorna o número de células no RangeAreas objeto, resumindo as contagens de
células de todos os intervalos retangulares individuais. Retornará -1 se a contagem
de células exceder 2^31-1 (2.147.483.647).
TypeScript
getCellCount(): number;
Retornos
number
getConditionalFormat(id)
Retorna um formato condicional identificado por sua ID. Se o objeto de formato
condicional não existir, esse método retornará undefined .
TypeScript
getConditionalFormat(id: string): ConditionalFormat | undefined;
Parâmetros
id string
A ID do formato condicional.
Retornos
ExcelScript.ConditionalFormat | undefined
getConditionalFormats()
Retorna uma coleção de formatos condicionais que se cruzam com todas as células
deste RangeAreas objeto.
TypeScript
getConditionalFormats(): ConditionalFormat[];
Retornos
ExcelScript.ConditionalFormat[]
getDataValidation()
Retorna um objeto de validação de dados para todos os intervalos no RangeAreas .
TypeScript
getDataValidation(): DataValidation;
Retornos
ExcelScript.DataValidation
getEntireColumn()
Retorna um RangeAreas objeto que representa as colunas inteiras do RangeAreas
(por exemplo, se o atual RangeAreas representa as células "B4:E11, H2", ele retorna
um RangeAreas que representa colunas "B:E, H:H").
TypeScript
getEntireColumn(): RangeAreas;
Retornos
getEntireRow()
Retorna um RangeAreas objeto que representa as linhas inteiras do RangeAreas (por
exemplo, se o atual RangeAreas representa as células "B4:E11", ele retorna um
RangeAreas que representa linhas "4:11").
TypeScript
getEntireRow(): RangeAreas;
Retornos
getFormat()
Retorna um RangeFormat objeto, encapsulando a fonte, preenchimento, bordas,
alinhamento e outras propriedades para todos os intervalos no RangeAreas objeto.
TypeScript
getFormat(): RangeFormat;
Retornos
ExcelScript.RangeFormat
Exemplos
TypeScript
/**
* This script finds and highlights all the cells in the current
worksheet that contain a formula.
*/
// Get the RangeAreas object for each cell with a formula.
const formulaCells =
usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);
// Add a light blue background to the cells containing formulas.

formulaCells.getFormat().getFill().setColor("#ADD8E6");
}
getIntersection(anotherRange)
Retorna o RangeAreas objeto que representa a interseção dos intervalos
determinados ou RangeAreas . Se nenhuma interseção for encontrada, esse método
TypeScript
getIntersection(anotherRange: Range | RangeAreas | string): RangeAreas;
Parâmetros
anotherRange ExcelScript.Range | ExcelScript.RangeAreas | string
O intervalo, RangeAreas objeto ou endereço que será usado para determinar a
interseção.
Retornos
getIsEntireColumn()
Especifica se todos os intervalos neste RangeAreas objeto representam colunas
inteiras (por exemplo, "A:C, Q:Z").
TypeScript
getIsEntireColumn(): boolean;
Retornos
boolean
getIsEntireRow()
Especifica se todos os intervalos neste RangeAreas objeto representam linhas inteiras
(por exemplo, "1:3, 5:7").
TypeScript
getIsEntireRow(): boolean;
Retornos
boolean
getOffsetRangeAreas(rowOffset, columnOffset)
Retorna um RangeAreas objeto que é deslocado pela linha específica e deslocamento
de coluna. A dimensão do retornado RangeAreas corresponderá ao objeto original.
Se o resultado RangeAreas for forçado fora dos limites da grade da planilha, um erro
será gerado.
TypeScript
getOffsetRangeAreas(
rowOffset: number,
columnOffset: number
): RangeAreas;
Parâmetros
rowOffset number
O número de linhas (positivas, negativas ou 0) pelas quais o RangeAreas deve ser
compensado. Valores positivos estão deslocados para baixo, e os valores negativos
para cima.
columnOffset number
O número de colunas (positivas, negativas ou 0) pelas quais o RangeAreas deve ser
compensado. Valores positivos estão deslocados para a direita, e os valores
negativos para a esquerda.
Retornos
getPredefinedCellStyle()
Representa o estilo para todos os intervalos neste RangeAreas objeto. Se os estilos
das células forem inconsistentes, null serão retornados. Para estilos personalizados,
o nome do estilo será retornado. Para estilos internos, uma cadeia de caracteres que
TypeScript
getPredefinedCellStyle(): string;
Retornos
string
getSpecialCells(cellType, cellValueType)
Retorna um RangeAreas objeto que representa todas as células que correspondem
ao tipo e valor especificados. Se nenhuma célula especial for encontrada que
corresponda aos critérios, esse método retornará undefined .
TypeScript
getSpecialCells(
cellType: SpecialCellType,
cellValueType?: SpecialCellValueType
): RangeAreas;
Parâmetros
cellType ExcelScript.SpecialCellType
O tipo de células a serem incluídas.
cellValueType ExcelScript.SpecialCellValueType
Se cellType for constants ou formulas , esse argumento será usado para determinar
quais tipos de células incluir no resultado. Esses valores podem ser combinados para
retornar mais de um tipo. O padrão é selecionar todas as constantes ou as fórmulas,
independente do tipo.
Retornos
getTables(fullyContained)
Retorna uma coleção de tabelas com escopo que se sobrepõe a qualquer intervalo
neste RangeAreas objeto.
TypeScript
getTables(fullyContained?: boolean): Table[];
Parâmetros
Se true , retornará apenas tabelas totalmente contidas nos limites de intervalo. O
padrão é false .
Retornos
ExcelScript.Table[]
getUsedRangeAreas(valuesOnly)
Retorna o usado RangeAreas que compreende todas as áreas usadas de intervalos
retangulares individuais no RangeAreas objeto. Se não houver células usadas no
RangeAreas , esse método retornará undefined .
TypeScript
getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;
Parâmetros
valuesOnly boolean
Se deve considerar apenas células com valores como células usadas.
Retornos
getWorksheet()
Retorna a planilha para o atual RangeAreas .
TypeScript
Retornos
setDirty()
Define o RangeAreas a ser recalculado quando ocorrer o próximo recálculo.
TypeScript
setDirty(): void;
Retornos
void
setPredefinedCellStyle(predefinedCellStyle)
Representa o estilo para todos os intervalos neste RangeAreas objeto. Se os estilos
das células forem inconsistentes, null serão retornados. Para estilos personalizados,
o nome do estilo será retornado. Para estilos internos, uma cadeia de caracteres que
TypeScript
setPredefinedCellStyle(predefinedCellStyle: string): void;
Parâmetros
predefinedCellStyle string
Retornos
void
Exemplos
TypeScript
/**
* This script sets the cell style to "warning text"
* on every cell with a formula error.
*/
// Get the used range in the current worksheet.
// Get any cells that are displaying errors.

const errorCells = usedRange.getSpecialCells(
ExcelScript.SpecialCellType.formulas,
ExcelScript.SpecialCellValueType.errors
);
// Check if there are error cells before proceeding.

if (errorCells) {
// Use the built-in warning text style on the error cells.
errorCells.setPredefinedCellStyle(
ExcelScript.BuiltInStyle.warningText.toString()
);
} else {
console.log("No formula errors in the worksheet.");
}
}
ExcelScript.RangeBorder interface
Referência
Pacote: ExcelScript
Representa a borda de um objeto.
Métodos
getColor() Código de cor HTML que representa a cor da linha de borda, no formulário
#RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por
getSideIndex() Valor constante que indica o lado específico da borda. Confira

ExcelScript.BorderIndex detalhes.
getStyle() Uma das constantes de estilo de linha especificando o estilo de linha da

borda. Confira ExcelScript.BorderLineStyle detalhes.
getTintAndShade() Especifica um duplo que clareia ou escure uma cor para a borda de
intervalo, o valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a
cor original. Um null valor indica que a borda não tem uma configuração
uniforme tintAndShade .
getWeight() Especifica o peso da borda em torno de um intervalo. Confira

ExcelScript.BorderWeight detalhes.
setColor(color) Código de cor HTML que representa a cor da linha de borda, no formulário
#RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por
setStyle(style) Uma das constantes de estilo de linha especificando o estilo de linha da

borda. Confira ExcelScript.BorderLineStyle detalhes.
setTintAnd Especifica um duplo que clareia ou escure uma cor para a borda de
Shade(tintAnd intervalo, o valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a
Shade) cor original. Um null valor indica que a borda não tem uma configuração
uniforme tintAndShade .
setWeight(weight) Especifica o peso da borda em torno de um intervalo. Confira

Detalhes do método
getColor()
#RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por exemplo,
"laranja").
TypeScript
getColor(): string;
Retornos
string
getSideIndex()
Valor constante que indica o lado específico da borda. Confira
ExcelScript.BorderIndex detalhes.
TypeScript
getSideIndex(): BorderIndex;
Retornos
ExcelScript.BorderIndex
getStyle()
TypeScript
getStyle(): BorderLineStyle;
Retornos
ExcelScript.BorderLineStyle
getTintAndShade()
Especifica um duplo que clareia ou escure uma cor para a borda de intervalo, o valor
valor indica que a borda não tem uma configuração uniforme tintAndShade .
TypeScript
getTintAndShade(): number;
Retornos
number
getWeight()
Especifica o peso da borda em torno de um intervalo. Confira
TypeScript
getWeight(): BorderWeight;
Retornos
ExcelScript.BorderWeight
setColor(color)
"laranja").
TypeScript
Parâmetros
color string
Retornos
void
setStyle(style)
TypeScript
setStyle(style: BorderLineStyle): void;
Parâmetros
style ExcelScript.BorderLineStyle
Retornos
void
Exemplos
TypeScript
/**
* This script adds a border around the outside of a range.
*/
// Get a range from the current worksheet.
let range = workbook.getActiveWorksheet().getRange("B2:E15");
// Add a border around the whole bounding range.

let format = range.getFormat();
}
setTintAndShade(tintAndShade)
Especifica um duplo que clareia ou escure uma cor para a borda de intervalo, o valor
valor indica que a borda não tem uma configuração uniforme tintAndShade .
TypeScript
setTintAndShade(tintAndShade: number): void;
Parâmetros
tintAndShade number
Retornos
void
setWeight(weight)
Especifica o peso da borda em torno de um intervalo. Confira
TypeScript
setWeight(weight: BorderWeight): void;
Parâmetros
weight ExcelScript.BorderWeight
Retornos
void
Exemplos
TypeScript
/**
*/
// Get a RangeBorder object for each edge of the range and set the
border properties.
let edgeBottom =

let edgeRight =
format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
}
ExcelScript.RangeFill interface
Referência
Pacote: ExcelScript
Representa a tela de fundo de um objeto Range.
Comentários
Exemplos
TypeScript
/**
* This script sets the fill color of the used range to green.
*/
{
// Get the used range of the current worksheet.
let usedRange = currentSheet.getUsedRange();
// Get the RangeFill object.

let fill = usedRange.getFormat().getFill();

fill.setColor("green");
}
Métodos
clear() Redefine a tela de fundo do intervalo.
getColor() Código de cor HTML que representa a cor do plano de fundo, no

formulário #RRGGBB (por exemplo, "FFA500" ou como uma cor HTML
nomeada (por exemplo, "laranja")
getPattern() O padrão de um intervalo. Confira ExcelScript.FillPattern detalhes.

LinearGradient e RectangularGradient não são compatíveis. Um null
valor indica que todo o intervalo não tem uma configuração de padrão
uniforme.
getPatternColor() O código de cores HTML que representa a cor do padrão de intervalo, no
getPatternTintAnd Especifica um duplo que clareia ou escure uma cor de padrão para o
Shade() preenchimento de intervalo. O valor é entre -1 (mais escuro) e 1 (mais
brilhante), com 0 para a cor original. Um null valor indica que o
intervalo não tem configurações uniformes patternTintAndShade .
getTintAndShade() Especifica um duplo que clareia ou escure uma cor para o preenchimento
de intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0
para a cor original. Um null valor indica que o intervalo não tem
configurações uniformes tintAndShade .
setColor(color) Código de cor HTML que representa a cor do plano de fundo, no

setPattern(pattern) O padrão de um intervalo. Confira ExcelScript.FillPattern detalhes.

LinearGradient e RectangularGradient não são compatíveis. Um null
valor indica que todo o intervalo não tem uma configuração de padrão
uniforme.
setPattern O código de cores HTML que representa a cor do padrão de intervalo, no

Color(patternColor) formulário #RRGGBB (por exemplo, "FFA500" ou como uma cor HTML
setPatternTintAnd Especifica um duplo que clareia ou escure uma cor de padrão para o
Shade(patternTint preenchimento de intervalo. O valor é entre -1 (mais escuro) e 1 (mais
AndShade) brilhante), com 0 para a cor original. Um null valor indica que o
intervalo não tem configurações uniformes patternTintAndShade .
setTintAndShade(tint Especifica um duplo que clareia ou escure uma cor para o preenchimento
AndShade) de intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0
para a cor original. Um null valor indica que o intervalo não tem
configurações uniformes tintAndShade .
Detalhes do método
clear()
Redefine a tela de fundo do intervalo.
TypeScript
clear(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script removes all fill color and styles from the used range.
*/
{
let usedRange = currentSheet.getUsedRange();
// Clear the fill from the entire range.

usedRange.getFormat().getFill().clear();
}
getColor()
"laranja")
TypeScript
getColor(): string;
Retornos
string
getPattern()
O padrão de um intervalo. Confira ExcelScript.FillPattern detalhes. LinearGradient
e RectangularGradient não são compatíveis. Um null valor indica que todo o
intervalo não tem uma configuração de padrão uniforme.
TypeScript
getPattern(): FillPattern;
Retornos
ExcelScript.FillPattern
getPatternColor()
O código de cores HTML que representa a cor do padrão de intervalo, no formulário
"laranja").
TypeScript
getPatternColor(): string;
Retornos
string
getPatternTintAndShade()
Especifica um duplo que clareia ou escure uma cor de padrão para o preenchimento
de intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor
original. Um null valor indica que o intervalo não tem configurações uniformes
patternTintAndShade .
TypeScript
getPatternTintAndShade(): number;
Retornos
number
getTintAndShade()
Especifica um duplo que clareia ou escure uma cor para o preenchimento de
intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor
tintAndShade .
TypeScript
Retornos
number
setColor(color)
"laranja")
TypeScript
Parâmetros
color string
Retornos
void
Exemplos
TypeScript
/**
* This script sets the fill color of cell A2 to blue.
*/
// Get the range representing cell A2 from the current worksheet.
let cell = workbook.getActiveWorksheet().getRange("A2");
// Set the fill color to blue.

cell.getFormat().getFill().setColor("blue");
}
setPattern(pattern)
O padrão de um intervalo. Confira ExcelScript.FillPattern detalhes. LinearGradient
e RectangularGradient não são compatíveis. Um null valor indica que todo o
intervalo não tem uma configuração de padrão uniforme.
TypeScript
setPattern(pattern: FillPattern): void;
Parâmetros
pattern ExcelScript.FillPattern
Retornos
void
Exemplos
TypeScript
/**
* This script sets a black-checkered fill on the selected range.
*/
selected.getFormat().getFill().setPattern(ExcelScript.FillPattern.checker
);
selected.getFormat().getFill().setPatternColor("black");
}
setPatternColor(patternColor)
O código de cores HTML que representa a cor do padrão de intervalo, no formulário
"laranja").
TypeScript
setPatternColor(patternColor: string): void;
Parâmetros
patternColor string
Retornos
void
setPatternTintAndShade(patternTintAndShade)
Especifica um duplo que clareia ou escure uma cor de padrão para o preenchimento
de intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor
patternTintAndShade .
TypeScript
setPatternTintAndShade(patternTintAndShade: number): void;
Parâmetros
patternTintAndShade number
Retornos
void
Especifica um duplo que clareia ou escure uma cor para o preenchimento de
intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor
tintAndShade .
TypeScript
Parâmetros
tintAndShade number
Retornos
void
ExcelScript.RangeFont interface
Referência
Pacote: ExcelScript
Esse objeto representa os atributos de fonte de um objeto, como nome, tamanho, cor,
dentre outros.
Comentários
Exemplos
TypeScript
/**
* This script sets the font of A1 to Arial, size 16.
*/
// Get A1 on the current worksheet.
// Adjust the font settings for that cell.

const cellFont = cell.getFormat().getFont();
cellFont.setName("Arial");
cellFont.setSize(16);
}
Métodos
getBold() Representa o status em negrito da fonte.
getColor() Representação de código de cor HTML da cor do texto (por

getItalic() Especifica o status itálico da fonte.
getName() Nome da fonte (por exemplo, "Calibri"). O comprimento do nome

não deve ser maior que 31 caracteres.
getSize() Font Size
getStrikethrough() Especifica o status strikethrough da fonte. Um null valor indica

que todo o intervalo não tem uma configuração de strikethrough
uniforme.
getSubscript() Especifica o status de subscrição da fonte. Retornará true se

todas as fontes do intervalo forem subscript. Retorna false se
todas as fontes do intervalo forem superscript ou normais (nem
superscript nem subscript). Retorna null caso contrário.
getSuperscript() Especifica o status de superscript da fonte. Retornará true se

todas as fontes do intervalo forem superscript. Retornará false se
todas as fontes do intervalo forem subscritos ou normais (nem
getTintAndShade() Especifica um duplo que clareia ou escure uma cor para a fonte de
intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com
0 para a cor original. Um null valor indica que todo o intervalo
não tem uma configuração de fonte tintAndShade uniforme.
getUnderline() Tipo de sublinhado aplicado à fonte. Confira

ExcelScript.RangeUnderlineStyle detalhes.
setBold(bold) Representa o status em negrito da fonte.
setColor(color) Representação de código de cor HTML da cor do texto (por

setItalic(italic) Especifica o status itálico da fonte.
setName(name) Nome da fonte (por exemplo, "Calibri"). O comprimento do nome

não deve ser maior que 31 caracteres.
setSize(size) Font Size
set Especifica o status strikethrough da fonte. Um null valor indica

Strikethrough(strikethrough) que todo o intervalo não tem uma configuração de strikethrough
uniforme.
setSubscript(subscript) Especifica o status de subscrição da fonte. Retornará true se

todas as fontes do intervalo forem subscript. Retorna false se
todas as fontes do intervalo forem superscript ou normais (nem
setSuperscript(superscript) Especifica o status de superscript da fonte. Retornará true se

todas as fontes do intervalo forem superscript. Retornará false se
todas as fontes do intervalo forem subscritos ou normais (nem
setTintAndShade(tintAnd Especifica um duplo que clareia ou escure uma cor para a fonte de
Shade) intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com
0 para a cor original. Um null valor indica que todo o intervalo
não tem uma configuração de fonte tintAndShade uniforme.
setUnderline(underline) Tipo de sublinhado aplicado à fonte. Confira
ExcelScript.RangeUnderlineStyle detalhes.
Detalhes do método
getBold()
Representa o status em negrito da fonte.
TypeScript
getBold(): boolean;
Retornos
boolean
getColor()
TypeScript
getColor(): string;
Retornos
string
getItalic()
Especifica o status itálico da fonte.
TypeScript
Retornos
boolean
getName()
Nome da fonte (por exemplo, "Calibri"). O comprimento do nome não deve ser
maior que 31 caracteres.
TypeScript
getName(): string;
Retornos
string
getSize()
Font Size
TypeScript
getSize(): number;
Retornos
number
getStrikethrough()
Especifica o status strikethrough da fonte. Um null valor indica que todo o intervalo
não tem uma configuração de strikethrough uniforme.
TypeScript
getStrikethrough(): boolean;
Retornos
boolean
getSubscript()
Especifica o status de subscrição da fonte. Retornará true se todas as fontes do
intervalo forem subscript. Retorna false se todas as fontes do intervalo forem
superscript ou normais (nem superscript nem subscript). Retorna null caso
contrário.
TypeScript
getSubscript(): boolean;
Retornos
boolean
getSuperscript()
Especifica o status de superscript da fonte. Retornará true se todas as fontes do
intervalo forem superscript. Retornará false se todas as fontes do intervalo forem
subscritos ou normais (nem superscript nem subscript). Retorna null caso contrário.
TypeScript
getSuperscript(): boolean;
Retornos
boolean
getTintAndShade()
Especifica um duplo que clareia ou escure uma cor para a fonte de intervalo. O valor
valor indica que todo o intervalo não tem uma configuração de fonte tintAndShade
uniforme.
TypeScript
Retornos
number
getUnderline()
Tipo de sublinhado aplicado à fonte. Confira ExcelScript.RangeUnderlineStyle
detalhes.
TypeScript
getUnderline(): RangeUnderlineStyle;
Retornos
ExcelScript.RangeUnderlineStyle
setBold(bold)
Representa o status em negrito da fonte.
TypeScript
Parâmetros
bold boolean
Retornos
void
Exemplos
TypeScript
/**
* This script bolds the text of cell A1.
*/
// Bold the font for that cell
cell.getFormat().getFont().setBold(true);
}
setColor(color)
TypeScript
Parâmetros
color string
Retornos
void
setItalic(italic)
Especifica o status itálico da fonte.
TypeScript
Parâmetros
italic boolean
Retornos
void
setName(name)
Nome da fonte (por exemplo, "Calibri"). O comprimento do nome não deve ser
maior que 31 caracteres.
TypeScript
Parâmetros
name string
Retornos
void
Exemplos
TypeScript
/**
* This script sets the font style of A1 to Arial.
*/
// Adjust the font settings for that cell.

cell.getFormat().getFont().setName("Arial");
}
setSize(size)
Font Size
TypeScript
Parâmetros
size number
Retornos
void
Exemplos
TypeScript
/**
* This script sets the font size of A1 to 16.
*/
// Adjust the font settings for that cell.clear

cell.getFormat().getFont().setSize(16);
}
setStrikethrough(strikethrough)
Especifica o status strikethrough da fonte. Um null valor indica que todo o intervalo
não tem uma configuração de strikethrough uniforme.
TypeScript
setStrikethrough(strikethrough: boolean): void;
Parâmetros
strikethrough boolean
Retornos
void
setSubscript(subscript)
Especifica o status de subscrição da fonte. Retornará true se todas as fontes do
intervalo forem subscript. Retorna false se todas as fontes do intervalo forem
superscript ou normais (nem superscript nem subscript). Retorna null caso
contrário.
TypeScript
setSubscript(subscript: boolean): void;

Parâmetros
subscript boolean
Retornos
void
setSuperscript(superscript)
Especifica o status de superscript da fonte. Retornará true se todas as fontes do
intervalo forem superscript. Retornará false se todas as fontes do intervalo forem
subscritos ou normais (nem superscript nem subscript). Retorna null caso contrário.
TypeScript
setSuperscript(superscript: boolean): void;
Parâmetros
superscript boolean
Retornos
void
Especifica um duplo que clareia ou escure uma cor para a fonte de intervalo. O valor
valor indica que todo o intervalo não tem uma configuração de fonte tintAndShade
uniforme.
TypeScript
Parâmetros
tintAndShade number
Retornos
void
Tipo de sublinhado aplicado à fonte. Confira ExcelScript.RangeUnderlineStyle
detalhes.
TypeScript
setUnderline(underline: RangeUnderlineStyle): void;
Parâmetros
underline ExcelScript.RangeUnderlineStyle
Retornos
void
comentários:
ExcelScript.RangeFormat interface
Referência
Pacote: ExcelScript
Um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o

alinhamento e outras propriedades do intervalo.
Comentários
Exemplos
TypeScript
/**
* This script applies some simple formatting to the top row of the used
range.
*/
// Get the top row of the used range in the current worksheet.
const topRow = selectedSheet.getUsedRange().getRow(0);
// For the top row, set the fill to black, the font color to white, and
the font to be bold.
const format: ExcelScript.RangeFormat = topRow.getFormat();
format.getFill().setColor("black");
format.getFont().setColor("white");
format.getFont().setBold(true);
}
Métodos
adjustIndent(amount) Ajusta o recuo da formatação de intervalo. O valor de recuo varia de

0 a 250 e é medido em caracteres.
autofitColumns() Altera a largura das colunas do intervalo atual para obter o melhor
ajuste, com base nos dados atuais nas colunas.
autofitRows() Altera a altura das linhas do intervalo atual para obter o melhor
ajuste, com base nos dados atuais nas colunas.
getAutoIndent() Especifica se o texto é recuado automaticamente quando o
alinhamento de texto é definido como distribuição igual.
getBorders() Coleção de objetos border que se aplicam a todo o intervalo.
getColumnWidth() Especifica a largura de todas as colunas dentro do intervalo. Se as

larguras da coluna não forem uniformes, null serão retornadas.
getFill() Retorna o objeto de preenchimento definido em todo o intervalo.
getFont() Retorna o objeto font definido em todo o intervalo.
getHorizontalAlignment() Representa o alinhamento horizontal do objeto especificado. Confira

getIndentLevel() Um número inteiro entre 0 e 250 que indica o nível de recuo.
getProtection() Retorna o objeto de proteção de formato para um intervalo.
getRangeBorder(index) Obtém um objeto Border usando o respectivo nome.
getRangeBorderTintAnd Especifica um duplo que clareia ou escure uma cor para bordas de
Shade() intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0
para a cor original. Um null valor indica que toda a coleção de
getReadingOrder() A ordem de leitura para o intervalo.
getRowHeight() A altura de todas as linhas no intervalo. Se as alturas da linha não

forem uniformes, null serão retornadas.
getShrinkToFit() Especifica se o texto reduz automaticamente para se encaixar na

getTextOrientation() A orientação de texto de todas as células dentro do intervalo. A

orientação de texto deve ser um inteiro de -90 a 90 ou 180 para
texto orientado verticalmente. Se a orientação dentro de um
intervalo não for uniforme, será null retornada.
getUseStandardHeight() Determina se a altura da linha do Range objeto é igual à altura

padrão da folha. Retornará true se a altura da linha do Range objeto
for igual à altura padrão da folha. Retorna null se o intervalo
contiver mais de uma linha e as linhas não tiverem a mesma altura.
Retorna false caso contrário.
getUseStandardWidth() Especifica se a largura da coluna do Range objeto é igual à largura

padrão da folha. Retornará true se a largura da coluna do Range
objeto for igual à largura padrão da folha. Retorna null se o
intervalo contiver mais de uma coluna e as colunas não tiverem a
mesma altura. Retorna false caso contrário.
getVerticalAlignment() Representa o alinhamento vertical do objeto especificado. Confira
getWrapText() Especifica se o Excel encapsula o texto no objeto. Um null valor

indica que todo o intervalo não tem uma configuração de envoltório
uniforme
setAutoIndent(auto Especifica se o texto é recuado automaticamente quando o

Indent) alinhamento de texto é definido como distribuição igual.
setColumnWidth(column Especifica a largura de todas as colunas dentro do intervalo.

Width)
setHorizontal Representa o alinhamento horizontal do objeto especificado. Confira

Alignment(horizontal ExcelScript.HorizontalAlignment detalhes.
Alignment)
setIndentLevel(indent Um número inteiro entre 0 e 250 que indica o nível de recuo.

Level)
setRangeBorderTintAnd Especifica um duplo que clareia ou escure uma cor para bordas de
Shade(rangeBorderTint intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0
AndShade) para a cor original. Um null valor indica que toda a coleção de
setReadingOrder(reading A ordem de leitura para o intervalo.

Order)
setRowHeight(rowHeight) Especifica a altura de todas as linhas no intervalo.
setShrinkToFit(shrinkToFit) Especifica se o texto reduz automaticamente para se encaixar na

setTextOrientation(text A orientação de texto de todas as células dentro do intervalo. A

Orientation) orientação de texto deve ser um inteiro de -90 a 90 ou 180 para
texto orientado verticalmente. Se a orientação dentro de um
intervalo não for uniforme, será null retornada.
setUseStandard Determina se a altura da linha do Range objeto é igual à altura

Height(useStandard padrão da folha. Observação: essa propriedade destina-se apenas a
Height) ser definida como true . Defini-lo como false não tem efeito.
setUseStandardWidth(use Especifica se a largura da coluna do Range objeto é igual à largura

StandardWidth) padrão da folha. Observação: essa propriedade destina-se apenas a
ser definida como true . Defini-lo como false não tem efeito.
setVertical Representa o alinhamento vertical do objeto especificado. Confira

Alignment(vertical ExcelScript.VerticalAlignment detalhes.
Alignment)
setWrapText(wrapText) Especifica se o Excel encapsula o texto no objeto. Um null valor
indica que todo o intervalo não tem uma configuração de envoltório
uniforme
Detalhes do método
adjustIndent(amount)
Ajusta o recuo da formatação de intervalo. O valor de recuo varia de 0 a 250 e é
medido em caracteres.
TypeScript
adjustIndent(amount: number): void;
Parâmetros
amount number
O número de espaços de caracteres pelos quais o recuo atual é ajustado. Esse valor
deve estar entre -250 e 250. Observação: se o valor elevar o nível de recuo acima de
250, o nível de recuo permanecerá com 250. Da mesma forma, se o valor diminuir o
nível de recuo abaixo de 0, o nível de recuo permanecerá 0.
Retornos
void
Exemplos
TypeScript
/**
* This script adjusts the indentation of a specific table column.
*/
const table = selectedSheet.getTables()[0];
// Get the data range of the second column.

const secondColumn = table.getColumn(2);
const data = secondColumn.getRangeBetweenHeaderAndTotal();
// Add an indentation of 1 character space to the data range.
data.getFormat().adjustIndent(1);
}
autofitColumns()
Altera a largura das colunas do intervalo atual para obter o melhor ajuste, com base
nos dados atuais nas colunas.
TypeScript
autofitColumns(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script creates a new table from existing data and autofits the
columns.
*/
// Create the table.

const table = currentSheet.addTable(usedRange, true);
// Format the table columns.

table.getRange().getFormat().autofitColumns();
}
autofitRows()
Altera a altura das linhas do intervalo atual para obter o melhor ajuste, com base nos
dados atuais nas colunas.
TypeScript
autofitRows(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script creates a new table from existing data and autofits the
rows.
*/
// Create the table.

const table = currentSheet.addTable(usedRange, true);
// Format the table rows.

table.getRange().getFormat().autofitRows();
}
getAutoIndent()
Especifica se o texto é recuado automaticamente quando o alinhamento de texto é
definido como distribuição igual.
TypeScript
getAutoIndent(): boolean;
Retornos
boolean
getBorders()
Coleção de objetos border que se aplicam a todo o intervalo.
TypeScript
getBorders(): RangeBorder[];
Retornos
ExcelScript.RangeBorder[]
getColumnWidth()
Especifica a largura de todas as colunas dentro do intervalo. Se as larguras da coluna
não forem uniformes, null serão retornadas.
TypeScript
getColumnWidth(): number;
Retornos
number
Exemplos
TypeScript
/**
* This script doubles the column width for every column in the active
worksheet's used range.
*/
// To optimize performance, get all the current row heights before

setting them.
let currentWidths = Array<number>(usedRange.getColumnCount());
for (let column = 0; column < currentWidths.length; column++) {
currentWidths[column] =
usedRange.getColumn(column).getFormat().getColumnWidth();
}
// Set the new column widths.

for (let column = 0; column < currentWidths.length; column++) {
usedRange.getFormat().setColumnWidth(currentWidths[column] * 2);
}
getFill()
Retorna o objeto de preenchimento definido em todo o intervalo.
TypeScript
getFill(): RangeFill;
Retornos
ExcelScript.RangeFill
Exemplos
TypeScript
/**
* This script gives the total row of a table a green color fill.
*/
let table = workbook.getTables()[0];
// Get the range for the total row of the table.

let totalRange = table.getTotalRowRange();

totalRange.getFormat().getFill().setColor("green");
}
getFont()
Retorna o objeto font definido em todo o intervalo.
TypeScript
getFont(): RangeFont;
Retornos
ExcelScript.RangeFont
Exemplos
TypeScript
/**
* This script bolds the text of cell A1.
*/
// Bold the font for that cell

cell.getFormat().getFont().setBold(true);
}
Representa o alinhamento horizontal do objeto especificado. Confira
TypeScript
getHorizontalAlignment(): HorizontalAlignment;
Retornos
getIndentLevel()
Um número inteiro entre 0 e 250 que indica o nível de recuo.
TypeScript
getIndentLevel(): number;
Retornos
number
getProtection()
Retorna o objeto de proteção de formato para um intervalo.
TypeScript
getProtection(): FormatProtection;
Retornos
ExcelScript.FormatProtection
getRangeBorder(index)
TypeScript
getRangeBorder(index: BorderIndex): RangeBorder;
Parâmetros
index ExcelScript.BorderIndex
Valor de índice do objeto Border a ser recuperado. Confira ExcelScript.BorderIndex
detalhes.
Retornos
ExcelScript.RangeBorder
Exemplos
TypeScript
/**
* This script adds a border around the outside of a range.
*/
// Get a range from the current worksheet.
let range = workbook.getActiveWorksheet().getRange("B2:E15");
// Add a border around the whole bounding range.

let format = range.getFormat();
}
getRangeBorderTintAndShade()
tintAndShade .
TypeScript
getRangeBorderTintAndShade(): number;
Retornos
number
getReadingOrder()
A ordem de leitura para o intervalo.
TypeScript
getReadingOrder(): ReadingOrder;
Retornos
getRowHeight()
A altura de todas as linhas no intervalo. Se as alturas da linha não forem uniformes,
null serão retornadas.
TypeScript
getRowHeight(): number;
Retornos
number
Exemplos
TypeScript
/**
* This script doubles the row height for every row in the active
worksheet's used range.
*/
// To optimize performance, get all the current row heights before

setting them.
let currentHeights = Array<number>(usedRange.getRowCount());
for (let row = 0; row < currentHeights.length; row++) {
currentHeights[row] =
usedRange.getRow(row).getFormat().getRowHeight();
}
// Set the new row heights.

for (let row = 0; row < currentHeights.length; row++) {
usedRange.getFormat().setRowHeight(currentHeights[row] * 2);
}
}
getShrinkToFit()
disponível.
TypeScript
getShrinkToFit(): boolean;
Retornos
boolean
A orientação de texto de todas as células dentro do intervalo. A orientação de texto
deve ser um inteiro de -90 a 90 ou 180 para texto orientado verticalmente. Se a
orientação dentro de um intervalo não for uniforme, será null retornada.
TypeScript
Retornos
number
getUseStandardHeight()
Determina se a altura da linha do Range objeto é igual à altura padrão da folha.
Retornará true se a altura da linha do Range objeto for igual à altura padrão da
folha. Retorna null se o intervalo contiver mais de uma linha e as linhas não tiverem
a mesma altura. Retorna false caso contrário.
TypeScript
getUseStandardHeight(): boolean;
Retornos
boolean
getUseStandardWidth()
Especifica se a largura da coluna do Range objeto é igual à largura padrão da folha.
Retornará true se a largura da coluna do Range objeto for igual à largura padrão da
folha. Retorna null se o intervalo contiver mais de uma coluna e as colunas não
tiverem a mesma altura. Retorna false caso contrário.
TypeScript
getUseStandardWidth(): boolean;
Retornos
boolean
Representa o alinhamento vertical do objeto especificado. Confira
TypeScript
getVerticalAlignment(): VerticalAlignment;
Retornos
getWrapText()
Especifica se o Excel encapsula o texto no objeto. Um null valor indica que todo o
intervalo não tem uma configuração de envoltório uniforme
TypeScript
getWrapText(): boolean;
Retornos
boolean
setAutoIndent(autoIndent)
Especifica se o texto é recuado automaticamente quando o alinhamento de texto é
definido como distribuição igual.
TypeScript
setAutoIndent(autoIndent: boolean): void;
Parâmetros
autoIndent boolean
Retornos
void
setColumnWidth(columnWidth)
Especifica a largura de todas as colunas dentro do intervalo.
TypeScript
setColumnWidth(columnWidth: number): void;
Parâmetros
columnWidth number
Retornos
void
Exemplos
TypeScript
/**
* This script inserts a new column and sets that column's width to 100
pixels wide.
*/
// Insert a new column between the current B and C columns.

const bcRange = currentSheet.getRange("C:C");
const newColumn =
bcRange.insert(ExcelScript.InsertShiftDirection.right);
// Set the column width of the new column to 100 pixels.

newColumn.getFormat().setColumnWidth(100);
}
Representa o alinhamento horizontal do objeto especificado. Confira
TypeScript
setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;
Parâmetros
horizontalAlignment ExcelScript.HorizontalAlignment
Retornos
void
Exemplos
TypeScript
/**
*/

headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlig
nment.center);
}
setIndentLevel(indentLevel)
Um número inteiro entre 0 e 250 que indica o nível de recuo.
TypeScript
setIndentLevel(indentLevel: number): void;
Parâmetros
indentLevel number
Retornos
void
setRangeBorderTintAndShade(rangeBorderTintAnd
Shade)
tintAndShade .
TypeScript
setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;
Parâmetros
rangeBorderTintAndShade number
Retornos
void
A ordem de leitura para o intervalo.
TypeScript
setReadingOrder(readingOrder: ReadingOrder): void;
Parâmetros
readingOrder ExcelScript.ReadingOrder
Retornos
void
setRowHeight(rowHeight)
Especifica a altura de todas as linhas no intervalo.
TypeScript
setRowHeight(rowHeight: number): void;
Parâmetros
rowHeight number
Retornos
void
Exemplos
TypeScript
/**
* This script inserts a new row and sets that row's width to 100 pixels
tall.
*/
// Insert a new row between the current 2 and 3 rows.

const bcRange = currentSheet.getRange("3:3");
const newRow = bcRange.insert(ExcelScript.InsertShiftDirection.down);
// Set the row height of the new row to 100 pixels.

newRow.getFormat().setRowHeight(100);
}
setShrinkToFit(shrinkToFit)
disponível.
TypeScript
setShrinkToFit(shrinkToFit: boolean): void;
Parâmetros
shrinkToFit boolean
Retornos
void
A orientação de texto de todas as células dentro do intervalo. A orientação de texto
deve ser um inteiro de -90 a 90 ou 180 para texto orientado verticalmente. Se a
orientação dentro de um intervalo não for uniforme, será null retornada.
TypeScript
Parâmetros
Retornos
void
setUseStandardHeight(useStandardHeight)
Determina se a altura da linha do Range objeto é igual à altura padrão da folha.
Observação: essa propriedade destina-se apenas a ser definida como true . Defini-lo
como false não tem efeito.
TypeScript
setUseStandardHeight(useStandardHeight: boolean): void;
Parâmetros
useStandardHeight boolean
Retornos
void
setUseStandardWidth(useStandardWidth)
Especifica se a largura da coluna do Range objeto é igual à largura padrão da folha.
Observação: essa propriedade destina-se apenas a ser definida como true . Defini-lo
como false não tem efeito.
TypeScript
setUseStandardWidth(useStandardWidth: boolean): void;
Parâmetros
useStandardWidth boolean
Retornos
void
Representa o alinhamento vertical do objeto especificado. Confira
TypeScript
setVerticalAlignment(verticalAlignment: VerticalAlignment): void;
Parâmetros
verticalAlignment ExcelScript.VerticalAlignment
Retornos
void
Exemplos
TypeScript
/**
* This script sets the vertical alignment formatting to "top"
* for every cell in the row.
*/
// Get row 1 for the current worksheet.
const firstRow = sheet.getRange("1:1");
// Set the vertical alignment formatting on the row.
firstRow.getFormat().setVerticalAlignment(ExcelScript.VerticalAlignment.t
op);
}
setWrapText(wrapText)
Especifica se o Excel encapsula o texto no objeto. Um null valor indica que todo o
intervalo não tem uma configuração de envoltório uniforme
TypeScript
setWrapText(wrapText: boolean): void;
Parâmetros
wrapText boolean
Retornos
void
Exemplos
TypeScript
/**
* This script turns on the text wrapping for a column.
*/
// Get the E column in current worksheet.
const column = workbook.getActiveWorksheet().getRange("E:E");
// Set wrap text to true for the column.

column.getFormat().setWrapText(true);
}
comentários:
ExcelScript.RangeHyperlink interface
Referência
Pacote: ExcelScript
Representa as cadeias de caracteres necessárias para obter/definir um objeto XHL

(hiperlink).
Comentários
Exemplos
TypeScript
/**
* This script puts a link to a webpage in a cell.
*/
// Create a link to a webpage.

const sampleHyperlink : ExcelScript.RangeHyperlink = {
address:
"https://learn.microsoft.com/office/dev/scripts/resources/samples/table-of-
contents",
screenTip: "Sample: Create a workbook table of contents",
textToDisplay: "Learn how to make a workbook table of contents"
}
// Put the link in the cell and format the width to fit.
cell.setHyperlink(sampleHyperlink);
cell.getFormat().autofitColumns();
}
Propriedades
address Representa o destino da URL para o hiperlink.
document Representa o destino de referência do documento para o hiperlink.

Reference
screenTip Representa a cadeia exibida ao passar o mouse sobre o hiperlink.
textToDisplay Representa a cadeia de caracteres exibida na parte superior esquerda da

maioria das células no intervalo.
address
Representa o destino da URL para o hiperlink.
TypeScript
address?: string;
string
documentReference
Representa o destino de referência do documento para o hiperlink.
TypeScript
documentReference?: string;
string
screenTip
Representa a cadeia exibida ao passar o mouse sobre o hiperlink.
TypeScript
screenTip?: string;
string
textToDisplay
Representa a cadeia de caracteres exibida na parte superior esquerda da maioria das
células no intervalo.
TypeScript
textToDisplay?: string;
string
comentários:
ExcelScript.RangeSort interface
Referência
Pacote: ExcelScript
Gerencia operações de classificação em Range objetos.
Métodos
apply(fields, matchCase, hasHeaders, orientation, Executa uma operação de

method) classificação.
Detalhes do método
apply(fields, matchCase, hasHeaders, orientation,

method)
Executa uma operação de classificação.
TypeScript
apply(
fields: SortField[],
matchCase?: boolean,
hasHeaders?: boolean,
orientation?: SortOrientation,
method?: SortMethod
): void;
Parâmetros
fields ExcelScript.SortField[]
A lista de condições para a classificação.
matchCase boolean
Opcional. Define se o uso de maiúsculas ou minúsculas afeta a ordenação da cadeia
de caracteres.
hasHeaders boolean
Opcional. Se o intervalo tem um cabeçalho.
orientation ExcelScript.SortOrientation
Opcional. Se a operação classifica linhas ou colunas.
method ExcelScript.SortMethod
Opcional. O método de ordenação usado pelos caracteres chineses.
Retornos
void
Exemplos
TypeScript
/**
* This script sorts the used range of the current worksheet.
*/
const activeRange = workbook.getActiveWorksheet().getUsedRange();
// Sort the rows in ascending order based on the last column.

activeRange.getSort().apply(
[{
ascending: true,
key: activeRange.getColumnCount() - 1
}],
false, /* Don't match case. */
true, /* Treat the first row as a header row. */
ExcelScript.SortOrientation.rows
);
}
comentários:
ExcelScript.RangeView interface
Referência
Pacote: ExcelScript
RangeView representa um conjunto de células visíveis do intervalo pai.
Comentários
Exemplos
TypeScript
/**
*/
const source =

}
Métodos
getCellAddresses() Representa os endereços de célula do RangeView .
getColumnCount() O número de colunas visíveis.
getFormulas() Representa a fórmula em notação A1. Se uma célula não tiver

getFormulasLocal() Representa a fórmula em notação A1, na formatação de número

da localidade e no idioma do usuário. Por exemplo, a fórmula
"=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em
retornado.
getFormulasR1C1() Representa a fórmula em notação no estilo L1C1. Se uma célula

não tiver fórmula, seu valor será retornado.
getIndex() Retorna um valor que representa o índice do RangeView .
getNumberFormat() Representa o código de formato de número do Excel para

determinada célula.
getRange() Obtém o intervalo pai associado ao atual RangeView .
getRowCount() O número de linhas visíveis.
getRows() Representa uma coleção de exibições de tabelas associadas ao

intervalo.
getText() Valores de texto do intervalo especificado. O valor de texto não

depende da largura da célula. A substituição do sinal # que
ocorre na interface do usuário do Excel não afeta o valor de
texto retornado pela API.
getValues() Representa os valores brutos da exibição do intervalo

especificado. Os dados retornados podem ser dos tipos: cadeia
de caracteres, número ou booliano. Células que contêm um erro
retornarão a cadeia de caracteres de erro.
getValueTypes() Representa o tipo de dados de cada célula.
setFormulas(formulas) Representa a fórmula em notação A1. Se uma célula não tiver

setFormulasLocal(formulas Representa a fórmula em notação A1, na formatação de número

Local) da localidade e no idioma do usuário. Por exemplo, a fórmula
"=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em
retornado.
set Representa a fórmula em notação no estilo L1C1. Se uma célula

FormulasR1C1(formulasR1C1) não tiver fórmula, seu valor será retornado.
setNumberFormat(number Representa o código de formato de número do Excel para

Format) determinada célula.
setValues(values) Representa os valores brutos da exibição do intervalo

especificado. Os dados retornados podem ser dos tipos: cadeia
de caracteres, número ou booliano. Células que contêm um erro
retornarão a cadeia de caracteres de erro.
Detalhes do método
getCellAddresses()
Representa os endereços de célula do RangeView .
TypeScript
getCellAddresses(): string[][];
Retornos
string[][]
Exemplos
TypeScript
/**
*/
const source =

}
getColumnCount()
O número de colunas visíveis.
TypeScript
getColumnCount(): number;
Retornos
number
getFormulas()
retornado.
TypeScript
getFormulas(): string[][];
Retornos
string[][]
getFormulasLocal()
retornado.
TypeScript
getFormulasLocal(): string[][];
Retornos
string[][]
getFormulasR1C1()
TypeScript
getFormulasR1C1(): string[][];
Retornos
string[][]
getIndex()
Retorna um valor que representa o índice do RangeView .
TypeScript
getIndex(): number;
Retornos
number
getNumberFormat()
Representa o código de formato de número do Excel para determinada célula.
TypeScript
getNumberFormat(): string[][];
Retornos
string[][]
getRange()
Obtém o intervalo pai associado ao atual RangeView .
TypeScript
getRange(): Range;
Retornos
ExcelScript.Range
getRowCount()
O número de linhas visíveis.
TypeScript
Retornos
number
getRows()
Representa uma coleção de exibições de tabelas associadas ao intervalo.
TypeScript
getRows(): RangeView[];
Retornos
ExcelScript.RangeView[]
getText()
Valores de texto do intervalo especificado. O valor de texto não depende da largura
da célula. A substituição do sinal # que ocorre na interface do usuário do Excel não
afeta o valor de texto retornado pela API.
TypeScript
getText(): string[][];
Retornos
string[][]
getValues()
Representa os valores brutos da exibição do intervalo especificado. Os dados
retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células
que contêm um erro retornarão a cadeia de caracteres de erro.
TypeScript
Retornos
getValueTypes()
Representa o tipo de dados de cada célula.
TypeScript
getValueTypes(): RangeValueType[][];
Retornos
setFormulas(formulas)
retornado.
TypeScript
setFormulas(formulas: string[][]): void;
Parâmetros
formulas string[][]
Retornos
void
setFormulasLocal(formulasLocal)
retornado.
TypeScript
setFormulasLocal(formulasLocal: string[][]): void;
Parâmetros
formulasLocal string[][]
Retornos
void
setFormulasR1C1(formulasR1C1)
TypeScript
setFormulasR1C1(formulasR1C1: string[][]): void;
Parâmetros
formulasR1C1 string[][]
Retornos
void
Representa o código de formato de número do Excel para determinada célula.
TypeScript
setNumberFormat(numberFormat: string[][]): void;
Parâmetros
numberFormat string[][]
Retornos
void
setValues(values)
Representa os valores brutos da exibição do intervalo especificado. Os dados
retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células
que contêm um erro retornarão a cadeia de caracteres de erro.
TypeScript
setValues(values: (string | number | boolean)[][]): void;
Parâmetros
values (string | number | boolean)[][]
Retornos
void
comentários:
ExcelScript.RemoveDuplicatesResult
interface
Referência
Pacote: ExcelScript
Representa os resultados de Range.removeDuplicates .
Métodos
getRemoved() Número de linhas duplicadas removidas pela operação.
getUniqueRemaining() Número de linhas restantes exclusivas presentes no intervalo resultante.
Detalhes do método
getRemoved()
Número de linhas duplicadas removidas pela operação.
TypeScript
getRemoved(): number;
Retornos
number
getUniqueRemaining()
Número de linhas restantes exclusivas presentes no intervalo resultante.
TypeScript
getUniqueRemaining(): number;
Retornos
number
comentários:
ExcelScript.ReplaceCriteria interface
Referência
Pacote: ExcelScript
Representa os critérios de substituição a serem usados.
Propriedades
complete Especifica se a correspondência precisa ser concluída ou parcial. Uma

Match correspondência completa corresponde ao conteúdo inteiro da célula. Uma
correspondência parcial corresponde a uma substring dentro do conteúdo da célula
(por exemplo, cat corresponde parcialmente e scatter ). caterpillar O padrão é
false (parcial).
match Especifica se a correspondência é sensível a maiúsculas de minúsculas. O padrão é

Case false (sem maiúsculas de maiúsculas de minúsculas).
completeMatch
Especifica se a correspondência precisa ser concluída ou parcial. Uma
correspondência completa corresponde ao conteúdo inteiro da célula. Uma
false (parcial).
TypeScript
completeMatch?: boolean;
boolean
Exemplos
TypeScript
/**
* This script normalizes the text in a column so that values don't
include both "OK" and "okay".
* It replaces "OK" and all the case-based variants with "okay".
*/
// Get the range representing column D.
const column = currentSheet.getRange("D:D");
// Create a ReplaceCriteria object for the Range.replaceAll call.

const criteria: ExcelScript.ReplaceCriteria = {
completeMatch: true, /* Use a complete match to skip cells that
already say "okay". */
matchCase: false /* Ignore case when comparing strings. */
};
// Replace all instances of "ok" (case-insensitive) with "okay".

column.replaceAll("ok", "okay", criteria);
}
matchCase
Especifica se a correspondência é sensível a maiúsculas de minúsculas. O padrão é
false (sem maiúsculas de maiúsculas de minúsculas).
TypeScript
matchCase?: boolean;
boolean
Exemplos
TypeScript
/**
* This script replaces instances of "NA" with "North America",
* using the casing to ignore parts of words.
*/
// Get the currently used range.
// Create a ReplaceCriteria object for the Range.replaceAll call.

const criteria: ExcelScript.ReplaceCriteria = {
completeMatch: false,
matchCase: true /* Match with "NA market", not "navigate" */
}
// Replace all instances of "NA" (case-sensitive) with "North America".

usedRange.replaceAll("NA", "North America", criteria);
}
comentários:
interface
Referência
Pacote: ExcelScript
Representa o Excel RowColumnPivotHierarchy.
Comentários
Exemplos
TypeScript
/**
*/

const valueFieldToSortOn: ExcelScript.DataPivotHierarchy =
pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");

const rowToSort: ExcelScript.RowColumnPivotHierarchy =
pivotTable.getRowHierarchy("Farm");
// Sort the "Farm" row's only field by the values in "Sum of Crates Sold
Wholesale".
}
Métodos
getFields() Retorna PivotFields associados a RowColumnPivotHierarchy.
getId() ID do RowColumnPivotHierarchy.
getName() Nome da RowColumnPivotHierarchy.

getPivot Obtém um PivotField pelo nome. Se o PivotField não existir, esse método
Field(name) retornará undefined .
getPosition() Posição da RowColumnPivotHierarchy.
setName(name) Nome da RowColumnPivotHierarchy.
set Posição da RowColumnPivotHierarchy.

Position(position)
setToDefault() Redefine o RowColumnPivotHierarchy para os valores padrão.
Detalhes do método
getFields()
Retorna PivotFields associados a RowColumnPivotHierarchy.
TypeScript
Retornos
getId()
ID do RowColumnPivotHierarchy.
TypeScript
getId(): string;
Retornos
string
getName()
Nome da RowColumnPivotHierarchy.
TypeScript
getName(): string;
Retornos
string
getPivotField(name)
undefined .
TypeScript
Parâmetros
name string
Retornos
getPosition()
Posição da RowColumnPivotHierarchy.
TypeScript
Retornos
number
setName(name)
Nome da RowColumnPivotHierarchy.
TypeScript
Parâmetros
name string
Retornos
void
Posição da RowColumnPivotHierarchy.
TypeScript
Parâmetros
position number
Retornos
void
setToDefault()
Redefine o RowColumnPivotHierarchy para os valores padrão.
TypeScript
Retornos
void
comentários:
ExcelScript.SearchCriteria interface
Referência
Pacote: ExcelScript
Representa os critérios de pesquisa a serem usados.
Comentários
Exemplos
TypeScript
/**
* This script searches for the next instance of the text "TK" on the
current worksheet.
* It then selects that cell and removes "TK" and all formatting from the
cell.
*/
// Get the next cell that contains "TK".

let tkCell = range.find("TK", {
completeMatch: true, /* Don't match if the cell text only contains "TK"
as part of another string. */
matchCase: false,
searchDirection: ExcelScript.SearchDirection.forward /* Start at the
beginning of the range and go to later columns and rows. */
});
// Set focus on the found cell.

tkCell.select();
// Remove the "TK" text value from the cell, as well as any formatting
that may have been added.
tkCell.clear(ExcelScript.ClearApplyTo.all);
}
Propriedades
false (parcial).

search Especifica a direção da pesquisa. O padrão é para frente. Consulte

Direction ExcelScript.SearchDirection .
completeMatch
false (parcial).
TypeScript
boolean
matchCase
TypeScript
boolean
searchDirection
Especifica a direção da pesquisa. O padrão é para frente. Consulte
ExcelScript.SearchDirection .
TypeScript
searchDirection?: SearchDirection;
ExcelScript.SearchDirection
comentários:
ExcelScript.Shape interface
Referência
Pacote: ExcelScript
Representa um objeto de forma genérica na planilha. Uma forma pode ser uma forma
geométrica, uma linha, um grupo de formas, etc.
Comentários
Exemplos
TypeScript
/**
*/


}
Métodos
copyTo(destination Copia e cola um Shape objeto. A forma colada é copiada para o mesmo
Sheet) local de pixel que essa forma.
delete() Remove a forma da planilha.
getAltTextDescription() Especifica o texto de descrição alternativa para um Shape objeto.
getAltTextTitle() Especifica o texto de título alternativo para um Shape objeto.

getAsImage(format) Converte a forma em uma imagem e retorna a imagem como uma
cadeia de caracteres de base 64. O DPI é 96. Os únicos formatos com
suporte são
ExcelScript.PictureFormat.BMP , ExcelScript.PictureFormat.PNG , ,
ExcelScript.PictureFormat.JPEG e . ExcelScript.PictureFormat.GIF
getConnectionSite Retorna o número de locais de conexão nessa forma.

Count()
getFill() Retorna a formatação de preenchimento dessa forma.
getGeometricShape() Retorna a forma geométrica associada à forma. Um erro será lançado,

se o tipo de forma não for "GeometricShape".
getGeometricShape Especifica o tipo de forma geométrica dessa forma geométrica. Confira

Type() ExcelScript.GeometricShapeType detalhes. Retorna null se o tipo de
forma não for "GeometricShape".
getGroup() Retorna o grupo de forma associado à forma. Um erro será lançado, se

o tipo de forma não for "GroupShape".
getHeight() Especifica a altura, em pontos, da forma. Gera uma exceção

InvalidArgument quando definida com um valor negativo ou zero como
uma entrada.
getImage() Retorna a imagem associada à forma. Um erro será lançado, se o tipo

de forma não for "Imagem".
getImage Converte a forma em uma imagem e retorna a imagem como uma

AsBase64(format) cadeia de caracteres de base 64. O DPI é 96. Os únicos formatos com
suporte são
getLeft() A distância, em pontos, da lateral esquerda da forma do lado esquerdo

da planilha. Gera uma exceção InvalidArgument quando definida com
um valor negativo como uma entrada.
getLevel() Especifica o nível da forma especificada. Por exemplo, um nível de 0

significa que a forma não faz parte de nenhum grupo, um nível de 1
significa que a forma é parte de um grupo de nível superior e um nível 2
significa que a forma faz parte de um subgrupo do nível superior.
getLine() Retorna a linha associada à forma. Um erro será lançado, se o tipo de

forma não for "Linha".
getLineFormat() Retorna a formatação de linha do objeto de forma.
getLockAspectRatio() Especifica se a proporção dessa forma está bloqueada.

getName() Especifica o nome da forma.
getParentGroup() Especifica o grupo pai dessa forma.
getPlacement() Representa como o objeto é anexado às células abaixo dela.
getRotation() Especifica a rotação, em graus, da forma.
getTextFrame() Retorna o objeto text frame de uma forma.
getTop() A distância, em pontos, da borda superior da forma até a borda superior

getType() Retorna o tipo dessa forma. Confira ExcelScript.ShapeType detalhes.
getVisible() Especifica se a forma está visível.
getWidth() Especifica a largura, em pontos, da forma. Gera uma exceção

uma entrada.
getZOrderPosition() Retorna a posição da forma especificada na ordem z, com 0

representando a parte inferior da pilha do pedido.
increment Move a forma horizontalmente pelo número especificado de pontos.

Left(increment)
increment O formato é girado em sentido horário ao redor do eixo z pelo número

Rotation(increment) especificado de graus. Use a rotation propriedade para definir a
rotação absoluta da forma.
increment Move a forma verticalmente pelo número especificado de pontos.

Top(increment)
scaleHeight(scale Dimensiona a altura da forma por um fator especificado. Para imagens,

Factor, scaleType, scale é possível indicar se você deseja dimensionar a forma em relação ao
From) tamanho original ou ao tamanho atual. As formas que não são figuras
serão sempre dimensionadas em relação à sua altura atual.
scaleWidth(scaleFactor, Dimensiona a largura da forma por um fator especificado. Para imagens,

scaleType, scaleFrom) é possível indicar se você deseja dimensionar a forma em relação ao
tamanho original ou ao tamanho atual. As formas que não são figuras
serão sempre dimensionadas em relação à sua largura atual.
setAltText Especifica o texto de descrição alternativa para um Shape objeto.

Description(altText
Description)
setAltTextTitle(altText Especifica o texto de título alternativo para um Shape objeto.

Title)
setGeometricShape Especifica o tipo de forma geométrica dessa forma geométrica. Confira
Type(geometricShape ExcelScript.GeometricShapeType detalhes. Retorna null se o tipo de
Type) forma não for "GeometricShape".
setHeight(height) Especifica a altura, em pontos, da forma. Gera uma exceção

uma entrada.
setLeft(left) A distância, em pontos, da lateral esquerda da forma do lado esquerdo

setLockAspect Especifica se a proporção dessa forma está bloqueada.

Ratio(lockAspectRatio)
setName(name) Especifica o nome da forma.
set Representa como o objeto é anexado às células abaixo dela.

Placement(placement)
setRotation(rotation) Especifica a rotação, em graus, da forma.
setTop(top) A distância, em pontos, da borda superior da forma até a borda superior

setVisible(visible) Especifica se a forma está visível.
setWidth(width) Especifica a largura, em pontos, da forma. Gera uma exceção

uma entrada.
setZOrder(position) Move a forma especificada para cima ou para baixo na ordem z da

coleção, que a desloca para frente ou para trás de outras formas.
Detalhes do método
copyTo(destinationSheet)
Copia e cola um Shape objeto. A forma colada é copiada para o mesmo local de
pixel que essa forma.
TypeScript
copyTo(destinationSheet?: Worksheet | string): Shape;

Parâmetros
destinationSheet ExcelScript.Worksheet | string
A folha à qual o objeto de forma será colado. O valor padrão é a planilha da forma
copiada.
Retornos
ExcelScript.Shape
delete()
Remove a forma da planilha.
TypeScript
delete(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script deletes all the shapes on the current worksheet.
*/
// Get the collection of shapes on the currently selected worksheet.
const shapes = workbook.getActiveWorksheet().getShapes();
// Remove each shape.

shapes.forEach(shape =>{
shape.delete();
});
}
getAltTextDescription()
Especifica o texto de descrição alternativa para um Shape objeto.
TypeScript
getAltTextDescription(): string;
Retornos
string
getAltTextTitle()
Especifica o texto de título alternativo para um Shape objeto.
TypeScript
getAltTextTitle(): string;
Retornos
string
getAsImage(format)
２ Aviso
Essa API foi preterida.
Use getImageAsBase64 instead.
Converte a forma em uma imagem e retorna a imagem como uma cadeia de

caracteres de base 64. O DPI é 96. Os únicos formatos com suporte são
TypeScript
getAsImage(format: PictureFormat): string;
Parâmetros
format ExcelScript.PictureFormat
Especifica o formato da imagem.
Retornos
string
Exemplos
TypeScript
/**
* It then returns the image as a base64-encoded string.
* This string would be used as part of a Power Automate flow to add the
image elsewhere.
*/

const star =
textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFit
Text);
// Return the shape as a PNG image represented by a base64-encoded

string.
return star.getAsImage(ExcelScript.PictureFormat.png);
}
getConnectionSiteCount()
Retorna o número de locais de conexão nessa forma.
TypeScript
getConnectionSiteCount(): number;
Retornos
number
getFill()
Retorna a formatação de preenchimento dessa forma.
TypeScript
getFill(): ShapeFill;
Retornos
ExcelScript.ShapeFill
getGeometricShape()
Retorna a forma geométrica associada à forma. Um erro será lançado, se o tipo de
forma não for "GeometricShape".
TypeScript
getGeometricShape(): GeometricShape;
Retornos
ExcelScript.GeometricShape
getGeometricShapeType()
Especifica o tipo de forma geométrica dessa forma geométrica. Confira
ExcelScript.GeometricShapeType detalhes. Retorna null se o tipo de forma não for
"GeometricShape".
TypeScript
getGeometricShapeType(): GeometricShapeType;
Retornos
ExcelScript.GeometricShapeType
getGroup()
Retorna o grupo de forma associado à forma. Um erro será lançado, se o tipo de
forma não for "GroupShape".
TypeScript
getGroup(): ShapeGroup;
Retornos
ExcelScript.ShapeGroup
getHeight()
Especifica a altura, em pontos, da forma. Gera uma exceção InvalidArgument quando
definida com um valor negativo ou zero como uma entrada.
TypeScript
Retornos
number
getId()
TypeScript
getId(): string;
Retornos
string
getImage()
Retorna a imagem associada à forma. Um erro será lançado, se o tipo de forma não
for "Imagem".
TypeScript
getImage(): Image;
Retornos
ExcelScript.Image
Exemplos
TypeScript
/**
* This script transfers an image from one worksheet to another.
*/
{
// Get the worksheet with the image on it.
let firstWorksheet = workbook.getWorksheet("FirstSheet");
// Get the first image from the worksheet.

// If a script added the image, you could add a name to make it easier
to find.
let image: ExcelScript.Image;
firstWorksheet.getShapes().forEach((shape, index) => {
if (shape.getType() === ExcelScript.ShapeType.image) {
image = shape.getImage();
return;
}
});
// Copy the image to another worksheet.

image.getShape().copyTo("SecondSheet");
}
getImageAsBase64(format)
Converte a forma em uma imagem e retorna a imagem como uma cadeia de
caracteres de base 64. O DPI é 96. Os únicos formatos com suporte são
TypeScript
getImageAsBase64(format: PictureFormat): string;

Parâmetros
format ExcelScript.PictureFormat
Especifica o formato da imagem.
Retornos
string
getLeft()
A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha.
Gera uma exceção InvalidArgument quando definida com um valor negativo como
uma entrada.
TypeScript
getLeft(): number;
Retornos
number
getLevel()
Especifica o nível da forma especificada. Por exemplo, um nível de 0 significa que a
forma não faz parte de nenhum grupo, um nível de 1 significa que a forma é parte
de um grupo de nível superior e um nível 2 significa que a forma faz parte de um
subgrupo do nível superior.
TypeScript
getLevel(): number;
Retornos
number
getLine()
Retorna a linha associada à forma. Um erro será lançado, se o tipo de forma não for
"Linha".
TypeScript
getLine(): Line;
Retornos
ExcelScript.Line
Exemplos
TypeScript
/**
* This script adds a line that goes from cell B2 to cell F4 on the
current worksheet.
*/

// Add a straight line that connects the top-left corners of both

cells.
b2Range.getLeft(),
b2Range.getTop(),
f4Range.getLeft(),
f4Range.getTop(),
// Add an open arrowhead to the end of the line, such that it points at
F4.
}
getLineFormat()
Retorna a formatação de linha do objeto de forma.
TypeScript
getLineFormat(): ShapeLineFormat;
Retornos
ExcelScript.ShapeLineFormat
getLockAspectRatio()
Especifica se a proporção dessa forma está bloqueada.
TypeScript
getLockAspectRatio(): boolean;
Retornos
boolean
getName()
Especifica o nome da forma.
TypeScript
getName(): string;
Retornos
string
getParentGroup()
Especifica o grupo pai dessa forma.
TypeScript
getParentGroup(): Shape;
Retornos
ExcelScript.Shape
getPlacement()
Representa como o objeto é anexado às células abaixo dela.
TypeScript
getPlacement(): Placement;
Retornos
ExcelScript.Placement
getRotation()
Especifica a rotação, em graus, da forma.
TypeScript
getRotation(): number;
Retornos
number
getTextFrame()
Retorna o objeto text frame de uma forma.
TypeScript
getTextFrame(): TextFrame;
Retornos
ExcelScript.TextFrame
Exemplos
TypeScript
/**
*/

const star =
textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFit
Text);
}
getTop()
A distância, em pontos, da borda superior da forma até a borda superior da planilha.
uma entrada.
TypeScript
getTop(): number;
Retornos
number
getType()
Retorna o tipo dessa forma. Confira ExcelScript.ShapeType detalhes.
TypeScript
getType(): ShapeType;
Retornos
ExcelScript.ShapeType
getVisible()
Especifica se a forma está visível.
TypeScript
Retornos
boolean
getWidth()
Especifica a largura, em pontos, da forma. Gera uma exceção InvalidArgument
quando definida com um valor negativo ou zero como uma entrada.
TypeScript
getWidth(): number;
Retornos
number
getZOrderPosition()
Retorna a posição da forma especificada na ordem z, com 0 representando a parte
inferior da pilha do pedido.
TypeScript
getZOrderPosition(): number;
Retornos
number
incrementLeft(increment)
Move a forma horizontalmente pelo número especificado de pontos.
TypeScript
incrementLeft(increment: number): void;

Parâmetros
increment number
O incremento, em pontos, a forma será movida horizontalmente. Um valor positivo
move a forma para a direita e um valor negativo a move para a esquerda. Se a
planilha estiver orientada da direita para a esquerda, isso será revertido: valores
positivos moverão a forma para a esquerda e os valores negativos a moverão para a
direita.
Retornos
void
incrementRotation(increment)
O formato é girado em sentido horário ao redor do eixo z pelo número especificado
de graus. Use a rotation propriedade para definir a rotação absoluta da forma.
TypeScript
incrementRotation(increment: number): void;
Parâmetros
increment number
Quantos graus a forma será girada. Um valor positivo gira a forma no sentido
horário e um valor negativo gira-a no sentido anti-horário.
Retornos
void
incrementTop(increment)
Move a forma verticalmente pelo número especificado de pontos.
TypeScript
incrementTop(increment: number): void;
Parâmetros
increment number
O incremento, em pontos, a forma será movida verticalmente. Um valor positivo
move a forma para baixo e um valor negativo a move para cima.
Retornos
void
scaleHeight(scaleFactor, scaleType, scaleFrom)

Dimensiona a altura da forma por um fator especificado. Para imagens, é possível
indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao
tamanho atual. As formas que não são figuras serão sempre dimensionadas em
relação à sua altura atual.
TypeScript
scaleHeight(
scaleFactor: number,
scaleType: ShapeScaleType,
scaleFrom?: ShapeScaleFrom
): void;
Parâmetros
scaleFactor number
Especifica a proporção entre a altura da forma após você redimensioná-la e a altura
atual ou original.
scaleType ExcelScript.ShapeScaleType
Especifica se a forma é dimensionada em relação ao tamanho original ou atual. A
opção de dimensionamento de tamanho original só funciona para imagens.
scaleFrom ExcelScript.ShapeScaleFrom
Opcional. Especifica qual parte da forma mantém sua posição quando a forma é
dimensionada. Se omitido, ele representa o canto superior esquerdo da forma
mantém sua posição.
Retornos
void
scaleWidth(scaleFactor, scaleType, scaleFrom)
Dimensiona a largura da forma por um fator especificado. Para imagens, é possível
indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao
tamanho atual. As formas que não são figuras serão sempre dimensionadas em
relação à sua largura atual.
TypeScript
scaleWidth(
scaleFactor: number,
scaleType: ShapeScaleType,
scaleFrom?: ShapeScaleFrom
): void;
Parâmetros
scaleFactor number
Especifica a proporção entre a largura da forma após você redimensioná-la e a
largura atual ou original.
scaleType ExcelScript.ShapeScaleType
Especifica se a forma é dimensionada em relação ao tamanho original ou atual. A
opção de dimensionamento de tamanho original só funciona para imagens.
scaleFrom ExcelScript.ShapeScaleFrom
Opcional. Especifica qual parte da forma mantém sua posição quando a forma é
dimensionada. Se omitido, ele representa o canto superior esquerdo da forma
mantém sua posição.
Retornos
void
setAltTextDescription(altTextDescription)
Especifica o texto de descrição alternativa para um Shape objeto.
TypeScript
setAltTextDescription(altTextDescription: string): void;

Parâmetros
altTextDescription string
Retornos
void
setAltTextTitle(altTextTitle)
Especifica o texto de título alternativo para um Shape objeto.
TypeScript
setAltTextTitle(altTextTitle: string): void;
Parâmetros
altTextTitle string
Retornos
void
setGeometricShapeType(geometricShapeType)
Especifica o tipo de forma geométrica dessa forma geométrica. Confira
ExcelScript.GeometricShapeType detalhes. Retorna null se o tipo de forma não for
"GeometricShape".
TypeScript
setGeometricShapeType(geometricShapeType: GeometricShapeType): void;
Parâmetros
geometricShapeType ExcelScript.GeometricShapeType
Retornos
void
setHeight(height)
Especifica a altura, em pontos, da forma. Gera uma exceção InvalidArgument quando
definida com um valor negativo ou zero como uma entrada.
TypeScript
Parâmetros
height number
Retornos
void
setLeft(left)
A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha.
uma entrada.
TypeScript
Parâmetros
left number
Retornos
void
setLockAspectRatio(lockAspectRatio)
Especifica se a proporção dessa forma está bloqueada.
TypeScript
setLockAspectRatio(lockAspectRatio: boolean): void;
Parâmetros
lockAspectRatio boolean
Retornos
void
setName(name)
Especifica o nome da forma.
TypeScript
Parâmetros
name string
Retornos
void
Exemplos
TypeScript
/**
* This script creates a triangle shape on the current worksheet and
names it "TRI".
*/
const triangle: ExcelScript.Shape =
currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.triangle);
triangle.setName("TRI");
}
setPlacement(placement)
Representa como o objeto é anexado às células abaixo dela.
TypeScript
setPlacement(placement: Placement): void;
Parâmetros
placement ExcelScript.Placement
Retornos
void
Exemplos
TypeScript
/**
* This script creates a diamond shape at cell C3.
* The shape moves and resizes as the grid underneath it changes.
*/
// Get cell C3 in the current worksheet.
const cell = sheet.getRange("C3");
// Create a diamond that slightly overlaps the cell C3.

const diamond =
sheet.addGeometricShape(ExcelScript.GeometricShapeType.diamond);
// Set each dimension so that the shape extends 5 pixels beyond the
cell borders.
diamond.setLeft(cell.getLeft() - 5);
diamond.setTop(cell.getTop() - 5);
diamond.setHeight(cell.getHeight() + 10);
diamond.setWidth(cell.getWidth() + 10);
// Set the placement of the shape so that it resizes and moves with the
grid.
diamond.setPlacement(ExcelScript.Placement.twoCell);
}
setRotation(rotation)
Especifica a rotação, em graus, da forma.
TypeScript
setRotation(rotation: number): void;
Parâmetros
rotation number
Retornos
void
setTop(top)
A distância, em pontos, da borda superior da forma até a borda superior da planilha.
uma entrada.
TypeScript
Parâmetros
top number
Retornos
void
setVisible(visible)
Especifica se a forma está visível.
TypeScript
Parâmetros
visible boolean
Retornos
void
setWidth(width)
Especifica a largura, em pontos, da forma. Gera uma exceção InvalidArgument
quando definida com um valor negativo ou zero como uma entrada.
TypeScript
Parâmetros
width number
Retornos
void
setZOrder(position)
Move a forma especificada para cima ou para baixo na ordem z da coleção, que a
desloca para frente ou para trás de outras formas.
TypeScript
setZOrder(position: ShapeZOrder): void;
Parâmetros
position ExcelScript.ShapeZOrder
Para onde mover a forma na pilha de ordem z em relação às outras formas. Confira
ExcelScript.ShapeZOrder detalhes.
Retornos
void
comentários:
ExcelScript.ShapeFill interface
Referência
Pacote: ExcelScript
Representa a formatação de preenchimento de um objeto de forma.
Métodos
clear() Limpa a formatação do preenchimento de um objeto de forma.
getForegroundColor() Representa a cor do primeiro plano de preenchimento de forma

no formato de cor HTML, no formulário #RRGGBB (por exemplo,
"FFA500") ou como uma cor HTML nomeada (por exemplo,
"laranja")
getTransparency() Especifica o percentual de transparência do preenchimento como

um valor de 0,0 (opaco) a 1,0 (claro). Retorna null se o tipo de
forma não dá suporte à transparência ou o preenchimento de
forma tiver transparência inconsistente, como com um tipo de
preenchimento gradiente.
getType() Retorna o tipo de preenchimento da forma. Confira

ExcelScript.ShapeFillType detalhes.
setForeground Representa a cor do primeiro plano de preenchimento de forma

Color(foregroundColor) no formato de cor HTML, no formulário #RRGGBB (por exemplo,
"FFA500") ou como uma cor HTML nomeada (por exemplo,
"laranja")
setSolidColor(color) Define a formatação de preenchimento de um formato com uma

cor uniforme. Isso altera o tipo de preenchimento para "Sólido".
set Especifica o percentual de transparência do preenchimento como

Transparency(transparency) um valor de 0,0 (opaco) a 1,0 (claro). Retorna null se o tipo de
forma não dá suporte à transparência ou o preenchimento de
forma tiver transparência inconsistente, como com um tipo de
preenchimento gradiente.
Detalhes do método
clear()
Limpa a formatação do preenchimento de um objeto de forma.
TypeScript
clear(): void;
Retornos
void
getForegroundColor()
Representa a cor do primeiro plano de preenchimento de forma no formato de cor
HTML, no formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML
TypeScript
getForegroundColor(): string;
Retornos
string
getTransparency()
Especifica o percentual de transparência do preenchimento como um valor de 0,0
(opaco) a 1,0 (claro). Retorna null se o tipo de forma não dá suporte à transparência
ou o preenchimento de forma tiver transparência inconsistente, como com um tipo
de preenchimento gradiente.
TypeScript
getTransparency(): number;
Retornos
number
getType()
Retorna o tipo de preenchimento da forma. Confira ExcelScript.ShapeFillType
detalhes.
TypeScript
getType(): ShapeFillType;
Retornos
ExcelScript.ShapeFillType
setForegroundColor(foregroundColor)
Representa a cor do primeiro plano de preenchimento de forma no formato de cor
TypeScript
setForegroundColor(foregroundColor: string): void;
Parâmetros
foregroundColor string
Retornos
void
setSolidColor(color)
Define a formatação de preenchimento de um formato com uma cor uniforme. Isso
altera o tipo de preenchimento para "Sólido".
TypeScript
setSolidColor(color: string): void;
Parâmetros
color string
Uma cadeia de caracteres que representa a cor de preenchimento no formato de cor
Retornos
void
setTransparency(transparency)
Especifica o percentual de transparência do preenchimento como um valor de 0,0
(opaco) a 1,0 (claro). Retorna null se o tipo de forma não dá suporte à transparência
ou o preenchimento de forma tiver transparência inconsistente, como com um tipo
de preenchimento gradiente.
TypeScript
setTransparency(transparency: number): void;
Parâmetros
transparency number
Retornos
void
comentários:
ExcelScript.ShapeFont interface
Referência
Pacote: ExcelScript
Representa os atributos de fonte, como nome da fonte, tamanho da fonte e cor, para o
objeto de TextRange uma forma.
Métodos
getBold() Representa o status da fonte em negrito. Retornará null se o TextRange

incluir fragmentos de texto em negrito e não negrito.
getColor() Representação de código de cor HTML da cor do texto (por exemplo,

"#FF0000" representa vermelho). Retornará null se o TextRange incluir
fragmentos de texto com cores diferentes.
getItalic() Representa o status da fonte em itálico. Retornará null se o TextRange

incluir fragmentos de texto itálico e não itálico.
getName() Representa o nome da fonte (por exemplo, "Calibri"). Se o texto for um

script complexo ou uma linguagem do Leste Asiático, este será o nome da
fonte correspondente; caso contrário, é o nome da fonte latina.
getSize() Representa o tamanho da fonte em pontos (por exemplo, 11). Retornará

null se o TextRange incluir fragmentos de texto com diferentes tamanhos
de fonte.
getUnderline() Tipo de sublinhado aplicado à fonte. Retornará null se o TextRange

incluir fragmentos de texto com diferentes estilos de sublinhado. Confira
ExcelScript.ShapeFontUnderlineStyle detalhes.
setBold(bold) Representa o status da fonte em negrito. Retornará null se o TextRange

incluir fragmentos de texto em negrito e não negrito.
setColor(color) Representação de código de cor HTML da cor do texto (por exemplo,

"#FF0000" representa vermelho). Retornará null se o TextRange incluir
fragmentos de texto com cores diferentes.
setItalic(italic) Representa o status da fonte em itálico. Retornará null se o TextRange

incluir fragmentos de texto itálico e não itálico.
setName(name) Representa o nome da fonte (por exemplo, "Calibri"). Se o texto for um

script complexo ou uma linguagem do Leste Asiático, este será o nome da
fonte correspondente; caso contrário, é o nome da fonte latina.
setSize(size) Representa o tamanho da fonte em pontos (por exemplo, 11). Retornará
null se o TextRange incluir fragmentos de texto com diferentes tamanhos
de fonte.
set Tipo de sublinhado aplicado à fonte. Retornará null se o TextRange

Underline(underline) incluir fragmentos de texto com diferentes estilos de sublinhado. Confira
Detalhes do método
getBold()
Representa o status da fonte em negrito. Retornará null se o TextRange incluir
fragmentos de texto em negrito e não negrito.
TypeScript
getBold(): boolean;
Retornos
boolean
getColor()
Representação de código de cor HTML da cor do texto (por exemplo, "#FF0000"
representa vermelho). Retornará null se o TextRange incluir fragmentos de texto
com cores diferentes.
TypeScript
getColor(): string;
Retornos
string
getItalic()
Representa o status da fonte em itálico. Retornará null se o TextRange incluir
fragmentos de texto itálico e não itálico.
TypeScript
Retornos
boolean
getName()
Representa o nome da fonte (por exemplo, "Calibri"). Se o texto for um script
complexo ou uma linguagem do Leste Asiático, este será o nome da fonte
correspondente; caso contrário, é o nome da fonte latina.
TypeScript
getName(): string;
Retornos
string
getSize()
Representa o tamanho da fonte em pontos (por exemplo, 11). Retornará null se o
TextRange incluir fragmentos de texto com diferentes tamanhos de fonte.
TypeScript
getSize(): number;
Retornos
number
getUnderline()
Tipo de sublinhado aplicado à fonte. Retornará null se o TextRange incluir
fragmentos de texto com diferentes estilos de sublinhado. Confira
TypeScript
getUnderline(): ShapeFontUnderlineStyle;
Retornos
ExcelScript.ShapeFontUnderlineStyle
setBold(bold)
Representa o status da fonte em negrito. Retornará null se o TextRange incluir
fragmentos de texto em negrito e não negrito.
TypeScript
Parâmetros
bold boolean
Retornos
void
setColor(color)
Representação de código de cor HTML da cor do texto (por exemplo, "#FF0000"
representa vermelho). Retornará null se o TextRange incluir fragmentos de texto
com cores diferentes.
TypeScript
Parâmetros
color string
Retornos
void
setItalic(italic)
Representa o status da fonte em itálico. Retornará null se o TextRange incluir
fragmentos de texto itálico e não itálico.
TypeScript
Parâmetros
italic boolean
Retornos
void
setName(name)
Representa o nome da fonte (por exemplo, "Calibri"). Se o texto for um script
complexo ou uma linguagem do Leste Asiático, este será o nome da fonte
correspondente; caso contrário, é o nome da fonte latina.
TypeScript
Parâmetros
name string
Retornos
void
setSize(size)
Representa o tamanho da fonte em pontos (por exemplo, 11). Retornará null se o
TextRange incluir fragmentos de texto com diferentes tamanhos de fonte.
TypeScript
Parâmetros
size number
Retornos
void
Tipo de sublinhado aplicado à fonte. Retornará null se o TextRange incluir
fragmentos de texto com diferentes estilos de sublinhado. Confira
TypeScript
setUnderline(underline: ShapeFontUnderlineStyle): void;
Parâmetros
underline ExcelScript.ShapeFontUnderlineStyle
Retornos
void
comentários:
ExcelScript.ShapeGroup interface
Referência
Pacote: ExcelScript
Representa um grupo de formas dentro de uma planilha. Para obter o objeto

correspondente Shape , use ShapeGroup.shape .
Métodos
getGroup Retorna o Shape objeto associado ao grupo.

Shape()
getShape(key) Obtém uma forma usando seu nome ou ID. Se o objeto shape não existir, esse
getShapes() Retorna a coleção de Shape objetos.
ungroup() Desagrupa todas as formas agrupadas no grupo de forma especificado.
Detalhes do método
getGroupShape()
Retorna o Shape objeto associado ao grupo.
TypeScript
getGroupShape(): Shape;
Retornos
ExcelScript.Shape
getId()
TypeScript
getId(): string;
Retornos
string
getShape(key)
Obtém uma forma usando seu nome ou ID. Se o objeto shape não existir, esse
TypeScript
getShape(key: string): Shape | undefined;
Parâmetros
key string
O nome ou a ID da forma a ser recuperada.
Retornos
ExcelScript.Shape | undefined
getShapes()
Retorna a coleção de Shape objetos.
TypeScript
getShapes(): Shape[];
Retornos
ExcelScript.Shape[]
ungroup()
Desagrupa todas as formas agrupadas no grupo de forma especificado.
TypeScript
ungroup(): void;
Retornos
void
comentários:
ExcelScript.ShapeLineFormat interface
Referência
Pacote: ExcelScript
Representa a formatação de linha para o objeto shape. Para imagens e formas

geométricas, a formatação de linha representa a borda da forma.
Métodos
getColor() Representa a cor da linha no formato de cor HTML, no formulário

#RRGGBB (por exemplo, "FFA500") ou como uma cor HTML
getDashStyle() Representa o estilo de linha da forma. Retorna null quando a linha

não está visível ou há estilos de traço inconsistentes. Confira
ExcelScript.ShapeLineDashStyle detalhes.
getStyle() Representa o estilo de linha da forma. Retorna null quando a linha

não está visível ou há estilos inconsistentes. Confira
ExcelScript.ShapeLineStyle detalhes.
getTransparency() Representa o grau de transparência da linha especificada como um

valor de 0,0 (opaco) a 1,0 (claro). Retorna null quando a forma
tem transparências inconsistentes.
getVisible() Especifica se a formatação de linha de um elemento de forma está

visível. Retorna null quando a forma tem visibilidades
inconsistentes.
getWeight() Representa a espessura da linha, em pontos. Retorna null quando

a linha não está visível ou há pesos de linha inconsistentes.
setColor(color) Representa a cor da linha no formato de cor HTML, no formulário

#RRGGBB (por exemplo, "FFA500") ou como uma cor HTML
setDashStyle(dashStyle) Representa o estilo de linha da forma. Retorna null quando a linha

não está visível ou há estilos de traço inconsistentes. Confira
ExcelScript.ShapeLineDashStyle detalhes.
setStyle(style) Representa o estilo de linha da forma. Retorna null quando a linha

não está visível ou há estilos inconsistentes. Confira
ExcelScript.ShapeLineStyle detalhes.
set Representa o grau de transparência da linha especificada como um
Transparency(transparency) valor de 0,0 (opaco) a 1,0 (claro). Retorna null quando a forma
tem transparências inconsistentes.
setVisible(visible) Especifica se a formatação de linha de um elemento de forma está

visível. Retorna null quando a forma tem visibilidades
inconsistentes.
setWeight(weight) Representa a espessura da linha, em pontos. Retorna null quando

a linha não está visível ou há pesos de linha inconsistentes.
Detalhes do método
getColor()
Representa a cor da linha no formato de cor HTML, no formulário #RRGGBB (por
exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").
TypeScript
getColor(): string;
Retornos
string
getDashStyle()
Representa o estilo de linha da forma. Retorna null quando a linha não está visível
ou há estilos de traço inconsistentes. Confira ExcelScript.ShapeLineDashStyle
detalhes.
TypeScript
getDashStyle(): ShapeLineDashStyle;
Retornos
ExcelScript.ShapeLineDashStyle
getStyle()
ou há estilos inconsistentes. Confira ExcelScript.ShapeLineStyle detalhes.
TypeScript
getStyle(): ShapeLineStyle;
Retornos
ExcelScript.ShapeLineStyle
getTransparency()
Representa o grau de transparência da linha especificada como um valor de 0,0
(opaco) a 1,0 (claro). Retorna null quando a forma tem transparências
inconsistentes.
TypeScript
getTransparency(): number;
Retornos
number
getVisible()
Especifica se a formatação de linha de um elemento de forma está visível. Retorna
null quando a forma tem visibilidades inconsistentes.
TypeScript
Retornos
boolean
getWeight()
Representa a espessura da linha, em pontos. Retorna null quando a linha não está
visível ou há pesos de linha inconsistentes.
TypeScript
Retornos
number
setColor(color)
Representa a cor da linha no formato de cor HTML, no formulário #RRGGBB (por
exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").
TypeScript
Parâmetros
color string
Retornos
void
setDashStyle(dashStyle)
ou há estilos de traço inconsistentes. Confira ExcelScript.ShapeLineDashStyle
detalhes.
TypeScript
setDashStyle(dashStyle: ShapeLineDashStyle): void;
Parâmetros
dashStyle ExcelScript.ShapeLineDashStyle
Retornos
void
setStyle(style)
ou há estilos inconsistentes. Confira ExcelScript.ShapeLineStyle detalhes.
TypeScript
setStyle(style: ShapeLineStyle): void;
Parâmetros
style ExcelScript.ShapeLineStyle
Retornos
void
setTransparency(transparency)
Representa o grau de transparência da linha especificada como um valor de 0,0
(opaco) a 1,0 (claro). Retorna null quando a forma tem transparências
inconsistentes.
TypeScript
setTransparency(transparency: number): void;
Parâmetros
transparency number
Retornos
void
setVisible(visible)
Especifica se a formatação de linha de um elemento de forma está visível. Retorna
null quando a forma tem visibilidades inconsistentes.
TypeScript
Parâmetros
visible boolean
Retornos
void
setWeight(weight)
Representa a espessura da linha, em pontos. Retorna null quando a linha não está
visível ou há pesos de linha inconsistentes.
TypeScript
Parâmetros
weight number
Retornos
void
comentários:
ExcelScript.ShowAsRule interface
Referência
Pacote: ExcelScript
Propriedades
baseField O PivotField para basear o ShowAs cálculo em, se aplicável de acordo com o
ShowAsCalculation tipo, em outra . null
baseItem O item no qual basear o ShowAs cálculo, se aplicável de acordo com o

ShowAsCalculation tipo, em outro null .
calculation O ShowAs cálculo a ser usado para o PivotField. Confira

ExcelScript.ShowAsCalculation detalhes.
baseField
O PivotField para basear o ShowAs cálculo em, se aplicável de acordo com o
ShowAsCalculation tipo, em outra . null
TypeScript
baseField?: PivotField;
ExcelScript.PivotField
baseItem
O item no qual basear o ShowAs cálculo, se aplicável de acordo com o
ShowAsCalculation tipo, em outro null .
TypeScript
baseItem?: PivotItem;
ExcelScript.PivotItem
calculation
O ShowAs cálculo a ser usado para o PivotField. Confira
ExcelScript.ShowAsCalculation detalhes.
TypeScript
calculation: ShowAsCalculation;
ExcelScript.ShowAsCalculation
comentários:
ExcelScript.Slicer interface
Referência
Pacote: ExcelScript
Representa um Slicer objeto na pasta de trabalho.
Comentários
Exemplos
TypeScript
/**
* This script adds a slicer for an existing PivotTable.
*/
// Get the PivotTable named "Farm Pivot".
const farmPivot = workbook.getPivotTable("Farm Pivot");
// Create the slicer.

// Note that this assumes "Type" is already added as a hierarchy to the
PivotTable.
const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
farmPivot, /* The table or PivotTale to be sliced. */
farmPivot.getHierarchy("Type").getFields()[0] /* What source field to
use as the slicer options. */
);
// Select the items to display.

fruitSlicer.selectItems(["Lemon", "Lime"]);
// Set the left margin of the slicer.

fruitSlicer.setLeft(400);
}
Métodos
clearFilters() Limpa todos os filtros aplicados à segmentação de dados no momento.
delete() Exclui a segmentação de dados.
getCaption() Representa a legenda da segmentação.

getHeight() Representa a altura, em pontos, da segmentação de dados. Gera uma exceção
InvalidArgument quando definida com um valor negativo ou zero como uma
entrada.
getId() Representa a ID exclusiva da segmentação.
getIsFilter O valor será true se todos os filtros aplicados atualmente na segmentação

Cleared() forem desmarcados.
getLeft() Representa a distância, em pontos, da lateral esquerda da segmentação de

dados à esquerda da planilha. Lança um InvalidArgument erro quando
definido com um valor negativo como uma entrada.
getName() Representa o nome da segmentação.
getSelected Retorna uma matriz de chaves de itens selecionados.

Items()
getSlicer Obtém um item da segmentação de dados usando sua chave ou nome. Se o

Item(key) item slicer não existir, esse método retornará undefined .
getSlicerItems() Representa a coleção de itens de segmentação que fazem parte da

segmentação.
getSortBy() Representa a ordem de classificação dos itens na segmentação de dados. Os

valores possíveis são: "DataSourceOrder", "Ascending", "Descending".
getStyle() Valor constante que representa o estilo de segmentação. Os valores possíveis

são: "SlicerStyleLight1" por meio de "SlicerStyleLight6", "TableStyleOther1" por
meio de "TableStyleOther2", "SlicerStyleDark1" por meio de "SlicerStyleDark6".
Também é possível usar um estilo definido pelo usuário que esteja presente
na planilha.
getTop() Representa a distância, em pontos, da borda superior da segmentação de

dados na parte superior da planilha. Lança um InvalidArgument erro quando
getWidth() Representa a largura, em pontos, da segmentação de dados. Lança um

InvalidArgument erro quando definido com um valor negativo ou zero como
uma entrada.
getWorksheet() Representa a planilha que contém a segmentação de dados.
select Seleciona itens de segmentação com base em suas chaves. As seleções

Items(items) anteriores são desmarcadas. Todos os itens serão selecionados por padrão se
a matriz estiver vazia.
set Representa a legenda da segmentação.

Caption(caption)
set Representa a altura, em pontos, da segmentação de dados. Gera uma exceção

Height(height) InvalidArgument quando definida com um valor negativo ou zero como uma
entrada.
setLeft(left) Representa a distância, em pontos, da lateral esquerda da segmentação de

dados à esquerda da planilha. Lança um InvalidArgument erro quando
setName(name) Representa o nome da segmentação.
setSortBy(sortBy) Representa a ordem de classificação dos itens na segmentação de dados. Os

valores possíveis são: "DataSourceOrder", "Ascending", "Descending".
setStyle(style) Valor constante que representa o estilo de segmentação. Os valores possíveis

são: "SlicerStyleLight1" por meio de "SlicerStyleLight6", "TableStyleOther1" por
meio de "TableStyleOther2", "SlicerStyleDark1" por meio de "SlicerStyleDark6".
Também é possível usar um estilo definido pelo usuário que esteja presente
na planilha.
setTop(top) Representa a distância, em pontos, da borda superior da segmentação de

dados na parte superior da planilha. Lança um InvalidArgument erro quando
setWidth(width) Representa a largura, em pontos, da segmentação de dados. Lança um

InvalidArgument erro quando definido com um valor negativo ou zero como
uma entrada.
Detalhes do método
clearFilters()
Limpa todos os filtros aplicados à segmentação de dados no momento.
TypeScript
clearFilters(): void;
Retornos
void
delete()
Exclui a segmentação de dados.
TypeScript
delete(): void;
Retornos
void
getCaption()
Representa a legenda da segmentação.
TypeScript
getCaption(): string;
Retornos
string
getHeight()
Representa a altura, em pontos, da segmentação de dados. Gera uma exceção
entrada.
TypeScript
Retornos
number
getId()
Representa a ID exclusiva da segmentação.
TypeScript
getId(): string;
Retornos
string
getIsFilterCleared()
O valor será true se todos os filtros aplicados atualmente na segmentação forem
desmarcados.
TypeScript
getIsFilterCleared(): boolean;
Retornos
boolean
getLeft()
Representa a distância, em pontos, da lateral esquerda da segmentação de dados à
esquerda da planilha. Lança um InvalidArgument erro quando definido com um
valor negativo como uma entrada.
TypeScript
getLeft(): number;
Retornos
number
getName()
Representa o nome da segmentação.
TypeScript
getName(): string;
Retornos
string
getSelectedItems()
Retorna uma matriz de chaves de itens selecionados.
TypeScript
getSelectedItems(): string[];
Retornos
string[]
getSlicerItem(key)
Obtém um item da segmentação de dados usando sua chave ou nome. Se o item
slicer não existir, esse método retornará undefined .
TypeScript
getSlicerItem(key: string): SlicerItem | undefined;
Parâmetros
key string
Chave ou nome da segmentação a ser recuperada.
Retornos
ExcelScript.SlicerItem | undefined
getSlicerItems()
Representa a coleção de itens de segmentação que fazem parte da segmentação.
TypeScript
getSlicerItems(): SlicerItem[];
Retornos
ExcelScript.SlicerItem[]
getSortBy()
Representa a ordem de classificação dos itens na segmentação de dados. Os valores
possíveis são: "DataSourceOrder", "Ascending", "Descending".
TypeScript
getSortBy(): SlicerSortType;
Retornos
ExcelScript.SlicerSortType
getStyle()
Valor constante que representa o estilo de segmentação. Os valores possíveis são:
"SlicerStyleLight1" por meio de "SlicerStyleLight6", "TableStyleOther1" por meio de
"TableStyleOther2", "SlicerStyleDark1" por meio de "SlicerStyleDark6". Também é
possível usar um estilo definido pelo usuário que esteja presente na planilha.
TypeScript
getStyle(): string;
Retornos
string
getTop()
Representa a distância, em pontos, da borda superior da segmentação de dados na
parte superior da planilha. Lança um InvalidArgument erro quando definido com um
TypeScript
getTop(): number;
Retornos
number
getWidth()
Representa a largura, em pontos, da segmentação de dados. Lança um
InvalidArgument erro quando definido com um valor negativo ou zero como uma
entrada.
TypeScript
getWidth(): number;
Retornos
number
getWorksheet()
Representa a planilha que contém a segmentação de dados.
TypeScript
Retornos
selectItems(items)
Seleciona itens de segmentação com base em suas chaves. As seleções anteriores
são desmarcadas. Todos os itens serão selecionados por padrão se a matriz estiver
vazia.
TypeScript
selectItems(items?: string[]): void;
Parâmetros
items string[]
Opcional. Os nomes de item de segmentação especificados a serem selecionados.
Retornos
void
setCaption(caption)
Representa a legenda da segmentação.
TypeScript
setCaption(caption: string): void;
Parâmetros
caption string
Retornos
void
setHeight(height)
Representa a altura, em pontos, da segmentação de dados. Gera uma exceção
entrada.
TypeScript
Parâmetros
height number
Retornos
void
setLeft(left)
Representa a distância, em pontos, da lateral esquerda da segmentação de dados à
esquerda da planilha. Lança um InvalidArgument erro quando definido com um
TypeScript
Parâmetros
left number
Retornos
void
setName(name)
Representa o nome da segmentação.
TypeScript
Parâmetros
name string
Retornos
void
setSortBy(sortBy)
Representa a ordem de classificação dos itens na segmentação de dados. Os valores
possíveis são: "DataSourceOrder", "Ascending", "Descending".
TypeScript
setSortBy(sortBy: SlicerSortType): void;
Parâmetros
sortBy ExcelScript.SlicerSortType
Retornos
void
setStyle(style)
Valor constante que representa o estilo de segmentação. Os valores possíveis são:
"SlicerStyleLight1" por meio de "SlicerStyleLight6", "TableStyleOther1" por meio de
"TableStyleOther2", "SlicerStyleDark1" por meio de "SlicerStyleDark6". Também é
possível usar um estilo definido pelo usuário que esteja presente na planilha.
TypeScript
setStyle(style: string): void;
Parâmetros
style string
Retornos
void
setTop(top)
Representa a distância, em pontos, da borda superior da segmentação de dados na
parte superior da planilha. Lança um InvalidArgument erro quando definido com um
TypeScript
Parâmetros
top number
Retornos
void
setWidth(width)
Representa a largura, em pontos, da segmentação de dados. Lança um
InvalidArgument erro quando definido com um valor negativo ou zero como uma
entrada.
TypeScript
Parâmetros
width number
Retornos
void
comentários:
ExcelScript.SlicerItem interface
Referência
Pacote: ExcelScript
Representa um item de segmentação em uma segmentação.
Métodos
getHasData() O valor será true se o item de segmentação tiver dados.
getIsSelected() O valor será true se o item de segmentação for selecionado. Definir esse valor
não limpará o estado selecionado de outros itens de segmentação. Por padrão,
se o item de segmentação for o único selecionado, quando ele for dessemar,
todos os itens serão selecionados.
getKey() Representa o valor exclusivo que representa o item da segmentação de dados.
getName() Representa o título exibido na interface do usuário do Excel.
setIsSelected(is O valor será true se o item de segmentação for selecionado. Definir esse valor
Selected) não limpará o estado selecionado de outros itens de segmentação. Por padrão,
se o item de segmentação for o único selecionado, quando ele for dessemar,
todos os itens serão selecionados.
Detalhes do método
getHasData()
O valor será true se o item de segmentação tiver dados.
TypeScript
getHasData(): boolean;
Retornos
boolean
getIsSelected()
O valor será true se o item de segmentação for selecionado. Definir esse valor não
limpará o estado selecionado de outros itens de segmentação. Por padrão, se o item
de segmentação for o único selecionado, quando ele for dessemar, todos os itens
serão selecionados.
TypeScript
getIsSelected(): boolean;
Retornos
boolean
getKey()
Representa o valor exclusivo que representa o item da segmentação de dados.
TypeScript
getKey(): string;
Retornos
string
getName()
Representa o título exibido na interface do usuário do Excel.
TypeScript
getName(): string;
Retornos
string
setIsSelected(isSelected)
O valor será true se o item de segmentação for selecionado. Definir esse valor não
limpará o estado selecionado de outros itens de segmentação. Por padrão, se o item
de segmentação for o único selecionado, quando ele for dessemar, todos os itens
serão selecionados.
TypeScript
setIsSelected(isSelected: boolean): void;
Parâmetros
isSelected boolean
Retornos
void
comentários:
ExcelScript.SlicerStyle interface
Referência
Pacote: ExcelScript
Representa um estilo de segmentação, que define elementos de estilo por região da

segmentação.
Métodos
delete() Exclui o estilo de segmentação.
duplicate() Cria uma duplicata desse estilo de segmentação com cópias de todos os
getName() Especifica o nome do estilo de segmentação.
getReadOnly() Especifica se esse SlicerStyle objeto é somente leitura.
set Especifica o nome do estilo de segmentação.

Name(name)
Detalhes do método
delete()
Exclui o estilo de segmentação.
TypeScript
delete(): void;
Retornos
void
duplicate()
Cria uma duplicata desse estilo de segmentação com cópias de todos os elementos
de estilo.
TypeScript
duplicate(): SlicerStyle;
Retornos
ExcelScript.SlicerStyle
getName()
Especifica o nome do estilo de segmentação.
TypeScript
getName(): string;
Retornos
string
getReadOnly()
Especifica se esse SlicerStyle objeto é somente leitura.
TypeScript
Retornos
boolean
setName(name)
Especifica o nome do estilo de segmentação.
TypeScript
Parâmetros
name string
Retornos
void
comentários:
ExcelScript.SortField interface
Referência
Pacote: ExcelScript
Representa uma condição em uma operação de classificação.
Propriedades
ascending Especifica se a classificação é feita de forma crescente.
color Especifica a cor que é o destino da condição se a classificação estiver na fonte ou na

cor da célula.
data Representa as opções de classificação adicionais para esse campo.

Option
icon Especifica o ícone que é o destino da condição, se a classificação estiver no ícone da

célula.
key Especifica a coluna (ou linha, dependendo da orientação de classificação) em que a

condição está. Representado como um deslocamento da primeira coluna (ou linha).
sortOn Especifica o tipo de classificação dessa condição.
subField Especifica o subcampo que é o nome da propriedade de destino de um valor rico

para classificar.
ascending
Especifica se a classificação é feita de forma crescente.
TypeScript
ascending?: boolean;
boolean
color
Especifica a cor que é o destino da condição se a classificação estiver na fonte ou na
cor da célula.
TypeScript
color?: string;
string
Exemplos
TypeScript
/**
* This script sorts a range based on the color of the cells.
* It brings all red cells to the top of the range.
*/
// Create a SortField for color sorting.

// This sorts the rows based on the fill color of each row's cell in
the first column.
let colorSort: ExcelScript.SortField = {
ascending: true,
color: "FF0000", /* red */
key: 0,
sortOn: ExcelScript.SortOn.cellColor
};

rangeToSort.getSort().apply([colorSort]);
}
dataOption
Representa as opções de classificação adicionais para esse campo.
TypeScript
dataOption?: SortDataOption;
ExcelScript.SortDataOption
Exemplos
TypeScript
/**
* This script sorts a table based on the values in column 1.
* If the text of a column-1 value can be treated as a number,
* it will be sorted in numerical order, rather than Unicode order
* (so 123 will come before 12.3).
*/
// Create the sorting parameters.

const countSortField: ExcelScript.SortField = {
key: 1,
ascending: true,
dataOption: ExcelScript.SortDataOption.textAsNumber
};
// Apply the sort to the table.

const sort = table.getSort();
sort.apply([countSortField]);
}
icon
Especifica o ícone que é o destino da condição, se a classificação estiver no ícone da
célula.
TypeScript
icon?: Icon;
ExcelScript.Icon
key
Especifica a coluna (ou linha, dependendo da orientação de classificação) em que a
condição está. Representado como um deslocamento da primeira coluna (ou linha).
TypeScript
key: number;
number
Exemplos
TypeScript
/**
* This script sorts the used range of the current worksheet.
*/
const activeRange = workbook.getActiveWorksheet().getUsedRange();
// Sort the rows in ascending order based on the last column.

activeRange.getSort().apply(
[{
ascending: true,
key: activeRange.getColumnCount() - 1
}],
false, /* Don't match case. */
true, /* Treat the first row as a header rows. */
ExcelScript.SortOrientation.rows
);
}
sortOn
Especifica o tipo de classificação dessa condição.
TypeScript
sortOn?: SortOn;
ExcelScript.SortOn
subField
Especifica o subcampo que é o nome da propriedade de destino de um valor rico
para classificar.
TypeScript
subField?: string;
string
comentários:
ExcelScript.Subtotals interface
Referência
Pacote: ExcelScript
Subtotais para o Campo Dinâmico.
Propriedades
automatic Se Automatic estiver definido como true , todos os outros valores serão
ignorados ao definir o Subtotals .
average Average
count Count
countNumbers CountNumbers
max Máx.
min Min
product Produto
standard StandardDeviation
Deviation
standard StandardDeviationP
DeviationP
sum Soma
variance Variância
varianceP VarianceP
automatic
Se Automatic estiver definido como true , todos os outros valores serão ignorados
ao definir o Subtotals .
TypeScript
automatic?: boolean;
boolean
average
Average
TypeScript
average?: boolean;
boolean
count
Count
TypeScript
count?: boolean;
boolean
countNumbers
CountNumbers
TypeScript
countNumbers?: boolean;
boolean
max
Máx.
TypeScript
max?: boolean;
boolean
min
Min
TypeScript
min?: boolean;
boolean
product
Produto
TypeScript
product?: boolean;
boolean
standardDeviation
StandardDeviation
TypeScript
standardDeviation?: boolean;
boolean
standardDeviationP
StandardDeviationP
TypeScript
standardDeviationP?: boolean;
boolean
sum
Soma
TypeScript
sum?: boolean;
boolean
variance
Variância
TypeScript
variance?: boolean;
boolean
varianceP
VarianceP
TypeScript
varianceP?: boolean;
boolean
ExcelScript.Table interface
Referência
Pacote: ExcelScript
Representa uma tabela do Excel.
Comentários
Exemplos
TypeScript
/**
* This script creates a table from the current sheet's used range.
* It then adds a total row to the table with the SUM of the last column.
*/
// Create a table that has headers from that range.

const table = sheet.addTable(range, true);
// Have the table display the SUM for the last column.
table.setShowTotals(true);
const lastColumn = table.getColumn(table.getColumns().length);
lastColumn.getTotalRowRange().setFormula(`=SUBTOTAL(109,
[${lastColumn.getName()}])`);
}
Métodos
addColumn(index, Adiciona uma nova coluna à tabela.

values, name)
addRow(index, values) Adiciona uma linha à tabela.
addRows(index, Adiciona uma ou mais linhas à tabela.

values)
clearFilters() Limpa todos os filtros aplicados à tabela no momento.

convertToRange() Converte a tabela em um intervalo de células normal. Todos os dados
são preservados.
delete() Exclui a tabela.
deleteRowsAt(index, Exclua um número especificado de linhas em um determinado índice.

count)
getAutoFilter() Representa o AutoFilter objeto da tabela.
getColumn(key) Obtém um objeto de coluna por nome ou ID. Se a coluna não existir,
getColumnById(key) Obtém um objeto de coluna por ID. Se a coluna não existir, retornará
indefinido.
getColumn Obtém um objeto de coluna por Nome. Se a coluna não existir,

ByName(key) retornará indefinido.
getColumns() Representa uma coleção de todas as colunas na tabela.
getHeaderRowRange() Obtém o objeto de intervalo associado à linha de cabeçalho da tabela.
getHighlightFirst Especifica se a primeira coluna contém formatação especial.

Column()
getHighlightLast Especifica se a última coluna contém formatação especial.

Column()
getId() Retorna um valor que identifica de forma exclusiva a tabela em uma

determinada pasta de trabalho. O valor do identificador permanece o
mesmo, ainda que a tabela seja renomeada.
getLegacyId() Retorna uma ID numérica.
getName() Nome da tabela.
getPredefinedTable Valor constante que representa o estilo de tabela. Os valores possíveis

Style() são: "TableStyleLight1" por meio de "TableStyleLight21",
"TableStyleMedium1" por "TableStyleMedium28", "TableStyleDark1" até
"TableStyleDark11". Também é possível usar um estilo definido pelo
usuário que esteja presente na planilha.
getRange() Obtém o objeto de intervalo associado a toda a tabela.
getRangeBetween Obtém o objeto de intervalo associado ao corpo de dados da tabela.

HeaderAndTotal()
getRowCount() Obtém a quantidade de linhas na tabela.
getShowBanded Especifica se as colunas mostram formatação em banda na qual colunas

Columns() ímpares são realçadas de forma diferente das até mesmo, para facilitar a
leitura da tabela.
getShowBanded Especifica se as linhas mostram formatação em banda na qual linhas

Rows() ímpares são realçadas de forma diferente das até mesmo, para facilitar a
leitura da tabela.
getShowFilterButton() Especifica se os botões de filtro estão visíveis na parte superior de cada

cabeçalho de coluna. Essa configuração só será permitida se a tabela
tiver uma linha de cabeçalho.
getShowHeaders() Especifica se a linha de cabeçalho está visível. Esse valor pode ser
definido para mostrar ou remover a linha do cabeçalho.
getShowTotals() Especifica se a linha total está visível. Esse valor pode ser definido para
mostrar ou remover a linha do total.
getSort() Representa a classificação da tabela.
getTotalRowRange() Obtém o objeto de intervalo associado à linha de totais da tabela.
getWorksheet() A planilha que contém a tabela atual.
reapplyFilters() Aplica novamente todos os filtros à tabela.
resize(newRange) Redimensione a tabela para o novo intervalo. O novo intervalo deve se

sobrepor ao intervalo de tabela original e os cabeçalhos (ou a parte
superior da tabela) devem estar na mesma linha.
setHighlightFirst Especifica se a primeira coluna contém formatação especial.

Column(highlightFirst
Column)
setHighlightLast Especifica se a última coluna contém formatação especial.

Column(highlightLast
Column)
setName(name) Nome da tabela.
setPredefinedTable Valor constante que representa o estilo de tabela. Os valores possíveis

Style(predefinedTable são: "TableStyleLight1" por meio de "TableStyleLight21",
Style) "TableStyleMedium1" por "TableStyleMedium28", "TableStyleDark1" até
"TableStyleDark11". Também é possível usar um estilo definido pelo
usuário que esteja presente na planilha.
setShowBanded Especifica se as colunas mostram formatação em banda na qual colunas

Columns(showBanded ímpares são realçadas de forma diferente das até mesmo, para facilitar a
Columns) leitura da tabela.
setShowBanded Especifica se as linhas mostram formatação em banda na qual linhas

Rows(showBanded ímpares são realçadas de forma diferente das até mesmo, para facilitar a
Rows) leitura da tabela.
setShowFilter Especifica se os botões de filtro estão visíveis na parte superior de cada
Button(showFilter cabeçalho de coluna. Essa configuração só será permitida se a tabela
Button) tiver uma linha de cabeçalho.
setShowHeaders(show Especifica se a linha de cabeçalho está visível. Esse valor pode ser
Headers) definido para mostrar ou remover a linha do cabeçalho.
setShowTotals(show Especifica se a linha total está visível. Esse valor pode ser definido para
Totals) mostrar ou remover a linha do total.
Detalhes do método
addColumn(index, values, name)

Adiciona uma nova coluna à tabela.
TypeScript
addColumn(
index?: number,
values?: (boolean | string | number)[],
name?: string
): TableColumn;
Parâmetros
index number
Opcional. Especifica a posição relativa da nova coluna. Se for null ou -1, a adição
ocorre no final. Colunas com um índice superior serão deslocadas para o lado.
Indexado com zero.
values (boolean | string | number)[]

Opcional. Uma matriz unidimensional de valores não formatados da coluna de
tabela.
name string
Opcional. Especifica o nome da nova coluna. Se for null, o nome padrão será usado.
Retornos
ExcelScript.TableColumn
Exemplos
TypeScript
/**
* This script adds a new column to a table.
*/
// Append an empty column to the table with the header "Total".

table.addColumn(-1, null, "Total");
}
addRow(index, values)
Adiciona uma linha à tabela.
TypeScript
addRow(index?: number, values?: (boolean | string | number)[]): void;
Parâmetros
index number
Opcional. Especifica a posição relativa da nova linha. Se for null ou -1, a adição
ocorre no final. Todas as linhas abaixo da linha inserida serão deslocadas para baixo.
Indexado com zero.
values (boolean | string | number)[]

Opcional. Uma matriz unidimensional de valores não formatados da linha de tabela.
Retornos
void
Exemplos
TypeScript
/**
* This script adds a row to an existing table.
*/
// Initialize the data to be added as a table row.

// Note that length of the array must match the number of columns in
the table.
let rowData = ["Carrots", "Vegetable", 750];
// Add a row to the end of the table.

table.addRow(-1, rowData);
}
addRows(index, values)
Adiciona uma ou mais linhas à tabela.
TypeScript
addRows(index?: number, values?: (boolean | string | number)[][]): void;
Parâmetros
index number
Opcional. Especifica a posição relativa da nova linha. Se for null ou -1, a adição
ocorre no final. Todas as linhas abaixo da linha inserida serão deslocadas para baixo.
Indexado com zero.
values (boolean | string | number)[][]

Opcional. Uma matriz bidimensional de valores não formatados da linha da tabela.
Retornos
void
Exemplos
TypeScript
/**
* This script adds multiple rows to an existing table.
*/
// Initialize the data to be added as table rows.

// Note that length of the array must match the number of columns in
the table.
let rowData = [["Apples", "Fruit", 5000],
["Celery", "Vegetable", 600],
["Onions", "Vegetable", 1500]];
// Add the rows to the end of the table.

table.addRows(-1, rowData);
}
clearFilters()
Limpa todos os filtros aplicados à tabela no momento.
TypeScript
clearFilters(): void;
Retornos
void
convertToRange()
Converte a tabela em um intervalo de células normal. Todos os dados são
preservados.
TypeScript
convertToRange(): Range;
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This script converts a table to a range and removes the formatting.
*/
// Convert the table to a range.

const formerTable = table.convertToRange();
// Remove the formatting from the table

formerTable.clear(ExcelScript.ClearApplyTo.formats);
}
delete()
Exclui a tabela.
TypeScript
delete(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script deletes a table.
* This removes all associated data and formatting.
*/
// Get the table named "Inventory".
const table = workbook.getTable("Inventory");
// Delete the table.

table.delete();
}
deleteRowsAt(index, count)
Exclua um número especificado de linhas em um determinado índice.
TypeScript
deleteRowsAt(index: number, count?: number): void;
Parâmetros
index number
O valor do índice da linha a ser excluída. Cuidado: o índice da linha pode ter se
movido do momento em que você determinou o valor a ser usado para remoção.
count number
Número de linhas a serem excluídas. Por padrão, uma única linha será excluída.
Observação: excluir mais de 1000 linhas ao mesmo tempo pode resultar em um
tempo limite do Power Automate.
Retornos
void
getAutoFilter()
Representa o AutoFilter objeto da tabela.
TypeScript
getAutoFilter(): AutoFilter;
Retornos
ExcelScript.AutoFilter
getColumn(key)
Obtém um objeto de coluna por nome ou ID. Se a coluna não existir, esse método
TypeScript
getColumn(key: number | string): TableColumn | undefined;

Parâmetros
key number | string
Nome da coluna ou ID.
Retornos
ExcelScript.TableColumn | undefined
Exemplos
TypeScript
/**
* This script adjusts the indentation of a specific table column.
*/
// Get the data range of the second column.

const secondColumn = table.getColumn(2);
const data = secondColumn.getRangeBetweenHeaderAndTotal();
// Add an indentation of 1 character space to the data range.

data.getFormat().adjustIndent(1);
}
getColumnById(key)
Obtém um objeto de coluna por ID. Se a coluna não existir, retornará indefinido.
TypeScript
getColumnById(key: number): TableColumn | undefined;
Parâmetros
key number
ID da coluna.
Retornos
getColumnByName(key)
Obtém um objeto de coluna por Nome. Se a coluna não existir, retornará indefinido.
TypeScript
getColumnByName(key: string): TableColumn | undefined;
Parâmetros
key string
Nome da coluna.
Retornos
Exemplos
TypeScript
/**
* This script removes a specific column from a table.
*/
// If it exists, remove the column named "Category".

let categoryColumn = table.getColumnByName("Category");
if (categoryColumn) {
categoryColumn.delete();
}
}
getColumns()
Representa uma coleção de todas as colunas na tabela.
TypeScript
getColumns(): TableColumn[];
Retornos
ExcelScript.TableColumn[]
Exemplos
TypeScript
/**
* It then sets the formulas in the new column to be the product
* of the values in the two preceding columns.
*/

const totalColumn = table.addColumn(-1, null, "Total");
// Get the names of the two preceding columns.

const productColumnName1 = table.getColumns()[totalColumn.getIndex() -
1].getName();
2].getName();
// Set the formulas in the "Total" column to be the product of the two
preceding columns.
totalColumn.getRangeBetweenHeaderAndTotal().setFormula(
`=[@[${productColumnName1}]]*[@[${productColumnName2}]]`
);
}
getHeaderRowRange()
Obtém o objeto de intervalo associado à linha de cabeçalho da tabela.
TypeScript
getHeaderRowRange(): Range;
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
*/

headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlig
nment.center);
}
getHighlightFirstColumn()
Especifica se a primeira coluna contém formatação especial.
TypeScript
getHighlightFirstColumn(): boolean;
Retornos
boolean
getHighlightLastColumn()
Especifica se a última coluna contém formatação especial.
TypeScript
getHighlightLastColumn(): boolean;
Retornos
boolean
getId()
Retorna um valor que identifica de forma exclusiva a tabela em uma determinada
pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a tabela
seja renomeada.
TypeScript
getId(): string;
Retornos
string
getLegacyId()
Retorna uma ID numérica.
TypeScript
getLegacyId(): string;
Retornos
string
getName()
Nome da tabela.
TypeScript
getName(): string;
Retornos
string
getPredefinedTableStyle()
Valor constante que representa o estilo de tabela. Os valores possíveis são:
"TableStyleLight1" por meio de "TableStyleLight21", "TableStyleMedium1" por
"TableStyleMedium28", "TableStyleDark1" até "TableStyleDark11". Também é possível
usar um estilo definido pelo usuário que esteja presente na planilha.
TypeScript
getPredefinedTableStyle(): string;
Retornos
string
getRange()
Obtém o objeto de intervalo associado a toda a tabela.
TypeScript
getRange(): Range;
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This script removes any extra formatting that's been applied to a
table.
* This leaves only the base table style effects.
* Any formatting outside of the table will be left as is.
*/
let table = worksheet.getTables()[0];
// Get the range used by the table.

let range = table.getRange();
// Clear all the formatting that is not applied by the table and the
table style.
}
getRangeBetweenHeaderAndTotal()
Obtém o objeto de intervalo associado ao corpo de dados da tabela.
TypeScript
getRangeBetweenHeaderAndTotal(): Range;
Retornos
ExcelScript.Range
getRowCount()
Obtém a quantidade de linhas na tabela.
TypeScript
Retornos
number
getShowBandedColumns()
Especifica se as colunas mostram formatação em banda na qual colunas ímpares são
realçadas de forma diferente das até mesmo, para facilitar a leitura da tabela.
TypeScript
getShowBandedColumns(): boolean;
Retornos
boolean
getShowBandedRows()
Especifica se as linhas mostram formatação em banda na qual linhas ímpares são
TypeScript
getShowBandedRows(): boolean;
Retornos
boolean
getShowFilterButton()
Especifica se os botões de filtro estão visíveis na parte superior de cada cabeçalho de
coluna. Essa configuração só será permitida se a tabela tiver uma linha de cabeçalho.
TypeScript
getShowFilterButton(): boolean;
Retornos
boolean
getShowHeaders()
Especifica se a linha de cabeçalho está visível. Esse valor pode ser definido para
mostrar ou remover a linha do cabeçalho.
TypeScript
getShowHeaders(): boolean;
Retornos
boolean
getShowTotals()
Especifica se a linha total está visível. Esse valor pode ser definido para mostrar ou
remover a linha do total.
TypeScript
getShowTotals(): boolean;
Retornos
boolean
getSort()
Representa a classificação da tabela.
TypeScript
getSort(): TableSort;
Retornos
ExcelScript.TableSort
getTotalRowRange()
Obtém o objeto de intervalo associado à linha de totais da tabela.
TypeScript
getTotalRowRange(): Range;
Retornos
ExcelScript.Range
getWorksheet()
A planilha que contém a tabela atual.
TypeScript
Retornos
reapplyFilters()
Aplica novamente todos os filtros à tabela.
TypeScript
reapplyFilters(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script reapplies the filters on every table in the workbook.
*/
// Get all the tables.
const tables = workbook.getTables();
// Iterate over every table.

tables.forEach((table) => {
// Reapply the filters to account for new table entries.
table.reapplyFilters();
});
}
resize(newRange)
Redimensione a tabela para o novo intervalo. O novo intervalo deve se sobrepor ao
intervalo de tabela original e os cabeçalhos (ou a parte superior da tabela) devem
estar na mesma linha.
TypeScript
resize(newRange: Range | string): void;
Parâmetros
newRange ExcelScript.Range | string
O objeto de intervalo ou o endereço de intervalo que será usado para determinar o
novo tamanho da tabela.
Retornos
void
setHighlightFirstColumn(highlightFirstColumn)
Especifica se a primeira coluna contém formatação especial.
TypeScript
setHighlightFirstColumn(highlightFirstColumn: boolean): void;
Parâmetros
highlightFirstColumn boolean
Retornos
void
setHighlightLastColumn(highlightLastColumn)
Especifica se a última coluna contém formatação especial.
TypeScript
setHighlightLastColumn(highlightLastColumn: boolean): void;
Parâmetros
highlightLastColumn boolean
Retornos
void
setName(name)
Nome da tabela.
TypeScript
Parâmetros
name string
Retornos
void
setPredefinedTableStyle(predefinedTableStyle)
Valor constante que representa o estilo de tabela. Os valores possíveis são:
"TableStyleLight1" por meio de "TableStyleLight21", "TableStyleMedium1" por
"TableStyleMedium28", "TableStyleDark1" até "TableStyleDark11". Também é possível
usar um estilo definido pelo usuário que esteja presente na planilha.
TypeScript
setPredefinedTableStyle(predefinedTableStyle: string): void;
Parâmetros
predefinedTableStyle string
Retornos
void
setShowBandedColumns(showBandedColumns)
Especifica se as colunas mostram formatação em banda na qual colunas ímpares são
TypeScript
setShowBandedColumns(showBandedColumns: boolean): void;

Parâmetros
showBandedColumns boolean
Retornos
void
setShowBandedRows(showBandedRows)
Especifica se as linhas mostram formatação em banda na qual linhas ímpares são
TypeScript
setShowBandedRows(showBandedRows: boolean): void;
Parâmetros
showBandedRows boolean
Retornos
void
setShowFilterButton(showFilterButton)
Especifica se os botões de filtro estão visíveis na parte superior de cada cabeçalho de
coluna. Essa configuração só será permitida se a tabela tiver uma linha de cabeçalho.
TypeScript
setShowFilterButton(showFilterButton: boolean): void;
Parâmetros
showFilterButton boolean
Retornos
void
setShowHeaders(showHeaders)
Especifica se a linha de cabeçalho está visível. Esse valor pode ser definido para
mostrar ou remover a linha do cabeçalho.
TypeScript
setShowHeaders(showHeaders: boolean): void;
Parâmetros
showHeaders boolean
Retornos
void
Exemplos
TypeScript
/**
* This script makes a table's headers not visible in the grid.
*/
// Get the table named "CoverageTable".
const coverageTable = workbook.getTable("CoverageTable");
// Make the header row not visible.

coverageTable.setShowHeaders(false);
}
setShowTotals(showTotals)
Especifica se a linha total está visível. Esse valor pode ser definido para mostrar ou
remover a linha do total.
TypeScript
setShowTotals(showTotals: boolean): void;
Parâmetros
showTotals boolean
Retornos
void
Exemplos
TypeScript
/**
* This script adds the Total Row to an existing table.
*/
// Set the Total Row to show.

table.setShowTotals(true);
}
comentários:
ExcelScript.TableColumn interface
Referência
Pacote: ExcelScript
Representa uma coluna em uma tabela.
Métodos
delete() Exclui a coluna da tabela.
getFilter() Recupera o filtro aplicado à coluna.
getHeaderRowRange() Obtém o objeto de intervalo associado à linha de cabeçalho da

coluna.
getId() Retorna uma chave exclusiva que identifica a coluna na tabela.
getIndex() Retorna o número de índice da coluna na coleção de colunas da

tabela. Indexado com zero.
getName() Especifica o nome da coluna de tabela.
getRange() Obtém o objeto de intervalo associado a toda a coluna.
getRangeBetweenHeader Obtém o objeto de intervalo associado ao corpo de dados da

AndTotal() coluna.
getTotalRowRange() Obtém o objeto de intervalo associado à linha de totais da coluna.
setName(name) Especifica o nome da coluna de tabela.
Detalhes do método
delete()
Exclui a coluna da tabela.
TypeScript
delete(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script removes a specific column from a table.
*/
// If it exists, remove the column named "Category".

let categoryColumn = table.getColumnByName("Category");
if (categoryColumn) {
categoryColumn.delete();
}
}
getFilter()
Recupera o filtro aplicado à coluna.
TypeScript
getFilter(): Filter;
Retornos
ExcelScript.Filter
Exemplos
TypeScript
/**
* This script adds a table filter to only show the top 10% of values
* belonging to a particular column.
*/
// Get the filter for the "PageViews" table column.
const pageViewFilter =
table.getColumnByName("PageViews").getFilter();
// Apply a filter to only show the rows in the top 10% of values in
this column.
pageViewFilter.applyTopPercentFilter(10);
}
getHeaderRowRange()
Obtém o objeto de intervalo associado à linha de cabeçalho da coluna.
TypeScript
getHeaderRowRange(): Range;
Retornos
ExcelScript.Range
getId()
Retorna uma chave exclusiva que identifica a coluna na tabela.
TypeScript
getId(): number;
Retornos
number
getIndex()
Retorna o número de índice da coluna na coleção de colunas da tabela. Indexado
com zero.
TypeScript
getIndex(): number;
Retornos
number
getName()
Especifica o nome da coluna de tabela.
TypeScript
getName(): string;
Retornos
string
getRange()
Obtém o objeto de intervalo associado a toda a coluna.
TypeScript
getRange(): Range;
Retornos
ExcelScript.Range
getRangeBetweenHeaderAndTotal()
Obtém o objeto de intervalo associado ao corpo de dados da coluna.
TypeScript
getRangeBetweenHeaderAndTotal(): Range;
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* It then sets the formulas in the new column to be the product
* of the values in the two preceding columns.
*/

const totalColumn = table.addColumn(-1, null, "Total");
// Get the names of the two preceding columns.

1].getName();
2].getName();
// Set the formulas in the "Total" column to be the product of the two
preceding columns.
totalColumn.getRangeBetweenHeaderAndTotal().setFormula(
`=[@[${productColumnName1}]]*[@[${productColumnName2}]]`
);
}
getTotalRowRange()
Obtém o objeto de intervalo associado à linha de totais da coluna.
TypeScript
getTotalRowRange(): Range;
Retornos
ExcelScript.Range
setName(name)
Especifica o nome da coluna de tabela.
TypeScript

Parâmetros
name string
Retornos
void
comentários:
ExcelScript.TableSort interface
Referência
Pacote: ExcelScript
Gerencia operações de classificação em Table objetos.
Métodos
apply(fields, match Executa uma operação de classificação.

Case, method)
clear() Limpa a classificação que está na tabela. Essa ação não modifica a
ordenação da tabela, mas limpa o estado dos botões do cabeçalho.
getFields() Especifica as condições atuais usadas para classificar a tabela pela última
vez.
getMatchCase() Especifica se o invólucro afeta o último tipo da tabela.
getMethod() Representa o método de ordenação de caracteres chinês usado pela

última vez para classificar a tabela.
reapply() Reaplica os parâmetros de classificação atuais à tabela.
Detalhes do método
apply(fields, matchCase, method)

Executa uma operação de classificação.
TypeScript
apply(
fields: SortField[],
matchCase?: boolean,
method?: SortMethod
): void;
Parâmetros
fields ExcelScript.SortField[]
A lista de condições para a classificação.
matchCase boolean
Opcional. Define se o uso de maiúsculas ou minúsculas afeta a ordenação da cadeia
de caracteres.
method ExcelScript.SortMethod
Opcional. O método de ordenação usado pelos caracteres chineses.
Retornos
void
Exemplos
TypeScript
/**
* This sample creates a table from the current worksheet's used range,
then sorts it based on the first column.
*/
// 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 }]);
}
clear()
Limpa a classificação que está na tabela. Essa ação não modifica a ordenação da
tabela, mas limpa o estado dos botões do cabeçalho.
TypeScript
clear(): void;
Retornos
void
getFields()
Especifica as condições atuais usadas para classificar a tabela pela última vez.
TypeScript
getFields(): SortField[];
Retornos
ExcelScript.SortField[]
getMatchCase()
Especifica se o invólucro afeta o último tipo da tabela.
TypeScript
getMatchCase(): boolean;
Retornos
boolean
getMethod()
Representa o método de ordenação de caracteres chinês usado pela última vez para
classificar a tabela.
TypeScript
getMethod(): SortMethod;
Retornos
ExcelScript.SortMethod
reapply()
Reaplica os parâmetros de classificação atuais à tabela.
TypeScript
reapply(): void;
Retornos
void
comentários:
ExcelScript.TableStyle interface
Referência
Pacote: ExcelScript
Representa um estilo de tabela, que define os elementos de estilo por região da tabela.
Métodos
delete() Exclui o estilo de tabela.
duplicate() Cria uma duplicata desse estilo de tabela com cópias de todos os elementos de
estilo.
getName() Especifica o nome do estilo de tabela.
getReadOnly() Especifica se esse TableStyle objeto é somente leitura.
set Especifica o nome do estilo de tabela.

Name(name)
Detalhes do método
delete()
Exclui o estilo de tabela.
TypeScript
delete(): void;
Retornos
void
duplicate()
Cria uma duplicata desse estilo de tabela com cópias de todos os elementos de
estilo.
TypeScript
duplicate(): TableStyle;
Retornos
ExcelScript.TableStyle
getName()
Especifica o nome do estilo de tabela.
TypeScript
getName(): string;
Retornos
string
getReadOnly()
Especifica se esse TableStyle objeto é somente leitura.
TypeScript
Retornos
boolean
setName(name)
Especifica o nome do estilo de tabela.
TypeScript

Parâmetros
name string
Retornos
void
comentários:
ExcelScript.TextConditionalFormat
interface
Referência
Pacote: ExcelScript
Representa um formato condicional de texto específico.
Comentários
Exemplos
TypeScript
/**
worksheet.
with "Excel".
*/

const textConditionFormat: ExcelScript.TextConditionalFormat =

text: "Excel"
};
}
Métodos
get Retorna um objeto de formato, encapsulando a fonte, o preenchimento, as bordas e

Format() outras propriedades do formato condicional.
getRule() A regra da formatação condicional.
set A regra da formatação condicional.

Rule(rule)
Detalhes do método
getFormat()
Retorna um objeto de formato, encapsulando a fonte, o preenchimento, as bordas e
outras propriedades do formato condicional.
TypeScript
Retornos
getRule()
TypeScript
getRule(): ConditionalTextComparisonRule;
Retornos
ExcelScript.ConditionalTextComparisonRule
setRule(rule)
TypeScript
setRule(rule: ConditionalTextComparisonRule): void;
Parâmetros
rule ExcelScript.ConditionalTextComparisonRule
Retornos
void
comentários:
ExcelScript.TextFrame interface
Referência
Pacote: ExcelScript
Representa o quadro de texto de um objeto shape.
Comentários
Exemplos
TypeScript
/**
*/

const star =
const textFrame: ExcelScript.TextFrame = star.getTextFrame();
t);
}
Métodos
deleteText() Exclui todo o texto no quadro de texto.
getAutoSizeSetting() As configurações de dimensionamento automático para o quadro de

texto. Um quadro de texto pode ser configurado para ajustar
automaticamente o texto ao quadro de texto, para ajustar
automaticamente o quadro do texto ao texto ou não executar
qualquer dimensionamento automático.
getBottomMargin() Representa margem inferior, em pontos, do quadro de texto.
getHasText() Especifica se o quadro de texto contém texto.
getHorizontalAlignment() Representa o alinhamento horizontal do quadro de texto. Confira

ExcelScript.ShapeTextHorizontalAlignment detalhes.
getHorizontalOverflow() Representa o comportamento de excedente horizontal do quadro de

texto. Confira ExcelScript.ShapeTextHorizontalOverflow detalhes.
getLeftMargin() Representa margem esquerda, em pontos, do quadro de texto.
getOrientation() Representa o ângulo para o qual o texto é orientado para o quadro

de texto. Confira ExcelScript.ShapeTextOrientation detalhes.
getReadingOrder() Representa a ordem de leitura do quadro de texto, da direita para a

esquerda ou da direita para a esquerda. Confira
ExcelScript.ShapeTextReadingOrder detalhes.
getRightMargin() Representa margem direita, em pontos, do quadro de texto.
getTextRange() Representa o texto que está anexado a uma forma, bem como
propriedades e métodos para manipular o texto. Confira
ExcelScript.TextRange detalhes.
getTopMargin() Representa margem superior, em pontos, do quadro de texto.
getVerticalAlignment() Representa o alinhamento vertical do quadro de texto. Confira

ExcelScript.ShapeTextVerticalAlignment detalhes.
getVerticalOverflow() Representa o comportamento de excedente vertical do quadro de

texto. Confira ExcelScript.ShapeTextVerticalOverflow detalhes.
setAutoSizeSetting(auto As configurações de dimensionamento automático para o quadro de

SizeSetting) texto. Um quadro de texto pode ser configurado para ajustar
automaticamente o texto ao quadro de texto, para ajustar
automaticamente o quadro do texto ao texto ou não executar
qualquer dimensionamento automático.
setBottomMargin(bottom Representa margem inferior, em pontos, do quadro de texto.

Margin)
setHorizontal Representa o alinhamento horizontal do quadro de texto. Confira

Alignment(horizontal ExcelScript.ShapeTextHorizontalAlignment detalhes.
Alignment)
setHorizontal Representa o comportamento de excedente horizontal do quadro de

Overflow(horizontal texto. Confira ExcelScript.ShapeTextHorizontalOverflow detalhes.
Overflow)
setLeftMargin(leftMargin) Representa margem esquerda, em pontos, do quadro de texto.

set Representa o ângulo para o qual o texto é orientado para o quadro
Orientation(orientation) de texto. Confira ExcelScript.ShapeTextOrientation detalhes.
setReadingOrder(reading Representa a ordem de leitura do quadro de texto, da direita para a

Order) esquerda ou da direita para a esquerda. Confira
ExcelScript.ShapeTextReadingOrder detalhes.
setRightMargin(right Representa margem direita, em pontos, do quadro de texto.

Margin)
setTopMargin(topMargin) Representa margem superior, em pontos, do quadro de texto.
setVertical Representa o alinhamento vertical do quadro de texto. Confira

Alignment(vertical ExcelScript.ShapeTextVerticalAlignment detalhes.
Alignment)
setVertical Representa o comportamento de excedente vertical do quadro de

Overflow(vertical texto. Confira ExcelScript.ShapeTextVerticalOverflow detalhes.
Overflow)
Detalhes do método
deleteText()
Exclui todo o texto no quadro de texto.
TypeScript
deleteText(): void;
Retornos
void
getAutoSizeSetting()
As configurações de dimensionamento automático para o quadro de texto. Um
quadro de texto pode ser configurado para ajustar automaticamente o texto ao
quadro de texto, para ajustar automaticamente o quadro do texto ao texto ou não
executar qualquer dimensionamento automático.
TypeScript
getAutoSizeSetting(): ShapeAutoSize;
Retornos
ExcelScript.ShapeAutoSize
getBottomMargin()
Representa margem inferior, em pontos, do quadro de texto.
TypeScript
getBottomMargin(): number;
Retornos
number
getHasText()
Especifica se o quadro de texto contém texto.
TypeScript
getHasText(): boolean;
Retornos
boolean
Representa o alinhamento horizontal do quadro de texto. Confira
TypeScript
getHorizontalAlignment(): ShapeTextHorizontalAlignment;
Retornos
ExcelScript.ShapeTextHorizontalAlignment
getHorizontalOverflow()
Representa o comportamento de excedente horizontal do quadro de texto. Confira
ExcelScript.ShapeTextHorizontalOverflow detalhes.
TypeScript
getHorizontalOverflow(): ShapeTextHorizontalOverflow;
Retornos
ExcelScript.ShapeTextHorizontalOverflow
getLeftMargin()
Representa margem esquerda, em pontos, do quadro de texto.
TypeScript
getLeftMargin(): number;
Retornos
number
getOrientation()
Representa o ângulo para o qual o texto é orientado para o quadro de texto. Confira
ExcelScript.ShapeTextOrientation detalhes.
TypeScript
getOrientation(): ShapeTextOrientation;
Retornos
ExcelScript.ShapeTextOrientation
getReadingOrder()
Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da
direita para a esquerda. Confira ExcelScript.ShapeTextReadingOrder detalhes.
TypeScript
getReadingOrder(): ShapeTextReadingOrder;
Retornos
ExcelScript.ShapeTextReadingOrder
getRightMargin()
Representa margem direita, em pontos, do quadro de texto.
TypeScript
getRightMargin(): number;
Retornos
number
getTextRange()
Representa o texto que está anexado a uma forma, bem como propriedades e
métodos para manipular o texto. Confira ExcelScript.TextRange detalhes.
TypeScript
getTextRange(): TextRange;
Retornos
ExcelScript.TextRange
getTopMargin()
Representa margem superior, em pontos, do quadro de texto.
TypeScript
getTopMargin(): number;
Retornos
number
Representa o alinhamento vertical do quadro de texto. Confira
TypeScript
getVerticalAlignment(): ShapeTextVerticalAlignment;
Retornos
ExcelScript.ShapeTextVerticalAlignment
getVerticalOverflow()
Representa o comportamento de excedente vertical do quadro de texto. Confira
ExcelScript.ShapeTextVerticalOverflow detalhes.
TypeScript
getVerticalOverflow(): ShapeTextVerticalOverflow;
Retornos
ExcelScript.ShapeTextVerticalOverflow
setAutoSizeSetting(autoSizeSetting)
As configurações de dimensionamento automático para o quadro de texto. Um
quadro de texto pode ser configurado para ajustar automaticamente o texto ao
quadro de texto, para ajustar automaticamente o quadro do texto ao texto ou não
executar qualquer dimensionamento automático.
TypeScript
setAutoSizeSetting(autoSizeSetting: ShapeAutoSize): void;
Parâmetros
autoSizeSetting ExcelScript.ShapeAutoSize
Retornos
void
setBottomMargin(bottomMargin)
Representa margem inferior, em pontos, do quadro de texto.
TypeScript
setBottomMargin(bottomMargin: number): void;
Parâmetros
bottomMargin number
Retornos
void
Representa o alinhamento horizontal do quadro de texto. Confira
TypeScript
horizontalAlignment: ShapeTextHorizontalAlignment
): void;
Parâmetros
horizontalAlignment ExcelScript.ShapeTextHorizontalAlignment
Retornos
void
setHorizontalOverflow(horizontalOverflow)
Representa o comportamento de excedente horizontal do quadro de texto. Confira
ExcelScript.ShapeTextHorizontalOverflow detalhes.
TypeScript
setHorizontalOverflow(
horizontalOverflow: ShapeTextHorizontalOverflow
): void;
Parâmetros
horizontalOverflow ExcelScript.ShapeTextHorizontalOverflow
Retornos
void
setLeftMargin(leftMargin)
Representa margem esquerda, em pontos, do quadro de texto.
TypeScript
setLeftMargin(leftMargin: number): void;
Parâmetros
leftMargin number
Retornos
void
setOrientation(orientation)
Representa o ângulo para o qual o texto é orientado para o quadro de texto. Confira
ExcelScript.ShapeTextOrientation detalhes.
TypeScript
setOrientation(orientation: ShapeTextOrientation): void;
Parâmetros
orientation ExcelScript.ShapeTextOrientation
Retornos
void
Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da
direita para a esquerda. Confira ExcelScript.ShapeTextReadingOrder detalhes.
TypeScript
setReadingOrder(readingOrder: ShapeTextReadingOrder): void;
Parâmetros
readingOrder ExcelScript.ShapeTextReadingOrder
Retornos
void
setRightMargin(rightMargin)
Representa margem direita, em pontos, do quadro de texto.
TypeScript
setRightMargin(rightMargin: number): void;
Parâmetros
rightMargin number
Retornos
void
setTopMargin(topMargin)
Representa margem superior, em pontos, do quadro de texto.
TypeScript
setTopMargin(topMargin: number): void;
Parâmetros
topMargin number
Retornos
void
Representa o alinhamento vertical do quadro de texto. Confira
TypeScript
verticalAlignment: ShapeTextVerticalAlignment
): void;
Parâmetros
verticalAlignment ExcelScript.ShapeTextVerticalAlignment
Retornos
void
setVerticalOverflow(verticalOverflow)
Representa o comportamento de excedente vertical do quadro de texto. Confira
ExcelScript.ShapeTextVerticalOverflow detalhes.
TypeScript
setVerticalOverflow(verticalOverflow: ShapeTextVerticalOverflow): void;
Parâmetros
verticalOverflow ExcelScript.ShapeTextVerticalOverflow
Retornos
void
comentários:
ExcelScript.TextRange interface
Referência
Pacote: ExcelScript
Contém o texto que é anexado a uma forma, bem como propriedades e métodos para
manipular o texto.
Comentários
Exemplos
TypeScript
/**
* This script adds text to a shape.
*/
// Create a hexagon shape in the current worksheet.
const hexagon =
sheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
// Set the text of the shape.

const hexText: ExcelScript.TextRange =
hexagon.getTextFrame().getTextRange();
hexText.setText("Forest");
}
Métodos
getFont() Retorna um ShapeFont objeto que representa os atributos de fonte para

o intervalo de texto.
getSubstring(start, Retorna um objeto TextRange para a subcadeia de caracteres no

length) intervalo especificado.
getText() Representa o conteúdo de texto sem formatação do intervalo de texto.
setText(text) Representa o conteúdo de texto sem formatação do intervalo de texto.

Detalhes do método
getFont()
Retorna um ShapeFont objeto que representa os atributos de fonte para o intervalo
de texto.
TypeScript
getFont(): ShapeFont;
Retornos
ExcelScript.ShapeFont
getSubstring(start, length)
Retorna um objeto TextRange para a subcadeia de caracteres no intervalo
especificado.
TypeScript
getSubstring(start: number, length?: number): TextRange;
Parâmetros
start number
O índice baseado em zero do primeiro caractere a ser obtido do intervalo de texto.
length number
Opcional. O número de caracteres a serem retornados no novo intervalo de texto. Se
o comprimento for omitido, todos os caracteres do início ao final do último
parágrafo do intervalo de texto serão retornados.
Retornos
ExcelScript.TextRange
getText()
Representa o conteúdo de texto sem formatação do intervalo de texto.
TypeScript
getText(): string;
Retornos
string
Exemplos
TypeScript
/**
* This script writes all the text from the workbook's geometric shapes
in a new worksheet.
*/
// Create a new worksheet.
const shapeTextSheet = workbook.addWorksheet("ShapeText");
let shapeTextValues: string[][] = [];
// Get the text from every geometric shape in every worksheet.

sheet.getShapes().forEach((shape) => {
if (shape.getType() === ExcelScript.ShapeType.geometricShape)
shapeTextValues.push([
sheet.getName(),
shape.getGeometricShapeType().toString(),
shape.getTextFrame().getTextRange().getText()]);
});
});
// Add the text to the new worksheet.

const range = shapeTextSheet.getRangeByIndexes(
0,
0,
shapeTextValues.length,
shapeTextValues[0].length);
range.setValues(shapeTextValues);
}
setText(text)
Representa o conteúdo de texto sem formatação do intervalo de texto.
TypeScript
Parâmetros
text string
Retornos
void
comentários:
ExcelScript.TimelineStyle interface
Referência
Pacote: ExcelScript
Representa um TimelineStyle , que define elementos de estilo por região no linha do

tempo.
Métodos
delete() Exclui o estilo de tabela.
duplicate() Cria uma duplicata desse estilo linha do tempo com cópias de todos os
getName() Especifica o nome do estilo linha do tempo.
getReadOnly() Especifica se esse TimelineStyle objeto é somente leitura.
set Especifica o nome do estilo linha do tempo.

Name(name)
Detalhes do método
delete()
Exclui o estilo de tabela.
TypeScript
delete(): void;
Retornos
void
duplicate()
Cria uma duplicata desse estilo linha do tempo com cópias de todos os elementos
de estilo.
TypeScript
duplicate(): TimelineStyle;
Retornos
ExcelScript.TimelineStyle
getName()
Especifica o nome do estilo linha do tempo.
TypeScript
getName(): string;
Retornos
string
getReadOnly()
Especifica se esse TimelineStyle objeto é somente leitura.
TypeScript
Retornos
boolean
setName(name)
Especifica o nome do estilo linha do tempo.
TypeScript
Parâmetros
name string
Retornos
void
comentários:
ExcelScript.TopBottomConditional
Format interface
Referência
Pacote: ExcelScript
Representa um formato condicional superior/inferior.
Comentários
Exemplos
TypeScript
/**
* This sample applies conditional formatting to the currently used range in
the worksheet.
* The conditional formatting is a green fill for the top 10% of values.
*/

// Set the fill color to green for the top 10% of values in the range.
conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
rank: 10, /* The percentage threshold. */
type: ExcelScript.ConditionalTopBottomCriterionType.topPercent /* The
});
}
Métodos
get Retorna um objeto de formato, encapsulando a fonte, o preenchimento, as bordas e

Format() outras propriedades do formato condicional.
getRule() Os critérios do formato condicional superior/inferior.
set Os critérios do formato condicional superior/inferior.

Rule(rule)
Detalhes do método
getFormat()
Retorna um objeto de formato, encapsulando a fonte, o preenchimento, as bordas e
outras propriedades do formato condicional.
TypeScript
Retornos
getRule()
Os critérios do formato condicional superior/inferior.
TypeScript
getRule(): ConditionalTopBottomRule;
Retornos
ExcelScript.ConditionalTopBottomRule
setRule(rule)
Os critérios do formato condicional superior/inferior.
TypeScript
setRule(rule: ConditionalTopBottomRule): void;

Parâmetros
rule ExcelScript.ConditionalTopBottomRule
Retornos
void
comentários:
ExcelScript.Workbook interface
Referência
Pacote: ExcelScript
A pasta de trabalho é o objeto de nível superior que contém objetos de pasta de

trabalho relacionados, como planilhas, tabelas e intervalos.
Comentários
Exemplos
TypeScript
/**
* This script adds a new worksheet to the workbook, then switches to it.
*/
// Add a new worksheet with the default name.
let worksheet = workbook.addWorksheet();
// Switch focus to the new worksheet.

worksheet.activate();
}
Métodos
addBinding(range, bindingType, Adiciona uma nova associação a um intervalo específico.

id)
addBindingFromNamed Adiciona uma nova associação com base em um item

Item(name, bindingType, id) nomeado na pasta de trabalho. Se o item nomeado fizer
referência a várias áreas, o InvalidReference erro será
retornado.
addBindingFrom Adiciona uma nova associação com base na seleção atual. Se a

Selection(bindingType, id) seleção tiver várias áreas, o InvalidReference erro será
retornado.
addComment(cellAddress, Cria um novo comentário com o conteúdo fornecido na célula

content, contentType) especificada. Um InvalidArgument erro será gerado se o
intervalo fornecido for maior que uma célula.
addCustomXmlPart(xml) Adiciona uma nova parte XML personalizada à pasta de
trabalho.
addNamedItem(name, Adiciona um novo nome à coleção do escopo fornecido.

reference, comment)
addNamedItemFormula Adiciona um novo nome à coleção de escopo fornecido

Local(name, formula, comment) usando a localidade do usuário para a fórmula.
addPivotTable(name, source, Adicione uma Tabela Dinâmica com base nos dados de origem
destination) especificados e insira-os na célula superior esquerda do
intervalo de destino.
addPivotTableStyle(name, make Cria um em branco PivotTableStyle com o nome

UniqueName) especificado.
addPredefinedCellStyle(name) Adiciona um novo estilo para o conjunto.
addSlicer(slicerSource, source Adiciona uma nova segmentação de dados à pasta de

Field, slicerDestination) trabalho.
addSlicerStyle(name, make Cria um estilo de segmentação em branco com o nome

UniqueName) 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, make Cria um em branco TableStyle com o nome especificado.

UniqueName)
addTimelineStyle(name, make Cria um em branco TimelineStyle com o nome especificado.

UniqueName)
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-a
.activate() .
breakAllLinksToLinked Quebra todos os links para as pastas de trabalho vinculadas.

Workbooks() Depois que os links são quebrados, todas as fórmulas que
referenciam links de pasta de trabalho são totalmente
removidas e substituídas pelos valores recuperados mais
recentemente.
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 um gráfico ativo, esse método retornará
undefined .
getActiveSlicer() Obtém a segmentação de dados ativa no momento na pasta

de trabalho. Se não houver uma segmentação ativa, esse
getActiveWorksheet() Obtém a planilha ativa no momento na pasta de trabalho.
getApplication() Representa a instância de aplicativo do Excel que contém essa

pasta de trabalho.
getAutoSave() Especifica se a pasta de trabalho está no modo AutoSave.
getBinding(id) Obtém um objeto de associação pela ID. Se o objeto de

associação não existir, esse método retornará undefined .
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 acompanharem o índice dos
pontos de dados.
getComment(commentId) 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 .
getCommentByCell(cellAddress) Obtém o comentário da célula especificada. Se não houver

nenhum comentário na célula, um erro será gerado.
getCommentByReplyId(replyId) Obtém o comentário ao qual a resposta determinada 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, esse método retornará undefined .
getCustomXmlPart Obtém uma nova coleção de partes XML personalizadas cujos

ByNamespace(namespaceUri) namespaces correspondem ao namespace fornecido.
getCustomXmlParts() Representa a coleção de partes XML personalizadas contidas

por esta pasta de trabalho.
getCustomXmlParts Obtém uma nova coleção de partes XML personalizadas cujos

ByNamespace(namespaceUri) namespaces correspondem ao namespace fornecido.
getDefaultPivotTableStyle() Obtém o estilo de 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 estilo de tabela padrão para o escopo do objeto pai.
getDefaultTimelineStyle() Obtém o estilo padrão linha do tempo para o escopo do

objeto pai.
getFirstWorksheet(visibleOnly) Obtém a primeira planilha na coleção.
getIsDirty() Especifica se foram feitas alterações desde que a pasta de

trabalho foi salva pela última vez. Você pode definir essa
propriedade como true se quiser fechar uma pasta de
trabalho modificada sem salvá-la ou ser solicitada a salvá-la.
getLastWorksheet(visibleOnly) Obtém a última planilha na coleção.
getLinkedWorkbookByUrl(key) Obtém informações sobre uma pasta de trabalho vinculada

por sua URL. Se a pasta de trabalho não existir, esse método
getLinkedWorkbookRefresh Representa o modo de atualização dos links da pasta de

Mode() trabalho. O modo é o mesmo para todos os links de pasta de
trabalho presentes na pasta de trabalho.
getLinkedWorkbooks() Retorna uma coleção de pastas de trabalho vinculadas. Em

fórmulas, os links da pasta de trabalho podem ser usados para
referenciar dados (valores e nomes de célula) fora da pasta de
trabalho atual.
getName() Obtém o nome da pasta de trabalho.
getNamedItem(name) Obtém um NamedItem objeto usando seu nome. Se o objeto

getNames() Representa uma coleção de itens nomeados com escopo de

pasta de trabalho (intervalos e constantes nomeados).
getPivotTable(name) Obtém uma Tabela Dinâmica por nome. Se a Tabela Dinâmica

getPivotTables() Representa uma coleção de Tabelas Dinâmicas associadas à

pasta de trabalho.
getPivotTableStyle(name) Obtém um PivotTableStyle por nome. Se o PivotTableStyle

getPivotTableStyles() Representa uma coleção de Tabelas Dinâmicas associadas à

pasta de trabalho.
getPredefinedCellStyle(name) Obtém um estilo por nome. Se o objeto style não existir, esse
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 para uma pasta de trabalho.
getQueries() Retorna uma coleção de consultas Power Query que fazem

parte da pasta de trabalho.
getQuery(key) Obtém uma consulta da coleção com base em seu nome.
getReadOnly() Retornará true se a pasta de trabalho estiver aberta no modo

somente leitura.
getSelectedRange() Obtém o intervalo único selecionado atualmente na pasta de

trabalho. Se houver vários intervalos selecionados, esse
método gerará um erro.
getSelectedRanges() Obtém um ou mais intervalos atualmente selecionados da

pasta de trabalho. Ao contrário getSelectedRange() de , esse
método retorna um RangeAreas objeto que representa todos
os intervalos selecionados.
getSlicer(key) Obtém uma segmentação usando seu nome ou ID. Se a

segmentação não existir, esse método retornará undefined .
getSlicers() Representa uma coleção de segmentações associadas à pasta

de trabalho.
getSlicerStyle(name) Obtém um SlicerStyle por nome. Se o estilo de segmentação

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,
getTables() Representa uma coleção de tabelas associadas à pasta de

trabalho.
getTableStyle(name) Obtém um TableStyle por nome. Se o estilo de tabela não

getTableStyles() Representa uma coleção de TableStyles associadas à pasta de
trabalho.
getTimelineStyle(name) Obtém um TimelineStyle por nome. Se o estilo linha do

tempo não existir, esse método retornará undefined .
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
alternar essa propriedade de false para true .
getWorksheet(key) Obtém um objeto de planilha usando o nome ou ID dele. Se a

planilha não existir, esse método retornará undefined .
getWorksheets() Representa uma coleção de planilhas associadas à pasta de

trabalho.
refreshAllDataConnections() Atualiza todas as Conexões de Dados.
refreshAllLinksToLinked Faz uma solicitação para atualizar todos os links da pasta de

Workbooks() trabalho.
refreshAllPivotTables() Atualiza todas as tabelas dinâmicas da coleção.
setChartDataPointTrack(chart True se todos os gráficos na pasta de trabalho estiverem

DataPointTrack) rastreando os pontos de dados reais aos quais eles estão
anexados. False se os gráficos acompanharem o índice dos
pontos de dados.
setDefaultPivotTableStyle(new Define o estilo de Tabela Dinâmica padrão para uso no escopo

DefaultStyle) do objeto pai.
setDefaultSlicerStyle(newDefault Define o estilo de segmentação padrão para uso no escopo do

Style) objeto pai.
setDefaultTableStyle(newDefault Define o estilo de tabela padrão para uso no escopo do objeto

Style) pai.
setDefaultTimelineStyle(new Define o estilo padrão linha do tempo para uso no escopo do

DefaultStyle) objeto pai.
setIsDirty(isDirty) Especifica se foram feitas alterações desde que a pasta de

trabalho foi salva pela última vez. Você pode definir essa
propriedade como true se quiser fechar uma pasta de
trabalho modificada sem salvá-la ou ser solicitada a salvá-la.
setLinkedWorkbookRefresh Representa o modo de atualização dos links da pasta de

Mode(linkedWorkbookRefresh trabalho. O modo é o mesmo para todos os links de pasta de
Mode) trabalho presentes na pasta de trabalho.
setUsePrecisionAsDisplayed(use True se os cálculos dessa pasta de trabalho forem efetuados

PrecisionAsDisplayed) usando apenas a precisão dos números conforme forem
exibidos. Os dados perderão permanentemente a precisão ao
alternar essa propriedade de false para true .
Detalhes do método
addBinding(range, bindingType, id)

Adiciona uma nova associação a um intervalo específico.
TypeScript
addBinding(
range: Range | string,
bindingType: BindingType,
id: string
): Binding;
Parâmetros
range ExcelScript.Range | string
Intervalo para vincular a associação. Pode ser um Range objeto ou uma cadeia de
caracteres. Se for uma cadeia de caracteres, deve conter o endereço completo,
incluindo o nome da planilha
bindingType ExcelScript.BindingType
Tipo de associação. Consulte ExcelScript.BindingType .
id string
Nome da associação.
Retornos
ExcelScript.Binding
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 InvalidReference erro
será retornado.
TypeScript
addBindingFromNamedItem(
name: string,
bindingType: BindingType,
id: string
): Binding;
Parâmetros
name string
Nome do qual deseja criar a associação.
id string
Retornos
ExcelScript.Binding
addBindingFromSelection(bindingType, id)
Adiciona uma nova associação com base na seleção atual. Se a seleção tiver várias
áreas, o InvalidReference erro será retornado.
TypeScript
addBindingFromSelection(bindingType: BindingType, id: string): Binding;
Parâmetros
id string
Retornos
ExcelScript.Binding
addComment(cellAddress, content, contentType)

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 que uma célula.
TypeScript
addComment(
cellAddress: Range | string,
): Comment;
Parâmetros
cellAddress ExcelScript.Range | string
A célula à qual o comentário é adicionado. Isso pode ser um Range objeto 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á gerado se o

O conteúdo do comentário. Isso pode ser uma cadeia de caracteres ou
CommentRichContent um objeto. Cadeias de caracteres são usadas para texto simples.
CommentRichContent objetos permitem outros recursos de comentário, como
menções.
ContentType.Plain .
Retornos
ExcelScript.Comment
addCustomXmlPart(xml)
Adiciona uma nova parte XML personalizada à pasta de trabalho.
TypeScript
addCustomXmlPart(xml: string): CustomXmlPart;
Parâmetros
xml string
Conteúdo XML. Deve ser um fragmento XML válido.
Retornos
ExcelScript.CustomXmlPart
addNamedItem(name, reference, comment)

Adiciona um novo nome à coleção do escopo fornecido.
TypeScript
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 nomeado.
Retornos
ExcelScript.NamedItem
Exemplos
TypeScript
/**
* This script creates a named formula and uses it in another part of the
workbook.
*/
// Create a named item for a formula.
// This formula is the sum of the cells F2:F21 on Sheet1.
const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
"GrandTotal",
"=SUM(Sheet1!$F$2:$F$21)",
"The sum of table sums."
);
// Add this named formula to a new sheet in the workbook.

const otherSheet = workbook.addWorksheet();
otherSheet.getRange("A1").setFormula(namedItem.getFormula());

otherSheet.activate();
}
addNamedItemFormulaLocal(name, formula, comment)

Adiciona um novo nome à coleção de escopo fornecido usando a localidade do
usuário para a fórmula.
TypeScript
addNamedItemFormulaLocal(
name: string,
formula: string,
comment?: string
): NamedItem;
Parâmetros
name string
formula string
A fórmula na localidade do usuário à qual o nome se referirá.
comment string
Retornos
addPivotTable(name, source, destination)

Adicione uma Tabela Dinâmica com base nos dados de origem especificados e
insira-os na célula superior esquerda do intervalo de destino.
TypeScript
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 de caracteres, incluindo o nome da planilha) 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
TypeScript
/**
an existing worksheet.
* It also assumes there is a worksheet named "PivotSheet".
*/
let pivotTable = workbook.addPivotTable("My Pivot", table,
"PivotSheet!A1");

}
addPivotTableStyle(name, makeUniqueName)
Cria um em branco PivotTableStyle com o nome especificado.
TypeScript
addPivotTableStyle(
name: string,
makeUniqueName?: boolean
): PivotTableStyle;
Parâmetros
name string
O nome exclusivo para o novo estilo de Tabela Dinâmica. Gerará um
InvalidArgument erro se o nome já estiver em uso.
makeUniqueName boolean
Opcional. Padrão para false . Se true , adicionará números ao nome para torná-lo
exclusivo, se necessário.
Retornos
addPredefinedCellStyle(name)
Adiciona um novo estilo para o conjunto.
TypeScript
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.
TypeScript
addSlicer(
slicerSource: string | PivotTable | Table,
sourceField: string | PivotField | number | TableColumn,
slicerDestination?: string | Worksheet
): Slicer;
Parâmetros
slicerSource string | ExcelScript.PivotTable | ExcelScript.Table
A fonte de dados na qual a nova segmentação será baseada. Pode ser um
PivotTable objeto, um Table objeto ou uma cadeia de caracteres. Quando um
objeto PivotTable é passado, a fonte de dados é a fonte do PivotTable objeto.

Quando um Table objeto é passado, a fonte de dados é o Table objeto. Quando
uma cadeia de caracteres é passada, ela é interpretada como o nome ou a ID de
uma tabela ou tabela dinâmica.
sourceField string | ExcelScript.PivotField | number | ExcelScript.TableColumn

O campo na fonte de dados a ser filtrado. Pode ser um PivotField objeto, um
TableColumn objeto, a ID de um PivotField ou o nome ou ID de um TableColumn .
slicerDestination string | ExcelScript.Worksheet

Opcional. A planilha na qual a nova segmentação será criada. Pode ser um
Worksheet objeto ou o nome ou ID de uma planilha. Esse parâmetro poderá ser
omitido se a coleção slicer for recuperada de uma planilha.
Retornos
ExcelScript.Slicer
Exemplos
TypeScript
/**
* This script adds a slicer for an existing PivotTable.
*/
// Get the PivotTable named "Farm Pivot".
const farmPivot = workbook.getPivotTable("Farm Pivot");

PivotTable.
const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
farmPivot, /* The table or PivotTale to be sliced. */
farmPivot.getHierarchy("Type").getFields()[0] /* What source field to
use as the slicer options. */
);

fruitSlicer.selectItems(["Lemon", "Lime"]);

fruitSlicer.setLeft(400);
}
addSlicerStyle(name, makeUniqueName)
Cria um estilo de segmentação em branco com o nome especificado.
TypeScript
addSlicerStyle(name: string, makeUniqueName?: boolean): SlicerStyle;
Parâmetros
name string
O nome exclusivo para o novo estilo de segmentação. Gerará uma exceção
InvalidArgument se o nome já estiver em uso.
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.
TypeScript
addTable(address: Range | string, hasHeaders: boolean): Table;
Parâmetros
address ExcelScript.Range | string
Um Range objeto ou um endereço de cadeia de caracteres ou um nome do 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
Um valor booliano que indica se os dados importados têm rótulos de coluna. Se a
origem não contiver cabeçalhos (ou seja, quando essa propriedade definida como
false ), o Excel gerará automaticamente um cabeçalho e deslocará os dados para
baixo por uma linha.
Retornos
ExcelScript.Table
Exemplos
TypeScript
/**
* This sample converts the information in the first worksheet
* into a table with headers.
*/
// This assumes there is one contiguous range in the first worksheet.
const dataRange = workbook.getFirstWorksheet().getUsedRange();
// Add a table at the workbook level.

workbook.addTable(dataRange.getAddress(), true);
}
addTableStyle(name, makeUniqueName)
Cria um em branco TableStyle com o nome especificado.
TypeScript
addTableStyle(name: string, makeUniqueName?: boolean): TableStyle;
Parâmetros
name string
O nome exclusivo para o novo estilo de tabela. Gerará um InvalidArgument erro se o
nome já estiver em uso.
Retornos
addTimelineStyle(name, makeUniqueName)
Cria um em branco TimelineStyle com o nome especificado.
TypeScript
addTimelineStyle(name: string, makeUniqueName?: boolean): TimelineStyle;

Parâmetros
name string
O nome exclusivo do novo estilo linha do tempo. Gerará um InvalidArgument erro se
o nome já estiver em uso.
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-a
.activate() .
TypeScript
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
Exemplos
TypeScript
/**
* This script adds a new worksheet named "Data" to the workbook.
* If a worksheet with that name already exists, the script logs a note.
*/
// Check if the "Data" worksheet already exists.
if (workbook.getWorksheet("Data")) {
console.log("The Data worksheet is already in the workbook.");
} else {
// Add a new worksheet.
let worksheet = workbook.addWorksheet("Data");
}
}
breakAllLinksToLinkedWorkbooks()
Quebra todos os links para as pastas de trabalho vinculadas. Depois que os links são
quebrados, todas as fórmulas que referenciam links de pasta de trabalho são
totalmente removidas e substituídas pelos valores recuperados mais recentemente.
TypeScript
breakAllLinksToLinkedWorkbooks(): void;
Retornos
void
getActiveCell()
Obtém a célula ativa no momento da pasta de trabalho.
TypeScript
getActiveCell(): Range;
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This script logs the value of the current active cell.
* If multiple cells are selected, the top-leftmost cell will be logged.
*/
// 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 um gráfico
ativo, esse método retornará undefined .
TypeScript
getActiveChart(): Chart;
Retornos
ExcelScript.Chart
getActiveSlicer()
Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não
houver uma segmentação ativa, esse método retornará undefined .
TypeScript
getActiveSlicer(): Slicer;
Retornos
ExcelScript.Slicer
getActiveWorksheet()
Obtém a planilha ativa no momento na pasta de trabalho.
TypeScript
getActiveWorksheet(): Worksheet;
Retornos
getApplication()
Representa a instância de aplicativo do Excel que contém essa pasta de trabalho.
TypeScript
getApplication(): Application;
Retornos
ExcelScript.Application
getAutoSave()
Especifica se a pasta de trabalho está no modo AutoSave.
TypeScript
getAutoSave(): boolean;
Retornos
boolean
getBinding(id)
Obtém um objeto de associação pela ID. Se o objeto de associação não existir, esse
TypeScript
getBinding(id: string): Binding | undefined;
Parâmetros
id string
ID do objeto Binding a recuperar.
Retornos
ExcelScript.Binding | undefined
getBindings()
Representa uma coleção de ligações que fazem parte da pasta de trabalho.
TypeScript
getBindings(): Binding[];
Retornos
ExcelScript.Binding[]
getCalculationEngineVersion()
Retorna um número sobre a versão do Mecanismo de Cálculo do Excel.
TypeScript
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 acompanharem o
índice dos pontos de dados.
TypeScript
getChartDataPointTrack(): boolean;
Retornos
boolean
getComment(commentId)
Obtém um comentário da coleção com base em seu ID. Se o objeto de comentário
TypeScript
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 houver nenhum comentário na
célula, um erro será gerado.
TypeScript
getCommentByCell(cellAddress: Range | string): Comment;
Parâmetros
A célula na qual o comentário está. Isso pode ser um Range objeto 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á gerado se o intervalo
fornecido for maior que uma célula.
Retornos
ExcelScript.Comment
getCommentByReplyId(replyId)
Obtém o comentário ao qual a resposta determinada está conectada.
TypeScript
getCommentByReplyId(replyId: string): Comment;
Parâmetros
replyId string
Retornos
ExcelScript.Comment
getComments()
Representa uma coleção de comentários associados à pasta de trabalho.
TypeScript
getComments(): Comment[];
Retornos
ExcelScript.Comment[]
getCustomXmlPart(id)
Obtém uma parte XML personalizada com base em sua ID. Se o CustomXmlPart não
TypeScript
getCustomXmlPart(id: string): CustomXmlPart | undefined;
Parâmetros
id string
ID do objeto a ser recuperado.
Retornos
ExcelScript.CustomXmlPart | undefined
getCustomXmlPartByNamespace(namespaceUri)
２ Aviso
Essa API foi preterida.
Use getCustomXmlPartsByNamespace instead.
Obtém uma nova coleção de partes XML personalizadas cujos namespaces

correspondem ao namespace fornecido.
TypeScript
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
ExcelScript.CustomXmlPart[]
getCustomXmlParts()
Representa a coleção de partes XML personalizadas contidas por esta pasta de
trabalho.
TypeScript
getCustomXmlParts(): CustomXmlPart[];
Retornos
getCustomXmlPartsByNamespace(namespaceUri)
Obtém uma nova coleção de partes XML personalizadas cujos namespaces
correspondem ao namespace fornecido.
TypeScript
getCustomXmlPartsByNamespace(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
getDefaultPivotTableStyle()
Obtém o estilo de Tabela Dinâmica padrão para o escopo do objeto pai.
TypeScript
getDefaultPivotTableStyle(): PivotTableStyle;
Retornos
getDefaultSlicerStyle()
Obtém o padrão SlicerStyle para o escopo do objeto pai.
TypeScript
getDefaultSlicerStyle(): SlicerStyle;
Retornos
getDefaultTableStyle()
Obtém o estilo de tabela padrão para o escopo do objeto pai.
TypeScript
getDefaultTableStyle(): TableStyle;
Retornos
getDefaultTimelineStyle()
Obtém o estilo padrão linha do tempo para o escopo do objeto pai.
TypeScript
getDefaultTimelineStyle(): TimelineStyle;
Retornos
getFirstWorksheet(visibleOnly)
Obtém a primeira planilha na coleção.
TypeScript
getFirstWorksheet(visibleOnly?: boolean): Worksheet;
Parâmetros
visibleOnly boolean
Opcional. Se true , considerar apenas planilhas visíveis, ignorando todas as ocultas.
Retornos
getIsDirty()
Especifica se foram feitas alterações desde que a pasta de trabalho foi salva pela
última vez. Você pode definir essa propriedade como true se quiser fechar uma
pasta de trabalho modificada sem salvá-la ou ser solicitada a salvá-la.
TypeScript
getIsDirty(): boolean;
Retornos
boolean
getLastWorksheet(visibleOnly)
Obtém a última planilha na coleção.
TypeScript
getLastWorksheet(visibleOnly?: boolean): Worksheet;
Parâmetros
visibleOnly boolean
Retornos
getLinkedWorkbookByUrl(key)
Obtém informações sobre uma pasta de trabalho vinculada por sua URL. Se a pasta
de trabalho não existir, esse método retornará undefined .
TypeScript
getLinkedWorkbookByUrl(key: string): LinkedWorkbook | undefined;

Parâmetros
key string
A URL da pasta de trabalho vinculada.
Retornos
ExcelScript.LinkedWorkbook | undefined
getLinkedWorkbookRefreshMode()
Representa o modo de atualização dos links da pasta de trabalho. O modo é o
mesmo para todos os links de pasta de trabalho presentes na pasta de trabalho.
TypeScript
getLinkedWorkbookRefreshMode(): WorkbookLinksRefreshMode;
Retornos
ExcelScript.WorkbookLinksRefreshMode
Exemplos
TypeScript
/**
* This script refreshes all the links to external workbooks,
* if the linked workbook refresh mode is set to manual.
* To learn about linked workbooks, see
https://support.microsoft.com/office/create-an-external-reference-link-
to-a-cell-range-in-another-workbook-c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
*/
// Check the refresh mode.
if (workbook.getLinkedWorkbookRefreshMode() ===
ExcelScript.WorkbookLinksRefreshMode.manual) {
console.log("Refreshing workbook links");
// Trigger a refresh of linked workbook content.

workbook.refreshAllLinksToLinkedWorkbooks();
}
}
getLinkedWorkbooks()
Retorna uma coleção de pastas de trabalho vinculadas. Em fórmulas, os links da
pasta de trabalho podem ser usados para referenciar dados (valores e nomes de
célula) fora da pasta de trabalho atual.
TypeScript
getLinkedWorkbooks(): LinkedWorkbook[];
Retornos
ExcelScript.LinkedWorkbook[]
getName()
Obtém o nome da pasta de trabalho.
TypeScript
getName(): string;
Retornos
string
Exemplos
TypeScript
/**
* This script logs the name of the workbook without the ".xlsx"
extension.
*/
// Get the workbook's name.
let name = workbook.getName();
// Remove the file extension.

name = name.substring(0, name.lastIndexOf(".xlsx"));
// Display the name in the console.

console.log(name);
}
getNamedItem(name)
Obtém um NamedItem objeto usando seu nome. Se o objeto não existir, esse método
TypeScript
getNamedItem(name: string): NamedItem | undefined;
Parâmetros
name string
Nome nameditem.
Retornos
ExcelScript.NamedItem | undefined
getNames()
Representa uma coleção de itens nomeados com escopo de pasta de trabalho
(intervalos e constantes nomeados).
TypeScript
getNames(): NamedItem[];
Retornos
ExcelScript.NamedItem[]
Exemplos
TypeScript
/**
*/
formula).
}
}
});
}
getPivotTable(name)
Obtém uma Tabela Dinâmica por nome. Se a Tabela Dinâmica não existir, esse
TypeScript
getPivotTable(name: string): PivotTable | undefined;
Parâmetros
name string
Nome da Tabela Dinâmica a ser recuperada.
Retornos
ExcelScript.PivotTable | undefined
getPivotTables()
Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.
TypeScript
getPivotTables(): PivotTable[];
Retornos
getPivotTableStyle(name)
Obtém um PivotTableStyle por nome. Se o PivotTableStyle não existir, esse
TypeScript
getPivotTableStyle(name: string): PivotTableStyle | undefined;
Parâmetros
name string
Nome do estilo tabela dinâmica a ser recuperado.
Retornos
ExcelScript.PivotTableStyle | undefined
getPivotTableStyles()
Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.
TypeScript
getPivotTableStyles(): PivotTableStyle[];
Retornos
ExcelScript.PivotTableStyle[]
getPredefinedCellStyle(name)
Obtém um estilo por nome. Se o objeto style não existir, esse método retornará
undefined .
TypeScript
getPredefinedCellStyle(name: string): PredefinedCellStyle | undefined;
Parâmetros
name string
Nome do estilo a ser recuperado.
Retornos
ExcelScript.PredefinedCellStyle | undefined
getPredefinedCellStyles()
Representa uma coleção de estilos associados à pasta de trabalho.
TypeScript
getPredefinedCellStyles(): PredefinedCellStyle[];
Retornos
ExcelScript.PredefinedCellStyle[]
getPreviouslySaved()
Especifica se a pasta de trabalho já foi salva localmente ou online.
TypeScript
getPreviouslySaved(): boolean;
Retornos
boolean
getProperties()
Obtém as propriedades da pasta de trabalho.
TypeScript
getProperties(): DocumentProperties;
Retornos
ExcelScript.DocumentProperties
getProtection()
Retorna o objeto de proteção para uma pasta de trabalho.
TypeScript
getProtection(): WorkbookProtection;
Retornos
ExcelScript.WorkbookProtection
getQueries()
Retorna uma coleção de consultas Power Query que fazem parte da pasta de
trabalho.
TypeScript
getQueries(): Query[];
Retornos
ExcelScript.Query[]
getQuery(key)
Obtém uma consulta da coleção com base em seu nome.
TypeScript
getQuery(key: string): Query;
Parâmetros
key string
O nome do caso de consulta insensibilidade de caso.
Retornos
ExcelScript.Query
getReadOnly()
Retornará true se a pasta de trabalho estiver aberta no modo somente leitura.
TypeScript
Retornos
boolean
getSelectedRange()
Obtém o intervalo único selecionado atualmente na pasta de trabalho. Se houver
vários intervalos selecionados, esse método gerará um erro.
TypeScript
getSelectedRange(): Range;
Retornos
ExcelScript.Range
getSelectedRanges()
Obtém um ou mais intervalos atualmente selecionados da pasta de trabalho. Ao
contrário getSelectedRange() de , esse método retorna um RangeAreas objeto que
representa todos os intervalos selecionados.
TypeScript
getSelectedRanges(): RangeAreas;
Retornos
getSlicer(key)
Obtém uma segmentação usando seu nome ou ID. Se a segmentação não existir,
TypeScript
getSlicer(key: string): Slicer | undefined;
Parâmetros
key string
Nome ou ID da segmentação a ser recuperada.
Retornos
ExcelScript.Slicer | undefined
getSlicers()
Representa uma coleção de segmentações associadas à pasta de trabalho.
TypeScript
getSlicers(): Slicer[];
Retornos
ExcelScript.Slicer[]
getSlicerStyle(name)
Obtém um SlicerStyle por nome. Se o estilo de segmentação não existir, esse
TypeScript
getSlicerStyle(name: string): SlicerStyle | undefined;
Parâmetros
name string
Nome do estilo de segmentação a ser recuperado.
Retornos
ExcelScript.SlicerStyle | undefined
getSlicerStyles()
Representa uma coleção de SlicerStyles associados à pasta de trabalho.
TypeScript
getSlicerStyles(): SlicerStyle[];
Retornos
ExcelScript.SlicerStyle[]
getTable(key)
Obtém uma tabela pelo nome ou ID. Se a tabela não existir, esse método retornará
undefined .
TypeScript
getTable(key: string): Table | undefined;
Parâmetros
key string
Nome ou ID da tabela a ser recuperada.
Retornos
ExcelScript.Table | undefined
getTables()
Representa uma coleção de tabelas associadas à pasta de trabalho.
TypeScript
getTables(): Table[];
Retornos
ExcelScript.Table[]
getTableStyle(name)
Obtém um TableStyle por nome. Se o estilo de tabela não existir, esse método
TypeScript
getTableStyle(name: string): TableStyle | undefined;
Parâmetros
name string
Nome do estilo de tabela a ser recuperado.
Retornos
ExcelScript.TableStyle | undefined
getTableStyles()
Representa uma coleção de TableStyles associadas à pasta de trabalho.
TypeScript
getTableStyles(): TableStyle[];
Retornos
ExcelScript.TableStyle[]
getTimelineStyle(name)
Obtém um TimelineStyle por nome. Se o estilo linha do tempo não existir, esse
TypeScript
getTimelineStyle(name: string): TimelineStyle | undefined;
Parâmetros
name string
Nome do estilo linha do tempo a ser recuperado.
Retornos
ExcelScript.TimelineStyle | undefined
getTimelineStyles()
Representa uma coleção de TimelineStyles associados à pasta de trabalho.
TypeScript
getTimelineStyles(): TimelineStyle[];
Retornos
ExcelScript.TimelineStyle[]
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 alternar essa propriedade de false para true .
TypeScript
getUsePrecisionAsDisplayed(): boolean;
Retornos
boolean
getWorksheet(key)
Obtém um objeto de planilha usando o nome ou ID dele. Se a planilha não existir,
TypeScript
getWorksheet(key: string): Worksheet | undefined;
Parâmetros
key string
O nome ou ID da planilha.
Retornos
ExcelScript.Worksheet | undefined
Exemplos
TypeScript
/**
* This script switches the active view to a worksheet named "Data", if
it exists.
*/
// 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.`);
}
}
getWorksheets()
Representa uma coleção de planilhas associadas à pasta de trabalho.
TypeScript
getWorksheets(): Worksheet[];
Retornos
ExcelScript.Worksheet[]
Exemplos
TypeScript
/**
* This script logs the names of all the worksheets in the 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.
TypeScript
refreshAllDataConnections(): void;
Retornos
void
refreshAllLinksToLinkedWorkbooks()
Faz uma solicitação para atualizar todos os links da pasta de trabalho.
TypeScript
refreshAllLinksToLinkedWorkbooks(): void;
Retornos
void
refreshAllPivotTables()
Atualiza todas as tabelas dinâmicas da coleção.
TypeScript
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 acompanharem o
índice dos pontos de dados.
TypeScript
setChartDataPointTrack(chartDataPointTrack: boolean): void;
Parâmetros
chartDataPointTrack boolean
Retornos
void
setDefaultPivotTableStyle(newDefaultStyle)
Define o estilo de Tabela Dinâmica padrão para uso no escopo do objeto pai.
TypeScript
setDefaultPivotTableStyle(
newDefaultStyle: PivotTableStyle | string
): void;
Parâmetros
newDefaultStyle ExcelScript.PivotTableStyle | string
O PivotTableStyle objeto, ou nome do PivotTableStyle objeto, que deve ser o
novo padrão.
Retornos
void
setDefaultSlicerStyle(newDefaultStyle)
Define o estilo de segmentação padrão para uso no escopo do objeto pai.
TypeScript
setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;
Parâmetros
newDefaultStyle ExcelScript.SlicerStyle | string
O SlicerStyle objeto, ou nome do SlicerStyle objeto, que deve ser o novo
padrão.
Retornos
void
setDefaultTableStyle(newDefaultStyle)
Define o estilo de tabela padrão para uso no escopo do objeto pai.
TypeScript
setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;
Parâmetros
newDefaultStyle ExcelScript.TableStyle | string
O TableStyle objeto, ou nome do TableStyle objeto, que deve ser o novo padrão.
Retornos
void
setDefaultTimelineStyle(newDefaultStyle)
Define o estilo padrão linha do tempo para uso no escopo do objeto pai.
TypeScript
setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;
Parâmetros
newDefaultStyle ExcelScript.TimelineStyle | string
O TimelineStyle objeto, ou nome do TimelineStyle objeto, que deve ser o novo
padrão.
Retornos
void
setIsDirty(isDirty)
Especifica se foram feitas alterações desde que a pasta de trabalho foi salva pela
última vez. Você pode definir essa propriedade como true se quiser fechar uma
pasta de trabalho modificada sem salvá-la ou ser solicitada a salvá-la.
TypeScript
setIsDirty(isDirty: boolean): void;
Parâmetros
isDirty boolean
Retornos
void
setLinkedWorkbookRefreshMode(linkedWorkbook
RefreshMode)
Representa o modo de atualização dos links da pasta de trabalho. O modo é o
mesmo para todos os links de pasta de trabalho presentes na pasta de trabalho.
TypeScript
setLinkedWorkbookRefreshMode(
linkedWorkbookRefreshMode: WorkbookLinksRefreshMode
): void;
Parâmetros
linkedWorkbookRefreshMode ExcelScript.WorkbookLinksRefreshMode
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 alternar essa propriedade de false para true .
TypeScript
setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;
Parâmetros
usePrecisionAsDisplayed boolean
Retornos
void
ExcelScript.WorkbookProtection
interface
Referência
Pacote: ExcelScript
Representa a proteção de um objeto de pasta de trabalho.
Métodos
getProtected() Especifica se a pasta de trabalho está protegida.
protect(password) Protege uma pasta de trabalho. Falhará se a pasta de trabalho estiver

protegida.
unprotect(password) Desprotege uma pasta de trabalho.
Detalhes do método
getProtected()
Especifica se a pasta de trabalho está protegida.
TypeScript
getProtected(): boolean;
Retornos
boolean
protect(password)
Protege uma pasta de trabalho. Falhará se a pasta de trabalho estiver protegida.
TypeScript
protect(password?: string): void;
Parâmetros
password string
Senha de proteção de pasta de trabalho.
Retornos
void
unprotect(password)
Desprotege uma pasta de trabalho.
TypeScript
unprotect(password?: string): void;
Parâmetros
password string
Senha de proteção de pasta de trabalho.
Retornos
void
comentários:
ExcelScript.WorkbookRangeAreas
interface
Referência
Pacote: ExcelScript
Representa uma coleção de um ou mais intervalos retangulares em várias planilhas.
Métodos
getAddresses() Retorna uma matriz de endereços no estilo A1. Os valores de endereço

contêm o nome da planilha para cada bloco retangular de células (por
exemplo, "Sheet1! A1:B4, Sheet1! D1:D4"). Somente leitura.
getAreas() Retorna o RangeAreasCollection objeto. Cada RangeAreas um na coleção

representa um ou mais intervalos de retângulo em uma planilha.
getRangeAreas Retorna o RangeAreas objeto com base no nome da planilha ou na ID da

BySheet(key) coleção. Se a planilha não existir, esse método retornará undefined .
getRanges() Retorna intervalos que compõem esse objeto em um RangeCollection objeto.
Detalhes do método
getAddresses()
Retorna uma matriz de endereços no estilo A1. Os valores de endereço contêm o
nome da planilha para cada bloco retangular de células (por exemplo, "Sheet1!
A1:B4, Sheet1! D1:D4"). Somente leitura.
TypeScript
getAddresses(): string[];
Retornos
string[]
getAreas()
Retorna o RangeAreasCollection objeto. Cada RangeAreas um na coleção representa
um ou mais intervalos de retângulo em uma planilha.
TypeScript
getAreas(): RangeAreas[];
Retornos
ExcelScript.RangeAreas[]
getRangeAreasBySheet(key)
Retorna o RangeAreas objeto com base no nome da planilha ou na ID da coleção. Se
a planilha não existir, esse método retornará undefined .
TypeScript
getRangeAreasBySheet(key: string): RangeAreas;
Parâmetros
key string
O nome ou ID da planilha.
Retornos
getRanges()
Retorna intervalos que compõem esse objeto em um RangeCollection objeto.
TypeScript
getRanges(): Range[];
Retornos
ExcelScript.Range[]
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
TypeScript
/**
* This script creates a new worksheet named "Plum" and sets its tab color
to purple.
*/
const newSheet = workbook.addWorksheet("Plum")
newSheet.setTabColor("purple");
}
Métodos
activate() Ative a planilha na interface do usuário do Excel.
addChart(type, source Cria um novo gráfico.

Data, seriesBy)
addComment(cell Cria um novo comentário com o conteúdo fornecido na célula

Address, content, content especificada. Um InvalidArgument erro será gerado se o intervalo
Type) fornecido for maior que uma célula.
addGeometric Adiciona uma forma geométrica à planilha. Retorna um Shape objeto

Shape(geometricShape que representa a nova forma.
Type)
addGroup(values) Um subconjunto de formas na planilha do conjunto de grupos.

Retorna um Shape objeto que representa o novo grupo de formas.
addHorizontalPage Adiciona uma quebra de página antes da célula superior esquerda do
Break(pageBreakRange) intervalo especificado.
addImage(base64Image Cria uma imagem de uma cadeia de caracteres na base 64 e a

String) adiciona à planilha. Retorna o Shape objeto que representa a nova
imagem.
addLine(startLeft, start Adiciona uma linha à planilha. Retorna um Shape objeto que
Top, endLeft, endTop, representa a nova linha.
connectorType)
addNamedItem(name, Adiciona um novo nome à coleção do escopo fornecido.

reference, comment)
addNamedItemFormula Adiciona um novo nome à coleção de escopo fornecido usando a

Local(name, formula, localidade do usuário para a fórmula.
comment)
addNamedSheet Cria uma nova exibição de planilha com o nome fornecido.

View(name)
addPivotTable(name, Adicione uma Tabela Dinâmica com base nos dados de origem
source, destination) especificados e insira-os na célula superior esquerda do intervalo de
destino.
addSlicer(slicerSource, Adiciona uma nova segmentação de dados à pasta de trabalho.

sourceField, slicer
Destination)
addTable(address, has Cria uma nova tabela. O objeto de intervalo ou endereço de origem
Headers) 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. Retorna um Shape objeto que representa a nova caixa de
texto.
addVerticalPage Adiciona uma quebra de página antes da célula superior esquerda do

Break(pageBreakRange) intervalo especificado.
addWorksheetCustom Adiciona uma nova propriedade personalizada que mapeia para a

Property(key, value) chave fornecida. Isso substitui as propriedades personalizadas
existentes com essa chave.
calculate(markAllDirty) Calcula todas as células em uma planilha.
copy(positionType, Copia uma planilha e a coloca na posição especificada.

relativeTo)
delete() Exclui a planilha da pasta de trabalho. Observe que, se a visibilidade

da planilha estiver definida como "VeryHidden", a operação de
exclusão falhará com uma exceção InvalidOperation . Primeiro, você
deve alterar sua visibilidade para oculta ou visível antes de excluí-la.
enterTemporaryNamed Cria e ativa uma nova exibição de planilha temporária. As exibições

SheetView() 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 temporária da planilha também pode ser
acessada com a cadeia de caracteres vazia (""), se a exibição
temporária existir.
exitActiveNamedSheet Sai do modo de exibição da planilha ativa no momento.

View()
findAll(text, criteria) Localiza todas as ocorrências da cadeia de caracteres determinada

com base nos critérios especificados e as retorna como um
RangeAreas objeto, compreendendo um ou mais intervalos
retangulares.
getActiveNamedSheet Obtém a exibição da planilha ativa atualmente.

View()
getAutoFilter() Representa o AutoFilter objeto da planilha.
getCell(row, column) Obtém o Range objeto que contém a célula única 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.
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, esse método retornará undefined .
getCharts() Retorna uma coleção de gráficos que fazem parte da planilha.
getComment(comment Obtém um comentário da coleção com base em seu ID. Se o objeto

Id) de comentário não existir, esse método retornará undefined .
getCommentByCell(cell Obtém o comentário da célula especificada. Se não houver nenhum

Address) comentário na célula, um erro será gerado.
getCommentByReply Obtém o comentário ao qual a resposta determinada está conectada.

Id(replyId)
getComments() Retorna um conjunto de todos os objetos Comments na planilha.
getCustomProperties() Obtém uma coleção de propriedades personalizadas no nível da

planilha.
getEnableCalculation() Determina se o Excel deve recalcular a planilha quando necessário.

True se o Excel recalcular a planilha quando necessário. False se o
Excel não recalcular a planilha.
getFreezePanes() Obtém um objeto que pode ser usado para manipular painéis
congelados na planilha.
getHorizontalPage Obtém a coleção de quebra de página horizontal da planilha. Esta

Breaks() 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.
getNamedItem(name) Obtém um NamedItem objeto usando seu nome. Se o objeto não

getNamedSheetView(key) 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á undefined .
getNamedSheetViews() Retorna uma coleção de exibições de planilha que estão presentes na

planilha.
getNames() Coleção de nomes com escopo para a planilha atual.
getNext(visibleOnly) Obtém a planilha que segue esta. Se não houver planilhas seguindo
esta, esse método retornará undefined .
getPageLayout() Obtém o PageLayout objeto da planilha.
getPivotTable(name) Obtém uma Tabela Dinâmica por nome. Se a Tabela Dinâmica não
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 planilha que precede essa. Se não houver planilhas

anteriores, esse método retornará undefined .
getProtection() Retorna o objeto de proteção de planilha para uma planilha.
getRange(address) Obtém o Range objeto, representando um único bloco retangular de

células, especificado pelo endereço ou nome.
getRangeByIndexes(start Obtém o Range objeto começando em um índice de linha específico

Row, startColumn, row e índice de coluna e abrangendo um determinado número de linhas
Count, columnCount) e colunas.
getRanges(address) Obtém o RangeAreas objeto, que representa um ou mais blocos de

intervalos retangulares, especificados pelo endereço ou nome.
getShape(key) Obtém uma forma usando seu nome ou ID. Se o objeto shape não
getShapes() Retorna a coleção de todos os objetos Shape na planilha.
getShowGridlines() Especifica se as linhas de grade estão visíveis para o usuário.
getShowHeadings() Especifica se os títulos estão visíveis para o usuário.
getSlicer(key) Obtém uma segmentação usando seu nome ou ID. Se a

segmentação não existir, esse método retornará undefined .
getSlicers() Retorna uma coleção de segmentações que fazem parte da planilha.
getStandardHeight() Retorna a altura padrão de todas as linhas na planilha, em pontos.
getStandardWidth() 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).
getTabColor() 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 formulário #RRGGBB (por exemplo,
"FFA500"). Ao definir a cor, use uma cadeia de caracteres vazia para
definir uma cor "automática" ou uma cor real caso contrário.
getTabId() Retorna um valor que representa essa planilha que pode ser lido pelo
Open Office XML. Esse é um valor inteiro, que é diferente de
worksheet.id (que retorna um identificador globalmente exclusivo) e
worksheet.name (que retorna um valor como "Sheet1").
getTable(key) Obtém uma tabela pelo nome ou ID. Se a tabela não existir, esse
getTables() Coleção de tabelas que fazem parte da planilha.
getUsedRange(values
Only)
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.
getWorksheetCustom Obtém um objeto de propriedade personalizada por sua chave, que

Property(key) diferencia maiúsculas de minúsculas. Se a propriedade personalizada
refreshAllPivotTables() Atualiza todas as tabelas dinâmicas da coleção.
removeAllHorizontalPage Redefine todas as quebras de página manuais na coleção.

Breaks()
removeAllVerticalPage Redefine todas as quebras de página manuais na coleção.

Breaks()
replaceAll(text, Localiza e substitui a cadeia de caracteres fornecida com base nos

replacement, criteria) critérios especificados na planilha atual.
setEnable Determina se o Excel deve recalcular a planilha quando necessário.

Calculation(enable True se o Excel recalcular a planilha quando necessário. False se o
Calculation) Excel não recalcular a planilha.
setName(name) O nome de exibição da planilha.
setPosition(position) A posição baseada em zero da planilha na pasta de trabalho.
setShowGridlines(show Especifica se as linhas de grade estão visíveis para o usuário.

Gridlines)
setShowHeadings(show Especifica se os títulos estão visíveis para o usuário.

Headings)
setStandard Especifica a largura padrão (padrão) de todas as colunas na planilha.

Width(standardWidth) 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 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 formulário #RRGGBB (por exemplo,
"FFA500"). Ao definir a cor, use uma cadeia de caracteres vazia para
definir uma cor "automática" ou uma cor real caso contrário.
setVisibility(visibility) A visibilidade da planilha.
showOutlineLevels(row Mostra grupos de linhas ou colunas pelos níveis de contorno.

Levels, columnLevels) Descreve grupos e resume uma lista de dados na planilha. Os
rowLevels parâmetros e columnLevels especificam quantos níveis do
contorno 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.
Detalhes do método
activate()
Ative a planilha na interface do usuário do Excel.
TypeScript
activate(): void;
Retornos
void
Exemplos
TypeScript
/**
* This script switches the active view to a worksheet named "Data", if
it exists.
*/
// 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.
TypeScript
addChart(
type: ChartType,
sourceData: Range,
seriesBy?: ChartSeriesBy
): Chart;
Parâmetros
type ExcelScript.ChartType
Representa o tipo de um gráfico. Confira ExcelScript.ChartType detalhes.
seriesBy ExcelScript.ChartSeriesBy
Opcional. Especifica a forma como as colunas ou linhas são usadas como série de
dados no gráfico. Confira ExcelScript.ChartSeriesBy detalhes.
Retornos
ExcelScript.Chart
Exemplos
TypeScript
/**
worksheet's data.
*/


let chart =
selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);

}
addComment(cellAddress, content, contentType)

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 que uma célula.
TypeScript
addComment(
cellAddress: Range | string,
): Comment;
Parâmetros
A célula à qual o comentário é adicionado. Isso pode ser um Range objeto 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á gerado se o

O conteúdo do comentário. Isso pode ser uma cadeia de caracteres ou
CommentRichContent um objeto. Cadeias de caracteres são usadas para texto simples.
CommentRichContent objetos permitem outros recursos de comentário, como
menções.
ContentType.Plain .
Retornos
ExcelScript.Comment
addGeometricShape(geometricShapeType)
Adiciona uma forma geométrica à planilha. Retorna um Shape objeto que representa
a nova forma.
TypeScript
addGeometricShape(geometricShapeType: GeometricShapeType): Shape;
Parâmetros
geometricShapeType ExcelScript.GeometricShapeType
Representa o tipo da forma geométrica. Confira ExcelScript.GeometricShapeType
detalhes.
Retornos
ExcelScript.Shape
Exemplos
TypeScript
/**
*/


}
addGroup(values)
Um subconjunto de formas na planilha do conjunto de grupos. Retorna um Shape
objeto que representa o novo grupo de formas.
TypeScript
addGroup(values: Array<string | Shape>): Shape;
Parâmetros
values Array<string | ExcelScript.Shape>
Uma matriz de IDs de forma ou objetos de forma.
Retornos
ExcelScript.Shape
addHorizontalPageBreak(pageBreakRange)
Adiciona uma quebra de página antes da célula superior esquerda do intervalo
especificado.
TypeScript
addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;
Parâmetros
pageBreakRange ExcelScript.Range | string
O intervalo imediatamente após a quebra de página a ser adicionado.
Retornos
addImage(base64ImageString)
Cria uma imagem de uma cadeia de caracteres na base 64 e a adiciona à planilha.
Retorna o Shape objeto que representa a nova imagem.
TypeScript
addImage(base64ImageString: string): Shape;
Parâmetros
base64ImageString string
Uma cadeia de caracteres codificada base64 que representa uma imagem no
formato JPEG ou PNG.
Retornos
ExcelScript.Shape
Exemplos
TypeScript
/**
* 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, connector

Type)
Adiciona uma linha à planilha. Retorna um Shape objeto que representa a nova linha.
TypeScript
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é o lado esquerdo da planilha.
startTop number
A distância, em pontos, do início da linha até a parte superior da planilha.
endLeft number
A distância, em pontos, do final da linha à esquerda da planilha.
endTop number
A distância, em pontos, do final da linha até a parte superior da planilha.
connectorType ExcelScript.ConnectorType
Representa o tipo de conector. Confira ExcelScript.ConnectorType detalhes.
Retornos
ExcelScript.Shape
addNamedItem(name, reference, comment)

Adiciona um novo nome à coleção do escopo fornecido.
TypeScript
addNamedItem(
name: string,
reference: Range | string,
comment?: string
): NamedItem;
Parâmetros
name string
reference ExcelScript.Range | string
A fórmula ou o intervalo ao qual o nome fará referência.
comment string
Retornos
addNamedItemFormulaLocal(name, formula, comment)

Adiciona um novo nome à coleção de escopo fornecido usando a localidade do
usuário para a fórmula.
TypeScript
addNamedItemFormulaLocal(
name: string,
formula: string,
comment?: string
): NamedItem;
Parâmetros
name string
formula string
A fórmula na localidade do usuário à qual o nome se referirá.
comment string
Retornos
addNamedSheetView(name)
Cria uma nova exibição de planilha com o nome fornecido.
TypeScript
addNamedSheetView(name: string): NamedSheetView;
Parâmetros
name string
O nome da exibição da planilha a ser criada. Lança um erro quando o nome
fornecido já existe, está vazio ou é um nome reservado pela planilha.
Retornos
addPivotTable(name, source, destination)

Adicione uma Tabela Dinâmica com base nos dados de origem especificados e
insira-os na célula superior esquerda do intervalo de destino.
TypeScript
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 de caracteres, incluindo o nome da planilha) 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
TypeScript
/**
a new worksheet.
*/



newSheet.activate();
}
addSlicer(slicerSource, sourceField, slicerDestination)

Adiciona uma nova segmentação de dados à pasta de trabalho.
TypeScript
addSlicer(
slicerSource: string | PivotTable | Table,
sourceField: string | PivotField | number | TableColumn,
slicerDestination?: string | Worksheet
): Slicer;
Parâmetros
slicerSource string | ExcelScript.PivotTable | ExcelScript.Table
A fonte de dados na qual a nova segmentação será baseada. Pode ser um
PivotTable objeto, um Table objeto ou uma cadeia de caracteres. Quando um
objeto PivotTable é passado, a fonte de dados é a fonte do PivotTable objeto.
Quando um Table objeto é passado, a fonte de dados é o Table objeto. Quando
uma cadeia de caracteres é passada, ela é interpretada como o nome ou a ID de
uma tabela ou tabela dinâmica.
sourceField string | ExcelScript.PivotField | number | ExcelScript.TableColumn

O campo na fonte de dados a ser filtrado. Pode ser um PivotField objeto, um
TableColumn objeto, a ID de um PivotField ou o nome ou ID de um TableColumn .
slicerDestination string | ExcelScript.Worksheet

Opcional. A planilha na qual a nova segmentação será criada. Pode ser um
Worksheet objeto ou o nome ou ID de uma planilha. Esse parâmetro poderá ser
omitido se a coleção slicer for recuperada de uma planilha.
Retornos
ExcelScript.Slicer
Exemplos
TypeScript
/**
* This script adds a slicer for an existing PivotTable on the current
worksheet.
*/
// Get the first PivotTable from the current worksheet.
const pivot = currentSheet.getPivotTables()[0];

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

slicer.selectItems(["Lemon", "Lime"]);

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.
TypeScript
addTable(address: Range | string, hasHeaders: boolean): Table;
Parâmetros
address ExcelScript.Range | string
Um Range objeto ou um endereço de cadeia de caracteres ou um nome do 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
Um valor booliano que indica se os dados importados têm rótulos de coluna. Se a
origem não contiver cabeçalhos (ou seja, quando essa propriedade definida como
false ), o Excel gerará automaticamente um cabeçalho e deslocará os dados para
baixo por uma linha.
Retornos
ExcelScript.Table
Exemplos
TypeScript
/**
* This sample creates a table from the current worksheet's used range,
then sorts it based on the first column.
*/
// 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.
Retorna um Shape objeto que representa a nova caixa de texto.
TypeScript
addTextBox(text?: string): Shape;
Parâmetros
text string
Representa o texto que será mostrado 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.
TypeScript
addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;
Parâmetros
pageBreakRange ExcelScript.Range | string
O intervalo imediatamente após a quebra de página a ser adicionado.
Retornos
addWorksheetCustomProperty(key, value)
Adiciona uma nova propriedade personalizada que mapeia para a chave fornecida.
Isso substitui as propriedades personalizadas existentes com essa chave.
TypeScript
addWorksheetCustomProperty(
key: string,
value: string
): WorksheetCustomProperty;
Parâmetros
key string
A chave que identifica o objeto de propriedade personalizado. É insensível a casos. A
chave é limitada a 255 caracteres (valores maiores farão com que um
InvalidArgument erro seja gerado.)
value string
O valor dessa propriedade personalizada.
Retornos
ExcelScript.WorksheetCustomProperty
calculate(markAllDirty)
Calcula todas as células em uma planilha.
TypeScript
calculate(markAllDirty: boolean): void;
Parâmetros
markAllDirty boolean
True, para marcar tudo como sujo.
Retornos
void
copy(positionType, relativeTo)
Copia uma planilha e a coloca na posição especificada.
TypeScript
copy(
positionType?: WorksheetPositionType,
relativeTo?: Worksheet
): Worksheet;
Parâmetros
positionType ExcelScript.WorksheetPositionType
O local na pasta de trabalho para colocar a planilha recém-criada. O valor padrão é
"Nenhum", que insere a planilha no início da planilha.
relativeTo ExcelScript.Worksheet
A planilha existente que determina a posição da planilha recém-criada. Isso só será
necessário se positionType for "Antes" ou "Depois".
Retornos
Exemplos
TypeScript
/**
* This script duplicates a worksheet named "Template".
* The new worksheet is added after the template.
*/
// 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. Observe que, se a visibilidade da planilha
estiver definida como "VeryHidden", a operação de exclusão falhará com uma
exceção InvalidOperation . Primeiro, você deve alterar sua visibilidade para oculta
ou visível antes de excluí-la.
TypeScript
delete(): void;
Retornos
void
Exemplos
TypeScript
/**
* The following scripts removes the first worksheet in the workbook.
*/
// Get the first worksheet.
let sheet = workbook.getWorksheets()[0];
// Remove that worksheet from the workbook.

sheet.delete();
}
enterTemporaryNamedSheetView()
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 temporária da planilha
também pode ser acessada com a cadeia de caracteres vazia (""), se a exibição
temporária existir.
TypeScript
enterTemporaryNamedSheetView(): NamedSheetView;
Retornos
exitActiveNamedSheetView()
Sai do modo de exibição da planilha ativa no momento.
TypeScript
exitActiveNamedSheetView(): void;
Retornos
void
findAll(text, criteria)
Localiza todas as ocorrências da cadeia de caracteres determinada com base nos
critérios especificados e as retorna como um RangeAreas objeto, compreendendo
um ou mais intervalos retangulares.
TypeScript
findAll(text: string, criteria: WorksheetSearchCriteria): RangeAreas;
Parâmetros
text string
A cadeia de caracteres a ser encontrada.
criteria ExcelScript.WorksheetSearchCriteria
Critérios de pesquisa adicionais, incluindo se a pesquisa precisa corresponder a toda
a célula ou ser sensível a casos.
Retornos
Exemplos
TypeScript
/**
* This script searches through a worksheet and finds cells containing
"No".
* Those cells are filled red.
* Use Range.find instead of Worksheet.findAll when you want to limit the
search to a specific range.
*/
let noCells = worksheet.findAll("No", { completeMatch: true });
// Set the fill color to red.

noCells.getFormat().getFill().setColor("red");
}
getActiveNamedSheetView()
Obtém a exibição da planilha ativa atualmente.
TypeScript
getActiveNamedSheetView(): NamedSheetView;
Retornos
getAutoFilter()
Representa o AutoFilter objeto da planilha.
TypeScript
getAutoFilter(): AutoFilter;
Retornos
ExcelScript.AutoFilter
Exemplos
TypeScript
/**
* 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).
*/
// 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 célula única 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.
TypeScript
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, esse
TypeScript
getChart(name: string): Chart | undefined;
Parâmetros
name string
Nome do gráfico a recuperar.
Retornos
ExcelScript.Chart | undefined
Exemplos
TypeScript
/**
* This sample moves an existing chart to a specific place on the
worksheet.
*/
// Get an existing chart named "ColumnChart".

let chart = selectedSheet.getChart("ColumnChart");
// Place the chart over the range "F1:L13".

chart.setPosition("F1", "L13");
}
getCharts()
Retorna uma coleção de gráficos que fazem parte da planilha.
TypeScript
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
TypeScript
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 houver nenhum comentário na
célula, um erro será gerado.
TypeScript
getCommentByCell(cellAddress: Range | string): Comment;
Parâmetros
A célula na qual o comentário está. Isso pode ser um Range objeto 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á gerado se o intervalo
fornecido for maior que uma célula.
Retornos
ExcelScript.Comment
getCommentByReplyId(replyId)
Obtém o comentário ao qual a resposta determinada está conectada.
TypeScript
getCommentByReplyId(replyId: string): Comment;
Parâmetros
replyId string
Retornos
ExcelScript.Comment
getComments()
Retorna um conjunto de todos os objetos Comments na planilha.
TypeScript
getComments(): Comment[];
Retornos
ExcelScript.Comment[]
getCustomProperties()
Obtém uma coleção de propriedades personalizadas no nível da planilha.
TypeScript
getCustomProperties(): WorksheetCustomProperty[];
Retornos
ExcelScript.WorksheetCustomProperty[]
getEnableCalculation()
Determina se o Excel deve recalcular a planilha quando necessário. True se o Excel
recalcular a planilha quando necessário. False se o Excel não recalcular a planilha.
TypeScript
getEnableCalculation(): boolean;
Retornos
boolean
getFreezePanes()
Obtém um objeto que pode ser usado para manipular painéis congelados na
planilha.
TypeScript
getFreezePanes(): WorksheetFreezePanes;
Retornos
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.
TypeScript
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.
TypeScript
getId(): string;
Retornos
string
getName()
O nome de exibição da planilha.
TypeScript
getName(): string;
Retornos
string
Exemplos
TypeScript
/**
* This sample gets all the worksheet names in the workbook.
* It then logs those names to the console.
*/
// 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 usando seu nome. Se o objeto não existir, esse método
TypeScript
getNamedItem(name: string): NamedItem | undefined;
Parâmetros
name string
Nome nameditem.
Retornos
ExcelScript.NamedItem | undefined
getNamedSheetView(key)
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á undefined .
TypeScript
getNamedSheetView(key: string): NamedSheetView | undefined;
Parâmetros
key string
O nome sensível a maiúsculas de maiúsculas e minúsculas do modo de exibição da
planilha. Use a cadeia de caracteres vazia ("") para obter a exibição temporária da
planilha, se a exibição temporária existir.
Retornos
ExcelScript.NamedSheetView | undefined
getNamedSheetViews()
Retorna uma coleção de exibições de planilha que estão presentes na planilha.
TypeScript
getNamedSheetViews(): NamedSheetView[];
Retornos
ExcelScript.NamedSheetView[]
getNames()
Coleção de nomes com escopo para a planilha atual.
TypeScript
getNames(): NamedItem[];
Retornos
ExcelScript.NamedItem[]
getNext(visibleOnly)
Obtém a planilha que segue esta. Se não houver planilhas seguindo esta, esse
TypeScript
getNext(visibleOnly?: boolean): Worksheet;
Parâmetros
visibleOnly boolean
Retornos
getPageLayout()
Obtém o PageLayout objeto da planilha.
TypeScript
getPageLayout(): PageLayout;
Retornos
ExcelScript.PageLayout
Exemplos
TypeScript
/**
*/

});
}
getPivotTable(name)
Obtém uma Tabela Dinâmica por nome. Se a Tabela Dinâmica não existir, esse
TypeScript
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.
TypeScript
getPivotTables(): PivotTable[];
Retornos
getPosition()
A posição baseada em zero da planilha na pasta de trabalho.
TypeScript
Retornos
number
getPrevious(visibleOnly)
Obtém a planilha que precede essa. Se não houver planilhas anteriores, esse método
TypeScript
getPrevious(visibleOnly?: boolean): Worksheet;
Parâmetros
visibleOnly boolean
Retornos
getProtection()
Retorna o objeto de proteção de planilha para uma planilha.
TypeScript
getProtection(): WorksheetProtection;
Retornos
ExcelScript.WorksheetProtection
Exemplos
TypeScript
/**
* This script protects cells from being selected on the current
worksheet.
*/
// Create a new WorksheetProtectionOptions object with the

selectionMode property set to `none`.
}

}
getRange(address)
Obtém o Range objeto, representando um único bloco retangular de células,
especificado pelo endereço ou nome.
TypeScript
getRange(address?: string): Range;

Parâmetros
address string
Opcional. A cadeia de caracteres que representa o endereço ou o nome do intervalo.
Por exemplo, "A1:B2". Caso não seja especificado, todo o intervalo da planilha será
retornado.
Retornos
ExcelScript.Range
Exemplos
TypeScript
/**
* This sample reads the value of A1 and prints it to the console.
*/
// 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 começando em um índice de linha específico e índice de
coluna e abrangendo um determinado número de linhas e colunas.
TypeScript
getRangeByIndexes(
startRow: number,
startColumn: number,
rowCount: number,
columnCount: number
): Range;
Parâmetros
startRow number
Linha inicial (indexada a zero).
startColumn number
Coluna Iniciar (indexada a zero).
rowCount number
Número de linhas a serem incluídas no intervalo.
columnCount number
Número de colunas a serem incluídas no intervalo.
Retornos
ExcelScript.Range
getRanges(address)
Obtém o RangeAreas objeto, que representa um ou mais blocos de intervalos
retangulares, especificados pelo endereço ou nome.
TypeScript
getRanges(address?: string): RangeAreas;
Parâmetros
address string
Opcional. Uma cadeia de caracteres que contém os endereços separados por vírgula
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, um RangeAreas objeto
para toda a planilha será retornado.
Retornos
getShape(key)
Obtém uma forma usando seu nome ou ID. Se o objeto shape não existir, esse
TypeScript
getShape(key: string): Shape | undefined;
Parâmetros
key string
O nome ou a ID da forma a ser recuperada.
Retornos
ExcelScript.Shape | undefined
getShapes()
Retorna a coleção de todos os objetos Shape na planilha.
TypeScript
getShapes(): Shape[];
Retornos
ExcelScript.Shape[]
getShowGridlines()
Especifica se as linhas de grade estão visíveis para o usuário.
TypeScript
getShowGridlines(): boolean;
Retornos
boolean
getShowHeadings()
Especifica se os títulos estão visíveis para o usuário.
TypeScript
getShowHeadings(): boolean;
Retornos
boolean
getSlicer(key)
Obtém uma segmentação usando seu nome ou ID. Se a segmentação não existir,
TypeScript
getSlicer(key: string): Slicer | undefined;
Parâmetros
key string
Nome ou ID da segmentação a ser recuperada.
Retornos
ExcelScript.Slicer | undefined
getSlicers()
Retorna uma coleção de segmentações que fazem parte da planilha.
TypeScript
getSlicers(): Slicer[];
Retornos
ExcelScript.Slicer[]
getStandardHeight()
Retorna a altura padrão de todas as linhas na planilha, em pontos.
TypeScript
getStandardHeight(): number;
Retornos
number
getStandardWidth()
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).
TypeScript
getStandardWidth(): number;
Retornos
number
getTabColor()
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 formulário #RRGGBB (por exemplo,
"FFA500"). Ao definir a cor, use uma cadeia de caracteres vazia para definir uma cor
"automática" ou uma cor real caso contrário.
TypeScript
getTabColor(): string;
Retornos
string
getTabId()
Retorna um valor que representa essa planilha que pode ser lido pelo Open Office
XML. Esse é um valor inteiro, que é diferente de worksheet.id (que retorna um
identificador globalmente exclusivo) e worksheet.name (que retorna um valor como
"Sheet1").
TypeScript
getTabId(): number;
Retornos
number
getTable(key)
Obtém uma tabela pelo nome ou ID. Se a tabela não existir, esse método retornará
undefined .
TypeScript
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.
TypeScript
getTables(): Table[];
Retornos
ExcelScript.Table[]
getUsedRange(valuesOnly)
TypeScript
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.
TypeScript
getVerticalPageBreaks(): PageBreak[];
Retornos
ExcelScript.PageBreak[]
getVisibility()
A visibilidade da planilha.
TypeScript
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, esse método
TypeScript
getWorksheetCustomProperty(
key: string
): WorksheetCustomProperty | undefined;
Parâmetros
key string
A chave que identifica o objeto de propriedade personalizado. É insensível a casos.
Retornos
ExcelScript.WorksheetCustomProperty | undefined
refreshAllPivotTables()
Atualiza todas as tabelas dinâmicas da coleção.
TypeScript
refreshAllPivotTables(): void;
Retornos
void
removeAllHorizontalPageBreaks()
Redefine todas as quebras de página manuais na coleção.
TypeScript
removeAllHorizontalPageBreaks(): void;
Retornos
void
removeAllVerticalPageBreaks()
Redefine todas as quebras de página manuais na coleção.
TypeScript
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.
TypeScript
replaceAll(
text: string,
replacement: string,
criteria: ReplaceCriteria
): number;
Parâmetros
text string
Cadeia de caracteres a ser encontrada.
replacement string
A cadeia de caracteres que substitui a cadeia de caracteres original.
criteria ExcelScript.ReplaceCriteria
Critérios de substituição adicionais.
Retornos
number
setEnableCalculation(enableCalculation)
Determina se o Excel deve recalcular a planilha quando necessário. True se o Excel
recalcular a planilha quando necessário. False se o Excel não recalcular a planilha.
TypeScript
setEnableCalculation(enableCalculation: boolean): void;
Parâmetros
enableCalculation boolean
Retornos
void
setName(name)
O nome de exibição da planilha.
TypeScript
Parâmetros
name string
Retornos
void
Exemplos
TypeScript
/**
* This sample renames a worksheet from "Sheet1" to "SALES".
*/
// 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.
TypeScript
Parâmetros
position number
Retornos
void
Exemplos
TypeScript
/**
* This sample sets the worksheet named "SALES" as the first sheet in the
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 grade estão visíveis para o usuário.
TypeScript
setShowGridlines(showGridlines: boolean): void;
Parâmetros
showGridlines boolean
Retornos
void
setShowHeadings(showHeadings)
Especifica se os títulos estão visíveis para o usuário.
TypeScript
setShowHeadings(showHeadings: boolean): void;
Parâmetros
showHeadings boolean
Retornos
void
setStandardWidth(standardWidth)
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).
TypeScript
setStandardWidth(standardWidth: number): void;
Parâmetros
standardWidth number
Retornos
void
setTabColor(tabColor)
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 formulário #RRGGBB (por exemplo,
"FFA500"). Ao definir a cor, use uma cadeia de caracteres vazia para definir uma cor
"automática" ou uma cor real caso contrário.
TypeScript
setTabColor(tabColor: string): void;
Parâmetros
tabColor string
Retornos
void
Exemplos
TypeScript
/**
* This script sets the tab color of every worksheet in the workbook to
red.
*/
// 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.
TypeScript
setVisibility(visibility: SheetVisibility): void;
Parâmetros
visibility ExcelScript.SheetVisibility
Retornos
void
Exemplos
TypeScript
/**
* This script unhides all the worksheets in the 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 níveis de contorno. Descreve grupos e
resume uma lista de dados na planilha. Os rowLevels parâmetros e columnLevels
especificam quantos níveis do contorno 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.
TypeScript
showOutlineLevels(rowLevels: number, columnLevels: number): void;

Parâmetros
rowLevels number
O número de níveis de linha de um contorno a ser exibido.
columnLevels number
O número de níveis de coluna de um contorno a ser exibido.
Retornos
void
comentários:
ExcelScript.WorksheetCustomProperty
interface
Referência
Pacote: ExcelScript
Representa uma propriedade personalizada no nível da planilha.
Métodos
delete() Exclui a propriedade personalizada.
getKey() Obtém a chave da propriedade personalizada. As chaves de propriedade

personalizadas não são maiúsculas de maiúsculas de minúsculas. A chave é
limitada a 255 caracteres (valores maiores farão com que um InvalidArgument erro
seja gerado.)
getValue() Obtém ou define o valor da propriedade personalizada.
set Obtém ou define o valor da propriedade personalizada.

Value(value)
Detalhes do método
delete()
Exclui a propriedade personalizada.
TypeScript
delete(): void;
Retornos
void
getKey()
Obtém a chave da propriedade personalizada. As chaves de propriedade
personalizadas não são maiúsculas de maiúsculas de minúsculas. A chave é limitada
a 255 caracteres (valores maiores farão com que um InvalidArgument erro seja
gerado.)
TypeScript
getKey(): string;
Retornos
string
getValue()
Obtém ou define o valor da propriedade personalizada.
TypeScript
getValue(): string;
Retornos
string
setValue(value)
Obtém ou define o valor da propriedade personalizada.
TypeScript
setValue(value: string): void;
Parâmetros
value string
Retornos
void
comentários:
interface
Referência
Pacote: ExcelScript
Métodos
freezeAt(frozen Define as células congeladas no modo de exibição da planilha ativa. O

Range) intervalo fornecido corresponde às células que serão congeladas no painel
superior e esquerdo.
freeze Congele a primeira coluna ou colunas da planilha no local.

Columns(count)
freeze Congele a linha superior ou as linhas da planilha no local.

Rows(count)
getLocation() Obtém um intervalo que descreve as células congeladas no modo de exibição

da planilha ativa. O intervalo congelado corresponde às células congeladas
no painel superior e esquerdo. Se não houver nenhum painel congelado, esse
unfreeze() Remove todos os painéis congelados na planilha.
Detalhes do método
freezeAt(frozenRange)
Define as células congeladas no modo de exibição da planilha ativa. O intervalo
fornecido corresponde às células que serão congeladas no painel superior e
esquerdo.
TypeScript
freezeAt(frozenRange: Range | string): void;
Parâmetros
frozenRange ExcelScript.Range | string
Um intervalo que representa as células a serem congeladas ou null para remover
todos os painéis congelados.
Retornos
void
freezeColumns(count)
Congele a primeira coluna ou colunas da planilha no local.
TypeScript
freezeColumns(count?: number): void;
Parâmetros
count number
Número opcional de colunas para congelar ou zero para descongelar todas as
colunas
Retornos
void
freezeRows(count)
Congele a linha superior ou as linhas da planilha no local.
TypeScript
freezeRows(count?: number): void;
Parâmetros
count number
Número opcional de linhas para congelar ou zero para descongelar todas as linhas
Retornos
void
getLocation()
Obtém um intervalo que descreve as células congeladas no modo de exibição da
planilha ativa. O intervalo congelado corresponde às células congeladas no painel
superior e esquerdo. Se não houver nenhum painel congelado, esse método
TypeScript
Retornos
ExcelScript.Range
unfreeze()
Remove todos os painéis congelados na planilha.
TypeScript
unfreeze(): void;
Retornos
void
comentários:
ExcelScript.WorksheetProtection
interface
Referência
Pacote: ExcelScript
Representa a proteção de um objeto de planilha.
Métodos
addAllowEdit Adiciona um AllowEditRange objeto à planilha. A proteção de planilha

Range(title, range deve ser desabilitada ou pausada para que esse método funcione
Address, options) corretamente. Se a proteção de planilha estiver habilitada e não
pausada, esse método gerará um AccessDenied erro e a operação de
adição falhará.
check Especifica se a senha pode ser usada para desbloquear a proteção de

Password(password) planilha. Esse método não altera o estado de proteção de planilha. Se
uma senha for inserida, mas nenhuma senha for necessária para
desbloquear a proteção de planilha, esse método retornará false.
getAllowEdit Obtém o AllowEditRange objeto pelo título.

Range(key)
getAllowEditRanges() Especifica o AllowEditRangeCollection objeto encontrado nesta

planilha. Essa é uma coleção de AllowEditRange objetos, que funcionam
com propriedades de proteção de planilha. Quando a proteção de
planilha está habilitada, um AllowEditRange objeto pode ser usado para
permitir a edição de um intervalo específico, mantendo a proteção no
restante da planilha.
getCanPause Especifica se a proteção pode ser pausada para esta planilha.

Protection()
getIsPassword Especifica se a planilha é protegida por senha.

Protected()
getIsPaused() Especifica se a proteção de planilha está pausada.
getOptions() Especifica as opções de proteção para a planilha.
getProtected() Especifica se a planilha está protegida.

getSavedOptions() Especifica as opções de proteção salvas na planilha. Isso retornará o
mesmo WorksheetProtectionOptions objeto, independentemente do
estado de proteção da planilha.
pause Pausa a proteção de planilha para o objeto de planilha fornecido para o

Protection(password) usuário na sessão atual. Esse método não faz nada se a proteção de
planilha não estiver habilitada ou já estiver pausada. Se a senha estiver
incorreta, esse método gera um InvalidArgument erro e falha ao pausar
a proteção. Esse método não alterará o estado de proteção se a
proteção de planilha não estiver habilitada ou já estiver pausada.
pauseProtectionForAll Pausa a proteção de planilha para todos os AllowEditRange objetos

AllowEdit encontrados nesta planilha que têm a senha fornecida para o usuário
Ranges(password) na sessão atual. Esse método não faz nada se a proteção de planilha
não estiver habilitada ou for pausada. Se a proteção de planilha não
puder ser pausada, esse método gerará um UnsupportedOperation erro
e falhará em pausar a proteção para o intervalo. Se a senha não
corresponder a nenhum AllowEditRange objeto na coleção, esse
método gerará um BadPassword erro e falhará em pausar a proteção
para qualquer intervalo na coleção.
protect(options, Protege uma planilha. Falhará se a planilha já tiver sido protegida.

password)
resumeProtection() Retoma a proteção de planilha para o objeto de planilha fornecido para

o usuário em uma determinada sessão. A proteção de planilha deve ser
pausada para que esse método funcione. Se a proteção de planilha não
for pausada, esse método não alterará o estado de proteção da
planilha.
setPassword(password) Altera a senha associada ao WorksheetProtection objeto. Definir a

senha como uma cadeia de caracteres vazia ("") ou como null
removerá a proteção de senha do WorksheetProtection objeto. A
proteção de planilha deve ser habilitada e pausada para que esse
método funcione corretamente. Se a proteção de planilha estiver
desabilitada, esse método gerará um InvalidOperation erro e não
alterará a senha. Se a proteção de planilha estiver habilitada e não
pausada, esse método gerará um AccessDenied erro e não alterará a
senha.
unprotect(password) Desprotege uma planilha.
update Altere as opções de proteção de planilha associadas ao

Options(options) WorksheetProtection objeto. A proteção de planilha deve ser
desabilitada ou pausada para que esse método funcione corretamente.
Se a proteção de planilha estiver habilitada e não pausada, esse método
gerará um AccessDenied erro e não alterará as opções de proteção de
planilha.
Detalhes do método
addAllowEditRange(title, rangeAddress, options)

Adiciona um AllowEditRange objeto à planilha. A proteção de planilha deve ser
desabilitada ou pausada para que esse método funcione corretamente. Se a
proteção de planilha estiver habilitada e não pausada, esse método gerará um
AccessDenied erro e a operação de adição falhará.
TypeScript
addAllowEditRange(
title: string,
rangeAddress: string,
options?: AllowEditRangeOptions
): void;
Parâmetros
title string
A cadeia de caracteres de título do objeto a AllowEditRange ser adicionado.
rangeAddress string
O endereço de intervalo do objeto a AllowEditRange ser adicionado.
options ExcelScript.AllowEditRangeOptions
Opções adicionais a serem adicionadas ao AllowEditRange objeto, como a senha.
Retornos
void
checkPassword(password)
Especifica se a senha pode ser usada para desbloquear a proteção de planilha. Esse
método não altera o estado de proteção de planilha. Se uma senha for inserida, mas
nenhuma senha for necessária para desbloquear a proteção de planilha, esse
método retornará false.
TypeScript
checkPassword(password?: string): boolean;
Parâmetros
password string
A senha a ser marcar na planilha protegida.
Retornos
boolean
getAllowEditRange(key)
Obtém o AllowEditRange objeto pelo título.
TypeScript
getAllowEditRange(key: string): AllowEditRange | undefined;
Parâmetros
key string
O título do AllowEditRange .
Retornos
ExcelScript.AllowEditRange | undefined
getAllowEditRanges()
Especifica o AllowEditRangeCollection objeto encontrado nesta planilha. Essa é uma
coleção de AllowEditRange objetos, que funcionam com propriedades de proteção
de planilha. Quando a proteção de planilha está habilitada, um AllowEditRange
objeto pode ser usado para permitir a edição de um intervalo específico, mantendo
a proteção no restante da planilha.
TypeScript
getAllowEditRanges(): AllowEditRange[];
Retornos
ExcelScript.AllowEditRange[]
getCanPauseProtection()
Especifica se a proteção pode ser pausada para esta planilha.
TypeScript
getCanPauseProtection(): boolean;
Retornos
boolean
getIsPasswordProtected()
Especifica se a planilha é protegida por senha.
TypeScript
getIsPasswordProtected(): boolean;
Retornos
boolean
getIsPaused()
Especifica se a proteção de planilha está pausada.
TypeScript
getIsPaused(): boolean;
Retornos
boolean
getOptions()
Especifica as opções de proteção para a planilha.
TypeScript
getOptions(): WorksheetProtectionOptions;
Retornos
ExcelScript.WorksheetProtectionOptions
getProtected()
Especifica se a planilha está protegida.
TypeScript
getProtected(): boolean;
Retornos
boolean
getSavedOptions()
Especifica as opções de proteção salvas na planilha. Isso retornará o mesmo
WorksheetProtectionOptions objeto, independentemente do estado de proteção da
planilha.
TypeScript
getSavedOptions(): WorksheetProtectionOptions;
Retornos
pauseProtection(password)
Pausa a proteção de planilha para o objeto de planilha fornecido para o usuário na
sessão atual. Esse método não faz nada se a proteção de planilha não estiver
habilitada ou já estiver pausada. Se a senha estiver incorreta, esse método gera um
InvalidArgument erro e falha ao pausar a proteção. Esse método não alterará o
estado de proteção se a proteção de planilha não estiver habilitada ou já estiver

pausada.
TypeScript
pauseProtection(password?: string): void;
Parâmetros
password string
A senha associada à planilha protegida.
Retornos
void
pauseProtectionForAllAllowEditRanges(password)
Pausa a proteção de planilha para todos os AllowEditRange objetos encontrados
nesta planilha que têm a senha fornecida para o usuário na sessão atual. Esse
método não faz nada se a proteção de planilha não estiver habilitada ou for
pausada. Se a proteção de planilha não puder ser pausada, esse método gerará um
UnsupportedOperation erro e falhará em pausar a proteção para o intervalo. Se a
senha não corresponder a nenhum AllowEditRange objeto na coleção, esse método

gerará um BadPassword erro e falhará em pausar a proteção para qualquer intervalo
na coleção.
TypeScript
pauseProtectionForAllAllowEditRanges(password: string): void;
Parâmetros
password string
A senha para pausar a proteção nos AllowEditRange objetos.
Retornos
void
protect(options, password)
Protege uma planilha. Falhará se a planilha já tiver sido protegida.
TypeScript
protect(options?: WorksheetProtectionOptions, password?: string): void;
Parâmetros
options ExcelScript.WorksheetProtectionOptions
Opcional. Opções de proteção da planilha.
password string
Opcional. Senha de proteção de planilha.
Retornos
void
Exemplos
TypeScript
/**
* This script protects cells from being selected on the current
worksheet.
*/
// Create a new WorksheetProtectionOptions object with the

selectionMode property set to `none`.
}

}
resumeProtection()
Retoma a proteção de planilha para o objeto de planilha fornecido para o usuário
em uma determinada sessão. A proteção de planilha deve ser pausada para que esse
método funcione. Se a proteção de planilha não for pausada, esse método não
alterará o estado de proteção da planilha.
TypeScript
resumeProtection(): void;
Retornos
void
setPassword(password)
Altera a senha associada ao WorksheetProtection objeto. Definir a senha como uma
cadeia de caracteres vazia ("") ou como null removerá a proteção de senha do
WorksheetProtection objeto. A proteção de planilha deve ser habilitada e pausada
para que esse método funcione corretamente. Se a proteção de planilha estiver

desabilitada, esse método gerará um InvalidOperation erro e não alterará a senha.
Se a proteção de planilha estiver habilitada e não pausada, esse método gerará um
AccessDenied erro e não alterará a senha.
TypeScript
setPassword(password?: string): void;
Parâmetros
password string
A senha associada ao WorksheetProtection objeto.
Retornos
void
unprotect(password)
Desprotege uma planilha.
TypeScript
unprotect(password?: string): void;
Parâmetros
password string
Senha de proteção de planilha.
Retornos
void
updateOptions(options)
Altere as opções de proteção de planilha associadas ao WorksheetProtection objeto.
A proteção de planilha deve ser desabilitada ou pausada para que esse método
funcione corretamente. Se a proteção de planilha estiver habilitada e não pausada,
esse método gerará um AccessDenied erro e não alterará as opções de proteção de
planilha.
TypeScript
updateOptions(options: WorksheetProtectionOptions): void;
Parâmetros
options ExcelScript.WorksheetProtectionOptions
A interface de opções associada ao WorksheetProtection objeto.
Retornos
void
comentários:
interface
Referência
Pacote: ExcelScript
Representa as opções de proteção da planilha.
Comentários
Exemplos
TypeScript
/**
* This script protects cells from being selected on the current worksheet.
*/
// Create a new WorksheetProtectionOptions object with the selectionMode

property set to `none`.
}

}
Propriedades
allowAutoFilter Representa a opção de proteção de planilha que permite o uso do recurso

AutoFilter.
allowDelete Representa a opção de proteção de planilha que permite a exclusão de

Columns colunas.
allowDeleteRows Representa a opção de proteção de planilha que permite a exclusão de

linhas.
allowEditObjects Representa a opção de proteção de planilha que permite a edição de

objetos.
allowEditScenarios Representa a opção de proteção de planilha que permite a edição de

cenários.
allowFormatCells Representa a opção de proteção de planilha que permite a formatação de

células.
allowFormat Representa a opção de proteção de planilha que permite a formatação de

Columns colunas.
allowFormatRows Representa a opção de proteção de planilha que permite a formatação de

linhas.
allowInsert Representa a opção de proteção de planilha que permite a inserção de

Columns colunas.
allowInsert Representa a opção de proteção de planilha que permite a inserção de

Hyperlinks hiperlinks.
allowInsertRows Representa a opção de proteção de planilha que permite a inserção de

linhas.
allowPivotTables Representa a opção de proteção de planilha que permite o uso do recurso

de Tabela Dinâmica.
allowSort Representa a opção de proteção de planilha que permite o uso do recurso

de classificação.
selectionMode Representa a opção de proteção da planilha do modo de seleção.
allowAutoFilter
Representa a opção de proteção de planilha que permite o uso do recurso
AutoFilter.
TypeScript
allowAutoFilter?: boolean;
boolean
allowDeleteColumns
Representa a opção de proteção de planilha que permite a exclusão de colunas.
TypeScript
allowDeleteColumns?: boolean;
boolean
allowDeleteRows
Representa a opção de proteção de planilha que permite a exclusão de linhas.
TypeScript
allowDeleteRows?: boolean;
boolean
allowEditObjects
Representa a opção de proteção de planilha que permite a edição de objetos.
TypeScript
allowEditObjects?: boolean;
boolean
allowEditScenarios
Representa a opção de proteção de planilha que permite a edição de cenários.
TypeScript
allowEditScenarios?: boolean;
boolean
allowFormatCells
Representa a opção de proteção de planilha que permite a formatação de células.
TypeScript
allowFormatCells?: boolean;
boolean
allowFormatColumns
Representa a opção de proteção de planilha que permite a formatação de colunas.
TypeScript
allowFormatColumns?: boolean;
boolean
allowFormatRows
Representa a opção de proteção de planilha que permite a formatação de linhas.
TypeScript
allowFormatRows?: boolean;
boolean
allowInsertColumns
Representa a opção de proteção de planilha que permite a inserção de colunas.
TypeScript
allowInsertColumns?: boolean;
boolean
allowInsertHyperlinks
Representa a opção de proteção de planilha que permite a inserção de hiperlinks.
TypeScript
allowInsertHyperlinks?: boolean;
boolean
allowInsertRows
Representa a opção de proteção de planilha que permite a inserção de linhas.
TypeScript
allowInsertRows?: boolean;
boolean
allowPivotTables
Representa a opção de proteção de planilha que permite o uso do recurso de Tabela
Dinâmica.
TypeScript
allowPivotTables?: boolean;
boolean
allowSort
Representa a opção de proteção de planilha que permite o uso do recurso de
classificação.
TypeScript
allowSort?: boolean;
boolean
selectionMode
Representa a opção de proteção da planilha do modo de seleção.
TypeScript
selectionMode?: ProtectionSelectionMode;
ExcelScript.WorksheetSearchCriteria
interface
Referência
Pacote: ExcelScript
Representa os critérios de pesquisa de planilha a serem usados.
Propriedades

false (parcial).

completeMatch
false (parcial).
TypeScript
boolean
matchCase
TypeScript
boolean
comentários:

Javascript API Office Scripts Office Scripts

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Javascript API Office Scripts Office Scripts

Enviado por

Direitos autorais:

Formatos disponíveis

Dê a sua opinião sobre a experiência de download do PDF.

Referência da API de scripts do Office

Se você estiver procurando as APIs JavaScript para desenvolver suplementos do

Uma Pasta de trabalho contém uma ou mais Planilhas.

ExcelScript.Allow Representa um AllowEditRange objeto encontrado em uma planilha. Esse

ExcelScript.Allow A interface usada para construir campos opcionais do AllowEditRange objeto.

ExcelScript. Representa o aplicativo Excel que gerencia a pasta de trabalho.

ExcelScript.Auto Representa o AutoFilter objeto. O AutoFilter transforma os valores na coluna

ExcelScript.Basic Representa os critérios básicos de validação de dados de tipo.

ExcelScript. Representa uma associação do Office.js definida na pasta de trabalho.

ExcelScript.Cell Representa um formato condicional de valor celular.

ExcelScript.Chart Representa um objeto chart em uma pasta de trabalho.

ExcelScript.Chart Encapsula as propriedades de formato da área de gráfico geral.

ExcelScript.Chart Representa os eixos de um gráfico.

ExcelScript.Chart Representa um único eixo em um gráfico.

ExcelScript.Chart Encapsula as propriedades de formato do eixo do gráfico.

ExcelScript.Chart Representa a formatação do título do eixo do gráfico.

ExcelScript.Chart Encapsula as opções de bin para gráficos de histograma e gráficos de pareto.

ExcelScript.Chart Representa a formatação de borda de um elemento gráfico.

ExcelScript.Chart Representa as propriedades de uma caixa e um gráfico de bigode.

ExcelScript.Chart Representa o rótulo de dados de um ponto de gráfico.

ExcelScript.Chart Encapsula as propriedades de formato dos rótulos de dados do gráfico.

ExcelScript.Chart Representa uma coleção de todos os rótulos de dados em um ponto do

ExcelScript.Chart Representa o objeto de tabela de dados de um gráfico.

ExcelScript.Chart Representa o formato de uma tabela de dados do gráfico.

ExcelScript.Chart Esse objeto representa os atributos das barras de erro de um gráfico.

ExcelScript.Chart Encapsula as propriedades de formato para barras de erro do gráfico.

ExcelScript.Chart Representa a formatação de preenchimento de um elemento do gráfico.

ExcelScript.Chart Representa a substring em objetos relacionados ao gráfico que contêm texto,

ExcelScript.Chart Representa linhas de grade principais ou secundárias em um eixo do gráfico.

ExcelScript.Chart Encapsula as propriedades de formato das linhas de grade do gráfico.

ExcelScript.Chart Representa a entrada da legenda em legendEntryCollection .

ExcelScript.Chart Encapsula as propriedades de formato de uma legenda de gráfico.

ExcelScript.Chart Encapsula as opções de formatação para elementos de linha.

ExcelScript.Chart Encapsula as propriedades de um gráfico de mapa de região.

ExcelScript.Chart Encapsula as opções de gráfico dinâmico.

ExcelScript.Chart Esse objeto representa os atributos de uma área de plotagem do gráfico.

ExcelScript.Chart Representa as propriedades de formato para uma área de plotagem de

ExcelScript.Chart Representa o ponto de uma série do gráfico.

ExcelScript.Chart Representa o objeto de formatação para pontos de gráfico.

ExcelScript.Chart Representa uma série de um gráfico.

ExcelScript.Chart Encapsula as propriedades de formato da série de gráficos

ExcelScript.Chart Representa um objeto ChartTitle de um gráfico.

ExcelScript.Chart Fornece acesso às opções de formatação para um título de gráfico.

ExcelScript.Chart Este objeto representa os atributos de um objeto de linha de tendência do

ExcelScript.Chart Representa as propriedades de formato para a linha de tendência do gráfico.

ExcelScript.Chart Esse objeto representa os atributos de um objeto de rótulo de linha de

ExcelScript.Color Representa os critérios de escala de cores para formatação condicional.

ExcelScript. Representa um comentário na pasta de trabalho.

ExcelScript. Representa a entidade mencionada nos comentários.

ExcelScript. Representa uma resposta de comentário na pasta de trabalho.

ExcelScript. Representa o conteúdo contido em uma resposta de comentário ou

ExcelScript. Representa uma regra de formato condicional de valor celular.

ExcelScript. Representa os critérios da escala de cores.

ExcelScript. Representa um critério de escala de cores que contém um tipo, um valor e

ExcelScript. Representa um formato condicional para o lado negativo da barra de dados.

ExcelScript. Representa um formato condicional para o lado positivo da barra de dados.

ExcelScript. Representa um tipo de regra para uma barra de dados.

ExcelScript. Um objeto encapsulando o intervalo, o formato, a regra e outras propriedades

ExcelScript. Representa um critério de ícone que contém um tipo, um valor, um operador

ExcelScript. Representa a regra de formato condicional de critérios predefinidos.

ExcelScript. Representa a borda de um objeto.

ExcelScript. Representa o plano de fundo de um objeto de intervalo condicional.

ExcelScript. Um objeto de formato encapsulando a fonte, o preenchimento, as bordas e