Jump to: navigation, search

Difference between revisions of "Orion/Documentation/Developer Guide/Plugging into the settings page"

(Service properties)
(orion.core.setting)
Line 7: Line 7:
  
 
= orion.core.setting =
 
= orion.core.setting =
The <code>orion.core.setting</code> service contributes one or more settings.
+
The <code>orion.core.setting</code> service contributes Settings.
  
 
== Service properties ==
 
== Service properties ==

Revision as of 11:06, 11 September 2012

Overview

Orion plugins can define Settings. A Setting defines some persistent information that is provided to one of the plugin's services. Defined Settings appear on Orion's "Settings" page, and their values can be changed using an automatically-generated UI.

A Setting is a combination of two more basic configuration elements:

  • A PID (persistent identifier), which uniquely identifies the configuration data for the setting.
  • Metatype information, which defines the "shape" of the setting. Specifically, it defines what named properties appear in the setting and what data type they have (string, boolean, number, etc). The Settings page uses this Metatype information to generate appropriate UI widgets (for example, text field, checkbox, etc).

orion.core.setting

The orion.core.setting service contributes Settings.

Service properties

To contribute one or more Settings, the settings service property is used:

settings
Setting[]. Defines Settings. Each Setting element has the following shape:
pid
String. The PID for this setting. This PID occupies the same namespace as the PIDs contributed by Managed Services, and must be unique in that respect.
name
String. Human-readable name of this setting.
tags
String[]. Optional. List of tags applying to this setting.
properties
PropertyType[]. Gives the properties that make up this setting. The shape of the PropertyType element is explained in Metatype documentation.

Service methods

None. This service is completely declarative.

Examples

This example shows how to define a Setting with PID example.navconfig. This Setting has a single property newtab, which is boolean-typed. Because we've enumerated the property's possible values using an options, the generated UI presentation will show a drop-down menu. Since we've provided a defaultValue of false, the second option "Open links in a same tab" will selected by default.

define(['orion/plugin'], function(PluginProvider) {
    var pluginProvider = new PluginProvider();
    pluginProvider.registerService('orion.core.setting',
        {},
        {  settings: [
               {  pid: 'example.navconfig',
                  name: 'Navigation settings',
                  properties: [
                      {  id: 'newtab',
                         name: 'Links',
                         type: 'boolean',
                         defaultValue: false,
                         options: [
                             {  label: "Open links in a new tab",
                                value: true
                             },
                             {  label: "Open links in same tab",
                                value: false
                             }
                         ]
                      }
                  ]
               }
           ]
        });
    provider.connect();
});

See also