Novidades na API JavaScript do Excel 1.8

  • Artigo

O conjunto de requisitos 1.8 da API JavaScript do Excel inclui APIs para tabelas dinâmicas, validação de dados, gráficos, eventos de gráficos, opções de desempenho e criação de pasta de trabalho.

Tabela Dinâmica

Onda 2 das APIs de Tabela Dinâmica permite que os suplementos definam as hierarquias de uma Tabela Dinâmica. Agora você pode controlar os dados e como eles são agregados. Nosso Artigo de Tabela Dinâmica tem mais informações sobre a nova funcionalidade de tabela dinâmica.

Validação de Dados

A validação de dados permite controlar o que um usuário digita em uma planilha. Você pode limitar as células a conjuntos de respostas predefinidos ou fornecer avisos pop-up sobre entradas indesejadas. Saiba mais sobre adicionar a validação de dados para intervalos hoje.

Gráficos

Outra rodada de APIs de gráficos traz um controle programático ainda maior sobre os elementos do gráfico. Agora você tem maior acesso à legenda, eixos, linha de tendência e área de plotagem.

Eventos

Mais eventos foram adicionados para os gráficos. Faça o seu suplemento reagir aos usuários interagindo com o gráfico. Você também pode alternar eventos disparados em toda a pasta de trabalho.

Lista de API

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

Classe Campos Descrição
BasicDataValidation 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).
formula2 Com os operadores ternários Between e NotBetween, especifica o operando de limite superior.
operator O operador a ser usado para validar os dados.
Gráfico 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.
Displayblanksas Especifica a forma como as células em branco são plotadas em um gráfico.
onActivated Ocorre quando o gráfico é ativado.
onDeactivated Ocorre quando o gráfico é desativado.
Plotarea Representa a área de plotagem para o gráfico.
Plotby Especifica a forma como as colunas ou linhas são usadas como série de dados no gráfico.
Plotvisibleonly Verdadeiro se apenas as células visíveis forem plotadas.
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.
Showdatalabelsovermaximum Especifica se deve mostrar os rótulos de dados quando o valor é maior que o valor máximo no eixo de valor.
style Especifica o estilo do gráfico para o gráfico.
ChartActivatedEventArgs chartId Obtém a ID do gráfico que está ativado.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha na qual o gráfico é ativado.
ChartAddedEventArgs chartId Obtém a ID do gráfico que é adicionado à planilha.
source Obtém a origem do evento.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha na qual o gráfico é adicionado.
ChartAxis Alinhamento Especifica o alinhamento para o rótulo de tique de eixo especificado.
isBetweenCategories Especifica se o eixo de valor cruza o eixo de categoria entre categorias.
Multinível Especifica se um eixo é multinível.
Numberformat Especifica o código de formato para o rótulo de tique de eixo.
Deslocamento 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.
position Especifica a posição de eixo especificada em que o outro eixo se cruza.
positionAt Especifica a posição do eixo em que o outro eixo se cruza.
setPositionAt(valor: número) Define a posição de eixo especificada em que o outro eixo se cruza.
textOrientation Especifica o ângulo para o qual o texto é orientado para o rótulo de tique do eixo do gráfico.
ChartAxisFormat fill Especifica a formatação de preenchimento do gráfico.
ChartAxisTitle setFormula(formula: string) 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.
ChartAxisTitleFormat borda Especifica o formato de borda do título do eixo do gráfico, que inclui cor, estilo de linha e peso.
fill Especifica a formatação de preenchimento do título do eixo do gráfico.
ChartBorder clear() Limpa a formatação da borda de um elemento do gráfico.
ChartCollection onActivated Ocorre quando um gráfico é ativado.
onAdded Ocorre quando um novo gráfico é adicionado à planilha.
onDeactivated Ocorre quando um gráfico é desativado.
onDeleted Ocorre quando um gráfico é excluído.
ChartDataLabel Autotexto Especifica se o rótulo de dados gera automaticamente o texto apropriado com base no contexto.
format Representa o formato do rótulo de dados do gráfico.
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.
height Retorna a altura, em pontos, do rótulo de dados do gráfico.
horizontalAlignment Representa o alinhamento horizontal de rótulo de dados do gráfico.
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.
Numberformat Valor de cadeia de caracteres que representa o código do formato do rótulo de dados.
text Cadeia de caracteres que representa o texto do rótulo de dados em um gráfico.
textOrientation Representa o ângulo para o qual o texto é orientado para o rótulo de dados do gráfico.
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.
verticalAlignment Representa o alinhamento vertical do rótulo de dados do gráfico.
width Retorna a largura, em pontos, do rótulo de dados do gráfico.
ChartDataLabelFormat borda Representa o formato de borda, que inclui a espessura de cor e estilo de linha.
ChartDataLabels Autotexto Especifica se os rótulos de dados geram automaticamente o texto apropriado com base no contexto.
horizontalAlignment Especifica o alinhamento horizontal para o rótulo de dados do gráfico.
Numberformat Especifica o código de formato para rótulos de dados.
textOrientation Representa o ângulo para o qual o texto é orientado para rótulos de dados.
verticalAlignment Representa o alinhamento vertical do rótulo de dados do gráfico.
ChartDeactivatedEventArgs chartId Obtém a ID do gráfico que está desativado.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha na qual o gráfico é desativado.
ChartDeletedEventArgs chartId Obtém a ID do gráfico que é excluído da planilha.
source Obtém a origem do evento.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha na qual o gráfico é excluído.
ChartLegendEntry height Especifica a altura da entrada da legenda na legenda do gráfico.
índice Especifica o índice da entrada de legenda na legenda do gráfico.
left Especifica o valor esquerdo de uma entrada de legenda de gráfico.
top Especifica a parte superior de uma entrada de legenda do gráfico.
width Representa a largura da entrada da legenda na legenda do gráfico.
ChartLegendFormat borda Representa o formato de borda, que inclui a espessura de cor e estilo de linha.
ChartPlotArea format Especifica a formatação de uma área de plotagem de gráfico.
height Especifica o valor de altura de uma área de plotagem.
insideHeight Especifica o valor de altura interna de uma área de plotagem.
insideLeft Especifica o valor interno esquerdo de uma área de plotagem.
insideTop Especifica o valor superior interno de uma área de plotagem.
insideWidth Especifica o valor de largura interna de uma área de plotagem.
left Especifica o valor esquerdo de uma área de plotagem.
position Especifica a posição de uma área de plotagem.
top Especifica o valor superior de uma área de plotagem.
width Especifica o valor de largura de uma área de plotagem.
ChartPlotAreaFormat borda Especifica os atributos de borda de uma área de gráfico.
fill Especifica o formato de preenchimento de um objeto, que inclui informações de formatação em segundo plano.
ChartSeries axisGroup Especifica o grupo da série especificada.
dataLabels Representa uma coleção de todos os rótulos de dados da série.
Explosão Especifica o valor de explosão para uma fatia de gráfico de pizza ou gráfico de donuts.
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).
invertIfNegative True se o Excel inverte o padrão no item quando ele corresponde a um número negativo.
Sobreposição Especifica como barras e colunas são posicionadas.
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.
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.
varyByCategories True se o Excel atribuir uma cor ou padrão diferente a cada marcador de dados.
ChartTrendline backwardPeriod Representa o número de períodos que a linha de tendência se estende para trás.
forwardPeriod Representa o número de períodos que a linha de tendência se estende para frente.
Rótulo Representa o rótulo de linha de tendência um gráfico.
showEquation Verdadeiro se a equação da linha de tendência for exibida no gráfico.
showRSquared True se o valor r-squared para a linha de tendência for exibido no gráfico.
ChartTrendlineLabel Autotexto Especifica se o rótulo de linha de tendência gera automaticamente o texto apropriado com base no contexto.
format O formato do rótulo de linha de tendência do gráfico.
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.
height Retorna a altura, em pontos, do rótulo de linha de tendência do gráfico.
horizontalAlignment Representa o alinhamento horizontal do rótulo de linha de tendência do gráfico.
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.
Numberformat Valor de cadeia de caracteres que representa o código de formato para o rótulo de linha de tendência.
text Cadeia de caracteres que representa o texto do rótulo em um gráfico de linha de tendência.
textOrientation Representa o ângulo para o qual o texto é orientado para o rótulo de linha de tendência do gráfico.
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.
verticalAlignment Representa o alinhamento vertical do rótulo de linha de tendência do gráfico.
width Retorna a largura, em pontos, do rótulo de linha de tendência do gráfico.
ChartTrendlineLabelFormat borda Especifica o formato de borda, que inclui cor, estilo de linha e peso.
fill Especifica o formato de preenchimento do rótulo de linha de tendência do gráfico atual.
font 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.
CustomDataValidation formula Uma fórmula de validação de dados personalizados.
DataPivotHierarchy campo Retorna PivotFields associados a DataPivotHierarchy.
id ID do DataPivotHierarchy.
name Nome da DataPivotHierarchy.
Numberformat Formato de número do DataPivotHierarchy.
position Posição da DataPivotHierarchy.
setToDefault() Redefina a DataPivotHierarchy para os valores padrão.
showAs Especifica se os dados devem ser mostrados como um cálculo de resumo específico.
summarizeBy Especifica se todos os itens do DataPivotHierarchy são mostrados.
DataPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) Adiciona o PivotHierarchy ao eixo atual.
getCount() Obtém o número de hierarquias dinâmicas na coleção.
getItem(name: string) Obtém um DataPivotHierarchy por seu nome ou ID.
getItemOrNullObject(name: string) Obtém uma DataPivotHierarchy por nome.
items Obtém os itens filhos carregados nesta coleção.
remove(DataPivotHierarchy: Excel.DataPivotHierarchy) Remove o PivotHierarchy do eixo atual.
DataValidation clear() Desfazer a validação de dados do intervalo atual.
errorAlert Alerta de erro quando o usuário insere dados inválidos.
ignoreBlanks Especifica se a validação de dados será executada em células em branco.
prompt Solicitar quando os usuários selecionarem uma célula.
Regra Regra de validação de dados que contém diferentes tipos de critérios de validação de dados.
type Tipo da validação de dados, consulte Excel.DataValidationType para obter detalhes.
Válido Representa se todos os valores de célula são válidos de acordo com as regras de validação de dados.
DataValidationErrorAlert message Representa a mensagem de alerta de erro.
showAlert Especifica se deve mostrar uma caixa de diálogo de alerta de erro quando um usuário insere dados inválidos.
style O tipo de alerta de validação de dados, consulte Excel.DataValidationAlertStyle para obter detalhes.
title Representa o título da caixa de diálogo alerta de erro.
DataValidationPrompt message Especifica a mensagem do prompt.
showPrompt Especifica se um prompt é mostrado quando um usuário seleciona uma célula com validação de dados.
title Especifica o título do prompt.
DataValidationRule Personalizado Critérios de validação de dados personalizados.
data 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.
DateTimeDataValidation 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).
formula2 Com os operadores ternários Between e NotBetween, especifica o operando de limite superior.
operator O operador a ser usado para validar os dados.
FilterPivotHierarchy enableMultipleFilterItems Determina se deseja permitir vários itens de filtro.
campos Retorna PivotFields associados a FilterPivotHierarchy.
id ID do FilterPivotHierarchy.
name Nome do FilterPivotHierarchy.
position Posição do FilterPivotHierarchy.
setToDefault() Redefina a FilterPivotHierarchy para os valores padrão.
FilterPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) Adiciona o PivotHierarchy ao eixo atual.
getCount() Obtém o número de hierarquias dinâmicas na coleção.
getItem(name: string) Obtém um FilterPivotHierarchy por seu nome ou ID.
getItemOrNullObject(name: string) Obtém um FilterPivotHierarchy por nome.
items Obtém os itens filhos carregados nesta coleção.
remove(filterPivotHierarchy: Excel.FilterPivotHierarchy) Remove o PivotHierarchy do eixo atual.
ListDataValidation inCellDropDown Especifica se é necessário exibir a lista em uma lista suspensa de células.
source Fonte da lista de validação de dados
PivotField id ID do PivotField.
items Retorna os PivotItems associados ao PivotField.
name Nome do PivotField.
showAllItems Determina se deseja mostrar todos os itens de PivotField.
sortByLabels(sortBy: SortBy) Classifica o PivotField.
subtotals Subtotais de PivotField.
PivotFieldCollection getCount() Obtém o número de campos dinâmicos na coleção.
getItem(name: string) Obtém um PivotField pelo nome ou ID.
getItemOrNullObject(name: string) Obtém um PivotField pelo nome.
items Obtém os itens filhos carregados nesta coleção.
PivotHierarchy campos Retorna PivotFields associados a PivotHierarchy.
id ID da PivotHierarchy.
name Nome do PivotHierarchy.
PivotHierarchyCollection getCount() Obtém o número de hierarquias dinâmicas na coleção.
getItem(name: string) Obtém uma PivotHierarchy por seu nome ou ID.
getItemOrNullObject(name: string) Obtém o PivotHierarchy por nome.
items Obtém os itens filhos carregados nesta coleção.
PivotItem id ID do PivotItem.
Isexpanded Determina se o item está expandido para mostrar itens filho ou se ele está recolhido e os itens filho estão ocultos.
name Nome do PivotItem.
visible Especifica se o PivotItem está visível.
PivotItemCollection getCount() Obtém o número de PivotItems na coleção.
getItem(name: string) Obtém um PivotItem por seu nome ou ID.
getItemOrNullObject(name: string) Obtém um PivotItem pelo nome.
items Obtém os itens filhos carregados nesta coleção.
PivotLayout getColumnLabelRange() Retorna o intervalo onde residem os rótulos de coluna da Tabela Dinâmica.
getDataBodyRange() Retorna o intervalo onde residem os valores de dados da tabela dinâmica.
getFilterAxisRange() Retorna o intervalo de área de filtro da Tabela Dinâmica.
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.
layoutType Essa propriedade indica o PivotLayoutType de todos os campos da Tabela Dinâmica.
showColumnGrandTotals Especifica se o relatório de Tabela Dinâmica mostra totais grandes para colunas.
showRowGrandTotals Especifica se o relatório de Tabela Dinâmica mostra totais grandes para linhas.
subtotalLocation Essa propriedade indica o SubtotalLocationType de todos os campos na Tabela Dinâmica.
PivotTable columnHierarchies As hierarquias de pivô da coluna da Tabela Dinâmica.
dataHierarchies As hierarquias dinâmicas de dados da Tabela Dinâmica.
delete() Exclui a Tabela Dinâmica.
filterHierarchies As hierarquias de pivô do filtro da Tabela Dinâmica.
Hierarquias Hierarquias pivô da Tabela Dinâmica.
Layout O PivotLayout descreve o layout e estrutura visual da Tabela Dinâmica.
rowHierarchies As hierarquias de pivô de linha da Tabela Dinâmica.
PivotTableCollection add(name: string, source: Range | string | Tabela, destino: intervalo | cadeia de caracteres) Adicione uma Tabela Dinâmica com base nos dados de origem especificados e insira-os na célula superior esquerda do intervalo de destino.
Range dataValidation Retorna um objeto de validação de dados.
RowColumnPivotHierarchy campos Retorna PivotFields associados a RowColumnPivotHierarchy.
id ID do RowColumnPivotHierarchy.
name Nome da RowColumnPivotHierarchy.
position Posição da RowColumnPivotHierarchy.
setToDefault() Redefine o RowColumnPivotHierarchy para os valores padrão.
RowColumnPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) Adiciona o PivotHierarchy ao eixo atual.
getCount() Obtém o número de hierarquias dinâmicas na coleção.
getItem(name: string) Obtém uma RowColumnPivotHierarchy por seu nome ou ID.
getItemOrNullObject(name: string) Obtém um RowColumnPivotHierarchy por nome.
items Obtém os itens filhos carregados nesta coleção.
remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy) Remove o PivotHierarchy do eixo atual.
Tempo de execução enableEvents Alterne eventos JavaScript no painel de tarefas atual ou no suplemento de conteúdo.
ShowAsRule 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.
Cálculo O ShowAs cálculo a ser usado para o PivotField.
Estilo autoIndent Especifica se o texto é recuado automaticamente quando o alinhamento de texto em uma célula é definido como distribuição igual.
textOrientation A orientação de texto para o estilo.
Subtotals automatic Se Automatic estiver definido como true, todos os outros valores serão ignorados ao definir o Subtotals.
Média
Count
countNumbers
Max
Min
Produto
standardDeviation
standardDeviationP
Soma
Variância
varianceP
Table legacyId Retorna uma ID numérica.
TableChangedEventArgs getRange(ctx: Excel.RequestContext) Obtém o intervalo que representa a área alterada de uma tabela em uma planilha específica.
getRangeOrNullObject(ctx: Excel.RequestContext) Obtém o intervalo que representa a área alterada de uma tabela em uma planilha específica.
Pasta de trabalho readOnly Retornará true se a pasta de trabalho estiver aberta no modo somente leitura.
WorkbookCreated
Planilha onCalculado Ocorre quando a planilha é calculada.
showGridlines Especifica se as linhas de grade estão visíveis para o usuário.
showHeadings Especifica se os títulos estão visíveis para o usuário.
WorksheetCalculatedEventArgs tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha na qual o cálculo ocorreu.
WorksheetChangedEventArgs getRange(ctx: Excel.RequestContext) Obtém o intervalo que representa a área alterada de uma planilha específica.
getRangeOrNullObject(ctx: Excel.RequestContext) Obtém o intervalo que representa a área alterada de uma planilha específica.
WorksheetCollection onCalculado Ocorre quando qualquer planilha na pasta de trabalho é calculada.

Confira também