Description

{{ description.replace(/\{@link (.*?)(#.*?)?\}/g, '$1$2') }}

Priority

{{priority}}

Event type

{{eventType}}

Requirements

Parameters

NameTypeDescription
{{ param.name }} {{ param.typeDefinitionUrl }} {{ param.description.replace(/\{@link (.*?)(#.*?)?\}/g, '$1$2') }}

Properties

NameTypeDescription
{{ prop.name }} {{ prop.typeDefinitionUrl }} {{ prop.description.replace(/\{@link (.*?)(#.*?)?\}/g, '$1$2') }}

Attributes

NameTypeDescription
{{ attr.name }} {{ attr.typeDefinitionUrl }} {{ marked(attr.description.replace(/\{@link (.*?)(#.*?)?\}/g, '$1$2')||'') }}

Animations

{{ animations }}

Example

{{ example.code }}

References

Authors

{{ author.map(function (credit) { return credit.replace(/(.*) <(.*)>/, '$1'); }).join(', ') }}

Tutorials

Members

NameTypeDescription
{{ member.name }} {{ member.type && member.type.names.join(" | ") }} {{ member.description }}


Methods

{{ func.name }} ({{ func.params.map(function(param){return param.name;}).join(", ") }}) -> {{ func.returns[0].typeDefinition }}

{{ func.description.replace(/\{@link (.*?)(#.*?)?\}/g, '$1$2') }}

References

  • {{ ref.replace(/\{@link (.*?)(#.*?)?\}/g, '$1$2') }}

Example

{{ example.code }}

Parameters

NameTypeDescription
{{ param.name }} {{ param.typeDefinitionUrl }} {{ param.description.replace(/\{@link (.*?)(#.*?)?\}/g, '$1$2') }}

Returns

TypeDescription
{{ ret.typeDefinitionUrl }} {{ ret.description.replace(/\{@link (.*?)(#.*?)?\}/g, '$1$2') }}