Shell.Configuration.ViewSettings.js

Applies To: Windows Azure Pack

Manages configuration settings associated with specific pages.

Widgets

None.

Name	Fields
Path	perType: ###PER_TYPE###. A pre-defined view setting path for settings that should be shared among instances of a resource type. perInstance: ###PER_INSTANCE###. A pre-defined view setting path for settings that should be distinct for each instance of a resource type.

None.

Name	Description	Returns	Parameters
Shell.Configuration.ViewSettings.getViewSettings	Asynchronously gets view settings	jQuery.Deferred	options (Object): An options object with the following properties: subViewName: (Optional) If these settings are for some sub-view in a larger view, use this string-typed option to distinguish these settings from those of other sub-views. subscriptionId: (Optional) Supply this option if these settings are stored per-subscription. settings (Array): An array of settings objects with properties: path: A path from Shell.Configuration.ViewState.Path. name: The name of the setting.
Shell.Configuration.ViewSettings.updateViewSetting	Asynchronously updates a single view setting	jQuery.Deferred	options (Object): An options object with the following properties: subViewName: (Optional) If these settings are for some sub-view in a larger view, use this string-typed option to distinguish these settings from those of other sub-views. subscriptionId: (Optional) Supply this option if these settings are stored per-subscription. path (String): A path from Shell.Configuration.ViewState.Path. name (String): The name of the setting.

Shell.Configuration.ViewSettings.getViewSettings

Asynchronously gets view settings

jQuery.Deferred

options (Object): An options object with the following properties:

subViewName: (Optional) If these settings are for some sub-view in a larger view, use this string-typed option to distinguish these settings from those of other sub-views.
subscriptionId: (Optional) Supply this option if these settings are stored per-subscription.

settings (Array): An array of settings objects with properties:

Shell.Configuration.ViewSettings.updateViewSetting

Asynchronously updates a single view setting

jQuery.Deferred

options (Object): An options object with the following properties:

subViewName: (Optional) If these settings are for some sub-view in a larger view, use this string-typed option to distinguish these settings from those of other sub-views.
subscriptionId: (Optional) Supply this option if these settings are stored per-subscription.

path (String): A path from Shell.Configuration.ViewState.Path.

name (String): The name of the setting.