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 ExcelApi 1.19 adiciona recursos para gráficos e formas, para ajudá-lo a visualizar melhor seus dados no Excel. Ele também inclui atualizações para o recurso de tipos de dados, como suporte para tipos de dados vinculados, notação de ponto e opções expandidas para valores básicos de célula.
A tabela a seguir fornece um resumo conciso das APIs, enquanto a tabela de lista de APIs subsequente fornece uma lista detalhada.
| Área de recurso | Descrição | Objetos relevantes |
|---|---|---|
| Rótulos de gráfico | Controle a aparência dos rótulos do gráfico. | ChartDataLabel, ChartDataLabelAnchor, ChartLeaderLines, ChartLeaderLinesFormat |
| Entidades Vinculadas | Adiciona suporte para tipos de dados conectados ao Excel a partir de fontes externas. Para saber mais, consulte Criar valores de célula de entidade vinculada | LinkedEntityDataDomain, LinkedEntityDataDomainCollection, LinkedEntityDataDomainCreateOptions, LinkedEntityIdCulture, LinkedEntityLoadServiceRequest |
Lista de APIs
A tabela a seguir lista as APIs no Excel Conjunto de requisitos da API JavaScript 1.19. 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.19 ou anterior, consulte APIs do Excel no conjunto de requisitos 1.19 ou anterior.
| Classe | Campos | Descrição |
|---|---|---|
| BasicCardLayout | de dispositivos móveis | Representa o tipo desse layout. |
| BasicCompactLayout | icon | Especifica o nome do ícone usado para abrir o card. |
| BasicViewLayouts | card | Representa o layout desse valor e suas propriedades na exibição de card. |
| compacto | Representa o layout usado quando há espaço limitado para representar o valor. | |
| BooleanCellValue | layouts | Representa informações de layout para exibições desse valor booleano. |
| properties | Representa propriedades adicionais desse valor booliano. | |
| do provedor | Representa informações que descrevem o serviço que forneceu os dados neste BooleanCellValuearquivo . |
|
| valores referenciais | Representa os valores de célula referenciados em BooleanCellValue.properties. |
|
| CardLayoutTwoColumnSection | de dispositivos móveis | Representa o tipo de layout desta seção. |
| ChartDataLabel | geometricShapeType | Especifica o tipo de forma geométrica do rótulo de dados. |
| getSubstring(start: number, length?: number) | Retorna uma subcadeia de caracteres do rótulo de dados. | |
| getTailAnchor() | Retorna a âncora final do rótulo de dados, que é mostrado como um texto explicativo auto-adesivo. | |
| setHeight(height: number) | Define a altura do rótulo de dados em pontos. | |
| setWidth(width: number) | Define a largura do rótulo de dados em pontos. | |
| showAsStickyCallout | Especifica se o rótulo de dados é mostrado como um balão com a âncora final anexada ao ponto de dados. | |
| ChartDataLabelAnchor | left | Especifica a distância, em pontos, da âncora até a borda esquerda do rótulo de dados do gráfico. |
| top | Especifica a distância, em pontos, da âncora até a borda superior do rótulo de dados do gráfico. | |
| ChartDataLabels | geometricShapeType | Especifica o tipo de forma geométrica dos rótulos de dados. |
| leaderLines | Obtém um objeto que representa as linhas de preenchimento dos rótulos de dados. | |
| showAsStickyCallout | Especifica se os rótulos de dados são mostrados como um texto explicativo com a âncora final anexada ao ponto de dados. | |
| showLeaderLines | Especifica se as linhas de chamada são exibidas para as legendas de dados. | |
| ChartLeaderLines | format | Representa a formatação de linhas de preenchimento de rótulos de dados em uma série. |
| ChartLeaderLinesFormat | line | Obtém um objeto que representa a formatação de linha de linhas de preenchimento do gráfico. |
| DoubleCellValue | layouts | Representa informações de layout para exibições desse valor duplo. |
| numberFormat | Retorna a cadeia de caracteres de formato de número usada para exibir esse valor. | |
| properties | Representa propriedades adicionais desse valor duplo. | |
| do provedor | Representa informações que descrevem o serviço que forneceu os dados neste DoubleCellValuearquivo . |
|
| valores referenciais | Representa os valores de célula referenciados em DoubleCellValue.properties. |
|
| JavaScriptCustomFunctionReferenceCellValue | basicType | Representa o valor que seria retornado por Range.valueTypes uma célula com esse valor. |
| basicValue | Representa o valor que seria retornado por Range.values uma célula com esse valor. |
|
| functionType | Representa o tipo de FunctionCellValuearquivo . |
|
| id | Representa a ID da função personalizada. | |
| namespace | Representa o namespace usado pela função personalizada. | |
| type | Representa o tipo desse valor de célula. | |
| LinkedEntityDataDomain | dataProvider | Obtém o nome do provedor de dados para o domínio de dados da entidade vinculada. |
| delete() | Exclui este objeto do LinkedEntityDataDomainCollection. |
|
| id | Obtém a ID do domínio de dados da entidade vinculada definido pelos Suplementos do Office. | |
| lastRefreshed | Obtém a data e a hora (no fuso horário local) desde que a pasta de trabalho foi aberta e os LinkedEntityCellValue objetos desse domínio de dados de entidade vinculado foram atualizados pela última vez. |
|
| loadFunctionId | Obtém a ID da função personalizada que é chamada sob demanda para resolver ou atualizar os LinkedEntityCellValue objetos do domínio de dados de entidade vinculada definido pelos Suplementos do Office. |
|
| name | Obtém o nome do domínio de dados da entidade vinculada. | |
| periodicRefreshInterval | Obtém a frequência, em segundos, na qual LinkedEntityCellValue os objetos desse domínio de dados de entidade vinculada são atualizados automaticamente. |
|
| refresh() | Atualiza todos os LinkedEntityCellValue objetos desse domínio de dados de entidade vinculada. |
|
| refreshMode | Especifica o modo de atualização que define como e quando os LinkedEntityCellValue objetos desse domínio de dados de entidade vinculada são atualizados. |
|
| serviceId | Obtém a ID de serviço do domínio de dados da entidade vinculada. | |
| supportedRefreshModes | Obtém todos os modos de atualização compatíveis com o domínio de dados da entidade vinculada. | |
| LinkedEntityDataDomainAddedEventArgs | id | Obtém a ID do domínio de dados da entidade vinculada que acabou de ser adicionado à pasta de trabalho. |
| serviceId | Obtém a ID de serviço do domínio de dados da entidade vinculada que acabou de ser adicionado à pasta de trabalho. | |
| source | Obtém a origem do evento. | |
| tipo | Obtém o tipo do evento. | |
| LinkedEntityDataDomainCollection | add(options: Excel.LinkedEntityDataDomainCreateOptions) | Adiciona um objeto de domínio de dados de entidade vinculado definido pelo Suplemento do Office à coleção. |
| getCount() | Obtém o número de domínios de dados de entidades vinculadas na coleção. | |
| getItem(id: string) | Obtém um domínio de dados de entidade vinculado por seu id. |
|
| getItemAt(index: number) | Obtém um domínio de dados de entidade vinculado por seu índice na coleção. | |
| getItemByName(name: string) | Obtém um domínio de dados de entidade vinculado por seu name. |
|
| getItemByNameOrNullObject(name: string) | Obtém um domínio de dados de entidade vinculado por seu name. |
|
| getItemOrNullObject(id: string) | Obtém um domínio de dados de entidade vinculado por seu id. |
|
| items | Obtém os itens filhos carregados nesta coleção. | |
| onLinkedEntityDataDomainAdded | Ocorre quando um novo domínio de dados de entidade vinculada é adicionado à pasta de trabalho. | |
| onRefreshCompleted | Ocorre quando a solicitação para atualizar LinkedEntityCellValue objetos de um domínio de dados de entidade vinculada é concluída. |
|
| onRefreshModeChanged | Ocorre quando o refreshMode domínio de dados de uma entidade vinculada é alterado. |
|
| refreshAll() | Atualiza todos os LinkedEntityCellValue objetos de todos os domínios de dados de entidades vinculadas nesta coleção. |
|
| LinkedEntityDataDomainCreateOptions | dataProvider | Especifica o nome do provedor de dados para o domínio de dados da entidade vinculada. |
| id | Especifica a ID do domínio de dados da entidade vinculada. | |
| loadFunctionId | Especifica a ID da função personalizada que será chamada sob demanda para resolver ou atualizar os LinkedEntityCellValue objetos desse domínio de dados de entidade vinculada. |
|
| name | Especifica o nome do domínio de dados da entidade vinculada. | |
| periodicRefreshInterval | Especifica a frequência, em segundos, na qual LinkedEntityCellValue os objetos desse domínio de dados de entidade vinculada são atualizados automaticamente. |
|
| supportedRefreshModes | Especifica todos os modos de atualização compatíveis com o domínio de dados da entidade vinculada. | |
| LinkedEntityDataDomainRefreshCompletedEventArgs | errors | Obtém todos os erros encontrados durante a solicitação para atualizar LinkedEntityCellValue objetos do domínio de dados da entidade vinculada. |
| id | Obtém a ID do domínio de dados da entidade vinculada cujos LinkedEntityCellValue objetos foram atualizados. |
|
| Última atualização | Retorna true se os LinkedEntityCellValue objetos do domínio de dados da entidade vinculada foram atualizados com êxito, caso contrário, retorna false. |
|
| serviceId | Obtém a ID de serviço do domínio de dados da entidade vinculada cujos LinkedEntityCellValue objetos foram atualizados. |
|
| source | Obtém a origem do evento. | |
| tipo | Obtém o tipo do evento. | |
| LinkedEntityDataDomainRefreshModeChangedEventArgs | id | Obtém a ID do domínio de dados da entidade vinculada cujo modo de atualização foi alterado. |
| refreshMode | Obtém o novo modo de atualização do domínio de dados da entidade vinculada. | |
| serviceId | Obtém a ID de serviço do domínio de dados da entidade vinculada cujo modo de atualização foi alterado. | |
| source | Obtém a origem do evento. | |
| tipo | Obtém o tipo do evento. | |
| LinkedEntityIdCulture | Cultura | Representa a cultura linguística usada para criar o LinkedEntityCellValue objeto. |
| entityId | Representa o identificador específico de um serviço usado para criar o LinkedEntityCellValue objeto. |
|
| LinkedEntityLoadServiceRequest | domainId | Representa o domínio específico do serviço usado para criar os LinkedEntityCellValue objetos. |
| entidades | Representa as IDs de entidade e as culturas dos LinkedEntityCellValue objetos a serem carregados. |
|
| LinkedEntityLoadServiceResult | entidades | Representa os objetos carregados LinkedEntityCellValue . |
| Range | getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions) | Retorna uma matriz 2D, encapsulando os dados de exibição para a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades de cada célula. |
| StringCellValue | layouts | Representa informações de layout para exibições desse valor de cadeia de caracteres. |
| properties | Representa propriedades adicionais desse valor de cadeia de caracteres. | |
| do provedor | Representa informações que descrevem o serviço que forneceu os dados neste StringCellValuearquivo . |
|
| valores referenciais | Representa os valores de célula referenciados em StringCellValue.properties. |
|
| Pasta de trabalho | getActiveShape() | Obtém a forma ativa na pasta de trabalho. |
| getActiveShapeOrNullObject() | Obtém a forma ativa na pasta de trabalho. | |
| linkedEntityDataDomains | Retorna uma coleção de domínios de dados de entidades vinculadas que estão disponíveis na pasta de trabalho. | |
| Planilha | showDataTypeIcons | Especifica se os ícones de tipo de dados estão visíveis na planilha. |