X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..refs/heads/master:/docs/output/Ext.chart.axis.Time.js?ds=inline diff --git a/docs/output/Ext.chart.axis.Time.js b/docs/output/Ext.chart.axis.Time.js index 62ce338c..c8ff1b62 100644 --- a/docs/output/Ext.chart.axis.Time.js +++ b/docs/output/Ext.chart.axis.Time.js @@ -1,339 +1 @@ -Ext.data.JsonP.Ext_chart_axis_Time({ - "tagname": "class", - "name": "Ext.chart.axis.Time", - "doc": "
A type of axis whose units are measured in time values. Use this axis\nfor listing dates that you will want to group or dynamically change.\nIf you just want to display dates as categories then use the\nCategory class for axis instead.
\n\nFor example:
\n\naxes: [{\n type: 'Time',\n position: 'bottom',\n fields: 'date',\n title: 'Day',\n dateFormat: 'M d',\n groupBy: 'year,month,day',\n aggregateOp: 'sum',\n\n constrain: true,\n fromDate: new Date('1/1/11'),\n toDate: new Date('1/7/11')\n}]\n
\n\nIn this example we're creating a time axis that has as title Day.\nThe field the axis is bound to is date
.\nThe date format to use to display the text for the axis labels is M d
\nwhich is a three letter month abbreviation followed by the day number.\nThe time axis will show values for dates between fromDate
and toDate
.\nSince constrain
is set to true all other values for other dates not between\nthe fromDate and toDate will not be displayed.
The size of the dash marker. Default's 3.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js", - "linenr": 69, - "html_filename": "Axis.html", - "href": "Axis.html#Ext-chart-axis-Axis-cfg-dashSize" - }, - { - "tagname": "cfg", - "name": "length", - "member": "Ext.chart.axis.Axis", - "type": "Number", - "doc": "Offset axis position. Default's 0.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js", - "linenr": 84, - "html_filename": "Axis.html", - "href": "Axis.html#Ext-chart-axis-Axis-cfg-length" - }, - { - "tagname": "cfg", - "name": "majorTickSteps", - "member": "Ext.chart.axis.Axis", - "type": "Number", - "doc": "If minimum
and maximum
are specified it forces the number of major ticks to the specified value.
The number of small ticks between two major ticks. Default is zero.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js", - "linenr": 61, - "html_filename": "Axis.html", - "href": "Axis.html#Ext-chart-axis-Axis-cfg-minorTickSteps" - }, - { - "tagname": "cfg", - "name": "position", - "member": "Ext.chart.axis.Axis", - "type": "String", - "doc": "Where to set the axis. Available options are left
, bottom
, right
, top
. Default's bottom
.
Offset axis width. Default's 0.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js", - "linenr": 90, - "html_filename": "Axis.html", - "href": "Axis.html#Ext-chart-axis-Axis-cfg-width" - } - ], - "method": [ - { - "tagname": "method", - "name": "Time", - "member": "Ext.chart.axis.Time", - "doc": "\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Time.js", - "linenr": 1, - "html_filename": "Time3.html", - "href": "Time3.html#Ext-chart-axis-Time-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "drawAxis", - "member": "Ext.chart.axis.Axis", - "doc": "Renders the axis into the screen and updates it's position.
\n", - "params": [ - { - "type": "Object", - "name": "init", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js", - "linenr": 199, - "html_filename": "Axis.html", - "href": "Axis.html#Ext-chart-axis-Axis-method-drawAxis", - "shortDoc": "Renders the axis into the screen and updates it's position.
\n" - }, - { - "tagname": "method", - "name": "drawGrid", - "member": "Ext.chart.axis.Axis", - "doc": "Renders an horizontal and/or vertical grid into the Surface.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js", - "linenr": 333, - "html_filename": "Axis.html", - "href": "Axis.html#Ext-chart-axis-Axis-method-drawGrid", - "shortDoc": "Renders an horizontal and/or vertical grid into the Surface.
\n" - }, - { - "tagname": "method", - "name": "drawLabel", - "member": "Ext.chart.axis.Axis", - "doc": "Renders the labels in the axes.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js", - "linenr": 647, - "html_filename": "Axis.html", - "href": "Axis.html#Ext-chart-axis-Axis-method-drawLabel", - "shortDoc": "Renders the labels in the axes.
\n" - }, - { - "tagname": "method", - "name": "setTitle", - "member": "Ext.chart.axis.Axis", - "doc": "Updates the title of this axis.
\n", - "params": [ - { - "type": "String", - "name": "title", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js", - "linenr": 708, - "html_filename": "Axis.html", - "href": "Axis.html#Ext-chart-axis-Axis-method-setTitle", - "shortDoc": "Updates the title of this axis.
\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "aggregateOp", - "member": "Ext.chart.axis.Time", - "type": "String", - "doc": "Aggregation operation when grouping. Possible options are 'sum', 'avg', 'max', 'min'. Default's 'sum'.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Time.js", - "linenr": 76, - "html_filename": "Time3.html", - "href": "Time3.html#Ext-chart-axis-Time-property-aggregateOp" - }, - { - "tagname": "property", - "name": "calculateByLabelSize", - "member": "Ext.chart.axis.Time", - "type": "Boolean", - "doc": "The minimum value drawn by the axis. If not set explicitly, the axis\nminimum will be calculated automatically.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Time.js", - "linenr": 50, - "html_filename": "Time3.html", - "href": "Time3.html#Ext-chart-axis-Time-property-calculateByLabelSize" - }, - { - "tagname": "property", - "name": "constrain", - "member": "Ext.chart.axis.Time", - "type": "Boolean", - "doc": "If true, the values of the chart will be rendered only if they belong between the fromDate and toDate.\nIf false, the time axis will adapt to the new values by adding/removing steps.\nDefault's [Ext.Date.DAY, 1].
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Time.js", - "linenr": 107, - "html_filename": "Time3.html", - "href": "Time3.html#Ext-chart-axis-Time-property-constrain", - "shortDoc": "If true, the values of the chart will be rendered only if they belong between the fromDate and toDate.\nIf false, the ..." - }, - { - "tagname": "property", - "name": "dateFormat", - "member": "Ext.chart.axis.Time", - "type": "String|Boolean", - "doc": "Indicates the format the date will be rendered on.\nFor example: 'M d' will render the dates as 'Jan 30', etc.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Time.js", - "linenr": 58, - "html_filename": "Time3.html", - "href": "Time3.html#Ext-chart-axis-Time-property-dateFormat" - }, - { - "tagname": "property", - "name": "fromDate", - "member": "Ext.chart.axis.Time", - "type": "Date", - "doc": "The starting date for the time axis.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Time.js", - "linenr": 84, - "html_filename": "Time3.html", - "href": "Time3.html#Ext-chart-axis-Time-property-fromDate" - }, - { - "tagname": "property", - "name": "step", - "member": "Ext.chart.axis.Time", - "type": "Array", - "doc": "An array with two components: The first is the unit of the step (day, month, year, etc). The second one is the number of units for the step (1, 2, etc.).\nDefault's [Ext.Date.DAY, 1].
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Time.js", - "linenr": 98, - "html_filename": "Time3.html", - "href": "Time3.html#Ext-chart-axis-Time-property-step", - "shortDoc": "An array with two components: The first is the unit of the step (day, month, year, etc). The second one is the number..." - }, - { - "tagname": "property", - "name": "timeUnit", - "member": "Ext.chart.axis.Time", - "type": "String", - "doc": "Indicates the time unit to use for each step. Can be 'day', 'month', 'year' or a comma-separated combination of all of them.\nDefault's 'year,month,day'.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Time.js", - "linenr": 67, - "html_filename": "Time3.html", - "href": "Time3.html#Ext-chart-axis-Time-property-timeUnit", - "shortDoc": "Indicates the time unit to use for each step. Can be 'day', 'month', 'year' or a comma-separated combination of all o..." - }, - { - "tagname": "property", - "name": "toDate", - "member": "Ext.chart.axis.Time", - "type": "Date", - "doc": "The ending date for the time axis.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Time.js", - "linenr": 91, - "html_filename": "Time3.html", - "href": "Time3.html#Ext-chart-axis-Time-property-toDate" - } - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Time.js", - "linenr": 1, - "html_filename": "Time3.html", - "href": "Time3.html#Ext-chart-axis-Time", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.chart.axis.Abstract", - "Ext.chart.axis.Axis" - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_chart_axis_Time({"tagname":"class","html":"Alternate names
Ext.chart.TimeAxisHierarchy
Ext.BaseExt.chart.axis.AbstractExt.chart.axis.AxisExt.chart.axis.NumericExt.chart.axis.TimeRequires
Files
A type of axis whose units are measured in time values. Use this axis\nfor listing dates that you will want to group or dynamically change.\nIf you just want to display dates as categories then use the\nCategory class for axis instead.
\n\nFor example:
\n\naxes: [{\n type: 'Time',\n position: 'bottom',\n fields: 'date',\n title: 'Day',\n dateFormat: 'M d',\n\n constrain: true,\n fromDate: new Date('1/1/11'),\n toDate: new Date('1/7/11')\n}]\n
\n\nIn this example we're creating a time axis that has as title Day.\nThe field the axis is bound to is date
.\nThe date format to use to display the text for the axis labels is M d
\nwhich is a three letter month abbreviation followed by the day number.\nThe time axis will show values for dates between fromDate
and toDate
.\nSince constrain
is set to true all other values for other dates not between\nthe fromDate and toDate will not be displayed.
If true, the values of the chart will be rendered only if they belong between the fromDate and toDate.\nIf false, the time axis will adapt to the new values by adding/removing steps.
\nDefaults to: false
Indicates the format the date will be rendered on.\nFor example: 'M d' will render the dates as 'Jan 30', etc.\nFor a list of possible format strings see Date
\nDefaults to: false
The grid configuration enables you to set a background grid for an axis.\nIf set to true on a vertical axis, vertical lines will be drawn.\nIf set to true on a horizontal axis, horizontal lines will be drawn.\nIf both are set, a proper grid with horizontal and vertical lines will be drawn.
\n\nYou can set specific options for the grid configuration for odd and/or even lines/rows.\nSince the rows being drawn are rectangle sprites, you can set to an odd or even property\nall styles that apply to Ext.draw.Sprite. For more information on all the style\nproperties you can set please take a look at Ext.draw.Sprite. Some useful style properties are opacity
, fill
, stroke
, stroke-width
, etc.
The possible values for a grid option are then true, false, or an object with { odd, even }
properties\nwhere each property contains a sprite style descriptor object that is defined in Ext.draw.Sprite.
For example:
\n\naxes: [{\n type: 'Numeric',\n grid: true,\n position: 'left',\n fields: ['data1', 'data2', 'data3'],\n title: 'Number of Hits',\n grid: {\n odd: {\n opacity: 1,\n fill: '#ddd',\n stroke: '#bbb',\n 'stroke-width': 1\n }\n }\n}, {\n type: 'Category',\n position: 'bottom',\n fields: ['name'],\n title: 'Month of the Year',\n grid: true\n}]\n
\nIf minimum
and maximum
are specified it forces the number of major ticks to the specified value.
If minimum
and maximum
are specified it forces the number of major ticks to the specified value.
The number of small ticks between two major ticks. Default is zero.
\nWhere to set the axis. Available options are left
, bottom
, right
, top
. Default's bottom
.
Defaults to: "bottom"
An array with two components: The first is the unit of the step (day, month, year, etc).\nThe second one is the number of units for the step (1, 2, etc.).\nDefaults to [Ext.Date.DAY, 1]
.
Indicates whether to extend maximum beyond data's maximum to the nearest\nmajorUnit.
\nIndicates whether to extend maximum beyond data's maximum to the nearest\nmajorUnit.
\nIndicates whether to extend the minimum beyond data's minimum to the\nnearest majorUnit.
\nIndicates whether to extend the minimum beyond data's minimum to the\nnearest majorUnit.
\nThe maximum value drawn by the axis. If not set explicitly, the axis\nmaximum will be calculated automatically.
\nThe minimum value drawn by the axis. If not set explicitly, the axis\nminimum will be calculated automatically.
\nIndicates the position of the axis relative to the chart
\nIndicates the position of the axis relative to the chart
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nCall the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nRenders an horizontal and/or vertical grid into the Surface.
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nthis
\n