Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
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 APIs
A tabela a seguir lista as APIs no Excel Conjunto de requisitos da API JavaScript 1.8. Para exibir a documentação de referência da API para todas as APIs compatíveis com o 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 |
|---|---|---|
| global | createWorkbook(base64?: string) | Crie e abra uma nova pasta de trabalho. |
| BasicDataValidation | Fórmula 1 | Especifica o operando direito quando a propriedade operator é definida como um operador binário, como GreaterThan (o operando esquerdo é o valor que o usuário tenta inserir na célula). |
| Fórmula2 | 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, fazendo referência ao nível dos rótulos de categoria de origem. |
| displayBlanksAs | Especifica a maneira 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 do 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 nome de série de gráfico, referindo-se ao nível dos nomes de série de origem. | |
| showDataLabelsOverMaximum | Especifica se os rótulos de dados devem ser exibidos quando o valor for maior que o valor máximo no eixo do valor. | |
| style | Especifica o estilo do 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 está ativado. | |
| ChartAddedEventArgs | chartId | Obtém a ID do gráfico 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 a legenda de escala do eixo especificado. |
| isBetweenCategories | Especifica se o eixo dos valores cruza o eixo de categoria entre categorias. | |
| multiNível | Especifica se um eixo é multinível. | |
| numberFormat | Especifica o código de formato para a legenda de escala do eixo. | |
| de deslocamento | Especifica a distância entre os níveis de legendas e a distância entre o primeiro nível e a linha do eixo. | |
| position | Especifica a posição do eixo especificada onde o outro eixo se cruza. | |
| posição | Especifica a posição do eixo onde o outro eixo se cruza. | |
| setPositionAt(value: number) | Define a posição do eixo especificada onde o outro eixo se cruza. | |
| textOrientation | Especifica o ângulo no qual o texto é orientado para o rótulo de escala do eixo do gráfico. | |
| ChartAxisFormat | fill | Especifica a formatação de preenchimento de 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 | Especifica o código de 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 no 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 do rótulo de dados do gráfico. | |
| numberFormat | Especifica o código de formato para rótulos de dados. | |
| textOrientation | Representa o ângulo no 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 está desativado. | |
| ChartDeletedEventArgs | chartId | Obtém a ID do gráfico 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 da 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 de gráfico. | |
| width | Representa a largura da entrada de 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 da altura interna de uma área de plotagem. | |
| insideLeft | Especifica o valor interno esquerdo de uma área de plotagem. | |
| por dentroTopo | Especifica o valor superior interno de uma área de plotagem. | |
| largura interna | Especifica o valor da 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 da largura de uma área de plotagem. | |
| ChartPlotAreaFormat | borda | Especifica os atributos de borda de uma área de plotagem de gráfico. |
| fill | Especifica o formato de preenchimento de um objeto, que inclui informações de formatação do plano de fundo. | |
| 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 rosca. | |
| firstSliceAngle | Especifica o ângulo da primeira fatia do gráfico de pizza ou gráfico de rosca, em graus (no sentido horário a partir da vertical). | |
| invertIfNegative | True se o Excel inverter 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 de pizza ou de barra de pizza como uma porcentagem do tamanho da pizza principal. | |
| splitType | Especifica a forma como as duas seções de um gráfico de pizza ou de barra são divididas. | |
| varyByCategories | Verdadeiro 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 de r-quadrado da linha de tendência for exibido no gráfico. | |
| ChartTrendlineLabel | AutoTexto | Especifica se o rótulo da linha de tendência gera automaticamente o texto apropriado com base no contexto. |
| format | O formato do rótulo da linha de tendência do gráfico. | |
| formula | Valor da cadeia de caracteres que representa a fórmula do rótulo da linha de tendência do gráfico usando a notação no 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 da linha de tendência do gráfico. | |
| left | Representa a distância, em pontos, da borda esquerda do rótulo da linha de tendência do gráfico até a borda esquerda da área do gráfico. | |
| numberFormat | Valor da cadeia de caracteres que representa o código de formato para o rótulo da 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 no qual o texto é orientado para o rótulo da linha de tendência do gráfico. | |
| top | Representa a distância, em pontos, da borda superior do rótulo da linha de tendência do gráfico até a parte superior da área do gráfico. | |
| verticalAlignment | Representa o alinhamento vertical do rótulo da 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 da borda, que inclui cor, estilo de linha e espessura. |
| fill | Especifica o formato de preenchimento do rótulo da 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 da 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 exibidos como um cálculo de resumo específico. | |
| summarizeBy | Especifica se todos os itens da 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 uma 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 de 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. |
| mostrarAlerta | Especifica se uma caixa de diálogo de alerta de erro deve ser mostrada 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 de 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 para o 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 do texto. | |
| time | Critérios de validação de dados de tempo. | |
| wholeNumber | Critérios de validação de dados de número inteiro. | |
| DateTimeDataValidation | Fórmula 1 | Especifica o operando direito quando a propriedade operator é definida como um operador binário, como GreaterThan (o operando esquerdo é o valor que o usuário tenta inserir na célula). |
| Fórmula2 | 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 uma 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 a lista será exibida em uma lista suspensa de célula. |
| source | Fonte da lista de validação de dados | |
| PivotField | id | ID do PivotField. |
| items | Retorna os Itens Dinâmicos associados ao Campo Dinâmico. | |
| 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 por seu nome ou ID. | |
| getItemOrNullObject(name: string) | Obtém um PivotField por nome. | |
| items | Obtém os itens filhos carregados nesta coleção. | |
| PivotHierarchy | campos | Retorna PivotFields associados a PivotHierarchy. |
| id | ID da Hierarquia Dinâmica. | |
| 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 Item Dinâmico. |
| é expandido | 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 Item Dinâmico está visível. | |
| PivotItemCollection | getCount() | Obtém o número de Itens Dinâmicos na coleção. |
| getItem(name: string) | Obtém um PivotItem por seu nome ou ID. | |
| getItemOrNullObject(name: string) | Obtém um PivotItem por 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 gerais para colunas. | |
| showRowGrandTotals | Especifica se o relatório de Tabela Dinâmica mostra totais gerais para linhas. | |
| subtotalLocation | Esta propriedade indica a 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. | |
| de dispositivos móveis | O PivotLayout descreve o layout e estrutura visual da Tabela Dinâmica. | |
| rowHierarquias | As hierarquias de pivô de linha da Tabela Dinâmica. | |
| PivotTableCollection | add(name: string, source: Intervalo | string | Tabela, destino: Intervalo | cadeia de caracteres) | Adicione uma Tabela Dinâmica com base nos dados de origem especificados e insira-a 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 da 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 suplemento de conteúdo. |
| ShowAsRule | baseField | O PivotField no qual basear o ShowAs cálculo, se aplicável de acordo com o ShowAsCalculation tipo, else null. |
| baseItem | O item no qual basear o ShowAs cálculo, se aplicável de acordo com o ShowAsCalculation tipo, else null. |
|
| de cálculo | O ShowAs cálculo a ser usado para o PivotField. |
|
| Estilo | autoIndent | Especifica se o texto é recuado automaticamente quando o alinhamento do texto em uma célula é definido como distribuição igual. |
| textOrientation | A orientação de texto para o estilo. | |
| Subtotals | automatic | Se Automatic for definido como true, todos os outros valores serão ignorados ao definir o Subtotals. |
| Média | ||
| Count | ||
| countNumbers | ||
| máx. | ||
| Mín. | ||
| Produto | ||
| desvio padrão | ||
| desvio-padrãoP | ||
| 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 | Retorna true se a pasta de trabalho estiver aberta no modo somente leitura. |
| WorkbookCreated | O WorkbookCreated objeto é o objeto de nível superior criado pelo Application.CreateWorkbook. |
|
| Planilha | onCalculated | Ocorre quando a planilha é calculada. |
| mostrar Linhas de grade | Especifica se as linhas de grade são visíveis para o usuário. | |
| showHeadings | Especifica se os títulos sã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 | onCalculated | Ocorre quando qualquer planilha na pasta de trabalho é calculada. |