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 seguinte fornece um resumo conciso das APIs, enquanto a tabela da lista de API subsequente apresenta uma lista detalhada.

Área de recurso Descrição Objetos relevantes
Tarefas de documentos Transforme os comentários em tarefas atribuídas aos utilizadores. DocumentTask, DocumentTaskChange, DocumentTaskChangeCollection, DocumentTaskCollection
Tipos de dados ligados Adiciona suporte para tipos de dados ligados ao Excel a partir de origens externas. LinkedDataType, LinkedDataTypeAddedEventArgs, LinkedDataTypeCollection
Table styles Fornece controlo para o tipo de letra, limite, cor de preenchimento e outros aspetos dos estilos de tabela. Tabela, Tabela Dinâmica, Segmentação de Dados

Lista de API

A tabela seguinte lista as APIs javaScript do Excel atualmente em pré-visualização. Para obter uma lista completa de todas as APIs JavaScript do Excel (incluindo APIs de pré-visualização e APIs lançadas anteriormente), veja todas as APIs JavaScript do Excel.

Classe Campos Descrição
Aplicativo formatStaleValues Especifica se a opção Formatar Valores Obsoletos nas Opções de Cálculo está ativada ou desativada.
Base64EncodedImage data A cadeia codificada em Base64.
type O tipo de ficheiro da imagem codificada em Base64.
BlockedErrorCellValue errorSubType Representa o tipo de BlockedErrorCellValue.
BusyErrorCellValue errorSubType Representa o tipo de BusyErrorCellValue.
CalcErrorCellValue errorSubType Representa o tipo de CalcErrorCellValue.
Gráfico getDataRange() Obtém a origem de dados de todo o gráfico.
getDataRangeOrNullObject() Obtém a origem de dados de todo o gráfico.
CheckboxCellControl type Representa um controlo interacionável dentro de uma célula.
Comentário assignTask(assignee: Excel.EmailIdentity) Atribui a tarefa anexada ao comentário ao utilizador especificado como um destinatário.
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 utilizador especificado como o único destinatário.
getTask() Obtém a tarefa associada ao tópico desta resposta de comentário.
getTaskOrNullObject() Obtém a tarefa associada ao tópico desta resposta de comentário.
ConnectErrorCellValue errorSubType Representa o tipo de ConnectErrorCellValue.
DatetimeFormatInfo shortDateTimePattern Obtém a cadeia de formato para um valor de data e hora abreviado.
DocumentTask assign(assignee: Excel.EmailIdentity) Adiciona o utilizador especificado à lista de detentores anexados à tarefa.
detentores Devolve uma coleção de detentores da tarefa.
alterações Obtém os registos de alteração da tarefa.
comentário Obtém o comentário associado à tarefa.
completedBy Faz com que o utilizador mais recente tenha concluído a tarefa.
completedDateTime Obtém a data e hora em que a tarefa foi concluída.
createdBy Obtém o utilizador que criou a tarefa.
createdDateTime Obtém a data e hora em que a tarefa foi criada.
id Obtém o ID da tarefa.
percentagemComplete Especifica a percentagem de conclusão da tarefa.
prioridade Especifica a prioridade da tarefa.
startAndDueDateTime Obtém ou define a data e hora em que a tarefa deve ser iniciada e está para conclusão.
title Especifica o título da tarefa.
unassign(assignee: Excel.EmailIdentity) Remove o utilizador especificado da lista de detentores anexados à tarefa.
unassignAll() Remove todos os utilizadores da lista de detentores anexados à tarefa.
DocumentTaskChange atribuir Representa o utilizador atribuído à tarefa para uma ação de alteração assign ou o utilizador não atribuído da tarefa para uma unassign ação de alteração.
alterado Por Representa a identidade do utilizador que efetuou a alteração da tarefa.
commentId Representa o ID da resposta do comentário ou comentário ao qual a alteração da tarefa está ancorada.
createdDateTime Representa a data e hora de criação do registo de alteração da tarefa.
dueDateTime Representa a data e hora para conclusão da tarefa.
id O GUID exclusivo da alteração da tarefa.
percentagemComplete Representa a percentagem de conclusão da tarefa.
prioridade Representa a prioridade da tarefa.
startDateTime Representa a data e hora de início da tarefa.
title Representa o título da tarefa.
type Representa o tipo de ação do registo de alteração de tarefa.
anularChangeId Representa a DocumentTaskChange.id propriedade que foi anulada para a ação undo de alteração.
DocumentTaskChangeCollection getCount() Obtém o número de registos de alterações na coleção da tarefa.
getItemAt(index: number) Obtém um registo de alteração de tarefas com o respetivo í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 com o respetivo ID.
getItemAt(index: number) Obtém uma tarefa através do respetivo índice na coleção.
getItemOrNullObject(key: string) Obtém uma tarefa com o respetivo ID.
items Obtém os itens filhos carregados nesta coleção.
DocumentTaskSchedule dueDateTime Obtém a data e hora para conclusão da tarefa.
startDateTime Obtém a data e hora que a tarefa deve iniciar.
EmailIdentity displayName Representa o nome para exibição do usuário.
email Representa o e-mail do utilizador.
id Representa o ID exclusivo do utilizador.
EmptyCellControl type
EntityArrayCardLayout arrayProperty Representa o nome da propriedade que contém a matriz apresentada no card.
columnsToReport Representa a contagem de colunas que as afirmações de card estão na matriz.
displayName Representa o nome da propriedade que contém a matriz apresentada no card.
firstRowIsHeader Representa se a primeira linha da matriz é tratada como um cabeçalho.
esquema Representa o tipo deste esquema.
rowsToReport Representa a contagem de linhas que as afirmações de card estão na matriz.
EntityCardLayout esquema Representa o tipo deste esquema.
ExternalCodeServiceObjectCellValue Python_str Representa a saída da função str() quando utilizada neste objeto.
Python_type Representa o nome completo deste objeto.
Python_typeName Representa o nome de tipo abreviado deste objeto.
basicType Representa o valor que seria devolvido por para Range.valueTypes uma célula com este valor.
basicValue Representa o valor que seria devolvido por para Range.values uma célula com este valor.
Idioma Representa a linguagem de runtime deste serviço de código externo.
visualização Representa o valor de pré-visualização apresentado na célula.
fornecedor Representa informações sobre o serviço que forneceu os dados neste ExternalCodeServiceObjectCellValue.
type Representa o tipo deste valor de célula.
Identity displayName Representa o nome para exibição do usuário.
id Representa o ID exclusivo do utilizador.
LinkedDataType dataProvider O nome do fornecedor de dados para o tipo de dados ligado.
lastRefreshed A data e hora do fuso horário local desde que o livro foi aberto quando o tipo de dados ligado foi atualizado pela última vez.
name O nome do tipo de dados ligado.
periodicRefreshInterval A frequência, em segundos, na qual o tipo de dados ligado é atualizado se refreshMode estiver definido como "Periódico".
refreshMode O mecanismo através do qual os dados do tipo de dados ligado são obtidos.
requestRefresh() Faz um pedido para atualizar o tipo de dados ligado.
requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode) Faz um pedido para alterar o modo de atualização para este tipo de dados ligado.
serviceId O ID exclusivo do tipo de dados ligado.
supportedRefreshModes Devolve uma matriz com todos os modos de atualização suportados pelo tipo de dados ligado.
LinkedDataTypeAddedEventArgs serviceId O ID exclusivo do novo tipo de dados ligado.
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 ligados na coleção.
getItem(chave: número) Obtém um tipo de dados ligado por ID de serviço.
getItemAt(index: number) Obtém um tipo de dados ligado pelo respetivo índice na coleção.
getItemOrNullObject(chave: número) Obtém um tipo de dados ligado por ID.
items Obtém os itens filhos carregados nesta coleção.
requestRefreshAll() Faz um pedido para atualizar todos os tipos de dados ligados na coleção.
LocalImage getBase64EncodedImageData(cacheUid: cadeia) Obtém os dados de imagem codificados com Base64 armazenados na cache de imagem partilhada com o identificador exclusivo da cache (UID).
LocalImageCellValue altText Representa o texto alternativo utilizado 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 esta imagem.
basicType Representa o valor que seria devolvido por para Range.valueTypes uma célula com este valor.
basicValue Representa o valor que seria devolvido por para Range.values uma célula com este valor.
image Representa a própria imagem, em cache ou codificada.
fornecedor Representa informações que descrevem a entidade ou indivíduo que forneceu a imagem.
type Representa o tipo deste valor de célula.
LocalImageCellValueCacheId cachedUid Representa o UID da imagem tal como aparece na cache.
MixedCellControl type
NameErrorCellValue errorSubType Representa o tipo de NameErrorCellValue.
NamedSheetViewCollection getItemOrNullObject(key: string) Obtém uma vista de folha com o respetivo nome.
NotAvailableErrorCellValue errorSubType Representa o tipo de NotAvailableErrorCellValue.
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.
estilo dinâmico O estilo aplicado à tabela dinâmica.
setStyle(style: string | Estilo de Tabela Dinâmica | BuiltInPivotTableStyle) Define o estilo aplicado à tabela dinâmica.
PythonErrorCellValue basicType Representa o valor que seria devolvido por para Range.valueTypes uma célula com este valor.
basicValue Representa o valor que seria devolvido por para Range.values uma célula com este valor.
errorType Representa o tipo de ErrorCellValue.
type Representa o tipo deste valor de célula.
Query delete() Elimina a consulta e a ligação associada.
refresh() Atualiza a consulta.
QueryCollection refreshAll() Atualize todas as consultas.
Range clearOrResetContents() Limpa os valores das células no intervalo, tendo em consideração especial as células que contêm controlos.
Controlo Acede ao controlo de células aplicado a este intervalo.
RangeAreas clearOrResetContents() Limpa os valores das células nos intervalos, tendo em consideração especial as células que contêm controlos.
RangeTextRun font
text
RefErrorCellValue errorSubType Representa o tipo de RefErrorCellValue.
RefreshModeChangedEventArgs refreshMode O modo de atualização do tipo de dados ligado.
serviceId O ID exclusivo do objeto cujo modo de atualização foi alterado.
source Obtém a origem do evento.
tipo Obtém o tipo do evento.
RefreshRequestCompletedEventArgs atualizado Indica se o pedido de atualização foi efetuado com êxito.
serviceId O ID exclusivo do objeto cujo pedido de atualização foi concluído.
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 do pedido de atualização.
SettableCellProperties textRuns Representa a propriedade textRuns.
ShapeCollection addLocalImageReference(address: string) Cria uma referência para a imagem local armazenada no endereço da célula e apresenta-a como uma forma flutuante sobre as células.
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 | Segmentação de DadosStyle | BuiltInSlicerStyle) Define o estilo aplicado à segmentação de dados.
segmentação de dadosStyle O estilo aplicado à segmentação de dados.
Table clearStyle() Altera a tabela para usar o estilo de tabela padrão.
onFiltered Ocorre quando um filtro é aplicado a 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 num livro ou numa folha de cálculo.
TableFilteredEventArgs tableId Obtém o ID da tabela na qual o filtro é aplicado.
tipo Obtém o tipo do evento.
worksheetId Obtém o ID da folha de cálculo que contém a tabela.
TimeoutErrorCellValue basicType Representa o valor que seria devolvido por para Range.valueTypes uma célula com este valor.
basicValue Representa o valor que seria devolvido por para Range.values uma célula com este valor.
errorSubType Representa o tipo de TimeoutErrorCellValue.
errorType Representa o tipo de ErrorCellValue.
type Representa o tipo deste valor de célula.
UnknownCellControl type
ValueErrorCellValue errorSubType Representa o tipo de ValueErrorCellValue.
Pasta de trabalho externalCodeServiceTimeout Especifica o período máximo de tempo, em segundos, atribuído a uma fórmula que depende de um serviço de código externo a concluir.
linkedDataTypes Devolve uma coleção de tipos de dados ligados que fazem parte do livro.
localImage Devolve o LocalImage objeto associado ao livro.
showPivotFieldList Especifica se o painel de lista de campos da tabela dinâmica é apresentado ao nível do livro.
tarefas Devolve uma coleção de tarefas que estão presentes no livro.
use1904DateSystem True se a pasta de trabalho usar o sistema de dados 1904.
Worksheet onFiltered Ocorre quando um filtro é aplicado numa folha de cálculo específica.
tarefas Devolve uma coleção de tarefas que estão presentes na folha de cálculo.
WorksheetCollection addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Folha de cálculo | cadeia) 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 o ID da folha de cálculo na qual o filtro é aplicado.

Confira também