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. Seguem-se 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.
  • Subcadeia de título do gráfico - obter e definir subcadeia 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 - utilize esta API para obter a célula ativa de um livro.

Lista de API

A tabela seguinte lista as APIs no excel JavaScript API requirement set 1.7. Para ver API reference documentation for all APIs supported by Excel JavaScript API requirement set 1.7 or earlier, see Excel APIs in requirement set 1.7 or earlier.

Classe Campos Descrição
Gráfico chartType Especifica o tipo do gráfico.
id Id exclusiva do gráfico.
showAllFieldButtons Especifica se pretende apresentar todos os botões de campo num gráfico dinâmico.
ChartAreaFormat limite Representa o formato de limite 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 para o eixo de categoria especificado.
categoryType Especifica o tipo de eixo de categoria.
customDisplayUnit Especifica o valor de unidade de apresentação do 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 margem esquerda do eixo à esquerda da área do gráfico.
logBase Especifica a base do logaritmo ao utilizar escalas logarítmicas.
majorTickMark Especifica o tipo de marca de escala principal para o eixo especificado.
majorTimeUnitScale Especifica o valor de escala de unidades principal para o eixo de categoria quando a categoryType propriedade está definida como dateAxis.
minorTickMark Especifica o tipo de marca de escala secundária para o eixo especificado.
minorTimeUnitScale Especifica o valor de escala de unidade secundária para o eixo de categoria quando a categoryType propriedade está definida como dateAxis.
reversePlotOrder Especifica se o Excel desenha pontos de dados do último ao primeiro.
scaleType Especifica o tipo de escala do eixo de valores.
setCategoryNames(sourceData: Intervalo) 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 a etiqueta da unidade de apresentaçã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 etiquetas de marca de escala.
tickMarkSpacing Especifica o número de categorias ou séries entre marcas de escala.
top Especifica a distância, em pontos, da margem superior do eixo para 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 da etiqueta 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 da etiqueta de dados está visível.
showCategoryName Especifica se o nome da categoria da etiqueta de dados está visível.
showLegendKey Especifica se a chave de legenda da etiqueta de dados está visível.
showPercentage Especifica se a percentagem da etiqueta de dados está visível.
showSeriesName Especifica se o nome da série de etiquetas de dados está visível.
showValue Especifica se o valor da etiqueta de dados está visível.
ChartFormatString font Representa os atributos do tipo de letra, como o nome do tipo de letra, o tamanho do tipo de letra e a cor de um objeto de carateres 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() Devolve o número de entradas de legenda na coleção.
getItemAt(index: number) Devolve uma entrada de legenda no índice especificado.
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 uma etiqueta de dados.
markerBackgroundColor Representação do código de cores HTML da cor de fundo do marcador de um ponto de dados (por exemplo, #FF0000 representa Vermelho).
markerForegroundColor Representação do código de cores HTML da cor de 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 limite Representa o formato de limite de um ponto de dados de gráfico, que inclui informações de cor, estilo e espessura.
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.
filtrado Especifica se a série está filtrada.
gapWidth Representa a largura do espaçamento de uma série de gráfico.
hasDataLabels Especifica se a série tem etiquetas de dados.
markerBackgroundColor Especifica a cor de fundo do marcador de uma série de gráficos.
markerForegroundColor Especifica a cor de primeiro plano do marcador 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 desenho de uma série de gráficos no grupo de gráficos.
setBubbleSizes(sourceData: Intervalo) Define os tamanhos das bolhas para uma série de gráficos.
setValues(sourceData: Intervalo) 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.
suave Especifica se a série é suave.
linhas de tendência A coleção de linhas de tendência da série.
ChartSeriesCollection add(name?: string, index?: number) Adiciona uma nova série para o conjunto.
ChartTitle getSubstring(start: number, length: number) Obter a subcadeia 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, desde a margem esquerda do título do gráfico até à margem esquerda da área do gráfico.
position Representa a posição de título do gráfico.
setFormula(fórmula: cadeia) 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, desde a margem superior do título do gráfico até à 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 limite Representa o formato de limite 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.
intercetar 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 de linha de tendência 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 utilizado 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 ligaçõ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 no mesmo livro.
DocumentProperties autor O autor do livro.
categoria A categoria do livro.
comments Os comentários do livro.
company A empresa do livro.
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.
palavras-chave As palavras-chave do livro.
lastAuthor Obtém o último autor da pasta de trabalho.
gestor O gestor do livro.
revisionNumber Obtém o número de revisão da pasta de trabalho.
subject O assunto do livro.
title O título do livro.
NamedItem arrayValues Retorna um objeto que contém valores e tipos do item nomeado.
formula A fórmula do item com nome.
NamedItemArrayValues types Representa os tipos de cada item na matriz de itens com nome
values Representa os valores de cada item na matriz de itens nomeados.
Range getAbsoluteResizedRange(numRows: number, numColumns: number) 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() Compõe o intervalo como uma imagem png codificada com base64.
getSurroundingRegion() Devolve um Range objeto que representa a região circundante para a célula superior esquerda neste intervalo.
hiperlink Representa a hiperligação 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 especificado, com base nas definições de idioma do utilizador.
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 do 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 do URL da hiperligação.
documentReference Representa o destino de referência do documento para a hiperligação.
descrição 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 limite que representam o estilo dos quatro limites.
builtIn Especifica se o estilo é um estilo incorporado.
delete() Exclui este estilo.
fill O preenchimento do estilo.
font Um Font objeto que representa o tipo de letra do estilo.
formulaHidden Especifica se a fórmula será ocultada quando a folha de cálculo estiver protegida.
horizontalAlignment Representa o alinhamento horizontal para o estilo.
includeAlignment Especifica se o estilo inclui as propriedades avanço automático, alinhamento horizontal, alinhamento vertical, moldagem de texto, nível de avanço e orientação do texto.
includeBorder Especifica se o estilo inclui as propriedades de limite de cor, índice de cores, estilo de linha e espessura.
includeFont Especifica se o estilo inclui as propriedades de fundo, negrito, cor, índice de cores, estilo do tipo de letra, itálico, nome, tamanho, rasurado, inferior à linha, superior à linha e sublinhado.
includeNumber Especifica se o estilo inclui a propriedade formato de número.
includePatterns Especifica se o estilo inclui a cor, o índice de cores, inverter se negativo, padrão, cor do padrão e propriedades interiores do índice de cores do padrão.
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 folha de cálculo está 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 diminui automaticamente para caber na largura da coluna disponível.
verticalAlignment Especifica o alinhamento vertical para o estilo.
wrapText Especifica se o Excel molda o texto no objeto.
StyleCollection add(name: string) Adiciona um novo estilo para o conjunto.
getItem(name: string) Obtém um Style pelo nome.
items Obtém os itens filhos carregados nesta coleção.
Table onChanged Ocorre quando os dados nas células mudam numa tabela específica.
onSelectionChanged Ocorre quando a seleção é alterada numa 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 a forma como o evento alterado é acionado.
source Obtém a origem do evento.
tableId Obtém o ID da tabela na qual os dados foram alterados.
tipo Obtém o tipo do evento.
worksheetId Obtém o ID da folha de cálculo na qual os dados foram alterados.
TableCollection onChanged Ocorre quando os dados são alterados em qualquer tabela num livro ou numa folha de cálculo.
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 o ID da tabela na qual a seleção foi alterada.
tipo Obtém o tipo do evento.
worksheetId Obtém o ID da folha de cálculo na qual a seleção foi alterada.
Pasta de trabalho dataConnections Representa todas as ligações de dados no livro.
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 Devolve o objeto de proteção de um livro.
estilos Representa uma coleção de estilos associados à pasta de trabalho.
WorkbookProtection protect(password?: string) Protege o livro.
protegido Especifica se o livro está protegido.
desproteger(palavra-passe?: cadeia) Desprotege o livro.
Planilha copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet) Copia uma folha de cálculo e coloca-a na posição especificada.
fixar Painéis Obtém um objeto que pode ser utilizado para manipular painéis congelados na folha de cálculo.
getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number) Obtém o Range objeto a começar num índice de linha e índice de colunas específico e abrange um determinado número de linhas e colunas.
onActivated Ocorre quando a folha de cálculo é ativada.
onChanged Ocorre quando os dados são alterados numa folha de cálculo específica.
onDeactivated Ocorre quando a folha de cálculo é desativada.
onSelectionChanged Ocorre quando a seleção é alterada numa folha de cálculo específica.
standardHeight Retorna a altura padrão de todas as linhas na planilha, em pontos.
largura padrão Especifica a largura padrão (predefinida) de todas as colunas na folha de cálculo.
tabColor A cor do separador da folha de cálculo.
WorksheetActivatedEventArgs tipo Obtém o tipo do evento.
worksheetId Obtém o ID da folha de cálculo que está ativada.
WorksheetAddedEventArgs source Obtém a origem do evento.
tipo Obtém o tipo do evento.
worksheetId Obtém o ID da folha de cálculo que é adicionada ao livro.
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 a forma como o evento alterado é acionado.
source Obtém a origem do evento.
tipo Obtém o tipo do evento.
worksheetId Obtém o ID da folha de cálculo na qual os dados foram alterados.
WorksheetCollection onActivated Ocorre quando uma folha de cálculo no livro é ativada.
onAdded Ocorre quando uma nova folha de cálculo é adicionada ao livro.
onDeactivated Ocorre quando uma folha de cálculo no livro é desativada.
onDeleted Ocorre quando uma folha de cálculo é eliminada do livro.
WorksheetDeactivatedEventArgs tipo Obtém o tipo do evento.
worksheetId Obtém o ID da folha de cálculo que está desativada.
WorksheetDeletedEventArgs source Obtém a origem do evento.
tipo Obtém o tipo do evento.
worksheetId Obtém o ID da folha de cálculo que é eliminada do livro.
WorksheetFreezePanes freezeAt(frozenRange: Intervalo | cadeia) Define as células congeladas no modo de exibição da planilha ativa.
freezeColumns(count?: number) Fixar a primeira coluna ou colunas da folha de cálculo no local.
freezeRows(count?: number) Fixar a linha ou linhas superiores da folha de cálculo 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.
desbloquear() Remove todos os painéis congelados na planilha.
WorksheetProtection desproteger(palavra-passe?: cadeia) Desprotege uma planilha.
WorksheetProtectionOptions allowEditObjects Representa a opção de proteção da folha de cálculo que permite a edição de objetos.
allowEditScenarios Representa a opção de proteção da folha de cálculo 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 o ID da folha de cálculo na qual a seleção foi alterada.

Confira também