Stockage des options d’instance

Lors du développement d’un widget, vous pouvez modifier le schéma d’option pour créer des paramètres pour votre widget, ou vous pouvez créer une table pour stocker les options d’instance. Si vous modifiez le schéma d’option existant, toutes les options d’instance définies sont stockées au format JSON dans le champ Options supplémentaires, format JSON de la table sp_instance. Les types de champs suivants sont disponibles :

Pour utiliser d’autres types de champ non pris en charge dans le schéma d’options, créez une table d’extension pour stocker votre schéma d’options de widget personnalisé. L’utilisation d’une table vous permet d’effectuer les actions suivantes :

Utilisation des options d’un widget

Accédez aux options dans le widget à partir du script client et du script serveur à l’aide de la variable globale options . Vous pouvez accéder à n’importe quelle valeur d’option dans votre script client de widget ou script serveur à l’aide de options.optionName.

function() {
  /* widget controller */
  var c = this;
    console.log(c.options.text_color) //Outputs the text_color option for this instance
}

(function() {
     $sp.log(options.text_color) //Logs the value of the text_color option to the browser console.
})();

Définition des options par défaut

Avant qu’une valeur d’option ne soit définie sur une instance, elle apparaît comme une valeur non définie lorsque vous accédez à cette variable d’option. Utilisez le script du serveur de widgets pour spécifier les valeurs par défaut de vos options.

(function() {
  options.text_color=options.text_color||"blue";
  options.maximum_entry_count=options.maximum_entry_count||5;
})