Compartir a través de

Excel.LinkedEntityDataDomain class

  • Referencia
Paquete:
excel

Representa una categoría o un campo de información específicos que comparten algunas características o atributos comunes. Un dominio de datos está vinculado a un proveedor de datos, que actúa como origen de datos para LinkedEntityCellValue los objetos del libro. Un dominio de datos es una categoría de datos, como acciones, geografía o monedas. Un proveedor de datos es un servicio, como Bing, Power BI o un complemento de Office.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
dataProvider

Obtiene el nombre del proveedor de datos para el dominio de datos de entidad vinculada. Este nombre puede cambiar en función de la información proporcionada por el proveedor de datos.
id

Obtiene el identificador del dominio de datos de entidad vinculado definido por los complementos de Office. Este identificador no es aplicable a los dominios de datos de entidad vinculada definidos por proveedores de datos de servicio, como Bing o Power BI.
lastRefreshed

Obtiene la fecha y hora (en la zona horaria local) desde que se abrió el libro y se actualizaron por última vez los LinkedEntityCellValue objetos de este dominio de datos de entidad vinculada. Devuelve undefined si LinkedEntityCellValue los objetos no se han actualizado desde que se abrió el libro.
loadFunctionId

Obtiene el identificador de la función personalizada a la que se llama a petición para resolver o actualizar los LinkedEntityCellValue objetos del dominio de datos de entidad vinculada definido por los complementos de Office. Para obtener más información, consulte Generación automática de metadatos JSON para funciones personalizadas: ID. Este identificador no es aplicable a los dominios de datos de entidad vinculada definidos por proveedores de datos de servicio, como Bing o Power BI.
name

Obtiene el nombre del dominio de datos de entidad vinculada. Este nombre puede cambiar en función de la información proporcionada por el proveedor de datos.
periodicRefreshInterval

Obtiene la frecuencia, en segundos, en la que LinkedEntityCellValue los objetos de este dominio de datos de entidad vinculada se actualizan automáticamente. El intervalo de actualización solo se aplica si se establece en refreshMode "Periódico".
refreshMode

Especifica el modo de actualización que define cómo y cuándo se actualizan los LinkedEntityCellValue objetos de este dominio de datos de entidad vinculada. Si el modo de actualización que se establece no es compatible con este dominio de datos de entidad vinculada, no se cambia el modo de actualización actual. Si el modo de actualización se establece en "Periódico", el intervalo de actualización se establece en el periodicRefreshInterval de este dominio de datos de entidad vinculada.
serviceId

Obtiene el identificador de servicio del dominio de datos de entidad vinculada. Este identificador es un valor reservado permanentemente para todos los dominios de datos de entidad vinculada definidos por proveedores de datos de servicio, como Bing o Power BI, o definidos por complementos de Office. Este identificador nunca cambia en las sesiones de usuario.
supportedRefreshModes

Obtiene todos los modos de actualización admitidos por el dominio de datos de entidad vinculada. Esta matriz puede cambiar en función de la información proporcionada por el proveedor de datos.

Métodos

delete()

Elimina este objeto de .LinkedEntityDataDomainCollection Una vez eliminado el dominio de datos de entidad vinculada, no se pueden crear nuevos LinkedEntityCellValue objetos de este dominio de datos de entidad vinculada y no se pueden actualizar los objetos existentes LinkedEntityCellValue . Un complemento de Office solo puede eliminar los dominios de datos de entidad vinculada que creó.
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
refresh()

Actualiza todos los LinkedEntityCellValue objetos de este dominio de datos de entidad vinculada. La solicitud de actualización puede producir un error si el proveedor de datos está ocupado o no se puede acceder temporalmente.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.LinkedEntityDataDomain es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LinkedEntityDataDomainData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

dataProvider

Obtiene el nombre del proveedor de datos para el dominio de datos de entidad vinculada. Este nombre puede cambiar en función de la información proporcionada por el proveedor de datos.

readonly dataProvider: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

id

Obtiene el identificador del dominio de datos de entidad vinculado definido por los complementos de Office. Este identificador no es aplicable a los dominios de datos de entidad vinculada definidos por proveedores de datos de servicio, como Bing o Power BI.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

lastRefreshed

Obtiene la fecha y hora (en la zona horaria local) desde que se abrió el libro y se actualizaron por última vez los LinkedEntityCellValue objetos de este dominio de datos de entidad vinculada. Devuelve undefined si LinkedEntityCellValue los objetos no se han actualizado desde que se abrió el libro.

readonly lastRefreshed: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

loadFunctionId

Obtiene el identificador de la función personalizada a la que se llama a petición para resolver o actualizar los LinkedEntityCellValue objetos del dominio de datos de entidad vinculada definido por los complementos de Office. Para obtener más información, consulte Generación automática de metadatos JSON para funciones personalizadas: ID. Este identificador no es aplicable a los dominios de datos de entidad vinculada definidos por proveedores de datos de servicio, como Bing o Power BI.

readonly loadFunctionId: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

name

Obtiene el nombre del dominio de datos de entidad vinculada. Este nombre puede cambiar en función de la información proporcionada por el proveedor de datos.

readonly name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

periodicRefreshInterval

Obtiene la frecuencia, en segundos, en la que LinkedEntityCellValue los objetos de este dominio de datos de entidad vinculada se actualizan automáticamente. El intervalo de actualización solo se aplica si se establece en refreshMode "Periódico".

readonly periodicRefreshInterval: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

refreshMode

Especifica el modo de actualización que define cómo y cuándo se actualizan los LinkedEntityCellValue objetos de este dominio de datos de entidad vinculada. Si el modo de actualización que se establece no es compatible con este dominio de datos de entidad vinculada, no se cambia el modo de actualización actual. Si el modo de actualización se establece en "Periódico", el intervalo de actualización se establece en el periodicRefreshInterval de este dominio de datos de entidad vinculada.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

serviceId

Obtiene el identificador de servicio del dominio de datos de entidad vinculada. Este identificador es un valor reservado permanentemente para todos los dominios de datos de entidad vinculada definidos por proveedores de datos de servicio, como Bing o Power BI, o definidos por complementos de Office. Este identificador nunca cambia en las sesiones de usuario.

readonly serviceId: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

supportedRefreshModes

Obtiene todos los modos de actualización admitidos por el dominio de datos de entidad vinculada. Esta matriz puede cambiar en función de la información proporcionada por el proveedor de datos.

readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];

Valor de propiedad

Excel.LinkedEntityDataDomainRefreshMode[]

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

Detalles del método

delete()

Elimina este objeto de .LinkedEntityDataDomainCollection Una vez eliminado el dominio de datos de entidad vinculada, no se pueden crear nuevos LinkedEntityCellValue objetos de este dominio de datos de entidad vinculada y no se pueden actualizar los objetos existentes LinkedEntityCellValue . Un complemento de Office solo puede eliminar los dominios de datos de entidad vinculada que creó.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;

Parámetros

options
Excel.Interfaces.LinkedEntityDataDomainLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.LinkedEntityDataDomain

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.LinkedEntityDataDomain

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.LinkedEntityDataDomain

refresh()

Actualiza todos los LinkedEntityCellValue objetos de este dominio de datos de entidad vinculada. La solicitud de actualización puede producir un error si el proveedor de datos está ocupado o no se puede acceder temporalmente.

refresh(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.19 ]

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.LinkedEntityDataDomain es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LinkedEntityDataDomainData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;

Devoluciones

Excel.Interfaces.LinkedEntityDataDomainData