Compartilhar via

Excel.LinkedEntityDataDomain class

  • Referência
Pacote:
excel

Representa uma categoria ou campo de informações específico que partilha algumas características ou atributos comuns. Um domínio de dados está ligado a um fornecedor de dados, que funciona como a origem de dados para LinkedEntityCellValue objetos no livro. Um domínio de dados é uma categoria de dados, como ações, geografia ou moedas. Um fornecedor de dados é um serviço, como o Bing, o Power BI ou um Suplemento do Office.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

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

Obtém o nome do fornecedor de dados para o domínio de dados da entidade ligada. Este nome pode ser alterado com base nas informações fornecidas pelo fornecedor de dados.
id

Obtém o ID do domínio de dados da entidade ligada definido pelos Suplementos do Office. Este ID não é aplicável a domínios de dados de entidades ligadas definidos por fornecedores de dados de serviços, como o Bing ou o Power BI.
lastRefreshed

Obtém a data e hora (no fuso horário local) desde que o livro foi aberto e os LinkedEntityCellValue objetos deste domínio de dados de entidade ligada foram atualizados pela última vez. Devolve undefined se LinkedEntityCellValue os objetos não tiverem sido atualizados desde que o livro foi aberto.
loadFunctionId

Obtém o ID da função personalizada que é chamada a pedido para resolve ou atualizar os LinkedEntityCellValue objetos do domínio de dados da entidade ligada definido pelos Suplementos do Office. Para obter mais informações, veja Autogenerate JSON metadata for custom functions: ID (Gerar automaticamente metadados JSON para funções personalizadas: ID). Este ID não é aplicável a domínios de dados de entidades ligadas definidos por fornecedores de dados de serviços, como o Bing ou o Power BI.
name

Obtém o nome do domínio de dados da entidade ligada. Este nome pode ser alterado com base nas informações fornecidas pelo fornecedor de dados.
periodicRefreshInterval

Obtém a frequência, em segundos, na qual LinkedEntityCellValue os objetos deste domínio de dados de entidade ligada são atualizados automaticamente. O intervalo de atualização só se aplica se estiver refreshMode definido como "Periódico".
refreshMode

Especifica o modo de atualização que define como e quando os LinkedEntityCellValue objetos deste domínio de dados de entidade ligada são atualizados. Se o modo de atualização que está a ser definido não for suportado por este domínio de dados de entidade ligada, o modo de atualização atual não será alterado. Se o modo de atualização estiver definido como "Periódico", o intervalo de atualização é definido como o periodicRefreshInterval deste domínio de dados de entidade ligada.
serviceId

Obtém o ID de serviço do domínio de dados da entidade ligada. Este ID é um valor reservado permanentemente para todos os domínios de dados de entidades ligadas que são definidos por fornecedores de dados de serviço, como o Bing ou o Power BI, ou definidos pelos Suplementos do Office. Este ID nunca muda entre sessões de utilizador.
supportedRefreshModes

Obtém todos os modos de atualização suportados pelo domínio de dados da entidade ligada. Esta matriz pode ser alterada com base nas informações fornecidas pelo fornecedor de dados.

Métodos

delete()

Elimina este objeto do LinkedEntityDataDomainCollection. Depois de o domínio de dados da entidade ligada ser eliminado, não é possível criar novos LinkedEntityCellValue objetos deste domínio de dados de entidade ligada e os objetos existentes LinkedEntityCellValue não podem ser atualizados. Um Suplemento do Office só pode eliminar domínios de dados de entidade ligados que criou.
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.
refresh()

Atualiza todos os LinkedEntityCellValue objetos deste domínio de dados de entidade ligada. O pedido de atualização pode falhar se o fornecedor de dados estiver ocupado ou temporariamente inacessível.
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.LinkedEntityDataDomain é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.LinkedEntityDataDomainData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

context

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

Obtém o nome do fornecedor de dados para o domínio de dados da entidade ligada. Este nome pode ser alterado com base nas informações fornecidas pelo fornecedor de dados.

readonly dataProvider: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

id

Obtém o ID do domínio de dados da entidade ligada definido pelos Suplementos do Office. Este ID não é aplicável a domínios de dados de entidades ligadas definidos por fornecedores de dados de serviços, como o Bing ou o Power BI.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

lastRefreshed

Obtém a data e hora (no fuso horário local) desde que o livro foi aberto e os LinkedEntityCellValue objetos deste domínio de dados de entidade ligada foram atualizados pela última vez. Devolve undefined se LinkedEntityCellValue os objetos não tiverem sido atualizados desde que o livro foi aberto.

readonly lastRefreshed: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

loadFunctionId

Obtém o ID da função personalizada que é chamada a pedido para resolve ou atualizar os LinkedEntityCellValue objetos do domínio de dados da entidade ligada definido pelos Suplementos do Office. Para obter mais informações, veja Autogenerate JSON metadata for custom functions: ID (Gerar automaticamente metadados JSON para funções personalizadas: ID). Este ID não é aplicável a domínios de dados de entidades ligadas definidos por fornecedores de dados de serviços, como o Bing ou o Power BI.

readonly loadFunctionId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

name

Obtém o nome do domínio de dados da entidade ligada. Este nome pode ser alterado com base nas informações fornecidas pelo fornecedor de dados.

readonly name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

periodicRefreshInterval

Obtém a frequência, em segundos, na qual LinkedEntityCellValue os objetos deste domínio de dados de entidade ligada são atualizados automaticamente. O intervalo de atualização só se aplica se estiver refreshMode definido como "Periódico".

readonly periodicRefreshInterval: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

refreshMode

Especifica o modo de atualização que define como e quando os LinkedEntityCellValue objetos deste domínio de dados de entidade ligada são atualizados. Se o modo de atualização que está a ser definido não for suportado por este domínio de dados de entidade ligada, o modo de atualização atual não será alterado. Se o modo de atualização estiver definido como "Periódico", o intervalo de atualização é definido como o periodicRefreshInterval deste domínio de dados de entidade ligada.

refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

serviceId

Obtém o ID de serviço do domínio de dados da entidade ligada. Este ID é um valor reservado permanentemente para todos os domínios de dados de entidades ligadas que são definidos por fornecedores de dados de serviço, como o Bing ou o Power BI, ou definidos pelos Suplementos do Office. Este ID nunca muda entre sessões de utilizador.

readonly serviceId: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

supportedRefreshModes

Obtém todos os modos de atualização suportados pelo domínio de dados da entidade ligada. Esta matriz pode ser alterada com base nas informações fornecidas pelo fornecedor de dados.

readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];

Valor da propriedade

Excel.LinkedEntityDataDomainRefreshMode[]

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

Detalhes do método

delete()

Elimina este objeto do LinkedEntityDataDomainCollection. Depois de o domínio de dados da entidade ligada ser eliminado, não é possível criar novos LinkedEntityCellValue objetos deste domínio de dados de entidade ligada e os objetos existentes LinkedEntityCellValue não podem ser atualizados. Um Suplemento do Office só pode eliminar domínios de dados de entidade ligados que criou.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

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(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;

Parâmetros

options
Excel.Interfaces.LinkedEntityDataDomainLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.LinkedEntityDataDomain

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(propertyNames?: string | string[]): Excel.LinkedEntityDataDomain;

Parâmetros

propertyNames

string | string[]

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

Retornos

Excel.LinkedEntityDataDomain

load(propertyNamesAndPaths)

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.LinkedEntityDataDomain;

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.LinkedEntityDataDomain

refresh()

Atualiza todos os LinkedEntityCellValue objetos deste domínio de dados de entidade ligada. O pedido de atualização pode falhar se o fornecedor de dados estiver ocupado ou temporariamente inacessível.

refresh(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

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.LinkedEntityDataDomain é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.LinkedEntityDataDomainData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;

Retornos

Excel.Interfaces.LinkedEntityDataDomainData