Quais são as novidades na API JavaScript do Excel 1.7

  • Artigo

O conjunto de requisitos 1.7 da API JavaScript do Excel incluei APIs para gráficos, eventos, planilhas, intervalos, propriedades do documento, itens nomeados, opções de proteção e estilos.

Personalize gráficos

Com as novas APIs de gráficos, você pode criar tipos degráficos adicionais, adicionar uma série de dados a um gráfico, definir o título do gráfico, adicionar um título de eixo, adicionar unidade de exibição, adicionar uma linha de tendência com média móvel, alterar uma linha de tendência para linear e muito mais. A seguir estão alguns exemplos.

  • Eixo gráfico - obtenha, defina, formate e remova unidade de eixo, etiqueta e título em um gráfico.
  • Série de gráficos - adicione, defina e exclua uma série em um gráfico. Alterar marcadores da série, pedidos de plotagem e dimensionamento.
  • Gráfico de linhas de tendências: adicione, receba e formate linhas de tendências em um gráfico.
  • Legenda do gráfico - formate a fonte de legenda de um gráfico.
  • Ponto do gráfico - defina a cor do ponto do gráfico.
  • Substring de título do gráfico – obter e definir substring de título para um gráfico.
  • Tipo de gráfico - opção para criar mais tipos de gráfico.

Eventos

As APIs de eventos JavaScript do Excel fornecem diversos, manipuladores de eventos que permitem que o suplemento execute automaticamente uma função designada quando ocorre um evento específico. Você pode criar essa função para executar as ações que seu cenário exige. Para obter uma lista de eventos que estão disponíveis, confira trabalhar com eventos usando as API JavaScript do Excel.

Personalizar a aparência de planilhas e intervalos

Nas novas APIs você pode personalizar a aparência das planilhas de várias maneiras:

  • Congele painéis para manter linhas ou colunas específicas visíveis durante a rolagem na planilha. Por exemplo, se a primeira linha da planilha inclui cabeçalhos, você pode congelá-la para que os cabeçalhos das colunas permaneçam visíveis enquanto rola para baixo na planilha.
  • Modificar a cor da guia de planilha.
  • Adicione títulos de planilha.

Você pode personalizar a aparência de intervalos de várias maneiras:

  • Defina o estilo de célula para um intervalo para garantir que todas as células no intervalo tenham formatação consistente. Um estilo de célula é um conjunto definido de características de formatação, como fontes e tamanhos de fonte, formatos numéricos, bordas de célula e sombreamento de célula. Use qualquer um dos estilos de célula internas do Excel ou crie seu próprio estilo de célula personalizado.
  • Defina a orientação de texto para um intervalo.
  • Adicione ou modifique um hiperlink em um intervalo vinculado a outro local na pasta de trabalho ou a um local externo.

Gerenciar propriedades dos documentos

Usando as APIs de propriedades do documento, você pode acessar as propriedades do documento interno e também criar e gerenciar propriedades personalizadas do documento para armazenar o estado da pasta de trabalho e direcionar o fluxo de trabalho e a lógica comercial.

Copiar planilhas

Usando a cópia da planilha APIs, você pode copiar os dados e o formato de uma planilha para uma nova planilha na mesma pasta de trabalho e reduzir a quantidade de transferência de dados necessária.

Lidar com intervalos com facilidade

Usando várias APIs de intervalo, você pode fazer coisas como obter região ao redor, obter um intervalo redimensionado e muito mais. Essas APIs devem tornar as tarefas, como manipulação de intervalo e endereçamento, muito mais eficientes.

Além disso:

  • Opções de proteção de pasta de trabalho e planilha - use estas APIs para proteger dados em uma planilha e a estrutura da pasta de trabalho.
  • Atualizar um item nomeado - usar esta API para atualizar um item nomeado.
  • Obter célula ativa – use essa API para obter a célula ativa de uma pasta de trabalho.

Lista de API

A tabela a seguir lista as APIs no conjunto de requisitos da API JavaScript do Excel 1.7. Para exibir a documentação de referência da API para todas as APIs com suporte no conjunto de requisitos de API JavaScript do Excel 1.7 ou anterior, consulte APIs do Excel no conjunto de requisitos 1.7 ou anterior.

Classe Campos Descrição
Gráfico Charttype Especifica o tipo do gráfico.
id Id exclusiva do gráfico.
showAllFieldButtons Especifica se é necessário exibir todos os botões de campo em um Gráfico Dinâmico.
ChartAreaFormat borda Representa o formato de borda da área do gráfico, que inclui cor, estilo de linha e peso.
ChartAxes getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup) Retorna o eixo específico identificado por tipo e grupo.
ChartAxis axisGroup Especifica o grupo para o eixo especificado.
baseTimeUnit Especifica a unidade base do eixo de categoria especificado.
Categorytype Especifica o tipo de eixo de categoria.
customDisplayUnit Especifica o valor da unidade de exibição de eixo personalizado.
displayUnit Representa a unidade de exibição de eixo.
height Especifica a altura, em pontos, do eixo do gráfico.
left Especifica a distância, em pontos, da borda esquerda do eixo à esquerda da área do gráfico.
logBase Especifica a base do logaritmo ao usar dimensionamentos logarítmicos.
majorTickMark Especifica o tipo de marca de tique principal para o eixo especificado.
majorTimeUnitScale Especifica o valor de escala de unidade principal para o eixo de categoria quando a categoryType propriedade é definida como dateAxis.
minorTickMark Especifica o tipo de marca de tique menor para o eixo especificado.
minorTimeUnitScale Especifica o valor de escala de unidade menor para o eixo de categoria quando a categoryType propriedade é definida como dateAxis.
reversePlotOrder Especifica se o Excel plota pontos de dados de último para primeiro.
scaleType Especifica o tipo de escala do eixo de valor.
setCategoryNames(sourceData: Range) Define todos os nomes de categoria para o eixo especificado.
setCustomDisplayUnit(valor: número) Definirá a unidade de exibição de eixo a um valor personalizado.
showDisplayUnitLabel Especifica se o rótulo da unidade de exibição do eixo está visível.
tickLabelPosition Especifica a posição dos rótulos de marcas de escala no eixo especificado.
tickLabelSpacing Especifica o número de categorias ou séries entre rótulos de marca de tique-taque.
tickMarkSpacing Especifica o número de categorias ou séries entre marcas de tique.
top Especifica a distância, em pontos, da borda superior do eixo até a parte superior da área do gráfico.
type Especifica o tipo de eixo.
visible Especifica se o eixo está visível.
width Especifica a largura, em pontos, do eixo do gráfico.
ChartBorder color Código de cor HTML que representa a cor das bordas no gráfico.
Linestyle Representa o estilo de linha da borda.
peso Representa a espessura da borda, em pontos.
ChartDataLabel position Valor que representa a posição do rótulo de dados.
Separador Cadeia de caracteres que representa o separador usado para o rótulo de dados em um gráfico.
showBubbleSize Especifica se o tamanho da bolha do rótulo de dados está visível.
showCategoryName Especifica se o nome da categoria do rótulo de dados está visível.
showLegendKey Especifica se a chave de legenda do rótulo de dados está visível.
showPercentage Especifica se o percentual do rótulo de dados está visível.
showSeriesName Especifica se o nome da série de rótulos de dados está visível.
showValue Especifica se o valor do rótulo de dados está visível.
ChartFormatString font Representa os atributos de fonte, como nome da fonte, tamanho da fonte e cor de um objeto de caracteres de gráfico.
ChartLegend height Especifica a altura, em pontos, da legenda no gráfico.
left Especifica o valor esquerdo, em pontos, da legenda no gráfico.
legendEntries Representa uma coleção de legendEntries na legenda.
showShadow Especifica se a legenda tem uma sombra no gráfico.
top Especifica a parte superior de uma legenda de gráfico.
width Especifica a largura, em pontos, da legenda no gráfico.
ChartLegendEntry visible Representa a visibilidade de uma entrada de legenda de gráfico.
ChartLegendEntryCollection getCount() Retorna o número de entradas de legenda na coleção.
getItemAt(index: number) Retorna uma entrada de legenda no índice fornecido.
items Obtém os itens filhos carregados nesta coleção.
ChartLineFormat Linestyle Representa o estilo de linha.
peso Representa a espessura da linha, em pontos.
ChartPoint dataLabel Retorna o rótulo de dados de um ponto de gráfico.
hasDataLabel Representa se um ponto de dados tem um rótulo de dados.
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).
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).
markerSize Representa o tamanho do marcador de um ponto de dados.
Markerstyle Representa estilo do marcador de um ponto de dados do gráfico.
ChartPointFormat borda Representa o formato de borda de um ponto de dados do gráfico, que inclui informações de cor, estilo e peso.
ChartSeries Charttype Representa o tipo de gráfico de uma série.
delete() Exclui a série de gráfico.
donutHoleSize Representa o tamanho do furo de rosca de uma série de gráficos.
Filtrada Especifica se a série é filtrada.
gapWidth Representa a largura do espaçamento de uma série de gráfico.
hasDataLabels Especifica se a série tem rótulos de dados.
markerBackgroundColor Especifica a cor de fundo do marcador de uma série de gráficos.
markerForegroundColor Especifica a cor do marcador em primeiro plano de uma série de gráficos.
markerSize Especifica o tamanho do marcador de uma série de gráficos.
Markerstyle Especifica o estilo de marcador de uma série de gráficos.
plotOrder Especifica a ordem de plotagem de uma série de gráficos no grupo de gráficos.
setBubbleSizes(sourceData: Range) Define os tamanhos de bolha para uma série de gráficos.
setValues(sourceData: Range) Define os valores de uma série de gráficos.
setXAxisValues(sourceData: Range) Define os valores do eixo x para uma série de gráficos.
showShadow Especifica se a série tem uma sombra.
Liso Especifica se a série é suave.
Trendlines A coleção de linhas de tendência na série.
ChartSeriesCollection add(name?: string, index?: number) Adiciona uma nova série para o conjunto.
ChartTitle getSubstring(start: number, length: number) Obtenha a substring de um título de gráfico.
height Representa a altura, em pontos, do título do gráfico.
horizontalAlignment Especifica o alinhamento horizontal para o título do gráfico.
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.
position Representa a posição de título do gráfico.
setFormula(formula: string) 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.
showShadow Representa um valor booliano que determina se o título do gráfico tiver uma sombra.
textOrientation Especifica o ângulo para o qual o texto é orientado para o título do gráfico.
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.
verticalAlignment Especifica o alinhamento vertical do título do gráfico.
width Especifica a largura, em pontos, do título do gráfico.
ChartTitleFormat borda Representa o formato de borda do título do gráfico, que inclui cor, estilo de linha e peso.
ChartTrendline delete() Deleta o objeto Trendline.
format Representa a formatação de uma linha de tendência do gráfico.
Interceptar Representa o valor de intercepção da linha de tendência.
movingAveragePeriod Representa o período de uma linha de tendência do gráfico.
name Representa o nome da linha de tendência.
polynomialOrder Representa a ordem de uma linha de tendência do gráfico.
type Representa o tipo da linha de tendência de um gráfico.
ChartTrendlineCollection add(type?: Excel.ChartTrendlineType) Adiciona uma nova linha de tendência ao conjunto de linha de tendência.
getCount() Retorna o número de linha de tendência na coleção.
getItem(index: number) Obtém um objeto trendline por índice, que é a ordem de inserção na matriz de itens.
items Obtém os itens filhos carregados nesta coleção.
ChartTrendlineFormat line Representa a formatação de linha do gráfico.
CustomProperty delete() Exclui a propriedade personalizada.
key A chave da propriedade personalizada.
type O tipo do valor usado para a propriedade personalizada.
value O valor da propriedade personalizada.
CustomPropertyCollection add(key: string, value: any) Cria uma nova propriedade personalizada ou define uma existente.
deleteAll() Exclui todas as propriedades personalizadas nesta coleção.
getCount() Obtém a contagem das propriedades personalizadas.
getItem(key: string) Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas.
getItemOrNullObject(key: string) Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas.
items Obtém os itens filhos carregados nesta coleção.
DataConnectionCollection refreshAll() Atualiza as conexões de dados na coleção, como de uma Tabela Dinâmica para um conjunto de dados do Power BI ou um Modelo de Dados para uma tabela ou intervalo na mesma pasta de trabalho.
DocumentProperties Autor O autor da pasta de trabalho.
Categoria A categoria da pasta de trabalho.
comments Os comentários da pasta de trabalho.
company A empresa da pasta de trabalho.
creationDate Obtém a data de criação da pasta de trabalho.
Personalizado Obtém a coleção de propriedades personalizadas da pasta de trabalho.
Keywords As palavras-chave da pasta de trabalho.
lastAuthor Obtém o último autor da pasta de trabalho.
manager O gerente da pasta de trabalho.
Revisionnumber Obtém o número de revisão da pasta de trabalho.
subject O assunto da pasta de trabalho.
title O título da pasta de trabalho.
NamedItem arrayValues Retorna um objeto que contém valores e tipos do item nomeado.
formula A fórmula do item nomeado.
NamedItemArrayValues types Representa os tipos para cada item na matriz de itens nomeada
values Representa os valores de cada item na matriz de itens nomeados.
Range getAbsoluteResizedRange(numRows: número, numColumns: número) 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.
getImage() Renderiza o intervalo como uma imagem png codificada com base64.
getSurroundingRegion() Retorna um Range objeto que representa a região circundante para a célula superior esquerda nesse intervalo.
hiperlink Representa o hiperlink para o intervalo atual.
isEntireColumn Representa se o intervalo atual está em uma coluna inteira.
isEntireRow Representa se o intervalo atual está em uma linha inteira.
Numberformatlocal 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.
showCard() Exibe o cartão para uma célula ativa se ele tiver um conteúdo valioso.
style Representa o estilo de intervalo atual.
RangeFormat textOrientation A orientação de texto de todas as células dentro do intervalo.
useStandardHeight Determina se a altura da linha do Range objeto é igual à altura padrão da folha.
useStandardWidth Especifica se a largura da coluna do Range objeto é igual à largura padrão da folha.
RangeHyperlink address Representa o destino da URL para o hiperlink.
Documentreference Representa o destino de referência do documento para o hiperlink.
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.
Estilo Borders Uma coleção de quatro objetos de borda que representam o estilo das quatro bordas.
Builtin Especifica se o estilo é um estilo interno.
delete() Exclui este estilo.
fill O preenchimento do estilo.
font Um Font objeto que representa a fonte do estilo.
formulaHidden Especifica se a fórmula será ocultada quando a planilha estiver protegida.
horizontalAlignment Representa o alinhamento horizontal para o estilo.
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.
includeBorder Especifica se o estilo inclui as propriedades color, color index, line style e weight border.
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.
includeNumber Especifica se o estilo inclui a propriedade de formato de número.
includePatterns Especifica se o estilo inclui as propriedades interiores color, color index, invert if negative, pattern, pattern color e pattern color index.
includeProtection Especifica se o estilo inclui as propriedades de proteção ocultas e bloqueadas da fórmula.
indentLevel Um número inteiro entre 0 e 250 que indica o nível de recuo do estilo.
bloqueado Especifica se o objeto está bloqueado quando a planilha é protegida.
name O nome do estilo.
Numberformat O código de formatação de formato de número para o estilo.
Numberformatlocal O código de formato localizado do formato numérico para o estilo.
readingOrder A ordem de leitura para o estilo.
shrinkToFit Especifica se o texto reduz automaticamente para se encaixar na largura da coluna disponível.
verticalAlignment Especifica o alinhamento vertical para o estilo.
wrapText Especifica se o Excel encapsula o texto no objeto.
StyleCollection add(name: string) Adiciona um novo estilo para o conjunto.
getItem(name: string) Obtém um Style por nome.
items Obtém os itens filhos carregados nesta coleção.
Table onChanged Ocorre quando os dados nas células são alterados em uma tabela específica.
onSelectionChanged Ocorre quando a seleção é alterada em uma tabela específica.
TableChangedEventArgs address Obtém o endereço que representa a área alterada de uma tabela em uma planilha específica.
changeType Obtém o tipo de alteração que representa como o evento alterado é disparado.
source Obtém a origem do evento.
tableId Obtém a ID da tabela na qual os dados foram alterados.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha na qual os dados foram alterados.
TableCollection onChanged Ocorre quando os dados são alterados em qualquer tabela em uma pasta de trabalho ou em uma planilha.
TableSelectionChangedEventArgs address Obtém o endereço do intervalo que representa a área selecionada da tabela em uma planilha específica.
isInsideTable Especifica se a seleção está dentro de uma tabela.
tableId Obtém a ID da tabela na qual a seleção foi alterada.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha na qual a seleção foi alterada.
Pasta de trabalho dataConnections Representa todas as conexões de dados na pasta de trabalho.
getActiveCell() Obtém a célula ativa no momento da pasta de trabalho.
name Obtém o nome da pasta de trabalho.
properties Obtém as propriedades da pasta de trabalho.
protection Retorna o objeto de proteção para uma pasta de trabalho.
Estilos Representa uma coleção de estilos associados à pasta de trabalho.
WorkbookProtection protect(password?: string) Protege uma pasta de trabalho.
Protegido Especifica se a pasta de trabalho está protegida.
desprotegir(senha?: cadeia de caracteres) Desprotege uma pasta de trabalho.
Planilha copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet) Copia uma planilha e a coloca na posição especificada.
freezePanes Obtém um objeto que pode ser usado para manipular painéis congelados na planilha.
getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number) 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.
onActivated Ocorre quando a planilha é ativada.
onChanged Ocorre quando os dados são alterados em uma planilha específica.
onDeactivated Ocorre quando a planilha é desativada.
onSelectionChanged Ocorre quando a seleção é alterada em uma planilha específica.
Standardheight Retorna a altura padrão de todas as linhas na planilha, em pontos.
Standardwidth Especifica a largura padrão (padrão) de todas as colunas na planilha.
tabColor A cor da guia da planilha.
WorksheetActivatedEventArgs tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha ativada.
WorksheetAddedEventArgs source Obtém a origem do evento.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha que é adicionada à pasta de trabalho.
WorksheetChangedEventArgs address Obtém o endereço do intervalo que representa a área alterada de uma planilha específica.
changeType Obtém o tipo de alteração que representa como o evento alterado é disparado.
source Obtém a origem do evento.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha na qual os dados foram alterados.
WorksheetCollection onActivated Ocorre quando qualquer planilha na pasta de trabalho é ativada.
onAdded Ocorre quando uma nova planilha é adicionada à pasta de trabalho.
onDeactivated Ocorre quando qualquer planilha na pasta de trabalho é desativada.
onDeleted Ocorre quando uma planilha é excluída da pasta de trabalho.
WorksheetDeactivatedEventArgs tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha que está desativada.
WorksheetDeletedEventArgs source Obtém a origem do evento.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha que é excluída da pasta de trabalho.
WorksheetFreezePanes freezeAt(frozenRange: cadeia de caracteres | de intervalo) Define as células congeladas no modo de exibição da planilha ativa.
freezeColumns(count?: number) Congele a primeira coluna ou colunas da planilha no local.
freezeRows(count?: número) Congele a linha superior ou as linhas da planilha no local.
getLocation() Obtém um intervalo que descreve as células congeladas no modo de exibição da planilha ativa.
getLocationOrNullObject() Obtém um intervalo que descreve as células congeladas no modo de exibição da planilha ativa.
descongelar() Remove todos os painéis congelados na planilha.
WorksheetProtection desprotegir(senha?: cadeia de caracteres) Desprotege uma planilha.
WorksheetProtectionOptions 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.
Selectionmode Representa a opção de proteção da planilha do modo de seleção.
WorksheetSelectionChangedEventArgs address Obtém o endereço do intervalo que representa a área selecionada de uma planilha específica.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha na qual a seleção foi alterada.

Confira também