Compartilhar via

Excel.LinkedDataType class

  • Referência
Pacote:
excel

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa um tipo de dados vinculado. Um tipo de dados vinculado é um tipo de dados conectado a uma fonte de dados online.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
dataProvider

O nome do provedor de dados para o tipo de dados vinculado. Isso pode mudar quando as informações forem recuperadas do serviço.
lastRefreshed

A data e 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. Retornará undefined se o tipo de dados vinculado não tiver sido atualizado.
name

O nome do tipo de dados vinculado. Isso pode mudar quando as informações forem recuperadas do serviço.
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.
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. O conteúdo da matriz pode ser alterado quando as informações são recuperadas do serviço.

Métodos

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
requestRefresh()

Faz uma solicitação para atualizar o tipo de dados vinculado. Se o serviço estiver ocupado ou temporariamente inacessível, a solicitação não será atendida.
requestSetRefreshMode(refreshMode)

Faz uma solicitação para alterar o modo de atualização desse tipo de dados vinculado. Se o modo de atualização fornecido não tiver suporte para esse tipo de dados vinculado, o modo ficará inalterado. Se definido como "Periódico", o intervalo de atualização será definido como um valor predeterminado com base no tipo de dados vinculado específico.
requestSetRefreshMode(refreshModeString)

Faz uma solicitação para alterar o modo de atualização desse tipo de dados vinculado. Se o modo de atualização fornecido não tiver suporte para esse tipo de dados vinculado, o modo ficará inalterado. Se definido como "Periódico", o intervalo de atualização será definido como um valor predeterminado com base no tipo de dados vinculado específico.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.LinkedDataType original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.LinkedDataTypeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

dataProvider

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

O nome do provedor de dados para o tipo de dados vinculado. Isso pode mudar quando as informações forem recuperadas do serviço.

readonly dataProvider: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

lastRefreshed

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

A data e 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. Retornará undefined se o tipo de dados vinculado não tiver sido atualizado.

readonly lastRefreshed: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

name

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

O nome do tipo de dados vinculado. Isso pode mudar quando as informações forem recuperadas do serviço.

readonly name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

periodicRefreshInterval

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

A frequência, em segundos, na qual o tipo de dados vinculado é atualizado se refreshMode estiver definido como "Periódico".

readonly periodicRefreshInterval: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

refreshMode

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

O mecanismo pelo qual os dados do tipo de dados vinculados são recuperados.

readonly refreshMode: Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";

Valor da propriedade

Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

serviceId

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

A ID exclusiva do tipo de dados vinculado.

readonly serviceId: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

supportedRefreshModes

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna uma matriz com todos os modos de atualização compatíveis com o tipo de dados vinculado. O conteúdo da matriz pode ser alterado quando as informações são recuperadas do serviço.

readonly supportedRefreshModes: Excel.LinkedDataTypeRefreshMode[];

Valor da propriedade

Excel.LinkedDataTypeRefreshMode[]

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

Detalhes do método

load(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Excel.Interfaces.LinkedDataTypeLoadOptions): Excel.LinkedDataType;

Parâmetros

options
Excel.Interfaces.LinkedDataTypeLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.LinkedDataType

load(propertyNames)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Excel.LinkedDataType;

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.LinkedDataType

load(propertyNamesAndPaths)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.LinkedDataType;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.LinkedDataType

requestRefresh()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Faz uma solicitação para atualizar o tipo de dados vinculado. Se o serviço estiver ocupado ou temporariamente inacessível, a solicitação não será atendida.

requestRefresh(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

requestSetRefreshMode(refreshMode)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Faz uma solicitação para alterar o modo de atualização desse tipo de dados vinculado. Se o modo de atualização fornecido não tiver suporte para esse tipo de dados vinculado, o modo ficará inalterado. Se definido como "Periódico", o intervalo de atualização será definido como um valor predeterminado com base no tipo de dados vinculado específico.

requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode): void;

Parâmetros

refreshMode
Excel.LinkedDataTypeRefreshMode

O modo pretendido para o qual esse tipo de dados vinculado é solicitado a ser alterado.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

requestSetRefreshMode(refreshModeString)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Faz uma solicitação para alterar o modo de atualização desse tipo de dados vinculado. Se o modo de atualização fornecido não tiver suporte para esse tipo de dados vinculado, o modo ficará inalterado. Se definido como "Periódico", o intervalo de atualização será definido como um valor predeterminado com base no tipo de dados vinculado específico.

requestSetRefreshMode(refreshModeString: "Unknown" | "Manual" | "OnLoad" | "Periodic"): void;

Parâmetros

refreshModeString

"Unknown" | "Manual" | "OnLoad" | "Periodic"

O modo pretendido para o qual esse tipo de dados vinculado é solicitado a ser alterado.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

toJSON()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.LinkedDataType original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.LinkedDataTypeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.LinkedDataTypeData;

Retornos

Excel.Interfaces.LinkedDataTypeData