Partager via

Excel.LinkedDataType class

  • Référence
Paquet:
excel

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Représente un type de données lié. Un type de données lié est un type de données connecté à une source de données en ligne.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

Propriétés

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
dataProvider

Nom du fournisseur de données pour le type de données lié. Cela peut changer lorsque des informations sont récupérées à partir du service.
lastRefreshed

Date et heure du fuseau horaire local depuis l’ouverture du classeur lors de la dernière actualisation du type de données lié. Retourne undefined si le type de données lié n’a pas été actualisé.
name

Nom du type de données lié. Cela peut changer lorsque des informations sont récupérées à partir du service.
periodicRefreshInterval

Fréquence, en secondes, à laquelle le type de données lié est actualisé si refreshMode est défini sur « Périodique ».
refreshMode

Mécanisme par lequel les données du type de données lié sont récupérées.
serviceId

ID unique du type de données lié.
supportedRefreshModes

Retourne un tableau avec tous les modes d’actualisation pris en charge par le type de données lié. Le contenu du tableau peut changer lorsque des informations sont récupérées à partir du service.

Méthodes

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
requestRefresh()

Effectue une demande d’actualisation du type de données lié. Si le service est occupé ou temporairement inaccessible, la demande n’est pas satisfaite.
requestSetRefreshMode(refreshMode)

Effectue une demande de modification du mode d’actualisation pour ce type de données lié. Si le mode d’actualisation donné n’est pas pris en charge par ce type de données lié, le mode reste inchangé. Si la valeur est « Périodique », l’intervalle d’actualisation est défini sur une valeur prédéterminée basée sur le type de données lié particulier.
requestSetRefreshMode(refreshModeString)

Effectue une demande de modification du mode d’actualisation pour ce type de données lié. Si le mode d’actualisation donné n’est pas pris en charge par ce type de données lié, le mode reste inchangé. Si la valeur est « Périodique », l’intervalle d’actualisation est défini sur une valeur prédéterminée basée sur le type de données lié particulier.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.LinkedDataType est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.LinkedDataTypeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

context

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

dataProvider

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Nom du fournisseur de données pour le type de données lié. Cela peut changer lorsque des informations sont récupérées à partir du service.

readonly dataProvider: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

lastRefreshed

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Date et heure du fuseau horaire local depuis l’ouverture du classeur lors de la dernière actualisation du type de données lié. Retourne undefined si le type de données lié n’a pas été actualisé.

readonly lastRefreshed: Date;

Valeur de propriété

Date

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

name

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Nom du type de données lié. Cela peut changer lorsque des informations sont récupérées à partir du service.

readonly name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

periodicRefreshInterval

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Fréquence, en secondes, à laquelle le type de données lié est actualisé si refreshMode est défini sur « Périodique ».

readonly periodicRefreshInterval: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

refreshMode

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Mécanisme par lequel les données du type de données lié sont récupérées.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

serviceId

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

ID unique du type de données lié.

readonly serviceId: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

supportedRefreshModes

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Retourne un tableau avec tous les modes d’actualisation pris en charge par le type de données lié. Le contenu du tableau peut changer lorsque des informations sont récupérées à partir du service.

readonly supportedRefreshModes: Excel.LinkedDataTypeRefreshMode[];

Valeur de propriété

Excel.LinkedDataTypeRefreshMode[]

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

Détails de la méthode

load(options)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.LinkedDataTypeLoadOptions): Excel.LinkedDataType;

Paramètres

options
Excel.Interfaces.LinkedDataTypeLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.LinkedDataType

load(propertyNames)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.LinkedDataType

load(propertyNamesAndPaths)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.LinkedDataType

requestRefresh()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Effectue une demande d’actualisation du type de données lié. Si le service est occupé ou temporairement inaccessible, la demande n’est pas satisfaite.

requestRefresh(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

requestSetRefreshMode(refreshMode)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Effectue une demande de modification du mode d’actualisation pour ce type de données lié. Si le mode d’actualisation donné n’est pas pris en charge par ce type de données lié, le mode reste inchangé. Si la valeur est « Périodique », l’intervalle d’actualisation est défini sur une valeur prédéterminée basée sur le type de données lié particulier.

requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode): void;

Paramètres

refreshMode
Excel.LinkedDataTypeRefreshMode

Mode prévu auquel ce type de données lié doit être modifié.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

requestSetRefreshMode(refreshModeString)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Effectue une demande de modification du mode d’actualisation pour ce type de données lié. Si le mode d’actualisation donné n’est pas pris en charge par ce type de données lié, le mode reste inchangé. Si la valeur est « Périodique », l’intervalle d’actualisation est défini sur une valeur prédéterminée basée sur le type de données lié particulier.

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

Paramètres

refreshModeString

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

Mode prévu auquel ce type de données lié doit être modifié.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

toJSON()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.LinkedDataType est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.LinkedDataTypeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.LinkedDataTypeData;

Retours

Excel.Interfaces.LinkedDataTypeData