Conjunto de requisitos da API javaScript do Excel 1.1
A API JavaScript do Excel 1.1 é a primeira versão da API. É o único conjunto de requisitos específico do Excel suportado pelo Excel 2016.
Lista de API
A tabela seguinte lista as APIs no excel JavaScript API requirement set 1.1. Para ver a documentação de referência da API para todas as APIs suportadas pelo conjunto de requisitos da API JavaScript do Excel 1.1, veja APIs do Excel no conjunto de requisitos 1.1.
Classe | Campos | Descrição |
---|---|---|
Aplicativo | calculate(calculationType: Excel.CalculationType) | Recalcula todas as pastas de trabalho abertas no Excel no momento. |
calculationMode | Devolve o modo de cálculo utilizado no livro, conforme definido pelas constantes em Excel.CalculationMode . |
|
Associação | getRange() | Retorna o intervalo representado pela associação. |
getTable() | Retorna a tabela representada pela associação. | |
getText() | Retorna o texto representado pela associação. | |
id | Representa o identificador de enlace. | |
type | Retorna o tipo da associação. | |
BindingCollection | Count | Retorna o número de associações da coleção. |
getItem(id: string) | Obtém um objeto de associação pela ID. | |
getItemAt(index: number) | Obtém um objeto de associação com base em sua posição na matriz dos itens. | |
items | Obtém os itens filhos carregados nesta coleção. | |
Gráfico | eixos | Representa os eixos de um gráfico. |
dataLabels | Representa os rótulos de dados no gráfico. | |
delete() | Exclui o objeto de gráfico. | |
format | Encapsula as propriedades de formato da área do gráfico. | |
height | Especifica a altura, em pontos, do objeto de gráfico. | |
left | A distância, em pontos, da esquerda do gráfico à origem da planilha. | |
legenda | Representa a legenda do gráfico. | |
name | Especifica o nome de um objeto de gráfico. | |
series | Representa uma única série ou uma coleção de séries no gráfico. | |
setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy) | Redefine os dados de origem do gráfico. | |
setPosition(startCell: Intervalo | cadeia, endCell?: Intervalo | cadeia) | Posiciona o gráfico em relação às células na planilha. | |
title | Representa o título do gráfico especificado, incluindo o respectivo texto, a visibilidade, a posição e a formatação. | |
top | Especifica a distância, em pontos, desde a margem superior do objeto até à parte superior da linha 1 (numa folha de cálculo) ou à parte superior da área do gráfico (num gráfico). | |
width | Especifica a largura, em pontos, do objeto de gráfico. | |
ChartAreaFormat | fill | Representa o formato de preenchimento de um objeto, que inclui informações sobre a formatação da tela de fundo. |
font | Representa os atributos de fonte do objeto atual, como nome, tamanho, cor, dentre outros. | |
ChartAxes | categoryAxis | Representa o eixo de categoria em um gráfico. |
seriesAxis | Representa o eixo da série de um gráfico 3D. | |
valueAxis | Representa o eixo dos valores em um eixo. | |
ChartAxis | format | Representa a formatação de um objeto Chart, que inclui formatação de linha e de fonte. |
majorGridlines | Devolve um objeto que representa as principais linhas de grelha do eixo especificado. | |
majorUnit | Representa o intervalo entre as duas principais marcas de escala. | |
maximum | Representa o valor máximo no eixo dos valores. | |
minimum | Representa o valor mínimo no eixo dos valores. | |
minorGridlines | Devolve um objeto que representa as linhas de grelha secundárias do eixo especificado. | |
minorUnit | Representa o intervalo entre as duas marcas de escala secundárias. | |
title | Representa o título do eixo. | |
ChartAxisFormat | font | Especifica os atributos do tipo de letra (nome do tipo de letra, tamanho do tipo de letra, cor, etc.) para um elemento do eixo do gráfico. |
line | Especifica a formatação de linhas do gráfico. | |
ChartAxisTitle | format | Especifica a formatação do título do eixo do gráfico. |
text | Especifica o título do eixo. | |
visible | Especifica se o título do eixo está visível. | |
ChartAxisTitleFormat | font | Especifica os atributos de tipo de letra do título do eixo do gráfico, como o nome do tipo de letra, o tamanho do tipo de letra ou a cor, do objeto de título do eixo do gráfico. |
ChartCollection | add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy) | Cria um novo gráfico. |
Count | Retorna o número de gráficos da planilha. | |
getItem(name: string) | Obtém um gráfico usando o respectivo nome. | |
getItemAt(index: number) | Obtém um gráfico com base em sua posição no conjunto. | |
items | Obtém os itens filhos carregados nesta coleção. | |
ChartDataLabelFormat | fill | Representa o formato de preenchimento do rótulo de dados atual do gráfico. |
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 uma etiqueta de dados do gráfico. | |
ChartDataLabels | format | Especifica o formato das etiquetas de dados do gráfico, que inclui a formatação de tipo de letra e preenchimento. |
position | Valor que representa a posição da etiqueta de dados. | |
separador | Cadeia de caracteres que representa o separador usado para os rótulos 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. | |
ChartFill | clear() | Limpa a cor de preenchimento de um elemento de gráfico. |
setSolidColor(color: string) | Define a formatação de preenchimento de um elemento do gráfico com uma cor uniforme. | |
ChartFont | bold | Representa o status da fonte em negrito. |
color | Representação do código de cores HTML da cor do texto (por exemplo, #FF0000 representa Vermelho). | |
italic | Representa o status da fonte em itálico. | |
name | Nome do tipo de letra (por exemplo, "Calibri") | |
size | Tamanho do tipo de letra (por exemplo, 11) | |
underline | Tipo de sublinhado aplicado à fonte. | |
ChartGridlines | format | Representa a formatação de linhas de grade do gráfico. |
visible | Especifica se as linhas de grelha do eixo estão visíveis. | |
ChartGridlinesFormat | line | Representa a formatação de linha do gráfico. |
ChartLegend | format | Representa a formatação de uma legenda de gráfico, que inclui a formatação de fonte e de preenchimento. |
overlay | Especifica se a legenda do gráfico deve sobrepor-se ao corpo main do gráfico. | |
position | Especifica a posição da legenda no gráfico. | |
visible | Especifica se a legenda do gráfico está visível. | |
ChartLegendFormat | fill | Representa o formato de preenchimento de um objeto, que inclui informações sobre a formatação da tela de fundo. |
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 uma legenda de gráfico. | |
ChartLineFormat | clear() | Limpa o formato de linha de um elemento de gráfico. |
color | Código de cores HTML que representa a cor das linhas no gráfico. | |
ChartPoint | format | Encapsula as propriedades de formato de um ponto do gráfico. |
value | Retorna o valor de um ponto do gráfico. | |
ChartPointFormat | fill | Representa o formato de preenchimento de um gráfico, que inclui informações de formatação de fundo. |
ChartPointsCollection | Count | Retorna o número de pontos do gráfico da série. |
getItemAt(index: number) | Recupera um ponto com base na respectiva posição dentro da série. | |
items | Obtém os itens filhos carregados nesta coleção. | |
ChartSeries | format | Representa a formatação de uma série do gráfico, que inclui a formatação de linha e de preenchimento. |
name | Especifica o nome de uma série num gráfico. | |
pontos | Devolve uma coleção de todos os pontos da série. | |
ChartSeriesCollection | Count | Retorna o número de série da coleção. |
getItemAt(index: number) | Recupera uma série com base na respectiva posição na coleção. | |
items | Obtém os itens filhos carregados nesta coleção. | |
ChartSeriesFormat | fill | Representa o formato de preenchimento de uma série do gráfico, que inclui informações sobre a formatação da tela de fundo. |
line | Representa a formatação de linha. | |
ChartTitle | format | Representa a formatação de um título do gráfico, que inclui a formatação de fonte e de preenchimento. |
overlay | Especifica se o título do gráfico irá sobrepor o gráfico. | |
text | Especifica o texto do título do gráfico. | |
visible | Especifica se o título do gráfico está visível. | |
ChartTitleFormat | fill | Representa o formato de preenchimento de um objeto, que inclui informações sobre a formatação da tela de fundo. |
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. | |
NamedItem | getRange() | Retorna o objeto Range associado ao nome. |
name | O nome do objeto. | |
type | Especifica o tipo do valor devolvido pela fórmula do nome. | |
value | Representa o valor calculado pela fórmula do nome. | |
visible | Especifica se o objeto está visível. | |
NamedItemCollection | getItem(name: string) | Obtém um NamedItem objeto com o respetivo nome. |
items | Obtém os itens filhos carregados nesta coleção. | |
Range | address | Especifica a referência de intervalo no estilo A1. |
addressLocal | Representa a referência de intervalo para o intervalo especificado no idioma do utilizador. | |
cellCount | Especifica o número de células no intervalo. | |
clear(applyTo?: Excel.ClearApplyTo) | Limpar valores de intervalo e formatação, como preenchimento e limite. | |
columnCount | Especifica o número total de colunas no intervalo. | |
columnIndex | Especifica o número da coluna da primeira célula no intervalo. | |
delete(shift: Excel.DeleteShiftDirection) | Exclui as células associadas ao intervalo. | |
format | Retorna um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo. | |
fórmulas | Representa a fórmula em notação A1. | |
formulasLocal | Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. | |
getBoundingRect(anotherRange: Intervalo | cadeia) | Obtém o menor objeto de intervalo que abrange os intervalos determinados. | |
getCell(row: number, column: number) | Obtém o objeto de intervalo que contém a célula única com base nos números de linha e de coluna. | |
getColumn(column: number) | Obtém uma coluna incluída no intervalo. | |
getEntireColumn() | Obtém um objeto que representa toda a coluna do intervalo (por exemplo, se o intervalo atual representar as células "B4:E11", 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 representar as células "B4:E11", GetEntireRow é um intervalo que representa as linhas "4:11"). |
|
getIntersection(anotherRange: Intervalo | cadeia) | Obtém o objeto de intervalo que representa a interseção retangular dos intervalos determinados. | |
getLastCell() | Obtém a última célula do intervalo. | |
getLastColumn() | Obtém a última coluna do intervalo. | |
getLastRow() | Obtém a última linha do intervalo. | |
getOffsetRange(rowOffset: number, columnOffset: number) | Obtém um objeto que representa um intervalo deslocado do intervalo especificado. | |
getRow(row: number) | Obtém uma linha contida no intervalo. | |
insert(shift: Excel.InsertShiftDirection) | 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. | |
numberFormat | Representa o código de formato de número do Excel para o intervalo especificado. | |
rowCount | Retorna o número total de linhas no intervalo. | |
rowIndex | Representa o número de linhas da primeira célula no intervalo. | |
Seleciona. | Seleciona o intervalo especificado na interface do usuário do Excel. | |
text | Valores de texto do intervalo especificado. | |
valueTypes | Especifica o tipo de dados em cada célula. | |
values | Representa os valores brutos do intervalo especificado. | |
worksheet | A planilha que contém o intervalo atual. | |
RangeBorder | color | Código de cores HTML que representa a cor da linha de limite, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja"). |
sideIndex | Valor constante que indica o lado específico da borda. | |
style | Uma das constantes de estilo de linha especificando o estilo de linha da borda. | |
peso | Especifica o peso da borda em torno de um intervalo. | |
RangeBorderCollection | Count | Número de objetos de borda da coleção. |
getItem(índice: Excel.BorderIndex) | Obtém um objeto Border usando o respectivo nome. | |
getItemAt(index: number) | Obtém um objeto Border usando o respectivo índice. | |
items | Obtém os itens filhos carregados nesta coleção. | |
RangeFill | clear() | Redefine a tela de fundo do intervalo. |
color | Código de cores HTML que representa a cor do fundo, no formulário #RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por exemplo, "laranja") | |
RangeFont | bold | Representa a status a negrito do tipo de letra. |
color | Representação do código de cores HTML da cor do texto (por exemplo, #FF0000 representa Vermelho). | |
italic | Especifica o status itálico do tipo de letra. | |
name | Nome do tipo de letra (por exemplo, "Calibri"). | |
size | Font Size | |
underline | Tipo de sublinhado aplicado à fonte. | |
RangeFormat | Borders | Coleção de objetos border que se aplicam a todo o intervalo. |
fill | Retorna o objeto de preenchimento definido em todo o intervalo. | |
font | Retorna o objeto font definido em todo o intervalo. | |
horizontalAlignment | Representa o alinhamento horizontal do objeto especificado. | |
verticalAlignment | Representa o alinhamento vertical do objeto especificado. | |
wrapText | Especifica se o Excel molda o texto no objeto. | |
Table | colunas | Representa uma coleção de todas as colunas na tabela. |
delete() | Exclui a tabela. | |
getDataBodyRange() | Obtém o objeto de intervalo associado ao corpo de dados da tabela. | |
getHeaderRowRange() | Obtém o objeto de intervalo associado à linha de cabeçalho da tabela. | |
getRange() | Obtém o objeto de intervalo associado a toda a tabela. | |
getTotalRowRange() | Obtém o objeto de intervalo associado à linha de totais da tabela. | |
id | Retorna um valor que identifica de forma exclusiva a tabela em uma determinada pasta de trabalho. | |
name | Nome da tabela. | |
rows | Representa uma coleção de todas as linhas na tabela. | |
showHeaders | Especifica se a linha de cabeçalho está visível. | |
showTotals | Especifica se a linha total está visível. | |
style | Valor constante que representa o estilo de tabela. | |
TableCollection | add(address: Range | string, hasHeaders: booleano) | Cria uma nova tabela. |
Count | Retorna o número de tabelas na pasta de trabalho. | |
getItem(key: string) | Obtém uma tabela pelo nome ou ID. | |
getItemAt(index: number) | Obtém uma tabela com base em sua posição na coleção. | |
items | Obtém os itens filhos carregados nesta coleção. | |
TableColumn | delete() | Exclui a coluna da tabela. |
getDataBodyRange() | Obtém o objeto de intervalo associado ao corpo de dados da coluna. | |
getHeaderRowRange() | Obtém o objeto de intervalo associado à linha de cabeçalho da coluna. | |
getRange() | Obtém o objeto de intervalo associado a toda a coluna. | |
getTotalRowRange() | Obtém o objeto de intervalo associado à linha de totais da coluna. | |
id | Retorna uma chave exclusiva que identifica a coluna na tabela. | |
índice | Retorna o número de índice da coluna na coleção de colunas da tabela. | |
name | Especifica o nome da coluna da tabela. | |
values | Representa os valores brutos do intervalo especificado. | |
TableColumnCollection | add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string) | Adiciona uma nova coluna à tabela. |
Count | Retorna o número de colunas na tabela. | |
getItem(chave: número | cadeia) | Obtém um objeto de coluna por nome ou ID. | |
getItemAt(index: number) | Obtém uma coluna com base em sua posição na coleção. | |
items | Obtém os itens filhos carregados nesta coleção. | |
TableRow | delete() | Exclui a linha da tabela. |
getRange() | Retorna o objeto de intervalo associado a toda a linha. | |
índice | Retorna o número de índice da linha na coleção de linhas da tabela. | |
values | Representa os valores brutos do intervalo especificado. | |
TableRowCollection | add(índice?: número, valores?:<<Matriz booleana | cadeia | número>> | booleano | cadeia | número, alwaysInsert?: booleano) | Adiciona uma ou mais linhas à tabela. |
Count | Retorna o número de linhas na tabela. | |
getItemAt(index: number) | Obtém uma linha com base em sua posição na coleção. | |
items | Obtém os itens filhos carregados nesta coleção. | |
Pasta de trabalho | application | Representa a instância da aplicação Excel que contém este livro. |
bindings | Representa uma coleção de ligações que fazem parte da pasta de trabalho. | |
getSelectedRange() | Obtém o intervalo único selecionado atualmente a partir do livro. | |
nomes | Representa uma coleção de itens nomeados com âmbito de livro (intervalos com nome e constantes). | |
tabelas | Representa uma coleção de tabelas associadas à pasta de trabalho. | |
folhas de cálculo | Representa uma coleção de planilhas associadas à pasta de trabalho. | |
Planilha | activate() | Ative a planilha na interface do usuário do Excel. |
gráficos | Devolve uma coleção de gráficos que fazem parte da folha de cálculo. | |
delete() | Exclui a planilha da pasta de trabalho. | |
getCell(row: number, column: number) | Obtém o Range objeto que contém a única célula com base nos números de linha e coluna. |
|
getRange(endereço?: cadeia) | Obtém o Range objeto, representando um único bloco retangular de células, especificado pelo endereço ou nome. |
|
id | Retorna um valor que identifica de forma exclusiva a planilha em uma determinada pasta de trabalho. | |
name | O nome de exibição da planilha. | |
position | A posição baseada em zero da planilha na pasta de trabalho. | |
tabelas | Coleção de tabelas que fazem parte da planilha. | |
visibilidade | A visibilidade da planilha. | |
WorksheetCollection | add(name?: string) | Adiciona uma nova planilha à pasta de trabalho. |
getActiveWorksheet() | Obtém a planilha ativa no momento na pasta de trabalho. | |
getItem(key: string) | Obtém um objeto de planilha usando o nome ou ID dele. | |
items | Obtém os itens filhos carregados nesta coleção. |
Confira também
Colabore connosco no GitHub
A origem deste conteúdo pode ser encontrada no GitHub, onde também pode criar e rever problemas e pedidos Pull. Para mais informações, consulte o nosso guia do contribuidor.