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 ligado. Um tipo de dados ligado é um tipo de dados ligado a uma origem de dados online.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Propriedades

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
dataProvider

O nome do fornecedor de dados para o tipo de dados ligado. Isto pode mudar quando as informações são obtidas do serviço.
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. Devolve undefined se o tipo de dados ligado não tiver sido atualizado.
name

O nome do tipo de dados ligado. Isto pode mudar quando as informações são obtidas do serviço.
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.
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. Os conteúdos da matriz podem ser alterados quando as informações são obtidas 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 um pedido para atualizar o tipo de dados ligado. Se o serviço estiver ocupado ou estiver temporariamente inacessível, o pedido não será cumprido.
requestSetRefreshMode(refreshMode)

Faz um pedido para alterar o modo de atualização para este tipo de dados ligado. Se o modo de atualização especificado não for suportado por este tipo de dados ligado, o modo permanece inalterado. Se definido como "Periódico", o intervalo de atualização é definido para um valor pré-determinado com base no tipo de dados ligado específico.
requestSetRefreshMode(refreshModeString)

Faz um pedido para alterar o modo de atualização para este tipo de dados ligado. Se o modo de atualização especificado não for suportado por este tipo de dados ligado, o modo permanece inalterado. Se definido como "Periódico", o intervalo de atualização é definido para um valor pré-determinado com base no tipo de dados ligado específico.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.LinkedDataType é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.LinkedDataTypeData) que contém cópias rasas de quaisquer propriedades subordinadas 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 do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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 fornecedor de dados para o tipo de dados ligado. Isto pode mudar quando as informações são obtidas do serviço.

readonly dataProvider: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 o livro foi aberto quando o tipo de dados ligado foi atualizado pela última vez. Devolve undefined se o tipo de dados ligado não tiver sido atualizado.

readonly lastRefreshed: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 ligado. Isto pode mudar quando as informações são obtidas do serviço.

readonly name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 ligado é atualizado se refreshMode estiver definido como "Periódico".

readonly periodicRefreshInterval: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 através do qual os dados do tipo de dados ligado são obtidos.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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.

O ID exclusivo do tipo de dados ligado.

readonly serviceId: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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.

Devolve uma matriz com todos os modos de atualização suportados pelo tipo de dados ligado. Os conteúdos da matriz podem ser alterados quando as informações são obtidas do serviço.

readonly supportedRefreshModes: Excel.LinkedDataTypeRefreshMode[];

Valor da propriedade

Excel.LinkedDataTypeRefreshMode[]

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

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 um pedido para atualizar o tipo de dados ligado. Se o serviço estiver ocupado ou estiver temporariamente inacessível, o pedido não será cumprido.

requestRefresh(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 um pedido para alterar o modo de atualização para este tipo de dados ligado. Se o modo de atualização especificado não for suportado por este tipo de dados ligado, o modo permanece inalterado. Se definido como "Periódico", o intervalo de atualização é definido para um valor pré-determinado com base no tipo de dados ligado específico.

requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode): void;

Parâmetros

refreshMode
Excel.LinkedDataTypeRefreshMode

O modo pretendido para o qual este tipo de dados ligado é pedido para alterar.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 um pedido para alterar o modo de atualização para este tipo de dados ligado. Se o modo de atualização especificado não for suportado por este tipo de dados ligado, o modo permanece inalterado. Se definido como "Periódico", o intervalo de atualização é definido para um valor pré-determinado com base no tipo de dados ligado específico.

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

Parâmetros

refreshModeString

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

O modo pretendido para o qual este tipo de dados ligado é pedido para alterar.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.LinkedDataType é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.LinkedDataTypeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.LinkedDataTypeData;

Retornos

Excel.Interfaces.LinkedDataTypeData