{{! For backwards compatibility }}

{{name}}

{{#crossLink type}}{{/crossLink}} {{#if deprecated}} deprecated {{/if}} {{#if access}} {{access}} {{/if}} {{#if final}} final {{/if}} {{#if static}} static {{/if}} {{#if optional}} optional {{/if}} {{#if required}} required {{/if}} {{#if readonly}} readonly {{/if}}
{{#if overwritten_from}}

Inherited from {{overwritten_from/class}} {{#if foundAt}} but overwritten in {{/if}} {{else}} {{#if extended_from}}

Inherited from {{extended_from}}: {{else}} {{#providedBy}}

Provided by the {{.}} module.

{{/providedBy}}

{{#if foundAt}} Defined in {{/if}} {{/if}} {{/if}} {{#if foundAt}} `{{{file}}}:{{{line}}}` {{/if}}

{{#if deprecationMessage}}

Deprecated: {{deprecationMessage}}

{{/if}} {{#if since}}

Available since {{since}}

{{/if}}
{{{attrDescription}}}
{{#if default}}

Default: {{default}}

{{/if}} {{#if emit}}

Fires event {{name}}Change

Fires when the value for the configuration attribute `{{{name}}}` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e {{#crossLink "EventFacade"}}{{/crossLink}}
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName {{#crossLink "String"}}{{/crossLink}}
      The name of the attribute being set.
    • subAttrName {{#crossLink "String"}}{{/crossLink}}
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
{{/if}} {{#example}}

Example:

{{{.}}}
{{/example}}