View Full Version : API Documentation Content Bugs

Pages : 1 2 [3]

26 Sep 2013, 12:12 PM
I posted this in the API doc. Please make the method Ext.isSimpleObject public.

Is there a reason why this method is named isSimpleObject? Other libraries (jQuery, Lo-Dash, Underscore) use the name isPlainObject. Did Ext JS have to be different? ;)

function Stooge(name, age) {
this.name = name;
this.age = age;

console.log(Ext.isSimpleObject(new Stooge('moe', 40))); // false
console.log(Ext.isSimpleObject([1, 2, 3])); // false
console.log(Ext.isSimpleObject({ 'name': 'moe', 'age': 40 })); // true

30 Sep 2013, 9:34 AM
The Series.onRedraw template method is not documented.

Ext.define('Ext.chart.series.Series', {
onRedraw: Ext.emptyFn,

1 Oct 2013, 7:51 AM
I noticed that while the docs now point to 4.2.2, 4.2.1 and 4.2.2 are not listed on the SDK Updates section on the main page of the documentation. The last entry is Mar 13 2013 Ext 4.2.0 Released. Not a huge deal, but it's kind of confusing to use 4.2.2 docs when the homepage says it doesn't exist!

29 Oct 2013, 12:18 PM
TablePanel shouldn't mention aggregating 'Scrollers' anymore.


10 Dec 2013, 1:15 AM
Googling Sencha MVC brings this dead link.


6 Jan 2014, 5:57 AM
Ext.AbstractComponent.itemId needs to mention what the valid characters are for an itemId.The component query regexp is /^(#)?([\w\-]+|\*)(?:\((true|false)\))?/I tried to use a space, but it didn't work.

10 Jan 2014, 3:28 PM
1) 4.2.2/#!/api/Ext.data.SortTypes

asText - Removes any tags and converts the value to a string
asUCText - Removes any tags and converts the value to an uppercase string
asUCText - Converts the value to an uppercase string
that must be: asUCString (http://docs.sencha.com/extjs/4.2.2/#!/api/Ext.data.SortTypes-method-asUCString)()

2) 4.2.2/#!/api/Ext.grid.column.Column
dataIndex (http://docs.sencha.com/extjs/4.2.2/#!/api/Ext.grid.column.Column-cfg-dataIndex) : String
(http://docs.sencha.com/extjs/4.2.2/#!/api/String)is not marked as Required,only bolded in text.

Are comments and authentication on docs.sencha.com down?

14 Jan 2014, 12:01 PM

Problem: Function defined multiple times
File: CSS.js (Ext.util.CSS)
Function: refreshCache
Summary: The refreshCache method is defined multiple times.
Solution: Remove one of the definitions

28 Jan 2014, 3:44 AM
At http://docs-origin.sencha.com/extjs/4.2.2/#!/api/Ext.util.Filter-cfg-caseSensitive reads
True to make the regex case sensitive (adds 'i' switch to regex).

while source code is

value = new RegExp(value, caseSensitive ? '' : 'i');

Should say
True to make the regex case sensitive (if true then doesn't add "i" switch to regex).

28 Jan 2014, 12:40 PM
It seems like Ext.container.Viewport.initComponent should be protected. It's marked both private and protected in the 4.1.3 docs:http://docs.sencha.com/extjs/4.1.3/#!/api/Ext.container.Viewport-method-initComponent

25 Feb 2014, 8:18 AM
ComboBox#tpl[1] should inherit its documentation from BoundList#tpl[2].

The ComboBox#itemSelector[3] from Ext JS 3.4.0 has no documentation for Ext JS 4.0.0 and greater.
If it was removed it should be marked that way.

An example for a custom class for the items of a BoundList is missing. Like:

Ext.create('Ext.form.field.ComboBox', {
fieldLabel: 'State',
queryMode: 'local',
displayField: 'name',
valueField: 'abbr',
store: Ext.create('Ext.data.Store', {
fields: ['abbr', 'name'],
data: [
{"abbr":"AL", "name":"Alabama"},
{"abbr":"AK", "name":"Alaska"},
{"abbr":"AZ", "name":"Arizona"}
listConfig: {
itemCls: 'custom',
tpl : '<tpl for="."><div class="custom">{name}</div></tpl>'

[1]: http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.form.field.ComboBox-cfg-tpl
[2]: http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.view.BoundList-cfg-tpl
[3]: http://docs-origin.sencha.com/extjs/3.4.0/#!/api/Ext.form.ComboBox-cfg-itemSelector

27 Feb 2014, 5:54 AM
Ext.data.Model.hasOne creates a hasOne assocition, but it is undocumented.Should it be documented?See http://www.sencha.com/forum/showthread.php?281902-Ext.data.Model.hasOne

5 Mar 2014, 10:17 AM
The getStateId method should probably be public or protected.

Ext.define('Ext.state.Stateful', {
* Gets the state id for this object.
* @return {String} The 'stateId' or the implicit 'id' specified by component configuration.
* @private
getStateId: function() {
var me = this;
return me.stateId || (me.autoGenId ? null : me.id);

1 Apr 2014, 11:52 PM
if (me.fireEvent('beforerefresh', me) !== false) {

Ext.view.View should mention the possibility of blocking the refresh by returning false - currently this is not mentioned in the docs

7 May 2014, 1:14 AM
In Ext.dd.DragTracker, API doc event name is different from source code event name (beforestart vs beforedragstart):

* @event beforestart
* @param {Object} this
* @param {Object} e event object

16 May 2014, 7:26 AM
var tpl = new Ext.DomHelper.createTemplate (http://docs.sencha.com/extjs/5.0.0/apidocs/#!/api/Ext.dom.Helper-method-createTemplate)(html);
these example lines must be without `new`.

13 Jun 2014, 7:31 AM
When following the guide for theming, which refers to the sencha CMD tutorial, neither states that (on windows at least) you need Ruby <2.0 So, the natural thing to do (which I have just done) is install the latest Ruby, try to compile, and poof! Only then does an error message pop up saying the wrong version of Ruby is installed, and I need to go back, uninstall ruby, re-install the old version, re-set up/change the path variables... a lot of trouble due to a lack of important documentation.

This is the sort of thing that will frustrate new users (though I've been with Sencha for 8 years), and is a very simple thing to put on a "how to install page" http://docs.sencha.com/extjs/4.2.2/#/guide/command

17 Jun 2014, 8:10 AM
Ruby <2 was required for past versions of Cmd, but works with the current stable Cmd. You may need to run "sencha upgrade" to ensure you have the latest version of Cmd. You will then run "sencha app upgrade" for each app / application within a workspace to upgrade the application to work with the current release of Cmd.

26 Jun 2014, 7:32 AM
'onRender' template method is missing in the Ext.Panel docs.

1 Aug 2014, 6:31 AM
The url property of a button is undocumented but appears to be an alias of the href property.

2 Oct 2014, 6:14 AM

"The server is temporarily unable to service your
request due to maintenance downtime or capacity
problems. Please try again later."

This this situation has been started about a WEEK ago. Try use anonymazer - the same picture.

Ext 5.0 Docs (http://docs.sencha.com/extjs/5.0/apidocs/) work fine.

Please fix it.

Gary Schlosberg
2 Oct 2014, 8:07 AM
The link you posted works for me using Chrome 37.

Perhaps it was just fixed. Are you still having this issue?

2 Oct 2014, 8:47 AM
Thank you, Gary

This problem was in my chrome. Firefox works fine.

Now I use mirror
For chrome

21 Nov 2014, 3:24 AM
Hi, mentioned that the API docs for 4.x are not updated for the Ext.chart.series.Column object (and also Ext.chart.series.Bar and Ext.chart.series.Line).

The "title" config option is described as it will accept only String value, but it also can be used with an Array of strings.
This is corrected in 5.x. API docs.

Can you please correct this?

21 Nov 2014, 2:26 PM
Thank you @mx_starter. I'll get that bug filed.