Excel.LinkedEntityDataDomainCreateOptions interface

Pacote:
excel

Representa as opções utilizadas para criar o objeto que LinkedEntityDataDomain está a ser adicionado ao LinkedEntityDataDomainCollection.

Comentários

Conjunto de API: ExcelApi 1.19

Esta interface não é suportada no Excel na Web.

Usada por

Exemplos

// Registers linked entity data domains when the add-in loads.
await Excel.run(async (context) => {
    const productsDomainOptions: Excel.LinkedEntityDataDomainCreateOptions = {
        dataProvider: "Contoso",
        id: "products",
        name: "Products",
        // ID of the custom function called by Excel to resolve or refresh linked entity cell values.
        loadFunctionId: "CONTOSOLOADSERVICE",
        // periodicRefreshInterval is only required when supportedRefreshModes contains "Periodic".
        periodicRefreshInterval: 300,
        // Manual refresh mode is always supported, even if unspecified.
        supportedRefreshModes: [
            Excel.LinkedEntityDataDomainRefreshMode.periodic,
            Excel.LinkedEntityDataDomainRefreshMode.onLoad
        ]
    };

    // Add the data domain to the collection to register it.
    context.workbook.linkedEntityDataDomains.add(productsDomainOptions);
    await context.sync();
});

Propriedades

dataProvider

Especifica o nome do fornecedor de dados para o domínio de dados da entidade ligada.
id

Especifica o ID do domínio de dados da entidade ligada. Este ID tem de ser exclusivo em todos os domínios de dados de entidades ligadas definidos por este Suplemento do Office.
loadFunctionId

Especifica o ID da função personalizada que será chamada a pedido para resolve ou atualizar os LinkedEntityCellValue objetos deste domínio de dados de entidade ligada. Para obter mais informações, veja Autogenerate JSON metadata for custom functions: ID (Gerar automaticamente metadados JSON para funções personalizadas: ID).
name

Especifica o nome do domínio de dados da entidade ligada. Este nome tem de ser exclusivo em todos os domínios de dados de entidades ligadas definidos por este Suplemento do Office.
periodicRefreshInterval

Especifica a frequência, em segundos, na qual LinkedEntityCellValue os objetos deste domínio de dados de entidade ligada são atualizados automaticamente. O valor mínimo válido é 300. Esta propriedade é necessária se a supportedRefreshModes matriz contiver o valor "Periódico". Esta propriedade só se aplica se o refreshMode domínio de dados da entidade ligada estiver definido como "Periódico".
supportedRefreshModes

Especifica todos os modos de atualização suportados pelo domínio de dados da entidade ligada. O valor predefinido é ["Manual"], que é sempre suportado mesmo que não seja especificado. O modo de atualização guardado no livro é carregado como o modo de atualização predefinido do domínio de dados da entidade ligada no livro seguinte aberto. Se o modo de atualização não tiver sido guardado no livro, o primeiro valor na matriz é definido como o modo de atualização predefinido do domínio de dados da entidade ligada. Se a matriz tiver o valor "Periodic", a periodicRefreshInterval propriedade também tem de ser definida para o domínio de dados da entidade ligada.

Detalhes da propriedade

dataProvider

Especifica o nome do fornecedor de dados para o domínio de dados da entidade ligada.

dataProvider: string;

Valor da propriedade

string

Comentários

Conjunto de API: ExcelApi 1.19

Esta propriedade não é suportada no Excel na Web.

id

Especifica o ID do domínio de dados da entidade ligada. Este ID tem de ser exclusivo em todos os domínios de dados de entidades ligadas definidos por este Suplemento do Office.

id: string;

Valor da propriedade

string

Comentários

Conjunto de API: ExcelApi 1.19

Esta propriedade não é suportada no Excel na Web.

loadFunctionId

Especifica o ID da função personalizada que será chamada a pedido para resolve ou atualizar os LinkedEntityCellValue objetos deste domínio de dados de entidade ligada. Para obter mais informações, veja Autogenerate JSON metadata for custom functions: ID (Gerar automaticamente metadados JSON para funções personalizadas: ID).

loadFunctionId: string;

Valor da propriedade

string

Comentários

Conjunto de API: ExcelApi 1.19

Esta propriedade não é suportada no Excel na Web.

name

Especifica o nome do domínio de dados da entidade ligada. Este nome tem de ser exclusivo em todos os domínios de dados de entidades ligadas definidos por este Suplemento do Office.

name: string;

Valor da propriedade

string

Comentários

Conjunto de API: ExcelApi 1.19

Esta propriedade não é suportada no Excel na Web.

periodicRefreshInterval

Especifica a frequência, em segundos, na qual LinkedEntityCellValue os objetos deste domínio de dados de entidade ligada são atualizados automaticamente. O valor mínimo válido é 300. Esta propriedade é necessária se a supportedRefreshModes matriz contiver o valor "Periódico". Esta propriedade só se aplica se o refreshMode domínio de dados da entidade ligada estiver definido como "Periódico".

periodicRefreshInterval?: number;

Valor da propriedade

number

Comentários

Conjunto de API: ExcelApi 1.19

Esta propriedade não é suportada no Excel na Web.

supportedRefreshModes

Especifica todos os modos de atualização suportados pelo domínio de dados da entidade ligada. O valor predefinido é ["Manual"], que é sempre suportado mesmo que não seja especificado. O modo de atualização guardado no livro é carregado como o modo de atualização predefinido do domínio de dados da entidade ligada no livro seguinte aberto. Se o modo de atualização não tiver sido guardado no livro, o primeiro valor na matriz é definido como o modo de atualização predefinido do domínio de dados da entidade ligada. Se a matriz tiver o valor "Periodic", a periodicRefreshInterval propriedade também tem de ser definida para o domínio de dados da entidade ligada.

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

Valor da propriedade

Excel.LinkedEntityDataDomainRefreshMode[]

Comentários

Conjunto de API: ExcelApi 1.19

Esta propriedade não é suportada no Excel na Web.