1 <div id="attr_{{name}}" class="attr item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">
2 <a name="config_{{name}}"></a> {{! For backwards compatibility }}
3 <h3 class="name"><code>{{name}}</code></h3>
4 <span class="type">{{#crossLink type}}{{/crossLink}}</span>
7 <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span>
11 <span class="flag {{access}}">{{access}}</span>
15 <span class="flag final">final</span>
19 <span class="flag static">static</span>
23 <span class="flag optional">optional</span>
27 <span class="flag required">required</span>
31 <span class="flag readonly">readonly</span>
35 {{#if overwritten_from}}
37 <a href="{{crossLinkRaw overwritten_from/class}}#attr_{{overwritten_from/name}}">
38 {{overwritten_from/class}}
46 <a href="{{crossLinkRaw extended_from}}#attr_{{name}}">{{extended_from}}</a>:
49 <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p>
58 <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
62 {{#if deprecationMessage}}
63 <p>Deprecated: {{deprecationMessage}}</p>
67 <p>Available since {{since}}</p>
71 <div class="description">
76 <p><strong>Default:</strong> {{default}}</p>
80 <div class="emits box">
81 <h4>Fires event <code>{{name}}Change</code></h4>
84 Fires when the value for the configuration attribute `{{{name}}}` is
85 changed. You can listen for the event using the `on` method if you
86 wish to be notified before the attribute's value has changed, or
87 using the `after` method if you wish to be notified after the
88 attribute's value has changed.
94 <ul class="params-list">
96 <code class="param-name">e</code>
97 <span class="type">{{#crossLink "EventFacade"}}{{/crossLink}}</span>
99 <div class="param-description">
100 An Event Facade object with the following
101 attribute-specific properties added:
104 <ul class="params-list">
106 <code class="param-name">prevVal</code>
107 <span class="type">Any</span>
108 <div class="param-description">The value of the attribute, prior to it being set.</div>
111 <code class="param-name">newVal</code>
112 <span class="type">Any</span>
113 <div class="param-description">The value the attribute is to be set to.</div>
116 <code class="param-name">attrName</code>
117 <span class="type">{{#crossLink "String"}}{{/crossLink}}</span>
118 <div class="param-description">The name of the attribute being set.</div>
121 <code class="param-name">subAttrName</code>
122 <span class="type">{{#crossLink "String"}}{{/crossLink}}</span>
123 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
133 <div class="example">
136 <div class="example-content">