Share via

APIs de visualização do JavaScript para Excel

  • Artigo

As novas APIs do JavaScript para Excel são introduzidas pela primeira vez na "visualização" e, posteriormente, tornam-se parte de um conjunto específico de requisitos numerados, após passarem por vários testes e após a recolha das opiniões de usuários.

Observação

As APIs de visualização estão sujeitas a alterações e não se destinam ao uso em um ambiente de produção. Recomendamos que você experimente apenas em ambiente de teste e desenvolvimento. Não use APIs de visualização em um ambiente de produção ou em documentos essenciais aos negócios.

Para usar APIs de visualização:

A tabela a seguir fornece um resumo conciso das APIs, enquanto a tabela de lista de API subsequente fornece uma lista detalhada.

Área de recurso Descrição Objetos relevantes
Tarefas de documento Transforme comentários em tarefas atribuídas aos usuários. DocumentTask, DocumentTaskChange, DocumentTaskChangeCollection, DocumentTaskCollection
Tipos de dados vinculados Adiciona suporte para tipos de dados conectados ao Excel de fontes externas. LinkedDataType, LinkedDataTypeAddedEventArgs, LinkedDataTypeCollection
Table styles Fornece controle para fonte, borda, cor de preenchimento e outros aspectos dos estilos de tabela. Tabela, Tabela Dinâmica, Segmentação

Lista de API

A tabela a seguir lista as APIs JavaScript do Excel atualmente em versão prévia. Para obter uma lista completa de todas as APIs JavaScript do Excel (incluindo APIs prévias e APIs lançadas anteriormente), consulte todas as APIs JavaScript do Excel.

Classe Campos Descrição
Aplicativo formatStaleValues Especifica se a opção Formatar Valores Obsoletos em Opções de Cálculo está habilitada ou desabilitada.
Base64EncodedImage data A codificação de cadeia de caracteres base64.
type O tipo de arquivo da imagem codificada.
Gráfico getDataRange() Obtém a fonte de dados de todo o gráfico.
getDataRangeOrNullObject() Obtém a fonte de dados de todo o gráfico.
Comentário assignTask(assignee: Excel.EmailIdentity) Atribui a tarefa anexada ao comentário ao usuário determinado como um atribuídor.
getTask() Obtém a tarefa associada a este comentário.
getTaskOrNullObject() Obtém a tarefa associada a este comentário.
CommentReply assignTask(assignee: Excel.EmailIdentity) Atribui a tarefa anexada ao comentário ao usuário determinado como o único atribuído.
getTask() Obtém a tarefa associada ao thread desta resposta de comentário.
getTaskOrNullObject() Obtém a tarefa associada ao thread desta resposta de comentário.
DocumentTask assign(assignee: Excel.EmailIdentity) Adiciona o usuário determinado à lista de atribuídos anexados à tarefa.
Cessionários Retorna uma coleção de atribuições da tarefa.
Alterações Obtém os registros de alteração da tarefa.
Comentário Obtém o comentário associado à tarefa.
completedBy Obtém o usuário mais recente a ter concluído a tarefa.
completedDateTime Obtém a data e a hora em que a tarefa foi concluída.
createdBy Obtém o usuário que criou a tarefa.
createdDateTime Obtém a data e a hora em que a tarefa foi criada.
id Obtém a ID da tarefa.
Percentcomplete Especifica o percentual de conclusão da tarefa.
Prioridade Especifica a prioridade da tarefa.
startAndDueDateTime Obtém ou define a data e a hora em que a tarefa deve ser iniciada e deve ser concluída.
title Especifica o título da tarefa.
unassign(assignee: Excel.EmailIdentity) Remove o usuário determinado da lista de atribuidores anexados à tarefa.
unassignAll() Remove todos os usuários da lista de atribuidores anexados à tarefa.
DocumentTaskChange Cessionário Representa o usuário atribuído à tarefa para uma assign ação de alteração ou o usuário não assinado da tarefa para uma unassign ação de alteração.
changedBy Representa a identidade do usuário que fez a alteração da tarefa.
commentId Representa a ID do comment ou commentReply ao qual a alteração de tarefa está ancorada.
createdDateTime Representa a data e a hora da criação do registro de alteração de tarefa.
dueDateTime Representa a data e a hora da tarefa.
id O GUID exclusivo da alteração da tarefa.
Percentcomplete Representa o percentual de conclusão da tarefa.
Prioridade Representa a prioridade da tarefa.
startDateTime Representa a data e a hora de início da tarefa.
title Representa o título da tarefa.
type Representa o tipo de ação do registro de alteração de tarefa.
undoChangeId Representa a DocumentTaskChange.id propriedade que foi desfeita para a ação undo de alteração.
DocumentTaskChangeCollection getCount() Obtém o número de registros de alteração na coleção para a tarefa.
getItemAt(index: number) Obtém um registro de alteração de tarefa usando seu índice na coleção.
items Obtém os itens filhos carregados nesta coleção.
DocumentTaskCollection getCount() Obtém o número de tarefas na coleção.
getItem(key: string) Obtém uma tarefa usando sua ID.
getItemAt(index: number) Obtém uma tarefa por seu índice na coleção.
getItemOrNullObject(key: string) Obtém uma tarefa usando sua ID.
items Obtém os itens filhos carregados nesta coleção.
DocumentTaskSchedule dueDateTime Obtém a data e a hora que a tarefa deve ser entregue.
startDateTime Obtém a data e a hora que a tarefa deve iniciar.
EmailIdentity displayName Representa o nome para exibição do usuário.
email Representa o email do usuário.
id Representa a ID exclusiva do usuário.
EntityArrayCardLayout arrayProperty Representa o nome da propriedade que contém a matriz mostrada no cartão.
columnsToReport Representa a contagem de colunas que as declarações cartão estão na matriz.
displayName Representa o nome da propriedade que contém a matriz mostrada no cartão.
firstRowIsHeader Representa se a primeira linha da matriz é tratada como um cabeçalho.
Layout Representa o tipo desse layout.
rowsToReport Representa a contagem de linhas que as declarações cartão estão na matriz.
EntityCardLayout Layout Representa o tipo desse layout.
ExternalCodeServiceObjectCellValue Python_str Representa a saída da função str() quando usada neste objeto.
Python_type Representa o nome de tipo completo desse objeto.
Python_typeName Representa o nome de tipo curto desse objeto.
basicType Representa o valor que seria retornado por Range.valueTypes para uma célula com esse valor.
basicValue Representa o valor que seria retornado por Range.values para uma célula com esse valor.
Língua Representa a linguagem de runtime deste serviço de código externo.
visualização Representa o valor de visualização mostrado na célula.
type Representa o tipo desse valor de célula.
Identity displayName Representa o nome para exibição do usuário.
id Representa a ID exclusiva do usuário.
LinkedDataType Dataprovider O nome do provedor de dados para o tipo de dados vinculado.
lastRefreshed A data e a hora do fuso horário local desde que a pasta de trabalho foi aberta quando o tipo de dados vinculado foi atualizado pela última vez.
name O nome do tipo de dados vinculado.
periodicRefreshInterval A frequência, em segundos, na qual o tipo de dados vinculado é atualizado se refreshMode estiver definido como "Periódico".
Refreshmode O mecanismo pelo qual os dados do tipo de dados vinculados são recuperados.
requestRefresh() Faz uma solicitação para atualizar o tipo de dados vinculado.
requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode) Faz uma solicitação para alterar o modo de atualização desse tipo de dados vinculado.
serviceId A ID exclusiva do tipo de dados vinculado.
supportedRefreshModes Retorna uma matriz com todos os modos de atualização compatíveis com o tipo de dados vinculado.
LinkedDataTypeAddedEventArgs serviceId A ID exclusiva do novo tipo de dados vinculado.
source Obtém a origem do evento.
tipo Obtém o tipo do evento.
LinkedDataTypeCollection getCount() Obtém o número de tipos de dados vinculados na coleção.
getItem(key: number) Obtém um tipo de dados vinculado por ID do serviço.
getItemAt(index: number) Obtém um tipo de dados vinculado por seu índice na coleção.
getItemOrNullObject(chave: número) Obtém um tipo de dados vinculado por ID.
items Obtém os itens filhos carregados nesta coleção.
requestRefreshAll() Faz uma solicitação para atualizar todos os tipos de dados vinculados na coleção.
LocalImageCellValue altText Representa o texto alternativo usado em cenários de acessibilidade para descrever o que a imagem representa.
attribution Representa informações de atribuição para descrever os requisitos de origem e licença para essa imagem.
basicType Representa o valor que seria retornado por Range.valueTypes para uma célula com esse valor.
basicValue Representa o valor que seria retornado por Range.values para uma célula com esse valor.
image Representa a imagem em si, armazenada em cache ou codificada.
Provedor Representa informações que descrevem a entidade ou o indivíduo que forneceu a imagem.
type Representa o tipo desse valor de célula.
LocalImageCellValueCacheId cacheUid Representa o UID da imagem como ela aparece no cache.
NamedSheetViewCollection getItemOrNullObject(key: string) Obtém uma exibição de planilha usando seu nome.
PivotLayout getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>) Obtém uma célula exclusiva na tabela dinâmica com base em uma hierarquia de dados, bem como os itens de linha e coluna de suas respectivas hierarquias.
pivotStyle O estilo aplicado à Tabela Dinâmica.
setStyle(style: string | PivotTableStyle | BuiltInPivotTableStyle) Define o estilo aplicado à Tabela Dinâmica.
PythonErrorCellValue basicType Representa o valor que seria retornado por Range.valueTypes para uma célula com esse valor.
basicValue Representa o valor que seria retornado por Range.values para uma célula com esse valor.
Errortype Representa o tipo de ErrorCellValue.
type Representa o tipo desse valor de célula.
Query delete() Exclui a consulta e a conexão associada.
refresh() Atualiza a consulta.
QueryCollection refreshAll() Atualize todas as consultas.
Range
RangeAreas
RefreshModeChangedEventArgs Refreshmode O modo de atualização do tipo de dados vinculado.
serviceId A ID exclusiva do objeto cujo modo de atualização foi alterado.
source Obtém a origem do evento.
tipo Obtém o tipo do evento.
RefreshRequestCompletedEventArgs Atualizada Indica se a solicitação de atualização foi bem-sucedida.
serviceId A ID exclusiva do objeto cuja solicitação de atualização foi concluída.
source Obtém a origem do evento.
tipo Obtém o tipo do evento.
Avisos Uma matriz que contém quaisquer avisos gerados a partir da solicitação de atualização.
ShapeCollection addSvg(xml: string) Cria um gráfico vetorial escalável (SVG) de uma cadeia de caracteres XML e a adiciona à planilha.
Segmentação de dados nameInFormula Representa o nome da segmentação de dados usada na fórmula.
setStyle(style: string | SlicerStyle | BuiltInSlicerStyle) Define o estilo aplicado à segmentação.
slicerStyle O estilo aplicado à segmentação.
Table clearStyle() Altera a tabela para usar o estilo de tabela padrão.
onFiltered Ocorre quando um filtro é aplicado em uma tabela específica.
setStyle(style: string | TableStyle | BuiltInTableStyle) Define o estilo aplicado à tabela.
Tablestyle O estilo aplicado à tabela.
TableCollection onFiltered Ocorre quando um filtro é aplicado em qualquer tabela em uma pasta de trabalho ou em uma planilha.
TableFilteredEventArgs tableId Obtém a ID da tabela na qual o filtro é aplicado.
tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha que contém a tabela.
TimeoutErrorCellValue basicType Representa o valor que seria retornado por Range.valueTypes para uma célula com esse valor.
basicValue Representa o valor que seria retornado por Range.values para uma célula com esse valor.
Errorsubtype Representa o tipo de TimeoutErrorCellValue.
Errortype Representa o tipo de ErrorCellValue.
type Representa o tipo desse valor de célula.
Pasta de trabalho externalCodeServiceTimeout Especifica o tempo máximo, em segundos, alocado para uma fórmula que depende da conclusão de um serviço de código externo.
linkedDataTypes Retorna uma coleção de tipos de dados vinculados que fazem parte da pasta de trabalho.
showPivotFieldList Especifica se o painel de lista de campos da Tabela Dinâmica é mostrado no nível da pasta de trabalho.
tarefas Retorna uma coleção de tarefas presentes na pasta de trabalho.
use1904DateSystem True se a pasta de trabalho usar o sistema de dados 1904.
Worksheet onFiltered Ocorre quando um filtro é aplicado em uma planilha específica.
tarefas Retorna uma coleção de tarefas presentes na planilha.
WorksheetCollection addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Planilha | cadeia de caracteres) Insere as planilhas especificadas de uma pasta de trabalho na pasta de trabalho atual.
onFiltered Ocorre quando filtro de uma planilha é aplicado na pasta de trabalho.
WorksheetFilteredEventArgs tipo Obtém o tipo do evento.
worksheetId Obtém a ID da planilha na qual o filtro é aplicado.

Confira também