Compartilhar via


Excel.Interfaces.LinkedEntityDataDomainLoadOptions interface

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.

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

Propriedades

$all

Especificar $all para as opções de carga carrega todas as propriedades escalares (como Range.address) mas não as propriedades de navegação (como Range.format.fill.color).

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.

Detalhes da propriedade

$all

Especificar $all para as opções de carga carrega todas as propriedades escalares (como Range.address) mas não as propriedades de navegação (como Range.format.fill.color).

$all?: boolean;

Valor da propriedade

boolean

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.

dataProvider?: boolean;

Valor da propriedade

boolean

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.

id?: boolean;

Valor da propriedade

boolean

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.

lastRefreshed?: boolean;

Valor da propriedade

boolean

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.

loadFunctionId?: boolean;

Valor da propriedade

boolean

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.

name?: boolean;

Valor da propriedade

boolean

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

periodicRefreshInterval?: boolean;

Valor da propriedade

boolean

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?: boolean;

Valor da propriedade

boolean

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.

serviceId?: boolean;

Valor da propriedade

boolean

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.

supportedRefreshModes?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.19 ]