Excel.LinkedDataType class

Paquete:

excel

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa un tipo de datos vinculado. Un tipo de datos vinculado es un tipo de datos conectado a un origen de datos en línea.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
dataProvider	Nombre del proveedor de datos para el tipo de datos vinculado. Esto puede cambiar cuando se recupera información del servicio.
lastRefreshed	Fecha y hora de la zona horaria local desde que se abrió el libro cuando se actualizó por última vez el tipo de datos vinculado. Devuelve undefined si el tipo de datos vinculado no se ha actualizado.
name	Nombre del tipo de datos vinculado. Esto puede cambiar cuando se recupera información del servicio.
periodicRefreshInterval	Frecuencia, en segundos, en la que se actualiza el tipo de datos vinculado si refreshMode se establece en "Periódico".
refreshMode	Mecanismo por el que se recuperan los datos del tipo de datos vinculado.
serviceId	Identificador único del tipo de datos vinculado.
supportedRefreshModes	Devuelve una matriz con todos los modos de actualización admitidos por el tipo de datos vinculado. El contenido de la matriz puede cambiar cuando se recupera información del servicio.

Métodos

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.
requestRefresh()	Realiza una solicitud para actualizar el tipo de datos vinculado. Si el servicio está ocupado o no se puede acceder temporalmente, la solicitud no se cumplirá.
requestSetRefreshMode(refreshMode)	Realiza una solicitud para cambiar el modo de actualización de este tipo de datos vinculado. Si el modo de actualización especificado no es compatible con este tipo de datos vinculados, el modo se deja sin cambios. Si se establece en "Periódico", el intervalo de actualización se establece en un valor predeterminado basado en el tipo de datos vinculado determinado.
requestSetRefreshMode(refreshModeString)	Realiza una solicitud para cambiar el modo de actualización de este tipo de datos vinculado. Si el modo de actualización especificado no es compatible con este tipo de datos vinculados, el modo se deja sin cambios. Si se establece en "Periódico", el intervalo de actualización se establece en un valor predeterminado basado en el tipo de datos vinculado determinado.
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.LinkedDataType es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LinkedDataTypeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Nombre del proveedor de datos para el tipo de datos vinculado. Esto puede cambiar cuando se recupera información del servicio.

readonly dataProvider: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

lastRefreshed

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Fecha y hora de la zona horaria local desde que se abrió el libro cuando se actualizó por última vez el tipo de datos vinculado. Devuelve undefined si el tipo de datos vinculado no se ha actualizado.

readonly lastRefreshed: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

name

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Nombre del tipo de datos vinculado. Esto puede cambiar cuando se recupera información del servicio.

readonly name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

periodicRefreshInterval

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Frecuencia, en segundos, en la que se actualiza el tipo de datos vinculado si refreshMode se establece en "Periódico".

readonly periodicRefreshInterval: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

refreshMode

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Mecanismo por el que se recuperan los datos del tipo de datos vinculado.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

serviceId

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Identificador único del tipo de datos vinculado.

readonly serviceId: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

supportedRefreshModes

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Devuelve una matriz con todos los modos de actualización admitidos por el tipo de datos vinculado. El contenido de la matriz puede cambiar cuando se recupera información del servicio.

readonly supportedRefreshModes: Excel.LinkedDataTypeRefreshMode[];

Valor de propiedad

Excel.LinkedDataTypeRefreshMode[]

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Detalles del método

load(options)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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.LinkedDataTypeLoadOptions): Excel.LinkedDataType;

Parámetros

options

Excel.Interfaces.LinkedDataTypeLoadOptions

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

Devoluciones

Excel.LinkedDataType

load(propertyNames)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

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

load(propertyNamesAndPaths)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

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

requestRefresh()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Realiza una solicitud para actualizar el tipo de datos vinculado. Si el servicio está ocupado o no se puede acceder temporalmente, la solicitud no se cumplirá.

requestRefresh(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

requestSetRefreshMode(refreshMode)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Realiza una solicitud para cambiar el modo de actualización de este tipo de datos vinculado. Si el modo de actualización especificado no es compatible con este tipo de datos vinculados, el modo se deja sin cambios. Si se establece en "Periódico", el intervalo de actualización se establece en un valor predeterminado basado en el tipo de datos vinculado determinado.

requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode): void;

Parámetros

refreshMode

Excel.LinkedDataTypeRefreshMode

Modo previsto al que se solicita que cambie este tipo de datos vinculado.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

requestSetRefreshMode(refreshModeString)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Realiza una solicitud para cambiar el modo de actualización de este tipo de datos vinculado. Si el modo de actualización especificado no es compatible con este tipo de datos vinculados, el modo se deja sin cambios. Si se establece en "Periódico", el intervalo de actualización se establece en un valor predeterminado basado en el tipo de datos vinculado determinado.

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

Parámetros

refreshModeString

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

Modo previsto al que se solicita que cambie este tipo de datos vinculado.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

toJSON()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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.LinkedDataType es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LinkedDataTypeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.LinkedDataTypeData;

Devoluciones

Excel.Interfaces.LinkedDataTypeData