diff --git a/HEADER.js b/HEADER.js index 5daf17e5..0ecdab5e 100644 --- a/HEADER.js +++ b/HEADER.js @@ -16,4 +16,9 @@ else { fabric.window = fabric.document.createWindow(); } +/** + * True when in environment that supports touch events + * @property isTouchSupported + * @type boolean + */ fabric.isTouchSupported = "ontouchstart" in fabric.document.documentElement; \ No newline at end of file diff --git a/README.md b/README.md index 635b94a3..e32c4917 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Fabric.js started as a foundation for design editor on [printio.ru](http://print 4. Optionally, you can build documentation - $ java -jar lib/jsdoc-toolkit/jsrun.jar lib/jsdoc-toolkit/app/run.js -a -t=lib/jsdoc-toolkit/templates/jsdoc -d=docs fabric.js src/ src/util/ + $ java -jar lib/jsdoc-toolkit/jsrun.jar lib/jsdoc-toolkit/app/run.js -a -t=lib/jsdoc-toolkit/templates/jsdoc -d=site/docs HEADER.js src/ src/util/ ### Demos diff --git a/lib/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl b/lib/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl index 4c7de1cd..3405d39d 100644 --- a/lib/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl +++ b/lib/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl @@ -1,56 +1,50 @@ - - - - - {! Link.base = ""; /* all generated links will be relative to this */ !} - JsDoc Reference - File Index - - - - +--- +layout: default +title: Fabric.js API Reference - File Index +--- + + + +{+include("static/header.html")+} + +
+ {+publish.classesIndex+} +
+ +
+

File Index

- - {+include("static/header.html")+} - -
- {+publish.classesIndex+} -
- -
-

File Index

- - -
-

{+new Link().toSrc(item.alias).withText(item.name)+}

- {+resolveLinks(item.desc)+} -
- -
Author:
-
{+item.author+}
- - -
Version:
-
{+item.version+}
- - {! var locations = item.comment.getTag('location').map(function($){return $.toString().replace(/(^\$ ?| ?\$$)/g, '').replace(/^HeadURL: https:/g, 'http:');}) !} - -
Location:
- -
{+location+}
- - -
-
-
- - -
-
- ©{+JSDOC.opt.D.copyright+}
 - Documentation generated by JsDoc Toolkit {+JSDOC.VERSION+} on {+new Date()+} -
- - \ No newline at end of file + +
+

{+new Link().toSrc(item.alias).withText(item.name)+}

+ {+resolveLinks(item.desc)+} +
+ +
Author:
+
{+item.author+}
+ + +
Version:
+
{+item.version+}
+ + {! var locations = item.comment.getTag('location').map(function($){return $.toString().replace(/(^\$ ?| ?\$$)/g, '').replace(/^HeadURL: https:/g, 'http:');}) !} + +
Location:
+ +
{+location+}
+ + +
+
+
+ +
+ +
+ ©{+JSDOC.opt.D.copyright+}
 + Documentation generated by + JsDoc Toolkit + {+JSDOC.VERSION+} on {+new Date()+} +
\ No newline at end of file diff --git a/lib/jsdoc-toolkit/templates/jsdoc/class.tmpl b/lib/jsdoc-toolkit/templates/jsdoc/class.tmpl index 1b32e4aa..68d1a152 100644 --- a/lib/jsdoc-toolkit/templates/jsdoc/class.tmpl +++ b/lib/jsdoc-toolkit/templates/jsdoc/class.tmpl @@ -1,649 +1,641 @@ - - - - - - {! Link.base = "../"; /* all generated links will be relative to this */ !} - JsDoc Reference - {+data.alias+} +--- +layout: doc +title: Fabric.js API Reference - {+data.alias+} +--- - - + - - - {+include("static/header.html")+} - + +{+include("static/header.html")+} + -
- - {+publish.classesIndex+} - -
- -
+
+ + {+publish.classesIndex+} + +
+ +
-

- {! - var classType = ""; - - if (data.isBuiltin()) { - classType += "Built-In "; - } - - if (data.isNamespace) { - if (data.is('FUNCTION')) { - classType += "Function "; - } - classType += "Namespace "; - } - else { - classType += "Class "; - } - !} - {+classType+}{+data.alias+} -

+

+ {! + var classType = ""; + + if (data.isBuiltin()) { + classType += "Built-In "; + } + + if (data.isNamespace) { + if (data.is('FUNCTION')) { + classType += "Function "; + } + classType += "Namespace "; + } + else { + classType += "Class "; + } + !} + {+classType+}{+data.alias+} +

-

-
Version - {+ data.version +}.
- -
Extends - {+ - data.augments - .sort() - .map( - function($) { return new Link().toSymbol($); } - ) - .join(", ") - +}.
- - - {+resolveLinks(data.classDesc)+} - - {# isn't defined in any file #} -
Defined in: {+new Link().toSrc(data.srcFile)+}. - -

+

+
Version + {+ data.version +}.
+ +
Extends + {+ + data.augments + .sort() + .map( + function($) { return new Link().toSymbol($); } + ) + .join(", ") + +}.
+ + + {+resolveLinks(data.classDesc)+} + + {# isn't defined in any file #} +
Defined in: {+new Link().toSrc(data.srcFile)+}. + +

- - - - - - - - - - - - - - - -
{+classType+}Summary
Constructor AttributesConstructor Name and Description
{! - if (data.isPrivate) output += "<private> "; - if (data.isInner) output += "<inner> "; - !}  -
- {+ new Link().toSymbol(data.alias).inner('constructor')+}{+ makeSignature(data.params) +} -
-
{+resolveLinks(summarize(data.desc))+}
-
- - - - - {! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} - - - - - - - - - - - - - - - - - -
Field Summary
Field AttributesField Name and Description
{! - if (member.isPrivate) output += "<private> "; - if (member.isInner) output += "<inner> "; - if (member.isStatic) output += "<static> "; - if (member.isConstant) output += "<constant> "; - !}  -
- {+member.memberOf+}.{+new Link().toSymbol(member.alias).withText(member.name)+} -
-
{+resolveLinks(summarize(member.desc))+}
-
- - - -
- {! - var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias}); - - var contributers = []; - borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); - for (var i = 0, l = contributers.length; i < l; i++) { - output += - "
Fields borrowed from class "+new Link().toSymbol(contributers[i])+":
" - + - "
" + - borrowedMembers - .filter( - function($) { return $.memberOf == contributers[i] } - ) - .sort(makeSortby("name")) - .map( - function($) { return new Link().toSymbol($.alias).withText($.name) } - ) - .join(", ") - + - "
"; - } - !} -
- - - - - - {! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} - - - - - - - - - - - - - - - - - -
Method Summary
Method AttributesMethod Name and Description
{! - if (member.isPrivate) output += "<private> "; - if (member.isInner) output += "<inner> "; - if (member.isStatic) output += "<static> "; - !}  -
{+member.memberOf+}.{+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, ''))+}{+makeSignature(member.params)+} -
-
{+resolveLinks(summarize(member.desc))+}
-
- - - -
- {! - var borrowedMembers = data.methods.filter(function($) {return $.memberOf != data.alias}); - var contributers = []; - borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); - for (var i = 0, l = contributers.length; i < l; i++) { - output += - "
Methods borrowed from class "+new Link().toSymbol(contributers[i])+":
" - + - "
" + - borrowedMembers - .filter( - function($) { return $.memberOf == contributers[i] } - ) - .sort(makeSortby("name")) - .map( - function($) { return new Link().toSymbol($.alias).withText($.name) } - ) - .join(", ") - + - "
"; - } - - !} -
- - - - - {! var ownEvents = data.events.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} - - - - - - - - - - - - - - - - - -
Event Summary
Event AttributesEvent Name and Description
{! - if (member.isPrivate) output += "<private> "; - if (member.isInner) output += "<inner> "; - if (member.isStatic) output += "<static> "; - !}  -
{+member.memberOf+}.{+new Link().toSymbol(member.alias).withText(member.name)+}{+makeSignature(member.params)+} -
-
{+resolveLinks(summarize(member.desc))+}
-
- - - -
- {! - var borrowedMembers = data.events.filter(function($) {return $.memberOf != data.alias}); - var contributers = []; - borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); - for (var i = 0, l = contributers.length; i < l; i++) { - output += - "
Events borrowed from class "+new Link().toSymbol(contributers[i])+":
" - + - "
" + - borrowedMembers - .filter( - function($) { return $.memberOf == contributers[i] } - ) - .sort(makeSortby("name")) - .map( - function($) { return new Link().toSymbol($.alias).withText($.name) } - ) - .join(", ") - + - "
"; - } - - !} -
- - - - - -
-
- {+classType+}Detail -
- -
{! + + + + + + + + + + + + + + + +
{+classType+}Summary
Constructor AttributesConstructor Name and Description
{! if (data.isPrivate) output += "<private> "; if (data.isInner) output += "<inner> "; - !} - {+ data.alias +}{+ makeSignature(data.params) +} - - -
- {+resolveLinks(data.desc)+} -
Author: {+data.author+}. -
- - - - 
{+example+}
- - - - - -
-
Parameters:
- -
- {+((item.type)?""+("{"+(new Link().toSymbol(item.type)+"} ")) : "")+} {+item.name+} - Optional, Default: {+item.defaultValue+} -
-
{+resolveLinks(item.desc)+}
- -
- - -
-
Deprecated:
-
- {+resolveLinks(data.deprecated)+} -
-
- - -
-
Since:
-
{+ data.since +}
-
- - -
-
Throws:
- -
- {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+item.name+} -
-
{+resolveLinks(item.desc)+}
- -
- - -
-
Returns:
- -
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+resolveLinks(item.desc)+}
- -
- - -
-
Requires:
- -
{+ new Link().toSymbol(item) +}
- -
- - -
-
See:
- -
{+ new Link().toSymbol(item) +}
- -
- + !} 		 +
+ {+ new Link().toSymbol(data.alias).inner('constructor')+}{+ makeSignature(data.params) +} +
+
{+resolveLinks(summarize(data.desc))+}
+
+ -
- - - - -
- Field Detail -
- - -
{! + + + {! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} + + + + + + + + + + + + + + + + + +
Field Summary
Field AttributesField Name and Description
{! if (member.isPrivate) output += "<private> "; if (member.isInner) output += "<inner> "; if (member.isStatic) output += "<static> "; if (member.isConstant) output += "<constant> "; - !} - - {{+new Link().toSymbol(member.type)+}} - {+member.memberOf+}.{+member.name+} - - -
- {+resolveLinks(member.desc)+} - -
- Defined in: {+new Link().toSrc(member.srcFile)+}. - -
Author: {+member.author+}. -
- - - - 
{+example+}
- - + !} 		 +
+ {+member.memberOf+}.{+new Link().toSymbol(member.alias).withText(member.name)+} +
+
{+resolveLinks(summarize(member.desc))+}
+
+ + + +
+ {! + var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias}); + + var contributers = []; + borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); + for (var i = 0, l = contributers.length; i < l; i++) { + output += + "
Fields borrowed from class "+new Link().toSymbol(contributers[i])+":
" + + + "
" + + borrowedMembers + .filter( + function($) { return $.memberOf == contributers[i] } + ) + .sort(makeSortby("name")) + .map( + function($) { return new Link().toSymbol($.alias).withText($.name) } + ) + .join(", ") + + + "
"; + } + !} +
+ + - -
-
Deprecated:
-
- {+ resolveLinks(member.deprecated) +} -
-
- - -
-
Since:
-
{+ member.since +}
-
- - -
-
See:
- -
{+ new Link().toSymbol(item) +}
- -
- - -
-
Default Value:
-
- {+resolveLinks(member.defaultValue)+} -
-
- + + + {! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} + + + + + + + + + + + + + + + + + +
Method Summary
Method AttributesMethod Name and Description
{! + if (member.isPrivate) output += "<private> "; + if (member.isInner) output += "<inner> "; + if (member.isStatic) output += "<static> "; + !}  +
{+member.memberOf+}.{+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, ''))+}{+makeSignature(member.params)+} +
+
{+resolveLinks(summarize(member.desc))+}
+
+ + + +
+ {! + var borrowedMembers = data.methods.filter(function($) {return $.memberOf != data.alias}); + var contributers = []; + borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); + for (var i = 0, l = contributers.length; i < l; i++) { + output += + "
Methods borrowed from class "+new Link().toSymbol(contributers[i])+":
" + + + "
" + + borrowedMembers + .filter( + function($) { return $.memberOf == contributers[i] } + ) + .sort(makeSortby("name")) + .map( + function($) { return new Link().toSymbol($.alias).withText($.name) } + ) + .join(", ") + + + "
"; + } + + !} +
+ + + + + {! var ownEvents = data.events.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} + + + + + + + + + + + + + + + + + +
Event Summary
Event AttributesEvent Name and Description
{! + if (member.isPrivate) output += "<private> "; + if (member.isInner) output += "<inner> "; + if (member.isStatic) output += "<static> "; + !}  +
{+member.memberOf+}.{+new Link().toSymbol(member.alias).withText(member.name)+}{+makeSignature(member.params)+} +
+
{+resolveLinks(summarize(member.desc))+}
+
+ + + +
+ {! + var borrowedMembers = data.events.filter(function($) {return $.memberOf != data.alias}); + var contributers = []; + borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); + for (var i = 0, l = contributers.length; i < l; i++) { + output += + "
Events borrowed from class "+new Link().toSymbol(contributers[i])+":
" + + + "
" + + borrowedMembers + .filter( + function($) { return $.memberOf == contributers[i] } + ) + .sort(makeSortby("name")) + .map( + function($) { return new Link().toSymbol($.alias).withText($.name) } + ) + .join(", ") + + + "
"; + } + + !} +
+ + -
+ + +
+
+ {+classType+}Detail +
+ +
{! + if (data.isPrivate) output += "<private> "; + if (data.isInner) output += "<inner> "; + !} + {+ data.alias +}{+ makeSignature(data.params) +} +
+ +
+ {+resolveLinks(data.desc)+} +
Author: {+data.author+}. +
+ + + + 
{+example+}
+ + + + + +
+
Parameters:
+ +
+ {+((item.type)?""+("{"+(new Link().toSymbol(item.type)+"} ")) : "")+} {+item.name+} + Optional, Default: {+item.defaultValue+} +
+
{+resolveLinks(item.desc)+}
 +
+ +
+
Deprecated:
+
+ {+resolveLinks(data.deprecated)+} +
+
+ + +
+
Since:
+
{+ data.since +}
+
+ + +
+
Throws:
+ +
+ {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+item.name+} +
+
{+resolveLinks(item.desc)+}
+ +
+ + +
+
Returns:
+ +
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+resolveLinks(item.desc)+}
+ +
+ + +
+
Requires:
+ +
{+ new Link().toSymbol(item) +}
+ +
+ + +
+
See:
+ +
{+ new Link().toSymbol(item) +}
+ +
+ + +
+ + + + +
+ Field Detail +
+ + +
{! + if (member.isPrivate) output += "<private> "; + if (member.isInner) output += "<inner> "; + if (member.isStatic) output += "<static> "; + if (member.isConstant) output += "<constant> "; + !} + + {{+new Link().toSymbol(member.type)+}} + {+member.memberOf+}.{+member.name+} + +
+
+ {+resolveLinks(member.desc)+} + +
+ Defined in: {+new Link().toSrc(member.srcFile)+}. + +
Author: {+member.author+}. +
+ + + + 
{+example+}
+ + + + +
+
Deprecated:
+
+ {+ resolveLinks(member.deprecated) +} +
+
+ + +
+
Since:
+
{+ member.since +}
+
+ + +
+
See:
+ +
{+ new Link().toSymbol(item) +}
+ +
+ + +
+
Default Value:
+
+ {+resolveLinks(member.defaultValue)+} +
+
+ + +
+ + - -
- Method Detail -
- - -
{! - if (member.isPrivate) output += "<private> "; - if (member.isInner) output += "<inner> "; - if (member.isStatic) output += "<static> "; - !} - - {{+new Link().toSymbol(member.type)+}} - {+member.memberOf+}.{+member.name.replace(/\^\d+$/, '')+}{+makeSignature(member.params)+} - -
-
- {+resolveLinks(member.desc)+} - -
- Defined in: {+new Link().toSrc(member.srcFile)+}. - -
Author: {+member.author+}. -
- - - - 
{+example+}
- - - - -
-
Parameters:
- -
- {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+item.name+} - Optional, Default: {+item.defaultValue+} -
-
{+resolveLinks(item.desc)+}
- -
- - -
-
Deprecated:
-
- {+ resolveLinks(member.deprecated) +} -
-
- - -
-
Since:
-
{+ member.since +}
-
- - - -
-
Throws:
- -
- {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+item.name+} -
-
{+resolveLinks(item.desc)+}
- -
- - -
-
Returns:
- -
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+resolveLinks(item.desc)+}
- -
- - -
-
Requires:
- -
{+ resolveLinks(item) +}
- -
- - -
-
See:
- -
{+ new Link().toSymbol(item) +}
- -
- - -
- - - - - -
- Event Detail -
- - -
{! - if (member.isPrivate) output += "<private> "; - if (member.isInner) output += "<inner> "; - if (member.isStatic) output += "<static> "; - !} - - {{+new Link().toSymbol(member.type)+}} - {+member.memberOf+}.{+member.name+}{+makeSignature(member.params)+} - -
-
- {+resolveLinks(member.desc)+} - -
- Defined in: {+new Link().toSrc(member.srcFile)+}. - -
Author: {+member.author+}. -
- - - - 
{+example+}
- - - - -
-
Parameters:
- -
- {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+item.name+} - Optional, Default: {+item.defaultValue+} -
-
{+ resolveLinks(item.desc) +}
- -
- - -
-
Deprecated:
-
- {+ resolveLinks(member.deprecated) +} -
-
- - -
-
Since:
-
{+ member.since +}
-
- - - -
-
Throws:
- -
- {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+item.name+} -
-
{+ resolveLinks(item.desc) +}
- -
- - -
-
Returns:
- -
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+resolveLinks(item.desc)+}
- -
- - -
-
Requires:
- -
{+ resolveLinks(item) +}
- -
- - -
-
See:
- -
{+ new Link().toSymbol(item) +}
- -
- - -
- - - -
+ +
+ Method Detail
+ + +
{! + if (member.isPrivate) output += "<private> "; + if (member.isInner) output += "<inner> "; + if (member.isStatic) output += "<static> "; + !} + + {{+new Link().toSymbol(member.type)+}} + {+member.memberOf+}.{+member.name.replace(/\^\d+$/, '')+}{+makeSignature(member.params)+} + +
+
+ {+resolveLinks(member.desc)+} + +
+ Defined in: {+new Link().toSrc(member.srcFile)+}. + +
Author: {+member.author+}. +
+ + + + 
{+example+}
+ + + + +
+
Parameters:
+ +
+ {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+item.name+} + Optional, Default: {+item.defaultValue+} +
+
{+resolveLinks(item.desc)+}
+ +
+ + +
+
Deprecated:
+
+ {+ resolveLinks(member.deprecated) +} +
+
+ + +
+
Since:
+
{+ member.since +}
+
+ + + +
+
Throws:
+ +
+ {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+item.name+} +
+
{+resolveLinks(item.desc)+}
+ +
+ + +
+
Returns:
+ +
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+resolveLinks(item.desc)+}
+ +
+ + +
+
Requires:
+ +
{+ resolveLinks(item) +}
+ +
+ + +
+
See:
+ +
{+ new Link().toSymbol(item) +}
+ +
+ + +
+ + + + + +
+ Event Detail +
+ + +
{! + if (member.isPrivate) output += "<private> "; + if (member.isInner) output += "<inner> "; + if (member.isStatic) output += "<static> "; + !} + + {{+new Link().toSymbol(member.type)+}} + {+member.memberOf+}.{+member.name+}{+makeSignature(member.params)+} + +
+
+ {+resolveLinks(member.desc)+} + +
+ Defined in: {+new Link().toSrc(member.srcFile)+}. + +
Author: {+member.author+}. +
+ + + + 
{+example+}
+ + + + +
+
Parameters:
+ +
+ {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+item.name+} + Optional, Default: {+item.defaultValue+} +
+
{+ resolveLinks(item.desc) +}
+ +
+ + +
+
Deprecated:
+
+ {+ resolveLinks(member.deprecated) +} +
+
+ + +
+
Since:
+
{+ member.since +}
+
+ + + +
+
Throws:
+ +
+ {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+item.name+} +
+
{+ resolveLinks(item.desc) +}
+ +
+ + +
+
Returns:
+ +
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+resolveLinks(item.desc)+}
+ +
+ + +
+
Requires:
+ +
{+ resolveLinks(item) +}
+ +
+ + +
+
See:
+ +
{+ new Link().toSymbol(item) +}
+ +
+ + +
+ + + +
+
-
- ©{+JSDOC.opt.D.copyright+}
 - Documentation generated by JsDoc Toolkit {+JSDOC.VERSION+} on {+new Date()+} -
- - +
+ ©{+JSDOC.opt.D.copyright+}
 + Documentation generated by JsDoc Toolkit {+JSDOC.VERSION+} on {+new Date()+} +
\ No newline at end of file diff --git a/lib/jsdoc-toolkit/templates/jsdoc/index.tmpl b/lib/jsdoc-toolkit/templates/jsdoc/index.tmpl index a5dc1158..940414b0 100644 --- a/lib/jsdoc-toolkit/templates/jsdoc/index.tmpl +++ b/lib/jsdoc-toolkit/templates/jsdoc/index.tmpl @@ -1,39 +1,33 @@ - - - - - - JsDoc Reference - Index - - - - +--- +layout: default +title: Fabric.js API Reference +--- + + + +{+include("static/header.html")+} + +
+ {+publish.classesIndex+} +
+ +
+

Class Index

- - {+include("static/header.html")+} - -
- {+publish.classesIndex+} + +
+

{+(new Link().toSymbol(thisClass.alias))+}

+ {+resolveLinks(summarize(thisClass.classDesc))+}
- -
-

Class Index

- - -
-

{+(new Link().toSymbol(thisClass.alias))+}

- {+resolveLinks(summarize(thisClass.classDesc))+} -
-
- - -
-
- ©{+JSDOC.opt.D.copyright+}
 - Documentation generated by JsDoc Toolkit {+JSDOC.VERSION+} on {+new Date()+} -
- - \ No newline at end of file +
+ +
+ +
+ ©{+JSDOC.opt.D.copyright+}
 + Documentation generated by + JsDoc Toolkit + {+JSDOC.VERSION+} on {+new Date()+} +
\ No newline at end of file diff --git a/lib/jsdoc-toolkit/templates/jsdoc/static/default.css b/lib/jsdoc-toolkit/templates/jsdoc/static/default.css index 97e021ef..96c1e2ad 100644 --- a/lib/jsdoc-toolkit/templates/jsdoc/static/default.css +++ b/lib/jsdoc-toolkit/templates/jsdoc/static/default.css @@ -1,8 +1,7 @@ /* default.css */ -body +#bd-wrapper { font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; - width: 800px; } .header @@ -34,8 +33,7 @@ pre.code border: 1px dashed #ccc; } -#index -{ +#index { margin-top: 24px; float: left; width: 160px; @@ -45,14 +43,12 @@ pre.code padding: 8px; } -#content -{ +#content { margin-left: 190px; width: 600px; } -.classList -{ +.classList { list-style-type: none; padding: 0; margin: 0 0 0 8px; @@ -61,23 +57,20 @@ pre.code overflow: auto; } -.classList li -{ +.classList li { padding: 0; margin: 0 0 8px 0; } .summaryTable { width: 100%; } -h1.classTitle -{ +h1.classTitle { font-size:170%; line-height:130%; } h2 { font-size: 110%; } -caption, div.sectionTitle -{ +caption, div.sectionTitle { background-color: #7F8FB1; color: #fff; font-size:130%; @@ -89,8 +82,7 @@ caption, div.sectionTitle div.sectionTitle { margin-bottom: 8px; } .summaryTable thead { display: none; } -.summaryTable td -{ +.summaryTable td { vertical-align: top; padding: 4px; border-bottom: 1px #7F8FB1 solid; @@ -98,30 +90,26 @@ div.sectionTitle { margin-bottom: 8px; } } /*col#summaryAttributes {}*/ -.summaryTable td.attributes -{ +.summaryTable td.attributes { border-left: 1px #7F8FB1 solid; width: 140px; text-align: right; } -td.attributes, .fixedFont -{ +td.attributes, .fixedFont { line-height: 15px; color: #002EBE; font-family: "Courier New",Courier,monospace; font-size: 13px; } -.summaryTable td.nameDescription -{ +.summaryTable td.nameDescription { text-align: left; font-size: 13px; line-height: 15px; } -.summaryTable td.nameDescription, .description -{ +.summaryTable td.nameDescription, .description { line-height: 15px; padding: 4px; padding-left: 4px; @@ -129,8 +117,7 @@ td.attributes, .fixedFont .summaryTable { margin-bottom: 8px; } -ul.inheritsList -{ +ul.inheritsList { list-style: square; margin-left: 20px; padding-left: 0; @@ -142,21 +129,18 @@ ul.inheritsList } .detailList dt { margin-left: 20px; } -.detailList .heading -{ +.detailList .heading { font-weight: bold; padding-bottom: 6px; margin-left: 0; } -.light, td.attributes, .light a:link, .light a:visited -{ +.light, td.attributes, .light a:link, .light a:visited { color: #777; font-style: italic; } -.fineprint -{ +.fineprint { text-align: right; font-size: 10px; } \ No newline at end of file diff --git a/src/object.class.js b/src/object.class.js index 6876c0ee..dca509c0 100644 --- a/src/object.class.js +++ b/src/object.class.js @@ -22,6 +22,7 @@ fabric.Object = fabric.util.createClass(/** @scope fabric.Object.prototype */ { /** + * Type of an object (rect, circle, path, etc) * @property * @type String */ diff --git a/src/observable.js b/src/observable.js index 2b5713b2..48a490b6 100644 --- a/src/observable.js +++ b/src/observable.js @@ -1,7 +1,11 @@ +/** + * @namespace + */ fabric.Observable = { /** - * @mthod observe + * Observes specified event + * @method observe * @param {String} eventName * @param {Function} handler */ @@ -24,8 +28,8 @@ fabric.Observable = { }, /** - * @mthod stopObserving - * @memberOf fabric.util + * Stops event observing for a particular event handler + * @method stopObserving * @param {String} eventName * @param {Function} handler */ @@ -40,8 +44,7 @@ fabric.Observable = { /** * Fires event with an optional memo object - * @mthod fire - * @memberOf fabric.util + * @method fire * @param {String} eventName * @param {Object} [memo] */ diff --git a/src/util/misc.js b/src/util/misc.js index e0d5fdb6..2267f4c6 100644 --- a/src/util/misc.js +++ b/src/util/misc.js @@ -1,5 +1,8 @@ (function() { + /** + * @namespace + */ fabric.util = { }; /**