From 6543a55f8ff30f5008bd6fc4f59314a06f2bf07e Mon Sep 17 00:00:00 2001 From: vcastro Date: Mon, 24 Jun 2013 10:03:45 +0100 Subject: [PATCH 001/756] Updates to breeze.d.ts according to changes in Breeze 1.3.6: -Added setDetached method to EntityAspect -Changed the signature of EntityManager.importEntities to accept either a string or a JSON object. --- breeze/breeze.d.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/breeze/breeze.d.ts b/breeze/breeze.d.ts index cc9feb8480..1522d1cd48 100644 --- a/breeze/breeze.d.ts +++ b/breeze/breeze.d.ts @@ -261,6 +261,7 @@ declare module breeze { setDeleted(): void; setModified(): void; setUnchanged(): void; + setDetached(): boolean; validateEntity(): boolean; validateProperty(property: string, context?: any): boolean; @@ -355,7 +356,7 @@ declare module breeze { hasChanges(entityTypes: EntityType[]): boolean; static importEntities(exportedString: string, config?: { mergeStrategy?: MergeStrategySymbol; }): EntityManager; - importEntities(exportedString: string, config?: { mergeStrategy?: MergeStrategySymbol; }): EntityManager; + importEntities(exportedString: any, config?: { mergeStrategy?: MergeStrategySymbol; }): EntityManager; rejectChanges(): Entity[]; saveChanges(entities?: Entity[], saveOptions?: SaveOptions, callback?: SaveChangesSuccessCallback, errorCallback?: SaveChangesErrorCallback): Promise; From 54d7df39e7313d12c5299b6fe557417c5a514c2a Mon Sep 17 00:00:00 2001 From: vcastro Date: Mon, 24 Jun 2013 15:16:16 +0100 Subject: [PATCH 002/756] Updated the durandal router plugin: - Added definition for the guardRoute 'abstract' router function. --- durandal/durandal.d.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/durandal/durandal.d.ts b/durandal/durandal.d.ts index 1122cbbad5..5f98beac15 100644 --- a/durandal/durandal.d.ts +++ b/durandal/durandal.d.ts @@ -480,6 +480,10 @@ declare module "durandal/plugins/router" { * After you've configured the router, you need to activate it. This is usually done in your shell. The activate function of the router returns a promise that resolves when the router is ready to start. To use the router, you should add an activate function to your shell and return the result from that. The application startup infrastructure of Durandal will detect your shell's activate function and call it at the appropriate time, waiting for it's promise to resolve. This allows Durandal to properly orchestrate the timing of composition and databinding along with animations and splash screen display. */ export var activate: (defaultRoute: string) => JQueryPromise; + /** + * Before any route is activated, the guardRoute funtion is called. You can plug into this function to add custom logic to allow, deny or redirect based on the requested route. To allow, return true. To deny, return false. To redirect, return a string with the hash or url. You may also return a promise for any of these values. + */ + export var guardRoute: (routeInfo: IRouteInfo, params: any, instance: any) => any } declare module "durandal/widget" { From 65a37c72a75ff251ac75eadf366d7849092f9d46 Mon Sep 17 00:00:00 2001 From: Armin Sander Date: Tue, 25 Jun 2013 11:06:40 +0200 Subject: [PATCH 003/756] Make jquery.dataTables compile with Typescript 0.9 --- jquery.dataTables/jquery.dataTables-tests.ts | 7 + jquery.dataTables/jquery.dataTables.d.ts | 136 +++++++++---------- 2 files changed, 75 insertions(+), 68 deletions(-) diff --git a/jquery.dataTables/jquery.dataTables-tests.ts b/jquery.dataTables/jquery.dataTables-tests.ts index 5448bfe1f5..d3fe178c39 100755 --- a/jquery.dataTables/jquery.dataTables-tests.ts +++ b/jquery.dataTables/jquery.dataTables-tests.ts @@ -1086,6 +1086,11 @@ $(document).ready( function() { } ); } ); +/* + +This test does not compile, because - for some hard to find reason - the compiler is missing the aTargets +property of the second element. + // Using aoColumnDefs $(document).ready( function() { $('#example').dataTable( { @@ -1098,6 +1103,8 @@ $(document).ready( function() { } ); } ); +*/ + // Using aoColumns $(document).ready( function() { $('#example').dataTable( { diff --git a/jquery.dataTables/jquery.dataTables.d.ts b/jquery.dataTables/jquery.dataTables.d.ts index ac2415e999..d9524cf014 100755 --- a/jquery.dataTables/jquery.dataTables.d.ts +++ b/jquery.dataTables/jquery.dataTables.d.ts @@ -27,30 +27,30 @@ declare module DataTables _(selector:JQuery, opts?:RowParams): any[]; /// Add a single new row or multiple rows of data to the table. - fnAddData(data:any, redraw?:bool) : number[]; + fnAddData(data:any, redraw?:boolean) : number[]; /// This function will make DataTables recalculate the column sizes. - fnAdjustColumnSizing(redraw? : bool) : void; + fnAdjustColumnSizing(redraw? : boolean) : void; /// Quickly and simply clear a table - fnClearTable(redraw? : bool) : void; + fnClearTable(redraw? : boolean) : void; /// The exact opposite of 'opening' a row, this function will close any rows which are currently 'open'. fnClose(node: Node) : number; /// Remove a row for the table - fnDeleteRow(index: number, callback?: () => void, redraw?: bool) : any[]; - fnDeleteRow(tr: Node, callback?: () => void, redraw?: bool) : any[]; + fnDeleteRow(index: number, callback?: () => void, redraw?: boolean) : any[]; + fnDeleteRow(tr: Node, callback?: () => void, redraw?: boolean) : any[]; /// Restore the table to it's original state in the DOM by removing all of DataTables enhancements, /// alterations to the DOM structure of the table and event listeners. - fnDestroy(remove?: bool) : void; + fnDestroy(remove?: boolean) : void; /// Redraw the table - fnDraw(complete? : bool) : void; + fnDraw(complete? : boolean) : void; /// Filter the input based on data - fnFilter(input: string, column? : number, regex?: bool, smart? : bool, showGlobal?: bool, caseInsensitive? : bool) : void; + fnFilter(input: string, column? : number, regex?: boolean, smart? : boolean, showGlobal?: boolean, caseInsensitive? : boolean) : void; /// Get the data for the whole table, an individual row or an individual cell based on the provided parameters. fnGetData(row?: Node, col? : number) : any; @@ -63,7 +63,7 @@ declare module DataTables fnGetPosition(node: Node) : any; // number | number[] /// Check to see if a row is 'open' or not. - fnIsOpen(tr: Node) : bool; + fnIsOpen(tr: Node) : boolean; /// This function will place a new row directly after a row which is currently on display on the page, /// with the HTML contents that is passed into the function. @@ -72,11 +72,11 @@ declare module DataTables fnOpen(node: Node, html: JQuery, clazz: string) : Node; /// Change the pagination - provides the internal logic for pagination in a simple API function. - fnPageChange(action: string, redraw?: bool) : void; - fnPageChange(page: number, redraw?: bool) : void; + fnPageChange(action: string, redraw?: boolean) : void; + fnPageChange(page: number, redraw?: boolean) : void; /// Show a particular column - fnSetColumnVis(column: number, show: bool, redraw?: bool) : void; + fnSetColumnVis(column: number, show: boolean, redraw?: boolean) : void; /// Get the settings for a particular table for external manipulation fnSettings() : Settings; @@ -90,25 +90,25 @@ declare module DataTables /// Update a table cell or row - this method will accept either a single value to update the cell with, /// an array of values with one element for each column or an object in the same format as the original data source. - fnUpdate(data: any, row: Node, column?:number, redraw?: bool, action? : bool) : number; - fnUpdate(data: any, dataIndex: number, column?:number, redraw?: bool, action? : bool) : number; + fnUpdate(data: any, row: Node, column?:number, redraw?: boolean, action? : boolean) : number; + fnUpdate(data: any, dataIndex: number, column?:number, redraw?: boolean, action? : boolean) : number; /// Provide a common method for plug-ins to check the version of DataTables being used, /// in order to ensure compatibility. - fnVersionCheck(version: string) : bool; + fnVersionCheck(version: string) : boolean; } export interface Static { /// Provide a common method for plug-ins to check the version of DataTables being used, /// in order to ensure compatibility. - fnVersionCheck(version: string) : bool; + fnVersionCheck(version: string) : boolean; /// Check if a TABLE node is a DataTable table already or not. - fnIsDataTable(table: Node) : bool; + fnIsDataTable(table: Node) : boolean; /// Get all DataTable tables that have been initialised. - fnTables(visible? : bool) : Node[]; + fnTables(visible? : boolean) : Node[]; } export interface RowParams @@ -138,24 +138,24 @@ declare module DataTables aoColumnDefs?: ColumnDef[]; aoSearchCols?: any[]; asStripClasses?: string[]; - bAutoWidth?: bool; - bDeferRender?: bool; - bDestroy?: bool; - bFilter?: bool; - bInfo?: bool; - bJQueryUI?: bool; - bLengthChange?: bool; - bPaginate?: bool; - bProcessing?: bool; - bRetrieve?: bool; - bScrollAutoCss?: bool; - bScrollCollapse?: bool; - bScrollInfinite?: bool; - bServerSide?: bool; - bSort?: bool; - bSortCellsTop?: bool; - bSortClasses?: bool; - bStateSave?: bool; + bAutoWidth?: boolean; + bDeferRender?: boolean; + bDestroy?: boolean; + bFilter?: boolean; + bInfo?: boolean; + bJQueryUI?: boolean; + bLengthChange?: boolean; + bPaginate?: boolean; + bProcessing?: boolean; + bRetrieve?: boolean; + bScrollAutoCss?: boolean; + bScrollCollapse?: boolean; + bScrollInfinite?: boolean; + bServerSide?: boolean; + bSort?: boolean; + bSortCellsTop?: boolean; + bSortClasses?: boolean; + bStateSave?: boolean; fnCookieCallback?: CookieCallback; fnCreatedRow?: RowCreatedCallback; fnDrawCallback?: DrawCallback; @@ -227,10 +227,10 @@ declare module DataTables { aDataSort?: number[]; asSorting?: string[]; - bSearchable? : bool; - bSortable? : bool; - bVisible? : bool; - _bAutoType? : bool; + bSearchable? : boolean; + bSortable? : boolean; + bVisible? : boolean; + _bAutoType? : boolean; fnCreatedCell?: CreatedCell; iDataSort?: number; mData?: any; @@ -257,7 +257,7 @@ declare module DataTables oFeatures : Features; oScroll: ScrollingSettings; oLanguage : { fnInfoCallback : InfoCallback; }; - oBrowser : { bScrollOversize : bool; }; + oBrowser : { bScrollOversize : boolean; }; aanFeatures: Node[][]; aoData: Row[]; aiDisplay: number[]; @@ -289,8 +289,8 @@ declare module DataTables nTFoot: Node; nTBody: Node; nTableWrapper: Node; - bDeferLoading: bool; - bInitialized: bool; + bDeferLoading: boolean; + bInitialized: boolean; aoOpenRows: any[]; sDom: string; sPaginationType: string; @@ -302,7 +302,7 @@ declare module DataTables oLoadedState: any; sAjaxSource: string; sAjaxDataProp: string; - bAjaxDataGet: bool; + bAjaxDataGet: boolean; jqXHR: any; fnServerData: any; aoServerParams: any[]; @@ -310,18 +310,18 @@ declare module DataTables fnFormatNumber: FormatNumber; aLengthMenu: any[]; iDraw: number; - bDrawing: bool; + bDrawing: boolean; iDrawError: number; _iDisplayLength: number; _iDisplayStart: number; _iDisplayEnd: number; _iRecordsTotal: number; _iRecordsDisplay: number; - bJUI: bool; + bJUI: boolean; oClasses: any; - bFiltered: bool; - bSorted: bool; - bSortCellsTop: bool; + bFiltered: boolean; + bSorted: boolean; + bSortCellsTop: boolean; oInit: any; aoDestroyCallback: any[]; fnRecordsTotal: () => number; @@ -336,24 +336,24 @@ declare module DataTables export interface Features { - bAutoWidth: bool; - bDeferRender: bool; - bFilter: bool; - bInfo: bool; - bLengthChange: bool; - bPaginate: bool; - bProcessing: bool; - bServerSize: bool; - bSort: bool; - bSortClasses: bool; - bStateSave: bool; + bAutoWidth: boolean; + bDeferRender: boolean; + bFilter: boolean; + bInfo: boolean; + bLengthChange: boolean; + bPaginate: boolean; + bProcessing: boolean; + bServerSize: boolean; + bSort: boolean; + bSortClasses: boolean; + bStateSave: boolean; } export interface ScrollingSettings { - bAutoCss : bool; - bCollapse: bool; - bInfinite: bool; + bAutoCss : boolean; + bCollapse: boolean; + bInfinite: boolean; iBarWidth: number; iLoadGap: number; sX: string; @@ -373,10 +373,10 @@ declare module DataTables { aDataSort: any; asSorting: string[]; - bSearchable : bool; - bSortable : bool; - bVisible : bool; - _bAutoType : bool; + bSearchable : boolean; + bSortable : boolean; + bVisible : boolean; + _bAutoType : boolean; fnCreatedCell: CreatedCell; fnGetData: (data: any, specific: string) => any; fnSetData: (data: any, value: any) => void; @@ -439,7 +439,7 @@ declare module DataTables export interface PreDrawCallback { - (settings: Settings) : bool; + (settings: Settings) : boolean; } export interface RowCallback From 8d4540f61b534df02412f21c16afe0d2a63b0ede Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Tue, 25 Jun 2013 13:44:00 +0100 Subject: [PATCH 004/756] Fix definitions for TS 0.9 --- bgiframe/typescript.bgiframe.d.ts | 2 +- box2d/box2dweb.d.ts | 154 +++++++++--------- epiceditor/epiceditor.d.ts | 2 +- firebase/firebase.d.ts | 2 +- .../jquery.clientSideLogging.d.ts | 1 - jscrollpane/jscrollpane.d.ts | 8 +- mousetrap/mousetrap.d.ts | 2 +- 7 files changed, 85 insertions(+), 86 deletions(-) diff --git a/bgiframe/typescript.bgiframe.d.ts b/bgiframe/typescript.bgiframe.d.ts index b0b77cf07c..60206f6107 100644 --- a/bgiframe/typescript.bgiframe.d.ts +++ b/bgiframe/typescript.bgiframe.d.ts @@ -12,7 +12,7 @@ * Copyright (c) 2013 Brandon Aaron (http://brandonaaron.net) */ -module BgiFrame { +declare module BgiFrame { interface ISettings { top: string; left: string; diff --git a/box2d/box2dweb.d.ts b/box2d/box2dweb.d.ts index 1126379803..808633adea 100644 --- a/box2d/box2dweb.d.ts +++ b/box2d/box2dweb.d.ts @@ -30,7 +30,7 @@ import b2Contacts = Box2D.Dynamics.Contacts; import b2Controllers = Box2D.Dynamics.Controllers; import b2Joints = Box2D.Dynamics.Joints; -module Box2D.Common { +declare module Box2D.Common { /** * Color for debug drawing. Each value has the range [0, 1]. @@ -76,7 +76,7 @@ module Box2D.Common { } } -module Box2D.Common { +declare module Box2D.Common { /** * Controls Box2D global settings. @@ -228,7 +228,7 @@ module Box2D.Common { } } -module Box2D.Common.Math { +declare module Box2D.Common.Math { /** * A 2-by-2 matrix. Stored in column-major order. @@ -341,7 +341,7 @@ module Box2D.Common.Math { } } -module Box2D.Common.Math { +declare module Box2D.Common.Math { /** * A 3-by3 matrix. Stored in column-major order. @@ -428,7 +428,7 @@ module Box2D.Common.Math { } } -module Box2D.Common.Math { +declare module Box2D.Common.Math { /** * Math utility functions. @@ -693,7 +693,7 @@ module Box2D.Common.Math { } } -module Box2D.Common.Math { +declare module Box2D.Common.Math { /** * This describes the motion of a body/shape for TOI computation. Shapes are defined with respect to the body origin, which may no coincide with the center of mass. However, to support dynamics we must interpolate the center of mass position. @@ -756,7 +756,7 @@ module Box2D.Common.Math { } } -module Box2D.Common.Math { +declare module Box2D.Common.Math { /** * A transform contains translation and rotation. It is used to represent the position and orientation of rigid frames. @@ -806,7 +806,7 @@ module Box2D.Common.Math { } } -module Box2D.Common.Math { +declare module Box2D.Common.Math { /** * A 2D column vector. @@ -957,7 +957,7 @@ module Box2D.Common.Math { } } -module Box2D.Common.Math { +declare module Box2D.Common.Math { /** * A 2D column vector with 3 elements. @@ -1043,7 +1043,7 @@ module Box2D.Common.Math { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * Axis aligned bounding box. @@ -1117,7 +1117,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * We use contact ids to facilitate warm starting. @@ -1153,7 +1153,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * This structure is used to report contact points. @@ -1207,7 +1207,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * Input for b2Distance. You have to option to use the shape radii in the computation. Even @@ -1241,7 +1241,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * Output calculation for b2Distance. @@ -1270,7 +1270,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * A distance proxy is used by the GJK algorithm. It encapsulates any shape. @@ -1327,7 +1327,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * A dynamic tree arranges data in a binary tree to accelerate queries such as volume queries and ray casts. Leafs are proxies with an AABB. In the tree we expand the proxy AABB by b2_fatAABBFactor so that the proxy AABB is bigger than the client object. This allows the client object to move by small amounts without triggering a tree update. Nodes are pooled. @@ -1402,7 +1402,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * The broad-phase is used for computing pairs and performing volume queries and ray casts. This broad-phase does not persist pairs. Instead, this reports potentially new pairs. It is up to the client to consume the new pairs and to track subsequent overlap. @@ -1483,7 +1483,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * Empty declaration, used in many callbacks within b2DynamicTree. @@ -1494,7 +1494,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * A manifold for two touching convex shapes. Box2D supports multiple types of contact: - clip point versus plane with radius - point versus point with radius (circles) The local point usage depends on the manifold type: -e_circles: the local center of circleA -e_faceA: the center of faceA -e_faceB: the center of faceB Similarly the local normal usage: -e_circles: not used -e_faceA: the normal on polygonA -e_faceB: the normal on polygonB We store contacts in this way so that position correction can account for movement, which is critical for continuous physics. All contact scenarios must be expressed in one of these types. This structure is stored across time steps, so we keep it small. @@ -1565,7 +1565,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * A manifold point is a contact point belonging to a contact manifold. It holds details related to the geometry and dynamics of the contact points. The local point usage depends on the manifold type: -e_circles: the local center of circleB -e_faceA: the local center of cirlceB or the clip point of polygonB -e_faceB: the clip point of polygonA This structure is stored across time steps, so we keep it small. Note: the impulses are used for internal caching and may not provide reliable contact forces, especially for high speed collisions. @@ -1610,7 +1610,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * An oriented bounding box. @@ -1634,7 +1634,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * Ray cast input data. @@ -1666,7 +1666,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * Results of a ray cast. @@ -1685,7 +1685,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * A line in space between two given vertices. @@ -1735,7 +1735,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * Used to warm start b2Distance. Set count to zero on first call. @@ -1764,7 +1764,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * Inpute parameters for b2TimeOfImpact @@ -1798,7 +1798,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * This is used to compute the current state of a contact manifold. @@ -1837,7 +1837,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * We use contact ids to facilitate warm starting. @@ -1866,7 +1866,7 @@ module Box2D.Collision { } } -module Box2D.Collision { +declare module Box2D.Collision { /** * Interface for objects tracking overlap of many AABBs. @@ -1940,7 +1940,7 @@ module Box2D.Collision { } } -module Box2D.Collision.Shapes { +declare module Box2D.Collision.Shapes { /** * A circle shape. @@ -2038,7 +2038,7 @@ module Box2D.Collision.Shapes { } } -module Box2D.Collision.Shapes { +declare module Box2D.Collision.Shapes { /** * This structure is used to build edge shapes. @@ -2067,7 +2067,7 @@ module Box2D.Collision.Shapes { } } -module Box2D.Collision.Shapes { +declare module Box2D.Collision.Shapes { /** * An edge shape. @@ -2223,7 +2223,7 @@ module Box2D.Collision.Shapes { } } -module Box2D.Collision.Shapes { +declare module Box2D.Collision.Shapes { /** * This holds the mass data computed for a shape. @@ -2247,7 +2247,7 @@ module Box2D.Collision.Shapes { } } -module Box2D.Collision.Shapes { +declare module Box2D.Collision.Shapes { /** * Convex polygon. The vertices must be in CCW order for a right-handed coordinate system with the z-axis coming out of the screen. @@ -2429,7 +2429,7 @@ module Box2D.Collision.Shapes { } } -module Box2D.Collision.Shapes { +declare module Box2D.Collision.Shapes { /** * A shape is used for collision detection. Shapes are created in b2Body. You can use shape for collision detection before they are attached to the world. @@ -2543,7 +2543,7 @@ module Box2D.Collision.Shapes { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * A rigid body. @@ -2927,7 +2927,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * A body definition holds all the data needed to construct a rigid body. You can safely re-use body definitions. @@ -3009,7 +3009,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * Implement this class to provide collision filtering. In other words, you can implement this class if you want finer control over contact creation. @@ -3037,7 +3037,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * Contact impulses for reporting. Impulses are used instead of forces because sub-step forces may approach infinity for rigid body collisions. These match up one-to-one with the contact points in b2Manifold. @@ -3056,7 +3056,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * Implement this class to get contact information. You can use these results for things like sounds and game logic. You can also get contact results by traversing the contact lists after the time step. However, you might miss some contacts because continuous physics leads to sub-stepping. Additionally you may receive multiple callbacks for the same contact in a single time step. You should strive to make your callbacks efficient because there may be many callbacks per time step. @@ -3092,7 +3092,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * Implement and register this class with a b2World to provide debug drawing of physics entities in your game. @@ -3285,7 +3285,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * Joints and shapes are destroyed when their associated body is destroyed. Implement this listener so that you may nullify references to these joints and shapes. @@ -3306,7 +3306,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * This holds contact filtering data. @@ -3336,7 +3336,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * A fixture is used to attach a shape to a body for collision detection. A fixture inherits its transform from its parent. Fixtures hold additional non-geometric data such as friction, collision filters, etc. Fixtures are created via b2Body::CreateFixture. @@ -3470,7 +3470,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * A fixture definition is used to create a fixture. This class defines an abstract fixture definition. You can reuse fixture definitions safely. @@ -3519,7 +3519,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics { +declare module Box2D.Dynamics { /** * The world class manages all physics entities, dynamic simulation, and asynchronous queries. @@ -3787,7 +3787,7 @@ module Box2D.Dynamics { } } -module Box2D.Dynamics.Contacts { +declare module Box2D.Dynamics.Contacts { /** * The class manages contact between two shapes. A contact exists for each overlapping AABB in the broad-phase (except if filtered). Therefore a contact object may exist that has no contact points. @@ -3873,7 +3873,7 @@ module Box2D.Dynamics.Contacts { } } -module Box2D.Dynamics.Contacts { +declare module Box2D.Dynamics.Contacts { /** * A contact edge is used to connect bodies and contacts together in a contact graph where each body is a node and each contact is an edge. A contact edge belongs to a doubly linked list maintained in each attached body. Each contact has two contact nodes, one for each attached body. @@ -3902,7 +3902,7 @@ module Box2D.Dynamics.Contacts { } } -module Box2D.Dynamics.Contacts { +declare module Box2D.Dynamics.Contacts { /** * This structure is used to report contact point results. @@ -3946,7 +3946,7 @@ module Box2D.Dynamics.Contacts { } } -module Box2D.Dynamics.Controllers { +declare module Box2D.Dynamics.Controllers { /** * Base class for controllers. Controllers are a convience for encapsulating common per-step functionality. @@ -4012,7 +4012,7 @@ module Box2D.Dynamics.Controllers { } } -module Box2D.Dynamics.Controllers { +declare module Box2D.Dynamics.Controllers { /** * Controller Edge. @@ -4051,7 +4051,7 @@ module Box2D.Dynamics.Controllers { } } -module Box2D.Dynamics.Controllers { +declare module Box2D.Dynamics.Controllers { /** * Calculates buoyancy forces for fluids in the form of a half plane. @@ -4112,7 +4112,7 @@ module Box2D.Dynamics.Controllers { } } -module Box2D.Dynamics.Controllers { +declare module Box2D.Dynamics.Controllers { /** * Applies an acceleration every frame, like gravity @@ -4131,7 +4131,7 @@ module Box2D.Dynamics.Controllers { } } -module Box2D.Dynamics.Controllers { +declare module Box2D.Dynamics.Controllers { /** * Applies an acceleration every frame, like gravity. @@ -4150,7 +4150,7 @@ module Box2D.Dynamics.Controllers { } } -module Box2D.Dynamics.Controllers { +declare module Box2D.Dynamics.Controllers { /** * Applies simplified gravity between every pair of bodies. @@ -4175,7 +4175,7 @@ module Box2D.Dynamics.Controllers { } } -module Box2D.Dynamics.Controllers { +declare module Box2D.Dynamics.Controllers { /** * Applies top down linear damping to the controlled bodies The damping is calculated by multiplying velocity by a matrix in local co-ordinates. @@ -4207,7 +4207,7 @@ module Box2D.Dynamics.Controllers { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * The base joint class. Joints are used to constraint two bodies together in various fashions. Some joints also feature limits and motors. @@ -4284,7 +4284,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Joint definitions are used to construct joints. @@ -4323,7 +4323,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * A joint edge is used to connect bodies and joints together in a joint graph where each body is a node and each joint is an edge. A joint edge belongs to a doubly linked list maintained in each attached body. Each joint has two joint nodes, one for each attached body. @@ -4352,7 +4352,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * A distance joint constrains two points on two bodies to remain at a fixed distance from each other. You can view this as a massless, rigid rod. @@ -4423,7 +4423,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Distance joint definition. This requires defining an anchor point on both bodies and the non-zero length of the distance joint. The definition uses local anchor points so that the initial configuration can violate the constraint slightly. This helps when saving and loading a game. @@ -4472,7 +4472,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Friction joint. This is used for top-down friction. It provides 2D translational friction and angular friction. @@ -4540,7 +4540,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Friction joint defintion. @@ -4582,7 +4582,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * A gear joint is used to connect two joints together. Either joint can be a revolute or prismatic joint. You specify a gear ratio to bind the motions together: coordinate1 + ratio coordinate2 = constant The ratio can be negative or positive. If one joint is a revolute joint and the other joint is a prismatic joint, then the ratio will have units of length or units of 1/length. @@ -4630,7 +4630,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Gear joint definition. This definition requires two existing revolute or prismatic joints (any combination will work). The provided joints must attach a dynamic body to a static body. @@ -4659,7 +4659,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * A line joint. This joint provides one degree of freedom: translation along an axis fixed in body1. You can use a joint limit to restrict the range of motion and a joint motor to drive the motion or to model joint friction. @@ -4779,7 +4779,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Line joint definition. This requires defining a line of motion using an axis and an anchor point. The definition uses local anchor points and a local axis so that the initial configuration can violate the constraint slightly. The joint translation is zero when the local anchor points coincide in world space. Using local anchors and a local axis helps when saving and loading a game. @@ -4847,7 +4847,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * A mouse joint is used to make a point on a body track a specified world point. This a soft constraint with a maximum force. This allows the constraint to stretch and without applying huge forces. Note: this joint is not fully documented as it is intended primarily for the testbed. See that for more instructions. @@ -4930,7 +4930,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Mouse joint definition. This requires a world target point, tuning parameters, and the time step. @@ -4959,7 +4959,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * A prismatic joint. This joint provides one degree of freedom: translation along an axis fixed in body1. Relative rotation is prevented. You can use a joint limit to restrict the range of motion and a joint motor to drive the motion or to model joint friction. @@ -5073,7 +5073,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Prismatic joint definition. This requires defining a line of motion using an axis and an anchor point. The definition uses local anchor points and a local axis so that the initial configuration can violate the constraint slightly. The joint translation is zero when the local anchor points coincide in world space. Using local anchors and a local axis helps when saving and loading a game. @@ -5146,7 +5146,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * The pulley joint is connected to two bodies and two fixed ground points. The pulley supports a ratio such that: length1 + ratio length2 <= constant Yes, the force transmitted is scaled by the ratio. The pulley also enforces a maximum length limit on both sides. This is useful to prevent one side of the pulley hitting the top. @@ -5206,7 +5206,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Pulley joint definition. This requires two ground anchors, two dynamic body anchor points, max lengths for each side, and a pulley ratio. @@ -5276,7 +5276,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * A revolute joint constrains to bodies to share a common point while they are free to rotate about the point. The relative rotation about the shared point is the joint angle. You can limit the relative rotation with a joint limit that specifies a lower and upper angle. You can use a motor to drive the relative rotation about the shared point. A maximum motor torque is provided so that infinite forces are not generated. @@ -5390,7 +5390,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Revolute joint definition. This requires defining an anchor point where the bodies are joined. The definition uses local anchor points so that the initial configuration can violate the constraint slightly. You also need to specify the initial relative angle for joint limits. This helps when saving and loading a game. The local anchor points are measured from the body's origin rather than the center of mass because: 1. you might not know where the center of mass will be. 2. if you add/remove shapes from a body and recompute the mass, the joints will be broken. @@ -5457,7 +5457,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * A weld joint essentially glues two bodies together. A weld joint may distort somewhat because the island constraint solver is approximate. @@ -5492,7 +5492,7 @@ module Box2D.Dynamics.Joints { } } -module Box2D.Dynamics.Joints { +declare module Box2D.Dynamics.Joints { /** * Weld joint definition. You need to specify local anchor points where they are attached and the relative body angle. The position of the anchor points is important for computing the reaction torque. diff --git a/epiceditor/epiceditor.d.ts b/epiceditor/epiceditor.d.ts index 7030923f2e..479cc7b73e 100644 --- a/epiceditor/epiceditor.d.ts +++ b/epiceditor/epiceditor.d.ts @@ -35,7 +35,7 @@ interface EpicEditorOptions { }; } -class EpicEditor { +declare class EpicEditor { constructor(); constructor(options: EpicEditorOptions); diff --git a/firebase/firebase.d.ts b/firebase/firebase.d.ts index f50919134b..ecab3806ef 100644 --- a/firebase/firebase.d.ts +++ b/firebase/firebase.d.ts @@ -43,7 +43,7 @@ interface IFirebaseQuery { ref(): Firebase; } -class Firebase implements IFirebaseQuery { +declare class Firebase implements IFirebaseQuery { constructor(firebaseURL: string); auth(authToken: string, onComplete?: (error: string, result: IFirebaseAuthResult) => void, onCancel?:(error: string) => void): void; unauth(): void; diff --git a/jquery.clientSideLogging/jquery.clientSideLogging.d.ts b/jquery.clientSideLogging/jquery.clientSideLogging.d.ts index d2031029e4..1bd2d871bd 100644 --- a/jquery.clientSideLogging/jquery.clientSideLogging.d.ts +++ b/jquery.clientSideLogging/jquery.clientSideLogging.d.ts @@ -25,7 +25,6 @@ interface ClientSideLoggingObject { interface JQueryStatic { info: (what?: any) => any; - error: (what?: any) => any; log: (what?: any) => any; clientSideLogging: (options: ClientSideLoggingObject) => any; } diff --git a/jscrollpane/jscrollpane.d.ts b/jscrollpane/jscrollpane.d.ts index 5fd6700602..c7738cfb4b 100644 --- a/jscrollpane/jscrollpane.d.ts +++ b/jscrollpane/jscrollpane.d.ts @@ -3,9 +3,9 @@ // Definitions by: Dániel Tar // Definitions: https://github.com/borisyankov/DefinitelyTyped -/// +/// -declare interface JScrollPaneSettings { +interface JScrollPaneSettings { /** * Whether arrows should be shown on the generated scroll pane. When set to false only the scrollbar * track and drag will be shown, if set to true then arrows buttons will also be shown. @@ -141,7 +141,7 @@ declare interface JScrollPaneSettings { trackClickRepeatFreq?: number; } -declare interface JScrollPaneApi { +interface JScrollPaneApi { /** * Reinitialises the scroll pane (if it's internal dimensions have changed since the last time it was initialised). * The settings object which is passed in will override any settings from the previous time it was initialised - @@ -308,7 +308,7 @@ declare interface JScrollPaneApi { destroy(): void; } -declare interface JQuery { +interface JQuery { /** * Initialises the jScrollPane on the JQuery object. */ diff --git a/mousetrap/mousetrap.d.ts b/mousetrap/mousetrap.d.ts index a81854c4f2..814efb3ddf 100644 --- a/mousetrap/mousetrap.d.ts +++ b/mousetrap/mousetrap.d.ts @@ -18,4 +18,4 @@ interface MousetrapStatic { reset(): void; } -var Mousetrap: MousetrapStatic; +declare var Mousetrap: MousetrapStatic; From 67f43af9b65a7c79a30ca95d19e3d6b6f67601c8 Mon Sep 17 00:00:00 2001 From: Aaron King Date: Tue, 25 Jun 2013 16:52:24 -0400 Subject: [PATCH 005/756] moment: added support for isBefore, isAfter, isSame --- moment/moment.d.ts | 66 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/moment/moment.d.ts b/moment/moment.d.ts index 2ba80d175c..7f8dc19d46 100644 --- a/moment/moment.d.ts +++ b/moment/moment.d.ts @@ -115,6 +115,39 @@ interface Moment { daysInMonth(): number; isDST(): bool; + isBefore(b: Moment): bool; + isBefore(b: string): bool; + isBefore(b: Number): bool; + isBefore(b: Date): bool; + isBefore(b: Array): bool; + isBefore(b: Moment, granularity: string): bool; + isBefore(b: String, granularity: string): bool; + isBefore(b: Number, granularity: string): bool; + isBefore(b: Date, granularity: string): bool; + isBefore(b: Array, granularity: string): bool; + + isAfter(b: Moment): bool; + isAfter(b: string): bool; + isAfter(b: Number): bool; + isAfter(b: Date): bool; + isAfter(b: Array): bool; + isAfter(b: Moment, granularity: string): bool; + isAfter(b: String, granularity: string): bool; + isAfter(b: Number, granularity: string): bool; + isAfter(b: Date, granularity: string): bool; + isAfter(b: Array, granularity: string): bool; + + isSame(b: Moment): bool; + isSame(b: string): bool; + isSame(b: Number): bool; + isSame(b: Date): bool; + isSame(b: Array): bool; + isSame(b: Moment, granularity: string): bool; + isSame(b: String, granularity: string): bool; + isSame(b: Number, granularity: string): bool; + isSame(b: Date, granularity: string): bool; + isSame(b: Array, granularity: string): bool; + lang(language: string); lang(reset: bool); lang(): string; @@ -220,6 +253,39 @@ interface MomentStatic { duration(input: MomentInput): Duration; duration(object: any): Duration; duration(): Duration; + + isBefore(b: Moment): bool; + isBefore(b: string): bool; + isBefore(b: Number): bool; + isBefore(b: Date): bool; + isBefore(b: Array): bool; + isBefore(b: Moment, granularity: string): bool; + isBefore(b: String, granularity: string): bool; + isBefore(b: Number, granularity: string): bool; + isBefore(b: Date, granularity: string): bool; + isBefore(b: Array, granularity: string): bool; + + isAfter(b: Moment): bool; + isAfter(b: string): bool; + isAfter(b: Number): bool; + isAfter(b: Date): bool; + isAfter(b: Array): bool; + isAfter(b: Moment, granularity: string): bool; + isAfter(b: String, granularity: string): bool; + isAfter(b: Number, granularity: string): bool; + isAfter(b: Date, granularity: string): bool; + isAfter(b: Array, granularity: string): bool; + + isSame(b: Moment): bool; + isSame(b: string): bool; + isSame(b: Number): bool; + isSame(b: Date): bool; + isSame(b: Array): bool; + isSame(b: Moment, granularity: string): bool; + isSame(b: String, granularity: string): bool; + isSame(b: Number, granularity: string): bool; + isSame(b: Date, granularity: string): bool; + isSame(b: Array, granularity: string): bool; } declare var moment: MomentStatic; From c72caf82d2088bc502215af39d1590430477a8b3 Mon Sep 17 00:00:00 2001 From: mihailik Date: Wed, 26 Jun 2013 00:16:05 +0200 Subject: [PATCH 006/756] Incorrect `number` type for `autofocus` option, should be `boolean`. --- codemirror/codemirror.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/codemirror/codemirror.d.ts b/codemirror/codemirror.d.ts index 9a3db7147e..03dc2878fa 100644 --- a/codemirror/codemirror.d.ts +++ b/codemirror/codemirror.d.ts @@ -679,7 +679,7 @@ declare module CodeMirror { /** Can be used to make CodeMirror focus itself on initialization. Defaults to off. When fromTextArea is used, and no explicit value is given for this option, it will be set to true when either the source textarea is focused, or it has an autofocus attribute and no other element is focused. */ - autofocus?: number; + autofocus?: boolean; /** Controls whether drag-and - drop is enabled. On by default. */ dragDrop?: boolean; From 2e2524ab4e50079dfb0a9ed2eeb7f66abecea777 Mon Sep 17 00:00:00 2001 From: Terence Lewis Date: Wed, 26 Jun 2013 10:04:11 +0200 Subject: [PATCH 007/756] Made the SignalR definition 0.9 compatible Changed the return type of HubConnection.received to match SignalR.received The 'on' callback can take a variable number of arguments --- signalr/signalr.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/signalr/signalr.d.ts b/signalr/signalr.d.ts index 6078a7d3c2..00a5240b5d 100644 --- a/signalr/signalr.d.ts +++ b/signalr/signalr.d.ts @@ -65,7 +65,7 @@ interface HubProxy { (connection: HubConnection, hubName: string): HubProxy; init(connection: HubConnection, hubName: string): void; hasSubscriptions(): bool; - on(eventName: string, callback: (msg) => void ): HubProxy; + on(eventName: string, callback: (...msg) => void ): HubProxy; off(eventName: string, callback: (msg) => void ): HubProxy; invoke(methodName: string, ...args: any[]): JQueryDeferred; } @@ -79,7 +79,7 @@ interface HubConnectionSettings { interface HubConnection extends SignalR { //(url?: string, queryString?: any, logging?: bool): HubConnection; proxies; - received(callback: (data: { Id; Method; Hub; State; Args; }) => void ): void; + received(callback: (data: { Id; Method; Hub; State; Args; }) => void ): HubConnection; createHubProxy(hubName: string): HubProxy; } From fb6a94f58c75dc69b79386cf839e89341da666e5 Mon Sep 17 00:00:00 2001 From: Karthikeyan VJ Date: Thu, 27 Jun 2013 20:52:23 +0300 Subject: [PATCH 008/756] Changed arguments to optional for Point and Rectangle --- easeljs/easeljs.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/easeljs/easeljs.d.ts b/easeljs/easeljs.d.ts index a8f49f83cb..609922068e 100644 --- a/easeljs/easeljs.d.ts +++ b/easeljs/easeljs.d.ts @@ -484,7 +484,7 @@ declare module createjs { y: number; // methods - constructor (x: number, y: number); + constructor (x?: number, y?: number); clone(): Point; toString(): string; } @@ -498,7 +498,7 @@ declare module createjs { height: number; // methods - constructor (x: number, y: number, width: number, height: number); + constructor (x?: number, y?: number, width?: number, height?: number); clone(): Rectangle; toString(): string; } From 9a9a50e8e6e931c3cff3e8e5ee498133f92cd61e Mon Sep 17 00:00:00 2001 From: Danil Flores Date: Thu, 27 Jun 2013 22:32:04 -0400 Subject: [PATCH 009/756] Fixed problem with jStorage screwing up jQuery --- jstorage/jstorage-tests.ts | 1 + jstorage/jstorage.d.ts | 54 ++++++++++++++++++++------------------ 2 files changed, 30 insertions(+), 25 deletions(-) diff --git a/jstorage/jstorage-tests.ts b/jstorage/jstorage-tests.ts index a8bd01af42..e86e9ffd43 100644 --- a/jstorage/jstorage-tests.ts +++ b/jstorage/jstorage-tests.ts @@ -1,3 +1,4 @@ +/// /// // Test set first overload diff --git a/jstorage/jstorage.d.ts b/jstorage/jstorage.d.ts index 0acc93fbd1..8e99a08a7f 100644 --- a/jstorage/jstorage.d.ts +++ b/jstorage/jstorage.d.ts @@ -3,15 +3,15 @@ // Definitions by: Danil Flores // Definitions: https://github.com/borisyankov/DefinitelyTyped -declare module $.jStorage { +interface JStorageOptions { + TTL: number; +} - class IStorageOptions { - TTL: number; - } +interface JStorageReadonlyStore { + [key: string]: any; +} - interface IJStorage { - [key: string]: any; - } +interface JStorageStatic { /** * Sets a key's value. @@ -24,7 +24,7 @@ declare module $.jStorage { * @param [options.TTL] - optional TTL value * @return the used value */ - function set (key: string, value: TValue, options?: IStorageOptions): TValue; + set(key: string, value: TValue, options?: JStorageOptions): TValue; /** * Looks up a key in cache @@ -33,7 +33,7 @@ declare module $.jStorage { * @param defaultIfNotFound - Default value to return, if key didn't exist. * @return the key value, default value or null */ - function get (key: string, defaultIfNotFound?: TValue): TValue; + get (key: string, defaultIfNotFound?: TValue): TValue; /** * Deletes a key from cache. @@ -41,7 +41,7 @@ declare module $.jStorage { * @param key - Key to delete. * @return true if key existed or false if it didn't */ - function deleteKey(key: string): boolean; + deleteKey(key: string): boolean; /** * Sets a TTL for a key, or remove it if ttl value is 0 or below @@ -50,7 +50,7 @@ declare module $.jStorage { * @param ttl - TTL timeout in milliseconds * @return true if key existed or false if it didn't */ - function setTTL(key: string, ttl: number): boolean; + setTTL(key: string, ttl: number): boolean; /** * Gets remaining TTL (in milliseconds) for a key or 0 when no TTL has been set @@ -58,21 +58,21 @@ declare module $.jStorage { * @param key Key to check * @return Remaining TTL in milliseconds */ - function getTTL(key: string): number; + getTTL(key: string): number; /** * Deletes everything in cache. * * @return Always true */ - function flush(): boolean; + flush(): boolean; /** * Returns a read-only copy of _storage * * @return Read-only copy of _storage */ - function storageObj(): IJStorage + storageObj(): JStorageReadonlyStore /** * Returns an index of all used keys as an array @@ -80,7 +80,7 @@ declare module $.jStorage { * * @return Used keys */ - function index(): string[]; + index(): string[]; /** * How much space in bytes does the storage take? @@ -88,21 +88,21 @@ declare module $.jStorage { * @return Storage size in chars (not the same as in bytes, * since some chars may take several bytes) */ - function storageSize(): number; + storageSize(): number; /** * Which backend is currently in use? * * @return Backend name */ - function currentBackend(): Storage; + currentBackend(): Storage; /** * Test if storage is available * * @return True if storage can be used */ - function storageAvailable(): boolean; + storageAvailable(): boolean; /** * Register change listeners @@ -110,7 +110,7 @@ declare module $.jStorage { * @param key Key name * @param callback Function to run when the key changes */ - function listenKeyChange(key: string, callback: (key: string, value: any) => void ): void; + listenKeyChange(key: string, callback: (key: string, value: any) => void ): void; /** * Register change listeners @@ -118,7 +118,7 @@ declare module $.jStorage { * @param key Key name * @param callback Function to run when the key changes */ - function listenKeyChange(key: string, callback: (key: string, value: TValue) => void ): void; + listenKeyChange(key: string, callback: (key: string, value: TValue) => void ): void; /** * Remove change listeners @@ -126,7 +126,7 @@ declare module $.jStorage { * @param key Key name to unregister listeners against * @param [callback] If set, unregister the callback, if not - unregister all */ - function stopListening(key: string, callback?: Function): void; + stopListening(key: string, callback?: Function): void; /** * Subscribe to a Publish/Subscribe event stream @@ -134,7 +134,7 @@ declare module $.jStorage { * @param channel Channel name * @param callback Function to run when the something is published to the channel */ - function subscribe(channel: string, callback: (channel: string, value: any) => void ): void; + subscribe(channel: string, callback: (channel: string, value: any) => void ): void; /** * Subscribe to a Publish/Subscribe event stream @@ -142,7 +142,7 @@ declare module $.jStorage { * @param channel Channel name * @param callback Function to run when the something is published to the channel */ - function subscribe(channel: string, callback: (channel: string, value: TValue) => void ): void; + subscribe(channel: string, callback: (channel: string, value: TValue) => void ): void; /** * Publish data to an event stream @@ -150,10 +150,14 @@ declare module $.jStorage { * @param channel Channel name * @param payload Payload to deliver */ - function publish(channel: string, payload: any): void; + publish(channel: string, payload: any): void; /** * Reloads the data from browser storage */ - function reInit(): void; + reInit(): void; +} + +interface JQueryStatic { + jStorage: JStorageStatic; } \ No newline at end of file From 1da3d8cf714ee649f0f9adc0ac058600261df45e Mon Sep 17 00:00:00 2001 From: rosedomini Date: Fri, 28 Jun 2013 17:44:54 +0200 Subject: [PATCH 010/756] add View#setElement for JQuery element parameter setElement(element: HTMLElement, delegate?: boolean); setElement(element: JQuery, delegate?: boolean); --- backbone/backbone.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/backbone/backbone.d.ts b/backbone/backbone.d.ts index cfc3c3d2f1..aa8488beac 100644 --- a/backbone/backbone.d.ts +++ b/backbone/backbone.d.ts @@ -295,6 +295,7 @@ declare module Backbone { collection: Collection; make(tagName: string, attrs?, opts?): View; setElement(element: HTMLElement, delegate?: boolean); + setElement(element: JQuery, delegate?: boolean); id: string; cid: string; className: string; From 5b862093ae5f2d51fbf8ac2a797b07ccd481978b Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Fri, 28 Jun 2013 21:51:16 +0100 Subject: [PATCH 011/756] Rename test files to standard convention --- colors/{colors-test.ts => colors-tests.ts} | 0 ...highcharts-test.ts => highcharts-tests.ts} | 198 +++++++++--------- logg/{logg-test.ts => logg-tests.ts} | 0 3 files changed, 99 insertions(+), 99 deletions(-) rename colors/{colors-test.ts => colors-tests.ts} (100%) rename highcharts/{highcharts-test.ts => highcharts-tests.ts} (96%) rename logg/{logg-test.ts => logg-tests.ts} (100%) diff --git a/colors/colors-test.ts b/colors/colors-tests.ts similarity index 100% rename from colors/colors-test.ts rename to colors/colors-tests.ts diff --git a/highcharts/highcharts-test.ts b/highcharts/highcharts-tests.ts similarity index 96% rename from highcharts/highcharts-test.ts rename to highcharts/highcharts-tests.ts index 1aab23a19c..0e951dbbd2 100644 --- a/highcharts/highcharts-test.ts +++ b/highcharts/highcharts-tests.ts @@ -1,99 +1,99 @@ -/// - - -var animate: HighchartsBoolOrAnimation; -animate = true; -animate = { duration: 200, easing: "linear" }; - - -var gradient: HighchartsColorOrGradient; -gradient = { - linearGradient: { x0: 0, y0: 0, x1: 500, y1: 500 }, - stops: [ - [0, 'rgb(255, 255, 255)'], - [1, 'rgb(200, 200, 255)'] - ] -} - -var color = "#fcfcff"; - -var backgound: HighchartsColorOrGradient; - -backgound = gradient; -backgound = color; - -var chart1 = new Highcharts.Chart({ - chart: { - renderTo: "container" - }, - xAxis: [{ - }], - series: [{ - data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4] - }] -}); - -var chart2 = new Highcharts.Chart({ - chart: { - renderTo: 'container', - width: 400, - height: 400, - spacingRight: 20 - }, - xAxis: [{ - type: 'logarithmic', - min: 1, - max: 1000, - endOnTick: true, - tickInterval: 1, - minorTickInterval: 0.1, - gridLineWidth: 1 - }], - yAxis: [{ - type: 'logarithmic', - min: 1, - max: 1000, - tickInterval: 1, - minorTickInterval: 0.1, - title: { - text: null - } - }], - legend: { - enabled: false - }, - series: [{ - data: [ - [550, 870], [738, 362], [719, 711], [547, 665], [595, 197], [332, 144], - [581, 555], [196, 862], [6, 837], [400, 924], [888, 148], [785, 730], - [374, 358], [440, 69], [704, 318], [646, 506], [238, 662], [233, 56], - [622, 572], [563, 903], [744, 672], [904, 646], [390, 325], [536, 491], - [676, 186], [467, 145], [790, 114], [437, 793], [853, 243], [947, 196], - [395, 728], [527, 148], [516, 675], [632, 562], [52, 552], [605, 580], - [790, 865], [156, 87], [584, 290], [339, 921], [383, 633], [106, 373], - [762, 863], [424, 149], [608, 959], [574, 711], [468, 664], [268, 77], - [894, 850], [171, 102], [203, 565], [592, 549], [86, 486], [526, 244], - [323, 575], [488, 842], [401, 618], [148, 43], [828, 314], [554, 711], - [685, 868], [387, 435], [469, 828], [623, 506], [436, 184], [450, 156], - [805, 517], [465, 997], [728, 802], [231, 438], [935, 438], [519, 856], - [378, 579], [73, 765], [223, 219], [359, 317], [686, 742], [17, 790], - [20, 35], [410, 644], [984, 325], [503, 882], [900, 187], [578, 968], - [27, 718], [355, 704], [395, 332], [641, 548], [964, 374], [215, 472], - [323, 66], [882, 542], [671, 327], [650, 193], [828, 632], [760, 929], - [607, 335], [928, 826], [462, 598], [631, 411] - ], - type: 'scatter' - }] -}); - -chart1.exportChart(null, { - chart: { - backgroundColor: '#FFFFFF' - } -}); - - -var div: HTMLDivElement; -var r = new Highcharts.Renderer(div, 20, 30); -var box = r.text("Hello", 10, 10).getBBox(); - +/// + + +var animate: HighchartsBoolOrAnimation; +animate = true; +animate = { duration: 200, easing: "linear" }; + + +var gradient: HighchartsColorOrGradient; +gradient = { + linearGradient: { x0: 0, y0: 0, x1: 500, y1: 500 }, + stops: [ + [0, 'rgb(255, 255, 255)'], + [1, 'rgb(200, 200, 255)'] + ] +} + +var color = "#fcfcff"; + +var backgound: HighchartsColorOrGradient; + +backgound = gradient; +backgound = color; + +var chart1 = new Highcharts.Chart({ + chart: { + renderTo: "container" + }, + xAxis: [{ + }], + series: [{ + data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4] + }] +}); + +var chart2 = new Highcharts.Chart({ + chart: { + renderTo: 'container', + width: 400, + height: 400, + spacingRight: 20 + }, + xAxis: [{ + type: 'logarithmic', + min: 1, + max: 1000, + endOnTick: true, + tickInterval: 1, + minorTickInterval: 0.1, + gridLineWidth: 1 + }], + yAxis: [{ + type: 'logarithmic', + min: 1, + max: 1000, + tickInterval: 1, + minorTickInterval: 0.1, + title: { + text: null + } + }], + legend: { + enabled: false + }, + series: [{ + data: [ + [550, 870], [738, 362], [719, 711], [547, 665], [595, 197], [332, 144], + [581, 555], [196, 862], [6, 837], [400, 924], [888, 148], [785, 730], + [374, 358], [440, 69], [704, 318], [646, 506], [238, 662], [233, 56], + [622, 572], [563, 903], [744, 672], [904, 646], [390, 325], [536, 491], + [676, 186], [467, 145], [790, 114], [437, 793], [853, 243], [947, 196], + [395, 728], [527, 148], [516, 675], [632, 562], [52, 552], [605, 580], + [790, 865], [156, 87], [584, 290], [339, 921], [383, 633], [106, 373], + [762, 863], [424, 149], [608, 959], [574, 711], [468, 664], [268, 77], + [894, 850], [171, 102], [203, 565], [592, 549], [86, 486], [526, 244], + [323, 575], [488, 842], [401, 618], [148, 43], [828, 314], [554, 711], + [685, 868], [387, 435], [469, 828], [623, 506], [436, 184], [450, 156], + [805, 517], [465, 997], [728, 802], [231, 438], [935, 438], [519, 856], + [378, 579], [73, 765], [223, 219], [359, 317], [686, 742], [17, 790], + [20, 35], [410, 644], [984, 325], [503, 882], [900, 187], [578, 968], + [27, 718], [355, 704], [395, 332], [641, 548], [964, 374], [215, 472], + [323, 66], [882, 542], [671, 327], [650, 193], [828, 632], [760, 929], + [607, 335], [928, 826], [462, 598], [631, 411] + ], + type: 'scatter' + }] +}); + +chart1.exportChart(null, { + chart: { + backgroundColor: '#FFFFFF' + } +}); + + +var div: HTMLDivElement; +var r = new Highcharts.Renderer(div, 20, 30); +var box = r.text("Hello", 10, 10).getBBox(); + diff --git a/logg/logg-test.ts b/logg/logg-tests.ts similarity index 100% rename from logg/logg-test.ts rename to logg/logg-tests.ts From 26d671ccbdadcad6297bc8c0a8afe16c9f732aaf Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Fri, 28 Jun 2013 22:14:33 +0100 Subject: [PATCH 012/756] Fix definitions for TS 0.9 --- breeze/breeze-1.0.d.ts | 2 +- jquerymobile/jquerymobile.d.ts | 3 -- jsoneditoronline/jsoneditoronline.d.ts | 12 +++---- kolite/kolite.d.ts | 4 +-- node/node-0.8.8.d.ts | 43 +++++++++++--------------- nodemailer/nodemailer.d.ts | 4 +-- pouchDB/pouch.d.ts | 2 +- preloadjs/preloadjs.d.ts | 2 +- pubsubjs/pubsub.d.ts | 2 +- routie/routie.d.ts | 2 +- swipeview/swipeview.d.ts | 2 +- tween.js/tween.js.d.ts | 4 +-- 12 files changed, 36 insertions(+), 46 deletions(-) diff --git a/breeze/breeze-1.0.d.ts b/breeze/breeze-1.0.d.ts index 8a6458498d..5669e85f17 100644 --- a/breeze/breeze-1.0.d.ts +++ b/breeze/breeze-1.0.d.ts @@ -183,7 +183,7 @@ declare module Breeze { parseDateFromServer(date: any): Date; } - declare var DataType: DataType; + var DataType: DataType; class EntityActionSymbol extends BreezeCore.EnumSymbol { } diff --git a/jquerymobile/jquerymobile.d.ts b/jquerymobile/jquerymobile.d.ts index 2d6fa744a1..84c27ba41a 100644 --- a/jquerymobile/jquerymobile.d.ts +++ b/jquerymobile/jquerymobile.d.ts @@ -291,11 +291,8 @@ interface JQueryMobile extends JQueryMobileOptions { showPageLoadingMsg(); hidePageLoadingMsg(); loader; - loading; - loadPage; page; - silentScroll; touchOverflow; showCategory; path; diff --git a/jsoneditoronline/jsoneditoronline.d.ts b/jsoneditoronline/jsoneditoronline.d.ts index 7bdacf0ac7..4b46f4ec03 100644 --- a/jsoneditoronline/jsoneditoronline.d.ts +++ b/jsoneditoronline/jsoneditoronline.d.ts @@ -12,7 +12,7 @@ interface JSONEditorOptions { search?: bool; } -class JSONEditorHistory { +declare class JSONEditorHistory { constructor(editor: JSONEditor); onChange(): void; add(action: string, params: Object); @@ -40,7 +40,7 @@ interface JSONEditorConstructorParams { value?: any; } -class JSONEditorNode { +declare class JSONEditorNode { constructor(editor: JSONEditor, params: JSONEditorConstructorParams); setParent(parent: JSONEditorNode): void; getParent(): JSONEditorNode; @@ -77,7 +77,7 @@ class JSONEditorNode { getAppend(): HTMLElement; } -class JSONEditorAppendNode extends JSONEditorNode { +declare class JSONEditorAppendNode extends JSONEditorNode { constructor(editor: JSONEditor); } @@ -92,7 +92,7 @@ interface JSONEditorShowDropDownListParams { callback: (value: any) => void; } -class JSONEditorSearchBox { +declare class JSONEditorSearchBox { constructor(editor: JSONEditor, container: HTMLElement); next(): void; previous(): void; @@ -126,7 +126,7 @@ interface JSONEditorActionParams { newType?: JSONEditorNodeType; } -class JSONEditor { +declare class JSONEditor { constructor(container: HTMLElement, options?: JSONEditorOptions, json?: any); set(json: Object, name?: string): void; setName(name?: string): void; @@ -170,7 +170,7 @@ interface JSONFormatterOptions { indentation?: number; } -class JSONFormatter { +declare class JSONFormatter { constructor(container: HTMLElement, options?: JSONFormatterOptions, json?: any); set(json: Object); get(): Object; diff --git a/kolite/kolite.d.ts b/kolite/kolite.d.ts index c6c5ec35e5..d86573116f 100644 --- a/kolite/kolite.d.ts +++ b/kolite/kolite.d.ts @@ -41,7 +41,7 @@ interface JQuery { // DirtyFlag ///////////////////////////////////////////// interface DirtyFlag { - isDirty: KnockoutComputed; + isDirty: KnockoutComputed; new (objectToTrack: any, isInitiallyDirty?: bool, hashFunction?: () => any); reset(): void; } @@ -54,7 +54,7 @@ interface KnockoutStatic { // Command ///////////////////////////////////////////// interface KoliteCommand { - canExecute: KnockoutComputed; + canExecute: KnockoutComputed; execute(...args: any[]): any; } diff --git a/node/node-0.8.8.d.ts b/node/node-0.8.8.d.ts index 152b8a9f8a..968d2143f2 100644 --- a/node/node-0.8.8.d.ts +++ b/node/node-0.8.8.d.ts @@ -12,17 +12,6 @@ declare var process: NodeProcess; declare var global: any; -declare var console: { - log(...data: any[]): void; - info(...data: any[]): void; - error(...data: any[]): void; - warn(...data: any[]): void; - dir(obj: any): void; - timeEnd(label: string): void; - trace(label: string): void; - assert(expression: any, ...message: string[]): void; -} - declare var __filename: string; declare var __dirname: string; @@ -309,7 +298,7 @@ declare module "cluster" { } export interface Worker { id: string; - process: child_process; + process: child_process.ChildProcess; suicide: bool; send(message: any, sendHandle?: any): void; destroy(): void; @@ -1015,19 +1004,23 @@ declare module "util" { } declare module "assert" { - export function (booleanValue: bool, message?: string); - export function fail(actual: any, expected: any, message: string, operator: string): void; - export function assert(value: any, message: string): void; - export function ok(value: any, message?: string): void; - export function equal(actual: any, expected: any, message?: string): void; - export function notEqual(actual: any, expected: any, message?: string): void; - export function deepEqual(actual: any, expected: any, message?: string): void; - export function notDeepEqual(acutal: any, expected: any, message?: string): void; - export function strictEqual(actual: any, expected: any, message?: string): void; - export function notStrictEqual(actual: any, expected: any, message?: string): void; - export function throws(block: any, error?: any, messsage?: string): void; - export function doesNotThrow(block: any, error?: any, messsage?: string): void; - export function ifError(value: any): void; + function internal(booleanValue: boolean, message?: string): void; + module internal { + export function fail(actual: any, expected: any, message: string, operator: string): void; + export function assert(value: any, message: string): void; + export function ok(value: any, message?: string): void; + export function equal(actual: any, expected: any, message?: string): void; + export function notEqual(actual: any, expected: any, message?: string): void; + export function deepEqual(actual: any, expected: any, message?: string): void; + export function notDeepEqual(acutal: any, expected: any, message?: string): void; + export function strictEqual(actual: any, expected: any, message?: string): void; + export function notStrictEqual(actual: any, expected: any, message?: string): void; + export function throws(block: any, error?: any, messsage?: string): void; + export function doesNotThrow(block: any, error?: any, messsage?: string): void; + export function ifError(value: any): void; + } + + export = internal; } declare module "tty" { diff --git a/nodemailer/nodemailer.d.ts b/nodemailer/nodemailer.d.ts index 681dd089b0..7d62b7fa56 100644 --- a/nodemailer/nodemailer.d.ts +++ b/nodemailer/nodemailer.d.ts @@ -4,7 +4,7 @@ // Definitions by: Vincent Bortone // Definitions: https://github.com/borisyankov/DefinitelyTyped -class Transport { +declare class Transport { static transports: { SMTP: Transport; SES: Transport; @@ -47,7 +47,7 @@ interface DKIMOptions{ privateKey: any; } -class XOAuthGenerator { +declare class XOAuthGenerator { constructor(options: XOAuthGeneratorOptions); generate(callback: () => any): string; } diff --git a/pouchDB/pouch.d.ts b/pouchDB/pouch.d.ts index 0fa6a1eb26..44730ca4dd 100644 --- a/pouchDB/pouch.d.ts +++ b/pouchDB/pouch.d.ts @@ -215,7 +215,7 @@ interface Pouch extends PouchApi { destroy(name: string, callback: (err: PouchError) => void): void; } -var Pouch: Pouch; +declare var Pouch: Pouch; // // emit is the function that the PouchFilter.map function should call in order to add a particular item to // a filter view. diff --git a/preloadjs/preloadjs.d.ts b/preloadjs/preloadjs.d.ts index 16d939e20b..1b882f9cfe 100644 --- a/preloadjs/preloadjs.d.ts +++ b/preloadjs/preloadjs.d.ts @@ -10,7 +10,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -module createjs { +declare module createjs { export class AbstractLoader { // properties canceled: bool; diff --git a/pubsubjs/pubsub.d.ts b/pubsubjs/pubsub.d.ts index f7bbbbf872..ae5b960f93 100644 --- a/pubsubjs/pubsub.d.ts +++ b/pubsubjs/pubsub.d.ts @@ -1,6 +1,6 @@ // Type definitions for PubSubJS 1.3.5 -module PubSubJS { +declare module PubSubJS { interface Base extends Publish, Subscribe, Unsubscribe { version: string; name: string; diff --git a/routie/routie.d.ts b/routie/routie.d.ts index 78f7e2808e..641c378871 100644 --- a/routie/routie.d.ts +++ b/routie/routie.d.ts @@ -12,4 +12,4 @@ interface Route { toURL(params: any): string; } -function routie(path: string, fn: Function): void; \ No newline at end of file +declare function routie(path: string, fn: Function): void; \ No newline at end of file diff --git a/swipeview/swipeview.d.ts b/swipeview/swipeview.d.ts index f9be1cb2db..dd77b7c610 100644 --- a/swipeview/swipeview.d.ts +++ b/swipeview/swipeview.d.ts @@ -20,7 +20,7 @@ interface PageHTMLElement extends HTMLElement { dataset: any; } -class SwipeView { +declare class SwipeView { masterPages: PageHTMLElement[]; currentMasterPage: number; diff --git a/tween.js/tween.js.d.ts b/tween.js/tween.js.d.ts index 348adf3c14..77aab07290 100644 --- a/tween.js/tween.js.d.ts +++ b/tween.js/tween.js.d.ts @@ -3,7 +3,7 @@ // Definitions by: https://github.com/sunetos // Definitions: https://github.com/borisyankov/DefinitelyTyped -module TWEEN { +declare module TWEEN { export var REVISION: string; export function getAll(): Tween[]; export function removeAll(): void; @@ -24,7 +24,7 @@ module TWEEN { onUpdate(callback:Function): Tween; onComplete(callback:Function): Tween; update(time:number): bool; - }; + } export var Easing: TweenEasing; export var Interpolation: TweenInterpolation; } From 393245eadbd6792b346a7c9dc26f752398758f04 Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Fri, 28 Jun 2013 22:37:05 +0100 Subject: [PATCH 013/756] Fix marked definition --- marked/marked.d.ts | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/marked/marked.d.ts b/marked/marked.d.ts index 044bd890b5..9e524719ff 100644 --- a/marked/marked.d.ts +++ b/marked/marked.d.ts @@ -5,11 +5,15 @@ declare module "marked" { - export function (src: string, opt?: Options): string; - export function lexer(src: string, opt?: Options): any[]; - export function parser(src: any[], opt?: Options): string; - export function parse(src: string, opt?: Options): string; - export function setOptions(opt: Options): void; + function marked(src: string, opt?: Options): string; + module marked { + export function lexer(src: string, opt?: Options): any[]; + export function parser(src: any[], opt?: Options): string; + export function parse(src: string, opt?: Options): string; + export function setOptions(opt: Options): void; + } + + export = marked; } interface Options { From 7c8fb1b03eb96336c6c52f33698d5cc708c612f9 Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Fri, 28 Jun 2013 23:01:51 +0100 Subject: [PATCH 014/756] Fix extjs definition --- extjs/ExtJS-4.2.0.d.ts | 124 ++++++++++++++++++++++++----------------- extjs/ExtJS.d.ts | 42 ++++++++------ 2 files changed, 98 insertions(+), 68 deletions(-) diff --git a/extjs/ExtJS-4.2.0.d.ts b/extjs/ExtJS-4.2.0.d.ts index c5a6c37d4e..1a26c781a2 100644 --- a/extjs/ExtJS-4.2.0.d.ts +++ b/extjs/ExtJS-4.2.0.d.ts @@ -164,9 +164,9 @@ declare module Ext { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; /** [Method] Template method called after a Component has been positioned @@ -2063,9 +2063,9 @@ declare module Ext.chart { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] set the store after rendering the chart */ afterRender?(): void; /** [Method] Binds a store to this instance @@ -3419,9 +3419,9 @@ declare module Ext { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Invoked after the Component has been hidden * @param callback Function * @param scope Object @@ -3482,7 +3482,7 @@ declare module Ext { focus?( selectText?:bool, delay?:bool ): Ext.IComponent; focus?( selectText?:bool, delay?:number ): Ext.IComponent; /** [Method] Implements an upward event bubbling policy */ - getBubbleTarget?(): void; + getBubbleTarget? (): Ext.IContainer; /** [Method] Retrieves the top level element representing this component */ getEl?(): Ext.dom.IElement; /** [Method] Retrieves the id of this component */ @@ -3710,9 +3710,9 @@ declare module Ext.container { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Invoked after the Container has laid out and rendered if necessary its child Components * @param layout Ext.layout.container.IContainer */ @@ -14114,7 +14114,7 @@ declare module Ext.form.field { /** [Method] Returns the name attribute of the field */ getName?(): string; /** [Method] Returns the raw value of the field without performing any normalization conversion or validation */ - getRawValue?(): string; + getRawValue?(): any; /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ getSubTplData?(): any; /** [Method] Gets the markup to be inserted into the outer template s bodyEl */ @@ -16469,7 +16469,7 @@ declare module Ext.form.field { /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ getModelData?(): any; /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ - getSubmitValue?(): any; + getSubmitValue?(): string; /** [Method] Method to manage awareness of when components are removed from their respective Container firing a removed event * @param destroying Boolean Will be passed as true if the Container performing the remove operation will delete this Component upon remove. */ @@ -16495,7 +16495,7 @@ declare module Ext.form { /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ getModelData?(): any; /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ - getSubmitValue?(): any; + getSubmitValue?(): string; /** [Method] Method to manage awareness of when components are removed from their respective Container firing a removed event * @param destroying Boolean Will be passed as true if the Container performing the remove operation will delete this Component upon remove. */ @@ -16655,9 +16655,9 @@ declare module Ext.form.field { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; /** [Method] Applies the state to the object @@ -16774,9 +16774,9 @@ declare module Ext.form { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; /** [Method] Applies the state to the object @@ -16893,9 +16893,9 @@ declare module Ext.form { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; /** [Method] Applies the state to the object @@ -18825,9 +18825,9 @@ declare module Ext.grid.column { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; /** [Method] Sizes this Column to fit the max content width @@ -18968,9 +18968,9 @@ declare module Ext.grid { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; /** [Method] Sizes this Column to fit the max content width @@ -20200,9 +20200,9 @@ declare module Ext.grid { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; } } declare module Ext.grid { @@ -20751,8 +20751,8 @@ declare module Ext { * @param version any The version, for example: '1.2.3alpha', '2.4.0-dev' */ export function setVersion( packageName?:any, version?:any ): any; - export function setVersion( packageName?:string, version?:string ): Ext; - export function setVersion( packageName?:string, version?:Ext.IVersion ): Ext; + export function setVersion( packageName?:string, version?:string ): any; + export function setVersion( packageName?:string, version?:Ext.IVersion ): any; /** [Method] */ export function suspendLayouts(): void; /** [Method] Synchronously loads all classes by the given names and all their direct dependencies optionally executes the given c @@ -25432,7 +25432,7 @@ declare module Ext.slider { /** [Method] private override Creates and returns the data object to be used when rendering the fieldSubTpl */ getSubTplData?(): any; /** [Method] Returns the value that would be included in a standard form submit for this field */ - getSubmitValue?(): any; + getSubmitValue?(): string; /** [Method] Returns the current value of the slider * @param index Number The index of the thumb to return a value for */ @@ -25523,7 +25523,7 @@ declare module Ext.slider { /** [Method] private override Creates and returns the data object to be used when rendering the fieldSubTpl */ getSubTplData?(): any; /** [Method] Returns the value that would be included in a standard form submit for this field */ - getSubmitValue?(): any; + getSubmitValue?(): string; /** [Method] Returns the current value of the slider * @param index Number The index of the thumb to return a value for */ @@ -26130,9 +26130,9 @@ declare module Ext.tab { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Invoked after the Container has laid out and rendered if necessary its child Components * @param layout Ext.layout.container.IContainer */ @@ -26427,7 +26427,10 @@ declare module Ext.tip { cancelShow?( el?:HTMLElement ): void; cancelShow?( el?:Ext.IElement ): void; /** [Method] Hides this tooltip if visible */ - hide?(): void; + hide? (animateTarget?: any, callback?: any, scope?: any): any; + hide? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IComponent, callback?: any, scope?: any): Ext.IComponent; /** [Method] The initComponent template method is an important initialization step for a Component */ initComponent?(): void; /** [Method] Configures a new quick tip instance and assigns it to a target element @@ -26435,7 +26438,9 @@ declare module Ext.tip { */ register?( config?:any ): void; /** [Method] Shows this tooltip at the current event target XY position */ - show?(): void; + show? (animateTarget?: any, callback?: any, scope?: any): any; + show? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + show? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; /** [Method] Removes this quick tip from its element and destroys it * @param el String The element from which the quick tip is to be removed or ID of the element. */ @@ -26459,7 +26464,10 @@ declare module Ext { cancelShow?( el?:HTMLElement ): void; cancelShow?( el?:Ext.IElement ): void; /** [Method] Hides this tooltip if visible */ - hide?(): void; + hide? (animateTarget?: any, callback?: any, scope?: any): any; + hide? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IComponent, callback?: any, scope?: any): Ext.IComponent; /** [Method] The initComponent template method is an important initialization step for a Component */ initComponent?(): void; /** [Method] Configures a new quick tip instance and assigns it to a target element @@ -26467,7 +26475,9 @@ declare module Ext { */ register?( config?:any ): void; /** [Method] Shows this tooltip at the current event target XY position */ - show?(): void; + show? (animateTarget?: any, callback?: any, scope?: any): any; + show? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + show? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; /** [Method] Removes this quick tip from its element and destroys it * @param el String The element from which the quick tip is to be removed or ID of the element. */ @@ -26608,7 +26618,10 @@ declare module Ext.tip { /** [Method] Invoked before the Component is destroyed */ beforeDestroy?(): void; /** [Method] Hides this tooltip if visible */ - hide?(): void; + hide? (animateTarget?: any, callback?: any, scope?: any): any; + hide? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IComponent, callback?: any, scope?: any): Ext.IComponent; /** [Method] The initComponent template method is an important initialization step for a Component */ initComponent?(): void; /** [Method] Allows addition of behavior to the destroy operation */ @@ -26642,7 +26655,9 @@ declare module Ext.tip { setTarget?( t?:HTMLElement ): void; setTarget?( t?:Ext.IElement ): void; /** [Method] Shows this tooltip at the current event target XY position */ - show?(): void; + show? (animateTarget?: any, callback?: any, scope?: any): any; + show? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + show? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; } } declare module Ext { @@ -26674,7 +26689,10 @@ declare module Ext { /** [Method] Invoked before the Component is destroyed */ beforeDestroy?(): void; /** [Method] Hides this tooltip if visible */ - hide?(): void; + hide? (animateTarget?: any, callback?: any, scope?: any): any; + hide? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IComponent, callback?: any, scope?: any): Ext.IComponent; /** [Method] The initComponent template method is an important initialization step for a Component */ initComponent?(): void; /** [Method] Allows addition of behavior to the destroy operation */ @@ -26708,7 +26726,9 @@ declare module Ext { setTarget?( t?:HTMLElement ): void; setTarget?( t?:Ext.IElement ): void; /** [Method] Shows this tooltip at the current event target XY position */ - show?(): void; + show? (animateTarget?: any, callback?: any, scope?: any): any; + show? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + show? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; } } declare module Ext.toolbar { @@ -27359,9 +27379,9 @@ declare module Ext.tree { * @param oldHeight Number The old height, or undefined if this was the initial layout. */ afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; /** [Method] Collapses a record that is loaded in the view diff --git a/extjs/ExtJS.d.ts b/extjs/ExtJS.d.ts index 42b3d3a035..27d53b6896 100644 --- a/extjs/ExtJS.d.ts +++ b/extjs/ExtJS.d.ts @@ -173,9 +173,9 @@ declare module Ext { */ afterComponentLayout?( width?:any, height?:any, oldWidth?:any, oldHeight?:any ): any; afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:undefined ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:undefined, oldHeight?:undefined ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; + afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; /** [Method] Template method called after a Component has been positioned @@ -3996,7 +3996,7 @@ declare module Ext { focus?( selectText?:bool, delay?:bool, callback?:any, scope?:any ): Ext.IComponent; focus?( selectText?:bool, delay?:number, callback?:any, scope?:any ): Ext.IComponent; /** [Method] Implements an upward event bubbling policy */ - getBubbleTarget?(): void; + getBubbleTarget? (): Ext.container.IContainer; /** [Method] Retrieves the top level element representing this component */ getEl?(): Ext.dom.IElement; /** [Method] Retrieves the id of this component */ @@ -18229,7 +18229,7 @@ declare module Ext.form.field { /** [Method] Returns the name attribute of the field */ getName?(): string; /** [Method] Returns the raw value of the field without performing any normalization conversion or validation */ - getRawValue?(): string; + getRawValue?(): any; /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ getSubTplData?(): any; /** [Method] Gets the markup to be inserted into the outer template s bodyEl */ @@ -19611,7 +19611,7 @@ declare module Ext.form.field { /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ getModelData?(): any; /** [Method] Returns the name attribute of the field */ - getName?(): any; + getName?(): string; /** [Method] Returns the parameter s that would be included in a standard form submit for this field */ getSubmitData?(): any; /** [Method] Returns the current data value of the field */ @@ -20480,7 +20480,7 @@ declare module Ext.form.field { /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ getModelData?(): any; /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ - getSubmitValue?(): any; + getSubmitValue?(): string; /** [Method] Method to manage awareness of when components are removed from their respective Container firing a removed event */ onRemoved?(): void; /** [Method] Sets either the checked unchecked status of this Radio or if a string value is passed checks a sibling Radio of th @@ -20504,7 +20504,7 @@ declare module Ext.form { /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ getModelData?(): any; /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ - getSubmitValue?(): any; + getSubmitValue?(): string; /** [Method] Method to manage awareness of when components are removed from their respective Container firing a removed event */ onRemoved?(): void; /** [Method] Sets either the checked unchecked status of this Radio or if a string value is passed checks a sibling Radio of th @@ -25343,8 +25343,8 @@ declare module Ext { * @param version String/Ext.Version The version, for example: '1.2.3alpha', '2.4.0-dev' */ export function setVersion( packageName?:any, version?:any ): any; - export function setVersion( packageName?:string, version?:string ): Ext; - export function setVersion( packageName?:string, version?:Ext.IVersion ): Ext; + export function setVersion( packageName?:string, version?:string ): any; + export function setVersion( packageName?:string, version?:Ext.IVersion ): any; /** [Method] Old alias to Ext Array sum * @param array Array The Array to calculate the sum value of. */ @@ -32643,7 +32643,7 @@ declare module Ext.slider { /** [Method] private override */ getSubTplData?(): any; /** [Method] Returns the value that would be included in a standard form submit for this field */ - getSubmitValue?(): any; + getSubmitValue?(): string; /** [Method] Returns the current value of the slider * @param index Number The index of the thumb to return a value for */ @@ -32731,7 +32731,7 @@ declare module Ext.slider { /** [Method] private override */ getSubTplData?(): any; /** [Method] Returns the value that would be included in a standard form submit for this field */ - getSubmitValue?(): any; + getSubmitValue?(): string; /** [Method] Returns the current value of the slider * @param index Number The index of the thumb to return a value for */ @@ -33971,7 +33971,10 @@ declare module Ext.tip { /** [Property] (HTMLElement) */ triggerElement?: HTMLElement; /** [Method] Hides this tooltip if visible */ - hide?(): void; + hide? (animateTarget?: any, callback?: any, scope?: any): any; + hide? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IComponent, callback?: any, scope?: any): Ext.IComponent; /** [Method] Binds this ToolTip to the specified element * @param t String/HTMLElement/Ext.Element The Element, HtmlElement, or ID of an element to bind to */ @@ -33980,7 +33983,9 @@ declare module Ext.tip { setTarget?( t?:HTMLElement ): void; setTarget?( t?:Ext.IElement ): void; /** [Method] Shows this tooltip at the current event target XY position */ - show?(): void; + show? (animateTarget?: any, callback?: any, scope?: any): any; + show? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + show? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; } } declare module Ext { @@ -34010,7 +34015,10 @@ declare module Ext { /** [Property] (HTMLElement) */ triggerElement?: HTMLElement; /** [Method] Hides this tooltip if visible */ - hide?(): void; + hide? (animateTarget?: any, callback?: any, scope?: any): any; + hide? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; + hide? (animateTarget?: Ext.IComponent, callback?: any, scope?: any): Ext.IComponent; /** [Method] Binds this ToolTip to the specified element * @param t String/HTMLElement/Ext.Element The Element, HtmlElement, or ID of an element to bind to */ @@ -34019,7 +34027,9 @@ declare module Ext { setTarget?( t?:HTMLElement ): void; setTarget?( t?:Ext.IElement ): void; /** [Method] Shows this tooltip at the current event target XY position */ - show?(): void; + show? (animateTarget?: any, callback?: any, scope?: any): any; + show? (animateTarget?: string, callback?: any, scope?: any): Ext.IComponent; + show? (animateTarget?: Ext.IElement, callback?: any, scope?: any): Ext.IComponent; } } declare module Ext.toolbar { From d48c1eadefb040009de9a81b5052bf0807f82da9 Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Fri, 28 Jun 2013 23:30:52 +0100 Subject: [PATCH 015/756] Fix sencha touch definition --- sencha_touch/SenchaTouch.d.ts | 432 ++++++++++++++++++++++------------ 1 file changed, 277 insertions(+), 155 deletions(-) diff --git a/sencha_touch/SenchaTouch.d.ts b/sencha_touch/SenchaTouch.d.ts index 2c2ed1e245..c2d13a06c6 100644 --- a/sencha_touch/SenchaTouch.d.ts +++ b/sencha_touch/SenchaTouch.d.ts @@ -69,7 +69,8 @@ declare module Ext { /** [Method] Returns the value of baseCls */ getBaseCls?(): string; /** [Method] Returns the value of bottom */ - getBottom?(): number; + getBottom? (): any; + getBottom? (): number; /** [Method] Returns the value of defaultType */ getDefaultType?(): string; /** [Method] Returns the value of height */ @@ -2294,7 +2295,7 @@ declare module Ext.carousel { /** [Config Option] (Boolean) */ indicator?: bool; /** [Method] Returns the value of indicator */ - getIndicator?(): any; + getIndicator?(): boolean; /** [Method] Returns the value of innerItemConfig */ getInnerItemConfig?(): any; /** [Method] Returns the value of maxItemIndex */ @@ -3943,7 +3944,7 @@ declare module Ext.chart { */ clear?( category?:string ): void; /** [Method] Not supported */ - getBBox?(): undefined; + getBBox?(): any; /** [Method] * @param category String * @param index Mixed @@ -4331,7 +4332,8 @@ declare module Ext.chart.series { /** [Method] Returns the value of donut */ getDonut?(): number; /** [Method] Returns the value of hidden */ - getHidden?(): any[]; + getHidden? (): boolean; + getHidden? (): any[]; /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object @@ -5253,6 +5255,7 @@ declare module Ext.chart.series { /** [Config Option] (Boolean) */ stacked?: bool; /** [Method] Returns the value of hidden */ + getHidden? (): boolean; getHidden?(): any[]; /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object @@ -7024,7 +7027,7 @@ declare module Ext.data.association { /** [Method] Returns the value of associationKey */ getAssociationKey?(): string; /** [Method] Returns the value of name */ - getName?(): any; + getName?(): string; /** [Method] Returns the value of ownerModel */ getOwnerModel?(): Ext.data.IModel; /** [Method] Returns the value of ownerModel */ @@ -7100,7 +7103,7 @@ declare module Ext.data { /** [Method] Returns the value of associationKey */ getAssociationKey?(): string; /** [Method] Returns the value of name */ - getName?(): any; + getName?(): string; /** [Method] Returns the value of ownerModel */ getOwnerModel?(): Ext.data.IModel; /** [Method] Returns the value of ownerModel */ @@ -8655,7 +8658,7 @@ declare module Ext.data { /** [Method] Marks this Record as dirty */ setDirty?(): void; /** [Method] Updates the collection of Fields that all instances of this Model use */ - setFields?(): any[]; + setFields? (fields?: any[]): void; /** [Method] Sets the value of hasMany * @param hasMany String/Object/String[]/Object[] */ @@ -11310,9 +11313,9 @@ declare module Ext.data.reader { /** [Config Option] (String) */ totalProperty?: string; /** [Method] Returns the value of successProperty */ - getSuccessProperty?(): any; + getSuccessProperty?(): string; /** [Method] Returns the value of totalProperty */ - getTotalProperty?(): any; + getTotalProperty?(): string; /** [Method] Sets the value of successProperty * @param successProperty Object */ @@ -11330,9 +11333,9 @@ declare module Ext.data { /** [Config Option] (String) */ totalProperty?: string; /** [Method] Returns the value of successProperty */ - getSuccessProperty?(): any; + getSuccessProperty?(): string; /** [Method] Returns the value of totalProperty */ - getTotalProperty?(): any; + getTotalProperty?(): string; /** [Method] Sets the value of successProperty * @param successProperty Object */ @@ -14605,6 +14608,7 @@ declare module Ext.dataview.component { /** [Method] Returns the value of record */ getRecord?(): Ext.data.IModel; /** [Method] Returns the value of width */ + getWidth? (): number; getWidth?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -14659,9 +14663,15 @@ declare module Ext.dataview.component { /** [Method] Returns the value of header */ getHeader?(): any; /** [Method] Returns the value of items */ - getItems?(): any; + getItems? (): any[]; /** [Method] Returns the value of tpl */ - getTpl?(): any; + getTpl? (): string; + /** [Method] Returns the value of tpl */ + getTpl? (): string[]; + /** [Method] Returns the value of tpl */ + getTpl? (): Ext.ITemplate[]; + /** [Method] Returns the value of tpl */ + getTpl? (): Ext.IXTemplate[]; /** [Method] Sets the value of baseCls * @param baseCls String */ @@ -15609,7 +15619,7 @@ declare module Ext.dataview { /** [Method] Returns all the items that are docked in the scroller in this list */ getScrollDockedItems?(): any[]; /** [Method] Returns the value of scrollable */ - getScrollable?(): any; + getScrollable?(): boolean; /** [Method] Returns the value of striped */ getStriped?(): bool; /** [Method] Returns the value of ui */ @@ -15767,7 +15777,7 @@ declare module Ext { /** [Method] Returns all the items that are docked in the scroller in this list */ getScrollDockedItems?(): any[]; /** [Method] Returns the value of scrollable */ - getScrollable?(): any; + getScrollable?(): boolean; /** [Method] Returns the value of striped */ getStriped?(): bool; /** [Method] Returns the value of ui */ @@ -15965,7 +15975,7 @@ declare module Ext.dataview { /** [Method] Returns the value of toolbar */ getToolbar?(): any; /** [Method] Returns the value of ui */ - getUi?(): any; + getUi?(): string; /** [Method] Returns the value of updateTitleText */ getUpdateTitleText?(): bool; /** [Method] Returns the value of useSimpleItems */ @@ -16176,7 +16186,7 @@ declare module Ext { /** [Method] Returns the value of toolbar */ getToolbar?(): any; /** [Method] Returns the value of ui */ - getUi?(): any; + getUi?(): string; /** [Method] Returns the value of updateTitleText */ getUpdateTitleText?(): bool; /** [Method] Returns the value of useSimpleItems */ @@ -19574,8 +19584,8 @@ declare module Ext.direct { /** [Method] Removes the provider * @param provider String/Ext.direct.Provider The provider instance or the id of the provider. */ - static removeProvider( provider?:string ): undefined; - static removeProvider( provider?:Ext.direct.IProvider ): undefined; + static removeProvider( provider?:string ): any; + static removeProvider( provider?:Ext.direct.IProvider ): any; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -19853,8 +19863,8 @@ declare module Ext { /** [Method] Removes the provider * @param provider String/Ext.direct.Provider The provider instance or the id of the provider. */ - static removeProvider( provider?:string ): undefined; - static removeProvider( provider?:Ext.direct.IProvider ): undefined; + static removeProvider( provider?:string ): any; + static removeProvider( provider?:Ext.direct.IProvider ): any; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -20211,7 +20221,7 @@ declare module Ext.direct { /** [Method] Returns the value of len */ getLen?(): any; /** [Method] Returns the value of name */ - getName?(): any; + getName?(): string; /** [Method] Returns the value of ordered */ getOrdered?(): bool; /** [Method] Returns the value of params */ @@ -20488,10 +20498,10 @@ declare module Ext.dom { * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. */ - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): undefined; + findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). @@ -20507,12 +20517,25 @@ declare module Ext.dom { * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. */ - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): undefined; - /** [Method] Returns the first Element */ - first?(): Ext.dom.IElement; + findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): any; + /** [Method] Gets the first child skipping text nodes + * @param selector String Find the next sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + first? (selector?: string, returnDom?: bool): Ext.dom.IElement; + /** [Method] Gets the first child skipping text nodes + * @param selector String Find the next sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + first? (selector?: string, returnDom?: bool): HTMLElement; + /** [Method] Gets the first child skipping text nodes + * @param selector String Find the next sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + first? (selector?: string, returnDom?: bool): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. @@ -20682,9 +20705,22 @@ declare module Ext.dom { /** [Method] Returns a flyweight Element of the dom element object at the specified index * @param index Number */ - item?( index?:number ): Ext.dom.IElement; - /** [Method] Returns the last Element */ - last?(): Ext.dom.IElement; + item? (index?: number): Ext.dom.IElement; + /** [Method] Gets the last child skipping text nodes + * @param selector String Find the previous sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + last? (selector?: string, returnDom?: bool): Ext.dom.IElement; + /** [Method] Gets the last child skipping text nodes + * @param selector String Find the previous sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + last? (selector?: string, returnDom?: bool): HTMLElement; + /** [Method] Gets the last child skipping text nodes + * @param selector String Find the previous sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + last? (selector?: string, returnDom?: bool): any; /** [Method] Puts a mask over this element to disable user interaction */ mask?(): void; /** [Method] Gets the next sibling skipping text nodes @@ -20701,7 +20737,7 @@ declare module Ext.dom { * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw dom node instead of an Ext.dom.Element. */ - next?( selector?:string, returnDom?:bool ): undefined; + next?( selector?:string, returnDom?:bool ): any; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. @@ -20716,7 +20752,7 @@ declare module Ext.dom { * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. */ - parent?( selector?:string, returnDom?:bool ): undefined; + parent?( selector?:string, returnDom?:bool ): any; /** [Method] Gets the previous sibling skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element @@ -20731,7 +20767,7 @@ declare module Ext.dom { * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element */ - prev?( selector?:string, returnDom?:bool ): undefined; + prev?( selector?:string, returnDom?:bool ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id @@ -20947,10 +20983,10 @@ declare module Ext.dom { * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). */ - up?( simpleSelector?:string, maxDepth?:number ): undefined; - up?( simpleSelector?:string, maxDepth?:string ): undefined; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): undefined; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): undefined; + up?( simpleSelector?:string, maxDepth?:number ): any; + up?( simpleSelector?:string, maxDepth?:string ): any; + up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; + up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -21081,10 +21117,10 @@ declare module Ext { * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. */ - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): undefined; + findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). @@ -21100,12 +21136,25 @@ declare module Ext { * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. */ - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): undefined; - /** [Method] Returns the first Element */ - first?(): Ext.dom.IElement; + findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): any; + findParentNode? (simpleSelector?: string, maxDepth?: Ext.IElement, returnEl?: bool): any; + /** [Method] Gets the first child skipping text nodes + * @param selector String Find the next sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + first? (selector?: string, returnDom?: bool): Ext.dom.IElement; + /** [Method] Gets the first child skipping text nodes + * @param selector String Find the next sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + first? (selector?: string, returnDom?: bool): HTMLElement; + /** [Method] Gets the first child skipping text nodes + * @param selector String Find the next sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + first? (selector?: string, returnDom?: bool): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. @@ -21275,9 +21324,22 @@ declare module Ext { /** [Method] Returns a flyweight Element of the dom element object at the specified index * @param index Number */ - item?( index?:number ): Ext.dom.IElement; - /** [Method] Returns the last Element */ - last?(): Ext.dom.IElement; + item? (index?: number): Ext.dom.IElement; + /** [Method] Gets the last child skipping text nodes + * @param selector String Find the previous sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + last? (selector?: string, returnDom?: bool): Ext.dom.IElement; + /** [Method] Gets the last child skipping text nodes + * @param selector String Find the previous sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + last? (selector?: string, returnDom?: bool): HTMLElement; + /** [Method] Gets the last child skipping text nodes + * @param selector String Find the previous sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + last? (selector?: string, returnDom?: bool): any; /** [Method] Puts a mask over this element to disable user interaction */ mask?(): void; /** [Method] Gets the next sibling skipping text nodes @@ -21294,7 +21356,7 @@ declare module Ext { * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw dom node instead of an Ext.dom.Element. */ - next?( selector?:string, returnDom?:bool ): undefined; + next?( selector?:string, returnDom?:bool ): any; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. @@ -21309,7 +21371,7 @@ declare module Ext { * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. */ - parent?( selector?:string, returnDom?:bool ): undefined; + parent?( selector?:string, returnDom?:bool ): any; /** [Method] Gets the previous sibling skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element @@ -21324,7 +21386,7 @@ declare module Ext { * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element */ - prev?( selector?:string, returnDom?:bool ): undefined; + prev?( selector?:string, returnDom?:bool ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id @@ -21540,10 +21602,10 @@ declare module Ext { * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). */ - up?( simpleSelector?:string, maxDepth?:number ): undefined; - up?( simpleSelector?:string, maxDepth?:string ): undefined; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): undefined; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): undefined; + up?( simpleSelector?:string, maxDepth?:number ): any; + up?( simpleSelector?:string, maxDepth?:string ): any; + up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; + up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -21674,10 +21736,10 @@ declare module Ext { * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. */ - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): undefined; + findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). @@ -21693,12 +21755,25 @@ declare module Ext { * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. */ - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): undefined; - /** [Method] Returns the first Element */ - first?(): Ext.dom.IElement; + findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): any; + findParentNode? (simpleSelector?: string, maxDepth?: Ext.IElement, returnEl?: bool): any; + /** [Method] Gets the first child skipping text nodes + * @param selector String Find the next sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + first? (selector?: string, returnDom?: bool): Ext.dom.IElement; + /** [Method] Gets the first child skipping text nodes + * @param selector String Find the next sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + first? (selector?: string, returnDom?: bool): HTMLElement; + /** [Method] Gets the first child skipping text nodes + * @param selector String Find the next sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + first? (selector?: string, returnDom?: bool): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. @@ -21868,9 +21943,22 @@ declare module Ext { /** [Method] Returns a flyweight Element of the dom element object at the specified index * @param index Number */ - item?( index?:number ): Ext.dom.IElement; - /** [Method] Returns the last Element */ - last?(): Ext.dom.IElement; + item? (index?: number): Ext.dom.IElement; + /** [Method] Gets the last child skipping text nodes + * @param selector String Find the previous sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + last? (selector?: string, returnDom?: bool): Ext.dom.IElement; + /** [Method] Gets the last child skipping text nodes + * @param selector String Find the previous sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + last? (selector?: string, returnDom?: bool): HTMLElement; + /** [Method] Gets the last child skipping text nodes + * @param selector String Find the previous sibling that matches the passed simple selector. + * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + */ + last? (selector?: string, returnDom?: bool): any; /** [Method] Puts a mask over this element to disable user interaction */ mask?(): void; /** [Method] Gets the next sibling skipping text nodes @@ -21887,7 +21975,7 @@ declare module Ext { * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw dom node instead of an Ext.dom.Element. */ - next?( selector?:string, returnDom?:bool ): undefined; + next?( selector?:string, returnDom?:bool ): any; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. @@ -21902,7 +21990,7 @@ declare module Ext { * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. */ - parent?( selector?:string, returnDom?:bool ): undefined; + parent?( selector?:string, returnDom?:bool ): any; /** [Method] Gets the previous sibling skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element @@ -21917,7 +22005,7 @@ declare module Ext { * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element */ - prev?( selector?:string, returnDom?:bool ): undefined; + prev?( selector?:string, returnDom?:bool ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id @@ -22133,10 +22221,10 @@ declare module Ext { * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). */ - up?( simpleSelector?:string, maxDepth?:number ): undefined; - up?( simpleSelector?:string, maxDepth?:string ): undefined; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): undefined; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): undefined; + up?( simpleSelector?:string, maxDepth?:number ): any; + up?( simpleSelector?:string, maxDepth?:string ): any; + up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; + up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -22289,10 +22377,10 @@ declare module Ext.dom { * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. */ - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): undefined; + findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). @@ -22308,10 +22396,10 @@ declare module Ext.dom { * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. */ - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): undefined; + findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): any; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. @@ -22338,7 +22426,7 @@ declare module Ext.dom { * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. */ - first?( selector?:string, returnDom?:bool ): undefined; + first?( selector?:string, returnDom?:bool ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. @@ -22519,7 +22607,7 @@ declare module Ext.dom { * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. */ - last?( selector?:string, returnDom?:bool ): undefined; + last?( selector?:string, returnDom?:bool ): any; /** [Method] Puts a mask over this element to disable user interaction */ mask?(): void; /** [Method] Alias for addManagedListener @@ -22555,7 +22643,7 @@ declare module Ext.dom { * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw dom node instead of an Ext.dom.Element. */ - next?( selector?:string, returnDom?:bool ): undefined; + next?( selector?:string, returnDom?:bool ): any; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -22596,7 +22684,7 @@ declare module Ext.dom { * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. */ - parent?( selector?:string, returnDom?:bool ): undefined; + parent?( selector?:string, returnDom?:bool ): any; /** [Method] Gets the previous sibling skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element @@ -22611,7 +22699,7 @@ declare module Ext.dom { * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element */ - prev?( selector?:string, returnDom?:bool ): undefined; + prev?( selector?:string, returnDom?:bool ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id @@ -22879,10 +22967,10 @@ declare module Ext.dom { * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). */ - up?( simpleSelector?:string, maxDepth?:number ): undefined; - up?( simpleSelector?:string, maxDepth?:string ): undefined; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): undefined; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): undefined; + up?( simpleSelector?:string, maxDepth?:number ): any; + up?( simpleSelector?:string, maxDepth?:string ): any; + up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; + up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -23085,10 +23173,10 @@ declare module Ext { * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. */ - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): undefined; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): undefined; + findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): any; + findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). @@ -23104,10 +23192,10 @@ declare module Ext { * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. */ - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): undefined; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): undefined; + findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:bool ): any; + findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:bool ): any; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. @@ -23134,7 +23222,7 @@ declare module Ext { * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. */ - first?( selector?:string, returnDom?:bool ): undefined; + first?( selector?:string, returnDom?:bool ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. @@ -23315,7 +23403,7 @@ declare module Ext { * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. */ - last?( selector?:string, returnDom?:bool ): undefined; + last?( selector?:string, returnDom?:bool ): any; /** [Method] Puts a mask over this element to disable user interaction */ mask?(): void; /** [Method] Alias for addManagedListener @@ -23351,7 +23439,7 @@ declare module Ext { * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw dom node instead of an Ext.dom.Element. */ - next?( selector?:string, returnDom?:bool ): undefined; + next?( selector?:string, returnDom?:bool ): any; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -23392,7 +23480,7 @@ declare module Ext { * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. */ - parent?( selector?:string, returnDom?:bool ): undefined; + parent?( selector?:string, returnDom?:bool ): any; /** [Method] Gets the previous sibling skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element @@ -23407,7 +23495,7 @@ declare module Ext { * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element */ - prev?( selector?:string, returnDom?:bool ): undefined; + prev?( selector?:string, returnDom?:bool ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id @@ -23675,10 +23763,10 @@ declare module Ext { * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). */ - up?( simpleSelector?:string, maxDepth?:number ): undefined; - up?( simpleSelector?:string, maxDepth?:string ): undefined; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): undefined; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): undefined; + up?( simpleSelector?:string, maxDepth?:number ): any; + up?( simpleSelector?:string, maxDepth?:string ): any; + up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; + up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -24348,7 +24436,8 @@ declare module Ext.draw { /** [Method] Returns the value of background */ getBackground?(): any; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of fitSurface */ getFitSurface?(): bool; /** [Method] Returns the value of resizeHandler */ @@ -25118,9 +25207,9 @@ declare module Ext.draw { */ rotate?( angle?:any, rcx?:any, rcy?:any, prepend?:any ): any; rotate?( angle?:number, rcx?:number, rcy?:number, prepend?:bool ): Ext.draw.IMatrix; - rotate?( angle?:number, rcx?:undefined, rcy?:number, prepend?:bool ): Ext.draw.IMatrix; - rotate?( angle?:number, rcx?:number, rcy?:undefined, prepend?:bool ): Ext.draw.IMatrix; - rotate?( angle?:number, rcx?:undefined, rcy?:undefined, prepend?:bool ): Ext.draw.IMatrix; + rotate?( angle?:number, rcx?:any, rcy?:number, prepend?:bool ): Ext.draw.IMatrix; + rotate?( angle?:number, rcx?:number, rcy?:any, prepend?:bool ): Ext.draw.IMatrix; + rotate?( angle?:number, rcx?:any, rcy?:any, prepend?:bool ): Ext.draw.IMatrix; /** [Method] Rotate the matrix by the angle of a vector * @param x Number * @param y Number @@ -26094,7 +26183,7 @@ declare module Ext.draw.sprite { /** [Method] Removes the sprite and clears all listeners */ destroy?(): void; /** [Method] Not supported */ - getBBox?(): undefined; + getBBox?(): any; /** [Method] Returns the bounding box for the instance at the given index * @param index Number The index of the instance. * @param isWithoutTransform Boolean 'true' to not apply sprite transforms to the bounding box. @@ -28195,7 +28284,8 @@ declare module Ext.field { /** [Method] Returns the checked value of this field */ getChecked?(): any; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of disabled */ getDisabled?(): bool; /** [Method] Returns the value of focusCls */ @@ -28826,7 +28916,8 @@ declare module Ext.field { /** [Config Option] (Number/Number[]) */ values?: any; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of increment */ getIncrement?(): number; /** [Method] Returns the value of maxValue */ @@ -28836,7 +28927,7 @@ declare module Ext.field { /** [Method] Returns the value of readOnly */ getReadOnly?(): bool; /** [Method] Returns the value of tabIndex */ - getTabIndex?(): any; + getTabIndex?(): number; /** [Method] Returns the value of value */ getValue?(): number; /** [Method] Returns the value of value */ @@ -28902,7 +28993,8 @@ declare module Ext.form { /** [Config Option] (Number/Number[]) */ values?: any; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of increment */ getIncrement?(): number; /** [Method] Returns the value of maxValue */ @@ -28912,7 +29004,7 @@ declare module Ext.form { /** [Method] Returns the value of readOnly */ getReadOnly?(): bool; /** [Method] Returns the value of tabIndex */ - getTabIndex?(): any; + getTabIndex? (): number; /** [Method] Returns the value of value */ getValue?(): number; /** [Method] Returns the value of value */ @@ -28986,7 +29078,8 @@ declare module Ext.field { /** [Method] Returns the value of accelerateOnTapHold */ getAccelerateOnTapHold?(): bool; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of component */ getComponent?(): any; /** [Method] Returns the value of cycle */ @@ -29072,7 +29165,8 @@ declare module Ext.form { /** [Method] Returns the value of accelerateOnTapHold */ getAccelerateOnTapHold?(): bool; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of component */ getComponent?(): any; /** [Method] Returns the value of cycle */ @@ -29166,7 +29260,8 @@ declare module Ext.field { /** [Method] Returns the value of autoCorrect */ getAutoCorrect?(): bool; /** [Method] Returns the value of bubbleEvents */ - getBubbleEvents?(): any[]; + getBubbleEvents? (): string; + getBubbleEvents?(): string[]; /** [Method] Returns the value of clearIcon */ getClearIcon?(): bool; /** [Method] Returns the value of component */ @@ -29266,7 +29361,8 @@ declare module Ext.form { /** [Method] Returns the value of autoCorrect */ getAutoCorrect?(): bool; /** [Method] Returns the value of bubbleEvents */ - getBubbleEvents?(): any[]; + getBubbleEvents? (): string; + getBubbleEvents? (): string[]; /** [Method] Returns the value of clearIcon */ getClearIcon?(): bool; /** [Method] Returns the value of component */ @@ -29422,7 +29518,8 @@ declare module Ext.field { /** [Property] (String) */ toggleOnLabel?: string; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of labelAlign */ getLabelAlign?(): string; /** [Method] Returns the value of maxValueCls */ @@ -29472,7 +29569,8 @@ declare module Ext.form { /** [Property] (String) */ toggleOnLabel?: string; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of labelAlign */ getLabelAlign?(): string; /** [Method] Returns the value of maxValueCls */ @@ -34516,7 +34614,8 @@ declare module Ext.picker { /** [Method] Returns the value of baseCls */ getBaseCls?(): string; /** [Method] Returns the value of bottom */ - getBottom?(): number; + getBottom? (): number; + getBottom? (): string; /** [Method] Returns the value of cancelButton */ getCancelButton?(): string; /** [Method] Returns the value of cancelButton */ @@ -34528,13 +34627,16 @@ declare module Ext.picker { /** [Method] Returns the value of doneButton */ getDoneButton?(): any; /** [Method] Returns the value of height */ - getHeight?(): number; + getHeight? (): number; + getHeight? (): string; /** [Method] Returns the value of layout */ getLayout?(): any; /** [Method] Returns the value of left */ - getLeft?(): number; + getLeft? (): number; + getLeft? (): string; /** [Method] Returns the value of right */ - getRight?(): number; + getRight? (): number; + getRight? (): string; /** [Method] Returns the value of slots */ getSlots?(): any[]; /** [Method] Returns the value of toolbar */ @@ -34655,7 +34757,8 @@ declare module Ext { /** [Method] Returns the value of baseCls */ getBaseCls?(): string; /** [Method] Returns the value of bottom */ - getBottom?(): number; + getBottom? (): number; + getBottom? (): string; /** [Method] Returns the value of cancelButton */ getCancelButton?(): string; /** [Method] Returns the value of cancelButton */ @@ -34667,13 +34770,16 @@ declare module Ext { /** [Method] Returns the value of doneButton */ getDoneButton?(): any; /** [Method] Returns the value of height */ - getHeight?(): number; + getHeight? (): number; + getHeight? (): string; /** [Method] Returns the value of layout */ getLayout?(): any; /** [Method] Returns the value of left */ - getLeft?(): number; + getLeft? (): number; + getLeft? (): string; /** [Method] Returns the value of right */ - getRight?(): number; + getRight? (): number; + getRight? (): string; /** [Method] Returns the value of slots */ getSlots?(): any[]; /** [Method] Returns the value of toolbar */ @@ -34780,9 +34886,13 @@ declare module Ext.picker { /** [Method] Returns the value of align */ getAlign?(): string; /** [Method] Returns the value of displayField */ - getDisplayField?(): string; + getDisplayField? (): string; /** [Method] Returns the value of itemTpl */ - getItemTpl?(): string; + getItemTpl? (): string; + /** [Method] Returns the value of itemTpl */ + getItemTpl? (): string[]; + /** [Method] Returns the value of itemTpl */ + getItemTpl? (): Ext.IXTemplate; /** [Method] Returns the value of name */ getName?(): string; /** [Method] Returns the value of title */ @@ -35040,7 +35150,8 @@ declare module Ext.scroll.indicator { /** [Config Option] (String/String[]) */ cls?: any; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Sets the value of cls * @param cls String */ @@ -35060,7 +35171,8 @@ declare module Ext.scroll.indicator { /** [Config Option] (String/String[]) */ cls?: any; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Sets the value of cls * @param cls String */ @@ -35072,7 +35184,8 @@ declare module Ext.scroll.indicator { /** [Config Option] (String/String[]) */ cls?: any; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Sets the value of cls * @param cls String */ @@ -35377,11 +35490,13 @@ declare module Ext { /** [Method] Returns the value of exit */ getExit?(): string; /** [Method] Returns the value of hideAnimation */ + getHideAnimation? (): string; getHideAnimation?(): any; /** [Method] Returns the value of modal */ getModal?(): bool; /** [Method] Returns the value of showAnimation */ - getShowAnimation?(): any; + getShowAnimation? (): any; + getShowAnimation? (): string; /** [Method] Returns the value of stretchX */ getStretchX?(): bool; /** [Method] Returns the value of stretchY */ @@ -35595,7 +35710,8 @@ declare module Ext { /** [Method] Returns the value of flex */ getFlex?(): number; /** [Method] Returns the value of width */ - getWidth?(): number; + getWidth? (): number; + getWidth? (): string; /** [Method] Sets the value of flex * @param flex Number */ @@ -35762,7 +35878,8 @@ declare module Ext.tab { */ doTabChange?( tabBar?:any, newTab?:any ): bool; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of layout */ getLayout?(): any; /** [Method] Returns the value of tabBar */ @@ -35820,7 +35937,8 @@ declare module Ext { */ doTabChange?( tabBar?:any, newTab?:any ): bool; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of layout */ getLayout?(): any; /** [Method] Returns the value of tabBar */ @@ -36161,13 +36279,15 @@ declare module Ext { /** [Method] Returns the value of baseCls */ getBaseCls?(): string; /** [Method] Returns the value of cls */ - getCls?(): string; + getCls? (): string; + getCls? (): string[]; /** [Method] Returns the value of defaultType */ getDefaultType?(): string; /** [Method] Returns the value of items */ getItems?(): any; /** [Method] Returns the value of minHeight */ - getMinHeight?(): string; + getMinHeight? (): string; + getMinHeight? (): number; /** [Method] Returns the value of title */ getTitle?(): string; /** [Method] Returns the value of ui */ @@ -36231,7 +36351,8 @@ declare module Ext { /** [Method] Returns the value of layout */ getLayout?(): any; /** [Method] Returns the value of minHeight */ - getMinHeight?(): string; + getMinHeight? (): string; + getMinHeight? (): number; /** [Method] Returns an Ext Title component */ getTitle?(): Ext.ITitle; /** [Method] Returns the value of ui */ @@ -38821,8 +38942,8 @@ declare module Ext { * @param version String/Ext.Version The version, for example: '1.2.3alpha', '2.4.0-dev'. */ setVersion?( packageName?:any, version?:any ): any; - setVersion?( packageName?:string, version?:string ): Ext; - setVersion?( packageName?:string, version?:Ext.IVersion ): Ext; + setVersion?( packageName?:string, version?:string ): any; + setVersion?( packageName?:string, version?:Ext.IVersion ): any; /** [Method] Returns this format major minor patch build release */ toArray?(): number[]; /** [Method] @@ -38853,7 +38974,8 @@ declare module Ext { /** [Method] Returns the value of url */ getUrl?(): string; /** [Method] Returns the value of url */ - getUrl?(): any[]; + getUrl? (): any[]; + getCls? (): string[]; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; /** [Method] Sets the value of cls From 7aafcfcb0e2f0b53532bccf7a6a60a2ab4be7f15 Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Sat, 29 Jun 2013 00:07:38 +0100 Subject: [PATCH 016/756] Update test runner so it doesnt test the test runner files Alos remove the case sensitivity when detecting test files --- _infrastructure/tests/runner.js | 4 ++-- _infrastructure/tests/runner.ts | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/_infrastructure/tests/runner.js b/_infrastructure/tests/runner.js index d0a23087a7..3b896c84f6 100644 --- a/_infrastructure/tests/runner.js +++ b/_infrastructure/tests/runner.js @@ -800,7 +800,7 @@ var DefinitelyTyped; SyntaxCheking.prototype.run = function (it, file, len, maxLen, callback) { var _this = this; - if (!endsWith(file, '-tests.ts')) { + if (!endsWith(file.toUpperCase(), '-TESTS.TS') && file.indexOf('../_infrastructure') < 0) { new Test(file).run(function (o) { var failed = false; @@ -915,7 +915,7 @@ var DefinitelyTyped; TestEval.prototype.run = function (it, file, len, maxLen, callback) { var _this = this; - if (endsWith(file, '-tests.ts')) { + if (endsWith(file.toUpperCase(), '-TESTS.TS')) { new Test(file).run(function (o) { var failed = false; diff --git a/_infrastructure/tests/runner.ts b/_infrastructure/tests/runner.ts index 8d0eeae142..d6e58ff3bc 100644 --- a/_infrastructure/tests/runner.ts +++ b/_infrastructure/tests/runner.ts @@ -291,8 +291,8 @@ module DefinitelyTyped { } } - private run(it, file, len, maxLen, callback: Function) { - if (!endsWith(file, '-tests.ts')) { + private run(it, file, len, maxLen, callback: Function) { + if (!endsWith(file.toUpperCase(), '-TESTS.TS') && file.indexOf('../_infrastructure') < 0) { new Test(file).run((o) => { var failed = false; @@ -408,7 +408,7 @@ module DefinitelyTyped { } private run(it, file, len, maxLen, callback: Function) { - if (endsWith(file, '-tests.ts')) { + if (endsWith(file.toUpperCase(), '-TESTS.TS')) { new Test(file).run((o) => { var failed = false; From 6cd22fa521fd7499f75913740730689db28831bd Mon Sep 17 00:00:00 2001 From: jbaldwin Date: Fri, 28 Jun 2013 19:44:12 -0600 Subject: [PATCH 017/756] Upgrade underscore-typed.t.ts to v0.9 Added generics Removed old typed versions [1.4.2, 1.4.3] (not necessary/old) --- underscore/underscore-typed-1.4.2.d.ts | 2008 ----------------------- underscore/underscore-typed-1.4.3.d.ts | 2031 ------------------------ underscore/underscore-typed-tests.ts | 26 +- underscore/underscore-typed.d.ts | 1317 ++++++++------- 4 files changed, 646 insertions(+), 4736 deletions(-) delete mode 100644 underscore/underscore-typed-1.4.2.d.ts delete mode 100644 underscore/underscore-typed-1.4.3.d.ts diff --git a/underscore/underscore-typed-1.4.2.d.ts b/underscore/underscore-typed-1.4.2.d.ts deleted file mode 100644 index 510176117e..0000000000 --- a/underscore/underscore-typed-1.4.2.d.ts +++ /dev/null @@ -1,2008 +0,0 @@ -/* -underscore-1.4.2.d.ts may be freely distributed under the MIT license. - -Copyright (c) 2012 Josh Baldwin https://github.com/jbaldwin/underscore.d.ts - -Permission is hereby granted, free of charge, to any person -obtaining a copy of this software and associated documentation -files (the "Software"), to deal in the Software without -restriction, including without limitation the rights to use, -copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the -Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES -OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT -HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, -WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -OTHER DEALINGS IN THE SOFTWARE. -*/ - -interface Underscore { - - /************** - * Collections * - **************/ - - /** - * Iterates over a list of elements, yielding each in turn to an iterator function. The iterator is - * bound to the context object, if one is passed. Each invocation of iterator is called with three - * arguments: (element, index, list). If list is a JavaScript object, iterator's arguments will be - * (value, key, object). Delegates to the native forEach function if it exists. - * @param list Iterates over this list of elements. - * @param iterator Iterator function for each element `list`. - * @param context 'this' object in `iterator`, optional. - **/ - each( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): void; - /** - * Iterates over a list of elements, yielding each in turn to an iterator function. The iterator is - * bound to the context object, if one is passed. Each invocation of iterator is called with three - * arguments: (element, index, list). If list is a JavaScript object, iterator's arguments will be - * (value, key, object). Delegates to the native forEach function if it exists. - * @param obj Iterators over this object's properties. - * @param iterator Iterator function for each property on `obj`. - * @param context `this` object in the `iterator`, optional. - **/ - each( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): void; - - /** - * Alias for 'each'. - * @see each - **/ - forEach( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): void; - /** - * Alias for 'each'. - * @see each - **/ - forEach( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): void; - - /** - * Produces a new array of values by mapping each value in list through a transformation function - * (iterator). If the native map method exists, it will be used instead. If list is a JavaScript - * object, iterator's arguments will be (value, key, object). - * @param list Maps the elements of this array. - * @param iterator Map iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return The mapped array result. - **/ - map( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - /** - * Produces a new array of values by mapping each value in list through a transformation function - * (iterator). If the native map method exists, it will be used instead. If list is a JavaScript - * object, iterator's arguments will be (value, key, object). - * @param list Maps the properties of this object. - * @param iterator Map iterator function for each property on `obj`. - * @param context `this` object in `iterator`, optional. - * @return The mapped object result. - **/ - map( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; - - /** - * Alias for 'map'. - * @see map - **/ - collect( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - /** - * Alias for 'map'. - * @see map - **/ - collect( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; - - /** - * Also known as inject and foldl, reduce boils down a list of values into a single value. - * Memo is the initial state of the reduction, and each successive step of it should be - * returned by iterator. The iterator is passed four arguments: the memo, then the value - * and index (or key) of the iteration, and finally a reference to the entire list. - * @param list Reduces the elements of this array. - * @param iterator Reduce iterator function for each element in `list`. - * @param memo Initial reduce state. - * @param context `this` object in `iterator`, optional. - * @return Reduced object result. - **/ - reduce( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduce'. - * @see reduce - **/ - inject( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduce'. - * @see reduce - **/ - foldl( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * The right-associative version of reduce. Delegates to the JavaScript 1.8 version of - * reduceRight, if it exists. Foldr is not as useful in JavaScript as it would be in a - * language with lazy evaluation. - * @param list Reduces the elements of this array. - * @param iterator Reduce iterator function for each element in `list`. - * @param memo Initial reduce state. - * @param context `this` object in `iterator`, optional. - * @return Reduced object result. - **/ - reduceRight( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduceRight'. - * @see reduceRight - **/ - foldr( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Looks through each value in the list, returning the first one that passes a truth - * test (iterator). The function returns as soon as it finds an acceptable element, - * and doesn't traverse the entire list. - * @param list Searches for a value in this list. - * @param iterator Search iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return The first acceptable found element in `list`, if nothing is found undefined/null is returned. - **/ - find( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; - - /** - * Alias for 'find'. - * @see find - **/ - detect( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; - - - /** - * Looks through each value in the list, returning an array of all the values that pass a truth - * test (iterator). Delegates to the native filter method, if it exists. - * @param list Filter elements out of this list. - * @param iterator Filter iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return The filtered list of elements. - **/ - filter( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Alias for 'filter'. - * @see filter - **/ - select( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Looks through each value in the list, returning an array of all the values that contain all - * of the key-value pairs listed in properties. - * @param list List to match elements again `properties`. - * @param properties The properties to check for on each element within `list`. - * @return The elements within `list` that contain the required `properties`. - **/ - where(list: any[], properties: any): any[]; - - /** - * Returns the values in list without the elements that the truth test (iterator) passes. - * The opposite of filter. - * Return all the elements for which a truth test fails. - * @param list Reject elements within this list. - * @param iterator Reject iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return The rejected list of elements. - **/ - reject( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Returns true if all of the values in the list pass the iterator truth test. Delegates to the - * native method every, if present. - * @param list Truth test against all elements within this list. - * @param iterator Trust test iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return True if all elements passed the truth test, otherwise false. - **/ - all( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Alias for 'all'. - * @see all - **/ - every( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Returns true if any of the values in the list pass the iterator truth test. Short-circuits and - * stops traversing the list if a true element is found. Delegates to the native method some, if present. - * @param list Truth test against all elements within this list. - * @param iterator Trust test iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return True if any elements passed the truth test, otherwise false. - **/ - any( - list: any[], - iterator?: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Alias for 'any'. - * @see any - **/ - some( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Returns true if the value is present in the list. Uses indexOf internally, - * if list is an Array. - * @param list Checks each element to see if `value` is present. - * @param value The value to check for within `list`. - * @return True if `value` is present in `list`, otherwise false. - **/ - contains(list: any[], value: any): bool; - - /** - * Alias for 'contains'. - * @see contains - **/ - include(list: any[], value: any): bool; - - /** - * Calls the method named by methodName on each value in the list. Any extra arguments passed to - * invoke will be forwarded on to the method invocation. - * @param list The element's in this list will each have the method `methodName` invoked. - * @param methodName The method's name to call on each element within `list`. - * @param arguments Additional arguments to pass to the method `methodName`. - **/ - invoke(list: any[], methodName: string, ...arguments: any[]): void; - - /** - * A convenient version of what is perhaps the most common use-case for map: extracting a list of - * property values. - * @param list The list to pluck elements out of that have the property `propertyName`. - * @param propertyName The property to look for on each element within `list`. - * @return The list of elements within `list` that have the property `propertyName`. - **/ - pluck(list: any[], propertyName: string): any[]; - - /** - * Returns the maximum value in list. - * @param list Finds the maximum value in this list. - * @return Maximum value in `list`. - **/ - max(list: number[]): number; - /** - * Returns the maximum value in list. If iterator is passed, it will be used on each value to generate - * the criterion by which the value is ranked. - * @param list Finds the maximum value in this list. - * @param iterator Compares each element in `list` to find the maximum value. - * @param context `this` object in `iterator`, optional. - * @return The maximum element within `list`. - **/ - max( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): any; - - /** - * Returns the minimum value in list. - * @param list Finds the minimum value in this list. - * @return Minimum value in `list`. - **/ - min(list: number[]): number; - /** - * Returns the minimum value in list. If iterator is passed, it will be used on each value to generate - * the criterion by which the value is ranked. - * @param list Finds the minimum value in this list. - * @param iterator Compares each element in `list` to find the minimum value. - * @param context `this` object in `iterator`, optional. - * @return The minimum element within `list`. - **/ - min( - list: any[], - iterator: (obj: any, index?: number, list?: any[]) => number, - context?: any): any; - - /** - * Returns a sorted copy of list, ranked in ascending order by the results of running each value - * through iterator. Iterator may also be the string name of the property to sort by (eg. length). - * @param list Sorts this list. - * @param iterator Sort iterator for each element within `list`. - * @param context `this` object in `iterator`, optional. - * @return A sorted copy of `list`. - **/ - sortBy( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): any[]; - /** - * Returns a sorted copy of list, ranked in ascending order by the results of running each value - * through iterator. Iterator may also be the string name of the property to sort by (eg. length). - * @param list Sorts this list. - * @param iterator Sort iterator for each element within `list`. - * @param context `this` object in `iterator`, optional. - * @return A sorted copy of `list`. - **/ - sortBy( - list: any[], - iterator: string, - context?: any): any[]; - - /** - * Splits a collection into sets, grouped by the result of running each value through iterator. - * If iterator is a string instead of a function, groups by the property named by iterator on - * each of the values. - * @param list Groups this list. - * @param iterator Group iterator for each element within `list`, return the key to group the element by. - * @param context `this` object in `iterator`, optional. - * @return An object with the group names as properties where each property contains the grouped elements from `list`. - **/ - groupBy( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): { [key: string]: any[]; }; - /** - * Splits a collection into sets, grouped by the result of running each value through iterator. - * If iterator is a string instead of a function, groups by the property named by iterator on - * each of the values. - * @param list Groups this list. - * @param iterator Group iterator for each element within `list`, return the key to group the element by. - * @param context `this` object in `iterator`, optional. - * @return An object with the group names as properties where each property contains the grouped elements from `list`. - **/ - groupBy( - list: any[], - iterator: string, - context?: any): { [key: string]: any[]; }; - - /** - * Sorts a list into groups and returns a count for the number of objects in each group. Similar - * to groupBy, but instead of returning a list of values, returns a count for the number of values - * in that group. - * @param list Group elements in this list and then count the number of elements in each group. - * @param iterator Group iterator for each element within `list`, return the key to group the element by. - * @param context `this` object in `iterator`, optional. - * @return An object with the group names as properties where each property contains the number of elements in that group. - **/ - countBy( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): { [key: string]: number; }; - /** - * Sorts a list into groups and returns a count for the number of objects in each group. Similar - * to groupBy, but instead of returning a list of values, returns a count for the number of values - * in that group. - * @param list Group elements in this list and then count the number of elements in each group. - * @param iterator Group iterator for each element within `list`, return the key to group the element by. - * @param context `this` object in `iterator`, optional. - * @return An object with the group names as properties where each property contains the number of elements in that group. - **/ - countBy( - list: any[], - iterator: string, - context?: any): { [key: string]: number; }; - - /** - * Returns a shuffled copy of the list, using a version of the Fisher-Yates shuffle. - * @param list List to shuffle. - * @return Shuffled copy of `list`. - **/ - shuffle(list: any[]): any[]; - - /** - * Converts the list (anything that can be iterated over), into a real Array. Useful for transmuting - * the arguments object. - * @param list object to transform into an array. - * @return `list` as an array. - **/ - toArray(list: any): any[]; - - /** - * Return the number of values in the list. - * @param list Count the number of values/elements in this list. - * @return Number of values in `list`. - **/ - size(list: any): number; - - /********* - * Arrays * - **********/ - - /** - * Returns the first element of an array. Passing n will return the first n elements of the array. - * @param array Retrieves the first element of this array. - * @return Returns the first element of `array`. - **/ - first(array: any[]): any; - /** - * Returns the first element of an array. Passing n will return the first n elements of the array. - * @param array Retreives the first `n` elements of this array. - * @param n Return more than one element from `array`. - * @return Returns the first `n` elements from `array. - **/ - first(array: any[], n: number): any[]; - - /** - * Alias for 'first'. - * @see first - **/ - head(array: any[]): any; - /** - * Alias for 'first'. - * @see first - **/ - head(array: any[], n: number): any[]; - - /** - * Alias for 'first'. - * @see first - **/ - take(array: any[]): any; - /** - * Alias for 'first'. - * @see first - **/ - take(array: any[], n: number): any[]; - - /** - * Returns everything but the last entry of the array. Especially useful on the arguments object. - * Pass n to exclude the last n elements from the result. - * @param array Retreive all elements except the last `n`. - * @param n Leaves this many elements behind, optional. - * @return Returns everything but the last `n` elements of `array`. - **/ - initial(array: any[], n?: number): any[]; - - /** - * Returns the last element of an array. Passing n will return the last n elements of the array. - * @param array Retrieves the last element of this array. - * @return Returns the last element of `array`. - **/ - last(array: any[]): any; - /** - * Returns the last element of an array. Passing n will return the last n elements of the array. - * @param array Retreives the last `n` elements of this array. - * @param n Return more than one element from `array`. - * @return Returns the last `n` elements from `array. - **/ - last(array: any[], n: number): any[]; - - /** - * Returns the rest of the elements in an array. Pass an index to return the values of the array - * from that index onward. - * @param array The array to retrieve all but the first `index` elements. - * @param index The index to start retrieving elements forward from, optional, default = 1. - * @return Returns the elements of `array` from `index` to the end of `array`. - **/ - rest(array: any[], index?: number): any[]; - - /** - * Alias for 'rest'. - * @see rest - **/ - tail(array: any[], index?: number): any[]; - - /** - * Alias for 'rest'. - * @see rest - **/ - drop(array: any[], index?: number): any[]; - - /** - * Returns a copy of the array with all falsy values removed. In JavaScript, false, null, 0, "", - * undefined and NaN are all falsy. - * @param array Array to compact. - * @return Copy of `array` without false values. - **/ - compact(array: any[]): any[]; - - /** - * Flattens a nested array (the nesting can be to any depth). If you pass shallow, the array will - * only be flattened a single level. - * @param array The array to flatten. - * @param shallow If true then only flatten one level, optional, default = false. - * @return `array` flattened. - **/ - flatten(array: any, shallow?: bool): any; - - /** - * Returns a copy of the array with all instances of the values removed. - * @param array The array to remove `values` from. - * @param values The values to remove from `array`. - * @return Copy of `array` without `values`. - **/ - without(array: any[], ...values: any[]): any[]; - - /** - * Computes the union of the passed-in arrays: the list of unique items, in order, that are - * present in one or more of the arrays. - * @param arrays Array of arrays to compute the union of. - * @return The union of elements within `arrays`. - **/ - union(...arrays: any[][]): any[]; - - /** - * Computes the list of values that are the intersection of all the arrays. Each value in the result - * is present in each of the arrays. - * @param arrays Array of arrays to compute the intersection of. - * @return The intersection of elements within `arrays`. - **/ - intersection(...arrays: any[][]): any[]; - - /** - * Similar to without, but returns the values from array that are not present in the other arrays. - * @param array Keeps values that are within `others`. - * @param others The values to keep within `array`. - * @return Copy of `array` with only `others` values. - **/ - difference(array: any[], ...others: any[]): any[]; - - /** - * Produces a duplicate-free version of the array, using === to test object equality. If you know in - * advance that the array is sorted, passing true for isSorted will run a much faster algorithm. If - * you want to compute unique items based on a transformation, pass an iterator function. - * @param array Array to remove duplicates from. - * @param isSorted True if `array` is already sorted, optiona, default = false. - * @param iterator Transform the elements of `array` before comparisons for uniqueness. - * @return Copy of `array` where all elements are unique. - **/ - uniq( - array: any[], - isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any): any[]; - - /** - * Alias for 'uniq'. - * @see uniq - **/ - unique(array: any[], - isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any): any[]; - - /** - * Merges together the values of each of the arrays with the values at the corresponding position. - * Useful when you have separate data sources that are coordinated through matching array indexes. - * If you're working with a matrix of nested arrays, zip.apply can transpose the matrix in a similar fashion. - * @param arrays The arrays to merge/zip. - * @return Zipped version of `arrays`. - **/ - zip(...arrays: any[][]): any[][]; - - /** - * Converts arrays into objects. Pass either a single list of [key, value] pairs, or a - * list of keys, and a list of values. - * @param keys Key array. - * @param values Value array. - * @return An object containing the `keys` as properties and `values` as the property values. - **/ - object(keys: string[], values: any[]): any; - /** - * Converts arrays into objects. Pass either a single list of [key, value] pairs, or a - * list of keys, and a list of values. - * @param keyValuePairs Array of [key, value] pairs. - * @return An object containing the `keys` as properties and `values` as the property values. - **/ - object(...keyValuePairs: any[][]): any; - - /** - * Returns the index at which value can be found in the array, or -1 if value is not present in the array. - * Uses the native indexOf function unless it's missing. If you're working with a large array, and you know - * that the array is already sorted, pass true for isSorted to use a faster binary search ... or, pass a number - * as the third argument in order to look for the first matching value in the array after the given index. - * @param array The array to search for the index of `value`. - * @param value The value to search for within `array`. - * @param isSorted True if the array is already sorted, optional, default = false. - * @return The index of `value` within `array`. - **/ - indexOf(array: any[], value: any, isSorted?: bool): number; - - /** - * Returns the index of the last occurrence of value in the array, or -1 if value is not present. Uses the - * native lastIndexOf function if possible. Pass fromIndex to start your search at a given index. - * @param array The array to search for the last index of `value`. - * @param value The value to search for within `array`. - * @param from The starting index for the search, optional. - * @return The index of the last occurance of `value` within `array`. - **/ - lastIndexOf(array: any[], value: any, from?: number): number; - - /** - * Uses a binary search to determine the index at which the value should be inserted into the list in order - * to maintain the list's sorted order. If an iterator is passed, it will be used to compute the sort ranking - * of each value, including the value you pass. - * @param list The sorted list. - * @param value The value to determine its index within `list`. - * @param iterator Iterator to compute the sort ranking of each value, optional. - * @return The index where `value` should be inserted into `list`. - **/ - sortedIndex(list: any[], value: any, iterator?: (element: any) => number): number; - - /** - * A function to create flexibly-numbered lists of integers, handy for each and map loops. start, if omitted, - * defaults to 0; step defaults to 1. Returns a list of integers from start to stop, incremented (or decremented) - * by step, exclusive. - * @param start Start here. - * @param stop Stop here. - * @param step The number to count up by each iteration, optional, default = 1. - * @return Array of numbers from `start` to `stop` with increments of `step`. - **/ - range(start: number, stop: number, step?: number): number[]; - /** - * A function to create flexibly-numbered lists of integers, handy for each and map loops. start, if omitted, - * defaults to 0; step defaults to 1. Returns a list of integers from start to stop, incremented (or decremented) - * by step, exclusive. - * @param stop Stop here. - * @return Array of numbers from 0 to `stop` with increments of 1. - * @note If start is not specified the implementation will never pull the step (step = arguments[2] || 0) - **/ - range(stop: number): number[]; - - /************ - * Functions * - *************/ - - /** - * Bind a function to an object, meaning that whenever the function is called, the value of this will - * be the object. Optionally, bind arguments to the function to pre-fill them, also known as partial application. - * @param fn The function to bind `this` to `object`. - * @param object The `this` pointer whenever `fn` is called. - * @param arguments Additional arguments to pass to `fn` when called. - * @return `fn` with `this` bound to `object`. - **/ - bind(fn: Function, object: any, ...arguments: any[]): Function; - - - /** - * Binds a number of methods on the object, specified by methodNames, to be run in the context of that object - * whenever they are invoked. Very handy for binding functions that are going to be used as event handlers, - * which would otherwise be invoked with a fairly useless this. If no methodNames are provided, all of the - * object's function properties will be bound to it. - * @param object The object to bind the methods `methodName` to. - * @param methodNames The methods to bind to `object`, optional and if not provided all of `object`'s - * methods are bound. - **/ - bindAll(object: any, ...methodNames: string[]): void; - - /** - * Memoizes a given function by caching the computed result. Useful for speeding up slow-running computations. - * If passed an optional hashFunction, it will be used to compute the hash key for storing the result, based - * on the arguments to the original function. The default hashFunction just uses the first argument to the - * memoized function as the key. - * @param fn Computationally expensive function that will now memoized results. - * @param hashFn Hash function for storing the result of `fn`. - * @return Memoized version of `fn`. - **/ - memoize(fn: Function, hashFn?: (n: any) => string): Function; - - /** - * Much like setTimeout, invokes function after wait milliseconds. If you pass the optional arguments, - * they will be forwarded on to the function when it is invoked. - * @param fn Function to delay `waitMS` amount of ms. - * @param waitMS The amount of milliseconds to delay `fn`. - * @arguments Additional arguments to pass to `fn`. - **/ - delay(fn: Function, waitMS: number, ...arguments: any[]): void; - - /** - * Defers invoking the function until the current call stack has cleared, similar to using setTimeout - * with a delay of 0. Useful for performing expensive computations or HTML rendering in chunks without - * blocking the UI thread from updating. If you pass the optional arguments, they will be forwarded on - * to the function when it is invoked. - * @param fn The function to defer. - * @param arguments Additional arguments to pass to `fn`. - **/ - defer(fn: Function, ...arguments: any[]): void; - - /** - * Creates and returns a new, throttled version of the passed function, that, when invoked repeatedly, - * will only actually call the original function at most once per every wait milliseconds. Useful for - * rate-limiting events that occur faster than you can keep up with. - * @param fn Function to throttle `waitMS` ms. - * @param waitMS The number of milliseconds to wait before `fn` can be invoked again. - * @return `fn` with a throttle of `waitMS`. - **/ - throttle(fn: Function, waitMS: number): Function; - - /** - * Creates and returns a new debounced version of the passed function that will postpone its execution - * until after wait milliseconds have elapsed since the last time it was invoked. Useful for implementing - * behavior that should only happen after the input has stopped arriving. For example: rendering a preview - * of a Markdown comment, recalculating a layout after the window has stopped being resized, and so on. - * - * Pass true for the immediate parameter to cause debounce to trigger the function on the leading instead - * of the trailing edge of the wait interval. Useful in circumstances like preventing accidental double - *-clicks on a "submit" button from firing a second time. - * @param fn Function to debounce `waitMS` ms. - * @param waitMS The number of milliseconds to wait before `fn` can be invoked again. - * @param immediate True if `fn` should be invoked on the leading edge of `waitMS` instead of the trailing edge. - * @return Debounced version of `fn` that waits `waitMS` ms when invoked. - **/ - debounce(fn: Function, waitMS: number, immediate?: bool): Function; - - /** - * Creates a version of the function that can only be called one time. Repeated calls to the modified - * function will have no effect, returning the value from the original call. Useful for initialization - * functions, instead of having to set a boolean flag and then check it later. - * @param fn Function to only execute once. - * @return Copy of `fn` that can only be invoked once. - **/ - once(fn: Function): Function; - - /** - * Creates a version of the function that will only be run after first being called count times. Useful - * for grouping asynchronous responses, where you want to be sure that all the async calls have finished, - * before proceeding. - * @param count Number of times to be called before actually executing. - * @fn The function to defer execution `count` times. - * @return Copy of `fn` that will not execute until it is invoked `count` times. - **/ - after(count: number, fn: Function): Function; - - /** - * Wraps the first function inside of the wrapper function, passing it as the first argument. This allows - * the wrapper to execute code before and after the function runs, adjust the arguments, and execute it - * conditionally. - * @param fn Function to wrap. - * @param wrapper The function that will wrap `fn`. - * @return Wrapped version of `fn. - **/ - wrap(fn: Function, wrapper: (fn: Function, ...args: any[]) => any): Function; - - /** - * Returns the composition of a list of functions, where each function consumes the return value of the - * function that follows. In math terms, composing the functions f(), g(), and h() produces f(g(h())). - * @param functions List of functions to compose. - * @return Composition of `functions`. - **/ - compose(...functions: Function[]): Function; - - /********** - * Objects * - ***********/ - - /** - * Retrieve all the names of the object's properties. - * @param object Retreive the key or property names from this object. - * @return List of all the property names on `object`. - **/ - keys(object: any): string[]; - - /** - * Return all of the values of the object's properties. - * @param object Retreive the values of all the properties on this object. - * @return List of all the values on `object`. - **/ - values(object: any): any[]; - - /** - * Convert an object into a list of [key, value] pairs. - * @param object Convert this object to a list of [key, value] pairs. - * @return List of [key, value] pairs on `object`. - **/ - pairs(object: any): any[][]; - - /** - * Returns a copy of the object where the keys have become the values and the values the keys. - * For this to work, all of your object's values should be unique and string serializable. - * @param object Object to invert key/value pairs. - * @return An inverted key/value paired version of `object`. - **/ - invert(object: any): any; - - /** - * Returns a sorted list of the names of every method in an object that is to say, - * the name of every function property of the object. - * @param object Object to pluck all function property names from. - * @return List of all the function names on `object`. - **/ - functions(object: any): string[]; - - /** - * Copy all of the properties in the source objects over to the destination object, and return - * the destination object. It's in-order, so the last source will override properties of the - * same name in previous arguments. - * @param destination Object to extend all the properties from `sources`. - * @param sources Extends `destination` with all properties from these source objects. - * @return `destination` extended with all the properties from the `sources` objects. - **/ - extend(destination: any, ...sources: any[]): any; - - /** - * Return a copy of the object, filtered to only have values for the whitelisted keys - * (or array of valid keys). - * @param object Object to strip unwanted key/value pairs. - * @keys The key/value pairs to keep on `object`. - * @return Copy of `object` with only the `keys` properties. - **/ - pick(object: any, ...keys: string[]): any; - - /** - * Return a copy of the object, filtered to omit the blacklisted keys (or array of keys). - * @param object Object to strip unwanted key/value pairs. - * @param keys The key/value pairs to remove on `object`. - * @return Copy of `object` without the `keys` properties. - **/ - omit(object: any, ...keys: string[]): any; - - /** - * Fill in null and undefined properties in object with values from the defaults objects, - * and return the object. As soon as the property is filled, further defaults will have no effect. - * @param object Fill this object with default values. - * @param defaults The default values to add to `object`. - * @return `object` with added `defaults` values. - **/ - defaults(object: any, ...defaults: any[]): any; - - /** - * Create a shallow-copied clone of the object. - * Any nested objects or arrays will be copied by reference, not duplicated. - * @param object Object to clone. - * @return Copy of `object`. - **/ - clone(object: any): any; - /** - * Create a shallow-copied clone of the object. - * Any nested objects or arrays will be copied by reference, not duplicated. - * @param list List to clone. - * @return Copy of `list`. - **/ - clone(list: any[]): any[]; - - /** - * Invokes interceptor with the object, and then returns object. The primary purpose of this method - * is to "tap into" a method chain, in order to perform operations on intermediate results within the chain. - * @param object Argument to `interceptor`. - * @param intercepter The function to modify `object` before continuing the method chain. - * @return Modified `object`. - **/ - tap(object: any, intercepter: Function): any; - - /** - * Does the object contain the given key? Identical to object.hasOwnProperty(key), but uses a safe - * reference to the hasOwnProperty function, in case it's been overridden accidentally. - * @param object Object to check for `key`. - * @param key The key to check for on `object`. - * @return True if `key` is a property on `object`, otherwise false. - **/ - has(object: any, key: string): bool; - - /** - * Performs an optimized deep comparison between the two objects, - * to determine if they should be considered equal. - * @param object Compare to `other`. - * @param other Compare to `object`. - * @return True if `object` is equal to `other`. - **/ - isEqual(object: any, other: any): bool; - - /** - * Returns true if object contains no values. - * @param object Check if this object has no properties or values. - * @return True if `object` is empty. - **/ - isEmpty(object: any): bool; - /** - * Returns true if the list contains no values. - * @param object Check if this list has no elements. - * @return True if `list` is empty. - **/ - isEmpty(list: any[]): bool; - - /** - * Returns true if object is a DOM element. - * @param object Check if this object is a DOM element. - * @return True if `object` is a DOM element, otherwise false. - **/ - isElement(object: any): bool; - - /** - * Returns true if object is an Array. - * @param object Check if this object is an Array. - * @return True if `object` is an Array, otherwise false. - **/ - isArray(object: any): bool; - - /** - * Returns true if value is an Object. Note that JavaScript arrays and functions are objects, - * while (normal) strings and numbers are not. - * @param object Check if this object is an Object. - * @return True of `object` is an Object, otherwise false. - **/ - isObject(object: any): bool; - - /** - * Returns true if object is an Arguments object. - * @param object Check if this object is an Arguments object. - * @return True if `object` is an Arguments object, otherwise false. - **/ - isArguments(object: any): bool; - - /** - * Returns true if object is a Function. - * @param object Check if this object is a Function. - * @return True if `object` is a Function, otherwise false. - **/ - isFunction(object: any): bool; - - /** - * Returns true if object is a String. - * @param object Check if this object is a String. - * @return True if `object` is a String, otherwise false. - **/ - isString(object: any): bool; - - /** - * Returns true if object is a Number (including NaN). - * @param object Check if this object is a Number. - * @return True if `object` is a Number, otherwise false. - **/ - isNumber(object: any): bool; - - /** - * Returns true if object is a finite Number. - * @param object Check if this object is a finite Number. - * @return True if `object` is a finite Number. - **/ - isFinite(object: any): bool; - - /** - * Returns true if object is either true or false. - * @param object Check if this object is a bool. - * @return True if `object` is a bool, otherwise false. - **/ - isBoolean(object: any): bool; - - /** - * Returns true if object is a Date. - * @param object Check if this object is a Date. - * @return True if `object` is a Date, otherwise false. - **/ - isDate(object: any): bool; - - /** - * Returns true if object is a RegExp. - * @param object Check if this object is a RegExp. - * @return True if `object` is a RegExp, otherwise false. - **/ - isRegExp(object: any): bool; - - /** - * Returns true if object is NaN. - * Note: this is not the same as the native isNaN function, - * which will also return true if the variable is undefined. - * @param object Check if this object is NaN. - * @return True if `object` is NaN, otherwise false. - **/ - isNaN(object: any): bool; - - /** - * Returns true if the value of object is null. - * @param object Check if this object is null. - * @return True if `object` is null, otherwise false. - **/ - isNull(object: any): bool; - - /** - * Returns true if value is undefined. - * @param object Check if this object is undefined. - * @return True if `object` is undefined, otherwise false. - **/ - isUndefined(object: any): bool; - - /********** - * Utility * - ***********/ - - /** - * Give control of the "_" variable back to its previous owner. - * Returns a reference to the Underscore object. - * @return Underscore object reference. - **/ - noConflict(): Underscore; - - /** - * Returns the same value that is used as the argument. In math: f(x) = x - * This function looks useless, but is used throughout Underscore as a default iterator. - * @param value Identity of this object. - * @return `value`. - **/ - identity(value: any): any; - - /** - * Invokes the given iterator function n times. - * Each invocation of iterator is called with an index argument - * @param n Number of times to invoke `iterator`. - * @param iterator Function iterator to invoke `n` times. - * @param context `this` object in `iterator`, optional. - **/ - times(n: number, iterator: (n: number) => void , context?: any): void; - - /** - * Returns a random integer between min and max, inclusive. If you only pass one argument, - * it will return a number between 0 and that number. - * @param max The maximum random number. - * @return A random number between 0 and `max`. - **/ - random(max: number): number; - /** - * Returns a random integer between min and max, inclusive. If you only pass one argument, - * it will return a number between 0 and that number. - * @param min The minimum random number. - * @param max The maximum random number. - * @return A random number between `min` and `max`. - **/ - random(min: number, max: number): number; - - /** - * Allows you to extend Underscore with your own utility functions. Pass a hash of - * {name: function} definitions to have your functions added to the Underscore object, - * as well as the OOP wrapper. - * @param object Mixin object containing key/function pairs to add to the Underscore object. - **/ - mixin(object: any): void; - - /** - * Generate a globally-unique id for client-side models or DOM elements that need one. - * If prefix is passed, the id will be appended to it. Without prefix, returns an integer. - * @return Unique number ID. - **/ - uniqueId(): number; - /** - * Generate a globally-unique id for client-side models or DOM elements that need one. - * If prefix is passed, the id will be appended to it. Without prefix, returns an integer. - * @param prefix A prefix string to start the unique ID with. - * @return Unique string ID beginning with `prefix`. - **/ - uniqueId(prefix: string): string; - - /** - * Escapes a string for insertion into HTML, replacing &, <, >, ", ', and / characters. - * @param str Raw string to escape. - * @return `str` HTML escaped. - **/ - escape(str: string): string; - - /** - * If the value of the named property is a function then invoke it; otherwise, return it. - * @param object Object to maybe invoke function `property` on. - * @param property The function by name to invoke on `object`. - * @return The result of invoking the function `property` on `object. - **/ - result(object: any, property: string): any; - - /** - * Compiles JavaScript templates into functions that can be evaluated for rendering. Useful - * for rendering complicated bits of HTML from JSON data sources. Template functions can both - * interpolate variables, using <%= %>, as well as execute arbitrary JavaScript code, with - * <% %>. If you wish to interpolate a value, and have it be HTML-escaped, use <%- %> When - * you evaluate a template function, pass in a data object that has properties corresponding to - * the template's free variables. If you're writing a one-off, you can pass the data object as - * the second parameter to template in order to render immediately instead of returning a template - * function. The settings argument should be a hash containing any _.templateSettings that should - * be overridden. - * @param templateString Underscore HTML template. - * @param data Data to use when compiling `templateString`. - * @param settings Settings to use while compiling. - * @return Returns the compiled Underscore HTML template. - **/ - template(templateString: string, data?: any, settings?: UnderscoreTemplateSettings): any; - - /** - * By default, Underscore uses ERB-style template delimiters, change the - * following template settings to use alternative delimiters. - **/ - templateSettings: UnderscoreTemplateSettings; - - /*********** - * Chaining * - ************/ - - /** - * Returns a wrapped object. Calling methods on this object will continue to return wrapped objects - * until value() is used. - * @param obj Object to chain. - * @return Wrapped `obj`. - **/ - chain(obj: any): any; - - /** - * Extracts the value of a wrapped object. - * @param obj Wrapped object to extract the value from. - * @return Value of `obj`. - **/ - value(obj: any): any; - - /************** - * OOP Wrapper * - **************/ - - /** - * Underscore OOP Wrapper, all Underscore functions that take an object - * as the first parameter can be invoked through this function. - * @param key First argument to Underscore object functions. - **/ - (obj: any): UnderscoreOOPWrapper; -} - -/** -* underscore.js template settings, set templateSettings or pass as an argument -* to 'template()' to overide defaults. -**/ -interface UnderscoreTemplateSettings { - /** - * Default value is '/<%([\s\S]+?)%>/g'. - **/ - evaluate?: RegExp; - - /** - * Default value is '/<%=([\s\S]+?)%>/g'. - **/ - interpolate?: RegExp; - - /** - * Default value is '/<%-([\s\S]+?)%>/g'. - **/ - escape?: RegExp; -} - -interface UnderscoreOOPWrapper { - - /************** - * Collections * - **************/ - - /** - * Wrapped type `any[]`. - * @see _.each - **/ - each( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): void; - /** - * Wrapped type `object`. - * @see _.each - **/ - each( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): void; - - /** - * Alias for 'each'. - * @see each - **/ - forEach( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): void; - /** - * Alias for 'each'. - * @see each - **/ - forEach( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): void; - - /** - * Wrapped type `any[]`. - * @see _.map - **/ - map( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - /** - * Wrapped type `object`. - * @see _.map - **/ - map( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; - - /** - * Alias for 'map'. - * @see map - **/ - collect( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - /** - * Alias for 'map'. - * @see map - **/ - collect( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; - - /** - * Wrapped type `any[]`. - * @see _.reduce - **/ - reduce( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduce'. - * @see reduce - **/ - inject( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduce'. - * @see reduce - **/ - foldl( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Wrapped type `any[]`. - * @see _.reduceRight - **/ - reduceRight( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduceRight'. - * @see reduceRight - **/ - foldr( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Wrapped type `any[]`. - * @see _.find - **/ - find( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; - - /** - * Alias for 'find'. - * @see find - **/ - detect( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; - - - /** - * Wrapped type `any[]`. - * @see _.filter - **/ - filter( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Alias for 'filter'. - * @see filter - **/ - select( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Wrapped type `any[]`. - * @see _.where - **/ - where(list: any[], properties: any): any[]; - - /** - * Wrapped type `any[]`. - * @see _.reject - **/ - reject( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Wrapped type `any[]`. - * @see _.all - **/ - all( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Alias for 'all'. - * @see all - **/ - every( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Wrapped type `any[]`. - * @see _.any - **/ - any( - list: any[], - iterator?: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Alias for 'any'. - * @see any - **/ - some( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Wrapped type `any[]`. - * @see _.contains - **/ - contains(value: any): bool; - - /** - * Alias for 'contains'. - * @see contains - **/ - include(value: any): bool; - - /** - * Wrapped type `any[]`. - * @see _.invoke - **/ - invoke(methodName: string, ...arguments: any[]): void; - - /** - * Wrapped type `any[]`. - * @see _.pluck - **/ - pluck(propertyName: string): any[]; - - /** - * Wrapped type `number[]`. - * @see _.max - **/ - max(): number; - /** - * Wrapped type `any[]`. - * @see _.max - **/ - max( - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): any; - - /** - * Wrapped type `number[]`. - * @see _.min - **/ - min(): number; - /** - * Wrapped type `any[]`. - * @see _.min - **/ - min( - iterator: (obj: any, index?: number, list?: any[]) => number, - context?: any): any; - - /** - * Wrapped type `any[]`. - * @see _.sortBy - **/ - sortBy( - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): any[]; - /** - * Wrapped type `any[]`. - * @see _.sortBy - **/ - sortBy( - iterator: string, - context?: any): any[]; - - /** - * Wrapped type `any[]`. - * @see _.groupBy - **/ - groupBy( - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): { [key: string]: any[]; }; - /** - * Wrapped type `any[]`. - * @see _.groupBy - **/ - groupBy( - iterator: string, - context?: any): { [key: string]: any[]; }; - - /** - * Wrapped type `any[]`. - * @see _.countBy - **/ - countBy( - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): { [key: string]: number; }; - /** - * Wrapped type `any[]`. - * @see _.countBy - **/ - countBy( - iterator: string, - context?: any): { [key: string]: number; }; - - /** - * Wrapped type `any[]`. - * @see _.shuffle - **/ - shuffle(): any[]; - - /** - * Wrapped type `any`. - * @see _.toArray - **/ - toArray(): any[]; - - /** - * Wrapped type `any`. - * @see _.size - **/ - size(): number; - - /********* - * Arrays * - **********/ - - /** - * Wrapped type `any[]`. - * @see _.first - **/ - first(): any; - /** - * Wrapped type `any[]`. - * @see _.first - **/ - first(n: number): any[]; - - /** - * Alias for 'first'. - * @see first - **/ - head(): any; - /** - * Alias for 'first'. - * @see first - **/ - head(n: number): any[]; - - /** - * Alias for 'first'. - * @see first - **/ - take(): any; - /** - * Alias for 'first'. - * @see first - **/ - take(n: number): any[]; - - /** - * Wrapped type `any[]`. - * @see _.initial - **/ - initial(n?: number): any[]; - - /** - * Wrapped type `any[]`. - * @see _.last - **/ - last(): any; - /** - * Wrapped type `any[]`. - * @see _.last - **/ - last(n: number): any[]; - - /** - * Wrapped type `any[]`. - * @see _.rest - **/ - rest(index?: number): any[]; - - /** - * Alias for 'rest'. - * @see rest - **/ - tail(index?: number): any[]; - - /** - * Alias for 'rest'. - * @see rest - **/ - drop(index?: number): any[]; - - /** - * Wrapped type `any[]`. - * @see _.compact - **/ - compact(): any[]; - - /** - * Wrapped type `any`. - * @see _.flatten - **/ - flatten(shallow?: bool): any; - - /** - * Wrapped type `any[]`. - * @see _.without - **/ - without(...values: any[]): any[]; - - /** - * Wrapped type `any[][]`. - * @see _.union - **/ - union(...arrays: any[][]): any[]; - - /** - * Wrapped type `any[][]`. - * @see _.intersection - **/ - intersection(...arrays: any[][]): any[]; - - /** - * Wrapped type `any[]`. - * @see _.difference - **/ - difference(...others: any[]): any[]; - - /** - * Wrapped type `any[]`. - * @see _.uniq - **/ - uniq( - isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any): any[]; - - /** - * Alias for 'uniq'. - * @see uniq - **/ - unique( - isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any): any[]; - - /** - * Wrapped type `any[][]`. - * @see _.zip - **/ - zip(...arrays: any[][]): any[][]; - - /** - * Wrapped type `any[][]`. - * @see _.object - **/ - object(...keyValuePairs: any[][]): any; - - /** - * Wrapped type `any[]`. - * @see _.indexOf - **/ - indexOf(value: any, isSorted?: bool): number; - - /** - * Wrapped type `any[]`. - * @see _.lastIndexOf - **/ - lastIndexOf(value: any, from?: number): number; - - /** - * Wrapped type `any[]`. - * @see _.sortedIndex - **/ - sortedIndex(value: any, iterator?: (element: any) => number): number; - - /** - * Wrapped type `number`. - * @see _.range - **/ - range(stop: number, step?: number): number[]; - /** - * Wrapped type `number`. - * @see _.range - **/ - range(): number[]; - - /************ - * Functions * - *************/ - - /** - * Wrapped type `Function`. - * @see _.bind - **/ - bind(object: any, ...arguments: any[]): Function; - - - /** - * Wrapped type `object`. - * @see _.bindAll - **/ - bindAll(...methodNames: string[]): void; - - /** - * Wrapped type `Function`. - * @see _.memoize - **/ - memoize(hashFn?: (n: any) => string): Function; - - /** - * Wrapped type `Function`. - * @see _.delay - **/ - delay(waitMS: number, ...arguments: any[]): void; - - /** - * Wrapped type `Function`. - * @see _.defer - **/ - defer(...arguments: any[]): void; - - /** - * Wrapped type `Function`. - * @see _.throttle - **/ - throttle(waitMS: number): Function; - - /** - * Wrapped type `Function`. - * @see _.debounce - **/ - debounce(waitMS: number, immediate?: bool): Function; - - /** - * Wrapped type `Function`. - * @see _.once - **/ - once(): Function; - - /** - * Wrapped type `number`. - * @see _.after - **/ - after(fn: Function): Function; - - /** - * Wrapped type `Function`. - * @see _.wrap - **/ - wrap(wrapper: (fn: Function, ...args: any[]) => any): Function; - - /** - * Wrapped type `Function[]`. - * @see _.compose - **/ - compose(...functions: Function[]): Function; - - /********** - * Objects * - ***********/ - - /** - * Wrapped type `object`. - * @see _.keys - **/ - keys(): string[]; - - /** - * Wrapped type `object`. - * @see _.values - **/ - values(): any[]; - - /** - * Wrapped type `object`. - * @see _.pairs - **/ - pairs(): any[][]; - - /** - * Wrapped type `object`. - * @see _.invert - **/ - invert(): any; - - /** - * Wrapped type `object`. - * @see _.functions - **/ - functions(): string[]; - - /** - * Wrapped type `object`. - * @see _.extend - **/ - extend(...sources: any[]): any; - - /** - * Wrapped type `object`. - * @see _.pick - **/ - pick(...keys: string[]): any; - - /** - * Wrapped type `object`. - * @see _.omit - **/ - omit(...keys: string[]): any; - - /** - * Wrapped type `object`. - * @see _.defaults - **/ - defaults(...defaults: any[]): any; - - /** - * Wrapped type `object`. - * @see _.clone - **/ - clone(object: any): any; - /** - * Wrapped type `any[]`. - * @see _.clone - **/ - clone(list: any[]): any[]; - - /** - * Wrapped type `object`. - * @see _.tap - **/ - tap(intercepter: Function): any; - - /** - * Wrapped type `object`. - * @see _.has - **/ - has(key: string): bool; - - /** - * Wrapped type `object`. - * @see _.isEqual - **/ - isEqual(other: any): bool; - - /** - * Wrapped type `object`. - * @see _.isEmpty - **/ - isEmpty(object: any): bool; - /** - * Wrapped type `any[]`. - * @see _.isEmpty - **/ - isEmpty(list: any[]): bool; - - /** - * Wrapped type `object`. - * @see _.isElement - **/ - isElement(): bool; - - /** - * Wrapped type `object`. - * @see _.isArray - **/ - isArray(): bool; - - /** - * Wrapped type `object`. - * @see _.isObject - **/ - isObject(): bool; - - /** - * Wrapped type `object`. - * @see _.isArguments - **/ - isArguments(): bool; - - /** - * Wrapped type `object`. - * @see _.isFunction - **/ - isFunction(): bool; - - /** - * Wrapped type `object`. - * @see _.isString - **/ - isString(): bool; - - /** - * Wrapped type `object`. - * @see _.isNumber - **/ - isNumber(): bool; - - /** - * Wrapped type `object`. - * @see _.isFinite - **/ - isFinite(): bool; - - /** - * Wrapped type `object`. - * @see _.isBoolean - **/ - isBoolean(): bool; - - /** - * Wrapped type `object`. - * @see _.isDate - **/ - isDate(): bool; - - /** - * Wrapped type `object`. - * @see _.isRegExp - **/ - isRegExp(): bool; - - /** - * Wrapped type `object`. - * @see _.isNaN - **/ - isNaN(): bool; - - /** - * Wrapped type `object`. - * @see _.isNull - **/ - isNull(): bool; - - /** - * Wrapped type `object`. - * @see _.isUndefined - **/ - isUndefined(): bool; - - /********** - * Utility * - ***********/ - - /** - * Wrapped type `any`. - * @see _.identity - **/ - identity(): any; - - /** - * Wrapped type `number`. - * @see _.times - **/ - times(iterator: (n: number) => void , context?: any): void; - - /** - * Wrapped type `number`. - * @see _.random - **/ - random(): number; - /** - * Wrapped type `number`. - * @see _.random - **/ - random(max: number): number; - - /** - * Wrapped type `object`. - * @see _.mixin - **/ - mixin(): void; - - /** - * Wrapped type `string`. - * @see _.uniqueId - **/ - uniqueId(): string; - - /** - * Wrapped type `string`. - * @see _.escape - **/ - escape(): string; - - /** - * Wrapped type `object`. - * @see _.result - **/ - result(property: string): any; - - /** - * Wrapped type `string`. - * @see _.template - **/ - template(data?: any, settings?: UnderscoreTemplateSettings): any; - - /*********** - * Chaining * - ************/ - - /** - * Wrapped type `any`. - * @see _.chain - **/ - chain(): any; - - /** - * Wrapped type `any`. - * @see _.value - **/ - value(): any; -} - -declare var _: Underscore; diff --git a/underscore/underscore-typed-1.4.3.d.ts b/underscore/underscore-typed-1.4.3.d.ts deleted file mode 100644 index 56fe7583ab..0000000000 --- a/underscore/underscore-typed-1.4.3.d.ts +++ /dev/null @@ -1,2031 +0,0 @@ -/* -underscore-1.4.3.d.ts may be freely distributed under the MIT license. - -Copyright (c) 2013 Josh Baldwin https://github.com/jbaldwin/underscore.d.ts - -Permission is hereby granted, free of charge, to any person -obtaining a copy of this software and associated documentation -files (the "Software"), to deal in the Software without -restriction, including without limitation the rights to use, -copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the -Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES -OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT -HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, -WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -OTHER DEALINGS IN THE SOFTWARE. -*/ - -interface Underscore { - - /************** - * Collections * - **************/ - - /** - * Iterates over a list of elements, yielding each in turn to an iterator function. The iterator is - * bound to the context object, if one is passed. Each invocation of iterator is called with three - * arguments: (element, index, list). If list is a JavaScript object, iterator's arguments will be - * (value, key, object). Delegates to the native forEach function if it exists. - * @param list Iterates over this list of elements. - * @param iterator Iterator function for each element `list`. - * @param context 'this' object in `iterator`, optional. - **/ - each( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): void; - /** - * Iterates over a list of elements, yielding each in turn to an iterator function. The iterator is - * bound to the context object, if one is passed. Each invocation of iterator is called with three - * arguments: (element, index, list). If list is a JavaScript object, iterator's arguments will be - * (value, key, object). Delegates to the native forEach function if it exists. - * @param obj Iterators over this object's properties. - * @param iterator Iterator function for each property on `obj`. - * @param context `this` object in the `iterator`, optional. - **/ - each( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): void; - - /** - * Alias for 'each'. - * @see each - **/ - forEach( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): void; - /** - * Alias for 'each'. - * @see each - **/ - forEach( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): void; - - /** - * Produces a new array of values by mapping each value in list through a transformation function - * (iterator). If the native map method exists, it will be used instead. If list is a JavaScript - * object, iterator's arguments will be (value, key, object). - * @param list Maps the elements of this array. - * @param iterator Map iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return The mapped array result. - **/ - map( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - /** - * Produces a new array of values by mapping each value in list through a transformation function - * (iterator). If the native map method exists, it will be used instead. If list is a JavaScript - * object, iterator's arguments will be (value, key, object). - * @param list Maps the properties of this object. - * @param iterator Map iterator function for each property on `obj`. - * @param context `this` object in `iterator`, optional. - * @return The mapped object result. - **/ - map( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; - - /** - * Alias for 'map'. - * @see map - **/ - collect( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - /** - * Alias for 'map'. - * @see map - **/ - collect( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; - - /** - * Also known as inject and foldl, reduce boils down a list of values into a single value. - * Memo is the initial state of the reduction, and each successive step of it should be - * returned by iterator. The iterator is passed four arguments: the memo, then the value - * and index (or key) of the iteration, and finally a reference to the entire list. - * @param list Reduces the elements of this array. - * @param iterator Reduce iterator function for each element in `list`. - * @param memo Initial reduce state. - * @param context `this` object in `iterator`, optional. - * @return Reduced object result. - **/ - reduce( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduce'. - * @see reduce - **/ - inject( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduce'. - * @see reduce - **/ - foldl( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * The right-associative version of reduce. Delegates to the JavaScript 1.8 version of - * reduceRight, if it exists. Foldr is not as useful in JavaScript as it would be in a - * language with lazy evaluation. - * @param list Reduces the elements of this array. - * @param iterator Reduce iterator function for each element in `list`. - * @param memo Initial reduce state. - * @param context `this` object in `iterator`, optional. - * @return Reduced object result. - **/ - reduceRight( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduceRight'. - * @see reduceRight - **/ - foldr( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Looks through each value in the list, returning the first one that passes a truth - * test (iterator). The function returns as soon as it finds an acceptable element, - * and doesn't traverse the entire list. - * @param list Searches for a value in this list. - * @param iterator Search iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return The first acceptable found element in `list`, if nothing is found undefined/null is returned. - **/ - find( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; - - /** - * Alias for 'find'. - * @see find - **/ - detect( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; - - - /** - * Looks through each value in the list, returning an array of all the values that pass a truth - * test (iterator). Delegates to the native filter method, if it exists. - * @param list Filter elements out of this list. - * @param iterator Filter iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return The filtered list of elements. - **/ - filter( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Alias for 'filter'. - * @see filter - **/ - select( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Looks through each value in the list, returning an array of all the values that contain all - * of the key-value pairs listed in properties. - * @param list List to match elements again `properties`. - * @param properties The properties to check for on each element within `list`. - * @return The elements within `list` that contain the required `properties`. - **/ - where(list: any[], properties: any): any[]; - - /** - * Returns the values in list without the elements that the truth test (iterator) passes. - * The opposite of filter. - * Return all the elements for which a truth test fails. - * @param list Reject elements within this list. - * @param iterator Reject iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return The rejected list of elements. - **/ - reject( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Returns true if all of the values in the list pass the iterator truth test. Delegates to the - * native method every, if present. - * @param list Truth test against all elements within this list. - * @param iterator Trust test iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return True if all elements passed the truth test, otherwise false. - **/ - all( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Alias for 'all'. - * @see all - **/ - every( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Returns true if any of the values in the list pass the iterator truth test. Short-circuits and - * stops traversing the list if a true element is found. Delegates to the native method some, if present. - * @param list Truth test against all elements within this list. - * @param iterator Trust test iterator function for each element in `list`. - * @param context `this` object in `iterator`, optional. - * @return True if any elements passed the truth test, otherwise false. - **/ - any( - list: any[], - iterator?: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Alias for 'any'. - * @see any - **/ - some( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Returns true if the value is present in the list. Uses indexOf internally, - * if list is an Array. - * @param list Checks each element to see if `value` is present. - * @param value The value to check for within `list`. - * @return True if `value` is present in `list`, otherwise false. - **/ - contains(list: any[], value: any): bool; - - /** - * Alias for 'contains'. - * @see contains - **/ - include(list: any[], value: any): bool; - - /** - * Calls the method named by methodName on each value in the list. Any extra arguments passed to - * invoke will be forwarded on to the method invocation. - * @param list The element's in this list will each have the method `methodName` invoked. - * @param methodName The method's name to call on each element within `list`. - * @param arguments Additional arguments to pass to the method `methodName`. - **/ - invoke(list: any[], methodName: string, ...arguments: any[]): void; - - /** - * A convenient version of what is perhaps the most common use-case for map: extracting a list of - * property values. - * @param list The list to pluck elements out of that have the property `propertyName`. - * @param propertyName The property to look for on each element within `list`. - * @return The list of elements within `list` that have the property `propertyName`. - **/ - pluck(list: any[], propertyName: string): any[]; - - /** - * Returns the maximum value in list. - * @param list Finds the maximum value in this list. - * @return Maximum value in `list`. - **/ - max(list: number[]): number; - /** - * Returns the maximum value in list. If iterator is passed, it will be used on each value to generate - * the criterion by which the value is ranked. - * @param list Finds the maximum value in this list. - * @param iterator Compares each element in `list` to find the maximum value. - * @param context `this` object in `iterator`, optional. - * @return The maximum element within `list`. - **/ - max( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): any; - - /** - * Returns the minimum value in list. - * @param list Finds the minimum value in this list. - * @return Minimum value in `list`. - **/ - min(list: number[]): number; - /** - * Returns the minimum value in list. If iterator is passed, it will be used on each value to generate - * the criterion by which the value is ranked. - * @param list Finds the minimum value in this list. - * @param iterator Compares each element in `list` to find the minimum value. - * @param context `this` object in `iterator`, optional. - * @return The minimum element within `list`. - **/ - min( - list: any[], - iterator: (obj: any, index?: number, list?: any[]) => number, - context?: any): any; - - /** - * Returns a sorted copy of list, ranked in ascending order by the results of running each value - * through iterator. Iterator may also be the string name of the property to sort by (eg. length). - * @param list Sorts this list. - * @param iterator Sort iterator for each element within `list`. - * @param context `this` object in `iterator`, optional. - * @return A sorted copy of `list`. - **/ - sortBy( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): any[]; - /** - * Returns a sorted copy of list, ranked in ascending order by the results of running each value - * through iterator. Iterator may also be the string name of the property to sort by (eg. length). - * @param list Sorts this list. - * @param iterator Sort iterator for each element within `list`. - * @param context `this` object in `iterator`, optional. - * @return A sorted copy of `list`. - **/ - sortBy( - list: any[], - iterator: string, - context?: any): any[]; - - /** - * Splits a collection into sets, grouped by the result of running each value through iterator. - * If iterator is a string instead of a function, groups by the property named by iterator on - * each of the values. - * @param list Groups this list. - * @param iterator Group iterator for each element within `list`, return the key to group the element by. - * @param context `this` object in `iterator`, optional. - * @return An object with the group names as properties where each property contains the grouped elements from `list`. - **/ - groupBy( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): { [key: string]: any[]; }; - /** - * Splits a collection into sets, grouped by the result of running each value through iterator. - * If iterator is a string instead of a function, groups by the property named by iterator on - * each of the values. - * @param list Groups this list. - * @param iterator Group iterator for each element within `list`, return the key to group the element by. - * @param context `this` object in `iterator`, optional. - * @return An object with the group names as properties where each property contains the grouped elements from `list`. - **/ - groupBy( - list: any[], - iterator: string, - context?: any): { [key: string]: any[]; }; - - /** - * Sorts a list into groups and returns a count for the number of objects in each group. Similar - * to groupBy, but instead of returning a list of values, returns a count for the number of values - * in that group. - * @param list Group elements in this list and then count the number of elements in each group. - * @param iterator Group iterator for each element within `list`, return the key to group the element by. - * @param context `this` object in `iterator`, optional. - * @return An object with the group names as properties where each property contains the number of elements in that group. - **/ - countBy( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): { [key: string]: number; }; - /** - * Sorts a list into groups and returns a count for the number of objects in each group. Similar - * to groupBy, but instead of returning a list of values, returns a count for the number of values - * in that group. - * @param list Group elements in this list and then count the number of elements in each group. - * @param iterator Group iterator for each element within `list`, return the key to group the element by. - * @param context `this` object in `iterator`, optional. - * @return An object with the group names as properties where each property contains the number of elements in that group. - **/ - countBy( - list: any[], - iterator: string, - context?: any): { [key: string]: number; }; - - /** - * Returns a shuffled copy of the list, using a version of the Fisher-Yates shuffle. - * @param list List to shuffle. - * @return Shuffled copy of `list`. - **/ - shuffle(list: any[]): any[]; - - /** - * Converts the list (anything that can be iterated over), into a real Array. Useful for transmuting - * the arguments object. - * @param list object to transform into an array. - * @return `list` as an array. - **/ - toArray(list: any): any[]; - - /** - * Return the number of values in the list. - * @param list Count the number of values/elements in this list. - * @return Number of values in `list`. - **/ - size(list: any): number; - - /********* - * Arrays * - **********/ - - /** - * Returns the first element of an array. Passing n will return the first n elements of the array. - * @param array Retrieves the first element of this array. - * @return Returns the first element of `array`. - **/ - first(array: any[]): any; - /** - * Returns the first element of an array. Passing n will return the first n elements of the array. - * @param array Retreives the first `n` elements of this array. - * @param n Return more than one element from `array`. - * @return Returns the first `n` elements from `array. - **/ - first(array: any[], n: number): any[]; - - /** - * Alias for 'first'. - * @see first - **/ - head(array: any[]): any; - /** - * Alias for 'first'. - * @see first - **/ - head(array: any[], n: number): any[]; - - /** - * Alias for 'first'. - * @see first - **/ - take(array: any[]): any; - /** - * Alias for 'first'. - * @see first - **/ - take(array: any[], n: number): any[]; - - /** - * Returns everything but the last entry of the array. Especially useful on the arguments object. - * Pass n to exclude the last n elements from the result. - * @param array Retreive all elements except the last `n`. - * @param n Leaves this many elements behind, optional. - * @return Returns everything but the last `n` elements of `array`. - **/ - initial(array: any[], n?: number): any[]; - - /** - * Returns the last element of an array. Passing n will return the last n elements of the array. - * @param array Retrieves the last element of this array. - * @return Returns the last element of `array`. - **/ - last(array: any[]): any; - /** - * Returns the last element of an array. Passing n will return the last n elements of the array. - * @param array Retreives the last `n` elements of this array. - * @param n Return more than one element from `array`. - * @return Returns the last `n` elements from `array. - **/ - last(array: any[], n: number): any[]; - - /** - * Returns the rest of the elements in an array. Pass an index to return the values of the array - * from that index onward. - * @param array The array to retrieve all but the first `index` elements. - * @param index The index to start retrieving elements forward from, optional, default = 1. - * @return Returns the elements of `array` from `index` to the end of `array`. - **/ - rest(array: any[], index?: number): any[]; - - /** - * Alias for 'rest'. - * @see rest - **/ - tail(array: any[], index?: number): any[]; - - /** - * Alias for 'rest'. - * @see rest - **/ - drop(array: any[], index?: number): any[]; - - /** - * Returns a copy of the array with all falsy values removed. In JavaScript, false, null, 0, "", - * undefined and NaN are all falsy. - * @param array Array to compact. - * @return Copy of `array` without false values. - **/ - compact(array: any[]): any[]; - - /** - * Flattens a nested array (the nesting can be to any depth). If you pass shallow, the array will - * only be flattened a single level. - * @param array The array to flatten. - * @param shallow If true then only flatten one level, optional, default = false. - * @return `array` flattened. - **/ - flatten(array: any, shallow?: bool): any; - - /** - * Returns a copy of the array with all instances of the values removed. - * @param array The array to remove `values` from. - * @param values The values to remove from `array`. - * @return Copy of `array` without `values`. - **/ - without(array: any[], ...values: any[]): any[]; - - /** - * Computes the union of the passed-in arrays: the list of unique items, in order, that are - * present in one or more of the arrays. - * @param arrays Array of arrays to compute the union of. - * @return The union of elements within `arrays`. - **/ - union(...arrays: any[][]): any[]; - - /** - * Computes the list of values that are the intersection of all the arrays. Each value in the result - * is present in each of the arrays. - * @param arrays Array of arrays to compute the intersection of. - * @return The intersection of elements within `arrays`. - **/ - intersection(...arrays: any[][]): any[]; - - /** - * Similar to without, but returns the values from array that are not present in the other arrays. - * @param array Keeps values that are within `others`. - * @param others The values to keep within `array`. - * @return Copy of `array` with only `others` values. - **/ - difference(array: any[], ...others: any[]): any[]; - - /** - * Produces a duplicate-free version of the array, using === to test object equality. If you know in - * advance that the array is sorted, passing true for isSorted will run a much faster algorithm. If - * you want to compute unique items based on a transformation, pass an iterator function. - * @param array Array to remove duplicates from. - * @param isSorted True if `array` is already sorted, optiona, default = false. - * @param iterator Transform the elements of `array` before comparisons for uniqueness. - * @param context 'this' object in `iterator`, optional. - * @return Copy of `array` where all elements are unique. - **/ - uniq( - array: any[], - isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - /** - * Produces a duplicate-free version of the array, using === to test object equality. If you know in - * advance that the array is sorted, passing true for isSorted will run a much faster algorithm. If - * you want to compute unique items based on a transformation, pass an iterator function. - * @param array Array to remove duplicates from. - * @param iterator Transform the elements of `array` before comparisons for uniqueness. - * @param context 'this' object in `iterator`, optional. - * @return Copy of `array` where all elements are unique. - **/ - uniq( - array: any[], - iterator?: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - - /** - * Alias for 'uniq'. - * @see uniq - **/ - unique(array: any[], - isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any): any[]; - - /** - * Merges together the values of each of the arrays with the values at the corresponding position. - * Useful when you have separate data sources that are coordinated through matching array indexes. - * If you're working with a matrix of nested arrays, zip.apply can transpose the matrix in a similar fashion. - * @param arrays The arrays to merge/zip. - * @return Zipped version of `arrays`. - **/ - zip(...arrays: any[][]): any[][]; - - /** - * Converts arrays into objects. Pass either a single list of [key, value] pairs, or a - * list of keys, and a list of values. - * @param keys Key array. - * @param values Value array. - * @return An object containing the `keys` as properties and `values` as the property values. - **/ - object(keys: string[], values: any[]): any; - /** - * Converts arrays into objects. Pass either a single list of [key, value] pairs, or a - * list of keys, and a list of values. - * @param keyValuePairs Array of [key, value] pairs. - * @return An object containing the `keys` as properties and `values` as the property values. - **/ - object(...keyValuePairs: any[][]): any; - - /** - * Returns the index at which value can be found in the array, or -1 if value is not present in the array. - * Uses the native indexOf function unless it's missing. If you're working with a large array, and you know - * that the array is already sorted, pass true for isSorted to use a faster binary search ... or, pass a number - * as the third argument in order to look for the first matching value in the array after the given index. - * @param array The array to search for the index of `value`. - * @param value The value to search for within `array`. - * @param isSorted True if the array is already sorted, optional, default = false. - * @return The index of `value` within `array`. - **/ - indexOf(array: any[], value: any, isSorted?: bool): number; - - /** - * Returns the index of the last occurrence of value in the array, or -1 if value is not present. Uses the - * native lastIndexOf function if possible. Pass fromIndex to start your search at a given index. - * @param array The array to search for the last index of `value`. - * @param value The value to search for within `array`. - * @param from The starting index for the search, optional. - * @return The index of the last occurance of `value` within `array`. - **/ - lastIndexOf(array: any[], value: any, from?: number): number; - - /** - * Uses a binary search to determine the index at which the value should be inserted into the list in order - * to maintain the list's sorted order. If an iterator is passed, it will be used to compute the sort ranking - * of each value, including the value you pass. - * @param list The sorted list. - * @param value The value to determine its index within `list`. - * @param iterator Iterator to compute the sort ranking of each value, optional. - * @return The index where `value` should be inserted into `list`. - **/ - sortedIndex(list: any[], value: any, iterator?: (element: any) => number): number; - - /** - * A function to create flexibly-numbered lists of integers, handy for each and map loops. start, if omitted, - * defaults to 0; step defaults to 1. Returns a list of integers from start to stop, incremented (or decremented) - * by step, exclusive. - * @param start Start here. - * @param stop Stop here. - * @param step The number to count up by each iteration, optional, default = 1. - * @return Array of numbers from `start` to `stop` with increments of `step`. - **/ - range(start: number, stop: number, step?: number): number[]; - /** - * A function to create flexibly-numbered lists of integers, handy for each and map loops. start, if omitted, - * defaults to 0; step defaults to 1. Returns a list of integers from start to stop, incremented (or decremented) - * by step, exclusive. - * @param stop Stop here. - * @return Array of numbers from 0 to `stop` with increments of 1. - * @note If start is not specified the implementation will never pull the step (step = arguments[2] || 0) - **/ - range(stop: number): number[]; - - /************ - * Functions * - *************/ - - /** - * Bind a function to an object, meaning that whenever the function is called, the value of this will - * be the object. Optionally, bind arguments to the function to pre-fill them, also known as partial application. - * @param fn The function to bind `this` to `object`. - * @param object The `this` pointer whenever `fn` is called. - * @param arguments Additional arguments to pass to `fn` when called. - * @return `fn` with `this` bound to `object`. - **/ - bind(fn: Function, object: any, ...arguments: any[]): Function; - - - /** - * Binds a number of methods on the object, specified by methodNames, to be run in the context of that object - * whenever they are invoked. Very handy for binding functions that are going to be used as event handlers, - * which would otherwise be invoked with a fairly useless this. If no methodNames are provided, all of the - * object's function properties will be bound to it. - * @param object The object to bind the methods `methodName` to. - * @param methodNames The methods to bind to `object`, optional and if not provided all of `object`'s - * methods are bound. - **/ - bindAll(object: any, ...methodNames: string[]): void; - - /** - * Memoizes a given function by caching the computed result. Useful for speeding up slow-running computations. - * If passed an optional hashFunction, it will be used to compute the hash key for storing the result, based - * on the arguments to the original function. The default hashFunction just uses the first argument to the - * memoized function as the key. - * @param fn Computationally expensive function that will now memoized results. - * @param hashFn Hash function for storing the result of `fn`. - * @return Memoized version of `fn`. - **/ - memoize(fn: Function, hashFn?: (n: any) => string): Function; - - /** - * Much like setTimeout, invokes function after wait milliseconds. If you pass the optional arguments, - * they will be forwarded on to the function when it is invoked. - * @param fn Function to delay `waitMS` amount of ms. - * @param waitMS The amount of milliseconds to delay `fn`. - * @arguments Additional arguments to pass to `fn`. - **/ - delay(fn: Function, waitMS: number, ...arguments: any[]): void; - - /** - * Defers invoking the function until the current call stack has cleared, similar to using setTimeout - * with a delay of 0. Useful for performing expensive computations or HTML rendering in chunks without - * blocking the UI thread from updating. If you pass the optional arguments, they will be forwarded on - * to the function when it is invoked. - * @param fn The function to defer. - * @param arguments Additional arguments to pass to `fn`. - **/ - defer(fn: Function, ...arguments: any[]): void; - - /** - * Creates and returns a new, throttled version of the passed function, that, when invoked repeatedly, - * will only actually call the original function at most once per every wait milliseconds. Useful for - * rate-limiting events that occur faster than you can keep up with. - * @param fn Function to throttle `waitMS` ms. - * @param waitMS The number of milliseconds to wait before `fn` can be invoked again. - * @return `fn` with a throttle of `waitMS`. - **/ - throttle(fn: Function, waitMS: number): Function; - - /** - * Creates and returns a new debounced version of the passed function that will postpone its execution - * until after wait milliseconds have elapsed since the last time it was invoked. Useful for implementing - * behavior that should only happen after the input has stopped arriving. For example: rendering a preview - * of a Markdown comment, recalculating a layout after the window has stopped being resized, and so on. - * - * Pass true for the immediate parameter to cause debounce to trigger the function on the leading instead - * of the trailing edge of the wait interval. Useful in circumstances like preventing accidental double - *-clicks on a "submit" button from firing a second time. - * @param fn Function to debounce `waitMS` ms. - * @param waitMS The number of milliseconds to wait before `fn` can be invoked again. - * @param immediate True if `fn` should be invoked on the leading edge of `waitMS` instead of the trailing edge. - * @return Debounced version of `fn` that waits `waitMS` ms when invoked. - **/ - debounce(fn: Function, waitMS: number, immediate?: bool): Function; - - /** - * Creates a version of the function that can only be called one time. Repeated calls to the modified - * function will have no effect, returning the value from the original call. Useful for initialization - * functions, instead of having to set a boolean flag and then check it later. - * @param fn Function to only execute once. - * @return Copy of `fn` that can only be invoked once. - **/ - once(fn: Function): Function; - - /** - * Creates a version of the function that will only be run after first being called count times. Useful - * for grouping asynchronous responses, where you want to be sure that all the async calls have finished, - * before proceeding. - * @param count Number of times to be called before actually executing. - * @fn The function to defer execution `count` times. - * @return Copy of `fn` that will not execute until it is invoked `count` times. - **/ - after(count: number, fn: Function): Function; - - /** - * Wraps the first function inside of the wrapper function, passing it as the first argument. This allows - * the wrapper to execute code before and after the function runs, adjust the arguments, and execute it - * conditionally. - * @param fn Function to wrap. - * @param wrapper The function that will wrap `fn`. - * @return Wrapped version of `fn. - **/ - wrap(fn: Function, wrapper: (fn: Function, ...args: any[]) => any): Function; - - /** - * Returns the composition of a list of functions, where each function consumes the return value of the - * function that follows. In math terms, composing the functions f(), g(), and h() produces f(g(h())). - * @param functions List of functions to compose. - * @return Composition of `functions`. - **/ - compose(...functions: Function[]): Function; - - /********** - * Objects * - ***********/ - - /** - * Retrieve all the names of the object's properties. - * @param object Retreive the key or property names from this object. - * @return List of all the property names on `object`. - **/ - keys(object: any): string[]; - - /** - * Return all of the values of the object's properties. - * @param object Retreive the values of all the properties on this object. - * @return List of all the values on `object`. - **/ - values(object: any): any[]; - - /** - * Convert an object into a list of [key, value] pairs. - * @param object Convert this object to a list of [key, value] pairs. - * @return List of [key, value] pairs on `object`. - **/ - pairs(object: any): any[][]; - - /** - * Returns a copy of the object where the keys have become the values and the values the keys. - * For this to work, all of your object's values should be unique and string serializable. - * @param object Object to invert key/value pairs. - * @return An inverted key/value paired version of `object`. - **/ - invert(object: any): any; - - /** - * Returns a sorted list of the names of every method in an object that is to say, - * the name of every function property of the object. - * @param object Object to pluck all function property names from. - * @return List of all the function names on `object`. - **/ - functions(object: any): string[]; - - /** - * Copy all of the properties in the source objects over to the destination object, and return - * the destination object. It's in-order, so the last source will override properties of the - * same name in previous arguments. - * @param destination Object to extend all the properties from `sources`. - * @param sources Extends `destination` with all properties from these source objects. - * @return `destination` extended with all the properties from the `sources` objects. - **/ - extend(destination: any, ...sources: any[]): any; - - /** - * Return a copy of the object, filtered to only have values for the whitelisted keys - * (or array of valid keys). - * @param object Object to strip unwanted key/value pairs. - * @keys The key/value pairs to keep on `object`. - * @return Copy of `object` with only the `keys` properties. - **/ - pick(object: any, ...keys: string[]): any; - - /** - * Return a copy of the object, filtered to omit the blacklisted keys (or array of keys). - * @param object Object to strip unwanted key/value pairs. - * @param keys The key/value pairs to remove on `object`. - * @return Copy of `object` without the `keys` properties. - **/ - omit(object: any, ...keys: string[]): any; - - /** - * Fill in null and undefined properties in object with values from the defaults objects, - * and return the object. As soon as the property is filled, further defaults will have no effect. - * @param object Fill this object with default values. - * @param defaults The default values to add to `object`. - * @return `object` with added `defaults` values. - **/ - defaults(object: any, ...defaults: any[]): any; - - /** - * Create a shallow-copied clone of the object. - * Any nested objects or arrays will be copied by reference, not duplicated. - * @param object Object to clone. - * @return Copy of `object`. - **/ - clone(object: any): any; - /** - * Create a shallow-copied clone of the object. - * Any nested objects or arrays will be copied by reference, not duplicated. - * @param list List to clone. - * @return Copy of `list`. - **/ - clone(list: any[]): any[]; - - /** - * Invokes interceptor with the object, and then returns object. The primary purpose of this method - * is to "tap into" a method chain, in order to perform operations on intermediate results within the chain. - * @param object Argument to `interceptor`. - * @param intercepter The function to modify `object` before continuing the method chain. - * @return Modified `object`. - **/ - tap(object: any, intercepter: Function): any; - - /** - * Does the object contain the given key? Identical to object.hasOwnProperty(key), but uses a safe - * reference to the hasOwnProperty function, in case it's been overridden accidentally. - * @param object Object to check for `key`. - * @param key The key to check for on `object`. - * @return True if `key` is a property on `object`, otherwise false. - **/ - has(object: any, key: string): bool; - - /** - * Performs an optimized deep comparison between the two objects, - * to determine if they should be considered equal. - * @param object Compare to `other`. - * @param other Compare to `object`. - * @return True if `object` is equal to `other`. - **/ - isEqual(object: any, other: any): bool; - - /** - * Returns true if object contains no values. - * @param object Check if this object has no properties or values. - * @return True if `object` is empty. - **/ - isEmpty(object: any): bool; - /** - * Returns true if the list contains no values. - * @param object Check if this list has no elements. - * @return True if `list` is empty. - **/ - isEmpty(list: any[]): bool; - - /** - * Returns true if object is a DOM element. - * @param object Check if this object is a DOM element. - * @return True if `object` is a DOM element, otherwise false. - **/ - isElement(object: any): bool; - - /** - * Returns true if object is an Array. - * @param object Check if this object is an Array. - * @return True if `object` is an Array, otherwise false. - **/ - isArray(object: any): bool; - - /** - * Returns true if value is an Object. Note that JavaScript arrays and functions are objects, - * while (normal) strings and numbers are not. - * @param object Check if this object is an Object. - * @return True of `object` is an Object, otherwise false. - **/ - isObject(object: any): bool; - - /** - * Returns true if object is an Arguments object. - * @param object Check if this object is an Arguments object. - * @return True if `object` is an Arguments object, otherwise false. - **/ - isArguments(object: any): bool; - - /** - * Returns true if object is a Function. - * @param object Check if this object is a Function. - * @return True if `object` is a Function, otherwise false. - **/ - isFunction(object: any): bool; - - /** - * Returns true if object is a String. - * @param object Check if this object is a String. - * @return True if `object` is a String, otherwise false. - **/ - isString(object: any): bool; - - /** - * Returns true if object is a Number (including NaN). - * @param object Check if this object is a Number. - * @return True if `object` is a Number, otherwise false. - **/ - isNumber(object: any): bool; - - /** - * Returns true if object is a finite Number. - * @param object Check if this object is a finite Number. - * @return True if `object` is a finite Number. - **/ - isFinite(object: any): bool; - - /** - * Returns true if object is either true or false. - * @param object Check if this object is a bool. - * @return True if `object` is a bool, otherwise false. - **/ - isBoolean(object: any): bool; - - /** - * Returns true if object is a Date. - * @param object Check if this object is a Date. - * @return True if `object` is a Date, otherwise false. - **/ - isDate(object: any): bool; - - /** - * Returns true if object is a RegExp. - * @param object Check if this object is a RegExp. - * @return True if `object` is a RegExp, otherwise false. - **/ - isRegExp(object: any): bool; - - /** - * Returns true if object is NaN. - * Note: this is not the same as the native isNaN function, - * which will also return true if the variable is undefined. - * @param object Check if this object is NaN. - * @return True if `object` is NaN, otherwise false. - **/ - isNaN(object: any): bool; - - /** - * Returns true if the value of object is null. - * @param object Check if this object is null. - * @return True if `object` is null, otherwise false. - **/ - isNull(object: any): bool; - - /** - * Returns true if value is undefined. - * @param object Check if this object is undefined. - * @return True if `object` is undefined, otherwise false. - **/ - isUndefined(object: any): bool; - - /********** - * Utility * - ***********/ - - /** - * Give control of the "_" variable back to its previous owner. - * Returns a reference to the Underscore object. - * @return Underscore object reference. - **/ - noConflict(): Underscore; - - /** - * Returns the same value that is used as the argument. In math: f(x) = x - * This function looks useless, but is used throughout Underscore as a default iterator. - * @param value Identity of this object. - * @return `value`. - **/ - identity(value: any): any; - - /** - * Invokes the given iterator function n times. - * Each invocation of iterator is called with an index argument - * @param n Number of times to invoke `iterator`. - * @param iterator Function iterator to invoke `n` times. - * @param context `this` object in `iterator`, optional. - **/ - times(n: number, iterator: (n: number) => any , context?: any): any[]; - - /** - * Returns a random integer between min and max, inclusive. If you only pass one argument, - * it will return a number between 0 and that number. - * @param max The maximum random number. - * @return A random number between 0 and `max`. - **/ - random(max: number): number; - /** - * Returns a random integer between min and max, inclusive. If you only pass one argument, - * it will return a number between 0 and that number. - * @param min The minimum random number. - * @param max The maximum random number. - * @return A random number between `min` and `max`. - **/ - random(min: number, max: number): number; - - /** - * Allows you to extend Underscore with your own utility functions. Pass a hash of - * {name: function} definitions to have your functions added to the Underscore object, - * as well as the OOP wrapper. - * @param object Mixin object containing key/function pairs to add to the Underscore object. - **/ - mixin(object: any): void; - - /** - * Generate a globally-unique id for client-side models or DOM elements that need one. - * If prefix is passed, the id will be appended to it. Without prefix, returns an integer. - * @return Unique number ID. - **/ - uniqueId(): number; - /** - * Generate a globally-unique id for client-side models or DOM elements that need one. - * If prefix is passed, the id will be appended to it. Without prefix, returns an integer. - * @param prefix A prefix string to start the unique ID with. - * @return Unique string ID beginning with `prefix`. - **/ - uniqueId(prefix: string): string; - - /** - * Escapes a string for insertion into HTML, replacing &, <, >, ", ', and / characters. - * @param str Raw string to escape. - * @return `str` HTML escaped. - **/ - escape(str: string): string; - - /** - * If the value of the named property is a function then invoke it; otherwise, return it. - * @param object Object to maybe invoke function `property` on. - * @param property The function by name to invoke on `object`. - * @return The result of invoking the function `property` on `object. - **/ - result(object: any, property: string): any; - - /** - * Compiles JavaScript templates into functions that can be evaluated for rendering. Useful - * for rendering complicated bits of HTML from JSON data sources. Template functions can both - * interpolate variables, using <%= %>, as well as execute arbitrary JavaScript code, with - * <% %>. If you wish to interpolate a value, and have it be HTML-escaped, use <%- %> When - * you evaluate a template function, pass in a data object that has properties corresponding to - * the template's free variables. If you're writing a one-off, you can pass the data object as - * the second parameter to template in order to render immediately instead of returning a template - * function. The settings argument should be a hash containing any _.templateSettings that should - * be overridden. - * @param templateString Underscore HTML template. - * @param data Data to use when compiling `templateString`. - * @param settings Settings to use while compiling. - * @return Returns the compiled Underscore HTML template. - **/ - template(templateString: string, data?: any, settings?: UnderscoreTemplateSettings): any; - - /** - * By default, Underscore uses ERB-style template delimiters, change the - * following template settings to use alternative delimiters. - **/ - templateSettings: UnderscoreTemplateSettings; - - /*********** - * Chaining * - ************/ - - /** - * Returns a wrapped object. Calling methods on this object will continue to return wrapped objects - * until value() is used. - * @param obj Object to chain. - * @return Wrapped `obj`. - **/ - chain(obj: any): UnderscoreOOPWrapper; - - /** - * Extracts the value of a wrapped object. - * @param obj Wrapped object to extract the value from. - * @return Value of `obj`. - **/ - value(obj: any): any; - - /************** - * OOP Wrapper * - **************/ - - /** - * Underscore OOP Wrapper, all Underscore functions that take an object - * as the first parameter can be invoked through this function. - * @param key First argument to Underscore object functions. - **/ - (obj: any): UnderscoreOOPWrapper; -} - -/** -* underscore.js template settings, set templateSettings or pass as an argument -* to 'template()' to overide defaults. -**/ -interface UnderscoreTemplateSettings { - /** - * Default value is '/<%([\s\S]+?)%>/g'. - **/ - evaluate?: RegExp; - - /** - * Default value is '/<%=([\s\S]+?)%>/g'. - **/ - interpolate?: RegExp; - - /** - * Default value is '/<%-([\s\S]+?)%>/g'. - **/ - escape?: RegExp; -} - -interface UnderscoreOOPWrapper { - - /************** - * Collections * - **************/ - - /** - * Wrapped type `any[]`. - * @see _.each - **/ - each( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): void; - /** - * Wrapped type `object`. - * @see _.each - **/ - each( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): void; - - /** - * Alias for 'each'. - * @see each - **/ - forEach( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): void; - /** - * Alias for 'each'. - * @see each - **/ - forEach( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): void; - - /** - * Wrapped type `any[]`. - * @see _.map - **/ - map( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - /** - * Wrapped type `object`. - * @see _.map - **/ - map( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; - - /** - * Alias for 'map'. - * @see map - **/ - collect( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - /** - * Alias for 'map'. - * @see map - **/ - collect( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; - - /** - * Wrapped type `any[]`. - * @see _.reduce - **/ - reduce( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduce'. - * @see reduce - **/ - inject( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduce'. - * @see reduce - **/ - foldl( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Wrapped type `any[]`. - * @see _.reduceRight - **/ - reduceRight( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Alias for 'reduceRight'. - * @see reduceRight - **/ - foldr( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; - - /** - * Wrapped type `any[]`. - * @see _.find - **/ - find( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; - - /** - * Alias for 'find'. - * @see find - **/ - detect( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; - - - /** - * Wrapped type `any[]`. - * @see _.filter - **/ - filter( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Alias for 'filter'. - * @see filter - **/ - select( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Wrapped type `any[]`. - * @see _.where - **/ - where(list: any[], properties: any): any[]; - - /** - * Wrapped type `any[]`. - * @see _.reject - **/ - reject( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; - - /** - * Wrapped type `any[]`. - * @see _.all - **/ - all( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Alias for 'all'. - * @see all - **/ - every( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Wrapped type `any[]`. - * @see _.any - **/ - any( - list: any[], - iterator?: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Alias for 'any'. - * @see any - **/ - some( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): bool; - - /** - * Wrapped type `any[]`. - * @see _.contains - **/ - contains(value: any): bool; - - /** - * Alias for 'contains'. - * @see contains - **/ - include(value: any): bool; - - /** - * Wrapped type `any[]`. - * @see _.invoke - **/ - invoke(methodName: string, ...arguments: any[]): void; - - /** - * Wrapped type `any[]`. - * @see _.pluck - **/ - pluck(propertyName: string): any[]; - - /** - * Wrapped type `number[]`. - * @see _.max - **/ - max(): number; - /** - * Wrapped type `any[]`. - * @see _.max - **/ - max( - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): any; - - /** - * Wrapped type `number[]`. - * @see _.min - **/ - min(): number; - /** - * Wrapped type `any[]`. - * @see _.min - **/ - min( - iterator: (obj: any, index?: number, list?: any[]) => number, - context?: any): any; - - /** - * Wrapped type `any[]`. - * @see _.sortBy - **/ - sortBy( - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): any[]; - /** - * Wrapped type `any[]`. - * @see _.sortBy - **/ - sortBy( - iterator: string, - context?: any): any[]; - - /** - * Wrapped type `any[]`. - * @see _.groupBy - **/ - groupBy( - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): { [key: string]: any[]; }; - /** - * Wrapped type `any[]`. - * @see _.groupBy - **/ - groupBy( - iterator: string, - context?: any): { [key: string]: any[]; }; - - /** - * Wrapped type `any[]`. - * @see _.countBy - **/ - countBy( - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): { [key: string]: number; }; - /** - * Wrapped type `any[]`. - * @see _.countBy - **/ - countBy( - iterator: string, - context?: any): { [key: string]: number; }; - - /** - * Wrapped type `any[]`. - * @see _.shuffle - **/ - shuffle(): any[]; - - /** - * Wrapped type `any`. - * @see _.toArray - **/ - toArray(): any[]; - - /** - * Wrapped type `any`. - * @see _.size - **/ - size(): number; - - /********* - * Arrays * - **********/ - - /** - * Wrapped type `any[]`. - * @see _.first - **/ - first(): any; - /** - * Wrapped type `any[]`. - * @see _.first - **/ - first(n: number): any[]; - - /** - * Alias for 'first'. - * @see first - **/ - head(): any; - /** - * Alias for 'first'. - * @see first - **/ - head(n: number): any[]; - - /** - * Alias for 'first'. - * @see first - **/ - take(): any; - /** - * Alias for 'first'. - * @see first - **/ - take(n: number): any[]; - - /** - * Wrapped type `any[]`. - * @see _.initial - **/ - initial(n?: number): any[]; - - /** - * Wrapped type `any[]`. - * @see _.last - **/ - last(): any; - /** - * Wrapped type `any[]`. - * @see _.last - **/ - last(n: number): any[]; - - /** - * Wrapped type `any[]`. - * @see _.rest - **/ - rest(index?: number): any[]; - - /** - * Alias for 'rest'. - * @see rest - **/ - tail(index?: number): any[]; - - /** - * Alias for 'rest'. - * @see rest - **/ - drop(index?: number): any[]; - - /** - * Wrapped type `any[]`. - * @see _.compact - **/ - compact(): any[]; - - /** - * Wrapped type `any`. - * @see _.flatten - **/ - flatten(shallow?: bool): any; - - /** - * Wrapped type `any[]`. - * @see _.without - **/ - without(...values: any[]): any[]; - - /** - * Wrapped type `any[][]`. - * @see _.union - **/ - union(...arrays: any[][]): any[]; - - /** - * Wrapped type `any[][]`. - * @see _.intersection - **/ - intersection(...arrays: any[][]): any[]; - - /** - * Wrapped type `any[]`. - * @see _.difference - **/ - difference(...others: any[]): any[]; - - /** - * Wrapped type `any[]`. - * @see _.uniq - **/ - uniq( - isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - /** - * Wrapped type `any[]`. - * @see _.uniq - **/ - uniq( - iterator?: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; - - /** - * Alias for 'uniq'. - * @see uniq - **/ - unique( - isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any): any[]; - - /** - * Wrapped type `any[][]`. - * @see _.zip - **/ - zip(...arrays: any[][]): any[][]; - - /** - * Wrapped type `any[][]`. - * @see _.object - **/ - object(...keyValuePairs: any[][]): any; - - /** - * Wrapped type `any[]`. - * @see _.indexOf - **/ - indexOf(value: any, isSorted?: bool): number; - - /** - * Wrapped type `any[]`. - * @see _.lastIndexOf - **/ - lastIndexOf(value: any, from?: number): number; - - /** - * Wrapped type `any[]`. - * @see _.sortedIndex - **/ - sortedIndex(value: any, iterator?: (element: any) => number): number; - - /** - * Wrapped type `number`. - * @see _.range - **/ - range(stop: number, step?: number): number[]; - /** - * Wrapped type `number`. - * @see _.range - **/ - range(): number[]; - - /************ - * Functions * - *************/ - - /** - * Wrapped type `Function`. - * @see _.bind - **/ - bind(object: any, ...arguments: any[]): Function; - - - /** - * Wrapped type `object`. - * @see _.bindAll - **/ - bindAll(...methodNames: string[]): void; - - /** - * Wrapped type `Function`. - * @see _.memoize - **/ - memoize(hashFn?: (n: any) => string): Function; - - /** - * Wrapped type `Function`. - * @see _.delay - **/ - delay(waitMS: number, ...arguments: any[]): void; - - /** - * Wrapped type `Function`. - * @see _.defer - **/ - defer(...arguments: any[]): void; - - /** - * Wrapped type `Function`. - * @see _.throttle - **/ - throttle(waitMS: number): Function; - - /** - * Wrapped type `Function`. - * @see _.debounce - **/ - debounce(waitMS: number, immediate?: bool): Function; - - /** - * Wrapped type `Function`. - * @see _.once - **/ - once(): Function; - - /** - * Wrapped type `number`. - * @see _.after - **/ - after(fn: Function): Function; - - /** - * Wrapped type `Function`. - * @see _.wrap - **/ - wrap(wrapper: (fn: Function, ...args: any[]) => any): Function; - - /** - * Wrapped type `Function[]`. - * @see _.compose - **/ - compose(...functions: Function[]): Function; - - /********** - * Objects * - ***********/ - - /** - * Wrapped type `object`. - * @see _.keys - **/ - keys(): string[]; - - /** - * Wrapped type `object`. - * @see _.values - **/ - values(): any[]; - - /** - * Wrapped type `object`. - * @see _.pairs - **/ - pairs(): any[][]; - - /** - * Wrapped type `object`. - * @see _.invert - **/ - invert(): any; - - /** - * Wrapped type `object`. - * @see _.functions - **/ - functions(): string[]; - - /** - * Wrapped type `object`. - * @see _.extend - **/ - extend(...sources: any[]): any; - - /** - * Wrapped type `object`. - * @see _.pick - **/ - pick(...keys: string[]): any; - - /** - * Wrapped type `object`. - * @see _.omit - **/ - omit(...keys: string[]): any; - - /** - * Wrapped type `object`. - * @see _.defaults - **/ - defaults(...defaults: any[]): any; - - /** - * Wrapped type `object`. - * @see _.clone - **/ - clone(object: any): any; - /** - * Wrapped type `any[]`. - * @see _.clone - **/ - clone(list: any[]): any[]; - - /** - * Wrapped type `object`. - * @see _.tap - **/ - tap(intercepter: Function): any; - - /** - * Wrapped type `object`. - * @see _.has - **/ - has(key: string): bool; - - /** - * Wrapped type `object`. - * @see _.isEqual - **/ - isEqual(other: any): bool; - - /** - * Wrapped type `object`. - * @see _.isEmpty - **/ - isEmpty(object: any): bool; - /** - * Wrapped type `any[]`. - * @see _.isEmpty - **/ - isEmpty(list: any[]): bool; - - /** - * Wrapped type `object`. - * @see _.isElement - **/ - isElement(): bool; - - /** - * Wrapped type `object`. - * @see _.isArray - **/ - isArray(): bool; - - /** - * Wrapped type `object`. - * @see _.isObject - **/ - isObject(): bool; - - /** - * Wrapped type `object`. - * @see _.isArguments - **/ - isArguments(): bool; - - /** - * Wrapped type `object`. - * @see _.isFunction - **/ - isFunction(): bool; - - /** - * Wrapped type `object`. - * @see _.isString - **/ - isString(): bool; - - /** - * Wrapped type `object`. - * @see _.isNumber - **/ - isNumber(): bool; - - /** - * Wrapped type `object`. - * @see _.isFinite - **/ - isFinite(): bool; - - /** - * Wrapped type `object`. - * @see _.isBoolean - **/ - isBoolean(): bool; - - /** - * Wrapped type `object`. - * @see _.isDate - **/ - isDate(): bool; - - /** - * Wrapped type `object`. - * @see _.isRegExp - **/ - isRegExp(): bool; - - /** - * Wrapped type `object`. - * @see _.isNaN - **/ - isNaN(): bool; - - /** - * Wrapped type `object`. - * @see _.isNull - **/ - isNull(): bool; - - /** - * Wrapped type `object`. - * @see _.isUndefined - **/ - isUndefined(): bool; - - /********** - * Utility * - ***********/ - - /** - * Wrapped type `any`. - * @see _.identity - **/ - identity(): any; - - /** - * Wrapped type `number`. - * @see _.times - **/ - times(iterator: (n: number) => any, context?: any): any[]; - - /** - * Wrapped type `number`. - * @see _.random - **/ - random(): number; - /** - * Wrapped type `number`. - * @see _.random - **/ - random(max: number): number; - - /** - * Wrapped type `object`. - * @see _.mixin - **/ - mixin(): void; - - /** - * Wrapped type `string`. - * @see _.uniqueId - **/ - uniqueId(): string; - - /** - * Wrapped type `string`. - * @see _.escape - **/ - escape(): string; - - /** - * Wrapped type `object`. - * @see _.result - **/ - result(property: string): any; - - /** - * Wrapped type `string`. - * @see _.template - **/ - template(data?: any, settings?: UnderscoreTemplateSettings): any; - - /*********** - * Chaining * - ************/ - - /** - * Wrapped type `any`. - * @see _.chain - **/ - chain(): any; - - /** - * Wrapped type `any`. - * @see _.value - **/ - value(): any; -} - -declare var _: Underscore; diff --git a/underscore/underscore-typed-tests.ts b/underscore/underscore-typed-tests.ts index abe680ed1b..b04f3c213d 100644 --- a/underscore/underscore-typed-tests.ts +++ b/underscore/underscore-typed-tests.ts @@ -3,7 +3,7 @@ declare var $; _.each([1, 2, 3], (num) => alert(num.toString())); -_.each({ one: 1, two: 2, three: 3 }, (value: number, key?: string) => alert(value.toString())); +_.each({ one: 1, two: 2, three: 3 }, (value) => alert(value.toString())); _.map([1, 2, 3], (num) => num * 3); _.map({ one: 1, two: 2, three: 3 }, (value: number, key?: string) => value * 3); @@ -41,16 +41,15 @@ _.min(numbers); _.sortBy([1, 2, 3, 4, 5, 6], (num) => Math.sin(num)); -// not sure how this is typechecking at all.. Math.floor(e) is number not string..? -_([1.3, 2.1, 2.4]).groupBy((e: number, i?: number, list?: number[]) => Math.floor(e)); -_.groupBy([1.3, 2.1, 2.4], (num: number) => Math.floor(num)); +_([1.3, 2.1, 2.4]).groupBy((e, i?: number, list?: any[]) => Math.floor(e)); +_.groupBy([1.3, 2.1, 2.4], (num: number) => Math.floor(num).toString()); _.groupBy(['one', 'two', 'three'], 'length'); _.countBy([1, 2, 3, 4, 5], (num) => num % 2 == 0 ? 'even' : 'odd'); _.shuffle([1, 2, 3, 4, 5, 6]); -// (function(){ return _.toArray(arguments).slice(1); })(1, 2, 3, 4); +(function(a, b, c, d){ return _.toArray(arguments).slice(1); })(1, 2, 3, 4); _.size({ one: 1, two: 2, three: 3 }); @@ -74,7 +73,7 @@ _.intersection([1, 2, 3], [101, 2, 1, 10], [2, 1]); _.difference([1, 2, 3, 4, 5], [5, 2, 10]); _.uniq([1, 2, 1, 3, 1, 4]); _.zip(['moe', 'larry', 'curly'], [30, 40, 50], [true, false, false]); -_.object(['moe', 'larry', 'curly'], [30, 40, 50]); +var r = _.object<{ [key: string]: number }>(['moe', 'larry', 'curly'], [30, 40, 50]); _.object([['moe', 30], ['larry', 40], ['curly', 50]]); _.indexOf([1, 2, 3], 2); _.lastIndexOf([1, 2, 3, 1, 2, 3], 2); @@ -154,10 +153,20 @@ _.defaults(iceCream, { flavor: "vanilla", sprinkles: "lots" }); _.clone({ name: 'moe' }); +_([1, 2, 3, 4]) + .chain() + .filter((num: number) => { + return num % 2 == 0; + }).tap(alert) + .map((num: number) => { + return num * num; + }) + .value(); + _.chain([1, 2, 3, 200]) - .filter(function (num) { return num % 2 == 0; }) + .filter(function (num: number) { return num % 2 == 0; }) .tap(alert) - .map(function (num) { return num * num }) + .map(function (num: number) { return num * num }) .value(); _.has({ a: 1, b: 2, c: 3 }, "b"); @@ -215,6 +224,7 @@ var moe2 = { name: 'moe' }; moe2 === _.identity(moe); var genie; +var r2 = _.times(3, (n) => { return n * n }); _(3).times(function (n) { genie.grantWishNumber(n); }); _.random(0, 100); diff --git a/underscore/underscore-typed.d.ts b/underscore/underscore-typed.d.ts index 2eb1dd6eff..d892f8746c 100644 --- a/underscore/underscore-typed.d.ts +++ b/underscore/underscore-typed.d.ts @@ -24,7 +24,40 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -interface Underscore { +/************** +* OOP Wrapper * +**************/ + +/** +* Underscore OOP Wrapper, all Underscore functions that take an object +* as the first parameter can be invoked through this function. +* @param key First argument to Underscore object functions. +**/ +declare function _(value: T[]): _; +declare function _(value: T): _; + +declare module _ { + + /** + * underscore.js template settings, set templateSettings or pass as an argument + * to 'template()' to overide defaults. + **/ + interface _TemplateSettings { + /** + * Default value is '/<%([\s\S]+?)%>/g'. + **/ + evaluate?: RegExp; + + /** + * Default value is '/<%=([\s\S]+?)%>/g'. + **/ + interpolate?: RegExp; + + /** + * Default value is '/<%-([\s\S]+?)%>/g'. + **/ + escape?: RegExp; + } /************** * Collections * @@ -39,39 +72,33 @@ interface Underscore { * @param iterator Iterator function for each element `list`. * @param context 'this' object in `iterator`, optional. **/ - each( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, + export function each( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => void, context?: any): void; /** - * Iterates over a list of elements, yielding each in turn to an iterator function. The iterator is - * bound to the context object, if one is passed. Each invocation of iterator is called with three - * arguments: (element, index, list). If list is a JavaScript object, iterator's arguments will be - * (value, key, object). Delegates to the native forEach function if it exists. + * @see _.each * @param obj Iterators over this object's properties. * @param iterator Iterator function for each property on `obj`. - * @param context `this` object in the `iterator`, optional. **/ - each( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, + export function each( + obj: T, + iterator: (value: any, key?: string, obj?: T) => void, context?: any): void; /** - * Alias for 'each'. - * @see each + * @see _.each **/ - forEach( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, + export function forEach( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => void, context?: any): void; /** - * Alias for 'each'. - * @see each + * @see _.each **/ - forEach( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, + export function forEach( + obj: T, + iterator: (value: any, key?: string, obj?: T) => void, context?: any): void; /** @@ -83,40 +110,36 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return The mapped array result. **/ - map( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; + export function map( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => TResult, + context?: any): TResult[]; /** - * Produces a new array of values by mapping each value in list through a transformation function - * (iterator). If the native map method exists, it will be used instead. If list is a JavaScript - * object, iterator's arguments will be (value, key, object). - * @param list Maps the properties of this object. + * @see _.map + * @param obj Maps the properties of this object. * @param iterator Map iterator function for each property on `obj`. * @param context `this` object in `iterator`, optional. * @return The mapped object result. **/ - map( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; + export function map( + obj: T, + iterator: (value: any, key?: string, object?: Object) => TResult, + context?: any): TResult[]; /** - * Alias for 'map'. - * @see map + * @see _.map **/ - collect( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; + export function collect( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => TResult, + context?: any): TResult[]; /** - * Alias for 'map'. - * @see map + * @see _.map **/ - collect( - obj: Object, - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; + export function collect( + obj: T, + iterator: (value: any, key?: string, object?: Object) => TResult, + context?: any): TResult[]; /** * Also known as inject and foldl, reduce boils down a list of values into a single value. @@ -129,31 +152,29 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return Reduced object result. **/ - reduce( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; + export function reduce( + list: T[], + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): TResult; /** - * Alias for 'reduce'. - * @see reduce + * @see _.reduce **/ - inject( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; + export function inject( + list: T[], + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): TResult; /** - * Alias for 'reduce'. - * @see reduce + * @see _.reduce **/ - foldl( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; + export function foldl( + list: T[], + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): TResult; /** * The right-associative version of reduce. Delegates to the JavaScript 1.8 version of @@ -165,21 +186,20 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return Reduced object result. **/ - reduceRight( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; + export function reduceRight( + list: T[], + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): TResult; /** - * Alias for 'reduceRight'. - * @see reduceRight + * @see _.reduceRight **/ - foldr( - list: any[], - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; + export function foldr( + list: T[], + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): TResult; /** * Looks through each value in the list, returning the first one that passes a truth @@ -190,20 +210,18 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return The first acceptable found element in `list`, if nothing is found undefined/null is returned. **/ - find( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; + export function find( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): T; /** - * Alias for 'find'. - * @see find + * @see _.find **/ - detect( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; - + export function detect( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): T; /** * Looks through each value in the list, returning an array of all the values that pass a truth @@ -213,19 +231,18 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return The filtered list of elements. **/ - filter( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; + export function filter( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): T[]; /** - * Alias for 'filter'. - * @see filter + * @see _.filter **/ - select( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; + export function select( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): T[]; /** * Looks through each value in the list, returning an array of all the values that contain all @@ -234,7 +251,7 @@ interface Underscore { * @param properties The properties to check for on each element within `list`. * @return The elements within `list` that contain the required `properties`. **/ - where(list: any[], properties: any): any[]; + export function where(list: T[], properties: U): T[]; /** * Looks through the list and returns the first value that matches all of the key-value pairs listed in properties. @@ -242,7 +259,7 @@ interface Underscore { * @param properties Properties to look for on the elements within `list`. * @return The first element in `list` that has all `properties`. **/ - findWhere(list: any[], properties: any): any; + export function findWhere(list: T[], properties: U): T; /** * Returns the values in list without the elements that the truth test (iterator) passes. @@ -253,10 +270,10 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return The rejected list of elements. **/ - reject( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; + export function reject( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): T[]; /** * Returns true if all of the values in the list pass the iterator truth test. Delegates to the @@ -266,18 +283,17 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return True if all elements passed the truth test, otherwise false. **/ - all( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, + export function all( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => bool, context?: any): bool; /** - * Alias for 'all'. - * @see all + * @see _.all **/ - every( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, + export function every( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => bool, context?: any): bool; /** @@ -288,18 +304,17 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return True if any elements passed the truth test, otherwise false. **/ - any( - list: any[], - iterator?: (element: any, index?: number, list?: any[]) => bool, + export function any( + list: T[], + iterator?: (element: T, index?: number, list?: T[]) => bool, context?: any): bool; /** - * Alias for 'any'. - * @see any + * @see _.any **/ - some( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, + export function some( + list: T[], + iterator?: (element: T, index?: number, list?: T[]) => bool, context?: any): bool; /** @@ -309,13 +324,12 @@ interface Underscore { * @param value The value to check for within `list`. * @return True if `value` is present in `list`, otherwise false. **/ - contains(list: any[], value: any): bool; + export function contains(list: T[], value: T): bool; /** - * Alias for 'contains'. - * @see contains + * @see _.contains **/ - include(list: any[], value: any): bool; + export function include(list: T[], value: T): bool; /** * Calls the method named by methodName on each value in the list. Any extra arguments passed to @@ -324,7 +338,7 @@ interface Underscore { * @param methodName The method's name to call on each element within `list`. * @param arguments Additional arguments to pass to the method `methodName`. **/ - invoke(list: any[], methodName: string, ...arguments: any[]): void; + export function invoke(list: T[], methodName: string, ...arguments: any[]): void; /** * A convenient version of what is perhaps the most common use-case for map: extracting a list of @@ -333,14 +347,14 @@ interface Underscore { * @param propertyName The property to look for on each element within `list`. * @return The list of elements within `list` that have the property `propertyName`. **/ - pluck(list: any[], propertyName: string): any[]; + export function pluck(list: T[], propertyName: string): T[]; /** * Returns the maximum value in list. * @param list Finds the maximum value in this list. * @return Maximum value in `list`. **/ - max(list: number[]): number; + export function max(list: number[]): number; /** * Returns the maximum value in list. If iterator is passed, it will be used on each value to generate * the criterion by which the value is ranked. @@ -349,17 +363,17 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return The maximum element within `list`. **/ - max( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): any; + export function max( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => number, + context?: any): T; /** * Returns the minimum value in list. * @param list Finds the minimum value in this list. * @return Minimum value in `list`. **/ - min(list: number[]): number; + export function min(list: number[]): number; /** * Returns the minimum value in list. If iterator is passed, it will be used on each value to generate * the criterion by which the value is ranked. @@ -368,10 +382,10 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return The minimum element within `list`. **/ - min( - list: any[], - iterator: (obj: any, index?: number, list?: any[]) => number, - context?: any): any; + export function min( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => number, + context?: any): T; /** * Returns a sorted copy of list, ranked in ascending order by the results of running each value @@ -381,22 +395,18 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return A sorted copy of `list`. **/ - sortBy( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; + export function sortBy( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => TSort, + context?: any): T[]; /** - * Returns a sorted copy of list, ranked in ascending order by the results of running each value - * through iterator. Iterator may also be the string name of the property to sort by (eg. length). - * @param list Sorts this list. + * @see _.sortBy * @param iterator Sort iterator for each element within `list`. - * @param context `this` object in `iterator`, optional. - * @return A sorted copy of `list`. **/ - sortBy( - list: any[], + export function sortBy( + list: T[], iterator: string, - context?: any): any[]; + context?: any): T[]; /** * Splits a collection into sets, grouped by the result of running each value through iterator. @@ -407,23 +417,21 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return An object with the group names as properties where each property contains the grouped elements from `list`. **/ - groupBy( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => string, + export function groupBy( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => string, context?: any): { [key: string]: any[]; }; + // todo: return should be { [key: string]: T[]; }; + /** - * Splits a collection into sets, grouped by the result of running each value through iterator. - * If iterator is a string instead of a function, groups by the property named by iterator on - * each of the values. - * @param list Groups this list. + * @see _.groupBy * @param iterator Group iterator for each element within `list`, return the key to group the element by. - * @param context `this` object in `iterator`, optional. - * @return An object with the group names as properties where each property contains the grouped elements from `list`. **/ - groupBy( - list: any[], + export function groupBy( + list: T[], iterator: string, context?: any): { [key: string]: any[]; }; + // todo: return should be { [key: string]: T[]; }; /** * Sorts a list into groups and returns a count for the number of objects in each group. Similar @@ -434,9 +442,9 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return An object with the group names as properties where each property contains the number of elements in that group. **/ - countBy( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => string, + export function countBy( + list: T[], + iterator: (element: T, index?: number, list?: T[]) => string, context?: any): { [key: string]: number; }; /** * Sorts a list into groups and returns a count for the number of objects in each group. Similar @@ -447,8 +455,8 @@ interface Underscore { * @param context `this` object in `iterator`, optional. * @return An object with the group names as properties where each property contains the number of elements in that group. **/ - countBy( - list: any[], + export function countBy( + list: T[], iterator: string, context?: any): { [key: string]: number; }; @@ -457,7 +465,7 @@ interface Underscore { * @param list List to shuffle. * @return Shuffled copy of `list`. **/ - shuffle(list: any[]): any[]; + export function shuffle(list: T[]): T[]; /** * Converts the list (anything that can be iterated over), into a real Array. Useful for transmuting @@ -465,14 +473,14 @@ interface Underscore { * @param list object to transform into an array. * @return `list` as an array. **/ - toArray(list: any): any[]; + export function toArray(list: any): any[]; /** * Return the number of values in the list. * @param list Count the number of values/elements in this list. * @return Number of values in `list`. **/ - size(list: any): number; + export function size(list: any): number; /********* * Arrays * @@ -483,36 +491,30 @@ interface Underscore { * @param array Retrieves the first element of this array. * @return Returns the first element of `array`. **/ - first(array: any[]): any; + export function first(array: T[]): T; /** - * Returns the first element of an array. Passing n will return the first n elements of the array. - * @param array Retreives the first `n` elements of this array. + * @see _.first * @param n Return more than one element from `array`. - * @return Returns the first `n` elements from `array. **/ - first(array: any[], n: number): any[]; + export function first(array: T[], n: number): T[]; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - head(array: any[]): any; + export function head(array: T[]): T; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - head(array: any[], n: number): any[]; + export function head(array: T[], n: number): T[]; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - take(array: any[]): any; + export function take(array: T[]): T; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - take(array: any[], n: number): any[]; + export function take(array: T[], n: number): T[]; /** * Returns everything but the last entry of the array. Especially useful on the arguments object. @@ -521,21 +523,19 @@ interface Underscore { * @param n Leaves this many elements behind, optional. * @return Returns everything but the last `n` elements of `array`. **/ - initial(array: any[], n?: number): any[]; + export function initial(array: T[], n?: number): T[]; /** * Returns the last element of an array. Passing n will return the last n elements of the array. * @param array Retrieves the last element of this array. * @return Returns the last element of `array`. **/ - last(array: any[]): any; + export function last(array: T[]): T; /** - * Returns the last element of an array. Passing n will return the last n elements of the array. - * @param array Retreives the last `n` elements of this array. + * @see _.last * @param n Return more than one element from `array`. - * @return Returns the last `n` elements from `array. **/ - last(array: any[], n: number): any[]; + export function last(array: T[], n: number): T[]; /** * Returns the rest of the elements in an array. Pass an index to return the values of the array @@ -544,19 +544,17 @@ interface Underscore { * @param index The index to start retrieving elements forward from, optional, default = 1. * @return Returns the elements of `array` from `index` to the end of `array`. **/ - rest(array: any[], index?: number): any[]; + export function rest(array: T[], index?: number): T[]; /** - * Alias for 'rest'. - * @see rest + * @see _.rest **/ - tail(array: any[], index?: number): any[]; + export function tail(array: T[], index?: number): T[]; /** - * Alias for 'rest'. - * @see rest + * @see _.rest **/ - drop(array: any[], index?: number): any[]; + export function drop(array: T[], index?: number): T[]; /** * Returns a copy of the array with all falsy values removed. In JavaScript, false, null, 0, "", @@ -564,7 +562,7 @@ interface Underscore { * @param array Array to compact. * @return Copy of `array` without false values. **/ - compact(array: any[]): any[]; + export function compact(array: T[]): T[]; /** * Flattens a nested array (the nesting can be to any depth). If you pass shallow, the array will @@ -573,7 +571,7 @@ interface Underscore { * @param shallow If true then only flatten one level, optional, default = false. * @return `array` flattened. **/ - flatten(array: any, shallow?: bool): any; + export function flatten(array: any, shallow?: bool): any; /** * Returns a copy of the array with all instances of the values removed. @@ -581,7 +579,7 @@ interface Underscore { * @param values The values to remove from `array`. * @return Copy of `array` without `values`. **/ - without(array: any[], ...values: any[]): any[]; + export function without(array: T[], ...values: T[]): T[]; /** * Computes the union of the passed-in arrays: the list of unique items, in order, that are @@ -589,7 +587,7 @@ interface Underscore { * @param arrays Array of arrays to compute the union of. * @return The union of elements within `arrays`. **/ - union(...arrays: any[][]): any[]; + export function union(...arrays: T[][]): T[]; /** * Computes the list of values that are the intersection of all the arrays. Each value in the result @@ -597,7 +595,7 @@ interface Underscore { * @param arrays Array of arrays to compute the intersection of. * @return The intersection of elements within `arrays`. **/ - intersection(...arrays: any[][]): any[]; + export function intersection(...arrays: T[][]): T[]; /** * Similar to without, but returns the values from array that are not present in the other arrays. @@ -605,7 +603,7 @@ interface Underscore { * @param others The values to keep within `array`. * @return Copy of `array` with only `others` values. **/ - difference(array: any[], ...others: any[]): any[]; + export function difference(array: T[], ...others: T[][]): T[]; /** * Produces a duplicate-free version of the array, using === to test object equality. If you know in @@ -617,32 +615,34 @@ interface Underscore { * @param context 'this' object in `iterator`, optional. * @return Copy of `array` where all elements are unique. **/ - uniq( - array: any[], + export function uniq( + array: T[], isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): T[]; /** - * Produces a duplicate-free version of the array, using === to test object equality. If you know in - * advance that the array is sorted, passing true for isSorted will run a much faster algorithm. If - * you want to compute unique items based on a transformation, pass an iterator function. - * @param array Array to remove duplicates from. - * @param iterator Transform the elements of `array` before comparisons for uniqueness. - * @param context 'this' object in `iterator`, optional. - * @return Copy of `array` where all elements are unique. + * @see _.unq **/ - uniq( - array: any[], - iterator?: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; + export function uniq( + array: T[], + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): T[]; /** - * Alias for 'uniq'. - * @see uniq + * @see _.uniq **/ - unique(array: any[], + export function unique( + array: T[], isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any): any[]; + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): T[]; + /** + * @see _.unq + **/ + export function unique( + array: T[], + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): T[]; /** * Merges together the values of each of the arrays with the values at the corresponding position. @@ -651,7 +651,7 @@ interface Underscore { * @param arrays The arrays to merge/zip. * @return Zipped version of `arrays`. **/ - zip(...arrays: any[][]): any[][]; + export function zip(...arrays: any[][]): any[][]; /** * Converts arrays into objects. Pass either a single list of [key, value] pairs, or a @@ -660,14 +660,14 @@ interface Underscore { * @param values Value array. * @return An object containing the `keys` as properties and `values` as the property values. **/ - object(keys: string[], values: any[]): any; + export function object(keys: string[], values: any[]): TResult; /** * Converts arrays into objects. Pass either a single list of [key, value] pairs, or a * list of keys, and a list of values. * @param keyValuePairs Array of [key, value] pairs. * @return An object containing the `keys` as properties and `values` as the property values. **/ - object(...keyValuePairs: any[][]): any; + export function object(...keyValuePairs: any[][]): TResult; /** * Returns the index at which value can be found in the array, or -1 if value is not present in the array. @@ -679,7 +679,7 @@ interface Underscore { * @param isSorted True if the array is already sorted, optional, default = false. * @return The index of `value` within `array`. **/ - indexOf(array: any[], value: any, isSorted?: bool): number; + export function indexOf(array: T[], value: T, isSorted?: bool): number; /** * Returns the index of the last occurrence of value in the array, or -1 if value is not present. Uses the @@ -689,7 +689,7 @@ interface Underscore { * @param from The starting index for the search, optional. * @return The index of the last occurance of `value` within `array`. **/ - lastIndexOf(array: any[], value: any, from?: number): number; + export function lastIndexOf(array: T[], value: T, from?: number): number; /** * Uses a binary search to determine the index at which the value should be inserted into the list in order @@ -700,7 +700,7 @@ interface Underscore { * @param iterator Iterator to compute the sort ranking of each value, optional. * @return The index where `value` should be inserted into `list`. **/ - sortedIndex(list: any[], value: any, iterator?: (element: any) => number): number; + export function sortedIndex(list: T[], value: T, iterator?: (element: T) => number): number; /** * A function to create flexibly-numbered lists of integers, handy for each and map loops. start, if omitted, @@ -711,7 +711,7 @@ interface Underscore { * @param step The number to count up by each iteration, optional, default = 1. * @return Array of numbers from `start` to `stop` with increments of `step`. **/ - range(start: number, stop: number, step?: number): number[]; + export function range(start: number, stop: number, step?: number): number[]; /** * A function to create flexibly-numbered lists of integers, handy for each and map loops. start, if omitted, * defaults to 0; step defaults to 1. Returns a list of integers from start to stop, incremented (or decremented) @@ -720,7 +720,7 @@ interface Underscore { * @return Array of numbers from 0 to `stop` with increments of 1. * @note If start is not specified the implementation will never pull the step (step = arguments[2] || 0) **/ - range(stop: number): number[]; + export function range(stop: number): number[]; /************ * Functions * @@ -734,8 +734,7 @@ interface Underscore { * @param arguments Additional arguments to pass to `fn` when called. * @return `fn` with `this` bound to `object`. **/ - bind(fn: Function, object: any, ...arguments: any[]): Function; - + export function bind(fn: Function, object: any, ...arguments: any[]): Function; /** * Binds a number of methods on the object, specified by methodNames, to be run in the context of that object @@ -746,7 +745,7 @@ interface Underscore { * @param methodNames The methods to bind to `object`, optional and if not provided all of `object`'s * methods are bound. **/ - bindAll(object: any, ...methodNames: string[]): void; + export function bindAll(object: any, ...methodNames: string[]): void; /** * Partially apply a function by filling in any number of its arguments, without changing its dynamic this value. @@ -755,7 +754,7 @@ interface Underscore { * @param arguments The partial arguments. * @return `fn` with partially filled in arguments. **/ - partial(fn: Function, ...arguments: any[]): Function; + export function partial(fn: Function, ...arguments: any[]): Function; /** * Memoizes a given function by caching the computed result. Useful for speeding up slow-running computations. @@ -766,7 +765,7 @@ interface Underscore { * @param hashFn Hash function for storing the result of `fn`. * @return Memoized version of `fn`. **/ - memoize(fn: Function, hashFn?: (n: any) => string): Function; + export function memoize(fn: Function, hashFn?: (n: any) => string): Function; /** * Much like setTimeout, invokes function after wait milliseconds. If you pass the optional arguments, @@ -775,7 +774,7 @@ interface Underscore { * @param waitMS The amount of milliseconds to delay `fn`. * @arguments Additional arguments to pass to `fn`. **/ - delay(fn: Function, waitMS: number, ...arguments: any[]): void; + export function delay(fn: Function, waitMS: number, ...arguments: any[]): void; /** * Defers invoking the function until the current call stack has cleared, similar to using setTimeout @@ -785,7 +784,7 @@ interface Underscore { * @param fn The function to defer. * @param arguments Additional arguments to pass to `fn`. **/ - defer(fn: Function, ...arguments: any[]): void; + export function defer(fn: Function, ...arguments: any[]): void; /** * Creates and returns a new, throttled version of the passed function, that, when invoked repeatedly, @@ -795,7 +794,7 @@ interface Underscore { * @param waitMS The number of milliseconds to wait before `fn` can be invoked again. * @return `fn` with a throttle of `waitMS`. **/ - throttle(fn: Function, waitMS: number): Function; + export function throttle(fn: Function, waitMS: number): Function; /** * Creates and returns a new debounced version of the passed function that will postpone its execution @@ -811,7 +810,7 @@ interface Underscore { * @param immediate True if `fn` should be invoked on the leading edge of `waitMS` instead of the trailing edge. * @return Debounced version of `fn` that waits `waitMS` ms when invoked. **/ - debounce(fn: Function, waitMS: number, immediate?: bool): Function; + export function debounce(fn: Function, waitMS: number, immediate?: bool): Function; /** * Creates a version of the function that can only be called one time. Repeated calls to the modified @@ -820,7 +819,7 @@ interface Underscore { * @param fn Function to only execute once. * @return Copy of `fn` that can only be invoked once. **/ - once(fn: Function): Function; + export function once(fn: Function): Function; /** * Creates a version of the function that will only be run after first being called count times. Useful @@ -830,7 +829,7 @@ interface Underscore { * @fn The function to defer execution `count` times. * @return Copy of `fn` that will not execute until it is invoked `count` times. **/ - after(count: number, fn: Function): Function; + export function after(count: number, fn: Function): Function; /** * Wraps the first function inside of the wrapper function, passing it as the first argument. This allows @@ -840,7 +839,7 @@ interface Underscore { * @param wrapper The function that will wrap `fn`. * @return Wrapped version of `fn. **/ - wrap(fn: Function, wrapper: (fn: Function, ...args: any[]) => any): Function; + export function wrap(fn: Function, wrapper: (fn: Function, ...args: any[]) => any): Function; /** * Returns the composition of a list of functions, where each function consumes the return value of the @@ -848,7 +847,7 @@ interface Underscore { * @param functions List of functions to compose. * @return Composition of `functions`. **/ - compose(...functions: Function[]): Function; + export function compose(...functions: Function[]): Function; /********** * Objects * @@ -859,21 +858,21 @@ interface Underscore { * @param object Retreive the key or property names from this object. * @return List of all the property names on `object`. **/ - keys(object: any): string[]; + export function keys(object: T): string[]; /** * Return all of the values of the object's properties. * @param object Retreive the values of all the properties on this object. * @return List of all the values on `object`. **/ - values(object: any): any[]; + export function values(object: T): any[]; /** * Convert an object into a list of [key, value] pairs. * @param object Convert this object to a list of [key, value] pairs. * @return List of [key, value] pairs on `object`. **/ - pairs(object: any): any[][]; + export function pairs(object: T): any[][]; /** * Returns a copy of the object where the keys have become the values and the values the keys. @@ -881,15 +880,15 @@ interface Underscore { * @param object Object to invert key/value pairs. * @return An inverted key/value paired version of `object`. **/ - invert(object: any): any; + export function invert(object: T): TResult; /** - * Returns a sorted list of the names of every method in an object � that is to say, + * Returns a sorted list of the names of every method in an object - that is to say, * the name of every function property of the object. * @param object Object to pluck all function property names from. * @return List of all the function names on `object`. **/ - functions(object: any): string[]; + export function functions(object: T): string[]; /** * Copy all of the properties in the source objects over to the destination object, and return @@ -899,7 +898,7 @@ interface Underscore { * @param sources Extends `destination` with all properties from these source objects. * @return `destination` extended with all the properties from the `sources` objects. **/ - extend(destination: any, ...sources: any[]): any; + export function extend(destination: any, ...sources: any[]): any; /** * Return a copy of the object, filtered to only have values for the whitelisted keys @@ -908,7 +907,7 @@ interface Underscore { * @keys The key/value pairs to keep on `object`. * @return Copy of `object` with only the `keys` properties. **/ - pick(object: any, ...keys: string[]): any; + export function pick(object: T, ...keys: string[]): TResult; /** * Return a copy of the object, filtered to omit the blacklisted keys (or array of keys). @@ -916,7 +915,7 @@ interface Underscore { * @param keys The key/value pairs to remove on `object`. * @return Copy of `object` without the `keys` properties. **/ - omit(object: any, ...keys: string[]): any; + export function omit(object: T, ...keys: string[]): TResult; /** * Fill in null and undefined properties in object with values from the defaults objects, @@ -925,7 +924,7 @@ interface Underscore { * @param defaults The default values to add to `object`. * @return `object` with added `defaults` values. **/ - defaults(object: any, ...defaults: any[]): any; + export function defaults(object: any, ...defaults: any[]): any; /** * Create a shallow-copied clone of the object. @@ -933,14 +932,13 @@ interface Underscore { * @param object Object to clone. * @return Copy of `object`. **/ - clone(object: any): any; + export function clone(object: T): T; /** - * Create a shallow-copied clone of the object. - * Any nested objects or arrays will be copied by reference, not duplicated. + * @see _.clone * @param list List to clone. * @return Copy of `list`. **/ - clone(list: any[]): any[]; + export function clone(list: T[]): T[]; /** * Invokes interceptor with the object, and then returns object. The primary purpose of this method @@ -949,7 +947,7 @@ interface Underscore { * @param intercepter The function to modify `object` before continuing the method chain. * @return Modified `object`. **/ - tap(object: any, intercepter: Function): any; + export function tap(object: T, intercepter: Function): T; /** * Does the object contain the given key? Identical to object.hasOwnProperty(key), but uses a safe @@ -958,7 +956,7 @@ interface Underscore { * @param key The key to check for on `object`. * @return True if `key` is a property on `object`, otherwise false. **/ - has(object: any, key: string): bool; + export function has(object: T, key: string): bool; /** * Performs an optimized deep comparison between the two objects, @@ -967,34 +965,34 @@ interface Underscore { * @param other Compare to `object`. * @return True if `object` is equal to `other`. **/ - isEqual(object: any, other: any): bool; + export function isEqual(object: any, other: any): bool; /** * Returns true if object contains no values. * @param object Check if this object has no properties or values. * @return True if `object` is empty. **/ - isEmpty(object: any): bool; + export function isEmpty(object: any): bool; /** * Returns true if the list contains no values. * @param object Check if this list has no elements. * @return True if `list` is empty. **/ - isEmpty(list: any[]): bool; + export function isEmpty(list: any[]): bool; /** * Returns true if object is a DOM element. * @param object Check if this object is a DOM element. * @return True if `object` is a DOM element, otherwise false. **/ - isElement(object: any): bool; + export function isElement(object: any): bool; /** * Returns true if object is an Array. * @param object Check if this object is an Array. * @return True if `object` is an Array, otherwise false. **/ - isArray(object: any): bool; + export function isArray(object: any): bool; /** * Returns true if value is an Object. Note that JavaScript arrays and functions are objects, @@ -1002,63 +1000,63 @@ interface Underscore { * @param object Check if this object is an Object. * @return True of `object` is an Object, otherwise false. **/ - isObject(object: any): bool; + export function isObject(object: any): bool; /** * Returns true if object is an Arguments object. * @param object Check if this object is an Arguments object. * @return True if `object` is an Arguments object, otherwise false. **/ - isArguments(object: any): bool; + export function isArguments(object: any): bool; /** * Returns true if object is a Function. * @param object Check if this object is a Function. * @return True if `object` is a Function, otherwise false. **/ - isFunction(object: any): bool; + export function isFunction(object: any): bool; /** * Returns true if object is a String. * @param object Check if this object is a String. * @return True if `object` is a String, otherwise false. **/ - isString(object: any): bool; + export function isString(object: any): bool; /** * Returns true if object is a Number (including NaN). * @param object Check if this object is a Number. * @return True if `object` is a Number, otherwise false. **/ - isNumber(object: any): bool; + export function isNumber(object: any): bool; /** * Returns true if object is a finite Number. * @param object Check if this object is a finite Number. * @return True if `object` is a finite Number. **/ - isFinite(object: any): bool; + export function isFinite(object: any): bool; /** * Returns true if object is either true or false. * @param object Check if this object is a bool. * @return True if `object` is a bool, otherwise false. **/ - isBoolean(object: any): bool; + export function isBoolean(object: any): bool; /** * Returns true if object is a Date. * @param object Check if this object is a Date. * @return True if `object` is a Date, otherwise false. **/ - isDate(object: any): bool; + export function isDate(object: any): bool; /** * Returns true if object is a RegExp. * @param object Check if this object is a RegExp. * @return True if `object` is a RegExp, otherwise false. **/ - isRegExp(object: any): bool; + export function isRegExp(object: any): bool; /** * Returns true if object is NaN. @@ -1067,21 +1065,21 @@ interface Underscore { * @param object Check if this object is NaN. * @return True if `object` is NaN, otherwise false. **/ - isNaN(object: any): bool; + export function isNaN(object: any): bool; /** * Returns true if the value of object is null. * @param object Check if this object is null. * @return True if `object` is null, otherwise false. **/ - isNull(object: any): bool; + export function isNull(object: any): bool; /** * Returns true if value is undefined. * @param object Check if this object is undefined. * @return True if `object` is undefined, otherwise false. **/ - isUndefined(object: any): bool; + export function isUndefined(object: any): bool; /********** * Utility * @@ -1092,7 +1090,7 @@ interface Underscore { * Returns a reference to the Underscore object. * @return Underscore object reference. **/ - noConflict(): Underscore; + export function noConflict(): any; /** * Returns the same value that is used as the argument. In math: f(x) = x @@ -1100,8 +1098,8 @@ interface Underscore { * @param value Identity of this object. * @return `value`. **/ - identity(value: any): any; - + export function identity(value: T): T; + /** * Invokes the given iterator function n times. * Each invocation of iterator is called with an index argument @@ -1109,7 +1107,7 @@ interface Underscore { * @param iterator Function iterator to invoke `n` times. * @param context `this` object in `iterator`, optional. **/ - times(n: number, iterator: (n: number) => any , context?: any): any[]; + export function times(n: number, iterator: (n: number) => TResult , context?: any): TResult[]; /** * Returns a random integer between min and max, inclusive. If you only pass one argument, @@ -1117,7 +1115,7 @@ interface Underscore { * @param max The maximum random number. * @return A random number between 0 and `max`. **/ - random(max: number): number; + export function random(max: number): number; /** * Returns a random integer between min and max, inclusive. If you only pass one argument, * it will return a number between 0 and that number. @@ -1125,7 +1123,7 @@ interface Underscore { * @param max The maximum random number. * @return A random number between `min` and `max`. **/ - random(min: number, max: number): number; + export function random(min: number, max: number): number; /** * Allows you to extend Underscore with your own utility functions. Pass a hash of @@ -1133,28 +1131,28 @@ interface Underscore { * as well as the OOP wrapper. * @param object Mixin object containing key/function pairs to add to the Underscore object. **/ - mixin(object: any): void; + export function mixin(object: any): void; /** * Generate a globally-unique id for client-side models or DOM elements that need one. * If prefix is passed, the id will be appended to it. Without prefix, returns an integer. * @return Unique number ID. **/ - uniqueId(): number; + export function uniqueId(): number; /** * Generate a globally-unique id for client-side models or DOM elements that need one. * If prefix is passed, the id will be appended to it. Without prefix, returns an integer. * @param prefix A prefix string to start the unique ID with. * @return Unique string ID beginning with `prefix`. **/ - uniqueId(prefix: string): string; + export function uniqueId(prefix: string): string; /** * Escapes a string for insertion into HTML, replacing &, <, >, ", ', and / characters. * @param str Raw string to escape. * @return `str` HTML escaped. **/ - escape(str: string): string; + export function escape(str: string): string; /** * If the value of the named property is a function then invoke it; otherwise, return it. @@ -1162,13 +1160,13 @@ interface Underscore { * @param property The function by name to invoke on `object`. * @return The result of invoking the function `property` on `object. **/ - result(object: any, property: string): any; + export function result(object: any, property: string): any; /** * Compiles JavaScript templates into functions that can be evaluated for rendering. Useful * for rendering complicated bits of HTML from JSON data sources. Template functions can both - * interpolate variables, using <%= � %>, as well as execute arbitrary JavaScript code, with - * <% � %>. If you wish to interpolate a value, and have it be HTML-escaped, use <%- � %> When + * interpolate variables, using <%= ... %>, as well as execute arbitrary JavaScript code, with + * <% ... %>. If you wish to interpolate a value, and have it be HTML-escaped, use <%- ... %> When * you evaluate a template function, pass in a data object that has properties corresponding to * the template's free variables. If you're writing a one-off, you can pass the data object as * the second parameter to template in order to render immediately instead of returning a template @@ -1179,13 +1177,13 @@ interface Underscore { * @param settings Settings to use while compiling. * @return Returns the compiled Underscore HTML template. **/ - template(templateString: string, data?: any, settings?: UnderscoreTemplateSettings): any; + export function template(templateString: string, data?: any, settings?: _TemplateSettings): any; /** * By default, Underscore uses ERB-style template delimiters, change the * following template settings to use alternative delimiters. **/ - templateSettings: UnderscoreTemplateSettings; + export var templateSettings: _TemplateSettings; /*********** * Chaining * @@ -1197,49 +1195,17 @@ interface Underscore { * @param obj Object to chain. * @return Wrapped `obj`. **/ - chain(obj: any): UnderscoreChain; + export function chain(obj: any): _Chain; /** * Extracts the value of a wrapped object. * @param obj Wrapped object to extract the value from. * @return Value of `obj`. **/ - value(obj: any): any; - - /************** - * OOP Wrapper * - **************/ - - /** - * Underscore OOP Wrapper, all Underscore functions that take an object - * as the first parameter can be invoked through this function. - * @param key First argument to Underscore object functions. - **/ - (obj: any): UnderscoreOOPWrapper; + export function value(obj: T): TResult; } -/** -* underscore.js template settings, set templateSettings or pass as an argument -* to 'template()' to overide defaults. -**/ -interface UnderscoreTemplateSettings { - /** - * Default value is '/<%([\s\S]+?)%>/g'. - **/ - evaluate?: RegExp; - - /** - * Default value is '/<%=([\s\S]+?)%>/g'. - **/ - interpolate?: RegExp; - - /** - * Default value is '/<%-([\s\S]+?)%>/g'. - **/ - escape?: RegExp; -} - -interface UnderscoreOOPWrapper { +declare class _ { /************** * Collections * @@ -1250,174 +1216,160 @@ interface UnderscoreOOPWrapper { * @see _.each **/ each( - iterator: (element: any, index?: number, list?: any[]) => any, + iterator: (element: T, index?: number, list?: T[]) => void, context?: any): void; /** - * Wrapped type `object`. * @see _.each **/ each( - iterator: (value: any, key?: string, object?: Object) => any, + iterator: (value: any, key?: string, object?: T) => void, context?: any): void; /** - * Alias for 'each'. - * @see each + * @see _.each **/ forEach( - iterator: (element: any, index?: number, list?: any[]) => any, + iterator: (element: T, index?: number, list?: T[]) => void , context?: any): void; /** - * Alias for 'each'. - * @see each + * @see _.each **/ forEach( - iterator: (value: any, key?: string, object?: Object) => any, + iterator: (value: any, key?: string, object?: T) => any, context?: any): void; /** * Wrapped type `any[]`. * @see _.map **/ - map( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; + map( + iterator: (element: T, index?: number, list?: T[]) => TResult, + context?: any): TResult[]; /** - * Wrapped type `object`. * @see _.map **/ - map( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; + map( + iterator: (value: any, key?: string, object?: T) => TResult, + context?: any): TResult[]; /** - * Alias for 'map'. - * @see map + * @see _.map **/ - collect( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; + collect( + iterator: (element: T, index?: number, list?: T[]) => TResult, + context?: any): TResult[]; /** - * Alias for 'map'. - * @see map + * @see _.map **/ - collect( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): any[]; + collect( + iterator: (value: any, key?: string, object?: T) => TResult, + context?: any): TResult[]; /** * Wrapped type `any[]`. * @see _.reduce **/ - reduce( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; + reduce( + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): TResult; /** - * Alias for 'reduce'. - * @see reduce + * @see _.reduce **/ - inject( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; + inject( + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): TResult; /** - * Alias for 'reduce'. - * @see reduce + * @see _.reduce **/ - foldl( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; + foldl( + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): TResult; /** * Wrapped type `any[]`. * @see _.reduceRight **/ - reduceRight( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; + reduceRight( + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): TResult; /** - * Alias for 'reduceRight'. - * @see reduceRight + * @see _.reduceRight **/ - foldr( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): any; + foldr( + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): TResult; /** * Wrapped type `any[]`. * @see _.find **/ find( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): T; /** - * Alias for 'find'. - * @see find + * @see _.find **/ detect( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any; - + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): T; /** * Wrapped type `any[]`. * @see _.filter **/ filter( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): T[]; /** - * Alias for 'filter'. - * @see filter + * @see _.filter **/ select( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): T[]; /** * Wrapped type `any[]`. * @see _.where **/ - where(list: any[], properties: any): any[]; + where(properties: U): T[]; /** * Wrapped type `any[]`. * @see _.findWhere **/ - findWhere(properties: any): any; + findWhere(properties: U): T; /** * Wrapped type `any[]`. * @see _.reject **/ reject( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): any[]; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): T[]; /** * Wrapped type `any[]`. * @see _.all **/ all( - iterator: (element: any, index?: number, list?: any[]) => bool, + iterator: (element: T, index?: number, list?: T[]) => bool, context?: any): bool; /** - * Alias for 'all'. - * @see all + * @see _.all **/ every( - iterator: (element: any, index?: number, list?: any[]) => bool, + iterator: (element: T, index?: number, list?: T[]) => bool, context?: any): bool; /** @@ -1425,17 +1377,14 @@ interface UnderscoreOOPWrapper { * @see _.any **/ any( - list: any[], - iterator?: (element: any, index?: number, list?: any[]) => bool, + iterator?: (element: T, index?: number, list?: T[]) => bool, context?: any): bool; /** - * Alias for 'any'. - * @see any + * @see _.any **/ some( - list: any[], - iterator: (element: any, index?: number, list?: any[]) => bool, + iterator: (element: T, index?: number, list?: T[]) => bool, context?: any): bool; /** @@ -1472,8 +1421,8 @@ interface UnderscoreOOPWrapper { * @see _.max **/ max( - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): any; + iterator: (element: T, index?: number, list?: T[]) => number, + context?: any): T; /** * Wrapped type `number[]`. @@ -1485,45 +1434,46 @@ interface UnderscoreOOPWrapper { * @see _.min **/ min( - iterator: (obj: any, index?: number, list?: any[]) => number, - context?: any): any; + iterator: (element: T, index?: number, list?: T[]) => number, + context?: any): T; /** * Wrapped type `any[]`. * @see _.sortBy **/ - sortBy( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; + sortBy( + iterator: (element: T, index?: number, list?: T[]) => TSort, + context?: any): T[]; /** * Wrapped type `any[]`. * @see _.sortBy **/ sortBy( iterator: string, - context?: any): any[]; + context?: any): T[]; + + /** + * Wrapped type `any[]`. + * @see _.groupBy + **/ + groupBy( + iterator: (element: any, index?: number, list?: any[]) => TSort, + context?: any): { [key: string]: T[]; }; /** * Wrapped type `any[]`. * @see _.groupBy **/ - groupBy( - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): { [key: string]: any[]; }; - /** - * Wrapped type `any[]`. - * @see _.groupBy - **/ groupBy( iterator: string, - context?: any): { [key: string]: any[]; }; + context?: any): { [key: string]: T[]; }; /** * Wrapped type `any[]`. * @see _.countBy **/ countBy( - iterator: (element: any, index?: number, list?: any[]) => string, + iterator: (element: T, index?: number, list?: T[]) => string, context?: any): { [key: string]: number; }; /** * Wrapped type `any[]`. @@ -1537,13 +1487,13 @@ interface UnderscoreOOPWrapper { * Wrapped type `any[]`. * @see _.shuffle **/ - shuffle(): any[]; + shuffle(): T[]; /** * Wrapped type `any`. * @see _.toArray **/ - toArray(): any[]; + toArray(): T[]; /** * Wrapped type `any`. @@ -1559,75 +1509,69 @@ interface UnderscoreOOPWrapper { * Wrapped type `any[]`. * @see _.first **/ - first(): any; + first(): T; /** * Wrapped type `any[]`. * @see _.first **/ - first(n: number): any[]; + first(n: number): T[]; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - head(): any; + head(): T; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - head(n: number): any[]; + head(n: number): T[]; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - take(): any; + take(): T; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - take(n: number): any[]; + take(n: number): T[]; /** * Wrapped type `any[]`. * @see _.initial **/ - initial(n?: number): any[]; + initial(n?: number): T[]; /** * Wrapped type `any[]`. * @see _.last **/ - last(): any; + last(): T; /** * Wrapped type `any[]`. * @see _.last **/ - last(n: number): any[]; + last(n: number): T[]; /** * Wrapped type `any[]`. * @see _.rest **/ - rest(index?: number): any[]; + rest(index?: number): T[]; /** - * Alias for 'rest'. - * @see rest + * @see _.rest **/ - tail(index?: number): any[]; + tail(index?: number): T[]; /** - * Alias for 'rest'. - * @see rest + * @see _.rest **/ - drop(index?: number): any[]; + drop(index?: number): T[]; /** * Wrapped type `any[]`. * @see _.compact **/ - compact(): any[]; + compact(): T[]; /** * Wrapped type `any`. @@ -1639,49 +1583,55 @@ interface UnderscoreOOPWrapper { * Wrapped type `any[]`. * @see _.without **/ - without(...values: any[]): any[]; + without(...values: T[]): T[]; /** * Wrapped type `any[][]`. * @see _.union **/ - union(...arrays: any[][]): any[]; + union(...arrays: T[][]): T[]; /** * Wrapped type `any[][]`. * @see _.intersection **/ - intersection(...arrays: any[][]): any[]; + intersection(...arrays: T[][]): T[]; /** * Wrapped type `any[]`. * @see _.difference **/ - difference(...others: any[]): any[]; + difference(...others: T[][]): T[]; /** * Wrapped type `any[]`. * @see _.uniq **/ - uniq( + uniq( isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): T[]; /** * Wrapped type `any[]`. * @see _.uniq **/ - uniq( - iterator?: (element: any, index?: number, list?: any[]) => any, - context?: any): any[]; + uniq( + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): T[]; /** - * Alias for 'uniq'. - * @see uniq + * @see _.uniq **/ - unique( + unique( isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any): any[]; + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): T[]; + /** + * @see _.uniq + **/ + unique( + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): T[]; /** * Wrapped type `any[][]`. @@ -1699,19 +1649,19 @@ interface UnderscoreOOPWrapper { * Wrapped type `any[]`. * @see _.indexOf **/ - indexOf(value: any, isSorted?: bool): number; + indexOf(value: T, isSorted?: bool): number; /** * Wrapped type `any[]`. * @see _.lastIndexOf **/ - lastIndexOf(value: any, from?: number): number; + lastIndexOf(value: T, from?: number): number; /** * Wrapped type `any[]`. * @see _.sortedIndex **/ - sortedIndex(value: any, iterator?: (element: any) => number): number; + sortedIndex(value: T, iterator?: (element: T) => number): number; /** * Wrapped type `number`. @@ -1863,12 +1813,12 @@ interface UnderscoreOOPWrapper { * Wrapped type `object`. * @see _.clone **/ - clone(object: any): any; + clone(object: T): T; /** * Wrapped type `any[]`. * @see _.clone **/ - clone(list: any[]): any[]; + clone(list: T[]): T[]; /** * Wrapped type `object`. @@ -1897,7 +1847,7 @@ interface UnderscoreOOPWrapper { * Wrapped type `any[]`. * @see _.isEmpty **/ - isEmpty(list: any[]): bool; + isEmpty(): bool; /** * Wrapped type `object`. @@ -1997,7 +1947,7 @@ interface UnderscoreOOPWrapper { * Wrapped type `number`. * @see _.times **/ - times(iterator: (n: number) => any, context?: any): any[]; + times(iterator: (n: number) => TResult, context?: any): TResult[]; /** * Wrapped type `number`. @@ -2038,7 +1988,7 @@ interface UnderscoreOOPWrapper { * Wrapped type `string`. * @see _.template **/ - template(data?: any, settings?: UnderscoreTemplateSettings): any; + template(data?: any, settings?: _._TemplateSettings): any; /*********** * Chaining * @@ -2048,16 +1998,16 @@ interface UnderscoreOOPWrapper { * Wrapped type `any`. * @see _.chain **/ - chain(): UnderscoreChain; + chain(): _Chain; /** * Wrapped type `any`. * @see _.value **/ - value(): any; + value(): TResult; } -interface UnderscoreChain { +interface _Chain { /************** * Collections * @@ -2068,303 +2018,290 @@ interface UnderscoreChain { * @see _.each **/ each( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => void , + context?: any): _Chain; /** - * Wrapped type `object`. * @see _.each **/ each( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): UnderscoreChain; + iterator: (value: any, key?: string, object?: T) => void , + context?: any): _Chain; /** - * Alias for 'each'. - * @see each + * @see _.each **/ forEach( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => void , + context?: any): _Chain; /** - * Alias for 'each'. - * @see each + * @see _.each **/ forEach( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): UnderscoreChain; + iterator: (value: any, key?: string, object?: T) => any, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.map **/ - map( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): UnderscoreChain; + map( + iterator: (element: T, index?: number, list?: T[]) => TResult, + context?: any): _Chain; /** - * Wrapped type `object`. * @see _.map **/ - map( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): UnderscoreChain; + map( + iterator: (value: any, key?: string, object?: T) => TResult, + context?: any): _Chain; /** - * Alias for 'map'. - * @see map + * @see _.map **/ - collect( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): UnderscoreChain; + collect( + iterator: (element: T, index?: number, list?: T[]) => TResult, + context?: any): _Chain; /** - * Alias for 'map'. - * @see map + * @see _.map **/ - collect( - iterator: (value: any, key?: string, object?: Object) => any, - context?: any): UnderscoreChain; + collect( + iterator: (value: any, key?: string, object?: T) => TResult, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.reduce **/ - reduce( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): UnderscoreChain; + reduce( + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): _Chain; /** - * Alias for 'reduce'. - * @see reduce + * @see _.reduce **/ - inject( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): UnderscoreChain; + inject( + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): _Chain; /** - * Alias for 'reduce'. - * @see reduce + * @see _.reduce **/ - foldl( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): UnderscoreChain; + foldl( + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.reduceRight **/ - reduceRight( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): UnderscoreChain; + reduceRight( + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): _Chain; /** - * Alias for 'reduceRight'. - * @see reduceRight + * @see _.reduceRight **/ - foldr( - iterator: (memo: any, element: any, index?: number, list?: any[]) => any, - memo: any, - context?: any): UnderscoreChain; + foldr( + iterator: (memo: TResult, element: T, index?: number, list?: T[]) => TResult, + memo: TResult, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.find **/ find( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): _Chain; /** - * Alias for 'find'. - * @see find + * @see _.find **/ detect( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): UnderscoreChain; - + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.filter **/ filter( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): _Chain; /** - * Alias for 'filter'. - * @see filter + * @see _.filter **/ select( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.where **/ - where(properties: any): UnderscoreChain; + where(properties: U): _Chain; /** * Wrapped type `any[]`. * @see _.findWhere **/ - findWhere(properties: any): UnderscoreChain; + findWhere(properties: U): _Chain; /** * Wrapped type `any[]`. * @see _.reject **/ reject( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.all **/ all( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): _Chain; /** - * Alias for 'all'. - * @see all + * @see _.all **/ every( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.any **/ any( - iterator?: (element: any, index?: number, list?: any[]) => bool, - context?: any): UnderscoreChain; + iterator?: (element: T, index?: number, list?: T[]) => bool, + context?: any): _Chain; /** - * Alias for 'any'. - * @see any + * @see _.any **/ some( - iterator: (element: any, index?: number, list?: any[]) => bool, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => bool, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.contains **/ - contains(value: any): UnderscoreChain; + contains(value: any): _Chain; /** * Alias for 'contains'. * @see contains **/ - include(value: any): UnderscoreChain; + include(value: any): _Chain; /** * Wrapped type `any[]`. * @see _.invoke **/ - invoke(methodName: string, ...arguments: any[]): UnderscoreChain; + invoke(methodName: string, ...arguments: any[]): _Chain; /** * Wrapped type `any[]`. * @see _.pluck **/ - pluck(propertyName: string): UnderscoreChain; + pluck(propertyName: string): _Chain; /** * Wrapped type `number[]`. * @see _.max **/ - max(): UnderscoreChain; + max(): _Chain; /** * Wrapped type `any[]`. * @see _.max **/ max( - iterator: (element: any, index?: number, list?: any[]) => number, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => number, + context?: any): _Chain; /** * Wrapped type `number[]`. * @see _.min **/ - min(): UnderscoreChain; + min(): _Chain; /** * Wrapped type `any[]`. * @see _.min **/ min( - iterator: (obj: any, index?: number, list?: any[]) => number, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => number, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.sortBy **/ - sortBy( - iterator: (element: any, index?: number, list?: any[]) => any, - context?: any): UnderscoreChain; + sortBy( + iterator: (element: T, index?: number, list?: T[]) => TSort, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.sortBy **/ sortBy( iterator: string, - context?: any): UnderscoreChain; + context?: any): _Chain; + + /** + * Wrapped type `any[]`. + * @see _.groupBy + **/ + groupBy( + iterator: (element: any, index?: number, list?: any[]) => TSort, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.groupBy **/ - groupBy( - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): UnderscoreChain; - /** - * Wrapped type `any[]`. - * @see _.groupBy - **/ groupBy( iterator: string, - context?: any): UnderscoreChain; + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.countBy **/ countBy( - iterator: (element: any, index?: number, list?: any[]) => string, - context?: any): UnderscoreChain; + iterator: (element: T, index?: number, list?: T[]) => string, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.countBy **/ countBy( iterator: string, - context?: any): UnderscoreChain; + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.shuffle **/ - shuffle(): UnderscoreChain; + shuffle(): _Chain; /** * Wrapped type `any`. * @see _.toArray **/ - toArray(): UnderscoreChain; + toArray(): _Chain; /** * Wrapped type `any`. * @see _.size **/ - size(): UnderscoreChain; + size(): _Chain; /********* * Arrays * @@ -2374,170 +2311,170 @@ interface UnderscoreChain { * Wrapped type `any[]`. * @see _.first **/ - first(): UnderscoreChain; + first(): _Chain; /** * Wrapped type `any[]`. * @see _.first **/ - first(n: number): UnderscoreChain; + first(n: number): _Chain; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - head(): UnderscoreChain; + head(): _Chain; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - head(n: number): UnderscoreChain; + head(n: number): _Chain; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - take(): UnderscoreChain; + take(): _Chain; /** - * Alias for 'first'. - * @see first + * @see _.first **/ - take(n: number): UnderscoreChain; + take(n: number): _Chain; /** * Wrapped type `any[]`. * @see _.initial **/ - initial(n?: number): UnderscoreChain; + initial(n?: number): _Chain; /** * Wrapped type `any[]`. * @see _.last **/ - last(): UnderscoreChain; + last(): _Chain; /** * Wrapped type `any[]`. * @see _.last **/ - last(n: number): UnderscoreChain; + last(n: number): _Chain; /** * Wrapped type `any[]`. * @see _.rest **/ - rest(index?: number): UnderscoreChain; + rest(index?: number): _Chain; /** - * Alias for 'rest'. - * @see rest + * @see _.rest **/ - tail(index?: number): UnderscoreChain; + tail(index?: number): _Chain; /** - * Alias for 'rest'. - * @see rest + * @see _.rest **/ - drop(index?: number): UnderscoreChain; + drop(index?: number): _Chain; /** * Wrapped type `any[]`. * @see _.compact **/ - compact(): UnderscoreChain; + compact(): _Chain; /** * Wrapped type `any`. * @see _.flatten **/ - flatten(shallow?: bool): UnderscoreChain; + flatten(shallow?: bool): _Chain; /** * Wrapped type `any[]`. * @see _.without **/ - without(...values: any[]): UnderscoreChain; + without(...values: T[]): _Chain; /** * Wrapped type `any[][]`. * @see _.union **/ - union(...arrays: any[][]): UnderscoreChain; + union(...arrays: T[][]): _Chain; /** * Wrapped type `any[][]`. * @see _.intersection **/ - intersection(...arrays: any[][]): UnderscoreChain; + intersection(...arrays: T[][]): _Chain; /** * Wrapped type `any[]`. * @see _.difference **/ - difference(...others: any[]): UnderscoreChain; + difference(...others: T[][]): _Chain; /** * Wrapped type `any[]`. * @see _.uniq **/ - uniq( + uniq( isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any, - context?: any): UnderscoreChain; + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): _Chain; /** * Wrapped type `any[]`. * @see _.uniq **/ - uniq( - iterator?: (element: any, index?: number, list?: any[]) => any, - context?: any): UnderscoreChain; + uniq( + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): _Chain; /** - * Alias for 'uniq'. - * @see uniq + * @see _.uniq **/ - unique( + unique( isSorted?: bool, - iterator?: (element: any, index?: number, list?: any[]) => any): UnderscoreChain; + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): _Chain; + /** + * @see _.uniq + **/ + unique( + iterator?: (element: T, index?: number, list?: T[]) => TSort, + context?: any): _Chain; /** * Wrapped type `any[][]`. * @see _.zip **/ - zip(...arrays: any[][]): UnderscoreChain; + zip(...arrays: any[][]): _Chain; /** * Wrapped type `any[][]`. * @see _.object **/ - object(...keyValuePairs: any[][]): UnderscoreChain; + object(...keyValuePairs: any[][]): _Chain; /** * Wrapped type `any[]`. * @see _.indexOf **/ - indexOf(value: any, isSorted?: bool): UnderscoreChain; + indexOf(value: T, isSorted?: bool): _Chain; /** * Wrapped type `any[]`. * @see _.lastIndexOf **/ - lastIndexOf(value: any, from?: number): UnderscoreChain; + lastIndexOf(value: T, from?: number): _Chain; /** * Wrapped type `any[]`. * @see _.sortedIndex **/ - sortedIndex(value: any, iterator?: (element: any) => number): UnderscoreChain; + sortedIndex(value: T, iterator?: (element: T) => number): _Chain; /** * Wrapped type `number`. * @see _.range **/ - range(stop: number, step?: number): UnderscoreChain; + range(stop: number, step?: number): _Chain; /** * Wrapped type `number`. * @see _.range **/ - range(): UnderscoreChain; + range(): _Chain; /************ * Functions * @@ -2547,74 +2484,74 @@ interface UnderscoreChain { * Wrapped type `Function`. * @see _.bind **/ - bind(object: any, ...arguments: any[]): UnderscoreChain; + bind(object: any, ...arguments: any[]): _Chain; /** * Wrapped type `object`. * @see _.bindAll **/ - bindAll(...methodNames: string[]): UnderscoreChain; + bindAll(...methodNames: string[]): _Chain; /** * Wrapped type `Function`. * @see _.partial **/ - partial(...arguments: any[]): UnderscoreChain; + partial(...arguments: any[]): _Chain; /** * Wrapped type `Function`. * @see _.memoize **/ - memoize(hashFn?: (n: any) => string): UnderscoreChain; + memoize(hashFn?: (n: any) => string): _Chain; /** * Wrapped type `Function`. * @see _.delay **/ - delay(waitMS: number, ...arguments: any[]): UnderscoreChain; + delay(waitMS: number, ...arguments: any[]): _Chain; /** * Wrapped type `Function`. * @see _.defer **/ - defer(...arguments: any[]): UnderscoreChain; + defer(...arguments: any[]): _Chain; /** * Wrapped type `Function`. * @see _.throttle **/ - throttle(waitMS: number): UnderscoreChain; + throttle(waitMS: number): _Chain; /** * Wrapped type `Function`. * @see _.debounce **/ - debounce(waitMS: number, immediate?: bool): UnderscoreChain; + debounce(waitMS: number, immediate?: bool): _Chain; /** * Wrapped type `Function`. * @see _.once **/ - once(): UnderscoreChain; + once(): _Chain; /** * Wrapped type `number`. * @see _.after **/ - after(fn: Function): UnderscoreChain; + after(fn: Function): _Chain; /** * Wrapped type `Function`. * @see _.wrap **/ - wrap(wrapper: (fn: Function, ...args: any[]) => any): UnderscoreChain; + wrap(wrapper: (fn: Function, ...args: any[]) => any): _Chain; /** * Wrapped type `Function[]`. * @see _.compose **/ - compose(...functions: Function[]): UnderscoreChain; + compose(...functions: Function[]): _Chain; /********** * Objects * @@ -2624,179 +2561,179 @@ interface UnderscoreChain { * Wrapped type `object`. * @see _.keys **/ - keys(): UnderscoreChain; + keys(): _Chain; /** * Wrapped type `object`. * @see _.values **/ - values(): UnderscoreChain; + values(): _Chain; /** * Wrapped type `object`. * @see _.pairs **/ - pairs(): UnderscoreChain; + pairs(): _Chain; /** * Wrapped type `object`. * @see _.invert **/ - invert(): UnderscoreChain; + invert(): _Chain; /** * Wrapped type `object`. * @see _.functions **/ - functions(): UnderscoreChain; + functions(): _Chain; /** * Wrapped type `object`. * @see _.extend **/ - extend(...sources: any[]): UnderscoreChain; + extend(...sources: any[]): _Chain; /** * Wrapped type `object`. * @see _.pick **/ - pick(...keys: string[]): UnderscoreChain; + pick(...keys: string[]): _Chain; /** * Wrapped type `object`. * @see _.omit **/ - omit(...keys: string[]): UnderscoreChain; + omit(...keys: string[]): _Chain; /** * Wrapped type `object`. * @see _.defaults **/ - defaults(...defaults: any[]): UnderscoreChain; + defaults(...defaults: any[]): _Chain; /** * Wrapped type `object`. * @see _.clone **/ - clone(object: any): UnderscoreChain; + clone(object: T): _Chain; /** * Wrapped type `any[]`. * @see _.clone **/ - clone(list: any[]): UnderscoreChain; + clone(list: T[]): _Chain; /** * Wrapped type `object`. * @see _.tap **/ - tap(intercepter: Function): UnderscoreChain; + tap(intercepter: Function): _Chain; /** * Wrapped type `object`. * @see _.has **/ - has(key: string): UnderscoreChain; + has(key: string): _Chain; /** * Wrapped type `object`. * @see _.isEqual **/ - isEqual(other: any): UnderscoreChain; + isEqual(other: any): _Chain; /** * Wrapped type `object`. * @see _.isEmpty **/ - isEmpty(object: any): UnderscoreChain; + isEmpty(object: any): _Chain; /** * Wrapped type `any[]`. * @see _.isEmpty **/ - isEmpty(): UnderscoreChain; + isEmpty(): _Chain; /** * Wrapped type `object`. * @see _.isElement **/ - isElement(): UnderscoreChain; + isElement(): _Chain; /** * Wrapped type `object`. * @see _.isArray **/ - isArray(): UnderscoreChain; + isArray(): _Chain; /** * Wrapped type `object`. * @see _.isObject **/ - isObject(): UnderscoreChain; + isObject(): _Chain; /** * Wrapped type `object`. * @see _.isArguments **/ - isArguments(): UnderscoreChain; + isArguments(): _Chain; /** * Wrapped type `object`. * @see _.isFunction **/ - isFunction(): UnderscoreChain; + isFunction(): _Chain; /** * Wrapped type `object`. * @see _.isString **/ - isString(): UnderscoreChain; + isString(): _Chain; /** * Wrapped type `object`. * @see _.isNumber **/ - isNumber(): UnderscoreChain; + isNumber(): _Chain; /** * Wrapped type `object`. * @see _.isFinite **/ - isFinite(): UnderscoreChain; + isFinite(): _Chain; /** * Wrapped type `object`. * @see _.isBoolean **/ - isBoolean(): UnderscoreChain; + isBoolean(): _Chain; /** * Wrapped type `object`. * @see _.isDate **/ - isDate(): UnderscoreChain; + isDate(): _Chain; /** * Wrapped type `object`. * @see _.isRegExp **/ - isRegExp(): UnderscoreChain; + isRegExp(): _Chain; /** * Wrapped type `object`. * @see _.isNaN **/ - isNaN(): UnderscoreChain; + isNaN(): _Chain; /** * Wrapped type `object`. * @see _.isNull **/ - isNull(): UnderscoreChain; + isNull(): _Chain; /** * Wrapped type `object`. * @see _.isUndefined **/ - isUndefined(): UnderscoreChain; + isUndefined(): _Chain; /********** * Utility * @@ -2806,54 +2743,54 @@ interface UnderscoreChain { * Wrapped type `any`. * @see _.identity **/ - identity(): UnderscoreChain; + identity(): _Chain; /** * Wrapped type `number`. * @see _.times **/ - times(iterator: (n: number) => any, context?: any): UnderscoreChain; + times(iterator: (n: number) => TResult, context?: any): _Chain; /** * Wrapped type `number`. * @see _.random **/ - random(): UnderscoreChain; + random(): _Chain; /** * Wrapped type `number`. * @see _.random **/ - random(max: number): UnderscoreChain; + random(max: number): _Chain; /** * Wrapped type `object`. * @see _.mixin **/ - mixin(): UnderscoreChain; + mixin(): _Chain; /** * Wrapped type `string`. * @see _.uniqueId **/ - uniqueId(): UnderscoreChain; + uniqueId(): _Chain; /** * Wrapped type `string`. * @see _.escape **/ - escape(): UnderscoreChain; + escape(): _Chain; /** * Wrapped type `object`. * @see _.result **/ - result(property: string): UnderscoreChain; + result(property: string): _Chain; /** * Wrapped type `string`. * @see _.template **/ - template(data?: any, settings?: UnderscoreTemplateSettings): UnderscoreChain; + template(data?: any, settings?: _._TemplateSettings): _Chain; /*********** * Chaining * @@ -2863,13 +2800,15 @@ interface UnderscoreChain { * Wrapped type `any`. * @see _.chain **/ - chain(): UnderscoreChain; + chain(): _Chain; /** * Wrapped type `any`. * @see _.value **/ - value(): any; + value(): TResult; } -declare var _: Underscore; +declare module "underscore" { + export = _; +} From 3dacaaa51296904255b71e3c55a03b108af3d460 Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Sat, 29 Jun 2013 15:18:02 +0100 Subject: [PATCH 018/756] Fix some tests --- breeze/breeze-1.0-tests.ts | 4 +- breeze/breeze-tests.ts | 2 +- breeze/breeze.d.ts | 2 +- gldatepicker/gldatepicker-tests.ts | 1 + jquery.transit/jquery.transit-tests.ts | 14 +-- leapmotionTS/LeapMotionTS-tests.ts | 2 +- phonegap/phonegap-tests.ts | 114 ++++++++----------------- platform/platform-tests.ts | 4 +- platform/platform.d.ts | 4 +- 9 files changed, 53 insertions(+), 94 deletions(-) diff --git a/breeze/breeze-1.0-tests.ts b/breeze/breeze-1.0-tests.ts index 6cc115e6f2..7dc1dc453d 100644 --- a/breeze/breeze-1.0-tests.ts +++ b/breeze/breeze-1.0-tests.ts @@ -1,7 +1,7 @@ /// -import breeze = module(Breeze); -import core = module(BreezeCore); +import breeze = Breeze; +import core = BreezeCore; function test_dataType() { var typ = breeze.DataType.DateTime; diff --git a/breeze/breeze-tests.ts b/breeze/breeze-tests.ts index 4275475742..2f4dab1d1e 100644 --- a/breeze/breeze-tests.ts +++ b/breeze/breeze-tests.ts @@ -1,6 +1,6 @@ /// -import core = module(breezeCore); +import core = breezeCore; function test_dataType() { var typ = breeze.DataType.DateTime; diff --git a/breeze/breeze.d.ts b/breeze/breeze.d.ts index 1522d1cd48..cb0aa13f99 100644 --- a/breeze/breeze.d.ts +++ b/breeze/breeze.d.ts @@ -748,7 +748,7 @@ declare module breeze { constructor (name: string, validatorFn: ValidatorFunction, context?: any); - static boolean(): Validator; + static bool(): Validator; static byte(): Validator; static date(): Validator; static duration(): Validator; diff --git a/gldatepicker/gldatepicker-tests.ts b/gldatepicker/gldatepicker-tests.ts index 885ec53eac..61efed8ceb 100644 --- a/gldatepicker/gldatepicker-tests.ts +++ b/gldatepicker/gldatepicker-tests.ts @@ -40,6 +40,7 @@ $('#example3').glDatePicker( { date: new Date(0, 0, 1), data: { message: 'Happy New Year!' }, + repeatMonth: false, repeatYear: true }, ], diff --git a/jquery.transit/jquery.transit-tests.ts b/jquery.transit/jquery.transit-tests.ts index a5ed477e9b..dda4cfd876 100644 --- a/jquery.transit/jquery.transit-tests.ts +++ b/jquery.transit/jquery.transit-tests.ts @@ -24,7 +24,7 @@ class Assert { static passedTests: number = 0; static Results() { - console.log('Tests succeeded - ' + passedTests + '/' + totalTests + '; Tests failed - ' + (totalTests - passedTests) + '/' + totalTests); + console.log('Tests succeeded - ' + this.passedTests + '/' + this.totalTests + '; Tests failed - ' + (this.totalTests - this.passedTests) + '/' + this.totalTests); } static AssertionFailed(actual: any, expected: any, test: string) { @@ -32,21 +32,21 @@ class Assert { } static Equal(actual: any, expected: any, test?: string) { - totalTests++; + this.totalTests++; if (actual === expected) { - passedTests++; + this.passedTests++; return; } - AssertionFailed(actual, expected, test); + this.AssertionFailed(actual, expected, test); } static NotEqual(actual: any, expected: any, test?: string) { - totalTests++; + this.totalTests++; if (actual !== expected) { - passedTests++; + this.passedTests++; return; } - AssertionFailed(actual, expected, test); + this.AssertionFailed(actual, expected, test); } } diff --git a/leapmotionTS/LeapMotionTS-tests.ts b/leapmotionTS/LeapMotionTS-tests.ts index 8ffc33e381..3fbdf0fc79 100755 --- a/leapmotionTS/LeapMotionTS-tests.ts +++ b/leapmotionTS/LeapMotionTS-tests.ts @@ -1,6 +1,6 @@ /// -import Leap = module('../LeapMotionTS'); +import Leap = module('LeapMotionTS'); var controller: Leap.Controller = new Leap.Controller(); controller.addEventListener(Leap.LeapEvent.LEAPMOTION_FRAME, (event: Leap.LeapEvent) => { diff --git a/phonegap/phonegap-tests.ts b/phonegap/phonegap-tests.ts index 843ac9fbba..2eabf75b02 100644 --- a/phonegap/phonegap-tests.ts +++ b/phonegap/phonegap-tests.ts @@ -73,9 +73,6 @@ function test_camera() { image.src = "data:image/jpeg;base64," + imageData; } - function onFail(message) { - alert('Failed because: ' + message); - } } function test_capture() { @@ -120,64 +117,12 @@ function test_capture() { navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error'); }; navigator.device.capture.captureImage(captureSuccess, captureError, { limit: 2 }); - function captureSuccess(mediaFiles) { - var i, len; - for (i = 0, len = mediaFiles.length; i < len; i += 1) { - uploadFile(mediaFiles[i]); - } - } - function captureError(error) { - var msg = 'An error occurred during capture: ' + error.code; - navigator.notification.alert(msg, null, 'Uh oh!'); - } function captureImage() { navigator.device.capture.captureImage(captureSuccess, captureError, { limit: 2 }); } - function uploadFile(mediaFile) { - var ft = new FileTransfer(), - path = mediaFile.fullPath, - name = mediaFile.name; - - ft.upload(path, - "http://my.domain.com/upload.php", - function (result) { - console.log('Upload success: ' + result.responseCode); - console.log(result.bytesSent + ' bytes sent'); - }, - function (error) { - console.log('Error uploading file ' + path + ': ' + error.code); - }, - { fileName: name }); - } - function captureSuccess(mediaFiles) { - var i, len; - for (i = 0, len = mediaFiles.length; i < len; i += 1) { - uploadFile(mediaFiles[i]); - } - } - function captureError(error) { - var msg = 'An error occurred during capture: ' + error.code; - navigator.notification.alert(msg, null, 'Uh oh!'); - } function captureVideo() { navigator.device.capture.captureVideo(captureSuccess, captureError, { limit: 2 }); } - function uploadFile(mediaFile) { - var ft = new FileTransfer(), - path = mediaFile.fullPath, - name = mediaFile.name; - - ft.upload(path, - "http://my.domain.com/upload.php", - function (result) { - console.log('Upload success: ' + result.responseCode); - console.log(result.bytesSent + ' bytes sent'); - }, - function (error) { - console.log('Error uploading file ' + path + ': ' + error.code); - }, - { fileName: name }); - } } function test_compass() { @@ -191,9 +136,10 @@ function test_compass() { function onError(compassError) { alert('Compass Error: ' + compassError.code); } +} + +function test_compass2() { var watchID = null; - - document.addEventListener("deviceready", onDeviceReady, false); function onDeviceReady() { startWatch(); @@ -215,7 +161,9 @@ function test_compass() { function onError(compassError) { alert('Compass error: ' + compassError.code); } - +} +function test_compass3() { + var watchID = null; function startWatch() { var options = { frequency: 3000 }; watchID = navigator.compass.watchHeading(onSuccess, onError, options); @@ -281,7 +229,17 @@ function test_contacts() { console.log("Original contact name = " + contact.name.givenName); console.log("Cloned contact name = " + clone.name.givenName); contact.remove(onSuccess, onError); - +} +function test_contacts2() { + + function onSuccess(contacts) { + for (var i = 0; i < contacts.length; i++) { + console.log("Display Name = " + contacts[i].displayName); + } + } + function onError(contactError) { + alert('onError!'); + } function onDeviceReady() { var contact = navigator.contacts.create(); contact.displayName = "Plumber"; @@ -375,7 +333,8 @@ function test_file() { function fail(evt) { console.log(evt.target.error.code); } - +} +function test_file2() { function onDeviceReady() { window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail); } @@ -403,7 +362,8 @@ function test_file() { function fail(error) { console.log(error.code); } - +} +function test_file3() { function onDeviceReady() { window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail); } @@ -459,11 +419,6 @@ function test_file() { console.log("Response = " + r.response); console.log("Sent = " + r.bytesSent); } - function fail(error) { - alert("An error has occurred: Code = " + error.code); - console.log("upload error source " + error.source); - console.log("upload error target " + error.target); - } var uri = encodeURI("http://some.server.com/upload.php"); var fileURI = ""; var options = new FileUploadOptions(); @@ -480,20 +435,21 @@ function test_file() { function test_geolocation() { var onSuccess = function (position) { alert('Latitude: ' + position.coords.latitude + '\n' + - 'Longitude: ' + position.coords.longitude + '\n' + - 'Altitude: ' + position.coords.altitude + '\n' + - 'Accuracy: ' + position.coords.accuracy + '\n' + - 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' + - 'Heading: ' + position.coords.heading + '\n' + - 'Speed: ' + position.coords.speed + '\n' + - 'Timestamp: ' + position.timestamp + '\n'); + 'Longitude: ' + position.coords.longitude + '\n' + + 'Altitude: ' + position.coords.altitude + '\n' + + 'Accuracy: ' + position.coords.accuracy + '\n' + + 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' + + 'Heading: ' + position.coords.heading + '\n' + + 'Speed: ' + position.coords.speed + '\n' + + 'Timestamp: ' + position.timestamp + '\n'); }; function onError(error: GeolocationError) { alert('code: ' + error.code + '\n' + - 'message: ' + error.message + '\n'); + 'message: ' + error.message + '\n'); } navigator.geolocation.getCurrentPosition(onSuccess, onError); - +} +function test_geolocation2() { function onSuccess(position) { var element = document.getElementById('geolocation'); element.innerHTML = 'Latitude: ' + position.coords.latitude + '
' + @@ -606,7 +562,8 @@ function test_inAppBrowser() { } function test_media() { - var my_media = new Media(src, ()=>{}, ()=>{}); + var src = ''; + var my_media = new Media(src, () => { }, () => { }); var mediaTimer = setInterval(function () { my_media.getCurrentPosition( function (position) { @@ -617,7 +574,7 @@ function test_media() { function (e) { console.log("Error getting pos=" + e); } - ); + ); }, 1000); var counter = 0; @@ -646,7 +603,8 @@ function test_media() { my_media.pause(); }, 10000); } - +} +function test_media2() { function playAudio(url) { var my_media = new Media(url, function () { diff --git a/platform/platform-tests.ts b/platform/platform-tests.ts index 9b2f84e78d..0a928e03a7 100644 --- a/platform/platform-tests.ts +++ b/platform/platform-tests.ts @@ -1,6 +1,6 @@ /// -declare interface ITestContainer { +interface ITestContainer { [name: string]: PlatformStatic; } @@ -54,7 +54,7 @@ function runTests() { onFalse = (name: string) => { - return function () => { + return () => { console.log('\tfailed on prop "' + name + '" for "' + n + '"'); } } diff --git a/platform/platform.d.ts b/platform/platform.d.ts index 49385f1a98..7d93e421f0 100644 --- a/platform/platform.d.ts +++ b/platform/platform.d.ts @@ -14,8 +14,8 @@ interface PlatformStatic { ua?: string; version?: string; os?: PlatformOS; - parse(ua: string): PlatformStatic; - toString(): string; + parse?(ua: string): PlatformStatic; + toString?(): string; } interface PlatformOS { From 59fa23885b8e314e6e287ee42123bfb8fc77dcfc Mon Sep 17 00:00:00 2001 From: jbaldwin Date: Sat, 29 Jun 2013 08:54:54 -0600 Subject: [PATCH 019/756] Upgraded box2d to typescript v0.9 --- box2d/README.md | 95 +++++++++ box2d/box2dweb-test.ts | 16 ++ box2d/box2dweb.d.ts | 429 ++++++++++++++++++++--------------------- 3 files changed, 320 insertions(+), 220 deletions(-) create mode 100644 box2d/README.md create mode 100644 box2d/box2dweb-test.ts diff --git a/box2d/README.md b/box2d/README.md new file mode 100644 index 0000000000..251b20ced4 --- /dev/null +++ b/box2d/README.md @@ -0,0 +1,95 @@ +box2dweb.d.ts +=========== + +This is a derived work of the original Box2D C++ located here: http://box2d.org/ + +This is a typescript definitions file for box2dweb.js located here: http://code.google.com/p/box2dweb/ + +There are a few ports of Box2D to javascript, I have specifically picked box2dweb.js since it has zero dependencies and can be linked to your project via a single file. It also appears to be the most up to date with box2d and is a direct automated port from Box2DFlash (http://www.box2dflash.org/) + +Basic Usage +========== + +Import Statements +----------------- + +Reference the box2dweb.d.ts file in your project and in an appropriate location include the following import statements to reduce the amount of typing you will need to do to acccess deeply nested modules. + +```typescript +/// + +// Include the following imports, or add more/less, to reduce the module nesting. +import b2Common = Box2D.Common; +import b2Math = Box2D.Common.Math; +import b2Collision = Box2D.Collision; +import b2Shapes = Box2D.Collision.Shapes; +import b2Dynamics = Box2D.Dynamics; +import b2Contacts = Box2D.Dynamics.Contacts; +import b2Controllers = Box2D.Dynamics.Controllers; +import b2Joints = Box2D.Dynamics.Joints; +``` + +Debug Drawing +------------- + +Notes from Box2DWeb + +Although Box2D is a physics engine and therefore has nothing to do with drawing, Box2dFlash provides such methods for debugging which are defined in the b2DebugDraw class. In Box2dWeb, a b2DebugDraw takes a canvas-context instead of a Sprite: + +```typescript +var debugDraw = new Box2D.Dynamics.b2DebugDraw(); +debugDraw.SetSprite(document.getElementsByTagName("canvas")[0].getContext("2d")); +``` + +Events +------ + +Notes from Box2DWeb + +You have to implement event-interfaces in Box2dFlash. Since Javascript doesn't support classical inheritance natively, I show you how to deal with events in Box2dWeb: +```typescript +var world = new Box2D.Dynamics.b2World(new Box2D.Common.Math.b2Vec2(0, 10), true); + +/* ... add bodies, etc. ... */ + +var myListener = new Box2D.Dynamics.b2DestructionListener; + +myListener.SayGoodbyeFixture = function(fixture) { + alert("goodbye fixture ..."); +} + +world.SetDestructionListener(myListener); +``` + +Change Log +========== + +2.1a 2013/06/28 +--------------- +* Upgraded to TypeScript v0.9 +* Removed import statements so the user can now declare the smaller namespaces in their code. Before the import statements were not 'exported', so they appeared as 'any' objects. + + +License +======= + +Box2DWeb-2.1.d.ts Copyright (c) 2012 Josh Baldwin http://github.com/jbaldwin/box2dweb.d.ts +There are a few competing javascript Box2D ports. +This definitions file is for Box2dWeb.js -> + http://code.google.com/p/box2dweb/ + +Box2D C++ Copyright (c) 2006-2007 Erin Catto http://www.gphysics.com + +This software is provided 'as-is', without any express or implied +warranty. In no event will the authors be held liable for any damages +arising from the use of this software. +Permission is granted to anyone to use this software for any purpose, +including commercial applications, and to alter it and redistribute it +freely, subject to the following restrictions: +1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. +2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. +3. This notice may not be removed or altered from any source distribution. diff --git a/box2d/box2dweb-test.ts b/box2d/box2dweb-test.ts new file mode 100644 index 0000000000..3d9fc19bd3 --- /dev/null +++ b/box2d/box2dweb-test.ts @@ -0,0 +1,16 @@ +/// + +import b2Common = Box2D.Common; +import b2Math = Box2D.Common.Math; +import b2Collision = Box2D.Collision; +import b2Shapes = Box2D.Collision.Shapes; +import b2Dynamics = Box2D.Dynamics; +import b2Contacts = Box2D.Dynamics.Contacts; +import b2Controllers = Box2D.Dynamics.Controllers; +import b2Joints = Box2D.Dynamics.Joints; + +var w1 = new Box2D.Dynamics.b2World(new Box2D.Common.Math.b2Vec2(0, 10), true); +var w2 = new b2Dynamics.b2World(new b2Math.b2Vec2(0, 10), true); + +var debugDraw = new Box2D.Dynamics.b2DebugDraw(); +debugDraw.SetSprite(document.getElementsByTagName("canvas")[0].getContext("2d")); diff --git a/box2d/box2dweb.d.ts b/box2d/box2dweb.d.ts index 808633adea..bdfe329d64 100644 --- a/box2d/box2dweb.d.ts +++ b/box2d/box2dweb.d.ts @@ -21,15 +21,6 @@ * 3. This notice may not be removed or altered from any source distribution. **/ -import b2Common = Box2D.Common; -import b2Math = Box2D.Common.Math; -import b2Collision = Box2D.Collision; -import b2Shapes = Box2D.Collision.Shapes; -import b2Dynamics = Box2D.Dynamics; -import b2Contacts = Box2D.Dynamics.Contacts; -import b2Controllers = Box2D.Dynamics.Controllers; -import b2Joints = Box2D.Dynamics.Joints; - declare module Box2D.Common { /** @@ -1053,12 +1044,12 @@ declare module Box2D.Collision { /** * Lower bound. **/ - public lowerBound: b2Math.b2Vec2; + public lowerBound: Box2D.Common.Math.b2Vec2; /** * Upper bound. **/ - public upperBound: b2Math.b2Vec2; + public upperBound: Box2D.Common.Math.b2Vec2; /** * Combines two AABBs into one with max values for upper bound and min values for lower bound. @@ -1086,13 +1077,13 @@ declare module Box2D.Collision { * Gets the center of the AABB. * @return Center of this AABB. **/ - public GetCenter(): b2Math.b2Vec2; + public GetCenter(): Box2D.Common.Math.b2Vec2; /** * Gets the extents of the AABB (half-widths). * @return Extents of this AABB. **/ - public GetExtents(): b2Math.b2Vec2; + public GetExtents(): Box2D.Common.Math.b2Vec2; /** * Verify that the bounds are sorted. @@ -1173,12 +1164,12 @@ declare module Box2D.Collision { /** * Points from shape1 to shape2. **/ - public normal: b2Math.b2Vec2; + public normal: Box2D.Common.Math.b2Vec2; /** * Position in world coordinates. **/ - public position: b2Math.b2Vec2; + public position: Box2D.Common.Math.b2Vec2; /** * The combined restitution coefficient. @@ -1203,7 +1194,7 @@ declare module Box2D.Collision { /** * Velocity of point on body2 relative to point on body1 (pre-solver). **/ - public velocity: b2Math.b2Vec2; + public velocity: Box2D.Common.Math.b2Vec2; } } @@ -1227,12 +1218,12 @@ declare module Box2D.Collision { /** * Transform A **/ - public transformA: b2Math.b2Transform; + public transformA: Box2D.Common.Math.b2Transform; /** * Transform B **/ - public transformB: b2Math.b2Transform; + public transformB: Box2D.Common.Math.b2Transform; /** * Use shape radii in computation? @@ -1261,12 +1252,12 @@ declare module Box2D.Collision { /** * Closest point on shape A. **/ - public pointA: b2Math.b2Vec2; + public pointA: Box2D.Common.Math.b2Vec2; /** * Closest point on shape B. **/ - public pointB: b2Math.b2Vec2; + public pointB: Box2D.Common.Math.b2Vec2; } } @@ -1290,28 +1281,28 @@ declare module Box2D.Collision { /** * Verticies **/ - public m_vertices: b2Math.b2Vec2[]; + public m_vertices: Box2D.Common.Math.b2Vec2[]; /** * Get the supporting vertex index in the given direction. * @param d Direction to look for the supporting vertex. * @return Supporting vertex index. **/ - public GetSupport(d: b2Math.b2Vec2): number; + public GetSupport(d: Box2D.Common.Math.b2Vec2): number; /** * Get the supporting vertex in the given direction. * @param d Direction to look for the supporting vertex. * @return Supporting vertex. **/ - public GetSupportVertex(d: b2Math.b2Vec2): b2Math.b2Vec2; + public GetSupportVertex(d: Box2D.Common.Math.b2Vec2): Box2D.Common.Math.b2Vec2; /** * Get a vertex by index. Used by b2Distance. * @param index Vetex's index. * @return Vertex at the given index. **/ - public GetVertex(index: number): b2Math.b2Vec2; + public GetVertex(index: number): Box2D.Common.Math.b2Vec2; /** * Get the vertex count. @@ -1374,7 +1365,7 @@ declare module Box2D.Collision { * @param aabb Swept AABB. * @param displacement Extra AABB displacement. **/ - public MoveProxy(proxy: b2DynamicTreeNode, aabb: b2AABB, displacement: b2Math.b2Vec2): bool; + public MoveProxy(proxy: b2DynamicTreeNode, aabb: b2AABB, displacement: Box2D.Common.Math.b2Vec2): bool; /** * Query an AABB for overlapping proxies. The callback is called for each proxy that overlaps the supplied AABB. The callback should match function signature fuction callback(proxy:b2DynamicTreeNode):Boolean and should return false to trigger premature termination. @@ -1442,7 +1433,7 @@ declare module Box2D.Collision { /** * @see IBroadPhase.MoveProxy **/ - public MoveProxy(proxy: b2DynamicTreeNode, aabb: b2AABB, displacement: b2Math.b2Vec2): void; + public MoveProxy(proxy: b2DynamicTreeNode, aabb: b2AABB, displacement: Box2D.Common.Math.b2Vec2): void; /** * @see IBroadPhase.Query @@ -1519,12 +1510,12 @@ declare module Box2D.Collision { /** * Not used for Type e_points **/ - public m_localPlaneNormal: b2Math.b2Vec2; + public m_localPlaneNormal: Box2D.Common.Math.b2Vec2; /** * Usage depends on manifold type **/ - public m_localPoint: b2Math.b2Vec2; + public m_localPoint: Box2D.Common.Math.b2Vec2; /** * The number of manifold points @@ -1580,7 +1571,7 @@ declare module Box2D.Collision { /** * Local contact point. **/ - public m_localpoint: b2Math.b2Vec2; + public m_localpoint: Box2D.Common.Math.b2Vec2; /** * Normal impluse for this contact point. @@ -1620,17 +1611,17 @@ declare module Box2D.Collision { /** * The local centroid. **/ - public center: b2Math.b2Vec2; + public center: Box2D.Common.Math.b2Vec2; /** * The half-widths. **/ - public extents: b2Math.b2Vec2; + public extents: Box2D.Common.Math.b2Vec2; /** * The rotation matrix. **/ - public R: b2Math.b2Mat22; + public R: Box2D.Common.Math.b2Mat22; } } @@ -1649,12 +1640,12 @@ declare module Box2D.Collision { /** * The start point of the ray. **/ - public p1: b2Math.b2Vec2; + public p1: Box2D.Common.Math.b2Vec2; /** * The end point of the ray. **/ - public p2: b2Math.b2Vec2; + public p2: Box2D.Common.Math.b2Vec2; /** * Creates a new ray cast input. @@ -1662,7 +1653,7 @@ declare module Box2D.Collision { * @param p2 End point of the ray, default = null. * @param maxFraction Truncate the ray to reach up to this fraction from p1 to p2. **/ - constructor(p1?: b2Math.b2Vec2, p2?: b2Math.b2Vec2, maxFraction?: number); + constructor(p1?: Box2D.Common.Math.b2Vec2, p2?: Box2D.Common.Math.b2Vec2, maxFraction?: number); } } @@ -1681,7 +1672,7 @@ declare module Box2D.Collision { /** * The normal at the point of collision. **/ - public normal: b2Math.b2Vec2; + public normal: Box2D.Common.Math.b2Vec2; } } @@ -1695,12 +1686,12 @@ declare module Box2D.Collision { /** * The starting point. **/ - public p1: b2Math.b2Vec2; + public p1: Box2D.Common.Math.b2Vec2; /** * The ending point. **/ - public p2: b2Math.b2Vec2; + public p2: Box2D.Common.Math.b2Vec2; /** * Extends or clips the segment so that it's ends lie on the boundary of the AABB. @@ -1729,7 +1720,7 @@ declare module Box2D.Collision { **/ public TestSegment( lambda: number[], - normal: b2Math.b2Vec2, + normal: Box2D.Common.Math.b2Vec2, segment: b2Segment, maxLambda: number): bool; } @@ -1784,12 +1775,12 @@ declare module Box2D.Collision { /** * Sweep A **/ - public sweepA: b2Math.b2Sweep; + public sweepA: Box2D.Common.Math.b2Sweep; /** * Sweep B **/ - public sweepB: b2Math.b2Sweep; + public sweepB: Box2D.Common.Math.b2Sweep; /** * Tolerance @@ -1808,12 +1799,12 @@ declare module Box2D.Collision { /** * World vector pointing from A to B. **/ - public m_normal: b2Math.b2Vec2; + public m_normal: Box2D.Common.Math.b2Vec2; /** * World contact point (point of intersection). **/ - public m_points: b2Math.b2Vec2[]; + public m_points: Box2D.Common.Math.b2Vec2[]; /** * Creates a new b2WorldManifold. @@ -1830,9 +1821,9 @@ declare module Box2D.Collision { **/ public Initialize( manifold: b2Manifold, - xfA: b2Math.b2Transform, + xfA: Box2D.Common.Math.b2Transform, radiusA: number, - xfB: b2Math.b2Transform, + xfB: Box2D.Common.Math.b2Transform, radiusB: number): void; } } @@ -1912,7 +1903,7 @@ declare module Box2D.Collision { * @param aabb Swept AABB. * @param displacement Extra AABB displacement. **/ - MoveProxy(proxy: b2DynamicTreeNode, aabb: b2AABB, displacement: b2Math.b2Vec2): void; + MoveProxy(proxy: b2DynamicTreeNode, aabb: b2AABB, displacement: Box2D.Common.Math.b2Vec2): void; /** * Query an AABB for overlapping proxies. The callback is called for each proxy that overlaps the supplied AABB. The callback should match function signature fuction callback(proxy:b2DynamicTreeNode):Boolean and should return false to trigger premature termination. @@ -1958,7 +1949,7 @@ declare module Box2D.Collision.Shapes { * @param aabb Calculated AABB, this argument is `out`. * @param xf Transform to calculate the AABB. **/ - public ComputeAABB(aabb: b2AABB, xf: b2Math.b2Transform): void; + public ComputeAABB(aabb: b2AABB, xf: Box2D.Common.Math.b2Transform): void; /** * Compute the mass properties of this shape using its dimensions and density. The inertia tensor is computed about the local origin, not the centroid. @@ -1975,10 +1966,10 @@ declare module Box2D.Collision.Shapes { * @param c The centroid, this argument is `out`. **/ public ComputeSubmergedArea( - normal: b2Math.b2Vec2, + normal: Box2D.Common.Math.b2Vec2, offset: number, - xf: b2Math.b2Transform, - c: b2Math.b2Vec2): number; + xf: Box2D.Common.Math.b2Transform, + c: Box2D.Common.Math.b2Vec2): number; /** * Copies the circle shape. @@ -1990,7 +1981,7 @@ declare module Box2D.Collision.Shapes { * Get the local position of this circle in its parent body. * @return This circle's local position. **/ - public GetLocalPosition(): b2Math.b2Vec2; + public GetLocalPosition(): Box2D.Common.Math.b2Vec2; /** * Get the radius of the circle. @@ -2008,7 +1999,7 @@ declare module Box2D.Collision.Shapes { public RayCast( output: b2RayCastOutput, input: b2RayCastInput, - transform: b2Math.b2Transform): bool; + transform: Box2D.Common.Math.b2Transform): bool; /** * Set the circle shape values from another shape. @@ -2020,7 +2011,7 @@ declare module Box2D.Collision.Shapes { * Set the local position of this circle in its parent body. * @param position The new local position of this circle. **/ - public SetLocalPosition(position: b2Math.b2Vec2): void; + public SetLocalPosition(position: Box2D.Common.Math.b2Vec2): void; /** * Set the radius of the circle. @@ -2034,7 +2025,7 @@ declare module Box2D.Collision.Shapes { * @param p Point to test against, in world coordinates. * @return True if the point is in this shape, otherwise false. **/ - public TestPoint(xf: b2Math.b2Transform, p: b2Math.b2Vec2): bool; + public TestPoint(xf: Box2D.Common.Math.b2Transform, p: Box2D.Common.Math.b2Vec2): bool; } } @@ -2058,7 +2049,7 @@ declare module Box2D.Collision.Shapes { /** * The vertices in local coordinates. **/ - public vertices: b2Math.b2Vec2; + public vertices: Box2D.Common.Math.b2Vec2; /** * Creates a new edge chain def. @@ -2079,14 +2070,14 @@ declare module Box2D.Collision.Shapes { * @param v1 First vertex * @param v2 Second vertex **/ - constructor(v1: b2Math.b2Vec2, v2: b2Math.b2Vec2); + constructor(v1: Box2D.Common.Math.b2Vec2, v2: Box2D.Common.Math.b2Vec2); /** * Given a transform, compute the associated axis aligned bounding box for this shape. * @param aabb Calculated AABB, this argument is `out`. * @param xf Transform to calculate the AABB. **/ - public ComputeAABB(aabb: b2AABB, xf: b2Math.b2Transform): void; + public ComputeAABB(aabb: b2AABB, xf: Box2D.Common.Math.b2Transform): void; /** * Compute the mass properties of this shape using its dimensions and density. The inertia tensor is computed about the local origin, not the centroid. @@ -2102,10 +2093,10 @@ declare module Box2D.Collision.Shapes { * @param c The centroid, this argument is `out`. **/ public ComputeSubmergedArea( - normal: b2Math.b2Vec2, + normal: Box2D.Common.Math.b2Vec2, offset: number, - xf: b2Math.b2Transform, - c: b2Math.b2Vec2): number; + xf: Box2D.Common.Math.b2Transform, + c: Box2D.Common.Math.b2Vec2): number; /** * Get the distance from vertex1 to vertex2. @@ -2117,49 +2108,49 @@ declare module Box2D.Collision.Shapes { * Get the local position of vertex1 in the parent body. * @return Local position of vertex1 in the parent body. **/ - public GetVertex1(): b2Math.b2Vec2; + public GetVertex1(): Box2D.Common.Math.b2Vec2; /** * Get the local position of vertex2 in the parent body. * @return Local position of vertex2 in the parent body. **/ - public GetVertex2(): b2Math.b2Vec2; + public GetVertex2(): Box2D.Common.Math.b2Vec2; /** * Get a core vertex 1 in local coordinates. These vertices represent a smaller edge that is used for time of impact. * @return core vertex 1 in local coordinates. **/ - public GetCoreVertex1(): b2Math.b2Vec2; + public GetCoreVertex1(): Box2D.Common.Math.b2Vec2; /** * Get a core vertex 2 in local coordinates. These vertices represent a smaller edge that is used for time of impact. * @return core vertex 2 in local coordinates. **/ - public GetCoreVertex2(): b2Math.b2Vec2; + public GetCoreVertex2(): Box2D.Common.Math.b2Vec2; /** * Get a perpendicular unit vector, pointing from the solid side to the empty side. * @return Normal vector. **/ - public GetNormalVector(): b2Math.b2Vec2; + public GetNormalVector(): Box2D.Common.Math.b2Vec2; /** * Get a parallel unit vector, pointing from vertex 1 to vertex 2. * @return Vertex 1 to vertex 2 directional vector. **/ - public GetDirectionVector(): b2Math.b2Vec2; + public GetDirectionVector(): Box2D.Common.Math.b2Vec2; /** * Returns a unit vector halfway between direction and previous direction. * @return Halfway unit vector between direction and previous direction. **/ - public GetCorner1Vector(): b2Math.b2Vec2; + public GetCorner1Vector(): Box2D.Common.Math.b2Vec2; /** * Returns a unit vector halfway between direction and previous direction. * @return Halfway unit vector between direction and previous direction. **/ - public GetCorner2Vector(): b2Math.b2Vec2; + public GetCorner2Vector(): Box2D.Common.Math.b2Vec2; /** * Determines if the first corner of this edge bends towards the solid side. @@ -2178,7 +2169,7 @@ declare module Box2D.Collision.Shapes { * @param xf Transform to apply. * @return First vertex with xf transform applied. **/ - public GetFirstVertex(xf: b2Math.b2Transform): b2Math.b2Vec2; + public GetFirstVertex(xf: Box2D.Common.Math.b2Transform): Box2D.Common.Math.b2Vec2; /** * Get the next edge in the chain. @@ -2199,7 +2190,7 @@ declare module Box2D.Collision.Shapes { * @param dY Y world direction. * @return Support point. **/ - public Support(xf: b2Math.b2Transform, dX: number, dY: number): b2Math.b2Vec2; + public Support(xf: Box2D.Common.Math.b2Transform, dX: number, dY: number): Box2D.Common.Math.b2Vec2; /** * Cast a ray against this shape. @@ -2211,7 +2202,7 @@ declare module Box2D.Collision.Shapes { public RayCast( output: b2RayCastOutput, input: b2RayCastInput, - transform: b2Math.b2Transform): bool; + transform: Box2D.Common.Math.b2Transform): bool; /** * Test a point for containment in this shape. This only works for convex shapes. @@ -2219,7 +2210,7 @@ declare module Box2D.Collision.Shapes { * @param p Point to test against, in world coordinates. * @return True if the point is in this shape, otherwise false. **/ - public TestPoint(xf: b2Math.b2Transform, p: b2Math.b2Vec2): bool; + public TestPoint(xf: Box2D.Common.Math.b2Transform, p: Box2D.Common.Math.b2Vec2): bool; } } @@ -2233,7 +2224,7 @@ declare module Box2D.Collision.Shapes { /** * The position of the shape's centroid relative to the shape's origin. **/ - public center: b2Math.b2Vec2; + public center: Box2D.Common.Math.b2Vec2; /** * The rotational inertia of the shape. This may be about the center or local origin, depending on usage. @@ -2260,7 +2251,7 @@ declare module Box2D.Collision.Shapes { * @param vertexCount Number of vertices in the shape, default value is 0 and in the box2dweb.js code it is ignored. * @return Convex polygon shape. **/ - public static AsArray(vertices: b2Math.b2Vec2[], vertexCount?: number): b2PolygonShape; + public static AsArray(vertices: Box2D.Common.Math.b2Vec2[], vertexCount?: number): b2PolygonShape; /** * Build vertices to represent an axis-aligned box. @@ -2276,7 +2267,7 @@ declare module Box2D.Collision.Shapes { * @param v2 Second vertex. * @return Edge polygon shape. **/ - public static AsEdge(v1: b2Math.b2Vec2, b2: b2Math.b2Vec2): b2PolygonShape; + public static AsEdge(v1: Box2D.Common.Math.b2Vec2, b2: Box2D.Common.Math.b2Vec2): b2PolygonShape; /** * Build vertices to represent an oriented box. @@ -2286,7 +2277,7 @@ declare module Box2D.Collision.Shapes { * @param angle The rotation of the box in local coordinates, default is 0.0. * @return Oriented box shape. **/ - public static AsOrientedBox(hx: number, hy: number, center?: b2Math.b2Vec2, angle?: number): b2PolygonShape; + public static AsOrientedBox(hx: number, hy: number, center?: Box2D.Common.Math.b2Vec2, angle?: number): b2PolygonShape; /** * This assumes the vertices define a convex polygon. It is assumed that the exterior is the the right of each edge. @@ -2294,14 +2285,14 @@ declare module Box2D.Collision.Shapes { * @param vertexCount The number of vertices, default is 0 and in the box2dweb.js code it is ignored. * @return Convex polygon shape. **/ - public static AsVector(vertices: b2Math.b2Vec2[], vertexCount?: number): b2PolygonShape; + public static AsVector(vertices: Box2D.Common.Math.b2Vec2[], vertexCount?: number): b2PolygonShape; /** * Given a transform, compute the associated axis aligned bounding box for this shape. * @param aabb Calculated AABB, this argument is `out`. * @param xf Transform to calculate the AABB. **/ - public ComputeAABB(aabb: b2AABB, xf: b2Math.b2Transform): void; + public ComputeAABB(aabb: b2AABB, xf: Box2D.Common.Math.b2Transform): void; /** * Compute the mass properties of this shape using its dimensions and density. The inertia tensor is computed about the local origin, not the centroid. @@ -2317,10 +2308,10 @@ declare module Box2D.Collision.Shapes { * @param c The centroid, this argument is `out`. **/ public ComputeSubmergedArea( - normal: b2Math.b2Vec2, + normal: Box2D.Common.Math.b2Vec2, offset: number, - xf: b2Math.b2Transform, - c: b2Math.b2Vec2): number; + xf: Box2D.Common.Math.b2Transform, + c: Box2D.Common.Math.b2Vec2): number; /** * Clone the shape. @@ -2331,21 +2322,21 @@ declare module Box2D.Collision.Shapes { * Get the edge normal vectors. There is one for each vertex. * @return List of edge normal vectors for each vertex. **/ - public GetNormals(): b2Math.b2Vec2[]; + public GetNormals(): Box2D.Common.Math.b2Vec2[]; /** * Get the supporting vertex index in the given direction. * @param d Direction to look. * @return Vertex index supporting the direction. **/ - public GetSupport(d: b2Math.b2Vec2): number; + public GetSupport(d: Box2D.Common.Math.b2Vec2): number; /** * Get the supporting vertex in the given direction. * @param d Direciton to look. * @return Vertex supporting the direction. **/ - public GetSupportVertex(d: b2Math.b2Vec2): b2Math.b2Vec2; + public GetSupportVertex(d: Box2D.Common.Math.b2Vec2): Box2D.Common.Math.b2Vec2; /** * Get the vertex count. @@ -2357,7 +2348,7 @@ declare module Box2D.Collision.Shapes { * Get the vertices in local coordinates. * @return List of the vertices in local coordinates. **/ - public GetVertices(): b2Math.b2Vec2[]; + public GetVertices(): Box2D.Common.Math.b2Vec2[]; /** * Cast a ray against this shape. @@ -2369,7 +2360,7 @@ declare module Box2D.Collision.Shapes { public RayCast( output: b2RayCastOutput, input: b2RayCastInput, - transform: b2Math.b2Transform): bool; + transform: Box2D.Common.Math.b2Transform): bool; /** * Set the shape values from another shape. @@ -2383,7 +2374,7 @@ declare module Box2D.Collision.Shapes { * @param vertexCount Number of vertices in the shape, default value is 0 and in the box2dweb.js code it is ignored. * @return Convex polygon shape. **/ - public SetAsArray(vertices: b2Math.b2Vec2[], vertexCount?: number): void; + public SetAsArray(vertices: Box2D.Common.Math.b2Vec2[], vertexCount?: number): void; /** * Build vertices to represent an axis-aligned box. @@ -2399,7 +2390,7 @@ declare module Box2D.Collision.Shapes { * @param v2 Second vertex. * @return Edge polygon shape. **/ - public SetAsEdge(v1: b2Math.b2Vec2, b2: b2Math.b2Vec2): void; + public SetAsEdge(v1: Box2D.Common.Math.b2Vec2, b2: Box2D.Common.Math.b2Vec2): void; /** * Build vertices to represent an oriented box. @@ -2409,7 +2400,7 @@ declare module Box2D.Collision.Shapes { * @param angle The rotation of the box in local coordinates, default is 0.0. * @return Oriented box shape. **/ - public SetAsOrientedBox(hx: number, hy: number, center?: b2Math.b2Vec2, angle?: number): void; + public SetAsOrientedBox(hx: number, hy: number, center?: Box2D.Common.Math.b2Vec2, angle?: number): void; /** * This assumes the vertices define a convex polygon. It is assumed that the exterior is the the right of each edge. @@ -2425,7 +2416,7 @@ declare module Box2D.Collision.Shapes { * @param p Point to test against, in world coordinates. * @return True if the point is in this shape, otherwise false. **/ - public TestPoint(xf: b2Math.b2Transform, p: b2Math.b2Vec2): bool; + public TestPoint(xf: Box2D.Common.Math.b2Transform, p: Box2D.Common.Math.b2Vec2): bool; } } @@ -2469,7 +2460,7 @@ declare module Box2D.Collision.Shapes { * @param aabb Calculated AABB, this argument is `out`. * @param xf Transform to calculate the AABB. **/ - public ComputeAABB(aabb: b2AABB, xf: b2Math.b2Transform): void; + public ComputeAABB(aabb: b2AABB, xf: Box2D.Common.Math.b2Transform): void; /** * Compute the mass properties of this shape using its dimensions and density. The inertia tensor is computed about the local origin, not the centroid. @@ -2486,10 +2477,10 @@ declare module Box2D.Collision.Shapes { * @param c The centroid, this argument is `out`. **/ public ComputeSubmergedArea( - normal: b2Math.b2Vec2, + normal: Box2D.Common.Math.b2Vec2, offset: number, - xf: b2Math.b2Transform, - c: b2Math.b2Vec2): number; + xf: Box2D.Common.Math.b2Transform, + c: Box2D.Common.Math.b2Vec2): number; /** * Clone the shape. @@ -2511,7 +2502,7 @@ declare module Box2D.Collision.Shapes { public RayCast( output: b2RayCastOutput, input: b2RayCastInput, - transform: b2Math.b2Transform): bool; + transform: Box2D.Common.Math.b2Transform): bool; /** * Set the shape values from another shape. @@ -2529,9 +2520,9 @@ declare module Box2D.Collision.Shapes { **/ public static TestOverlap( shape1: b2Shape, - transform1: b2Math.b2Transform, + transform1: Box2D.Common.Math.b2Transform, shape2: b2Shape, - transform2: b2Math.b2Transform): bool; + transform2: Box2D.Common.Math.b2Transform): bool; /** * Test a point for containment in this shape. This only works for convex shapes. @@ -2539,7 +2530,7 @@ declare module Box2D.Collision.Shapes { * @param p Point to test against, in world coordinates. * @return True if the point is in this shape, otherwise false. **/ - public TestPoint(xf: b2Math.b2Transform, p: b2Math.b2Vec2): bool; + public TestPoint(xf: Box2D.Common.Math.b2Transform, p: Box2D.Common.Math.b2Vec2): bool; } } @@ -2570,14 +2561,14 @@ declare module Box2D.Dynamics { * @param force The world force vector, usually in Newtons (N). * @param point The world position of the point of application. **/ - public ApplyForce(force: b2Math.b2Vec2, point: b2Math.b2Vec2): void; + public ApplyForce(force: Box2D.Common.Math.b2Vec2, point: Box2D.Common.Math.b2Vec2): void; /** * Apply an impulse at a point. This immediately modifies the velocity. It also modifies the angular velocity if the point of application is not at the center of mass. This wakes up the body. * @param impules The world impulse vector, usually in N-seconds or kg-m/s. * @param point The world position of the point of application. **/ - public ApplyImpulse(impulse: b2Math.b2Vec2, point: b2Math.b2Vec2): void; + public ApplyImpulse(impulse: Box2D.Common.Math.b2Vec2, point: Box2D.Common.Math.b2Vec2): void; /** * Apply a torque. This affects the angular velocity without affecting the linear velocity of the center of mass. This wakes up the body. @@ -2600,7 +2591,7 @@ declare module Box2D.Dynamics { * @param density The shape density, default is 0.0, set to zero for static bodies. * @return The created fixture. **/ - public CreateFixture2(shape: b2Shapes.b2Shape, density?: number): b2Fixture; + public CreateFixture2(shape: Box2D.Collision.Shapes.b2Shape, density?: number): b2Fixture; /** * Destroy a fixture. This removes the fixture from the broad-phase and destroys all contacts associated with this fixture. This will automatically adjust the mass of the body if the body is dynamic and the fixture has positive density. All fixtures attached to a body are implicitly destroyed when the body is destroyed. @@ -2674,41 +2665,41 @@ declare module Box2D.Dynamics { * Get the linear velocity of the center of mass. * @return The linear velocity of the center of mass. **/ - public GetLinearVelocity(): b2Math.b2Vec2; + public GetLinearVelocity(): Box2D.Common.Math.b2Vec2; /** * Get the world velocity of a local point. * @param localPoint Point in local coordinates. * @return The world velocity of the point. **/ - public GetLinearVelocityFromLocalPoint(localPoint: b2Math.b2Vec2): b2Math.b2Vec2; + public GetLinearVelocityFromLocalPoint(localPoint: Box2D.Common.Math.b2Vec2): Box2D.Common.Math.b2Vec2; /** * Get the world linear velocity of a world point attached to this body. * @param worldPoint Point in world coordinates. * @return The world velocity of the point. **/ - public GetLinearVelocityFromWorldPoint(worldPoint: b2Math.b2Vec2): b2Math.b2Vec2; + public GetLinearVelocityFromWorldPoint(worldPoint: Box2D.Common.Math.b2Vec2): Box2D.Common.Math.b2Vec2; /** * Get the local position of the center of mass. * @return Local position of the center of mass. **/ - public GetLocalCenter(): b2Math.b2Vec2; + public GetLocalCenter(): Box2D.Common.Math.b2Vec2; /** * Gets a local point relative to the body's origin given a world point. * @param worldPoint Pointin world coordinates. * @return The corresponding local point relative to the body's origin. **/ - public GetLocalPoint(worldPoint: b2Math.b2Vec2): b2Math.b2Vec2; + public GetLocalPoint(worldPoint: Box2D.Common.Math.b2Vec2): Box2D.Common.Math.b2Vec2; /** * Gets a local vector given a world vector. * @param worldVector World vector. * @return The corresponding local vector. **/ - public GetLocalVector(worldVector: b2Math.b2Vec2): b2Math.b2Vec2; + public GetLocalVector(worldVector: Box2D.Common.Math.b2Vec2): Box2D.Common.Math.b2Vec2; /** * Get the total mass of the body. @@ -2720,7 +2711,7 @@ declare module Box2D.Dynamics { * Get the mass data of the body. The rotational inertial is relative to the center of mass. * @param data Body's mass data, this argument is `out`. **/ - public GetMassData(data: b2Shapes.b2MassData): void; + public GetMassData(data: Box2D.Collision.Shapes.b2MassData): void; /** * Get the next body in the world's body list. @@ -2732,13 +2723,13 @@ declare module Box2D.Dynamics { * Get the world body origin position. * @return World position of the body's origin. **/ - public GetPosition(): b2Math.b2Vec2; + public GetPosition(): Box2D.Common.Math.b2Vec2; /** * Get the body transform for the body's origin. * @return World transform of the body's origin. **/ - public GetTransform(): b2Math.b2Transform; + public GetTransform(): Box2D.Common.Math.b2Transform; /** * Get the type of this body. @@ -2762,21 +2753,21 @@ declare module Box2D.Dynamics { * Get the world position of the center of mass. * @return World position of the center of mass. **/ - public GetWorldCenter(): b2Math.b2Vec2; + public GetWorldCenter(): Box2D.Common.Math.b2Vec2; /** * Get the world coordinates of a point given the local coordinates. * @param localPoint Point on the body measured relative to the body's origin. * @return localPoint expressed in world coordinates. **/ - public GetWorldPoint(localPoint: b2Math.b2Vec2): b2Math.b2Vec2; + public GetWorldPoint(localPoint: Box2D.Common.Math.b2Vec2): Box2D.Common.Math.b2Vec2; /** * Get the world coordinates of a vector given the local coordinates. * @param localVector Vector fixed in the body. * @return localVector expressed in world coordinates. **/ - public GetWorldVector(localVector: b2Math.b2Vec2): b2Math.b2Vec2; + public GetWorldVector(localVector: Box2D.Common.Math.b2Vec2): Box2D.Common.Math.b2Vec2; /** * Get the active state of the body. @@ -2871,27 +2862,27 @@ declare module Box2D.Dynamics { * Set the linear velocity of the center of mass. * @param v New linear velocity of the center of mass. **/ - public SetLinearVelocity(v: b2Math.b2Vec2): void; + public SetLinearVelocity(v: Box2D.Common.Math.b2Vec2): void; /** * Set the mass properties to override the mass properties of the fixtures Note that this changes the center of mass position. Note that creating or destroying fixtures can also alter the mass. This function has no effect if the body isn't dynamic. * @warning The supplied rotational inertia should be relative to the center of mass. * @param massData New mass data properties. **/ - public SetMassData(massData: b2Shapes.b2MassData): void; + public SetMassData(massData: Box2D.Collision.Shapes.b2MassData): void; /** * Set the world body origin position. * @param position New world body origin position. **/ - public SetPosition(position: b2Math.b2Vec2): void; + public SetPosition(position: Box2D.Common.Math.b2Vec2): void; /** * Set the position of the body's origin and rotation (radians). This breaks any contacts and wakes the other bodies. * @param position New world body origin position. * @param angle New world rotation angle of the body in radians. **/ - public SetPositionAndAngle(position: b2Math.b2Vec2, angle: number): void; + public SetPositionAndAngle(position: Box2D.Common.Math.b2Vec2, angle: number): void; /** * Is this body allowed to sleep @@ -2903,7 +2894,7 @@ declare module Box2D.Dynamics { * Set the position of the body's origin and rotation (radians). This breaks any contacts and wakes the other bodies. Note this is less efficient than the other overload - you should use that if the angle is available. * @param xf Body's origin and rotation (radians). **/ - public SetTransform(xf: b2Math.b2Transform): void; + public SetTransform(xf: Box2D.Common.Math.b2Transform): void; /** * Set the type of this body. This may alter the mass and velocity @@ -2989,12 +2980,12 @@ declare module Box2D.Dynamics { /** * The linear velocity of the body's origin in world co-ordinates. **/ - public linearVelocity: b2Math.b2Vec2; + public linearVelocity: Box2D.Common.Math.b2Vec2; /** * The world position of the body. Avoid creating bodies at the origin since this can lead to many overlapping shapes. **/ - public position: b2Math.b2Vec2; + public position: Box2D.Common.Math.b2Vec2; /** * The body type: static, kinematic, or dynamic. A member of the b2BodyType class . @@ -3047,12 +3038,12 @@ declare module Box2D.Dynamics { /** * Normal impulses. **/ - public normalImpulses: b2Math.b2Vec2; + public normalImpulses: Box2D.Common.Math.b2Vec2; /** * Tangent impulses. **/ - public tangentImpulses: b2Math.b2Vec2; + public tangentImpulses: Box2D.Common.Math.b2Vec2; } } @@ -3088,7 +3079,7 @@ declare module Box2D.Dynamics { * @param contact Contact point. * @param oldManifold Old manifold. **/ - public PreSolve(contact: Contacts.b2Contact, oldManifold: b2Collision.b2Manifold): void; + public PreSolve(contact: Contacts.b2Contact, oldManifold: Box2D.Collision.b2Manifold): void; } } @@ -3156,7 +3147,7 @@ declare module Box2D.Dynamics { * @param radius Circle radius. * @param color Circle draw color. **/ - public DrawCircle(center: b2Math.b2Vec2, radius: number, color: b2Common.b2Color): void; + public DrawCircle(center: Box2D.Common.Math.b2Vec2, radius: number, color: Box2D.Common.b2Color): void; /** * Draw a closed polygon provided in CCW order. @@ -3164,7 +3155,7 @@ declare module Box2D.Dynamics { * @param vertexCount Number of vertices in the polygon, usually vertices.length. * @param color Polygon draw color. **/ - public DrawPolygon(vertices: b2Math.b2Vec2[], vertexCount: number, color: b2Common.b2Color): void; + public DrawPolygon(vertices: Box2D.Common.Math.b2Vec2[], vertexCount: number, color: Box2D.Common.b2Color): void; /** * Draw a line segment. @@ -3172,7 +3163,7 @@ declare module Box2D.Dynamics { * @param p2 Line endpoint. * @param color Line color. **/ - public DrawSegment(p1: b2Math.b2Vec2, p2: b2Math.b2Vec2, color: b2Common.b2Color): void; + public DrawSegment(p1: Box2D.Common.Math.b2Vec2, p2: Box2D.Common.Math.b2Vec2, color: Box2D.Common.b2Color): void; /** * Draw a solid circle. @@ -3181,7 +3172,7 @@ declare module Box2D.Dynamics { * @param axis Circle axis. * @param color Circle color. **/ - public DrawSolidCircle(center: b2Math.b2Vec2, radius: number, axis: b2Math.b2Vec2, color: b2Common.b2Color): void; + public DrawSolidCircle(center: Box2D.Common.Math.b2Vec2, radius: number, axis: Box2D.Common.Math.b2Vec2, color: Box2D.Common.b2Color): void; /** * Draw a solid closed polygon provided in CCW order. @@ -3189,13 +3180,13 @@ declare module Box2D.Dynamics { * @param vertexCount Number of vertices in the polygon, usually vertices.length. * @param color Polygon draw color. **/ - public DrawSolidPolygon(vertices: b2Math.b2Vec2[], vertexCount: number, color: b2Common.b2Color): void; + public DrawSolidPolygon(vertices: Box2D.Common.Math.b2Vec2[], vertexCount: number, color: Box2D.Common.b2Color): void; /** * Draw a transform. Choose your own length scale. * @param xf Transform to draw. **/ - public DrawTransform(xf: b2Math.b2Transform): void; + public DrawTransform(xf: Box2D.Common.Math.b2Transform): void; /** * Get the alpha value used for lines. @@ -3348,7 +3339,7 @@ declare module Box2D.Dynamics { * Get the fixture's AABB. This AABB may be enlarge and/or stale. If you need a more accurate AABB, compute it using the shape and the body transform. * @return Fiture's AABB. **/ - public GetAABB(): b2Collision.b2AABB; + public GetAABB(): Box2D.Collision.b2AABB; /** * Get the parent body of this fixture. This is NULL if the fixture is not attached. @@ -3379,7 +3370,7 @@ declare module Box2D.Dynamics { * @param massData This is a reference to a valid b2MassData, if it is null a new b2MassData is allocated and then returned. Default = null. * @return Mass data. **/ - public GetMassData(massData?: b2Shapes.b2MassData): b2Shapes.b2MassData; + public GetMassData(massData?: Box2D.Collision.Shapes.b2MassData): Box2D.Collision.Shapes.b2MassData; /** * Get the next fixture in the parent body's fixture list. @@ -3397,7 +3388,7 @@ declare module Box2D.Dynamics { * Get the child shape. You can modify the child shape, however you should not change the number of vertices because this will crash some collision caching mechanisms. * @return Fixture shape. **/ - public GetShape(): b2Shapes.b2Shape; + public GetShape(): Box2D.Collision.Shapes.b2Shape; /** * Get the type of the child shape. You can use this to down cast to the concrete shape. @@ -3423,7 +3414,7 @@ declare module Box2D.Dynamics { * @param input Ray cast input parameters. * @return True if the ray hits the shape, otherwise false. **/ - public RayCast(output: b2Collision.b2RayCastOutput, input: b2Collision.b2RayCastInput): bool; + public RayCast(output: Box2D.Collision.b2RayCastOutput, input: Box2D.Collision.b2RayCastInput): bool; /** * Set the density of this fixture. This will _not_ automatically adjust the mass of the body. You must call b2Body::ResetMassData to update the body's mass. @@ -3466,7 +3457,7 @@ declare module Box2D.Dynamics { * @param p Point to test against, in world coordinates. * @return True if the point is in this shape, otherwise false. **/ - public TestPoint(p: b2Math.b2Vec2): bool; + public TestPoint(p: Box2D.Common.Math.b2Vec2): bool; } } @@ -3505,7 +3496,7 @@ declare module Box2D.Dynamics { /** * The shape, this must be set. The shape will be cloned, so you can create the shape on the stack. **/ - public shape: b2Shapes.b2Shape; + public shape: Box2D.Collision.Shapes.b2Shape; /** * Use this to store application specific fixture data. @@ -3541,7 +3532,7 @@ declare module Box2D.Dynamics { * @param gravity The world gravity vector. * @param doSleep Improvie performance by not simulating inactive bodies. **/ - constructor(gravity: b2Math.b2Vec2, doSleep: bool); + constructor(gravity: Box2D.Common.Math.b2Vec2, doSleep: bool); /** * Add a controller to the world list. @@ -3630,7 +3621,7 @@ declare module Box2D.Dynamics { * Get the global gravity vector. * @return Global gravity vector. **/ - public GetGravity(): b2Math.b2Vec2; + public GetGravity(): Box2D.Common.Math.b2Vec2; /** * The world provides a single static ground body with no collision shapes. You can use this to simplify the creation of joints and static shapes. @@ -3667,7 +3658,7 @@ declare module Box2D.Dynamics { * @param callback A user implemented callback class. It should match signature function Callback(fixture:b2Fixture):Boolean. Return true to continue to the next fixture. * @param aabb The query bounding box. **/ - public QueryAABB(callback: (fixutre: b2Fixture) => bool, aabb: b2Collision.b2AABB): void; + public QueryAABB(callback: (fixutre: b2Fixture) => bool, aabb: Box2D.Collision.b2AABB): void; /** * Query the world for all fixtures that contain a point. @@ -3675,7 +3666,7 @@ declare module Box2D.Dynamics { * @param callback A user implemented callback class. It should match signature function Callback(fixture:b2Fixture):Boolean. Return true to continue to the next fixture. * @param p The query point. **/ - public QueryPoint(callback: (fixture: b2Fixture) => bool, p: b2Math.b2Vec2): void; + public QueryPoint(callback: (fixture: b2Fixture) => bool, p: Box2D.Common.Math.b2Vec2): void; /** * Query the world for all fixtures that precisely overlap the provided transformed shape. @@ -3684,7 +3675,7 @@ declare module Box2D.Dynamics { * @param shape The query shape. * @param transform Optional transform, default = null. **/ - public QueryShape(callback: (fixture: b2Fixture) => bool, shape: b2Shapes.b2Shape, transform?: b2Math.b2Transform): void; + public QueryShape(callback: (fixture: b2Fixture) => bool, shape: Box2D.Collision.Shapes.b2Shape, transform?: Box2D.Common.Math.b2Transform): void; /** * Ray-cast the world for all fixtures in the path of the ray. Your callback Controls whether you get the closest point, any point, or n-points The ray-cast ignores shapes that contain the starting point. @@ -3699,7 +3690,7 @@ declare module Box2D.Dynamics { * @param point1 The ray starting point. * @param point2 The ray ending point. **/ - public RayCast(callback: (fixture: b2Fixture, point: b2Math.b2Vec2, normal: b2Math.b2Vec2, fraction: number) => number, point1: b2Math.b2Vec2, point2: b2Math.b2Vec2): void; + public RayCast(callback: (fixture: b2Fixture, point: Box2D.Common.Math.b2Vec2, normal: Box2D.Common.Math.b2Vec2, fraction: number) => number, point1: Box2D.Common.Math.b2Vec2, point2: Box2D.Common.Math.b2Vec2): void; /** * Ray-cast the world for all fixture in the path of the ray. @@ -3707,7 +3698,7 @@ declare module Box2D.Dynamics { * @param point2 The ray ending point. * @return Array of all the fixtures intersected by the ray. **/ - public RayCastAll(point1: b2Math.b2Vec2, point2: b2Math.b2Vec2): b2Fixture[]; + public RayCastAll(point1: Box2D.Common.Math.b2Vec2, point2: Box2D.Common.Math.b2Vec2): b2Fixture[]; /** * Ray-cast the world for the first fixture in the path of the ray. @@ -3715,7 +3706,7 @@ declare module Box2D.Dynamics { * @param point2 The ray ending point. * @return First fixture intersected by the ray. **/ - public RayCastOne(point1: b2Math.b2Vec2, point2: b2Math.b2Vec2): b2Fixture; + public RayCastOne(point1: Box2D.Common.Math.b2Vec2, point2: Box2D.Common.Math.b2Vec2): b2Fixture; /** * Removes the controller from the world. @@ -3728,7 +3719,7 @@ declare module Box2D.Dynamics { * @warning This function is locked during callbacks. * @param broadphase: Broad phase implementation. **/ - public SetBroadPhase(broadPhase: b2Collision.IBroadPhase): void; + public SetBroadPhase(broadPhase: Box2D.Collision.IBroadPhase): void; /** * Register a contact filter to provide specific control over collision. Otherwise the default filter is used (b2_defaultFilter). @@ -3764,7 +3755,7 @@ declare module Box2D.Dynamics { * Change the global gravity vector. * @param gravity New global gravity vector. **/ - public SetGravity(gravity: b2Math.b2Vec2): void; + public SetGravity(gravity: Box2D.Common.Math.b2Vec2): void; /** * Enable/disable warm starting. For testing. @@ -3820,7 +3811,7 @@ declare module Box2D.Dynamics.Contacts { * Get the contact manifold. Do not modify the manifold unless you understand the internals of Box2D. * @return Contact manifold. **/ - public GetManifold(): b2Collision.b2Manifold; + public GetManifold(): Box2D.Collision.b2Manifold; /** * Get the next contact in the world's contact list. @@ -3833,7 +3824,7 @@ declare module Box2D.Dynamics.Contacts { * @param worldManifold World manifold out. * @return World manifold. **/ - public GetWorldManifold(worldManifold: b2Collision.b2WorldManifold): void; + public GetWorldManifold(worldManifold: Box2D.Collision.b2WorldManifold): void; /** * Does this contact generate TOI events for continuous simulation. @@ -3912,12 +3903,12 @@ declare module Box2D.Dynamics.Contacts { /** * The contact id identifies the features in contact. **/ - public id: b2Collision.b2ContactID; + public id: Box2D.Collision.b2ContactID; /** * Points from shape1 to shape2. **/ - public normal: b2Math.b2Vec2; + public normal: Box2D.Common.Math.b2Vec2; /** * The normal impulse applied to body2. @@ -3927,17 +3918,17 @@ declare module Box2D.Dynamics.Contacts { /** * Position in world coordinates. **/ - public position: b2Math.b2Vec2; + public position: Box2D.Common.Math.b2Vec2; /** * The first shape. **/ - public shape1: b2Shapes.b2Shape; + public shape1: Box2D.Collision.Shapes.b2Shape; /** * The second shape. **/ - public shape2: b2Shapes.b2Shape; + public shape2: Box2D.Collision.Shapes.b2Shape; /** * The tangent impulse applied to body2. @@ -4074,7 +4065,7 @@ declare module Box2D.Dynamics.Controllers { * Gravity vector, if the world's gravity is not used. * @default = null **/ - public gravity: b2Math.b2Vec2; + public gravity: Box2D.Common.Math.b2Vec2; /** * Linear drag co-efficient. @@ -4085,7 +4076,7 @@ declare module Box2D.Dynamics.Controllers { /** * The outer surface normal. **/ - public normal: b2Math.b2Vec2; + public normal: Box2D.Common.Math.b2Vec2; /** * The height of the fluid surface along the normal. @@ -4108,7 +4099,7 @@ declare module Box2D.Dynamics.Controllers { /** * Fluid velocity, for drag calculations. **/ - public velocity: b2Math.b2Vec2; + public velocity: Box2D.Common.Math.b2Vec2; } } @@ -4122,7 +4113,7 @@ declare module Box2D.Dynamics.Controllers { /** * The acceleration to apply. **/ - public A: b2Math.b2Vec2; + public A: Box2D.Common.Math.b2Vec2; /** * @see b2Controller.Step @@ -4141,7 +4132,7 @@ declare module Box2D.Dynamics.Controllers { /** * The acceleration to apply. **/ - public A: b2Math.b2Vec2; + public A: Box2D.Common.Math.b2Vec2; /** * @see b2Controller.Step @@ -4191,7 +4182,7 @@ declare module Box2D.Dynamics.Controllers { /** * Tensor to use in damping model. **/ - public T: b2Math.b2Mat22; + public T: Box2D.Common.Math.b2Mat22; /** * Helper function to set T in a common case. @@ -4218,13 +4209,13 @@ declare module Box2D.Dynamics.Joints { * Get the anchor point on bodyA in world coordinates. * @return Anchor A point. **/ - public GetAnchorA(): b2Math.b2Vec2; + public GetAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the anchor point on bodyB in world coordinates. * @return Anchor B point. **/ - public GetAnchorB(): b2Math.b2Vec2; + public GetAnchorB(): Box2D.Common.Math.b2Vec2; /** * Get the first body attached to this joint. @@ -4249,7 +4240,7 @@ declare module Box2D.Dynamics.Joints { * @param inv_dt * @return Reaction force (N) **/ - public GetReactionForce(inv_dt: number): b2Math.b2Vec2; + public GetReactionForce(inv_dt: number): Box2D.Common.Math.b2Vec2; /** * Get the reaction torque on body2 in N. @@ -4363,13 +4354,13 @@ declare module Box2D.Dynamics.Joints { * Get the anchor point on bodyA in world coordinates. * @return Body A anchor. **/ - public GetAnchorA(): b2Math.b2Vec2; + public GetAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the anchor point on bodyB in world coordinates. * @return Body B anchor. **/ - public GetAnchorB(): b2Math.b2Vec2; + public GetAnchorB(): Box2D.Common.Math.b2Vec2; /** * Gets the damping ratio. @@ -4394,7 +4385,7 @@ declare module Box2D.Dynamics.Joints { * @param inv_dt * @return Reaction force in N. **/ - public GetReactionForce(inv_dt: number): b2Math.b2Vec2; + public GetReactionForce(inv_dt: number): Box2D.Common.Math.b2Vec2; /** * Get the reaction torque on body 2 in N. @@ -4449,12 +4440,12 @@ declare module Box2D.Dynamics.Joints { /** * The local anchor point relative to body1's origin. **/ - public localAnchorA: b2Math.b2Vec2; + public localAnchorA: Box2D.Common.Math.b2Vec2; /** * The local anchor point relative to body2's origin. **/ - public localAnchorB: b2Math.b2Vec2; + public localAnchorB: Box2D.Common.Math.b2Vec2; /** * Constructor. @@ -4468,7 +4459,7 @@ declare module Box2D.Dynamics.Joints { * @param anchorA Anchor A. * @param anchorB Anchor B. **/ - public Initialize(bA: b2Body, bB: b2Body, anchorA: b2Math.b2Vec2, anchorB: b2Math.b2Vec2): void; + public Initialize(bA: b2Body, bB: b2Body, anchorA: Box2D.Common.Math.b2Vec2, anchorB: Box2D.Common.Math.b2Vec2): void; } } @@ -4487,19 +4478,19 @@ declare module Box2D.Dynamics.Joints { /** * Linear mass. **/ - public m_linearMass: b2Math.b2Mat22; + public m_linearMass: Box2D.Common.Math.b2Mat22; /** * Get the anchor point on bodyA in world coordinates. * @return Body A anchor. **/ - public GetAnchorA(): b2Math.b2Vec2; + public GetAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the anchor point on bodyB in world coordinates. * @return Body B anchor. **/ - public GetAnchorB(): b2Math.b2Vec2; + public GetAnchorB(): Box2D.Common.Math.b2Vec2; /** * Gets the max force. @@ -4518,7 +4509,7 @@ declare module Box2D.Dynamics.Joints { * @param inv_dt * @return Reaction force in N. **/ - public GetReactionForce(inv_dt: number): b2Math.b2Vec2; + public GetReactionForce(inv_dt: number): Box2D.Common.Math.b2Vec2; /** * Get the reaction torque on body 2 in N. @@ -4550,12 +4541,12 @@ declare module Box2D.Dynamics.Joints { /** * The local anchor point relative to body1's origin. **/ - public localAnchorA: b2Math.b2Vec2; + public localAnchorA: Box2D.Common.Math.b2Vec2; /** * The local anchor point relative to body2's origin. **/ - public localAnchorB: b2Math.b2Vec2; + public localAnchorB: Box2D.Common.Math.b2Vec2; /** * The maximum force in N. @@ -4578,7 +4569,7 @@ declare module Box2D.Dynamics.Joints { * @param bB Body B. * @param anchor World anchor. **/ - public Initialize(bA: b2Body, bB: b2Body, anchor: b2Math.b2Vec2): void; + public Initialize(bA: b2Body, bB: b2Body, anchor: Box2D.Common.Math.b2Vec2): void; } } @@ -4594,13 +4585,13 @@ declare module Box2D.Dynamics.Joints { * Get the anchor point on bodyA in world coordinates. * @return Body A anchor. **/ - public GetAnchorA(): b2Math.b2Vec2; + public GetAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the anchor point on bodyB in world coordinates. * @return Body B anchor. **/ - public GetAnchorB(): b2Math.b2Vec2; + public GetAnchorB(): Box2D.Common.Math.b2Vec2; /** * Get the gear ratio. @@ -4613,7 +4604,7 @@ declare module Box2D.Dynamics.Joints { * @param inv_dt * @return Reaction force in N. **/ - public GetReactionForce(inv_dt: number): b2Math.b2Vec2; + public GetReactionForce(inv_dt: number): Box2D.Common.Math.b2Vec2; /** * Get the reaction torque on body 2 in N. @@ -4682,13 +4673,13 @@ declare module Box2D.Dynamics.Joints { * Get the anchor point on bodyA in world coordinates. * @return Body A anchor. **/ - public GetAnchorA(): b2Math.b2Vec2; + public GetAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the anchor point on bodyB in world coordinates. * @return Body B anchor. **/ - public GetAnchorB(): b2Math.b2Vec2; + public GetAnchorB(): Box2D.Common.Math.b2Vec2; /** * Get the current joint translation speed, usually in meters per second. @@ -4731,7 +4722,7 @@ declare module Box2D.Dynamics.Joints { * @param inv_dt * @return Reaction force in N. **/ - public GetReactionForce(inv_dt: number): b2Math.b2Vec2; + public GetReactionForce(inv_dt: number): Box2D.Common.Math.b2Vec2; /** * Get the reaction torque on body 2 in N. @@ -4799,17 +4790,17 @@ declare module Box2D.Dynamics.Joints { /** * The local anchor point relative to body1's origin. **/ - public localAnchorA: b2Math.b2Vec2; + public localAnchorA: Box2D.Common.Math.b2Vec2; /** * The local anchor point relative to body2's origin. **/ - public localAnchorB: b2Math.b2Vec2; + public localAnchorB: Box2D.Common.Math.b2Vec2; /** * The local translation axis in bodyA. **/ - public localAxisA: b2Math.b2Vec2; + public localAxisA: Box2D.Common.Math.b2Vec2; /** * The lower translation limit, usually in meters. @@ -4843,7 +4834,7 @@ declare module Box2D.Dynamics.Joints { * @param anchor Anchor. * @param axis Axis. **/ - public Initialize(bA: b2Body, bB: b2Body, anchor: b2Math.b2Vec2, axis: b2Math.b2Vec2): void; + public Initialize(bA: b2Body, bB: b2Body, anchor: Box2D.Common.Math.b2Vec2, axis: Box2D.Common.Math.b2Vec2): void; } } @@ -4858,13 +4849,13 @@ declare module Box2D.Dynamics.Joints { * Get the anchor point on bodyA in world coordinates. * @return Body A anchor. **/ - public GetAnchorA(): b2Math.b2Vec2; + public GetAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the anchor point on bodyB in world coordinates. * @return Body B anchor. **/ - public GetAnchorB(): b2Math.b2Vec2; + public GetAnchorB(): Box2D.Common.Math.b2Vec2; /** * Gets the damping ratio. @@ -4889,7 +4880,7 @@ declare module Box2D.Dynamics.Joints { * @param inv_dt * @return Reaction force in N. **/ - public GetReactionForce(inv_dt: number): b2Math.b2Vec2; + public GetReactionForce(inv_dt: number): Box2D.Common.Math.b2Vec2; /** * Get the reaction torque on body 2 in N. @@ -4902,7 +4893,7 @@ declare module Box2D.Dynamics.Joints { * Gets the target. * @return Target. **/ - public GetTarget(): b2Math.b2Vec2; + public GetTarget(): Box2D.Common.Math.b2Vec2; /** * Sets the damping ratio. @@ -4926,7 +4917,7 @@ declare module Box2D.Dynamics.Joints { * Use this to update the target point. * @param target New target. **/ - public SetTarget(target: b2Math.b2Vec2): void; + public SetTarget(target: Box2D.Common.Math.b2Vec2): void; } } @@ -4982,13 +4973,13 @@ declare module Box2D.Dynamics.Joints { * Get the anchor point on bodyA in world coordinates. * @return Body A anchor. **/ - public GetAnchorA(): b2Math.b2Vec2; + public GetAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the anchor point on bodyB in world coordinates. * @return Body B anchor. **/ - public GetAnchorB(): b2Math.b2Vec2; + public GetAnchorB(): Box2D.Common.Math.b2Vec2; /** * Get the current joint translation speed, usually in meters per second. @@ -5025,7 +5016,7 @@ declare module Box2D.Dynamics.Joints { * @param inv_dt * @return Reaction force in N. **/ - public GetReactionForce(inv_dt: number): b2Math.b2Vec2; + public GetReactionForce(inv_dt: number): Box2D.Common.Math.b2Vec2; /** * Get the reaction torque on body 2 in N. @@ -5093,17 +5084,17 @@ declare module Box2D.Dynamics.Joints { /** * The local anchor point relative to body1's origin. **/ - public localAnchorA: b2Math.b2Vec2; + public localAnchorA: Box2D.Common.Math.b2Vec2; /** * The local anchor point relative to body2's origin. **/ - public localAnchorB: b2Math.b2Vec2; + public localAnchorB: Box2D.Common.Math.b2Vec2; /** * The local translation axis in body1. **/ - public localAxisA: b2Math.b2Vec2; + public localAxisA: Box2D.Common.Math.b2Vec2; /** * The lower translation limit, usually in meters. @@ -5142,7 +5133,7 @@ declare module Box2D.Dynamics.Joints { * @param anchor Anchor. * @param axis Axis. **/ - public Initialize(bA: b2Body, bB: b2Body, anchor: b2Math.b2Vec2, axis: b2Math.b2Vec2): void; + public Initialize(bA: b2Body, bB: b2Body, anchor: Box2D.Common.Math.b2Vec2, axis: Box2D.Common.Math.b2Vec2): void; } } @@ -5157,23 +5148,23 @@ declare module Box2D.Dynamics.Joints { * Get the anchor point on bodyA in world coordinates. * @return Body A anchor. **/ - public GetAnchorA(): b2Math.b2Vec2; + public GetAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the anchor point on bodyB in world coordinates. * @return Body B anchor. **/ - public GetAnchorB(): b2Math.b2Vec2; + public GetAnchorB(): Box2D.Common.Math.b2Vec2; /** * Get the first ground anchor. **/ - public GetGroundAnchorA(): b2Math.b2Vec2; + public GetGroundAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the second ground anchor. **/ - public GetGroundAnchorB(): b2Math.b2Vec2; + public GetGroundAnchorB(): Box2D.Common.Math.b2Vec2; /** * Get the current length of the segment attached to body1. @@ -5195,7 +5186,7 @@ declare module Box2D.Dynamics.Joints { * @param inv_dt * @return Reaction force in N. **/ - public GetReactionForce(inv_dt: number): b2Math.b2Vec2; + public GetReactionForce(inv_dt: number): Box2D.Common.Math.b2Vec2; /** * Get the reaction torque on body 2 in N. @@ -5216,12 +5207,12 @@ declare module Box2D.Dynamics.Joints { /** * The first ground anchor in world coordinates. This point never moves. **/ - public groundAnchorA: b2Math.b2Vec2; + public groundAnchorA: Box2D.Common.Math.b2Vec2; /** * The second ground anchor in world coordinates. This point never moves. **/ - public groundAnchorB: b2Math.b2Vec2; + public groundAnchorB: Box2D.Common.Math.b2Vec2; /** * The a reference length for the segment attached to bodyA. @@ -5236,12 +5227,12 @@ declare module Box2D.Dynamics.Joints { /** * The local anchor point relative to body1's origin. **/ - public localAnchorA: b2Math.b2Vec2; + public localAnchorA: Box2D.Common.Math.b2Vec2; /** * The local anchor point relative to body2's origin. **/ - public localAnchorB: b2Math.b2Vec2; + public localAnchorB: Box2D.Common.Math.b2Vec2; /** * The maximum length of the segment attached to bodyA. @@ -5272,7 +5263,7 @@ declare module Box2D.Dynamics.Joints { * @param anchorA Anchor A. * @param anchorB Anchor B. **/ - public Initialize(bA: b2Body, bB: b2Body, gaA: b2Math.b2Vec2, gaB: b2Math.b2Vec2, anchorA: b2Math.b2Vec2, anchorB: b2Math.b2Vec2): void; + public Initialize(bA: b2Body, bB: b2Body, gaA: Box2D.Common.Math.b2Vec2, gaB: Box2D.Common.Math.b2Vec2, anchorA: Box2D.Common.Math.b2Vec2, anchorB: Box2D.Common.Math.b2Vec2): void; } } @@ -5299,13 +5290,13 @@ declare module Box2D.Dynamics.Joints { * Get the anchor point on bodyA in world coordinates. * @return Body A anchor. **/ - public GetAnchorA(): b2Math.b2Vec2; + public GetAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the anchor point on bodyB in world coordinates. * @return Body B anchor. **/ - public GetAnchorB(): b2Math.b2Vec2; + public GetAnchorB(): Box2D.Common.Math.b2Vec2; /** * Get the current joint angle in radians. @@ -5342,7 +5333,7 @@ declare module Box2D.Dynamics.Joints { * @param inv_dt * @return Reaction force in N. **/ - public GetReactionForce(inv_dt: number): b2Math.b2Vec2; + public GetReactionForce(inv_dt: number): Box2D.Common.Math.b2Vec2; /** * Get the reaction torque on body 2 in N. @@ -5410,12 +5401,12 @@ declare module Box2D.Dynamics.Joints { /** * The local anchor point relative to body1's origin. **/ - public localAnchorA: b2Math.b2Vec2; + public localAnchorA: Box2D.Common.Math.b2Vec2; /** * The local anchor point relative to body2's origin. **/ - public localAnchorB: b2Math.b2Vec2; + public localAnchorB: Box2D.Common.Math.b2Vec2; /** * The lower angle for the joint limit (radians). @@ -5453,7 +5444,7 @@ declare module Box2D.Dynamics.Joints { * @param bB Body B. * @param anchor Anchor. **/ - public Initialize(bA: b2Body, bB: b2Body, anchor: b2Math.b2Vec2): void; + public Initialize(bA: b2Body, bB: b2Body, anchor: Box2D.Common.Math.b2Vec2): void; } } @@ -5468,20 +5459,20 @@ declare module Box2D.Dynamics.Joints { * Get the anchor point on bodyA in world coordinates. * @return Body A anchor. **/ - public GetAnchorA(): b2Math.b2Vec2; + public GetAnchorA(): Box2D.Common.Math.b2Vec2; /** * Get the anchor point on bodyB in world coordinates. * @return Body B anchor. **/ - public GetAnchorB(): b2Math.b2Vec2; + public GetAnchorB(): Box2D.Common.Math.b2Vec2; /** * Get the reaction force on body2 at the joint anchor in N. * @param inv_dt * @return Reaction force in N. **/ - public GetReactionForce(inv_dt: number): b2Math.b2Vec2; + public GetReactionForce(inv_dt: number): Box2D.Common.Math.b2Vec2; /** * Get the reaction torque on body 2 in N. @@ -5502,12 +5493,12 @@ declare module Box2D.Dynamics.Joints { /** * The local anchor point relative to body1's origin. **/ - public localAnchorA: b2Math.b2Vec2; + public localAnchorA: Box2D.Common.Math.b2Vec2; /** * The local anchor point relative to body2's origin. **/ - public localAnchorB: b2Math.b2Vec2; + public localAnchorB: Box2D.Common.Math.b2Vec2; /** * The body2 angle minus body1 angle in the reference state (radians). @@ -5525,8 +5516,6 @@ declare module Box2D.Dynamics.Joints { * @param bB Body B. * @param anchor Anchor. **/ - public Initialize(bA: b2Body, bB: b2Body, anchor: b2Math.b2Vec2): void; + public Initialize(bA: b2Body, bB: b2Body, anchor: Box2D.Common.Math.b2Vec2): void; } } - - From cb2af0bfae14a3d930ee27aa5fc85d068dd6e21e Mon Sep 17 00:00:00 2001 From: Derek Cicerone Date: Sat, 29 Jun 2013 17:29:14 -0400 Subject: [PATCH 020/756] Replace bool with boolean (for TypeScript 0.9.0+) --- jquery/jquery.d.ts | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/jquery/jquery.d.ts b/jquery/jquery.d.ts index c175d25f55..c66b283f81 100644 --- a/jquery/jquery.d.ts +++ b/jquery/jquery.d.ts @@ -190,7 +190,7 @@ interface JQuerySupport { interface JQueryParam { (obj: any): string; - (obj: any, traditional: bool): string; + (obj: any, traditional: boolean): string; } /* @@ -224,7 +224,7 @@ interface JQueryStatic { Callbacks(flags?: string): JQueryCallback; // Core - holdReady(hold: bool): any; + holdReady(hold: boolean): any; (selector: string, context?: any): JQuery; (element: Element): JQuery; @@ -235,7 +235,7 @@ interface JQueryStatic { (array: any[]): JQuery; (): JQuery; - noConflict(removeAll?: bool): Object; + noConflict(removeAll?: boolean): Object; when(...deferreds: any[]): JQueryPromise; @@ -296,11 +296,11 @@ interface JQueryStatic { each(collection: T[], callback: (indexInArray: number, valueOfElement: T) => any): any; extend(target: any, ...objs: any[]): Object; - extend(deep: bool, target: any, ...objs: any[]): Object; + extend(deep: boolean, target: any, ...objs: any[]): Object; globalEval(code: string): any; - grep(array: T[], func: (elementOfArray: T, indexInArray: number) => boolean, invert?: bool): T[]; + grep(array: T[], func: (elementOfArray: T, indexInArray: number) => boolean, invert?: boolean): T[]; inArray(value: T, array: T[], fromIndex?: number): number; @@ -336,15 +336,15 @@ interface JQueryStatic { type(obj: any): string; unique(arr: any[]): any[]; - - /** + + /** * Parses a string into an array of DOM nodes. * * @param data HTML string to be parsed * @param context DOM element to serve as the context in which the HTML fragment will be created * @param keepScripts A Boolean indicating whether to include scripts passed in the HTML string */ - parseHTML(data: string, context?: HTMLElement, keepScripts?: bool): any[]; + parseHTML(data: string, context?: HTMLElement, keepScripts?: boolean): any[]; } /* @@ -396,8 +396,8 @@ interface JQuery { removeProp(propertyName: any): JQuery; - toggleClass(className: any, swtch?: bool): JQuery; - toggleClass(swtch?: bool): JQuery; + toggleClass(className: any, swtch?: boolean): JQuery; + toggleClass(swtch?: boolean): JQuery; toggleClass(func: (index: any, cls: any, swtch: any) => any): JQuery; val(): any; @@ -425,8 +425,8 @@ interface JQuery { offset(coordinates: any): JQuery; offset(func: (index: any, coords: any) => any): JQuery; - outerHeight(includeMargin?: bool): number; - outerWidth(includeMargin?: bool): number; + outerHeight(includeMargin?: boolean): number; + outerWidth(includeMargin?: boolean): number; position(): { top: number; left: number; }; @@ -491,17 +491,17 @@ interface JQuery { slideUp(duration?: any, callback?: any): JQuery; slideUp(duration?: any, easing?: string, callback?: any): JQuery; - stop(clearQueue?: bool, jumpToEnd?: bool): JQuery; - stop(queue?: any, clearQueue?: bool, jumpToEnd?: bool): JQuery; + stop(clearQueue?: boolean, jumpToEnd?: boolean): JQuery; + stop(queue?: any, clearQueue?: boolean, jumpToEnd?: boolean): JQuery; toggle(duration?: any, callback?: any): JQuery; toggle(duration?: any, easing?: string, callback?: any): JQuery; - toggle(showOrHide: bool): JQuery; + toggle(showOrHide: boolean): JQuery; // Events bind(eventType: string, eventData?: any, handler?: (eventObject: JQueryEventObject) => any): JQuery; - bind(eventType: string, eventData: any, preventBubble: bool): JQuery; - bind(eventType: string, preventBubble: bool): JQuery; + bind(eventType: string, eventData: any, preventBubble: boolean): JQuery; + bind(eventType: string, preventBubble: boolean): JQuery; bind(...events: any[]); blur(eventData?: any, handler?: (eventObject: JQueryEventObject) => any): JQuery; @@ -603,7 +603,7 @@ interface JQuery { triggerHandler(eventType: string, ...extraParameters: any[]): Object; unbind(eventType?: string, handler?: (eventObject: JQueryEventObject) => any): JQuery; - unbind(eventType: string, fls: bool): JQuery; + unbind(eventType: string, fls: boolean): JQuery; unbind(evt: any): JQuery; undelegate(): JQuery; @@ -636,7 +636,7 @@ interface JQuery { before(...content: any[]): JQuery; before(func: (index: any) => any); - clone(withDataAndEvents?: bool, deepWithDataAndEvents?: bool): JQuery; + clone(withDataAndEvents?: boolean, deepWithDataAndEvents?: boolean): JQuery; detach(selector?: any): JQuery; @@ -770,4 +770,4 @@ interface JQuery { } declare var jQuery: JQueryStatic; -declare var $: JQueryStatic; \ No newline at end of file +declare var $: JQueryStatic; From 9f6176c717483cb72cb8e4c26e1f903d70cce285 Mon Sep 17 00:00:00 2001 From: Derek Cicerone Date: Sat, 29 Jun 2013 17:32:44 -0400 Subject: [PATCH 021/756] Replace bool with boolean (for TypeScript 0.9.0+) --- moment/moment.d.ts | 144 ++++++++++++++++++++++----------------------- 1 file changed, 72 insertions(+), 72 deletions(-) diff --git a/moment/moment.d.ts b/moment/moment.d.ts index 7f8dc19d46..ec167e7767 100644 --- a/moment/moment.d.ts +++ b/moment/moment.d.ts @@ -56,7 +56,7 @@ interface Moment { format(format: string): string; format(): string; - fromNow(withoutSuffix?: bool): string; + fromNow(withoutSuffix?: boolean): string; startOf(soort: string): Moment; endOf(soort: string): Moment; @@ -75,7 +75,7 @@ interface Moment { utc(): Moment; // current date/time in UTC mode - isValid(): bool; + isValid(): boolean; year(y: number): Moment; year(): number; @@ -98,58 +98,58 @@ interface Moment { eod(): Moment; // End of Day from(f: Moment): string; - from(f: Moment, suffix: bool): string; + from(f: Moment, suffix: boolean): string; from(d: Date): string; from(s: string): string; from(date: number[]): string; diff(b: Moment): number; diff(b: Moment, soort: string): number; - diff(b: Moment, soort: string, round: bool): number; + diff(b: Moment, soort: string, round: boolean): number; toDate(): Date; unix(): number; - isLeapYear(): bool; + isLeapYear(): boolean; zone(): number; daysInMonth(): number; - isDST(): bool; + isDST(): boolean; - isBefore(b: Moment): bool; - isBefore(b: string): bool; - isBefore(b: Number): bool; - isBefore(b: Date): bool; - isBefore(b: Array): bool; - isBefore(b: Moment, granularity: string): bool; - isBefore(b: String, granularity: string): bool; - isBefore(b: Number, granularity: string): bool; - isBefore(b: Date, granularity: string): bool; - isBefore(b: Array, granularity: string): bool; + isBefore(b: Moment): boolean; + isBefore(b: string): boolean; + isBefore(b: Number): boolean; + isBefore(b: Date): boolean; + isBefore(b: Array): boolean; + isBefore(b: Moment, granularity: string): boolean; + isBefore(b: String, granularity: string): boolean; + isBefore(b: Number, granularity: string): boolean; + isBefore(b: Date, granularity: string): boolean; + isBefore(b: Array, granularity: string): boolean; - isAfter(b: Moment): bool; - isAfter(b: string): bool; - isAfter(b: Number): bool; - isAfter(b: Date): bool; - isAfter(b: Array): bool; - isAfter(b: Moment, granularity: string): bool; - isAfter(b: String, granularity: string): bool; - isAfter(b: Number, granularity: string): bool; - isAfter(b: Date, granularity: string): bool; - isAfter(b: Array, granularity: string): bool; + isAfter(b: Moment): boolean; + isAfter(b: string): boolean; + isAfter(b: Number): boolean; + isAfter(b: Date): boolean; + isAfter(b: Array): boolean; + isAfter(b: Moment, granularity: string): boolean; + isAfter(b: String, granularity: string): boolean; + isAfter(b: Number, granularity: string): boolean; + isAfter(b: Date, granularity: string): boolean; + isAfter(b: Array, granularity: string): boolean; - isSame(b: Moment): bool; - isSame(b: string): bool; - isSame(b: Number): bool; - isSame(b: Date): bool; - isSame(b: Array): bool; - isSame(b: Moment, granularity: string): bool; - isSame(b: String, granularity: string): bool; - isSame(b: Number, granularity: string): bool; - isSame(b: Date, granularity: string): bool; - isSame(b: Array, granularity: string): bool; + isSame(b: Moment): boolean; + isSame(b: string): boolean; + isSame(b: Number): boolean; + isSame(b: Date): boolean; + isSame(b: Array): boolean; + isSame(b: Moment, granularity: string): boolean; + isSame(b: String, granularity: string): boolean; + isSame(b: Number, granularity: string): boolean; + isSame(b: Date, granularity: string): boolean; + isSame(b: Array, granularity: string): boolean; lang(language: string); - lang(reset: bool); + lang(reset: boolean); lang(): string; } @@ -174,7 +174,7 @@ interface MomentLanguage { weekdaysMin?: any; longDateFormat?: MomentLongDateFormat; relativeTime?: MomentRelativeTime; - meridiem?: (hour: number, minute: number, isLowercase: bool) => string; + meridiem?: (hour: number, minute: number, isLowercase: boolean) => string; calendar?: MomentCalendar; ordinal?: (num: number) => string; @@ -196,7 +196,7 @@ interface MomentLongDateFormat { } interface MomentRelativeTime { - + future: any; past: any; s: any; @@ -233,8 +233,8 @@ interface MomentStatic { utc(String: string): Moment; // parse string into UTC mode utc(String1: string, String2: string): Moment; // parse a string and format into UTC mode - isMoment(): bool; - isMoment(m: any): bool; + isMoment(): boolean; + isMoment(m: any): boolean; lang(language: string); lang(language: string, definition: MomentLanguage); months: string[]; @@ -244,7 +244,7 @@ interface MomentStatic { weekdaysMin: string[]; longDateFormat: any; relativeTime: any; - meridiem: (hour: number, minute: number, isLowercase: bool) => string; + meridiem: (hour: number, minute: number, isLowercase: boolean) => string; calendar: any; ordinal: (num: number) => string; @@ -254,38 +254,38 @@ interface MomentStatic { duration(object: any): Duration; duration(): Duration; - isBefore(b: Moment): bool; - isBefore(b: string): bool; - isBefore(b: Number): bool; - isBefore(b: Date): bool; - isBefore(b: Array): bool; - isBefore(b: Moment, granularity: string): bool; - isBefore(b: String, granularity: string): bool; - isBefore(b: Number, granularity: string): bool; - isBefore(b: Date, granularity: string): bool; - isBefore(b: Array, granularity: string): bool; + isBefore(b: Moment): boolean; + isBefore(b: string): boolean; + isBefore(b: Number): boolean; + isBefore(b: Date): boolean; + isBefore(b: Array): boolean; + isBefore(b: Moment, granularity: string): boolean; + isBefore(b: String, granularity: string): boolean; + isBefore(b: Number, granularity: string): boolean; + isBefore(b: Date, granularity: string): boolean; + isBefore(b: Array, granularity: string): boolean; - isAfter(b: Moment): bool; - isAfter(b: string): bool; - isAfter(b: Number): bool; - isAfter(b: Date): bool; - isAfter(b: Array): bool; - isAfter(b: Moment, granularity: string): bool; - isAfter(b: String, granularity: string): bool; - isAfter(b: Number, granularity: string): bool; - isAfter(b: Date, granularity: string): bool; - isAfter(b: Array, granularity: string): bool; + isAfter(b: Moment): boolean; + isAfter(b: string): boolean; + isAfter(b: Number): boolean; + isAfter(b: Date): boolean; + isAfter(b: Array): boolean; + isAfter(b: Moment, granularity: string): boolean; + isAfter(b: String, granularity: string): boolean; + isAfter(b: Number, granularity: string): boolean; + isAfter(b: Date, granularity: string): boolean; + isAfter(b: Array, granularity: string): boolean; - isSame(b: Moment): bool; - isSame(b: string): bool; - isSame(b: Number): bool; - isSame(b: Date): bool; - isSame(b: Array): bool; - isSame(b: Moment, granularity: string): bool; - isSame(b: String, granularity: string): bool; - isSame(b: Number, granularity: string): bool; - isSame(b: Date, granularity: string): bool; - isSame(b: Array, granularity: string): bool; + isSame(b: Moment): boolean; + isSame(b: string): boolean; + isSame(b: Number): boolean; + isSame(b: Date): boolean; + isSame(b: Array): boolean; + isSame(b: Moment, granularity: string): boolean; + isSame(b: String, granularity: string): boolean; + isSame(b: Number, granularity: string): boolean; + isSame(b: Date, granularity: string): boolean; + isSame(b: Array, granularity: string): boolean; } declare var moment: MomentStatic; From 7463b0068110c5a5ae016582c7b0a83a51464a60 Mon Sep 17 00:00:00 2001 From: Andrew Gaspar Date: Sun, 30 Jun 2013 17:59:21 -0700 Subject: [PATCH 022/756] Made Q have better generics support made possible be v0.9.0.1. Also eliminated redundant function definitions in express. --- express/express.d.ts | 231 +++---------------------------------------- q/Q-tests.ts | 33 +++++-- q/Q.d.ts | 17 +++- 3 files changed, 51 insertions(+), 230 deletions(-) diff --git a/express/express.d.ts b/express/express.d.ts index d7ac6efd97..d2f994a468 100644 --- a/express/express.d.ts +++ b/express/express.d.ts @@ -780,6 +780,10 @@ interface ExpressServerResponse { charset: string; } +interface ExpressRequestFunction { + (req: ExpressServerRequest, res: ExpressServerResponse, next: Function): any; +} + interface ExpressApplication { /** * Initialize the server. @@ -1020,228 +1024,17 @@ interface ExpressApplication { render(name: string, fn: Function); - get (name: string): any; + get(name: string, ...handlers: ExpressRequestFunction[]): any; + get(name: RegExp, ...handlers: ExpressRequestFunction[]): any; - get (name: string, handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; + post(name: string, ...handlers: ExpressRequestFunction[]): any; + post(name: RegExp, ...handlers: ExpressRequestFunction[]): any; - get (name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; + put(name: string, ...handlers: ExpressRequestFunction[]): any; + put(name: RegExp, ...handlers: ExpressRequestFunction[]): any; - get (name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - get (name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - get (name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler5: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - get (name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler5: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - ...handlers: any[]): any; - - get (name: RegExp): any; - - get (name: RegExp, handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - get (name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - get (name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - get (name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - get (name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler5: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - ...handlers: any[]): any; - - post(name: string): any; - - post(name: string, handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - post(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - post(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - post(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - post(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler5: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - ...handlers: any[]): any; - - post(name: RegExp): any; - - post(name: RegExp, handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - post(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - post(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - post(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - post(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler5: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - ...handlers: any[]): any; - - put(name: string): any; - - put(name: string, handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - put(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - put(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - put(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - put(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler5: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - ...handlers: any[]): any; - - put(name: RegExp): any; - - put(name: RegExp, handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - put(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - put(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - put(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - put(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler5: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - ...handlers: any[]): any; - - del(name: string): any; - - del(name: string, handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - del(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - del(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - del(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - del(name: string, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler5: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - ...handlers: any[]): any; - - del(name: RegExp): any; - - del(name: RegExp, handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - del(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - del(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - del(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any): any; - - del(name: RegExp, - handler: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler2: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler3: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler4: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - handler5: (req: ExpressServerRequest, res: ExpressServerResponse, next: Function) => any, - ...handlers: any[]): any; + del(name: string, ...handlers: ExpressRequestFunction[]): any; + del(name: RegExp, ...handlers: ExpressRequestFunction[]): any; /** * Listen for connections. diff --git a/q/Q-tests.ts b/q/Q-tests.ts index f982ae8d68..6bdc5ff088 100644 --- a/q/Q-tests.ts +++ b/q/Q-tests.ts @@ -1,3 +1,4 @@ +/// /// import q = module('q'); @@ -40,14 +41,14 @@ Q.all([ Q.fcall(function () { }) -.then(function () { }) -.then(function () { }) -.then(function () { }) -.then(function (value4) { - // Do something with value4 -}, function (error) { - // Handle any error from step1 through step4 -}).done(); + .then(function () { }) + .then(function () { }) + .then(function () { }) + .then(function (value4) { + // Do something with value4 + }, function (error) { + // Handle any error from step1 through step4 + }).done(); Q.allResolved([]) .then(function (promises: Q.Promise[]) { @@ -58,4 +59,18 @@ Q.allResolved([]) var exception = promise.valueOf().exception; } }) -}); \ No newline at end of file +}); + +declare var arrayPromise: Q.IPromise; +declare var stringPromise: Q.IPromise; +declare function returnsNumPromise(text: string): Q.Promise; + +Q(arrayPromise) // type specification required + .then(arr => arr.join(',')) + .then(returnsNumPromise) // requires specification + .then(num => num.toFixed()); + +declare var jPromise: JQueryPromise; + +// if jQuery promises definition supported generics, this could be more interesting example +Q(jPromise).then((val) => val.toExponential()); \ No newline at end of file diff --git a/q/Q.d.ts b/q/Q.d.ts index 9fd4518f22..cadca16597 100644 --- a/q/Q.d.ts +++ b/q/Q.d.ts @@ -3,9 +3,17 @@ // Definitions by: Barrie Nemetchek, Andrew Gaspar // Definitions: https://github.com/borisyankov/DefinitelyTyped -declare function Q(value): Q.Promise; +declare function Q(value: T): Q.Promise; +declare function Q(promise: Q.IPromise): Q.Promise; declare module Q { + interface IPromise { + then(onFulfill: (value: T) => U, onReject?: (reason) => U): IPromise; + then(onFulfill: (value: T) => IPromise, onReject?: (reason) => U): IPromise; + then(onFulfill: (value: T) => U, onReject?: (reason) => IPromise): IPromise; + then(onFulfill: (value: T) => IPromise, onReject?: (reason) => IPromise): IPromise; + } + interface Deferred { promise: Promise; resolve(value: T): any; @@ -18,7 +26,12 @@ declare module Q { fail(errorCallback: Function): Promise; fin(finallyCallback: Function): Promise; finally(finallyCallback: Function): Promise; - then(onFulfilled?: (value: T) => any, onRejected?: (reason) => any, onProgress?: Function): Promise; + + then(onFulfill: (value: T) => U, onReject?: (reason) => U, onProgress?: Function): Promise; + then(onFulfill: (value: T) => IPromise, onReject?: (reason) => U, onProgress?: Function): Promise; + then(onFulfill: (value: T) => U, onReject?: (reason) => IPromise, onProgress?: Function): Promise; + then(onFulfill: (value: T) => IPromise, onReject?: (reason) => IPromise, onProgress?: Function): Promise; + spread(onFulfilled: Function, onRejected?: Function): Promise; catch(onRejected: Function): Promise; progress(onProgress: Function): Promise; From 054918bf52db7c785c7c5b86b17f5360f70fac4c Mon Sep 17 00:00:00 2001 From: Derek Cicerone Date: Sun, 30 Jun 2013 21:37:24 -0400 Subject: [PATCH 023/756] Update version number to 2.0.0 The isSame, isBefore, isAfter functions all appear to be new in 2.0.0. --- moment/moment.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/moment/moment.d.ts b/moment/moment.d.ts index ec167e7767..900c686faa 100644 --- a/moment/moment.d.ts +++ b/moment/moment.d.ts @@ -1,4 +1,4 @@ -// Type definitions for Moment.js 1.7 +// Type definitions for Moment.js 2.0.0 // Project: https://github.com/timrwood/moment // Definitions by: Michael Lakerveld // DefinitelyTyped: https://github.com/borisyankov/DefinitelyTyped From 1a2fced0c6367a8e3d4021be48ab1a291e89b6d2 Mon Sep 17 00:00:00 2001 From: Andrew Davey Date: Mon, 1 Jul 2013 10:12:54 +0100 Subject: [PATCH 024/756] Re-add getColor.reset() This is compatible with TypeScript 0.9. --- raphael/raphael.d.ts | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/raphael/raphael.d.ts b/raphael/raphael.d.ts index fc8503cd39..26a183d2d1 100644 --- a/raphael/raphael.d.ts +++ b/raphael/raphael.d.ts @@ -244,7 +244,10 @@ interface RaphaelStatic { fn: any; format(token: string, ...parameters: any[]): string; fullfill(token: string, json: JSON): string; - getColor(value?: number): string; + getColor { + (value?: number): string; + reset(); + }; getPointAtLength(path: string, length: number): { x: number; y: number; alpha: number; }; getRGB(colour: string): { r: number; g: number; b: number; hex: string; error: bool; }; getSubpath(path: string, from: number, to: number): string; @@ -287,4 +290,4 @@ interface RaphaelStatic { vml: bool; } -declare var Raphael: RaphaelStatic; \ No newline at end of file +declare var Raphael: RaphaelStatic; From 7da6a8af84767086fee293fb11e2a2fe0378a0e0 Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Mon, 1 Jul 2013 20:16:22 +0100 Subject: [PATCH 025/756] Strongly type fullcalendar methods --- fullCalendar/fullCalendar-tests.ts | 4 ++-- fullCalendar/fullCalendar.d.ts | 28 +++++++++++++++++++++++++++- 2 files changed, 29 insertions(+), 3 deletions(-) diff --git a/fullCalendar/fullCalendar-tests.ts b/fullCalendar/fullCalendar-tests.ts index a85dd1d6e9..6c60f3ddb3 100644 --- a/fullCalendar/fullCalendar-tests.ts +++ b/fullCalendar/fullCalendar-tests.ts @@ -87,7 +87,7 @@ $('#calendar').fullCalendar({ } }); -var view: FullCalendar.View = $('#calendar').fullCalendar('getView'); +var view = $('#calendar').fullCalendar('getView'); alert("The view's title is " + view.title); $(document).ready(function () { @@ -407,7 +407,7 @@ $('#my-today-button').click(function () { $('#calendar').fullCalendar('gotoDate', 1, 0, 1); $('#my-button').click(function () { - var d: Date = $('#calendar').fullCalendar('getDate'); + var d = $('#calendar').fullCalendar('getDate'); alert("The current date of the calendar is " + d); }); diff --git a/fullCalendar/fullCalendar.d.ts b/fullCalendar/fullCalendar.d.ts index d11c68e046..b26920dc21 100644 --- a/fullCalendar/fullCalendar.d.ts +++ b/fullCalendar/fullCalendar.d.ts @@ -180,7 +180,33 @@ declare module FullCalendar { interface JQuery { fullCalendar(options: FullCalendar.Options): JQuery; - fullCalendar(method: string, ...args: Array): JQuery; + fullCalendar(method: string, arg1: any, arg2: any, arg3: any): void; + fullCalendar(method: 'option', option: string, value?: any): void; + fullCalendar(method: 'render'): void; + fullCalendar(method: 'destroy'): void; + fullCalendar(method: 'prev'): void; + fullCalendar(method: 'next'): void; + fullCalendar(method: 'prevYear'): void; + fullCalendar(method: 'nextYear'): void; + fullCalendar(method: 'today'): void; + fullCalendar(method: 'getView'): FullCalendar.View; + fullCalendar(method: 'changeView', viewName: string): void; + fullCalendar(method: 'gotoDate', year: number, month?: number, date?: number): void; + fullCalendar(method: 'gotoDate', date: Date): void; + fullCalendar(method: 'incrementDate', year: number, month?: number, date?: number): void; + fullCalendar(method: 'getDate'): Date; + fullCalendar(method: 'select', startDate: Date, endDate: Date, allDay: boolean): void; + fullCalendar(method: 'unselect'): void; + fullCalendar(method: 'updateEvent', event: FullCalendar.EventObject): void; + fullCalendar(method: 'clientEvents', idOrfilter?: any): Array; + fullCalendar(method: 'clientEvents', idOrfilter?: (e: FullCalendar.EventObject) => boolean): Array; + fullCalendar(method: 'removeEvents', idOrfilter?: any): void; + fullCalendar(method: 'removeEvents', idOrfilter?: (e: FullCalendar.EventObject) => boolean): void; + fullCalendar(method: 'refreshEvents'): void; + fullCalendar(method: 'addEventSource', source: any): void; + fullCalendar(method: 'removeEventSource', source: any): void; + fullCalendar(method: 'renderEvent', event: FullCalendar.EventObject, stick?: boolean): void; + fullCalendar(method: 'rerenderEvents'): void; } interface JQueryStatic { From f90f624aefb0d9bff547a8b9c17bff6e61042e47 Mon Sep 17 00:00:00 2001 From: Carl de Billy Date: Mon, 1 Jul 2013 15:36:58 -0400 Subject: [PATCH 026/756] Fixed broken declarations of the upgrade to 0.9 --- rx.js/rx.js.aggregates.d.ts | 12 +- rx.js/rx.js.d.ts | 793 ++++++++++++++++++------------------ rx.js/rx.js.html.d.ts | 6 +- rx.js/rx.js.time.d.ts | 10 +- 4 files changed, 408 insertions(+), 413 deletions(-) diff --git a/rx.js/rx.js.aggregates.d.ts b/rx.js/rx.js.aggregates.d.ts index 92ab499894..7c10866a6e 100644 --- a/rx.js/rx.js.aggregates.d.ts +++ b/rx.js/rx.js.aggregates.d.ts @@ -6,11 +6,11 @@ /// declare module Rx { - export module Observable { - function all(predicate?: (any) => bool): IObservable; - function min(predicate?: (any) => bool): IObservable; - function max(predicate?: (any) => bool): IObservable; - function count(predicate?: (any) => bool): IObservable; - function sum(keySelector?: (any) => any): IObservable; + interface Observable { + all(predicate?: (any) => bool): IObservable; + min(predicate?: (any) => bool): IObservable; + max(predicate?: (any) => bool): IObservable; + count(predicate?: (any) => bool): IObservable; + sum(keySelector?: (any) => any): IObservable; } } \ No newline at end of file diff --git a/rx.js/rx.js.d.ts b/rx.js/rx.js.d.ts index 481603a7c7..543fb703de 100644 --- a/rx.js/rx.js.d.ts +++ b/rx.js/rx.js.d.ts @@ -5,462 +5,457 @@ declare module Rx { - export module Internals { - function inherits(child: Function, parent: Function): Function; - function addProperties(obj: Object, ...sourcces: Object[]): void; - function addRef(xs: IObservable, r: { getDisposable(): _IDisposable; }): IObservable; - } + export module Internals { + function inherits(child: Function, parent: Function): Function; + function addProperties(obj: Object, ...sourcces: Object[]): void; + function addRef(xs: IObservable, r: { getDisposable(): _IDisposable; }): IObservable; + } - //Collections - interface IIndexedItem { - id: number; - value: IScheduledItem; + //Collections + interface IIndexedItem { + id: number; + value: IScheduledItem; - compareTo(other: IIndexedItem): number; - } + compareTo(other: IIndexedItem): number; + } - // Priority Queue for Scheduling - interface IPriorityQueue { - items: IIndexedItem[]; - length: number; + // Priority Queue for Scheduling + interface IPriorityQueue { + items: IIndexedItem[]; + length: number; - isHigherPriority(left: number, right: number): bool; - percolate(index: number): void; - heapify(index: number): void; - peek(): IIndexedItem; - removeAt(index: number): void; - dequeue(): IIndexedItem; - enqueue(item: IIndexedItem): void; - remove(item: IIndexedItem): bool; - } + isHigherPriority(left: number, right: number): bool; + percolate(index: number): void; + heapify(index: number): void; + peek(): IIndexedItem; + removeAt(index: number): void; + dequeue(): IIndexedItem; + enqueue(item: IIndexedItem): void; + remove(item: IIndexedItem): bool; + } - interface _IDisposable { - dispose(): void; - } + interface _IDisposable { + dispose(): void; + } - interface ICompositeDisposable { - disposables: _IDisposable[]; - isDisposed: bool; - length: number; + export class CompositeDisposable { + constructor (...disposables: _IDisposable[]); - dispose(): void; - add(item: _IDisposable): void; - remove(item: _IDisposable): bool; - clear(): void; - contains(item: _IDisposable): bool; - toArray(): _IDisposable[]; - } - export interface CompositeDisposable { - (...disposables: _IDisposable[]): ICompositeDisposable; - } + disposables: _IDisposable[]; + isDisposed: bool; + length: number; - // Main disposable class - interface IDisposable { - isDisposed: bool; - action: () =>void; + dispose(): void; + add(item: _IDisposable): void; + remove(item: _IDisposable): bool; + clear(): void; + contains(item: _IDisposable): bool; + toArray(): _IDisposable[]; + } - dispose(): void; - } - export interface Disposable { - (action: () =>void ): IDisposable; + // Main disposable class + interface IDisposable { + isDisposed: bool; + action: () =>void; - create(action: () =>void ): _IDisposable; - empty: _IDisposable; - } + dispose(): void; + } + export interface Disposable { + (action: () =>void ): IDisposable; - // Single assignment - interface ISingleAssignmentDisposable { - isDisposed: bool; - current: _IDisposable; + create(action: () =>void ): _IDisposable; + empty: _IDisposable; + } - dispose(): void; - disposable(value?: _IDisposable): _IDisposable; - getDisposable(): _IDisposable; - setDisposable(value: _IDisposable): void; - } - export interface SingleAssignmentDisposable { - (): ISingleAssignmentDisposable; - } + // Single assignment + interface ISingleAssignmentDisposable { + isDisposed: bool; + current: _IDisposable; - // Multiple assignment disposable - interface ISerialDisposable { - isDisposed: bool; - current: _IDisposable; + dispose(): void; + disposable(value?: _IDisposable): _IDisposable; + getDisposable(): _IDisposable; + setDisposable(value: _IDisposable): void; + } + export interface SingleAssignmentDisposable { + (): ISingleAssignmentDisposable; + } - dispose(): void; - getDisposable(): _IDisposable; - setDisposable(value: _IDisposable): void; - disposable(value?: _IDisposable): _IDisposable; - } - export interface SerialDisposable { - (): ISerialDisposable; - } + // Multiple assignment disposable + export class SerialDisposable { + isDisposed: bool; + current: _IDisposable; - interface IRefCountDisposable { - underlyingDisposable: _IDisposable; - isDisposed: bool; - isPrimaryDisposed: bool; - count: number; + dispose(): void; + getDisposable(): _IDisposable; + setDisposable(value: _IDisposable): void; + disposable(value?: _IDisposable): _IDisposable; + } - dispose(): void; - getDisposable(): _IDisposable; - } - export interface RefCountDisposable { - (disposable: _IDisposable): IRefCountDisposable; - } + export class RefCountDisposable { + constructor(disposable: _IDisposable); - interface IScheduledItem { - scheduler: IScheduler; - state: any; - action: (scheduler: IScheduler, state) => _IDisposable; - dueTime: number; - comparer: (x: number, y: number) =>number; - disposable: ISingleAssignmentDisposable; + underlyingDisposable: _IDisposable; + isDisposed: bool; + isPrimaryDisposed: bool; + count: number; - invoke(): void; - compareTo(other: IScheduledItem): number; - isCancelled(): bool; - invokeCore(): _IDisposable; - } + dispose(): void; + getDisposable(): _IDisposable; + } - interface IScheduler { - _schedule: (state: any, action: (scheduler: IScheduler, state: any) =>_IDisposable) => _IDisposable; - _scheduleRelative: (state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable) =>_IDisposable; - _scheduleAbsolute: (state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable) =>_IDisposable; + interface IScheduledItem { + scheduler: IScheduler; + state: any; + action: (scheduler: IScheduler, state) => _IDisposable; + dueTime: number; + comparer: (x: number, y: number) =>number; + disposable: ISingleAssignmentDisposable; - now(): number; - scheduleWithState(state: any, action: (scheduler: IScheduler, state: any) =>_IDisposable): _IDisposable; - scheduleWithAbsoluteAndState(state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable): _IDisposable; - scheduleWithRelativeAndState(state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable): _IDisposable; + invoke(): void; + compareTo(other: IScheduledItem): number; + isCancelled(): bool; + invokeCore(): _IDisposable; + } - catchException(handler: (exception: any) =>bool): ICatchScheduler; - schedulePeriodic(period: number, action: () =>void ): _IDisposable; - schedulePeriodicWithState(state: any, period: number, action: (state: any) =>any): _IDisposable;//returns {Disposable|SingleAssignmentDisposable} - schedule(action: () =>void ): _IDisposable; - scheduleWithRelative(dueTime: number, action: () =>void ): _IDisposable; - scheduleWithAbsolute(dueTime: number, action: () =>void ): _IDisposable; - scheduleRecursive(action: (action: () =>void ) =>void ): _IDisposable; - scheduleRecursiveWithState(state: any, action: (state: any, action: (state: any) =>void ) =>void ): _IDisposable; - scheduleRecursiveWithRelative(dueTime: number, action: (action: (dueTime: number) =>void ) =>void ): _IDisposable; - scheduleRecursiveWithRelativeAndState(state: any, dueTime: number, action: (state: any, action: (state: any, dueTime: number) =>void ) =>void ): _IDisposable; - scheduleRecursiveWithAbsolute(dueTime: number, action: (action: (dueTime: number) =>void ) =>void ): _IDisposable; - scheduleRecursiveWithAbsoluteAndState(state: any, dueTime: number, action: (state: any, action: (state: any, dueTime: number) =>void ) =>void ): _IDisposable; - } - export interface Scheduler { - (now: () =>number, - schedule: (state: any, action: (scheduler: IScheduler, state: any) =>_IDisposable) => _IDisposable, - scheduleRelative: (state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable) =>_IDisposable, - scheduleAbsolute: (state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable) =>_IDisposable - ): IScheduler; + interface IScheduler { + _schedule: (state: any, action: (scheduler: IScheduler, state: any) =>_IDisposable) => _IDisposable; + _scheduleRelative: (state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable) =>_IDisposable; + _scheduleAbsolute: (state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable) =>_IDisposable; - now(): number; - normalize(timeSpan: number): number; + now(): number; + scheduleWithState(state: any, action: (scheduler: IScheduler, state: any) =>_IDisposable): _IDisposable; + scheduleWithAbsoluteAndState(state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable): _IDisposable; + scheduleWithRelativeAndState(state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable): _IDisposable; - immediate: IScheduler; - currentThread: ICurrentScheduler;//IScheduler; - timeout: IScheduler; - } + catchException(handler: (exception: any) =>bool): ICatchScheduler; + schedulePeriodic(period: number, action: () =>void ): _IDisposable; + schedulePeriodicWithState(state: any, period: number, action: (state: any) =>any): _IDisposable;//returns {Disposable|SingleAssignmentDisposable} + schedule(action: () =>void ): _IDisposable; + scheduleWithRelative(dueTime: number, action: () =>void ): _IDisposable; + scheduleWithAbsolute(dueTime: number, action: () =>void ): _IDisposable; + scheduleRecursive(action: (action: () =>void ) =>void ): _IDisposable; + scheduleRecursiveWithState(state: any, action: (state: any, action: (state: any) =>void ) =>void ): _IDisposable; + scheduleRecursiveWithRelative(dueTime: number, action: (action: (dueTime: number) =>void ) =>void ): _IDisposable; + scheduleRecursiveWithRelativeAndState(state: any, dueTime: number, action: (state: any, action: (state: any, dueTime: number) =>void ) =>void ): _IDisposable; + scheduleRecursiveWithAbsolute(dueTime: number, action: (action: (dueTime: number) =>void ) =>void ): _IDisposable; + scheduleRecursiveWithAbsoluteAndState(state: any, dueTime: number, action: (state: any, action: (state: any, dueTime: number) =>void ) =>void ): _IDisposable; + } + export interface Scheduler { + (now: () =>number, + schedule: (state: any, action: (scheduler: IScheduler, state: any) =>_IDisposable) => _IDisposable, + scheduleRelative: (state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable) =>_IDisposable, + scheduleAbsolute: (state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable) =>_IDisposable + ): IScheduler; - // Current Thread IScheduler - interface ICurrentScheduler extends IScheduler { - scheduleRequired(): bool; - ensureTrampoline(action: () =>_IDisposable): _IDisposable; - } + now(): number; + normalize(timeSpan: number): number; - // Virtual IScheduler - interface IVirtualTimeScheduler extends IScheduler { - toRelative(duetime): number; - toDateTimeOffset(duetime: number): number; + immediate: IScheduler; + currentThread: ICurrentScheduler;//IScheduler; + timeout: IScheduler; + } - clock: number; - comparer: (x: number, y: number) =>number; - isEnabled: bool; - queue: IPriorityQueue; - scheduleRelativeWithState(state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable): _IDisposable; - scheduleRelative(dueTime: number, action: () =>void ): _IDisposable; - start(): _IDisposable; - stop(): void; - advanceTo(time: number); - advanceBy(time: number); - sleep(time: number); - getNext(): IScheduledItem; - scheduleAbsolute(dueTime: number, action: () =>void ); - scheduleAbsoluteWithState(state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable): _IDisposable; - } - //export module VirtualTimeScheduler { - // //absract - // function new (initialClock: number, comparer: (x: number, y: number) =>number): IVirtualTimeScheduler; - //} + // Current Thread IScheduler + interface ICurrentScheduler extends IScheduler { + scheduleRequired(): bool; + ensureTrampoline(action: () =>_IDisposable): _IDisposable; + } + + // Virtual IScheduler + interface IVirtualTimeScheduler extends IScheduler { + toRelative(duetime): number; + toDateTimeOffset(duetime: number): number; + + clock: number; + comparer: (x: number, y: number) =>number; + isEnabled: bool; + queue: IPriorityQueue; + scheduleRelativeWithState(state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable): _IDisposable; + scheduleRelative(dueTime: number, action: () =>void ): _IDisposable; + start(): _IDisposable; + stop(): void; + advanceTo(time: number); + advanceBy(time: number); + sleep(time: number); + getNext(): IScheduledItem; + scheduleAbsolute(dueTime: number, action: () =>void ); + scheduleAbsoluteWithState(state: any, dueTime: number, action: (scheduler: IScheduler, state: any) =>_IDisposable): _IDisposable; + } + //export module VirtualTimeScheduler { + // //absract + // function new (initialClock: number, comparer: (x: number, y: number) =>number): IVirtualTimeScheduler; + //} - // CatchScheduler - interface ICatchScheduler extends IScheduler { } + // CatchScheduler + interface ICatchScheduler extends IScheduler { } - // Notifications - interface INotification { - accept(observer: IObserver): void; - accept(onNext: (value: any) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): void; - toObservable(scheduler?: IScheduler): IObservable; - hasValue: bool; - equals(other: INotification): bool; - kind: string; - value?: any; - exception?: any; - } - export interface Notification { - //abstract - //function new (): INotification; + // Notifications + interface INotification { + accept(observer: IObserver): void; + accept(onNext: (value: any) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): void; + toObservable(scheduler?: IScheduler): IObservable; + hasValue: bool; + equals(other: INotification): bool; + kind: string; + value?: any; + exception?: any; + } + export interface Notification { + //abstract + //function new (): INotification; - createOnNext(value: any): INotification;//ON - createOnError(exception): INotification;//OE - createOnCompleted(): INotification;//OC - } + createOnNext(value: any): INotification;//ON + createOnError(exception): INotification;//OE + createOnCompleted(): INotification;//OC + } - export module Internals { - // Enumerator - interface IEnumerator { - moveNext(): bool; - getCurrent(): any; - dispose(): void; - } - export interface Enumerator { - (moveNext: () =>bool, getCurrent: () => any, dispose: () =>void ): IEnumerator; + var Notification: Notification; - create(moveNext: () =>bool, getCurrent: () =>any, dispose?: () =>void ): IEnumerator; - } + export module Internals { + // Enumerator + interface IEnumerator { + moveNext(): bool; + getCurrent(): any; + dispose(): void; + } + export interface Enumerator { + (moveNext: () =>bool, getCurrent: () => any, dispose: () =>void ): IEnumerator; - // Enumerable - interface IEnumerable { - getEnumerator(): IEnumerator; + create(moveNext: () =>bool, getCurrent: () =>any, dispose?: () =>void ): IEnumerator; + } - concat(): IObservable; - catchException(): IObservable; - } - export interface Enumerable { - (getEnumerator: () =>IEnumerator): IEnumerable; + // Enumerable + interface IEnumerable { + getEnumerator(): IEnumerator; - repeat(value: any, repeatCount?: number): IEnumerable; - forEach(source: any[], selector?: (element: any, index: number) =>any): IEnumerable; - forEach(source: { length: number;[index: number]: any; }, selector?: (element: any, index: number) =>any): IEnumerable; - } - } + concat(): IObservable; + catchException(): IObservable; + } + export interface Enumerable { + (getEnumerator: () =>IEnumerator): IEnumerable; - // Observer - interface IObserver { - onNext(value: any): void; - onError(exception: any): void; - onCompleted(): void; + repeat(value: any, repeatCount?: number): IEnumerable; + forEach(source: any[], selector?: (element: any, index: number) =>any): IEnumerable; + forEach(source: { length: number;[index: number]: any; }, selector?: (element: any, index: number) =>any): IEnumerable; + } + } - toNotifier(): (notification: INotification) =>void; - asObserver(): IObserver; - checked(): ICheckedObserver; - } - export module Observer { - //abstract - //function new (): IObserver; + // Observer + interface IObserver { + onNext(value: any): void; + onError(exception: any): void; + onCompleted(): void; - function create(onNext: (value: any) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): IObserver; - function fromNotifier(handler: (notification: INotification) =>void ): IObserver; - } + toNotifier(): (notification: INotification) =>void; + asObserver(): IObserver; + checked(): ICheckedObserver; + } + export module Observer { + //abstract + //function new (): IObserver; - export module Internals { - // Abstract Observer - interface IAbstractObserver extends IObserver { - isStopped: bool; + function create(onNext: (value: any) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): IObserver; + function fromNotifier(handler: (notification: INotification) =>void ): IObserver; + } - dispose(): void; - next(value: any): void; - error(exception: any): void; - completed(): void; - fail(): bool; - } - //export module AbstractObserver { - // //abstract - // function new (): IAbstractObserver; - //} - } + export module Internals { + // Abstract Observer + interface IAbstractObserver extends IObserver { + isStopped: bool; - interface IAnonymousObserver extends Internals.IAbstractObserver { - _onNext: (value: any) =>void; - _onError: (exception: any) =>void; - _onCompleted: () =>void; - } - export interface AnonymousObserver { - (onNext: (value: any) =>void , onError: (exception: any) =>void , onCompleted: () =>void ): IAnonymousObserver; - } + dispose(): void; + next(value: any): void; + error(exception: any): void; + completed(): void; + fail(): bool; + } + //export module AbstractObserver { + // //abstract + // function new (): IAbstractObserver; + //} + } - interface ICheckedObserver extends IObserver { - _observer: IObserver; - _state: number; // 0 - idle, 1 - busy, 2 - done - checkAccess(): void; - } + export class AnonymousObserver { + constructor(onNext: (value: any) => void , onError: (exception: any) => void , onCompleted: () => void); + } - export module Internals { - interface IScheduledObserver extends IAbstractObserver { - scheduler: IScheduler; - observer: IObserver; - isAcquired: bool; - hasFaulted: bool; - //queue: { (value: any): void; (exception: any): void; (): void; }[]; - disposable: ISerialDisposable; + interface ICheckedObserver extends IObserver { + _observer: IObserver; + _state: number; // 0 - idle, 1 - busy, 2 - done + checkAccess(): void; + } - ensureActive(): void; - } - export interface ScheduledObserver { - (scheduler: IScheduler, observer: IObserver): IScheduledObserver; - } - } + export module Internals { + interface IScheduledObserver extends IAbstractObserver { + scheduler: IScheduler; + observer: IObserver; + isAcquired: bool; + hasFaulted: bool; + //queue: { (value: any): void; (exception: any): void; (): void; }[]; + disposable: SerialDisposable; + + ensureActive(): void; + } + export interface ScheduledObserver { + (scheduler: IScheduler, observer: IObserver): IScheduledObserver; + } + } - interface IObservable { - _subscribe: (observer: IObserver) =>_IDisposable; + interface IObservable { + _subscribe: (observer: IObserver) =>_IDisposable; - subscribe(observer: IObserver): _IDisposable; + subscribe(observer: IObserver): _IDisposable; - finalValue(): IObservable; - subscribe(onNext?: (value: any) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): _IDisposable; - toArray(): IObservable; + finalValue(): IObservable; + subscribe(onNext?: (value: any) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): _IDisposable; + toArray(): IObservable; - observeOn(scheduler: IScheduler): IObservable; - subscribeOn(scheduler: IScheduler): IObservable; - amb(rightSource: IObservable): IObservable; - catchException(handler: (exception: any) =>IObservable): IObservable; - catchException(second: IObservable): IObservable; - combineLatest(second: IObservable, resultSelector: (v1: any, v2: any) =>any): IObservable; - combineLatest(second: IObservable, third: IObservable, resultSelector: (v1: any, v2: any, v3: any) =>any): IObservable; - combineLatest(second: IObservable, third: IObservable, fourth: IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any) =>any): IObservable; - combineLatest(second: IObservable, third: IObservable, fourth: IObservable, fifth, IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any, v5: any) =>any): IObservable; - combineLatest(...soucesAndResultSelector: any[]): IObservable; - concat(...sources: IObservable[]): IObservable; - concat(sources: IObservable[]): IObservable; - concatIObservable(): IObservable; - merge(maxConcurrent: number): IObservable; - merge(other: IObservable): IObservable; - mergeIObservable(): IObservable; - onErrorResumeNext(second: IObservable): IObservable; - skipUntil(other: IObservable): IObservable; - switchLatest(): IObservable; - takeUntil(other: IObservable): IObservable; - zip(second: IObservable, resultSelector: (v1: any, v2: any) =>any): IObservable; - zip(second: IObservable, third: IObservable, resultSelector: (v1: any, v2: any, v3: any) =>any): IObservable; - zip(second: IObservable, third: IObservable, fourth: IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any) =>any): IObservable; - zip(second: IObservable, third: IObservable, fourth: IObservable, fifth, IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any, v5: any) =>any): IObservable; - zip(...soucesAndResultSelector: any[]): IObservable; - zip(second: any[], resultSelector: (left: any, right: any) =>any): IObservable; - asIObservable(): IObservable; - bufferWithCount(count: number, skip?: number): IObservable; - dematerialize(): IObservable; - distinctUntilChanged(keySelector?: (value: any) =>any, comparer?: (x: any, y: any) =>bool): IObservable; - doAction(observer: IObserver): IObservable; - doAction(onNext: (value: any) => void , onError?: (exception: any) =>void , onCompleted?: () =>void ): IObservable; - finallyAction(action: () =>void ): IObservable; - ignoreElements(): IObservable; - materialize(): IObservable; - repeat(repeatCount?: number): IObservable; - retry(retryCount?: number): IObservable; - scan(seed: any, accumulator: (acc: any, value: any) =>any): IObservable; - scan(accumulator: (acc: any, value: any) =>any): IObservable; - skipLast(count: number): IObservable; - startWith(...values: any[]): IObservable; - startWith(scheduler: IScheduler, ...values: any[]): IObservable; - takeLast(count: number, scheduler?: IScheduler): IObservable; - takeLastBuffer(count: number): IObservable; - windowWithCount(count: number, skip?: number): IObservable; - defaultIfEmpty(defaultValue?: any): IObservable; - distinct(keySelector?: (value: any) =>any, keySerializer?: (key: any) =>string): IObservable; - groupBy(keySelector: (value: any) =>any, elementSelector?: (value: any) =>any, keySerializer?: (key: any) =>string): IGroupedObservable; - groupByUntil(keySelector: (value: any) =>any, elementSelector: (value: any) =>any, durationSelector: (gloup: IGroupedObservable) =>IObservable, keySerializer?: (key: any) =>string): IGroupedObservable; - select(selector: (value: any, index: number) =>any): IObservable; - selectMany(selector: (value: any) =>IObservable, resultSelector?: (x: any, y: any) =>any): IObservable; - selectMany(other: IObservable): IObservable; - skip(count: number): IObservable; - skipWhile(predicate: (value: any, index?: number) =>bool): IObservable; - take(count: number, scheduler?: IScheduler): IObservable; - takeWhile(predicate: (value: any, index?: number) =>bool): IObservable; - where(predicate: (value: any, index?: number) => bool): IObservable; + observeOn(scheduler: IScheduler): IObservable; + subscribeOn(scheduler: IScheduler): IObservable; + amb(rightSource: IObservable): IObservable; + catchException(handler: (exception: any) =>IObservable): IObservable; + catchException(second: IObservable): IObservable; + combineLatest(second: IObservable, resultSelector: (v1: any, v2: any) =>any): IObservable; + combineLatest(second: IObservable, third: IObservable, resultSelector: (v1: any, v2: any, v3: any) =>any): IObservable; + combineLatest(second: IObservable, third: IObservable, fourth: IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any) =>any): IObservable; + combineLatest(second: IObservable, third: IObservable, fourth: IObservable, fifth, IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any, v5: any) =>any): IObservable; + combineLatest(...soucesAndResultSelector: any[]): IObservable; + concat(...sources: IObservable[]): IObservable; + concat(sources: IObservable[]): IObservable; + concatIObservable(): IObservable; + merge(maxConcurrent: number): IObservable; + merge(other: IObservable): IObservable; + mergeIObservable(): IObservable; + onErrorResumeNext(second: IObservable): IObservable; + skipUntil(other: IObservable): IObservable; + switchLatest(): IObservable; + takeUntil(other: IObservable): IObservable; + zip(second: IObservable, resultSelector: (v1: any, v2: any) =>any): IObservable; + zip(second: IObservable, third: IObservable, resultSelector: (v1: any, v2: any, v3: any) =>any): IObservable; + zip(second: IObservable, third: IObservable, fourth: IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any) =>any): IObservable; + zip(second: IObservable, third: IObservable, fourth: IObservable, fifth, IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any, v5: any) =>any): IObservable; + zip(...soucesAndResultSelector: any[]): IObservable; + zip(second: any[], resultSelector: (left: any, right: any) =>any): IObservable; + asIObservable(): IObservable; + bufferWithCount(count: number, skip?: number): IObservable; + dematerialize(): IObservable; + distinctUntilChanged(keySelector?: (value: any) =>any, comparer?: (x: any, y: any) =>bool): IObservable; + doAction(observer: IObserver): IObservable; + doAction(onNext: (value: any) => void , onError?: (exception: any) =>void , onCompleted?: () =>void ): IObservable; + finallyAction(action: () =>void ): IObservable; + ignoreElements(): IObservable; + materialize(): IObservable; + repeat(repeatCount?: number): IObservable; + retry(retryCount?: number): IObservable; + scan(seed: any, accumulator: (acc: any, value: any) =>any): IObservable; + scan(accumulator: (acc: any, value: any) =>any): IObservable; + skipLast(count: number): IObservable; + startWith(...values: any[]): IObservable; + startWith(scheduler: IScheduler, ...values: any[]): IObservable; + takeLast(count: number, scheduler?: IScheduler): IObservable; + takeLastBuffer(count: number): IObservable; + windowWithCount(count: number, skip?: number): IObservable; + defaultIfEmpty(defaultValue?: any): IObservable; + distinct(keySelector?: (value: any) =>any, keySerializer?: (key: any) =>string): IObservable; + groupBy(keySelector: (value: any) =>any, elementSelector?: (value: any) =>any, keySerializer?: (key: any) =>string): IGroupedObservable; + groupByUntil(keySelector: (value: any) =>any, elementSelector: (value: any) =>any, durationSelector: (gloup: IGroupedObservable) =>IObservable, keySerializer?: (key: any) =>string): IGroupedObservable; + select(selector: (value: any, index: number) =>any): IObservable; + selectMany(selector: (value: any) =>IObservable, resultSelector?: (x: any, y: any) =>any): IObservable; + selectMany(other: IObservable): IObservable; + skip(count: number): IObservable; + skipWhile(predicate: (value: any, index?: number) =>bool): IObservable; + take(count: number, scheduler?: IScheduler): IObservable; + takeWhile(predicate: (value: any, index?: number) =>bool): IObservable; + where(predicate: (value: any, index?: number) => bool): IObservable; - // time - delay(dueTime: number, scheduler?: IScheduler): IObservable; - throttle(dueTime: number, scheduler?: IScheduler): IObservable; - windowWithTime(dueTime: number, timeShiftOrScheduler?: any, scheduler?: IScheduler): IObservable; - timeInterval(scheduler: IScheduler): IObservable; - sample(interval: number, scheduler?: IScheduler): IObservable; - sample(sampler: IObservable, scheduler?: IScheduler): IObservable; - timeout(dueTime: number, other?: IObservable, scheduler?: IScheduler): IObservable; - delaySubscription(dueTime: number, scheduler?: IScheduler): IObservable; - } - export interface Observable { - (subscribe: (observer: IObserver) =>_IDisposable): IObservable; + // time + delay(dueTime: number, scheduler?: IScheduler): IObservable; + throttle(dueTime: number, scheduler?: IScheduler): IObservable; + windowWithTime(dueTime: number, timeShiftOrScheduler?: any, scheduler?: IScheduler): IObservable; + timeInterval(scheduler: IScheduler): IObservable; + sample(interval: number, scheduler?: IScheduler): IObservable; + sample(sampler: IObservable, scheduler?: IScheduler): IObservable; + timeout(dueTime: number, other?: IObservable, scheduler?: IScheduler): IObservable; + delaySubscription(dueTime: number, scheduler?: IScheduler): IObservable; + } + interface Observable { + (subscribe: (observer: IObserver) =>_IDisposable): IObservable; - start(func: () =>any, scheduler?: IScheduler, context?: any): IObservable; - toAsync(func: Function, scheduler?: IScheduler, context?: any): (...arguments: any[]) => IObservable; - create(subscribe: (Observer) =>() =>void ): IObservable; - createWithDisposable(subscribe: (Observer) =>_IDisposable): IObservable; - defer(observableFactory: () =>IObservable): IObservable; - empty(scheduler?: IScheduler): IObservable; - fromArray(array: any[], scheduler?: IScheduler): IObservable; - fromArray(array: { length: number;[index: number]: any; }, scheduler?: IScheduler): IObservable; - generate(initialState: any, condition: (state: any) =>bool, iterate: (state: any) =>any, resultSelector: (state: any) =>any, scheduler?: IScheduler): IObservable; - never(): IObservable; - range(start: number, count: number, scheduler?: IScheduler): IObservable; - repeat(value: any, repeatCount?: number, scheduler?: IScheduler): IObservable; - returnValue(value: any, scheduler?: IScheduler): IObservable; - throwException(exception: any, scheduler?: IScheduler): IObservable; - using(resourceFactory: () =>any, observableFactory: (resource: any) =>IObservable): IObservable; - amb(...sources: IObservable[]): IObservable; - catchException(sources: IObservable[]): IObservable; - catchException(...sources: IObservable[]): IObservable; - concat(...sources: IObservable[]): IObservable; - concat(sources: IObservable[]): IObservable; - merge(...sources: IObservable[]): IObservable; - merge(sources: IObservable[]): IObservable; - merge(scheduler: IScheduler, ...sources: IObservable[]): IObservable; - merge(scheduler: IScheduler, sources: IObservable[]): IObservable; - onErrorResumeNext(...sources: IObservable[]): IObservable; - onErrorResumeNext(sources: IObservable[]): IObservable; - } + start(func: () =>any, scheduler?: IScheduler, context?: any): IObservable; + toAsync(func: Function, scheduler?: IScheduler, context?: any): (...arguments: any[]) => IObservable; + create(subscribe: (Observer) => void ): IObservable; + create(subscribe: (Observer) => () => void ): IObservable; + createWithDisposable(subscribe: (Observer) =>_IDisposable): IObservable; + defer(observableFactory: () =>IObservable): IObservable; + empty(scheduler?: IScheduler): IObservable; + fromArray(array: any[], scheduler?: IScheduler): IObservable; + fromArray(array: { length: number;[index: number]: any; }, scheduler?: IScheduler): IObservable; + generate(initialState: any, condition: (state: any) =>bool, iterate: (state: any) =>any, resultSelector: (state: any) =>any, scheduler?: IScheduler): IObservable; + never(): IObservable; + range(start: number, count: number, scheduler?: IScheduler): IObservable; + repeat(value: any, repeatCount?: number, scheduler?: IScheduler): IObservable; + returnValue(value: any, scheduler?: IScheduler): IObservable; + throwException(exception: any, scheduler?: IScheduler): IObservable; + using(resourceFactory: () =>any, observableFactory: (resource: any) =>IObservable): IObservable; + amb(...sources: IObservable[]): IObservable; + catchException(sources: IObservable[]): IObservable; + catchException(...sources: IObservable[]): IObservable; + concat(...sources: IObservable[]): IObservable; + concat(sources: IObservable[]): IObservable; + merge(...sources: IObservable[]): IObservable; + merge(sources: IObservable[]): IObservable; + merge(scheduler: IScheduler, ...sources: IObservable[]): IObservable; + merge(scheduler: IScheduler, sources: IObservable[]): IObservable; + onErrorResumeNext(...sources: IObservable[]): IObservable; + onErrorResumeNext(sources: IObservable[]): IObservable; + } - export module Internals { - interface IAnonymousObservable extends IObservable { } - export interface AnonymousObservable { - (subscribe: (observer: IObserver) =>_IDisposable): IAnonymousObservable; - } - } + var Observable: Observable; - interface IGroupedObservable extends IObservable { - key: any; - underlyingObservable: IObservable; - } + export module Internals { + interface IAnonymousObservable extends IObservable { } + export interface AnonymousObservable { + (subscribe: (observer: IObserver) =>_IDisposable): IAnonymousObservable; + } + } - interface ISubject extends IObservable, IObserver { - isDisposed: bool; - isStopped: bool; - observers: IObserver[]; + interface IGroupedObservable extends IObservable { + key: any; + underlyingObservable: IObservable; + } - dispose(): void; - } - export interface Subject { - (): ISubject; + interface ISubject extends IObservable, IObserver { + isDisposed: bool; + isStopped: bool; + observers: IObserver[]; - create(observer: IObserver, observable: IObservable): ISubject; - } + dispose(): void; + } + export interface Subject { + (): ISubject; - interface IAsyncSubject extends IObservable, IObserver { - isDisposed: bool; - value: any; - hasValue: bool; - observers: IObserver[]; - exception: any; + create(observer?: IObserver, observable?: IObservable): ISubject; + } - dispose(): void; - } - export interface AsyncSubject { - (): IAsyncSubject; - } + interface IAsyncSubject extends IObservable, IObserver { + isDisposed: bool; + value: any; + hasValue: bool; + observers: IObserver[]; + exception: any; - interface IAnonymousSubject extends IObservable { - onNext(value: any): void; - onError(exception: any): void; - onCompleted(): void; - } + dispose(): void; + } + export interface AsyncSubject { + (): IAsyncSubject; + } + + interface IAnonymousSubject extends IObservable { + onNext(value: any): void; + onError(exception: any): void; + onCompleted(): void; + } } \ No newline at end of file diff --git a/rx.js/rx.js.html.d.ts b/rx.js/rx.js.html.d.ts index 4a9eb833f2..2592d3f122 100644 --- a/rx.js/rx.js.html.d.ts +++ b/rx.js/rx.js.html.d.ts @@ -1,8 +1,8 @@ /// declare module Rx { - export module Observable { - function fromEvent(element: HTMLElement, eventName: string) : IObservable; - function fromEvent(document: HTMLDocument, eventName: string): IObservable; + interface Observable { + fromEvent(element: HTMLElement, eventName: string) : IObservable; + fromEvent(document: HTMLDocument, eventName: string): IObservable; } } \ No newline at end of file diff --git a/rx.js/rx.js.time.d.ts b/rx.js/rx.js.time.d.ts index f1bd2a5846..2c098fa6a6 100644 --- a/rx.js/rx.js.time.d.ts +++ b/rx.js/rx.js.time.d.ts @@ -1,10 +1,10 @@ /// declare module Rx { - export module Observable { - function ifThen(condition: () => bool, thenSource: IObservable): IObservable; - function ifThen(condition: () => bool, thenSource: IObservable, elseSource: IObservable): IObservable; - function ifThen(condition: () => bool, thenSource: IObservable, scheduler: IScheduler): IObservable; - function interval(period: number, scheduler?: IScheduler): IObservable; + interface Observable { + ifThen(condition: () => bool, thenSource: IObservable): IObservable; + ifThen(condition: () => bool, thenSource: IObservable, elseSource: IObservable): IObservable; + ifThen(condition: () => bool, thenSource: IObservable, scheduler: IScheduler): IObservable; + interval(period: number, scheduler?: IScheduler): IObservable; } } \ No newline at end of file From e6ed59efebe69a53eaa83f7fe9b0a9f017f57b0e Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Mon, 1 Jul 2013 21:09:38 +0100 Subject: [PATCH 027/756] strongly type jqueryui methods --- jqueryui/jqueryui.d.ts | 118 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) diff --git a/jqueryui/jqueryui.d.ts b/jqueryui/jqueryui.d.ts index ba6bf05fd0..ecc52a0f15 100644 --- a/jqueryui/jqueryui.d.ts +++ b/jqueryui/jqueryui.d.ts @@ -782,6 +782,11 @@ interface JQuery { accordion(): JQuery; accordion(methodName: string): JQuery; + accordion(methodName: 'destroy'): void; + accordion(methodName: 'disable'): void; + accordion(methodName: 'enable'): void; + accordion(methodName: 'refresh'): void; + accordion(methodName: 'widget'): JQuery; accordion(options: JQueryUI.AccordionOptions): JQuery; accordion(optionLiteral: string, optionName: string): any; accordion(optionLiteral: string, options: JQueryUI.AccordionOptions): any; @@ -789,6 +794,12 @@ interface JQuery { autocomplete(): JQuery; autocomplete(methodName: string): JQuery; + autocomplete(methodName: 'close'): void; + autocomplete(methodName: 'destroy'): void; + autocomplete(methodName: 'disable'): void; + autocomplete(methodName: 'enable'): void; + autocomplete(methodName: 'search', value?: string): void; + autocomplete(methodName: 'widget'): JQuery; autocomplete(options: JQueryUI.AutocompleteOptions): JQuery; autocomplete(optionLiteral: string, optionName: string): any; autocomplete(optionLiteral: string, options: JQueryUI.AutocompleteOptions): any; @@ -796,6 +807,11 @@ interface JQuery { button(): JQuery; button(methodName: string): JQuery; + button(methodName: 'destroy'): void; + button(methodName: 'disable'): void; + button(methodName: 'enable'): void; + button(methodName: 'refresh'): void; + button(methodName: 'widget'): JQuery; button(options: JQueryUI.ButtonOptions): JQuery; button(optionLiteral: string, optionName: string): any; button(optionLiteral: string, options: JQueryUI.ButtonOptions): any; @@ -803,6 +819,11 @@ interface JQuery { buttonset(): JQuery; buttonset(methodName: string): JQuery; + buttonset(methodName: 'destroy'): void; + buttonset(methodName: 'disable'): void; + buttonset(methodName: 'enable'): void; + buttonset(methodName: 'refresh'): void; + buttonset(methodName: 'widget'): JQuery; buttonset(options: JQueryUI.ButtonOptions): JQuery; buttonset(optionLiteral: string, optionName: string): any; buttonset(optionLiteral: string, options: JQueryUI.ButtonOptions): any; @@ -810,6 +831,17 @@ interface JQuery { datepicker(): JQuery; datepicker(methodName: string): JQuery; + datepicker(methodName: 'destroy'): void; + datepicker(methodName: 'dialog', date?: Date, onSelect?: () => void , pos?: any): void; + datepicker(methodName: 'dialog', date?: string, onSelect?: () => void , pos?: any): void; + datepicker(methodName: 'getDate'): Date; + datepicker(methodName: 'hide'): void; + datepicker(methodName: 'isDisabled'): boolean; + datepicker(methodName: 'refresh'): void; + datepicker(methodName: 'setDate', date: Date): void; + datepicker(methodName: 'setDate', date: string): void; + datepicker(methodName: 'show'): void; + datepicker(methodName: 'widget'): JQuery; datepicker(options: JQueryUI.DatepickerOptions): JQuery; datepicker(optionLiteral: string, optionName: string): any; datepicker(optionLiteral: string, options: JQueryUI.DatepickerOptions): any; @@ -817,6 +849,12 @@ interface JQuery { dialog(): JQuery; dialog(methodName: string): JQuery; + dialog(methodName: 'close'): void; + dialog(methodName: 'destroy'): void; + dialog(methodName: 'isOpen'): boolean; + dialog(methodName: 'moveToTop'): void; + dialog(methodName: 'open'): void; + dialog(methodName: 'widget'): JQuery; dialog(options: JQueryUI.DialogOptions): JQuery; dialog(optionLiteral: string, optionName: string): any; dialog(optionLiteral: string, options: JQueryUI.DialogOptions): any; @@ -824,6 +862,10 @@ interface JQuery { draggable(): JQuery; draggable(methodName: string): JQuery; + draggable(methodName: 'destroy'): void; + draggable(methodName: 'disable'): void; + draggable(methodName: 'enable'): void; + draggable(methodName: 'widget'): JQuery; draggable(options: JQueryUI.DraggableOptions): JQuery; draggable(optionLiteral: string, optionName: string): any; draggable(optionLiteral: string, options: JQueryUI.DraggableOptions): any; @@ -831,6 +873,10 @@ interface JQuery { droppable(): JQuery; droppable(methodName: string): JQuery; + droppable(methodName: 'destroy'): void; + droppable(methodName: 'disable'): void; + droppable(methodName: 'enable'): void; + droppable(methodName: 'widget'): JQuery; droppable(options: JQueryUI.DroppableOptions): JQuery; droppable(optionLiteral: string, optionName: string): any; droppable(optionLiteral: string, options: JQueryUI.DraggableOptions): any; @@ -838,6 +884,23 @@ interface JQuery { menu(): JQuery; menu(methodName: string): JQuery; + menu(methodName: 'blur'): void; + menu(methodName: 'collapse', event?: JQueryEventObject): void; + menu(methodName: 'collapseAll', event?: JQueryEventObject, all?: boolean): void; + menu(methodName: 'destroy'): void; + menu(methodName: 'disable'): void; + menu(methodName: 'enable'): void; + menu(methodName: string, event: JQueryEventObject, item: JQuery): void; + menu(methodName: 'focus', event: JQueryEventObject, item: JQuery): void; + menu(methodName: 'isFirstItem'): boolean; + menu(methodName: 'isLastItem'): boolean; + menu(methodName: 'next', event?: JQueryEventObject): void; + menu(methodName: 'nextPage', event?: JQueryEventObject): void; + menu(methodName: 'previous', event?: JQueryEventObject): void; + menu(methodName: 'previousPage', event?: JQueryEventObject): void; + menu(methodName: 'refresh'): void; + menu(methodName: 'select', event?: JQueryEventObject): void; + menu(methodName: 'widget'): JQuery; menu(options: JQueryUI.MenuOptions): JQuery; menu(optionLiteral: string, optionName: string): any; menu(optionLiteral: string, options: JQueryUI.MenuOptions): any; @@ -845,6 +908,15 @@ interface JQuery { progressbar(): JQuery; progressbar(methodName: string): JQuery; + progressbar(methodName: 'destroy'): void; + progressbar(methodName: 'disable'): void; + progressbar(methodName: 'enable'): void; + progressbar(methodName: 'refresh'): void; + progressbar(methodName: 'value'): number; + progressbar(methodName: 'value'): boolean; + progressbar(methodName: 'value', value: number): void; + progressbar(methodName: 'value', value: boolean): void; + progressbar(methodName: 'widget'): JQuery; progressbar(options: JQueryUI.ProgressbarOptions): JQuery; progressbar(optionLiteral: string, optionName: string): any; progressbar(optionLiteral: string, options: JQueryUI.ProgressbarOptions): any; @@ -852,6 +924,10 @@ interface JQuery { resizable(): JQuery; resizable(methodName: string): JQuery; + resizable(methodName: 'destroy'): void; + resizable(methodName: 'disable'): void; + resizable(methodName: 'enable'): void; + resizable(methodName: 'widget'): JQuery; resizable(options: JQueryUI.ResizableOptions): JQuery; resizable(optionLiteral: string, optionName: string): any; resizable(optionLiteral: string, options: JQueryUI.ResizableOptions): any; @@ -859,6 +935,10 @@ interface JQuery { selectable(): JQuery; selectable(methodName: string): JQuery; + selectable(methodName: 'destroy'): void; + selectable(methodName: 'disable'): void; + selectable(methodName: 'enable'): void; + selectable(methodName: 'widget'): JQuery; selectable(options: JQueryUI.SelectableOptions): JQuery; selectable(optionLiteral: string, optionName: string): any; selectable(optionLiteral: string, options: JQueryUI.SelectableOptions): any; @@ -866,6 +946,18 @@ interface JQuery { slider(): JQuery; slider(methodName: string): JQuery; + slider(methodName: 'destroy'): void; + slider(methodName: 'disable'): void; + slider(methodName: 'enable'): void; + slider(methodName: 'refresh'): void; + slider(methodName: 'value'): number; + slider(methodName: 'value', value: number): void; + slider(methodName: 'values'): Array; + slider(methodName: 'values', index: number): number; + slider(methodName: string, index: number, value: number): void; + slider(methodName: 'values', index: number, value: number): void; + slider(methodName: 'values', values: Array): void; + slider(methodName: 'widget'): JQuery; slider(options: JQueryUI.SliderOptions): JQuery; slider(optionLiteral: string, optionName: string): any; slider(optionLiteral: string, options: JQueryUI.SliderOptions): any; @@ -873,6 +965,10 @@ interface JQuery { sortable(): JQuery; sortable(methodName: string): JQuery; + sortable(methodName: 'destroy'): void; + sortable(methodName: 'disable'): void; + sortable(methodName: 'enable'): void; + sortable(methodName: 'widget'): JQuery; sortable(options: JQueryUI.SortableOptions): JQuery; sortable(optionLiteral: string, optionName: string): any; sortable(optionLiteral: string, options: JQueryUI.SortableOptions): any; @@ -880,6 +976,16 @@ interface JQuery { spinner(): JQuery; spinner(methodName: string): JQuery; + spinner(methodName: 'destroy'): void; + spinner(methodName: 'disable'): void; + spinner(methodName: 'enable'): void; + spinner(methodName: 'pageDown', pages?: number): void; + spinner(methodName: 'pageUp', pages?: number): void; + spinner(methodName: 'stepDown', steps?: number): void; + spinner(methodName: 'stepUp', steps?: number): void; + spinner(methodName: 'value'): number; + spinner(methodName: 'value', value: number): void; + spinner(methodName: 'widget'): JQuery; spinner(options: JQueryUI.SpinnerOptions): JQuery; spinner(optionLiteral: string, optionName: string): any; spinner(optionLiteral: string, options: JQueryUI.SpinnerOptions): any; @@ -887,6 +993,12 @@ interface JQuery { tabs(): JQuery; tabs(methodName: string): JQuery; + tabs(methodName: 'destroy'): void; + tabs(methodName: 'disable'): void; + tabs(methodName: 'enable'): void; + tabs(methodName: 'load', index: number): void; + tabs(methodName: 'refresh'): void; + tabs(methodName: 'widget'): JQuery; tabs(options: JQueryUI.TabsOptions): JQuery; tabs(optionLiteral: string, optionName: string): any; tabs(optionLiteral: string, options: JQueryUI.TabsOptions): any; @@ -894,6 +1006,12 @@ interface JQuery { tooltip(): JQuery; tooltip(methodName: string): JQuery; + tooltip(methodName: 'destroy'): void; + tooltip(methodName: 'disable'): void; + tooltip(methodName: 'enable'): void; + tooltip(methodName: 'open'): void; + tooltip(methodName: 'close'): void; + tooltip(methodName: 'widget'): JQuery; tooltip(options: JQueryUI.TooltipOptions): JQuery; tooltip(optionLiteral: string, optionName: string): any; tooltip(optionLiteral: string, options: JQueryUI.TooltipOptions): any; From 9941765485bb2e39fb9183fea4ef05d358ffb681 Mon Sep 17 00:00:00 2001 From: Derek Cicerone Date: Mon, 1 Jul 2013 17:38:49 -0400 Subject: [PATCH 028/756] Replace bool with boolean (for TypeScript 0.9.0+) --- backbone/backbone.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backbone/backbone.d.ts b/backbone/backbone.d.ts index aa8488beac..c957be929b 100644 --- a/backbone/backbone.d.ts +++ b/backbone/backbone.d.ts @@ -271,7 +271,7 @@ declare module Backbone { navigate(fragment: string, options?: any); started: boolean; - _updateHash(location: Location, fragment: string, replace: bool); + _updateHash(location: Location, fragment: string, replace: boolean); } interface ViewOptions { From f42029618dc7d34f9bdaeb3636a3cd426315d682 Mon Sep 17 00:00:00 2001 From: Derek Cicerone Date: Mon, 1 Jul 2013 18:00:11 -0400 Subject: [PATCH 029/756] Replace bool with boolean (for TypeScript 0.9.0+) Looks like my editor removed trailing whitespace and possibly also normalized some line endings as well. --- leaflet/leaflet.d.ts | 1090 +++++++++++++++++++++--------------------- 1 file changed, 545 insertions(+), 545 deletions(-) diff --git a/leaflet/leaflet.d.ts b/leaflet/leaflet.d.ts index a2e3fb09fa..5d6825383c 100644 --- a/leaflet/leaflet.d.ts +++ b/leaflet/leaflet.d.ts @@ -9,27 +9,27 @@ declare module L { * Initial geographical center of the map. */ center?: LatLng; - + /** * Initial map zoom. */ zoom?: number; - + /** * Layers that will be added to the map initially. */ layers?: ILayer[]; - + /** * Minimum zoom level of the map. Overrides any minZoom set on map layers. */ minZoom?: number; - + /** * Maximum zoom level of the map. This overrides any maxZoom set on map layers. */ maxZoom?: number; - + /** * When this option is set, the map restricts the view to the given geographical * bounds, bouncing the user back when he tries to pan outside the view, and also @@ -37,125 +37,125 @@ declare module L { * on the map size). To set the restriction dynamically, use setMaxBounds method */ maxBounds?: LatLngBounds; - + /** * Coordinate Reference System to use. Don't change this if you're not sure * what it means. */ crs?: ICRS; - + /** * Whether the map be draggable with mouse/touch or not. */ - dragging?: bool; - + dragging?: boolean; + /** * Whether the map can be zoomed by touch-dragging with two fingers. */ - touchZoom?: bool; - + touchZoom?: boolean; + /** * Whether the map can be zoomed by using the mouse wheel. */ - scrollWheelZoom?: bool; - + scrollWheelZoom?: boolean; + /** * Whether the map can be zoomed in by double clicking on it. */ - doubleClickZoom?: bool; - + doubleClickZoom?: boolean; + /** * Whether the map can be zoomed to a rectangular area specified by dragging * the mouse while pressing shift. */ - boxZoom?: bool; - + boxZoom?: boolean; + /** * Whether the map automatically handles browser window resize to update itself. */ - trackResize?: bool; - + trackResize?: boolean; + /** * With this option enabled, the map tracks when you pan to another "copy" of * the world and seamlessly jumps to the original one so that all overlays like * markers and vector layers are still visible. */ - worldCopyJump?: bool; - + worldCopyJump?: boolean; + /** * Set it to false if you don't want popups to close when user clicks the map. */ - closePopupOnClick?: bool; - + closePopupOnClick?: boolean; + /** * Makes the map focusable and allows users to navigate the map with keyboard * arrows and +/- keys. */ - keyboard?: bool; - + keyboard?: boolean; + /** * Amount of pixels to pan when pressing an arrow key. */ keyboardPanOffset?: number; - + /** * Number of zoom levels to change when pressing + or - key. */ keyboardZoomOffset?: number; - + /** * If enabled, panning of the map will have an inertia effect where the map builds * momentum while dragging and continues moving in the same direction for some * time. Feels especially nice on touch devices. */ - inertia?: bool; - + inertia?: boolean; + /** * The rate with which the inertial movement slows down, in pixels/second2. */ inertiaDeceleration?: number; - + /** * Max speed of the inertial movement, in pixels/second. */ inertiaMaxSpeed?: number; - + /** * Amount of milliseconds that should pass between stopping the movement and * releasing the mouse or touch to prevent inertial movement. 32 for touch devices * and 14 for the rest by default. */ inertiaThreshold?: number; - + /** * Whether the zoom control is added to the map by default. */ - zoomControl?: bool; - + zoomControl?: boolean; + /** * Whether the attribution control is added to the map by default. */ - attributionControl?: bool; - + attributionControl?: boolean; + /** * Whether the tile fade animation is enabled. By default it's enabled in all * browsers that support CSS3 Transitions except Android. */ - fadeAnimation?: bool; - + fadeAnimation?: boolean; + /** * Whether the tile zoom animation is enabled. By default it's enabled in all * browsers that support CSS3 Transitions except Android. */ - zoomAnimation?: bool; - + zoomAnimation?: boolean; + /** * Whether markers animate their zoom with the zoom animation, if disabled * they will disappear for the length of the animation. By default it's enabled * in all browsers that support CSS3 Transitions except Android. */ - markerZoomAnimation?: bool; - + markerZoomAnimation?: boolean; + } export interface LocateOptions { @@ -164,36 +164,36 @@ declare module L { * it once) using W3C watchPosition method. You can later stop watching using * map.stopLocate() method. */ - watch?: bool; - + watch?: boolean; + /** * If true, automatically sets the map view to the user location with respect * to detection accuracy, or to world view if geolocation failed. */ - setView?: bool; - + setView?: boolean; + /** * The maximum zoom for automatic view setting when using `setView` option. */ maxZoom?: number; - + /** * Number of millisecond to wait for a response from geolocation before firing * a locationerror event. */ timeout?: number; - + /** * Maximum age of detected location. If less than this amount of milliseconds * passed since last geolocation response, locate will return a cached location. */ maximumAge?: number; - + /** * Enables high accuracy, see description in the W3C spec. */ - enableHighAccuracy?: bool; - + enableHighAccuracy?: boolean; + } export interface MapPanes { @@ -201,37 +201,37 @@ declare module L { * Pane that contains all other map panes. */ mapPane: HTMLElement; - + /** * Pane for tile layers. */ tilePane: HTMLElement; - + /** * Pane that contains all the panes except tile pane. */ objectsPane: HTMLElement; - + /** * Pane for overlay shadows (e.g. marker shadows). */ shadowPane: HTMLElement; - + /** * Pane for overlays like polylines and polygons. */ overlayPane: HTMLElement; - + /** * Pane for marker icons. */ markerPane: HTMLElement; - + /** * Pane for popups. */ popupPane: HTMLElement; - + } export class Map implements IEventPowered { @@ -252,64 +252,64 @@ declare module L { * set to true, the map is reloaded even if it's eligible for pan or zoom animation * (false by default). */ - setView(center: LatLng, zoom: number, forceReset?: bool): Map; - + setView(center: LatLng, zoom: number, forceReset?: boolean): Map; + /** * Sets the zoom of the map. */ setZoom(zoom: number): Map; - + /** * Increases the zoom of the map by delta (1 by default). */ zoomIn(delta?: number): Map; - + /** * Decreases the zoom of the map by delta (1 by default). */ zoomOut(delta?: number): Map; - + /** * Sets a map view that contains the given geographical bounds with the maximum * zoom level possible. */ fitBounds(bounds: LatLngBounds): Map; - + /** * Sets a map view that mostly contains the whole world with the maximum zoom * level possible. */ fitWorld(): Map; - + /** * Pans the map to a given center. Makes an animated pan if new center is not more * than one screen away from the current one. */ panTo(latlng: LatLng): Map; - + /** * Pans the map to the closest view that would lie inside the given bounds (if * it's not already). */ panInsideBounds(bounds: LatLngBounds): Map; - + /** * Pans the map by a given number of pixels (animated). */ panBy(point: Point): Map; - + /** * Checks if the map container size changed and updates the map if so — call it * after you've changed the map size dynamically. If animate is true, map animates * the update. */ - invalidateSize(animate?: bool): Map; - + invalidateSize(animate?: boolean): Map; + /** * Restricts the map view to the given bounds (see map maxBounds option). */ setMaxBounds(bounds: LatLngBounds): Map; - + /** * Tries to locate the user using Geolocation API, firing locationfound event * with location data on success or locationerror event on failure, and optionally @@ -318,219 +318,219 @@ declare module L { * details. */ locate(options?: LocateOptions): Map; - + /** * Stops watching location previously initiated by map.locate({watch: true}). */ stopLocate(): Map; - + /** * Returns the geographical center of the map view. */ getCenter(): LatLng; - + /** * Returns the current zoom of the map view. */ getZoom(): number; - + /** * Returns the minimum zoom level of the map. */ getMinZoom(): number; - + /** * Returns the maximum zoom level of the map. */ getMaxZoom(): number; - + /** * Returns the LatLngBounds of the current map view. */ getBounds(): LatLngBounds; - + /** * Returns the maximum zoom level on which the given bounds fit to the map view * in its entirety. If inside (optional) is set to true, the method instead returns * the minimum zoom level on which the map view fits into the given bounds in its * entirety. */ - getBoundsZoom(bounds: LatLngBounds, inside?: bool): number; - + getBoundsZoom(bounds: LatLngBounds, inside?: boolean): number; + /** * Returns the current size of the map container. */ getSize(): Point; - + /** * Returns the bounds of the current map view in projected pixel coordinates * (sometimes useful in layer and overlay implementations). */ getPixelBounds(): Bounds; - + /** * Returns the projected pixel coordinates of the top left point of the map layer * (useful in custom layer and overlay implementations). */ getPixelOrigin(): Point; - + /** * Adds the given layer to the map. If optional insertAtTheBottom is set to true, * the layer is inserted under all others (useful when switching base tile layers). */ - addLayer(layer: ILayer, insertAtTheBottom?: bool): Map; - + addLayer(layer: ILayer, insertAtTheBottom?: boolean): Map; + /** * Removes the given layer from the map. */ removeLayer(layer: ILayer): Map; - + /** * Returns true if the given layer is currently added to the map. */ - hasLayer(layer: ILayer): bool; - + hasLayer(layer: ILayer): boolean; + /** * Opens the specified popup while closing the previously opened (to make sure * only one is opened at one time for usability). */ openPopup(popup: Popup): Map; - + /** * Closes the popup opened with openPopup. */ closePopup(): Map; - + /** * Adds the given control to the map. */ addControl(control: IControl): Map; - + /** * Removes the given control from the map. */ removeControl(control: IControl): Map; - + /** * Returns the map layer point that corresponds to the given geographical coordinates * (useful for placing overlays on the map). */ latLngToLayerPoint(latlng: LatLng): Point; - + /** * Returns the geographical coordinates of a given map layer point. */ layerPointToLatLng(point: Point): LatLng; - + /** * Converts the point relative to the map container to a point relative to the * map layer. */ containerPointToLayerPoint(point: Point): Point; - + /** * Converts the point relative to the map layer to a point relative to the map * container. */ layerPointToContainerPoint(point: Point): Point; - + /** * Returns the map container point that corresponds to the given geographical * coordinates. */ latLngToContainerPoint(latlng: LatLng): Point; - + /** * Returns the geographical coordinates of a given map container point. */ containerPointToLatLng(point: Point): LatLng; - + /** * Projects the given geographical coordinates to absolute pixel coordinates * for the given zoom level (current zoom level by default). */ project(latlng: LatLng, zoom?: number): Point; - + /** * Projects the given absolute pixel coordinates to geographical coordinates * for the given zoom level (current zoom level by default). */ unproject(point: Point, zoom?: number): LatLng; - + /** * Returns the pixel coordinates of a mouse click (relative to the top left corner * of the map) given its event object. */ mouseEventToContainerPoint(event: LeafletMouseEvent): Point; - + /** * Returns the pixel coordinates of a mouse click relative to the map layer given * its event object. */ mouseEventToLayerPoint(event: LeafletMouseEvent): Point; - + /** * Returns the geographical coordinates of the point the mouse clicked on given * the click's event object. */ mouseEventToLatLng(event: LeafletMouseEvent): LatLng; - + /** * Returns the container element of the map. */ getContainer(): HTMLElement; - + /** * Returns an object with different map panes (to render overlays in). */ getPanes(): MapPanes; - + /** * Runs the given callback when the map gets initialized with a place and zoom, * or immediately if it happened already, optionally passing a function context. */ whenReady(fn: Function, context?: any): Map; - + /** * Map dragging handler (by both mouse and touch). */ dragging: IHandler; - + /** * Touch zoom handler. */ touchZoom: IHandler; - + /** * Double click zoom handler. */ doubleClickZoom: IHandler; - + /** * Scroll wheel zoom handler. */ scrollWheelZoom: IHandler; - + /** * Box (shift-drag with mouse) zoom handler. */ boxZoom: IHandler; - + /** * Keyboard navigation handler. */ keyboard: IHandler; - + /** * Zoom control. */ zoomControl: Zoom; - + /** * Attribution control. */ attributionControl: Attribution; - + //////////// //// IEventPowered members //////////// @@ -539,7 +539,7 @@ declare module L { addEventListener(eventMap: any, context?: any): IEventPowered; removeEventListener(type: string, fn?: (e: LeafletEvent) => void, context?: any): IEventPowered; removeEventListener(eventMap: any, context?: any): IEventPowered; - hasEventListeners(type: string): bool; + hasEventListeners(type: string): boolean; fireEvent(type: string, data?: any): IEventPowered; on(type: string, fn: (e: LeafletEvent) => void, context?: any): IEventPowered; on(eventMap: any, context?: any): IEventPowered; @@ -554,45 +554,45 @@ declare module L { * on how to customize the marker icon. Set to new L.Icon.Default() by default. */ icon?: Icon; - + /** * If false, the marker will not emit mouse events and will act as a part of the * underlying map. */ - clickable?: bool; - + clickable?: boolean; + /** * Whether the marker is draggable with mouse/touch or not. */ - draggable?: bool; - + draggable?: boolean; + /** * Text for the browser tooltip that appear on marker hover (no tooltip by default). */ title?: string; - + /** * By default, marker images zIndex is set automatically based on its latitude. * You this option if you want to put the marker on top of all others (or below), * specifying a high value like 1000 (or high negative value, respectively). */ zIndexOffset?: number; - + /** * The opacity of the marker. */ opacity?: number; - + /** * If true, the marker will get on top of others when you hover the mouse over it. */ - riseOnHover?: bool; - + riseOnHover?: boolean; + /** * The z-index offset used for the riseOnHover feature. */ riseOffset?: number; - + } export class Marker implements ILayer, IEventPowered { @@ -601,59 +601,59 @@ declare module L { * an options object. */ constructor(latlng: LatLng, options?: MarkerOptions); - + /** * Adds the marker to the map. */ addTo(map: Map): Marker; - + /** * Returns the current geographical position of the marker. */ getLatLng(): LatLng; - + /** * Changes the marker position to the given point. */ setLatLng(latlng: LatLng): Marker; - + /** * Changes the marker icon. */ setIcon(icon: Icon): Marker; - + /** * Changes the zIndex offset of the marker. */ setZIndexOffset(offset: number): Marker; - + /** * Changes the opacity of the marker. */ setOpacity(opacity: number): Marker; - + /** * Updates the marker position, useful if coordinates of its latLng object * were changed directly. */ update(): Marker; - + /** * Binds a popup with a particular HTML content to a click on this marker. You * can also open the bound popup with the Marker openPopup method. */ bindPopup(htmlContent: string, options?: PopupOptions): Marker; - + /** * Unbinds the popup previously bound to the marker with bindPopup. */ unbindPopup(): Marker; - + /** * Opens the popup previously bound by the bindPopup method. */ openPopup(): Marker; - + /** * Closes the bound popup of the marker if it's opened. */ @@ -669,13 +669,13 @@ declare module L { * Called on map.addLayer(layer). */ onAdd(map: Map): void; - + /** * Should contain all clean up code that removes the overlay's elements from * the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer). */ onRemove(map: Map): void; - + //////////// //// IEventPowered members //////////// @@ -684,7 +684,7 @@ declare module L { addEventListener(eventMap: any, context?: any): IEventPowered; removeEventListener(type: string, fn?: (e: LeafletEvent) => void, context?: any): IEventPowered; removeEventListener(eventMap: any, context?: any): IEventPowered; - hasEventListeners(type: string): bool; + hasEventListeners(type: string): boolean; fireEvent(type: string, data?: any): IEventPowered; on(type: string, fn: (e: LeafletEvent) => void, context?: any): IEventPowered; on(eventMap: any, context?: any): IEventPowered; @@ -698,47 +698,47 @@ declare module L { * Max width of the popup. */ maxWidth?: number; - + /** * Min width of the popup. */ minWidth?: number; - + /** * If set, creates a scrollable container of the given height inside a popup * if its content exceeds it. */ maxHeight?: number; - + /** * Set it to false if you don't want the map to do panning animation to fit the opened * popup. */ - autoPan?: bool; - + autoPan?: boolean; + /** * Controls the presense of a close button in the popup. */ - closeButton?: bool; - + closeButton?: boolean; + /** * The offset of the popup position. Useful to control the anchor of the popup * when opening it on some overlays. */ offset?: Point; - + /** * The margin between the popup and the edges of the map view after autopanning * was performed. */ autoPanPadding?: Point; - + /** * Whether to animate the popup on zoom. Disable it if you have problems with * Flash content inside popups. */ - zoomAnimation?: bool; - + zoomAnimation?: boolean; + } export class Popup implements ILayer { @@ -748,22 +748,22 @@ declare module L { * popup with a reference to the source object to which it refers. */ constructor(options?: PopupOptions, source?: any); - + /** * Adds the popup to the map. */ addTo(map: Map): Popup; - + /** * Adds the popup to the map and closes the previous one. The same as map.openPopup(popup). */ openOn(map: Map): Popup; - + /** * Sets the geographical point where the popup will open. */ setLatLng(latlng: LatLng): Popup; - + /** * Sets the HTML content of the popup. */ @@ -779,13 +779,13 @@ declare module L { * Called on map.addLayer(layer). */ onAdd(map: Map): void; - + /** * Should contain all clean up code that removes the overlay's elements from * the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer). */ onRemove(map: Map): void; - + } export interface TileLayerOptions { @@ -793,92 +793,92 @@ declare module L { * Minimum zoom number. */ minZoom?: number; - + /** * Maximum zoom number. */ maxZoom?: number; - + /** * Tile size (width and height in pixels, assuming tiles are square). */ tileSize?: number; - + /** * Subdomains of the tile service. Can be passed in the form of one string (where * each letter is a subdomain name) or an array of strings. */ subdomains?: string; - + /** * URL to the tile image to show in place of the tile that failed to load. */ errorTileUrl?: string; - + /** * e.g. "© CloudMade" — the string used by the attribution control, describes * the layer data. */ attribution?: string; - + /** * If true, inverses Y axis numbering for tiles (turn this on for TMS services). */ - tms?: bool; - + tms?: boolean; + /** * If set to true, the tile coordinates won't be wrapped by world width (-180 * to 180 longitude) or clamped to lie within world height (-90 to 90). Use this * if you use Leaflet for maps that don't reflect the real world (e.g. game, indoor * or photo maps). */ - continuousWorld?: bool; - + continuousWorld?: boolean; + /** * If set to true, the tiles just won't load outside the world width (-180 to 180 * longitude) instead of repeating. */ - noWrap?: bool; - + noWrap?: boolean; + /** * The zoom number used in tile URLs will be offset with this value. */ zoomOffset?: number; - + /** * If set to true, the zoom number used in tile URLs will be reversed (maxZoom * - zoom instead of zoom) */ - zoomReverse?: bool; - + zoomReverse?: boolean; + /** * The opacity of the tile layer. */ opacity?: number; - + /** * The explicit zIndex of the tile layer. Not set by default. */ zIndex?: number; - + /** * If true, all the tiles that are not visible after panning are removed (for * better performance). true by default on mobile WebKit, otherwise false. */ - unloadInvisibleTiles?: bool; - + unloadInvisibleTiles?: boolean; + /** * If false, new tiles are loaded during panning, otherwise only after it (for * better performance). true by default on mobile WebKit, otherwise false. */ - updateWhenIdle?: bool; - + updateWhenIdle?: boolean; + /** * If true and user is on a retina display, it will request four tiles of half the * specified size and a bigger zoom level in place of one to utilize the high resolution. */ - detectRetina?: bool; - + detectRetina?: boolean; + /** * If true, all the tiles that are not visible after panning are placed in a reuse * queue from which they will be fetched when new tiles become visible (as opposed @@ -886,8 +886,8 @@ declare module L { * low and eliminate the need for reserving new memory whenever a new tile is * needed. */ - reuseTiles?: bool; - + reuseTiles?: boolean; + } export class TileLayer implements ILayer, IEventPowered { @@ -896,44 +896,44 @@ declare module L { * object. */ constructor(urlTemplate: string, options?: TileLayerOptions); - + /** * Adds the layer to the map. */ addTo(map: Map): TileLayer; - + /** * Brings the tile layer to the top of all tile layers. */ bringToFront(): TileLayer; - + /** * Brings the tile layer to the bottom of all tile layers. */ bringToBack(): TileLayer; - + /** * Changes the opacity of the tile layer. */ setOpacity(opacity: number): TileLayer; - + /** * Sets the zIndex of the tile layer. */ setZIndex(zIndex: number): TileLayer; - + /** * Causes the layer to clear all the tiles and request them again. */ redraw(): TileLayer; - + /** * Updates the layer's URL template and redraws it. */ setUrl(urlTemplate: string): TileLayer; static WMS: new () => WMS; - + static Canvas: new () => Canvas; //////////// @@ -946,13 +946,13 @@ declare module L { * Called on map.addLayer(layer). */ onAdd(map: Map): void; - + /** * Should contain all clean up code that removes the overlay's elements from * the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer). */ onRemove(map: Map): void; - + //////////// //// IEventPowered members //////////// @@ -961,7 +961,7 @@ declare module L { addEventListener(eventMap: any, context?: any): IEventPowered; removeEventListener(type: string, fn?: (e: LeafletEvent) => void, context?: any): IEventPowered; removeEventListener(eventMap: any, context?: any): IEventPowered; - hasEventListeners(type: string): bool; + hasEventListeners(type: string): boolean; fireEvent(type: string, data?: any): IEventPowered; on(type: string, fn: (e: LeafletEvent) => void, context?: any): IEventPowered; on(eventMap: any, context?: any): IEventPowered; @@ -975,27 +975,27 @@ declare module L { * (required) Comma-separated list of WMS layers to show. */ layers?: string; - + /** * Comma-separated list of WMS styles. */ styles?: string; - + /** * WMS image format (use 'image/png' for layers with transparency). */ format?: string; - + /** * If true, the WMS service will return images with transparency. */ - transparent?: bool; - + transparent?: boolean; + /** * Version of the WMS service to use. */ version?: string; - + } export class WMS { @@ -1004,13 +1004,13 @@ declare module L { * a WMS parameters/options object. */ constructor(baseUrl: string, options: WMSOptions); - + /** * Merges an object with the new parameters and re-requests tiles on the current * screen (unless noRedraw was set to true). */ - setParams(params: WMS, noRedraw?: bool): WMS; - + setParams(params: WMS, noRedraw?: boolean): WMS; + } export class Canvas { @@ -1018,20 +1018,20 @@ declare module L { * Instantiates a Canvas tile layer object given an options object (optionally). */ constructor(options?: TileLayerOptions); - + /** * You need to define this method after creating the instance to draw tiles; * canvas is the actual canvas tile on which you can draw, tilePoint represents * the tile numbers, and zoom is the current zoom. */ drawTile(canvas: HTMLCanvasElement, tilePoint: Point, zoom: number): Canvas; - + /** * Calling redraw will cause the drawTile method to be called for all tiles. * May be used for updating dynamic content drawn on the Canvas */ redraw(): Canvas; - + } export interface ImageOverlayOptions { @@ -1039,7 +1039,7 @@ declare module L { * The opacity of the image overlay. */ opacity?: number; - + } export class ImageOverlay implements ILayer { @@ -1048,22 +1048,22 @@ declare module L { * bounds it is tied to. */ constructor(imageUrl: string, bounds: LatLngBounds, options?: ImageOverlayOptions); - + /** * Adds the overlay to the map. */ addTo(map: Map): ImageOverlay; - + /** * Sets the opacity of the overlay. */ setOpacity(opacity: number): ImageOverlay; - + /** * Brings the layer to the top of all overlays. */ bringToFront(): ImageOverlay; - + /** * Brings the layer to the bottom of all overlays. */ @@ -1079,13 +1079,13 @@ declare module L { * Called on map.addLayer(layer). */ onAdd(map: Map): void; - + /** * Should contain all clean up code that removes the overlay's elements from * the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer). */ onRemove(map: Map): void; - + } export interface PathOptions { @@ -1093,51 +1093,51 @@ declare module L { * Whether to draw stroke along the path. Set it to false to disable borders on * polygons or circles. */ - stroke?: bool; - + stroke?: boolean; + /** * Stroke color. */ color?: string; - + /** * Stroke width in pixels. */ weight?: number; - + /** * Stroke opacity. */ opacity?: number; - + /** * Whether to fill the path with color. Set it to false to disable filling on polygons * or circles. */ - fill?: bool; - + fill?: boolean; + /** * Fill color. */ fillColor?: string; - + /** * Fill opacity. */ fillOpacity?: number; - + /** * A string that defines the stroke dash pattern. Doesn't work on canvas-powered * layers (e.g. Android 2). */ dashArray?: string; - + /** * If false, the vector will not emit mouse events and will act as a part of the * underlying map. */ - clickable?: bool; - + clickable?: boolean; + } export class Path implements ILayer, IEventPowered { @@ -1145,64 +1145,64 @@ declare module L { * Adds the layer to the map. */ addTo(map: Map): Path; - + /** * Binds a popup with a particular HTML content to a click on this path. */ bindPopup(htmlContent: string, options?: PopupOptions): Path; - + /** * Unbinds the popup previously bound to the path with bindPopup. */ unbindPopup(): Path; - + /** * Opens the popup previously bound by the bindPopup method in the given point, * or in one of the path's points if not specified. */ openPopup(latlng?: LatLng): Path; - + /** * Closes the path's bound popup if it is opened. */ closePopup(): Path; - + /** * Changes the appearance of a Path based on the options in the Path options object. */ setStyle(object: PathOptions): Path; - + /** * Returns the LatLngBounds of the path. */ getBounds(): LatLngBounds; - + /** * Brings the layer to the top of all path layers. */ bringToFront(): Path; - + /** * Brings the layer to the bottom of all path layers. */ bringToBack(): Path; - + /** * Redraws the layer. Sometimes useful after you changed the coordinates that * the path uses. */ redraw(): Path; - + /** * True if SVG is used for vector rendering (true for most modern browsers). */ - static SVG: bool; - + static SVG: boolean; + /** * True if VML is used for vector rendering (IE 6-8). */ - static VML: bool; - + static VML: boolean; + /** * True if Canvas is used for vector rendering (Android 2). You can also force * this by setting global variable L_PREFER_CANVAS to true before the Leaflet @@ -1210,8 +1210,8 @@ declare module L { * when rendering thousands of circle markers, but currently suffers from * a bug that causes removing such layers to be extremely slow. */ - static CANVAS: bool; - + static CANVAS: boolean; + /** * How much to extend the clip area around the map view (relative to its size, * e.g. 0.5 is half the screen in each direction). Smaller values mean that you @@ -1230,13 +1230,13 @@ declare module L { * Called on map.addLayer(layer). */ onAdd(map: Map): void; - + /** * Should contain all clean up code that removes the overlay's elements from * the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer). */ onRemove(map: Map): void; - + //////////// //// IEventPowered members //////////// @@ -1245,7 +1245,7 @@ declare module L { addEventListener(eventMap: any, context?: any): IEventPowered; removeEventListener(type: string, fn?: (e: LeafletEvent) => void, context?: any): IEventPowered; removeEventListener(eventMap: any, context?: any): IEventPowered; - hasEventListeners(type: string): bool; + hasEventListeners(type: string): boolean; fireEvent(type: string, data?: any): IEventPowered; on(type: string, fn: (e: LeafletEvent) => void, context?: any): IEventPowered; on(eventMap: any, context?: any): IEventPowered; @@ -1260,12 +1260,12 @@ declare module L { * and smoother look, and less means more accurate representation. */ smoothFactor?: number; - + /** * Disabled polyline clipping. */ - noClip?: bool; - + noClip?: boolean; + } export class Polyline extends Path { @@ -1274,34 +1274,34 @@ declare module L { * optionally an options object. */ constructor(latlngs: LatLng[], options?: PolylineOptions); - + /** * Adds a given point to the polyline. */ addLatLng(latlng: LatLng): Polyline; - + /** * Replaces all the points in the polyline with the given array of geographical * points. */ setLatLngs(latlngs: LatLng[]): Polyline; - + /** * Returns an array of the points in the path. */ getLatLngs(): LatLng[]; - + /** * Allows adding, removing or replacing points in the polyline. Syntax is the * same as in Array#splice. Returns the array of removed points (if any). */ spliceLatLngs(index: number, pointsToRemove: number, ...latlngs: LatLng[]): LatLng[]; - + /** * Returns the LatLngBounds of the polyline. */ getBounds(): LatLngBounds; - + } export class MultiPolyline extends FeatureGroup { @@ -1310,7 +1310,7 @@ declare module L { * points (one for each individual polyline) and optionally an options object. */ constructor(latlngs: LatLng[][], options?: PolylineOptions); - + } export class Polygon extends Polyline { @@ -1322,7 +1322,7 @@ declare module L { * the holes inside. */ constructor(latlngs: LatLng[], options?: PolylineOptions); - + } export class MultiPolygon extends FeatureGroup { @@ -1332,7 +1332,7 @@ declare module L { * as for MultiPolyline). */ constructor(latlngs: LatLng[][], options?: PolylineOptions); - + } export class Rectangle extends Polygon { @@ -1341,12 +1341,12 @@ declare module L { * optionally an options object. */ constructor(bounds: LatLngBounds, options?: PathOptions); - + /** * Redraws the rectangle with the passed bounds. */ setBounds(bounds: LatLngBounds): Rectangle; - + } export class Circle extends Path { @@ -1355,27 +1355,27 @@ declare module L { * and optionally an options object. */ constructor(latlng: LatLng, radius: number, options?: PathOptions); - + /** * Returns the current geographical position of the circle. */ getLatLng(): LatLng; - + /** * Returns the current radius of a circle. Units are in meters. */ getRadius(): number; - + /** * Sets the position of a circle to a new location. */ setLatLng(latlng: LatLng): Circle; - + /** * Sets the radius of a circle. Units are in meters. */ setRadius(radius: number): Circle; - + } export class CircleMarker extends Circle { @@ -1385,17 +1385,17 @@ declare module L { * "radius" member in the path options object. */ constructor(latlng: LatLng, options?: PathOptions); - + /** * Sets the position of a circle marker to a new location. */ setLatLng(latlng: LatLng): CircleMarker; - + /** * Sets the radius of a circle marker. Units are in pixels. */ setRadius(radius: number): CircleMarker; - + } export class LayerGroup implements ILayer { @@ -1403,27 +1403,27 @@ declare module L { * Create a layer group, optionally given an initial set of layers. */ constructor(layers?: ILayer[]); - + /** * Adds the group of layers to the map. */ addTo(map: Map): LayerGroup; - + /** * Adds a given layer to the group. */ addLayer(layer: ILayer): LayerGroup; - + /** * Removes a given layer from the group. */ removeLayer(layer: ILayer): LayerGroup; - + /** * Removes all the layers from the group. */ clearLayers(): LayerGroup; - + /** * Iterates over the layers of the group, optionally specifying context of * the iterator function. @@ -1440,13 +1440,13 @@ declare module L { * Called on map.addLayer(layer). */ onAdd(map: Map): void; - + /** * Should contain all clean up code that removes the overlay's elements from * the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer). */ onRemove(map: Map): void; - + } export class FeatureGroup implements ILayer, IEventPowered { @@ -1454,29 +1454,29 @@ declare module L { * Create a layer group, optionally given an initial set of layers. */ constructor(layers?: ILayer[]); - + /** * Binds a popup with a particular HTML content to a click on any layer from the * group that has a bindPopup method. */ bindPopup(htmlContent: string, options?: PopupOptions): FeatureGroup; - + /** * Returns the LatLngBounds of the Feature Group (created from bounds and coordinates * of its children). */ getBounds(): LatLngBounds; - + /** * Sets the given path options to each layer of the group that has a setStyle method. */ setStyle(style: PathOptions): FeatureGroup; - + /** * Brings the layer group to the top of all other layers. */ bringToFront(): FeatureGroup; - + /** * Brings the layer group to the bottom of all other layers. */ @@ -1492,13 +1492,13 @@ declare module L { * Called on map.addLayer(layer). */ onAdd(map: Map): void; - + /** * Should contain all clean up code that removes the overlay's elements from * the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer). */ onRemove(map: Map): void; - + //////////// //// IEventPowered members //////////// @@ -1507,7 +1507,7 @@ declare module L { addEventListener(eventMap: any, context?: any): IEventPowered; removeEventListener(type: string, fn?: (e: LeafletEvent) => void, context?: any): IEventPowered; removeEventListener(eventMap: any, context?: any): IEventPowered; - hasEventListeners(type: string): bool; + hasEventListeners(type: string): boolean; fireEvent(type: string, data?: any): IEventPowered; on(type: string, fn: (e: LeafletEvent) => void, context?: any): IEventPowered; on(eventMap: any, context?: any): IEventPowered; @@ -1522,24 +1522,24 @@ declare module L { * specified, simple markers will be created). */ pointToLayer?: (featureData: any, latlng: LatLng) => ILayer; - + /** * Function that will be used to get style options for vector layers created * for GeoJSON features. */ style?: (featureData: any) => any; - + /** * Function that will be called on each created feature layer. Useful for attaching * events and popups to features. */ onEachFeature?: (featureData: any, layer: ILayer) => void; - + /** * Function that will be used to decide whether to show a feature or not. */ filter?: (featureData: any, layer: ILayer) => bool; - + } export class GeoJSON extends FeatureGroup { @@ -1549,12 +1549,12 @@ declare module L { * and an options object. */ constructor(geojson?: any, options?: GeoJSONOptions); - + /** - * Adds a GeoJSON object to the layer. + * Adds a GeoJSON object to the layer. */ - addData(data: any): bool; - + addData(data: any): boolean; + /** * NOTE: A fake signature to allow an overriding overload. */ @@ -1564,33 +1564,33 @@ declare module L { * Changes styles of GeoJSON vector layers with the given style function. */ setStyle(style: (featureData: any) => any): GeoJSON; - + /** * Resets the the given vector layer's style to the original GeoJSON style, * useful for resetting style after hover events. */ resetStyle(layer: Path): GeoJSON; - + /** * Creates a layer from a given GeoJSON feature. */ static geometryToLayer(featureData: GeoJSON, pointToLayer?: (featureData: any, latlng: LatLng) => ILayer): ILayer; - + /** * Creates a LatLng object from an array of 2 numbers (latitude, longitude) * used in GeoJSON for points. If reverse is set to true, the numbers will be interpreted * as (longitude, latitude). */ - static coordsToLatlng(coords: Array, reverse?: bool): LatLng; - + static coordsToLatlng(coords: Array, reverse?: boolean): LatLng; + /** * Creates a multidimensional array of LatLng objects from a GeoJSON coordinates * array. levelsDeep specifies the nesting level (0 is for an array of points, * 1 for an array of arrays of points, etc., 0 by default). If reverse is set to * true, the numbers will be interpreted as (longitude, latitude). */ - static coordsToLatlngs(coords: Array, levelsDeep?: number, reverse?: bool): Array; - + static coordsToLatlngs(coords: Array, levelsDeep?: number, reverse?: boolean): Array; + } export class LatLng { @@ -1599,40 +1599,40 @@ declare module L { * and longitude. */ constructor(latitude: number, longitude: number); - + /** * Returns the distance (in meters) to the given LatLng calculated using the * Haversine formula. See description on wikipedia */ distanceTo(otherLatlng: LatLng): number; - + /** * Returns true if the given LatLng point is at the same position (within a small * margin of error). */ - equals(otherLatlng: LatLng): bool; - + equals(otherLatlng: LatLng): boolean; + /** * Returns a string representation of the point (for debugging purposes). */ toString(): string; - + /** * Returns a new LatLng object with the longitude wrapped around left and right * boundaries (-180 to 180 by default). */ wrap(left: number, right: number): LatLng; - + /** * Latitude in degrees. */ lat: number; - + /** * Longitude in degrees. */ lng: number; - + } export class LatLngBounds { @@ -1641,12 +1641,12 @@ declare module L { * of the rectangle. */ constructor(southWest: LatLng, northEast: LatLng); - + /** * Extends the bounds to contain the given point or bounds. */ extend(latlng: LatLng): LatLngBounds; - + /** * Extends the bounds to contain the given point or bounds. */ @@ -1656,65 +1656,65 @@ declare module L { * Returns the south-west point of the bounds. */ getSouthWest(): LatLng; - + /** * Returns the north-east point of the bounds. */ getNorthEast(): LatLng; - + /** * Returns the north-west point of the bounds. */ getNorthWest(): LatLng; - + /** * Returns the south-east point of the bounds. */ getSouthEast(): LatLng; - + /** * Returns the center point of the bounds. */ getCenter(): LatLng; - + /** * Returns true if the rectangle contains the given one. */ - contains(otherBounds: LatLngBounds): bool; - + contains(otherBounds: LatLngBounds): boolean; + /** * Returns true if the rectangle contains the given point. */ - contains(latlng: LatLng): bool; - + contains(latlng: LatLng): boolean; + /** * Returns true if the rectangle intersects the given bounds. */ - intersects(otherBounds: LatLngBounds): bool; - + intersects(otherBounds: LatLngBounds): boolean; + /** * Returns true if the rectangle is equivalent (within a small margin of error) * to the given bounds. */ - equals(otherBounds: LatLngBounds): bool; - + equals(otherBounds: LatLngBounds): boolean; + /** * Returns a string with bounding box coordinates in a 'southwest_lng,southwest_lat,northeast_lng,northeast_lat' * format. Useful for sending requests to web services that return geo data. */ toBBoxString(): string; - + /** * Returns bigger bounds created by extending the current bounds by a given * percentage in each direction. */ pad(bufferRatio: number): LatLngBounds; - + /** * Returns true if the bounds are properly initialized. */ - isValid(): bool; - + isValid(): boolean; + } export class Point { @@ -1722,64 +1722,64 @@ declare module L { * Creates a Point object with the given x and y coordinates. If optional round * is set to true, rounds the x and y values. */ - constructor(x: number, y: number, round?: bool); - + constructor(x: number, y: number, round?: boolean); + /** * Returns the result of addition of the current and the given points. */ add(otherPoint: Point): Point; - + /** * Returns the result of subtraction of the given point from the current. */ subtract(otherPoint: Point): Point; - + /** * Returns the result of multiplication of the current point by the given number. */ multiplyBy(number: number): Point; - + /** * Returns the result of division of the current point by the given number. If * optional round is set to true, returns a rounded result. */ - divideBy(number: number, round?: bool): Point; - + divideBy(number: number, round?: boolean): Point; + /** * Returns the distance between the current and the given points. */ distanceTo(otherPoint: Point): number; - + /** * Returns a copy of the current point. */ clone(): Point; - + /** * Returns a copy of the current point with rounded coordinates. */ round(): Point; - + /** * Returns true if the given point has the same coordinates. */ - equals(otherPoint: Point): bool; - + equals(otherPoint: Point): boolean; + /** * Returns a string representation of the point for debugging purposes. */ toString(): string; - + /** * The x coordinate. */ x: number; - + /** * The y coordinate. */ y: number; - + } export class Bounds { @@ -1788,52 +1788,52 @@ declare module L { * corners). */ constructor(topLeft: Point, bottomRight: Point); - + /** * Extends the bounds to contain the given point. */ extend(point: Point): void; - + /** * Returns the center point of the bounds. */ getCenter(): Point; - + /** * Returns true if the rectangle contains the given one. */ - contains(otherBounds: Bounds): bool; - + contains(otherBounds: Bounds): boolean; + /** * Returns true if the rectangle contains the given point. */ - contains(point: Point): bool; - + contains(point: Point): boolean; + /** * Returns true if the rectangle intersects the given bounds. */ - intersects(otherBounds: Bounds): bool; - + intersects(otherBounds: Bounds): boolean; + /** * Returns true if the bounds are properly initialized. */ - isValid(): bool; - + isValid(): boolean; + /** * Returns the size of the given bounds. */ getSize(): Point; - + /** * The top left corner of the rectangle. */ min: Point; - + /** * The bottom right corner of the rectangle. */ max: Point; - + } export interface IconOptions { @@ -1842,18 +1842,18 @@ declare module L { * path). */ iconUrl?: string; - + /** * The URL to a retina sized version of the icon image (absolute or relative to * your script path). Used for Retina screen devices. */ iconRetinaUrl?: string; - + /** * Size of the icon image in pixels. */ iconSize?: Point; - + /** * The coordinates of the "tip" of the icon (relative to its top left corner). * The icon will be aligned so that this point is at the marker's geographical @@ -1861,41 +1861,41 @@ declare module L { * with negative margins. */ iconAnchor?: Point; - + /** * The URL to the icon shadow image. If not specified, no shadow image will be * created. */ shadowUrl?: string; - + /** * The URL to the retina sized version of the icon shadow image. If not specified, * no shadow image will be created. Used for Retina screen devices. */ shadowRetinaUrl?: string; - + /** * Size of the shadow image in pixels. */ shadowSize?: Point; - + /** * The coordinates of the "tip" of the shadow (relative to its top left corner) * (the same as iconAnchor if not specified). */ shadowAnchor?: Point; - + /** * The coordinates of the point from which popups will "open", relative to the * icon anchor. */ popupAnchor?: Point; - + /** * A custom class name to assign to both icon and shadow images. Empty by default. */ className?: string; - + } export class Icon { @@ -1903,7 +1903,7 @@ declare module L { * Creates an icon instance with the given options. */ constructor(options: IconOptions); - + } export interface DivIconOptions { @@ -1911,7 +1911,7 @@ declare module L { * Size of the icon in pixels. Can be also set through CSS. */ iconSize?: Point; - + /** * The coordinates of the "tip" of the icon (relative to its top left corner). * The icon will be aligned so that this point is at the marker's geographical @@ -1919,17 +1919,17 @@ declare module L { * with negative margins. */ iconAnchor?: Point; - + /** * A custom class name to assign to the icon. 'leaflet-div-icon' by default. */ className?: string; - + /** * A custom HTML code to put inside the div element, empty by default. */ html?: string; - + } export class DivIcon extends Icon{ @@ -1937,7 +1937,7 @@ declare module L { * Creates a div icon instance with the given options. */ constructor(options: DivIconOptions); - + } export interface ControlOptions { @@ -1946,7 +1946,7 @@ declare module L { * positions. */ position: string; - + } export class Control implements IControl { @@ -1954,33 +1954,33 @@ declare module L { * Creates a control with the given options. */ constructor(options?: ControlOptions); - + /** * Sets the position of the control. See control positions. */ setPosition(position: string): Control; - + /** * Returns the current position of the control. */ getPosition(): string; - + /** * Adds the control to the map. */ addTo(map: Map): Control; - + /** * Removes the control from the map. */ removeFrom(map: Map): Control; static Zoom: new () => Zoom; - + static Attribution: new () => Attribution; - + static Layers: new () => Layers; - + static Scale: new () => Scale; //////////// @@ -1993,14 +1993,14 @@ declare module L { * containing the control. Called on map.addControl(control) or control.addTo(map). */ onAdd(map: Map): HTMLElement; - + /** * Optional, should contain all clean up code (e.g. removes control's event * listeners). Called on map.removeControl(control) or control.removeFrom(map). * The control's DOM container is removed automatically. */ onRemove(map: Map): void; - + } export interface ZoomOptions { @@ -2008,7 +2008,7 @@ declare module L { * The position of the control (one of the map corners). See control positions. */ position?: string; - + } export class Zoom extends Control { @@ -2016,7 +2016,7 @@ declare module L { * Creates a zoom control. */ constructor(options?: ZoomOptions); - + } export interface AttributionOptions { @@ -2024,12 +2024,12 @@ declare module L { * The position of the control (one of the map corners). See control positions. */ position?: string; - + /** * The HTML text shown before the attributions. Pass false to disable. */ prefix?: string; - + } export class Attribution extends Control { @@ -2037,22 +2037,22 @@ declare module L { * Creates an attribution control. */ constructor(options?: AttributionOptions); - + /** * Sets the text before the attributions. */ setPrefix(prefix: string): Attribution; - + /** * Adds an attribution text (e.g. 'Vector data © CloudMade'). */ addAttribution(text: string): Attribution; - + /** * Removes an attribution text. */ removeAttribution(text: string): Attribution; - + } export interface LayersOptions { @@ -2060,19 +2060,19 @@ declare module L { * The position of the control (one of the map corners). See control positions. */ position?: string; - + /** * If true, the control will be collapsed into an icon and expanded on mouse hover * or touch. */ - collapsed?: bool; - + collapsed?: boolean; + /** * If true, the control will assign zIndexes in increasing order to all of its * layers so that the order is preserved when switching them on/off. */ - autoZIndex?: bool; - + autoZIndex?: boolean; + } export class Layers extends Control implements IEventPowered { @@ -2081,22 +2081,22 @@ declare module L { * switched with radio buttons, while overlays will be switched with checkboxes. */ constructor(baseLayers?: any, overlays?: any, options?: LayersOptions); - + /** * Adds a base layer (radio button entry) with the given name to the control. */ addBaseLayer(layer: ILayer, name: string): Layers; - + /** * Adds an overlay (checkbox entry) with the given name to the control. */ addOverlay(layer: ILayer, name: string): Layers; - + /** * Remove the given layer from the control. */ removeLayer(layer: ILayer): Layers; - + //////////// //// IEventPowered members //////////// @@ -2105,7 +2105,7 @@ declare module L { addEventListener(eventMap: any, context?: any): IEventPowered; removeEventListener(type: string, fn?: (e: LeafletEvent) => void, context?: any): IEventPowered; removeEventListener(eventMap: any, context?: any): IEventPowered; - hasEventListeners(type: string): bool; + hasEventListeners(type: string): boolean; fireEvent(type: string, data?: any): IEventPowered; on(type: string, fn: (e: LeafletEvent) => void, context?: any): IEventPowered; on(eventMap: any, context?: any): IEventPowered; @@ -2119,29 +2119,29 @@ declare module L { * The position of the control (one of the map corners). See control positions. */ position?: string; - + /** * Maximum width of the control in pixels. The width is set dynamically to show * round values (e.g. 100, 200, 500). */ maxWidth?: number; - + /** * Whether to show the metric scale line (m/km). */ - metric?: bool; - + metric?: boolean; + /** * Whether to show the imperial scale line (mi/ft). */ - imperial?: bool; - + imperial?: boolean; + /** * If true, the control is updated on moveend, otherwise it's always up-to-date * (updated on move). */ - updateWhenIdle?: bool; - + updateWhenIdle?: boolean; + } export class Scale extends Control { @@ -2149,7 +2149,7 @@ declare module L { * Creates an scale control with the given options. */ constructor(options?: ScaleOptions); - + } export interface IEventPowered { @@ -2160,34 +2160,34 @@ declare module L { * dblclick'). */ addEventListener(type: string, fn: (e: LeafletEvent) => void, context?: any): IEventPowered; - + /** * Adds a set of type/listener pairs, e.g. {click: onClick, mousemove: onMouseMove} */ addEventListener(eventMap: any, context?: any): IEventPowered; - + /** * Removes a previously added listener function. If no function is specified, * it will remove all the listeners of that particular event from the object. */ removeEventListener(type: string, fn?: (e: LeafletEvent) => void, context?: any): IEventPowered; - + /** * Removes a set of type/listener pairs. */ removeEventListener(eventMap: any, context?: any): IEventPowered; - + /** * Returns true if a particular event type has some listeners attached to it. */ - hasEventListeners(type: string): bool; - + hasEventListeners(type: string): boolean; + /** * Fires an event of the specified type. You can optionally provide an data object * — the first argument of the listener function will contain its properties. */ fireEvent(type: string, data?: any): IEventPowered; - + /** * Alias to addEventListener. */ @@ -2207,12 +2207,12 @@ declare module L { * Alias to removeEventListener. */ off(eventMap: any, context?: any): IEventPowered; - + /** * Alias to fireEvent. */ fire(type: string, data?: any): IEventPowered; - + } export interface LeafletEvent { @@ -2220,12 +2220,12 @@ declare module L { * The event type (e.g. 'click'). */ type: string; - + /** * The object that fired the event. */ target: any; - + } export interface LeafletMouseEvent { @@ -2233,24 +2233,24 @@ declare module L { * The geographical point where the mouse event occured. */ latlng: LatLng; - + /** * Pixel coordinates of the point where the mouse event occured relative to * the map layer. */ layerPoint: Point; - + /** * Pixel coordinates of the point where the mouse event occured relative to * the map сontainer. */ containerPoint: Point; - + /** * The original DOM mouse event fired by the browser. */ originalEvent: MouseEvent; - + } export interface LeafletLocationEvent { @@ -2258,18 +2258,18 @@ declare module L { * Detected geographical location of the user. */ latlng: LatLng; - + /** * Geographical bounds of the area user is located in (with respect to the accuracy * of location). */ bounds: LatLngBounds; - + /** * Accuracy of location in meters. */ accuracy: number; - + } export interface LeafletErrorEvent { @@ -2277,12 +2277,12 @@ declare module L { * Error message. */ message: string; - + /** * Error code (if applicable). */ code: number; - + } export interface LeafletLayerEvent { @@ -2290,7 +2290,7 @@ declare module L { * The layer that was added or removed. */ layer: ILayer; - + } export interface LeafletTileEvent { @@ -2298,12 +2298,12 @@ declare module L { * The tile element (image). */ tile: HTMLElement; - + /** * The source URL of the tile. */ url: string; - + } export interface LeafletGeoJSONEvent { @@ -2311,22 +2311,22 @@ declare module L { * The layer for the GeoJSON feature that is being added to the map. */ layer: ILayer; - + /** * GeoJSON properties of the feature. */ properties: any; - + /** * GeoJSON geometry type of the feature. */ geometryType: string; - + /** * GeoJSON ID of the feature (if present). */ id: string; - + } export interface LeafletPopupEvent { @@ -2334,7 +2334,7 @@ declare module L { * The popup that was opened or closed. */ popup: Popup; - + } export class Class { @@ -2344,70 +2344,70 @@ declare module L { /** * true for all Internet Explorer versions. */ - static ie: bool; - + static ie: boolean; + /** * true for Internet Explorer 6. */ - static ie6: bool; - + static ie6: boolean; + /** * true for Internet Explorer 6. */ - static ie7: bool; - + static ie7: boolean; + /** * true for webkit-based browsers like Chrome and Safari (including mobile * versions). */ - static webkit: bool; - + static webkit: boolean; + /** * true for webkit-based browsers that support CSS 3D transformations. */ - static webkit3d: bool; - + static webkit3d: boolean; + /** * true for Android mobile browser. */ - static android: bool; - + static android: boolean; + /** * true for old Android stock browsers (2 and 3). */ - static android23: bool; - + static android23: boolean; + /** * true for modern mobile browsers (including iOS Safari and different Android * browsers). */ - static mobile: bool; - + static mobile: boolean; + /** * true for mobile webkit-based browsers. */ - static mobileWebkit: bool; - + static mobileWebkit: boolean; + /** * true for mobile Opera. */ - static mobileOpera: bool; - + static mobileOpera: boolean; + /** * true for all browsers on touch devices. */ - static touch: bool; - + static touch: boolean; + /** * true for browsers with Microsoft touch model (e.g. IE10). */ - static msTouch: bool; - + static msTouch: boolean; + /** * true for devices with Retina screens. */ - static retina: bool; - + static retina: boolean; + } export class Util { @@ -2416,18 +2416,18 @@ declare module L { * and returns the latter. Has an L.extend shortcut. */ static extend(dest: any, ...sources: any[]): any; - + /** * Returns a function which executes function fn with the given scope obj (so * that this keyword refers to obj inside the function code). Has an L.bind shortcut. */ static bind(fn: Function, obj: any): Function; - + /** * Applies a unique key to the object and returns that key. Has an L.stamp shortcut. */ static stamp(obj: any): string; - + /** * Returns a wrapper around the function fn that makes sure it's called not more * often than a certain time interval time, but as fast as possible otherwise @@ -2436,53 +2436,53 @@ declare module L { * be called. */ static limitExecByInterval(fn: Function, time: number, context?: any): Function; - + /** * Returns a function which always returns false. */ static falseFn(): () => bool; - + /** * Returns the number num rounded to digits decimals. */ static formatNum(num: number, digits: number): number; - + /** * Trims and splits the string on whitespace and returns the array of parts. */ static splitWords(str: string): string[]; - + /** * Merges the given properties to the options of the obj object, returning the * resulting options. See Class options. Has an L.setOptions shortcut. */ static setOptions(obj: any, options: any): any; - + /** * Converts an object into a parameter URL string, e.g. {a: "foo", b: "bar"} * translates to '?a=foo&b=bar'. */ static getParamString(obj: any): string; - + /** * Simple templating facility, creates a string by applying the values of the * data object of a form {a: 'foo', b: 'bar', …} to a template string of the form * 'Hello {a}, {b}' — in this example you will get 'Hello foo, bar'. */ static template(str: string, data: any): string; - + /** * Returns true if the given object is an array. */ - static isArray(obj: any): bool; - + static isArray(obj: any): boolean; + /** * Data URI string containing a base64-encoded empty GIF image. Used as a hack * to free memory from unused images on WebKit-powered mobile devices (by setting * image src to this string). */ static emptyImageUrl: string; - + } export class Transformation { @@ -2490,19 +2490,19 @@ declare module L { * Creates a transformation object with the given coefficients. */ constructor(a: number, b: number, c: number, d: number); - + /** * Returns a transformed point, optionally multiplied by the given scale. * Only accepts real L.Point instances, not arrays. */ transform(point: Point, scale?: number): Point; - + /** * Returns the reverse transformation of the given point, optionally divided * by the given scale. Only accepts real L.Point instances, not arrays. */ untransform(point: Point, scale?: number): Point; - + } export class LineUtil { @@ -2515,24 +2515,24 @@ declare module L { * released as a separated micro-library Simplify.js. */ static simplify(points: Point[], tolerance: number): Point[]; - + /** * Returns the distance between point p and segment p1 to p2. */ static pointToSegmentDistance(p: Point, p1: Point, p2: Point): number; - + /** * Returns the closest point from a point p on a segment p1 to p2. */ static closestPointOnSegment(p: Point, p1: Point, p2: Point): number; - + /** * Clips the segment a to b by rectangular bounds (modifying the segment points * directly!). Used by Leaflet to only show polyline points that are on the screen * or near, increasing performance. */ static clipSegment(a: Point, b: Point, bounds: Bounds): void; - + } export class PolyUtil { @@ -2543,7 +2543,7 @@ declare module L { * for clipping than polyline, so there's a seperate method for it. */ static clipPolygon(points: Point[], bounds: Bounds): Point[]; - + } export class DomEvent { @@ -2552,12 +2552,12 @@ declare module L { * inside the listener will point to context, or to the element if not specified. */ static addListener(el: HTMLElement, type: string, fn: (e: Event) => void, context?: any): DomEvent; - + /** * Removes an event listener from the element. */ static removeListener(el: HTMLElement, type: string, fn: (e: Event) => void): DomEvent; - + /** * Stop the given event from propagation to parent elements. Used inside the * listener functions: @@ -2567,36 +2567,36 @@ declare module L { * }); */ static stopPropagation(e: Event): DomEvent; - + /** * Prevents the default action of the event from happening (such as following * a link in the href of the a element, or doing a POST request with page reload * when form is submitted). Use it inside listener functions. */ static preventDefault(e: Event): DomEvent; - + /** * Does stopPropagation and preventDefault at the same time. */ static stop(e: Event): DomEvent; - + /** * Adds stopPropagation to the element's 'click', 'doubleclick', 'mousedown' * and 'touchstart' events. */ static disableClickPropagation(el: HTMLElement): DomEvent; - + /** * Gets normalized mouse position from a DOM event relative to the container * or to the whole page if not specified. */ static getMousePosition(e: Event, container?: HTMLElement): Point; - + /** * Gets normalized wheel delta from a mousewheel DOM event. */ static getWheelDelta(e: Event): number; - + } export class DomUtil { @@ -2605,97 +2605,97 @@ declare module L { * the element if it was passed directly. */ static get(id: string): HTMLElement; - + /** * Returns the value for a certain style attribute on an element, including * computed values or values set through CSS. */ static getStyle(el: HTMLElement, style: string): string; - + /** * Returns the offset to the viewport for the requested element. */ static getViewportOffset(el: HTMLElement): Point; - + /** * Creates an element with tagName, sets the className, and optionally appends * it to container element. */ static create(tagName: string, className: string, container?: HTMLElement): HTMLElement; - + /** * Makes sure text cannot be selected, for example during dragging. */ static disableTextSelection(): void; - + /** * Makes text selection possible again. */ static enableTextSelection(): void; - + /** * Returns true if the element class attribute contains name. */ - static hasClass(el: HTMLElement, name: string): bool; - + static hasClass(el: HTMLElement, name: string): boolean; + /** * Adds name to the element's class attribute. */ static addClass(el: HTMLElement, name: string): void; - + /** * Removes name from the element's class attribute. */ static removeClass(el: HTMLElement, name: string): void; - + /** * Set the opacity of an element (including old IE support). Value must be from * 0 to 1. */ static setOpacity(el: HTMLElement, value: number): void; - + /** * Goes through the array of style names and returns the first name that is a valid * style name for an element. If no such name is found, it returns false. Useful * for vendor-prefixed styles like transform. */ static testProp(props: String[]): string; - + /** * Returns a CSS transform string to move an element by the offset provided in * the given point. Uses 3D translate on WebKit for hardware-accelerated transforms * and 2D on other browsers. */ static getTranslateString(point: Point): string; - + /** * Returns a CSS transform string to scale an element (with the given scale origin). */ static getScaleString(scale: number, origin: Point): string; - + /** * Sets the position of an element to coordinates specified by point, using * CSS translate or top/left positioning depending on the browser (used by * Leaflet internally to position its layers). Forces top/left positioning * if disable3D is true. */ - static setPosition(el: HTMLElement, point: Point, disable3D?: bool): void; - + static setPosition(el: HTMLElement, point: Point, disable3D?: boolean): void; + /** * Returns the coordinates of an element previously positioned with setPosition. */ static getPosition(el: HTMLElement): Point; - + /** * Vendor-prefixed transition style name (e.g. 'webkitTransition' for WebKit). */ static TRANSITION: string; - + /** * Vendor-prefixed transform style name. */ static TRANSFORM: string; - + } export class PosAnimation implements IEventPowered { @@ -2703,14 +2703,14 @@ declare module L { * Creates a PosAnimation object. */ constructor(); - + /** * Run an animation of a given element to a new position, optionally setting * duration in seconds (0.25 by default) and easing linearity factor (3rd argument * of the cubic bezier curve, 0.5 by default) */ run(element: HTMLElement, newPos: Point, duration?: number, easeLinearity?: number): PosAnimation; - + //////////// //// IEventPowered members //////////// @@ -2719,7 +2719,7 @@ declare module L { addEventListener(eventMap: any, context?: any): IEventPowered; removeEventListener(type: string, fn?: (e: LeafletEvent) => void, context?: any): IEventPowered; removeEventListener(eventMap: any, context?: any): IEventPowered; - hasEventListeners(type: string): bool; + hasEventListeners(type: string): boolean; fireEvent(type: string, data?: any): IEventPowered; on(type: string, fn: (e: LeafletEvent) => void, context?: any): IEventPowered; on(eventMap: any, context?: any): IEventPowered; @@ -2734,17 +2734,17 @@ declare module L { * the dragHandle element (equals the element itself by default). */ constructor(element: HTMLElement, dragHandle?: HTMLElement); - + /** * Enables the dragging ability. */ enable(): void; - + /** * Disables the dragging ability. */ disable(): void; - + //////////// //// IEventPowered members //////////// @@ -2753,7 +2753,7 @@ declare module L { addEventListener(eventMap: any, context?: any): IEventPowered; removeEventListener(type: string, fn?: (e: LeafletEvent) => void, context?: any): IEventPowered; removeEventListener(eventMap: any, context?: any): IEventPowered; - hasEventListeners(type: string): bool; + hasEventListeners(type: string): boolean; fireEvent(type: string, data?: any): IEventPowered; on(type: string, fn: (e: LeafletEvent) => void, context?: any): IEventPowered; on(eventMap: any, context?: any): IEventPowered; @@ -2767,17 +2767,17 @@ declare module L { * Enables the handler. */ enable(): void; - + /** * Disables the handler. */ disable(): void; - + /** * Returns true if the handler is enabled. */ - enabled(): bool; - + enabled(): boolean; + } export interface ILayer { @@ -2787,13 +2787,13 @@ declare module L { * Called on map.addLayer(layer). */ onAdd(map: Map): void; - + /** * Should contain all clean up code that removes the overlay's elements from * the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer). */ onRemove(map: Map): void; - + } export interface IControl { @@ -2803,14 +2803,14 @@ declare module L { * containing the control. Called on map.addControl(control) or control.addTo(map). */ onAdd(map: Map): HTMLElement; - + /** * Optional, should contain all clean up code (e.g. removes control's event * listeners). Called on map.removeControl(control) or control.removeFrom(map). * The control's DOM container is removed automatically. */ onRemove(map: Map): void; - + } export class Projection { @@ -2820,14 +2820,14 @@ declare module L { * is a sphere. Used by the EPSG:3857 CRS. */ static SphericalMercator: IProjection; - + /** * Elliptical Mercator projection — more complex than Spherical Mercator. * Takes into account that Earth is a geoid, not a perfect sphere. Used by the * EPSG:3395 CRS. */ static Mercator: IProjection; - + /** * Equirectangular, or Plate Carree projection — the most simple projection, * mostly used by GIS enthusiasts. Directly maps x as longitude, and y as latitude. @@ -2835,7 +2835,7 @@ declare module L { * CRS. */ static LonLat: IProjection; - + } export interface IProjection { @@ -2843,12 +2843,12 @@ declare module L { * Projects geographical coordinates into a 2D point. */ project(latlng: LatLng): Point; - + /** * The inverse of project. Projects a 2D point into geographical location. */ unproject(point: Point): LatLng; - + } export class CRS { @@ -2858,25 +2858,25 @@ declare module L { * Map's crs option. */ static EPSG3857: ICRS; - + /** * A common CRS among GIS enthusiasts. Uses simple Equirectangular projection. */ static EPSG4326: ICRS; - + /** * Rarely used by some commercial tile providers. Uses Elliptical Mercator * projection. */ static EPSG3395: ICRS; - + /** * A simple CRS that maps longitude and latitude into x and y directly. May be * used for maps of flat surfaces (e.g. game maps). Note that the y axis should * still be inverted (going from bottom to top). */ static Simple: ICRS; - + } export interface ICRS { @@ -2884,50 +2884,50 @@ declare module L { * Projection that this CRS uses. */ projection: IProjection; - + /** * Transformation that this CRS uses to turn projected coordinates into screen * coordinates for a particular tile service. */ transformation: Transformation; - + /** * Standard code name of the CRS passed into WMS services (e.g. 'EPSG:3857'). */ code: string; - + /** * Projects geographical coordinates on a given zoom into pixel coordinates. */ latLngToPoint(latlng: LatLng, zoom: number): Point; - + /** * The inverse of latLngToPoint. Projects pixel coordinates on a given zoom * into geographical coordinates. */ pointToLatLng(point: Point, zoom: number): LatLng; - + /** * Projects geographical coordinates into coordinates in units accepted * for this CRS (e.g. meters for EPSG:3857, for passing it to WMS services). */ project(latlng: LatLng): Point; - + /** * Returns the scale used when transforming projected coordinates into pixel * coordinates for a particular zoom. For example, it returns 256 * 2^zoom for * Mercator-based CRS. */ scale(zoom: number): number; - + } /** - * This method restores the L global variale to the original value it had + * This method restores the L global variale to the original value it had * before Leaflet inclusion, and returns the real Leaflet namespace. */ export var noConflict: () => L; - + /** * A constant that represents the Leaflet version in use. */ @@ -2935,19 +2935,19 @@ declare module L { } /** - * Forces Leaflet to use the Canvas back-end (if available) for vector layers - * instead of SVG. This can increase performance considerably in some cases + * Forces Leaflet to use the Canvas back-end (if available) for vector layers + * instead of SVG. This can increase performance considerably in some cases * (e.g. many thousands of circle markers on the map). */ -declare var L_PREFER_CANVAS: bool; +declare var L_PREFER_CANVAS: boolean; /** * Forces Leaflet to not use touch events even if it detects them. */ -declare var L_NO_TOUCH: bool; +declare var L_NO_TOUCH: boolean; /** - * Forces Leaflet to not use hardware-accelerated CSS 3D transforms for positioning + * Forces Leaflet to not use hardware-accelerated CSS 3D transforms for positioning * (which may cause glitches in some rare environments) even if they're supported. */ -declare var L_DISABLE_3D: bool; +declare var L_DISABLE_3D: boolean; From 555d0f5c5f31f7f05621f818cd71400d7946225d Mon Sep 17 00:00:00 2001 From: Derek Cicerone Date: Mon, 1 Jul 2013 19:10:05 -0400 Subject: [PATCH 030/756] Replace bool with boolean (for TypeScript 0.9.0+) --- handlebars/handlebars.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/handlebars/handlebars.d.ts b/handlebars/handlebars.d.ts index aa5e72086d..f6b0c55652 100644 --- a/handlebars/handlebars.d.ts +++ b/handlebars/handlebars.d.ts @@ -5,7 +5,7 @@ interface HandlebarsStatic { - registerHelper(name: string, fn: Function, inverse?: bool): void; + registerHelper(name: string, fn: Function, inverse?: boolean): void; registerPartial(name: string, str): void; K(); createFrame(object); @@ -20,4 +20,4 @@ interface HandlebarsStatic { compile(environment, options?, context?, asObject?); } -declare var Handlebars: HandlebarsStatic; \ No newline at end of file +declare var Handlebars: HandlebarsStatic; From bc491674fc7416065c2a5cdd6c16ac85477e2c38 Mon Sep 17 00:00:00 2001 From: Carl de Billy Date: Mon, 1 Jul 2013 22:53:39 -0400 Subject: [PATCH 031/756] IObservable => IObservable Now use generics who improve a lot the writing of Rx fluent expressions! --- rx.js/rx.js.aggregates.d.ts | 19 ++- rx.js/rx.js.d.ts | 315 ++++++++++++++++++------------------ rx.js/rx.js.html.d.ts | 6 +- rx.js/rx.js.jquery.d.ts | 122 +++++++++----- rx.js/rx.js.time.d.ts | 11 +- 5 files changed, 262 insertions(+), 211 deletions(-) diff --git a/rx.js/rx.js.aggregates.d.ts b/rx.js/rx.js.aggregates.d.ts index 7c10866a6e..16426a96e4 100644 --- a/rx.js/rx.js.aggregates.d.ts +++ b/rx.js/rx.js.aggregates.d.ts @@ -1,16 +1,19 @@ +/// + // Type definitions for RxJS "Aggregates" // Project: http://rx.codeplex.com/ // Definitions by: Carl de Billy // Definitions: https://github.com/borisyankov/DefinitelyTyped -/// - declare module Rx { - interface Observable { - all(predicate?: (any) => bool): IObservable; - min(predicate?: (any) => bool): IObservable; - max(predicate?: (any) => bool): IObservable; - count(predicate?: (any) => bool): IObservable; - sum(keySelector?: (any) => any): IObservable; + interface IObservable { + all(predicate?: (value: T) => bool): IObservable; + min(comparer?: (value1: T, value2: T) => number): IObservable; + max(comparer?: (value1: T, value2: T) => number): IObservable; + count(predicate?: (item: T) => bool): IObservable; + sum(keySelector?: (item: T) => number): IObservable; + isEmpty(predicate?: (value: T) => bool): IObservable; + contains(value: T, comparer?: (value1: T, value2: T) => bool): IObservable; + average(keySelector?: (item: T) => number): IObservable; } } \ No newline at end of file diff --git a/rx.js/rx.js.d.ts b/rx.js/rx.js.d.ts index 543fb703de..1cce070dcb 100644 --- a/rx.js/rx.js.d.ts +++ b/rx.js/rx.js.d.ts @@ -8,7 +8,7 @@ declare module Rx { export module Internals { function inherits(child: Function, parent: Function): Function; function addProperties(obj: Object, ...sourcces: Object[]): void; - function addRef(xs: IObservable, r: { getDisposable(): _IDisposable; }): IObservable; + function addRef(xs: IObservable, r: { getDisposable(): _IDisposable; }): IObservable; } //Collections @@ -192,81 +192,81 @@ declare module Rx { interface ICatchScheduler extends IScheduler { } // Notifications - interface INotification { - accept(observer: IObserver): void; - accept(onNext: (value: any) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): void; + interface INotification { + accept(observer: IObserver): void; + accept(onNext: (value: T) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): void; toObservable(scheduler?: IScheduler): IObservable; hasValue: bool; - equals(other: INotification): bool; + equals(other: INotification): bool; kind: string; - value?: any; + value?: T; exception?: any; } export interface Notification { //abstract //function new (): INotification; - createOnNext(value: any): INotification;//ON - createOnError(exception): INotification;//OE - createOnCompleted(): INotification;//OC + createOnNext(value: T): INotification;//ON + createOnError(exception): INotification;//OE + createOnCompleted(): INotification;//OC } var Notification: Notification; export module Internals { // Enumerator - interface IEnumerator { + interface IEnumerator { moveNext(): bool; - getCurrent(): any; + getCurrent(): T; dispose(): void; } - export interface Enumerator { - (moveNext: () =>bool, getCurrent: () => any, dispose: () =>void ): IEnumerator; + export interface Enumerator { + (moveNext: () =>bool, getCurrent: () => T, dispose: () =>void ): IEnumerator; - create(moveNext: () =>bool, getCurrent: () =>any, dispose?: () =>void ): IEnumerator; + create(moveNext: () =>bool, getCurrent: () => T, dispose?: () =>void ): IEnumerator; } // Enumerable - interface IEnumerable { - getEnumerator(): IEnumerator; + interface IEnumerable { + getEnumerator(): IEnumerator; - concat(): IObservable; - catchException(): IObservable; + concat(): IObservable; + catchException(): IObservable; } - export interface Enumerable { - (getEnumerator: () =>IEnumerator): IEnumerable; + export interface Enumerable { + (getEnumerator: () =>IEnumerator): IEnumerable; - repeat(value: any, repeatCount?: number): IEnumerable; - forEach(source: any[], selector?: (element: any, index: number) =>any): IEnumerable; - forEach(source: { length: number;[index: number]: any; }, selector?: (element: any, index: number) =>any): IEnumerable; + repeat(value: T, repeatCount?: number): IEnumerable; + forEach(source: T[], selector?: (element: T, index: number) => T2): IEnumerable; + forEach(source: { length: number; [index: number]: T; }, selector?: (element: T, index: number) => T2): IEnumerable; } } // Observer - interface IObserver { - onNext(value: any): void; + interface IObserver { + onNext(value: T): void; onError(exception: any): void; onCompleted(): void; - toNotifier(): (notification: INotification) =>void; - asObserver(): IObserver; + toNotifier(): (notification: INotification) =>void; + asObserver(): IObserver; checked(): ICheckedObserver; } export module Observer { //abstract //function new (): IObserver; - function create(onNext: (value: any) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): IObserver; - function fromNotifier(handler: (notification: INotification) =>void ): IObserver; + function create(onNext: (value: T) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): IObserver; + function fromNotifier(handler: (notification: INotification) =>void ): IObserver; } export module Internals { // Abstract Observer - interface IAbstractObserver extends IObserver { + interface IAbstractObserver extends IObserver { isStopped: bool; dispose(): void; - next(value: any): void; + next(value: T): void; error(exception: any): void; completed(): void; fail(): bool; @@ -277,20 +277,20 @@ declare module Rx { //} } - export class AnonymousObserver { - constructor(onNext: (value: any) => void , onError: (exception: any) => void , onCompleted: () => void); + export class AnonymousObserver { + constructor(onNext: (value: T) => void , onError: (exception: any) => void , onCompleted: () => void); } - interface ICheckedObserver extends IObserver { - _observer: IObserver; + interface ICheckedObserver extends IObserver { + _observer: IObserver; _state: number; // 0 - idle, 1 - busy, 2 - done checkAccess(): void; } export module Internals { - interface IScheduledObserver extends IAbstractObserver { + interface IScheduledObserver extends IAbstractObserver { scheduler: IScheduler; - observer: IObserver; + observer: IObserver; isAcquired: bool; hasFaulted: bool; //queue: { (value: any): void; (exception: any): void; (): void; }[]; @@ -298,163 +298,164 @@ declare module Rx { ensureActive(): void; } - export interface ScheduledObserver { - (scheduler: IScheduler, observer: IObserver): IScheduledObserver; + export interface ScheduledObserver { + (scheduler: IScheduler, observer: IObserver): IScheduledObserver; } } + interface IObservable { + _subscribe: (observer: IObserver) =>_IDisposable; - interface IObservable { - _subscribe: (observer: IObserver) =>_IDisposable; + subscribe(observer: IObserver): _IDisposable; - subscribe(observer: IObserver): _IDisposable; + finalValue(): IObservable; + subscribe(onNext?: (value: T) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): _IDisposable; + toArray(): IObservable; - finalValue(): IObservable; - subscribe(onNext?: (value: any) =>void , onError?: (exception: any) =>void , onCompleted?: () =>void ): _IDisposable; - toArray(): IObservable; - - observeOn(scheduler: IScheduler): IObservable; - subscribeOn(scheduler: IScheduler): IObservable; - amb(rightSource: IObservable): IObservable; - catchException(handler: (exception: any) =>IObservable): IObservable; - catchException(second: IObservable): IObservable; - combineLatest(second: IObservable, resultSelector: (v1: any, v2: any) =>any): IObservable; - combineLatest(second: IObservable, third: IObservable, resultSelector: (v1: any, v2: any, v3: any) =>any): IObservable; - combineLatest(second: IObservable, third: IObservable, fourth: IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any) =>any): IObservable; - combineLatest(second: IObservable, third: IObservable, fourth: IObservable, fifth, IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any, v5: any) =>any): IObservable; - combineLatest(...soucesAndResultSelector: any[]): IObservable; - concat(...sources: IObservable[]): IObservable; - concat(sources: IObservable[]): IObservable; - concatIObservable(): IObservable; - merge(maxConcurrent: number): IObservable; - merge(other: IObservable): IObservable; - mergeIObservable(): IObservable; - onErrorResumeNext(second: IObservable): IObservable; - skipUntil(other: IObservable): IObservable; - switchLatest(): IObservable; - takeUntil(other: IObservable): IObservable; - zip(second: IObservable, resultSelector: (v1: any, v2: any) =>any): IObservable; - zip(second: IObservable, third: IObservable, resultSelector: (v1: any, v2: any, v3: any) =>any): IObservable; - zip(second: IObservable, third: IObservable, fourth: IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any) =>any): IObservable; - zip(second: IObservable, third: IObservable, fourth: IObservable, fifth, IObservable, resultSelector: (v1: any, v2: any, v3: any, v4: any, v5: any) =>any): IObservable; - zip(...soucesAndResultSelector: any[]): IObservable; - zip(second: any[], resultSelector: (left: any, right: any) =>any): IObservable; + observeOn(scheduler: IScheduler): IObservable; + subscribeOn(scheduler: IScheduler): IObservable; + amb(rightSource: IObservable): IObservable; + catchException(handler: (exception: any) =>IObservable): IObservable; + catchException(second: IObservable): IObservable; + combineLatest(second: IObservable, resultSelector: (v1: T, v2: T2) =>TResult): IObservable; + combineLatest(second: IObservable, third: IObservable, resultSelector: (v1: T, v2: T2, v3: T3) =>TResult): IObservable; + combineLatest(second: IObservable, third: IObservable, fourth: IObservable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) =>TResult): IObservable; + combineLatest(second: IObservable, third: IObservable, fourth: IObservable, fifth: IObservable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4, v5: T5) =>TResult): IObservable; + combineLatest(...soucesAndResultSelector: any[]): IObservable; + concat(...sources: IObservable[]): IObservable; + concat(sources: IObservable[]): IObservable; + //concatIObservable(): IObservable; + merge(maxConcurrent: number): IObservable; + merge(other: IObservable): IObservable; + //mergeIObservable(): IObservable; + onErrorResumeNext(second: IObservable): IObservable; + skipUntil(other: IObservable): IObservable; + switchLatest(): IObservable; + takeUntil(other: IObservable): IObservable; + zip(second: IObservable, resultSelector: (v1: T, v2: T2) =>TResult): IObservable; + zip(second: IObservable, third: IObservable, resultSelector: (v1: T, v2: T2, v3: T3) => TResult): IObservable; + zip(second: IObservable, third: IObservable, fourth: IObservable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): IObservable; + zip(second: IObservable, third: IObservable, fourth: IObservable, fifth: IObservable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4, v5: T5) => TResult): IObservable; + zip(...soucesAndResultSelector: any[]): IObservable; + zip(second: any[], resultSelector: (left: T, right: any) => TResult): IObservable; asIObservable(): IObservable; - bufferWithCount(count: number, skip?: number): IObservable; - dematerialize(): IObservable; - distinctUntilChanged(keySelector?: (value: any) =>any, comparer?: (x: any, y: any) =>bool): IObservable; - doAction(observer: IObserver): IObservable; - doAction(onNext: (value: any) => void , onError?: (exception: any) =>void , onCompleted?: () =>void ): IObservable; - finallyAction(action: () =>void ): IObservable; - ignoreElements(): IObservable; - materialize(): IObservable; - repeat(repeatCount?: number): IObservable; - retry(retryCount?: number): IObservable; - scan(seed: any, accumulator: (acc: any, value: any) =>any): IObservable; - scan(accumulator: (acc: any, value: any) =>any): IObservable; - skipLast(count: number): IObservable; - startWith(...values: any[]): IObservable; - startWith(scheduler: IScheduler, ...values: any[]): IObservable; - takeLast(count: number, scheduler?: IScheduler): IObservable; - takeLastBuffer(count: number): IObservable; - windowWithCount(count: number, skip?: number): IObservable; - defaultIfEmpty(defaultValue?: any): IObservable; - distinct(keySelector?: (value: any) =>any, keySerializer?: (key: any) =>string): IObservable; - groupBy(keySelector: (value: any) =>any, elementSelector?: (value: any) =>any, keySerializer?: (key: any) =>string): IGroupedObservable; - groupByUntil(keySelector: (value: any) =>any, elementSelector: (value: any) =>any, durationSelector: (gloup: IGroupedObservable) =>IObservable, keySerializer?: (key: any) =>string): IGroupedObservable; - select(selector: (value: any, index: number) =>any): IObservable; - selectMany(selector: (value: any) =>IObservable, resultSelector?: (x: any, y: any) =>any): IObservable; - selectMany(other: IObservable): IObservable; - skip(count: number): IObservable; - skipWhile(predicate: (value: any, index?: number) =>bool): IObservable; - take(count: number, scheduler?: IScheduler): IObservable; - takeWhile(predicate: (value: any, index?: number) =>bool): IObservable; - where(predicate: (value: any, index?: number) => bool): IObservable; + bufferWithCount(count: number, skip?: number): IObservable; + dematerialize(): IObservable; + distinctUntilChanged(keySelector?: (value: T) => TValue, comparer?: (x: TValue, y: TValue) =>bool): IObservable; + doAction(observer: IObserver): IObservable; + doAction(onNext: (value: T) => void , onError?: (exception: any) =>void , onCompleted?: () =>void ): IObservable; + finallyAction(action: () =>void): IObservable; + ignoreElements(): IObservable; + materialize(): IObservable>; // IObservable> not supported by TypeScript 0.9.0 !! + repeat(repeatCount?: number): IObservable; + retry(retryCount?: number): IObservable; + scan(seed: TAcc, accumulator: (acc: TAcc, value: T) => TAcc): IObservable; + scan(accumulator: (acc: TAcc, value: T) => TAcc): IObservable; + skipLast(count: number): IObservable; + startWith(...values: T[]): IObservable; + startWith(scheduler: IScheduler, ...values: T[]): IObservable; + takeLast(count: number, scheduler?: IScheduler): IObservable; + takeLastBuffer(count: number): IObservable; + windowWithCount(count: number, skip?: number): IObservable; + defaultIfEmpty(defaultValue?: any): IObservable; + distinct(keySelector?: (value: T) => TKey, keySerializer?: (key: TKey) =>string): IObservable; + groupBy(keySelector: (value: T) => TKey, elementSelector?: (value: T) => TElement, keySerializer?: (key: TKey) => string): IGroupedObservable; + groupByUntil(keySelector: (value: T) => TKey, elementSelector: (value: T) => TElement, durationSelector: (group: IGroupedObservable) => IObservable, keySerializer?: (key: TKey) => string): IGroupedObservable; + select(selector: (value: T, index: number) =>T2): IObservable; + selectMany(selector: (value: T) =>IObservable, resultSelector?: (x: any, y: any) =>any): IObservable; + selectMany(other: IObservable): IObservable; + skip(count: number): IObservable; + skipWhile(predicate: (value: T, index?: number) =>bool): IObservable; + take(count: number, scheduler?: IScheduler): IObservable; + takeWhile(predicate: (value: T, index?: number) =>bool): IObservable; + where(predicate: (value: T, index?: number) => bool): IObservable; // time - delay(dueTime: number, scheduler?: IScheduler): IObservable; - throttle(dueTime: number, scheduler?: IScheduler): IObservable; - windowWithTime(dueTime: number, timeShiftOrScheduler?: any, scheduler?: IScheduler): IObservable; - timeInterval(scheduler: IScheduler): IObservable; - sample(interval: number, scheduler?: IScheduler): IObservable; - sample(sampler: IObservable, scheduler?: IScheduler): IObservable; - timeout(dueTime: number, other?: IObservable, scheduler?: IScheduler): IObservable; - delaySubscription(dueTime: number, scheduler?: IScheduler): IObservable; + delay(dueTime: number, scheduler?: IScheduler): IObservable; + throttle(dueTime: number, scheduler?: IScheduler): IObservable; + windowWithTime(dueTime: number, timeShiftOrScheduler?: any, scheduler?: IScheduler): IObservable; + timeInterval(scheduler: IScheduler): IObservable; + sample(interval: number, scheduler?: IScheduler): IObservable; + sample(sampler: IObservable, scheduler?: IScheduler): IObservable; + timeout(dueTime: number, other?: IObservable, scheduler?: IScheduler): IObservable; + delaySubscription(dueTime: number, scheduler?: IScheduler): IObservable; } - interface Observable { - (subscribe: (observer: IObserver) =>_IDisposable): IObservable; - start(func: () =>any, scheduler?: IScheduler, context?: any): IObservable; - toAsync(func: Function, scheduler?: IScheduler, context?: any): (...arguments: any[]) => IObservable; - create(subscribe: (Observer) => void ): IObservable; - create(subscribe: (Observer) => () => void ): IObservable; - createWithDisposable(subscribe: (Observer) =>_IDisposable): IObservable; - defer(observableFactory: () =>IObservable): IObservable; - empty(scheduler?: IScheduler): IObservable; - fromArray(array: any[], scheduler?: IScheduler): IObservable; - fromArray(array: { length: number;[index: number]: any; }, scheduler?: IScheduler): IObservable; - generate(initialState: any, condition: (state: any) =>bool, iterate: (state: any) =>any, resultSelector: (state: any) =>any, scheduler?: IScheduler): IObservable; - never(): IObservable; - range(start: number, count: number, scheduler?: IScheduler): IObservable; - repeat(value: any, repeatCount?: number, scheduler?: IScheduler): IObservable; - returnValue(value: any, scheduler?: IScheduler): IObservable; - throwException(exception: any, scheduler?: IScheduler): IObservable; - using(resourceFactory: () =>any, observableFactory: (resource: any) =>IObservable): IObservable; - amb(...sources: IObservable[]): IObservable; - catchException(sources: IObservable[]): IObservable; - catchException(...sources: IObservable[]): IObservable; - concat(...sources: IObservable[]): IObservable; - concat(sources: IObservable[]): IObservable; - merge(...sources: IObservable[]): IObservable; - merge(sources: IObservable[]): IObservable; - merge(scheduler: IScheduler, ...sources: IObservable[]): IObservable; - merge(scheduler: IScheduler, sources: IObservable[]): IObservable; - onErrorResumeNext(...sources: IObservable[]): IObservable; - onErrorResumeNext(sources: IObservable[]): IObservable; + interface Observable { + (subscribe: (observer: IObserver) =>_IDisposable): IObservable; + + start(func: () =>T, scheduler?: IScheduler, context?: any): IObservable; + toAsync(func: Function, scheduler?: IScheduler, context?: any): (...arguments: any[]) => IObservable; + create(subscribe: (observer: IObserver) => void ): IObservable; + create(subscribe: (observer: IObserver) => () => void ): IObservable; + createWithDisposable(subscribe: (observer: IObserver) =>_IDisposable): IObservable; + defer(observableFactory: () =>IObservable): IObservable; + empty(scheduler?: IScheduler): IObservable; + fromArray(array: T[], scheduler?: IScheduler): IObservable; + fromArray(array: { length: number;[index: number]: T; }, scheduler?: IScheduler): IObservable; + generate(initialState: TState, condition: (state: TState) => bool, iterate: (state: TState) => TState, resultSelector: (state: TState) => TResult, scheduler?: IScheduler): IObservable; + never(): IObservable; + range(start: number, count: number, scheduler?: IScheduler): IObservable; + repeat(value: T, repeatCount?: number, scheduler?: IScheduler): IObservable; + returnValue(value: T, scheduler?: IScheduler): IObservable; + throwException(exception: any, scheduler?: IScheduler): IObservable; + using(resourceFactory: () => TResource, observableFactory: (resource: TResource) => IObservable): IObservable; + amb(...sources: IObservable[]): IObservable; + catchException(sources: IObservable[]): IObservable; + catchException(...sources: IObservable[]): IObservable; + concat(...sources: IObservable[]): IObservable; + concat(sources: IObservable[]): IObservable; + merge(...sources: IObservable[]): IObservable; + merge(sources: IObservable[]): IObservable; + merge(scheduler: IScheduler, ...sources: IObservable[]): IObservable; + merge(scheduler: IScheduler, sources: IObservable[]): IObservable; + onErrorResumeNext(...sources: IObservable[]): IObservable; + onErrorResumeNext(sources: IObservable[]): IObservable; } var Observable: Observable; export module Internals { - interface IAnonymousObservable extends IObservable { } - export interface AnonymousObservable { - (subscribe: (observer: IObserver) =>_IDisposable): IAnonymousObservable; + interface IAnonymousObservable extends IObservable { } + export interface AnonymousObservable { + (subscribe: (observer: IObserver) =>_IDisposable): IAnonymousObservable; } } - interface IGroupedObservable extends IObservable { - key: any; - underlyingObservable: IObservable; + interface IGroupedObservable extends IObservable { + key: TKey; + underlyingObservable: IObservable; } - interface ISubject extends IObservable, IObserver { + interface ISubject extends IObservable, IObserver { isDisposed: bool; isStopped: bool; - observers: IObserver[]; + //observers: IObserver[]; dispose(): void; } - export interface Subject { - (): ISubject; - create(observer?: IObserver, observable?: IObservable): ISubject; + export interface Subject { + (): ISubject; + + create(observer?: IObserver, observable?: IObservable): ISubject; } - interface IAsyncSubject extends IObservable, IObserver { + interface IAsyncSubject extends IObservable, IObserver { isDisposed: bool; - value: any; + value: T; hasValue: bool; - observers: IObserver[]; + observers: IObserver[]; exception: any; dispose(): void; } - export interface AsyncSubject { - (): IAsyncSubject; + export interface AsyncSubject { + (): IAsyncSubject; } - interface IAnonymousSubject extends IObservable { - onNext(value: any): void; + interface IAnonymousSubject extends IObservable { + onNext(value: T): void; onError(exception: any): void; onCompleted(): void; } diff --git a/rx.js/rx.js.html.d.ts b/rx.js/rx.js.html.d.ts index 2592d3f122..e1dcf69dd5 100644 --- a/rx.js/rx.js.html.d.ts +++ b/rx.js/rx.js.html.d.ts @@ -1,8 +1,8 @@ -/// +/// declare module Rx { interface Observable { - fromEvent(element: HTMLElement, eventName: string) : IObservable; - fromEvent(document: HTMLDocument, eventName: string): IObservable; + fromEvent(element: HTMLElement, eventName: string): IObservable; + fromEvent(document: HTMLDocument, eventName: string): IObservable; } } \ No newline at end of file diff --git a/rx.js/rx.js.jquery.d.ts b/rx.js/rx.js.jquery.d.ts index 7f87a37da8..361040390b 100644 --- a/rx.js/rx.js.jquery.d.ts +++ b/rx.js/rx.js.jquery.d.ts @@ -1,46 +1,90 @@ -/// +/// /// +declare module JQueryResults { + + export interface eventBase{ + bubbles: bool; + cancelable: bool; + type: string; + preventDefault(): void; + isDefaultPrevented(): bool; + stopPropagation(): void; + isPropagationStopped(): bool; + data: any; + originalEvent: any; + eventPhase: number; + } + + export interface keyEvent extends eventBase { + key: number; + keyCode: number; + altKey: bool; + ctrlKey: bool; + shiftKey: bool; + char: string; + metaKey: bool; + } + + export interface uiEvent extends eventBase{ + target: any; + currentTarget: any; + } + + export interface mouseEvent extends keyEvent{ + clientX: number; + clientY: number; + screenX: number; + screenY: number; + offsetX: number; + offsetY: number; + pageX: number; + pageY: number; + which: number; + } +} + + interface JQueryStatic { - ajaxAsObservable(settings: JQueryAjaxSettings): Rx.IObservable; - getAsObservable(url: string, data: any, dataType: string): Rx.IObservable; - getJSONAsObservable(url: string, data: any): Rx.IObservable; - getScriptAsObservable(url: string, data: any): Rx.IObservable; - postAsObservable(url: string, data: any, dataType: string): Rx.IObservable; + ajaxAsObservable(settings: JQueryAjaxSettings): Rx.IObservable; + getAsObservable(url: string, data: any, dataType: string): Rx.IObservable; + getJSONAsObservable(url: string, data: any): Rx.IObservable; + getScriptAsObservable(url: string, data: any): Rx.IObservable; + postAsObservable(url: string, data: any, dataType: string): Rx.IObservable; } interface JQuery { - changeAsObservable(eventData?: any): Rx.IObservable; - clickAsObservable(eventData?: any): Rx.IObservable; - dblclickAsObservable(eventData?: any): Rx.IObservable; - focusAsObservable(eventData?: any): Rx.IObservable; - focusinAsObservable(eventData?: any): Rx.IObservable; - focusoutAsObservable(eventData?: any): Rx.IObservable; - keydownAsObservable(eventData?: any): Rx.IObservable; - keyupAsObservable(eventData?: any): Rx.IObservable; - loadAsObservable(eventData?: any): Rx.IObservable; - mousedownAsObservable(eventData?: any): Rx.IObservable; - mouseenterAsObservable(eventData?: any): Rx.IObservable; - mouseleaveAsObservable(eventData?: any): Rx.IObservable; - mousemoveAsObservable(eventData?: any): Rx.IObservable; - mouseoutAsObservable(eventData?: any): Rx.IObservable; - mouseoverAsObservable(eventData?: any): Rx.IObservable; - mouseupAsObservable(eventData?: any): Rx.IObservable; - resizeAsObservable(eventData?: any): Rx.IObservable; - scrollAsObservable(eventData?: any): Rx.IObservable; - selectAsObservable(eventData?: any): Rx.IObservable; - submitAsObservable(eventData?: any): Rx.IObservable; - unloadAsObservable(eventData?: any): Rx.IObservable; - readyAsObservable(): Rx.IObservable; - hideAsObservable(duration: number): Rx.IObservable; - showAsObservable(duration: number): Rx.IObservable; - animateAsObservable(properties: any, duration: number, easing?: string): Rx.IObservable; - fadeInAsObservable(duration: number, easing?: string): Rx.IObservable; - fadeToAsObservable(duration: number, opacity: number, easing?: string): Rx.IObservable; - fadeOutAsObservable(duration: number, easing?: string): Rx.IObservable; - fadeToggleAsObservable(duration: number, easing?: string): Rx.IObservable; - slideDownAsObservable(duration: number): Rx.IObservable; - slideUpAsObservable(duration: number): Rx.IObservable; - slideToggleAsObservable(duration: number): Rx.IObservable; - toggleAsObservable(duration: number): Rx.IObservable; + changeAsObservable(eventData?: any): Rx.IObservable; + clickAsObservable(eventData?: any): Rx.IObservable; + dblclickAsObservable(eventData?: any): Rx.IObservable; + focusAsObservable(eventData?: any): Rx.IObservable; + focusinAsObservable(eventData?: any): Rx.IObservable; + focusoutAsObservable(eventData?: any): Rx.IObservable; + keydownAsObservable(eventData?: any): Rx.IObservable; + keyupAsObservable(eventData?: any): Rx.IObservable; + loadAsObservable(eventData?: any): Rx.IObservable; + mousedownAsObservable(eventData?: any): Rx.IObservable; + mouseenterAsObservable(eventData?: any): Rx.IObservable; + mouseleaveAsObservable(eventData?: any): Rx.IObservable; + mousemoveAsObservable(eventData?: any): Rx.IObservable; + mouseoutAsObservable(eventData?: any): Rx.IObservable; + mouseoverAsObservable(eventData?: any): Rx.IObservable; + mouseupAsObservable(eventData?: any): Rx.IObservable; + resizeAsObservable(eventData?: any): Rx.IObservable; + scrollAsObservable(eventData?: any): Rx.IObservable; + selectAsObservable(eventData?: any): Rx.IObservable; + submitAsObservable(eventData?: any): Rx.IObservable; + unloadAsObservable(eventData?: any): Rx.IObservable; + hideAsObservable(duration: number): Rx.IObservable; + showAsObservable(duration: number): Rx.IObservable; + readyAsObservable(): Rx.IObservable; + animateAsObservable(properties: any, duration: number, easing?: string): Rx.IObservable; + fadeInAsObservable(duration: number, easing?: string): Rx.IObservable; + fadeToAsObservable(duration: number, opacity: number, easing?: string): Rx.IObservable; + fadeOutAsObservable(duration: number, easing?: string): Rx.IObservable; + fadeToggleAsObservable(duration: number, easing?: string): Rx.IObservable; + slideDownAsObservable(duration: number): Rx.IObservable; + slideUpAsObservable(duration: number): Rx.IObservable; + slideToggleAsObservable(duration: number): Rx.IObservable; + toggleAsObservable(duration: number): Rx.IObservable; } \ No newline at end of file diff --git a/rx.js/rx.js.time.d.ts b/rx.js/rx.js.time.d.ts index 2c098fa6a6..fc12992558 100644 --- a/rx.js/rx.js.time.d.ts +++ b/rx.js/rx.js.time.d.ts @@ -1,10 +1,13 @@ /// declare module Rx { + interface IObservable { + ifThen(condition: () => bool, thenSource: IObservable): IObservable; + ifThen(condition: () => bool, thenSource: IObservable, elseSource: IObservable): IObservable; + ifThen(condition: () => bool, thenSource: IObservable, scheduler: IScheduler): IObservable; + } interface Observable { - ifThen(condition: () => bool, thenSource: IObservable): IObservable; - ifThen(condition: () => bool, thenSource: IObservable, elseSource: IObservable): IObservable; - ifThen(condition: () => bool, thenSource: IObservable, scheduler: IScheduler): IObservable; - interval(period: number, scheduler?: IScheduler): IObservable; + interval(period: number, scheduler?: IScheduler): IObservable; + interval(dutTime: number, period: number, scheduler?: IScheduler): IObservable; } } \ No newline at end of file From 24ca683da9ec8fbe536d243b61c4c1da850969f1 Mon Sep 17 00:00:00 2001 From: Derek Cicerone Date: Tue, 2 Jul 2013 14:57:23 -0400 Subject: [PATCH 032/756] Replace bool with boolean (for TypeScript 0.9.0+) --- zeroclipboard/zeroclipboard.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/zeroclipboard/zeroclipboard.d.ts b/zeroclipboard/zeroclipboard.d.ts index 86713503e3..c059d47eb6 100644 --- a/zeroclipboard/zeroclipboard.d.ts +++ b/zeroclipboard/zeroclipboard.d.ts @@ -10,7 +10,7 @@ declare class ZeroClipboard { setText(newText: string); setTitle(newTitle: string); setSize(width: number, height: number); - setHandCursor(enabled: bool); + setHandCursor(enabled: boolean); version: string; moviePath: string; trustedDomains: any; @@ -18,7 +18,7 @@ declare class ZeroClipboard { hoverClass: string; activeClass: string; resetBridge(); - ready: bool; + ready: boolean; reposition(); on(eventName, func); addEventListener(eventName: string, func); @@ -29,7 +29,7 @@ declare class ZeroClipboard { unglue(elements: any); static setDefaults(options: ZeroClipboardOptions); static destroy(); - static detectFlashSupport(): bool; + static detectFlashSupport(): boolean; static dispatch(eventName: string, func); } From 221f0bcfb0297f69d76ce4b2dcce0b32b419d0ff Mon Sep 17 00:00:00 2001 From: Derek Cicerone Date: Tue, 2 Jul 2013 16:11:22 -0400 Subject: [PATCH 033/756] Replace bool with boolean (for TypeScript 0.9.0+) --- mousetrap/mousetrap.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mousetrap/mousetrap.d.ts b/mousetrap/mousetrap.d.ts index 814efb3ddf..d2ae42aa6d 100644 --- a/mousetrap/mousetrap.d.ts +++ b/mousetrap/mousetrap.d.ts @@ -4,11 +4,11 @@ // Definitions: https://github.com/borisyankov/DefinitelyTyped interface ExtendedKeyboardEvent extends KeyboardEvent { - returnValue: bool; // IE returnValue + returnValue: boolean; // IE returnValue } interface MousetrapStatic { - stopCallback: (e: ExtendedKeyboardEvent, element: Element, combo: string) => bool; + stopCallback: (e: ExtendedKeyboardEvent, element: Element, combo: string) => boolean; bind(keys: string, callback: (e: ExtendedKeyboardEvent, combo: string) => any, action?: string): void; bind(keyArray: string[], callback: (e: ExtendedKeyboardEvent, combo: string) => any, action?: string): void; From 210b10c34764ef703857be5546a3af2f7d5f2cab Mon Sep 17 00:00:00 2001 From: Derek Cicerone Date: Tue, 2 Jul 2013 19:43:47 -0400 Subject: [PATCH 034/756] Replace bool with boolean (for TypeScript 0.9.0+) --- hammerjs/hammerjs.d.ts | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/hammerjs/hammerjs.d.ts b/hammerjs/hammerjs.d.ts index f933058cee..38a77e5a51 100644 --- a/hammerjs/hammerjs.d.ts +++ b/hammerjs/hammerjs.d.ts @@ -7,24 +7,24 @@ /// interface HammerOptions { - prevent_default?: bool; - css_hacks?: bool; - swipe?: bool; + prevent_default?: boolean; + css_hacks?: boolean; + swipe?: boolean; swipe_time?: number; swipe_min_distance?: number; - drag?: bool; - drag_vertical?: bool; - drag_horizontal?: bool; + drag?: boolean; + drag_vertical?: boolean; + drag_horizontal?: boolean; drag_min_distance?: number; - transform?: bool; + transform?: boolean; scale_treshold?: number; rotation_treshold?: number; - tap?: bool; - tap_double?: bool; + tap?: boolean; + tap_double?: boolean; tap_max_interval?: number; tap_max_distance?: number; tap_double_distance?: number; - hold?: bool; + hold?: boolean; hold_timeout?: number; } @@ -70,4 +70,4 @@ declare class Hammer { interface JQuery { hammer(options?: HammerOptions): JQuery; -} \ No newline at end of file +} From 6fb97f40bf1bc28056321d98d3c3bc2d21cac0c8 Mon Sep 17 00:00:00 2001 From: Andrew Gaspar Date: Wed, 3 Jul 2013 00:24:15 -0700 Subject: [PATCH 035/756] Added types all over the place in Q --- q/Q-tests.ts | 19 +++++++-- q/Q.d.ts | 118 +++++++++++++++++++++++++++++++++++++-------------- 2 files changed, 103 insertions(+), 34 deletions(-) diff --git a/q/Q-tests.ts b/q/Q-tests.ts index 6bdc5ff088..af8aa7ef23 100644 --- a/q/Q-tests.ts +++ b/q/Q-tests.ts @@ -6,15 +6,18 @@ import q = module('q'); Q(8).then(x => console.log(x.toExponential())); var delay = function (delay: number) { - var d = Q.defer(); + var d = Q.defer(); setTimeout(d.resolve, delay); return d.promise; }; -Q.when(delay(1000), function () { +Q.when(delay(1000), function (val: void) { console.log('Hello, World!'); + return; }); +Q.timeout(Q(new Date()), 1000, "My dates never arrived. :(").then(d => d.toJSON()); + Q.delay(Q(8), 1000).then(x => x.toExponential()); Q.delay(8, 1000).then(x => x.toExponential()); Q.delay(Q("asdf"), 1000).then(x => x.length); @@ -73,4 +76,14 @@ Q(arrayPromise) // type specification required declare var jPromise: JQueryPromise; // if jQuery promises definition supported generics, this could be more interesting example -Q(jPromise).then((val) => val.toExponential()); \ No newline at end of file +Q(jPromise).then((val) => val.toExponential()); + +declare var promiseArray: Q.IPromise[]; +var qPromiseArray = promiseArray.map(p => Q(p)); +var myNums: any[] = [2, 3, Q(4), 5, Q(6), Q(7)]; + +Q.all(promiseArray).then(nums => nums.map(num => num.toPrecision(2)).join(',')); + +Q.all(myNums).then(nums => nums.map(Math.round)); + +Q.fbind((dateString) => new Date(dateString), "11/11/1991")().then(d => d.toLocaleDateString()); \ No newline at end of file diff --git a/q/Q.d.ts b/q/Q.d.ts index cadca16597..3665260308 100644 --- a/q/Q.d.ts +++ b/q/Q.d.ts @@ -16,71 +16,127 @@ declare module Q { interface Deferred { promise: Promise; - resolve(value: T): any; - reject(reason: any); - notify(value: any); + resolve(value: T): void; + reject(reason: any): void; + notify(value: any): void; makeNodeResolver(): (reason, value: T) => void; } interface Promise { - fail(errorCallback: Function): Promise; - fin(finallyCallback: Function): Promise; - finally(finallyCallback: Function): Promise; + fin(finallyCallback: () => any): Promise; + finally(finallyCallback: () => any): Promise; then(onFulfill: (value: T) => U, onReject?: (reason) => U, onProgress?: Function): Promise; then(onFulfill: (value: T) => IPromise, onReject?: (reason) => U, onProgress?: Function): Promise; then(onFulfill: (value: T) => U, onReject?: (reason) => IPromise, onProgress?: Function): Promise; then(onFulfill: (value: T) => IPromise, onReject?: (reason) => IPromise, onProgress?: Function): Promise; - spread(onFulfilled: Function, onRejected?: Function): Promise; - catch(onRejected: Function): Promise; - progress(onProgress: Function): Promise; - done(onFulfilled?: Function, onRejected?: Function, onProgress?: Function): void; - get(propertyName: String): Promise; - set(propertyName: String, value: any): Promise; - delete(propertyName: String): Promise; - post(methodName: String, args: any[]): Promise; - invoke(methodName: String, ...args: any[]): Promise; + spread(onFulfilled: Function, onRejected?: Function): Promise; + + fail(onRejected: (reason) => U): Promise; + fail(onRejected: (reason) => IPromise): Promise; + catch(onRejected: (reason) => U): Promise; + catch(onRejected: (reason) => IPromise): Promise; + + progress(onProgress: (progress) => any): Promise; + + done(onFulfilled?: (value: T) => any, onRejected?: (reason) => any, onProgress?: (progress) => any): void; + + get(propertyName: String): Promise; + set(propertyName: String, value: any): Promise; + delete(propertyName: String): Promise; + post(methodName: String, args: any[]): Promise; + invoke(methodName: String, ...args: any[]): Promise; + fapply(args: any[]): Promise; + fcall(...args: any[]): Promise; + keys(): Promise; - fapply(args: any[]): Promise; - fcall(method: Function, ...args: any[]): Promise; - timeout(ms: number, message?): Promise; + + timeout(ms: number, message?: string): Promise; delay(ms: number): Promise; + isFulfilled(): boolean; isRejected(): boolean; isPending(): boolean; + valueOf(): any; } - export function when(value: any, onFulfilled: Function, onRejected?: Function): Promise; + export function when(value: T): Promise; + export function when(value: IPromise): Promise; + export function when(value: T, onFulfilled: (val: T) => U): Promise; + export function when(value: T, onFulfilled: (val: T) => IPromise): Promise; + export function when(value: IPromise, onFulfilled: (val: T) => U, onRejected?: (reason) => U): Promise; + export function when(value: IPromise, onFulfilled: (val: T) => IPromise, onRejected?: (reason) => U): Promise; + export function when(value: IPromise, onFulfilled: (val: T) => U, onRejected?: (reason) => IPromise): Promise; + export function when(value: IPromise, onFulfilled: (val: T) => IPromise, onRejected?: (reason) => IPromise): Promise; + //export function try(method: Function, ...args: any[]): Promise; // <- This is broken currently - not sure how to fix. - export function fbind(method: Function, ...args: any[]): Promise; - export function fcall(method: Function, ...args: any[]): Promise; - export function nfbind(nodeFunction: Function): (...args: any[]) => Promise; - export function nfcall(nodeFunction: Function, ...args: any[]): Promise; - export function ninvoke(nodeModule: any, functionName: string, ...args: any[]): Promise; - export function all(promises: Promise[]): Promise; - export function allResolved(promises: Promise[]): Promise; - export function spread(onFulfilled: Function, onRejected: Function): Promise; - export function timeout(promise: Promise, ms: number, message?): Promise; + + export function fbind(method: (...args: any[]) => T, ...args: any[]): (...args: any[]) => Promise; + export function fbind(method: (...args: any[]) => IPromise, ...args: any[]): (...args: any[]) => Promise; + + export function fcall(method: (...args) => T, ...args: any[]): Promise; + + export function send(obj: any, functionName: string, ...args: any[]): Promise; + export function invoke(obj: any, functionName: string, ...args: any[]): Promise; + export function mcall(obj: any, functionName: string, ...args: any[]): Promise; + + export function nfbind(nodeFunction: Function, ...args: any[]): (...args: any[]) => Promise; + export function nfcall(nodeFunction: Function, ...args: any[]): Promise; + + export function ninvoke(nodeModule: any, functionName: string, ...args: any[]): Promise; + export function nsend(nodeModule: any, functionName: string, ...args: any[]): Promise; + export function nmcall(nodeModule: any, functionName: string, ...args: any[]): Promise; + + export function all(promises: any[]): Promise; + export function all(promises: IPromise[]): Promise; + + export function allSettled(promises: any[]): Promise[]>; + export function allSettled(promises: IPromise[]): Promise[]>; + + export function allResolved(promises: any[]): Promise[]>; + export function allResolved(promises: IPromise[]): Promise[]>; + + export function spread(promises: any[], onFulfilled: (...args: any[]) => U, onRejected: (reason) => U): Promise; + export function spread(promises: any[], onFulfilled: (...args: any[]) => IPromise, onRejected: (reason) => U): Promise; + export function spread(promises: any[], onFulfilled: (...args: any[]) => U, onRejected: (reason) => IPromise): Promise; + export function spread(promises: any[], onFulfilled: (...args: any[]) => IPromise, onRejected: (reason) => IPromise): Promise; + export function spread(promises: IPromise[], onFulfilled: (...args: T[]) => U, onRejected: (reason) => U): Promise; + export function spread(promises: IPromise[], onFulfilled: (...args: T[]) => IPromise, onRejected: (reason) => U): Promise; + export function spread(promises: IPromise[], onFulfilled: (...args: T[]) => U, onRejected: (reason) => IPromise): Promise; + export function spread(promises: IPromise[], onFulfilled: (...args: T[]) => IPromise, onRejected: (reason) => IPromise): Promise; + + export function timeout(promise: Promise, ms: number, message?: string): Promise; + export function delay(promise: Promise, ms: number): Promise; export function delay(value: T, ms: number): Promise; + export function isFulfilled(promise: Promise): boolean; export function isRejected(promise: Promise): boolean; export function isPending(promise: Promise): boolean; - export function valueOf(promise: Promise): T; + export function defer(): Deferred; + export function reject(reason?): Promise; - export function promise(factory: { resolve: Function; reject: Function; notify: Function; }): Promise; + + export function promise(resolver: (resolve: (val: T) => void , reject: (reason) => void , notify: (progress) => void ) => void ): Promise; + export function promise(resolver: (resolve: (val: IPromise) => void , reject: (reason) => void , notify: (progress) => void ) => void ): Promise; + export function promised(callback: (...any) => T): (...any) => Promise; + export function isPromise(object): boolean; export function isPromiseAlike(object): boolean; export function isPending(object): boolean; + export function async(generatorFunction: any): (...args) => Promise; export function nextTick(callback: Function): void; + export var oneerror: () => void; export var longStackSupport: boolean; - export function resolve(object): Promise; + + export function resolve(object: T): Promise; + export function resolve(object: IPromise): Promise; } declare module "q" { From bccbbdaa83c41ffd796d7759944e3260e334423a Mon Sep 17 00:00:00 2001 From: Andrew Gaspar Date: Wed, 3 Jul 2013 00:33:25 -0700 Subject: [PATCH 036/756] Added progress handlers to Q.when --- q/Q-tests.ts | 5 ++++- q/Q.d.ts | 12 ++++++++---- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/q/Q-tests.ts b/q/Q-tests.ts index af8aa7ef23..943f2bb4e2 100644 --- a/q/Q-tests.ts +++ b/q/Q-tests.ts @@ -86,4 +86,7 @@ Q.all(promiseArray).then(nums => nums.map(num => num.toPrecision(2)).join(',')); Q.all(myNums).then(nums => nums.map(Math.round)); -Q.fbind((dateString) => new Date(dateString), "11/11/1991")().then(d => d.toLocaleDateString()); \ No newline at end of file +Q.fbind((dateString) => new Date(dateString), "11/11/1991")().then(d => d.toLocaleDateString()); + +Q.when(8, num => num + "!"); +Q.when(Q(8), num => num + "!").then(str => str.split(',')); \ No newline at end of file diff --git a/q/Q.d.ts b/q/Q.d.ts index 3665260308..4dc20fb375 100644 --- a/q/Q.d.ts +++ b/q/Q.d.ts @@ -62,14 +62,18 @@ declare module Q { valueOf(): any; } + // if no fulfill, reject, or progress provided, returned promise will be of same type export function when(value: T): Promise; export function when(value: IPromise): Promise; + + // If a non-promise value is provided, it will not reject or progress export function when(value: T, onFulfilled: (val: T) => U): Promise; export function when(value: T, onFulfilled: (val: T) => IPromise): Promise; - export function when(value: IPromise, onFulfilled: (val: T) => U, onRejected?: (reason) => U): Promise; - export function when(value: IPromise, onFulfilled: (val: T) => IPromise, onRejected?: (reason) => U): Promise; - export function when(value: IPromise, onFulfilled: (val: T) => U, onRejected?: (reason) => IPromise): Promise; - export function when(value: IPromise, onFulfilled: (val: T) => IPromise, onRejected?: (reason) => IPromise): Promise; + + export function when(value: IPromise, onFulfilled: (val: T) => U, onRejected?: (reason) => U, onProgress?: (progress) => any): Promise; + export function when(value: IPromise, onFulfilled: (val: T) => IPromise, onRejected?: (reason) => U, onProgress?: (progress) => any): Promise; + export function when(value: IPromise, onFulfilled: (val: T) => U, onRejected?: (reason) => IPromise, onProgress?: (progress) => any): Promise; + export function when(value: IPromise, onFulfilled: (val: T) => IPromise, onRejected?: (reason) => IPromise, onProgress?: (progress) => any): Promise; //export function try(method: Function, ...args: any[]): Promise; // <- This is broken currently - not sure how to fix. From 85eabfe63b58f4b03e9afee11f4f778e5c9330cc Mon Sep 17 00:00:00 2001 From: Andrew Gaspar Date: Wed, 3 Jul 2013 01:36:17 -0700 Subject: [PATCH 037/756] Added typings to jQuery promises and deferreds. --- jquery/jquery-tests.ts | 3 +- jquery/jquery.d.ts | 67 +++++++++++++++++++++++++++++------------- q/Q-tests.ts | 2 +- 3 files changed, 48 insertions(+), 24 deletions(-) diff --git a/jquery/jquery-tests.ts b/jquery/jquery-tests.ts index fbee85509f..01f75a9855 100644 --- a/jquery/jquery-tests.ts +++ b/jquery/jquery-tests.ts @@ -940,8 +940,7 @@ function test_deferred() { filtered.done(function (data) { }); function asyncEvent() { - var newDeferred = new jQuery.Deferred(); - var dfd: JQueryDeferred; + var dfd: JQueryDeferred = $.Deferred(); setTimeout(function () { dfd.resolve("hurray"); }, Math.floor(400 + Math.random() * 2000)); diff --git a/jquery/jquery.d.ts b/jquery/jquery.d.ts index c66b283f81..5254e98b12 100644 --- a/jquery/jquery.d.ts +++ b/jquery/jquery.d.ts @@ -57,7 +57,7 @@ interface JQueryAjaxSettings { /* Interface for the jqXHR object */ -interface JQueryXHR extends XMLHttpRequest, JQueryPromise { +interface JQueryXHR extends XMLHttpRequest, JQueryPromise { overrideMimeType(mimeType: string); abort(statusText?: string): void; } @@ -78,33 +78,61 @@ interface JQueryCallback { remove(...callbacks: any[]): any; } +/* + Allows jQuery Promises to interop with non-jQuery promises +*/ +interface JQueryGenericPromise { + then(onFulfill: (value: T) => U, onReject?: (reason) => U): JQueryGenericPromise; + then(onFulfill: (value: T) => JQueryGenericPromise, onReject?: (reason) => U): JQueryGenericPromise; + then(onFulfill: (value: T) => U, onReject?: (reason) => JQueryGenericPromise): JQueryGenericPromise; + then(onFulfill: (value: T) => JQueryGenericPromise, onReject?: (reason) => JQueryGenericPromise): JQueryGenericPromise; +} + /* Interface for the JQuery promise, part of callbacks */ -interface JQueryPromise { - always(...alwaysCallbacks: any[]): JQueryDeferred; - done(...doneCallbacks: any[]): JQueryDeferred; - fail(...failCallbacks: any[]): JQueryDeferred; +interface JQueryPromise { + always(...alwaysCallbacks: any[]): JQueryPromise; + done(...doneCallbacks: any[]): JQueryPromise; + fail(...failCallbacks: any[]): JQueryPromise; + progress(...progressCallbacks: any[]): JQueryPromise; + + // Deprecated - given no typings pipe(doneFilter?: (x: any) => any, failFilter?: (x: any) => any, progressFilter?: (x: any) => any): JQueryPromise; - then(doneCallbacks: any, failCallbacks?: any, progressCallbacks?: any): JQueryDeferred; + + then(onFulfill: (value: T) => U, onReject?: (...reasons) => U, onProgress?: (...progression) => any): JQueryPromise; + then(onFulfill: (value: T) => JQueryGenericPromise, onReject?: (...reasons) => U, onProgress?: (...progression) => any): JQueryPromise; + then(onFulfill: (value: T) => U, onReject?: (...reasons) => JQueryGenericPromise, onProgress?: (...progression) => any): JQueryPromise; + then(onFulfill: (value: T) => JQueryGenericPromise, onReject?: (...reasons) => JQueryGenericPromise, onProgress?: (...progression) => any): JQueryPromise; + + /* Because JQuery Promises Suck */ + then(onFulfill: (...args) => U, onReject?: (...reasons) => U, onProgress?: (...progression) => any): JQueryPromise; + then(onFulfill: (...args) => JQueryGenericPromise, onReject?: (...reasons) => U, onProgress?: (...progression) => any): JQueryPromise; + then(onFulfill: (...args) => U, onReject?: (...reasons) => JQueryGenericPromise, onProgress?: (...progression) => any): JQueryPromise; + then(onFulfill: (...args) => JQueryGenericPromise, onReject?: (...reasons) => JQueryGenericPromise, onProgress?: (...progression) => any): JQueryPromise; } /* Interface for the JQuery deferred, part of callbacks */ -interface JQueryDeferred extends JQueryPromise { - notify(...args: any[]): JQueryDeferred; - notifyWith(context: any, ...args: any[]): JQueryDeferred; +interface JQueryDeferred extends JQueryPromise { + always(...alwaysCallbacks: any[]): JQueryDeferred; + done(...doneCallbacks: any[]): JQueryDeferred; + fail(...failCallbacks: any[]): JQueryDeferred; + progress(...progressCallbacks: any[]): JQueryDeferred; - pipe(doneFilter?: any, failFilter?: any, progressFilter?: any): JQueryPromise; - progress(...progressCallbacks: any[]): JQueryDeferred; - reject(...args: any[]): JQueryDeferred; - rejectWith(context: any, ...args: any[]): JQueryDeferred; - resolve(...args: any[]): JQueryDeferred; - resolveWith(context: any, ...args: any[]): JQueryDeferred; + notify(...args: any[]): JQueryDeferred; + notifyWith(context: any, ...args: any[]): JQueryDeferred; + + reject(...args: any[]): JQueryDeferred; + rejectWith(context: any, ...args: any[]): JQueryDeferred; + + resolve(val: T): JQueryDeferred; + resolve(...args: any[]): JQueryDeferred; + resolveWith(context: any, ...args: any[]): JQueryDeferred; state(): string; - then(doneCallbacks: any, failCallbacks?: any, progressCallbacks?: any): JQueryDeferred; - promise(target?: any): JQueryPromise; + + promise(target?: any): JQueryPromise; } /* @@ -260,10 +288,7 @@ interface JQueryStatic { removeData(element: Element, name?: string): JQuery; // Deferred - Deferred: { - (beforeStart?: (deferred: JQueryDeferred) => any): JQueryDeferred; - new (beforeStart?: (deferred: JQueryDeferred) => any): JQueryDeferred; - }; + Deferred(beforeStart?: (deferred: JQueryDeferred) => any): JQueryDeferred; // Effects fx: { tick: () => void; interval: number; stop: () => void; speeds: { slow: number; fast: number; }; off: boolean; step: any; }; diff --git a/q/Q-tests.ts b/q/Q-tests.ts index 943f2bb4e2..d647fabde8 100644 --- a/q/Q-tests.ts +++ b/q/Q-tests.ts @@ -73,7 +73,7 @@ Q(arrayPromise) // type specification required .then(returnsNumPromise) // requires specification .then(num => num.toFixed()); -declare var jPromise: JQueryPromise; +declare var jPromise: JQueryPromise; // if jQuery promises definition supported generics, this could be more interesting example Q(jPromise).then((val) => val.toExponential()); From f83fb6805bc1630792f7503f3ec4b56565e7049d Mon Sep 17 00:00:00 2001 From: Carl de Billy Date: Fri, 5 Jul 2013 01:03:30 -0400 Subject: [PATCH 038/756] Support for more RxJS packages + bool => boolean for TS0.9 --- rx.js/rx.js.aggregates.d.ts | 48 +++++++++++++++++++---- rx.js/rx.js.binding.d.ts | 42 ++++++++++++++++++++ rx.js/rx.js.coincidence.d.ts | 40 +++++++++++++++++++ rx.js/rx.js.d.ts | 15 ++----- rx.js/rx.js.html.d.ts | 8 ---- rx.js/rx.js.joinpatterns.d.ts | 20 ++++++++++ rx.js/rx.js.jquery.d.ts | 21 +++++++--- rx.js/rx.js.time.d.ts | 73 +++++++++++++++++++++++++++++++++++ 8 files changed, 234 insertions(+), 33 deletions(-) create mode 100644 rx.js/rx.js.binding.d.ts create mode 100644 rx.js/rx.js.coincidence.d.ts delete mode 100644 rx.js/rx.js.html.d.ts create mode 100644 rx.js/rx.js.joinpatterns.d.ts diff --git a/rx.js/rx.js.aggregates.d.ts b/rx.js/rx.js.aggregates.d.ts index 16426a96e4..93a304db4f 100644 --- a/rx.js/rx.js.aggregates.d.ts +++ b/rx.js/rx.js.aggregates.d.ts @@ -1,19 +1,53 @@ /// -// Type definitions for RxJS "Aggregates" +// Type definitions for RxJS-Aggregates package // Project: http://rx.codeplex.com/ // Definitions by: Carl de Billy // Definitions: https://github.com/borisyankov/DefinitelyTyped +// +// Dependencies: +// -> rx.js +// -> rx.aggregates.js declare module Rx { interface IObservable { - all(predicate?: (value: T) => bool): IObservable; - min(comparer?: (value1: T, value2: T) => number): IObservable; - max(comparer?: (value1: T, value2: T) => number): IObservable; - count(predicate?: (item: T) => bool): IObservable; + aggregate(accumulator: (acc: TAcc, value: T) => TAcc): IObservable; + aggregate(seed: TAcc, accumulator: (acc: TAcc, value: T) => TAcc): IObservable; + + any(): IObservable; + any(selector: (item: T) => boolean): IObservable; + + isEmpty(predicate?: (value: T) => boolean): IObservable; + all(predicate?: (value: T) => boolean): IObservable; + contains(value: T, comparer?: (value1: T, value2: T) => boolean): IObservable; + count(predicate?: (item: T) => boolean): IObservable; sum(keySelector?: (item: T) => number): IObservable; - isEmpty(predicate?: (value: T) => bool): IObservable; - contains(value: T, comparer?: (value1: T, value2: T) => bool): IObservable; + minBy(keySelector: (item: T) => number, comparer?: (value1: T, value2: T) => number): IObservable; + min(comparer?: (value1: T, value2: T) => number): IObservable; + maxBy(keySelector: (item: T) => number, comparer?: (value1: T, value2: T) => number): IObservable; + max(comparer?: (value1: T, value2: T) => number): IObservable; average(keySelector?: (item: T) => number): IObservable; + + sequenceEqual(second: IObservable, comparer?: (value1: T, value2: T) => number): IObservable; + elementAt(index: number): IObservable; + elementAtOrDefault(index: number, defaultValue: T): IObservable; + + single(): IObservable; + single(predicate: (T) => boolean): IObservable; + singleOrDefault(): IObservable; + singleOrDefault(predicate: (T) => boolean): IObservable; + singleOrDefault(predicate: (T) => boolean, defaultValue: T): IObservable; + + first(): IObservable; + first(predicate: (T) => boolean): IObservable; + firstOrDefault(): IObservable; + firstOrDefault(predicate: (T) => boolean): IObservable; + firstOrDefault(predicate: (T) => boolean, defaultValue: T): IObservable; + + last(): IObservable; + last(predicate: (T) => boolean): IObservable; + lastOrDefault(): IObservable; + lastOrDefault(predicate: (T) => boolean): IObservable; + lastOrDefault(predicate: (T) => boolean, defaultValue: T): IObservable; } } \ No newline at end of file diff --git a/rx.js/rx.js.binding.d.ts b/rx.js/rx.js.binding.d.ts new file mode 100644 index 0000000000..e2d4bfd981 --- /dev/null +++ b/rx.js/rx.js.binding.d.ts @@ -0,0 +1,42 @@ +/// + +// Type definitions for RxJS-Binding package +// Project: http://rx.codeplex.com/ +// Definitions by: Carl de Billy +// Definitions: https://github.com/borisyankov/DefinitelyTyped +// +// Dependencies: +// -> rx.js +// -> rx.binding.js + +declare module Rx { + + interface ReplaySubject extends ISubject { + new (bufferSize?: number, window?: number, scheduler?: IScheduler): ReplaySubject; + } + + interface BehaviorSubject extends ISubject { + new (initialValue: T): BehaviorSubject; + } + + interface ConnectableObservable extends IObservable{ + connect(): _IDisposable; + refCount(): IObservable; + } + + interface IObservable { + + publish(): ConnectableObservable; + publish(selector: (item: T) => IObservable): ConnectableObservable; + publishLast(): ConnectableObservable; + publishLast(selector: (item: T) => IObservable): ConnectableObservable; + publishValue(initialValue: T): ConnectableObservable; + publishValue(selector: (item: T) => TResult, initialValue: TResult): ConnectableObservable; + + replay(selector?: (source: IObservable) => ReplaySubject, bufferSize?: number, window?: number, scheduler?: IScheduler): ReplaySubject; + } + + + interface Observable { + } +} diff --git a/rx.js/rx.js.coincidence.d.ts b/rx.js/rx.js.coincidence.d.ts new file mode 100644 index 0000000000..138e992368 --- /dev/null +++ b/rx.js/rx.js.coincidence.d.ts @@ -0,0 +1,40 @@ +/// + +// Type definitions for RxJS-Coincidence package +// Project: http://rx.codeplex.com/ +// Definitions by: Carl de Billy +// Definitions: https://github.com/borisyankov/DefinitelyTyped +// +// Dependencies: +// -> rx.js +// -> rx.coincidence.js + +declare module Rx { + + interface IObservable { + join( + right: IObservable, + leftDurationSelector: (leftItem: T) => IObservable, + rightDurationSelector: (rightItem: T2) => IObservable, + resultSelector: (leftItem: T, rightItem: T2) => TResult): IObservable; + + groupJoin( + right: IObservable, + leftDurationSelector: (leftItem: T) => IObservable, + rightDurationSelector: (rightItem: T2) => IObservable, + resultSelector: (leftItem: T, rightItem: IObservable) => TResult): IObservable; + + + // lack of documentation to complete the followings... + + buffer(bufferOpenings: IObservable, + bufferClosingSelector: (opening: TBufferOpening) => IObservable): IObservable; + + window(bufferOpenings: IObservable, + bufferClosingSelector: (opening: TBufferOpening) => IObservable): IObservable; + } + + + interface Observable { + } +} diff --git a/rx.js/rx.js.d.ts b/rx.js/rx.js.d.ts index 1cce070dcb..7426944316 100644 --- a/rx.js/rx.js.d.ts +++ b/rx.js/rx.js.d.ts @@ -314,6 +314,7 @@ declare module Rx { observeOn(scheduler: IScheduler): IObservable; subscribeOn(scheduler: IScheduler): IObservable; + amb(rightSource: IObservable): IObservable; catchException(handler: (exception: any) =>IObservable): IObservable; catchException(second: IObservable): IObservable; @@ -369,16 +370,6 @@ declare module Rx { take(count: number, scheduler?: IScheduler): IObservable; takeWhile(predicate: (value: T, index?: number) =>bool): IObservable; where(predicate: (value: T, index?: number) => bool): IObservable; - - // time - delay(dueTime: number, scheduler?: IScheduler): IObservable; - throttle(dueTime: number, scheduler?: IScheduler): IObservable; - windowWithTime(dueTime: number, timeShiftOrScheduler?: any, scheduler?: IScheduler): IObservable; - timeInterval(scheduler: IScheduler): IObservable; - sample(interval: number, scheduler?: IScheduler): IObservable; - sample(sampler: IObservable, scheduler?: IScheduler): IObservable; - timeout(dueTime: number, other?: IObservable, scheduler?: IScheduler): IObservable; - delaySubscription(dueTime: number, scheduler?: IScheduler): IObservable; } interface Observable { @@ -387,9 +378,9 @@ declare module Rx { start(func: () =>T, scheduler?: IScheduler, context?: any): IObservable; toAsync(func: Function, scheduler?: IScheduler, context?: any): (...arguments: any[]) => IObservable; create(subscribe: (observer: IObserver) => void ): IObservable; - create(subscribe: (observer: IObserver) => () => void ): IObservable; + //create(subscribe: (observer: IObserver) => () => void ): IObservable; createWithDisposable(subscribe: (observer: IObserver) =>_IDisposable): IObservable; - defer(observableFactory: () =>IObservable): IObservable; + defer(observableFactory: () => IObservable): IObservable; empty(scheduler?: IScheduler): IObservable; fromArray(array: T[], scheduler?: IScheduler): IObservable; fromArray(array: { length: number;[index: number]: T; }, scheduler?: IScheduler): IObservable; diff --git a/rx.js/rx.js.html.d.ts b/rx.js/rx.js.html.d.ts deleted file mode 100644 index e1dcf69dd5..0000000000 --- a/rx.js/rx.js.html.d.ts +++ /dev/null @@ -1,8 +0,0 @@ -/// - -declare module Rx { - interface Observable { - fromEvent(element: HTMLElement, eventName: string): IObservable; - fromEvent(document: HTMLDocument, eventName: string): IObservable; - } -} \ No newline at end of file diff --git a/rx.js/rx.js.joinpatterns.d.ts b/rx.js/rx.js.joinpatterns.d.ts new file mode 100644 index 0000000000..a62b1914de --- /dev/null +++ b/rx.js/rx.js.joinpatterns.d.ts @@ -0,0 +1,20 @@ +/// + +// Type definitions for RxJS-Join package +// Project: http://rx.codeplex.com/ +// Definitions by: Carl de Billy +// Definitions: https://github.com/borisyankov/DefinitelyTyped +// +// Dependencies: +// -> rx.js +// -> rx.joinpatterns.js + +declare module Rx { + + //interface IObservable { + //} + + + //interface Observable { + //} +} diff --git a/rx.js/rx.js.jquery.d.ts b/rx.js/rx.js.jquery.d.ts index 361040390b..2a0b29b270 100644 --- a/rx.js/rx.js.jquery.d.ts +++ b/rx.js/rx.js.jquery.d.ts @@ -1,6 +1,15 @@ /// /// +// Those are the definitions for bridging Rx with jQuery. +// +// Using the https://github.com/Reactive-Extensions/rxjs-jquery project +// +// Dependencies: +// -> rx.js +// -> rx.jquery.js +// -> jquery.js + declare module JQueryResults { export interface eventBase{ @@ -8,9 +17,9 @@ declare module JQueryResults { cancelable: bool; type: string; preventDefault(): void; - isDefaultPrevented(): bool; + isDefaultPrevented(): boolean; stopPropagation(): void; - isPropagationStopped(): bool; + isPropagationStopped(): boolean; data: any; originalEvent: any; eventPhase: number; @@ -19,11 +28,11 @@ declare module JQueryResults { export interface keyEvent extends eventBase { key: number; keyCode: number; - altKey: bool; - ctrlKey: bool; - shiftKey: bool; + altKey: boolean; + ctrlKey: boolean; + shiftKey: boolean; char: string; - metaKey: bool; + metaKey: boolean; } export interface uiEvent extends eventBase{ diff --git a/rx.js/rx.js.time.d.ts b/rx.js/rx.js.time.d.ts index fc12992558..698cc300c2 100644 --- a/rx.js/rx.js.time.d.ts +++ b/rx.js/rx.js.time.d.ts @@ -1,13 +1,86 @@ /// +// Type definitions for RxJS "Aggregates" +// Project: http://rx.codeplex.com/ +// Definitions by: Carl de Billy +// Definitions: https://github.com/borisyankov/DefinitelyTyped +// +// Dependencies: +// -> rx.js +// -> rx.time.js + declare module Rx { + + interface ITimeInterval { + value: any; + interval: number; + } + + interface ITimestamp { + value: any; + interval: number; + } + interface IObservable { ifThen(condition: () => bool, thenSource: IObservable): IObservable; ifThen(condition: () => bool, thenSource: IObservable, elseSource: IObservable): IObservable; ifThen(condition: () => bool, thenSource: IObservable, scheduler: IScheduler): IObservable; + + delay(dueTime: number, scheduler?: IScheduler): IObservable; + throttle(dueTime: number, scheduler?: IScheduler): IObservable; + windowWithTime(timeSpan: number, timeShift: number, scheduler?: IScheduler): IObservable; + windowWithTime(timeSpan: number, scheduler?: IScheduler): IObservable; + windowWithTimeOrCount(timeSpan: number, count: number, scheduler?: IScheduler): IObservable; + bufferWithTime(timeSpan: number, timeShift: number, scheduler?: IScheduler): IObservable; + bufferWithTime(timeSpan: number, scheduler?: IScheduler): IObservable; + bufferWithTimeOrCount(timeSpan: number, count: number, scheduler?: IScheduler): IObservable; + timeInterval(scheduler?: IScheduler): IObservable; + timestamp(scheduler?: IScheduler): IObservable; + sample(interval: number, scheduler?: IScheduler): IObservable; + sample(sampler: IObservable, scheduler?: IScheduler): IObservable; + timeout(dueTime: Date, other?: IObservable, scheduler?: IScheduler): IObservable; + timeout(dueTime: number, other?: IObservable, scheduler?: IScheduler): IObservable; + + delaySubscription(dueTime: number, scheduler?: IScheduler): IObservable; + delayWithSelector(delayDurationSelector: (T) => number): IObservable; + delayWithSelector(subscriptionDelay: number, delayDurationSelector: (T) => number): IObservable; + + timeoutWithSelector(firstTimeout: IObservable, timeoutdurationSelector?: (T) => IObservable, other?: IObservable): IObservable; + throttleWithSelector(throttleDurationSelector: (T) => IObservable): IObservable; + + skipLastWithTime(duration: number, scheduler?: IScheduler): IObservable; + takeLastWithTime(duration: number, timerScheduler?: IScheduler, loopScheduler?: IScheduler): IObservable; + + takeLastBufferWithTime(duration: number, scheduler?: IScheduler): IObservable; + takeWithTime(duration: number, scheduler?: IScheduler): IObservable; + skipWithTime(duration: number, scheduler?: IScheduler): IObservable; + + skipUntilWithTime(startTime: Date, scheduler?: IScheduler): IObservable; + takeUntilWithTime(endTime: Date, scheduler?: IScheduler): IObservable; } + interface Observable { interval(period: number, scheduler?: IScheduler): IObservable; interval(dutTime: number, period: number, scheduler?: IScheduler): IObservable; + timer(dueTime: Date, period: number, scheduler: IScheduler): IObservable; + timer(dueTime: Date, scheduler: IScheduler): IObservable; + timer(dueTime: number, period: number, scheduler: IScheduler): IObservable; + timer(dueTime: number, scheduler: IScheduler): IObservable; + + generateWithAbsoluteTime( + initialState: TState, + condition: (TState) => boolean, + iterate: (TState) => TState, + resultSelector: (TState) => TResult, + timeSelector: (TState) => Date, + scheduler?: IScheduler): IObservable; + + generateWithRelativeTime( + initialState: TState, + condition: (TState) => boolean, + iterate: (TState) => TState, + resultSelector: (TState) => TResult, + timeSelector: (TState) => number, + scheduler?: IScheduler): IObservable; } } \ No newline at end of file From 284f4a629ae74f643ce4e72d705a89b8ee5141c7 Mon Sep 17 00:00:00 2001 From: Andrew Gaspar Date: Fri, 5 Jul 2013 01:06:47 -0700 Subject: [PATCH 039/756] Minor fixes for issue #726 --- jquery/jquery.d.ts | 2 +- q/Q-tests.ts | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/jquery/jquery.d.ts b/jquery/jquery.d.ts index 5254e98b12..c2f9f47ddb 100644 --- a/jquery/jquery.d.ts +++ b/jquery/jquery.d.ts @@ -98,7 +98,7 @@ interface JQueryPromise { progress(...progressCallbacks: any[]): JQueryPromise; // Deprecated - given no typings - pipe(doneFilter?: (x: any) => any, failFilter?: (x: any) => any, progressFilter?: (x: any) => any): JQueryPromise; + pipe(doneFilter?: (x: any) => any, failFilter?: (x: any) => any, progressFilter?: (x: any) => any): JQueryPromise; then(onFulfill: (value: T) => U, onReject?: (...reasons) => U, onProgress?: (...progression) => any): JQueryPromise; then(onFulfill: (value: T) => JQueryGenericPromise, onReject?: (...reasons) => U, onProgress?: (...progression) => any): JQueryPromise; diff --git a/q/Q-tests.ts b/q/Q-tests.ts index d647fabde8..504655c991 100644 --- a/q/Q-tests.ts +++ b/q/Q-tests.ts @@ -76,7 +76,8 @@ Q(arrayPromise) // type specification required declare var jPromise: JQueryPromise; // if jQuery promises definition supported generics, this could be more interesting example -Q(jPromise).then((val) => val.toExponential()); +Q(jPromise).then(str => str.split(',')); +jPromise.then(returnsNumPromise); declare var promiseArray: Q.IPromise[]; var qPromiseArray = promiseArray.map(p => Q(p)); From e4693b884b4edd3756475409742e34c6ec88d977 Mon Sep 17 00:00:00 2001 From: Tomas Carnecky Date: Fri, 5 Jul 2013 13:52:23 +0200 Subject: [PATCH 040/756] Change IDirective.transclude to be of `any` type It can actually be bool or string, but TypeScript doesn't allow union types (see http://typescript.codeplex.com/workitem/120). --- angularjs/angular.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 8e5e2a007f..4320bebb8b 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -644,7 +644,7 @@ declare module ng { template?: string; templateUrl?: string; replace?: bool; - transclude?: bool; + transclude?: any; restrict?: string; scope?: any; link?: Function; From ec405640601f44b6ccff802c80a900fc3df205ef Mon Sep 17 00:00:00 2001 From: Steve Fenton Date: Fri, 5 Jul 2013 13:59:47 +0100 Subject: [PATCH 041/756] Create basic version of jQuery UI Layout definition. --- jquery.ui.layout/jquery.ui.layout.d.ts | 40 ++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 jquery.ui.layout/jquery.ui.layout.d.ts diff --git a/jquery.ui.layout/jquery.ui.layout.d.ts b/jquery.ui.layout/jquery.ui.layout.d.ts new file mode 100644 index 0000000000..80e71327c2 --- /dev/null +++ b/jquery.ui.layout/jquery.ui.layout.d.ts @@ -0,0 +1,40 @@ +// Type definitions for jQueryUI 1.9 +// Project: http://layout.jquery-dev.net/ +// Definitions by: Steve Fenton +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +/// +/// + +interface JQueryLayoutOptions { + north: any; + east: any; + south: any; + west: any; +} + +interface JQueryLayout { + panes: any; + options: JQueryLayoutOptions; + state: any; + + toggle(pane: any): any; + open(pane: any): any; + close(pane: any): any; + show(pane: any, openPane?: bool): any; + hide(pane: any): any; + sizePane(pane: any, sizeInPixels: number): any; + resizeContent(pane: any): any; + resizeAll(): any; + + addToggleBtn(selector: string, pane: any) + addCloseBtn(selector: string, pane: any) + addOpenBtn(selector: string, pane: any) + addPinBtn(selector: string, pane: any) + allowOverflow(elemOrPane: any) + resetOverflow(elemOrPane: any) +} + +interface JQuery { + layout(options?: JQueryLayoutOptions): JQueryLayout; +} From 4fd627247d88bc4ca0baba56dc747b1394674882 Mon Sep 17 00:00:00 2001 From: oising Date: Fri, 5 Jul 2013 11:46:37 -0400 Subject: [PATCH 042/756] updated sammyjs definitions for typescript 0.9.x --- sammyjs/sammyjs.d.ts | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/sammyjs/sammyjs.d.ts b/sammyjs/sammyjs.d.ts index f8b5ae1473..84b0aef8a6 100644 --- a/sammyjs/sammyjs.d.ts +++ b/sammyjs/sammyjs.d.ts @@ -1,16 +1,28 @@ // Type definitions for Sammy.js // Project: http://sammyjs.org/ // Definitions by: Boris Yankov +// - Updated for TypeScript 0.9.x by: Oisin Grehan // Definitions: https://github.com/borisyankov/DefinitelyTyped - /// -module Sammy { - export function (): Sammy.Application; - export function (selector: string): Sammy.Application; - export function (handler: Function): Sammy.Application; - export function (selector: string, handler: Function): Sammy.Application; +interface SammyFunc { + (): Sammy.Application; + (selector: string): Sammy.Application; + (handler: Function): Sammy.Application; + (selector: string, handler: Function): Sammy.Application; +} + +declare function Sammy(): Sammy.Application; +declare function Sammy(selector: string): Sammy.Application; +declare function Sammy(handler: Function): Sammy.Application; +declare function Sammy(selector: string, handler: Function): Sammy.Application; + +interface JQueryStatic { + sammy: SammyFunc; +} + +declare module Sammy { export function Cache(app, options); export function DataCacheProxy(initial, $element); @@ -201,8 +213,7 @@ module Sammy { trigger(name, data); wait(): void; } - - + export interface StoreOptions { name?: string; element?: string; @@ -241,7 +252,4 @@ module Sammy { isAvailable(type); Template(app, method_alias); } -} -interface JQueryStatic { - sammy: Sammy; } \ No newline at end of file From 89b039b2b76871a16a02522f96ecdb24c8e227d0 Mon Sep 17 00:00:00 2001 From: Richard Hepburn Date: Fri, 5 Jul 2013 13:01:31 -0400 Subject: [PATCH 043/756] Changed bool -> boolean to align with TypeScript 0.9 Updated bool type declarations to boolean to align with the ES6 standard now supported in TS 0.9. --- bootstrap/bootstrap.d.ts | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/bootstrap/bootstrap.d.ts b/bootstrap/bootstrap.d.ts index c06c08f89e..47ef378fd9 100644 --- a/bootstrap/bootstrap.d.ts +++ b/bootstrap/bootstrap.d.ts @@ -7,16 +7,16 @@ /// interface ModalOptions { - backdrop?: bool; - keyboard?: bool; - show?: bool; + backdrop?: boolean; + keyboard?: boolean; + show?: boolean; remote?: string; } interface ModalOptionsBackdropString { backdrop?: string; // for "static" - keyboard?: bool; - show?: bool; + keyboard?: boolean; + show?: boolean; remote?: string; } @@ -25,8 +25,8 @@ interface ScrollSpyOptions { } interface TooltipOptions { - animation?: bool; - html?: bool; + animation?: boolean; + html?: boolean; placement?: any; selector?: string; title?: any; @@ -35,8 +35,8 @@ interface TooltipOptions { } interface PopoverOptions { - animation?: bool; - html?: bool; + animation?: boolean; + html?: boolean; placement?: any; selector?: string; trigger?: string; @@ -47,7 +47,7 @@ interface PopoverOptions { interface CollapseOptions { parent?: any; - toggle?: bool; + toggle?: boolean; } interface CarouselOptions { From e98875bf101f337a5e64187d573f701cc9ee122e Mon Sep 17 00:00:00 2001 From: Richard Hepburn Date: Fri, 5 Jul 2013 13:01:50 -0400 Subject: [PATCH 044/756] Changed bool -> boolean to align with TypeScript 0.9 Updated bool type declarations to boolean to align with the ES6 standard now supported in TS 0.9. --- i18next/i18next.d.ts | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/i18next/i18next.d.ts b/i18next/i18next.d.ts index a1b8436404..f9ea5fb423 100644 --- a/i18next/i18next.d.ts +++ b/i18next/i18next.d.ts @@ -20,28 +20,28 @@ interface I18nextOptions { lng?: string; // Default value: undefined load?: string; // Default value: 'all' preload?: string[]; // Default value: [] - lowerCaseLng?: bool; // Default value: false - returnObjectTrees?: bool; // Default value: false + lowerCaseLng?: boolean; // Default value: false + returnObjectTrees?: boolean; // Default value: false fallbackLng?: string; // Default value: 'dev' detectLngQS?: string; // Default value: 'setLng' ns?: any; // Default value: 'translation' (string), can also be an object nsseparator?: string; // Default value: '::' keyseparator?: string; // Default value: '.' selectorAttr?: string; // Default value: 'data-i18n' - debug?: bool; // Default value: false + debug?: boolean; // Default value: false resGetPath?: string; // Default value: 'locales/__lng__/__ns__.json' resPostPath?: string; // Default value: 'locales/add/__lng__/__ns__' - getAsync?: bool; // Default value: true - postAsync?: bool; // Default value: true + getAsync?: boolean; // Default value: true + postAsync?: boolean; // Default value: true resStore?: IResourceStore; // Default value: undefined - useLocalStorage?: bool; // Default value: false + useLocalStorage?: boolean; // Default value: false localStorageExpirationTime?: number; // Default value: 7 * 24 * 60 * 60 * 1000 (in ms default one week) - dynamicLoad?: bool; // Default value: false - sendMissing?: bool; // Default value: false + dynamicLoad?: boolean; // Default value: false + sendMissing?: boolean; // Default value: false sendMissingTo?: string; // Default value: 'fallback'. Other options are: current | all sendType?: string; // Default value: 'POST' @@ -53,11 +53,11 @@ interface I18nextOptions { pluralNotFound?: string; // Default value: ['plural_not_found' Math.random()].join( '' ) contextNotFound?: string; // Default value: ['context_not_found' Math.random()].join( '' ) - setJqueryExt?: bool; // Default value: true - defaultValueFromContent?: bool; // Default value: true - useDataAttrOptions?: bool; // Default value: false + setJqueryExt?: boolean; // Default value: true + defaultValueFromContent?: boolean; // Default value: true + useDataAttrOptions?: boolean; // Default value: false cookieExpirationTime?: number; // Default value: undefined - useCookie?: bool; // Default value: true + useCookie?: boolean; // Default value: true cookieName?: string; // Default value: 'i18next' postProcess?: string; // Default value: undefined @@ -69,7 +69,7 @@ interface I18nextStatic { detectLanguage(): string; functions: { extend(target: any, ...objs: any[]): Object; - extend(deep: bool, target: any, ...objs: any[]): Object; + extend(deep: boolean, target: any, ...objs: any[]): Object; each(collection: any, callback: (indexInArray: any, valueOfElement: any) => any): any; ajax(settings: JQueryAjaxSettings): JQueryXHR; ajax(url: string, settings?: JQueryAjaxSettings): JQueryXHR; From 8dd5bcc633e0706bdd04448c50abb1c5fcaadc41 Mon Sep 17 00:00:00 2001 From: Richard Hepburn Date: Fri, 5 Jul 2013 13:02:27 -0400 Subject: [PATCH 045/756] Changed bool -> boolean to align with TypeScript 0.9 Updated bool type declarations to boolean to align with the ES6 standard now supported in TS 0.9. --- numeraljs/numeraljs.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/numeraljs/numeraljs.d.ts b/numeraljs/numeraljs.d.ts index 25e540677b..e680806d12 100644 --- a/numeraljs/numeraljs.d.ts +++ b/numeraljs/numeraljs.d.ts @@ -23,7 +23,7 @@ interface NumeralJSLanguage { interface Numeral { (value?: any): Numeral; version: string; - isNumeral: bool; + isNumeral: boolean; language(key: string, values?: NumeralJSLanguage): Numeral; zeroFormat(format: string): string; clone(): Numeral; From 47a6bcdfb0fcf5b9c89c774286aa25959189c0e9 Mon Sep 17 00:00:00 2001 From: Richard Hepburn Date: Fri, 5 Jul 2013 13:02:40 -0400 Subject: [PATCH 046/756] Changed bool -> boolean to align with TypeScript 0.9 Updated bool type declarations to boolean to align with the ES6 standard now supported in TS 0.9. --- toastr/toastr.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/toastr/toastr.d.ts b/toastr/toastr.d.ts index e22e8cbfc6..db36ee4772 100644 --- a/toastr/toastr.d.ts +++ b/toastr/toastr.d.ts @@ -10,7 +10,7 @@ interface ToastrOptions { /** * Should clicking on toast dismiss it? */ - tapToDismiss?: bool; + tapToDismiss?: boolean; /** * CSS class the toast element will be given */ @@ -22,7 +22,7 @@ interface ToastrOptions { /** * Should debug details be outputted to the console */ - debug?: bool; + debug?: boolean; /** * Time in milliseconds the toast should take to fade in */ @@ -88,7 +88,7 @@ interface ToastrOptions { /** * Set newest toast to appear on top **/ - newestOnTop?: bool; + newestOnTop?: boolean; /** * Function to execute on toast click From 184bda7faf5b6f4d897f5b7cda7d484b2997e747 Mon Sep 17 00:00:00 2001 From: NN Date: Fri, 5 Jul 2013 22:05:25 +0300 Subject: [PATCH 047/756] Update according to TS 0.9 'export = internal' is illegal. --- node/node.d.ts | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/node/node.d.ts b/node/node.d.ts index c1a5528692..96fa847e10 100644 --- a/node/node.d.ts +++ b/node/node.d.ts @@ -1019,8 +1019,8 @@ declare module "util" { } declare module "assert" { - function internal (booleanValue: boolean, message?: string): void; - module internal { + export function internal (booleanValue: boolean, message?: string): void; + export module internal { export function fail(actual: any, expected: any, message: string, operator: string): void; export function assert(value: any, message: string): void; export function ok(value: any, message?: string): void; @@ -1034,8 +1034,6 @@ declare module "assert" { export function doesNotThrow(block: any, error?: any, messsage?: string): void; export function ifError(value: any): void; } - - export = internal; } declare module "tty" { From 64092006cfcc0d8a3997d7db0808fc08285e0fc4 Mon Sep 17 00:00:00 2001 From: NN Date: Fri, 5 Jul 2013 22:05:28 +0300 Subject: [PATCH 048/756] Update according to TS 0.9 'export = internal' is illegal. --- node/node-0.8.8.d.ts | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/node/node-0.8.8.d.ts b/node/node-0.8.8.d.ts index 968d2143f2..53f5a07e00 100644 --- a/node/node-0.8.8.d.ts +++ b/node/node-0.8.8.d.ts @@ -1004,8 +1004,8 @@ declare module "util" { } declare module "assert" { - function internal(booleanValue: boolean, message?: string): void; - module internal { + export function internal(booleanValue: boolean, message?: string): void; + export module internal { export function fail(actual: any, expected: any, message: string, operator: string): void; export function assert(value: any, message: string): void; export function ok(value: any, message?: string): void; @@ -1019,8 +1019,6 @@ declare module "assert" { export function doesNotThrow(block: any, error?: any, messsage?: string): void; export function ifError(value: any): void; } - - export = internal; } declare module "tty" { From 21dd00558d14f6e190f1a8d66d1aead1bca8332c Mon Sep 17 00:00:00 2001 From: NN Date: Fri, 5 Jul 2013 22:08:49 +0300 Subject: [PATCH 049/756] TS requires semicolon Fix according to TS 0.9 specification. --- durandal/durandal.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/durandal/durandal.d.ts b/durandal/durandal.d.ts index 5f98beac15..043ab3f662 100644 --- a/durandal/durandal.d.ts +++ b/durandal/durandal.d.ts @@ -249,7 +249,7 @@ declare module "durandal/viewModel" { export var activator: { (): IDurandalViewModelActiveItem; (initialActiveItem: any, settings?: IViewModelDefaults): IDurandalViewModelActiveItem; - } + }; } declare module "durandal/viewModelBinder" { @@ -483,7 +483,7 @@ declare module "durandal/plugins/router" { /** * Before any route is activated, the guardRoute funtion is called. You can plug into this function to add custom logic to allow, deny or redirect based on the requested route. To allow, return true. To deny, return false. To redirect, return a string with the hash or url. You may also return a promise for any of these values. */ - export var guardRoute: (routeInfo: IRouteInfo, params: any, instance: any) => any + export var guardRoute: (routeInfo: IRouteInfo, params: any, instance: any) => any; } declare module "durandal/widget" { @@ -524,4 +524,4 @@ interface IEventSubscription * This function removing current subscription from event handlers */ off(): void; - } + } From b96032e42fc4b9e96dda1334c3e5c0266c7fa275 Mon Sep 17 00:00:00 2001 From: NN Date: Fri, 5 Jul 2013 22:22:36 +0300 Subject: [PATCH 050/756] Update according to TS 0.9 There is no declare inside module --- teechart/teechart.d.ts | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/teechart/teechart.d.ts b/teechart/teechart.d.ts index 41f9de677e..6e3a4424a2 100644 --- a/teechart/teechart.d.ts +++ b/teechart/teechart.d.ts @@ -18,7 +18,7 @@ */ -module Tee { +declare module Tee { interface IPoint { x: number; @@ -565,12 +565,12 @@ module Tee { refresh(series: ISeries, index: number): void; } - declare class Point implements IPoint { + class Point implements IPoint { public x:number; public y:number; } - declare class Chart implements IChart { + class Chart implements IChart { //public aspect: IAspect; public axes: IAxes; @@ -600,79 +600,79 @@ module Tee { // SERIES - declare var Line: { + var Line: { prototype: ILine; new(values?:number[]): ILine; } - declare var PointXY: { + var PointXY: { prototype: ICustomSeries; new(values?:number[]): ICustomSeries; } - declare var Area: { + var Area: { prototype: IArea; new(values?:number[]): IArea; } - declare var HorizArea: { + var HorizArea: { prototype: IArea; new(values?:number[]): IArea; } - declare var Bar: { + var Bar: { prototype: ICustomBar; new(values?:number[]): ICustomBar; } - declare var HorizBar: { + var HorizBar: { prototype: ICustomBar; new(values?:number[]): ICustomBar; } - declare var Pie: { + var Pie: { prototype: IPie; new(values?:number[]): IPie; } - declare var Donut: { + var Donut: { prototype: IPie; new(values?:number[]): IPie; } - declare var Bubble: { + var Bubble: { prototype: IBubble; new(values?:number[]): IBubble; } - declare var Gantt: { + var Gantt: { prototype: IGantt; new(values?:number[]): IGantt; } - declare var Volume: { + var Volume: { prototype: ICustomBar; new(values?:number[]): ICustomBar; } - declare var Candle: { + var Candle: { prototype: ICandle; new(values?:number[]): ICandle; } // TOOLS - declare var CursorTool: { + var CursorTool: { prototype: ICursorTool; new(chart?: Chart): ICursorTool; } - declare var DragTool: { + var DragTool: { prototype: IDragTool; new(chart?: Chart): IDragTool; } - declare var ToolTip: { + var ToolTip: { prototype: IToolTip; new(chart?: Chart): IToolTip; } From be4949c064d5b18a74487e56c79d67389999822b Mon Sep 17 00:00:00 2001 From: NN Date: Fri, 5 Jul 2013 22:55:50 +0300 Subject: [PATCH 051/756] TS doesn't allow optional parameters with literals --- jquery.pickadate/jquery.pickadate.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/jquery.pickadate/jquery.pickadate.d.ts b/jquery.pickadate/jquery.pickadate.d.ts index d0825c7700..03d2f943a2 100644 --- a/jquery.pickadate/jquery.pickadate.d.ts +++ b/jquery.pickadate/jquery.pickadate.d.ts @@ -251,7 +251,7 @@ interface DatePickerObject extends PickerObject { get(thing: string): any; /** Returns the string value of the picker's input element. */ - get(thing?: 'value'): string; + get(thing: 'value'): string; /** Returns the item object that is visually selected. */ get(thing: 'select'): DatePickerItemObject; @@ -317,7 +317,7 @@ interface TimePickerObject extends PickerObject { get(thing: string): any; /** Returns the string value of the picker's input element. */ - get(thing?: 'value'): string; + get(thing: 'value'): string; /** Returns the item object that is visually selected. */ get(thing: 'select'): TimePickerItemObject; @@ -372,4 +372,4 @@ interface HTMLInputElement { pickadate(picker: string): DatePickerObject; pickatime(picker: string): TimePickerObject; -} \ No newline at end of file +} From a55f110fe3036646dbacf3b70acab7002fc44630 Mon Sep 17 00:00:00 2001 From: BreeeZe Date: Fri, 5 Jul 2013 23:24:13 +0200 Subject: [PATCH 052/756] Added generic type as return type since shift() and pop() return an item from the array --- knockout/knockout.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/knockout/knockout.d.ts b/knockout/knockout.d.ts index 5614d9d493..1e23e868cf 100644 --- a/knockout/knockout.d.ts +++ b/knockout/knockout.d.ts @@ -27,9 +27,9 @@ interface KnockoutObservableArrayFunctions extends KnockoutObservableFunction slice(start: number, end?: number): T[]; splice(start: number): T[]; splice(start: number, deleteCount: number, ...items: T[]): T[]; - pop(); + pop(): T; push(...items: T[]): void; - shift(); + shift(): T; unshift(...items: T[]): number; reverse(): T[]; sort(): void; From f7450dcedb4474197efe28dee19178219cf53744 Mon Sep 17 00:00:00 2001 From: sgtfrankieboy Date: Sun, 7 Jul 2013 01:27:58 +0200 Subject: [PATCH 053/756] Google API TypeScript Definition Files TypeScript Definition File for the Google API Client (gapi). Also included are gapi.urlshortener, gapi.youtube, gapi.youtubeAnalytics. All the Definition files have full JsDoc Support. --- README.md | 6 +- gapi.urlshortener/gapi.urlshortener.d.ts | 146 + gapi.youtube/gapi.youtube.d.ts | 2337 +++++++++++++++++ .../gapi.youtubeAnalytics.d.ts | 60 + gapi/gapi.d.ts | 207 ++ 5 files changed, 2755 insertions(+), 1 deletion(-) create mode 100644 gapi.urlshortener/gapi.urlshortener.d.ts create mode 100644 gapi.youtube/gapi.youtube.d.ts create mode 100644 gapi.youtubeAnalytics/gapi.youtubeAnalytics.d.ts create mode 100644 gapi/gapi.d.ts diff --git a/README.md b/README.md index 2943452fdb..b5aa9b464f 100755 --- a/README.md +++ b/README.md @@ -68,9 +68,11 @@ List of Definitions * [glDatePicker](http://glad.github.com/glDatePicker/) (by [Dániel Tar](https://github.com/qcz)) * [GreenSock Animation Platform (GSAP)](http://www.greensock.com/get-started-js/) (by [Robert S.](https://github.com/codeBelt)) * [Grunt JS](http://gruntjs.com/) (by [Basarat Ali Syed](https://github.com/basarat)) +* [Google API Client](https://code.google.com/p/google-api-javascript-client/) (by [Frank M](https://github.com/sgtfrankieboy)) * [Google App Engine Channel API](https://developers.google.com/appengine/docs/java/channel/javascript) (by [vvakame](https://github.com/vvakame)) * [GoogleMaps](https://developers.google.com/maps/) (by [Esben Nepper](https://github.com/eNepper)) * [Google Geolocation](https://code.google.com/p/geo-location-javascript/) (by [Vincent Bortone](https://github.com/vbortone)) +* [Google Url Shortener](https://developers.google.com/url-shortener/) (by [Frank M](https://github.com/sgtfrankieboy)) * [Hammer.js](http://eightmedia.github.com/hammer.js/) (by [Boris Yankov](https://github.com/borisyankov)) * [Handlebars](http://handlebarsjs.com/) (by [Boris Yankov](https://github.com/borisyankov)) * [Highcharts](http://www.highcharts.com/) (by [damianog](https://github.com/damianog)) @@ -178,7 +180,9 @@ List of Definitions * [Vimeo](http://developer.vimeo.com/player/js-api) (by [Daz Wilkin](https://github.com/DazWilkin/)) * [WebRTC](http://dev.w3.org/2011/webrtc/editor/webrtc.html) (by [Ken Smith](https://github.com/smithkl42)) * [YouTube](https://developers.google.com/youtube/) (by [Daz Wilkin](https://github.com/DazWilkin/)) -* [Zepto.js] (http://zeptojs.com/) (by [Josh Baldwin](https://github.com/jbaldwin)) +* [YouTube Analytics API](https://developers.google.com/youtube/analytics/) (by [Frank M](https://github.com/sgtfrankieboy)) +* [YouTube Data API](https://developers.google.com/youtube/v3/) (by [Frank M](https://github.com/sgtfrankieboy/)) +* [Zepto.js](http://zeptojs.com/) (by [Josh Baldwin](https://github.com/jbaldwin)) * [Zynga Scroller](https://github.com/zynga/scroller) (by [Boris Yankov](https://github.com/borisyankov)) * [ZeroClipboard](https://github.com/jonrohan/ZeroClipboard) (by [Eric J. Smith](https://github.com/ejsmith)) diff --git a/gapi.urlshortener/gapi.urlshortener.d.ts b/gapi.urlshortener/gapi.urlshortener.d.ts new file mode 100644 index 0000000000..28ae6861d4 --- /dev/null +++ b/gapi.urlshortener/gapi.urlshortener.d.ts @@ -0,0 +1,146 @@ +// Type definitions for Google Url Shortener API +// Project: https://developers.google.com/url-shortener/ +// Definitions by: Frank M +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +/// + +declare module gapi.client.urlshortener { + + export interface url { + + /** + * Expands a short URL or gets creation time and analytics. + */ + get(object: { + /** + * The short URL, including the protocol. + */ + 'shortUrl': string; + /** + * Additional information to return. ANALYTICS_CLICKS, ANALYTICS_TOP_STRINGS, FULL + */ + 'projection'?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + 'fields'?: string + }): HttpRequest; + /** + * Creates a new short URL. + */ + insert(object: { + /** + * Selector specifying which fields to include in a partial response. + */ + 'fields'?: string; + /** + * HTTP Request Body + */ + 'RequestBody'?: string + }): HttpRequest; + /** + * Retrieves a list of URLs shortened by a user. + */ + list(object: { + /** + * Additional information to return. ANALYTICS_CLICKS, FULL + */ + 'projection'?: string; + /** + * Token for requesting successive pages of results. + */ + 'start-token'?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + 'fields'?: string + }): HttpRequest; + } +} + +interface GoogleApiUrlShortenerUrlResource { + /** + * The fixed string "urlshortener#url". + */ + kind: string; + /** + * Short URL + */ + id: string; + /** + * Long URL + */ + longUrl: string; + /** + * Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". + */ + status: string; + /** + * Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format. + */ + created: string; + /** + * A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable. + */ + analytics: { + /** + * Click analytics over all time. + */ + allTime: GoogleApiUrlShortenerUrlResourceAnalyticsObject; + /** + * Click analytics over the last month. + */ + month: GoogleApiUrlShortenerUrlResourceAnalyticsObject; + /** + * Click analytics over the last week. + */ + week: GoogleApiUrlShortenerUrlResourceAnalyticsObject; + /** + * Click analytics over the last day. + */ + day: GoogleApiUrlShortenerUrlResourceAnalyticsObject; + /** + * Click analytics over the last two hours. + */ + twoHours: GoogleApiUrlShortenerUrlResourceAnalyticsObject; + } +} + +interface GoogleApiUrlShortenerUrlResourceAnalyticsObject { + /** + * Number of clicks on this short URL. + */ + shortUrlClicks: string; + /** + * Number of clicks on all goo.gl short URLs pointing to this long URL. + */ + longUrlClicks: string; + /** + * Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available. + */ + referrers: GoogleApiUrlShortenerUrlResourceAnalyticsArrayObject[]; + /** + * Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available. + */ + countries: GoogleApiUrlShortenerUrlResourceAnalyticsArrayObject[]; + /** + * Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available. + */ + browsers: GoogleApiUrlShortenerUrlResourceAnalyticsArrayObject[]; + /** + * Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available. + */ + platforms: GoogleApiUrlShortenerUrlResourceAnalyticsArrayObject[]; +} + +interface GoogleApiUrlShortenerUrlResourceAnalyticsArrayObject { + /** + * Number of clicks for this top entry, e.g. for this particular country or browser. + */ + count: string; + /** + * Label assigned to this top entry, e.g. "US" or "Chrome". + */ + id: string; +} \ No newline at end of file diff --git a/gapi.youtube/gapi.youtube.d.ts b/gapi.youtube/gapi.youtube.d.ts new file mode 100644 index 0000000000..afef4a7aad --- /dev/null +++ b/gapi.youtube/gapi.youtube.d.ts @@ -0,0 +1,2337 @@ +// Type definitions for YouTube Data API v3 +// Project: https://developers.google.com/youtube/v3/ +// Definitions by: Frank M +// Definitions: https://github.com/borisyankov/DefinitelyTyped + + +/// + +declare module gapi.client.youtube { + + export interface activities { + + /** + * Posts a bulletin for a specific channel. + */ + insert(object: { + /** + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. + */ + part: string; + /** + * HTTP Request Body + */ + RequestBody?: string; + }): HttpRequest; + + /** + * Returns a list of channel activity events that match the request criteria. + */ + list(object: { + /** + * The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. + */ + part: string; + /** + * The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities. + */ + channelId?: string; + /** + * Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user. + */ + home?: boolean; + /** + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + */ + maxResults?: number; + /** + * Set this parameter's value to true to retrieve a feed of the authenticated user's activities. + */ + mine?: boolean; + /** + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + */ + pageToken?: string; + /** + * The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + */ + publishedAfter?: string; + /** + * The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + */ + publishedBefore?: string; + /** + * The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. + */ + regionCode?: string; + }): HttpRequest>; + + } + + export interface channelBanners { + + /** + * Uploads a channel banner to YouTube. + */ + insert(object: { + /** + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + */ + onBehalfOfContentOwner: string; + /** + * HTTP Request Body + */ + RequestBody: string; + }): HttpRequest; + } + + export interface channels { + + /** + * Returns a collection of zero or more channel resources that match the request criteria. + */ + list(object: { + /** + * The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, statistics, topicDetails, and invideoPromotion. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties. + */ + part: string; + /** + * The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category. + */ + categoryId?: string; + /** + * The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username. + */ + forUsername?: string; + /** + * The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID. + */ + id?: string; + /** + * Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided. + */ + managedByMe?: boolean; + /** + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + */ + maxResults?: number; + /** + * Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user. + */ + mine?: boolean; + /** + * Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel. + */ + mySubscribers?: boolean; + /** + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + */ + onBehalfOfContentOwner?: string; + /** + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + */ + pageToken?: string; + }): HttpRequest>; + + /** + * Updates a channel's metadata. + */ + update(object: { + /** + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are id and invideoPromotion. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. + */ + part: string; + /** + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + */ + onBehalfOfContentOwner?: string; + /** + * HTTP Request Body + */ + RequestBody?: string; + }): HttpRequest; + + } + + export interface guideCategories { + + /** + * Returns a list of categories that can be associated with YouTube channels. + */ + list(object: { + /** + * The part parameter specifies a comma-separated list of one or more guideCategory resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a guideCategory resource, the snippet property contains other properties, such as the category's title. If you set part=snippet, the API response will also contain all of those nested properties. + */ + part: string; + /** + * The hl parameter specifies the language that will be used for text values in the API response. + */ + hl?: string; + /** + * The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a guideCategory resource, the id property specifies the YouTube channel category ID. + */ + id?: string; + /** + * The regionCode parameter instructs the API to return the list of guide categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. + */ + regionCode?: string; + }): HttpRequest>; + + } + + export interface playlistItems { + + /** + * Deletes a playlist item. + */ + delete(object: { + /** + * The id parameter specifies the YouTube playlist item ID for the playlist item that is being deleted. In a playlistItem resource, the id property specifies the playlist item's ID. + */ + id: string; + }): HttpRequest; + + /** + * Adds a resource to a playlist. + */ + insert(object: { + /** + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. + */ + part: string; + /** + * HTTP Request Body + */ + RequestBody?: string; + }): HttpRequest; + + /** + * Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs. + */ + list(object: { + /** + * The part parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set part=snippet, the API response will contain all of those properties. + */ + part: string; + /** + * The id parameter specifies a comma-separated list of one or more unique playlist item IDs. + */ + id?: string; + /** + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + */ + maxResults?: number; + /** + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + */ + pageToken?: string; + /** + * The playlistId parameter specifies the unique ID of the playlist for which you want to retrieve playlist items. Note that even though this is an optional parameter, every request to retrieve playlist items must specify a value for either the id parameter or the playlistId parameter. + */ + playlistId?: string; + /** + * The videoId parameter specifies that the request should return only the playlist items that contain the specified video. + */ + videoId?: string; + }): HttpRequest>; + + /** + * Modifies a playlist item. For example, you could update the item's position in the playlist. + */ + update(object: { + /** + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist's privacy setting is contained in the status part. As such, if your request is updating a private playlist, and the request's part parameter value includes the status part, the playlist's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the playlist will revert to the default privacy setting. + */ + part: string; + /** + * HTTP Request Body + */ + RequestBody?: string; + }): HttpRequest; + } + + export interface playlists { + + /** + * Deletes a playlist. + */ + delete(object: { + /** + * The id parameter specifies the YouTube playlist ID for the playlist that is being deleted. In a playlist resource, the id property specifies the playlist's ID. + + */ + id: string; + }): HttpRequest; + + /** + * Creates a playlist. + */ + insert(object: { + /** + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and status. + */ + part: string; + /** + * HTTP Request Body + */ + RequestBody?: string; + }): HttpRequest; + + /** + * Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs. + */ + list(object: { + /** + * The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and status. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties. + */ + part: string; + /** + * This value indicates that the API should only return the specified channel's playlists. + */ + channelId?: string; + /** + * The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved. In a playlist resource, the id property specifies the playlist's YouTube playlist ID. + */ + id?: string; + /** + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + */ + maxResults?: number; + /** + * Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user. + */ + mine?: boolean; + /** + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + */ + pagetoken: string; + }): HttpRequest>; + + /** + * Modifies a playlist. For example, you could change a playlist's title, description, or privacy status. + */ + update(object: { + /** + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist's privacy setting is contained in the status part. As such, if your request is updating a private playlist, and the request's part parameter value includes the status part, the playlist's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the playlist will revert to the default privacy setting. + */ + part: string; + /** + * HTTP Request Body + */ + RequestBody?: string; + }): HttpRequest; + + } + + export interface search { + + /** + * Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource. + */ + list(object: { + /** + * The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a search result, the snippet property contains other properties that identify the result's title, description, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. + */ + part: string; + /** + * The channelId parameter indicates that the API response should only contain resources created by the channel + */ + channelId?: string; + /** + * The channelType parameter lets you restrict a search to a particular type of channel. + */ + channelType?: string; + /** + * The forContentOwner parameter restricts the search to only retrieve resources owned by the content owner specified by the onBehalfOfContentOwner parameter. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided. + */ + forContentOwner?: boolean; + /** + * The forMine parameter restricts the search to only retrieve videos owned by the authenticated user. + */ + forMine?: boolean; + /** + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + */ + maxResults?: number; + /** + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + */ + onBehalfOfContentOwner?: string; + /** + * The order parameter specifies the method that will be used to order resources in the API response. + */ + order?: string; + /** + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + */ + pageToken?: string; + /** + * The publishedAfter parameter indicates that the API response should only contain resources created after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). + */ + publishedAfter?: string; + /** + * The publishedBefore parameter indicates that the API response should only contain resources created before the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). + */ + publishedBefore?: string; + /** + * The q parameter specifies the query term to search for. + */ + q?: string; + /** + * The regionCode parameter instructs the API to return search results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. + */ + regionCode?: string; + /** + * The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video. + */ + relatedToVideoId?: string; + /** + * The safeSearch parameter indicates whether the search results should include restricted content as well as standard content. + */ + safeSearch?: string; + /** + * The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID. + */ + topicId?: string; + /** + * The type parameter restricts a search query to only retrieve a particular type of resource. + */ + type?: string; + /** + * The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions. + */ + videoCaption?: string; + /** + * The videoCategoryId parameter filters video search results based on their category. + */ + videoCategoryId?: string; + /** + * The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available. + */ + videoDefinition?: string; + /** + * The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos. + */ + videoDimension?: string; + /** + * The videoDuration parameter filters video search results based on their duration. + */ + videoDuration?: string; + /** + * The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage. + */ + videoEmbeddable?: string; + /** + * The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos. + */ + videoLicense?: string; + /** + * The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com. + */ + videoSyndicated?: string; + /** + * The videoType parameter lets you restrict a search to a particular type of videos. + */ + videoType?: string; + }): HttpRequest>; + + } + + export interface subscriptions { + + /** + * Deletes a subscription. + */ + delete(object: { + /** + * The id parameter specifies the YouTube subscription ID for the resource that is being deleted. In a subscription resource, the id property specifies the YouTube subscription ID. + */ + id: string; + }): HttpRequest; + + /** + * Adds a subscription for the authenticated user's channel. + */ + insert(object: { + /** + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. + */ + part: string; + /** + * HTTP Request Body + */ + RequestBody: string; + }): HttpRequest; + + /** + * Returns subscription resources that match the API request criteria. + */ + list(object: { + /** + * The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties. + */ + part: string; + /** + * The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions. + */ + channelId?: string; + /** + * The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels. + */ + forChannelId?: string; + /** + * The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID. + */ + id?: string; + /** + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + */ + maxResults?: number; + /** + * Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions. + */ + mine?: boolean; + /** + * Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user. + */ + mySubscripbers?: boolean; + /** + * The order parameter specifies the method that will be used to sort resources in the API response. + */ + order?: string; + /** + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + */ + pageToken?: string; + }): HttpRequest>; + } + + export interface thumbnails { + + /** + * Uploads a custom video thumbnail to YouTube and sets it for a video. + */ + set(object: { + /** + * The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided. + */ + videoId: string; + }): HttpRequest>; + + } + + export interface videoCategories { + + /** + * Returns a list of categories that can be associated with YouTube videos. + */ + list(object: { + /** + * The part parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet. + */ + part: string; + /** + * The hl parameter specifies the language that should be used for text values in the API response. + */ + hl?: string; + /** + * The id parameter specifies a comma-separated list of video category IDs for the resources that you are retrieving. + */ + id?: string; + /** + * The regionCode parameter instructs the API to return the list of video categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. + */ + regionCode?: string; + }): HttpRequest>; + + } + + export interface videos { + + /** + * Deletes a YouTube video. + */ + delete(object: { + /** + * The id parameter specifies the YouTube video ID for the resource that is being deleted. In a video resource, the id property specifies the video's ID. + + */ + id: string; + /** + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + */ + onBehalfOfContentOwner?: string; + }): HttpRequest; + + /** + * Get user ratings for videos. + */ + getRating(object: { + /** + * The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID. + */ + id: string; + /** + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + */ + onBehalfOfContentOwner?: string; + }): HttpRequest; + + /** + * Uploads a video to YouTube and optionally sets the video's metadata. + */ + insert(object: { + /** + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet, contentDetails, player, statistics, status, and topicDetails. However, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. + */ + part: string; + /** + * The autoLevels parameter specifies whether the video should be auto-leveled by YouTube. + */ + autoLevels?: boolean; + /** + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + */ + onBehalfOfContentOwner?: string; + /** + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the channel specified in the parameter value. This parameter must be used in conjunction with the onBehalfOfContentOwner parameter, and the user must be authenticated using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. In addition, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. + */ + onBehalfOfContentOwnerChannel?: string; + /** + * The stabilize parameter specifies whether the video should be stabilized by YouTube. + */ + stabilize?: boolean; + /** + * HTTP Request Body + */ + RequestBody?: string; + }): HttpRequest; + + /** + * Returns a list of videos that match the API request parameters. + */ + list(object: { + /** + * The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, player, statistics, status, and topicDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties. + */ + part: string; + /** + * Set this parameter's value to mostPopular to instruct the API to return videos belonging to the chart of most popular videos. + */ + chart: string; + /** + * The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID. + */ + id: string; + /** + * The locale parameter selects a video chart available in the specified locale. If using this parameter, chart must also be set. The parameter value is an BCP 47 locale. Supported locales include ar_AE, ar_DZ, ar_EG, ar_JO, ar_MA, ar_SA, ar_TN, ar_YE, cs_CZ, de_DE, el_GR, en_AU, en_BE, en_CA, en_GB, en_GH, en_IE, en_IL, en_IN, en_KE, en_NG, en_NZ, en_SG, en_UG, en_US, en_ZA, es_AR, es_CL, es_CO, es_ES, es_MX, es_PE, fil_PH, fr_FR, hu_HU, id_ID, it_IT, ja_JP, ko_KR, ms_MY, nl_NL, pl_PL, pt_BR, ru_RU, sv_SE, tr_TR, zh_HK, zh_TW + */ + locale: string; + /** + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + */ + maxResults: number; + /** + * Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user. + */ + myRating: string; + /** + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + */ + onBehalfOfContentOwner: string; + /** + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + */ + pageToken: string; + /** + * The videoCategoryId parameter selects a video chart based on the category. If using this parameter, chart must also be set. + */ + videoCategoryId: string; + }): HttpRequest>; + + /** + * Like, dislike, or remove rating from a video. + */ + rate(object: { + /** + * The id parameter specifies the YouTube video ID. + */ + id: string; + /** + * Specifies the rating to record. + */ + rating: string; + /** + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + */ + onBehalfOfContentOwner?: string; + }): HttpRequest; + + /** + * Updates a video's metadata. + */ + update(object: { + /** + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet, contentDetails, player, statistics, status, and topicDetails. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting. In addition, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. + */ + part: string; + /** + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + */ + onBehalfOfContentOwner?: string; + /** + * HTTP Request Body + */ + RequestBody?: string; + }): HttpRequest; + + } + +} + +interface GoogleApiYouTubePageInfo { + /** + * The type of the API response. For this operation, the value will be youtube#activityListResponse. + */ + kind: string; + /** + * The ETag of the response. + */ + etag: string; + /** + * A list of activities, or events, that match the request criteria. + */ + items: T[]; +} + +interface GoogleApiYouTubePaginationInfo { + + /** + * The type of the API response. For this operation, the value will be youtube#activityListResponse. + */ + kind: string; + /** + * The ETag of the response. + */ + etag: string; + /** + * The pageInfo object encapsulates paging information for the result set. + */ + pageInfo: { + /** + * The total number of results in the result set. + */ + totalResults: number; + /** + * The number of results included in the API response. + */ + resultsPerPage: number; + }; + /** + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. + */ + nextPageToken: string; + /** + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. + */ + prevPageToken: string; + /** + * A list of activities, or events, that match the request criteria. + */ + items: T[]; + +} + +interface GoogleApiYouTubeActivityResource { + /** + * The type of the API resource. For activity resources, the value will be youtube#activity. + */ + kind: string; + /** + * The ETag of the activity resource. + */ + etag: string; + /** + * The ID that YouTube uses to uniquely identify the activity. + */ + id: string; + /** + * The snippet object contains basic details about the activity, including the activitys type and group ID. + */ + snippet: { + /** + * The date and time that the activity occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + */ + publishedAt: string; + /** + * The ID that YouTube uses to uniquely identify the channel associated with the activity. + */ + channelId: string; + /** + * The title of the resource primarily associated with the activity. + */ + title: string; + /** + * The description of the resource primarily associated with the activity. + */ + description: string; + /** + * A map of thumbnail images associated with the resource that is primarily associated with the activity. + */ + thumbnails: GoogleApiYouTubeThumbnailItemResource[]; + /** + * Channel title for the channel responsible for this activity + */ + channelTitle: string; + /** + * The type of activity that the resource describes. + */ + type: string; + /** + * The group ID associated with the activity. + */ + groupId: string; + } + /** + * The contentDetails object contains information about the content associated with the activity. + */ + contentDetails: { + /** + * The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload. + */ + upload: { + /** + * The ID that YouTube uses to uniquely identify the uploaded video. + */ + videoId: string; + } + /** + * The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like. + */ + like: { + /** + * The resourceId object contains information that identifies the rated resource. + */ + resourceId: { + /** + * The type of the API resource. + */ + kind: string; + /** + * The ID that YouTube uses to uniquely identify the video, if the rated resource is a video. This property is only present if the resourceId.kind is youtube#video + */ + videoId: string; + } + } + /** + * The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite. + */ + favorite: { + /** + * The resourceId object contains information that identifies the resource that was marked as a favorite. + */ + resourceId: { + /** + * The type of the API resource. + */ + kind: string; + /** + * The ID that YouTube uses to uniquely identify the favorite video. This property is only present if the resourceId.kind is youtube#video. + */ + videoId: string; + } + } + /** + * The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment. + */ + comment: { + /** + * The resourceId object contains information that identifies the resource associated with the comment. + */ + resourceId: { + /** + * The type of the API resource. + */ + kind: string; + /** + * The ID that YouTube uses to uniquely identify the video associated with a comment. This property is only present if the resourceId.kind is youtube#video. + */ + videoId: string; + /** + * The ID that YouTube uses to uniquely identify the channel associated with a comment. This property is only present if the resourceId.kind is youtube#channel. + */ + channelId: string; + } + } + /** + * The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription. + */ + subscription: { + /** + * The resourceId object contains information that identifies the resource that the user subscribed to. + */ + resourceId: { + /** + * The type of the API resource. + */ + kind: string; + /** + * The ID that YouTube uses to uniquely identify the channel that the user subscribed to. This property is only present if the resourceId.kind is youtube#channel. + */ + channelId: string; + } + } + /** + * The playlistItem object contains information about an item that was added to a playlist. This property is only present if the snippet.type is playlistItem. + */ + playlistItem: { + /** + * The resourceId object contains information that identifies the resource that was added to the playlist. + */ + resourceId: { + /** + * The type of the API resource. + */ + kind: string; + /** + * The ID that YouTube uses to uniquely identify the video that was added to the playlist. This property is only present if the resourceId.kind is youtube#video. + */ + videoId: string; + } + /** + * The value that YouTube uses to uniquely identify the playlist. + */ + playlistId: string; + /** + * The value that YouTube uses to uniquely identify the item in the playlist. + */ + playlistItemId: string; + } + /** + * The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation. + */ + recommendation: { + /** + * The resourceId object contains information that identifies the recommended resource. + */ + resourceId: { + /** + * The type of the API resource. + */ + kind: string; + /** + * The ID that YouTube uses to uniquely identify the video, if the recommended resource is a video. This property is only present if the resourceId.kind is youtube#video. + */ + videoId: string; + /** + * The ID that YouTube uses to uniquely identify the channel, if the recommended resource is a channel. This property is only present if the resourceId.kind is youtube#channel. + */ + channelId: string; + } + /** + * The reason that the resource is recommended to the user. + */ + reason: string; + /** + * The seedResourceId object contains information about the resource that caused the recommendation. + */ + seedResourceId: { + /** + * The type of the API resource. + */ + kind: string; + /** + * The ID that YouTube uses to uniquely identify the video, if the recommendation was caused by a particular video. This property is only present if the seedResourceId.kind is youtube#video. + */ + videoId: string; + /** + * The ID that YouTube uses to uniquely identify the channel, if the recommendation was caused by a particular channel. This property is only present if the seedResourceId.kind is youtube#channel. + */ + channelId: string; + /** + * The ID that YouTube uses to uniquely identify the playlist, if the recommendation was caused by a particular playlist. This property is only present if the seedResourceId.kind is youtube#playlist. + */ + playlistId: string; + } + } + /** + * The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin. + */ + bulletin: { + /** + * The resourceId object contains information that identifies the resource associated with a bulletin post. + */ + resourceId: { + /** + * The type of the API resource. + */ + kind: string; + /** + * The ID that YouTube uses to uniquely identify the video featured in a bulletin post, if the post refers to a video. This property will only be present if the value of the bulletin.resourceId.kind property is youtube#video. + */ + videoId: string; + /** + * The ID that YouTube uses to uniquely identify the channel featured in a bulletin post, if the post refers to a channel. This property will only be present if the value of the bulletin.resourceId.kind property is youtube#channel. + */ + channelId: string; + /** + * The ID that YouTube uses to uniquely identify the playlist featured in a bulletin post, if the post refers to a playlist. This property will only be present if the value of the bulletin.resourceId.kind property is youtube#playlist. + */ + playlistId: string; + } + } + /** + * The social object contains details about a social network post. This property is only present if the snippet.type is social. + */ + social: { + /** + * The name of the social network. + */ + type: string; + /** + * The resourceId object encapsulates information that identifies the resource associated with a social network post. + */ + resourceId: { + /** + * The type of the API resource. + */ + kind: string; + /** + * The ID that YouTube uses to uniquely identify the video featured in a social network post, if the post refers to a video. This property will only be present if the value of the social.resourceId.kind property is youtube#video. + */ + videoId: string; + /** + * The ID that YouTube uses to uniquely identify the channel featured in a social network post, if the post refers to a channel. This property will only be present if the value of the social.resourceId.kind property is youtube#channel. + */ + channelId: string; + /** + * The ID that YouTube uses to uniquely identify the playlist featured in a social network post, if the post refers to a playlist. This property will only be present if the value of the social.resourceId.kind property is youtube#playlist. + */ + playlistId: string; + } + /** + * The author of the social network post. + */ + author: string; + /** + * The URL of the social network post. + */ + referenceUrl: string; + /** + * An image of the posts author. + */ + imageUrl: string; + } + /** + * The channelItem object contains details about a resource that was added to a channel. This property is only present if the snippet.type is channelItem. + */ + channelItem: { + /** + * The resourceId object contains information that identifies the resource that was added to the channel. + */ + resourceId: { + } + } + } +} + +interface GoogleApiYouTubeChannelBannerResource { + /** + * The type of the API response. For this operation, the value will be youtube#channelBannerInsertResponse. + */ + kind: string; + /** + * The ETag of the response. + */ + etag: string; + /** + * The banner images URL. After calling the channelBanners.insert method, extract this value from the API response. Then call the channels.update method, and set the URL as the value of the brandingSettings.image.bannerExternalUrl property to set the banner image for a channel. + */ + url: string; +} + +interface GoogleApiYouTubeChannelResource { + /** + * The ID that YouTube uses to uniquely identify the channel. + */ + id: string; + /** + * The type of the API resource. For channel resources, the value will be youtube#channel. + */ + kind: string; + /** + * The ETag for the channel resource. + */ + etag: string; + /** + * The snippet object contains basic details about the channel, such as its title, description, and thumbnail images. + */ + snippet: { + /** + * The channels title. + */ + title: string; + /** + * The channels description. + */ + description: string; + /** + * The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + */ + publishedAt: string; + /** + * A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. + */ + thumbnails: GoogleApiYouTubeThumbnailItemResource[]; + } + /** + * The contentDetails object encapsulates information about the channels content. + */ + contentDetails: { + /** + * The relatedPlaylists object is a map that identifies playlists associated with the channel, such as the channels uploaded videos or favorite videos. You can retrieve any of these playlists using the playlists.list method. + */ + relatedPlaylists: { + /** + * The ID of the playlist that contains the channels liked videos. + */ + likes: string; + /** + * The ID of the playlist that contains the channels favorite videos. + */ + favorites: string; + /** + * The ID of the playlist that contains the channels uploaded videos. + */ + uploads: string; + /** + * The ID of the playlist that contains the channels watch history. + */ + watchHistory: string; + /** + * The ID of the channels watch later playlist. + */ + watchLater: string; + } + /** + * The googlePlusUserId object identifies the Google+ profile ID associated with this channel. + */ + googlePlusUserId: string; + } + /** + * The statistics object encapsulates statistics for the channel. + */ + statistics: { + /** + * The number of times the channel has been viewed. + */ + viewCount: number; + /** + * The number of comments for the channel. + */ + commentCount: number; + /** + * The number of subscribers that the channel has. + */ + subscriberCount: number; + /** + * The number of videos uploaded to the channel. + */ + videoCount: number; + } + /** + * The topicDetails object encapsulates information about Freebase topics associated with the channel. + */ + topicDetails: { + /** + * A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API. + */ + topicIds: string[]; + } + /** + * The status object encapsulates information about the privacy status of the channel. + */ + status: { + /** + * Privacy status of the channel. + */ + privacyStatus: string; + /** + * Indicates whether the channel data identifies a user that is already linked to either a YouTube username or a Google+ account. A user that has one of these links already has a public YouTube identity, which is a prerequisite for several actions, such as uploading videos. + */ + isLinked: boolean; + } + /** + * The brandingSettings object encapsulates information about the branding of the channel. + */ + brandingSettings: { + /** + * The channel object encapsulates branding properties of the channel page. + */ + channel: { + /** + * The channels title. The title has a maximum length of 30 characters. + */ + title: string; + /** + * The channel description, which appears in the channel information box on your channel page. + */ + description: string; + /** + * Keywords associated with your channel. The value is a comma-separated list of strings. + */ + keywords: string; + /** + * The content tab that users should display by default when viewers arrive at your channel page. + */ + defaultTab: string; + /** + * The ID for a Google Analytics account that you want to use to track and measure traffic to your channel. + */ + trackingAnalyticsAccountId: string; + /** + * This setting determines whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. The default value is false. + */ + moderateComments: boolean; + /** + * This setting indicates whether YouTube should show an algorithmically generated list of related channels on your channel page. + */ + showRelatedChannels: boolean; + /** + * This setting indicates whether the channel page should display content in a browse or feed view. + */ + showBrowseView: boolean; + /** + * The title that displays above the featured channels module. + */ + featuredChannelsTitle: string; + /** + * A list of up to 16 channels that you would like to link to from the featured channels module. The property value is a list of YouTube channel ID values, each of which uniquely identifies a channel. + */ + featuredChannelsUrls: string[]; + /** + * The video that should play in the featured video module in the channel pages browse view for unsubscribed viewers. Subscribed viewers may see a different view that highlights more recent channel activity. + */ + unsubscribedTrailer: string; + } + /** + * The watch object encapsulates branding properties of the watch pages for the channels videos. + */ + watch: { + /** + * The background color for the video watch pages branded area. + */ + textColor: string; + /** + * The text color for the video watch pages branded area. + */ + backgroundColor: string; + /** + * An ID that uniquely identifies a playlist that displays next to the video player on the video watch page. + */ + featuredPlaylistId: string; + } + /** + * The image object encapsulates information about images that display on the channels channel page or video watch pages. + */ + image: { + /** + * The URL for the banner image shown on the channel page on the YouTube website. The image is 1060px by 175px. + */ + bannerImageUrl: string; + /** + * The URL for the banner image shown on the channel page in mobile applications. The image is 640px by 175px. + */ + bannerMobileImageUrl: string; + /** + * The backgroundImageUrl object encapsulates settings for the background image shown on the video watch page. The image is 1200px by 615px, with a maximum file size of 128k. + */ + backgroundImageUrl: { + /** + * The default value for the property. + */ + default: string; + /** + * A list of objects that specify language-specific values for the property. + */ + localized: { + /** + * The property value for a specified language. + */ + value: string; + /** + * The language associated with the value. + */ + language: string; + }[]; + } + /** + * The largeBrandedBannerImageImapScript object encapsulates information about the image map script for the banner image shown on the channel page. + */ + largeBrandedBannerImageImapScript: { + /** + * The default value for the property. + */ + default: string; + /** + * A list of objects that specify language-specific values for the property. + */ + localized: { + /** + * The property value for a specified language. + */ + value: string; + /** + * The language associated with the value. + */ + language: string; + }[]; + } + /** + * The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page. + */ + largeBrandedBannerImageUrl: { + /** + * The default value for the property. + */ + default: string; + /** + * A list of objects that specify language-specific values for the property. + */ + localized: { + /** + * The property value for a specified language. + */ + value: string; + /** + * The language associated with the value. + */ + language: string; + }[]; + } + /** + * The image map script for the small banner image. The largeBrandedBannerImageImapScript object encapsulates information about the image map script for the banner image shown on the channel page in mobile applications. + */ + smallBrandedBannerImageImapScript: { + /** + * The default value for the property. + */ + default: string; + /** + * A list of objects that specify language-specific values for the property. + */ + localized: { + /** + * The property value for a specified language. + */ + value: string; + /** + * The language associated with the value. + */ + language: string; + }[]; + } + /** + * The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. + */ + smallBrandedBannerImageUrl: { + /** + * The default value for the property. + */ + default: string; + /** + * A list of objects that specify language-specific values for the property. + */ + localized: { + /** + * The property value for a specified language. + */ + value: string; + /** + * The language associated with the value. + */ + language: string; + }[]; + } + /** + * The URL for the image that appears above the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels. If you do not provide this image, your channel name will appear instead of an image. + */ + watchIconImageUrl: string; + /** + * The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages. + */ + trackingImageUrl: string; + /** + * The URL for a low-resolution banner image that displays on the channel page in tablet applications. The image is 1138px by 188px. + */ + bannerTabletLowImageUrl: string; + /** + * The URL for a banner image that displays on the channel page in tablet applications. The image is 1707px by 283px. + */ + bannerTabletImageUrl: string; + /** + * The URL for a high-resolution banner image that displays on the channel page in tablet applications. The image is 2276px by 377px. + */ + bannerTabletHdImageUrl: string; + /** + * The URL for an insanely high-resolution banner image that displays on the channel page in tablet applications. The image is 2560px by 424px. + */ + bannerTabletExtraHdImageUrl: string; + /** + * The URL for a low-resolution banner image that displays on the channel page in mobile applications. The image is 320px by 88px. + */ + bannerMobileLowImageUrl: string; + /** + * The URL for a medium-resolution banner image that displays on the channel page in mobile applications. The image is 960px by 263px. + */ + bannerMobileMediumImageUrl: string; + /** + * The URL for a high-resolution banner image that displays on the channel page in mobile applications. The image is 1280px by 360px. + */ + bannerMobileHdImageUrl: string; + /** + * The URL for a very high-resolution banner image that displays on the channel page in mobile applications. The image is 1440px by 395px. + */ + bannerMobileExtraHdImageUrl: string; + /** + * The URL for a banner image that displays on the channel page in television applications. The image is 2120px by 1192px. + */ + bannerTvImageUrl: string; + /** + * This property specifies the location of the banner image that YouTube will use to generate the various banner image sizes for a channel. To obtain the URL banner images external URL, you must first upload the channel banner image that you want to use by calling the channelBanners.insert method. + */ + bannerExternalUrl: string; + } + /** + * The hints object encapsulates additional branding properties + */ + hints: { + /** + * A property. + */ + property: string; + /** + * The propertys value. + */ + value: string; + }[]; + } + /** + * The invideoPromotion object encapsulates information about a promotional campaign associated with the channel. A channel can use an in-video promotional campaign to display the thumbnail image of a promoted video in the video player during playback of the channels videos + */ + invideoPromotion: { + /** + * The timing object encapsulates information about the temporal position within the video when the promoted item will be displayed. + */ + timing: { + /** + * The timing method that determines when the promoted item is inserted during the video playback. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video. + */ + type: string; + /** + * The time offset, specified in milliseconds, that determines when the promoted item appears during video playbacks. The type propertys value determines whether the offset is measured from the start or end of the video. + */ + offsetMs: number; + } + /** + * The position object encapsulates information about the spatial position within the video where the promoted item will be displayed. + */ + position: { + /** + * The manner in which the promoted item is positioned in the video player. + */ + type: string; + /** + * The corner of the player where the promoted item will appear. + */ + cornerPosition: string; + } + /** + * The list of promoted items in the order that they will display across different playbacks to the same viewer. + */ + items: { + /** + * The promoted items type. + */ + type: string; + /** + * If the promoted item represents a video, then this value is present and identifies the YouTube ID that YouTube assigned to identify that video. This field is only present if the type propertys value is video. + */ + videoId: string; + }[]; + } +} + +interface GoogleApiYouTubeGuideCategoryResource { + /** + * The ID that YouTube uses to uniquely identify the guide category. + */ + id: string; + /** + * The type of the API resource. For guideCategory resources, the value will be youtube#guideCategory. + */ + kind: string; + /** + * The ETag of the guideCategory resource. + */ + etag: string; + /** + * The snippet object contains basic details about the category, such as its title. + */ + snippet: { + /** + * The ID that YouTube uses to uniquely identify the channel publishing the guide category. + */ + channelId: string; + /** + * The categorys title. + */ + title: string; + } +} + +interface GoogleApiYouTubePlaylistItemResource { + /** + * The ID that YouTube uses to uniquely identify the playlist item. + */ + id: string; + /** + * The type of the API resource. For playlist item resources, the value will be youtube#playlistItem. + */ + kind: string; + /** + * The ETag for the playlist item resource. + */ + etag: string; + /** + * The snippet object contains basic details about the playlist item, such as its title and position in the playlist. + */ + snippet: { + /** + * The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + */ + publishedAt: string; + /** + * The ID that YouTube uses to uniquely identify the user that added the item to the playlist. + */ + channelId: string; + /** + * The items title. + */ + title: string; + /** + * The items description. + */ + description: string; + /** + * A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. + */ + thumbnails: GoogleApiYouTubeThumbnailItemResource[]; + /** + * The channel title of the channel that the playlist item belongs to. + */ + channelTitle: string; + /** + * The ID that YouTube uses to uniquely identify the playlist that the playlist item is in. + */ + playlistId: string; + /** + * The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth. + */ + position: number; + /** + * The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item. + */ + resourceId: { + /** + * The kind, or type, of the referred resource. + */ + kind: string; + /** + * If the snippet.resourceId.kind propertys value is youtube#video, then this property will be present and its value will contain the ID that YouTube uses to uniquely identify the video in the playlist. + */ + videoId: string; + } + } + /** + * The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video. + */ + contentDetails: { + /** + * The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request. + */ + videoId: string; + /** + * The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0. + */ + startAt: string; + /** + * The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video. + */ + endAt: string; + /** + * A user-generated note for this item. + */ + note: string; + } + /** + * The status object contains information about the playlist items privacy status. + */ + status: { + /** + * The playlist items privacy status. The channel that uploaded the video that the playlist item represents can set this value using either the videos.insert or videos.update method. + */ + privacyStatus: string; + } +} + +interface GoogleApiYouTubePlaylistResource { + /** + * The ID that YouTube uses to uniquely identify the playlist. + */ + id: string; + /** + * The type of the API resource. For video resources, the value will be youtube#playlist. + */ + kind: string; + /** + * The ETag for the playlist resource. + */ + etag: string; + /** + * The snippet object contains basic details about the playlist, such as its title and description. + */ + snippet: { + /** + * The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + */ + publishedAt: string; + /** + * The ID that YouTube uses to uniquely identify the channel that published the playlist. + */ + channelId: string; + /** + * The playlists title. + */ + title: string; + /** + * The playlists description. + */ + description: string; + /** + * A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. + */ + thumbnails: GoogleApiYouTubeThumbnailItemResource[]; + /** + * The channel title of the channel that the video belongs to. + */ + channelTitle: string; + /** + * Keyword tags associated with the playlist. + */ + tags: string[]; + } + /** + * The status object contains status information for the playlist. + */ + status: { + /** + * The playlists privacy status. + */ + privacyStatus: string; + } + /** + * The contentDetails object contains information about the playlist content, including the number of videos in the playlist. + */ + contentDetails: { + /** + * The number of videos in the playlist. + */ + itemCount: number; + } + /** + * The player object contains information that you would use to play the playlist in an embedded player. + */ + player: { + /** + * An ') + */ + youTubeCode?: string; + /** + * Vimeo embed code. %id% is replaced by video id. (default: '') + */ + vimeoCode?: string; + } + + + export interface RoyalSliderOptions { /** * Automatically updates slider height based on base width. (default: false) @@ -251,7 +295,15 @@ declare module RoyalSlider { /** * Deep linking module makes URL automatically change when you switch slides and you can easily link to specific slide (aka permalink). */ - deeplinking?: RoyalSliderDeeplinkingOptions + deeplinking?: RoyalSliderDeeplinkingOptions; + /** + * Autoplay slideshow can be enabled via slider options. Delay between items can be set globally via delay option, or specifically for each item by adding data-rsDelay="1000" to root element of the slide (1000 = 1sec). + */ + autoplay?: RoyalSliderAutoplayOptions; + /** + * To add video to slide, you need to add data-rsVideo="" attribute to image. It can contain link to YouTube or Vimeo video. + */ + video?: RoyalSliderVideoOptions; } } From 5f3e373e14e63aa0a850297b7b53824b90281836 Mon Sep 17 00:00:00 2001 From: Christiaan Rakowski Date: Thu, 18 Jul 2013 21:06:52 +0200 Subject: [PATCH 098/756] updated tests --- royalslider/royalslider-tests.ts | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/royalslider/royalslider-tests.ts b/royalslider/royalslider-tests.ts index 10715db6a4..025bfb2d94 100644 --- a/royalslider/royalslider-tests.ts +++ b/royalslider/royalslider-tests.ts @@ -40,4 +40,29 @@ jQuery(document).ready(function ($) { prefix: 'slider-' } }); +}); + + +jQuery(document).ready(function ($) { + $(".royalSlider").royalSlider({ + // general options go gere + autoScaleSlider: true, + autoPlay: { + // autoplay options go gere + enabled: true, + pauseOnHover: true + } + }); +}); + +jQuery(document).ready(function ($) { + $(".royalSlider").royalSlider({ + // general options go gere + autoScaleSlider: true, + video: { + // video options go gere + autoHideBlocks: true, + autoHideArrows: false + } + }); }); \ No newline at end of file From b6e1333b6c83a6a53b6527090da7ac7f7390ef00 Mon Sep 17 00:00:00 2001 From: Christiaan Rakowski Date: Thu, 18 Jul 2013 21:50:43 +0200 Subject: [PATCH 099/756] Added typings for jQuery royal-slider v9.4.0 --- royalslider/royalslider-tests.ts | 161 +++++++++++++++++++++++++++ royalslider/royalslider.d.ts | 183 ++++++++++++++++++++++++++++++- 2 files changed, 342 insertions(+), 2 deletions(-) diff --git a/royalslider/royalslider-tests.ts b/royalslider/royalslider-tests.ts index 025bfb2d94..8a5e2dcd61 100644 --- a/royalslider/royalslider-tests.ts +++ b/royalslider/royalslider-tests.ts @@ -65,4 +65,165 @@ jQuery(document).ready(function ($) { autoHideArrows: false } }); +}); + +jQuery(document).ready(function ($) { + $(".royalSlider").royalSlider({ + // general options go gere + autoScaleSlider: true, + block: { + // animated blocks options go gere + fadeEffect: false, + moveEffect: 'left' + } + }); +}); + +jQuery(document).ready(function ($) { + $(".royalSlider").royalSlider({ + // general options go gere + keyboardNavEnabled: true, + visibleNearby: { + enabled: true, + centerArea: 0.5, + center: true, + breakpoint: 650, + breakpointCenterArea: 0.64, + navigateByCenterClick: true + } + }); +}); + +// All public methods can be called jQuery-way - $(".royalSlider").royalSlider('startAutoPlay'); +// Another example: $(".royalSlider").royalSlider('goTo', 3); +// But it's recommended to get instance once if you have many calls: + +var slider = $(".royalSlider").royalSlider(); + +slider.goTo(3); // go to slide with id +slider.next(); // next slide +slider.prev(); // prev slide + +slider.destroy(); // removes all events and clears all slider data +// use on ajax sites to avoid memory leaks + +// Dynamic slides adding/removing +// More info in Javascript API section of support desk - http://dimsemenov.com/private/forum.php +slider.appendSlide($('div')); +slider.appendSlide($('div'), 4); + +slider.removeSlide(); +slider.removeSlide(4); + +slider.updateSliderSize(); // updates size of slider. Use after you resize slider with js. +slider.updateSliderSize(true); // Function has "forceResize" Boolean paramater. + +// Thumbnails public methods +slider.setThumbsOrientation('vertical'); // changes orientation of thumbnails +slider.updateThumbsSize(); // updates size of thumbnails + +// Fullscreen public methods +slider.enterFullscreen(); +slider.exitFullscreen(); + +// Autoplay public methods +slider.startAutoPlay(); +slider.stopAutoPlay(); +slider.toggleAutoPlay(); + +// Video public methods +slider.toggleVideo(); +slider.playVideo(); +slider.stopVideo(); + + + + +slider.currSlideId // current slide index +slider.currSlide // current slide object + +slider.numSlides // total number of slides + +slider.isFullscreen // indicates if slider is in fullscreen mode +slider.nativeFS // indicates if browser supports native fullscreen + +slider.width // width of slider +slider.height // height of slider + +slider.dragSuccess // Boolean, changes on mouseup, indicates if slide was dragged. Used to check if event is drag or click. + +slider.slides // array, contains all data about each slide +slider.slidesJQ // array, contains list of HTML slides that are added to slider + +slider.st // object with slider settings +slider.ev // jQuery object with slider events + + + + +// In each listener event.target is slider instance + +slider.ev.on('rsAfterSlideChange', function (event) { + // triggers after slide change +}); +slider.ev.on('rsBeforeAnimStart', function (event) { + // before animation between slides start +}); +slider.ev.on('rsBeforeMove', function (event, type, userAction) { + // before any transition start (including after drag release) + // "type" - can be "next", "prev", or ID of slide to move + // userAction (Boolean) - defines if action is triggered by user (e.g. will be false if movement is triggered by autoPlay) +}); +slider.ev.on('rsBeforeSizeSet', function (event) { + // before size of slider is changed +}); +slider.ev.on('rsDragStart', function (event) { + // mouse/touch drag start +}); +slider.ev.on('rsDragRelease', function () { + // mouse/touch drag end +}); +slider.ev.on('rsBeforeDestroy', function () { + // triggers before slider in destroyed +}); +slider.ev.on('rsOnCreateVideoElement', function (e, url)) { + // triggers before video element is created, after click on play button. + // Read more in Tips&Tricks section +}); +slider.ev.on('rsSlideClick', function () { + // triggers when user clicks on slide + // doesn't trigger after click and drag +}); +slider.ev.on('rsEnterFullscreen', function () { + // enter fullscreen mode +}); +slider.ev.on('rsExitFullscreen', function () { + // exit fullscreen mode +}); + +slider.ev.on('rsVideoPlay', function () { + // video start +}); +slider.ev.on('rsVideoStop', function () { + // video stop +}); + +slider.slides[2].holder.on('rsAfterContentSet', function () { + // fires when third slide content is loaded and added to DOM +}); +// or globally +slider.ev.on('rsAfterContentSet', function (e, slideObject) { + // fires when every time when slide content is loaded and added to DOM +}); + +// Next events TRIGGER DIRECTLY ON SLIDER INITIALIZATION +// if you bind them after slider init they'll not fire +// used for module development +slider.ev.on('rsAfterInit', function () { + // after slider is initialized, +}); +slider.ev.on('rsBeforeParseNode', function (e, content, obj) { + // before slide node is parsed + // content - HTML object of slide that is parsed + // obj - RoyalSlider data object (stores image URLs) }); \ No newline at end of file diff --git a/royalslider/royalslider.d.ts b/royalslider/royalslider.d.ts index 72af7d7a1d..2e83e395ce 100644 --- a/royalslider/royalslider.d.ts +++ b/royalslider/royalslider.d.ts @@ -1,4 +1,4 @@ -// Type definitions for jQuery royal-slider +// Type definitions for jQuery royal-slider v9.4.0 // Project: http://dimsemenov.com/plugins/royal-slider/documentation/ // Definitions by: Christiaan Rakowski // Definitions: https://github.com/borisyankov/DefinitelyTyped @@ -137,7 +137,59 @@ declare module RoyalSlider { vimeoCode?: string; } + export interface RoyalSliderBlockOptions { + /** + * true or false (default: true) + */ + fadeEffect?: boolean; + /** + * Move effect direction.Can be 'left', 'right', 'top', 'bottom' or 'none'. (default: 'top') + */ + moveEffect?: string; + /** + * Distance for move effect in pixels. (default: 20) + */ + moveOffset?: number; + /** + * Transition speed of block, in ms. (default: 400) + */ + speed?: number; + /** + * Easing function of block animation.Read more in easing section of docs. (default: 'easeOutSine' ) + */ + easing?: string; + /** + * Delay between each block show up, in ms. (default: 200) + */ + delay?: number; + } + export interface RoyalSliderVisibleOptions { + /** + * Enable visible-nearby. (default: true) + */ + enabled?: boolean; + /** + * Ratio that determines area of center image.For example for 0.6 - 60 % of slider area will get center image and 20% for two images on sides. (default: 0.6) + */ + centerArea?: number; + /** + * Alignment of center image, if you set it to false center image will be aligned to left. (default: true) + */ + center?: boolean; + /** + * Disables navigation to next slide by clicking on current slide (if navigateByClick is true). (default: true) + */ + navigateByCenterClick?: boolean; + /** + * Used for responsive design. Changes centerArea value to breakpointCenterArea when width of slider is less then value in this option. Set to 0 to disable. (default: 0) + */ + breakpoint?: number; + /** + * Same as centerArea option, just for breakpoint. Can be changed dynamically via `sliderInstance.st.breakpointCenterArea`. (default: 0.8) + */ + breakpointCenterArea?: number; + } export interface RoyalSliderOptions { /** @@ -304,6 +356,133 @@ declare module RoyalSlider { * To add video to slide, you need to add data-rsVideo="" attribute to image. It can contain link to YouTube or Vimeo video. */ video?: RoyalSliderVideoOptions; + /** + * All elements inside slide that have class rsABlock will be treated by slider as animated blocks (tag name doesn't matter). Blocks can not be nested, but you can put multiple instances of them into one slide, or make slide itself animated block. + */ + block?: RoyalSliderBlockOptions; + /** + * Module "reveals" next and previous slides, like in this template. + */ + visibleNearby?: RoyalSliderVisibleOptions; + } + + export interface RoyalSlider { //TODO: extends/implements JQuery? (giving problems due to next(), prev(), width and height and 'selector'. + /** + * go to slide with id + */ + goTo(id: number): void; + /** + * next slide + */ + next(): void; + /** + * prev slide + */ + prev(): void; + /** + * removes all events and clears all slider data (use on ajax sites to avoid memory leaks) + */ + destroy(): void; + /** + * Dynamic slides adding/removing + */ + appendSlide(element: JQuery, index?: number): void; + /** + * Remove slide + */ + removeSlide(index?: number): void; + /** + * updates size of slider. Use after you resize slider with js. + */ + updateSliderSize(forceResize?: boolean): void; + /** + * changes orientation of thumbnails + */ + setThumbsOrientation(orientation: string): void; + /** + * updates size of thumbnails + */ + updateThumbsSize(): void; + /** + * Enter Fullscreen mode + */ + enterFullscreen(): void; + /** + * Exit Fullscreen mode + */ + exitFullscreen(): void; + /** + * Start autoplay + */ + startAutoPlay(): void; + /** + * Stop autoplay + */ + stopAutoPlay(): void; + /** + * Toggle autoplay between start and stop + */ + toggleAutoPlay(): void; + /** + * Toggle video between start and stop + */ + toggleVideo(): void; + /** + * Play video + */ + playVideo(): void; + /** + * Stop video + */ + stopVideo(): void; + /** + * current slide index + */ + currSlideId: number; + /** + * current slide object + */ + currSlide: JQuery; + /** + * total number of slides + */ + numSlides: number; + /** + * indicates if slider is in fullscreen mode + */ + isFullscreen: boolean; + /** + * indicates if browser supports native fullscreen + */ + nativeFS: boolean; + /** + * width of slider + */ + width: number; + /** + * height of slider + */ + height: number; + /** + * Boolean, changes on mouseup, indicates if slide was dragged. Used to check if event is drag or click. + */ + dragSuccess: boolean; + /** + * contains all data about each slide + */ + slides: any[]; //TODO: what type? + /** + * Contains list of HTML slides that are added to slider + */ + slidesJQ: JQuery[]; //TODO: what type? + /** + * Object with slider settings + */ + st: RoyalSliderOptions; + /** + * jQuery object with slider events + */ + ev: JQuery; } } @@ -313,5 +492,5 @@ interface JQuery { * * @param options The options */ - royalSlider(options?: RoyalSlider.RoyalSliderOptions): JQuery; + royalSlider(options?: RoyalSlider.RoyalSliderOptions): RoyalSlider.RoyalSlider; } \ No newline at end of file From b8baf38823973b75bdf2a02a1b4d9cc2f0418ee2 Mon Sep 17 00:00:00 2001 From: Karthikeyan VJ Date: Fri, 19 Jul 2013 01:58:02 +0300 Subject: [PATCH 100/756] update setMute and getMute for createjs.Sound createjs.Sound.setMute http://www.createjs.com/Docs/SoundJS/files/.._src_soundjs_Sound.js.html#l1151 createjs.Sound.getMute() http://www.createjs.com/Docs/SoundJS/files/.._src_soundjs_Sound.js.html#l1180 --- soundjs/soundjs.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/soundjs/soundjs.d.ts b/soundjs/soundjs.d.ts index 24eeb01395..c083dcc65c 100644 --- a/soundjs/soundjs.d.ts +++ b/soundjs/soundjs.d.ts @@ -168,7 +168,7 @@ declare module createjs { static getCapabilities(): Object; static getCapability(key: string): any; //HERE can return string | number | bool static getInstanceById(uniqueId: string): SoundInstance; - static getMute(): number; + static getMute(): bool; static getMasterVolume(): number; static getSrcFromId(value: string): string; static getVolume(): number; @@ -181,7 +181,7 @@ declare module createjs { static registerManifest(manifest: Array); static resume(id: string): void; static setMasterVolume(value: number): bool; - static setMute(isMuted: bool, id: string): bool; + static setMute(isMuted: bool): bool; static setVolume(value: number, id?: string): bool; static stop(): bool; From d9ebddeae241b95e713ebb7501a5e43a8a38d847 Mon Sep 17 00:00:00 2001 From: vvakame Date: Fri, 19 Jul 2013 11:55:45 +0900 Subject: [PATCH 101/756] Added definition for Firefox Web API --- README.md | 1 + firefox/firefox-test.ts | 28 ++++++++++++++++++++++++++++ firefox/firefox.d.ts | 39 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 firefox/firefox-test.ts create mode 100644 firefox/firefox.d.ts diff --git a/README.md b/README.md index 5176fe729c..64740d3206 100755 --- a/README.md +++ b/README.md @@ -60,6 +60,7 @@ List of Definitions * [File API: Writer](http://www.w3.org/TR/file-writer-api/) (by [Kon](http://phyzkit.net/)) * [Finite State Machine](https://github.com/jakesgordon/javascript-state-machine) (by [Boris Yankov](https://github.com/borisyankov)) * [Firebase](https://www.firebase.com/docs/javascript/firebase) (by [Vincent Bortone](https://github.com/vbortone)) +* [Firefox](https://developer.mozilla.org/en-US/docs/Web/API) (by [vvakame](https://github.com/vvakame)) * [FlexSlider](http://www.woothemes.com/flexslider/) (by [Diullei Gomes](https://github.com/Diullei)) * [Foundation](http://foundation.zurb.com/) (by [Boris Yankov](https://github.com/borisyankov)) * [FPSMeter](http://darsa.in/fpsmeter/) (by [Aaron Lampros](https://github.com/alampros)) diff --git a/firefox/firefox-test.ts b/firefox/firefox-test.ts new file mode 100644 index 0000000000..30f7d7493c --- /dev/null +++ b/firefox/firefox-test.ts @@ -0,0 +1,28 @@ +/// + +var manifestUrl = window.location.protocol + "//" + window.location.host + "/manifest.webapp"; + +var log = (data:any) => { + alert(data); +}; + +var setupCallback = (src:string, request:DOMRequest) => { + request.onsuccess = (data)=> { + if (request.result && request.result.manifest) { + log('app is installed ' + request.result.manifest.name + " by " + src); + } else if (request.result) { + // bug 806597. https://bugzilla.mozilla.org/show_bug.cgi?id=806597 + log("app is installed by " + src); + } else { + log("app is not installed by " + src); + } + }; + request.onerror = ()=> { + log('failed, error: ' + request.error.name + " by " + src); + }; +}; + +var apps = navigator.mozApps; +setupCallback("install", apps.install(manifestUrl)); +setupCallback("checkInstalled", apps.checkInstalled(manifestUrl)); +setupCallback("getSelf", apps.getSelf()); diff --git a/firefox/firefox.d.ts b/firefox/firefox.d.ts new file mode 100644 index 0000000000..dd052f1a8f --- /dev/null +++ b/firefox/firefox.d.ts @@ -0,0 +1,39 @@ +// Type definitions for Mozilla Web API +// Project: https://developer.mozilla.org/en-US/docs/Web/API +// Definitions by: vvakame +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +// required lib.d.ts + +// expand Navigator definietion. +interface Navigator { + mozApps:Apps; +} + +interface Apps { + install(url:string, receipts?:any[]):DOMRequest; + getSelf():DOMRequest; + getInstalled():DOMRequest; + checkInstalled(url:string): DOMRequest; +} + +interface DOMRequest { + onsuccess: Function; + onerror: Function; + readyState:string; // "done" or "pending" + result:T; + error:DOMError; +} + +interface App { + manifest:any; + manifestURL:string; + origin:string; + installOrigin:string; + installTime:number; + receipts:any[]; + + launch(); + checkForUpdate():DOMRequest; +} + From 274667b7604faca2eb94e56d798863ed70920fea Mon Sep 17 00:00:00 2001 From: Diullei Gomes Date: Fri, 19 Jul 2013 12:11:20 -0300 Subject: [PATCH 102/756] bug fix - node test --- node/node.d.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/node/node.d.ts b/node/node.d.ts index 96fa847e10..dfcbee7b79 100644 --- a/node/node.d.ts +++ b/node/node.d.ts @@ -1019,8 +1019,8 @@ declare module "util" { } declare module "assert" { - export function internal (booleanValue: boolean, message?: string): void; - export module internal { + function internal (booleanValue: boolean, message?: string): void; + module internal { export function fail(actual: any, expected: any, message: string, operator: string): void; export function assert(value: any, message: string): void; export function ok(value: any, message?: string): void; @@ -1034,6 +1034,8 @@ declare module "assert" { export function doesNotThrow(block: any, error?: any, messsage?: string): void; export function ifError(value: any): void; } + + export = internal; } declare module "tty" { From 5031efe99918926d45d77e3905c3a7718e29e24b Mon Sep 17 00:00:00 2001 From: basarat Date: Sat, 20 Jul 2013 23:11:52 +1000 Subject: [PATCH 103/756] http://raphaeljs.com/reference.html#Raphael.getColor fixed invalid typescript http://raphaeljs.com/reference.html#Raphael.getColor --- raphael/raphael.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/raphael/raphael.d.ts b/raphael/raphael.d.ts index 26a183d2d1..5deac9d138 100644 --- a/raphael/raphael.d.ts +++ b/raphael/raphael.d.ts @@ -244,7 +244,7 @@ interface RaphaelStatic { fn: any; format(token: string, ...parameters: any[]): string; fullfill(token: string, json: JSON): string; - getColor { + getColor:{ (value?: number): string; reset(); }; From 8439d657c13aed3215c32083e620723de06c70fa Mon Sep 17 00:00:00 2001 From: Theodore Brown Date: Sun, 21 Jul 2013 11:23:38 -0500 Subject: [PATCH 104/756] bool -> boolean in jquery.cookie --- jquery.cookie/jquery.cookie-tests.ts | 2 +- jquery.cookie/jquery.cookie.d.ts | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/jquery.cookie/jquery.cookie-tests.ts b/jquery.cookie/jquery.cookie-tests.ts index 6bf057757d..69a8c04120 100644 --- a/jquery.cookie/jquery.cookie-tests.ts +++ b/jquery.cookie/jquery.cookie-tests.ts @@ -15,7 +15,7 @@ class CookieOptions implements JQueryCookieOptions { expires: number; path: string; domain: string; - secure: bool; + secure: boolean; } $.cookie("the_cookie", "the_value"); diff --git a/jquery.cookie/jquery.cookie.d.ts b/jquery.cookie/jquery.cookie.d.ts index 3c5f051924..0fc82d8460 100644 --- a/jquery.cookie/jquery.cookie.d.ts +++ b/jquery.cookie/jquery.cookie.d.ts @@ -10,12 +10,12 @@ interface JQueryCookieOptions { expires?: any; path?: string; domain?: string; - secure?: bool; + secure?: boolean; } interface JQueryCookieStatic { - raw?: bool; - json?: bool; + raw?: boolean; + json?: boolean; (name: string): any; (name: string, value: string): void; @@ -27,6 +27,6 @@ interface JQueryCookieStatic { interface JQueryStatic { cookie?: JQueryCookieStatic; - removeCookie(name: string): bool; - removeCookie(name: string, options: JQueryCookieOptions): bool; + removeCookie(name: string): boolean; + removeCookie(name: string, options: JQueryCookieOptions): boolean; } \ No newline at end of file From 4c5af1c3fa16e55b3d79c411e8cfe77fc0c0a230 Mon Sep 17 00:00:00 2001 From: Theodore Brown Date: Sun, 21 Jul 2013 11:28:25 -0500 Subject: [PATCH 105/756] bool -> boolean in spin.js --- spin/spin.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spin/spin.d.ts b/spin/spin.d.ts index f48adbb5ef..becf2f58e3 100644 --- a/spin/spin.d.ts +++ b/spin/spin.d.ts @@ -15,8 +15,8 @@ interface SpinnerOptions { color?: string; // #rgb or #rrggbb speed?: number; // Rounds per second trail?: number; // Afterglow percentage - shadow?: bool; // Whether to render a shadow - hwaccel?: bool; // Whether to use hardware acceleration + shadow?: boolean; // Whether to render a shadow + hwaccel?: boolean; // Whether to use hardware acceleration className?: string; // The CSS class to assign to the spinner zIndex?: number; // The z-index (defaults to 2000000000) top?: string; // Top position relative to parent in px @@ -30,4 +30,4 @@ declare class Spinner { stop(); lines(el, o); opacity(el, i, val); -} +} From fb2e396858135e589311be7a1c796ce5f8ae225f Mon Sep 17 00:00:00 2001 From: Utkarsh Upadhyay Date: Sun, 21 Jul 2013 21:45:19 +0200 Subject: [PATCH 106/756] Fix issue #668. Change the spellings of Types/docs to American English. --- d3/d3.d.ts | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/d3/d3.d.ts b/d3/d3.d.ts index b12dc01c1c..07409eeee4 100644 --- a/d3/d3.d.ts +++ b/d3/d3.d.ts @@ -58,9 +58,9 @@ declare module D3 { export interface Base extends Selectors { /** - * Create a behaviour + * Create a behavior */ - behavior: Behaviour.Behavior; + behavior: Behavior.Behavior; /** * Access the current user event for interaction */ @@ -167,7 +167,7 @@ declare module D3 { /** * Randomize the order of an array. * - * @param arr Array to randomise + * @param arr Array to randomize */ shuffle(arr: T[]): T[]; /** @@ -344,15 +344,15 @@ declare module D3 { */ interpolateString: Transition.BaseInterpolate; /* - * Interpolate two RGB colours + * Interpolate two RGB colors */ interpolateRgb: Transition.BaseInterpolate; /* - * Interpolate two HSL colours + * Interpolate two HSL colors */ interpolateHsl: Transition.BaseInterpolate; /* - * Interpolate two HCL colours + * Interpolate two HCL colors */ interpolateHcl: Transition.BaseInterpolate; /* @@ -1366,7 +1366,7 @@ declare module D3 { } } - // Colour + // Color export module Color { export interface Color { /** From d559a14e790dc586e5e7f42ec4814d6763ee4177 Mon Sep 17 00:00:00 2001 From: vvakame Date: Mon, 22 Jul 2013 12:29:57 +0900 Subject: [PATCH 107/756] Renamed firefox-test.ts to firefox-tests.ts --- firefox/{firefox-test.ts => firefox-tests.ts} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename firefox/{firefox-test.ts => firefox-tests.ts} (100%) diff --git a/firefox/firefox-test.ts b/firefox/firefox-tests.ts similarity index 100% rename from firefox/firefox-test.ts rename to firefox/firefox-tests.ts From 661adf0b644f664f8a67f0ac98c2d7319060c5ec Mon Sep 17 00:00:00 2001 From: jfoliveira Date: Mon, 22 Jul 2013 14:47:40 +0100 Subject: [PATCH 108/756] Added getSubscriptionsCount function to KnockoutComputedFunctions This function was missing and is expected to be available to all KnockoutComputer objects, as stated in the docs: http://knockoutjs.com/documentation/computedObservables.html#computed_observable_reference --- knockout/knockout.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/knockout/knockout.d.ts b/knockout/knockout.d.ts index 0beebeb3e8..d468790186 100644 --- a/knockout/knockout.d.ts +++ b/knockout/knockout.d.ts @@ -15,6 +15,7 @@ interface KnockoutSubscribableFunctions { interface KnockoutComputedFunctions extends KnockoutSubscribableFunctions { getDependenciesCount(): number; + getSubscriptionsCount(): number; hasWriteFunction(): boolean; } From b0f8d750357796128feb0a06ddf48c59d21c03f5 Mon Sep 17 00:00:00 2001 From: Diullei Gomes Date: Mon, 22 Jul 2013 12:28:19 -0300 Subject: [PATCH 109/756] bug fix - d3 --- d3/d3.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/d3/d3.d.ts b/d3/d3.d.ts index 07409eeee4..67dca5fec1 100644 --- a/d3/d3.d.ts +++ b/d3/d3.d.ts @@ -2585,7 +2585,7 @@ declare module D3 { } // Behaviour - export module Behaviour { + export module Behavior { export interface Behavior{ /** * Constructs a new drag behaviour From 1a32cce3e01583fb5761aa014a0ac524387f60b9 Mon Sep 17 00:00:00 2001 From: James Hudon Date: Tue, 23 Jul 2013 23:13:45 -0400 Subject: [PATCH 110/756] AngularJS: give an interface to $http callback functions - add IHttpPromiseCallback for both `error` and `success` promise calls use case is if we're passing around the callback, we don't want to be repeating that entire function declaration every time, and we cannot use `Function` as that doesn't satisfy the compiler. (see test case) --- angularjs/angular-tests.ts | 14 ++++++++++++++ angularjs/angular.d.ts | 8 ++++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/angularjs/angular-tests.ts b/angularjs/angular-tests.ts index 3ea1371f48..eab0d60817 100644 --- a/angularjs/angular-tests.ts +++ b/angularjs/angular-tests.ts @@ -137,6 +137,20 @@ module HttpAndRegularPromiseTests { $scope.letters = letters; }); } + + // Test that we can pass around a type-checked success/error Promise Callback + var anotherController: Function = ($scope: SomeControllerScope, $http: + ng.IHttpService, $q: ng.IQService) => { + + var buildFooData: Function = () => 42; + + var doFoo: Function = (callback: ng.IHttpPromiseCallback) => { + $http.get('/foo', buildFooData()) + .success(callback); + } + + doFoo((data) => console.log(data)); + } } // Test for AngularJS Syntac diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 22f4cbf724..3eda659e83 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -531,6 +531,10 @@ declare module ng { transformResponse?: any; } + interface IHttpPromiseCallback { + (data: any, status: number, headers: (headerName: string) => string, config: IRequestConfig): any; + } + interface IHttpPromiseCallbackArg { data?: any; status?: number; @@ -539,8 +543,8 @@ declare module ng { } interface IHttpPromise extends IPromise { - success(callback: (data: any, status: number, headers: (headerName: string) => string, config: IRequestConfig) => any): IHttpPromise; - error(callback: (data: any, status: number, headers: (headerName: string) => string, config: IRequestConfig) => any): IHttpPromise; + success(callback: IHttpPromiseCallback): IHttpPromise; + error(callback: IHttpPromiseCallback): IHttpPromise; then(successCallback: (response: IHttpPromiseCallbackArg) => any, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; } From 0d35893c08c1b45a8afee2d635f7613ca9e79222 Mon Sep 17 00:00:00 2001 From: jraymakers Date: Thu, 25 Jul 2013 22:56:10 -0700 Subject: [PATCH 111/756] Replace bool with boolean in angular --- angularjs/angular-resource.d.ts | 2 +- angularjs/angular.d.ts | 70 ++++++++++++++++----------------- 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/angularjs/angular-resource.d.ts b/angularjs/angular-resource.d.ts index 37b491d742..c66bb341d1 100644 --- a/angularjs/angular-resource.d.ts +++ b/angularjs/angular-resource.d.ts @@ -28,7 +28,7 @@ declare module ng.resource { // Just a reference to facilitate describing new actions interface IActionDescriptor { method: string; - isArray?: bool; + isArray?: boolean; params?: any; headers?: any; } diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 3eda659e83..d9c948a156 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -29,21 +29,21 @@ declare module ng { bootstrap(element: Element, modules?: any[]): auto.IInjectorService; copy(source: any, destination?: any): any; element: JQueryStatic; - equals(value1: any, value2: any): bool; + equals(value1: any, value2: any): boolean; extend(destination: any, ...sources: any[]): any; forEach(obj: any, iterator: (value, key) => any, context?: any): any; fromJson(json: string): any; identity(arg?: any): any; injector(modules?: any[]): auto.IInjectorService; - isArray(value: any): bool; - isDate(value: any): bool; - isDefined(value: any): bool; - isElement(value: any): bool; - isFunction(value: any): bool; - isNumber(value: any): bool; - isObject(value: any): bool; - isString(value: any): bool; - isUndefined(value: any): bool; + isArray(value: any): boolean; + isDate(value: any): boolean; + isDefined(value: any): boolean; + isElement(value: any): boolean; + isFunction(value: any): boolean; + isNumber(value: any): boolean; + isObject(value: any): boolean; + isString(value: any): boolean; + isUndefined(value: any): boolean; lowercase(str: string): string; /** construct your angular application official docs: Interface for configuring angular modules. @@ -56,7 +56,7 @@ declare module ng { requires?: string[], configFunction?: any): IModule; noop(...args: any[]): void; - toJson(obj: any, pretty?: bool): string; + toJson(obj: any, pretty?: boolean): string; uppercase(str: string): string; version: { full: string; @@ -128,10 +128,10 @@ declare module ng { // see http://docs.angularjs.org/api/ng.directive:form.FormController /////////////////////////////////////////////////////////////////////////// interface IFormController { - $pristine: bool; - $dirty: bool; - $valid: bool; - $invalid: bool; + $pristine: boolean; + $dirty: boolean; + $valid: boolean; + $invalid: boolean; $error: any; } @@ -141,7 +141,7 @@ declare module ng { /////////////////////////////////////////////////////////////////////////// interface INgModelController { $render(): void; - $setValidity(validationErrorKey: string, isValid: bool): void; + $setValidity(validationErrorKey: string, isValid: boolean): void; $setViewValue(value: string): void; // XXX Not sure about the types here. Documentation states it's a string, but @@ -155,10 +155,10 @@ declare module ng { $parsers: IModelParser[]; $formatters: IModelFormatter[]; $error: any; - $pristine: bool; - $dirty: bool; - $valid: bool; - $invalid: bool; + $pristine: boolean; + $dirty: boolean; + $valid: boolean; + $invalid: boolean; } interface IModelParser { @@ -192,14 +192,14 @@ declare module ng { $evalAsync(expression: (scope: IScope) => any): void; // Defaults to false by the implementation checking strategy - $new(isolate?: bool): IScope; + $new(isolate?: boolean): IScope; $on(name: string, listener: (event: IAngularEvent, ...args: any[]) => any): Function; - $watch(watchExpression: string, listener?: string, objectEquality?: bool): Function; - $watch(watchExpression: string, listener?: (newValue: any, oldValue: any, scope: IScope) => any, objectEquality?: bool): Function; - $watch(watchExpression: (scope: IScope) => any, listener?: string, objectEquality?: bool): Function; - $watch(watchExpression: (scope: IScope) => any, listener?: (newValue: any, oldValue: any, scope: IScope) => any, objectEquality?: bool): Function; + $watch(watchExpression: string, listener?: string, objectEquality?: boolean): Function; + $watch(watchExpression: string, listener?: (newValue: any, oldValue: any, scope: IScope) => any, objectEquality?: boolean): Function; + $watch(watchExpression: (scope: IScope) => any, listener?: string, objectEquality?: boolean): Function; + $watch(watchExpression: (scope: IScope) => any, listener?: (newValue: any, oldValue: any, scope: IScope) => any, objectEquality?: boolean): Function; $parent: IScope; @@ -211,7 +211,7 @@ declare module ng { currentScope: IScope; name: string; preventDefault: Function; - defaultPrevented: bool; + defaultPrevented: boolean; // Available only events that were $emit-ted stopPropagation?: Function; @@ -234,8 +234,8 @@ declare module ng { // see http://docs.angularjs.org/api/ng.$timeout /////////////////////////////////////////////////////////////////////////// interface ITimeoutService { - (func: Function, delay?: number, invokeApply?: bool): IPromise; - cancel(promise: IPromise): bool; + (func: Function, delay?: number, invokeApply?: boolean): IPromise; + cancel(promise: IPromise): boolean; } /////////////////////////////////////////////////////////////////////////// @@ -360,12 +360,12 @@ declare module ng { interface ILocationProvider extends IServiceProvider { hashPrefix(): string; hashPrefix(prefix: string): ILocationProvider; - html5Mode(): bool; + html5Mode(): boolean; // Documentation states that parameter is string, but // implementation tests it as boolean, which makes more sense // since this is a toggler - html5Mode(active: bool): ILocationProvider; + html5Mode(active: boolean): ILocationProvider; } /////////////////////////////////////////////////////////////////////////// @@ -523,7 +523,7 @@ declare module ng { cache?: any; timeout?: number; - withCredentials?: bool; + withCredentials?: boolean; // These accept multiple types, so let's defile them as any data?: any; @@ -560,7 +560,7 @@ declare module ng { /////////////////////////////////////////////////////////////////////////// interface IHttpBackendService { // XXX Perhaps define callback signature in the future - (method: string, url: string, post?: any, callback?: Function, headers?: any, timeout?: number, withCredentials?: bool): void; + (method: string, url: string, post?: any, callback?: Function, headers?: any, timeout?: number, withCredentials?: boolean): void; } /////////////////////////////////////////////////////////////////////////// @@ -569,7 +569,7 @@ declare module ng { // see http://docs.angularjs.org/api/ng.$interpolateProvider /////////////////////////////////////////////////////////////////////////// interface IInterpolateService { - (text: string, mustHaveExpression?: bool): IInterpolationFunction; + (text: string, mustHaveExpression?: boolean): IInterpolationFunction; endSymbol(): string; startSymbol(): string; } @@ -624,7 +624,7 @@ declare module ng { templateUrl?: string; resolve?: any; redirectTo?: any; - reloadOnSearch?: bool; + reloadOnSearch?: boolean; } // see http://docs.angularjs.org/api/ng.$route#current @@ -650,7 +650,7 @@ declare module ng { priority?: number; template?: string; templateUrl?: string; - replace?: bool; + replace?: boolean; transclude?: any; restrict?: string; scope?: any; From 299381fb0d5d47de3838623effc5e4a1928835bd Mon Sep 17 00:00:00 2001 From: Christiaan Rakowski Date: Fri, 26 Jul 2013 17:07:33 +0200 Subject: [PATCH 112/756] fixed typo --- royalslider/royalslider-tests.ts | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/royalslider/royalslider-tests.ts b/royalslider/royalslider-tests.ts index 8a5e2dcd61..03294c4642 100644 --- a/royalslider/royalslider-tests.ts +++ b/royalslider/royalslider-tests.ts @@ -8,14 +8,16 @@ $(".royalSlider").royalSlider({ keyboardNavEnabled: true }); -$(".royalSlider").royalSlider({ - // general options go gere - autoScaleSlider: true, - thumbs: { - // thumbnails options go gere - spacing: 10, - arrowsAutoHide: true - } +jQuery(document).ready(function ($) { + $(".royalSlider").royalSlider({ + // general options go gere + autoScaleSlider: true, + thumbs: { + // thumbnails options go gere + spacing: 10, + arrowsAutoHide: true + } + }); }); jQuery(document).ready(function ($) { @@ -186,7 +188,7 @@ slider.ev.on('rsDragRelease', function () { slider.ev.on('rsBeforeDestroy', function () { // triggers before slider in destroyed }); -slider.ev.on('rsOnCreateVideoElement', function (e, url)) { +slider.ev.on('rsOnCreateVideoElement', function (e, url) { // triggers before video element is created, after click on play button. // Read more in Tips&Tricks section }); From 512ccaba0aa353d00180aa0091381ce3049b5ba2 Mon Sep 17 00:00:00 2001 From: Brian Surowiec Date: Fri, 26 Jul 2013 23:56:39 -0400 Subject: [PATCH 113/756] Angular JS: adding debug() to the log service --- angularjs/angular.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index d9c948a156..989c6d48d2 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -305,6 +305,7 @@ declare module ng { // see http://docs.angularjs.org/api/ng.$log /////////////////////////////////////////////////////////////////////////// interface ILogService { + debug: ILogCall; error: ILogCall; info: ILogCall; log: ILogCall; From 4c85dad3e038b228338c4de92af0398128f74a27 Mon Sep 17 00:00:00 2001 From: skideh Date: Fri, 26 Jul 2013 23:58:05 -0600 Subject: [PATCH 114/756] Added ko.unwrap shortcut Detailed in release notes for 2.3.0 https://github.com/knockout/knockout/releases/tag/v2.3.0 There is a shortcut for ko.utils.unwrapObservable, now a much nicer cleaner ko.unwrap --- knockout/knockout.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/knockout/knockout.d.ts b/knockout/knockout.d.ts index d468790186..ccee80d93b 100644 --- a/knockout/knockout.d.ts +++ b/knockout/knockout.d.ts @@ -402,6 +402,7 @@ interface KnockoutStatic { cleanNode(node: Element); renderTemplate(template: Function, viewModel: any, options?: any, target?: any, renderMode?: any); renderTemplate(template: string, viewModel: any, options?: any, target?: any, renderMode?: any); + unwrap(value: any): any; ////////////////////////////////// // templateSources.js From 5c92515db62d2cbf39e0cf80bd6f526b81c2b890 Mon Sep 17 00:00:00 2001 From: Christiaan Rakowski Date: Sat, 27 Jul 2013 15:56:31 +0200 Subject: [PATCH 115/756] Updated readme to add royalslider --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0bccaa28f0..2db6bb1c3c 100755 --- a/README.md +++ b/README.md @@ -152,6 +152,7 @@ List of Definitions * [PreloadJS](http://www.createjs.com/#!/PreloadJS) (by [Pedro Ferreira](https://bitbucket.org/drk4)) * [QUnit](http://qunitjs.com/) (by [Diullei Gomes](https://github.com/Diullei)) * [Restify](https://github.com/mcavage/node-restify) (by [Bret Little](https://github.com/blittle)) +* [Royalslider](http://dimsemenov.com/plugins/royal-slider/) (by [Christiaan Rakowski](https://github.com/csrakowski)) * [Rx.js](http://rx.codeplex.com/) (by [gsino](http://www.codeplex.com/site/users/view/gsino)) * [Raphael](http://raphaeljs.com/) (by [CheCoxshall](https://github.com/CheCoxshall)) * [Restangular](https://github.com/mgonto/restangular/) (by [Boris Yankov](https://github.com/borisyankov)) From 4ccd5709f3044e80017715ba9eedc59ace79fb76 Mon Sep 17 00:00:00 2001 From: jraymakers Date: Sat, 27 Jul 2013 15:47:36 -0700 Subject: [PATCH 116/756] fix jquery.ui.layout syntax errors --- jquery.ui.layout/jquery.ui.layout.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/jquery.ui.layout/jquery.ui.layout.d.ts b/jquery.ui.layout/jquery.ui.layout.d.ts index 80e71327c2..384fe01762 100644 --- a/jquery.ui.layout/jquery.ui.layout.d.ts +++ b/jquery.ui.layout/jquery.ui.layout.d.ts @@ -3,8 +3,8 @@ // Definitions by: Steve Fenton // Definitions: https://github.com/borisyankov/DefinitelyTyped -/// -/// +/// +/// interface JQueryLayoutOptions { north: any; From 552379df145aee86174dc702e76c71d78b5e4d0e Mon Sep 17 00:00:00 2001 From: jraymakers Date: Sat, 27 Jul 2013 16:23:37 -0700 Subject: [PATCH 117/756] fix AmCharts syntax errors --- amcharts/AmCharts.d.ts | 79 ++++++++++++++++++++---------------------- 1 file changed, 38 insertions(+), 41 deletions(-) diff --git a/amcharts/AmCharts.d.ts b/amcharts/AmCharts.d.ts index ca677da7a8..1efd46a618 100644 --- a/amcharts/AmCharts.d.ts +++ b/amcharts/AmCharts.d.ts @@ -1,5 +1,5 @@ /// AmCharts object (it's not a class) is create automatically when amcharts.js or amstock.js file is included in a web page. -declare module AmChartsStatic { +declare module AmCharts { /** Set it to true if you have base href set for your page. This will fix rendering problems in Firefox caused by base href. */ var baseHref: bool; @@ -31,7 +31,7 @@ declare module AmChartsStatic { chart.dataProvider = chartData; chart.write("chartdiv"); */ - declare class AmPieChart { + class AmPieChart { /** Name of the field in chart's dataProvider which holds slice's alpha. */ alphaField: string; /** Pie lean angle (for 3D effect). Valid range is 0 - 90. */ @@ -232,7 +232,7 @@ declare module AmChartsStatic { chart.write("chartdiv"); } */ - declare class AmRadarChart extends AmCoordinateChart { + class AmRadarChart extends AmCoordinateChart { /** Bottom margin of the chart. */ marginBottom: number; /** Left margin of the chart. */ @@ -290,7 +290,7 @@ declare module AmChartsStatic { chart.write("chartdiv); */ - declare class AmXYChart extends AmRectangularChart { + class AmXYChart extends AmRectangularChart { /** Specifies if Scrollbar of X axis (horizontal) should be hidden. */ hideXScrollbar: bool; /** Specifies if Scrollbar of Y axis (vertical) should be hidden. */ @@ -305,7 +305,7 @@ declare module AmChartsStatic { /** Guides are straight vertical or horizontal lines or areas supported by AmSerialChart, AmXYChart and AmRadarChart. You can have guides both on value and category axes. To add/remove a guide to an axis, use axis.addGuide(guide)/axis.removeGuide(guide) methods. If you do not set properties such as dashLength, lineAlpha, lineColor, etc - values of the axis are used.*/ - declare class Guide { + class Guide { /** Radar chart only. Specifies angle at which guide should start. Affects only fills, not lines. */ angle: number; /** Baloon fill color. */ @@ -348,7 +348,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val value: number; } /** ImagesSettings is a class which holds common settings of all MapImage objects. */ - declare class ImagesSettings { + class ImagesSettings { /** Opacity of the image. @default 1 */ @@ -402,7 +402,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** AreasSettings is a class which holds common settings of all MapArea objects. */ - declare class AreasSettings { + class AreasSettings { /** Opacity of areas. @default 1 */ @@ -454,7 +454,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** Slice is an item of AmPieChart's chartData Array and holds all the information about the slice. When working with a pie chart, you do not create slices or change it's properties directly, instead you set array of data using dataProvider property. Consider properties of a Slice read-only - change values in chart's data provider if you need to. */ - declare class Slice { + class Slice { /** Opacity of a slice. */ alpha: number; /** Color of a slice. */ @@ -481,7 +481,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val /** AmStockChart is a main class Stock chart. */ - declare class AmStockChart { + class AmStockChart { /** Specifies if animation was already played. Animation is only played once, when chart is rendered for the first time. If you want the animation to be repeated, set this property to false. */ animationPlayed: bool; /** Balloon object. */ @@ -613,7 +613,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** ValueAxesSettings settings set 's settings for all ValueAxes. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of ValueAxis class will be used. */ - declare class ValueAxesSettings { + class ValueAxesSettings { /** Specifies whether number for gridCount is specified automatically, according to the axis size. @default true */ @@ -684,7 +684,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val var legend = new AmCharts.AmLegend(); chart.addLegend(legend); */ - declare class AmLegend { + class AmLegend { /** Alignment of legend entries. Possible values are: "left", "center", "right". left */ align: string; @@ -822,7 +822,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val /** StockLegend is a legend of StockPanel. */ - declare class StockLegend extends AmLegend { + class StockLegend extends AmLegend { /** The text which will be displayed in the value portion of the legend when graph is comparable and at least one dataSet is selected for comparing. You can use tags like [[value]], [[open]], [[high]], [[low]], [[close]], [[percents.value/open/close/low/high]], [[description]]. [[percents.value]]% */ valueTextComparing: string; @@ -833,7 +833,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val /** StockPanel class creates stock panels (charts). AmStockChart can have multiple Stock panels. */ - declare class StockPanel extends AmSerialChart { + class StockPanel extends AmSerialChart { /** Specifies whether x button will be displayed near the panel. This button allows turning panel off. */ allowTurningOff: bool; /** If true, drawing icons will be displayed in top-right corner. */ @@ -879,7 +879,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** AmChart is a base class of all charts. It can not be instantiated explicitly. AmCoordinateChart, AmPieChart and AmMap extend AmChart class. */ - declare class AmChart { + class AmChart { /** Background color. You should set backgroundAlpha to >0 value in order background to be visible. We recommend setting background color directly on a chart's DIV instead of using this property. #FFFFFF */ backgroundColor: string; /** The chart creates AmBalloon class itself. If you want to customize balloon, get balloon instance using this property, and then change balloon's properties. AmBalloon */ @@ -988,7 +988,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val /** AmCoordinateChart is a base class of AmRectangularChart. It can not be instantiated explicitly. */ - declare class AmCoordinateChart extends AmChart { + class AmCoordinateChart extends AmChart { /** Specifies the colors of the graphs if the lineColor of a graph is not set. It there are more graphs then colors in this array, the chart picks random color. @default ['#FF6600', '#FCD202', '#B0DE09', '#0D8ECF', '#2A0CD0', '#CD0D74', '#CC0000', '#00CC00', '#0000CC', '#DDDDDD', '#999999', '#333333', '#990000'] */ @@ -1098,7 +1098,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** GraphDataItem holds all the information about the graph's data item. When working with a chart, you do not create GraphDataItem objects or change it's properties directly. GraphDataItem is passed to you by events when user interacts with data item on the chart. The list of properties below will help you to extract data item's value/coordinate/etc. */ - declare class GraphDataItem { + class GraphDataItem { /** Opacity of the data item. */ alpha: number; /** Bullet type. */ @@ -1132,7 +1132,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** SerialDataItem holds all the information about each series. When working with a chart, you do not create SerialDataItem objects or change it's properties directly. Consider properties of a SerialDataItem read-only - change values in chart's data provider if you need to. When serial chart parses dataProvider, it generates "chartData" array. Objects of this array are SerialDataItem objects. */ - declare class SerialDataItem { + class SerialDataItem { /** You can access each GraphDataItem using this object. The data structure is: graphDataItem = serialDataItem.axes[axisId].graphs[graphId]. */ axes: Object; @@ -1147,7 +1147,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val x: number; } - declare class CategoryAxis extends AxisBase { + class CategoryAxis extends AxisBase { /** When parse dates is on for the category axis, the chart will try to highlight the beginning of the periods, like month, in bold. Set this to false to disable the functionality. @default true @@ -1197,7 +1197,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val var chartScrollbar = new AmCharts.ChartScrollbar(); chart.addChartScrollbar(chartScrollbar); */ - declare class ChartScrollbar { + class ChartScrollbar { /** Specifies whether number of gridCount is specified automatically, acoarding to the axis size. */ autoGridCount: bool; /** Background opacity. @@ -1261,7 +1261,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** AmRectangularChart is a base class of AmSerialChart and AmXYChart. It can not be instantiated explicitly.*/ - declare class AmRectangularChart extends AmCoordinateChart { + class AmRectangularChart extends AmCoordinateChart { /** The angle of the 3D part of plot area. This creates a 3D effect (if the "depth3D" is > 0). */ angle: number; /** Space left from axis labels/title to the chart's outside border, if autoMargins set to true. @@ -1324,7 +1324,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val trendLine.lineColor = "#CC0000"; chart.addTrendLine(trendLine); */ - declare class TrendLine { + class TrendLine { } @@ -1334,7 +1334,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val var chartCursor = new AmCharts.ChartCursor(); chart.addChartCursor(chartCursor); */ - declare class ChartCursor { + class ChartCursor { /** Specifies if bullet for each graph will follow the cursor. */ bulletsEnabled: bool; /** Size of bullets, following the cursor. @@ -1431,7 +1431,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val chart.write("chartdiv"); */ - declare class AmSerialChart extends AmRectangularChart { + class AmSerialChart extends AmRectangularChart { /** Read-only. Chart creates category axis itself. If you want to change some properties, you should get this axis from the chart and set properties to this object. */ categoryAxis: CategoryAxis; /** Category field name tells the chart the name of the field in your dataProvider object which will be used for category axis values. */ @@ -1479,7 +1479,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val zoomToIndexes(start, end); } - declare class PeriodSelector { + class PeriodSelector { /** Date format of date input fields. Check [[http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/mx/formatters/DateFormatter.html DD-MM-YYYY */ dateFormat: string; /** Text displayed next to "from" date input field. From: */ @@ -1531,7 +1531,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val /** PanelsSettings settings set's settings for all StockPanels. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of StockPanel class will be used. */ - declare class PanelsSettings { + class PanelsSettings { /** The angle of the 3D part of plot area. This creates a 3D effect (if the "depth3D" is > 0). */ angle: number; /** Opacity of panel background. Possible values are 1 and 0. Values like 0.5 will not make it half-transparent. */ @@ -1590,7 +1590,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val /** DataSet is objects which holds all information about data. */ - declare class DataSet { + class DataSet { /** Category field name in your dataProvider. */ categoryField: string; /** Color of the data set. One of colors from AmStockChart.colors array will be used if not set. */ @@ -1615,7 +1615,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val title: string; } - declare class StockGraph extends AmGraph { + class StockGraph extends AmGraph { /** Specifies whether this graph will be compared if some data set is selected for comparing. */ comparable: bool; /** Specifies a field to be used to generate comparing graph. Note, this field is not the one used in your dataProvider, but toField from FieldMapping object. */ @@ -1655,7 +1655,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** StockEvent is object which holds information about event(bullet).Values from StockEventsSettings will be used if not set.Stock event bullet's size depends on it's graphs fontSize.When user rolls - over, clicks or rolls - out of the event bullet, AmStockChart dispatches events.*/ - declare class StockEvent { + class StockEvent { /** Opacity of bullet background. @default 1 */ @@ -1689,7 +1689,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** Common settings of legends. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of StockLegend class will be used. */ - declare class LegendSettings { + class LegendSettings { /** Alignment of legend entries. Possible values are: "left", "right" and "center". */ align: string; /** Specifies if each legend entry should take the same space as the longest legend entry. */ @@ -1744,7 +1744,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** DataSetSelector is a tool for selecting data set's as main and for comparing with main data set. */ - declare class DataSetSelector { + class DataSetSelector { /** Text displayed in the "compare to" combobox (when position is "top" or "bottom"). Select... */ comboBoxSelectText: string; /** Text displayed near "compare to" list. Compare to: */ @@ -1774,7 +1774,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val balloon.cornerRadius = 5; balloon.fillColor = "#FFFFFF"; */ - declare class AmBalloon { + class AmBalloon { /** If this is set to true, border color instead of background color will be changed when user rolls-over the slice, graph, etc. */ adjustBorderColor: bool; /** Balloon border opacity. Value range is 0 - 1. @@ -1830,7 +1830,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** CategoryAxesSettings settings set's settings common for all CategoryAxes of StockPanels. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of CategoryAxis class will be used. */ - declare class CategoryAxesSettings { + class CategoryAxesSettings { /** Specifies whether number of gridCount is specified automatically, according to the axis size. @default true */ @@ -1890,7 +1890,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** ChartCursorSettings settings set's settings for chart cursor. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of ChartCursor class will be used. */ - declare class ChartCursorSettings { + class ChartCursorSettings { /** Specifies if bullet for each graph will follow the cursor. */ bulletsEnabled: bool; /** Size of bullets, following the cursor. */ @@ -1922,7 +1922,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /* ChartScrollbarSettings settings set's settings for chart scrollbar. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of ChartScrollbar class will be used.*/ - declare class ChartScrollbarSettings { + class ChartScrollbarSettings { /** Specifies whether number of gridCount is specified automatically, according to the axis size. @default true */ @@ -1992,7 +1992,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val graph.fillAlphas = 1; chart.addGraph(graph); */ - declare class AmGraph { + class AmGraph { /** Name of the alpha field in your dataProvider. */ alphaField: string; /** Value balloon color. Will use graph or data item color if not set. */ @@ -2162,7 +2162,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** AxisBase is the base class for ValueAxis and CategoryAxis. It can not be instantiated explicitly. */ - declare class AxisBase { + class AxisBase { /** Specifies whether number of gridCount is specified automatically, acoarding to the axis size. @default true */ @@ -2249,7 +2249,7 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val } /** ValueAxis is the class which displays value axis for the chart. The chart can have any number of value axes. For Serial chart one value axis is created automatically. For XY Chart two value axes (horizontal and vertical) are created automatically. */ - declare class ValueAxis extends AxisBase { + class ValueAxis extends AxisBase { /** Radar chart only. Specifies distance from axis to the axis title (category) 10 */ axisTitleOffset: number; /** Read-only. Coordinate of the base value. */ @@ -2340,7 +2340,4 @@ If you do not set properties such as dashLength, lineAlpha, lineColor, etc - val /** Removes event listener from chart object. */ removeListener(chart: AmChart, type: string, handler: any); } -} - -/** AmCharts object (it's not a class) is create automatically when amcharts.js or amstock.js file is included in a web page. */ -var AmCharts: AmChartsStatic; \ No newline at end of file +} \ No newline at end of file From 2c2624f8b9d83064807f868fefcb413739127b74 Mon Sep 17 00:00:00 2001 From: jraymakers Date: Sat, 27 Jul 2013 18:22:02 -0700 Subject: [PATCH 118/756] fix ember syntax error --- ember/ember.d.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/ember/ember.d.ts b/ember/ember.d.ts index 3542b4723b..c3ada0db85 100644 --- a/ember/ember.d.ts +++ b/ember/ember.d.ts @@ -292,5 +292,4 @@ interface EmberStatic { wrap(func: Function, superFunc: Function); } -declare var Em: Ember; -//declare var Ember: EmberStatic; \ No newline at end of file +declare var Em: EmberStatic; \ No newline at end of file From 5ce7d2786a655d7f8c0b0eeab786eb0c826979ba Mon Sep 17 00:00:00 2001 From: jraymakers Date: Sat, 27 Jul 2013 18:28:08 -0700 Subject: [PATCH 119/756] fix spelling mistakes in test runner --- _infrastructure/tests/runner.js | 40 ++++++++++++++++----------------- _infrastructure/tests/runner.ts | 24 ++++++++++---------- 2 files changed, 32 insertions(+), 32 deletions(-) diff --git a/_infrastructure/tests/runner.js b/_infrastructure/tests/runner.js index 3b896c84f6..9874993544 100644 --- a/_infrastructure/tests/runner.js +++ b/_infrastructure/tests/runner.js @@ -655,8 +655,8 @@ var DefinitelyTyped; this.out(' \33[36m\33[1mTypeScript files :\33[0m ' + this.tsFiles + '\n'); }; - Print.prototype.printSyntaxCheking = function () { - this.out('============================ \33[34m\33[1mSyntax cheking\33[0m =================================\n'); + Print.prototype.printSyntaxChecking = function () { + this.out('============================ \33[34m\33[1mSyntax checking\33[0m ================================\n'); }; Print.prototype.printTypingTests = function () { @@ -745,14 +745,14 @@ var DefinitelyTyped; return File; })(); - var SyntaxCheking = (function () { - function SyntaxCheking(fielHandler, out) { - this.fielHandler = fielHandler; + var SyntaxChecking = (function () { + function SyntaxChecking(fileHandler, out) { + this.fileHandler = fileHandler; this.out = out; this.files = []; this.timer = new Timer(); } - SyntaxCheking.prototype.getFailedFiles = function () { + SyntaxChecking.prototype.getFailedFiles = function () { var list = []; for (var i = 0; i < this.files.length; i++) { @@ -764,7 +764,7 @@ var DefinitelyTyped; return list; }; - SyntaxCheking.prototype.getSuccessFiles = function () { + SyntaxChecking.prototype.getSuccessFiles = function () { var list = []; for (var i = 0; i < this.files.length; i++) { @@ -776,14 +776,14 @@ var DefinitelyTyped; return list; }; - SyntaxCheking.prototype.printStats = function () { + SyntaxChecking.prototype.printStats = function () { this.out.printDiv(); this.out.printElapsedTime(this.timer.asString, this.timer.time); this.out.printSuccessCount(this.getSuccessFiles().length, this.files.length); this.out.printFailedCount(this.getFailedFiles().length, this.files.length); }; - SyntaxCheking.prototype.printFailedFiles = function () { + SyntaxChecking.prototype.printFailedFiles = function () { if (this.getFailedFiles().length > 0) { this.out.printDiv(); @@ -793,12 +793,12 @@ var DefinitelyTyped; for (var i = 0; i < this.getFailedFiles().length; i++) { var errorFile = this.getFailedFiles()[i]; - this.out.printErrorFile(errorFile.formatName(this.fielHandler.path)); + this.out.printErrorFile(errorFile.formatName(this.fileHandler.path)); } } }; - SyntaxCheking.prototype.run = function (it, file, len, maxLen, callback) { + SyntaxChecking.prototype.run = function (it, file, len, maxLen, callback) { var _this = this; if (!endsWith(file.toUpperCase(), '-TESTS.TS') && file.indexOf('../_infrastructure') < 0) { new Test(file).run(function (o) { @@ -843,10 +843,10 @@ var DefinitelyTyped; } }; - SyntaxCheking.prototype.start = function (callback) { + SyntaxChecking.prototype.start = function (callback) { this.timer.start(); - var tsFiles = this.fielHandler.allTS(); + var tsFiles = this.fileHandler.allTS(); var it = new Iterator(tsFiles); @@ -857,12 +857,12 @@ var DefinitelyTyped; this.run(it, it.next(), len, maxLen, callback); } }; - return SyntaxCheking; + return SyntaxChecking; })(); var TestEval = (function () { - function TestEval(fielHandler, out) { - this.fielHandler = fielHandler; + function TestEval(fileHandler, out) { + this.fileHandler = fileHandler; this.out = out; this.files = []; this.timer = new Timer(); @@ -908,7 +908,7 @@ var DefinitelyTyped; for (var i = 0; i < this.getFailedFiles().length; i++) { var errorFile = this.getFailedFiles()[i]; - this.out.printErrorFile(errorFile.formatName(this.fielHandler.path)); + this.out.printErrorFile(errorFile.formatName(this.fileHandler.path)); } } }; @@ -961,7 +961,7 @@ var DefinitelyTyped; TestEval.prototype.start = function (callback) { this.timer.start(); - var tsFiles = this.fielHandler.allTS(); + var tsFiles = this.fileHandler.allTS(); var it = new Iterator(tsFiles); @@ -981,7 +981,7 @@ var DefinitelyTyped; this.typings = []; this.fh = new FileHandler(dtPath, /.\.ts/g); this.out = new Print('0.9.0.0', this.fh.allTypings().length, this.fh.allTS().length); - this.sc = new SyntaxCheking(this.fh, this.out); + this.sc = new SyntaxChecking(this.fh, this.out); this.te = new TestEval(this.fh, this.out); var tpgs = this.fh.allTypings(); @@ -1019,7 +1019,7 @@ var DefinitelyTyped; timer.start(); this.out.printHeader(); - this.out.printSyntaxCheking(); + this.out.printSyntaxChecking(); this.sc.start(function (syntaxFailedCount, syntaxTotal) { _this.out.printTypingTests(); diff --git a/_infrastructure/tests/runner.ts b/_infrastructure/tests/runner.ts index d6e58ff3bc..61d0f5b104 100644 --- a/_infrastructure/tests/runner.ts +++ b/_infrastructure/tests/runner.ts @@ -148,8 +148,8 @@ module DefinitelyTyped { this.out(' \33[36m\33[1mTypeScript files :\33[0m ' + this.tsFiles + '\n'); } - public printSyntaxCheking() { - this.out('============================ \33[34m\33[1mSyntax cheking\33[0m =================================\n'); + public printSyntaxChecking() { + this.out('============================ \33[34m\33[1mSyntax checking\33[0m ================================\n'); } public printTypingTests() { @@ -235,7 +235,7 @@ module DefinitelyTyped { } } - class SyntaxCheking { + class SyntaxChecking { private timer: Timer; @@ -265,7 +265,7 @@ module DefinitelyTyped { return list; } - constructor(public fielHandler: FileHandler, public out: Print) { + constructor(public fileHandler: FileHandler, public out: Print) { this.timer = new Timer(); } @@ -286,7 +286,7 @@ module DefinitelyTyped { for(var i = 0; i < this.getFailedFiles().length; i++) { var errorFile = this.getFailedFiles()[i]; - this.out.printErrorFile(errorFile.formatName(this.fielHandler.path)); + this.out.printErrorFile(errorFile.formatName(this.fileHandler.path)); } } } @@ -338,7 +338,7 @@ module DefinitelyTyped { public start(callback: Function) { this.timer.start(); - var tsFiles = this.fielHandler.allTS(); + var tsFiles = this.fileHandler.allTS(); var it = new Iterator(tsFiles); @@ -381,7 +381,7 @@ module DefinitelyTyped { return list; } - constructor(public fielHandler: FileHandler, public out: Print) { + constructor(public fileHandler: FileHandler, public out: Print) { this.timer = new Timer(); } @@ -402,7 +402,7 @@ module DefinitelyTyped { for(var i = 0; i < this.getFailedFiles().length; i++) { var errorFile = this.getFailedFiles()[i]; - this.out.printErrorFile(errorFile.formatName(this.fielHandler.path)); + this.out.printErrorFile(errorFile.formatName(this.fileHandler.path)); } } } @@ -454,7 +454,7 @@ module DefinitelyTyped { public start(callback: Function) { this.timer.start(); - var tsFiles = this.fielHandler.allTS(); + var tsFiles = this.fileHandler.allTS(); var it = new Iterator(tsFiles); @@ -470,7 +470,7 @@ module DefinitelyTyped { export class TestRunner { private fh: FileHandler; private out: Print; - private sc: SyntaxCheking; + private sc: SyntaxChecking; private te: TestEval; private typings: Typing[] = []; @@ -505,7 +505,7 @@ module DefinitelyTyped { constructor(public dtPath: string) { this.fh = new FileHandler(dtPath, /.\.ts/g); this.out = new Print('0.9.0.0', this.fh.allTypings().length, this.fh.allTS().length); - this.sc = new SyntaxCheking(this.fh, this.out); + this.sc = new SyntaxChecking(this.fh, this.out); this.te = new TestEval(this.fh, this.out); var tpgs = this.fh.allTypings(); @@ -519,7 +519,7 @@ module DefinitelyTyped { timer.start(); this.out.printHeader(); - this.out.printSyntaxCheking(); + this.out.printSyntaxChecking(); this.sc.start((syntaxFailedCount, syntaxTotal) => { this.out.printTypingTests(); From e915de957361149d9d786c69ba56155ec112a20b Mon Sep 17 00:00:00 2001 From: jraymakers Date: Sat, 27 Jul 2013 18:43:19 -0700 Subject: [PATCH 120/756] fix jquery.elang syntax errors --- jquery.elang/jquery.elang.d.ts | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/jquery.elang/jquery.elang.d.ts b/jquery.elang/jquery.elang.d.ts index f01a466cdd..606145d5ce 100644 --- a/jquery.elang/jquery.elang.d.ts +++ b/jquery.elang/jquery.elang.d.ts @@ -70,10 +70,10 @@ interface IELangDBDelegates { } interface IELangDBEvents { - select: JQueryDeferred; - insert: JQueryDeferred; - modify: JQueryDeferred; - remove: JQueryDeferred; + select: JQueryDeferred; + insert: JQueryDeferred; + modify: JQueryDeferred; + remove: JQueryDeferred; } interface IELangDB { @@ -176,7 +176,7 @@ interface IELangSearchDelegates { } interface IELangSearchEvents { - select: JQueryDeferred; + select: JQueryDeferred; } interface IELangSearch extends IELangBase { @@ -212,10 +212,10 @@ interface IELangEditDelegates { } interface IELangEditEvents { - insert: JQueryDeferred; - modify: JQueryDeferred; - remove: JQueryDeferred; - select: JQueryDeferred; + insert: JQueryDeferred; + modify: JQueryDeferred; + remove: JQueryDeferred; + select: JQueryDeferred; } interface IELangEditDefaults extends IELangBaseDefaults { From 401707e3b7602e6cd6cdaa4454523d909a0edd96 Mon Sep 17 00:00:00 2001 From: jraymakers Date: Sat, 27 Jul 2013 18:43:34 -0700 Subject: [PATCH 121/756] fix linq.jquery syntax error --- linq/linq.jquery.d.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/linq/linq.jquery.d.ts b/linq/linq.jquery.d.ts index c813bf0edb..896b53c5ae 100755 --- a/linq/linq.jquery.d.ts +++ b/linq/linq.jquery.d.ts @@ -3,6 +3,7 @@ // Definitions by: neuecc (http://www.codeplex.com/site/users/view/neuecc) /// +/// declare module linqjs { interface Enumerable { @@ -16,5 +17,5 @@ interface JQuery { } interface JQueryStatic { - Enumerable: linqjs.EnumerableStatic; + Enumerable: linq.EnumerableStatic; } From 9a1337949e73dfdd578f3f323675e7e82c7f5b42 Mon Sep 17 00:00:00 2001 From: jraymakers Date: Sat, 27 Jul 2013 21:31:33 -0700 Subject: [PATCH 122/756] fix node_redis syntax error --- node_redis/node_redis.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/node_redis/node_redis.d.ts b/node_redis/node_redis.d.ts index 74652ab332..bde231778c 100644 --- a/node_redis/node_redis.d.ts +++ b/node_redis/node_redis.d.ts @@ -20,7 +20,7 @@ declare module 'redis' { } interface Command { - (...args: any[]): Commands; + (...args: any[]): any; } interface Commands { From 53bb6e36ed7810234c83c25405a932ddc41203f9 Mon Sep 17 00:00:00 2001 From: jraymakers Date: Sat, 27 Jul 2013 21:33:10 -0700 Subject: [PATCH 123/756] fix teechart syntax error --- teechart/teechart.d.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/teechart/teechart.d.ts b/teechart/teechart.d.ts index 6e3a4424a2..87fb3dd7c5 100644 --- a/teechart/teechart.d.ts +++ b/teechart/teechart.d.ts @@ -177,7 +177,7 @@ declare module Tee { cursor: string; } - interface ISeries { + interface ISeriesNoBounds { data: ISeriesData; marks: IMarks; @@ -210,8 +210,6 @@ declare module Tee { associatedToAxis(axis: IAxis): bool; - bounds(rectangle: IRectangle): void; - calc(index: number, position: IPoint): void; clicked(position: IPoint): number; @@ -225,8 +223,10 @@ declare module Tee { count(): number; addRandom(count: number, range?: number, x?: bool): ISeries; + } - + interface ISeries extends ISeriesNoBounds { + bounds(rectangle: IRectangle): void; } interface IAxisLabels { @@ -504,7 +504,7 @@ declare module Tee { end: number[]; } - interface IGantt extends ISeries { + interface IGantt extends ISeriesNoBounds { data: IGanttData; dateFormat: string; colorEach: string; From 6adcf493b7ab2653021361282cce8946372dc829 Mon Sep 17 00:00:00 2001 From: jraymakers Date: Sat, 27 Jul 2013 21:33:49 -0700 Subject: [PATCH 124/756] fix underscore-ko syntax errors --- underscore-ko/underscore-ko.d.ts | 24 ++++++++++++------------ underscore/underscore.d.ts | 4 ++-- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/underscore-ko/underscore-ko.d.ts b/underscore-ko/underscore-ko.d.ts index c10b49d432..241a0db12d 100644 --- a/underscore-ko/underscore-ko.d.ts +++ b/underscore-ko/underscore-ko.d.ts @@ -8,18 +8,18 @@ interface KnockoutObservableArrayFunctions { - /**** - Collections - *****/ - each(iterator: ListIterator, context?: any): any[]; - each(iterator: ObjectIterator, context?: any): any[]; - forEach(iterator: ObjectIterator, context?: any): any[]; - forEach(iterator: ListIterator, context?: any): any[]; + /**** + Collections + *****/ + each(iterator: _.ListIterator, context?: any): any[]; + each(iterator: _.ObjectIterator, context?: any): any[]; + forEach(iterator: _.ObjectIterator, context?: any): any[]; + forEach(iterator: _.ListIterator, context?: any): any[]; - map(iterator: ListIterator, context?: any): any[]; - map(iterator: ObjectIterator, context?: any): any[]; - collect(iterator: ListIterator, context?: any): any[]; - collect(iterator: ObjectIterator, context?: any): any[]; + map(iterator: _.ListIterator, context?: any): any[]; + map(iterator: _.ObjectIterator, context?: any): any[]; + collect(iterator: _.ListIterator, context?: any): any[]; + collect(iterator: _.ObjectIterator, context?: any): any[]; reduce(iterator: any, memo: any, context?: any): any; inject(iterator: any, memo: any, context?: any): any; @@ -97,5 +97,5 @@ interface KnockoutObservableArrayFunctions { /**** Chaining *****/ - chain(object: any): UnderscoreWrappedObject; + chain(object: any): any; } diff --git a/underscore/underscore.d.ts b/underscore/underscore.d.ts index d0ad26e1b1..c42eeed034 100644 --- a/underscore/underscore.d.ts +++ b/underscore/underscore.d.ts @@ -14,11 +14,11 @@ declare module _ { escape?: RegExp; } - interface ListIterator { + export interface ListIterator { (value: T, index: number, list?: List): TResult; } - interface ObjectIterator { + export interface ObjectIterator { (element: T, key: string, list?: any): TResult; } From 9c09d6a0765a0fac993e9c945e0c82b031078258 Mon Sep 17 00:00:00 2001 From: Derik Whittaker Date: Sun, 28 Jul 2013 07:38:37 -0400 Subject: [PATCH 125/756] Definition file for Bootstrap Paginator https://github.com/lyonlai/bootstrap-paginator --- bootstrap.paginator/bootstrap.paginator.d.ts | 23 ++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 bootstrap.paginator/bootstrap.paginator.d.ts diff --git a/bootstrap.paginator/bootstrap.paginator.d.ts b/bootstrap.paginator/bootstrap.paginator.d.ts new file mode 100644 index 0000000000..fa530edd27 --- /dev/null +++ b/bootstrap.paginator/bootstrap.paginator.d.ts @@ -0,0 +1,23 @@ +/// + +interface PaginatorOptions{ + alignment?: string; + size?: string; + itemContainerClass?: (type, page, current) => string; + currentPage?: number; + numberOfPages?: number; + totalPages?: number; + pageUrl?: (type, page, current) => string; + shouldShowPage?: boolean; + itemText?: (type, page, current) => any; + tooltipTitles?: (type, page, current) => string; + useBootstrapTooltip?: boolean; + bootstrapTooltipOptions?: {}; + onPageClicked?: (event, originalEvent, type, page) => void; + onPageChanged?: (event, originalEvent, type, page) => void; +} + +interface JQuery { + bootstrapPaginator(): JQuery; + bootstrapPaginator(options: PaginatorOptions): JQuery; +} \ No newline at end of file From 515bb54d0bca98600f9a59a05aaee16c5c4b67b5 Mon Sep 17 00:00:00 2001 From: Brian Surowiec Date: Fri, 26 Jul 2013 23:56:39 -0400 Subject: [PATCH 126/756] Angular JS: adding debug() to the log service --- angularjs/angular.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index d9c948a156..989c6d48d2 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -305,6 +305,7 @@ declare module ng { // see http://docs.angularjs.org/api/ng.$log /////////////////////////////////////////////////////////////////////////// interface ILogService { + debug: ILogCall; error: ILogCall; info: ILogCall; log: ILogCall; From 1466df01910ea07cca1e6bf0050772a453196b32 Mon Sep 17 00:00:00 2001 From: skideh Date: Fri, 26 Jul 2013 23:58:05 -0600 Subject: [PATCH 127/756] Added ko.unwrap shortcut Detailed in release notes for 2.3.0 https://github.com/knockout/knockout/releases/tag/v2.3.0 There is a shortcut for ko.utils.unwrapObservable, now a much nicer cleaner ko.unwrap --- knockout/knockout.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/knockout/knockout.d.ts b/knockout/knockout.d.ts index d468790186..ccee80d93b 100644 --- a/knockout/knockout.d.ts +++ b/knockout/knockout.d.ts @@ -402,6 +402,7 @@ interface KnockoutStatic { cleanNode(node: Element); renderTemplate(template: Function, viewModel: any, options?: any, target?: any, renderMode?: any); renderTemplate(template: string, viewModel: any, options?: any, target?: any, renderMode?: any); + unwrap(value: any): any; ////////////////////////////////// // templateSources.js From 0044280813b9faef763f8b69fb24755d3564e70b Mon Sep 17 00:00:00 2001 From: Derik Whittaker Date: Sun, 28 Jul 2013 07:38:37 -0400 Subject: [PATCH 128/756] Definition file for Bootstrap Paginator https://github.com/lyonlai/bootstrap-paginator --- bootstrap.paginator/bootstrap.paginator.d.ts | 23 ++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 bootstrap.paginator/bootstrap.paginator.d.ts diff --git a/bootstrap.paginator/bootstrap.paginator.d.ts b/bootstrap.paginator/bootstrap.paginator.d.ts new file mode 100644 index 0000000000..fa530edd27 --- /dev/null +++ b/bootstrap.paginator/bootstrap.paginator.d.ts @@ -0,0 +1,23 @@ +/// + +interface PaginatorOptions{ + alignment?: string; + size?: string; + itemContainerClass?: (type, page, current) => string; + currentPage?: number; + numberOfPages?: number; + totalPages?: number; + pageUrl?: (type, page, current) => string; + shouldShowPage?: boolean; + itemText?: (type, page, current) => any; + tooltipTitles?: (type, page, current) => string; + useBootstrapTooltip?: boolean; + bootstrapTooltipOptions?: {}; + onPageClicked?: (event, originalEvent, type, page) => void; + onPageChanged?: (event, originalEvent, type, page) => void; +} + +interface JQuery { + bootstrapPaginator(): JQuery; + bootstrapPaginator(options: PaginatorOptions): JQuery; +} \ No newline at end of file From 1629acedfa238a28fb1d5572ca3b4c2ee010e7a6 Mon Sep 17 00:00:00 2001 From: Derek Cicerone Date: Sun, 28 Jul 2013 20:40:15 -0700 Subject: [PATCH 129/756] Fix more bool usage picked up by the 0.9.1 beta --- leaflet/leaflet.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/leaflet/leaflet.d.ts b/leaflet/leaflet.d.ts index 5d6825383c..1b1ddfe8b2 100644 --- a/leaflet/leaflet.d.ts +++ b/leaflet/leaflet.d.ts @@ -1538,7 +1538,7 @@ declare module L { /** * Function that will be used to decide whether to show a feature or not. */ - filter?: (featureData: any, layer: ILayer) => bool; + filter?: (featureData: any, layer: ILayer) => boolean; } @@ -2440,7 +2440,7 @@ declare module L { /** * Returns a function which always returns false. */ - static falseFn(): () => bool; + static falseFn(): () => boolean; /** * Returns the number num rounded to digits decimals. From 607c86a814e789d17b4d61211585e8b6710a56b4 Mon Sep 17 00:00:00 2001 From: Santi Albo Date: Mon, 29 Jul 2013 11:01:00 +0100 Subject: [PATCH 130/756] Fix withConfig return type in restangular `withConfig` method returns a new Restangular service, not a RestangularElement. https://github.com/mgonto/restangular#properties --- restangular/restangular.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/restangular/restangular.d.ts b/restangular/restangular.d.ts index 96a74fd1ee..b18b3c8e29 100644 --- a/restangular/restangular.d.ts +++ b/restangular/restangular.d.ts @@ -10,7 +10,7 @@ interface Restangular extends RestangularCustom { one(route: string, id?: number): RestangularElement; all(route: string): RestangularCollection; copy(fromElement: any): RestangularElement; - withConfig(configurer: any): RestangularElement; + withConfig(configurer: any): Restangular; } interface RestangularElement extends Restangular { @@ -67,4 +67,4 @@ interface RestangularProvider { } declare var Restangular: Restangular; -declare var RestangularProvider: RestangularProvider; \ No newline at end of file +declare var RestangularProvider: RestangularProvider; From 640c34cbf490356a51259da9ca11d85efa31a626 Mon Sep 17 00:00:00 2001 From: Derik Whittaker Date: Tue, 30 Jul 2013 06:01:05 -0400 Subject: [PATCH 131/756] Definition file for Bootstrap Timepicker --- .../bootstrap.timepicker.d.ts | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 bootstrap.timepicker/bootstrap.timepicker.d.ts diff --git a/bootstrap.timepicker/bootstrap.timepicker.d.ts b/bootstrap.timepicker/bootstrap.timepicker.d.ts new file mode 100644 index 0000000000..8685882762 --- /dev/null +++ b/bootstrap.timepicker/bootstrap.timepicker.d.ts @@ -0,0 +1,24 @@ + + +/// + +interface TimeickerOptions { + defaultTime?: string; + disableFocus?: boolean; + isOpen?: boolean; + minuteStep?: number; + modalBackdrop?: boolean; + secondStep?: number; + showSeconds?: boolean; + showInputs?: boolean; + showMeridian?: boolean; + template?: string; + appendWidgetTo?: string; +} + +interface JQuery { + timepicker(): JQuery; + timepicker(methodName: string): JQuery; + timepicker(methodName: string, params: any): JQuery; + timepicker(options: TimeickerOptions): JQuery; +} \ No newline at end of file From e96a9648180cbacb9fe5c79a2123a30ad166c780 Mon Sep 17 00:00:00 2001 From: codebelt Date: Tue, 30 Jul 2013 22:42:09 -0500 Subject: [PATCH 132/756] Updated for TypeScript 0.9.0 --- greensock/greensock.d.ts | 240 ++++++++++++++++++++------------------- 1 file changed, 125 insertions(+), 115 deletions(-) diff --git a/greensock/greensock.d.ts b/greensock/greensock.d.ts index df8958be4c..3cc3346af1 100644 --- a/greensock/greensock.d.ts +++ b/greensock/greensock.d.ts @@ -1,139 +1,160 @@ // GreenSock Animation Platform (GSAP) - http://www.greensock.com/get-started-js/ // JavaScript Docs http://api.greensock.com/js/ -// Version 1.0 +// Version 1.1 (TypeScript 0.9) + +interface IDispatcher { + addEventListener(type:string, callback:Function, scope:Object, useParam:boolean, priority:number):void; + removeEventListener(type:string, callback:Function):void; +} //com.greensock.core -interface Animation { +declare class Animation { data:any; - ticker:any; + static ticker:IDispatcher; timeline:SimpleTimeline; vars:Object; - Animation(duration:number, vars?:Object); + constructor(duration?:number, vars?:Object); + delay(value:number):any; duration(value:number):any; eventCallback(type:string, callback?:Function, params?:any[], scope?:any):any; invalidate():any; kill(vars?:Object, target?:Object):any; - pause(atTime?:any, suppressEvents?:bool):any; - paused(value?:bool):any; - play(from?:any, suppressEvents?:bool):any; - restart(includeDelay?:bool, suppressEvents?:bool):any; - resume(from?:any, suppressEvents?:bool):any; - reverse(from?:any, suppressEvents?:bool):any; - reversed(value?:bool):any; - seek(time:any, suppressEvents?:bool):any; + pause(atTime?:any, suppressEvents?:boolean):any; + paused(value?:boolean):any; + play(from?:any, suppressEvents?:boolean):any; + restart(includeDelay?:boolean, suppressEvents?:boolean):any; + resume(from?:any, suppressEvents?:boolean):any; + reverse(from?:any, suppressEvents?:boolean):any; + reversed(value?:boolean):any; + seek(time:any, suppressEvents?:boolean):any; startTime(value:number):any; - time(value:number, suppressEvents?:bool):any; + time(value:number, suppressEvents?:boolean):any; timeScale(value:number):any; totalDuration(value:number):any; - totalTime(time:number, suppressEvents?:bool):any; + totalTime(time:number, suppressEvents?:boolean):any; } -interface SimpleTimeline extends Animation { - autoRemoveChildren:bool; - smoothChildTiming:bool; +declare class SimpleTimeline extends Animation { + autoRemoveChildren:boolean; + smoothChildTiming:boolean; + constructor(vars?:Object); + + add(value:any, position?:any, align?:string, stagger?:number):any; insert(tween:any, time:any):any; - render(time:number, suppressEvents?:bool, force?:bool):void; + render(time:number, suppressEvents?:boolean, force?:boolean):void; } //com.greensock -interface TimelineLite { - addLabel(label:string, time:number):any; - append(value:any, offset:number):any; - appendMultiple(tweens:any[], offset:number, align:string, stagger:number):any; - call(callback:Function, params?:any[], scope?:any, offset?:number, baseTimeOrLabel?:any):any; - clear(labels?:bool):any; - duration(value:number):any; - exportRoot(vars?:Object, omitDelayedCalls?:bool):TimelineLite; - from(target:Object, duration:number, vars:Object, offset:number, baseTimeOrLabel?:any):any; - fromTo(target:Object, duration:number, fromVars:Object, toVars:Object, offset:number, baseTimeOrLabel?:any):any; - getChildren(nested?:bool, tweens?:bool, timelines?:bool, ignoreBeforeTime?:number):any[]; - getLabelTime(label:string):number; - getTweensOf(target:Object, nested?:bool):any[]; - insert(value:any, timeOrLabel:any):any; - insertMultiple(tweens:any[], timeOrLabel:any, align:string, stagger:number):any; +declare class TweenLite extends Animation { + static defaultEase:Ease; + static defaultOverwrite:string; + static selector:any; + target:Object; + static ticker:IDispatcher; + timeline:SimpleTimeline; + vars:Object; + + constructor(target:Object, duration:number, vars:Object); + + static delayedCall(delay:number, callback:Function, params?:any[], scope?:any, useFrames?:boolean):TweenLite; + static from(target:Object, duration:number, vars:Object):TweenLite; + static fromTo(target:Object, duration:number, fromVars:Object, toVars:Object):TweenLite; + static getTweensOf(target:Object):any[]; invalidate():any; + static killDelayedCallsTo(func:Function):void; + static killTweensOf(target:Object, vars?:Object):void; + static set(target:Object, vars:Object):TweenLite; + static to(target:Object, duration:number, vars:Object):TweenLite; +} + +declare class TweenMax extends TweenLite { + static ticker:IDispatcher; + + constructor(target:Object, duration:number, vars:Object); + + static delayedCall(delay:number, callback:Function, params?:any[], scope?:any, useFrames?:boolean):TweenMax; + static from(target:Object, duration:number, vars:Object):TweenMax; + static fromTo(target:Object, duration:number, fromVars:Object, toVars:Object):TweenMax; + static getAllTweens(includeTimelines?:boolean):any[]; + static getTweensOf(target:Object):any[]; + invalidate():any; + static isTweening(target:Object):boolean; + static killAll(complete?:boolean, tweens?:boolean, delayedCalls?:boolean, timelines?:boolean):void; + static killChildTweensOf(parent:any, complete?:boolean):void; + static killDelayedCallsTo(func:Function):void; + static killTweensOf(target:Object, vars?:Object):void; + static pauseAll(tweens?:boolean, delayedCalls?:boolean, timelines?:boolean):void; + progress(value:number):any; + repeat(value:number):any; + repeatDelay(value:number):any; + static resumeAll(tweens?:boolean, delayedCalls?:boolean, timelines?:boolean):void; + static set(target:Object, vars:Object):TweenMax; + static staggerFrom(targets:Object[], duration:number, vars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; + static staggerFromTo(targets:Object[], duration:number, fromVars:Object, toVars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; + static staggerTo(targets:Object[], duration:number, vars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; + time(value:number, suppressEvents?:boolean):any; + static to(target:Object, duration:number, vars:Object):TweenMax; + totalDuration(value:number):any; + totalProgress(value:number):any; + updateTo(vars:Object, resetDuration?:boolean):any; + yoyo(value?:boolean):any; +} + +declare class TimelineLite extends SimpleTimeline { + constructor(vars?:Object); + + add(value:any, position?:any, align?:string, stagger?:number):any + addLabel(label:string, position:any):any + addPause(position?:any, callback?:Function, params?:any[], scope?:any):any + append(value:any, offsetOrLabel?:any):any + appendMultiple(tweens:any[], offsetOrLabel?:any, align?:string, stagger?:number):any + call(callback:Function, params?:any[], scope?:any, position?:any):any + clear(labels?:boolean):any + duration(value:number):any + exportRoot(vars?:Object, omitDelayedCalls?:boolean):TimelineLite + fromTo(target:Object, duration:number, fromVars:Object, toVars:Object, position?:any):any + getChildren(nested?:boolean, tweens?:boolean, timelines?:boolean, ignoreBeforeTime?:number):any[]; + getLabelTime(label:string):number + getTweensOf(target:Object, nested?:boolean):any[]; + insert(value:any, timeOrLabel?:any):any + insertMultiple(tweens:any[], timeOrLabel?:any, align?:string, stagger?:number):any + invalidate():any progress(value:number):any; remove(value:any):any; removeLabel(label:string):any; - seek(timeOrLabel:any, suppressEvents?:bool):any; - set(target:Object, vars:Object, offset:number, baseTimeOrLabel?:any):any; - shiftChildren(amount:number, adjustLabels?:bool, ignoreBeforeTime?:number):any; - staggerFrom(targets:Object[], duration:number, vars:Object, stagger:number, offset:number, baseTimeOrLabel?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any; - staggerFromTo(targets:Object[], duration:number, fromVars:Object, toVars:Object, stagger:number, offset:number, baseTimeOrLabel?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any; - staggerTo(targets:Object[], duration:number, vars:Object, stagger:number, offset:number, baseTimeOrLabel?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any; + seek(position:any, suppressEvents?:boolean):any; + shiftChildren(amount:number, adjustLabels?:boolean, ignoreBeforeTime?:number):any; + staggerFrom(targets:any[], duration:number, vars:Object, stagger?:number, position?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteScope?:any):any; + staggerFromTo(targets:any[], duration:number, fromVars:Object, toVars:Object, stagger?:number, position?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any; + staggerTo(targets:any[], duration:number, vars:Object, stagger:number, position?:any, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any; stop():any; - to(target:Object, duration:number, vars:Object, offset:number, baseTimeOrLabel?:any):any; - totalDuration(value:number):any; - usesFrames():bool; + to(target:Object, duration:number, vars:Object, position?:any):any; + usesFrames():Boolean } -interface TimelineMax { - addCallback(callback:Function, timeOrLabel:any, params?:any[], scope?:any):TimelineMax; +declare class TimelineMax extends TimelineLite { + constructor(vars?:Object); + + addCallback(callback:Function, position:any, params?:any[], scope?:any):TimelineMax; currentLabel(value?:string):any; - getActive(nested?:bool, tweens?:bool, timelines?:bool):any[]; - getLabelAfter(time:number):string; - getLabelBefore(time:number):string; + getActive(nested?:boolean, tweens?:boolean, timelines?:boolean):any[]; + getLabelAfter(time:number):string + getLabelBefore(time:number):string getLabelsArray():any[]; invalidate():any; progress(value:number):any; - removeCallback(callback:Function, timeOrLabel?:any):TimelineMax; - repeat(value:number):any; - repeatDelay(value:number):any; - time(value:number, suppressEvents?:bool):any; + removeCallback(callback:Function, timeOrLabel?:any):TimelineMax + repeat(value?:number):any; + repeatDelay(value?:number):any; + time(value:number, suppressEvents?:boolean):any; totalDuration(value:number):any; totalProgress(value:number):any; - tweenFromTo(fromTimeOrLabel:any, toTimeOrLabel:any, vars?:Object):TweenLite; - tweenTo(timeOrLabel:any, vars?:Object):TweenLite; - yoyo(value?:bool):any; -} - -interface TweenLite extends Animation { - defaultEase:Ease; - defaultOverwrite:string; - target:Object; - ticker:any; - - delayedCall(delay:number, callback:Function, params?:any[], scope?:any, useFrames?:bool):TweenLite; - from(target:Object, duration:number, vars:Object):TweenLite; - fromTo(target:Object, duration:number, fromVars:Object, toVars:Object):TweenLite; - getTweensOf(target:Object):any[]; - invalidate():any; - killDelayedCallsTo(func:Function):void; - killTweensOf(target:Object, vars?:Object):void; - set(target:Object, vars:Object):TweenLite; - to(target:Object, duration:number, vars:Object):TweenLite; -} - -interface TweenMax extends TweenLite { - delayedCall(delay:number, callback:Function, params?:any[], scope?:any, useFrames?:bool):TweenMax; - from(target:Object, duration:number, vars:Object):TweenMax; - fromTo(target:Object, duration:number, fromVars:Object, toVars:Object):TweenMax; - getAllTweens(includeTimelines?:bool):any[]; - getTweensOf(target:Object):any[]; - invalidate():any; - isTweening(target:Object):bool; - killAll(complete?:bool, tweens?:bool, delayedCalls?:bool, timelines?:bool):void; - killChildTweensOf(parent:any, complete?:bool):void; - killDelayedCallsTo(func:Function):void; - killTweensOf(target:Object, vars?:Object):void; - pauseAll(tweens?:bool, delayedCalls?:bool, timelines?:bool):void; - progress(value:number):any; - repeat(value:number):any; - repeatDelay(value:number):any; - resumeAll(tweens?:bool, delayedCalls?:bool, timelines?:bool):void; - set(target:Object, vars:Object):TweenMax; - staggerFrom(targets:Object[], duration:number, vars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; - staggerFromTo(targets:Object[], duration:number, fromVars:Object, toVars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; - staggerTo(targets:Object[], duration:number, vars:Object, stagger:number, onCompleteAll?:Function, onCompleteAllParams?:any[], onCompleteAllScope?:any):any[]; - time(value:number, suppressEvents?:bool):any; - to(target:Object, duration:number, vars:Object):TweenMax; - totalDuration(value:number):any; - totalProgress(value:number):any; - updateTo(vars:Object, resetDuration?:bool):any; - yoyo(value?:bool):any; + tweenFromTo(fromPosition:any, toPosition:any, vars?:Object):TweenLite + tweenTo(position:any, vars?:Object):TweenLite + yoyo(value?:boolean):any; } //com.greensock.easing @@ -228,8 +249,8 @@ interface Sine { interface SlowMo { ease:SlowMo; - SlowMo(linearRatio:number, power:number, yoyoMode:bool); - config(linearRatio:number, power:number, yoyoMode:bool):SlowMo; + SlowMo(linearRatio:number, power:number, yoyoMode:boolean); + config(linearRatio:number, power:number, yoyoMode:boolean):SlowMo; getRatio(p:number):number; } interface SteppedEase { @@ -244,7 +265,7 @@ interface Strong { //com.greensock.plugins interface BezierPlugin extends TweenPlugin { - bezierThrough(values:any[], curviness?:number, quadratic?:bool, correlate?:string, prepend?:Object, calcDifs?:bool):Object; + bezierThrough(values:any[], curviness?:number, quadratic?:boolean, correlate?:string, prepend?:Object, calcDifs?:boolean):Object; cubicToQuadratic(a:number, b:number, c:number, d:number):any[]; quadraticToCubic(a:number, b:number, c:number):Object; } @@ -270,20 +291,9 @@ interface ScrollToPlugin extends TweenPlugin { } interface TweenPlugin { - activate(plugins:any[]):bool; + activate(plugins:any[]):boolean; } - -//com.greensock.core -declare var Animation:Animation; -declare var SimpleTimeline:SimpleTimeline; - -//com.greensock -declare var TimelineLite:TimelineLite; -declare var TimelineMax:TimelineMax; -declare var TweenLite:TweenLite; -declare var TweenMax:TweenMax; - //com.greensock.easing declare var Back:Back; declare var Bounce:Bounce; From 709fe49bf3ae47b35413a8ef9ce20bc7ed4886b4 Mon Sep 17 00:00:00 2001 From: Santi Albo Date: Thu, 1 Aug 2013 12:19:52 +0100 Subject: [PATCH 133/756] Add missing getRestangularUrl method Both `RestangularElement` and `RestangularCollection` were missing the `getRestangularUrl`. https://github.com/mgonto/restangular#element-methods --- restangular/restangular.d.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/restangular/restangular.d.ts b/restangular/restangular.d.ts index b18b3c8e29..cb7578a419 100644 --- a/restangular/restangular.d.ts +++ b/restangular/restangular.d.ts @@ -31,6 +31,7 @@ interface RestangularElement extends Restangular { trace(queryParams?, headers?): ng.IPromise; options(queryParams?, headers?): ng.IPromise; patch(queryParams?, headers?): ng.IPromise; + getRestangularUrl(): string; } interface RestangularCollection extends Restangular { @@ -41,6 +42,7 @@ interface RestangularCollection extends Restangular { options(queryParams?, headers?): ng.IPromise; patch(queryParams?, headers?): ng.IPromise; putElement(idx, params, headers): ng.IPromise; + getRestangularUrl(): string; } interface RestangularCustom { From 3056c411a79785bee9fff883f7828ff5a36ba9f0 Mon Sep 17 00:00:00 2001 From: Santi Albo Date: Thu, 1 Aug 2013 15:16:05 +0100 Subject: [PATCH 134/756] Restangular also accepts strings as id for the method "one" --- restangular/restangular.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/restangular/restangular.d.ts b/restangular/restangular.d.ts index b18b3c8e29..691d77d5c8 100644 --- a/restangular/restangular.d.ts +++ b/restangular/restangular.d.ts @@ -8,6 +8,7 @@ interface Restangular extends RestangularCustom { one(route: string, id?: number): RestangularElement; + one(route: string, id?: string): RestangularElement; all(route: string): RestangularCollection; copy(fromElement: any): RestangularElement; withConfig(configurer: any): Restangular; From f9ceadde2af7be79585e9364b5072f363e31afec Mon Sep 17 00:00:00 2001 From: yutavsky Date: Thu, 1 Aug 2013 23:18:23 +0900 Subject: [PATCH 135/756] fix some method type --- moment/moment.d.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/moment/moment.d.ts b/moment/moment.d.ts index e937f53dfb..3ad485934f 100644 --- a/moment/moment.d.ts +++ b/moment/moment.d.ts @@ -68,8 +68,9 @@ interface Moment { subtract(soort: string, aantal: number): Moment; calendar(): string; + clone(): Moment; - valueOf(): string; + valueOf(): number; local(): Moment; // current date/time in local mode @@ -95,13 +96,13 @@ interface Moment { seconds(): number; milliseconds(ms: number): Moment; milliseconds(): number; - weekday(): Moment; + weekday(): number; weekday(d: number): Moment; - isoWeekday(): Moment; + isoWeekday(): number; isoWeekday(d: number): Moment; - weekYear(): Moment; + weekYear(): number; weekYear(d: number): Moment; - isoWeekYear(): Moment; + isoWeekYear(): number; isoWeekYear(d: number): Moment; from(f: Moment): string; @@ -232,7 +233,6 @@ interface MomentStatic { (date: number[]): Moment; (clone: Moment): Moment; - clone(): Moment; unix(timestamp: number): Moment; utc(): Moment; // current date/time in UTC mode From f711d046d561ea71ac3a45c7d4ac3ee672af8dd7 Mon Sep 17 00:00:00 2001 From: danieljsinclair Date: Thu, 1 Aug 2013 18:12:31 +0100 Subject: [PATCH 136/756] IRoute.templateUrl also now accepts a function instead of a string. Adjusted templateUrl of IRoute because $routeProvider now allows function templateUrls to be defined such as; .when("/:controller/:action", { templateUrl: function ($routeParams) { console.log("Default rule"); return '/ng/app/views/partials/' + $routeParams.action.toLowerCase() + '.htm'; } }) --- angularjs/angular.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 989c6d48d2..8ba4d4cb60 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -622,7 +622,7 @@ declare module ng { interface IRoute { controller?: any; template?: string; - templateUrl?: string; + templateUrl?: any; resolve?: any; redirectTo?: any; reloadOnSearch?: boolean; From 69d53f2b438521a2388861404d4bb20cfd5af2f5 Mon Sep 17 00:00:00 2001 From: jbaldwin Date: Thu, 1 Aug 2013 16:19:51 -0600 Subject: [PATCH 137/756] Merge underscore+typed versions together --- underscore/underscore-tests.ts | 90 +- underscore/underscore-typed-tests.ts | 261 --- underscore/underscore-typed.d.ts | 2814 ------------------------ underscore/underscore.d.ts | 3044 +++++++++++++++++++++++--- 4 files changed, 2811 insertions(+), 3398 deletions(-) delete mode 100644 underscore/underscore-typed-tests.ts delete mode 100644 underscore/underscore-typed.d.ts diff --git a/underscore/underscore-tests.ts b/underscore/underscore-tests.ts index 97aaf0cbf0..3e1514a456 100644 --- a/underscore/underscore-tests.ts +++ b/underscore/underscore-tests.ts @@ -1,18 +1,16 @@ -import _ = require("underscore") +/// declare var $; -declare function alert(any); -_.each([1, 2, 3], (num) => alert(num)); -_.each({ one: 1, two: 2, three: 3 }, (num, key) => alert(num)); +_.each([1, 2, 3], (num) => alert(num.toString())); +_.each({ one: 1, two: 2, three: 3 }, (value) => alert(value.toString())); _.map([1, 2, 3], (num) => num * 3); -_.map({ one: 1, two: 2, three: 3 }, (num, key) => num * 3); +_.map({ one: 1, two: 2, three: 3 }, (value: number, key?: string) => value * 3); var sum = _.reduce([1, 2, 3], (memo, num) => memo + num, 0); var list = [[0, 1], [2, 3], [4, 5]]; - var flat = _.reduceRight(list, (a, b) => a.concat(b), []); var even = _.find([1, 2, 3, 4, 5, 6], (num) => num % 2 == 0); @@ -37,19 +35,23 @@ _.pluck(stooges, 'name'); _.max(stooges, (stooge) => stooge.age); +_.max([1, 2, 3, 4, 5]); + var numbers = [10, 5, 100, 2, 1000]; _.min(numbers); _.sortBy([1, 2, 3, 4, 5, 6], (num) => Math.sin(num)); -_.groupBy([1.3, 2.1, 2.4], (num) => Math.floor(num)); + +_([1.3, 2.1, 2.4]).groupBy((e) => Math.floor(e)); +_.groupBy([1.3, 2.1, 2.4], (num: number) => Math.floor(num).toString()); _.groupBy(['one', 'two', 'three'], 'length'); -_.countBy([1, 2, 3, 4, 5], (num) => num % 2 == 0 ? 'even' : 'odd'); +_.countBy([1, 2, 3, 4, 5], (num) => (num % 2 == 0) ? 'even' : 'odd'); _.shuffle([1, 2, 3, 4, 5, 6]); -// (function(){ return _.toArray(arguments).slice(1); })(1, 2, 3, 4); +(function(a, b, c, d){ return _.toArray(arguments).slice(1); })(1, 2, 3, 4); _.size({ one: 1, two: 2, three: 3 }); @@ -60,16 +62,21 @@ _.initial([5, 4, 3, 2, 1]); _.last([5, 4, 3, 2, 1]); _.rest([5, 4, 3, 2, 1]); _.compact([0, 1, false, 2, '', 3]); -_.flatten([1, [2], [3, [[4]]]]); -_.flatten([1, [2], [3, [[4]]]], true); + +_.flatten([1, 2, 3, 4]); +_.flatten([1, [2]]); + +// typescript doesn't like the elements being different +_.flatten([1, [2], [3, [[4]]]]); +_.flatten([1, [2], [3, [[4]]]], true); _.without([1, 2, 1, 0, 3, 1, 4], 0, 1); _.union([1, 2, 3], [101, 2, 1, 10], [2, 1]); _.intersection([1, 2, 3], [101, 2, 1, 10], [2, 1]); _.difference([1, 2, 3, 4, 5], [5, 2, 10]); _.uniq([1, 2, 1, 3, 1, 4]); _.zip(['moe', 'larry', 'curly'], [30, 40, 50], [true, false, false]); -_.object(['moe', 'larry', 'curly'], [30, 40, 50]); -_.object([['moe', 30], ['larry', 40], ['curly', 50]]); +var r = _.object<{ [key: string]: number }>(['moe', 'larry', 'curly'], [30, 40, 50]); +_.object([['moe', 30], ['larry', 40], ['curly', 50]]); _.indexOf([1, 2, 3], 2); _.lastIndexOf([1, 2, 3, 1, 2, 3], 2); _.sortedIndex([10, 20, 30, 40, 50], 35); @@ -81,20 +88,22 @@ _.range(0); /////////////////////////////////////////////////////////////////////////////////////// -var func = function (greeting?) { return greeting + ': ' + this.name }; -func = _.bind(func, { name: 'moe' }, 'hi'); -func(); +var func = function (greeting) { return greeting + ': ' + this.name }; +// need a second var otherwise typescript thinks func signature is the above func type, +// instead of the newly returned _bind => func type. +var func2 = _.bind(func, { name: 'moe' }, 'hi'); +func2(); var buttonView = { - label: 'underscore', - onClick: function () { alert('clicked: ' + this.label); }, - onHover: function () { console.log('hovering: ' + this.label); } + label: 'underscore', + onClick: function () { alert('clicked: ' + this.label); }, + onHover: function () { console.log('hovering: ' + this.label); } }; _.bindAll(buttonView); $('#underscore_button').bind('click', buttonView.onClick); var fibonacci = _.memoize(function (n) { - return n < 2 ? n : fibonacci(n - 1) + fibonacci(n - 2); + return n < 2 ? n : fibonacci(n - 1) + fibonacci(n - 2); }); var log = _.bind(console.log, console); @@ -120,9 +129,10 @@ var render = () => alert("rendering..."); var renderNotes = _.after(notes.length, render); _.each(notes, (note) => note.asyncSave({ success: renderNotes })); -var hello = function (name?) { return "hello: " + name; }; -hello = _.wrap(hello, (func) => { return "before, " + func("moe") + ", after"; }); -hello(); +var hello = function (name) { return "hello: " + name; }; +// can't use the same "hello" var otherwise typescript fails +var hello2 = _.wrap(hello, (func) => { return "before, " + func("moe") + ", after"; }); +hello2(); var greet = function (name) { return "hi: " + name; }; var exclaim = function (statement) { return statement + "!"; }; @@ -144,12 +154,23 @@ var iceCream = { flavor: "chocolate" }; _.defaults(iceCream, { flavor: "vanilla", sprinkles: "lots" }); _.clone({ name: 'moe' }); +_.clone(['i', 'am', 'an', 'object!']); + +_([1, 2, 3, 4]) + .chain() + .filter((num: number) => { + return num % 2 == 0; + }).tap(alert) + .map((num: number) => { + return num * num; + }) + .value(); _.chain([1, 2, 3, 200]) - .filter(function (num) { return num % 2 == 0; }) - .tap(alert) - .map(function (num) { return num * num }) - .value(); + .filter(function (num: number) { return num % 2 == 0; }) + .tap(alert) + .map(function (num: number) { return num * num }) + .value(); _.has({ a: 1, b: 2, c: 3 }, "b"); @@ -206,15 +227,17 @@ var moe2 = { name: 'moe' }; moe2 === _.identity(moe); var genie; +var r2 = _.times(3, (n) => { return n * n }); _(3).times(function (n) { genie.grantWishNumber(n); }); _.random(0, 100); _.mixin({ - capitalize: function (string) { - return string.charAt(0).toUpperCase() + string.substring(1).toLowerCase(); - } + capitalize: function (string) { + return string.charAt(0).toUpperCase() + string.substring(1).toLowerCase(); + } }); +(_("fabio")).capitalize(); _.uniqueId('contact_'); @@ -234,14 +257,11 @@ template({ value: ''); + +_.toSentence(['jQuery', 'Mootools', 'Prototype']); +_.toSentence(['jQuery', 'Mootools', 'Prototype'], ', ', ' unt '); + +_.toSentenceSerial(['jQuery', 'Mootools']); +_.toSentenceSerial(['jQuery', 'Mootools', 'Prototype']); +_.toSentenceSerial(['jQuery', 'Mootools', 'Prototype'], ', ', ' unt '); + +_.repeat('foo', 3); +_.repeat('foo', 3, 'bar'); + +_.surround('foo', 'ab'); + +_.quote('foo'); + +_.unquote('"foo"'); +_.unquote("'foo'", "'"); + +_.slugify("Un éléphant à l'orée du bois"); + +['foo20', 'foo5'].sort(_.naturalCmp); + +_.toBoolean('true'); +_.toBoolean('FALSE'); +_.toBoolean('random'); +_.toBoolean('truthy', ['truthy'], ['falsy']); +_.toBoolean('true only at start', [/^true/]); diff --git a/underscore.string/underscore.string.d.ts b/underscore.string/underscore.string.d.ts new file mode 100644 index 0000000000..7996d7cbb8 --- /dev/null +++ b/underscore.string/underscore.string.d.ts @@ -0,0 +1,515 @@ +// Type definitions for underscore.string +// Project: https://github.com/epeli/underscore.string +// Definitions by: Ry Racherbaumer +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +declare module 'underscore.string' { + + /** + * Determine if a string is 'blank.' + * @param str + */ + function isBlank(str: string): boolean; + + /** + * Removes all html tags from string. + * @param str + */ + function stripTags(str: string): string; + + /** + * Converts first letter of the string to uppercase. + * ('foo Bar') => 'Foo Bar' + * @param str + */ + function capitalize(str: string): string; + + /** + * Chop a string into pieces. + * ('whitespace', 3) => ['whi','tes','pac','e'] + * @param str String to chop + * @param step Size of the pieces + */ + function chop(str: string, step: number): Array; + + /** + * Compress some whitespaces to one. + * (' foo bar ') => 'foo bar' + * @param str + */ + function clean(str: string): string; + + /** + * Count occurences of a sub string. + * ('Hello world', 'l') => 3 + * @param str + * @param substr + */ + function count(str: string, substr: string): number; + + /** + * Convert string to an array of characters. + * ('Hello') => ['H','e','l','l','o'] + * @param str + */ + function chars(str: string): Array; + + /** + * Returns a copy of the string in which all the case-based characters have had their case swapped. + * ('hELLO') => 'Hello' + * @param str + */ + function swapCase(str: string): string; + + /** + * Converts HTML special characters to their entity equivalents. + * ('
Blah blah blah
') => '<div>Blah blah blah</div>' + * @param str + */ + function escapeHTML(str: string): string; + + /** + * Converts entity characters to HTML equivalents. + * ('<div>Blah blah blah</div>') => '
Blah blah blah
' + * @param str + */ + function unescapeHTML(str: string): string; + + /** + * Escape a string for use in a regular expression. + * @param str + */ + function escapeRegExp(str: string): string; + + /** + * Splice a string like an array. + * @param str + * @param i + * @param howmany + * @param substr + */ + function splice(str: string, i: number, howmany: number, substr?: string): string; + + /** + * Insert a string at index. + * @param str + * @param i + * @param substr + */ + function insert(str: string, i: number, substr: string): string; + + /** + * Tests if string contains a substring. + * ('foobar', 'ob') => true + * @param str + * @param needle + */ + function include(str: string, needle: string): boolean; + + /** + * Tests if string contains a substring. + * ('foobar', 'ob') => true + * @param str + * @param needle + */ + function contains(str: string, needle: string): boolean; + + /** + * Joins strings together with given separator. + * (' ', 'foo', 'bar') => 'foo bar' + * @param separator + * @param args + */ + function join(separator: string, ...args: string[]): string; + + /** + * Split string by newlines character. + * ('Hello\nWorld') => ['Hello', 'World'] + * @param str + */ + function lines(str: string): Array; + + /** + * Return reversed string. + * ('foobar') => 'raboof' + * @param str + */ + function reverse(str: string): string; + + /** + * Checks if string starts with another string. + * ('image.gif', 'image') => true + * @param str + * @param starts + */ + function startsWith(str: string, starts: string): boolean; + + /** + * Checks if string ends with another string. + * ('image.gif', 'gif') => true + * @param value + * @param starts + */ + function endsWith(value: string, starts: string): boolean; + + /** + * Returns the successor to passed string. + * ('a') => 'b' + * @param str + */ + function succ(str: string): string; + + /** + * Capitalize first letter of every word in the string. + * ('my name is epeli') => 'My Name Is Epeli' + * @param str + */ + function titleize(str: string): string; + + /** + * Converts underscored or dasherized string to a camelized one. + * ('-moz-transform') => 'MozTransform' + * @param str + */ + function camelize(str: string): string; + + /** + * Converts a camelized or dasherized string into an underscored one. + * ('MozTransform') => 'moz_transform' + * @param str + */ + function underscored(str: string): string; + + /** + * Converts a underscored or camelized string into an dasherized one. + * ('MozTransform') => '-moz-transform' + * @param str + */ + function dasherize(str: string): string; + + /** + * Converts string to camelized class name. + * ('some_class_name') => 'SomeClassName' + * @param str + */ + function classify(str: string): string; + + /** + * Converts an underscored, camelized, or dasherized string into a humanized one. + * Also removes beginning and ending whitespace, and removes the postfix '_id'. + * (' capitalize dash-CamelCase_underscore trim ') => 'Capitalize dash camel case underscore trim' + * @param str + */ + function humanize(str: string): string; + + /** + * Trims defined characters from begining and ending of the string. + * Defaults to whitespace characters. + * (' foobar ') => 'foobar' + * ('_-foobar-_', '_-') => 'foobar' + * @param str + * @param characters + */ + function trim(str: string, characters?: string): string; + + /** + * Trims defined characters from begining and ending of the string. + * Defaults to whitespace characters. + * (' foobar ') => 'foobar' + * ('_-foobar-_', '_-') => 'foobar' + * @param str + * @param characters + */ + function strip(str: string, characters?: string): string; + + /** + * Left trim. Similar to trim, but only for left side. + * @param str + * @param characters + */ + function ltrim(str: string, characters?: string): string; + + /** + * Left trim. Similar to trim, but only for left side. + * @param str + * @param characters + */ + function lstrip(str: string, characters?: string): string; + + /** + * Right trim. Similar to trim, but only for right side. + * @param str + * @param characters + */ + function rtrim(str: string, characters?: string): string; + + /** + * Right trim. Similar to trim, but only for right side. + * @param str + * @param characters + */ + function rstrip(str: string, characters?: string): string; + + /** + * Truncate string to specified length. + * ('Hello world').truncate(5) => 'Hello...' + * ('Hello').truncate(10) => 'Hello' + * @param str + * @param length + * @param truncateStr + */ + function truncate(str: string, length: number, truncateStr?: string): string; + + /** + * Elegant version of truncate. + * Makes sure the pruned string does not exceed the original length. + * Avoid half-chopped words when truncating. + * ('Hello, cruel world', 15) => 'Hello, cruel...' + * @param str + * @param length + * @param pruneStr + */ + function prune(str: string, length: number, pruneStr?: string): string; + + /** + * Split string by delimiter (String or RegExp). + * /\s+/ by default. + * (' I love you ') => ['I','love','you'] + * ('I_love_you', '_') => ['I','love','you'] + * @param str + * @param delimiter + */ + function words(str: string, delimiter?: string): Array; + + /** + * Pads a string with characters until the total string length is equal to the passed length parameter. + * By default, pads on the left with the space char (' '). + * padStr is truncated to a single character if necessary. + * ('1', 8) => ' 1' + * ('1', 8, '0') => '00000001' + * ('1', 8, '0', 'right') => '10000000' + * ('1', 8, '0', 'both') => '00001000' + * ('1', 8, 'bleepblorp', 'both') => 'bbbb1bbb' + * @param str + * @param length + * @param padStr + * @param type + */ + function pad(str: string, length: number, padStr?:string, type?: string): string; + + /** + * Left-pad a string. + * Alias for pad(str, length, padStr, 'left') + * ('1', 8, '0') => '00000001' + * @param str + * @param length + * @param padStr + */ + function lpad(str: string, length: number, padStr?: string): string; + + /** + * Left-pad a string. + * Alias for pad(str, length, padStr, 'left') + * ('1', 8, '0') => '00000001' + * @param str + * @param length + * @param padStr + */ + function rjust(str: string, length: number, padStr?: string): string; + + /** + * Right-pad a string. + * Alias for pad(str, length, padStr, 'right') + * ('1', 8, '0') => '10000000' + * @param str + * @param length + * @param padStr + */ + function rpad(str: string, length: number, padStr?: string): string; + + /** + * Right-pad a string. + * Alias for pad(str, length, padStr, 'right') + * ('1', 8, '0') => '10000000' + * @param str + * @param length + * @param padStr + */ + function ljust(str: string, length: number, padStr?: string): string; + + /** + * Left/right-pad a string. + * Alias for pad(str, length, padStr, 'both') + * ('1', 8, '0') => '00001000' + * @param str + * @param length + * @param padStr + */ + function lrpad(str: string, length: number, padStr?: string): string; + + /** + * Left/right-pad a string. + * Alias for pad(str, length, padStr, 'both') + * ('1', 8, '0') => '00001000' + * @param str + * @param length + * @param padStr + */ + function center(str: string, length: number, padStr?: string): string; + + function sprintf(format: string, ...args: any[]): string; + + function vsprintf(fmt: string, ...argv: any[]): string; + + /** + * Parse string to number. + * Returns NaN if string can't be parsed to number. + * ('2.556').toNumber() => 3 + * ('2.556').toNumber(1) => 2.6 + * @param str + * @param decimals + */ + function toNumber(str: string, decimals?: number): number; + + function numberFormat(number: number, dec?: number, dsep?: string, tsep?: string): string; + + /** + * Searches a string from left to right for a pattern. + * Returns a substring consisting of the characters in the string that are to the right of the pattern. + * If no match found, returns entire string. + * ('This_is_a_test_string').strRight('_') => 'is_a_test_string' + * @param str + * @param sep + */ + function strRight(str: string, sep: string): string; + + /** + * Searches a string from right to left for a pattern. + * Returns a substring consisting of the characters in the string that are to the right of the pattern. + * If no match found, returns entire string. + * ('This_is_a_test_string').strRightBack('_') => 'string' + * @param str + * @param sep + */ + function strRightBack(str: string, sep: string): string; + + /** + * Searches a string from left to right for a pattern. + * Returns a substring consisting of the characters in the string that are to the left of the pattern. + * If no match found, returns entire string. + * ('This_is_a_test_string').strLeft('_') => 'This' + * @param str + * @param sep + */ + function strLeft(str: string, sep: string): string; + + /** + * Searches a string from right to left for a pattern. + * Returns a substring consisting of the characters in the string that are to the left of the pattern. + * If no match found, returns entire string. + * ('This_is_a_test_string').strLeftBack('_') => 'This_is_a_test' + * @param str + * @param sep + */ + function strLeftBack(str: string, sep: string): string; + + /** + * Join an array into a human readable sentence. + * (['jQuery', 'Mootools', 'Prototype']) => 'jQuery, Mootools and Prototype' + * (['jQuery', 'Mootools', 'Prototype'], ', ', ' unt ') => 'jQuery, Mootools unt Prototype' + * @param array + * @param separator + * @param lastSeparator + * @param serial + */ + function toSentence(array: Array, separator?: string, lastSeparator?: string, serial?: boolean): string; + + /** + * The same as toSentence, but uses ', ' as default for lastSeparator. + * @param array + * @param separator + * @param lastSeparator + */ + function toSentenceSerial(array: Array, separator?: string, lastSeparator?: string): string; + + /** + * Transform text into a URL slug. Replaces whitespaces, accentuated, and special characters with a dash. + * ('Un éléphant à l'orée du bois') => 'un-elephant-a-loree-du-bois' + * @param str + */ + function slugify(str: string): string; + + /** + * Surround a string with another string. + * ('foo', 'ab') => 'abfooab' + * @param str + * @param wrapper + */ + function surround(str: string, wrapper: string): string; + + /** + * Quotes a string. + * quoteChar defaults to " + * ('foo') => '"foo"' + * @param str + */ + function quote(str: string, quoteChar?: string): string; + + /** + * Quotes a string. + * quoteChar defaults to " + * ('foo') => '"foo"' + * @param str + */ + function q(str: string, quoteChar?: string): string; + + /** + * Unquotes a string. + * quoteChar defaults to " + * ('"foo"') => 'foo' + * ("'foo'", "'") => 'foo' + * @param str + */ + function unquote(str: string, quoteChar?: string): string; + + /** + * Repeat a string with an optional separator. + * ('foo', 3) => 'foofoofoo' + * ('foo', 3, 'bar') => 'foobarfoobarfoo' + * @param value + * @param count + * @param separator + */ + function repeat(value: string, count: number, separator?:string): string; + + /** + * Naturally sort strings like humans would do. + * Caution: this function is charset dependent. + * @param str1 + * @param str2 + */ + function naturalCmp(str1: string, str2: string): number; + + /** + * Calculates Levenshtein distance between two strings. + * ('kitten', 'kittah') => 2 + * @param str1 + * @param str2 + */ + function levenshtein(str1: string, str2: string): number; + + /** + * Turn strings that can be commonly considered as booleans to real booleans. + * Such as "true", "false", "1" and "0". This function is case insensitive. + * ('true') => true + * ('FALSE') => false + * ('random') => undefined + * ('truthy', ['truthy'], ['falsy']) => true + * ('true only at start', [/^true/]) => true + * @param str + * @param trueValues + * @param falseValues + */ + function toBoolean(str: string, trueValues?: Array, falseValues?: Array): boolean; + +} From a1c725fde327218cb751e627eb83eba40ca14383 Mon Sep 17 00:00:00 2001 From: Ry Racherbaumer Date: Tue, 27 Aug 2013 13:59:52 -0700 Subject: [PATCH 368/756] Updated JSDoc for sprintf and numberFormat --- underscore.string/underscore.string.d.ts | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/underscore.string/underscore.string.d.ts b/underscore.string/underscore.string.d.ts index 7996d7cbb8..c066c88c93 100644 --- a/underscore.string/underscore.string.d.ts +++ b/underscore.string/underscore.string.d.ts @@ -295,7 +295,7 @@ declare module 'underscore.string' { * @param padStr * @param type */ - function pad(str: string, length: number, padStr?:string, type?: string): string; + function pad(str: string, length: number, padStr:string, type?: string): string; /** * Left-pad a string. @@ -357,10 +357,14 @@ declare module 'underscore.string' { */ function center(str: string, length: number, padStr?: string): string; + /** + * C like string formatting. + * _.sprintf('%.1f', 1.17) => '1.2' + * @param format + * @param args + */ function sprintf(format: string, ...args: any[]): string; - function vsprintf(fmt: string, ...argv: any[]): string; - /** * Parse string to number. * Returns NaN if string can't be parsed to number. @@ -371,6 +375,15 @@ declare module 'underscore.string' { */ function toNumber(str: string, decimals?: number): number; + /** + * Formats the numbers. + * (1000, 2) => '1,000.00' + * (123456789.123, 5, '.', ',') => '123,456,789.12300' + * @param number + * @param dec + * @param dsep + * @param tsep + */ function numberFormat(number: number, dec?: number, dsep?: string, tsep?: string): string; /** From 38c877628c5c5ab64e8b0e6e23936a782fd9ccfa Mon Sep 17 00:00:00 2001 From: artsjedi Date: Tue, 27 Aug 2013 19:49:48 -0300 Subject: [PATCH 369/756] SoundInstance.plau() has optional parameters --- soundjs/soundjs.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/soundjs/soundjs.d.ts b/soundjs/soundjs.d.ts index 0cd0e71d2c..c5e09ca268 100644 --- a/soundjs/soundjs.d.ts +++ b/soundjs/soundjs.d.ts @@ -116,7 +116,7 @@ declare module createjs { getVolume(): number; mute(isMuted: boolean): boolean; pause(): boolean; - play(interrupt: string, delay: number, offset: number, loop: number, volume: number, pan: number): void; + play(interrupt?: string, delay?: number, offset?: number, loop?: number, volume?: number, pan?: number): void; resume(): boolean; setPan(value: number): number; setPosition(value: number): void; From cac75d05997394194d4fd553bb79df0ac821b560 Mon Sep 17 00:00:00 2001 From: Georgios Diamantopoulos Date: Wed, 28 Aug 2013 10:54:24 +0300 Subject: [PATCH 370/756] IHttpPromise updates success/error should retain the promise type also, the callback return should be void, any return value doesn't seem to be carried anywhere: http://jsfiddle.net/9syMH/ --- angularjs/angular.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 1e2b95cc58..86f0859b88 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -539,7 +539,7 @@ declare module ng { } interface IHttpPromiseCallback { - (data: T, status: number, headers: (headerName: string) => string, config: IRequestConfig): any; + (data: T, status: number, headers: (headerName: string) => string, config: IRequestConfig): void; } interface IHttpPromiseCallbackArg { @@ -550,8 +550,8 @@ declare module ng { } interface IHttpPromise extends IPromise { - success(callback: IHttpPromiseCallback): IHttpPromise; - error(callback: IHttpPromiseCallback): IHttpPromise; + success(callback: IHttpPromiseCallback): IHttpPromise; + error(callback: IHttpPromiseCallback): IHttpPromise; then(successCallback: (response: IHttpPromiseCallbackArg) => any, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; } From e41aa1f64d9ca7075a8fe92ae0134795f60434ac Mon Sep 17 00:00:00 2001 From: basarat Date: Wed, 28 Aug 2013 20:14:49 +1000 Subject: [PATCH 371/756] winjs/winrt from TypeScript samples --- README.md | 2 + winjs/winjs.d.ts | 208 + winrt/winrt.d.ts | 14644 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 14854 insertions(+) create mode 100644 winjs/winjs.d.ts create mode 100644 winrt/winrt.d.ts diff --git a/README.md b/README.md index 98f6ccdc44..811b1c5346 100755 --- a/README.md +++ b/README.md @@ -201,6 +201,8 @@ List of Definitions * [Viewporter](https://github.com/zynga/viewporter) (by [Boris Yankov](https://github.com/borisyankov)) * [Vimeo](http://developer.vimeo.com/player/js-api) (by [Daz Wilkin](https://github.com/DazWilkin/)) * [WebRTC](http://dev.w3.org/2011/webrtc/editor/webrtc.html) (by [Ken Smith](https://github.com/smithkl42)) +* [WinJS](http://msdn.microsoft.com/en-us/library/windows/apps/br229773.aspx) (from TypeScript samples) +* [WinRT](http://msdn.microsoft.com/en-us/library/windows/apps/br211377.aspx) (from TypeScript samples) * [YouTube](https://developers.google.com/youtube/) (by [Daz Wilkin](https://github.com/DazWilkin/)) * [YouTube Analytics API](https://developers.google.com/youtube/analytics/) (by [Frank M](https://github.com/sgtfrankieboy)) * [YouTube Data API](https://developers.google.com/youtube/v3/) (by [Frank M](https://github.com/sgtfrankieboy/)) diff --git a/winjs/winjs.d.ts b/winjs/winjs.d.ts new file mode 100644 index 0000000000..debd080d27 --- /dev/null +++ b/winjs/winjs.d.ts @@ -0,0 +1,208 @@ +/* ***************************************************************************** +Copyright (c) Microsoft Corporation. All rights reserved. +Licensed under the Apache License, Version 2.0 (the "License"); you may not use +this file except in compliance with the License. You may obtain a copy of the +License at http://www.apache.org/licenses/LICENSE-2.0 + +THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED +WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, +MERCHANTABLITY OR NON-INFRINGEMENT. + +See the Apache Version 2.0 License for specific language governing permissions +and limitations under the License. +***************************************************************************** */ + +declare module WinJS { + function strictProcessing(): void; + module Binding { + function as(data: any): any; + class List { + constructor(data: any[]); + public push(item: any): any; + public indexOf(item: any): number; + public splice(index: number, count: number, newelems: any[]): any[]; + public splice(index: number, count: number): any[]; + public splice(index: number): any[]; + public createFiltered(predicate: (x: any) => boolean): List; + public createGrouped(keySelector: (x: any) => any, dataSelector: (x:any) => any): List; + public groups: any; + public dataSource: any; + public getAt: any; + } + } + module Namespace { + var define: any; + var defineWithParent: any; + } + module Class { + function define(constructor: any, instanceMembers: any): any; + function derive(baseClass: any, constructor: any, instanceMembers: any): any; + function mix(constructor: any, mixin: any): any; + } + function xhr(options: { type?: string; url?: string; user?: string; password?: string; headers?: any; data?: any; responseType?: string; }): WinJS.Promise; + module Application { + interface IOHelper { + exists(filename: string): boolean; + readText(fileName: string, def: string): WinJS.Promise; + readText(fileName: string): WinJS.Promise; + writeText(fileName: string, text: string): WinJS.Promise; + remove(fileName: string): WinJS.Promise; + } + var local: IOHelper; + var roaming: IOHelper; + var onactivated: EventListener; + var sessionState: any; + interface ApplicationActivationEvent extends Event { + detail: any; + setPromise(p: Promise): any; + } + function addEventListener(type: string, listener: EventListener, capture?: boolean): void; + var oncheckpoint: EventListener; + function start(): void; + function stop(): void; + } + class Promise { + constructor(init: (c: any, e: any, p: any) => void); + then(success?: (value: T) => Promise, error?: (error: any) => Promise, progress?: (progress: any) => void ): Promise; + then(success?: (value: T) => Promise, error?: (error: any) => U, progress?: (progress: any) => void ): Promise; + then(success?: (value: T) => U, error?: (error: any) => Promise, progress?: (progress: any) => void ): Promise; + then(success?: (value: T) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Promise; + done(success?: (value: T) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + static join: any; + static timeout: any; + } + module Navigation { + var history: any; + var canGoBack: boolean; + var canGoForward: boolean; + var location: string; + var state: any; + function addEventListener(type: string, listener: EventListener, capture: boolean): void; + function back(): void; + function forward(): void; + function navigate(location: any, initialState: any); + function navigate(location: any); + function removeEventListener(type: string, listener: EventListener, capture: boolean): void; + var onbeforenavigate: CustomEvent; + var onnavigated: CustomEvent; + var onnavigating: CustomEvent; + } + module Utilities { + function markSupportedForProcessing(obj: any): void; + enum Key { + backspace, + tab, + enter, + shift, + ctrl, + alt, + pause, + capsLock, + escape, + space, + pageUp, + pageDown, + end, + home, + leftArrow, + upArrow, + rightArrow, + downArrow, + insert, + deleteKey, + num0, + num1, + num2, + num3, + num4, + num5, + num6, + num7, + num8, + num9, + a, + b, + c, + d, + e, + f, + g, + h, + i, + j, + k, + l, + m, + n, + o, + p, + q, + r, + s, + t, + u, + v, + w, + x, + y, + z, + leftWindows, + rightWindows, + numPad0, + numPad1, + numPad2, + numPad3, + numPad4, + numPad5, + numPad6, + numPad7, + numPad8, + numPad9, + multiply, + add, + subtract, + decimalPoint, + divide, + f1, + f2, + f3, + f4, + f5, + f6, + f7, + f8, + f9, + f10, + f11, + f12, + numLock, + scrollLock, + semicolon, + equal, + comma, + dash, + period, + forwardSlash, + graveAccent, + openBracket, + backSlash, + closeBracket, + singleQuote + } + } + module UI { + var process: any; + var processAll: any; + var ListLayout: any; + var GridLayout: any; + var Pages: any; + var Menu: any; + var setOptions: any; + } +} + +interface Element { + winControl: any; // TODO: This should be control? +} + diff --git a/winrt/winrt.d.ts b/winrt/winrt.d.ts new file mode 100644 index 0000000000..11f1dba862 --- /dev/null +++ b/winrt/winrt.d.ts @@ -0,0 +1,14644 @@ +/* ***************************************************************************** +Copyright (c) Microsoft Corporation. All rights reserved. +Licensed under the Apache License, Version 2.0 (the "License"); you may not use +this file except in compliance with the License. You may obtain a copy of the +License at http://www.apache.org/licenses/LICENSE-2.0 + +THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED +WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, +MERCHANTABLITY OR NON-INFRINGEMENT. + +See the Apache Version 2.0 License for specific language governing permissions +and limitations under the License. +***************************************************************************** */ + +declare module Windows { + export module Foundation { + export module Collections { + export enum CollectionChange { + reset, + itemInserted, + itemRemoved, + itemChanged, + } + export interface IVectorChangedEventArgs { + collectionChange: Windows.Foundation.Collections.CollectionChange; + index: number; + } + export interface IPropertySet extends Windows.Foundation.Collections.IObservableMap, Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + } + export class PropertySet implements Windows.Foundation.Collections.IPropertySet, Windows.Foundation.Collections.IObservableMap, Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + size: number; + onmapchanged: any/* TODO */; + lookup(key: string): any; + hasKey(key: string): boolean; + getView(): Windows.Foundation.Collections.IMapView; + insert(key: string, value: any): boolean; + remove(key: string): void; + clear(): void; + first(): Windows.Foundation.Collections.IIterator>; + } + export interface IIterable { + first(): Windows.Foundation.Collections.IIterator; + } + export interface IIterator { + current: T; + hasCurrent: boolean; + moveNext(): boolean; + getMany(): { items: T[]; returnValue: number; }; + } + export interface IVectorView extends Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): T; + indexOf(value: T): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: T[]; returnValue: number; }; + + toString(): string; + toLocaleString(): string; + concat(...items: T[][]): T[]; + join(seperator: string): string; + pop(): T; + push(...items: T[]): void; + reverse(): T[]; + shift(): T; + slice(start: number): T[]; + slice(start: number, end: number): T[]; + sort(): T[]; + sort(compareFn: (a: T, b: T) => number): T[]; + splice(start: number): T[]; + splice(start: number, deleteCount: number, ...items: T[]): T[]; + unshift(...items: T[]): number; + lastIndexOf(searchElement: T): number; + lastIndexOf(searchElement: T, fromIndex: number): number; + every(callbackfn: (value: T, index: number, array: T[]) => boolean): boolean; + every(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: T, index: number, array: T[]) => boolean): boolean; + some(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: T, index: number, array: T[]) => void ): void; + forEach(callbackfn: (value: T, index: number, array: T[]) => void , thisArg: any): void; + map(callbackfn: (value: T, index: number, array: T[]) => any): any[]; + map(callbackfn: (value: T, index: number, array: T[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: T, index: number, array: T[]) => boolean): T[]; + filter(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg: any): T[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: T[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: T[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: T[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: T[]) => any, initialValue: any): any; + length: number; + } + export interface IVector extends Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): T; + getView(): Windows.Foundation.Collections.IVectorView; + indexOf(value: T): { index: number; returnValue: boolean; }; + setAt(index: number, value: T): void; + insertAt(index: number, value: T): void; + removeAt(index: number): void; + append(value: T): void; + removeAtEnd(): void; + clear(): void; + getMany(startIndex: number): { items: T[]; returnValue: number; }; + replaceAll(items: T[]): void; + + toString(): string; + toLocaleString(): string; + concat(...items: T[][]): T[]; + join(seperator: string): string; + pop(): T; + push(...items: T[]): void; + reverse(): T[]; + shift(): T; + slice(start: number): T[]; + slice(start: number, end: number): T[]; + sort(): T[]; + sort(compareFn: (a: T, b: T) => number): T[]; + splice(start: number): T[]; + splice(start: number, deleteCount: number, ...items: T[]): T[]; + unshift(...items: T[]): number; + lastIndexOf(searchElement: T): number; + lastIndexOf(searchElement: T, fromIndex: number): number; + every(callbackfn: (value: T, index: number, array: T[]) => boolean): boolean; + every(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: T, index: number, array: T[]) => boolean): boolean; + some(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: T, index: number, array: T[]) => void ): void; + forEach(callbackfn: (value: T, index: number, array: T[]) => void , thisArg: any): void; + map(callbackfn: (value: T, index: number, array: T[]) => any): any[]; + map(callbackfn: (value: T, index: number, array: T[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: T, index: number, array: T[]) => boolean): T[]; + filter(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg: any): T[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: T[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: T[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: T[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: T[]) => any, initialValue: any): any; + length: number; + } + export interface IKeyValuePair { + key: K; + value: V; + } + export interface IMap extends Windows.Foundation.Collections.IIterable> { + size: number; + lookup(key: K): V; + hasKey(key: K): boolean; + getView(): Windows.Foundation.Collections.IMapView; + insert(key: K, value: V): boolean; + remove(key: K): void; + clear(): void; + } + export interface IMapView extends Windows.Foundation.Collections.IIterable> { + size: number; + lookup(key: K): V; + hasKey(key: K): boolean; + split(): { first: Windows.Foundation.Collections.IMapView; second: Windows.Foundation.Collections.IMapView; }; + } + export interface VectorChangedEventHandler { + (sender: Windows.Foundation.Collections.IObservableVector, event: Windows.Foundation.Collections.IVectorChangedEventArgs): void; + } + export interface IObservableVector extends Windows.Foundation.Collections.IVector, Windows.Foundation.Collections.IIterable { + onvectorchanged: any/* TODO */; + } + export interface IMapChangedEventArgs { + collectionChange: Windows.Foundation.Collections.CollectionChange; + key: K; + } + export interface MapChangedEventHandler { + (sender: Windows.Foundation.Collections.IObservableMap, event: Windows.Foundation.Collections.IMapChangedEventArgs): void; + } + export interface IObservableMap extends Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + onmapchanged: any/* TODO */; + } + } + } +} +declare module Windows { + export module Foundation { + export interface IUriRuntimeClass { + absoluteUri: string; + displayUri: string; + domain: string; + extension: string; + fragment: string; + host: string; + password: string; + path: string; + port: number; + query: string; + queryParsed: Windows.Foundation.WwwFormUrlDecoder; + rawUri: string; + schemeName: string; + suspicious: boolean; + userName: string; + equals(pUri: Windows.Foundation.Uri): boolean; + combineUri(relativeUri: string): Windows.Foundation.Uri; + } + export class WwwFormUrlDecoder implements Windows.Foundation.IWwwFormUrlDecoderRuntimeClass, Windows.Foundation.Collections.IIterable, Windows.Foundation.Collections.IVectorView { + constructor(query: string); + size: number; + getFirstValueByName(name: string): string; + first(): Windows.Foundation.Collections.IIterator; + getAt(index: number): Windows.Foundation.IWwwFormUrlDecoderEntry; + indexOf(value: Windows.Foundation.IWwwFormUrlDecoderEntry): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: Windows.Foundation.IWwwFormUrlDecoderEntry[]; returnValue: number; }; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.Foundation.IWwwFormUrlDecoderEntry[][]): Windows.Foundation.IWwwFormUrlDecoderEntry[]; + join(seperator: string): string; + pop(): Windows.Foundation.IWwwFormUrlDecoderEntry; + push(...items: Windows.Foundation.IWwwFormUrlDecoderEntry[]): void; + reverse(): Windows.Foundation.IWwwFormUrlDecoderEntry[]; + shift(): Windows.Foundation.IWwwFormUrlDecoderEntry; + slice(start: number): Windows.Foundation.IWwwFormUrlDecoderEntry[]; + slice(start: number, end: number): Windows.Foundation.IWwwFormUrlDecoderEntry[]; + sort(): Windows.Foundation.IWwwFormUrlDecoderEntry[]; + sort(compareFn: (a: Windows.Foundation.IWwwFormUrlDecoderEntry, b: Windows.Foundation.IWwwFormUrlDecoderEntry) => number): Windows.Foundation.IWwwFormUrlDecoderEntry[]; + splice(start: number): Windows.Foundation.IWwwFormUrlDecoderEntry[]; + splice(start: number, deleteCount: number, ...items: Windows.Foundation.IWwwFormUrlDecoderEntry[]): Windows.Foundation.IWwwFormUrlDecoderEntry[]; + unshift(...items: Windows.Foundation.IWwwFormUrlDecoderEntry[]): number; + lastIndexOf(searchElement: Windows.Foundation.IWwwFormUrlDecoderEntry): number; + lastIndexOf(searchElement: Windows.Foundation.IWwwFormUrlDecoderEntry, fromIndex: number): number; + every(callbackfn: (value: Windows.Foundation.IWwwFormUrlDecoderEntry, index: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => boolean): boolean; + every(callbackfn: (value: Windows.Foundation.IWwwFormUrlDecoderEntry, index: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.Foundation.IWwwFormUrlDecoderEntry, index: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => boolean): boolean; + some(callbackfn: (value: Windows.Foundation.IWwwFormUrlDecoderEntry, index: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.Foundation.IWwwFormUrlDecoderEntry, index: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => void ): void; + forEach(callbackfn: (value: Windows.Foundation.IWwwFormUrlDecoderEntry, index: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.Foundation.IWwwFormUrlDecoderEntry, index: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => any): any[]; + map(callbackfn: (value: Windows.Foundation.IWwwFormUrlDecoderEntry, index: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.Foundation.IWwwFormUrlDecoderEntry, index: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => boolean): Windows.Foundation.IWwwFormUrlDecoderEntry[]; + filter(callbackfn: (value: Windows.Foundation.IWwwFormUrlDecoderEntry, index: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => boolean, thisArg: any): Windows.Foundation.IWwwFormUrlDecoderEntry[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Foundation.IWwwFormUrlDecoderEntry[]) => any, initialValue: any): any; + length: number; + } + export class Uri implements Windows.Foundation.IUriRuntimeClass, Windows.Foundation.IUriRuntimeClassWithAbsoluteCanonicalUri { + constructor(uri: string); + constructor(baseUri: string, relativeUri: string); + absoluteUri: string; + displayUri: string; + domain: string; + extension: string; + fragment: string; + host: string; + password: string; + path: string; + port: number; + query: string; + queryParsed: Windows.Foundation.WwwFormUrlDecoder; + rawUri: string; + schemeName: string; + suspicious: boolean; + userName: string; + absoluteCanonicalUri: string; + displayIri: string; + equals(pUri: Windows.Foundation.Uri): boolean; + combineUri(relativeUri: string): Windows.Foundation.Uri; + static unescapeComponent(toUnescape: string): string; + static escapeComponent(toEscape: string): string; + } + export interface IUriRuntimeClassWithAbsoluteCanonicalUri { + absoluteCanonicalUri: string; + displayIri: string; + } + export interface IUriEscapeStatics { + unescapeComponent(toUnescape: string): string; + escapeComponent(toEscape: string): string; + } + export interface IUriRuntimeClassFactory { + createUri(uri: string): Windows.Foundation.Uri; + createUri(baseUri: string, relativeUri: string): Windows.Foundation.Uri; + } + export interface IWwwFormUrlDecoderEntry { + name: string; + value: string; + } + export interface IWwwFormUrlDecoderRuntimeClass extends Windows.Foundation.Collections.IIterable, Windows.Foundation.Collections.IVectorView { + getFirstValueByName(name: string): string; + } + export interface IWwwFormUrlDecoderRuntimeClassFactory { + createWwwFormUrlDecoder(query: string): Windows.Foundation.WwwFormUrlDecoder; + } + export interface IGetActivationFactory { + getActivationFactory(activatableClassId: string): any; + } + export interface IClosable { + close(): void; + } + export enum PropertyType { + empty, + uInt8, + int16, + uInt16, + int32, + uInt32, + int64, + uInt64, + single, + double, + char16, + boolean, + string, + inspectable, + dateTime, + timeSpan, + guid, + point, + size, + rect, + otherType, + uInt8Array, + int16Array, + uInt16Array, + int32Array, + uInt32Array, + int64Array, + uInt64Array, + singleArray, + doubleArray, + char16Array, + booleanArray, + stringArray, + inspectableArray, + dateTimeArray, + timeSpanArray, + guidArray, + pointArray, + sizeArray, + rectArray, + otherTypeArray, + } + export interface Point { + x: number; + y: number; + } + export interface Size { + width: number; + height: number; + } + export interface Rect { + x: number; + y: number; + width: number; + height: number; + } + export interface DateTime { + universalTime: number; + } + export interface TimeSpan { + duration: number; + } + export interface IPropertyValue { + isNumericScalar: boolean; + type: Windows.Foundation.PropertyType; + getUInt8(): number; + getInt16(): number; + getUInt16(): number; + getInt32(): number; + getUInt32(): number; + getInt64(): number; + getUInt64(): number; + getSingle(): number; + getDouble(): number; + getChar16(): string; + getBoolean(): boolean; + getString(): string; + getGuid(): string; + getDateTime(): Date; + getTimeSpan(): number; + getPoint(): Windows.Foundation.Point; + getSize(): Windows.Foundation.Size; + getRect(): Windows.Foundation.Rect; + getUInt8Array(): Uint8Array; + getInt16Array(): Int16Array; + getUInt16Array(): Uint16Array; + getInt32Array(): Int32Array; + getUInt32Array(): Uint32Array; + getInt64Array(): number[]; + getUInt64Array(): number[]; + getSingleArray(): Float32Array; + getDoubleArray(): Float64Array; + getChar16Array(): string[]; + getBooleanArray(): boolean[]; + getStringArray(): string[]; + getInspectableArray(): any[]; + getGuidArray(): string[]; + getDateTimeArray(): Date[]; + getTimeSpanArray(): number[]; + getPointArray(): Windows.Foundation.Point[]; + getSizeArray(): Windows.Foundation.Size[]; + getRectArray(): Windows.Foundation.Rect[]; + } + export interface IPropertyValueStatics { + createEmpty(): any; + createUInt8(value: number): any; + createInt16(value: number): any; + createUInt16(value: number): any; + createInt32(value: number): any; + createUInt32(value: number): any; + createInt64(value: number): any; + createUInt64(value: number): any; + createSingle(value: number): any; + createDouble(value: number): any; + createChar16(value: string): any; + createBoolean(value: boolean): any; + createString(value: string): any; + createInspectable(value: any): any; + createGuid(value: string): any; + createDateTime(value: Date): any; + createTimeSpan(value: number): any; + createPoint(value: Windows.Foundation.Point): any; + createSize(value: Windows.Foundation.Size): any; + createRect(value: Windows.Foundation.Rect): any; + createUInt8Array(value: Uint8Array): any; + createInt16Array(value: Int16Array): any; + createUInt16Array(value: Uint16Array): any; + createInt32Array(value: Int32Array): any; + createUInt32Array(value: Uint32Array): any; + createInt64Array(value: number[]): any; + createUInt64Array(value: number[]): any; + createSingleArray(value: Float32Array): any; + createDoubleArray(value: Float64Array): any; + createChar16Array(value: string[]): any; + createBooleanArray(value: boolean[]): any; + createStringArray(value: string[]): any; + createInspectableArray(value: any[]): any; + createGuidArray(value: string[]): any; + createDateTimeArray(value: Date[]): any; + createTimeSpanArray(value: number[]): any; + createPointArray(value: Windows.Foundation.Point[]): any; + createSizeArray(value: Windows.Foundation.Size[]): any; + createRectArray(value: Windows.Foundation.Rect[]): any; + } + export class PropertyValue { + static createEmpty(): any; + static createUInt8(value: number): any; + static createInt16(value: number): any; + static createUInt16(value: number): any; + static createInt32(value: number): any; + static createUInt32(value: number): any; + static createInt64(value: number): any; + static createUInt64(value: number): any; + static createSingle(value: number): any; + static createDouble(value: number): any; + static createChar16(value: string): any; + static createBoolean(value: boolean): any; + static createString(value: string): any; + static createInspectable(value: any): any; + static createGuid(value: string): any; + static createDateTime(value: Date): any; + static createTimeSpan(value: number): any; + static createPoint(value: Windows.Foundation.Point): any; + static createSize(value: Windows.Foundation.Size): any; + static createRect(value: Windows.Foundation.Rect): any; + static createUInt8Array(value: Uint8Array): any; + static createInt16Array(value: Int16Array): any; + static createUInt16Array(value: Uint16Array): any; + static createInt32Array(value: Int32Array): any; + static createUInt32Array(value: Uint32Array): any; + static createInt64Array(value: number[]): any; + static createUInt64Array(value: number[]): any; + static createSingleArray(value: Float32Array): any; + static createDoubleArray(value: Float64Array): any; + static createChar16Array(value: string[]): any; + static createBooleanArray(value: boolean[]): any; + static createStringArray(value: string[]): any; + static createInspectableArray(value: any[]): any; + static createGuidArray(value: string[]): any; + static createDateTimeArray(value: Date[]): any; + static createTimeSpanArray(value: number[]): any; + static createPointArray(value: Windows.Foundation.Point[]): any; + static createSizeArray(value: Windows.Foundation.Size[]): any; + static createRectArray(value: Windows.Foundation.Rect[]): any; + } + export interface AsyncActionCompletedHandler { + (asyncInfo: Windows.Foundation.IAsyncAction, asyncStatus: Windows.Foundation.AsyncStatus): void; + } + export enum AsyncStatus { + canceled, + completed, + error, + started, + } + export interface EventRegistrationToken { + value: number; + } + export interface HResult { + value: number; + } + export interface IAsyncInfo { + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + cancel(): void; + close(): void; + } + export interface IAsyncAction extends Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncActionCompletedHandler; + getResults(): void; + } + export interface AsyncOperationWithProgressCompletedHandler { + (asyncInfo: Windows.Foundation.IAsyncOperationWithProgress, asyncStatus: Windows.Foundation.AsyncStatus): void; + } + export interface IAsyncOperationWithProgress extends Windows.Foundation.IPromise { + operation: { + progress: Windows.Foundation.AsyncOperationProgressHandler; + completed: Windows.Foundation.AsyncOperationWithProgressCompletedHandler; + getResults(): TResult; + } + } + export interface AsyncOperationCompletedHandler { + (asyncInfo: Windows.Foundation.IAsyncOperation, asyncStatus: Windows.Foundation.AsyncStatus): void; + } + export interface IAsyncOperation extends Windows.Foundation.IPromise { + operation: { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + getResults(): TResult; + } + } + export interface AsyncActionWithProgressCompletedHandler { + (asyncInfo: Windows.Foundation.IAsyncActionWithProgress, asyncStatus: Windows.Foundation.AsyncStatus): void; + } + export interface IAsyncActionWithProgress extends Windows.Foundation.IAsyncInfo { + progress: Windows.Foundation.AsyncActionProgressHandler; + completed: Windows.Foundation.AsyncActionWithProgressCompletedHandler; + getResults(): void; + } + export interface AsyncOperationProgressHandler { + (asyncInfo: Windows.Foundation.IAsyncOperationWithProgress, progressInfo: TProgress): void; + } + export interface AsyncActionProgressHandler { + (asyncInfo: Windows.Foundation.IAsyncActionWithProgress, progressInfo: TProgress): void; + } + export interface IReference extends Windows.Foundation.IPropertyValue { + value: T; + } + export interface IReferenceArray extends Windows.Foundation.IPropertyValue { + value: T[]; + } + export interface TypedEventHandler { + (sender: TSender, args: TResult): void; + } + export interface EventHandler { + (sender: any, args: T): void; + } + } +} +declare module Windows { + export module Foundation { + export module Metadata { + export class WebHostHiddenAttribute { + } + export class VariantAttribute { + } + export class HasVariantAttribute { + } + export class DualApiPartitionAttribute { + } + export class MuseAttribute { + } + export enum GCPressureAmount { + low, + medium, + high, + } + export class GCPressureAttribute { + } + export class ActivatableAttribute { + constructor(version: number); + constructor(type: string /* TODO: really? */, version: number); + } + export class VersionAttribute { + constructor(version: number); + } + export class AllowMultipleAttribute { + } + export class AttributeUsageAttribute { + constructor(targets: Windows.Foundation.Metadata.AttributeTargets /* TODO: Really part of WinRT? */); + } + export enum AttributeTargets { + all, + delegate, + enum, + event, + field, + interface, + method, + parameter, + property, + runtimeClass, + struct, + interfaceImpl, + } + export class DefaultOverloadAttribute { + } + export class DefaultAttribute { + } + export class GuidAttribute { + constructor(a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number); + } + export class ComposableAttribute { + constructor(type: string /* TODO: really? */, compositionType: Windows.Foundation.Metadata.CompositionType, version: number); + } + export enum CompositionType { + protected, + public, + } + export class OverloadAttribute { + constructor(method: string); + } + export class StaticAttribute { + constructor(type: string /* TODO: really? */, version: number); + } + export class OverridableAttribute { + } + export class ProtectedAttribute { + } + export class ThreadingAttribute { + constructor(model: Windows.Foundation.Metadata.ThreadingModel); + } + export enum ThreadingModel { + sTA, + mTA, + both, + invalidThreading, + } + export class MarshalingBehaviorAttribute { + constructor(behavior: Windows.Foundation.Metadata.MarshalingType); + } + export enum MarshalingType { + none, + agile, + standard, + invalidMarshaling, + } + export class ExclusiveToAttribute { + constructor(typeName: string /* TODO: really? */); + } + export class LengthIsAttribute { + constructor(indexLengthParameter: number); + } + export class RangeAttribute { + constructor(minValue: number, maxValue: number); + } + } + } +} +declare module Windows { + export module Foundation { + export module Diagnostics { + export enum ErrorOptions { + none, + suppressExceptions, + forceExceptions, + useSetErrorInfo, + suppressSetErrorInfo, + } + export interface IErrorReportingSettings { + setErrorOptions(value: Windows.Foundation.Diagnostics.ErrorOptions): void; + getErrorOptions(): Windows.Foundation.Diagnostics.ErrorOptions; + } + export class RuntimeBrokerErrorSettings implements Windows.Foundation.Diagnostics.IErrorReportingSettings { + setErrorOptions(value: Windows.Foundation.Diagnostics.ErrorOptions): void; + getErrorOptions(): Windows.Foundation.Diagnostics.ErrorOptions; + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module Background { + export enum BackgroundAccessStatus { + unspecified, + allowedWithAlwaysOnRealTimeConnectivity, + allowedMayUseActiveRealTimeConnectivity, + denied, + } + export interface IBackgroundExecutionManagerStatics { + requestAccessAsync(): Windows.Foundation.IAsyncOperation; + requestAccessAsync(applicationId: string): Windows.Foundation.IAsyncOperation; + removeAccess(): void; + removeAccess(applicationId: string): void; + getAccessStatus(): Windows.ApplicationModel.Background.BackgroundAccessStatus; + getAccessStatus(applicationId: string): Windows.ApplicationModel.Background.BackgroundAccessStatus; + } + export class BackgroundExecutionManager { + static requestAccessAsync(): Windows.Foundation.IAsyncOperation; + static requestAccessAsync(applicationId: string): Windows.Foundation.IAsyncOperation; + static removeAccess(): void; + static removeAccess(applicationId: string): void; + static getAccessStatus(): Windows.ApplicationModel.Background.BackgroundAccessStatus; + static getAccessStatus(applicationId: string): Windows.ApplicationModel.Background.BackgroundAccessStatus; + } + export enum BackgroundTaskCancellationReason { + abort, + terminating, + loggingOff, + servicingUpdate, + } + export interface BackgroundTaskCanceledEventHandler { + (sender: Windows.ApplicationModel.Background.IBackgroundTaskInstance, reason: Windows.ApplicationModel.Background.BackgroundTaskCancellationReason): void; + } + export interface IBackgroundTaskInstance { + instanceId: string; + progress: number; + suspendedCount: number; + task: Windows.ApplicationModel.Background.BackgroundTaskRegistration; + triggerDetails: any; + oncanceled: any/* TODO */; + getDeferral(): Windows.ApplicationModel.Background.BackgroundTaskDeferral; + } + export class BackgroundTaskRegistration implements Windows.ApplicationModel.Background.IBackgroundTaskRegistration { + name: string; + taskId: string; + onprogress: any/* TODO */; + oncompleted: any/* TODO */; + unregister(cancelTask: boolean): void; + static allTasks: Windows.Foundation.Collections.IMapView; + } + export class BackgroundTaskDeferral implements Windows.ApplicationModel.Background.IBackgroundTaskDeferral { + complete(): void; + } + export interface BackgroundTaskProgressEventHandler { + (sender: Windows.ApplicationModel.Background.BackgroundTaskRegistration, args: Windows.ApplicationModel.Background.BackgroundTaskProgressEventArgs): void; + } + export class BackgroundTaskProgressEventArgs implements Windows.ApplicationModel.Background.IBackgroundTaskProgressEventArgs { + instanceId: string; + progress: number; + } + export interface BackgroundTaskCompletedEventHandler { + (sender: Windows.ApplicationModel.Background.BackgroundTaskRegistration, args: Windows.ApplicationModel.Background.BackgroundTaskCompletedEventArgs): void; + } + export class BackgroundTaskCompletedEventArgs implements Windows.ApplicationModel.Background.IBackgroundTaskCompletedEventArgs { + instanceId: string; + checkResult(): void; + } + export interface IBackgroundTaskDeferral { + complete(): void; + } + export interface IBackgroundTask { + run(taskInstance: Windows.ApplicationModel.Background.IBackgroundTaskInstance): void; + } + export interface IBackgroundTaskRegistration { + name: string; + taskId: string; + onprogress: any/* TODO */; + oncompleted: any/* TODO */; + unregister(cancelTask: boolean): void; + } + export interface IBackgroundTaskRegistrationStatics { + allTasks: Windows.Foundation.Collections.IMapView; + } + export interface IBackgroundTaskBuilder { + name: string; + taskEntryPoint: string; + setTrigger(trigger: Windows.ApplicationModel.Background.IBackgroundTrigger): void; + addCondition(condition: Windows.ApplicationModel.Background.IBackgroundCondition): void; + register(): Windows.ApplicationModel.Background.BackgroundTaskRegistration; + } + export interface IBackgroundTrigger { + } + export interface IBackgroundCondition { + } + export interface IBackgroundTaskCompletedEventArgs { + instanceId: string; + checkResult(): void; + } + export interface IBackgroundTaskProgressEventArgs { + instanceId: string; + progress: number; + } + export class BackgroundTaskBuilder implements Windows.ApplicationModel.Background.IBackgroundTaskBuilder { + name: string; + taskEntryPoint: string; + setTrigger(trigger: Windows.ApplicationModel.Background.IBackgroundTrigger): void; + addCondition(condition: Windows.ApplicationModel.Background.IBackgroundCondition): void; + register(): Windows.ApplicationModel.Background.BackgroundTaskRegistration; + } + export enum SystemTriggerType { + invalid, + smsReceived, + userPresent, + userAway, + networkStateChange, + controlChannelReset, + internetAvailable, + sessionConnected, + servicingComplete, + lockScreenApplicationAdded, + lockScreenApplicationRemoved, + timeZoneChange, + onlineIdConnectedStateChange, + } + export enum SystemConditionType { + invalid, + userPresent, + userNotPresent, + internetAvailable, + internetNotAvailable, + sessionConnected, + sessionDisconnected, + } + export interface ISystemTrigger extends Windows.ApplicationModel.Background.IBackgroundTrigger { + oneShot: boolean; + triggerType: Windows.ApplicationModel.Background.SystemTriggerType; + } + export interface ISystemTriggerFactory { + create(triggerType: Windows.ApplicationModel.Background.SystemTriggerType, oneShot: boolean): Windows.ApplicationModel.Background.SystemTrigger; + } + export class SystemTrigger implements Windows.ApplicationModel.Background.ISystemTrigger, Windows.ApplicationModel.Background.IBackgroundTrigger { + constructor(triggerType: Windows.ApplicationModel.Background.SystemTriggerType, oneShot: boolean); + oneShot: boolean; + triggerType: Windows.ApplicationModel.Background.SystemTriggerType; + } + export interface ISystemCondition extends Windows.ApplicationModel.Background.IBackgroundCondition { + conditionType: Windows.ApplicationModel.Background.SystemConditionType; + } + export interface ISystemConditionFactory { + create(conditionType: Windows.ApplicationModel.Background.SystemConditionType): Windows.ApplicationModel.Background.SystemCondition; + } + export class SystemCondition implements Windows.ApplicationModel.Background.ISystemCondition, Windows.ApplicationModel.Background.IBackgroundCondition { + constructor(conditionType: Windows.ApplicationModel.Background.SystemConditionType); + conditionType: Windows.ApplicationModel.Background.SystemConditionType; + } + export interface INetworkOperatorNotificationTrigger extends Windows.ApplicationModel.Background.IBackgroundTrigger { + networkAccountId: string; + } + export interface INetworkOperatorNotificationTriggerFactory { + create(networkAccountId: string): Windows.ApplicationModel.Background.NetworkOperatorNotificationTrigger; + } + export class NetworkOperatorNotificationTrigger implements Windows.ApplicationModel.Background.INetworkOperatorNotificationTrigger, Windows.ApplicationModel.Background.IBackgroundTrigger { + constructor(networkAccountId: string); + networkAccountId: string; + } + export interface ITimeTrigger extends Windows.ApplicationModel.Background.IBackgroundTrigger { + freshnessTime: number; + oneShot: boolean; + } + export interface ITimeTriggerFactory { + create(freshnessTime: number, oneShot: boolean): Windows.ApplicationModel.Background.TimeTrigger; + } + export class TimeTrigger implements Windows.ApplicationModel.Background.ITimeTrigger, Windows.ApplicationModel.Background.IBackgroundTrigger { + constructor(freshnessTime: number, oneShot: boolean); + freshnessTime: number; + oneShot: boolean; + } + export interface IMaintenanceTrigger extends Windows.ApplicationModel.Background.IBackgroundTrigger { + freshnessTime: number; + oneShot: boolean; + } + export interface IMaintenanceTriggerFactory { + create(freshnessTime: number, oneShot: boolean): Windows.ApplicationModel.Background.MaintenanceTrigger; + } + export class MaintenanceTrigger implements Windows.ApplicationModel.Background.IMaintenanceTrigger, Windows.ApplicationModel.Background.IBackgroundTrigger { + constructor(freshnessTime: number, oneShot: boolean); + freshnessTime: number; + oneShot: boolean; + } + export interface INetworkOperatorHotspotAuthenticationTrigger extends Windows.ApplicationModel.Background.IBackgroundTrigger { + } + export class NetworkOperatorHotspotAuthenticationTrigger implements Windows.ApplicationModel.Background.INetworkOperatorHotspotAuthenticationTrigger, Windows.ApplicationModel.Background.IBackgroundTrigger { + } + export interface IPushNotificationTriggerFactory { + create(applicationId: string): Windows.ApplicationModel.Background.PushNotificationTrigger; + } + export class PushNotificationTrigger implements Windows.ApplicationModel.Background.IBackgroundTrigger { + constructor(applicationId: string); + constructor(); + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module Contacts { + export enum ContactFieldType { + email, + phoneNumber, + location, + instantMessage, + custom, + } + export enum ContactFieldCategory { + none, + home, + work, + mobile, + other, + } + export enum ContactSelectionMode { + contacts, + fields, + } + export interface IContactField { + category: Windows.ApplicationModel.Contacts.ContactFieldCategory; + name: string; + type: Windows.ApplicationModel.Contacts.ContactFieldType; + value: string; + } + export class ContactField implements Windows.ApplicationModel.Contacts.IContactField { + constructor(value: string, type: Windows.ApplicationModel.Contacts.ContactFieldType); + constructor(value: string, type: Windows.ApplicationModel.Contacts.ContactFieldType, category: Windows.ApplicationModel.Contacts.ContactFieldCategory); + constructor(name: string, value: string, type: Windows.ApplicationModel.Contacts.ContactFieldType, category: Windows.ApplicationModel.Contacts.ContactFieldCategory); + category: Windows.ApplicationModel.Contacts.ContactFieldCategory; + name: string; + type: Windows.ApplicationModel.Contacts.ContactFieldType; + value: string; + } + export interface IContactLocationField extends Windows.ApplicationModel.Contacts.IContactField { + city: string; + country: string; + postalCode: string; + region: string; + street: string; + unstructuredAddress: string; + } + export class ContactLocationField implements Windows.ApplicationModel.Contacts.IContactLocationField, Windows.ApplicationModel.Contacts.IContactField { + constructor(unstructuredAddress: string); + constructor(unstructuredAddress: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory); + constructor(unstructuredAddress: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory, street: string, city: string, region: string, country: string, postalCode: string); + city: string; + country: string; + postalCode: string; + region: string; + street: string; + unstructuredAddress: string; + category: Windows.ApplicationModel.Contacts.ContactFieldCategory; + name: string; + type: Windows.ApplicationModel.Contacts.ContactFieldType; + value: string; + } + export interface IContactInstantMessageField extends Windows.ApplicationModel.Contacts.IContactField { + displayText: string; + launchUri: Windows.Foundation.Uri; + service: string; + userName: string; + } + export class ContactInstantMessageField implements Windows.ApplicationModel.Contacts.IContactInstantMessageField, Windows.ApplicationModel.Contacts.IContactField { + constructor(userName: string); + constructor(userName: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory); + constructor(userName: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory, service: string, displayText: string, verb: Windows.Foundation.Uri); + displayText: string; + launchUri: Windows.Foundation.Uri; + service: string; + userName: string; + category: Windows.ApplicationModel.Contacts.ContactFieldCategory; + name: string; + type: Windows.ApplicationModel.Contacts.ContactFieldType; + value: string; + } + export interface IKnownContactFieldStatics { + email: string; + instantMessage: string; + location: string; + phoneNumber: string; + convertNameToType(name: string): Windows.ApplicationModel.Contacts.ContactFieldType; + convertTypeToName(type: Windows.ApplicationModel.Contacts.ContactFieldType): string; + } + export class KnownContactField { + static email: string; + static instantMessage: string; + static location: string; + static phoneNumber: string; + static convertNameToType(name: string): Windows.ApplicationModel.Contacts.ContactFieldType; + static convertTypeToName(type: Windows.ApplicationModel.Contacts.ContactFieldType): string; + } + export interface IContactInformation { + customFields: Windows.Foundation.Collections.IVectorView; + emails: Windows.Foundation.Collections.IVectorView; + instantMessages: Windows.Foundation.Collections.IVectorView; + locations: Windows.Foundation.Collections.IVectorView; + name: string; + phoneNumbers: Windows.Foundation.Collections.IVectorView; + getThumbnailAsync(): Windows.Foundation.IAsyncOperation; + queryCustomFields(customName: string): Windows.Foundation.Collections.IVectorView; + } + export class ContactInformation implements Windows.ApplicationModel.Contacts.IContactInformation { + customFields: Windows.Foundation.Collections.IVectorView; + emails: Windows.Foundation.Collections.IVectorView; + instantMessages: Windows.Foundation.Collections.IVectorView; + locations: Windows.Foundation.Collections.IVectorView; + name: string; + phoneNumbers: Windows.Foundation.Collections.IVectorView; + getThumbnailAsync(): Windows.Foundation.IAsyncOperation; + queryCustomFields(customName: string): Windows.Foundation.Collections.IVectorView; + } + export interface IContactPicker { + commitButtonText: string; + desiredFields: Windows.Foundation.Collections.IVector; + selectionMode: Windows.ApplicationModel.Contacts.ContactSelectionMode; + pickSingleContactAsync(): Windows.Foundation.IAsyncOperation; + pickMultipleContactsAsync(): Windows.Foundation.IAsyncOperation>; + } + export class ContactPicker implements Windows.ApplicationModel.Contacts.IContactPicker { + commitButtonText: string; + desiredFields: Windows.Foundation.Collections.IVector; + selectionMode: Windows.ApplicationModel.Contacts.ContactSelectionMode; + pickSingleContactAsync(): Windows.Foundation.IAsyncOperation; + pickMultipleContactsAsync(): Windows.Foundation.IAsyncOperation>; + } + export interface IContact { + fields: Windows.Foundation.Collections.IVector; + name: string; + thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference; + } + export class Contact implements Windows.ApplicationModel.Contacts.IContact { + fields: Windows.Foundation.Collections.IVector; + name: string; + thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference; + } + export interface IContactFieldFactory { + createField(value: string, type: Windows.ApplicationModel.Contacts.ContactFieldType): Windows.ApplicationModel.Contacts.ContactField; + createField(value: string, type: Windows.ApplicationModel.Contacts.ContactFieldType, category: Windows.ApplicationModel.Contacts.ContactFieldCategory): Windows.ApplicationModel.Contacts.ContactField; + createField(name: string, value: string, type: Windows.ApplicationModel.Contacts.ContactFieldType, category: Windows.ApplicationModel.Contacts.ContactFieldCategory): Windows.ApplicationModel.Contacts.ContactField; + } + export interface IContactLocationFieldFactory { + createLocation(unstructuredAddress: string): Windows.ApplicationModel.Contacts.ContactLocationField; + createLocation(unstructuredAddress: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory): Windows.ApplicationModel.Contacts.ContactLocationField; + createLocation(unstructuredAddress: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory, street: string, city: string, region: string, country: string, postalCode: string): Windows.ApplicationModel.Contacts.ContactLocationField; + } + export interface IContactInstantMessageFieldFactory { + createInstantMessage(userName: string): Windows.ApplicationModel.Contacts.ContactInstantMessageField; + createInstantMessage(userName: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory): Windows.ApplicationModel.Contacts.ContactInstantMessageField; + createInstantMessage(userName: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory, service: string, displayText: string, verb: Windows.Foundation.Uri): Windows.ApplicationModel.Contacts.ContactInstantMessageField; + } + export class ContactFieldFactory implements Windows.ApplicationModel.Contacts.IContactFieldFactory, Windows.ApplicationModel.Contacts.IContactLocationFieldFactory, Windows.ApplicationModel.Contacts.IContactInstantMessageFieldFactory { + createField(value: string, type: Windows.ApplicationModel.Contacts.ContactFieldType): Windows.ApplicationModel.Contacts.ContactField; + createField(value: string, type: Windows.ApplicationModel.Contacts.ContactFieldType, category: Windows.ApplicationModel.Contacts.ContactFieldCategory): Windows.ApplicationModel.Contacts.ContactField; + createField(name: string, value: string, type: Windows.ApplicationModel.Contacts.ContactFieldType, category: Windows.ApplicationModel.Contacts.ContactFieldCategory): Windows.ApplicationModel.Contacts.ContactField; + createLocation(unstructuredAddress: string): Windows.ApplicationModel.Contacts.ContactLocationField; + createLocation(unstructuredAddress: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory): Windows.ApplicationModel.Contacts.ContactLocationField; + createLocation(unstructuredAddress: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory, street: string, city: string, region: string, country: string, postalCode: string): Windows.ApplicationModel.Contacts.ContactLocationField; + createInstantMessage(userName: string): Windows.ApplicationModel.Contacts.ContactInstantMessageField; + createInstantMessage(userName: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory): Windows.ApplicationModel.Contacts.ContactInstantMessageField; + createInstantMessage(userName: string, category: Windows.ApplicationModel.Contacts.ContactFieldCategory, service: string, displayText: string, verb: Windows.Foundation.Uri): Windows.ApplicationModel.Contacts.ContactInstantMessageField; + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module Contacts { + export module Provider { + export interface IContactRemovedEventArgs { + id: string; + } + export class ContactRemovedEventArgs implements Windows.ApplicationModel.Contacts.Provider.IContactRemovedEventArgs { + id: string; + } + export enum AddContactResult { + added, + alreadyAdded, + unavailable, + } + export interface IContactPickerUI { + desiredFields: Windows.Foundation.Collections.IVectorView; + selectionMode: Windows.ApplicationModel.Contacts.ContactSelectionMode; + addContact(id: string, contact: Windows.ApplicationModel.Contacts.Contact): Windows.ApplicationModel.Contacts.Provider.AddContactResult; + removeContact(id: string): void; + containsContact(id: string): boolean; + oncontactremoved: any/* TODO */; + } + export class ContactPickerUI implements Windows.ApplicationModel.Contacts.Provider.IContactPickerUI { + desiredFields: Windows.Foundation.Collections.IVectorView; + selectionMode: Windows.ApplicationModel.Contacts.ContactSelectionMode; + addContact(id: string, contact: Windows.ApplicationModel.Contacts.Contact): Windows.ApplicationModel.Contacts.Provider.AddContactResult; + removeContact(id: string): void; + containsContact(id: string): boolean; + oncontactremoved: any/* TODO */; + } + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module DataTransfer { + export interface IStandardDataFormatsStatics { + bitmap: string; + html: string; + rtf: string; + storageItems: string; + text: string; + uri: string; + } + export class StandardDataFormats { + static bitmap: string; + static html: string; + static rtf: string; + static storageItems: string; + static text: string; + static uri: string; + } + export interface IDataPackagePropertySetView extends Windows.Foundation.Collections.IMapView, Windows.Foundation.Collections.IIterable> { + applicationListingUri: Windows.Foundation.Uri; + applicationName: string; + description: string; + fileTypes: Windows.Foundation.Collections.IVectorView; + thumbnail: Windows.Storage.Streams.RandomAccessStreamReference; + title: string; + } + export interface IDataPackagePropertySet extends Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + applicationListingUri: Windows.Foundation.Uri; + applicationName: string; + description: string; + fileTypes: Windows.Foundation.Collections.IVector; + thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference; + title: string; + } + export class DataPackagePropertySetView implements Windows.ApplicationModel.DataTransfer.IDataPackagePropertySetView, Windows.Foundation.Collections.IMapView, Windows.Foundation.Collections.IIterable> { + applicationListingUri: Windows.Foundation.Uri; + applicationName: string; + description: string; + fileTypes: Windows.Foundation.Collections.IVectorView; + thumbnail: Windows.Storage.Streams.RandomAccessStreamReference; + title: string; + size: number; + lookup(key: string): any; + hasKey(key: string): boolean; + split(): { first: Windows.Foundation.Collections.IMapView; second: Windows.Foundation.Collections.IMapView; }; + first(): Windows.Foundation.Collections.IIterator>; + } + export class DataPackagePropertySet implements Windows.ApplicationModel.DataTransfer.IDataPackagePropertySet, Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + applicationListingUri: Windows.Foundation.Uri; + applicationName: string; + description: string; + fileTypes: Windows.Foundation.Collections.IVector; + thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference; + title: string; + size: number; + lookup(key: string): any; + hasKey(key: string): boolean; + getView(): Windows.Foundation.Collections.IMapView; + insert(key: string, value: any): boolean; + remove(key: string): void; + clear(): void; + first(): Windows.Foundation.Collections.IIterator>; + } + export interface IDataProviderDeferral { + complete(): void; + } + export class DataProviderDeferral implements Windows.ApplicationModel.DataTransfer.IDataProviderDeferral { + complete(): void; + } + export interface IDataProviderRequest { + deadline: Date; + formatId: string; + getDeferral(): Windows.ApplicationModel.DataTransfer.DataProviderDeferral; + setData(value: any): void; + } + export class DataProviderRequest implements Windows.ApplicationModel.DataTransfer.IDataProviderRequest { + deadline: Date; + formatId: string; + getDeferral(): Windows.ApplicationModel.DataTransfer.DataProviderDeferral; + setData(value: any): void; + } + export interface DataProviderHandler { + (request: Windows.ApplicationModel.DataTransfer.DataProviderRequest): void; + } + export enum DataPackageOperation { + none, + copy, + move, + link, + } + export interface IOperationCompletedEventArgs { + operation: Windows.ApplicationModel.DataTransfer.DataPackageOperation; + } + export class OperationCompletedEventArgs implements Windows.ApplicationModel.DataTransfer.IOperationCompletedEventArgs { + operation: Windows.ApplicationModel.DataTransfer.DataPackageOperation; + } + export interface IDataPackageView { + availableFormats: Windows.Foundation.Collections.IVectorView; + properties: Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView; + requestedOperation: Windows.ApplicationModel.DataTransfer.DataPackageOperation; + reportOperationCompleted(value: Windows.ApplicationModel.DataTransfer.DataPackageOperation): void; + contains(formatId: string): boolean; + getDataAsync(formatId: string): Windows.Foundation.IAsyncOperation; + getTextAsync(): Windows.Foundation.IAsyncOperation; + getTextAsync(formatId: string): Windows.Foundation.IAsyncOperation; + getUriAsync(): Windows.Foundation.IAsyncOperation; + getHtmlFormatAsync(): Windows.Foundation.IAsyncOperation; + getResourceMapAsync(): Windows.Foundation.IAsyncOperation>; + getRtfAsync(): Windows.Foundation.IAsyncOperation; + getBitmapAsync(): Windows.Foundation.IAsyncOperation; + getStorageItemsAsync(): Windows.Foundation.IAsyncOperation>; + } + export interface IDataPackage { + properties: Windows.ApplicationModel.DataTransfer.DataPackagePropertySet; + requestedOperation: Windows.ApplicationModel.DataTransfer.DataPackageOperation; + resourceMap: Windows.Foundation.Collections.IMap; + getView(): Windows.ApplicationModel.DataTransfer.DataPackageView; + onoperationcompleted: any/* TODO */; + ondestroyed: any/* TODO */; + setData(formatId: string, value: any): void; + setDataProvider(formatId: string, delayRenderer: Windows.ApplicationModel.DataTransfer.DataProviderHandler): void; + setText(value: string): void; + setUri(value: Windows.Foundation.Uri): void; + setHtmlFormat(value: string): void; + setRtf(value: string): void; + setBitmap(value: Windows.Storage.Streams.RandomAccessStreamReference): void; + setStorageItems(value: Windows.Foundation.Collections.IIterable): void; + setStorageItems(value: Windows.Foundation.Collections.IIterable, readOnly: boolean): void; + } + export class DataPackageView implements Windows.ApplicationModel.DataTransfer.IDataPackageView { + availableFormats: Windows.Foundation.Collections.IVectorView; + properties: Windows.ApplicationModel.DataTransfer.DataPackagePropertySetView; + requestedOperation: Windows.ApplicationModel.DataTransfer.DataPackageOperation; + reportOperationCompleted(value: Windows.ApplicationModel.DataTransfer.DataPackageOperation): void; + contains(formatId: string): boolean; + getDataAsync(formatId: string): Windows.Foundation.IAsyncOperation; + getTextAsync(): Windows.Foundation.IAsyncOperation; + getTextAsync(formatId: string): Windows.Foundation.IAsyncOperation; + getUriAsync(): Windows.Foundation.IAsyncOperation; + getHtmlFormatAsync(): Windows.Foundation.IAsyncOperation; + getResourceMapAsync(): Windows.Foundation.IAsyncOperation>; + getRtfAsync(): Windows.Foundation.IAsyncOperation; + getBitmapAsync(): Windows.Foundation.IAsyncOperation; + getStorageItemsAsync(): Windows.Foundation.IAsyncOperation>; + } + export class DataPackage implements Windows.ApplicationModel.DataTransfer.IDataPackage { + properties: Windows.ApplicationModel.DataTransfer.DataPackagePropertySet; + requestedOperation: Windows.ApplicationModel.DataTransfer.DataPackageOperation; + resourceMap: Windows.Foundation.Collections.IMap; + getView(): Windows.ApplicationModel.DataTransfer.DataPackageView; + onoperationcompleted: any/* TODO */; + ondestroyed: any/* TODO */; + setData(formatId: string, value: any): void; + setDataProvider(formatId: string, delayRenderer: Windows.ApplicationModel.DataTransfer.DataProviderHandler): void; + setText(value: string): void; + setUri(value: Windows.Foundation.Uri): void; + setHtmlFormat(value: string): void; + setRtf(value: string): void; + setBitmap(value: Windows.Storage.Streams.RandomAccessStreamReference): void; + setStorageItems(value: Windows.Foundation.Collections.IIterable): void; + setStorageItems(value: Windows.Foundation.Collections.IIterable, readOnly: boolean): void; + } + export interface IHtmlFormatHelperStatics { + getStaticFragment(htmlFormat: string): string; + createHtmlFormat(htmlFragment: string): string; + } + export class HtmlFormatHelper { + static getStaticFragment(htmlFormat: string): string; + static createHtmlFormat(htmlFragment: string): string; + } + export interface IClipboardStatics { + getContent(): Windows.ApplicationModel.DataTransfer.DataPackageView; + setContent(content: Windows.ApplicationModel.DataTransfer.DataPackage): void; + flush(): void; + clear(): void; + oncontentchanged: any/* TODO */; + } + export class Clipboard { + static getContent(): Windows.ApplicationModel.DataTransfer.DataPackageView; + static setContent(content: Windows.ApplicationModel.DataTransfer.DataPackage): void; + static flush(): void; + static clear(): void; + static oncontentchanged: any/* TODO */; + } + export interface IDataRequestDeferral { + complete(): void; + } + export class DataRequestDeferral implements Windows.ApplicationModel.DataTransfer.IDataRequestDeferral { + complete(): void; + } + export interface IDataRequest { + data: Windows.ApplicationModel.DataTransfer.DataPackage; + deadline: Date; + failWithDisplayText(value: string): void; + getDeferral(): Windows.ApplicationModel.DataTransfer.DataRequestDeferral; + } + export class DataRequest implements Windows.ApplicationModel.DataTransfer.IDataRequest { + data: Windows.ApplicationModel.DataTransfer.DataPackage; + deadline: Date; + failWithDisplayText(value: string): void; + getDeferral(): Windows.ApplicationModel.DataTransfer.DataRequestDeferral; + } + export interface IDataRequestedEventArgs { + request: Windows.ApplicationModel.DataTransfer.DataRequest; + } + export class DataRequestedEventArgs implements Windows.ApplicationModel.DataTransfer.IDataRequestedEventArgs { + request: Windows.ApplicationModel.DataTransfer.DataRequest; + } + export interface ITargetApplicationChosenEventArgs { + applicationName: string; + } + export class TargetApplicationChosenEventArgs implements Windows.ApplicationModel.DataTransfer.ITargetApplicationChosenEventArgs { + applicationName: string; + } + export interface IDataTransferManager { + ondatarequested: any/* TODO */; + ontargetapplicationchosen: any/* TODO */; + } + export class DataTransferManager implements Windows.ApplicationModel.DataTransfer.IDataTransferManager { + ondatarequested: any/* TODO */; + ontargetapplicationchosen: any/* TODO */; + static showShareUI(): void; + static getForCurrentView(): Windows.ApplicationModel.DataTransfer.DataTransferManager; + } + export interface IDataTransferManagerStatics { + showShareUI(): void; + getForCurrentView(): Windows.ApplicationModel.DataTransfer.DataTransferManager; + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module Search { + export interface ISearchPaneQueryLinguisticDetails { + queryTextAlternatives: Windows.Foundation.Collections.IVectorView; + queryTextCompositionLength: number; + queryTextCompositionStart: number; + } + export class SearchPaneQueryLinguisticDetails implements Windows.ApplicationModel.Search.ISearchPaneQueryLinguisticDetails { + queryTextAlternatives: Windows.Foundation.Collections.IVectorView; + queryTextCompositionLength: number; + queryTextCompositionStart: number; + } + export interface ISearchPaneVisibilityChangedEventArgs { + visible: boolean; + } + export class SearchPaneVisibilityChangedEventArgs implements Windows.ApplicationModel.Search.ISearchPaneVisibilityChangedEventArgs { + visible: boolean; + } + export interface ISearchPaneQueryChangedEventArgs { + language: string; + linguisticDetails: Windows.ApplicationModel.Search.SearchPaneQueryLinguisticDetails; + queryText: string; + } + export class SearchPaneQueryChangedEventArgs implements Windows.ApplicationModel.Search.ISearchPaneQueryChangedEventArgs { + language: string; + linguisticDetails: Windows.ApplicationModel.Search.SearchPaneQueryLinguisticDetails; + queryText: string; + } + export interface ISearchPaneQuerySubmittedEventArgs { + language: string; + queryText: string; + } + export class SearchPaneQuerySubmittedEventArgs implements Windows.ApplicationModel.Search.ISearchPaneQuerySubmittedEventArgs { + language: string; + queryText: string; + } + export interface ISearchPaneResultSuggestionChosenEventArgs { + tag: string; + } + export class SearchPaneResultSuggestionChosenEventArgs implements Windows.ApplicationModel.Search.ISearchPaneResultSuggestionChosenEventArgs { + tag: string; + } + export interface ISearchSuggestionCollection { + size: number; + appendQuerySuggestion(text: string): void; + appendQuerySuggestions(suggestions: Windows.Foundation.Collections.IIterable): void; + appendResultSuggestion(text: string, detailText: string, tag: string, image: Windows.Storage.Streams.IRandomAccessStreamReference, imageAlternateText: string): void; + appendSearchSeparator(label: string): void; + } + export class SearchSuggestionCollection implements Windows.ApplicationModel.Search.ISearchSuggestionCollection { + size: number; + appendQuerySuggestion(text: string): void; + appendQuerySuggestions(suggestions: Windows.Foundation.Collections.IIterable): void; + appendResultSuggestion(text: string, detailText: string, tag: string, image: Windows.Storage.Streams.IRandomAccessStreamReference, imageAlternateText: string): void; + appendSearchSeparator(label: string): void; + } + export interface ISearchPaneSuggestionsRequestDeferral { + complete(): void; + } + export interface ISearchPaneSuggestionsRequest { + isCanceled: boolean; + searchSuggestionCollection: Windows.ApplicationModel.Search.SearchSuggestionCollection; + getDeferral(): Windows.ApplicationModel.Search.SearchPaneSuggestionsRequestDeferral; + } + export class SearchPaneSuggestionsRequestDeferral implements Windows.ApplicationModel.Search.ISearchPaneSuggestionsRequestDeferral { + complete(): void; + } + export class SearchPaneSuggestionsRequest implements Windows.ApplicationModel.Search.ISearchPaneSuggestionsRequest { + isCanceled: boolean; + searchSuggestionCollection: Windows.ApplicationModel.Search.SearchSuggestionCollection; + getDeferral(): Windows.ApplicationModel.Search.SearchPaneSuggestionsRequestDeferral; + } + export interface ISearchPaneSuggestionsRequestedEventArgs extends Windows.ApplicationModel.Search.ISearchPaneQueryChangedEventArgs { + request: Windows.ApplicationModel.Search.SearchPaneSuggestionsRequest; + } + export class SearchPaneSuggestionsRequestedEventArgs implements Windows.ApplicationModel.Search.ISearchPaneSuggestionsRequestedEventArgs, Windows.ApplicationModel.Search.ISearchPaneQueryChangedEventArgs { + request: Windows.ApplicationModel.Search.SearchPaneSuggestionsRequest; + language: string; + linguisticDetails: Windows.ApplicationModel.Search.SearchPaneQueryLinguisticDetails; + queryText: string; + } + export interface ILocalContentSuggestionSettings { + aqsFilter: string; + enabled: boolean; + locations: Windows.Foundation.Collections.IVector; + propertiesToMatch: Windows.Foundation.Collections.IVector; + } + export class LocalContentSuggestionSettings implements Windows.ApplicationModel.Search.ILocalContentSuggestionSettings { + aqsFilter: string; + enabled: boolean; + locations: Windows.Foundation.Collections.IVector; + propertiesToMatch: Windows.Foundation.Collections.IVector; + } + export interface ISearchPaneStatics { + getForCurrentView(): Windows.ApplicationModel.Search.SearchPane; + } + export class SearchPane implements Windows.ApplicationModel.Search.ISearchPane { + language: string; + placeholderText: string; + queryText: string; + searchHistoryContext: string; + searchHistoryEnabled: boolean; + showOnKeyboardInput: boolean; + visible: boolean; + onvisibilitychanged: any/* TODO */; + onquerychanged: any/* TODO */; + onsuggestionsrequested: any/* TODO */; + onquerysubmitted: any/* TODO */; + onresultsuggestionchosen: any/* TODO */; + setLocalContentSuggestionSettings(settings: Windows.ApplicationModel.Search.LocalContentSuggestionSettings): void; + show(): void; + show(query: string): void; + trySetQueryText(query: string): boolean; + static getForCurrentView(): Windows.ApplicationModel.Search.SearchPane; + } + export interface ISearchPane { + language: string; + placeholderText: string; + queryText: string; + searchHistoryContext: string; + searchHistoryEnabled: boolean; + showOnKeyboardInput: boolean; + visible: boolean; + onvisibilitychanged: any/* TODO */; + onquerychanged: any/* TODO */; + onsuggestionsrequested: any/* TODO */; + onquerysubmitted: any/* TODO */; + onresultsuggestionchosen: any/* TODO */; + setLocalContentSuggestionSettings(settings: Windows.ApplicationModel.Search.LocalContentSuggestionSettings): void; + show(): void; + show(query: string): void; + trySetQueryText(query: string): boolean; + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module DataTransfer { + export module ShareTarget { + export interface IQuickLink { + id: string; + supportedDataFormats: Windows.Foundation.Collections.IVector; + supportedFileTypes: Windows.Foundation.Collections.IVector; + thumbnail: Windows.Storage.Streams.RandomAccessStreamReference; + title: string; + } + export class QuickLink implements Windows.ApplicationModel.DataTransfer.ShareTarget.IQuickLink { + id: string; + supportedDataFormats: Windows.Foundation.Collections.IVector; + supportedFileTypes: Windows.Foundation.Collections.IVector; + thumbnail: Windows.Storage.Streams.RandomAccessStreamReference; + title: string; + } + export interface IShareOperation { + data: Windows.ApplicationModel.DataTransfer.DataPackageView; + quickLinkId: string; + removeThisQuickLink(): void; + reportStarted(): void; + reportDataRetrieved(): void; + reportSubmittedBackgroundTask(): void; + reportCompleted(quicklink: Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink): void; + reportCompleted(): void; + reportError(value: string): void; + } + export class ShareOperation implements Windows.ApplicationModel.DataTransfer.ShareTarget.IShareOperation { + data: Windows.ApplicationModel.DataTransfer.DataPackageView; + quickLinkId: string; + removeThisQuickLink(): void; + reportStarted(): void; + reportDataRetrieved(): void; + reportSubmittedBackgroundTask(): void; + reportCompleted(quicklink: Windows.ApplicationModel.DataTransfer.ShareTarget.QuickLink): void; + reportCompleted(): void; + reportError(value: string): void; + } + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module Activation { + export interface ISplashScreen { + imageLocation: Windows.Foundation.Rect; + ondismissed: any/* TODO */; + } + export class SplashScreen implements Windows.ApplicationModel.Activation.ISplashScreen { + imageLocation: Windows.Foundation.Rect; + ondismissed: any/* TODO */; + } + export enum ApplicationExecutionState { + notRunning, + running, + suspended, + terminated, + closedByUser, + } + export enum ActivationKind { + launch, + search, + shareTarget, + file, + protocol, + fileOpenPicker, + fileSavePicker, + cachedFileUpdater, + contactPicker, + device, + printTaskSettings, + cameraSettings, + } + export interface IActivatedEventArgs { + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface ILaunchActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + arguments: string; + tileId: string; + } + export class LaunchActivatedEventArgs implements Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + arguments: string; + tileId: string; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface ISearchActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + language: string; + queryText: string; + } + export class SearchActivatedEventArgs implements Windows.ApplicationModel.Activation.ISearchActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + language: string; + queryText: string; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface IShareTargetActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + shareOperation: Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation; + } + export class ShareTargetActivatedEventArgs implements Windows.ApplicationModel.Activation.IShareTargetActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + shareOperation: Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface IFileActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + files: Windows.Foundation.Collections.IVectorView; + verb: string; + } + export class FileActivatedEventArgs implements Windows.ApplicationModel.Activation.IFileActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + files: Windows.Foundation.Collections.IVectorView; + verb: string; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface IProtocolActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + uri: Windows.Foundation.Uri; + } + export class ProtocolActivatedEventArgs implements Windows.ApplicationModel.Activation.IProtocolActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + uri: Windows.Foundation.Uri; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface IFileOpenPickerActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + fileOpenPickerUI: Windows.Storage.Pickers.Provider.FileOpenPickerUI; + } + export class FileOpenPickerActivatedEventArgs implements Windows.ApplicationModel.Activation.IFileOpenPickerActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + fileOpenPickerUI: Windows.Storage.Pickers.Provider.FileOpenPickerUI; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface IFileSavePickerActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + fileSavePickerUI: Windows.Storage.Pickers.Provider.FileSavePickerUI; + } + export class FileSavePickerActivatedEventArgs implements Windows.ApplicationModel.Activation.IFileSavePickerActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + fileSavePickerUI: Windows.Storage.Pickers.Provider.FileSavePickerUI; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface ICachedFileUpdaterActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + cachedFileUpdaterUI: Windows.Storage.Provider.CachedFileUpdaterUI; + } + export class CachedFileUpdaterActivatedEventArgs implements Windows.ApplicationModel.Activation.ICachedFileUpdaterActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + cachedFileUpdaterUI: Windows.Storage.Provider.CachedFileUpdaterUI; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface IContactPickerActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + contactPickerUI: Windows.ApplicationModel.Contacts.Provider.ContactPickerUI; + } + export class ContactPickerActivatedEventArgs implements Windows.ApplicationModel.Activation.IContactPickerActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + contactPickerUI: Windows.ApplicationModel.Contacts.Provider.ContactPickerUI; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface IDeviceActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + deviceInformationId: string; + verb: string; + } + export class DeviceActivatedEventArgs implements Windows.ApplicationModel.Activation.IDeviceActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + deviceInformationId: string; + verb: string; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface IPrintTaskSettingsActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + configuration: Windows.Devices.Printers.Extensions.PrintTaskConfiguration; + } + export class PrintTaskSettingsActivatedEventArgs implements Windows.ApplicationModel.Activation.IPrintTaskSettingsActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + configuration: Windows.Devices.Printers.Extensions.PrintTaskConfiguration; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + export interface ICameraSettingsActivatedEventArgs extends Windows.ApplicationModel.Activation.IActivatedEventArgs { + videoDeviceController: any; + videoDeviceExtension: any; + } + export class CameraSettingsActivatedEventArgs implements Windows.ApplicationModel.Activation.ICameraSettingsActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs { + videoDeviceController: any; + videoDeviceExtension: any; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module Core { + export class CoreApplication { + static mainView: Windows.ApplicationModel.Core.CoreApplicationView; + static views: Windows.Foundation.Collections.IVectorView; + static id: string; + static properties: Windows.Foundation.Collections.IPropertySet; + static incrementApplicationUseCount(): void; + static decrementApplicationUseCount(): void; + static createNewView(runtimeType: string, entryPoint: string): Windows.ApplicationModel.Core.CoreApplicationView; + static exit(): void; + static onexiting: any/* TODO */; + static onsuspending: any/* TODO */; + static onresuming: any/* TODO */; + static getCurrentView(): Windows.ApplicationModel.Core.CoreApplicationView; + static run(viewSource: Windows.ApplicationModel.Core.IFrameworkViewSource): void; + static runWithActivationFactories(activationFactoryCallback: Windows.Foundation.IGetActivationFactory): void; + } + export class CoreApplicationView implements Windows.ApplicationModel.Core.ICoreApplicationView { + coreWindow: Windows.UI.Core.CoreWindow; + isHosted: boolean; + isMain: boolean; + onactivated: any/* TODO */; + } + export interface IFrameworkView { + initialize(applicationView: Windows.ApplicationModel.Core.CoreApplicationView): void; + setWindow(window: Windows.UI.Core.CoreWindow): void; + load(entryPoint: string): void; + run(): void; + uninitialize(): void; + } + export interface IFrameworkViewSource { + createView(): Windows.ApplicationModel.Core.IFrameworkView; + } + export interface ICoreApplication { + id: string; + properties: Windows.Foundation.Collections.IPropertySet; + onsuspending: any/* TODO */; + onresuming: any/* TODO */; + getCurrentView(): Windows.ApplicationModel.Core.CoreApplicationView; + run(viewSource: Windows.ApplicationModel.Core.IFrameworkViewSource): void; + runWithActivationFactories(activationFactoryCallback: Windows.Foundation.IGetActivationFactory): void; + } + export interface ICoreApplicationUseCount { + incrementApplicationUseCount(): void; + decrementApplicationUseCount(): void; + } + export interface ICoreApplicationExit { + exit(): void; + onexiting: any/* TODO */; + } + export interface ICoreImmersiveApplication { + mainView: Windows.ApplicationModel.Core.CoreApplicationView; + views: Windows.Foundation.Collections.IVectorView; + createNewView(runtimeType: string, entryPoint: string): Windows.ApplicationModel.Core.CoreApplicationView; + } + export interface ICoreApplicationView { + coreWindow: Windows.UI.Core.CoreWindow; + isHosted: boolean; + isMain: boolean; + onactivated: any/* TODO */; + } + } + } +} +declare module Windows { + export module ApplicationModel { + export class SuspendingEventArgs implements Windows.ApplicationModel.ISuspendingEventArgs { + suspendingOperation: Windows.ApplicationModel.SuspendingOperation; + } + export interface ISuspendingDeferral { + complete(): void; + } + export class SuspendingDeferral implements Windows.ApplicationModel.ISuspendingDeferral { + complete(): void; + } + export interface ISuspendingOperation { + deadline: Date; + getDeferral(): Windows.ApplicationModel.SuspendingDeferral; + } + export class SuspendingOperation implements Windows.ApplicationModel.ISuspendingOperation { + deadline: Date; + getDeferral(): Windows.ApplicationModel.SuspendingDeferral; + } + export interface ISuspendingEventArgs { + suspendingOperation: Windows.ApplicationModel.SuspendingOperation; + } + export interface PackageVersion { + major: number; + minor: number; + build: number; + revision: number; + } + export interface IPackageId { + architecture: Windows.System.ProcessorArchitecture; + familyName: string; + fullName: string; + name: string; + publisher: string; + publisherId: string; + resourceId: string; + version: Windows.ApplicationModel.PackageVersion; + } + export class PackageId implements Windows.ApplicationModel.IPackageId { + architecture: Windows.System.ProcessorArchitecture; + familyName: string; + fullName: string; + name: string; + publisher: string; + publisherId: string; + resourceId: string; + version: Windows.ApplicationModel.PackageVersion; + } + export interface IPackage { + dependencies: Windows.Foundation.Collections.IVectorView; + id: Windows.ApplicationModel.PackageId; + installedLocation: Windows.Storage.StorageFolder; + isFramework: boolean; + } + export class Package implements Windows.ApplicationModel.IPackage { + dependencies: Windows.Foundation.Collections.IVectorView; + id: Windows.ApplicationModel.PackageId; + installedLocation: Windows.Storage.StorageFolder; + isFramework: boolean; + static current: Windows.ApplicationModel.Package; + } + export interface IPackageStatics { + current: Windows.ApplicationModel.Package; + } + export interface IDesignModeStatics { + designModeEnabled: boolean; + } + export class DesignMode { + static designModeEnabled: boolean; + } + } +} +declare module Windows { + export module ApplicationModel { + export module Resources { + export interface IResourceLoader { + getString(resource: string): string; + } + export class ResourceLoader implements Windows.ApplicationModel.Resources.IResourceLoader { + constructor(name: string); + constructor(); + getString(resource: string): string; + static getStringForReference(uri: Windows.Foundation.Uri): string; + } + export interface IResourceLoaderStatics { + getStringForReference(uri: Windows.Foundation.Uri): string; + } + export interface IResourceLoaderFactory { + createResourceLoaderByName(name: string): Windows.ApplicationModel.Resources.ResourceLoader; + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module Resources { + export module Core { + export interface IResourceManager { + allResourceMaps: Windows.Foundation.Collections.IMapView; + defaultContext: Windows.ApplicationModel.Resources.Core.ResourceContext; + mainResourceMap: Windows.ApplicationModel.Resources.Core.ResourceMap; + loadPriFiles(files: Windows.Foundation.Collections.IIterable): void; + unloadPriFiles(files: Windows.Foundation.Collections.IIterable): void; + } + export class ResourceMap implements Windows.ApplicationModel.Resources.Core.IResourceMap, Windows.Foundation.Collections.IMapView, Windows.Foundation.Collections.IIterable> { + uri: Windows.Foundation.Uri; + size: number; + getValue(resource: string): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + getValue(resource: string, context: Windows.ApplicationModel.Resources.Core.ResourceContext): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + getSubtree(reference: string): Windows.ApplicationModel.Resources.Core.ResourceMap; + lookup(key: string): Windows.ApplicationModel.Resources.Core.NamedResource; + hasKey(key: string): boolean; + split(): { first: Windows.Foundation.Collections.IMapView; second: Windows.Foundation.Collections.IMapView; }; + first(): Windows.Foundation.Collections.IIterator>; + } + export class ResourceContext implements Windows.ApplicationModel.Resources.Core.IResourceContext { + languages: Windows.Foundation.Collections.IVectorView; + qualifierValues: Windows.Foundation.Collections.IObservableMap; + reset(): void; + reset(qualifierNames: Windows.Foundation.Collections.IIterable): void; + overrideToMatch(result: Windows.Foundation.Collections.IIterable): void; + clone(): Windows.ApplicationModel.Resources.Core.ResourceContext; + static createMatchingContext(result: Windows.Foundation.Collections.IIterable): Windows.ApplicationModel.Resources.Core.ResourceContext; + } + export interface IResourceManagerStatics { + current: Windows.ApplicationModel.Resources.Core.ResourceManager; + isResourceReference(resourceReference: string): boolean; + } + export class ResourceManager implements Windows.ApplicationModel.Resources.Core.IResourceManager { + allResourceMaps: Windows.Foundation.Collections.IMapView; + defaultContext: Windows.ApplicationModel.Resources.Core.ResourceContext; + mainResourceMap: Windows.ApplicationModel.Resources.Core.ResourceMap; + loadPriFiles(files: Windows.Foundation.Collections.IIterable): void; + unloadPriFiles(files: Windows.Foundation.Collections.IIterable): void; + static current: Windows.ApplicationModel.Resources.Core.ResourceManager; + static isResourceReference(resourceReference: string): boolean; + } + export interface IResourceQualifier { + isDefault: boolean; + isMatch: boolean; + qualifierName: string; + qualifierValue: string; + score: number; + } + export class ResourceQualifier implements Windows.ApplicationModel.Resources.Core.IResourceQualifier { + isDefault: boolean; + isMatch: boolean; + qualifierName: string; + qualifierValue: string; + score: number; + } + export interface IResourceContext { + languages: Windows.Foundation.Collections.IVectorView; + qualifierValues: Windows.Foundation.Collections.IObservableMap; + reset(): void; + reset(qualifierNames: Windows.Foundation.Collections.IIterable): void; + overrideToMatch(result: Windows.Foundation.Collections.IIterable): void; + clone(): Windows.ApplicationModel.Resources.Core.ResourceContext; + } + export interface IResourceContextStatics { + createMatchingContext(result: Windows.Foundation.Collections.IIterable): Windows.ApplicationModel.Resources.Core.ResourceContext; + } + export interface IResourceCandidate { + isDefault: boolean; + isMatch: boolean; + isMatchAsDefault: boolean; + qualifiers: Windows.Foundation.Collections.IVectorView; + valueAsString: string; + getValueAsFileAsync(): Windows.Foundation.IAsyncOperation; + getQualifierValue(qualifierName: string): string; + } + export class ResourceCandidate implements Windows.ApplicationModel.Resources.Core.IResourceCandidate { + isDefault: boolean; + isMatch: boolean; + isMatchAsDefault: boolean; + qualifiers: Windows.Foundation.Collections.IVectorView; + valueAsString: string; + getValueAsFileAsync(): Windows.Foundation.IAsyncOperation; + getQualifierValue(qualifierName: string): string; + } + export interface INamedResource { + candidates: Windows.Foundation.Collections.IVectorView; + uri: Windows.Foundation.Uri; + resolve(): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + resolve(resourceContext: Windows.ApplicationModel.Resources.Core.ResourceContext): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + resolveAll(): Windows.Foundation.Collections.IVectorView; + resolveAll(resourceContext: Windows.ApplicationModel.Resources.Core.ResourceContext): Windows.Foundation.Collections.IVectorView; + } + export class NamedResource implements Windows.ApplicationModel.Resources.Core.INamedResource { + candidates: Windows.Foundation.Collections.IVectorView; + uri: Windows.Foundation.Uri; + resolve(): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + resolve(resourceContext: Windows.ApplicationModel.Resources.Core.ResourceContext): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + resolveAll(): Windows.Foundation.Collections.IVectorView; + resolveAll(resourceContext: Windows.ApplicationModel.Resources.Core.ResourceContext): Windows.Foundation.Collections.IVectorView; + } + export interface IResourceMap extends Windows.Foundation.Collections.IMapView, Windows.Foundation.Collections.IIterable> { + uri: Windows.Foundation.Uri; + getValue(resource: string): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + getValue(resource: string, context: Windows.ApplicationModel.Resources.Core.ResourceContext): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + getSubtree(reference: string): Windows.ApplicationModel.Resources.Core.ResourceMap; + } + export class ResourceMapIterator implements Windows.Foundation.Collections.IIterator> { + current: Windows.Foundation.Collections.IKeyValuePair; + hasCurrent: boolean; + moveNext(): boolean; + getMany(): { items: Windows.Foundation.Collections.IKeyValuePair[]; returnValue: number; }; + } + export class ResourceMapMapView implements Windows.Foundation.Collections.IMapView, Windows.Foundation.Collections.IIterable> { + size: number; + lookup(key: string): Windows.ApplicationModel.Resources.Core.ResourceMap; + hasKey(key: string): boolean; + split(): { first: Windows.Foundation.Collections.IMapView; second: Windows.Foundation.Collections.IMapView; }; + first(): Windows.Foundation.Collections.IIterator>; + } + export class ResourceMapMapViewIterator implements Windows.Foundation.Collections.IIterator> { + current: Windows.Foundation.Collections.IKeyValuePair; + hasCurrent: boolean; + moveNext(): boolean; + getMany(): { items: Windows.Foundation.Collections.IKeyValuePair[]; returnValue: number; }; + } + export class ResourceQualifierObservableMap implements Windows.Foundation.Collections.IObservableMap, Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + size: number; + onmapchanged: any/* TODO */; + lookup(key: string): string; + hasKey(key: string): boolean; + getView(): Windows.Foundation.Collections.IMapView; + insert(key: string, value: string): boolean; + remove(key: string): void; + clear(): void; + first(): Windows.Foundation.Collections.IIterator>; + } + export class ResourceQualifierMapView implements Windows.Foundation.Collections.IMapView, Windows.Foundation.Collections.IIterable> { + size: number; + lookup(key: string): string; + hasKey(key: string): boolean; + split(): { first: Windows.Foundation.Collections.IMapView; second: Windows.Foundation.Collections.IMapView; }; + first(): Windows.Foundation.Collections.IIterator>; + } + export class ResourceQualifierVectorView implements Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): Windows.ApplicationModel.Resources.Core.ResourceQualifier; + indexOf(value: Windows.ApplicationModel.Resources.Core.ResourceQualifier): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; returnValue: number; }; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.ApplicationModel.Resources.Core.ResourceQualifier[][]): Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; + join(seperator: string): string; + pop(): Windows.ApplicationModel.Resources.Core.ResourceQualifier; + push(...items: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]): void; + reverse(): Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; + shift(): Windows.ApplicationModel.Resources.Core.ResourceQualifier; + slice(start: number): Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; + slice(start: number, end: number): Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; + sort(): Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; + sort(compareFn: (a: Windows.ApplicationModel.Resources.Core.ResourceQualifier, b: Windows.ApplicationModel.Resources.Core.ResourceQualifier) => number): Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; + splice(start: number): Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; + splice(start: number, deleteCount: number, ...items: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]): Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; + unshift(...items: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]): number; + lastIndexOf(searchElement: Windows.ApplicationModel.Resources.Core.ResourceQualifier): number; + lastIndexOf(searchElement: Windows.ApplicationModel.Resources.Core.ResourceQualifier, fromIndex: number): number; + every(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceQualifier, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => boolean): boolean; + every(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceQualifier, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceQualifier, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => boolean): boolean; + some(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceQualifier, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceQualifier, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => void ): void; + forEach(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceQualifier, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceQualifier, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => any): any[]; + map(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceQualifier, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceQualifier, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => boolean): Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; + filter(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceQualifier, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => boolean, thisArg: any): Windows.ApplicationModel.Resources.Core.ResourceQualifier[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.ApplicationModel.Resources.Core.ResourceQualifier[]) => any, initialValue: any): any; + length: number; + } + export class ResourceCandidateVectorView implements Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + indexOf(value: Windows.ApplicationModel.Resources.Core.ResourceCandidate): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; returnValue: number; }; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.ApplicationModel.Resources.Core.ResourceCandidate[][]): Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; + join(seperator: string): string; + pop(): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + push(...items: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]): void; + reverse(): Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; + shift(): Windows.ApplicationModel.Resources.Core.ResourceCandidate; + slice(start: number): Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; + slice(start: number, end: number): Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; + sort(): Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; + sort(compareFn: (a: Windows.ApplicationModel.Resources.Core.ResourceCandidate, b: Windows.ApplicationModel.Resources.Core.ResourceCandidate) => number): Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; + splice(start: number): Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; + splice(start: number, deleteCount: number, ...items: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]): Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; + unshift(...items: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]): number; + lastIndexOf(searchElement: Windows.ApplicationModel.Resources.Core.ResourceCandidate): number; + lastIndexOf(searchElement: Windows.ApplicationModel.Resources.Core.ResourceCandidate, fromIndex: number): number; + every(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceCandidate, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => boolean): boolean; + every(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceCandidate, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceCandidate, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => boolean): boolean; + some(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceCandidate, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceCandidate, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => void ): void; + forEach(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceCandidate, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceCandidate, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => any): any[]; + map(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceCandidate, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceCandidate, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => boolean): Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; + filter(callbackfn: (value: Windows.ApplicationModel.Resources.Core.ResourceCandidate, index: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => boolean, thisArg: any): Windows.ApplicationModel.Resources.Core.ResourceCandidate[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.ApplicationModel.Resources.Core.ResourceCandidate[]) => any, initialValue: any): any; + length: number; + } + export class ResourceContextLanguagesVectorView implements Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): string; + indexOf(value: string): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: string[]; returnValue: number; }; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: string[][]): string[]; + join(seperator: string): string; + pop(): string; + push(...items: string[]): void; + reverse(): string[]; + shift(): string; + slice(start: number): string[]; + slice(start: number, end: number): string[]; + sort(): string[]; + sort(compareFn: (a: string, b: string) => number): string[]; + splice(start: number): string[]; + splice(start: number, deleteCount: number, ...items: string[]): string[]; + unshift(...items: string[]): number; + lastIndexOf(searchElement: string): number; + lastIndexOf(searchElement: string, fromIndex: number): number; + every(callbackfn: (value: string, index: number, array: string[]) => boolean): boolean; + every(callbackfn: (value: string, index: number, array: string[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: string, index: number, array: string[]) => boolean): boolean; + some(callbackfn: (value: string, index: number, array: string[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: string, index: number, array: string[]) => void ): void; + forEach(callbackfn: (value: string, index: number, array: string[]) => void , thisArg: any): void; + map(callbackfn: (value: string, index: number, array: string[]) => any): any[]; + map(callbackfn: (value: string, index: number, array: string[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: string, index: number, array: string[]) => boolean): string[]; + filter(callbackfn: (value: string, index: number, array: string[]) => boolean, thisArg: any): string[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: string[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: string[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: string[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: string[]) => any, initialValue: any): any; + length: number; + } + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module Resources { + export module Management { + export enum IndexedResourceType { + string, + path, + } + export interface IResourceIndexer { + indexFilePath(filePath: Windows.Foundation.Uri): Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate; + indexFileContentsAsync(file: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation>; + } + export class IndexedResourceCandidate implements Windows.ApplicationModel.Resources.Management.IIndexedResourceCandidate { + metadata: Windows.Foundation.Collections.IMapView; + qualifiers: Windows.Foundation.Collections.IVectorView; + type: Windows.ApplicationModel.Resources.Management.IndexedResourceType; + uri: Windows.Foundation.Uri; + valueAsString: string; + getQualifierValue(qualifierName: string): string; + } + export interface IResourceIndexerFactory { + createResourceIndexer(projectRoot: Windows.Foundation.Uri): Windows.ApplicationModel.Resources.Management.ResourceIndexer; + } + export class ResourceIndexer implements Windows.ApplicationModel.Resources.Management.IResourceIndexer { + constructor(projectRoot: Windows.Foundation.Uri); + indexFilePath(filePath: Windows.Foundation.Uri): Windows.ApplicationModel.Resources.Management.IndexedResourceCandidate; + indexFileContentsAsync(file: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation>; + } + export interface IIndexedResourceQualifier { + qualifierName: string; + qualifierValue: string; + } + export interface IIndexedResourceCandidate { + metadata: Windows.Foundation.Collections.IMapView; + qualifiers: Windows.Foundation.Collections.IVectorView; + type: Windows.ApplicationModel.Resources.Management.IndexedResourceType; + uri: Windows.Foundation.Uri; + valueAsString: string; + getQualifierValue(qualifierName: string): string; + } + export class IndexedResourceQualifier implements Windows.ApplicationModel.Resources.Management.IIndexedResourceQualifier { + qualifierName: string; + qualifierValue: string; + } + } + } + } +} +declare module Windows { + export module ApplicationModel { + export module Store { + export interface LicenseChangedEventHandler { + (): void; + } + export interface ICurrentApp { + appId: string; + licenseInformation: Windows.ApplicationModel.Store.LicenseInformation; + linkUri: Windows.Foundation.Uri; + requestAppPurchaseAsync(includeReceipt: boolean): Windows.Foundation.IAsyncOperation; + requestProductPurchaseAsync(productId: string, includeReceipt: boolean): Windows.Foundation.IAsyncOperation; + loadListingInformationAsync(): Windows.Foundation.IAsyncOperation; + getAppReceiptAsync(): Windows.Foundation.IAsyncOperation; + getProductReceiptAsync(productId: string): Windows.Foundation.IAsyncOperation; + } + export class LicenseInformation implements Windows.ApplicationModel.Store.ILicenseInformation { + expirationDate: Date; + isActive: boolean; + isTrial: boolean; + productLicenses: Windows.Foundation.Collections.IMapView; + onlicensechanged: any/* TODO */; + } + export class ListingInformation implements Windows.ApplicationModel.Store.IListingInformation { + ageRating: number; + currentMarket: string; + description: string; + formattedPrice: string; + name: string; + productListings: Windows.Foundation.Collections.IMapView; + } + export interface ICurrentAppSimulator { + appId: string; + licenseInformation: Windows.ApplicationModel.Store.LicenseInformation; + linkUri: Windows.Foundation.Uri; + requestAppPurchaseAsync(includeReceipt: boolean): Windows.Foundation.IAsyncOperation; + requestProductPurchaseAsync(productId: string, includeReceipt: boolean): Windows.Foundation.IAsyncOperation; + loadListingInformationAsync(): Windows.Foundation.IAsyncOperation; + getAppReceiptAsync(): Windows.Foundation.IAsyncOperation; + getProductReceiptAsync(productId: string): Windows.Foundation.IAsyncOperation; + reloadSimulatorAsync(simulatorSettingsFile: Windows.Storage.StorageFile): Windows.Foundation.IAsyncAction; + } + export interface ILicenseInformation { + expirationDate: Date; + isActive: boolean; + isTrial: boolean; + productLicenses: Windows.Foundation.Collections.IMapView; + onlicensechanged: any/* TODO */; + } + export class ProductLicense implements Windows.ApplicationModel.Store.IProductLicense { + expirationDate: Date; + isActive: boolean; + productId: string; + } + export interface IProductLicense { + expirationDate: Date; + isActive: boolean; + productId: string; + } + export interface IListingInformation { + ageRating: number; + currentMarket: string; + description: string; + formattedPrice: string; + name: string; + productListings: Windows.Foundation.Collections.IMapView; + } + export class ProductListing implements Windows.ApplicationModel.Store.IProductListing { + formattedPrice: string; + name: string; + productId: string; + } + export interface IProductListing { + formattedPrice: string; + name: string; + productId: string; + } + export class CurrentApp { + static appId: string; + static licenseInformation: Windows.ApplicationModel.Store.LicenseInformation; + static linkUri: Windows.Foundation.Uri; + static requestAppPurchaseAsync(includeReceipt: boolean): Windows.Foundation.IAsyncOperation; + static requestProductPurchaseAsync(productId: string, includeReceipt: boolean): Windows.Foundation.IAsyncOperation; + static loadListingInformationAsync(): Windows.Foundation.IAsyncOperation; + static getAppReceiptAsync(): Windows.Foundation.IAsyncOperation; + static getProductReceiptAsync(productId: string): Windows.Foundation.IAsyncOperation; + } + export class CurrentAppSimulator { + static appId: string; + static licenseInformation: Windows.ApplicationModel.Store.LicenseInformation; + static linkUri: Windows.Foundation.Uri; + static requestAppPurchaseAsync(includeReceipt: boolean): Windows.Foundation.IAsyncOperation; + static requestProductPurchaseAsync(productId: string, includeReceipt: boolean): Windows.Foundation.IAsyncOperation; + static loadListingInformationAsync(): Windows.Foundation.IAsyncOperation; + static getAppReceiptAsync(): Windows.Foundation.IAsyncOperation; + static getProductReceiptAsync(productId: string): Windows.Foundation.IAsyncOperation; + static reloadSimulatorAsync(simulatorSettingsFile: Windows.Storage.StorageFile): Windows.Foundation.IAsyncAction; + } + } + } +} +declare module Windows { + export module Data { + export module Html { + export interface IHtmlUtilities { + convertToText(html: string): string; + } + export class HtmlUtilities { + static convertToText(html: string): string; + } + } + } +} +declare module Windows { + export module Data { + export module Json { + export enum JsonValueType { + null_, + boolean, + number, + string, + array, + object, + } + export enum JsonErrorStatus { + unknown, + invalidJsonString, + invalidJsonNumber, + jsonValueNotFound, + implementationLimit, + } + export interface IJsonValue { + valueType: Windows.Data.Json.JsonValueType; + stringify(): string; + getString(): string; + getNumber(): number; + getBoolean(): boolean; + getArray(): Windows.Data.Json.JsonArray; + getObject(): Windows.Data.Json.JsonObject; + } + export class JsonArray implements Windows.Data.Json.IJsonArray, Windows.Data.Json.IJsonValue, Windows.Foundation.Collections.IVector, Windows.Foundation.Collections.IIterable { + valueType: Windows.Data.Json.JsonValueType; + size: number; + getObjectAt(index: number): Windows.Data.Json.JsonObject; + getArrayAt(index: number): Windows.Data.Json.JsonArray; + getStringAt(index: number): string; + getNumberAt(index: number): number; + getBooleanAt(index: number): boolean; + stringify(): string; + getString(): string; + getNumber(): number; + getBoolean(): boolean; + getArray(): Windows.Data.Json.JsonArray; + getObject(): Windows.Data.Json.JsonObject; + getAt(index: number): Windows.Data.Json.IJsonValue; + getView(): Windows.Foundation.Collections.IVectorView; + indexOf(value: Windows.Data.Json.IJsonValue): { index: number; returnValue: boolean; }; + setAt(index: number, value: Windows.Data.Json.IJsonValue): void; + insertAt(index: number, value: Windows.Data.Json.IJsonValue): void; + removeAt(index: number): void; + append(value: Windows.Data.Json.IJsonValue): void; + removeAtEnd(): void; + clear(): void; + getMany(startIndex: number): { items: Windows.Data.Json.IJsonValue[]; returnValue: number; }; + replaceAll(items: Windows.Data.Json.IJsonValue[]): void; + first(): Windows.Foundation.Collections.IIterator; + static parse(input: string): Windows.Data.Json.JsonArray; + static tryParse(input: string): { result: Windows.Data.Json.JsonArray; succeeded: boolean; }; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.Data.Json.IJsonValue[][]): Windows.Data.Json.IJsonValue[]; + join(seperator: string): string; + pop(): Windows.Data.Json.IJsonValue; + push(...items: Windows.Data.Json.IJsonValue[]): void; + reverse(): Windows.Data.Json.IJsonValue[]; + shift(): Windows.Data.Json.IJsonValue; + slice(start: number): Windows.Data.Json.IJsonValue[]; + slice(start: number, end: number): Windows.Data.Json.IJsonValue[]; + sort(): Windows.Data.Json.IJsonValue[]; + sort(compareFn: (a: Windows.Data.Json.IJsonValue, b: Windows.Data.Json.IJsonValue) => number): Windows.Data.Json.IJsonValue[]; + splice(start: number): Windows.Data.Json.IJsonValue[]; + splice(start: number, deleteCount: number, ...items: Windows.Data.Json.IJsonValue[]): Windows.Data.Json.IJsonValue[]; + unshift(...items: Windows.Data.Json.IJsonValue[]): number; + lastIndexOf(searchElement: Windows.Data.Json.IJsonValue): number; + lastIndexOf(searchElement: Windows.Data.Json.IJsonValue, fromIndex: number): number; + every(callbackfn: (value: Windows.Data.Json.IJsonValue, index: number, array: Windows.Data.Json.IJsonValue[]) => boolean): boolean; + every(callbackfn: (value: Windows.Data.Json.IJsonValue, index: number, array: Windows.Data.Json.IJsonValue[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.Data.Json.IJsonValue, index: number, array: Windows.Data.Json.IJsonValue[]) => boolean): boolean; + some(callbackfn: (value: Windows.Data.Json.IJsonValue, index: number, array: Windows.Data.Json.IJsonValue[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.Data.Json.IJsonValue, index: number, array: Windows.Data.Json.IJsonValue[]) => void ): void; + forEach(callbackfn: (value: Windows.Data.Json.IJsonValue, index: number, array: Windows.Data.Json.IJsonValue[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.Data.Json.IJsonValue, index: number, array: Windows.Data.Json.IJsonValue[]) => any): any[]; + map(callbackfn: (value: Windows.Data.Json.IJsonValue, index: number, array: Windows.Data.Json.IJsonValue[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.Data.Json.IJsonValue, index: number, array: Windows.Data.Json.IJsonValue[]) => boolean): Windows.Data.Json.IJsonValue[]; + filter(callbackfn: (value: Windows.Data.Json.IJsonValue, index: number, array: Windows.Data.Json.IJsonValue[]) => boolean, thisArg: any): Windows.Data.Json.IJsonValue[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Json.IJsonValue[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Json.IJsonValue[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Json.IJsonValue[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Json.IJsonValue[]) => any, initialValue: any): any; + length: number; + } + export class JsonObject implements Windows.Data.Json.IJsonObject, Windows.Data.Json.IJsonValue, Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + valueType: Windows.Data.Json.JsonValueType; + size: number; + getNamedValue(name: string): Windows.Data.Json.JsonValue; + setNamedValue(name: string, value: Windows.Data.Json.IJsonValue): void; + getNamedObject(name: string): Windows.Data.Json.JsonObject; + getNamedArray(name: string): Windows.Data.Json.JsonArray; + getNamedString(name: string): string; + getNamedNumber(name: string): number; + getNamedBoolean(name: string): boolean; + stringify(): string; + getString(): string; + getNumber(): number; + getBoolean(): boolean; + getArray(): Windows.Data.Json.JsonArray; + getObject(): Windows.Data.Json.JsonObject; + lookup(key: string): Windows.Data.Json.IJsonValue; + hasKey(key: string): boolean; + getView(): Windows.Foundation.Collections.IMapView; + insert(key: string, value: Windows.Data.Json.IJsonValue): boolean; + remove(key: string): void; + clear(): void; + first(): Windows.Foundation.Collections.IIterator>; + static parse(input: string): Windows.Data.Json.JsonObject; + static tryParse(input: string): { result: Windows.Data.Json.JsonObject; succeeded: boolean; }; + } + export interface IJsonValueStatics { + parse(input: string): Windows.Data.Json.JsonValue; + tryParse(input: string): { result: Windows.Data.Json.JsonValue; succeeded: boolean; }; + createBooleanValue(input: boolean): Windows.Data.Json.JsonValue; + createNumberValue(input: number): Windows.Data.Json.JsonValue; + createStringValue(input: string): Windows.Data.Json.JsonValue; + } + export class JsonValue implements Windows.Data.Json.IJsonValue { + valueType: Windows.Data.Json.JsonValueType; + stringify(): string; + getString(): string; + getNumber(): number; + getBoolean(): boolean; + getArray(): Windows.Data.Json.JsonArray; + getObject(): Windows.Data.Json.JsonObject; + static parse(input: string): Windows.Data.Json.JsonValue; + static tryParse(input: string): { result: Windows.Data.Json.JsonValue; succeeded: boolean; }; + static createBooleanValue(input: boolean): Windows.Data.Json.JsonValue; + static createNumberValue(input: number): Windows.Data.Json.JsonValue; + static createStringValue(input: string): Windows.Data.Json.JsonValue; + } + export interface IJsonObject extends Windows.Data.Json.IJsonValue { + getNamedValue(name: string): Windows.Data.Json.JsonValue; + setNamedValue(name: string, value: Windows.Data.Json.IJsonValue): void; + getNamedObject(name: string): Windows.Data.Json.JsonObject; + getNamedArray(name: string): Windows.Data.Json.JsonArray; + getNamedString(name: string): string; + getNamedNumber(name: string): number; + getNamedBoolean(name: string): boolean; + } + export interface IJsonObjectStatics { + parse(input: string): Windows.Data.Json.JsonObject; + tryParse(input: string): { result: Windows.Data.Json.JsonObject; succeeded: boolean; }; + } + export interface IJsonArray extends Windows.Data.Json.IJsonValue { + getObjectAt(index: number): Windows.Data.Json.JsonObject; + getArrayAt(index: number): Windows.Data.Json.JsonArray; + getStringAt(index: number): string; + getNumberAt(index: number): number; + getBooleanAt(index: number): boolean; + } + export interface IJsonArrayStatics { + parse(input: string): Windows.Data.Json.JsonArray; + tryParse(input: string): { result: Windows.Data.Json.JsonArray; succeeded: boolean; }; + } + export interface IJsonErrorStatics { + getStatus(hresult: number): Windows.Data.Json.JsonErrorStatus; + } + export class JsonError { + static getStatus(hresult: number): Windows.Data.Json.JsonErrorStatus; + } + } + } +} +declare module Windows { + export module Data { + export module Xml { + export module Dom { + export enum NodeType { + invalid, + elementNode, + attributeNode, + textNode, + dataSectionNode, + entityReferenceNode, + entityNode, + processingInstructionNode, + commentNode, + documentNode, + documentTypeNode, + documentFragmentNode, + notationNode, + } + export interface IXmlNodeSelector { + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + } + export class XmlNodeList implements Windows.Data.Xml.Dom.IXmlNodeList, Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + length: number; + size: number; + item(index: number): Windows.Data.Xml.Dom.IXmlNode; + getAt(index: number): Windows.Data.Xml.Dom.IXmlNode; + indexOf(value: Windows.Data.Xml.Dom.IXmlNode): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: Windows.Data.Xml.Dom.IXmlNode[]; returnValue: number; }; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.Data.Xml.Dom.IXmlNode[][]): Windows.Data.Xml.Dom.IXmlNode[]; + join(seperator: string): string; + pop(): Windows.Data.Xml.Dom.IXmlNode; + push(...items: Windows.Data.Xml.Dom.IXmlNode[]): void; + reverse(): Windows.Data.Xml.Dom.IXmlNode[]; + shift(): Windows.Data.Xml.Dom.IXmlNode; + slice(start: number): Windows.Data.Xml.Dom.IXmlNode[]; + slice(start: number, end: number): Windows.Data.Xml.Dom.IXmlNode[]; + sort(): Windows.Data.Xml.Dom.IXmlNode[]; + sort(compareFn: (a: Windows.Data.Xml.Dom.IXmlNode, b: Windows.Data.Xml.Dom.IXmlNode) => number): Windows.Data.Xml.Dom.IXmlNode[]; + splice(start: number): Windows.Data.Xml.Dom.IXmlNode[]; + splice(start: number, deleteCount: number, ...items: Windows.Data.Xml.Dom.IXmlNode[]): Windows.Data.Xml.Dom.IXmlNode[]; + unshift(...items: Windows.Data.Xml.Dom.IXmlNode[]): number; + lastIndexOf(searchElement: Windows.Data.Xml.Dom.IXmlNode): number; + lastIndexOf(searchElement: Windows.Data.Xml.Dom.IXmlNode, fromIndex: number): number; + every(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean): boolean; + every(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean): boolean; + some(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => void ): void; + forEach(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any): any[]; + map(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean): Windows.Data.Xml.Dom.IXmlNode[]; + filter(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean, thisArg: any): Windows.Data.Xml.Dom.IXmlNode[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any, initialValue: any): any; + } + export class XmlNamedNodeMap implements Windows.Data.Xml.Dom.IXmlNamedNodeMap, Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + length: number; + size: number; + item(index: number): Windows.Data.Xml.Dom.IXmlNode; + getNamedItem(name: string): Windows.Data.Xml.Dom.IXmlNode; + setNamedItem(node: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeNamedItem(name: string): Windows.Data.Xml.Dom.IXmlNode; + getNamedItemNS(namespaceUri: any, name: string): Windows.Data.Xml.Dom.IXmlNode; + removeNamedItemNS(namespaceUri: any, name: string): Windows.Data.Xml.Dom.IXmlNode; + setNamedItemNS(node: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + getAt(index: number): Windows.Data.Xml.Dom.IXmlNode; + indexOf(value: Windows.Data.Xml.Dom.IXmlNode): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: Windows.Data.Xml.Dom.IXmlNode[]; returnValue: number; }; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.Data.Xml.Dom.IXmlNode[][]): Windows.Data.Xml.Dom.IXmlNode[]; + join(seperator: string): string; + pop(): Windows.Data.Xml.Dom.IXmlNode; + push(...items: Windows.Data.Xml.Dom.IXmlNode[]): void; + reverse(): Windows.Data.Xml.Dom.IXmlNode[]; + shift(): Windows.Data.Xml.Dom.IXmlNode; + slice(start: number): Windows.Data.Xml.Dom.IXmlNode[]; + slice(start: number, end: number): Windows.Data.Xml.Dom.IXmlNode[]; + sort(): Windows.Data.Xml.Dom.IXmlNode[]; + sort(compareFn: (a: Windows.Data.Xml.Dom.IXmlNode, b: Windows.Data.Xml.Dom.IXmlNode) => number): Windows.Data.Xml.Dom.IXmlNode[]; + splice(start: number): Windows.Data.Xml.Dom.IXmlNode[]; + splice(start: number, deleteCount: number, ...items: Windows.Data.Xml.Dom.IXmlNode[]): Windows.Data.Xml.Dom.IXmlNode[]; + unshift(...items: Windows.Data.Xml.Dom.IXmlNode[]): number; + lastIndexOf(searchElement: Windows.Data.Xml.Dom.IXmlNode): number; + lastIndexOf(searchElement: Windows.Data.Xml.Dom.IXmlNode, fromIndex: number): number; + every(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean): boolean; + every(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean): boolean; + some(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => void ): void; + forEach(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any): any[]; + map(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean): Windows.Data.Xml.Dom.IXmlNode[]; + filter(callbackfn: (value: Windows.Data.Xml.Dom.IXmlNode, index: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => boolean, thisArg: any): Windows.Data.Xml.Dom.IXmlNode[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Data.Xml.Dom.IXmlNode[]) => any, initialValue: any): any; + } + export class XmlDocument implements Windows.Data.Xml.Dom.IXmlDocument, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer, Windows.Data.Xml.Dom.IXmlDocumentIO { + doctype: Windows.Data.Xml.Dom.XmlDocumentType; + documentElement: Windows.Data.Xml.Dom.XmlElement; + documentUri: string; + implementation: Windows.Data.Xml.Dom.XmlDomImplementation; + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + createElement(tagName: string): Windows.Data.Xml.Dom.XmlElement; + createDocumentFragment(): Windows.Data.Xml.Dom.XmlDocumentFragment; + createTextNode(data: string): Windows.Data.Xml.Dom.XmlText; + createComment(data: string): Windows.Data.Xml.Dom.XmlComment; + createProcessingInstruction(target: string, data: string): Windows.Data.Xml.Dom.XmlProcessingInstruction; + createAttribute(name: string): Windows.Data.Xml.Dom.XmlAttribute; + createEntityReference(name: string): Windows.Data.Xml.Dom.XmlEntityReference; + getElementsByTagName(tagName: string): Windows.Data.Xml.Dom.XmlNodeList; + createCDataSection(data: string): Windows.Data.Xml.Dom.XmlCDataSection; + createAttributeNS(namespaceUri: any, qualifiedName: string): Windows.Data.Xml.Dom.XmlAttribute; + createElementNS(namespaceUri: any, qualifiedName: string): Windows.Data.Xml.Dom.XmlElement; + getElementById(elementId: string): Windows.Data.Xml.Dom.XmlElement; + importNode(node: Windows.Data.Xml.Dom.IXmlNode, deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + loadXml(xml: string): void; + loadXml(xml: string, loadSettings: Windows.Data.Xml.Dom.XmlLoadSettings): void; + saveToFileAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + static loadFromUriAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + static loadFromUriAsync(uri: Windows.Foundation.Uri, loadSettings: Windows.Data.Xml.Dom.XmlLoadSettings): Windows.Foundation.IAsyncOperation; + static loadFromFileAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + static loadFromFileAsync(file: Windows.Storage.IStorageFile, loadSettings: Windows.Data.Xml.Dom.XmlLoadSettings): Windows.Foundation.IAsyncOperation; + } + export interface IXmlNodeSerializer { + innerText: string; + getXml(): string; + } + export interface IXmlNode extends Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + } + export interface IXmlDomImplementation { + hasFeature(feature: string, version: any): boolean; + } + export interface IXmlDocumentType extends Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + entities: Windows.Data.Xml.Dom.XmlNamedNodeMap; + name: string; + notations: Windows.Data.Xml.Dom.XmlNamedNodeMap; + } + export interface IXmlAttribute extends Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + name: string; + specified: boolean; + value: string; + } + export interface IXmlDocumentFragment extends Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + } + export interface IXmlElement extends Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + tagName: string; + getAttribute(attributeName: string): string; + setAttribute(attributeName: string, attributeValue: string): void; + removeAttribute(attributeName: string): void; + getAttributeNode(attributeName: string): Windows.Data.Xml.Dom.XmlAttribute; + setAttributeNode(newAttribute: Windows.Data.Xml.Dom.XmlAttribute): Windows.Data.Xml.Dom.XmlAttribute; + removeAttributeNode(attributeNode: Windows.Data.Xml.Dom.XmlAttribute): Windows.Data.Xml.Dom.XmlAttribute; + getElementsByTagName(tagName: string): Windows.Data.Xml.Dom.XmlNodeList; + setAttributeNS(namespaceUri: any, qualifiedName: string, value: string): void; + getAttributeNS(namespaceUri: any, localName: string): string; + removeAttributeNS(namespaceUri: any, localName: string): void; + setAttributeNodeNS(newAttribute: Windows.Data.Xml.Dom.XmlAttribute): Windows.Data.Xml.Dom.XmlAttribute; + getAttributeNodeNS(namespaceUri: any, localName: string): Windows.Data.Xml.Dom.XmlAttribute; + } + export class XmlAttribute implements Windows.Data.Xml.Dom.IXmlAttribute, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + name: string; + specified: boolean; + value: string; + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + export interface IDtdNotation extends Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + publicId: any; + systemId: any; + } + export interface IDtdEntity extends Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + notationName: any; + publicId: any; + systemId: any; + } + export interface IXmlEntityReference extends Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + } + export interface IXmlProcessingInstruction extends Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + data: string; + target: string; + } + export interface IXmlCharacterData extends Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + data: string; + length: number; + substringData(offset: number, count: number): string; + appendData(data: string): void; + insertData(offset: number, data: string): void; + deleteData(offset: number, count: number): void; + replaceData(offset: number, count: number, data: string): void; + } + export interface IXmlComment extends Windows.Data.Xml.Dom.IXmlCharacterData, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + } + export interface IXmlText extends Windows.Data.Xml.Dom.IXmlCharacterData, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + splitText(offset: number): Windows.Data.Xml.Dom.IXmlText; + } + export interface IXmlCDataSection extends Windows.Data.Xml.Dom.IXmlText, Windows.Data.Xml.Dom.IXmlCharacterData, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + } + export interface IXmlDocument extends Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + doctype: Windows.Data.Xml.Dom.XmlDocumentType; + documentElement: Windows.Data.Xml.Dom.XmlElement; + documentUri: string; + implementation: Windows.Data.Xml.Dom.XmlDomImplementation; + createElement(tagName: string): Windows.Data.Xml.Dom.XmlElement; + createDocumentFragment(): Windows.Data.Xml.Dom.XmlDocumentFragment; + createTextNode(data: string): Windows.Data.Xml.Dom.XmlText; + createComment(data: string): Windows.Data.Xml.Dom.XmlComment; + createProcessingInstruction(target: string, data: string): Windows.Data.Xml.Dom.XmlProcessingInstruction; + createAttribute(name: string): Windows.Data.Xml.Dom.XmlAttribute; + createEntityReference(name: string): Windows.Data.Xml.Dom.XmlEntityReference; + getElementsByTagName(tagName: string): Windows.Data.Xml.Dom.XmlNodeList; + createCDataSection(data: string): Windows.Data.Xml.Dom.XmlCDataSection; + createAttributeNS(namespaceUri: any, qualifiedName: string): Windows.Data.Xml.Dom.XmlAttribute; + createElementNS(namespaceUri: any, qualifiedName: string): Windows.Data.Xml.Dom.XmlElement; + getElementById(elementId: string): Windows.Data.Xml.Dom.XmlElement; + importNode(node: Windows.Data.Xml.Dom.IXmlNode, deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + } + export class XmlDocumentType implements Windows.Data.Xml.Dom.IXmlDocumentType, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + entities: Windows.Data.Xml.Dom.XmlNamedNodeMap; + name: string; + notations: Windows.Data.Xml.Dom.XmlNamedNodeMap; + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + export class XmlDomImplementation implements Windows.Data.Xml.Dom.IXmlDomImplementation { + hasFeature(feature: string, version: any): boolean; + } + export class XmlElement implements Windows.Data.Xml.Dom.IXmlElement, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + tagName: string; + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + getAttribute(attributeName: string): string; + setAttribute(attributeName: string, attributeValue: string): void; + removeAttribute(attributeName: string): void; + getAttributeNode(attributeName: string): Windows.Data.Xml.Dom.XmlAttribute; + setAttributeNode(newAttribute: Windows.Data.Xml.Dom.XmlAttribute): Windows.Data.Xml.Dom.XmlAttribute; + removeAttributeNode(attributeNode: Windows.Data.Xml.Dom.XmlAttribute): Windows.Data.Xml.Dom.XmlAttribute; + getElementsByTagName(tagName: string): Windows.Data.Xml.Dom.XmlNodeList; + setAttributeNS(namespaceUri: any, qualifiedName: string, value: string): void; + getAttributeNS(namespaceUri: any, localName: string): string; + removeAttributeNS(namespaceUri: any, localName: string): void; + setAttributeNodeNS(newAttribute: Windows.Data.Xml.Dom.XmlAttribute): Windows.Data.Xml.Dom.XmlAttribute; + getAttributeNodeNS(namespaceUri: any, localName: string): Windows.Data.Xml.Dom.XmlAttribute; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + export class XmlDocumentFragment implements Windows.Data.Xml.Dom.IXmlDocumentFragment, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + export class XmlText implements Windows.Data.Xml.Dom.IXmlText, Windows.Data.Xml.Dom.IXmlCharacterData, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + data: string; + length: number; + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + splitText(offset: number): Windows.Data.Xml.Dom.IXmlText; + substringData(offset: number, count: number): string; + appendData(data: string): void; + insertData(offset: number, data: string): void; + deleteData(offset: number, count: number): void; + replaceData(offset: number, count: number, data: string): void; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + export class XmlComment implements Windows.Data.Xml.Dom.IXmlComment, Windows.Data.Xml.Dom.IXmlCharacterData, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + data: string; + length: number; + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + substringData(offset: number, count: number): string; + appendData(data: string): void; + insertData(offset: number, data: string): void; + deleteData(offset: number, count: number): void; + replaceData(offset: number, count: number, data: string): void; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + export class XmlProcessingInstruction implements Windows.Data.Xml.Dom.IXmlProcessingInstruction, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + data: string; + target: string; + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + export class XmlEntityReference implements Windows.Data.Xml.Dom.IXmlEntityReference, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + export class XmlCDataSection implements Windows.Data.Xml.Dom.IXmlCDataSection, Windows.Data.Xml.Dom.IXmlText, Windows.Data.Xml.Dom.IXmlCharacterData, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + data: string; + length: number; + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + splitText(offset: number): Windows.Data.Xml.Dom.IXmlText; + substringData(offset: number, count: number): string; + appendData(data: string): void; + insertData(offset: number, data: string): void; + deleteData(offset: number, count: number): void; + replaceData(offset: number, count: number, data: string): void; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + export interface IXmlNamedNodeMap extends Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + length: number; + item(index: number): Windows.Data.Xml.Dom.IXmlNode; + getNamedItem(name: string): Windows.Data.Xml.Dom.IXmlNode; + setNamedItem(node: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeNamedItem(name: string): Windows.Data.Xml.Dom.IXmlNode; + getNamedItemNS(namespaceUri: any, name: string): Windows.Data.Xml.Dom.IXmlNode; + removeNamedItemNS(namespaceUri: any, name: string): Windows.Data.Xml.Dom.IXmlNode; + setNamedItemNS(node: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + } + export interface IXmlNodeList extends Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + length: number; + item(index: number): Windows.Data.Xml.Dom.IXmlNode; + } + export interface IXmlLoadSettings { + elementContentWhiteSpace: boolean; + maxElementDepth: number; + prohibitDtd: boolean; + resolveExternals: boolean; + validateOnParse: boolean; + } + export interface IXmlDocumentIO { + loadXml(xml: string): void; + loadXml(xml: string, loadSettings: Windows.Data.Xml.Dom.XmlLoadSettings): void; + saveToFileAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + } + export class XmlLoadSettings implements Windows.Data.Xml.Dom.IXmlLoadSettings { + elementContentWhiteSpace: boolean; + maxElementDepth: number; + prohibitDtd: boolean; + resolveExternals: boolean; + validateOnParse: boolean; + } + export interface IXmlDocumentStatics { + loadFromUriAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + loadFromUriAsync(uri: Windows.Foundation.Uri, loadSettings: Windows.Data.Xml.Dom.XmlLoadSettings): Windows.Foundation.IAsyncOperation; + loadFromFileAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + loadFromFileAsync(file: Windows.Storage.IStorageFile, loadSettings: Windows.Data.Xml.Dom.XmlLoadSettings): Windows.Foundation.IAsyncOperation; + } + export class DtdNotation implements Windows.Data.Xml.Dom.IDtdNotation, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + publicId: any; + systemId: any; + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + export class DtdEntity implements Windows.Data.Xml.Dom.IDtdEntity, Windows.Data.Xml.Dom.IXmlNode, Windows.Data.Xml.Dom.IXmlNodeSelector, Windows.Data.Xml.Dom.IXmlNodeSerializer { + notationName: any; + publicId: any; + systemId: any; + attributes: Windows.Data.Xml.Dom.XmlNamedNodeMap; + childNodes: Windows.Data.Xml.Dom.XmlNodeList; + firstChild: Windows.Data.Xml.Dom.IXmlNode; + lastChild: Windows.Data.Xml.Dom.IXmlNode; + localName: any; + namespaceUri: any; + nextSibling: Windows.Data.Xml.Dom.IXmlNode; + nodeName: string; + nodeType: Windows.Data.Xml.Dom.NodeType; + nodeValue: any; + ownerDocument: Windows.Data.Xml.Dom.XmlDocument; + parentNode: Windows.Data.Xml.Dom.IXmlNode; + prefix: any; + previousSibling: Windows.Data.Xml.Dom.IXmlNode; + innerText: string; + hasChildNodes(): boolean; + insertBefore(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + replaceChild(newChild: Windows.Data.Xml.Dom.IXmlNode, referenceChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + removeChild(childNode: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + appendChild(newChild: Windows.Data.Xml.Dom.IXmlNode): Windows.Data.Xml.Dom.IXmlNode; + cloneNode(deep: boolean): Windows.Data.Xml.Dom.IXmlNode; + normalize(): void; + selectSingleNode(xpath: string): Windows.Data.Xml.Dom.IXmlNode; + selectNodes(xpath: string): Windows.Data.Xml.Dom.XmlNodeList; + selectSingleNodeNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.IXmlNode; + selectNodesNS(xpath: string, namespaces: any): Windows.Data.Xml.Dom.XmlNodeList; + getXml(): string; + } + } + } + } +} +declare module Windows { + export module Data { + export module Xml { + export module Xsl { + export interface IXsltProcessor { + transformToString(inputNode: Windows.Data.Xml.Dom.IXmlNode): string; + } + export interface IXsltProcessorFactory { + createInstance(document: Windows.Data.Xml.Dom.XmlDocument): Windows.Data.Xml.Xsl.XsltProcessor; + } + export class XsltProcessor implements Windows.Data.Xml.Xsl.IXsltProcessor { + constructor(document: Windows.Data.Xml.Dom.XmlDocument); + transformToString(inputNode: Windows.Data.Xml.Dom.IXmlNode): string; + } + } + } + } +} +declare module Windows { + export module Devices { + export module Sms { + export enum SmsMessageClass { + none, + class0, + class1, + class2, + class3, + } + export interface ISmsMessage { + id: number; + messageClass: Windows.Devices.Sms.SmsMessageClass; + } + export enum SmsDataFormat { + unknown, + cdmaSubmit, + gsmSubmit, + cdmaDeliver, + gsmDeliver, + } + export interface ISmsBinaryMessage extends Windows.Devices.Sms.ISmsMessage { + format: Windows.Devices.Sms.SmsDataFormat; + getData(): Uint8Array; + setData(value: Uint8Array): void; + } + export class SmsBinaryMessage implements Windows.Devices.Sms.ISmsBinaryMessage, Windows.Devices.Sms.ISmsMessage { + format: Windows.Devices.Sms.SmsDataFormat; + id: number; + messageClass: Windows.Devices.Sms.SmsMessageClass; + getData(): Uint8Array; + setData(value: Uint8Array): void; + } + export enum SmsEncoding { + unknown, + optimal, + sevenBitAscii, + unicode, + gsmSevenBit, + } + export interface ISmsTextMessage extends Windows.Devices.Sms.ISmsMessage { + body: string; + encoding: Windows.Devices.Sms.SmsEncoding; + from: string; + partCount: number; + partNumber: number; + partReferenceId: number; + timestamp: Date; + to: string; + toBinaryMessages(format: Windows.Devices.Sms.SmsDataFormat): Windows.Foundation.Collections.IVectorView; + } + export interface ISmsTextMessageStatics { + fromBinaryMessage(binaryMessage: Windows.Devices.Sms.SmsBinaryMessage): Windows.Devices.Sms.SmsTextMessage; + fromBinaryData(format: Windows.Devices.Sms.SmsDataFormat, value: Uint8Array): Windows.Devices.Sms.SmsTextMessage; + } + export class SmsTextMessage implements Windows.Devices.Sms.ISmsTextMessage, Windows.Devices.Sms.ISmsMessage { + body: string; + encoding: Windows.Devices.Sms.SmsEncoding; + from: string; + partCount: number; + partNumber: number; + partReferenceId: number; + timestamp: Date; + to: string; + id: number; + messageClass: Windows.Devices.Sms.SmsMessageClass; + toBinaryMessages(format: Windows.Devices.Sms.SmsDataFormat): Windows.Foundation.Collections.IVectorView; + static fromBinaryMessage(binaryMessage: Windows.Devices.Sms.SmsBinaryMessage): Windows.Devices.Sms.SmsTextMessage; + static fromBinaryData(format: Windows.Devices.Sms.SmsDataFormat, value: Uint8Array): Windows.Devices.Sms.SmsTextMessage; + } + export enum SmsMessageFilter { + all, + unread, + read, + sent, + draft, + } + export enum SmsMessageType { + binary, + text, + } + export class DeleteSmsMessageOperation implements Windows.Foundation.IAsyncAction, Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncActionCompletedHandler; + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + getResults(): void; + cancel(): void; + close(): void; + then(success?: (value: any) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: any) => Windows.Foundation.IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: any) => U, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: any) => Windows.Foundation.IPromise, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done(success?: (value: any) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + operation: { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + getResults(): any; + } + } + export class DeleteSmsMessagesOperation implements Windows.Foundation.IAsyncAction, Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncActionCompletedHandler; + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + getResults(): void; + cancel(): void; + close(): void; + then(success?: (value: any) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: any) => Windows.Foundation.IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: any) => U, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: any) => Windows.Foundation.IPromise, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done(success?: (value: any) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + operation: { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + getResults(): any; + } + } + export class GetSmsMessageOperation implements Windows.Foundation.IAsyncOperation, Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + getResults(): Windows.Devices.Sms.ISmsMessage; + cancel(): void; + close(): void; + then(success?: (value: Windows.Devices.Sms.ISmsMessage) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Devices.Sms.ISmsMessage) => Windows.Foundation.IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Devices.Sms.ISmsMessage) => U, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Devices.Sms.ISmsMessage) => Windows.Foundation.IPromise, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done(success?: (value: Windows.Devices.Sms.ISmsMessage) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + operation: { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + getResults(): Windows.Devices.Sms.ISmsMessage; + } + } + export class GetSmsMessagesOperation implements Windows.Foundation.IAsyncOperationWithProgress, number>, Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncOperationWithProgressCompletedHandler, number>; + progress: Windows.Foundation.AsyncOperationProgressHandler, number>; + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + getResults(): Windows.Foundation.Collections.IVectorView; + cancel(): void; + close(): void; + then(success?: (value: Windows.Foundation.Collections.IVectorView) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Foundation.Collections.IVectorView) => Windows.Foundation.IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Foundation.Collections.IVectorView) => U, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Foundation.Collections.IVectorView) => Windows.Foundation.IPromise, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done(success?: (value: Windows.Foundation.Collections.IVectorView) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + operation: { + progress: Windows.Foundation.AsyncOperationProgressHandler, number>; + completed: Windows.Foundation.AsyncOperationCompletedHandler>; + getResults(): Windows.Foundation.Collections.IVectorView; + } + } + export interface ISmsDeviceMessageStore { + maxMessages: number; + deleteMessageAsync(messageId: number): Windows.Foundation.IAsyncAction; + deleteMessagesAsync(messageFilter: Windows.Devices.Sms.SmsMessageFilter): Windows.Foundation.IAsyncAction; + getMessageAsync(messageId: number): Windows.Foundation.IAsyncOperation; + getMessagesAsync(messageFilter: Windows.Devices.Sms.SmsMessageFilter): Windows.Foundation.IAsyncOperationWithProgress, number>; + } + export class SmsDeviceMessageStore implements Windows.Devices.Sms.ISmsDeviceMessageStore { + maxMessages: number; + deleteMessageAsync(messageId: number): Windows.Foundation.IAsyncAction; + deleteMessagesAsync(messageFilter: Windows.Devices.Sms.SmsMessageFilter): Windows.Foundation.IAsyncAction; + getMessageAsync(messageId: number): Windows.Foundation.IAsyncOperation; + getMessagesAsync(messageFilter: Windows.Devices.Sms.SmsMessageFilter): Windows.Foundation.IAsyncOperationWithProgress, number>; + } + export interface SmsEncodedLength { + segmentCount: number; + characterCountLastSegment: number; + charactersPerSegment: number; + byteCountLastSegment: number; + bytesPerSegment: number; + } + export enum CellularClass { + none, + gsm, + cdma, + } + export enum SmsDeviceStatus { + off, + ready, + simNotInserted, + badSim, + deviceFailure, + subscriptionNotActivated, + deviceLocked, + deviceBlocked, + } + export class SendSmsMessageOperation implements Windows.Foundation.IAsyncAction, Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncActionCompletedHandler; + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + getResults(): void; + cancel(): void; + close(): void; + then(success: (value: any) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success: (value: any) => Windows.Foundation.IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success: (value: any) => U, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success: (value: any) => Windows.Foundation.IPromise, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done(success: (value: any) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + operation: { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + getResults(): any; + } + } + export interface ISmsMessageReceivedEventArgs { + binaryMessage: Windows.Devices.Sms.SmsBinaryMessage; + textMessage: Windows.Devices.Sms.SmsTextMessage; + } + export class SmsMessageReceivedEventArgs implements Windows.Devices.Sms.ISmsMessageReceivedEventArgs { + binaryMessage: Windows.Devices.Sms.SmsBinaryMessage; + textMessage: Windows.Devices.Sms.SmsTextMessage; + } + export interface SmsMessageReceivedEventHandler { + (sender: Windows.Devices.Sms.SmsDevice, e: Windows.Devices.Sms.SmsMessageReceivedEventArgs): void; + } + export class SmsDevice implements Windows.Devices.Sms.ISmsDevice { + accountPhoneNumber: string; + cellularClass: Windows.Devices.Sms.CellularClass; + deviceStatus: Windows.Devices.Sms.SmsDeviceStatus; + messageStore: Windows.Devices.Sms.SmsDeviceMessageStore; + sendMessageAsync(message: Windows.Devices.Sms.ISmsMessage): Windows.Devices.Sms.SendSmsMessageOperation; + calculateLength(message: Windows.Devices.Sms.SmsTextMessage): Windows.Devices.Sms.SmsEncodedLength; + onsmsmessagereceived: any/* TODO */; + onsmsdevicestatuschanged: any/* TODO */; + static getDeviceSelector(): string; + static fromIdAsync(deviceInstanceId: string): Windows.Foundation.IAsyncOperation; + static getDefaultAsync(): Windows.Foundation.IAsyncOperation; + } + export interface SmsDeviceStatusChangedEventHandler { + (sender: Windows.Devices.Sms.SmsDevice): void; + } + export class GetSmsDeviceOperation implements Windows.Foundation.IAsyncOperation, Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + getResults(): Windows.Devices.Sms.SmsDevice; + cancel(): void; + close(): void; + then(success?: (value: Windows.Devices.Sms.SmsDevice) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Devices.Sms.SmsDevice) => Windows.Foundation.IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Devices.Sms.SmsDevice) => U, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Devices.Sms.SmsDevice) => Windows.Foundation.IPromise, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done(success?: (value: Windows.Devices.Sms.SmsDevice) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + operation: { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + getResults(): Windows.Devices.Sms.SmsDevice; + } + } + export interface ISmsDeviceStatics { + getDeviceSelector(): string; + fromIdAsync(deviceInstanceId: string): Windows.Foundation.IAsyncOperation; + getDefaultAsync(): Windows.Foundation.IAsyncOperation; + } + export interface ISmsDevice { + accountPhoneNumber: string; + cellularClass: Windows.Devices.Sms.CellularClass; + deviceStatus: Windows.Devices.Sms.SmsDeviceStatus; + messageStore: Windows.Devices.Sms.SmsDeviceMessageStore; + sendMessageAsync(message: Windows.Devices.Sms.ISmsMessage): Windows.Devices.Sms.SendSmsMessageOperation; + calculateLength(message: Windows.Devices.Sms.SmsTextMessage): Windows.Devices.Sms.SmsEncodedLength; + onsmsmessagereceived: any/* TODO */; + onsmsdevicestatuschanged: any/* TODO */; + } + export interface ISmsReceivedEventDetails { + deviceId: string; + messageIndex: number; + } + export class SmsReceivedEventDetails implements Windows.Devices.Sms.ISmsReceivedEventDetails { + deviceId: string; + messageIndex: number; + } + } + } +} +declare module Windows { + export module Devices { + export module Enumeration { + export enum DeviceClass { + all, + audioCapture, + audioRender, + portableStorageDevice, + videoCapture, + } + export enum DeviceWatcherStatus { + created, + started, + enumerationCompleted, + stopping, + stopped, + aborted, + } + export class DeviceThumbnail implements Windows.Storage.Streams.IRandomAccessStreamWithContentType, Windows.Storage.Streams.IRandomAccessStream, Windows.Foundation.IClosable, Windows.Storage.Streams.IInputStream, Windows.Storage.Streams.IOutputStream, Windows.Storage.Streams.IContentTypeProvider { + canRead: boolean; + canWrite: boolean; + position: number; + size: number; + contentType: string; + getInputStreamAt(position: number): Windows.Storage.Streams.IInputStream; + getOutputStreamAt(position: number): Windows.Storage.Streams.IOutputStream; + seek(position: number): void; + cloneStream(): Windows.Storage.Streams.IRandomAccessStream; + dispose(): void; + readAsync(buffer: Windows.Storage.Streams.IBuffer, count: number, options: Windows.Storage.Streams.InputStreamOptions): Windows.Foundation.IAsyncOperationWithProgress; + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + close(): void; + } + export enum Panel { + unknown, + front, + back, + top, + bottom, + left, + right, + } + export interface IEnclosureLocation { + inDock: boolean; + inLid: boolean; + panel: Windows.Devices.Enumeration.Panel; + } + export class EnclosureLocation implements Windows.Devices.Enumeration.IEnclosureLocation { + inDock: boolean; + inLid: boolean; + panel: Windows.Devices.Enumeration.Panel; + } + export interface IDeviceInformationUpdate { + id: string; + properties: Windows.Foundation.Collections.IMapView; + } + export class DeviceInformationUpdate implements Windows.Devices.Enumeration.IDeviceInformationUpdate { + id: string; + properties: Windows.Foundation.Collections.IMapView; + } + export class DeviceInformationCollection implements Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): Windows.Devices.Enumeration.DeviceInformation; + indexOf(value: Windows.Devices.Enumeration.DeviceInformation): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: Windows.Devices.Enumeration.DeviceInformation[]; returnValue: number; }; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.Devices.Enumeration.DeviceInformation[][]): Windows.Devices.Enumeration.DeviceInformation[]; + join(seperator: string): string; + pop(): Windows.Devices.Enumeration.DeviceInformation; + push(...items: Windows.Devices.Enumeration.DeviceInformation[]): void; + reverse(): Windows.Devices.Enumeration.DeviceInformation[]; + shift(): Windows.Devices.Enumeration.DeviceInformation; + slice(start: number): Windows.Devices.Enumeration.DeviceInformation[]; + slice(start: number, end: number): Windows.Devices.Enumeration.DeviceInformation[]; + sort(): Windows.Devices.Enumeration.DeviceInformation[]; + sort(compareFn: (a: Windows.Devices.Enumeration.DeviceInformation, b: Windows.Devices.Enumeration.DeviceInformation) => number): Windows.Devices.Enumeration.DeviceInformation[]; + splice(start: number): Windows.Devices.Enumeration.DeviceInformation[]; + splice(start: number, deleteCount: number, ...items: Windows.Devices.Enumeration.DeviceInformation[]): Windows.Devices.Enumeration.DeviceInformation[]; + unshift(...items: Windows.Devices.Enumeration.DeviceInformation[]): number; + lastIndexOf(searchElement: Windows.Devices.Enumeration.DeviceInformation): number; + lastIndexOf(searchElement: Windows.Devices.Enumeration.DeviceInformation, fromIndex: number): number; + every(callbackfn: (value: Windows.Devices.Enumeration.DeviceInformation, index: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => boolean): boolean; + every(callbackfn: (value: Windows.Devices.Enumeration.DeviceInformation, index: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.Devices.Enumeration.DeviceInformation, index: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => boolean): boolean; + some(callbackfn: (value: Windows.Devices.Enumeration.DeviceInformation, index: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.Devices.Enumeration.DeviceInformation, index: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => void ): void; + forEach(callbackfn: (value: Windows.Devices.Enumeration.DeviceInformation, index: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.Devices.Enumeration.DeviceInformation, index: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => any): any[]; + map(callbackfn: (value: Windows.Devices.Enumeration.DeviceInformation, index: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.Devices.Enumeration.DeviceInformation, index: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => boolean): Windows.Devices.Enumeration.DeviceInformation[]; + filter(callbackfn: (value: Windows.Devices.Enumeration.DeviceInformation, index: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => boolean, thisArg: any): Windows.Devices.Enumeration.DeviceInformation[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Devices.Enumeration.DeviceInformation[]) => any, initialValue: any): any; + length: number; + } + export interface IDeviceWatcher { + status: Windows.Devices.Enumeration.DeviceWatcherStatus; + onadded: any/* TODO */; + onupdated: any/* TODO */; + onremoved: any/* TODO */; + onenumerationcompleted: any/* TODO */; + onstopped: any/* TODO */; + start(): void; + stop(): void; + } + export class DeviceWatcher implements Windows.Devices.Enumeration.IDeviceWatcher { + status: Windows.Devices.Enumeration.DeviceWatcherStatus; + onadded: any/* TODO */; + onupdated: any/* TODO */; + onremoved: any/* TODO */; + onenumerationcompleted: any/* TODO */; + onstopped: any/* TODO */; + start(): void; + stop(): void; + } + export class DeviceInformation implements Windows.Devices.Enumeration.IDeviceInformation { + enclosureLocation: Windows.Devices.Enumeration.EnclosureLocation; + id: string; + isDefault: boolean; + isEnabled: boolean; + name: string; + properties: Windows.Foundation.Collections.IMapView; + update(updateInfo: Windows.Devices.Enumeration.DeviceInformationUpdate): void; + getThumbnailAsync(): Windows.Foundation.IAsyncOperation; + getGlyphThumbnailAsync(): Windows.Foundation.IAsyncOperation; + static createFromIdAsync(id: string): Windows.Foundation.IAsyncOperation; + static createFromIdAsync(id: string, additionalProperties: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + static findAllAsync(): Windows.Foundation.IAsyncOperation; + static findAllAsync(deviceClass: Windows.Devices.Enumeration.DeviceClass): Windows.Foundation.IAsyncOperation; + static findAllAsync(aqsFilter: string): Windows.Foundation.IAsyncOperation; + static findAllAsync(aqsFilter: string, additionalProperties: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + static createWatcher(): Windows.Devices.Enumeration.DeviceWatcher; + static createWatcher(deviceClass: Windows.Devices.Enumeration.DeviceClass): Windows.Devices.Enumeration.DeviceWatcher; + static createWatcher(aqsFilter: string): Windows.Devices.Enumeration.DeviceWatcher; + static createWatcher(aqsFilter: string, additionalProperties: Windows.Foundation.Collections.IIterable): Windows.Devices.Enumeration.DeviceWatcher; + } + export interface IDeviceInformationStatics { + createFromIdAsync(id: string): Windows.Foundation.IAsyncOperation; + createFromIdAsync(id: string, additionalProperties: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + findAllAsync(): Windows.Foundation.IAsyncOperation; + findAllAsync(deviceClass: Windows.Devices.Enumeration.DeviceClass): Windows.Foundation.IAsyncOperation; + findAllAsync(aqsFilter: string): Windows.Foundation.IAsyncOperation; + findAllAsync(aqsFilter: string, additionalProperties: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + createWatcher(): Windows.Devices.Enumeration.DeviceWatcher; + createWatcher(deviceClass: Windows.Devices.Enumeration.DeviceClass): Windows.Devices.Enumeration.DeviceWatcher; + createWatcher(aqsFilter: string): Windows.Devices.Enumeration.DeviceWatcher; + createWatcher(aqsFilter: string, additionalProperties: Windows.Foundation.Collections.IIterable): Windows.Devices.Enumeration.DeviceWatcher; + } + export interface IDeviceInformation { + enclosureLocation: Windows.Devices.Enumeration.EnclosureLocation; + id: string; + isDefault: boolean; + isEnabled: boolean; + name: string; + properties: Windows.Foundation.Collections.IMapView; + update(updateInfo: Windows.Devices.Enumeration.DeviceInformationUpdate): void; + getThumbnailAsync(): Windows.Foundation.IAsyncOperation; + getGlyphThumbnailAsync(): Windows.Foundation.IAsyncOperation; + } + } + } +} +declare module Windows { + export module Devices { + export module Enumeration { + export module Pnp { + export enum PnpObjectType { + unknown, + deviceInterface, + deviceContainer, + device, + deviceInterfaceClass, + } + export interface IPnpObjectUpdate { + id: string; + properties: Windows.Foundation.Collections.IMapView; + type: Windows.Devices.Enumeration.Pnp.PnpObjectType; + } + export class PnpObjectUpdate implements Windows.Devices.Enumeration.Pnp.IPnpObjectUpdate { + id: string; + properties: Windows.Foundation.Collections.IMapView; + type: Windows.Devices.Enumeration.Pnp.PnpObjectType; + } + export class PnpObjectCollection implements Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): Windows.Devices.Enumeration.Pnp.PnpObject; + indexOf(value: Windows.Devices.Enumeration.Pnp.PnpObject): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: Windows.Devices.Enumeration.Pnp.PnpObject[]; returnValue: number; }; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.Devices.Enumeration.Pnp.PnpObject[][]): Windows.Devices.Enumeration.Pnp.PnpObject[]; + join(seperator: string): string; + pop(): Windows.Devices.Enumeration.Pnp.PnpObject; + push(...items: Windows.Devices.Enumeration.Pnp.PnpObject[]): void; + reverse(): Windows.Devices.Enumeration.Pnp.PnpObject[]; + shift(): Windows.Devices.Enumeration.Pnp.PnpObject; + slice(start: number): Windows.Devices.Enumeration.Pnp.PnpObject[]; + slice(start: number, end: number): Windows.Devices.Enumeration.Pnp.PnpObject[]; + sort(): Windows.Devices.Enumeration.Pnp.PnpObject[]; + sort(compareFn: (a: Windows.Devices.Enumeration.Pnp.PnpObject, b: Windows.Devices.Enumeration.Pnp.PnpObject) => number): Windows.Devices.Enumeration.Pnp.PnpObject[]; + splice(start: number): Windows.Devices.Enumeration.Pnp.PnpObject[]; + splice(start: number, deleteCount: number, ...items: Windows.Devices.Enumeration.Pnp.PnpObject[]): Windows.Devices.Enumeration.Pnp.PnpObject[]; + unshift(...items: Windows.Devices.Enumeration.Pnp.PnpObject[]): number; + lastIndexOf(searchElement: Windows.Devices.Enumeration.Pnp.PnpObject): number; + lastIndexOf(searchElement: Windows.Devices.Enumeration.Pnp.PnpObject, fromIndex: number): number; + every(callbackfn: (value: Windows.Devices.Enumeration.Pnp.PnpObject, index: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => boolean): boolean; + every(callbackfn: (value: Windows.Devices.Enumeration.Pnp.PnpObject, index: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.Devices.Enumeration.Pnp.PnpObject, index: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => boolean): boolean; + some(callbackfn: (value: Windows.Devices.Enumeration.Pnp.PnpObject, index: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.Devices.Enumeration.Pnp.PnpObject, index: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => void ): void; + forEach(callbackfn: (value: Windows.Devices.Enumeration.Pnp.PnpObject, index: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.Devices.Enumeration.Pnp.PnpObject, index: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => any): any[]; + map(callbackfn: (value: Windows.Devices.Enumeration.Pnp.PnpObject, index: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.Devices.Enumeration.Pnp.PnpObject, index: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => boolean): Windows.Devices.Enumeration.Pnp.PnpObject[]; + filter(callbackfn: (value: Windows.Devices.Enumeration.Pnp.PnpObject, index: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => boolean, thisArg: any): Windows.Devices.Enumeration.Pnp.PnpObject[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Devices.Enumeration.Pnp.PnpObject[]) => any, initialValue: any): any; + length: number; + } + export interface IPnpObjectWatcher { + status: Windows.Devices.Enumeration.DeviceWatcherStatus; + onadded: any/* TODO */; + onupdated: any/* TODO */; + onremoved: any/* TODO */; + onenumerationcompleted: any/* TODO */; + onstopped: any/* TODO */; + start(): void; + stop(): void; + } + export class PnpObjectWatcher implements Windows.Devices.Enumeration.Pnp.IPnpObjectWatcher { + status: Windows.Devices.Enumeration.DeviceWatcherStatus; + onadded: any/* TODO */; + onupdated: any/* TODO */; + onremoved: any/* TODO */; + onenumerationcompleted: any/* TODO */; + onstopped: any/* TODO */; + start(): void; + stop(): void; + } + export class PnpObject implements Windows.Devices.Enumeration.Pnp.IPnpObject { + id: string; + properties: Windows.Foundation.Collections.IMapView; + type: Windows.Devices.Enumeration.Pnp.PnpObjectType; + update(updateInfo: Windows.Devices.Enumeration.Pnp.PnpObjectUpdate): void; + static createFromIdAsync(type: Windows.Devices.Enumeration.Pnp.PnpObjectType, id: string, requestedProperties: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + static findAllAsync(type: Windows.Devices.Enumeration.Pnp.PnpObjectType, requestedProperties: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + static findAllAsync(type: Windows.Devices.Enumeration.Pnp.PnpObjectType, requestedProperties: Windows.Foundation.Collections.IIterable, aqsFilter: string): Windows.Foundation.IAsyncOperation; + static createWatcher(type: Windows.Devices.Enumeration.Pnp.PnpObjectType, requestedProperties: Windows.Foundation.Collections.IIterable): Windows.Devices.Enumeration.Pnp.PnpObjectWatcher; + static createWatcher(type: Windows.Devices.Enumeration.Pnp.PnpObjectType, requestedProperties: Windows.Foundation.Collections.IIterable, aqsFilter: string): Windows.Devices.Enumeration.Pnp.PnpObjectWatcher; + } + export interface IPnpObjectStatics { + createFromIdAsync(type: Windows.Devices.Enumeration.Pnp.PnpObjectType, id: string, requestedProperties: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + findAllAsync(type: Windows.Devices.Enumeration.Pnp.PnpObjectType, requestedProperties: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + findAllAsync(type: Windows.Devices.Enumeration.Pnp.PnpObjectType, requestedProperties: Windows.Foundation.Collections.IIterable, aqsFilter: string): Windows.Foundation.IAsyncOperation; + createWatcher(type: Windows.Devices.Enumeration.Pnp.PnpObjectType, requestedProperties: Windows.Foundation.Collections.IIterable): Windows.Devices.Enumeration.Pnp.PnpObjectWatcher; + createWatcher(type: Windows.Devices.Enumeration.Pnp.PnpObjectType, requestedProperties: Windows.Foundation.Collections.IIterable, aqsFilter: string): Windows.Devices.Enumeration.Pnp.PnpObjectWatcher; + } + export interface IPnpObject { + id: string; + properties: Windows.Foundation.Collections.IMapView; + type: Windows.Devices.Enumeration.Pnp.PnpObjectType; + update(updateInfo: Windows.Devices.Enumeration.Pnp.PnpObjectUpdate): void; + } + } + } + } +} +declare module Windows { + export module Devices { + export module Geolocation { + export enum PositionAccuracy { + default, + high, + } + export enum PositionStatus { + ready, + initializing, + noData, + disabled, + notInitialized, + notAvailable, + } + export interface IGeocoordinate { + accuracy: number; + altitude: number; + altitudeAccuracy: number; + heading: number; + latitude: number; + longitude: number; + speed: number; + timestamp: Date; + } + export class Geocoordinate implements Windows.Devices.Geolocation.IGeocoordinate { + accuracy: number; + altitude: number; + altitudeAccuracy: number; + heading: number; + latitude: number; + longitude: number; + speed: number; + timestamp: Date; + } + export interface ICivicAddress { + city: string; + country: string; + postalCode: string; + state: string; + timestamp: Date; + } + export class CivicAddress implements Windows.Devices.Geolocation.ICivicAddress { + city: string; + country: string; + postalCode: string; + state: string; + timestamp: Date; + } + export interface IGeoposition { + civicAddress: Windows.Devices.Geolocation.CivicAddress; + coordinate: Windows.Devices.Geolocation.Geocoordinate; + } + export class Geoposition implements Windows.Devices.Geolocation.IGeoposition { + civicAddress: Windows.Devices.Geolocation.CivicAddress; + coordinate: Windows.Devices.Geolocation.Geocoordinate; + } + export interface IPositionChangedEventArgs { + position: Windows.Devices.Geolocation.Geoposition; + } + export class PositionChangedEventArgs implements Windows.Devices.Geolocation.IPositionChangedEventArgs { + position: Windows.Devices.Geolocation.Geoposition; + } + export interface IStatusChangedEventArgs { + status: Windows.Devices.Geolocation.PositionStatus; + } + export class StatusChangedEventArgs implements Windows.Devices.Geolocation.IStatusChangedEventArgs { + status: Windows.Devices.Geolocation.PositionStatus; + } + export interface IGeolocator { + desiredAccuracy: Windows.Devices.Geolocation.PositionAccuracy; + locationStatus: Windows.Devices.Geolocation.PositionStatus; + movementThreshold: number; + reportInterval: number; + getGeopositionAsync(): Windows.Foundation.IAsyncOperation; + getGeopositionAsync(maximumAge: number, timeout: number): Windows.Foundation.IAsyncOperation; + onpositionchanged: any/* TODO */; + onstatuschanged: any/* TODO */; + } + export class Geolocator implements Windows.Devices.Geolocation.IGeolocator { + desiredAccuracy: Windows.Devices.Geolocation.PositionAccuracy; + locationStatus: Windows.Devices.Geolocation.PositionStatus; + movementThreshold: number; + reportInterval: number; + getGeopositionAsync(): Windows.Foundation.IAsyncOperation; + getGeopositionAsync(maximumAge: number, timeout: number): Windows.Foundation.IAsyncOperation; + onpositionchanged: any/* TODO */; + onstatuschanged: any/* TODO */; + } + } + } +} +declare module Windows { + export module Devices { + export module Input { + export enum PointerDeviceType { + touch, + pen, + mouse, + } + export interface PointerDeviceUsage { + usagePage: number; + usage: number; + minLogical: number; + maxLogical: number; + minPhysical: number; + maxPhysical: number; + unit: number; + physicalMultiplier: number; + } + export interface MouseDelta { + x: number; + y: number; + } + export interface IMouseCapabilities { + horizontalWheelPresent: number; + mousePresent: number; + numberOfButtons: number; + swapButtons: number; + verticalWheelPresent: number; + } + export interface IKeyboardCapabilities { + keyboardPresent: number; + } + export interface ITouchCapabilities { + contacts: number; + touchPresent: number; + } + export interface IPointerDeviceStatics { + getPointerDevice(pointerId: number): Windows.Devices.Input.PointerDevice; + getPointerDevices(): Windows.Foundation.Collections.IVectorView; + } + export class PointerDevice implements Windows.Devices.Input.IPointerDevice { + isIntegrated: boolean; + maxContacts: number; + physicalDeviceRect: Windows.Foundation.Rect; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + screenRect: Windows.Foundation.Rect; + supportedUsages: Windows.Foundation.Collections.IVectorView; + static getPointerDevice(pointerId: number): Windows.Devices.Input.PointerDevice; + static getPointerDevices(): Windows.Foundation.Collections.IVectorView; + } + export interface IPointerDevice { + isIntegrated: boolean; + maxContacts: number; + physicalDeviceRect: Windows.Foundation.Rect; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + screenRect: Windows.Foundation.Rect; + supportedUsages: Windows.Foundation.Collections.IVectorView; + } + export interface IMouseEventArgs { + mouseDelta: Windows.Devices.Input.MouseDelta; + } + export interface IMouseDevice { + onmousemoved: any/* TODO */; + } + export class MouseDevice implements Windows.Devices.Input.IMouseDevice { + onmousemoved: any/* TODO */; + static getForCurrentView(): Windows.Devices.Input.MouseDevice; + } + export class MouseEventArgs implements Windows.Devices.Input.IMouseEventArgs { + mouseDelta: Windows.Devices.Input.MouseDelta; + } + export interface IMouseDeviceStatics { + getForCurrentView(): Windows.Devices.Input.MouseDevice; + } + export class MouseCapabilities implements Windows.Devices.Input.IMouseCapabilities { + horizontalWheelPresent: number; + mousePresent: number; + numberOfButtons: number; + swapButtons: number; + verticalWheelPresent: number; + } + export class KeyboardCapabilities implements Windows.Devices.Input.IKeyboardCapabilities { + keyboardPresent: number; + } + export class TouchCapabilities implements Windows.Devices.Input.ITouchCapabilities { + contacts: number; + touchPresent: number; + } + } + } +} +declare module Windows { + export module Devices { + export module Portable { + export enum ServiceDeviceType { + calendarService, + contactsService, + deviceStatusService, + notesService, + ringtonesService, + smsService, + tasksService, + } + export interface IStorageDeviceStatics { + fromId(interfaceId: string): Windows.Storage.StorageFolder; + getDeviceSelector(): string; + } + export interface IServiceDeviceStatics { + getDeviceSelector(serviceType: Windows.Devices.Portable.ServiceDeviceType): string; + getDeviceSelectorFromServiceId(serviceId: string): string; + } + export class StorageDevice { + static fromId(interfaceId: string): Windows.Storage.StorageFolder; + static getDeviceSelector(): string; + } + export class ServiceDevice { + static getDeviceSelector(serviceType: Windows.Devices.Portable.ServiceDeviceType): string; + static getDeviceSelectorFromServiceId(serviceId: string): string; + } + } + } +} +declare module Windows { + export module Devices { + export module Printers { + export module Extensions { + export interface IPrintTaskConfigurationSaveRequestedDeferral { + complete(): void; + } + export class PrintTaskConfigurationSaveRequestedDeferral implements Windows.Devices.Printers.Extensions.IPrintTaskConfigurationSaveRequestedDeferral { + complete(): void; + } + export interface IPrintTaskConfigurationSaveRequest { + deadline: Date; + cancel(): void; + save(printerExtensionContext: any): void; + getDeferral(): Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequestedDeferral; + } + export class PrintTaskConfigurationSaveRequest implements Windows.Devices.Printers.Extensions.IPrintTaskConfigurationSaveRequest { + deadline: Date; + cancel(): void; + save(printerExtensionContext: any): void; + getDeferral(): Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequestedDeferral; + } + export interface IPrintTaskConfigurationSaveRequestedEventArgs { + request: Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest; + } + export class PrintTaskConfigurationSaveRequestedEventArgs implements Windows.Devices.Printers.Extensions.IPrintTaskConfigurationSaveRequestedEventArgs { + request: Windows.Devices.Printers.Extensions.PrintTaskConfigurationSaveRequest; + } + export interface IPrintTaskConfiguration { + printerExtensionContext: any; + onsaverequested: any/* TODO */; + } + export class PrintTaskConfiguration implements Windows.Devices.Printers.Extensions.IPrintTaskConfiguration { + printerExtensionContext: any; + onsaverequested: any/* TODO */; + } + export interface IPrintNotificationEventDetails { + eventData: string; + printerName: string; + } + export class PrintNotificationEventDetails implements Windows.Devices.Printers.Extensions.IPrintNotificationEventDetails { + eventData: string; + printerName: string; + } + export interface IPrintExtensionContextStatic { + fromDeviceId(deviceId: string): any; + } + export class PrintExtensionContext { + static fromDeviceId(deviceId: string): any; + } + } + } + } +} +declare module Windows { + export module Devices { + export module Sensors { + export interface IAccelerometerStatics { + getDefault(): Windows.Devices.Sensors.Accelerometer; + } + export class Accelerometer implements Windows.Devices.Sensors.IAccelerometer { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.AccelerometerReading; + onreadingchanged: any/* TODO */; + onshaken: any/* TODO */; + static getDefault(): Windows.Devices.Sensors.Accelerometer; + } + export interface IAccelerometer { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.AccelerometerReading; + onreadingchanged: any/* TODO */; + onshaken: any/* TODO */; + } + export class AccelerometerReading implements Windows.Devices.Sensors.IAccelerometerReading { + accelerationX: number; + accelerationY: number; + accelerationZ: number; + timestamp: Date; + } + export class AccelerometerReadingChangedEventArgs implements Windows.Devices.Sensors.IAccelerometerReadingChangedEventArgs { + reading: Windows.Devices.Sensors.AccelerometerReading; + } + export class AccelerometerShakenEventArgs implements Windows.Devices.Sensors.IAccelerometerShakenEventArgs { + timestamp: Date; + } + export interface IAccelerometerReading { + accelerationX: number; + accelerationY: number; + accelerationZ: number; + timestamp: Date; + } + export interface IAccelerometerReadingChangedEventArgs { + reading: Windows.Devices.Sensors.AccelerometerReading; + } + export interface IAccelerometerShakenEventArgs { + timestamp: Date; + } + export interface IInclinometerStatics { + getDefault(): Windows.Devices.Sensors.Inclinometer; + } + export class Inclinometer implements Windows.Devices.Sensors.IInclinometer { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.InclinometerReading; + onreadingchanged: any/* TODO */; + static getDefault(): Windows.Devices.Sensors.Inclinometer; + } + export interface IInclinometer { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.InclinometerReading; + onreadingchanged: any/* TODO */; + } + export class InclinometerReading implements Windows.Devices.Sensors.IInclinometerReading { + pitchDegrees: number; + rollDegrees: number; + timestamp: Date; + yawDegrees: number; + } + export class InclinometerReadingChangedEventArgs implements Windows.Devices.Sensors.IInclinometerReadingChangedEventArgs { + reading: Windows.Devices.Sensors.InclinometerReading; + } + export interface IInclinometerReading { + pitchDegrees: number; + rollDegrees: number; + timestamp: Date; + yawDegrees: number; + } + export interface IInclinometerReadingChangedEventArgs { + reading: Windows.Devices.Sensors.InclinometerReading; + } + export interface IGyrometerStatics { + getDefault(): Windows.Devices.Sensors.Gyrometer; + } + export class Gyrometer implements Windows.Devices.Sensors.IGyrometer { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.GyrometerReading; + onreadingchanged: any/* TODO */; + static getDefault(): Windows.Devices.Sensors.Gyrometer; + } + export interface IGyrometer { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.GyrometerReading; + onreadingchanged: any/* TODO */; + } + export class GyrometerReading implements Windows.Devices.Sensors.IGyrometerReading { + angularVelocityX: number; + angularVelocityY: number; + angularVelocityZ: number; + timestamp: Date; + } + export class GyrometerReadingChangedEventArgs implements Windows.Devices.Sensors.IGyrometerReadingChangedEventArgs { + reading: Windows.Devices.Sensors.GyrometerReading; + } + export interface IGyrometerReading { + angularVelocityX: number; + angularVelocityY: number; + angularVelocityZ: number; + timestamp: Date; + } + export interface IGyrometerReadingChangedEventArgs { + reading: Windows.Devices.Sensors.GyrometerReading; + } + export interface ICompassStatics { + getDefault(): Windows.Devices.Sensors.Compass; + } + export class Compass implements Windows.Devices.Sensors.ICompass { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.CompassReading; + onreadingchanged: any/* TODO */; + static getDefault(): Windows.Devices.Sensors.Compass; + } + export interface ICompass { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.CompassReading; + onreadingchanged: any/* TODO */; + } + export class CompassReading implements Windows.Devices.Sensors.ICompassReading { + headingMagneticNorth: number; + headingTrueNorth: number; + timestamp: Date; + } + export class CompassReadingChangedEventArgs implements Windows.Devices.Sensors.ICompassReadingChangedEventArgs { + reading: Windows.Devices.Sensors.CompassReading; + } + export interface ICompassReading { + headingMagneticNorth: number; + headingTrueNorth: number; + timestamp: Date; + } + export interface ICompassReadingChangedEventArgs { + reading: Windows.Devices.Sensors.CompassReading; + } + export interface ILightSensorStatics { + getDefault(): Windows.Devices.Sensors.LightSensor; + } + export class LightSensor implements Windows.Devices.Sensors.ILightSensor { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.LightSensorReading; + onreadingchanged: any/* TODO */; + static getDefault(): Windows.Devices.Sensors.LightSensor; + } + export interface ILightSensor { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.LightSensorReading; + onreadingchanged: any/* TODO */; + } + export class LightSensorReading implements Windows.Devices.Sensors.ILightSensorReading { + illuminanceInLux: number; + timestamp: Date; + } + export class LightSensorReadingChangedEventArgs implements Windows.Devices.Sensors.ILightSensorReadingChangedEventArgs { + reading: Windows.Devices.Sensors.LightSensorReading; + } + export interface ILightSensorReading { + illuminanceInLux: number; + timestamp: Date; + } + export interface ILightSensorReadingChangedEventArgs { + reading: Windows.Devices.Sensors.LightSensorReading; + } + export interface ISensorRotationMatrix { + m11: number; + m12: number; + m13: number; + m21: number; + m22: number; + m23: number; + m31: number; + m32: number; + m33: number; + } + export interface ISensorQuaternion { + w: number; + x: number; + y: number; + z: number; + } + export class SensorRotationMatrix implements Windows.Devices.Sensors.ISensorRotationMatrix { + m11: number; + m12: number; + m13: number; + m21: number; + m22: number; + m23: number; + m31: number; + m32: number; + m33: number; + } + export class SensorQuaternion implements Windows.Devices.Sensors.ISensorQuaternion { + w: number; + x: number; + y: number; + z: number; + } + export interface IOrientationSensorStatics { + getDefault(): Windows.Devices.Sensors.OrientationSensor; + } + export class OrientationSensor implements Windows.Devices.Sensors.IOrientationSensor { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.OrientationSensorReading; + onreadingchanged: any/* TODO */; + static getDefault(): Windows.Devices.Sensors.OrientationSensor; + } + export interface IOrientationSensor { + minimumReportInterval: number; + reportInterval: number; + getCurrentReading(): Windows.Devices.Sensors.OrientationSensorReading; + onreadingchanged: any/* TODO */; + } + export class OrientationSensorReading implements Windows.Devices.Sensors.IOrientationSensorReading { + quaternion: Windows.Devices.Sensors.SensorQuaternion; + rotationMatrix: Windows.Devices.Sensors.SensorRotationMatrix; + timestamp: Date; + } + export class OrientationSensorReadingChangedEventArgs implements Windows.Devices.Sensors.IOrientationSensorReadingChangedEventArgs { + reading: Windows.Devices.Sensors.OrientationSensorReading; + } + export interface IOrientationSensorReading { + quaternion: Windows.Devices.Sensors.SensorQuaternion; + rotationMatrix: Windows.Devices.Sensors.SensorRotationMatrix; + timestamp: Date; + } + export interface IOrientationSensorReadingChangedEventArgs { + reading: Windows.Devices.Sensors.OrientationSensorReading; + } + export enum SimpleOrientation { + notRotated, + rotated90DegreesCounterclockwise, + rotated180DegreesCounterclockwise, + rotated270DegreesCounterclockwise, + faceup, + facedown, + } + export interface ISimpleOrientationSensorStatics { + getDefault(): Windows.Devices.Sensors.SimpleOrientationSensor; + } + export class SimpleOrientationSensor implements Windows.Devices.Sensors.ISimpleOrientationSensor { + getCurrentOrientation(): Windows.Devices.Sensors.SimpleOrientation; + onorientationchanged: any/* TODO */; + static getDefault(): Windows.Devices.Sensors.SimpleOrientationSensor; + } + export interface ISimpleOrientationSensor { + getCurrentOrientation(): Windows.Devices.Sensors.SimpleOrientation; + onorientationchanged: any/* TODO */; + } + export class SimpleOrientationSensorOrientationChangedEventArgs implements Windows.Devices.Sensors.ISimpleOrientationSensorOrientationChangedEventArgs { + orientation: Windows.Devices.Sensors.SimpleOrientation; + timestamp: Date; + } + export interface ISimpleOrientationSensorOrientationChangedEventArgs { + orientation: Windows.Devices.Sensors.SimpleOrientation; + timestamp: Date; + } + } + } +} +declare module Windows { + export module Globalization { + export module Fonts { + export interface ILanguageFontGroup { + documentAlternate1Font: Windows.Globalization.Fonts.LanguageFont; + documentAlternate2Font: Windows.Globalization.Fonts.LanguageFont; + documentHeadingFont: Windows.Globalization.Fonts.LanguageFont; + fixedWidthTextFont: Windows.Globalization.Fonts.LanguageFont; + modernDocumentFont: Windows.Globalization.Fonts.LanguageFont; + traditionalDocumentFont: Windows.Globalization.Fonts.LanguageFont; + uICaptionFont: Windows.Globalization.Fonts.LanguageFont; + uIHeadingFont: Windows.Globalization.Fonts.LanguageFont; + uINotificationHeadingFont: Windows.Globalization.Fonts.LanguageFont; + uITextFont: Windows.Globalization.Fonts.LanguageFont; + uITitleFont: Windows.Globalization.Fonts.LanguageFont; + } + export class LanguageFont implements Windows.Globalization.Fonts.ILanguageFont { + fontFamily: string; + fontStretch: Windows.UI.Text.FontStretch; + fontStyle: Windows.UI.Text.FontStyle; + fontWeight: Windows.UI.Text.FontWeight; + scaleFactor: number; + } + export interface ILanguageFontGroupFactory { + createLanguageFontGroup(languageTag: string): Windows.Globalization.Fonts.LanguageFontGroup; + } + export class LanguageFontGroup implements Windows.Globalization.Fonts.ILanguageFontGroup { + constructor(languageTag: string); + documentAlternate1Font: Windows.Globalization.Fonts.LanguageFont; + documentAlternate2Font: Windows.Globalization.Fonts.LanguageFont; + documentHeadingFont: Windows.Globalization.Fonts.LanguageFont; + fixedWidthTextFont: Windows.Globalization.Fonts.LanguageFont; + modernDocumentFont: Windows.Globalization.Fonts.LanguageFont; + traditionalDocumentFont: Windows.Globalization.Fonts.LanguageFont; + uICaptionFont: Windows.Globalization.Fonts.LanguageFont; + uIHeadingFont: Windows.Globalization.Fonts.LanguageFont; + uINotificationHeadingFont: Windows.Globalization.Fonts.LanguageFont; + uITextFont: Windows.Globalization.Fonts.LanguageFont; + uITitleFont: Windows.Globalization.Fonts.LanguageFont; + } + export interface ILanguageFont { + fontFamily: string; + fontStretch: Windows.UI.Text.FontStretch; + fontStyle: Windows.UI.Text.FontStyle; + fontWeight: Windows.UI.Text.FontWeight; + scaleFactor: number; + } + } + } +} +declare module Windows { + export module Globalization { + export enum DayOfWeek { + sunday, + monday, + tuesday, + wednesday, + thursday, + friday, + saturday, + } + export interface ICalendarIdentifiersStatics { + gregorian: string; + hebrew: string; + hijri: string; + japanese: string; + julian: string; + korean: string; + taiwan: string; + thai: string; + umAlQura: string; + } + export class CalendarIdentifiers { + static gregorian: string; + static hebrew: string; + static hijri: string; + static japanese: string; + static julian: string; + static korean: string; + static taiwan: string; + static thai: string; + static umAlQura: string; + } + export interface IClockIdentifiersStatics { + twelveHour: string; + twentyFourHour: string; + } + export class ClockIdentifiers { + static twelveHour: string; + static twentyFourHour: string; + } + export interface IGeographicRegion { + code: string; + codeThreeDigit: string; + codeThreeLetter: string; + codeTwoLetter: string; + currenciesInUse: Windows.Foundation.Collections.IVectorView; + displayName: string; + nativeName: string; + } + export interface IGeographicRegionFactory { + createGeographicRegion(geographicRegionCode: string): Windows.Globalization.GeographicRegion; + } + export class GeographicRegion implements Windows.Globalization.IGeographicRegion { + constructor(geographicRegionCode: string); + constructor(); + code: string; + codeThreeDigit: string; + codeThreeLetter: string; + codeTwoLetter: string; + currenciesInUse: Windows.Foundation.Collections.IVectorView; + displayName: string; + nativeName: string; + static isSupported(geographicRegionCode: string): boolean; + } + export interface IGeographicRegionStatics { + isSupported(geographicRegionCode: string): boolean; + } + export interface ILanguage { + displayName: string; + languageTag: string; + nativeName: string; + script: string; + } + export interface ILanguageFactory { + createLanguage(languageTag: string): Windows.Globalization.Language; + } + export class Language implements Windows.Globalization.ILanguage { + constructor(languageTag: string); + displayName: string; + languageTag: string; + nativeName: string; + script: string; + static currentInputMethodLanguageTag: string; + static isWellFormed(languageTag: string): boolean; + } + export interface ILanguageStatics { + currentInputMethodLanguageTag: string; + isWellFormed(languageTag: string): boolean; + } + export interface ICalendar { + day: number; + dayOfWeek: Windows.Globalization.DayOfWeek; + era: number; + firstDayInThisMonth: number; + firstEra: number; + firstHourInThisPeriod: number; + firstMinuteInThisHour: number; + firstMonthInThisYear: number; + firstPeriodInThisDay: number; + firstSecondInThisMinute: number; + firstYearInThisEra: number; + hour: number; + isDaylightSavingTime: boolean; + languages: Windows.Foundation.Collections.IVectorView; + lastDayInThisMonth: number; + lastEra: number; + lastHourInThisPeriod: number; + lastMinuteInThisHour: number; + lastMonthInThisYear: number; + lastPeriodInThisDay: number; + lastSecondInThisMinute: number; + lastYearInThisEra: number; + minute: number; + month: number; + nanosecond: number; + numberOfDaysInThisMonth: number; + numberOfEras: number; + numberOfHoursInThisPeriod: number; + numberOfMinutesInThisHour: number; + numberOfMonthsInThisYear: number; + numberOfPeriodsInThisDay: number; + numberOfSecondsInThisMinute: number; + numberOfYearsInThisEra: number; + numeralSystem: string; + period: number; + resolvedLanguage: string; + second: number; + year: number; + clone(): Windows.Globalization.Calendar; + setToMin(): void; + setToMax(): void; + getCalendarSystem(): string; + changeCalendarSystem(value: string): void; + getClock(): string; + changeClock(value: string): void; + getDateTime(): Date; + setDateTime(value: Date): void; + setToNow(): void; + addEras(eras: number): void; + eraAsString(): string; + eraAsString(idealLength: number): string; + addYears(years: number): void; + yearAsString(): string; + yearAsTruncatedString(remainingDigits: number): string; + yearAsPaddedString(minDigits: number): string; + addMonths(months: number): void; + monthAsString(): string; + monthAsString(idealLength: number): string; + monthAsSoloString(): string; + monthAsSoloString(idealLength: number): string; + monthAsNumericString(): string; + monthAsPaddedNumericString(minDigits: number): string; + addWeeks(weeks: number): void; + addDays(days: number): void; + dayAsString(): string; + dayAsPaddedString(minDigits: number): string; + dayOfWeekAsString(): string; + dayOfWeekAsString(idealLength: number): string; + dayOfWeekAsSoloString(): string; + dayOfWeekAsSoloString(idealLength: number): string; + addPeriods(periods: number): void; + periodAsString(): string; + periodAsString(idealLength: number): string; + addHours(hours: number): void; + hourAsString(): string; + hourAsPaddedString(minDigits: number): string; + addMinutes(minutes: number): void; + minuteAsString(): string; + minuteAsPaddedString(minDigits: number): string; + addSeconds(seconds: number): void; + secondAsString(): string; + secondAsPaddedString(minDigits: number): string; + addNanoseconds(nanoseconds: number): void; + nanosecondAsString(): string; + nanosecondAsPaddedString(minDigits: number): string; + compare(other: Windows.Globalization.Calendar): number; + compareDateTime(other: Date): number; + copyTo(other: Windows.Globalization.Calendar): void; + } + export class Calendar implements Windows.Globalization.ICalendar { + constructor(languages: Windows.Foundation.Collections.IIterable); + constructor(languages: Windows.Foundation.Collections.IIterable, calendar: string, clock: string); + constructor(); + day: number; + dayOfWeek: Windows.Globalization.DayOfWeek; + era: number; + firstDayInThisMonth: number; + firstEra: number; + firstHourInThisPeriod: number; + firstMinuteInThisHour: number; + firstMonthInThisYear: number; + firstPeriodInThisDay: number; + firstSecondInThisMinute: number; + firstYearInThisEra: number; + hour: number; + isDaylightSavingTime: boolean; + languages: Windows.Foundation.Collections.IVectorView; + lastDayInThisMonth: number; + lastEra: number; + lastHourInThisPeriod: number; + lastMinuteInThisHour: number; + lastMonthInThisYear: number; + lastPeriodInThisDay: number; + lastSecondInThisMinute: number; + lastYearInThisEra: number; + minute: number; + month: number; + nanosecond: number; + numberOfDaysInThisMonth: number; + numberOfEras: number; + numberOfHoursInThisPeriod: number; + numberOfMinutesInThisHour: number; + numberOfMonthsInThisYear: number; + numberOfPeriodsInThisDay: number; + numberOfSecondsInThisMinute: number; + numberOfYearsInThisEra: number; + numeralSystem: string; + period: number; + resolvedLanguage: string; + second: number; + year: number; + clone(): Windows.Globalization.Calendar; + setToMin(): void; + setToMax(): void; + getCalendarSystem(): string; + changeCalendarSystem(value: string): void; + getClock(): string; + changeClock(value: string): void; + getDateTime(): Date; + setDateTime(value: Date): void; + setToNow(): void; + addEras(eras: number): void; + eraAsString(): string; + eraAsString(idealLength: number): string; + addYears(years: number): void; + yearAsString(): string; + yearAsTruncatedString(remainingDigits: number): string; + yearAsPaddedString(minDigits: number): string; + addMonths(months: number): void; + monthAsString(): string; + monthAsString(idealLength: number): string; + monthAsSoloString(): string; + monthAsSoloString(idealLength: number): string; + monthAsNumericString(): string; + monthAsPaddedNumericString(minDigits: number): string; + addWeeks(weeks: number): void; + addDays(days: number): void; + dayAsString(): string; + dayAsPaddedString(minDigits: number): string; + dayOfWeekAsString(): string; + dayOfWeekAsString(idealLength: number): string; + dayOfWeekAsSoloString(): string; + dayOfWeekAsSoloString(idealLength: number): string; + addPeriods(periods: number): void; + periodAsString(): string; + periodAsString(idealLength: number): string; + addHours(hours: number): void; + hourAsString(): string; + hourAsPaddedString(minDigits: number): string; + addMinutes(minutes: number): void; + minuteAsString(): string; + minuteAsPaddedString(minDigits: number): string; + addSeconds(seconds: number): void; + secondAsString(): string; + secondAsPaddedString(minDigits: number): string; + addNanoseconds(nanoseconds: number): void; + nanosecondAsString(): string; + nanosecondAsPaddedString(minDigits: number): string; + compare(other: Windows.Globalization.Calendar): number; + compareDateTime(other: Date): number; + copyTo(other: Windows.Globalization.Calendar): void; + } + export interface ICalendarFactory { + createCalendarDefaultCalendarAndClock(languages: Windows.Foundation.Collections.IIterable): Windows.Globalization.Calendar; + createCalendar(languages: Windows.Foundation.Collections.IIterable, calendar: string, clock: string): Windows.Globalization.Calendar; + } + export interface IApplicationLanguagesStatics { + languages: Windows.Foundation.Collections.IVectorView; + manifestLanguages: Windows.Foundation.Collections.IVectorView; + primaryLanguageOverride: string; + } + export class ApplicationLanguages { + static languages: Windows.Foundation.Collections.IVectorView; + static manifestLanguages: Windows.Foundation.Collections.IVectorView; + static primaryLanguageOverride: string; + } + } +} +declare module Windows { + export module Globalization { + export module DateTimeFormatting { + export enum YearFormat { + none, + default, + abbreviated, + full, + } + export enum MonthFormat { + none, + default, + abbreviated, + full, + numeric, + } + export enum DayOfWeekFormat { + none, + default, + abbreviated, + full, + } + export enum DayFormat { + none, + default, + } + export enum HourFormat { + none, + default, + } + export enum MinuteFormat { + none, + default, + } + export enum SecondFormat { + none, + default, + } + export interface IDateTimeFormatter { + calendar: string; + clock: string; + geographicRegion: string; + includeDay: Windows.Globalization.DateTimeFormatting.DayFormat; + includeDayOfWeek: Windows.Globalization.DateTimeFormatting.DayOfWeekFormat; + includeHour: Windows.Globalization.DateTimeFormatting.HourFormat; + includeMinute: Windows.Globalization.DateTimeFormatting.MinuteFormat; + includeMonth: Windows.Globalization.DateTimeFormatting.MonthFormat; + includeSecond: Windows.Globalization.DateTimeFormatting.SecondFormat; + includeYear: Windows.Globalization.DateTimeFormatting.YearFormat; + languages: Windows.Foundation.Collections.IVectorView; + numeralSystem: string; + patterns: Windows.Foundation.Collections.IVectorView; + resolvedGeographicRegion: string; + resolvedLanguage: string; + template: string; + format(value: Date): string; + } + export interface IDateTimeFormatterFactory { + createDateTimeFormatter(formatTemplate: string): Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + createDateTimeFormatterLanguages(formatTemplate: string, languages: Windows.Foundation.Collections.IIterable): Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + createDateTimeFormatterContext(formatTemplate: string, languages: Windows.Foundation.Collections.IIterable, geographicRegion: string, calendar: string, clock: string): Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + createDateTimeFormatterDate(yearFormat: Windows.Globalization.DateTimeFormatting.YearFormat, monthFormat: Windows.Globalization.DateTimeFormatting.MonthFormat, dayFormat: Windows.Globalization.DateTimeFormatting.DayFormat, dayOfWeekFormat: Windows.Globalization.DateTimeFormatting.DayOfWeekFormat): Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + createDateTimeFormatterTime(hourFormat: Windows.Globalization.DateTimeFormatting.HourFormat, minuteFormat: Windows.Globalization.DateTimeFormatting.MinuteFormat, secondFormat: Windows.Globalization.DateTimeFormatting.SecondFormat): Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + createDateTimeFormatterDateTimeLanguages(yearFormat: Windows.Globalization.DateTimeFormatting.YearFormat, monthFormat: Windows.Globalization.DateTimeFormatting.MonthFormat, dayFormat: Windows.Globalization.DateTimeFormatting.DayFormat, dayOfWeekFormat: Windows.Globalization.DateTimeFormatting.DayOfWeekFormat, hourFormat: Windows.Globalization.DateTimeFormatting.HourFormat, minuteFormat: Windows.Globalization.DateTimeFormatting.MinuteFormat, secondFormat: Windows.Globalization.DateTimeFormatting.SecondFormat, languages: Windows.Foundation.Collections.IIterable): Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + createDateTimeFormatterDateTimeContext(yearFormat: Windows.Globalization.DateTimeFormatting.YearFormat, monthFormat: Windows.Globalization.DateTimeFormatting.MonthFormat, dayFormat: Windows.Globalization.DateTimeFormatting.DayFormat, dayOfWeekFormat: Windows.Globalization.DateTimeFormatting.DayOfWeekFormat, hourFormat: Windows.Globalization.DateTimeFormatting.HourFormat, minuteFormat: Windows.Globalization.DateTimeFormatting.MinuteFormat, secondFormat: Windows.Globalization.DateTimeFormatting.SecondFormat, languages: Windows.Foundation.Collections.IIterable, geographicRegion: string, calendar: string, clock: string): Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + } + export class DateTimeFormatter implements Windows.Globalization.DateTimeFormatting.IDateTimeFormatter { + constructor(formatTemplate: string); + constructor(formatTemplate: string, languages: Windows.Foundation.Collections.IIterable); + constructor(formatTemplate: string, languages: Windows.Foundation.Collections.IIterable, geographicRegion: string, calendar: string, clock: string); + constructor(yearFormat: Windows.Globalization.DateTimeFormatting.YearFormat, monthFormat: Windows.Globalization.DateTimeFormatting.MonthFormat, dayFormat: Windows.Globalization.DateTimeFormatting.DayFormat, dayOfWeekFormat: Windows.Globalization.DateTimeFormatting.DayOfWeekFormat); + constructor(hourFormat: Windows.Globalization.DateTimeFormatting.HourFormat, minuteFormat: Windows.Globalization.DateTimeFormatting.MinuteFormat, secondFormat: Windows.Globalization.DateTimeFormatting.SecondFormat); + constructor(yearFormat: Windows.Globalization.DateTimeFormatting.YearFormat, monthFormat: Windows.Globalization.DateTimeFormatting.MonthFormat, dayFormat: Windows.Globalization.DateTimeFormatting.DayFormat, dayOfWeekFormat: Windows.Globalization.DateTimeFormatting.DayOfWeekFormat, hourFormat: Windows.Globalization.DateTimeFormatting.HourFormat, minuteFormat: Windows.Globalization.DateTimeFormatting.MinuteFormat, secondFormat: Windows.Globalization.DateTimeFormatting.SecondFormat, languages: Windows.Foundation.Collections.IIterable); + constructor(yearFormat: Windows.Globalization.DateTimeFormatting.YearFormat, monthFormat: Windows.Globalization.DateTimeFormatting.MonthFormat, dayFormat: Windows.Globalization.DateTimeFormatting.DayFormat, dayOfWeekFormat: Windows.Globalization.DateTimeFormatting.DayOfWeekFormat, hourFormat: Windows.Globalization.DateTimeFormatting.HourFormat, minuteFormat: Windows.Globalization.DateTimeFormatting.MinuteFormat, secondFormat: Windows.Globalization.DateTimeFormatting.SecondFormat, languages: Windows.Foundation.Collections.IIterable, geographicRegion: string, calendar: string, clock: string); + calendar: string; + clock: string; + geographicRegion: string; + includeDay: Windows.Globalization.DateTimeFormatting.DayFormat; + includeDayOfWeek: Windows.Globalization.DateTimeFormatting.DayOfWeekFormat; + includeHour: Windows.Globalization.DateTimeFormatting.HourFormat; + includeMinute: Windows.Globalization.DateTimeFormatting.MinuteFormat; + includeMonth: Windows.Globalization.DateTimeFormatting.MonthFormat; + includeSecond: Windows.Globalization.DateTimeFormatting.SecondFormat; + includeYear: Windows.Globalization.DateTimeFormatting.YearFormat; + languages: Windows.Foundation.Collections.IVectorView; + numeralSystem: string; + patterns: Windows.Foundation.Collections.IVectorView; + resolvedGeographicRegion: string; + resolvedLanguage: string; + template: string; + format(value: Date): string; + static longDate: Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + static longTime: Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + static shortDate: Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + static shortTime: Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + } + export interface IDateTimeFormatterStatics { + longDate: Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + longTime: Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + shortDate: Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + shortTime: Windows.Globalization.DateTimeFormatting.DateTimeFormatter; + } + } + } +} +declare module Windows { + export module Globalization { + export module NumberFormatting { + export interface INumberFormatter { + format(value: number): string; + } + export interface INumberFormatter2 { + formatInt(value: number): string; + formatUInt(value: number): string; + formatDouble(value: number): string; + } + export interface INumberParser { + parseInt(text: string): number; + parseUInt(text: string): number; + parseDouble(text: string): number; + } + export interface INumberFormatterOptions { + fractionDigits: number; + geographicRegion: string; + integerDigits: number; + isDecimalPointAlwaysDisplayed: boolean; + isGrouped: boolean; + languages: Windows.Foundation.Collections.IVectorView; + numeralSystem: string; + resolvedGeographicRegion: string; + resolvedLanguage: string; + } + export interface IDecimalFormatterFactory { + createDecimalFormatter(languages: Windows.Foundation.Collections.IIterable, geographicRegion: string): Windows.Globalization.NumberFormatting.DecimalFormatter; + } + export class DecimalFormatter implements Windows.Globalization.NumberFormatting.INumberFormatterOptions, Windows.Globalization.NumberFormatting.INumberFormatter, Windows.Globalization.NumberFormatting.INumberFormatter2, Windows.Globalization.NumberFormatting.INumberParser { + constructor(languages: Windows.Foundation.Collections.IIterable, geographicRegion: string); + constructor(); + fractionDigits: number; + geographicRegion: string; + integerDigits: number; + isDecimalPointAlwaysDisplayed: boolean; + isGrouped: boolean; + languages: Windows.Foundation.Collections.IVectorView; + numeralSystem: string; + resolvedGeographicRegion: string; + resolvedLanguage: string; + format(value: number): string; + formatInt(value: number): string; + formatUInt(value: number): string; + formatDouble(value: number): string; + parseInt(text: string): number; + parseUInt(text: string): number; + parseDouble(text: string): number; + } + export interface IPercentFormatterFactory { + createPercentFormatter(languages: Windows.Foundation.Collections.IIterable, geographicRegion: string): Windows.Globalization.NumberFormatting.PercentFormatter; + } + export class PercentFormatter implements Windows.Globalization.NumberFormatting.INumberFormatterOptions, Windows.Globalization.NumberFormatting.INumberFormatter, Windows.Globalization.NumberFormatting.INumberFormatter2, Windows.Globalization.NumberFormatting.INumberParser { + constructor(languages: Windows.Foundation.Collections.IIterable, geographicRegion: string); + constructor(); + fractionDigits: number; + geographicRegion: string; + integerDigits: number; + isDecimalPointAlwaysDisplayed: boolean; + isGrouped: boolean; + languages: Windows.Foundation.Collections.IVectorView; + numeralSystem: string; + resolvedGeographicRegion: string; + resolvedLanguage: string; + format(value: number): string; + formatInt(value: number): string; + formatUInt(value: number): string; + formatDouble(value: number): string; + parseInt(text: string): number; + parseUInt(text: string): number; + parseDouble(text: string): number; + } + export interface IPermilleFormatterFactory { + createPermilleFormatter(languages: Windows.Foundation.Collections.IIterable, geographicRegion: string): Windows.Globalization.NumberFormatting.PermilleFormatter; + } + export class PermilleFormatter implements Windows.Globalization.NumberFormatting.INumberFormatterOptions, Windows.Globalization.NumberFormatting.INumberFormatter, Windows.Globalization.NumberFormatting.INumberFormatter2, Windows.Globalization.NumberFormatting.INumberParser { + constructor(languages: Windows.Foundation.Collections.IIterable, geographicRegion: string); + constructor(); + fractionDigits: number; + geographicRegion: string; + integerDigits: number; + isDecimalPointAlwaysDisplayed: boolean; + isGrouped: boolean; + languages: Windows.Foundation.Collections.IVectorView; + numeralSystem: string; + resolvedGeographicRegion: string; + resolvedLanguage: string; + format(value: number): string; + formatInt(value: number): string; + formatUInt(value: number): string; + formatDouble(value: number): string; + parseInt(text: string): number; + parseUInt(text: string): number; + parseDouble(text: string): number; + } + export interface ICurrencyFormatterFactory { + createCurrencyFormatterCode(currencyCode: string): Windows.Globalization.NumberFormatting.CurrencyFormatter; + createCurrencyFormatterCodeContext(currencyCode: string, languages: Windows.Foundation.Collections.IIterable, geographicRegion: string): Windows.Globalization.NumberFormatting.CurrencyFormatter; + } + export class CurrencyFormatter implements Windows.Globalization.NumberFormatting.ICurrencyFormatter, Windows.Globalization.NumberFormatting.INumberFormatterOptions, Windows.Globalization.NumberFormatting.INumberFormatter, Windows.Globalization.NumberFormatting.INumberFormatter2, Windows.Globalization.NumberFormatting.INumberParser { + constructor(currencyCode: string); + constructor(currencyCode: string, languages: Windows.Foundation.Collections.IIterable, geographicRegion: string); + currency: string; + fractionDigits: number; + geographicRegion: string; + integerDigits: number; + isDecimalPointAlwaysDisplayed: boolean; + isGrouped: boolean; + languages: Windows.Foundation.Collections.IVectorView; + numeralSystem: string; + resolvedGeographicRegion: string; + resolvedLanguage: string; + format(value: number): string; + formatInt(value: number): string; + formatUInt(value: number): string; + formatDouble(value: number): string; + parseInt(text: string): number; + parseUInt(text: string): number; + parseDouble(text: string): number; + } + export interface ICurrencyFormatter extends Windows.Globalization.NumberFormatting.INumberFormatterOptions, Windows.Globalization.NumberFormatting.INumberFormatter, Windows.Globalization.NumberFormatting.INumberFormatter2, Windows.Globalization.NumberFormatting.INumberParser { + currency: string; + } + } + } +} +declare module Windows { + export module Globalization { + export module Collation { + export interface ICharacterGrouping { + first: string; + label: string; + } + export class CharacterGrouping implements Windows.Globalization.Collation.ICharacterGrouping { + first: string; + label: string; + } + export interface ICharacterGroupings extends Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + lookup(text: string): string; + } + export class CharacterGroupings implements Windows.Globalization.Collation.ICharacterGroupings, Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + size: number; + lookup(text: string): string; + getAt(index: number): Windows.Globalization.Collation.CharacterGrouping; + indexOf(value: Windows.Globalization.Collation.CharacterGrouping): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: Windows.Globalization.Collation.CharacterGrouping[]; returnValue: number; }; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.Globalization.Collation.CharacterGrouping[][]): Windows.Globalization.Collation.CharacterGrouping[]; + join(seperator: string): string; + pop(): Windows.Globalization.Collation.CharacterGrouping; + push(...items: Windows.Globalization.Collation.CharacterGrouping[]): void; + reverse(): Windows.Globalization.Collation.CharacterGrouping[]; + shift(): Windows.Globalization.Collation.CharacterGrouping; + slice(start: number): Windows.Globalization.Collation.CharacterGrouping[]; + slice(start: number, end: number): Windows.Globalization.Collation.CharacterGrouping[]; + sort(): Windows.Globalization.Collation.CharacterGrouping[]; + sort(compareFn: (a: Windows.Globalization.Collation.CharacterGrouping, b: Windows.Globalization.Collation.CharacterGrouping) => number): Windows.Globalization.Collation.CharacterGrouping[]; + splice(start: number): Windows.Globalization.Collation.CharacterGrouping[]; + splice(start: number, deleteCount: number, ...items: Windows.Globalization.Collation.CharacterGrouping[]): Windows.Globalization.Collation.CharacterGrouping[]; + unshift(...items: Windows.Globalization.Collation.CharacterGrouping[]): number; + lastIndexOf(searchElement: Windows.Globalization.Collation.CharacterGrouping): number; + lastIndexOf(searchElement: Windows.Globalization.Collation.CharacterGrouping, fromIndex: number): number; + every(callbackfn: (value: Windows.Globalization.Collation.CharacterGrouping, index: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => boolean): boolean; + every(callbackfn: (value: Windows.Globalization.Collation.CharacterGrouping, index: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.Globalization.Collation.CharacterGrouping, index: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => boolean): boolean; + some(callbackfn: (value: Windows.Globalization.Collation.CharacterGrouping, index: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.Globalization.Collation.CharacterGrouping, index: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => void ): void; + forEach(callbackfn: (value: Windows.Globalization.Collation.CharacterGrouping, index: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.Globalization.Collation.CharacterGrouping, index: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => any): any[]; + map(callbackfn: (value: Windows.Globalization.Collation.CharacterGrouping, index: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.Globalization.Collation.CharacterGrouping, index: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => boolean): Windows.Globalization.Collation.CharacterGrouping[]; + filter(callbackfn: (value: Windows.Globalization.Collation.CharacterGrouping, index: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => boolean, thisArg: any): Windows.Globalization.Collation.CharacterGrouping[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Globalization.Collation.CharacterGrouping[]) => any, initialValue: any): any; + length: number; + } + } + } +} +declare module Windows { + export module Graphics { + export module Display { + export interface DisplayPropertiesEventHandler { + (sender: any): void; + } + export enum DisplayOrientations { + none, + landscape, + portrait, + landscapeFlipped, + portraitFlipped, + } + export enum ResolutionScale { + invalid, + scale100Percent, + scale140Percent, + scale180Percent, + } + export interface IDisplayPropertiesStatics { + autoRotationPreferences: Windows.Graphics.Display.DisplayOrientations; + currentOrientation: Windows.Graphics.Display.DisplayOrientations; + logicalDpi: number; + nativeOrientation: Windows.Graphics.Display.DisplayOrientations; + resolutionScale: Windows.Graphics.Display.ResolutionScale; + stereoEnabled: boolean; + onorientationchanged: any/* TODO */; + onlogicaldpichanged: any/* TODO */; + onstereoenabledchanged: any/* TODO */; + getColorProfileAsync(): Windows.Foundation.IAsyncOperation; + oncolorprofilechanged: any/* TODO */; + ondisplaycontentsinvalidated: any/* TODO */; + } + export class DisplayProperties { + static autoRotationPreferences: Windows.Graphics.Display.DisplayOrientations; + static currentOrientation: Windows.Graphics.Display.DisplayOrientations; + static logicalDpi: number; + static nativeOrientation: Windows.Graphics.Display.DisplayOrientations; + static resolutionScale: Windows.Graphics.Display.ResolutionScale; + static stereoEnabled: boolean; + static onorientationchanged: any/* TODO */; + static onlogicaldpichanged: any/* TODO */; + static onstereoenabledchanged: any/* TODO */; + static getColorProfileAsync(): Windows.Foundation.IAsyncOperation; + static oncolorprofilechanged: any/* TODO */; + static ondisplaycontentsinvalidated: any/* TODO */; + } + } + } +} +declare module Windows { + export module Graphics { + export module Imaging { + export enum BitmapPixelFormat { + unknown, + rgba16, + rgba8, + bgra8, + } + export enum BitmapAlphaMode { + premultiplied, + straight, + ignore, + } + export enum BitmapInterpolationMode { + nearestNeighbor, + linear, + cubic, + fant, + } + export enum BitmapFlip { + none, + horizontal, + vertical, + } + export enum BitmapRotation { + none, + clockwise90Degrees, + clockwise180Degrees, + clockwise270Degrees, + } + export interface BitmapBounds { + x: number; + y: number; + width: number; + height: number; + } + export enum ColorManagementMode { + doNotColorManage, + colorManageToSRgb, + } + export enum ExifOrientationMode { + ignoreExifOrientation, + respectExifOrientation, + } + export enum PngFilterMode { + automatic, + none, + sub, + up, + average, + paeth, + adaptive, + } + export enum TiffCompressionMode { + automatic, + none, + ccitt3, + ccitt4, + lzw, + rle, + zip, + lzwhDifferencing, + } + export enum JpegSubsamplingMode { + default, + y4Cb2Cr0, + y4Cb2Cr2, + y4Cb4Cr4, + } + export interface IBitmapTransform { + bounds: Windows.Graphics.Imaging.BitmapBounds; + flip: Windows.Graphics.Imaging.BitmapFlip; + interpolationMode: Windows.Graphics.Imaging.BitmapInterpolationMode; + rotation: Windows.Graphics.Imaging.BitmapRotation; + scaledHeight: number; + scaledWidth: number; + } + export class BitmapTransform implements Windows.Graphics.Imaging.IBitmapTransform { + bounds: Windows.Graphics.Imaging.BitmapBounds; + flip: Windows.Graphics.Imaging.BitmapFlip; + interpolationMode: Windows.Graphics.Imaging.BitmapInterpolationMode; + rotation: Windows.Graphics.Imaging.BitmapRotation; + scaledHeight: number; + scaledWidth: number; + } + export interface IBitmapTypedValue { + type: Windows.Foundation.PropertyType; + value: any; + } + export interface IBitmapTypedValueFactory { + create(value: any, type: Windows.Foundation.PropertyType): Windows.Graphics.Imaging.BitmapTypedValue; + } + export class BitmapTypedValue implements Windows.Graphics.Imaging.IBitmapTypedValue { + constructor(value: any, type: Windows.Foundation.PropertyType); + type: Windows.Foundation.PropertyType; + value: any; + } + export class BitmapPropertySet implements Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + size: number; + lookup(key: string): Windows.Graphics.Imaging.BitmapTypedValue; + hasKey(key: string): boolean; + getView(): Windows.Foundation.Collections.IMapView; + insert(key: string, value: Windows.Graphics.Imaging.BitmapTypedValue): boolean; + remove(key: string): void; + clear(): void; + first(): Windows.Foundation.Collections.IIterator>; + } + export interface IBitmapPropertiesView { + getPropertiesAsync(propertiesToRetrieve: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + } + export interface IBitmapProperties extends Windows.Graphics.Imaging.IBitmapPropertiesView { + setPropertiesAsync(propertiesToSet: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + } + export class BitmapPropertiesView implements Windows.Graphics.Imaging.IBitmapPropertiesView { + getPropertiesAsync(propertiesToRetrieve: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + } + export class BitmapProperties implements Windows.Graphics.Imaging.IBitmapProperties, Windows.Graphics.Imaging.IBitmapPropertiesView { + setPropertiesAsync(propertiesToSet: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + getPropertiesAsync(propertiesToRetrieve: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + } + export interface IPixelDataProvider { + detachPixelData(): Uint8Array; + } + export class PixelDataProvider implements Windows.Graphics.Imaging.IPixelDataProvider { + detachPixelData(): Uint8Array; + } + export class ImageStream implements Windows.Storage.Streams.IRandomAccessStreamWithContentType, Windows.Storage.Streams.IRandomAccessStream, Windows.Foundation.IClosable, Windows.Storage.Streams.IInputStream, Windows.Storage.Streams.IOutputStream, Windows.Storage.Streams.IContentTypeProvider { + canRead: boolean; + canWrite: boolean; + position: number; + size: number; + contentType: string; + getInputStreamAt(position: number): Windows.Storage.Streams.IInputStream; + getOutputStreamAt(position: number): Windows.Storage.Streams.IOutputStream; + seek(position: number): void; + cloneStream(): Windows.Storage.Streams.IRandomAccessStream; + dispose(): void; + readAsync(buffer: Windows.Storage.Streams.IBuffer, count: number, options: Windows.Storage.Streams.InputStreamOptions): Windows.Foundation.IAsyncOperationWithProgress; + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + close(): void; + } + export interface IBitmapFrame { + bitmapAlphaMode: Windows.Graphics.Imaging.BitmapAlphaMode; + bitmapPixelFormat: Windows.Graphics.Imaging.BitmapPixelFormat; + bitmapProperties: Windows.Graphics.Imaging.BitmapPropertiesView; + dpiX: number; + dpiY: number; + orientedPixelHeight: number; + orientedPixelWidth: number; + pixelHeight: number; + pixelWidth: number; + getThumbnailAsync(): Windows.Foundation.IAsyncOperation; + getPixelDataAsync(): Windows.Foundation.IAsyncOperation; + getPixelDataAsync(pixelFormat: Windows.Graphics.Imaging.BitmapPixelFormat, alphaMode: Windows.Graphics.Imaging.BitmapAlphaMode, transform: Windows.Graphics.Imaging.BitmapTransform, exifOrientationMode: Windows.Graphics.Imaging.ExifOrientationMode, colorManagementMode: Windows.Graphics.Imaging.ColorManagementMode): Windows.Foundation.IAsyncOperation; + } + export class BitmapFrame implements Windows.Graphics.Imaging.IBitmapFrame { + bitmapAlphaMode: Windows.Graphics.Imaging.BitmapAlphaMode; + bitmapPixelFormat: Windows.Graphics.Imaging.BitmapPixelFormat; + bitmapProperties: Windows.Graphics.Imaging.BitmapPropertiesView; + dpiX: number; + dpiY: number; + orientedPixelHeight: number; + orientedPixelWidth: number; + pixelHeight: number; + pixelWidth: number; + getThumbnailAsync(): Windows.Foundation.IAsyncOperation; + getPixelDataAsync(): Windows.Foundation.IAsyncOperation; + getPixelDataAsync(pixelFormat: Windows.Graphics.Imaging.BitmapPixelFormat, alphaMode: Windows.Graphics.Imaging.BitmapAlphaMode, transform: Windows.Graphics.Imaging.BitmapTransform, exifOrientationMode: Windows.Graphics.Imaging.ExifOrientationMode, colorManagementMode: Windows.Graphics.Imaging.ColorManagementMode): Windows.Foundation.IAsyncOperation; + } + export interface IBitmapCodecInformation { + codecId: string; + fileExtensions: Windows.Foundation.Collections.IVectorView; + friendlyName: string; + mimeTypes: Windows.Foundation.Collections.IVectorView; + } + export class BitmapCodecInformation implements Windows.Graphics.Imaging.IBitmapCodecInformation { + codecId: string; + fileExtensions: Windows.Foundation.Collections.IVectorView; + friendlyName: string; + mimeTypes: Windows.Foundation.Collections.IVectorView; + } + export interface IBitmapDecoderStatics { + bmpDecoderId: string; + gifDecoderId: string; + icoDecoderId: string; + jpegDecoderId: string; + jpegXRDecoderId: string; + pngDecoderId: string; + tiffDecoderId: string; + getDecoderInformationEnumerator(): Windows.Foundation.Collections.IVectorView; + createAsync(stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + createAsync(decoderId: string, stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + } + export class BitmapDecoder implements Windows.Graphics.Imaging.IBitmapDecoder, Windows.Graphics.Imaging.IBitmapFrame { + bitmapContainerProperties: Windows.Graphics.Imaging.BitmapPropertiesView; + decoderInformation: Windows.Graphics.Imaging.BitmapCodecInformation; + frameCount: number; + bitmapAlphaMode: Windows.Graphics.Imaging.BitmapAlphaMode; + bitmapPixelFormat: Windows.Graphics.Imaging.BitmapPixelFormat; + bitmapProperties: Windows.Graphics.Imaging.BitmapPropertiesView; + dpiX: number; + dpiY: number; + orientedPixelHeight: number; + orientedPixelWidth: number; + pixelHeight: number; + pixelWidth: number; + getPreviewAsync(): Windows.Foundation.IAsyncOperation; + getFrameAsync(frameIndex: number): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(): Windows.Foundation.IAsyncOperation; + getPixelDataAsync(): Windows.Foundation.IAsyncOperation; + getPixelDataAsync(pixelFormat: Windows.Graphics.Imaging.BitmapPixelFormat, alphaMode: Windows.Graphics.Imaging.BitmapAlphaMode, transform: Windows.Graphics.Imaging.BitmapTransform, exifOrientationMode: Windows.Graphics.Imaging.ExifOrientationMode, colorManagementMode: Windows.Graphics.Imaging.ColorManagementMode): Windows.Foundation.IAsyncOperation; + static bmpDecoderId: string; + static gifDecoderId: string; + static icoDecoderId: string; + static jpegDecoderId: string; + static jpegXRDecoderId: string; + static pngDecoderId: string; + static tiffDecoderId: string; + static getDecoderInformationEnumerator(): Windows.Foundation.Collections.IVectorView; + static createAsync(stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + static createAsync(decoderId: string, stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + } + export interface IBitmapDecoder { + bitmapContainerProperties: Windows.Graphics.Imaging.BitmapPropertiesView; + decoderInformation: Windows.Graphics.Imaging.BitmapCodecInformation; + frameCount: number; + getPreviewAsync(): Windows.Foundation.IAsyncOperation; + getFrameAsync(frameIndex: number): Windows.Foundation.IAsyncOperation; + } + export interface IBitmapEncoderStatics { + bmpEncoderId: string; + gifEncoderId: string; + jpegEncoderId: string; + jpegXREncoderId: string; + pngEncoderId: string; + tiffEncoderId: string; + getEncoderInformationEnumerator(): Windows.Foundation.Collections.IVectorView; + createAsync(encoderId: string, stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + createAsync(encoderId: string, stream: Windows.Storage.Streams.IRandomAccessStream, encodingOptions: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncOperation; + createForTranscodingAsync(stream: Windows.Storage.Streams.IRandomAccessStream, bitmapDecoder: Windows.Graphics.Imaging.BitmapDecoder): Windows.Foundation.IAsyncOperation; + createForInPlacePropertyEncodingAsync(bitmapDecoder: Windows.Graphics.Imaging.BitmapDecoder): Windows.Foundation.IAsyncOperation; + } + export class BitmapEncoder implements Windows.Graphics.Imaging.IBitmapEncoder { + bitmapContainerProperties: Windows.Graphics.Imaging.BitmapProperties; + bitmapProperties: Windows.Graphics.Imaging.BitmapProperties; + bitmapTransform: Windows.Graphics.Imaging.BitmapTransform; + encoderInformation: Windows.Graphics.Imaging.BitmapCodecInformation; + generatedThumbnailHeight: number; + generatedThumbnailWidth: number; + isThumbnailGenerated: boolean; + setPixelData(pixelFormat: Windows.Graphics.Imaging.BitmapPixelFormat, alphaMode: Windows.Graphics.Imaging.BitmapAlphaMode, width: number, height: number, dpiX: number, dpiY: number, pixels: Uint8Array): void; + goToNextFrameAsync(): Windows.Foundation.IAsyncAction; + goToNextFrameAsync(encodingOptions: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + flushAsync(): Windows.Foundation.IAsyncAction; + static bmpEncoderId: string; + static gifEncoderId: string; + static jpegEncoderId: string; + static jpegXREncoderId: string; + static pngEncoderId: string; + static tiffEncoderId: string; + static getEncoderInformationEnumerator(): Windows.Foundation.Collections.IVectorView; + static createAsync(encoderId: string, stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + static createAsync(encoderId: string, stream: Windows.Storage.Streams.IRandomAccessStream, encodingOptions: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncOperation; + static createForTranscodingAsync(stream: Windows.Storage.Streams.IRandomAccessStream, bitmapDecoder: Windows.Graphics.Imaging.BitmapDecoder): Windows.Foundation.IAsyncOperation; + static createForInPlacePropertyEncodingAsync(bitmapDecoder: Windows.Graphics.Imaging.BitmapDecoder): Windows.Foundation.IAsyncOperation; + } + export interface IBitmapEncoder { + bitmapContainerProperties: Windows.Graphics.Imaging.BitmapProperties; + bitmapProperties: Windows.Graphics.Imaging.BitmapProperties; + bitmapTransform: Windows.Graphics.Imaging.BitmapTransform; + encoderInformation: Windows.Graphics.Imaging.BitmapCodecInformation; + generatedThumbnailHeight: number; + generatedThumbnailWidth: number; + isThumbnailGenerated: boolean; + setPixelData(pixelFormat: Windows.Graphics.Imaging.BitmapPixelFormat, alphaMode: Windows.Graphics.Imaging.BitmapAlphaMode, width: number, height: number, dpiX: number, dpiY: number, pixels: Uint8Array): void; + goToNextFrameAsync(): Windows.Foundation.IAsyncAction; + goToNextFrameAsync(encodingOptions: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + flushAsync(): Windows.Foundation.IAsyncAction; + } + } + } +} +declare module Windows { + export module Graphics { + export module Printing { + export module OptionDetails { + export enum PrintOptionStates { + none, + enabled, + constrained, + } + export enum PrintOptionType { + unknown, + number, + text, + itemList, + } + export interface IPrintOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + trySetValue(value: any): boolean; + } + export interface IPrintNumberOptionDetails extends Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails { + maxValue: number; + minValue: number; + } + export interface IPrintTextOptionDetails extends Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails { + maxCharacters: number; + } + export interface IPrintItemListOptionDetails extends Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails { + items: Windows.Foundation.Collections.IVectorView; + } + export class PrintCopiesOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintNumberOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + maxValue: number; + minValue: number; + trySetValue(value: any): boolean; + } + export class PrintMediaSizeOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + } + export class PrintMediaTypeOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + } + export class PrintOrientationOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + } + export class PrintQualityOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + } + export class PrintColorModeOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + } + export class PrintDuplexOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + } + export class PrintCollationOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + } + export class PrintStapleOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + } + export class PrintHolePunchOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + } + export class PrintBindingOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + } + export interface IPrintCustomOptionDetails extends Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails { + displayName: string; + } + export interface IPrintCustomTextOptionDetails extends Windows.Graphics.Printing.OptionDetails.IPrintCustomOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails { + maxCharacters: number; + } + export class PrintCustomTextOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintCustomOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintCustomTextOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + displayName: string; + maxCharacters: number; + trySetValue(value: any): boolean; + } + export interface IPrintCustomItemDetails { + itemDisplayName: string; + itemId: string; + } + export class PrintCustomItemDetails implements Windows.Graphics.Printing.OptionDetails.IPrintCustomItemDetails { + itemDisplayName: string; + itemId: string; + } + export interface IPrintCustomItemListOptionDetails extends Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintCustomOptionDetails { + addItem(itemId: string, displayName: string): void; + } + export class PrintCustomItemListOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintCustomOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintItemListOptionDetails, Windows.Graphics.Printing.OptionDetails.IPrintCustomItemListOptionDetails { + errorText: string; + optionId: string; + optionType: Windows.Graphics.Printing.OptionDetails.PrintOptionType; + state: Windows.Graphics.Printing.OptionDetails.PrintOptionStates; + value: any; + displayName: string; + items: Windows.Foundation.Collections.IVectorView; + trySetValue(value: any): boolean; + addItem(itemId: string, displayName: string): void; + } + export interface IPrintTaskOptionChangedEventArgs { + optionId: any; + } + export class PrintTaskOptionChangedEventArgs implements Windows.Graphics.Printing.OptionDetails.IPrintTaskOptionChangedEventArgs { + optionId: any; + } + export interface IPrintTaskOptionDetails { + options: Windows.Foundation.Collections.IMapView; + createItemListOption(optionId: string, displayName: string): Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails; + createTextOption(optionId: string, displayName: string): Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails; + onoptionchanged: any/* TODO */; + onbeginvalidation: any/* TODO */; + } + export class PrintTaskOptionDetails implements Windows.Graphics.Printing.OptionDetails.IPrintTaskOptionDetails, Windows.Graphics.Printing.IPrintTaskOptionsCore, Windows.Graphics.Printing.IPrintTaskOptionsCoreUIConfiguration { + options: Windows.Foundation.Collections.IMapView; + displayedOptions: Windows.Foundation.Collections.IVector; + createItemListOption(optionId: string, displayName: string): Windows.Graphics.Printing.OptionDetails.PrintCustomItemListOptionDetails; + createTextOption(optionId: string, displayName: string): Windows.Graphics.Printing.OptionDetails.PrintCustomTextOptionDetails; + onoptionchanged: any/* TODO */; + onbeginvalidation: any/* TODO */; + getPageDescription(jobPageNumber: number): Windows.Graphics.Printing.PrintPageDescription; + static getFromPrintTaskOptions(printTaskOptions: Windows.Graphics.Printing.PrintTaskOptions): Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails; + } + export interface IPrintTaskOptionDetailsStatic { + getFromPrintTaskOptions(printTaskOptions: Windows.Graphics.Printing.PrintTaskOptions): Windows.Graphics.Printing.OptionDetails.PrintTaskOptionDetails; + } + } + } + } +} +declare module Windows { + export module Graphics { + export module Printing { + export interface PrintPageDescription { + pageSize: Windows.Foundation.Size; + imageableRect: Windows.Foundation.Rect; + dpiX: number; + dpiY: number; + } + export enum PrintMediaSize { + default, + notAvailable, + printerCustom, + businessCard, + creditCard, + isoA0, + isoA1, + isoA10, + isoA2, + isoA3, + isoA3Extra, + isoA3Rotated, + isoA4, + isoA4Extra, + isoA4Rotated, + isoA5, + isoA5Extra, + isoA5Rotated, + isoA6, + isoA6Rotated, + isoA7, + isoA8, + isoA9, + isoB0, + isoB1, + isoB10, + isoB2, + isoB3, + isoB4, + isoB4Envelope, + isoB5Envelope, + isoB5Extra, + isoB7, + isoB8, + isoB9, + isoC0, + isoC1, + isoC10, + isoC2, + isoC3, + isoC3Envelope, + isoC4, + isoC4Envelope, + isoC5, + isoC5Envelope, + isoC6, + isoC6C5Envelope, + isoC6Envelope, + isoC7, + isoC8, + isoC9, + isoDLEnvelope, + isoDLEnvelopeRotated, + isoSRA3, + japan2LPhoto, + japanChou3Envelope, + japanChou3EnvelopeRotated, + japanChou4Envelope, + japanChou4EnvelopeRotated, + japanDoubleHagakiPostcard, + japanDoubleHagakiPostcardRotated, + japanHagakiPostcard, + japanHagakiPostcardRotated, + japanKaku2Envelope, + japanKaku2EnvelopeRotated, + japanKaku3Envelope, + japanKaku3EnvelopeRotated, + japanLPhoto, + japanQuadrupleHagakiPostcard, + japanYou1Envelope, + japanYou2Envelope, + japanYou3Envelope, + japanYou4Envelope, + japanYou4EnvelopeRotated, + japanYou6Envelope, + japanYou6EnvelopeRotated, + jisB0, + jisB1, + jisB10, + jisB2, + jisB3, + jisB4, + jisB4Rotated, + jisB5, + jisB5Rotated, + jisB6, + jisB6Rotated, + jisB7, + jisB8, + jisB9, + northAmerica10x11, + northAmerica10x12, + northAmerica10x14, + northAmerica11x17, + northAmerica14x17, + northAmerica4x6, + northAmerica4x8, + northAmerica5x7, + northAmerica8x10, + northAmerica9x11, + northAmericaArchitectureASheet, + northAmericaArchitectureBSheet, + northAmericaArchitectureCSheet, + northAmericaArchitectureDSheet, + northAmericaArchitectureESheet, + northAmericaCSheet, + northAmericaDSheet, + northAmericaESheet, + northAmericaExecutive, + northAmericaGermanLegalFanfold, + northAmericaGermanStandardFanfold, + northAmericaLegal, + northAmericaLegalExtra, + northAmericaLetter, + northAmericaLetterExtra, + northAmericaLetterPlus, + northAmericaLetterRotated, + northAmericaMonarchEnvelope, + northAmericaNote, + northAmericaNumber10Envelope, + northAmericaNumber10EnvelopeRotated, + northAmericaNumber11Envelope, + northAmericaNumber12Envelope, + northAmericaNumber14Envelope, + northAmericaNumber9Envelope, + northAmericaPersonalEnvelope, + northAmericaQuarto, + northAmericaStatement, + northAmericaSuperA, + northAmericaSuperB, + northAmericaTabloid, + northAmericaTabloidExtra, + otherMetricA3Plus, + otherMetricA4Plus, + otherMetricFolio, + otherMetricInviteEnvelope, + otherMetricItalianEnvelope, + prc10Envelope, + prc10EnvelopeRotated, + prc16K, + prc16KRotated, + prc1Envelope, + prc1EnvelopeRotated, + prc2Envelope, + prc2EnvelopeRotated, + prc32K, + prc32KBig, + prc32KRotated, + prc3Envelope, + prc3EnvelopeRotated, + prc4Envelope, + prc4EnvelopeRotated, + prc5Envelope, + prc5EnvelopeRotated, + prc6Envelope, + prc6EnvelopeRotated, + prc7Envelope, + prc7EnvelopeRotated, + prc8Envelope, + prc8EnvelopeRotated, + prc9Envelope, + prc9EnvelopeRotated, + roll04Inch, + roll06Inch, + roll08Inch, + roll12Inch, + roll15Inch, + roll18Inch, + roll22Inch, + roll24Inch, + roll30Inch, + roll36Inch, + roll54Inch, + } + export enum PrintMediaType { + default, + notAvailable, + printerCustom, + autoSelect, + archival, + backPrintFilm, + bond, + cardStock, + continuous, + envelopePlain, + envelopeWindow, + fabric, + highResolution, + label, + multiLayerForm, + multiPartForm, + photographic, + photographicFilm, + photographicGlossy, + photographicHighGloss, + photographicMatte, + photographicSatin, + photographicSemiGloss, + plain, + screen, + screenPaged, + stationery, + tabStockFull, + tabStockPreCut, + transparency, + tShirtTransfer, + none, + } + export enum PrintOrientation { + default, + notAvailable, + printerCustom, + portrait, + portraitFlipped, + landscape, + landscapeFlipped, + } + export enum PrintQuality { + default, + notAvailable, + printerCustom, + automatic, + draft, + fax, + high, + normal, + photographic, + text, + } + export enum PrintColorMode { + default, + notAvailable, + printerCustom, + color, + grayscale, + monochrome, + } + export enum PrintDuplex { + default, + notAvailable, + printerCustom, + oneSided, + twoSidedShortEdge, + twoSidedLongEdge, + } + export enum PrintCollation { + default, + notAvailable, + printerCustom, + collated, + uncollated, + } + export enum PrintStaple { + default, + notAvailable, + printerCustom, + none, + stapleTopLeft, + stapleTopRight, + stapleBottomLeft, + stapleBottomRight, + stapleDualLeft, + stapleDualRight, + stapleDualTop, + stapleDualBottom, + saddleStitch, + } + export enum PrintHolePunch { + default, + notAvailable, + printerCustom, + none, + leftEdge, + rightEdge, + topEdge, + bottomEdge, + } + export enum PrintBinding { + default, + notAvailable, + printerCustom, + none, + bale, + bindBottom, + bindLeft, + bindRight, + bindTop, + booklet, + edgeStitchBottom, + edgeStitchLeft, + edgeStitchRight, + edgeStitchTop, + fold, + jogOffset, + trim, + } + export interface IPrintTaskOptionsCoreProperties { + binding: Windows.Graphics.Printing.PrintBinding; + collation: Windows.Graphics.Printing.PrintCollation; + colorMode: Windows.Graphics.Printing.PrintColorMode; + duplex: Windows.Graphics.Printing.PrintDuplex; + holePunch: Windows.Graphics.Printing.PrintHolePunch; + maxCopies: number; + mediaSize: Windows.Graphics.Printing.PrintMediaSize; + mediaType: Windows.Graphics.Printing.PrintMediaType; + minCopies: number; + numberOfCopies: number; + orientation: Windows.Graphics.Printing.PrintOrientation; + printQuality: Windows.Graphics.Printing.PrintQuality; + staple: Windows.Graphics.Printing.PrintStaple; + } + export interface IPrintTaskOptionsCoreUIConfiguration { + displayedOptions: Windows.Foundation.Collections.IVector; + } + export interface IPrintTaskOptionsCore { + getPageDescription(jobPageNumber: number): Windows.Graphics.Printing.PrintPageDescription; + } + export class PrintTaskOptions implements Windows.Graphics.Printing.IPrintTaskOptionsCore, Windows.Graphics.Printing.IPrintTaskOptionsCoreProperties, Windows.Graphics.Printing.IPrintTaskOptionsCoreUIConfiguration { + binding: Windows.Graphics.Printing.PrintBinding; + collation: Windows.Graphics.Printing.PrintCollation; + colorMode: Windows.Graphics.Printing.PrintColorMode; + duplex: Windows.Graphics.Printing.PrintDuplex; + holePunch: Windows.Graphics.Printing.PrintHolePunch; + maxCopies: number; + mediaSize: Windows.Graphics.Printing.PrintMediaSize; + mediaType: Windows.Graphics.Printing.PrintMediaType; + minCopies: number; + numberOfCopies: number; + orientation: Windows.Graphics.Printing.PrintOrientation; + printQuality: Windows.Graphics.Printing.PrintQuality; + staple: Windows.Graphics.Printing.PrintStaple; + displayedOptions: Windows.Foundation.Collections.IVector; + getPageDescription(jobPageNumber: number): Windows.Graphics.Printing.PrintPageDescription; + } + export interface IStandardPrintTaskOptionsStatic { + binding: string; + collation: string; + colorMode: string; + copies: string; + duplex: string; + holePunch: string; + inputBin: string; + mediaSize: string; + mediaType: string; + nUp: string; + orientation: string; + printQuality: string; + staple: string; + } + export class StandardPrintTaskOptions { + static binding: string; + static collation: string; + static colorMode: string; + static copies: string; + static duplex: string; + static holePunch: string; + static inputBin: string; + static mediaSize: string; + static mediaType: string; + static nUp: string; + static orientation: string; + static printQuality: string; + static staple: string; + } + export interface IPrintDocumentSource { + } + export interface IPrintTaskProgressingEventArgs { + documentPageCount: number; + } + export class PrintTaskProgressingEventArgs implements Windows.Graphics.Printing.IPrintTaskProgressingEventArgs { + documentPageCount: number; + } + export enum PrintTaskCompletion { + abandoned, + canceled, + failed, + submitted, + } + export interface IPrintTaskCompletedEventArgs { + completion: Windows.Graphics.Printing.PrintTaskCompletion; + } + export class PrintTaskCompletedEventArgs implements Windows.Graphics.Printing.IPrintTaskCompletedEventArgs { + completion: Windows.Graphics.Printing.PrintTaskCompletion; + } + export interface IPrintTask { + options: Windows.Graphics.Printing.PrintTaskOptions; + properties: Windows.ApplicationModel.DataTransfer.DataPackagePropertySet; + source: Windows.Graphics.Printing.IPrintDocumentSource; + onpreviewing: any/* TODO */; + onsubmitting: any/* TODO */; + onprogressing: any/* TODO */; + oncompleted: any/* TODO */; + } + export class PrintTask implements Windows.Graphics.Printing.IPrintTask { + options: Windows.Graphics.Printing.PrintTaskOptions; + properties: Windows.ApplicationModel.DataTransfer.DataPackagePropertySet; + source: Windows.Graphics.Printing.IPrintDocumentSource; + onpreviewing: any/* TODO */; + onsubmitting: any/* TODO */; + onprogressing: any/* TODO */; + oncompleted: any/* TODO */; + } + export interface IPrintTaskSourceRequestedDeferral { + complete(): void; + } + export class PrintTaskSourceRequestedDeferral implements Windows.Graphics.Printing.IPrintTaskSourceRequestedDeferral { + complete(): void; + } + export interface IPrintTaskSourceRequestedArgs { + deadline: Date; + setSource(source: Windows.Graphics.Printing.IPrintDocumentSource): void; + getDeferral(): Windows.Graphics.Printing.PrintTaskSourceRequestedDeferral; + } + export class PrintTaskSourceRequestedArgs implements Windows.Graphics.Printing.IPrintTaskSourceRequestedArgs { + deadline: Date; + setSource(source: Windows.Graphics.Printing.IPrintDocumentSource): void; + getDeferral(): Windows.Graphics.Printing.PrintTaskSourceRequestedDeferral; + } + export interface PrintTaskSourceRequestedHandler { + (args: Windows.Graphics.Printing.PrintTaskSourceRequestedArgs): void; + } + export interface IPrintTaskRequestedDeferral { + complete(): void; + } + export class PrintTaskRequestedDeferral implements Windows.Graphics.Printing.IPrintTaskRequestedDeferral { + complete(): void; + } + export interface IPrintTaskRequest { + deadline: Date; + createPrintTask(title: string, handler: Windows.Graphics.Printing.PrintTaskSourceRequestedHandler): Windows.Graphics.Printing.PrintTask; + getDeferral(): Windows.Graphics.Printing.PrintTaskRequestedDeferral; + } + export class PrintTaskRequest implements Windows.Graphics.Printing.IPrintTaskRequest { + deadline: Date; + createPrintTask(title: string, handler: Windows.Graphics.Printing.PrintTaskSourceRequestedHandler): Windows.Graphics.Printing.PrintTask; + getDeferral(): Windows.Graphics.Printing.PrintTaskRequestedDeferral; + } + export interface IPrintTaskRequestedEventArgs { + request: Windows.Graphics.Printing.PrintTaskRequest; + } + export class PrintTaskRequestedEventArgs implements Windows.Graphics.Printing.IPrintTaskRequestedEventArgs { + request: Windows.Graphics.Printing.PrintTaskRequest; + } + export interface IPrintManagerStatic { + getForCurrentView(): Windows.Graphics.Printing.PrintManager; + showPrintUIAsync(): Windows.Foundation.IAsyncOperation; + } + export class PrintManager implements Windows.Graphics.Printing.IPrintManager { + onprinttaskrequested: any/* TODO */; + static getForCurrentView(): Windows.Graphics.Printing.PrintManager; + static showPrintUIAsync(): Windows.Foundation.IAsyncOperation; + } + export interface IPrintManager { + onprinttaskrequested: any/* TODO */; + } + } + } +} +declare module Windows { + export module Management { + export module Deployment { + export enum DeploymentProgressState { + queued, + processing, + } + export interface DeploymentProgress { + state: Windows.Management.Deployment.DeploymentProgressState; + percentage: number; + } + export enum DeploymentOptions { + none, + forceApplicationShutdown, + developmentMode, + } + export interface IDeploymentResult { + activityId: string; + errorText: string; + extendedErrorCode: number; + } + export class DeploymentResult implements Windows.Management.Deployment.IDeploymentResult { + activityId: string; + errorText: string; + extendedErrorCode: number; + } + export enum PackageInstallState { + notInstalled, + staged, + installed, + } + export interface IPackageUserInformation { + installState: Windows.Management.Deployment.PackageInstallState; + userSecurityId: string; + } + export class PackageUserInformation implements Windows.Management.Deployment.IPackageUserInformation { + installState: Windows.Management.Deployment.PackageInstallState; + userSecurityId: string; + } + export enum PackageState { + normal, + licenseInvalid, + modified, + tampered, + } + export interface IPackageManager { + addPackageAsync(packageUri: Windows.Foundation.Uri, dependencyPackageUris: Windows.Foundation.Collections.IIterable, deploymentOptions: Windows.Management.Deployment.DeploymentOptions): Windows.Foundation.IAsyncOperationWithProgress; + updatePackageAsync(packageUri: Windows.Foundation.Uri, dependencyPackageUris: Windows.Foundation.Collections.IIterable, deploymentOptions: Windows.Management.Deployment.DeploymentOptions): Windows.Foundation.IAsyncOperationWithProgress; + removePackageAsync(packageFullName: string): Windows.Foundation.IAsyncOperationWithProgress; + stagePackageAsync(packageUri: Windows.Foundation.Uri, dependencyPackageUris: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperationWithProgress; + registerPackageAsync(manifestUri: Windows.Foundation.Uri, dependencyPackageUris: Windows.Foundation.Collections.IIterable, deploymentOptions: Windows.Management.Deployment.DeploymentOptions): Windows.Foundation.IAsyncOperationWithProgress; + findPackages(): Windows.Foundation.Collections.IIterable; + findPackagesForUser(userSecurityId: string): Windows.Foundation.Collections.IIterable; + findPackages(packageName: string, packagePublisher: string): Windows.Foundation.Collections.IIterable; + findPackagesForUser(userSecurityId: string, packageName: string, packagePublisher: string): Windows.Foundation.Collections.IIterable; + findUsers(packageFullName: string): Windows.Foundation.Collections.IIterable; + setPackageState(packageFullName: string, packageState: Windows.Management.Deployment.PackageState): void; + findPackage(packageFullName: string): Windows.ApplicationModel.Package; + cleanupPackageForUserAsync(packageName: string, userSecurityId: string): Windows.Foundation.IAsyncOperationWithProgress; + findPackages(packageFamilyName: string): Windows.Foundation.Collections.IIterable; + findPackagesForUser(userSecurityId: string, packageFamilyName: string): Windows.Foundation.Collections.IIterable; + findPackageForUser(userSecurityId: string, packageFullName: string): Windows.ApplicationModel.Package; + } + export class PackageManager implements Windows.Management.Deployment.IPackageManager { + addPackageAsync(packageUri: Windows.Foundation.Uri, dependencyPackageUris: Windows.Foundation.Collections.IIterable, deploymentOptions: Windows.Management.Deployment.DeploymentOptions): Windows.Foundation.IAsyncOperationWithProgress; + updatePackageAsync(packageUri: Windows.Foundation.Uri, dependencyPackageUris: Windows.Foundation.Collections.IIterable, deploymentOptions: Windows.Management.Deployment.DeploymentOptions): Windows.Foundation.IAsyncOperationWithProgress; + removePackageAsync(packageFullName: string): Windows.Foundation.IAsyncOperationWithProgress; + stagePackageAsync(packageUri: Windows.Foundation.Uri, dependencyPackageUris: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperationWithProgress; + registerPackageAsync(manifestUri: Windows.Foundation.Uri, dependencyPackageUris: Windows.Foundation.Collections.IIterable, deploymentOptions: Windows.Management.Deployment.DeploymentOptions): Windows.Foundation.IAsyncOperationWithProgress; + findPackages(): Windows.Foundation.Collections.IIterable; + findPackagesForUser(userSecurityId: string): Windows.Foundation.Collections.IIterable; + findPackages(packageName: string, packagePublisher: string): Windows.Foundation.Collections.IIterable; + findPackagesForUser(userSecurityId: string, packageName: string, packagePublisher: string): Windows.Foundation.Collections.IIterable; + findUsers(packageFullName: string): Windows.Foundation.Collections.IIterable; + setPackageState(packageFullName: string, packageState: Windows.Management.Deployment.PackageState): void; + findPackage(packageFullName: string): Windows.ApplicationModel.Package; + cleanupPackageForUserAsync(packageName: string, userSecurityId: string): Windows.Foundation.IAsyncOperationWithProgress; + findPackages(packageFamilyName: string): Windows.Foundation.Collections.IIterable; + findPackagesForUser(userSecurityId: string, packageFamilyName: string): Windows.Foundation.Collections.IIterable; + findPackageForUser(userSecurityId: string, packageFullName: string): Windows.ApplicationModel.Package; + } + } + } +} +declare module Windows { + export module Management { + export module Core { + export interface IApplicationDataManagerStatics { + createForPackageFamily(packageFamilyName: string): Windows.Storage.ApplicationData; + } + export interface IApplicationDataManager { + } + export class ApplicationDataManager implements Windows.Management.Core.IApplicationDataManager { + static createForPackageFamily(packageFamilyName: string): Windows.Storage.ApplicationData; + } + } + } +} +declare module Windows { + export module Media { + export module Capture { + export enum CameraCaptureUIMode { + photoOrVideo, + photo, + video, + } + export enum CameraCaptureUIPhotoFormat { + jpeg, + png, + jpegXR, + } + export enum CameraCaptureUIVideoFormat { + mp4, + wmv, + } + export enum CameraCaptureUIMaxVideoResolution { + highestAvailable, + lowDefinition, + standardDefinition, + highDefinition, + } + export enum CameraCaptureUIMaxPhotoResolution { + highestAvailable, + verySmallQvga, + smallVga, + mediumXga, + large3M, + veryLarge5M, + } + export interface ICameraCaptureUIPhotoCaptureSettings { + allowCropping: boolean; + croppedAspectRatio: Windows.Foundation.Size; + croppedSizeInPixels: Windows.Foundation.Size; + format: Windows.Media.Capture.CameraCaptureUIPhotoFormat; + maxResolution: Windows.Media.Capture.CameraCaptureUIMaxPhotoResolution; + } + export class CameraCaptureUIPhotoCaptureSettings implements Windows.Media.Capture.ICameraCaptureUIPhotoCaptureSettings { + allowCropping: boolean; + croppedAspectRatio: Windows.Foundation.Size; + croppedSizeInPixels: Windows.Foundation.Size; + format: Windows.Media.Capture.CameraCaptureUIPhotoFormat; + maxResolution: Windows.Media.Capture.CameraCaptureUIMaxPhotoResolution; + } + export interface ICameraCaptureUIVideoCaptureSettings { + allowTrimming: boolean; + format: Windows.Media.Capture.CameraCaptureUIVideoFormat; + maxDurationInSeconds: number; + maxResolution: Windows.Media.Capture.CameraCaptureUIMaxVideoResolution; + } + export class CameraCaptureUIVideoCaptureSettings implements Windows.Media.Capture.ICameraCaptureUIVideoCaptureSettings { + allowTrimming: boolean; + format: Windows.Media.Capture.CameraCaptureUIVideoFormat; + maxDurationInSeconds: number; + maxResolution: Windows.Media.Capture.CameraCaptureUIMaxVideoResolution; + } + export interface ICameraCaptureUI { + photoSettings: Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings; + videoSettings: Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings; + captureFileAsync(mode: Windows.Media.Capture.CameraCaptureUIMode): Windows.Foundation.IAsyncOperation; + } + export class CameraCaptureUI implements Windows.Media.Capture.ICameraCaptureUI { + photoSettings: Windows.Media.Capture.CameraCaptureUIPhotoCaptureSettings; + videoSettings: Windows.Media.Capture.CameraCaptureUIVideoCaptureSettings; + captureFileAsync(mode: Windows.Media.Capture.CameraCaptureUIMode): Windows.Foundation.IAsyncOperation; + } + export interface ICameraOptionsUIStatics { + show(mediaCapture: Windows.Media.Capture.MediaCapture): void; + } + export class CameraOptionsUI { + static show(mediaCapture: Windows.Media.Capture.MediaCapture): void; + } + export enum MediaStreamType { + videoPreview, + videoRecord, + audio, + photo, + } + export enum StreamingCaptureMode { + audioAndVideo, + audio, + video, + } + export enum VideoRotation { + none, + clockwise90Degrees, + clockwise180Degrees, + clockwise270Degrees, + } + export enum PhotoCaptureSource { + auto, + videoPreview, + photo, + } + export enum VideoDeviceCharacteristic { + allStreamsIndependent, + previewRecordStreamsIdentical, + previewPhotoStreamsIdentical, + recordPhotoStreamsIdentical, + allStreamsIdentical, + } + export enum PowerlineFrequency { + disabled, + fiftyHertz, + sixtyHertz, + } + export interface IMediaCaptureFailedEventArgs { + code: number; + message: string; + } + export class MediaCaptureFailedEventArgs implements Windows.Media.Capture.IMediaCaptureFailedEventArgs { + code: number; + message: string; + } + export interface MediaCaptureFailedEventHandler { + (sender: Windows.Media.Capture.MediaCapture, errorEventArgs: Windows.Media.Capture.MediaCaptureFailedEventArgs): void; + } + export class MediaCapture implements Windows.Media.Capture.IMediaCapture, Windows.Media.Capture.IMediaCaptureVideoPreview { + audioDeviceController: Windows.Media.Devices.AudioDeviceController; + mediaCaptureSettings: Windows.Media.Capture.MediaCaptureSettings; + videoDeviceController: Windows.Media.Devices.VideoDeviceController; + initializeAsync(): Windows.Foundation.IAsyncAction; + initializeAsync(mediaCaptureInitializationSettings: Windows.Media.Capture.MediaCaptureInitializationSettings): Windows.Foundation.IAsyncAction; + startRecordToStorageFileAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + startRecordToStreamAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncAction; + startRecordToCustomSinkAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, customMediaSink: Windows.Media.IMediaExtension): Windows.Foundation.IAsyncAction; + startRecordToCustomSinkAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, customSinkActivationId: string, customSinkSettings: Windows.Foundation.Collections.IPropertySet): Windows.Foundation.IAsyncAction; + stopRecordAsync(): Windows.Foundation.IAsyncAction; + capturePhotoToStorageFileAsync(type: Windows.Media.MediaProperties.ImageEncodingProperties, file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + capturePhotoToStreamAsync(type: Windows.Media.MediaProperties.ImageEncodingProperties, stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncAction; + addEffectAsync(mediaStreamType: Windows.Media.Capture.MediaStreamType, effectActivationID: string, effectSettings: Windows.Foundation.Collections.IPropertySet): Windows.Foundation.IAsyncAction; + clearEffectsAsync(mediaStreamType: Windows.Media.Capture.MediaStreamType): Windows.Foundation.IAsyncAction; + setEncoderProperty(mediaStreamType: Windows.Media.Capture.MediaStreamType, propertyId: string, propertyValue: any): void; + getEncoderProperty(mediaStreamType: Windows.Media.Capture.MediaStreamType, propertyId: string): any; + onfailed: any/* TODO */; + onrecordlimitationexceeded: any/* TODO */; + setPreviewMirroring(value: boolean): void; + getPreviewMirroring(): boolean; + setPreviewRotation(value: Windows.Media.Capture.VideoRotation): void; + getPreviewRotation(): Windows.Media.Capture.VideoRotation; + setRecordRotation(value: Windows.Media.Capture.VideoRotation): void; + getRecordRotation(): Windows.Media.Capture.VideoRotation; + startPreviewAsync(): Windows.Foundation.IAsyncAction; + startPreviewToCustomSinkAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, customMediaSink: Windows.Media.IMediaExtension): Windows.Foundation.IAsyncAction; + startPreviewToCustomSinkAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, customSinkActivationId: string, customSinkSettings: Windows.Foundation.Collections.IPropertySet): Windows.Foundation.IAsyncAction; + stopPreviewAsync(): Windows.Foundation.IAsyncAction; + } + export interface RecordLimitationExceededEventHandler { + (sender: Windows.Media.Capture.MediaCapture): void; + } + export interface IMediaCaptureInitializationSettings { + audioDeviceId: string; + photoCaptureSource: Windows.Media.Capture.PhotoCaptureSource; + streamingCaptureMode: Windows.Media.Capture.StreamingCaptureMode; + videoDeviceId: string; + } + export class MediaCaptureInitializationSettings implements Windows.Media.Capture.IMediaCaptureInitializationSettings { + audioDeviceId: string; + photoCaptureSource: Windows.Media.Capture.PhotoCaptureSource; + streamingCaptureMode: Windows.Media.Capture.StreamingCaptureMode; + videoDeviceId: string; + } + export interface IMediaCapture { + audioDeviceController: Windows.Media.Devices.AudioDeviceController; + mediaCaptureSettings: Windows.Media.Capture.MediaCaptureSettings; + videoDeviceController: Windows.Media.Devices.VideoDeviceController; + initializeAsync(): Windows.Foundation.IAsyncAction; + initializeAsync(mediaCaptureInitializationSettings: Windows.Media.Capture.MediaCaptureInitializationSettings): Windows.Foundation.IAsyncAction; + startRecordToStorageFileAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + startRecordToStreamAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncAction; + startRecordToCustomSinkAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, customMediaSink: Windows.Media.IMediaExtension): Windows.Foundation.IAsyncAction; + startRecordToCustomSinkAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, customSinkActivationId: string, customSinkSettings: Windows.Foundation.Collections.IPropertySet): Windows.Foundation.IAsyncAction; + stopRecordAsync(): Windows.Foundation.IAsyncAction; + capturePhotoToStorageFileAsync(type: Windows.Media.MediaProperties.ImageEncodingProperties, file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + capturePhotoToStreamAsync(type: Windows.Media.MediaProperties.ImageEncodingProperties, stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncAction; + addEffectAsync(mediaStreamType: Windows.Media.Capture.MediaStreamType, effectActivationID: string, effectSettings: Windows.Foundation.Collections.IPropertySet): Windows.Foundation.IAsyncAction; + clearEffectsAsync(mediaStreamType: Windows.Media.Capture.MediaStreamType): Windows.Foundation.IAsyncAction; + setEncoderProperty(mediaStreamType: Windows.Media.Capture.MediaStreamType, propertyId: string, propertyValue: any): void; + getEncoderProperty(mediaStreamType: Windows.Media.Capture.MediaStreamType, propertyId: string): any; + onfailed: any/* TODO */; + onrecordlimitationexceeded: any/* TODO */; + setPreviewMirroring(value: boolean): void; + getPreviewMirroring(): boolean; + setPreviewRotation(value: Windows.Media.Capture.VideoRotation): void; + getPreviewRotation(): Windows.Media.Capture.VideoRotation; + setRecordRotation(value: Windows.Media.Capture.VideoRotation): void; + getRecordRotation(): Windows.Media.Capture.VideoRotation; + } + export class MediaCaptureSettings implements Windows.Media.Capture.IMediaCaptureSettings { + audioDeviceId: string; + photoCaptureSource: Windows.Media.Capture.PhotoCaptureSource; + streamingCaptureMode: Windows.Media.Capture.StreamingCaptureMode; + videoDeviceCharacteristic: Windows.Media.Capture.VideoDeviceCharacteristic; + videoDeviceId: string; + } + export interface IMediaCaptureVideoPreview { + startPreviewAsync(): Windows.Foundation.IAsyncAction; + startPreviewToCustomSinkAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, customMediaSink: Windows.Media.IMediaExtension): Windows.Foundation.IAsyncAction; + startPreviewToCustomSinkAsync(encodingProfile: Windows.Media.MediaProperties.MediaEncodingProfile, customSinkActivationId: string, customSinkSettings: Windows.Foundation.Collections.IPropertySet): Windows.Foundation.IAsyncAction; + stopPreviewAsync(): Windows.Foundation.IAsyncAction; + } + export interface IMediaCaptureSettings { + audioDeviceId: string; + photoCaptureSource: Windows.Media.Capture.PhotoCaptureSource; + streamingCaptureMode: Windows.Media.Capture.StreamingCaptureMode; + videoDeviceCharacteristic: Windows.Media.Capture.VideoDeviceCharacteristic; + videoDeviceId: string; + } + } + } +} +declare module Windows { + export module Media { + export module Devices { + export enum TelephonyKey { + d0, + d1, + d2, + d3, + d4, + d5, + d6, + d7, + d8, + d9, + star, + pound, + a, + b, + c, + d, + } + export interface IDialRequestedEventArgs { + contact: any; + handled(): void; + } + export class DialRequestedEventArgs implements Windows.Media.Devices.IDialRequestedEventArgs { + contact: any; + handled(): void; + } + export interface IRedialRequestedEventArgs { + handled(): void; + } + export class RedialRequestedEventArgs implements Windows.Media.Devices.IRedialRequestedEventArgs { + handled(): void; + } + export interface IKeypadPressedEventArgs { + telephonyKey: Windows.Media.Devices.TelephonyKey; + } + export class KeypadPressedEventArgs implements Windows.Media.Devices.IKeypadPressedEventArgs { + telephonyKey: Windows.Media.Devices.TelephonyKey; + } + export interface CallControlEventHandler { + (sender: Windows.Media.Devices.CallControl): void; + } + export class CallControl implements Windows.Media.Devices.ICallControl { + hasRinger: boolean; + indicateNewIncomingCall(enableRinger: boolean, callerId: string): number; + indicateNewOutgoingCall(): number; + indicateActiveCall(callToken: number): void; + endCall(callToken: number): void; + onanswerrequested: any/* TODO */; + onhanguprequested: any/* TODO */; + ondialrequested: any/* TODO */; + onredialrequested: any/* TODO */; + onkeypadpressed: any/* TODO */; + onaudiotransferrequested: any/* TODO */; + static getDefault(): Windows.Media.Devices.CallControl; + static fromId(deviceInterfaceId: string): Windows.Media.Devices.CallControl; + } + export interface DialRequestedEventHandler { + (sender: Windows.Media.Devices.CallControl, e: Windows.Media.Devices.DialRequestedEventArgs): void; + } + export interface RedialRequestedEventHandler { + (sender: Windows.Media.Devices.CallControl, e: Windows.Media.Devices.RedialRequestedEventArgs): void; + } + export interface KeypadPressedEventHandler { + (sender: Windows.Media.Devices.CallControl, e: Windows.Media.Devices.KeypadPressedEventArgs): void; + } + export interface ICallControl { + hasRinger: boolean; + indicateNewIncomingCall(enableRinger: boolean, callerId: string): number; + indicateNewOutgoingCall(): number; + indicateActiveCall(callToken: number): void; + endCall(callToken: number): void; + onanswerrequested: any/* TODO */; + onhanguprequested: any/* TODO */; + ondialrequested: any/* TODO */; + onredialrequested: any/* TODO */; + onkeypadpressed: any/* TODO */; + onaudiotransferrequested: any/* TODO */; + } + export interface ICallControlStatics { + getDefault(): Windows.Media.Devices.CallControl; + fromId(deviceInterfaceId: string): Windows.Media.Devices.CallControl; + } + export enum AudioDeviceRole { + default, + communications, + } + export interface IDefaultAudioDeviceChangedEventArgs { + id: string; + role: Windows.Media.Devices.AudioDeviceRole; + } + export interface IMediaDeviceStatics { + getAudioCaptureSelector(): string; + getAudioRenderSelector(): string; + getVideoCaptureSelector(): string; + getDefaultAudioCaptureId(role: Windows.Media.Devices.AudioDeviceRole): string; + getDefaultAudioRenderId(role: Windows.Media.Devices.AudioDeviceRole): string; + ondefaultaudiocapturedevicechanged: any/* TODO */; + ondefaultaudiorenderdevicechanged: any/* TODO */; + } + export class DefaultAudioCaptureDeviceChangedEventArgs implements Windows.Media.Devices.IDefaultAudioDeviceChangedEventArgs { + id: string; + role: Windows.Media.Devices.AudioDeviceRole; + } + export class DefaultAudioRenderDeviceChangedEventArgs implements Windows.Media.Devices.IDefaultAudioDeviceChangedEventArgs { + id: string; + role: Windows.Media.Devices.AudioDeviceRole; + } + export class MediaDevice { + static getAudioCaptureSelector(): string; + static getAudioRenderSelector(): string; + static getVideoCaptureSelector(): string; + static getDefaultAudioCaptureId(role: Windows.Media.Devices.AudioDeviceRole): string; + static getDefaultAudioRenderId(role: Windows.Media.Devices.AudioDeviceRole): string; + static ondefaultaudiocapturedevicechanged: any/* TODO */; + static ondefaultaudiorenderdevicechanged: any/* TODO */; + } + export class AudioDeviceController implements Windows.Media.Devices.IAudioDeviceController, Windows.Media.Devices.IMediaDeviceController { + muted: boolean; + volumePercent: number; + getAvailableMediaStreamProperties(mediaStreamType: Windows.Media.Capture.MediaStreamType): Windows.Foundation.Collections.IVectorView; + getMediaStreamProperties(mediaStreamType: Windows.Media.Capture.MediaStreamType): Windows.Media.MediaProperties.IMediaEncodingProperties; + setMediaStreamPropertiesAsync(mediaStreamType: Windows.Media.Capture.MediaStreamType, mediaEncodingProperties: Windows.Media.MediaProperties.IMediaEncodingProperties): Windows.Foundation.IAsyncAction; + } + export class VideoDeviceController implements Windows.Media.Devices.IVideoDeviceController, Windows.Media.Devices.IMediaDeviceController, Windows.Media.Devices.IAdvancedVideoCaptureDeviceController { + backlightCompensation: Windows.Media.Devices.MediaDeviceControl; + brightness: Windows.Media.Devices.MediaDeviceControl; + contrast: Windows.Media.Devices.MediaDeviceControl; + exposure: Windows.Media.Devices.MediaDeviceControl; + focus: Windows.Media.Devices.MediaDeviceControl; + hue: Windows.Media.Devices.MediaDeviceControl; + pan: Windows.Media.Devices.MediaDeviceControl; + roll: Windows.Media.Devices.MediaDeviceControl; + tilt: Windows.Media.Devices.MediaDeviceControl; + whiteBalance: Windows.Media.Devices.MediaDeviceControl; + zoom: Windows.Media.Devices.MediaDeviceControl; + trySetPowerlineFrequency(value: Windows.Media.Capture.PowerlineFrequency): boolean; + tryGetPowerlineFrequency(): { value: Windows.Media.Capture.PowerlineFrequency; succeeded: boolean; }; + getAvailableMediaStreamProperties(mediaStreamType: Windows.Media.Capture.MediaStreamType): Windows.Foundation.Collections.IVectorView; + getMediaStreamProperties(mediaStreamType: Windows.Media.Capture.MediaStreamType): Windows.Media.MediaProperties.IMediaEncodingProperties; + setMediaStreamPropertiesAsync(mediaStreamType: Windows.Media.Capture.MediaStreamType, mediaEncodingProperties: Windows.Media.MediaProperties.IMediaEncodingProperties): Windows.Foundation.IAsyncAction; + setDeviceProperty(propertyId: string, propertyValue: any): void; + getDeviceProperty(propertyId: string): any; + } + export interface IMediaDeviceController { + getAvailableMediaStreamProperties(mediaStreamType: Windows.Media.Capture.MediaStreamType): Windows.Foundation.Collections.IVectorView; + getMediaStreamProperties(mediaStreamType: Windows.Media.Capture.MediaStreamType): Windows.Media.MediaProperties.IMediaEncodingProperties; + setMediaStreamPropertiesAsync(mediaStreamType: Windows.Media.Capture.MediaStreamType, mediaEncodingProperties: Windows.Media.MediaProperties.IMediaEncodingProperties): Windows.Foundation.IAsyncAction; + } + export interface IAudioDeviceController extends Windows.Media.Devices.IMediaDeviceController { + muted: boolean; + volumePercent: number; + } + export interface IVideoDeviceController extends Windows.Media.Devices.IMediaDeviceController { + backlightCompensation: Windows.Media.Devices.MediaDeviceControl; + brightness: Windows.Media.Devices.MediaDeviceControl; + contrast: Windows.Media.Devices.MediaDeviceControl; + exposure: Windows.Media.Devices.MediaDeviceControl; + focus: Windows.Media.Devices.MediaDeviceControl; + hue: Windows.Media.Devices.MediaDeviceControl; + pan: Windows.Media.Devices.MediaDeviceControl; + roll: Windows.Media.Devices.MediaDeviceControl; + tilt: Windows.Media.Devices.MediaDeviceControl; + whiteBalance: Windows.Media.Devices.MediaDeviceControl; + zoom: Windows.Media.Devices.MediaDeviceControl; + trySetPowerlineFrequency(value: Windows.Media.Capture.PowerlineFrequency): boolean; + tryGetPowerlineFrequency(): { value: Windows.Media.Capture.PowerlineFrequency; succeeded: boolean; }; + } + export class MediaDeviceControl implements Windows.Media.Devices.IMediaDeviceControl { + capabilities: Windows.Media.Devices.MediaDeviceControlCapabilities; + tryGetValue(): { value: number; succeeded: boolean; }; + trySetValue(value: number): boolean; + tryGetAuto(): { value: boolean; succeeded: boolean; }; + trySetAuto(value: boolean): boolean; + } + export interface IMediaDeviceControl { + capabilities: Windows.Media.Devices.MediaDeviceControlCapabilities; + tryGetValue(): { value: number; succeeded: boolean; }; + trySetValue(value: number): boolean; + tryGetAuto(): { value: boolean; succeeded: boolean; }; + trySetAuto(value: boolean): boolean; + } + export class MediaDeviceControlCapabilities implements Windows.Media.Devices.IMediaDeviceControlCapabilities { + autoModeSupported: boolean; + default: number; + max: number; + min: number; + step: number; + supported: boolean; + } + export interface IMediaDeviceControlCapabilities { + autoModeSupported: boolean; + default: number; + max: number; + min: number; + step: number; + supported: boolean; + } + export interface IAdvancedVideoCaptureDeviceController { + setDeviceProperty(propertyId: string, propertyValue: any): void; + getDeviceProperty(propertyId: string): any; + } + } + } +} +declare module Windows { + export module Media { + export enum SoundLevel { + muted, + low, + full, + } + export interface IMediaControl { + albumArt: Windows.Foundation.Uri; + artistName: string; + isPlaying: boolean; + soundLevel: Windows.Media.SoundLevel; + trackName: string; + onsoundlevelchanged: any/* TODO */; + onplaypressed: any/* TODO */; + onpausepressed: any/* TODO */; + onstoppressed: any/* TODO */; + onplaypausetogglepressed: any/* TODO */; + onrecordpressed: any/* TODO */; + onnexttrackpressed: any/* TODO */; + onprevioustrackpressed: any/* TODO */; + onfastforwardpressed: any/* TODO */; + onrewindpressed: any/* TODO */; + onchanneluppressed: any/* TODO */; + onchanneldownpressed: any/* TODO */; + } + export class MediaControl { + static albumArt: Windows.Foundation.Uri; + static artistName: string; + static isPlaying: boolean; + static soundLevel: Windows.Media.SoundLevel; + static trackName: string; + static onsoundlevelchanged: any/* TODO */; + static onplaypressed: any/* TODO */; + static onpausepressed: any/* TODO */; + static onstoppressed: any/* TODO */; + static onplaypausetogglepressed: any/* TODO */; + static onrecordpressed: any/* TODO */; + static onnexttrackpressed: any/* TODO */; + static onprevioustrackpressed: any/* TODO */; + static onfastforwardpressed: any/* TODO */; + static onrewindpressed: any/* TODO */; + static onchanneluppressed: any/* TODO */; + static onchanneldownpressed: any/* TODO */; + } + export interface IMediaExtension { + setProperties(configuration: Windows.Foundation.Collections.IPropertySet): void; + } + export interface IMediaExtensionManager { + registerSchemeHandler(activatableClassId: string, scheme: string): void; + registerSchemeHandler(activatableClassId: string, scheme: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + registerByteStreamHandler(activatableClassId: string, fileExtension: string, mimeType: string): void; + registerByteStreamHandler(activatableClassId: string, fileExtension: string, mimeType: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + registerAudioDecoder(activatableClassId: string, inputSubtype: string, outputSubtype: string): void; + registerAudioDecoder(activatableClassId: string, inputSubtype: string, outputSubtype: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + registerAudioEncoder(activatableClassId: string, inputSubtype: string, outputSubtype: string): void; + registerAudioEncoder(activatableClassId: string, inputSubtype: string, outputSubtype: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + registerVideoDecoder(activatableClassId: string, inputSubtype: string, outputSubtype: string): void; + registerVideoDecoder(activatableClassId: string, inputSubtype: string, outputSubtype: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + registerVideoEncoder(activatableClassId: string, inputSubtype: string, outputSubtype: string): void; + registerVideoEncoder(activatableClassId: string, inputSubtype: string, outputSubtype: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + } + export class MediaExtensionManager implements Windows.Media.IMediaExtensionManager { + registerSchemeHandler(activatableClassId: string, scheme: string): void; + registerSchemeHandler(activatableClassId: string, scheme: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + registerByteStreamHandler(activatableClassId: string, fileExtension: string, mimeType: string): void; + registerByteStreamHandler(activatableClassId: string, fileExtension: string, mimeType: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + registerAudioDecoder(activatableClassId: string, inputSubtype: string, outputSubtype: string): void; + registerAudioDecoder(activatableClassId: string, inputSubtype: string, outputSubtype: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + registerAudioEncoder(activatableClassId: string, inputSubtype: string, outputSubtype: string): void; + registerAudioEncoder(activatableClassId: string, inputSubtype: string, outputSubtype: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + registerVideoDecoder(activatableClassId: string, inputSubtype: string, outputSubtype: string): void; + registerVideoDecoder(activatableClassId: string, inputSubtype: string, outputSubtype: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + registerVideoEncoder(activatableClassId: string, inputSubtype: string, outputSubtype: string): void; + registerVideoEncoder(activatableClassId: string, inputSubtype: string, outputSubtype: string, configuration: Windows.Foundation.Collections.IPropertySet): void; + } + export interface IVideoEffectsStatics { + videoStabilization: string; + } + export class VideoEffects { + static videoStabilization: string; + } + } +} +declare module Windows { + export module Media { + export module Playlists { + export enum PlaylistFormat { + windowsMedia, + zune, + m3u, + } + export interface IPlaylist { + files: Windows.Foundation.Collections.IVector; + saveAsync(): Windows.Foundation.IAsyncAction; + saveAsAsync(saveLocation: Windows.Storage.IStorageFolder, desiredName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncOperation; + saveAsAsync(saveLocation: Windows.Storage.IStorageFolder, desiredName: string, option: Windows.Storage.NameCollisionOption, playlistFormat: Windows.Media.Playlists.PlaylistFormat): Windows.Foundation.IAsyncOperation; + } + export interface IPlaylistStatics { + loadAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + } + export class Playlist implements Windows.Media.Playlists.IPlaylist { + files: Windows.Foundation.Collections.IVector; + saveAsync(): Windows.Foundation.IAsyncAction; + saveAsAsync(saveLocation: Windows.Storage.IStorageFolder, desiredName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncOperation; + saveAsAsync(saveLocation: Windows.Storage.IStorageFolder, desiredName: string, option: Windows.Storage.NameCollisionOption, playlistFormat: Windows.Media.Playlists.PlaylistFormat): Windows.Foundation.IAsyncOperation; + static loadAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + } + } + } +} +declare module Windows { + export module Media { + export module PlayTo { + export interface IPlayToSource { + connection: Windows.Media.PlayTo.PlayToConnection; + next: Windows.Media.PlayTo.PlayToSource; + playNext(): void; + } + export class PlayToConnection implements Windows.Media.PlayTo.IPlayToConnection { + state: Windows.Media.PlayTo.PlayToConnectionState; + onstatechanged: any/* TODO */; + ontransferred: any/* TODO */; + onerror: any/* TODO */; + } + export class PlayToSource implements Windows.Media.PlayTo.IPlayToSource { + connection: Windows.Media.PlayTo.PlayToConnection; + next: Windows.Media.PlayTo.PlayToSource; + playNext(): void; + } + export enum PlayToConnectionState { + disconnected, + connected, + rendering, + } + export interface IPlayToConnectionStateChangedEventArgs { + currentState: Windows.Media.PlayTo.PlayToConnectionState; + previousState: Windows.Media.PlayTo.PlayToConnectionState; + } + export class PlayToConnectionStateChangedEventArgs implements Windows.Media.PlayTo.IPlayToConnectionStateChangedEventArgs { + currentState: Windows.Media.PlayTo.PlayToConnectionState; + previousState: Windows.Media.PlayTo.PlayToConnectionState; + } + export interface IPlayToConnectionTransferredEventArgs { + currentSource: Windows.Media.PlayTo.PlayToSource; + previousSource: Windows.Media.PlayTo.PlayToSource; + } + export class PlayToConnectionTransferredEventArgs implements Windows.Media.PlayTo.IPlayToConnectionTransferredEventArgs { + currentSource: Windows.Media.PlayTo.PlayToSource; + previousSource: Windows.Media.PlayTo.PlayToSource; + } + export enum PlayToConnectionError { + none, + deviceNotResponding, + deviceError, + deviceLocked, + } + export interface IPlayToConnectionErrorEventArgs { + code: Windows.Media.PlayTo.PlayToConnectionError; + message: string; + } + export class PlayToConnectionErrorEventArgs implements Windows.Media.PlayTo.IPlayToConnectionErrorEventArgs { + code: Windows.Media.PlayTo.PlayToConnectionError; + message: string; + } + export interface IPlayToConnection { + state: Windows.Media.PlayTo.PlayToConnectionState; + onstatechanged: any/* TODO */; + ontransferred: any/* TODO */; + onerror: any/* TODO */; + } + export interface ISourceChangeRequestedEventArgs { + album: string; + author: string; + date: Date; + description: string; + genre: string; + properties: Windows.Foundation.Collections.IMapView; + rating: number; + stream: Windows.Storage.Streams.IRandomAccessStreamWithContentType; + thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference; + title: string; + } + export class SourceChangeRequestedEventArgs implements Windows.Media.PlayTo.ISourceChangeRequestedEventArgs { + album: string; + author: string; + date: Date; + description: string; + genre: string; + properties: Windows.Foundation.Collections.IMapView; + rating: number; + stream: Windows.Storage.Streams.IRandomAccessStreamWithContentType; + thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference; + title: string; + } + export interface IPlaybackRateChangeRequestedEventArgs { + rate: number; + } + export class PlaybackRateChangeRequestedEventArgs implements Windows.Media.PlayTo.IPlaybackRateChangeRequestedEventArgs { + rate: number; + } + export interface ICurrentTimeChangeRequestedEventArgs { + time: number; + } + export class CurrentTimeChangeRequestedEventArgs implements Windows.Media.PlayTo.ICurrentTimeChangeRequestedEventArgs { + time: number; + } + export interface IMuteChangeRequestedEventArgs { + mute: boolean; + } + export class MuteChangeRequestedEventArgs implements Windows.Media.PlayTo.IMuteChangeRequestedEventArgs { + mute: boolean; + } + export interface IVolumeChangeRequestedEventArgs { + volume: number; + } + export class VolumeChangeRequestedEventArgs implements Windows.Media.PlayTo.IVolumeChangeRequestedEventArgs { + volume: number; + } + export interface IPlayToReceiver { + friendlyName: string; + properties: Windows.Foundation.Collections.IPropertySet; + supportsAudio: boolean; + supportsImage: boolean; + supportsVideo: boolean; + onplayrequested: any/* TODO */; + onpauserequested: any/* TODO */; + onsourcechangerequested: any/* TODO */; + onplaybackratechangerequested: any/* TODO */; + oncurrenttimechangerequested: any/* TODO */; + onmutechangerequested: any/* TODO */; + onvolumechangerequested: any/* TODO */; + ontimeupdaterequested: any/* TODO */; + onstoprequested: any/* TODO */; + notifyVolumeChange(volume: number, mute: boolean): void; + notifyRateChange(rate: number): void; + notifyLoadedMetadata(): void; + notifyTimeUpdate(currentTime: number): void; + notifyDurationChange(duration: number): void; + notifySeeking(): void; + notifySeeked(): void; + notifyPaused(): void; + notifyPlaying(): void; + notifyEnded(): void; + notifyError(): void; + notifyStopped(): void; + startAsync(): Windows.Foundation.IAsyncAction; + stopAsync(): Windows.Foundation.IAsyncAction; + } + export class PlayToReceiver implements Windows.Media.PlayTo.IPlayToReceiver { + friendlyName: string; + properties: Windows.Foundation.Collections.IPropertySet; + supportsAudio: boolean; + supportsImage: boolean; + supportsVideo: boolean; + onplayrequested: any/* TODO */; + onpauserequested: any/* TODO */; + onsourcechangerequested: any/* TODO */; + onplaybackratechangerequested: any/* TODO */; + oncurrenttimechangerequested: any/* TODO */; + onmutechangerequested: any/* TODO */; + onvolumechangerequested: any/* TODO */; + ontimeupdaterequested: any/* TODO */; + onstoprequested: any/* TODO */; + notifyVolumeChange(volume: number, mute: boolean): void; + notifyRateChange(rate: number): void; + notifyLoadedMetadata(): void; + notifyTimeUpdate(currentTime: number): void; + notifyDurationChange(duration: number): void; + notifySeeking(): void; + notifySeeked(): void; + notifyPaused(): void; + notifyPlaying(): void; + notifyEnded(): void; + notifyError(): void; + notifyStopped(): void; + startAsync(): Windows.Foundation.IAsyncAction; + stopAsync(): Windows.Foundation.IAsyncAction; + } + export interface IPlayToSourceSelectedEventArgs { + friendlyName: string; + icon: Windows.Storage.Streams.IRandomAccessStreamWithContentType; + supportsAudio: boolean; + supportsImage: boolean; + supportsVideo: boolean; + } + export class PlayToSourceSelectedEventArgs implements Windows.Media.PlayTo.IPlayToSourceSelectedEventArgs { + friendlyName: string; + icon: Windows.Storage.Streams.IRandomAccessStreamWithContentType; + supportsAudio: boolean; + supportsImage: boolean; + supportsVideo: boolean; + } + export interface IPlayToSourceDeferral { + complete(): void; + } + export class PlayToSourceDeferral implements Windows.Media.PlayTo.IPlayToSourceDeferral { + complete(): void; + } + export interface IPlayToSourceRequest { + deadline: Date; + displayErrorString(errorString: string): void; + getDeferral(): Windows.Media.PlayTo.PlayToSourceDeferral; + setSource(value: Windows.Media.PlayTo.PlayToSource): void; + } + export class PlayToSourceRequest implements Windows.Media.PlayTo.IPlayToSourceRequest { + deadline: Date; + displayErrorString(errorString: string): void; + getDeferral(): Windows.Media.PlayTo.PlayToSourceDeferral; + setSource(value: Windows.Media.PlayTo.PlayToSource): void; + } + export interface IPlayToSourceRequestedEventArgs { + sourceRequest: Windows.Media.PlayTo.PlayToSourceRequest; + } + export class PlayToSourceRequestedEventArgs implements Windows.Media.PlayTo.IPlayToSourceRequestedEventArgs { + sourceRequest: Windows.Media.PlayTo.PlayToSourceRequest; + } + export interface IPlayToManager { + defaultSourceSelection: boolean; + onsourcerequested: any/* TODO */; + onsourceselected: any/* TODO */; + } + export class PlayToManager implements Windows.Media.PlayTo.IPlayToManager { + defaultSourceSelection: boolean; + onsourcerequested: any/* TODO */; + onsourceselected: any/* TODO */; + static getForCurrentView(): Windows.Media.PlayTo.PlayToManager; + static showPlayToUI(): void; + } + export interface IPlayToManagerStatics { + getForCurrentView(): Windows.Media.PlayTo.PlayToManager; + showPlayToUI(): void; + } + } + } +} +declare module Windows { + export module Media { + export module MediaProperties { + export interface IMediaRatio { + denominator: number; + numerator: number; + } + export class MediaRatio implements Windows.Media.MediaProperties.IMediaRatio { + denominator: number; + numerator: number; + } + export class MediaPropertySet implements Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + size: number; + lookup(key: string): any; + hasKey(key: string): boolean; + getView(): Windows.Foundation.Collections.IMapView; + insert(key: string, value: any): boolean; + remove(key: string): void; + clear(): void; + first(): Windows.Foundation.Collections.IIterator>; + } + export interface IMediaEncodingProperties { + properties: Windows.Media.MediaProperties.MediaPropertySet; + subtype: string; + type: string; + } + export interface IAudioEncodingProperties extends Windows.Media.MediaProperties.IMediaEncodingProperties { + bitrate: number; + bitsPerSample: number; + channelCount: number; + sampleRate: number; + } + export class AudioEncodingProperties implements Windows.Media.MediaProperties.IAudioEncodingProperties, Windows.Media.MediaProperties.IMediaEncodingProperties { + bitrate: number; + bitsPerSample: number; + channelCount: number; + sampleRate: number; + properties: Windows.Media.MediaProperties.MediaPropertySet; + subtype: string; + type: string; + } + export interface IVideoEncodingProperties extends Windows.Media.MediaProperties.IMediaEncodingProperties { + bitrate: number; + frameRate: Windows.Media.MediaProperties.MediaRatio; + height: number; + pixelAspectRatio: Windows.Media.MediaProperties.MediaRatio; + width: number; + } + export class VideoEncodingProperties implements Windows.Media.MediaProperties.IVideoEncodingProperties, Windows.Media.MediaProperties.IMediaEncodingProperties { + bitrate: number; + frameRate: Windows.Media.MediaProperties.MediaRatio; + height: number; + pixelAspectRatio: Windows.Media.MediaProperties.MediaRatio; + width: number; + properties: Windows.Media.MediaProperties.MediaPropertySet; + subtype: string; + type: string; + } + export interface IImageEncodingProperties extends Windows.Media.MediaProperties.IMediaEncodingProperties { + height: number; + width: number; + } + export interface IImageEncodingPropertiesStatics { + createJpeg(): Windows.Media.MediaProperties.ImageEncodingProperties; + createPng(): Windows.Media.MediaProperties.ImageEncodingProperties; + createJpegXR(): Windows.Media.MediaProperties.ImageEncodingProperties; + } + export class ImageEncodingProperties implements Windows.Media.MediaProperties.IImageEncodingProperties, Windows.Media.MediaProperties.IMediaEncodingProperties { + height: number; + width: number; + properties: Windows.Media.MediaProperties.MediaPropertySet; + subtype: string; + type: string; + static createJpeg(): Windows.Media.MediaProperties.ImageEncodingProperties; + static createPng(): Windows.Media.MediaProperties.ImageEncodingProperties; + static createJpegXR(): Windows.Media.MediaProperties.ImageEncodingProperties; + } + export interface IContainerEncodingProperties extends Windows.Media.MediaProperties.IMediaEncodingProperties { + } + export class ContainerEncodingProperties implements Windows.Media.MediaProperties.IContainerEncodingProperties, Windows.Media.MediaProperties.IMediaEncodingProperties { + properties: Windows.Media.MediaProperties.MediaPropertySet; + subtype: string; + type: string; + } + export enum AudioEncodingQuality { + auto, + high, + medium, + low, + } + export enum VideoEncodingQuality { + auto, + hD1080p, + hD720p, + wvga, + ntsc, + pal, + vga, + qvga, + } + export interface IMediaEncodingProfileStatics { + createM4a(quality: Windows.Media.MediaProperties.AudioEncodingQuality): Windows.Media.MediaProperties.MediaEncodingProfile; + createMp3(quality: Windows.Media.MediaProperties.AudioEncodingQuality): Windows.Media.MediaProperties.MediaEncodingProfile; + createWma(quality: Windows.Media.MediaProperties.AudioEncodingQuality): Windows.Media.MediaProperties.MediaEncodingProfile; + createMp4(quality: Windows.Media.MediaProperties.VideoEncodingQuality): Windows.Media.MediaProperties.MediaEncodingProfile; + createWmv(quality: Windows.Media.MediaProperties.VideoEncodingQuality): Windows.Media.MediaProperties.MediaEncodingProfile; + createFromFileAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + createFromStreamAsync(stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + } + export class MediaEncodingProfile implements Windows.Media.MediaProperties.IMediaEncodingProfile { + audio: Windows.Media.MediaProperties.AudioEncodingProperties; + container: Windows.Media.MediaProperties.ContainerEncodingProperties; + video: Windows.Media.MediaProperties.VideoEncodingProperties; + static createM4a(quality: Windows.Media.MediaProperties.AudioEncodingQuality): Windows.Media.MediaProperties.MediaEncodingProfile; + static createMp3(quality: Windows.Media.MediaProperties.AudioEncodingQuality): Windows.Media.MediaProperties.MediaEncodingProfile; + static createWma(quality: Windows.Media.MediaProperties.AudioEncodingQuality): Windows.Media.MediaProperties.MediaEncodingProfile; + static createMp4(quality: Windows.Media.MediaProperties.VideoEncodingQuality): Windows.Media.MediaProperties.MediaEncodingProfile; + static createWmv(quality: Windows.Media.MediaProperties.VideoEncodingQuality): Windows.Media.MediaProperties.MediaEncodingProfile; + static createFromFileAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + static createFromStreamAsync(stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + } + export interface IMediaEncodingProfile { + audio: Windows.Media.MediaProperties.AudioEncodingProperties; + container: Windows.Media.MediaProperties.ContainerEncodingProperties; + video: Windows.Media.MediaProperties.VideoEncodingProperties; + } + } + } +} +declare module Windows { + export module Media { + export module Protection { + export class MediaProtectionManager implements Windows.Media.Protection.IMediaProtectionManager { + properties: Windows.Foundation.Collections.IPropertySet; + onservicerequested: any/* TODO */; + onrebootneeded: any/* TODO */; + oncomponentloadfailed: any/* TODO */; + } + export class ServiceRequestedEventArgs implements Windows.Media.Protection.IServiceRequestedEventArgs { + completion: Windows.Media.Protection.MediaProtectionServiceCompletion; + request: Windows.Media.Protection.IMediaProtectionServiceRequest; + } + export class ComponentLoadFailedEventArgs implements Windows.Media.Protection.IComponentLoadFailedEventArgs { + completion: Windows.Media.Protection.MediaProtectionServiceCompletion; + information: Windows.Media.Protection.RevocationAndRenewalInformation; + } + export class MediaProtectionServiceCompletion implements Windows.Media.Protection.IMediaProtectionServiceCompletion { + complete(success: boolean): void; + } + export class RevocationAndRenewalInformation implements Windows.Media.Protection.IRevocationAndRenewalInformation { + items: Windows.Foundation.Collections.IVector; + } + export class RevocationAndRenewalItem implements Windows.Media.Protection.IRevocationAndRenewalItem { + headerHash: string; + name: string; + publicKeyHash: string; + reasons: Windows.Media.Protection.RevocationAndRenewalReasons; + renewalId: string; + } + export interface ServiceRequestedEventHandler { + (sender: Windows.Media.Protection.MediaProtectionManager, e: Windows.Media.Protection.ServiceRequestedEventArgs): void; + } + export interface RebootNeededEventHandler { + (sender: Windows.Media.Protection.MediaProtectionManager): void; + } + export interface ComponentLoadFailedEventHandler { + (sender: Windows.Media.Protection.MediaProtectionManager, e: Windows.Media.Protection.ComponentLoadFailedEventArgs): void; + } + export interface IMediaProtectionManager { + properties: Windows.Foundation.Collections.IPropertySet; + onservicerequested: any/* TODO */; + onrebootneeded: any/* TODO */; + oncomponentloadfailed: any/* TODO */; + } + export interface IMediaProtectionServiceCompletion { + complete(success: boolean): void; + } + export interface IServiceRequestedEventArgs { + completion: Windows.Media.Protection.MediaProtectionServiceCompletion; + request: Windows.Media.Protection.IMediaProtectionServiceRequest; + } + export interface IMediaProtectionServiceRequest { + protectionSystem: string; + type: string; + } + export interface IComponentLoadFailedEventArgs { + completion: Windows.Media.Protection.MediaProtectionServiceCompletion; + information: Windows.Media.Protection.RevocationAndRenewalInformation; + } + export interface IRevocationAndRenewalInformation { + items: Windows.Foundation.Collections.IVector; + } + export enum RevocationAndRenewalReasons { + userModeComponentLoad, + kernelModeComponentLoad, + appComponent, + globalRevocationListLoadFailed, + invalidGlobalRevocationListSignature, + globalRevocationListAbsent, + componentRevoked, + invalidComponentCertificateExtendedKeyUse, + componentCertificateRevoked, + invalidComponentCertificateRoot, + componentHighSecurityCertificateRevoked, + componentLowSecurityCertificateRevoked, + bootDriverVerificationFailed, + componentSignedWithTestCertificate, + encryptionFailure, + } + export interface IRevocationAndRenewalItem { + headerHash: string; + name: string; + publicKeyHash: string; + reasons: Windows.Media.Protection.RevocationAndRenewalReasons; + renewalId: string; + } + export class ComponentRenewal { + static renewSystemComponentsAsync(information: Windows.Media.Protection.RevocationAndRenewalInformation): Windows.Foundation.IAsyncOperationWithProgress; + } + export enum RenewalStatus { + notStarted, + updatesInProgress, + userCancelled, + appComponentsMayNeedUpdating, + noComponentsFound, + } + export interface IComponentRenewalStatics { + renewSystemComponentsAsync(information: Windows.Media.Protection.RevocationAndRenewalInformation): Windows.Foundation.IAsyncOperationWithProgress; + } + } + } +} +declare module Windows { + export module Media { + export module Transcoding { + export enum TranscodeFailureReason { + none, + unknown, + invalidProfile, + codecNotFound, + } + export interface IMediaTranscoder { + alwaysReencode: boolean; + hardwareAccelerationEnabled: boolean; + trimStartTime: number; + trimStopTime: number; + addAudioEffect(activatableClassId: string): void; + addAudioEffect(activatableClassId: string, effectRequired: boolean, configuration: Windows.Foundation.Collections.IPropertySet): void; + addVideoEffect(activatableClassId: string): void; + addVideoEffect(activatableClassId: string, effectRequired: boolean, configuration: Windows.Foundation.Collections.IPropertySet): void; + clearEffects(): void; + prepareFileTranscodeAsync(source: Windows.Storage.IStorageFile, destination: Windows.Storage.IStorageFile, profile: Windows.Media.MediaProperties.MediaEncodingProfile): Windows.Foundation.IAsyncOperation; + prepareStreamTranscodeAsync(source: Windows.Storage.Streams.IRandomAccessStream, destination: Windows.Storage.Streams.IRandomAccessStream, profile: Windows.Media.MediaProperties.MediaEncodingProfile): Windows.Foundation.IAsyncOperation; + } + export class PrepareTranscodeResult implements Windows.Media.Transcoding.IPrepareTranscodeResult { + canTranscode: boolean; + failureReason: Windows.Media.Transcoding.TranscodeFailureReason; + transcodeAsync(): Windows.Foundation.IAsyncActionWithProgress; + } + export interface IPrepareTranscodeResult { + canTranscode: boolean; + failureReason: Windows.Media.Transcoding.TranscodeFailureReason; + transcodeAsync(): Windows.Foundation.IAsyncActionWithProgress; + } + export class MediaTranscoder implements Windows.Media.Transcoding.IMediaTranscoder { + alwaysReencode: boolean; + hardwareAccelerationEnabled: boolean; + trimStartTime: number; + trimStopTime: number; + addAudioEffect(activatableClassId: string): void; + addAudioEffect(activatableClassId: string, effectRequired: boolean, configuration: Windows.Foundation.Collections.IPropertySet): void; + addVideoEffect(activatableClassId: string): void; + addVideoEffect(activatableClassId: string, effectRequired: boolean, configuration: Windows.Foundation.Collections.IPropertySet): void; + clearEffects(): void; + prepareFileTranscodeAsync(source: Windows.Storage.IStorageFile, destination: Windows.Storage.IStorageFile, profile: Windows.Media.MediaProperties.MediaEncodingProfile): Windows.Foundation.IAsyncOperation; + prepareStreamTranscodeAsync(source: Windows.Storage.Streams.IRandomAccessStream, destination: Windows.Storage.Streams.IRandomAccessStream, profile: Windows.Media.MediaProperties.MediaEncodingProfile): Windows.Foundation.IAsyncOperation; + } + } + } +} +declare module Windows { + export module Networking { + export module NetworkOperators { + export enum DataClasses { + none, + gprs, + edge, + umts, + hsdpa, + hsupa, + lteAdvanced, + cdma1xRtt, + cdma1xEvdo, + cdma1xEvdoRevA, + cdma1xEvdv, + cdma3xRtt, + cdma1xEvdoRevB, + cdmaUmb, + custom, + } + export enum MobileBroadbandDeviceType { + unknown, + embedded, + removable, + remote, + } + export enum NetworkDeviceStatus { + deviceNotReady, + deviceReady, + simNotInserted, + badSim, + deviceHardwareFailure, + accountNotActivated, + deviceLocked, + deviceBlocked, + } + export enum NetworkRegistrationState { + none, + deregistered, + searching, + home, + roaming, + partner, + denied, + } + export enum MobileBroadbandRadioState { + off, + on, + } + export enum NetworkOperatorEventMessageType { + gsm, + cdma, + ussd, + dataPlanThresholdReached, + dataPlanReset, + dataPlanDeleted, + profileConnected, + profileDisconnected, + registeredRoaming, + registeredHome, + } + export enum MobileBroadbandAccountWatcherStatus { + created, + started, + enumerationCompleted, + stopped, + aborted, + } + export interface IMobileBroadbandAccountStatics { + availableNetworkAccountIds: Windows.Foundation.Collections.IVectorView; + createFromNetworkAccountId(networkAccountId: string): Windows.Networking.NetworkOperators.MobileBroadbandAccount; + } + export class MobileBroadbandAccount implements Windows.Networking.NetworkOperators.IMobileBroadbandAccount { + currentDeviceInformation: Windows.Networking.NetworkOperators.MobileBroadbandDeviceInformation; + currentNetwork: Windows.Networking.NetworkOperators.MobileBroadbandNetwork; + networkAccountId: string; + serviceProviderGuid: string; + serviceProviderName: string; + static availableNetworkAccountIds: Windows.Foundation.Collections.IVectorView; + static createFromNetworkAccountId(networkAccountId: string): Windows.Networking.NetworkOperators.MobileBroadbandAccount; + } + export interface IMobileBroadbandAccount { + currentDeviceInformation: Windows.Networking.NetworkOperators.MobileBroadbandDeviceInformation; + currentNetwork: Windows.Networking.NetworkOperators.MobileBroadbandNetwork; + networkAccountId: string; + serviceProviderGuid: string; + serviceProviderName: string; + } + export class MobileBroadbandNetwork implements Windows.Networking.NetworkOperators.IMobileBroadbandNetwork { + accessPointName: string; + activationNetworkError: number; + networkAdapter: Windows.Networking.Connectivity.NetworkAdapter; + networkRegistrationState: Windows.Networking.NetworkOperators.NetworkRegistrationState; + packetAttachNetworkError: number; + registeredDataClass: Windows.Networking.NetworkOperators.DataClasses; + registeredProviderId: string; + registeredProviderName: string; + registrationNetworkError: number; + showConnectionUI(): void; + } + export class MobileBroadbandDeviceInformation implements Windows.Networking.NetworkOperators.IMobileBroadbandDeviceInformation { + cellularClass: Windows.Devices.Sms.CellularClass; + currentRadioState: Windows.Networking.NetworkOperators.MobileBroadbandRadioState; + customDataClass: string; + dataClasses: Windows.Networking.NetworkOperators.DataClasses; + deviceId: string; + deviceType: Windows.Networking.NetworkOperators.MobileBroadbandDeviceType; + firmwareInformation: string; + manufacturer: string; + mobileEquipmentId: string; + model: string; + networkDeviceStatus: Windows.Networking.NetworkOperators.NetworkDeviceStatus; + simIccId: string; + subscriberId: string; + telephoneNumbers: Windows.Foundation.Collections.IVectorView; + } + export interface IMobileBroadbandDeviceInformation { + cellularClass: Windows.Devices.Sms.CellularClass; + currentRadioState: Windows.Networking.NetworkOperators.MobileBroadbandRadioState; + customDataClass: string; + dataClasses: Windows.Networking.NetworkOperators.DataClasses; + deviceId: string; + deviceType: Windows.Networking.NetworkOperators.MobileBroadbandDeviceType; + firmwareInformation: string; + manufacturer: string; + mobileEquipmentId: string; + model: string; + networkDeviceStatus: Windows.Networking.NetworkOperators.NetworkDeviceStatus; + simIccId: string; + subscriberId: string; + telephoneNumbers: Windows.Foundation.Collections.IVectorView; + } + export interface IMobileBroadbandNetwork { + accessPointName: string; + activationNetworkError: number; + networkAdapter: Windows.Networking.Connectivity.NetworkAdapter; + networkRegistrationState: Windows.Networking.NetworkOperators.NetworkRegistrationState; + packetAttachNetworkError: number; + registeredDataClass: Windows.Networking.NetworkOperators.DataClasses; + registeredProviderId: string; + registeredProviderName: string; + registrationNetworkError: number; + showConnectionUI(): void; + } + export interface INetworkOperatorNotificationEventDetails { + encodingType: number; + message: string; + networkAccountId: string; + notificationType: Windows.Networking.NetworkOperators.NetworkOperatorEventMessageType; + ruleId: string; + smsMessage: Windows.Devices.Sms.ISmsMessage; + } + export class NetworkOperatorNotificationEventDetails implements Windows.Networking.NetworkOperators.INetworkOperatorNotificationEventDetails { + encodingType: number; + message: string; + networkAccountId: string; + notificationType: Windows.Networking.NetworkOperators.NetworkOperatorEventMessageType; + ruleId: string; + smsMessage: Windows.Devices.Sms.ISmsMessage; + } + export interface IMobileBroadbandAccountEventArgs { + networkAccountId: string; + } + export class MobileBroadbandAccountEventArgs implements Windows.Networking.NetworkOperators.IMobileBroadbandAccountEventArgs { + networkAccountId: string; + } + export interface IMobileBroadbandAccountUpdatedEventArgs { + hasDeviceInformationChanged: boolean; + hasNetworkChanged: boolean; + networkAccountId: string; + } + export class MobileBroadbandAccountUpdatedEventArgs implements Windows.Networking.NetworkOperators.IMobileBroadbandAccountUpdatedEventArgs { + hasDeviceInformationChanged: boolean; + hasNetworkChanged: boolean; + networkAccountId: string; + } + export interface IMobileBroadbandAccountWatcher { + status: Windows.Networking.NetworkOperators.MobileBroadbandAccountWatcherStatus; + onaccountadded: any/* TODO */; + onaccountupdated: any/* TODO */; + onaccountremoved: any/* TODO */; + onenumerationcompleted: any/* TODO */; + onstopped: any/* TODO */; + start(): void; + stop(): void; + } + export class MobileBroadbandAccountWatcher implements Windows.Networking.NetworkOperators.IMobileBroadbandAccountWatcher { + status: Windows.Networking.NetworkOperators.MobileBroadbandAccountWatcherStatus; + onaccountadded: any/* TODO */; + onaccountupdated: any/* TODO */; + onaccountremoved: any/* TODO */; + onenumerationcompleted: any/* TODO */; + onstopped: any/* TODO */; + start(): void; + stop(): void; + } + export interface IHotspotAuthenticationEventDetails { + eventToken: string; + } + export class HotspotAuthenticationEventDetails implements Windows.Networking.NetworkOperators.IHotspotAuthenticationEventDetails { + eventToken: string; + } + export interface IHotspotAuthenticationContextStatics { + tryGetAuthenticationContext(evenToken: string): { context: Windows.Networking.NetworkOperators.HotspotAuthenticationContext; isValid: boolean; }; + } + export class HotspotAuthenticationContext implements Windows.Networking.NetworkOperators.IHotspotAuthenticationContext { + authenticationUrl: Windows.Foundation.Uri; + networkAdapter: Windows.Networking.Connectivity.NetworkAdapter; + redirectMessageUrl: Windows.Foundation.Uri; + redirectMessageXml: Windows.Data.Xml.Dom.XmlDocument; + wirelessNetworkId: Uint8Array; + issueCredentials(userName: string, password: string, extraParameters: string, markAsManualConnectOnFailure: boolean): void; + abortAuthentication(markAsManual: boolean): void; + skipAuthentication(): void; + triggerAttentionRequired(packageRelativeApplicationId: string, applicationParameters: string): void; + static tryGetAuthenticationContext(evenToken: string): { context: Windows.Networking.NetworkOperators.HotspotAuthenticationContext; isValid: boolean; }; + } + export interface IHotspotAuthenticationContext { + authenticationUrl: Windows.Foundation.Uri; + networkAdapter: Windows.Networking.Connectivity.NetworkAdapter; + redirectMessageUrl: Windows.Foundation.Uri; + redirectMessageXml: Windows.Data.Xml.Dom.XmlDocument; + wirelessNetworkId: Uint8Array; + issueCredentials(userName: string, password: string, extraParameters: string, markAsManualConnectOnFailure: boolean): void; + abortAuthentication(markAsManual: boolean): void; + skipAuthentication(): void; + triggerAttentionRequired(packageRelativeApplicationId: string, applicationParameters: string): void; + } + export enum ProfileMediaType { + wlan, + wwan, + } + export interface IProvisionFromXmlDocumentResults { + allElementsProvisioned: boolean; + provisionResultsXml: string; + } + export class ProvisionFromXmlDocumentResults implements Windows.Networking.NetworkOperators.IProvisionFromXmlDocumentResults { + allElementsProvisioned: boolean; + provisionResultsXml: string; + } + export interface ProfileUsage { + usageInMegabytes: number; + lastSyncTime: Date; + } + export interface IProvisionedProfile { + updateCost(value: Windows.Networking.Connectivity.NetworkCostType): void; + updateUsage(value: Windows.Networking.NetworkOperators.ProfileUsage): void; + } + export class ProvisionedProfile implements Windows.Networking.NetworkOperators.IProvisionedProfile { + updateCost(value: Windows.Networking.Connectivity.NetworkCostType): void; + updateUsage(value: Windows.Networking.NetworkOperators.ProfileUsage): void; + } + export interface IProvisioningAgent { + provisionFromXmlDocumentAsync(provisioningXmlDocument: string): Windows.Foundation.IAsyncOperation; + getProvisionedProfile(mediaType: Windows.Networking.NetworkOperators.ProfileMediaType, profileName: string): Windows.Networking.NetworkOperators.ProvisionedProfile; + } + export interface IProvisioningAgentStaticMethods { + createFromNetworkAccountId(networkAccountId: string): Windows.Networking.NetworkOperators.ProvisioningAgent; + } + export class ProvisioningAgent implements Windows.Networking.NetworkOperators.IProvisioningAgent { + provisionFromXmlDocumentAsync(provisioningXmlDocument: string): Windows.Foundation.IAsyncOperation; + getProvisionedProfile(mediaType: Windows.Networking.NetworkOperators.ProfileMediaType, profileName: string): Windows.Networking.NetworkOperators.ProvisionedProfile; + static createFromNetworkAccountId(networkAccountId: string): Windows.Networking.NetworkOperators.ProvisioningAgent; + } + export enum UssdResultCode { + noActionRequired, + actionRequired, + terminated, + otherLocalClient, + operationNotSupported, + networkTimeout, + } + export interface IUssdMessage { + dataCodingScheme: number; + payloadAsText: string; + getPayload(): Uint8Array; + setPayload(value: Uint8Array): void; + } + export interface IUssdMessageFactory { + createMessage(messageText: string): Windows.Networking.NetworkOperators.UssdMessage; + } + export class UssdMessage implements Windows.Networking.NetworkOperators.IUssdMessage { + constructor(messageText: string); + dataCodingScheme: number; + payloadAsText: string; + getPayload(): Uint8Array; + setPayload(value: Uint8Array): void; + } + export interface IUssdReply { + message: Windows.Networking.NetworkOperators.UssdMessage; + resultCode: Windows.Networking.NetworkOperators.UssdResultCode; + } + export class UssdReply implements Windows.Networking.NetworkOperators.IUssdReply { + message: Windows.Networking.NetworkOperators.UssdMessage; + resultCode: Windows.Networking.NetworkOperators.UssdResultCode; + } + export interface IUssdSession { + sendMessageAndGetReplyAsync(message: Windows.Networking.NetworkOperators.UssdMessage): Windows.Foundation.IAsyncOperation; + close(): void; + } + export interface IUssdSessionStatics { + createFromNetworkAccountId(networkAccountId: string): Windows.Networking.NetworkOperators.UssdSession; + createFromNetworkInterfaceId(networkInterfaceId: string): Windows.Networking.NetworkOperators.UssdSession; + } + export class UssdSession implements Windows.Networking.NetworkOperators.IUssdSession { + sendMessageAndGetReplyAsync(message: Windows.Networking.NetworkOperators.UssdMessage): Windows.Foundation.IAsyncOperation; + close(): void; + static createFromNetworkAccountId(networkAccountId: string): Windows.Networking.NetworkOperators.UssdSession; + static createFromNetworkInterfaceId(networkInterfaceId: string): Windows.Networking.NetworkOperators.UssdSession; + } + } + } +} +declare module Windows { + export module Networking { + export module BackgroundTransfer { + export enum BackgroundTransferStatus { + idle, + running, + pausedByApplication, + pausedCostedNetwork, + pausedNoNetwork, + completed, + canceled, + error, + } + export enum BackgroundTransferCostPolicy { + default, + unrestrictedOnly, + always, + } + export interface BackgroundDownloadProgress { + bytesReceived: number; + totalBytesToReceive: number; + status: Windows.Networking.BackgroundTransfer.BackgroundTransferStatus; + hasResponseChanged: boolean; + hasRestarted: boolean; + } + export interface BackgroundUploadProgress { + bytesReceived: number; + bytesSent: number; + totalBytesToReceive: number; + totalBytesToSend: number; + status: Windows.Networking.BackgroundTransfer.BackgroundTransferStatus; + hasResponseChanged: boolean; + hasRestarted: boolean; + } + export interface IBackgroundTransferBase { + costPolicy: Windows.Networking.BackgroundTransfer.BackgroundTransferCostPolicy; + group: string; + method: string; + proxyCredential: Windows.Security.Credentials.PasswordCredential; + serverCredential: Windows.Security.Credentials.PasswordCredential; + setRequestHeader(headerName: string, headerValue: string): void; + } + export interface IBackgroundDownloader extends Windows.Networking.BackgroundTransfer.IBackgroundTransferBase { + createDownload(uri: Windows.Foundation.Uri, resultFile: Windows.Storage.IStorageFile): Windows.Networking.BackgroundTransfer.DownloadOperation; + createDownload(uri: Windows.Foundation.Uri, resultFile: Windows.Storage.IStorageFile, requestBodyFile: Windows.Storage.IStorageFile): Windows.Networking.BackgroundTransfer.DownloadOperation; + createDownloadAsync(uri: Windows.Foundation.Uri, resultFile: Windows.Storage.IStorageFile, requestBodyStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncOperation; + } + export class DownloadOperation implements Windows.Networking.BackgroundTransfer.IDownloadOperation, Windows.Networking.BackgroundTransfer.IBackgroundTransferOperation { + progress: Windows.Networking.BackgroundTransfer.BackgroundDownloadProgress; + resultFile: Windows.Storage.IStorageFile; + costPolicy: Windows.Networking.BackgroundTransfer.BackgroundTransferCostPolicy; + group: string; + guid: string; + method: string; + requestedUri: Windows.Foundation.Uri; + startAsync(): Windows.Foundation.IAsyncOperationWithProgress; + attachAsync(): Windows.Foundation.IAsyncOperationWithProgress; + pause(): void; + resume(): void; + getResultStreamAt(position: number): Windows.Storage.Streams.IInputStream; + getResponseInformation(): Windows.Networking.BackgroundTransfer.ResponseInformation; + } + export interface IBackgroundUploader extends Windows.Networking.BackgroundTransfer.IBackgroundTransferBase { + createUpload(uri: Windows.Foundation.Uri, sourceFile: Windows.Storage.IStorageFile): Windows.Networking.BackgroundTransfer.UploadOperation; + createUploadFromStreamAsync(uri: Windows.Foundation.Uri, sourceStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncOperation; + createUploadAsync(uri: Windows.Foundation.Uri, parts: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + createUploadAsync(uri: Windows.Foundation.Uri, parts: Windows.Foundation.Collections.IIterable, subType: string): Windows.Foundation.IAsyncOperation; + createUploadAsync(uri: Windows.Foundation.Uri, parts: Windows.Foundation.Collections.IIterable, subType: string, boundary: string): Windows.Foundation.IAsyncOperation; + } + export class UploadOperation implements Windows.Networking.BackgroundTransfer.IUploadOperation, Windows.Networking.BackgroundTransfer.IBackgroundTransferOperation { + progress: Windows.Networking.BackgroundTransfer.BackgroundUploadProgress; + sourceFile: Windows.Storage.IStorageFile; + costPolicy: Windows.Networking.BackgroundTransfer.BackgroundTransferCostPolicy; + group: string; + guid: string; + method: string; + requestedUri: Windows.Foundation.Uri; + startAsync(): Windows.Foundation.IAsyncOperationWithProgress; + attachAsync(): Windows.Foundation.IAsyncOperationWithProgress; + getResultStreamAt(position: number): Windows.Storage.Streams.IInputStream; + getResponseInformation(): Windows.Networking.BackgroundTransfer.ResponseInformation; + } + export class BackgroundTransferContentPart implements Windows.Networking.BackgroundTransfer.IBackgroundTransferContentPart { + constructor(name: string); + constructor(name: string, fileName: string); + constructor(); + setHeader(headerName: string, headerValue: string): void; + setText(value: string): void; + setFile(value: Windows.Storage.IStorageFile): void; + } + export interface IBackgroundTransferOperation { + costPolicy: Windows.Networking.BackgroundTransfer.BackgroundTransferCostPolicy; + group: string; + guid: string; + method: string; + requestedUri: Windows.Foundation.Uri; + getResultStreamAt(position: number): Windows.Storage.Streams.IInputStream; + getResponseInformation(): Windows.Networking.BackgroundTransfer.ResponseInformation; + } + export class ResponseInformation implements Windows.Networking.BackgroundTransfer.IResponseInformation { + actualUri: Windows.Foundation.Uri; + headers: Windows.Foundation.Collections.IMapView; + isResumable: boolean; + statusCode: number; + } + export interface IDownloadOperation extends Windows.Networking.BackgroundTransfer.IBackgroundTransferOperation { + progress: Windows.Networking.BackgroundTransfer.BackgroundDownloadProgress; + resultFile: Windows.Storage.IStorageFile; + startAsync(): Windows.Foundation.IAsyncOperationWithProgress; + attachAsync(): Windows.Foundation.IAsyncOperationWithProgress; + pause(): void; + resume(): void; + } + export interface IUploadOperation extends Windows.Networking.BackgroundTransfer.IBackgroundTransferOperation { + progress: Windows.Networking.BackgroundTransfer.BackgroundUploadProgress; + sourceFile: Windows.Storage.IStorageFile; + startAsync(): Windows.Foundation.IAsyncOperationWithProgress; + attachAsync(): Windows.Foundation.IAsyncOperationWithProgress; + } + export interface IBackgroundDownloaderStaticMethods { + getCurrentDownloadsAsync(): Windows.Foundation.IAsyncOperation>; + getCurrentDownloadsAsync(group: string): Windows.Foundation.IAsyncOperation>; + } + export interface IBackgroundUploaderStaticMethods { + getCurrentUploadsAsync(): Windows.Foundation.IAsyncOperation>; + getCurrentUploadsAsync(group: string): Windows.Foundation.IAsyncOperation>; + } + export interface IResponseInformation { + actualUri: Windows.Foundation.Uri; + headers: Windows.Foundation.Collections.IMapView; + isResumable: boolean; + statusCode: number; + } + export interface IBackgroundTransferErrorStaticMethods { + getStatus(hresult: number): Windows.Web.WebErrorStatus; + } + export interface IBackgroundTransferContentPart { + setHeader(headerName: string, headerValue: string): void; + setText(value: string): void; + setFile(value: Windows.Storage.IStorageFile): void; + } + export interface IBackgroundTransferContentPartFactory { + createWithName(name: string): Windows.Networking.BackgroundTransfer.BackgroundTransferContentPart; + createWithNameAndFileName(name: string, fileName: string): Windows.Networking.BackgroundTransfer.BackgroundTransferContentPart; + } + export class BackgroundDownloader implements Windows.Networking.BackgroundTransfer.IBackgroundDownloader, Windows.Networking.BackgroundTransfer.IBackgroundTransferBase { + costPolicy: Windows.Networking.BackgroundTransfer.BackgroundTransferCostPolicy; + group: string; + method: string; + proxyCredential: Windows.Security.Credentials.PasswordCredential; + serverCredential: Windows.Security.Credentials.PasswordCredential; + createDownload(uri: Windows.Foundation.Uri, resultFile: Windows.Storage.IStorageFile): Windows.Networking.BackgroundTransfer.DownloadOperation; + createDownload(uri: Windows.Foundation.Uri, resultFile: Windows.Storage.IStorageFile, requestBodyFile: Windows.Storage.IStorageFile): Windows.Networking.BackgroundTransfer.DownloadOperation; + createDownloadAsync(uri: Windows.Foundation.Uri, resultFile: Windows.Storage.IStorageFile, requestBodyStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncOperation; + setRequestHeader(headerName: string, headerValue: string): void; + static getCurrentDownloadsAsync(): Windows.Foundation.IAsyncOperation>; + static getCurrentDownloadsAsync(group: string): Windows.Foundation.IAsyncOperation>; + } + export class BackgroundUploader implements Windows.Networking.BackgroundTransfer.IBackgroundUploader, Windows.Networking.BackgroundTransfer.IBackgroundTransferBase { + costPolicy: Windows.Networking.BackgroundTransfer.BackgroundTransferCostPolicy; + group: string; + method: string; + proxyCredential: Windows.Security.Credentials.PasswordCredential; + serverCredential: Windows.Security.Credentials.PasswordCredential; + createUpload(uri: Windows.Foundation.Uri, sourceFile: Windows.Storage.IStorageFile): Windows.Networking.BackgroundTransfer.UploadOperation; + createUploadFromStreamAsync(uri: Windows.Foundation.Uri, sourceStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncOperation; + createUploadAsync(uri: Windows.Foundation.Uri, parts: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation; + createUploadAsync(uri: Windows.Foundation.Uri, parts: Windows.Foundation.Collections.IIterable, subType: string): Windows.Foundation.IAsyncOperation; + createUploadAsync(uri: Windows.Foundation.Uri, parts: Windows.Foundation.Collections.IIterable, subType: string, boundary: string): Windows.Foundation.IAsyncOperation; + setRequestHeader(headerName: string, headerValue: string): void; + static getCurrentUploadsAsync(): Windows.Foundation.IAsyncOperation>; + static getCurrentUploadsAsync(group: string): Windows.Foundation.IAsyncOperation>; + } + export class BackgroundTransferError { + static getStatus(hresult: number): Windows.Web.WebErrorStatus; + } + } + } +} +declare module Windows { + export module Networking { + export module Proximity { + export interface IProximityMessage { + data: Windows.Storage.Streams.IBuffer; + dataAsString: string; + messageType: string; + subscriptionId: number; + } + export class ProximityMessage implements Windows.Networking.Proximity.IProximityMessage { + data: Windows.Storage.Streams.IBuffer; + dataAsString: string; + messageType: string; + subscriptionId: number; + } + export interface MessageReceivedHandler { + (sender: Windows.Networking.Proximity.ProximityDevice, message: Windows.Networking.Proximity.ProximityMessage): void; + } + export class ProximityDevice implements Windows.Networking.Proximity.IProximityDevice { + bitsPerSecond: number; + deviceId: string; + maxMessageBytes: number; + subscribeForMessage(messageType: string, messageReceivedHandler: Windows.Networking.Proximity.MessageReceivedHandler): number; + publishMessage(messageType: string, message: string): number; + publishMessage(messageType: string, message: string, messageTransmittedHandler: Windows.Networking.Proximity.MessageTransmittedHandler): number; + publishBinaryMessage(messageType: string, message: Windows.Storage.Streams.IBuffer): number; + publishBinaryMessage(messageType: string, message: Windows.Storage.Streams.IBuffer, messageTransmittedHandler: Windows.Networking.Proximity.MessageTransmittedHandler): number; + publishUriMessage(message: Windows.Foundation.Uri): number; + publishUriMessage(message: Windows.Foundation.Uri, messageTransmittedHandler: Windows.Networking.Proximity.MessageTransmittedHandler): number; + stopSubscribingForMessage(subscriptionId: number): void; + stopPublishingMessage(messageId: number): void; + ondevicearrived: any/* TODO */; + ondevicedeparted: any/* TODO */; + static getDeviceSelector(): string; + static getDefault(): Windows.Networking.Proximity.ProximityDevice; + static fromId(deviceInterfaceId: string): Windows.Networking.Proximity.ProximityDevice; + } + export interface MessageTransmittedHandler { + (sender: Windows.Networking.Proximity.ProximityDevice, messageId: number): void; + } + export interface DeviceArrivedEventHandler { + (sender: Windows.Networking.Proximity.ProximityDevice): void; + } + export interface DeviceDepartedEventHandler { + (sender: Windows.Networking.Proximity.ProximityDevice): void; + } + export interface IProximityDevice { + bitsPerSecond: number; + deviceId: string; + maxMessageBytes: number; + subscribeForMessage(messageType: string, messageReceivedHandler: Windows.Networking.Proximity.MessageReceivedHandler): number; + publishMessage(messageType: string, message: string): number; + publishMessage(messageType: string, message: string, messageTransmittedHandler: Windows.Networking.Proximity.MessageTransmittedHandler): number; + publishBinaryMessage(messageType: string, message: Windows.Storage.Streams.IBuffer): number; + publishBinaryMessage(messageType: string, message: Windows.Storage.Streams.IBuffer, messageTransmittedHandler: Windows.Networking.Proximity.MessageTransmittedHandler): number; + publishUriMessage(message: Windows.Foundation.Uri): number; + publishUriMessage(message: Windows.Foundation.Uri, messageTransmittedHandler: Windows.Networking.Proximity.MessageTransmittedHandler): number; + stopSubscribingForMessage(subscriptionId: number): void; + stopPublishingMessage(messageId: number): void; + ondevicearrived: any/* TODO */; + ondevicedeparted: any/* TODO */; + } + export interface IProximityDeviceStatics { + getDeviceSelector(): string; + getDefault(): Windows.Networking.Proximity.ProximityDevice; + fromId(deviceInterfaceId: string): Windows.Networking.Proximity.ProximityDevice; + } + export enum TriggeredConnectState { + peerFound, + listening, + connecting, + completed, + canceled, + failed, + } + export interface ITriggeredConnectionStateChangedEventArgs { + id: number; + socket: Windows.Networking.Sockets.StreamSocket; + state: Windows.Networking.Proximity.TriggeredConnectState; + } + export class TriggeredConnectionStateChangedEventArgs implements Windows.Networking.Proximity.ITriggeredConnectionStateChangedEventArgs { + id: number; + socket: Windows.Networking.Sockets.StreamSocket; + state: Windows.Networking.Proximity.TriggeredConnectState; + } + export interface IPeerInformation { + displayName: string; + } + export class PeerInformation implements Windows.Networking.Proximity.IPeerInformation { + displayName: string; + } + export interface IConnectionRequestedEventArgs { + peerInformation: Windows.Networking.Proximity.PeerInformation; + } + export class ConnectionRequestedEventArgs implements Windows.Networking.Proximity.IConnectionRequestedEventArgs { + peerInformation: Windows.Networking.Proximity.PeerInformation; + } + export enum PeerDiscoveryTypes { + none, + browse, + triggered, + } + export interface IPeerFinderStatics { + allowBluetooth: boolean; + allowInfrastructure: boolean; + allowWiFiDirect: boolean; + alternateIdentities: Windows.Foundation.Collections.IMap; + displayName: string; + supportedDiscoveryTypes: Windows.Networking.Proximity.PeerDiscoveryTypes; + start(): void; + start(peerMessage: string): void; + stop(): void; + ontriggeredconnectionstatechanged: any/* TODO */; + onconnectionrequested: any/* TODO */; + findAllPeersAsync(): Windows.Foundation.IAsyncOperation>; + connectAsync(peerInformation: Windows.Networking.Proximity.PeerInformation): Windows.Foundation.IAsyncOperation; + } + export class PeerFinder { + static allowBluetooth: boolean; + static allowInfrastructure: boolean; + static allowWiFiDirect: boolean; + static alternateIdentities: Windows.Foundation.Collections.IMap; + static displayName: string; + static supportedDiscoveryTypes: Windows.Networking.Proximity.PeerDiscoveryTypes; + static start(): void; + static start(peerMessage: string): void; + static stop(): void; + static ontriggeredconnectionstatechanged: any/* TODO */; + static onconnectionrequested: any/* TODO */; + static findAllPeersAsync(): Windows.Foundation.IAsyncOperation>; + static connectAsync(peerInformation: Windows.Networking.Proximity.PeerInformation): Windows.Foundation.IAsyncOperation; + } + } + } +} +declare module Windows { + export module Networking { + export module Sockets { + export enum ControlChannelTriggerStatus { + hardwareSlotRequested, + softwareSlotAllocated, + hardwareSlotAllocated, + policyError, + systemError, + transportDisconnected, + serviceUnavailable, + } + export enum ControlChannelTriggerResourceType { + requestSoftwareSlot, + requestHardwareSlot, + } + export enum ControlChannelTriggerResetReason { + fastUserSwitched, + lowPowerExit, + } + export interface IControlChannelTrigger extends Windows.Foundation.IClosable { + controlChannelTriggerId: string; + currentKeepAliveIntervalInMinutes: number; + keepAliveTrigger: Windows.ApplicationModel.Background.IBackgroundTrigger; + pushNotificationTrigger: Windows.ApplicationModel.Background.IBackgroundTrigger; + serverKeepAliveIntervalInMinutes: number; + transportObject: any; + usingTransport(transport: any): void; + waitForPushEnabled(): Windows.Networking.Sockets.ControlChannelTriggerStatus; + decreaseNetworkKeepAliveInterval(): void; + flushTransport(): void; + } + export interface IControlChannelTriggerFactory { + createControlChannelTrigger(channelId: string, serverKeepAliveIntervalInMinutes: number): Windows.Networking.Sockets.ControlChannelTrigger; + createControlChannelTrigger(channelId: string, serverKeepAliveIntervalInMinutes: number, resourceRequestType: Windows.Networking.Sockets.ControlChannelTriggerResourceType): Windows.Networking.Sockets.ControlChannelTrigger; + } + export class ControlChannelTrigger implements Windows.Networking.Sockets.IControlChannelTrigger, Windows.Foundation.IClosable { + constructor(channelId: string, serverKeepAliveIntervalInMinutes: number); + constructor(channelId: string, serverKeepAliveIntervalInMinutes: number, resourceRequestType: Windows.Networking.Sockets.ControlChannelTriggerResourceType); + controlChannelTriggerId: string; + currentKeepAliveIntervalInMinutes: number; + keepAliveTrigger: Windows.ApplicationModel.Background.IBackgroundTrigger; + pushNotificationTrigger: Windows.ApplicationModel.Background.IBackgroundTrigger; + serverKeepAliveIntervalInMinutes: number; + transportObject: any; + usingTransport(transport: any): void; + waitForPushEnabled(): Windows.Networking.Sockets.ControlChannelTriggerStatus; + decreaseNetworkKeepAliveInterval(): void; + flushTransport(): void; + dispose(): void; + close(): void; + } + export interface IControlChannelTriggerEventDetails { + controlChannelTrigger: Windows.Networking.Sockets.ControlChannelTrigger; + } + export interface IControlChannelTriggerResetEventDetails { + hardwareSlotReset: boolean; + resetReason: Windows.Networking.Sockets.ControlChannelTriggerResetReason; + softwareSlotReset: boolean; + } + export enum SocketMessageType { + binary, + utf8, + } + export enum SocketProtectionLevel { + plainSocket, + ssl, + sslAllowNullEncryption, + } + export enum SocketQualityOfService { + normal, + lowLatency, + } + export enum SocketErrorStatus { + unknown, + operationAborted, + httpInvalidServerResponse, + connectionTimedOut, + addressFamilyNotSupported, + socketTypeNotSupported, + hostNotFound, + noDataRecordOfRequestedType, + nonAuthoritativeHostNotFound, + classTypeNotFound, + addressAlreadyInUse, + cannotAssignRequestedAddress, + connectionRefused, + networkIsUnreachable, + unreachableHost, + networkIsDown, + networkDroppedConnectionOnReset, + softwareCausedConnectionAbort, + connectionResetByPeer, + hostIsDown, + noAddressesFound, + tooManyOpenFiles, + messageTooLong, + certificateExpired, + certificateUntrustedRoot, + certificateCommonNameIsIncorrect, + certificateWrongUsage, + certificateRevoked, + certificateNoRevocationCheck, + certificateRevocationServerOffline, + certificateIsInvalid, + } + export interface RoundTripTimeStatistics { + variance: number; + max: number; + min: number; + sum: number; + } + export interface BandwidthStatistics { + outboundBitsPerSecond: number; + inboundBitsPerSecond: number; + outboundBitsPerSecondInstability: number; + inboundBitsPerSecondInstability: number; + outboundBandwidthPeaked: boolean; + inboundBandwidthPeaked: boolean; + } + export interface IDatagramSocketMessageReceivedEventArgs { + localAddress: Windows.Networking.HostName; + remoteAddress: Windows.Networking.HostName; + remotePort: string; + getDataReader(): Windows.Storage.Streams.DataReader; + getDataStream(): Windows.Storage.Streams.IInputStream; + } + export interface IMessageWebSocketMessageReceivedEventArgs { + messageType: Windows.Networking.Sockets.SocketMessageType; + getDataReader(): Windows.Storage.Streams.DataReader; + getDataStream(): Windows.Storage.Streams.IInputStream; + } + export interface IWebSocketClosedEventArgs { + code: number; + reason: string; + } + export interface IDatagramSocketInformation { + localAddress: Windows.Networking.HostName; + localPort: string; + remoteAddress: Windows.Networking.HostName; + remotePort: string; + } + export interface IDatagramSocketControl { + outboundUnicastHopLimit: number; + qualityOfService: Windows.Networking.Sockets.SocketQualityOfService; + } + export interface IDatagramSocketStatics { + getEndpointPairsAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string): Windows.Foundation.IAsyncOperation>; + getEndpointPairsAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string, sortOptions: Windows.Networking.HostNameSortOptions): Windows.Foundation.IAsyncOperation>; + } + export interface IDatagramSocket extends Windows.Foundation.IClosable { + control: Windows.Networking.Sockets.DatagramSocketControl; + information: Windows.Networking.Sockets.DatagramSocketInformation; + outputStream: Windows.Storage.Streams.IOutputStream; + connectAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string): Windows.Foundation.IAsyncAction; + connectAsync(endpointPair: Windows.Networking.EndpointPair): Windows.Foundation.IAsyncAction; + bindServiceNameAsync(localServiceName: string): Windows.Foundation.IAsyncAction; + bindEndpointAsync(localHostName: Windows.Networking.HostName, localServiceName: string): Windows.Foundation.IAsyncAction; + joinMulticastGroup(host: Windows.Networking.HostName): void; + getOutputStreamAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string): Windows.Foundation.IAsyncOperation; + getOutputStreamAsync(endpointPair: Windows.Networking.EndpointPair): Windows.Foundation.IAsyncOperation; + onmessagereceived: any/* TODO */; + } + export class DatagramSocketControl implements Windows.Networking.Sockets.IDatagramSocketControl { + outboundUnicastHopLimit: number; + qualityOfService: Windows.Networking.Sockets.SocketQualityOfService; + } + export class DatagramSocketInformation implements Windows.Networking.Sockets.IDatagramSocketInformation { + localAddress: Windows.Networking.HostName; + localPort: string; + remoteAddress: Windows.Networking.HostName; + remotePort: string; + } + export class DatagramSocket implements Windows.Networking.Sockets.IDatagramSocket, Windows.Foundation.IClosable { + control: Windows.Networking.Sockets.DatagramSocketControl; + information: Windows.Networking.Sockets.DatagramSocketInformation; + outputStream: Windows.Storage.Streams.IOutputStream; + connectAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string): Windows.Foundation.IAsyncAction; + connectAsync(endpointPair: Windows.Networking.EndpointPair): Windows.Foundation.IAsyncAction; + bindServiceNameAsync(localServiceName: string): Windows.Foundation.IAsyncAction; + bindEndpointAsync(localHostName: Windows.Networking.HostName, localServiceName: string): Windows.Foundation.IAsyncAction; + joinMulticastGroup(host: Windows.Networking.HostName): void; + getOutputStreamAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string): Windows.Foundation.IAsyncOperation; + getOutputStreamAsync(endpointPair: Windows.Networking.EndpointPair): Windows.Foundation.IAsyncOperation; + onmessagereceived: any/* TODO */; + dispose(): void; + static getEndpointPairsAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string): Windows.Foundation.IAsyncOperation>; + static getEndpointPairsAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string, sortOptions: Windows.Networking.HostNameSortOptions): Windows.Foundation.IAsyncOperation>; + close(): void; + } + export class DatagramSocketMessageReceivedEventArgs implements Windows.Networking.Sockets.IDatagramSocketMessageReceivedEventArgs { + localAddress: Windows.Networking.HostName; + remoteAddress: Windows.Networking.HostName; + remotePort: string; + getDataReader(): Windows.Storage.Streams.DataReader; + getDataStream(): Windows.Storage.Streams.IInputStream; + } + export interface IStreamSocketInformation { + bandwidthStatistics: Windows.Networking.Sockets.BandwidthStatistics; + localAddress: Windows.Networking.HostName; + localPort: string; + protectionLevel: Windows.Networking.Sockets.SocketProtectionLevel; + remoteAddress: Windows.Networking.HostName; + remoteHostName: Windows.Networking.HostName; + remotePort: string; + remoteServiceName: string; + roundTripTimeStatistics: Windows.Networking.Sockets.RoundTripTimeStatistics; + sessionKey: Windows.Storage.Streams.IBuffer; + } + export interface IStreamSocketControl { + keepAlive: boolean; + noDelay: boolean; + outboundBufferSizeInBytes: number; + outboundUnicastHopLimit: number; + qualityOfService: Windows.Networking.Sockets.SocketQualityOfService; + } + export interface IStreamSocket extends Windows.Foundation.IClosable { + control: Windows.Networking.Sockets.StreamSocketControl; + information: Windows.Networking.Sockets.StreamSocketInformation; + inputStream: Windows.Storage.Streams.IInputStream; + outputStream: Windows.Storage.Streams.IOutputStream; + connectAsync(endpointPair: Windows.Networking.EndpointPair): Windows.Foundation.IAsyncAction; + connectAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string): Windows.Foundation.IAsyncAction; + connectAsync(endpointPair: Windows.Networking.EndpointPair, protectionLevel: Windows.Networking.Sockets.SocketProtectionLevel): Windows.Foundation.IAsyncAction; + connectAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string, protectionLevel: Windows.Networking.Sockets.SocketProtectionLevel): Windows.Foundation.IAsyncAction; + upgradeToSslAsync(protectionLevel: Windows.Networking.Sockets.SocketProtectionLevel, validationHostName: Windows.Networking.HostName): Windows.Foundation.IAsyncAction; + } + export class StreamSocketControl implements Windows.Networking.Sockets.IStreamSocketControl { + keepAlive: boolean; + noDelay: boolean; + outboundBufferSizeInBytes: number; + outboundUnicastHopLimit: number; + qualityOfService: Windows.Networking.Sockets.SocketQualityOfService; + } + export class StreamSocketInformation implements Windows.Networking.Sockets.IStreamSocketInformation { + bandwidthStatistics: Windows.Networking.Sockets.BandwidthStatistics; + localAddress: Windows.Networking.HostName; + localPort: string; + protectionLevel: Windows.Networking.Sockets.SocketProtectionLevel; + remoteAddress: Windows.Networking.HostName; + remoteHostName: Windows.Networking.HostName; + remotePort: string; + remoteServiceName: string; + roundTripTimeStatistics: Windows.Networking.Sockets.RoundTripTimeStatistics; + sessionKey: Windows.Storage.Streams.IBuffer; + } + export interface IStreamSocketListenerControl { + qualityOfService: Windows.Networking.Sockets.SocketQualityOfService; + } + export interface IStreamSocketListenerInformation { + localPort: string; + } + export interface IStreamSocketListenerConnectionReceivedEventArgs { + socket: Windows.Networking.Sockets.StreamSocket; + } + export class StreamSocket implements Windows.Networking.Sockets.IStreamSocket, Windows.Foundation.IClosable { + control: Windows.Networking.Sockets.StreamSocketControl; + information: Windows.Networking.Sockets.StreamSocketInformation; + inputStream: Windows.Storage.Streams.IInputStream; + outputStream: Windows.Storage.Streams.IOutputStream; + connectAsync(endpointPair: Windows.Networking.EndpointPair): Windows.Foundation.IAsyncAction; + connectAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string): Windows.Foundation.IAsyncAction; + connectAsync(endpointPair: Windows.Networking.EndpointPair, protectionLevel: Windows.Networking.Sockets.SocketProtectionLevel): Windows.Foundation.IAsyncAction; + connectAsync(remoteHostName: Windows.Networking.HostName, remoteServiceName: string, protectionLevel: Windows.Networking.Sockets.SocketProtectionLevel): Windows.Foundation.IAsyncAction; + upgradeToSslAsync(protectionLevel: Windows.Networking.Sockets.SocketProtectionLevel, validationHostName: Windows.Networking.HostName): Windows.Foundation.IAsyncAction; + dispose(): void; + close(): void; + } + export interface IStreamSocketListener extends Windows.Foundation.IClosable { + control: Windows.Networking.Sockets.StreamSocketListenerControl; + information: Windows.Networking.Sockets.StreamSocketListenerInformation; + bindServiceNameAsync(localServiceName: string): Windows.Foundation.IAsyncAction; + bindEndpointAsync(localHostName: Windows.Networking.HostName, localServiceName: string): Windows.Foundation.IAsyncAction; + onconnectionreceived: any/* TODO */; + } + export class StreamSocketListenerControl implements Windows.Networking.Sockets.IStreamSocketListenerControl { + qualityOfService: Windows.Networking.Sockets.SocketQualityOfService; + } + export class StreamSocketListenerInformation implements Windows.Networking.Sockets.IStreamSocketListenerInformation { + localPort: string; + } + export class StreamSocketListener implements Windows.Networking.Sockets.IStreamSocketListener, Windows.Foundation.IClosable { + control: Windows.Networking.Sockets.StreamSocketListenerControl; + information: Windows.Networking.Sockets.StreamSocketListenerInformation; + bindServiceNameAsync(localServiceName: string): Windows.Foundation.IAsyncAction; + bindEndpointAsync(localHostName: Windows.Networking.HostName, localServiceName: string): Windows.Foundation.IAsyncAction; + onconnectionreceived: any/* TODO */; + dispose(): void; + close(): void; + } + export class StreamSocketListenerConnectionReceivedEventArgs implements Windows.Networking.Sockets.IStreamSocketListenerConnectionReceivedEventArgs { + socket: Windows.Networking.Sockets.StreamSocket; + } + export interface IWebSocketControl { + outboundBufferSizeInBytes: number; + proxyCredential: Windows.Security.Credentials.PasswordCredential; + serverCredential: Windows.Security.Credentials.PasswordCredential; + supportedProtocols: Windows.Foundation.Collections.IVector; + } + export interface IWebSocketInformation { + bandwidthStatistics: Windows.Networking.Sockets.BandwidthStatistics; + localAddress: Windows.Networking.HostName; + protocol: string; + } + export interface IWebSocket extends Windows.Foundation.IClosable { + outputStream: Windows.Storage.Streams.IOutputStream; + connectAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncAction; + setRequestHeader(headerName: string, headerValue: string): void; + onclosed: any/* TODO */; + close(): void; + close(code: number, reason: string): void; + } + export class WebSocketClosedEventArgs implements Windows.Networking.Sockets.IWebSocketClosedEventArgs { + code: number; + reason: string; + } + export interface IMessageWebSocketControl extends Windows.Networking.Sockets.IWebSocketControl { + maxMessageSize: number; + messageType: Windows.Networking.Sockets.SocketMessageType; + } + export interface IMessageWebSocket extends Windows.Networking.Sockets.IWebSocket, Windows.Foundation.IClosable { + control: Windows.Networking.Sockets.MessageWebSocketControl; + information: Windows.Networking.Sockets.MessageWebSocketInformation; + onmessagereceived: any/* TODO */; + } + export class MessageWebSocketControl implements Windows.Networking.Sockets.IMessageWebSocketControl, Windows.Networking.Sockets.IWebSocketControl { + maxMessageSize: number; + messageType: Windows.Networking.Sockets.SocketMessageType; + outboundBufferSizeInBytes: number; + proxyCredential: Windows.Security.Credentials.PasswordCredential; + serverCredential: Windows.Security.Credentials.PasswordCredential; + supportedProtocols: Windows.Foundation.Collections.IVector; + } + export class MessageWebSocketInformation implements Windows.Networking.Sockets.IWebSocketInformation { + bandwidthStatistics: Windows.Networking.Sockets.BandwidthStatistics; + localAddress: Windows.Networking.HostName; + protocol: string; + } + export class MessageWebSocket implements Windows.Networking.Sockets.IMessageWebSocket, Windows.Networking.Sockets.IWebSocket, Windows.Foundation.IClosable { + control: Windows.Networking.Sockets.MessageWebSocketControl; + information: Windows.Networking.Sockets.MessageWebSocketInformation; + outputStream: Windows.Storage.Streams.IOutputStream; + onmessagereceived: any/* TODO */; + connectAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncAction; + setRequestHeader(headerName: string, headerValue: string): void; + onclosed: any/* TODO */; + close(code: number, reason: string): void; + dispose(): void; + close(): void; + } + export class MessageWebSocketMessageReceivedEventArgs implements Windows.Networking.Sockets.IMessageWebSocketMessageReceivedEventArgs { + messageType: Windows.Networking.Sockets.SocketMessageType; + getDataReader(): Windows.Storage.Streams.DataReader; + getDataStream(): Windows.Storage.Streams.IInputStream; + } + export interface IStreamWebSocketControl extends Windows.Networking.Sockets.IWebSocketControl { + noDelay: boolean; + } + export interface IStreamWebSocket extends Windows.Networking.Sockets.IWebSocket, Windows.Foundation.IClosable { + control: Windows.Networking.Sockets.StreamWebSocketControl; + information: Windows.Networking.Sockets.StreamWebSocketInformation; + inputStream: Windows.Storage.Streams.IInputStream; + } + export class StreamWebSocketControl implements Windows.Networking.Sockets.IStreamWebSocketControl, Windows.Networking.Sockets.IWebSocketControl { + noDelay: boolean; + outboundBufferSizeInBytes: number; + proxyCredential: Windows.Security.Credentials.PasswordCredential; + serverCredential: Windows.Security.Credentials.PasswordCredential; + supportedProtocols: Windows.Foundation.Collections.IVector; + } + export class StreamWebSocketInformation implements Windows.Networking.Sockets.IWebSocketInformation { + bandwidthStatistics: Windows.Networking.Sockets.BandwidthStatistics; + localAddress: Windows.Networking.HostName; + protocol: string; + } + export interface ISocketErrorStatics { + getStatus(hresult: number): Windows.Networking.Sockets.SocketErrorStatus; + } + export interface IWebSocketErrorStatics { + getStatus(hresult: number): Windows.Web.WebErrorStatus; + } + export class StreamWebSocket implements Windows.Networking.Sockets.IStreamWebSocket, Windows.Networking.Sockets.IWebSocket, Windows.Foundation.IClosable { + control: Windows.Networking.Sockets.StreamWebSocketControl; + information: Windows.Networking.Sockets.StreamWebSocketInformation; + inputStream: Windows.Storage.Streams.IInputStream; + outputStream: Windows.Storage.Streams.IOutputStream; + connectAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncAction; + setRequestHeader(headerName: string, headerValue: string): void; + onclosed: any/* TODO */; + close(code: number, reason: string): void; + dispose(): void; + close(): void; + } + export class WebSocketKeepAlive implements Windows.ApplicationModel.Background.IBackgroundTask { + run(taskInstance: Windows.ApplicationModel.Background.IBackgroundTaskInstance): void; + } + export class SocketError { + static getStatus(hresult: number): Windows.Networking.Sockets.SocketErrorStatus; + } + export class WebSocketError { + static getStatus(hresult: number): Windows.Web.WebErrorStatus; + } + } + } +} +declare module Windows { + export module Networking { + export enum HostNameSortOptions { + none, + optimizeForLongConnections, + } + export enum HostNameType { + domainName, + ipv4, + ipv6, + bluetooth, + } + export interface IHostNameStatics { + compare(value1: string, value2: string): number; + } + export interface IHostName { + canonicalName: string; + displayName: string; + iPInformation: Windows.Networking.Connectivity.IPInformation; + rawName: string; + type: Windows.Networking.HostNameType; + isEqual(hostName: Windows.Networking.HostName): boolean; + } + export class HostName implements Windows.Networking.IHostName { + constructor(hostName: string); + canonicalName: string; + displayName: string; + iPInformation: Windows.Networking.Connectivity.IPInformation; + rawName: string; + type: Windows.Networking.HostNameType; + isEqual(hostName: Windows.Networking.HostName): boolean; + static compare(value1: string, value2: string): number; + } + export interface IHostNameFactory { + createHostName(hostName: string): Windows.Networking.HostName; + } + export interface IEndpointPair { + localHostName: Windows.Networking.HostName; + localServiceName: string; + remoteHostName: Windows.Networking.HostName; + remoteServiceName: string; + } + export interface IEndpointPairFactory { + createEndpointPair(localHostName: Windows.Networking.HostName, localServiceName: string, remoteHostName: Windows.Networking.HostName, remoteServiceName: string): Windows.Networking.EndpointPair; + } + export class EndpointPair implements Windows.Networking.IEndpointPair { + constructor(localHostName: Windows.Networking.HostName, localServiceName: string, remoteHostName: Windows.Networking.HostName, remoteServiceName: string); + localHostName: Windows.Networking.HostName; + localServiceName: string; + remoteHostName: Windows.Networking.HostName; + remoteServiceName: string; + } + } +} +declare module Windows { + export module Networking { + export module Connectivity { + export class IPInformation implements Windows.Networking.Connectivity.IIPInformation { + networkAdapter: Windows.Networking.Connectivity.NetworkAdapter; + prefixLength: number; + } + export enum NetworkCostType { + unknown, + unrestricted, + fixed, + variable, + } + export enum NetworkConnectivityLevel { + none, + localAccess, + constrainedInternetAccess, + internetAccess, + } + export enum NetworkTypes { + none, + internet, + privateNetwork, + } + export enum RoamingStates { + none, + notRoaming, + roaming, + } + export enum NetworkAuthenticationType { + none, + unknown, + open80211, + sharedKey80211, + wpa, + wpaPsk, + wpaNone, + rsna, + rsnaPsk, + ihv, + } + export enum NetworkEncryptionType { + none, + unknown, + wep, + wep40, + wep104, + tkip, + ccmp, + wpaUseGroup, + rsnUseGroup, + ihv, + } + export interface IDataUsage { + bytesReceived: number; + bytesSent: number; + } + export interface IDataPlanUsage { + lastSyncTime: Date; + megabytesUsed: number; + } + export interface IDataPlanStatus { + dataLimitInMegabytes: number; + dataPlanUsage: Windows.Networking.Connectivity.DataPlanUsage; + inboundBitsPerSecond: number; + maxTransferSizeInMegabytes: number; + nextBillingCycle: Date; + outboundBitsPerSecond: number; + } + export class DataPlanUsage implements Windows.Networking.Connectivity.IDataPlanUsage { + lastSyncTime: Date; + megabytesUsed: number; + } + export interface IConnectionCost { + approachingDataLimit: boolean; + networkCostType: Windows.Networking.Connectivity.NetworkCostType; + overDataLimit: boolean; + roaming: boolean; + } + export interface INetworkSecuritySettings { + networkAuthenticationType: Windows.Networking.Connectivity.NetworkAuthenticationType; + networkEncryptionType: Windows.Networking.Connectivity.NetworkEncryptionType; + } + export interface IConnectionProfile { + networkAdapter: Windows.Networking.Connectivity.NetworkAdapter; + networkSecuritySettings: Windows.Networking.Connectivity.NetworkSecuritySettings; + profileName: string; + getNetworkConnectivityLevel(): Windows.Networking.Connectivity.NetworkConnectivityLevel; + getNetworkNames(): Windows.Foundation.Collections.IVectorView; + getConnectionCost(): Windows.Networking.Connectivity.ConnectionCost; + getDataPlanStatus(): Windows.Networking.Connectivity.DataPlanStatus; + getLocalUsage(StartTime: Date, EndTime: Date): Windows.Networking.Connectivity.DataUsage; + getLocalUsage(StartTime: Date, EndTime: Date, States: Windows.Networking.Connectivity.RoamingStates): Windows.Networking.Connectivity.DataUsage; + } + export class ConnectionCost implements Windows.Networking.Connectivity.IConnectionCost { + approachingDataLimit: boolean; + networkCostType: Windows.Networking.Connectivity.NetworkCostType; + overDataLimit: boolean; + roaming: boolean; + } + export class DataPlanStatus implements Windows.Networking.Connectivity.IDataPlanStatus { + dataLimitInMegabytes: number; + dataPlanUsage: Windows.Networking.Connectivity.DataPlanUsage; + inboundBitsPerSecond: number; + maxTransferSizeInMegabytes: number; + nextBillingCycle: Date; + outboundBitsPerSecond: number; + } + export class NetworkAdapter implements Windows.Networking.Connectivity.INetworkAdapter { + ianaInterfaceType: number; + inboundMaxBitsPerSecond: number; + networkAdapterId: string; + networkItem: Windows.Networking.Connectivity.NetworkItem; + outboundMaxBitsPerSecond: number; + getConnectedProfileAsync(): Windows.Foundation.IAsyncOperation; + } + export class DataUsage implements Windows.Networking.Connectivity.IDataUsage { + bytesReceived: number; + bytesSent: number; + } + export class NetworkSecuritySettings implements Windows.Networking.Connectivity.INetworkSecuritySettings { + networkAuthenticationType: Windows.Networking.Connectivity.NetworkAuthenticationType; + networkEncryptionType: Windows.Networking.Connectivity.NetworkEncryptionType; + } + export interface ILanIdentifierData { + type: number; + value: Windows.Foundation.Collections.IVectorView; + } + export interface ILanIdentifier { + infrastructureId: Windows.Networking.Connectivity.LanIdentifierData; + networkAdapterId: string; + portId: Windows.Networking.Connectivity.LanIdentifierData; + } + export class LanIdentifierData implements Windows.Networking.Connectivity.ILanIdentifierData { + type: number; + value: Windows.Foundation.Collections.IVectorView; + } + export interface NetworkStatusChangedEventHandler { + (sender: any): void; + } + export interface INetworkInformationStatics { + getConnectionProfiles(): Windows.Foundation.Collections.IVectorView; + getInternetConnectionProfile(): Windows.Networking.Connectivity.ConnectionProfile; + getLanIdentifiers(): Windows.Foundation.Collections.IVectorView; + getHostNames(): Windows.Foundation.Collections.IVectorView; + getProxyConfigurationAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + getSortedEndpointPairs(destinationList: Windows.Foundation.Collections.IIterable, sortOptions: Windows.Networking.HostNameSortOptions): Windows.Foundation.Collections.IVectorView; + onnetworkstatuschanged: any/* TODO */; + } + export class ConnectionProfile implements Windows.Networking.Connectivity.IConnectionProfile { + networkAdapter: Windows.Networking.Connectivity.NetworkAdapter; + networkSecuritySettings: Windows.Networking.Connectivity.NetworkSecuritySettings; + profileName: string; + getNetworkConnectivityLevel(): Windows.Networking.Connectivity.NetworkConnectivityLevel; + getNetworkNames(): Windows.Foundation.Collections.IVectorView; + getConnectionCost(): Windows.Networking.Connectivity.ConnectionCost; + getDataPlanStatus(): Windows.Networking.Connectivity.DataPlanStatus; + getLocalUsage(StartTime: Date, EndTime: Date): Windows.Networking.Connectivity.DataUsage; + getLocalUsage(StartTime: Date, EndTime: Date, States: Windows.Networking.Connectivity.RoamingStates): Windows.Networking.Connectivity.DataUsage; + } + export class LanIdentifier implements Windows.Networking.Connectivity.ILanIdentifier { + infrastructureId: Windows.Networking.Connectivity.LanIdentifierData; + networkAdapterId: string; + portId: Windows.Networking.Connectivity.LanIdentifierData; + } + export class ProxyConfiguration implements Windows.Networking.Connectivity.IProxyConfiguration { + canConnectDirectly: boolean; + proxyUris: Windows.Foundation.Collections.IVectorView; + } + export interface INetworkItem { + networkId: string; + getNetworkTypes(): Windows.Networking.Connectivity.NetworkTypes; + } + export interface INetworkAdapter { + ianaInterfaceType: number; + inboundMaxBitsPerSecond: number; + networkAdapterId: string; + networkItem: Windows.Networking.Connectivity.NetworkItem; + outboundMaxBitsPerSecond: number; + getConnectedProfileAsync(): Windows.Foundation.IAsyncOperation; + } + export class NetworkItem implements Windows.Networking.Connectivity.INetworkItem { + networkId: string; + getNetworkTypes(): Windows.Networking.Connectivity.NetworkTypes; + } + export interface IIPInformation { + networkAdapter: Windows.Networking.Connectivity.NetworkAdapter; + prefixLength: number; + } + export interface IProxyConfiguration { + canConnectDirectly: boolean; + proxyUris: Windows.Foundation.Collections.IVectorView; + } + export class NetworkInformation { + static getConnectionProfiles(): Windows.Foundation.Collections.IVectorView; + static getInternetConnectionProfile(): Windows.Networking.Connectivity.ConnectionProfile; + static getLanIdentifiers(): Windows.Foundation.Collections.IVectorView; + static getHostNames(): Windows.Foundation.Collections.IVectorView; + static getProxyConfigurationAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + static getSortedEndpointPairs(destinationList: Windows.Foundation.Collections.IIterable, sortOptions: Windows.Networking.HostNameSortOptions): Windows.Foundation.Collections.IVectorView; + static onnetworkstatuschanged: any/* TODO */; + } + } + } +} +declare module Windows { + export module Networking { + export module PushNotifications { + export enum PushNotificationType { + toast, + tile, + badge, + raw, + } + export interface IPushNotificationChannelManagerStatics { + createPushNotificationChannelForApplicationAsync(): Windows.Foundation.IAsyncOperation; + createPushNotificationChannelForApplicationAsync(applicationId: string): Windows.Foundation.IAsyncOperation; + createPushNotificationChannelForSecondaryTileAsync(tileId: string): Windows.Foundation.IAsyncOperation; + } + export class PushNotificationChannel implements Windows.Networking.PushNotifications.IPushNotificationChannel { + expirationTime: Date; + uri: string; + close(): void; + onpushnotificationreceived: any/* TODO */; + } + export interface IPushNotificationChannel { + expirationTime: Date; + uri: string; + close(): void; + onpushnotificationreceived: any/* TODO */; + } + export class PushNotificationReceivedEventArgs implements Windows.Networking.PushNotifications.IPushNotificationReceivedEventArgs { + badgeNotification: Windows.UI.Notifications.BadgeNotification; + cancel: boolean; + notificationType: Windows.Networking.PushNotifications.PushNotificationType; + rawNotification: Windows.Networking.PushNotifications.RawNotification; + tileNotification: Windows.UI.Notifications.TileNotification; + toastNotification: Windows.UI.Notifications.ToastNotification; + } + export interface IPushNotificationReceivedEventArgs { + badgeNotification: Windows.UI.Notifications.BadgeNotification; + cancel: boolean; + notificationType: Windows.Networking.PushNotifications.PushNotificationType; + rawNotification: Windows.Networking.PushNotifications.RawNotification; + tileNotification: Windows.UI.Notifications.TileNotification; + toastNotification: Windows.UI.Notifications.ToastNotification; + } + export class RawNotification implements Windows.Networking.PushNotifications.IRawNotification { + content: string; + } + export interface IRawNotification { + content: string; + } + export class PushNotificationChannelManager { + static createPushNotificationChannelForApplicationAsync(): Windows.Foundation.IAsyncOperation; + static createPushNotificationChannelForApplicationAsync(applicationId: string): Windows.Foundation.IAsyncOperation; + static createPushNotificationChannelForSecondaryTileAsync(tileId: string): Windows.Foundation.IAsyncOperation; + } + } + } +} +declare module Windows { + export module Security { + export module Authentication { + export module OnlineId { + export enum CredentialPromptType { + promptIfNeeded, + retypeCredentials, + doNotPrompt, + } + export interface IOnlineIdServiceTicketRequest { + policy: string; + service: string; + } + export interface IOnlineIdServiceTicketRequestFactory { + createOnlineIdServiceTicketRequest(service: string, policy: string): Windows.Security.Authentication.OnlineId.OnlineIdServiceTicketRequest; + createOnlineIdServiceTicketRequest(service: string): Windows.Security.Authentication.OnlineId.OnlineIdServiceTicketRequest; + } + export class OnlineIdServiceTicketRequest implements Windows.Security.Authentication.OnlineId.IOnlineIdServiceTicketRequest { + constructor(service: string, policy: string); + constructor(service: string); + policy: string; + service: string; + } + export interface IOnlineIdServiceTicket { + errorCode: number; + request: Windows.Security.Authentication.OnlineId.OnlineIdServiceTicketRequest; + value: string; + } + export interface IUserIdentity { + firstName: string; + id: string; + isBetaAccount: boolean; + isConfirmedPC: boolean; + lastName: string; + safeCustomerId: string; + signInName: string; + tickets: Windows.Foundation.Collections.IVectorView; + } + export class OnlineIdServiceTicket implements Windows.Security.Authentication.OnlineId.IOnlineIdServiceTicket { + errorCode: number; + request: Windows.Security.Authentication.OnlineId.OnlineIdServiceTicketRequest; + value: string; + } + export interface IOnlineIdAuthenticator { + applicationId: string; + authenticatedSafeCustomerId: string; + canSignOut: boolean; + authenticateUserAsync(request: Windows.Security.Authentication.OnlineId.OnlineIdServiceTicketRequest): Windows.Security.Authentication.OnlineId.UserAuthenticationOperation; + authenticateUserAsync(requests: Windows.Foundation.Collections.IIterable, credentialPromptType: Windows.Security.Authentication.OnlineId.CredentialPromptType): Windows.Security.Authentication.OnlineId.UserAuthenticationOperation; + signOutUserAsync(): Windows.Security.Authentication.OnlineId.SignOutUserOperation; + } + export class UserAuthenticationOperation implements Windows.Foundation.IAsyncOperation, Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + getResults(): Windows.Security.Authentication.OnlineId.UserIdentity; + cancel(): void; + close(): void; + then(success?: (value: Windows.Security.Authentication.OnlineId.UserIdentity) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Security.Authentication.OnlineId.UserIdentity) => Windows.Foundation.IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Security.Authentication.OnlineId.UserIdentity) => U, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: Windows.Security.Authentication.OnlineId.UserIdentity) => Windows.Foundation.IPromise, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done(success?: (value: Windows.Security.Authentication.OnlineId.UserIdentity) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + operation: { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + getResults(): Windows.Security.Authentication.OnlineId.UserIdentity; + } + } + export class SignOutUserOperation implements Windows.Foundation.IAsyncAction, Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncActionCompletedHandler; + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + getResults(): void; + cancel(): void; + close(): void; + then(success: (value: any) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success: (value: any) => Windows.Foundation.IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success: (value: any) => U, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success: (value: any) => Windows.Foundation.IPromise, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done(success: (value: any) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + operation: { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + getResults(): any; + } + } + export class UserIdentity implements Windows.Security.Authentication.OnlineId.IUserIdentity { + firstName: string; + id: string; + isBetaAccount: boolean; + isConfirmedPC: boolean; + lastName: string; + safeCustomerId: string; + signInName: string; + tickets: Windows.Foundation.Collections.IVectorView; + } + export class OnlineIdAuthenticator implements Windows.Security.Authentication.OnlineId.IOnlineIdAuthenticator { + applicationId: string; + authenticatedSafeCustomerId: string; + canSignOut: boolean; + authenticateUserAsync(request: Windows.Security.Authentication.OnlineId.OnlineIdServiceTicketRequest): Windows.Security.Authentication.OnlineId.UserAuthenticationOperation; + authenticateUserAsync(requests: Windows.Foundation.Collections.IIterable, credentialPromptType: Windows.Security.Authentication.OnlineId.CredentialPromptType): Windows.Security.Authentication.OnlineId.UserAuthenticationOperation; + signOutUserAsync(): Windows.Security.Authentication.OnlineId.SignOutUserOperation; + } + } + } + } +} +declare module Windows { + export module Security { + export module Authentication { + export module Web { + export enum WebAuthenticationStatus { + success, + userCancel, + errorHttp, + } + export enum WebAuthenticationOptions { + none, + silentMode, + useTitle, + useHttpPost, + useCorporateNetwork, + } + export interface IWebAuthenticationResult { + responseData: string; + responseErrorDetail: number; + responseStatus: Windows.Security.Authentication.Web.WebAuthenticationStatus; + } + export class WebAuthenticationResult implements Windows.Security.Authentication.Web.IWebAuthenticationResult { + responseData: string; + responseErrorDetail: number; + responseStatus: Windows.Security.Authentication.Web.WebAuthenticationStatus; + } + export interface IWebAuthenticationBrokerStatics { + authenticateAsync(options: Windows.Security.Authentication.Web.WebAuthenticationOptions, requestUri: Windows.Foundation.Uri, callbackUri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + authenticateAsync(options: Windows.Security.Authentication.Web.WebAuthenticationOptions, requestUri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + getCurrentApplicationCallbackUri(): Windows.Foundation.Uri; + } + export class WebAuthenticationBroker { + static authenticateAsync(options: Windows.Security.Authentication.Web.WebAuthenticationOptions, requestUri: Windows.Foundation.Uri, callbackUri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + static authenticateAsync(options: Windows.Security.Authentication.Web.WebAuthenticationOptions, requestUri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + static getCurrentApplicationCallbackUri(): Windows.Foundation.Uri; + } + } + } + } +} +declare module Windows { + export module Security { + export module Credentials { + export module UI { + export enum AuthenticationProtocol { + basic, + digest, + ntlm, + kerberos, + negotiate, + credSsp, + custom, + } + export enum CredentialSaveOption { + unselected, + selected, + hidden, + } + export interface ICredentialPickerOptions { + alwaysDisplayDialog: boolean; + authenticationProtocol: Windows.Security.Credentials.UI.AuthenticationProtocol; + callerSavesCredential: boolean; + caption: string; + credentialSaveOption: Windows.Security.Credentials.UI.CredentialSaveOption; + customAuthenticationProtocol: string; + errorCode: number; + message: string; + previousCredential: Windows.Storage.Streams.IBuffer; + targetName: string; + } + export class CredentialPickerOptions implements Windows.Security.Credentials.UI.ICredentialPickerOptions { + alwaysDisplayDialog: boolean; + authenticationProtocol: Windows.Security.Credentials.UI.AuthenticationProtocol; + callerSavesCredential: boolean; + caption: string; + credentialSaveOption: Windows.Security.Credentials.UI.CredentialSaveOption; + customAuthenticationProtocol: string; + errorCode: number; + message: string; + previousCredential: Windows.Storage.Streams.IBuffer; + targetName: string; + } + export interface ICredentialPickerStatics { + pickAsync(options: Windows.Security.Credentials.UI.CredentialPickerOptions): Windows.Foundation.IAsyncOperation; + pickAsync(targetName: string, message: string): Windows.Foundation.IAsyncOperation; + pickAsync(targetName: string, message: string, caption: string): Windows.Foundation.IAsyncOperation; + } + export class CredentialPickerResults implements Windows.Security.Credentials.UI.ICredentialPickerResults { + credential: Windows.Storage.Streams.IBuffer; + credentialDomainName: string; + credentialPassword: string; + credentialSaveOption: Windows.Security.Credentials.UI.CredentialSaveOption; + credentialSaved: boolean; + credentialUserName: string; + errorCode: number; + } + export class CredentialPicker { + static pickAsync(options: Windows.Security.Credentials.UI.CredentialPickerOptions): Windows.Foundation.IAsyncOperation; + static pickAsync(targetName: string, message: string): Windows.Foundation.IAsyncOperation; + static pickAsync(targetName: string, message: string, caption: string): Windows.Foundation.IAsyncOperation; + } + export interface ICredentialPickerResults { + credential: Windows.Storage.Streams.IBuffer; + credentialDomainName: string; + credentialPassword: string; + credentialSaveOption: Windows.Security.Credentials.UI.CredentialSaveOption; + credentialSaved: boolean; + credentialUserName: string; + errorCode: number; + } + } + } + } +} +declare module Windows { + export module Security { + export module Credentials { + export interface IPasswordCredential { + password: string; + properties: Windows.Foundation.Collections.IPropertySet; + resource: string; + userName: string; + retrievePassword(): void; + } + export class PasswordCredential implements Windows.Security.Credentials.IPasswordCredential { + constructor(resource: string, userName: string, password: string); + constructor(); + password: string; + properties: Windows.Foundation.Collections.IPropertySet; + resource: string; + userName: string; + retrievePassword(): void; + } + export interface ICredentialFactory { + createPasswordCredential(resource: string, userName: string, password: string): Windows.Security.Credentials.PasswordCredential; + } + export interface IPasswordVault { + add(credential: Windows.Security.Credentials.PasswordCredential): void; + remove(credential: Windows.Security.Credentials.PasswordCredential): void; + retrieve(resource: string, userName: string): Windows.Security.Credentials.PasswordCredential; + findAllByResource(resource: string): Windows.Foundation.Collections.IVectorView; + findAllByUserName(userName: string): Windows.Foundation.Collections.IVectorView; + retrieveAll(): Windows.Foundation.Collections.IVectorView; + } + export class PasswordVault implements Windows.Security.Credentials.IPasswordVault { + add(credential: Windows.Security.Credentials.PasswordCredential): void; + remove(credential: Windows.Security.Credentials.PasswordCredential): void; + retrieve(resource: string, userName: string): Windows.Security.Credentials.PasswordCredential; + findAllByResource(resource: string): Windows.Foundation.Collections.IVectorView; + findAllByUserName(userName: string): Windows.Foundation.Collections.IVectorView; + retrieveAll(): Windows.Foundation.Collections.IVectorView; + } + export class PasswordCredentialPropertyStore implements Windows.Foundation.Collections.IPropertySet, Windows.Foundation.Collections.IObservableMap, Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + size: number; + onmapchanged: any/* TODO */; + lookup(key: string): any; + hasKey(key: string): boolean; + getView(): Windows.Foundation.Collections.IMapView; + insert(key: string, value: any): boolean; + remove(key: string): void; + clear(): void; + first(): Windows.Foundation.Collections.IIterator>; + } + } + } +} +declare module Windows { + export module Security { + export module Cryptography { + export module Certificates { + export enum EnrollKeyUsages { + none, + decryption, + signing, + keyAgreement, + all, + } + export enum KeyProtectionLevel { + noConsent, + consentOnly, + consentWithPassword, + } + export enum ExportOption { + notExportable, + exportable, + } + export enum KeySize { + invalid, + rsa2048, + rsa4096, + } + export enum InstallOptions { + none, + deleteExpired, + } + export interface ICertificateRequestProperties { + exportable: Windows.Security.Cryptography.Certificates.ExportOption; + friendlyName: string; + hashAlgorithmName: string; + keyAlgorithmName: string; + keyProtectionLevel: Windows.Security.Cryptography.Certificates.KeyProtectionLevel; + keySize: number; + keyStorageProviderName: string; + keyUsages: Windows.Security.Cryptography.Certificates.EnrollKeyUsages; + subject: string; + } + export class CertificateRequestProperties implements Windows.Security.Cryptography.Certificates.ICertificateRequestProperties { + exportable: Windows.Security.Cryptography.Certificates.ExportOption; + friendlyName: string; + hashAlgorithmName: string; + keyAlgorithmName: string; + keyProtectionLevel: Windows.Security.Cryptography.Certificates.KeyProtectionLevel; + keySize: number; + keyStorageProviderName: string; + keyUsages: Windows.Security.Cryptography.Certificates.EnrollKeyUsages; + subject: string; + } + export interface ICertificateEnrollmentManagerStatics { + createRequestAsync(request: Windows.Security.Cryptography.Certificates.CertificateRequestProperties): Windows.Foundation.IAsyncOperation; + installCertificateAsync(certificate: string, installOption: Windows.Security.Cryptography.Certificates.InstallOptions): Windows.Foundation.IAsyncAction; + importPfxDataAsync(pfxData: string, password: string, exportable: Windows.Security.Cryptography.Certificates.ExportOption, keyProtectionLevel: Windows.Security.Cryptography.Certificates.KeyProtectionLevel, installOption: Windows.Security.Cryptography.Certificates.InstallOptions, friendlyName: string): Windows.Foundation.IAsyncAction; + } + export class CertificateEnrollmentManager { + static createRequestAsync(request: Windows.Security.Cryptography.Certificates.CertificateRequestProperties): Windows.Foundation.IAsyncOperation; + static installCertificateAsync(certificate: string, installOption: Windows.Security.Cryptography.Certificates.InstallOptions): Windows.Foundation.IAsyncAction; + static importPfxDataAsync(pfxData: string, password: string, exportable: Windows.Security.Cryptography.Certificates.ExportOption, keyProtectionLevel: Windows.Security.Cryptography.Certificates.KeyProtectionLevel, installOption: Windows.Security.Cryptography.Certificates.InstallOptions, friendlyName: string): Windows.Foundation.IAsyncAction; + } + export interface IKeyAlgorithmNamesStatics { + dsa: string; + ecdh256: string; + ecdh384: string; + ecdh521: string; + ecdsa256: string; + ecdsa384: string; + ecdsa521: string; + rsa: string; + } + export class KeyAlgorithmNames { + static dsa: string; + static ecdh256: string; + static ecdh384: string; + static ecdh521: string; + static ecdsa256: string; + static ecdsa384: string; + static ecdsa521: string; + static rsa: string; + } + export interface IKeyStorageProviderNamesStatics { + platformKeyStorageProvider: string; + smartcardKeyStorageProvider: string; + softwareKeyStorageProvider: string; + } + export class KeyStorageProviderNames { + static platformKeyStorageProvider: string; + static smartcardKeyStorageProvider: string; + static softwareKeyStorageProvider: string; + } + } + } + } +} +declare module Windows { + export module Security { + export module Cryptography { + export module Core { + export enum CryptographicPrivateKeyBlobType { + pkcs8RawPrivateKeyInfo, + pkcs1RsaPrivateKey, + bCryptPrivateKey, + capi1PrivateKey, + } + export enum CryptographicPublicKeyBlobType { + x509SubjectPublicKeyInfo, + pkcs1RsaPublicKey, + bCryptPublicKey, + capi1PublicKey, + } + export interface IKeyDerivationParameters { + iterationCount: number; + kdfGenericBinary: Windows.Storage.Streams.IBuffer; + } + export interface IKeyDerivationParametersStatics { + buildForPbkdf2(pbkdf2Salt: Windows.Storage.Streams.IBuffer, iterationCount: number): Windows.Security.Cryptography.Core.KeyDerivationParameters; + buildForSP800108(label: Windows.Storage.Streams.IBuffer, context: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.KeyDerivationParameters; + buildForSP80056a(algorithmId: Windows.Storage.Streams.IBuffer, partyUInfo: Windows.Storage.Streams.IBuffer, partyVInfo: Windows.Storage.Streams.IBuffer, suppPubInfo: Windows.Storage.Streams.IBuffer, suppPrivInfo: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.KeyDerivationParameters; + } + export class KeyDerivationParameters implements Windows.Security.Cryptography.Core.IKeyDerivationParameters { + iterationCount: number; + kdfGenericBinary: Windows.Storage.Streams.IBuffer; + static buildForPbkdf2(pbkdf2Salt: Windows.Storage.Streams.IBuffer, iterationCount: number): Windows.Security.Cryptography.Core.KeyDerivationParameters; + static buildForSP800108(label: Windows.Storage.Streams.IBuffer, context: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.KeyDerivationParameters; + static buildForSP80056a(algorithmId: Windows.Storage.Streams.IBuffer, partyUInfo: Windows.Storage.Streams.IBuffer, partyVInfo: Windows.Storage.Streams.IBuffer, suppPubInfo: Windows.Storage.Streams.IBuffer, suppPrivInfo: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.KeyDerivationParameters; + } + export interface ICryptographicKey { + keySize: number; + export(): Windows.Storage.Streams.IBuffer; + export(BlobType: Windows.Security.Cryptography.Core.CryptographicPrivateKeyBlobType): Windows.Storage.Streams.IBuffer; + exportPublicKey(): Windows.Storage.Streams.IBuffer; + exportPublicKey(BlobType: Windows.Security.Cryptography.Core.CryptographicPublicKeyBlobType): Windows.Storage.Streams.IBuffer; + } + export class CryptographicKey implements Windows.Security.Cryptography.Core.ICryptographicKey { + keySize: number; + export(): Windows.Storage.Streams.IBuffer; + export(BlobType: Windows.Security.Cryptography.Core.CryptographicPrivateKeyBlobType): Windows.Storage.Streams.IBuffer; + exportPublicKey(): Windows.Storage.Streams.IBuffer; + exportPublicKey(BlobType: Windows.Security.Cryptography.Core.CryptographicPublicKeyBlobType): Windows.Storage.Streams.IBuffer; + } + export interface IHashComputation { + append(data: Windows.Storage.Streams.IBuffer): void; + getValueAndReset(): Windows.Storage.Streams.IBuffer; + } + export class CryptographicHash implements Windows.Security.Cryptography.Core.IHashComputation { + append(data: Windows.Storage.Streams.IBuffer): void; + getValueAndReset(): Windows.Storage.Streams.IBuffer; + } + export interface IHashAlgorithmProvider { + algorithmName: string; + hashLength: number; + hashData(data: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.IBuffer; + createHash(): Windows.Security.Cryptography.Core.CryptographicHash; + } + export interface IMacAlgorithmProvider { + algorithmName: string; + macLength: number; + createKey(keyMaterial: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.CryptographicKey; + } + export interface IKeyDerivationAlgorithmProvider { + algorithmName: string; + createKey(keyMaterial: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.CryptographicKey; + } + export interface ISymmetricKeyAlgorithmProvider { + algorithmName: string; + blockLength: number; + createSymmetricKey(keyMaterial: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.CryptographicKey; + } + export interface IAsymmetricKeyAlgorithmProvider { + algorithmName: string; + createKeyPair(keySize: number): Windows.Security.Cryptography.Core.CryptographicKey; + importKeyPair(keyBlob: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.CryptographicKey; + importKeyPair(keyBlob: Windows.Storage.Streams.IBuffer, BlobType: Windows.Security.Cryptography.Core.CryptographicPrivateKeyBlobType): Windows.Security.Cryptography.Core.CryptographicKey; + importPublicKey(keyBlob: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.CryptographicKey; + importPublicKey(keyBlob: Windows.Storage.Streams.IBuffer, BlobType: Windows.Security.Cryptography.Core.CryptographicPublicKeyBlobType): Windows.Security.Cryptography.Core.CryptographicKey; + } + export interface IEncryptedAndAuthenticatedData { + authenticationTag: Windows.Storage.Streams.IBuffer; + encryptedData: Windows.Storage.Streams.IBuffer; + } + export class EncryptedAndAuthenticatedData implements Windows.Security.Cryptography.Core.IEncryptedAndAuthenticatedData { + authenticationTag: Windows.Storage.Streams.IBuffer; + encryptedData: Windows.Storage.Streams.IBuffer; + } + export interface ICryptographicEngineStatics { + encrypt(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer, iv: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.IBuffer; + decrypt(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer, iv: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.IBuffer; + encryptAndAuthenticate(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer, nonce: Windows.Storage.Streams.IBuffer, authenticatedData: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.EncryptedAndAuthenticatedData; + decryptAndAuthenticate(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer, nonce: Windows.Storage.Streams.IBuffer, authenticationTag: Windows.Storage.Streams.IBuffer, authenticatedData: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.IBuffer; + sign(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.IBuffer; + verifySignature(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer, signature: Windows.Storage.Streams.IBuffer): boolean; + deriveKeyMaterial(key: Windows.Security.Cryptography.Core.CryptographicKey, parameters: Windows.Security.Cryptography.Core.KeyDerivationParameters, desiredKeySize: number): Windows.Storage.Streams.IBuffer; + } + export class CryptographicEngine { + static encrypt(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer, iv: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.IBuffer; + static decrypt(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer, iv: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.IBuffer; + static encryptAndAuthenticate(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer, nonce: Windows.Storage.Streams.IBuffer, authenticatedData: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.EncryptedAndAuthenticatedData; + static decryptAndAuthenticate(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer, nonce: Windows.Storage.Streams.IBuffer, authenticationTag: Windows.Storage.Streams.IBuffer, authenticatedData: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.IBuffer; + static sign(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.IBuffer; + static verifySignature(key: Windows.Security.Cryptography.Core.CryptographicKey, data: Windows.Storage.Streams.IBuffer, signature: Windows.Storage.Streams.IBuffer): boolean; + static deriveKeyMaterial(key: Windows.Security.Cryptography.Core.CryptographicKey, parameters: Windows.Security.Cryptography.Core.KeyDerivationParameters, desiredKeySize: number): Windows.Storage.Streams.IBuffer; + } + export interface IHashAlgorithmProviderStatics { + openAlgorithm(algorithm: string): Windows.Security.Cryptography.Core.HashAlgorithmProvider; + } + export class HashAlgorithmProvider implements Windows.Security.Cryptography.Core.IHashAlgorithmProvider { + algorithmName: string; + hashLength: number; + hashData(data: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.IBuffer; + createHash(): Windows.Security.Cryptography.Core.CryptographicHash; + static openAlgorithm(algorithm: string): Windows.Security.Cryptography.Core.HashAlgorithmProvider; + } + export interface IMacAlgorithmProviderStatics { + openAlgorithm(algorithm: string): Windows.Security.Cryptography.Core.MacAlgorithmProvider; + } + export class MacAlgorithmProvider implements Windows.Security.Cryptography.Core.IMacAlgorithmProvider { + algorithmName: string; + macLength: number; + createKey(keyMaterial: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.CryptographicKey; + static openAlgorithm(algorithm: string): Windows.Security.Cryptography.Core.MacAlgorithmProvider; + } + export interface IKeyDerivationAlgorithmProviderStatics { + openAlgorithm(algorithm: string): Windows.Security.Cryptography.Core.KeyDerivationAlgorithmProvider; + } + export class KeyDerivationAlgorithmProvider implements Windows.Security.Cryptography.Core.IKeyDerivationAlgorithmProvider { + algorithmName: string; + createKey(keyMaterial: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.CryptographicKey; + static openAlgorithm(algorithm: string): Windows.Security.Cryptography.Core.KeyDerivationAlgorithmProvider; + } + export interface ISymmetricKeyAlgorithmProviderStatics { + openAlgorithm(algorithm: string): Windows.Security.Cryptography.Core.SymmetricKeyAlgorithmProvider; + } + export class SymmetricKeyAlgorithmProvider implements Windows.Security.Cryptography.Core.ISymmetricKeyAlgorithmProvider { + algorithmName: string; + blockLength: number; + createSymmetricKey(keyMaterial: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.CryptographicKey; + static openAlgorithm(algorithm: string): Windows.Security.Cryptography.Core.SymmetricKeyAlgorithmProvider; + } + export interface IAsymmetricKeyAlgorithmProviderStatics { + openAlgorithm(algorithm: string): Windows.Security.Cryptography.Core.AsymmetricKeyAlgorithmProvider; + } + export class AsymmetricKeyAlgorithmProvider implements Windows.Security.Cryptography.Core.IAsymmetricKeyAlgorithmProvider { + algorithmName: string; + createKeyPair(keySize: number): Windows.Security.Cryptography.Core.CryptographicKey; + importKeyPair(keyBlob: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.CryptographicKey; + importKeyPair(keyBlob: Windows.Storage.Streams.IBuffer, BlobType: Windows.Security.Cryptography.Core.CryptographicPrivateKeyBlobType): Windows.Security.Cryptography.Core.CryptographicKey; + importPublicKey(keyBlob: Windows.Storage.Streams.IBuffer): Windows.Security.Cryptography.Core.CryptographicKey; + importPublicKey(keyBlob: Windows.Storage.Streams.IBuffer, BlobType: Windows.Security.Cryptography.Core.CryptographicPublicKeyBlobType): Windows.Security.Cryptography.Core.CryptographicKey; + static openAlgorithm(algorithm: string): Windows.Security.Cryptography.Core.AsymmetricKeyAlgorithmProvider; + } + export interface IHashAlgorithmNamesStatics { + md5: string; + sha1: string; + sha256: string; + sha384: string; + sha512: string; + } + export class HashAlgorithmNames { + static md5: string; + static sha1: string; + static sha256: string; + static sha384: string; + static sha512: string; + } + export interface IMacAlgorithmNamesStatics { + aesCmac: string; + hmacMd5: string; + hmacSha1: string; + hmacSha256: string; + hmacSha384: string; + hmacSha512: string; + } + export class MacAlgorithmNames { + static aesCmac: string; + static hmacMd5: string; + static hmacSha1: string; + static hmacSha256: string; + static hmacSha384: string; + static hmacSha512: string; + } + export interface ISymmetricAlgorithmNamesStatics { + aesCbc: string; + aesCbcPkcs7: string; + aesCcm: string; + aesEcb: string; + aesEcbPkcs7: string; + aesGcm: string; + desCbc: string; + desCbcPkcs7: string; + desEcb: string; + desEcbPkcs7: string; + rc2Cbc: string; + rc2CbcPkcs7: string; + rc2Ecb: string; + rc2EcbPkcs7: string; + rc4: string; + tripleDesCbc: string; + tripleDesCbcPkcs7: string; + tripleDesEcb: string; + tripleDesEcbPkcs7: string; + } + export class SymmetricAlgorithmNames { + static aesCbc: string; + static aesCbcPkcs7: string; + static aesCcm: string; + static aesEcb: string; + static aesEcbPkcs7: string; + static aesGcm: string; + static desCbc: string; + static desCbcPkcs7: string; + static desEcb: string; + static desEcbPkcs7: string; + static rc2Cbc: string; + static rc2CbcPkcs7: string; + static rc2Ecb: string; + static rc2EcbPkcs7: string; + static rc4: string; + static tripleDesCbc: string; + static tripleDesCbcPkcs7: string; + static tripleDesEcb: string; + static tripleDesEcbPkcs7: string; + } + export interface IAsymmetricAlgorithmNamesStatics { + dsaSha1: string; + dsaSha256: string; + ecdsaP256Sha256: string; + ecdsaP384Sha384: string; + ecdsaP521Sha512: string; + rsaOaepSha1: string; + rsaOaepSha256: string; + rsaOaepSha384: string; + rsaOaepSha512: string; + rsaPkcs1: string; + rsaSignPkcs1Sha1: string; + rsaSignPkcs1Sha256: string; + rsaSignPkcs1Sha384: string; + rsaSignPkcs1Sha512: string; + rsaSignPssSha1: string; + rsaSignPssSha256: string; + rsaSignPssSha384: string; + rsaSignPssSha512: string; + } + export class AsymmetricAlgorithmNames { + static dsaSha1: string; + static dsaSha256: string; + static ecdsaP256Sha256: string; + static ecdsaP384Sha384: string; + static ecdsaP521Sha512: string; + static rsaOaepSha1: string; + static rsaOaepSha256: string; + static rsaOaepSha384: string; + static rsaOaepSha512: string; + static rsaPkcs1: string; + static rsaSignPkcs1Sha1: string; + static rsaSignPkcs1Sha256: string; + static rsaSignPkcs1Sha384: string; + static rsaSignPkcs1Sha512: string; + static rsaSignPssSha1: string; + static rsaSignPssSha256: string; + static rsaSignPssSha384: string; + static rsaSignPssSha512: string; + } + export interface IKeyDerivationAlgorithmNamesStatics { + pbkdf2Md5: string; + pbkdf2Sha1: string; + pbkdf2Sha256: string; + pbkdf2Sha384: string; + pbkdf2Sha512: string; + sp800108CtrHmacMd5: string; + sp800108CtrHmacSha1: string; + sp800108CtrHmacSha256: string; + sp800108CtrHmacSha384: string; + sp800108CtrHmacSha512: string; + sp80056aConcatMd5: string; + sp80056aConcatSha1: string; + sp80056aConcatSha256: string; + sp80056aConcatSha384: string; + sp80056aConcatSha512: string; + } + export class KeyDerivationAlgorithmNames { + static pbkdf2Md5: string; + static pbkdf2Sha1: string; + static pbkdf2Sha256: string; + static pbkdf2Sha384: string; + static pbkdf2Sha512: string; + static sp800108CtrHmacMd5: string; + static sp800108CtrHmacSha1: string; + static sp800108CtrHmacSha256: string; + static sp800108CtrHmacSha384: string; + static sp800108CtrHmacSha512: string; + static sp80056aConcatMd5: string; + static sp80056aConcatSha1: string; + static sp80056aConcatSha256: string; + static sp80056aConcatSha384: string; + static sp80056aConcatSha512: string; + } + } + } + } +} +declare module Windows { + export module Security { + export module Cryptography { + export module DataProtection { + export interface IDataProtectionProvider { + protectAsync(data: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperation; + unprotectAsync(data: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperation; + protectStreamAsync(src: Windows.Storage.Streams.IInputStream, dest: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncAction; + unprotectStreamAsync(src: Windows.Storage.Streams.IInputStream, dest: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncAction; + } + export interface IDataProtectionProviderFactory { + createOverloadExplicit(protectionDescriptor: string): Windows.Security.Cryptography.DataProtection.DataProtectionProvider; + } + export class DataProtectionProvider implements Windows.Security.Cryptography.DataProtection.IDataProtectionProvider { + constructor(protectionDescriptor: string); + constructor(); + protectAsync(data: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperation; + unprotectAsync(data: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperation; + protectStreamAsync(src: Windows.Storage.Streams.IInputStream, dest: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncAction; + unprotectStreamAsync(src: Windows.Storage.Streams.IInputStream, dest: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncAction; + } + } + } + } +} +declare module Windows { + export module Security { + export module Cryptography { + export enum BinaryStringEncoding { + utf8, + utf16LE, + utf16BE, + } + export interface ICryptographicBufferStatics { + compare(object1: Windows.Storage.Streams.IBuffer, object2: Windows.Storage.Streams.IBuffer): boolean; + generateRandom(length: number): Windows.Storage.Streams.IBuffer; + generateRandomNumber(): number; + createFromByteArray(value: Uint8Array): Windows.Storage.Streams.IBuffer; + copyToByteArray(buffer: Windows.Storage.Streams.IBuffer): Uint8Array; + decodeFromHexString(value: string): Windows.Storage.Streams.IBuffer; + encodeToHexString(buffer: Windows.Storage.Streams.IBuffer): string; + decodeFromBase64String(value: string): Windows.Storage.Streams.IBuffer; + encodeToBase64String(buffer: Windows.Storage.Streams.IBuffer): string; + convertStringToBinary(value: string, encoding: Windows.Security.Cryptography.BinaryStringEncoding): Windows.Storage.Streams.IBuffer; + convertBinaryToString(encoding: Windows.Security.Cryptography.BinaryStringEncoding, buffer: Windows.Storage.Streams.IBuffer): string; + } + export class CryptographicBuffer { + static compare(object1: Windows.Storage.Streams.IBuffer, object2: Windows.Storage.Streams.IBuffer): boolean; + static generateRandom(length: number): Windows.Storage.Streams.IBuffer; + static generateRandomNumber(): number; + static createFromByteArray(value: Uint8Array): Windows.Storage.Streams.IBuffer; + static copyToByteArray(buffer: Windows.Storage.Streams.IBuffer): Uint8Array; + static decodeFromHexString(value: string): Windows.Storage.Streams.IBuffer; + static encodeToHexString(buffer: Windows.Storage.Streams.IBuffer): string; + static decodeFromBase64String(value: string): Windows.Storage.Streams.IBuffer; + static encodeToBase64String(buffer: Windows.Storage.Streams.IBuffer): string; + static convertStringToBinary(value: string, encoding: Windows.Security.Cryptography.BinaryStringEncoding): Windows.Storage.Streams.IBuffer; + static convertBinaryToString(encoding: Windows.Security.Cryptography.BinaryStringEncoding, buffer: Windows.Storage.Streams.IBuffer): string; + } + } + } +} +declare module Windows { + export module Security { + export module ExchangeActiveSyncProvisioning { + export enum EasRequireEncryptionResult { + notEvaluated, + compliant, + canBeCompliant, + notProvisionedOnAllVolumes, + deFixedDataNotSupported, + deHardwareNotCompliant, + deWinReNotConfigured, + deProtectionSuspended, + deOsVolumeNotProtected, + deProtectionNotYetEnabled, + noFeatureLicense, + osNotProtected, + } + export enum EasMinPasswordLengthResult { + notEvaluated, + compliant, + canBeCompliant, + requestedPolicyIsStricter, + requestedPolicyNotEnforceable, + invalidParameter, + currentUserHasBlankPassword, + adminsHaveBlankPassword, + userCannotChangePassword, + adminsCannotChangePassword, + localControlledUsersCannotChangePassword, + connectedAdminsProviderPolicyIsWeak, + connectedUserProviderPolicyIsWeak, + changeConnectedAdminsPassword, + changeConnectedUserPassword, + } + export enum EasDisallowConvenienceLogonResult { + notEvaluated, + compliant, + canBeCompliant, + requestedPolicyIsStricter, + } + export enum EasMinPasswordComplexCharactersResult { + notEvaluated, + compliant, + canBeCompliant, + requestedPolicyIsStricter, + requestedPolicyNotEnforceable, + invalidParameter, + currentUserHasBlankPassword, + adminsHaveBlankPassword, + userCannotChangePassword, + adminsCannotChangePassword, + localControlledUsersCannotChangePassword, + connectedAdminsProviderPolicyIsWeak, + connectedUserProviderPolicyIsWeak, + changeConnectedAdminsPassword, + changeConnectedUserPassword, + } + export enum EasPasswordExpirationResult { + notEvaluated, + compliant, + canBeCompliant, + requestedPolicyIsStricter, + requestedExpirationIncompatible, + invalidParameter, + userCannotChangePassword, + adminsCannotChangePassword, + localControlledUsersCannotChangePassword, + } + export enum EasPasswordHistoryResult { + notEvaluated, + compliant, + canBeCompliant, + requestedPolicyIsStricter, + invalidParameter, + } + export enum EasMaxPasswordFailedAttemptsResult { + notEvaluated, + compliant, + canBeCompliant, + requestedPolicyIsStricter, + invalidParameter, + } + export enum EasMaxInactivityTimeLockResult { + notEvaluated, + compliant, + canBeCompliant, + requestedPolicyIsStricter, + invalidParameter, + } + export interface IEasClientDeviceInformation { + friendlyName: string; + id: string; + operatingSystem: string; + systemManufacturer: string; + systemProductName: string; + systemSku: string; + } + export interface IEasClientSecurityPolicy { + disallowConvenienceLogon: boolean; + maxInactivityTimeLock: number; + maxPasswordFailedAttempts: number; + minPasswordComplexCharacters: number; + minPasswordLength: number; + passwordExpiration: number; + passwordHistory: number; + requireEncryption: boolean; + checkCompliance(): Windows.Security.ExchangeActiveSyncProvisioning.EasComplianceResults; + applyAsync(): Windows.Foundation.IAsyncOperation; + } + export class EasComplianceResults implements Windows.Security.ExchangeActiveSyncProvisioning.IEasComplianceResults { + compliant: boolean; + disallowConvenienceLogonResult: Windows.Security.ExchangeActiveSyncProvisioning.EasDisallowConvenienceLogonResult; + maxInactivityTimeLockResult: Windows.Security.ExchangeActiveSyncProvisioning.EasMaxInactivityTimeLockResult; + maxPasswordFailedAttemptsResult: Windows.Security.ExchangeActiveSyncProvisioning.EasMaxPasswordFailedAttemptsResult; + minPasswordComplexCharactersResult: Windows.Security.ExchangeActiveSyncProvisioning.EasMinPasswordComplexCharactersResult; + minPasswordLengthResult: Windows.Security.ExchangeActiveSyncProvisioning.EasMinPasswordLengthResult; + passwordExpirationResult: Windows.Security.ExchangeActiveSyncProvisioning.EasPasswordExpirationResult; + passwordHistoryResult: Windows.Security.ExchangeActiveSyncProvisioning.EasPasswordHistoryResult; + requireEncryptionResult: Windows.Security.ExchangeActiveSyncProvisioning.EasRequireEncryptionResult; + } + export interface IEasComplianceResults { + compliant: boolean; + disallowConvenienceLogonResult: Windows.Security.ExchangeActiveSyncProvisioning.EasDisallowConvenienceLogonResult; + maxInactivityTimeLockResult: Windows.Security.ExchangeActiveSyncProvisioning.EasMaxInactivityTimeLockResult; + maxPasswordFailedAttemptsResult: Windows.Security.ExchangeActiveSyncProvisioning.EasMaxPasswordFailedAttemptsResult; + minPasswordComplexCharactersResult: Windows.Security.ExchangeActiveSyncProvisioning.EasMinPasswordComplexCharactersResult; + minPasswordLengthResult: Windows.Security.ExchangeActiveSyncProvisioning.EasMinPasswordLengthResult; + passwordExpirationResult: Windows.Security.ExchangeActiveSyncProvisioning.EasPasswordExpirationResult; + passwordHistoryResult: Windows.Security.ExchangeActiveSyncProvisioning.EasPasswordHistoryResult; + requireEncryptionResult: Windows.Security.ExchangeActiveSyncProvisioning.EasRequireEncryptionResult; + } + export class EasClientSecurityPolicy implements Windows.Security.ExchangeActiveSyncProvisioning.IEasClientSecurityPolicy { + disallowConvenienceLogon: boolean; + maxInactivityTimeLock: number; + maxPasswordFailedAttempts: number; + minPasswordComplexCharacters: number; + minPasswordLength: number; + passwordExpiration: number; + passwordHistory: number; + requireEncryption: boolean; + checkCompliance(): Windows.Security.ExchangeActiveSyncProvisioning.EasComplianceResults; + applyAsync(): Windows.Foundation.IAsyncOperation; + } + export class EasClientDeviceInformation implements Windows.Security.ExchangeActiveSyncProvisioning.IEasClientDeviceInformation { + friendlyName: string; + id: string; + operatingSystem: string; + systemManufacturer: string; + systemProductName: string; + systemSku: string; + } + } + } +} +declare module Windows { + export module Storage { + export module Streams { + export enum ByteOrder { + littleEndian, + bigEndian, + } + export enum UnicodeEncoding { + utf8, + utf16LE, + utf16BE, + } + export class DataReaderLoadOperation implements Windows.Foundation.IAsyncOperation, Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + getResults(): number; + cancel(): void; + close(): void; + then(success?: (value: number) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: number) => Windows.Foundation.IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: number) => U, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: number) => Windows.Foundation.IPromise, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done(success?: (value: number) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + operation: { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + getResults(): number; + } + } + export interface IDataReader { + byteOrder: Windows.Storage.Streams.ByteOrder; + inputStreamOptions: Windows.Storage.Streams.InputStreamOptions; + unconsumedBufferLength: number; + unicodeEncoding: Windows.Storage.Streams.UnicodeEncoding; + readByte(): number; + readBytes(): Uint8Array; + readBuffer(length: number): Windows.Storage.Streams.IBuffer; + readBoolean(): boolean; + readGuid(): string; + readInt16(): number; + readInt32(): number; + readInt64(): number; + readUInt16(): number; + readUInt32(): number; + readUInt64(): number; + readSingle(): number; + readDouble(): number; + readString(codeUnitCount: number): string; + readDateTime(): Date; + readTimeSpan(): number; + loadAsync(count: number): Windows.Storage.Streams.DataReaderLoadOperation; + detachBuffer(): Windows.Storage.Streams.IBuffer; + detachStream(): Windows.Storage.Streams.IInputStream; + } + export interface IDataReaderFactory { + createDataReader(inputStream: Windows.Storage.Streams.IInputStream): Windows.Storage.Streams.DataReader; + } + export class DataReader implements Windows.Storage.Streams.IDataReader, Windows.Foundation.IClosable { + constructor(inputStream: Windows.Storage.Streams.IInputStream); + byteOrder: Windows.Storage.Streams.ByteOrder; + inputStreamOptions: Windows.Storage.Streams.InputStreamOptions; + unconsumedBufferLength: number; + unicodeEncoding: Windows.Storage.Streams.UnicodeEncoding; + readByte(): number; + readBytes(): Uint8Array; + readBuffer(length: number): Windows.Storage.Streams.IBuffer; + readBoolean(): boolean; + readGuid(): string; + readInt16(): number; + readInt32(): number; + readInt64(): number; + readUInt16(): number; + readUInt32(): number; + readUInt64(): number; + readSingle(): number; + readDouble(): number; + readString(codeUnitCount: number): string; + readDateTime(): Date; + readTimeSpan(): number; + loadAsync(count: number): Windows.Storage.Streams.DataReaderLoadOperation; + detachBuffer(): Windows.Storage.Streams.IBuffer; + detachStream(): Windows.Storage.Streams.IInputStream; + dispose(): void; + static fromBuffer(buffer: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.DataReader; + close(): void; + } + export interface IDataReaderStatics { + fromBuffer(buffer: Windows.Storage.Streams.IBuffer): Windows.Storage.Streams.DataReader; + } + export class DataWriterStoreOperation implements Windows.Foundation.IAsyncOperation, Windows.Foundation.IAsyncInfo { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + errorCode: number; + id: number; + status: Windows.Foundation.AsyncStatus; + getResults(): number; + cancel(): void; + close(): void; + then(success?: (value: number) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: number) => Windows.Foundation.IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: number) => U, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: number) => Windows.Foundation.IPromise, error?: (error: any) => Windows.Foundation.IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done(success?: (value: number) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + operation: { + completed: Windows.Foundation.AsyncOperationCompletedHandler; + getResults(): number; + } + } + export interface IDataWriter { + byteOrder: Windows.Storage.Streams.ByteOrder; + unicodeEncoding: Windows.Storage.Streams.UnicodeEncoding; + unstoredBufferLength: number; + writeByte(value: number): void; + writeBytes(value: Uint8Array): void; + writeBuffer(buffer: Windows.Storage.Streams.IBuffer): void; + writeBuffer(buffer: Windows.Storage.Streams.IBuffer, start: number, count: number): void; + writeBoolean(value: boolean): void; + writeGuid(value: string): void; + writeInt16(value: number): void; + writeInt32(value: number): void; + writeInt64(value: number): void; + writeUInt16(value: number): void; + writeUInt32(value: number): void; + writeUInt64(value: number): void; + writeSingle(value: number): void; + writeDouble(value: number): void; + writeDateTime(value: Date): void; + writeTimeSpan(value: number): void; + writeString(value: string): number; + measureString(value: string): number; + storeAsync(): Windows.Storage.Streams.DataWriterStoreOperation; + flushAsync(): Windows.Foundation.IAsyncOperation; + detachBuffer(): Windows.Storage.Streams.IBuffer; + detachStream(): Windows.Storage.Streams.IOutputStream; + } + export interface IDataWriterFactory { + createDataWriter(outputStream: Windows.Storage.Streams.IOutputStream): Windows.Storage.Streams.DataWriter; + } + export class DataWriter implements Windows.Storage.Streams.IDataWriter, Windows.Foundation.IClosable { + constructor(outputStream: Windows.Storage.Streams.IOutputStream); + constructor(); + byteOrder: Windows.Storage.Streams.ByteOrder; + unicodeEncoding: Windows.Storage.Streams.UnicodeEncoding; + unstoredBufferLength: number; + writeByte(value: number): void; + writeBytes(value: Uint8Array): void; + writeBuffer(buffer: Windows.Storage.Streams.IBuffer): void; + writeBuffer(buffer: Windows.Storage.Streams.IBuffer, start: number, count: number): void; + writeBoolean(value: boolean): void; + writeGuid(value: string): void; + writeInt16(value: number): void; + writeInt32(value: number): void; + writeInt64(value: number): void; + writeUInt16(value: number): void; + writeUInt32(value: number): void; + writeUInt64(value: number): void; + writeSingle(value: number): void; + writeDouble(value: number): void; + writeDateTime(value: Date): void; + writeTimeSpan(value: number): void; + writeString(value: string): number; + measureString(value: string): number; + storeAsync(): Windows.Storage.Streams.DataWriterStoreOperation; + flushAsync(): Windows.Foundation.IAsyncOperation; + detachBuffer(): Windows.Storage.Streams.IBuffer; + detachStream(): Windows.Storage.Streams.IOutputStream; + dispose(): void; + close(): void; + } + export interface IRandomAccessStreamStatics { + copyAsync(source: Windows.Storage.Streams.IInputStream, destination: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncOperationWithProgress; + copyAsync(source: Windows.Storage.Streams.IInputStream, destination: Windows.Storage.Streams.IOutputStream, bytesToCopy: number): Windows.Foundation.IAsyncOperationWithProgress; + copyAndCloseAsync(source: Windows.Storage.Streams.IInputStream, destination: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncOperationWithProgress; + } + export class RandomAccessStream { + static copyAsync(source: Windows.Storage.Streams.IInputStream, destination: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncOperationWithProgress; + static copyAsync(source: Windows.Storage.Streams.IInputStream, destination: Windows.Storage.Streams.IOutputStream, bytesToCopy: number): Windows.Foundation.IAsyncOperationWithProgress; + static copyAndCloseAsync(source: Windows.Storage.Streams.IInputStream, destination: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncOperationWithProgress; + } + export interface IBufferFactory { + create(capacity: number): Windows.Storage.Streams.Buffer; + } + export class Buffer implements Windows.Storage.Streams.IBuffer { + constructor(capacity: number); + capacity: number; + length: number; + } + export interface IBuffer { + capacity: number; + length: number; + } + export enum InputStreamOptions { + none, + partial, + readAhead, + } + export interface IContentTypeProvider { + contentType: string; + } + export interface IRandomAccessStreamReference { + openReadAsync(): Windows.Foundation.IAsyncOperation; + } + export interface IInputStreamReference { + openSequentialReadAsync(): Windows.Foundation.IAsyncOperation; + } + export interface IRandomAccessStreamReferenceStatics { + createFromFile(file: Windows.Storage.IStorageFile): Windows.Storage.Streams.RandomAccessStreamReference; + createFromUri(uri: Windows.Foundation.Uri): Windows.Storage.Streams.RandomAccessStreamReference; + createFromStream(stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Storage.Streams.RandomAccessStreamReference; + } + export class RandomAccessStreamReference implements Windows.Storage.Streams.IRandomAccessStreamReference { + openReadAsync(): Windows.Foundation.IAsyncOperation; + static createFromFile(file: Windows.Storage.IStorageFile): Windows.Storage.Streams.RandomAccessStreamReference; + static createFromUri(uri: Windows.Foundation.Uri): Windows.Storage.Streams.RandomAccessStreamReference; + static createFromStream(stream: Windows.Storage.Streams.IRandomAccessStream): Windows.Storage.Streams.RandomAccessStreamReference; + } + export class FileRandomAccessStream implements Windows.Storage.Streams.IRandomAccessStream, Windows.Foundation.IClosable, Windows.Storage.Streams.IInputStream, Windows.Storage.Streams.IOutputStream { + canRead: boolean; + canWrite: boolean; + position: number; + size: number; + getInputStreamAt(position: number): Windows.Storage.Streams.IInputStream; + getOutputStreamAt(position: number): Windows.Storage.Streams.IOutputStream; + seek(position: number): void; + cloneStream(): Windows.Storage.Streams.IRandomAccessStream; + dispose(): void; + readAsync(buffer: Windows.Storage.Streams.IBuffer, count: number, options: Windows.Storage.Streams.InputStreamOptions): Windows.Foundation.IAsyncOperationWithProgress; + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + close(): void; + } + export class FileInputStream implements Windows.Storage.Streams.IInputStream, Windows.Foundation.IClosable { + readAsync(buffer: Windows.Storage.Streams.IBuffer, count: number, options: Windows.Storage.Streams.InputStreamOptions): Windows.Foundation.IAsyncOperationWithProgress; + dispose(): void; + close(): void; + } + export class FileOutputStream implements Windows.Storage.Streams.IOutputStream, Windows.Foundation.IClosable { + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + dispose(): void; + close(): void; + } + export class RandomAccessStreamOverStream implements Windows.Storage.Streams.IRandomAccessStream, Windows.Foundation.IClosable, Windows.Storage.Streams.IInputStream, Windows.Storage.Streams.IOutputStream { + canRead: boolean; + canWrite: boolean; + position: number; + size: number; + getInputStreamAt(position: number): Windows.Storage.Streams.IInputStream; + getOutputStreamAt(position: number): Windows.Storage.Streams.IOutputStream; + seek(position: number): void; + cloneStream(): Windows.Storage.Streams.IRandomAccessStream; + dispose(): void; + readAsync(buffer: Windows.Storage.Streams.IBuffer, count: number, options: Windows.Storage.Streams.InputStreamOptions): Windows.Foundation.IAsyncOperationWithProgress; + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + close(): void; + } + export class InputStreamOverStream implements Windows.Storage.Streams.IInputStream, Windows.Foundation.IClosable { + readAsync(buffer: Windows.Storage.Streams.IBuffer, count: number, options: Windows.Storage.Streams.InputStreamOptions): Windows.Foundation.IAsyncOperationWithProgress; + dispose(): void; + close(): void; + } + export class OutputStreamOverStream implements Windows.Storage.Streams.IOutputStream, Windows.Foundation.IClosable { + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + dispose(): void; + close(): void; + } + export class InMemoryRandomAccessStream implements Windows.Storage.Streams.IRandomAccessStream, Windows.Foundation.IClosable, Windows.Storage.Streams.IInputStream, Windows.Storage.Streams.IOutputStream { + canRead: boolean; + canWrite: boolean; + position: number; + size: number; + getInputStreamAt(position: number): Windows.Storage.Streams.IInputStream; + getOutputStreamAt(position: number): Windows.Storage.Streams.IOutputStream; + seek(position: number): void; + cloneStream(): Windows.Storage.Streams.IRandomAccessStream; + dispose(): void; + readAsync(buffer: Windows.Storage.Streams.IBuffer, count: number, options: Windows.Storage.Streams.InputStreamOptions): Windows.Foundation.IAsyncOperationWithProgress; + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + close(): void; + } + export interface IInputStream extends Windows.Foundation.IClosable { + readAsync(buffer: Windows.Storage.Streams.IBuffer, count: number, options: Windows.Storage.Streams.InputStreamOptions): Windows.Foundation.IAsyncOperationWithProgress; + } + export interface IOutputStream extends Windows.Foundation.IClosable { + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + } + export interface IRandomAccessStream extends Windows.Foundation.IClosable, Windows.Storage.Streams.IInputStream, Windows.Storage.Streams.IOutputStream { + canRead: boolean; + canWrite: boolean; + position: number; + size: number; + getInputStreamAt(position: number): Windows.Storage.Streams.IInputStream; + getOutputStreamAt(position: number): Windows.Storage.Streams.IOutputStream; + seek(position: number): void; + cloneStream(): Windows.Storage.Streams.IRandomAccessStream; + } + export interface IRandomAccessStreamWithContentType extends Windows.Storage.Streams.IRandomAccessStream, Windows.Foundation.IClosable, Windows.Storage.Streams.IInputStream, Windows.Storage.Streams.IOutputStream, Windows.Storage.Streams.IContentTypeProvider { + } + } + } +} +declare module Windows { + export module Storage { + export module Pickers { + export module Provider { + export interface IFileRemovedEventArgs { + id: string; + } + export class FileRemovedEventArgs implements Windows.Storage.Pickers.Provider.IFileRemovedEventArgs { + id: string; + } + export enum AddFileResult { + added, + alreadyAdded, + notAllowed, + unavailable, + } + export enum FileSelectionMode { + single, + multiple, + } + export interface IFileOpenPickerUI { + allowedFileTypes: Windows.Foundation.Collections.IVectorView; + selectionMode: Windows.Storage.Pickers.Provider.FileSelectionMode; + settingsIdentifier: string; + title: string; + addFile(id: string, file: Windows.Storage.IStorageFile): Windows.Storage.Pickers.Provider.AddFileResult; + removeFile(id: string): void; + containsFile(id: string): boolean; + canAddFile(file: Windows.Storage.IStorageFile): boolean; + onfileremoved: any/* TODO */; + onclosing: any/* TODO */; + } + export class FileOpenPickerUI implements Windows.Storage.Pickers.Provider.IFileOpenPickerUI { + allowedFileTypes: Windows.Foundation.Collections.IVectorView; + selectionMode: Windows.Storage.Pickers.Provider.FileSelectionMode; + settingsIdentifier: string; + title: string; + addFile(id: string, file: Windows.Storage.IStorageFile): Windows.Storage.Pickers.Provider.AddFileResult; + removeFile(id: string): void; + containsFile(id: string): boolean; + canAddFile(file: Windows.Storage.IStorageFile): boolean; + onfileremoved: any/* TODO */; + onclosing: any/* TODO */; + } + export class PickerClosingEventArgs implements Windows.Storage.Pickers.Provider.IPickerClosingEventArgs { + closingOperation: Windows.Storage.Pickers.Provider.PickerClosingOperation; + isCanceled: boolean; + } + export interface IPickerClosingEventArgs { + closingOperation: Windows.Storage.Pickers.Provider.PickerClosingOperation; + isCanceled: boolean; + } + export class PickerClosingOperation implements Windows.Storage.Pickers.Provider.IPickerClosingOperation { + deadline: Date; + getDeferral(): Windows.Storage.Pickers.Provider.PickerClosingDeferral; + } + export interface IPickerClosingOperation { + deadline: Date; + getDeferral(): Windows.Storage.Pickers.Provider.PickerClosingDeferral; + } + export class PickerClosingDeferral implements Windows.Storage.Pickers.Provider.IPickerClosingDeferral { + complete(): void; + } + export interface IPickerClosingDeferral { + complete(): void; + } + export enum SetFileNameResult { + succeeded, + notAllowed, + unavailable, + } + export interface IFileSavePickerUI { + allowedFileTypes: Windows.Foundation.Collections.IVectorView; + fileName: string; + settingsIdentifier: string; + title: string; + trySetFileName(value: string): Windows.Storage.Pickers.Provider.SetFileNameResult; + onfilenamechanged: any/* TODO */; + ontargetfilerequested: any/* TODO */; + } + export class FileSavePickerUI implements Windows.Storage.Pickers.Provider.IFileSavePickerUI { + allowedFileTypes: Windows.Foundation.Collections.IVectorView; + fileName: string; + settingsIdentifier: string; + title: string; + trySetFileName(value: string): Windows.Storage.Pickers.Provider.SetFileNameResult; + onfilenamechanged: any/* TODO */; + ontargetfilerequested: any/* TODO */; + } + export class TargetFileRequestedEventArgs implements Windows.Storage.Pickers.Provider.ITargetFileRequestedEventArgs { + request: Windows.Storage.Pickers.Provider.TargetFileRequest; + } + export interface ITargetFileRequestedEventArgs { + request: Windows.Storage.Pickers.Provider.TargetFileRequest; + } + export class TargetFileRequest implements Windows.Storage.Pickers.Provider.ITargetFileRequest { + targetFile: Windows.Storage.IStorageFile; + getDeferral(): Windows.Storage.Pickers.Provider.TargetFileRequestDeferral; + } + export interface ITargetFileRequest { + targetFile: Windows.Storage.IStorageFile; + getDeferral(): Windows.Storage.Pickers.Provider.TargetFileRequestDeferral; + } + export class TargetFileRequestDeferral implements Windows.Storage.Pickers.Provider.ITargetFileRequestDeferral { + complete(): void; + } + export interface ITargetFileRequestDeferral { + complete(): void; + } + } + } + } +} +declare module Windows { + export module Storage { + export module Provider { + export enum CachedFileTarget { + local, + remote, + } + export enum UIStatus { + unavailable, + hidden, + visible, + complete, + } + export interface ICachedFileUpdaterUI { + title: string; + uIStatus: Windows.Storage.Provider.UIStatus; + updateTarget: Windows.Storage.Provider.CachedFileTarget; + onfileupdaterequested: any/* TODO */; + onuirequested: any/* TODO */; + } + export class CachedFileUpdaterUI implements Windows.Storage.Provider.ICachedFileUpdaterUI { + title: string; + uIStatus: Windows.Storage.Provider.UIStatus; + updateTarget: Windows.Storage.Provider.CachedFileTarget; + onfileupdaterequested: any/* TODO */; + onuirequested: any/* TODO */; + } + export class FileUpdateRequestedEventArgs implements Windows.Storage.Provider.IFileUpdateRequestedEventArgs { + request: Windows.Storage.Provider.FileUpdateRequest; + } + export interface IFileUpdateRequestedEventArgs { + request: Windows.Storage.Provider.FileUpdateRequest; + } + export class FileUpdateRequest implements Windows.Storage.Provider.IFileUpdateRequest { + contentId: string; + file: Windows.Storage.StorageFile; + status: Windows.Storage.Provider.FileUpdateStatus; + getDeferral(): Windows.Storage.Provider.FileUpdateRequestDeferral; + updateLocalFile(value: Windows.Storage.IStorageFile): void; + } + export interface IFileUpdateRequest { + contentId: string; + file: Windows.Storage.StorageFile; + status: Windows.Storage.Provider.FileUpdateStatus; + getDeferral(): Windows.Storage.Provider.FileUpdateRequestDeferral; + updateLocalFile(value: Windows.Storage.IStorageFile): void; + } + export class FileUpdateRequestDeferral implements Windows.Storage.Provider.IFileUpdateRequestDeferral { + complete(): void; + } + export interface IFileUpdateRequestDeferral { + complete(): void; + } + export enum FileUpdateStatus { + incomplete, + complete, + userInputNeeded, + currentlyUnavailable, + failed, + completeAndRenamed, + } + export enum CachedFileOptions { + none, + requireUpdateOnAccess, + useCachedFileWhenOffline, + denyAccessWhenOffline, + } + export enum ReadActivationMode { + notNeeded, + beforeAccess, + } + export enum WriteActivationMode { + readOnly, + notNeeded, + afterWrite, + } + export interface ICachedFileUpdaterStatics { + setUpdateInformation(file: Windows.Storage.IStorageFile, contentId: string, readMode: Windows.Storage.Provider.ReadActivationMode, writeMode: Windows.Storage.Provider.WriteActivationMode, options: Windows.Storage.Provider.CachedFileOptions): void; + } + export class CachedFileUpdater { + static setUpdateInformation(file: Windows.Storage.IStorageFile, contentId: string, readMode: Windows.Storage.Provider.ReadActivationMode, writeMode: Windows.Storage.Provider.WriteActivationMode, options: Windows.Storage.Provider.CachedFileOptions): void; + } + } + } +} +declare module Windows { + export module Storage { + export module FileProperties { + export enum PropertyPrefetchOptions { + none, + musicProperties, + videoProperties, + imageProperties, + documentProperties, + basicProperties, + } + export enum ThumbnailType { + image, + icon, + } + export interface IThumbnailProperties { + originalHeight: number; + originalWidth: number; + returnedSmallerCachedSize: boolean; + type: Windows.Storage.FileProperties.ThumbnailType; + } + export class StorageItemThumbnail implements Windows.Storage.Streams.IRandomAccessStreamWithContentType, Windows.Storage.Streams.IRandomAccessStream, Windows.Foundation.IClosable, Windows.Storage.Streams.IInputStream, Windows.Storage.Streams.IOutputStream, Windows.Storage.Streams.IContentTypeProvider, Windows.Storage.FileProperties.IThumbnailProperties { + canRead: boolean; + canWrite: boolean; + position: number; + size: number; + contentType: string; + originalHeight: number; + originalWidth: number; + returnedSmallerCachedSize: boolean; + type: Windows.Storage.FileProperties.ThumbnailType; + getInputStreamAt(position: number): Windows.Storage.Streams.IInputStream; + getOutputStreamAt(position: number): Windows.Storage.Streams.IOutputStream; + seek(position: number): void; + cloneStream(): Windows.Storage.Streams.IRandomAccessStream; + dispose(): void; + readAsync(buffer: Windows.Storage.Streams.IBuffer, count: number, options: Windows.Storage.Streams.InputStreamOptions): Windows.Foundation.IAsyncOperationWithProgress; + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + close(): void; + } + export enum ThumbnailMode { + picturesView, + videosView, + musicView, + documentsView, + listView, + singleItem, + } + export enum ThumbnailOptions { + none, + returnOnlyIfCached, + resizeThumbnail, + useCurrentScale, + } + export enum PhotoOrientation { + unspecified, + normal, + flipHorizontal, + rotate180, + flipVertical, + transpose, + rotate270, + transverse, + rotate90, + } + export enum VideoOrientation { + normal, + rotate90, + rotate180, + rotate270, + } + export interface IStorageItemExtraProperties { + retrievePropertiesAsync(propertiesToRetrieve: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation>; + savePropertiesAsync(propertiesToSave: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + savePropertiesAsync(): Windows.Foundation.IAsyncAction; + } + export interface IStorageItemContentProperties extends Windows.Storage.FileProperties.IStorageItemExtraProperties { + getMusicPropertiesAsync(): Windows.Foundation.IAsyncOperation; + getVideoPropertiesAsync(): Windows.Foundation.IAsyncOperation; + getImagePropertiesAsync(): Windows.Foundation.IAsyncOperation; + getDocumentPropertiesAsync(): Windows.Foundation.IAsyncOperation; + } + export class MusicProperties implements Windows.Storage.FileProperties.IMusicProperties, Windows.Storage.FileProperties.IStorageItemExtraProperties { + album: string; + albumArtist: string; + artist: string; + bitrate: number; + composers: Windows.Foundation.Collections.IVector; + conductors: Windows.Foundation.Collections.IVector; + duration: number; + genre: Windows.Foundation.Collections.IVector; + producers: Windows.Foundation.Collections.IVector; + publisher: string; + rating: number; + subtitle: string; + title: string; + trackNumber: number; + writers: Windows.Foundation.Collections.IVector; + year: number; + retrievePropertiesAsync(propertiesToRetrieve: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation>; + savePropertiesAsync(propertiesToSave: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + savePropertiesAsync(): Windows.Foundation.IAsyncAction; + } + export class VideoProperties implements Windows.Storage.FileProperties.IVideoProperties, Windows.Storage.FileProperties.IStorageItemExtraProperties { + bitrate: number; + directors: Windows.Foundation.Collections.IVector; + duration: number; + height: number; + keywords: Windows.Foundation.Collections.IVector; + latitude: number; + longitude: number; + orientation: Windows.Storage.FileProperties.VideoOrientation; + producers: Windows.Foundation.Collections.IVector; + publisher: string; + rating: number; + subtitle: string; + title: string; + width: number; + writers: Windows.Foundation.Collections.IVector; + year: number; + retrievePropertiesAsync(propertiesToRetrieve: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation>; + savePropertiesAsync(propertiesToSave: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + savePropertiesAsync(): Windows.Foundation.IAsyncAction; + } + export class ImageProperties implements Windows.Storage.FileProperties.IImageProperties, Windows.Storage.FileProperties.IStorageItemExtraProperties { + cameraManufacturer: string; + cameraModel: string; + dateTaken: Date; + height: number; + keywords: Windows.Foundation.Collections.IVector; + latitude: number; + longitude: number; + orientation: Windows.Storage.FileProperties.PhotoOrientation; + peopleNames: Windows.Foundation.Collections.IVectorView; + rating: number; + title: string; + width: number; + retrievePropertiesAsync(propertiesToRetrieve: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation>; + savePropertiesAsync(propertiesToSave: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + savePropertiesAsync(): Windows.Foundation.IAsyncAction; + } + export class DocumentProperties implements Windows.Storage.FileProperties.IDocumentProperties, Windows.Storage.FileProperties.IStorageItemExtraProperties { + author: Windows.Foundation.Collections.IVector; + comment: string; + keywords: Windows.Foundation.Collections.IVector; + title: string; + retrievePropertiesAsync(propertiesToRetrieve: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation>; + savePropertiesAsync(propertiesToSave: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + savePropertiesAsync(): Windows.Foundation.IAsyncAction; + } + export interface IMusicProperties extends Windows.Storage.FileProperties.IStorageItemExtraProperties { + album: string; + albumArtist: string; + artist: string; + bitrate: number; + composers: Windows.Foundation.Collections.IVector; + conductors: Windows.Foundation.Collections.IVector; + duration: number; + genre: Windows.Foundation.Collections.IVector; + producers: Windows.Foundation.Collections.IVector; + publisher: string; + rating: number; + subtitle: string; + title: string; + trackNumber: number; + writers: Windows.Foundation.Collections.IVector; + year: number; + } + export interface IImageProperties extends Windows.Storage.FileProperties.IStorageItemExtraProperties { + cameraManufacturer: string; + cameraModel: string; + dateTaken: Date; + height: number; + keywords: Windows.Foundation.Collections.IVector; + latitude: number; + longitude: number; + orientation: Windows.Storage.FileProperties.PhotoOrientation; + peopleNames: Windows.Foundation.Collections.IVectorView; + rating: number; + title: string; + width: number; + } + export interface IVideoProperties extends Windows.Storage.FileProperties.IStorageItemExtraProperties { + bitrate: number; + directors: Windows.Foundation.Collections.IVector; + duration: number; + height: number; + keywords: Windows.Foundation.Collections.IVector; + latitude: number; + longitude: number; + orientation: Windows.Storage.FileProperties.VideoOrientation; + producers: Windows.Foundation.Collections.IVector; + publisher: string; + rating: number; + subtitle: string; + title: string; + width: number; + writers: Windows.Foundation.Collections.IVector; + year: number; + } + export interface IDocumentProperties extends Windows.Storage.FileProperties.IStorageItemExtraProperties { + author: Windows.Foundation.Collections.IVector; + comment: string; + keywords: Windows.Foundation.Collections.IVector; + title: string; + } + export interface IBasicProperties { + dateModified: Date; + itemDate: Date; + size: number; + } + export class StorageItemContentProperties implements Windows.Storage.FileProperties.IStorageItemContentProperties, Windows.Storage.FileProperties.IStorageItemExtraProperties { + getMusicPropertiesAsync(): Windows.Foundation.IAsyncOperation; + getVideoPropertiesAsync(): Windows.Foundation.IAsyncOperation; + getImagePropertiesAsync(): Windows.Foundation.IAsyncOperation; + getDocumentPropertiesAsync(): Windows.Foundation.IAsyncOperation; + retrievePropertiesAsync(propertiesToRetrieve: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation>; + savePropertiesAsync(propertiesToSave: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + savePropertiesAsync(): Windows.Foundation.IAsyncAction; + } + export class BasicProperties implements Windows.Storage.FileProperties.IBasicProperties, Windows.Storage.FileProperties.IStorageItemExtraProperties { + dateModified: Date; + itemDate: Date; + size: number; + retrievePropertiesAsync(propertiesToRetrieve: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncOperation>; + savePropertiesAsync(propertiesToSave: Windows.Foundation.Collections.IIterable>): Windows.Foundation.IAsyncAction; + savePropertiesAsync(): Windows.Foundation.IAsyncAction; + } + } + } +} +declare module Windows { + export module Storage { + export interface IKnownFoldersStatics { + documentsLibrary: Windows.Storage.StorageFolder; + homeGroup: Windows.Storage.StorageFolder; + mediaServerDevices: Windows.Storage.StorageFolder; + musicLibrary: Windows.Storage.StorageFolder; + picturesLibrary: Windows.Storage.StorageFolder; + removableDevices: Windows.Storage.StorageFolder; + videosLibrary: Windows.Storage.StorageFolder; + } + export class StorageFolder implements Windows.Storage.IStorageFolder, Windows.Storage.IStorageItem, Windows.Storage.Search.IStorageFolderQueryOperations, Windows.Storage.IStorageItemProperties { + attributes: Windows.Storage.FileAttributes; + dateCreated: Date; + name: string; + path: string; + displayName: string; + displayType: string; + folderRelativeId: string; + properties: Windows.Storage.FileProperties.StorageItemContentProperties; + createFileAsync(desiredName: string): Windows.Foundation.IAsyncOperation; + createFileAsync(desiredName: string, options: Windows.Storage.CreationCollisionOption): Windows.Foundation.IAsyncOperation; + createFolderAsync(desiredName: string): Windows.Foundation.IAsyncOperation; + createFolderAsync(desiredName: string, options: Windows.Storage.CreationCollisionOption): Windows.Foundation.IAsyncOperation; + getFileAsync(name: string): Windows.Foundation.IAsyncOperation; + getFolderAsync(name: string): Windows.Foundation.IAsyncOperation; + getItemAsync(name: string): Windows.Foundation.IAsyncOperation; + getFilesAsync(): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(): Windows.Foundation.IAsyncOperation>; + getItemsAsync(): Windows.Foundation.IAsyncOperation>; + renameAsync(desiredName: string): Windows.Foundation.IAsyncAction; + renameAsync(desiredName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncAction; + deleteAsync(): Windows.Foundation.IAsyncAction; + deleteAsync(option: Windows.Storage.StorageDeleteOption): Windows.Foundation.IAsyncAction; + getBasicPropertiesAsync(): Windows.Foundation.IAsyncOperation; + isOfType(type: Windows.Storage.StorageItemTypes): boolean; + getIndexedStateAsync(): Windows.Foundation.IAsyncOperation; + createFileQuery(): Windows.Storage.Search.StorageFileQueryResult; + createFileQuery(query: Windows.Storage.Search.CommonFileQuery): Windows.Storage.Search.StorageFileQueryResult; + createFileQueryWithOptions(queryOptions: Windows.Storage.Search.QueryOptions): Windows.Storage.Search.StorageFileQueryResult; + createFolderQuery(): Windows.Storage.Search.StorageFolderQueryResult; + createFolderQuery(query: Windows.Storage.Search.CommonFolderQuery): Windows.Storage.Search.StorageFolderQueryResult; + createFolderQueryWithOptions(queryOptions: Windows.Storage.Search.QueryOptions): Windows.Storage.Search.StorageFolderQueryResult; + createItemQuery(): Windows.Storage.Search.StorageItemQueryResult; + createItemQueryWithOptions(queryOptions: Windows.Storage.Search.QueryOptions): Windows.Storage.Search.StorageItemQueryResult; + getFilesAsync(query: Windows.Storage.Search.CommonFileQuery, startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getFilesAsync(query: Windows.Storage.Search.CommonFileQuery): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(query: Windows.Storage.Search.CommonFolderQuery, startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(query: Windows.Storage.Search.CommonFolderQuery): Windows.Foundation.IAsyncOperation>; + getItemsAsync(startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + areQueryOptionsSupported(queryOptions: Windows.Storage.Search.QueryOptions): boolean; + isCommonFolderQuerySupported(query: Windows.Storage.Search.CommonFolderQuery): boolean; + isCommonFileQuerySupported(query: Windows.Storage.Search.CommonFileQuery): boolean; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number, options: Windows.Storage.FileProperties.ThumbnailOptions): Windows.Foundation.IAsyncOperation; + static getFolderFromPathAsync(path: string): Windows.Foundation.IAsyncOperation; + } + export class KnownFolders { + static documentsLibrary: Windows.Storage.StorageFolder; + static homeGroup: Windows.Storage.StorageFolder; + static mediaServerDevices: Windows.Storage.StorageFolder; + static musicLibrary: Windows.Storage.StorageFolder; + static picturesLibrary: Windows.Storage.StorageFolder; + static removableDevices: Windows.Storage.StorageFolder; + static videosLibrary: Windows.Storage.StorageFolder; + } + export enum CreationCollisionOption { + generateUniqueName, + replaceExisting, + failIfExists, + openIfExists, + } + export interface IDownloadsFolderStatics { + createFileAsync(desiredName: string): Windows.Foundation.IAsyncOperation; + createFolderAsync(desiredName: string): Windows.Foundation.IAsyncOperation; + createFileAsync(desiredName: string, option: Windows.Storage.CreationCollisionOption): Windows.Foundation.IAsyncOperation; + createFolderAsync(desiredName: string, option: Windows.Storage.CreationCollisionOption): Windows.Foundation.IAsyncOperation; + } + export class StorageFile implements Windows.Storage.IStorageFile, Windows.Storage.IStorageItem, Windows.Storage.Streams.IRandomAccessStreamReference, Windows.Storage.Streams.IInputStreamReference, Windows.Storage.IStorageItemProperties { + contentType: string; + fileType: string; + attributes: Windows.Storage.FileAttributes; + dateCreated: Date; + name: string; + path: string; + displayName: string; + displayType: string; + folderRelativeId: string; + properties: Windows.Storage.FileProperties.StorageItemContentProperties; + openAsync(accessMode: Windows.Storage.FileAccessMode): Windows.Foundation.IAsyncOperation; + openTransactedWriteAsync(): Windows.Foundation.IAsyncOperation; + copyAsync(destinationFolder: Windows.Storage.IStorageFolder): Windows.Foundation.IAsyncOperation; + copyAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string): Windows.Foundation.IAsyncOperation; + copyAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncOperation; + copyAndReplaceAsync(fileToReplace: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + moveAsync(destinationFolder: Windows.Storage.IStorageFolder): Windows.Foundation.IAsyncAction; + moveAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string): Windows.Foundation.IAsyncAction; + moveAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncAction; + moveAndReplaceAsync(fileToReplace: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + renameAsync(desiredName: string): Windows.Foundation.IAsyncAction; + renameAsync(desiredName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncAction; + deleteAsync(): Windows.Foundation.IAsyncAction; + deleteAsync(option: Windows.Storage.StorageDeleteOption): Windows.Foundation.IAsyncAction; + getBasicPropertiesAsync(): Windows.Foundation.IAsyncOperation; + isOfType(type: Windows.Storage.StorageItemTypes): boolean; + openReadAsync(): Windows.Foundation.IAsyncOperation; + openSequentialReadAsync(): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number, options: Windows.Storage.FileProperties.ThumbnailOptions): Windows.Foundation.IAsyncOperation; + static getFileFromPathAsync(path: string): Windows.Foundation.IAsyncOperation; + static getFileFromApplicationUriAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + static createStreamedFileAsync(displayNameWithExtension: string, dataRequested: Windows.Storage.StreamedFileDataRequestedHandler, thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference): Windows.Foundation.IAsyncOperation; + static replaceWithStreamedFileAsync(fileToReplace: Windows.Storage.IStorageFile, dataRequested: Windows.Storage.StreamedFileDataRequestedHandler, thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference): Windows.Foundation.IAsyncOperation; + static createStreamedFileFromUriAsync(displayNameWithExtension: string, uri: Windows.Foundation.Uri, thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference): Windows.Foundation.IAsyncOperation; + static replaceWithStreamedFileFromUriAsync(fileToReplace: Windows.Storage.IStorageFile, uri: Windows.Foundation.Uri, thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference): Windows.Foundation.IAsyncOperation; + } + export class DownloadsFolder { + static createFileAsync(desiredName: string): Windows.Foundation.IAsyncOperation; + static createFolderAsync(desiredName: string): Windows.Foundation.IAsyncOperation; + static createFileAsync(desiredName: string, option: Windows.Storage.CreationCollisionOption): Windows.Foundation.IAsyncOperation; + static createFolderAsync(desiredName: string, option: Windows.Storage.CreationCollisionOption): Windows.Foundation.IAsyncOperation; + } + export enum NameCollisionOption { + generateUniqueName, + replaceExisting, + failIfExists, + } + export enum StorageDeleteOption { + default, + permanentDelete, + } + export enum StorageItemTypes { + none, + file, + folder, + } + export enum FileAttributes { + normal, + readOnly, + directory, + archive, + temporary, + } + export enum FileAccessMode { + read, + readWrite, + } + export enum StreamedFileFailureMode { + failed, + currentlyUnavailable, + incomplete, + } + export interface IStreamedFileDataRequest { + failAndClose(failureMode: Windows.Storage.StreamedFileFailureMode): void; + } + export class StreamedFileDataRequest implements Windows.Storage.Streams.IOutputStream, Windows.Foundation.IClosable, Windows.Storage.IStreamedFileDataRequest { + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + dispose(): void; + failAndClose(failureMode: Windows.Storage.StreamedFileFailureMode): void; + close(): void; + } + export interface StreamedFileDataRequestedHandler { + (stream: Windows.Storage.StreamedFileDataRequest): void; + } + export interface IStorageFileStatics { + getFileFromPathAsync(path: string): Windows.Foundation.IAsyncOperation; + getFileFromApplicationUriAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + createStreamedFileAsync(displayNameWithExtension: string, dataRequested: Windows.Storage.StreamedFileDataRequestedHandler, thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference): Windows.Foundation.IAsyncOperation; + replaceWithStreamedFileAsync(fileToReplace: Windows.Storage.IStorageFile, dataRequested: Windows.Storage.StreamedFileDataRequestedHandler, thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference): Windows.Foundation.IAsyncOperation; + createStreamedFileFromUriAsync(displayNameWithExtension: string, uri: Windows.Foundation.Uri, thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference): Windows.Foundation.IAsyncOperation; + replaceWithStreamedFileFromUriAsync(fileToReplace: Windows.Storage.IStorageFile, uri: Windows.Foundation.Uri, thumbnail: Windows.Storage.Streams.IRandomAccessStreamReference): Windows.Foundation.IAsyncOperation; + } + export class StorageStreamTransaction implements Windows.Storage.IStorageStreamTransaction, Windows.Foundation.IClosable { + stream: Windows.Storage.Streams.IRandomAccessStream; + commitAsync(): Windows.Foundation.IAsyncAction; + dispose(): void; + close(): void; + } + export interface IStorageItem { + attributes: Windows.Storage.FileAttributes; + dateCreated: Date; + name: string; + path: string; + renameAsync(desiredName: string): Windows.Foundation.IAsyncAction; + renameAsync(desiredName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncAction; + deleteAsync(): Windows.Foundation.IAsyncAction; + deleteAsync(option: Windows.Storage.StorageDeleteOption): Windows.Foundation.IAsyncAction; + getBasicPropertiesAsync(): Windows.Foundation.IAsyncOperation; + isOfType(type: Windows.Storage.StorageItemTypes): boolean; + } + export interface IStorageFolder extends Windows.Storage.IStorageItem { + createFileAsync(desiredName: string): Windows.Foundation.IAsyncOperation; + createFileAsync(desiredName: string, options: Windows.Storage.CreationCollisionOption): Windows.Foundation.IAsyncOperation; + createFolderAsync(desiredName: string): Windows.Foundation.IAsyncOperation; + createFolderAsync(desiredName: string, options: Windows.Storage.CreationCollisionOption): Windows.Foundation.IAsyncOperation; + getFileAsync(name: string): Windows.Foundation.IAsyncOperation; + getFolderAsync(name: string): Windows.Foundation.IAsyncOperation; + getItemAsync(name: string): Windows.Foundation.IAsyncOperation; + getFilesAsync(): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(): Windows.Foundation.IAsyncOperation>; + getItemsAsync(): Windows.Foundation.IAsyncOperation>; + } + export interface IStorageFile extends Windows.Storage.IStorageItem, Windows.Storage.Streams.IRandomAccessStreamReference, Windows.Storage.Streams.IInputStreamReference { + contentType: string; + fileType: string; + openAsync(accessMode: Windows.Storage.FileAccessMode): Windows.Foundation.IAsyncOperation; + openTransactedWriteAsync(): Windows.Foundation.IAsyncOperation; + copyAsync(destinationFolder: Windows.Storage.IStorageFolder): Windows.Foundation.IAsyncOperation; + copyAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string): Windows.Foundation.IAsyncOperation; + copyAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncOperation; + copyAndReplaceAsync(fileToReplace: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + moveAsync(destinationFolder: Windows.Storage.IStorageFolder): Windows.Foundation.IAsyncAction; + moveAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string): Windows.Foundation.IAsyncAction; + moveAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncAction; + moveAndReplaceAsync(fileToReplace: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + } + export interface IStorageFolderStatics { + getFolderFromPathAsync(path: string): Windows.Foundation.IAsyncOperation; + } + export interface IStorageItemProperties { + displayName: string; + displayType: string; + folderRelativeId: string; + properties: Windows.Storage.FileProperties.StorageItemContentProperties; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number, options: Windows.Storage.FileProperties.ThumbnailOptions): Windows.Foundation.IAsyncOperation; + } + export interface IFileIOStatics { + readTextAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + readTextAsync(file: Windows.Storage.IStorageFile, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncOperation; + writeTextAsync(file: Windows.Storage.IStorageFile, contents: string): Windows.Foundation.IAsyncAction; + writeTextAsync(file: Windows.Storage.IStorageFile, contents: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + appendTextAsync(file: Windows.Storage.IStorageFile, contents: string): Windows.Foundation.IAsyncAction; + appendTextAsync(file: Windows.Storage.IStorageFile, contents: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + readLinesAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation>; + readLinesAsync(file: Windows.Storage.IStorageFile, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncOperation>; + writeLinesAsync(file: Windows.Storage.IStorageFile, lines: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncAction; + writeLinesAsync(file: Windows.Storage.IStorageFile, lines: Windows.Foundation.Collections.IIterable, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + appendLinesAsync(file: Windows.Storage.IStorageFile, lines: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncAction; + appendLinesAsync(file: Windows.Storage.IStorageFile, lines: Windows.Foundation.Collections.IIterable, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + readBufferAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + writeBufferAsync(file: Windows.Storage.IStorageFile, buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncAction; + writeBytesAsync(file: Windows.Storage.IStorageFile, buffer: Uint8Array): Windows.Foundation.IAsyncAction; + } + export class FileIO { + static readTextAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + static readTextAsync(file: Windows.Storage.IStorageFile, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncOperation; + static writeTextAsync(file: Windows.Storage.IStorageFile, contents: string): Windows.Foundation.IAsyncAction; + static writeTextAsync(file: Windows.Storage.IStorageFile, contents: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + static appendTextAsync(file: Windows.Storage.IStorageFile, contents: string): Windows.Foundation.IAsyncAction; + static appendTextAsync(file: Windows.Storage.IStorageFile, contents: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + static readLinesAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation>; + static readLinesAsync(file: Windows.Storage.IStorageFile, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncOperation>; + static writeLinesAsync(file: Windows.Storage.IStorageFile, lines: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncAction; + static writeLinesAsync(file: Windows.Storage.IStorageFile, lines: Windows.Foundation.Collections.IIterable, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + static appendLinesAsync(file: Windows.Storage.IStorageFile, lines: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncAction; + static appendLinesAsync(file: Windows.Storage.IStorageFile, lines: Windows.Foundation.Collections.IIterable, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + static readBufferAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + static writeBufferAsync(file: Windows.Storage.IStorageFile, buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncAction; + static writeBytesAsync(file: Windows.Storage.IStorageFile, buffer: Uint8Array): Windows.Foundation.IAsyncAction; + } + export interface IPathIOStatics { + readTextAsync(absolutePath: string): Windows.Foundation.IAsyncOperation; + readTextAsync(absolutePath: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncOperation; + writeTextAsync(absolutePath: string, contents: string): Windows.Foundation.IAsyncAction; + writeTextAsync(absolutePath: string, contents: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + appendTextAsync(absolutePath: string, contents: string): Windows.Foundation.IAsyncAction; + appendTextAsync(absolutePath: string, contents: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + readLinesAsync(absolutePath: string): Windows.Foundation.IAsyncOperation>; + readLinesAsync(absolutePath: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncOperation>; + writeLinesAsync(absolutePath: string, lines: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncAction; + writeLinesAsync(absolutePath: string, lines: Windows.Foundation.Collections.IIterable, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + appendLinesAsync(absolutePath: string, lines: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncAction; + appendLinesAsync(absolutePath: string, lines: Windows.Foundation.Collections.IIterable, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + readBufferAsync(absolutePath: string): Windows.Foundation.IAsyncOperation; + writeBufferAsync(absolutePath: string, buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncAction; + writeBytesAsync(absolutePath: string, buffer: Uint8Array): Windows.Foundation.IAsyncAction; + } + export class PathIO { + static readTextAsync(absolutePath: string): Windows.Foundation.IAsyncOperation; + static readTextAsync(absolutePath: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncOperation; + static writeTextAsync(absolutePath: string, contents: string): Windows.Foundation.IAsyncAction; + static writeTextAsync(absolutePath: string, contents: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + static appendTextAsync(absolutePath: string, contents: string): Windows.Foundation.IAsyncAction; + static appendTextAsync(absolutePath: string, contents: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + static readLinesAsync(absolutePath: string): Windows.Foundation.IAsyncOperation>; + static readLinesAsync(absolutePath: string, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncOperation>; + static writeLinesAsync(absolutePath: string, lines: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncAction; + static writeLinesAsync(absolutePath: string, lines: Windows.Foundation.Collections.IIterable, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + static appendLinesAsync(absolutePath: string, lines: Windows.Foundation.Collections.IIterable): Windows.Foundation.IAsyncAction; + static appendLinesAsync(absolutePath: string, lines: Windows.Foundation.Collections.IIterable, encoding: Windows.Storage.Streams.UnicodeEncoding): Windows.Foundation.IAsyncAction; + static readBufferAsync(absolutePath: string): Windows.Foundation.IAsyncOperation; + static writeBufferAsync(absolutePath: string, buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncAction; + static writeBytesAsync(absolutePath: string, buffer: Uint8Array): Windows.Foundation.IAsyncAction; + } + export interface ICachedFileManagerStatics { + deferUpdates(file: Windows.Storage.IStorageFile): void; + completeUpdatesAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + } + export class CachedFileManager { + static deferUpdates(file: Windows.Storage.IStorageFile): void; + static completeUpdatesAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + } + export interface IStorageStreamTransaction extends Windows.Foundation.IClosable { + stream: Windows.Storage.Streams.IRandomAccessStream; + commitAsync(): Windows.Foundation.IAsyncAction; + } + export enum ApplicationDataLocality { + local, + roaming, + temporary, + } + export enum ApplicationDataCreateDisposition { + always, + existing, + } + export interface IApplicationDataStatics { + current: Windows.Storage.ApplicationData; + } + export class ApplicationData implements Windows.Storage.IApplicationData { + localFolder: Windows.Storage.StorageFolder; + localSettings: Windows.Storage.ApplicationDataContainer; + roamingFolder: Windows.Storage.StorageFolder; + roamingSettings: Windows.Storage.ApplicationDataContainer; + roamingStorageQuota: number; + temporaryFolder: Windows.Storage.StorageFolder; + version: number; + setVersionAsync(desiredVersion: number, handler: Windows.Storage.ApplicationDataSetVersionHandler): Windows.Foundation.IAsyncAction; + clearAsync(): Windows.Foundation.IAsyncAction; + clearAsync(locality: Windows.Storage.ApplicationDataLocality): Windows.Foundation.IAsyncAction; + ondatachanged: any/* TODO */; + signalDataChanged(): void; + static current: Windows.Storage.ApplicationData; + } + export interface IApplicationData { + localFolder: Windows.Storage.StorageFolder; + localSettings: Windows.Storage.ApplicationDataContainer; + roamingFolder: Windows.Storage.StorageFolder; + roamingSettings: Windows.Storage.ApplicationDataContainer; + roamingStorageQuota: number; + temporaryFolder: Windows.Storage.StorageFolder; + version: number; + setVersionAsync(desiredVersion: number, handler: Windows.Storage.ApplicationDataSetVersionHandler): Windows.Foundation.IAsyncAction; + clearAsync(): Windows.Foundation.IAsyncAction; + clearAsync(locality: Windows.Storage.ApplicationDataLocality): Windows.Foundation.IAsyncAction; + ondatachanged: any/* TODO */; + signalDataChanged(): void; + } + export interface ApplicationDataSetVersionHandler { + (setVersionRequest: Windows.Storage.SetVersionRequest): void; + } + export class SetVersionRequest implements Windows.Storage.ISetVersionRequest { + currentVersion: number; + desiredVersion: number; + getDeferral(): Windows.Storage.SetVersionDeferral; + } + export class ApplicationDataContainer implements Windows.Storage.IApplicationDataContainer { + containers: Windows.Foundation.Collections.IMapView; + locality: Windows.Storage.ApplicationDataLocality; + name: string; + values: Windows.Foundation.Collections.IPropertySet; + createContainer(name: string, disposition: Windows.Storage.ApplicationDataCreateDisposition): Windows.Storage.ApplicationDataContainer; + deleteContainer(name: string): void; + } + export interface ISetVersionRequest { + currentVersion: number; + desiredVersion: number; + getDeferral(): Windows.Storage.SetVersionDeferral; + } + export class SetVersionDeferral implements Windows.Storage.ISetVersionDeferral { + complete(): void; + } + export interface ISetVersionDeferral { + complete(): void; + } + export interface IApplicationDataContainer { + containers: Windows.Foundation.Collections.IMapView; + locality: Windows.Storage.ApplicationDataLocality; + name: string; + values: Windows.Foundation.Collections.IPropertySet; + createContainer(name: string, disposition: Windows.Storage.ApplicationDataCreateDisposition): Windows.Storage.ApplicationDataContainer; + deleteContainer(name: string): void; + } + export class ApplicationDataContainerSettings implements Windows.Foundation.Collections.IPropertySet, Windows.Foundation.Collections.IObservableMap, Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + size: number; + onmapchanged: any/* TODO */; + lookup(key: string): any; + hasKey(key: string): boolean; + getView(): Windows.Foundation.Collections.IMapView; + insert(key: string, value: any): boolean; + remove(key: string): void; + clear(): void; + first(): Windows.Foundation.Collections.IIterator>; + } + export class ApplicationDataCompositeValue implements Windows.Foundation.Collections.IPropertySet, Windows.Foundation.Collections.IObservableMap, Windows.Foundation.Collections.IMap, Windows.Foundation.Collections.IIterable> { + size: number; + onmapchanged: any/* TODO */; + lookup(key: string): any; + hasKey(key: string): boolean; + getView(): Windows.Foundation.Collections.IMapView; + insert(key: string, value: any): boolean; + remove(key: string): void; + clear(): void; + first(): Windows.Foundation.Collections.IIterator>; + } + } +} +declare module Windows { + export module Storage { + export module Search { + export interface SortEntry { + propertyName: string; + ascendingOrder: boolean; + } + export enum DateStackOption { + none, + year, + month, + } + export enum IndexerOption { + useIndexerWhenAvailable, + onlyUseIndexer, + doNotUseIndexer, + } + export enum FolderDepth { + shallow, + deep, + } + export enum CommonFileQuery { + defaultQuery, + orderByName, + orderByTitle, + orderByMusicProperties, + orderBySearchRank, + orderByDate, + } + export enum CommonFolderQuery { + defaultQuery, + groupByYear, + groupByMonth, + groupByArtist, + groupByAlbum, + groupByAlbumArtist, + groupByComposer, + groupByGenre, + groupByPublishedYear, + groupByRating, + groupByTag, + groupByAuthor, + groupByType, + } + export enum IndexedState { + unknown, + notIndexed, + partiallyIndexed, + fullyIndexed, + } + export interface IQueryOptions { + applicationSearchFilter: string; + dateStackOption: Windows.Storage.Search.DateStackOption; + fileTypeFilter: Windows.Foundation.Collections.IVector; + folderDepth: Windows.Storage.Search.FolderDepth; + groupPropertyName: string; + indexerOption: Windows.Storage.Search.IndexerOption; + language: string; + sortOrder: Windows.Foundation.Collections.IVector; + userSearchFilter: string; + saveToString(): string; + loadFromString(value: string): void; + setThumbnailPrefetch(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number, options: Windows.Storage.FileProperties.ThumbnailOptions): void; + setPropertyPrefetch(options: Windows.Storage.FileProperties.PropertyPrefetchOptions, propertiesToRetrieve: Windows.Foundation.Collections.IIterable): void; + } + export interface IQueryOptionsFactory { + createCommonFileQuery(query: Windows.Storage.Search.CommonFileQuery, fileTypeFilter: Windows.Foundation.Collections.IIterable): Windows.Storage.Search.QueryOptions; + createCommonFolderQuery(query: Windows.Storage.Search.CommonFolderQuery): Windows.Storage.Search.QueryOptions; + } + export class QueryOptions implements Windows.Storage.Search.IQueryOptions { + constructor(query: Windows.Storage.Search.CommonFileQuery, fileTypeFilter: Windows.Foundation.Collections.IIterable); + constructor(query: Windows.Storage.Search.CommonFolderQuery); + constructor(); + applicationSearchFilter: string; + dateStackOption: Windows.Storage.Search.DateStackOption; + fileTypeFilter: Windows.Foundation.Collections.IVector; + folderDepth: Windows.Storage.Search.FolderDepth; + groupPropertyName: string; + indexerOption: Windows.Storage.Search.IndexerOption; + language: string; + sortOrder: Windows.Foundation.Collections.IVector; + userSearchFilter: string; + saveToString(): string; + loadFromString(value: string): void; + setThumbnailPrefetch(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number, options: Windows.Storage.FileProperties.ThumbnailOptions): void; + setPropertyPrefetch(options: Windows.Storage.FileProperties.PropertyPrefetchOptions, propertiesToRetrieve: Windows.Foundation.Collections.IIterable): void; + } + export interface IStorageQueryResultBase { + folder: Windows.Storage.StorageFolder; + getItemCountAsync(): Windows.Foundation.IAsyncOperation; + oncontentschanged: any/* TODO */; + onoptionschanged: any/* TODO */; + findStartIndexAsync(value: any): Windows.Foundation.IAsyncOperation; + getCurrentQueryOptions(): Windows.Storage.Search.QueryOptions; + applyNewQueryOptions(newQueryOptions: Windows.Storage.Search.QueryOptions): void; + } + export interface IStorageFileQueryResult extends Windows.Storage.Search.IStorageQueryResultBase { + getFilesAsync(startIndex: number, maxNumberOfItems: number): Windows.Foundation.IAsyncOperation>; + getFilesAsync(): Windows.Foundation.IAsyncOperation>; + } + export interface IStorageFolderQueryResult extends Windows.Storage.Search.IStorageQueryResultBase { + getFoldersAsync(startIndex: number, maxNumberOfItems: number): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(): Windows.Foundation.IAsyncOperation>; + } + export interface IStorageItemQueryResult extends Windows.Storage.Search.IStorageQueryResultBase { + getItemsAsync(startIndex: number, maxNumberOfItems: number): Windows.Foundation.IAsyncOperation>; + getItemsAsync(): Windows.Foundation.IAsyncOperation>; + } + export interface IStorageFolderQueryOperations { + getIndexedStateAsync(): Windows.Foundation.IAsyncOperation; + createFileQuery(): Windows.Storage.Search.StorageFileQueryResult; + createFileQuery(query: Windows.Storage.Search.CommonFileQuery): Windows.Storage.Search.StorageFileQueryResult; + createFileQueryWithOptions(queryOptions: Windows.Storage.Search.QueryOptions): Windows.Storage.Search.StorageFileQueryResult; + createFolderQuery(): Windows.Storage.Search.StorageFolderQueryResult; + createFolderQuery(query: Windows.Storage.Search.CommonFolderQuery): Windows.Storage.Search.StorageFolderQueryResult; + createFolderQueryWithOptions(queryOptions: Windows.Storage.Search.QueryOptions): Windows.Storage.Search.StorageFolderQueryResult; + createItemQuery(): Windows.Storage.Search.StorageItemQueryResult; + createItemQueryWithOptions(queryOptions: Windows.Storage.Search.QueryOptions): Windows.Storage.Search.StorageItemQueryResult; + getFilesAsync(query: Windows.Storage.Search.CommonFileQuery, startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getFilesAsync(query: Windows.Storage.Search.CommonFileQuery): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(query: Windows.Storage.Search.CommonFolderQuery, startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(query: Windows.Storage.Search.CommonFolderQuery): Windows.Foundation.IAsyncOperation>; + getItemsAsync(startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + areQueryOptionsSupported(queryOptions: Windows.Storage.Search.QueryOptions): boolean; + isCommonFolderQuerySupported(query: Windows.Storage.Search.CommonFolderQuery): boolean; + isCommonFileQuerySupported(query: Windows.Storage.Search.CommonFileQuery): boolean; + } + export class StorageFileQueryResult implements Windows.Storage.Search.IStorageFileQueryResult, Windows.Storage.Search.IStorageQueryResultBase { + folder: Windows.Storage.StorageFolder; + getFilesAsync(startIndex: number, maxNumberOfItems: number): Windows.Foundation.IAsyncOperation>; + getFilesAsync(): Windows.Foundation.IAsyncOperation>; + getItemCountAsync(): Windows.Foundation.IAsyncOperation; + oncontentschanged: any/* TODO */; + onoptionschanged: any/* TODO */; + findStartIndexAsync(value: any): Windows.Foundation.IAsyncOperation; + getCurrentQueryOptions(): Windows.Storage.Search.QueryOptions; + applyNewQueryOptions(newQueryOptions: Windows.Storage.Search.QueryOptions): void; + } + export class StorageFolderQueryResult implements Windows.Storage.Search.IStorageFolderQueryResult, Windows.Storage.Search.IStorageQueryResultBase { + folder: Windows.Storage.StorageFolder; + getFoldersAsync(startIndex: number, maxNumberOfItems: number): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(): Windows.Foundation.IAsyncOperation>; + getItemCountAsync(): Windows.Foundation.IAsyncOperation; + oncontentschanged: any/* TODO */; + onoptionschanged: any/* TODO */; + findStartIndexAsync(value: any): Windows.Foundation.IAsyncOperation; + getCurrentQueryOptions(): Windows.Storage.Search.QueryOptions; + applyNewQueryOptions(newQueryOptions: Windows.Storage.Search.QueryOptions): void; + } + export class StorageItemQueryResult implements Windows.Storage.Search.IStorageItemQueryResult, Windows.Storage.Search.IStorageQueryResultBase { + folder: Windows.Storage.StorageFolder; + getItemsAsync(startIndex: number, maxNumberOfItems: number): Windows.Foundation.IAsyncOperation>; + getItemsAsync(): Windows.Foundation.IAsyncOperation>; + getItemCountAsync(): Windows.Foundation.IAsyncOperation; + oncontentschanged: any/* TODO */; + onoptionschanged: any/* TODO */; + findStartIndexAsync(value: any): Windows.Foundation.IAsyncOperation; + getCurrentQueryOptions(): Windows.Storage.Search.QueryOptions; + applyNewQueryOptions(newQueryOptions: Windows.Storage.Search.QueryOptions): void; + } + export class SortEntryVector implements Windows.Foundation.Collections.IVector, Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): Windows.Storage.Search.SortEntry; + getView(): Windows.Foundation.Collections.IVectorView; + indexOf(value: Windows.Storage.Search.SortEntry): { index: number; returnValue: boolean; }; + setAt(index: number, value: Windows.Storage.Search.SortEntry): void; + insertAt(index: number, value: Windows.Storage.Search.SortEntry): void; + removeAt(index: number): void; + append(value: Windows.Storage.Search.SortEntry): void; + removeAtEnd(): void; + clear(): void; + getMany(startIndex: number): { items: Windows.Storage.Search.SortEntry[]; returnValue: number; }; + replaceAll(items: Windows.Storage.Search.SortEntry[]): void; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.Storage.Search.SortEntry[][]): Windows.Storage.Search.SortEntry[]; + join(seperator: string): string; + pop(): Windows.Storage.Search.SortEntry; + push(...items: Windows.Storage.Search.SortEntry[]): void; + reverse(): Windows.Storage.Search.SortEntry[]; + shift(): Windows.Storage.Search.SortEntry; + slice(start: number): Windows.Storage.Search.SortEntry[]; + slice(start: number, end: number): Windows.Storage.Search.SortEntry[]; + sort(): Windows.Storage.Search.SortEntry[]; + sort(compareFn: (a: Windows.Storage.Search.SortEntry, b: Windows.Storage.Search.SortEntry) => number): Windows.Storage.Search.SortEntry[]; + splice(start: number): Windows.Storage.Search.SortEntry[]; + splice(start: number, deleteCount: number, ...items: Windows.Storage.Search.SortEntry[]): Windows.Storage.Search.SortEntry[]; + unshift(...items: Windows.Storage.Search.SortEntry[]): number; + lastIndexOf(searchElement: Windows.Storage.Search.SortEntry): number; + lastIndexOf(searchElement: Windows.Storage.Search.SortEntry, fromIndex: number): number; + every(callbackfn: (value: Windows.Storage.Search.SortEntry, index: number, array: Windows.Storage.Search.SortEntry[]) => boolean): boolean; + every(callbackfn: (value: Windows.Storage.Search.SortEntry, index: number, array: Windows.Storage.Search.SortEntry[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.Storage.Search.SortEntry, index: number, array: Windows.Storage.Search.SortEntry[]) => boolean): boolean; + some(callbackfn: (value: Windows.Storage.Search.SortEntry, index: number, array: Windows.Storage.Search.SortEntry[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.Storage.Search.SortEntry, index: number, array: Windows.Storage.Search.SortEntry[]) => void ): void; + forEach(callbackfn: (value: Windows.Storage.Search.SortEntry, index: number, array: Windows.Storage.Search.SortEntry[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.Storage.Search.SortEntry, index: number, array: Windows.Storage.Search.SortEntry[]) => any): any[]; + map(callbackfn: (value: Windows.Storage.Search.SortEntry, index: number, array: Windows.Storage.Search.SortEntry[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.Storage.Search.SortEntry, index: number, array: Windows.Storage.Search.SortEntry[]) => boolean): Windows.Storage.Search.SortEntry[]; + filter(callbackfn: (value: Windows.Storage.Search.SortEntry, index: number, array: Windows.Storage.Search.SortEntry[]) => boolean, thisArg: any): Windows.Storage.Search.SortEntry[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.Search.SortEntry[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.Search.SortEntry[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.Search.SortEntry[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.Search.SortEntry[]) => any, initialValue: any): any; + length: number; + } + } + } +} +declare module Windows { + export module Storage { + export module AccessCache { + export interface AccessListEntry { + token: string; + metadata: string; + } + export interface IItemRemovedEventArgs { + removedEntry: Windows.Storage.AccessCache.AccessListEntry; + } + export class AccessListEntryView implements Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): Windows.Storage.AccessCache.AccessListEntry; + indexOf(value: Windows.Storage.AccessCache.AccessListEntry): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: Windows.Storage.AccessCache.AccessListEntry[]; returnValue: number; }; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.Storage.AccessCache.AccessListEntry[][]): Windows.Storage.AccessCache.AccessListEntry[]; + join(seperator: string): string; + pop(): Windows.Storage.AccessCache.AccessListEntry; + push(...items: Windows.Storage.AccessCache.AccessListEntry[]): void; + reverse(): Windows.Storage.AccessCache.AccessListEntry[]; + shift(): Windows.Storage.AccessCache.AccessListEntry; + slice(start: number): Windows.Storage.AccessCache.AccessListEntry[]; + slice(start: number, end: number): Windows.Storage.AccessCache.AccessListEntry[]; + sort(): Windows.Storage.AccessCache.AccessListEntry[]; + sort(compareFn: (a: Windows.Storage.AccessCache.AccessListEntry, b: Windows.Storage.AccessCache.AccessListEntry) => number): Windows.Storage.AccessCache.AccessListEntry[]; + splice(start: number): Windows.Storage.AccessCache.AccessListEntry[]; + splice(start: number, deleteCount: number, ...items: Windows.Storage.AccessCache.AccessListEntry[]): Windows.Storage.AccessCache.AccessListEntry[]; + unshift(...items: Windows.Storage.AccessCache.AccessListEntry[]): number; + lastIndexOf(searchElement: Windows.Storage.AccessCache.AccessListEntry): number; + lastIndexOf(searchElement: Windows.Storage.AccessCache.AccessListEntry, fromIndex: number): number; + every(callbackfn: (value: Windows.Storage.AccessCache.AccessListEntry, index: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => boolean): boolean; + every(callbackfn: (value: Windows.Storage.AccessCache.AccessListEntry, index: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.Storage.AccessCache.AccessListEntry, index: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => boolean): boolean; + some(callbackfn: (value: Windows.Storage.AccessCache.AccessListEntry, index: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.Storage.AccessCache.AccessListEntry, index: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => void ): void; + forEach(callbackfn: (value: Windows.Storage.AccessCache.AccessListEntry, index: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.Storage.AccessCache.AccessListEntry, index: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => any): any[]; + map(callbackfn: (value: Windows.Storage.AccessCache.AccessListEntry, index: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.Storage.AccessCache.AccessListEntry, index: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => boolean): Windows.Storage.AccessCache.AccessListEntry[]; + filter(callbackfn: (value: Windows.Storage.AccessCache.AccessListEntry, index: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => boolean, thisArg: any): Windows.Storage.AccessCache.AccessListEntry[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.AccessCache.AccessListEntry[]) => any, initialValue: any): any; + length: number; + } + export enum AccessCacheOptions { + none, + disallowUserInput, + fastLocationsOnly, + useReadOnlyCachedCopy, + suppressAccessTimeUpdate, + } + export interface IStorageItemAccessList { + entries: Windows.Storage.AccessCache.AccessListEntryView; + maximumItemsAllowed: number; + add(file: Windows.Storage.IStorageItem): string; + add(file: Windows.Storage.IStorageItem, metadata: string): string; + addOrReplace(token: string, file: Windows.Storage.IStorageItem): void; + addOrReplace(token: string, file: Windows.Storage.IStorageItem, metadata: string): void; + getItemAsync(token: string): Windows.Foundation.IAsyncOperation; + getFileAsync(token: string): Windows.Foundation.IAsyncOperation; + getFolderAsync(token: string): Windows.Foundation.IAsyncOperation; + getItemAsync(token: string, options: Windows.Storage.AccessCache.AccessCacheOptions): Windows.Foundation.IAsyncOperation; + getFileAsync(token: string, options: Windows.Storage.AccessCache.AccessCacheOptions): Windows.Foundation.IAsyncOperation; + getFolderAsync(token: string, options: Windows.Storage.AccessCache.AccessCacheOptions): Windows.Foundation.IAsyncOperation; + remove(token: string): void; + containsItem(token: string): boolean; + clear(): void; + checkAccess(file: Windows.Storage.IStorageItem): boolean; + } + export interface IStorageItemMostRecentlyUsedList extends Windows.Storage.AccessCache.IStorageItemAccessList { + onitemremoved: any/* TODO */; + } + export class StorageItemMostRecentlyUsedList implements Windows.Storage.AccessCache.IStorageItemMostRecentlyUsedList, Windows.Storage.AccessCache.IStorageItemAccessList { + entries: Windows.Storage.AccessCache.AccessListEntryView; + maximumItemsAllowed: number; + onitemremoved: any/* TODO */; + add(file: Windows.Storage.IStorageItem): string; + add(file: Windows.Storage.IStorageItem, metadata: string): string; + addOrReplace(token: string, file: Windows.Storage.IStorageItem): void; + addOrReplace(token: string, file: Windows.Storage.IStorageItem, metadata: string): void; + getItemAsync(token: string): Windows.Foundation.IAsyncOperation; + getFileAsync(token: string): Windows.Foundation.IAsyncOperation; + getFolderAsync(token: string): Windows.Foundation.IAsyncOperation; + getItemAsync(token: string, options: Windows.Storage.AccessCache.AccessCacheOptions): Windows.Foundation.IAsyncOperation; + getFileAsync(token: string, options: Windows.Storage.AccessCache.AccessCacheOptions): Windows.Foundation.IAsyncOperation; + getFolderAsync(token: string, options: Windows.Storage.AccessCache.AccessCacheOptions): Windows.Foundation.IAsyncOperation; + remove(token: string): void; + containsItem(token: string): boolean; + clear(): void; + checkAccess(file: Windows.Storage.IStorageItem): boolean; + } + export class ItemRemovedEventArgs implements Windows.Storage.AccessCache.IItemRemovedEventArgs { + removedEntry: Windows.Storage.AccessCache.AccessListEntry; + } + export interface IStorageApplicationPermissionsStatics { + futureAccessList: Windows.Storage.AccessCache.StorageItemAccessList; + mostRecentlyUsedList: Windows.Storage.AccessCache.StorageItemMostRecentlyUsedList; + } + export class StorageItemAccessList implements Windows.Storage.AccessCache.IStorageItemAccessList { + entries: Windows.Storage.AccessCache.AccessListEntryView; + maximumItemsAllowed: number; + add(file: Windows.Storage.IStorageItem): string; + add(file: Windows.Storage.IStorageItem, metadata: string): string; + addOrReplace(token: string, file: Windows.Storage.IStorageItem): void; + addOrReplace(token: string, file: Windows.Storage.IStorageItem, metadata: string): void; + getItemAsync(token: string): Windows.Foundation.IAsyncOperation; + getFileAsync(token: string): Windows.Foundation.IAsyncOperation; + getFolderAsync(token: string): Windows.Foundation.IAsyncOperation; + getItemAsync(token: string, options: Windows.Storage.AccessCache.AccessCacheOptions): Windows.Foundation.IAsyncOperation; + getFileAsync(token: string, options: Windows.Storage.AccessCache.AccessCacheOptions): Windows.Foundation.IAsyncOperation; + getFolderAsync(token: string, options: Windows.Storage.AccessCache.AccessCacheOptions): Windows.Foundation.IAsyncOperation; + remove(token: string): void; + containsItem(token: string): boolean; + clear(): void; + checkAccess(file: Windows.Storage.IStorageItem): boolean; + } + export class StorageApplicationPermissions { + static futureAccessList: Windows.Storage.AccessCache.StorageItemAccessList; + static mostRecentlyUsedList: Windows.Storage.AccessCache.StorageItemMostRecentlyUsedList; + } + } + } +} +declare module Windows { + export module Storage { + export module BulkAccess { + export interface IStorageItemInformation { + basicProperties: Windows.Storage.FileProperties.BasicProperties; + documentProperties: Windows.Storage.FileProperties.DocumentProperties; + imageProperties: Windows.Storage.FileProperties.ImageProperties; + musicProperties: Windows.Storage.FileProperties.MusicProperties; + thumbnail: Windows.Storage.FileProperties.StorageItemThumbnail; + videoProperties: Windows.Storage.FileProperties.VideoProperties; + onthumbnailupdated: any/* TODO */; + onpropertiesupdated: any/* TODO */; + } + export interface IFileInformationFactoryFactory { + createWithMode(queryResult: Windows.Storage.Search.IStorageQueryResultBase, mode: Windows.Storage.FileProperties.ThumbnailMode): Windows.Storage.BulkAccess.FileInformationFactory; + createWithModeAndSize(queryResult: Windows.Storage.Search.IStorageQueryResultBase, mode: Windows.Storage.FileProperties.ThumbnailMode, requestedThumbnailSize: number): Windows.Storage.BulkAccess.FileInformationFactory; + createWithModeAndSizeAndOptions(queryResult: Windows.Storage.Search.IStorageQueryResultBase, mode: Windows.Storage.FileProperties.ThumbnailMode, requestedThumbnailSize: number, thumbnailOptions: Windows.Storage.FileProperties.ThumbnailOptions): Windows.Storage.BulkAccess.FileInformationFactory; + createWithModeAndSizeAndOptionsAndFlags(queryResult: Windows.Storage.Search.IStorageQueryResultBase, mode: Windows.Storage.FileProperties.ThumbnailMode, requestedThumbnailSize: number, thumbnailOptions: Windows.Storage.FileProperties.ThumbnailOptions, delayLoad: boolean): Windows.Storage.BulkAccess.FileInformationFactory; + } + export class FileInformationFactory implements Windows.Storage.BulkAccess.IFileInformationFactory { + constructor(queryResult: Windows.Storage.Search.IStorageQueryResultBase, mode: Windows.Storage.FileProperties.ThumbnailMode); + constructor(queryResult: Windows.Storage.Search.IStorageQueryResultBase, mode: Windows.Storage.FileProperties.ThumbnailMode, requestedThumbnailSize: number); + constructor(queryResult: Windows.Storage.Search.IStorageQueryResultBase, mode: Windows.Storage.FileProperties.ThumbnailMode, requestedThumbnailSize: number, thumbnailOptions: Windows.Storage.FileProperties.ThumbnailOptions); + constructor(queryResult: Windows.Storage.Search.IStorageQueryResultBase, mode: Windows.Storage.FileProperties.ThumbnailMode, requestedThumbnailSize: number, thumbnailOptions: Windows.Storage.FileProperties.ThumbnailOptions, delayLoad: boolean); + getItemsAsync(startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getItemsAsync(): Windows.Foundation.IAsyncOperation>; + getFilesAsync(startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getFilesAsync(): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(): Windows.Foundation.IAsyncOperation>; + getVirtualizedItemsVector(): any; + getVirtualizedFilesVector(): any; + getVirtualizedFoldersVector(): any; + } + export interface IFileInformationFactory { + getItemsAsync(startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getItemsAsync(): Windows.Foundation.IAsyncOperation>; + getFilesAsync(startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getFilesAsync(): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(): Windows.Foundation.IAsyncOperation>; + getVirtualizedItemsVector(): any; + getVirtualizedFilesVector(): any; + getVirtualizedFoldersVector(): any; + } + export class FileInformation implements Windows.Storage.BulkAccess.IStorageItemInformation, Windows.Storage.IStorageFile, Windows.Storage.IStorageItem, Windows.Storage.Streams.IRandomAccessStreamReference, Windows.Storage.Streams.IInputStreamReference, Windows.Storage.IStorageItemProperties { + basicProperties: Windows.Storage.FileProperties.BasicProperties; + documentProperties: Windows.Storage.FileProperties.DocumentProperties; + imageProperties: Windows.Storage.FileProperties.ImageProperties; + musicProperties: Windows.Storage.FileProperties.MusicProperties; + thumbnail: Windows.Storage.FileProperties.StorageItemThumbnail; + videoProperties: Windows.Storage.FileProperties.VideoProperties; + contentType: string; + fileType: string; + attributes: Windows.Storage.FileAttributes; + dateCreated: Date; + name: string; + path: string; + displayName: string; + displayType: string; + folderRelativeId: string; + properties: Windows.Storage.FileProperties.StorageItemContentProperties; + onthumbnailupdated: any/* TODO */; + onpropertiesupdated: any/* TODO */; + openAsync(accessMode: Windows.Storage.FileAccessMode): Windows.Foundation.IAsyncOperation; + openTransactedWriteAsync(): Windows.Foundation.IAsyncOperation; + copyAsync(destinationFolder: Windows.Storage.IStorageFolder): Windows.Foundation.IAsyncOperation; + copyAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string): Windows.Foundation.IAsyncOperation; + copyAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncOperation; + copyAndReplaceAsync(fileToReplace: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + moveAsync(destinationFolder: Windows.Storage.IStorageFolder): Windows.Foundation.IAsyncAction; + moveAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string): Windows.Foundation.IAsyncAction; + moveAsync(destinationFolder: Windows.Storage.IStorageFolder, desiredNewName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncAction; + moveAndReplaceAsync(fileToReplace: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + renameAsync(desiredName: string): Windows.Foundation.IAsyncAction; + renameAsync(desiredName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncAction; + deleteAsync(): Windows.Foundation.IAsyncAction; + deleteAsync(option: Windows.Storage.StorageDeleteOption): Windows.Foundation.IAsyncAction; + getBasicPropertiesAsync(): Windows.Foundation.IAsyncOperation; + isOfType(type: Windows.Storage.StorageItemTypes): boolean; + openReadAsync(): Windows.Foundation.IAsyncOperation; + openSequentialReadAsync(): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number, options: Windows.Storage.FileProperties.ThumbnailOptions): Windows.Foundation.IAsyncOperation; + } + export class FolderInformation implements Windows.Storage.BulkAccess.IStorageItemInformation, Windows.Storage.IStorageFolder, Windows.Storage.IStorageItem, Windows.Storage.IStorageItemProperties, Windows.Storage.Search.IStorageFolderQueryOperations { + basicProperties: Windows.Storage.FileProperties.BasicProperties; + documentProperties: Windows.Storage.FileProperties.DocumentProperties; + imageProperties: Windows.Storage.FileProperties.ImageProperties; + musicProperties: Windows.Storage.FileProperties.MusicProperties; + thumbnail: Windows.Storage.FileProperties.StorageItemThumbnail; + videoProperties: Windows.Storage.FileProperties.VideoProperties; + attributes: Windows.Storage.FileAttributes; + dateCreated: Date; + name: string; + path: string; + displayName: string; + displayType: string; + folderRelativeId: string; + properties: Windows.Storage.FileProperties.StorageItemContentProperties; + onthumbnailupdated: any/* TODO */; + onpropertiesupdated: any/* TODO */; + createFileAsync(desiredName: string): Windows.Foundation.IAsyncOperation; + createFileAsync(desiredName: string, options: Windows.Storage.CreationCollisionOption): Windows.Foundation.IAsyncOperation; + createFolderAsync(desiredName: string): Windows.Foundation.IAsyncOperation; + createFolderAsync(desiredName: string, options: Windows.Storage.CreationCollisionOption): Windows.Foundation.IAsyncOperation; + getFileAsync(name: string): Windows.Foundation.IAsyncOperation; + getFolderAsync(name: string): Windows.Foundation.IAsyncOperation; + getItemAsync(name: string): Windows.Foundation.IAsyncOperation; + getFilesAsync(): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(): Windows.Foundation.IAsyncOperation>; + getItemsAsync(): Windows.Foundation.IAsyncOperation>; + renameAsync(desiredName: string): Windows.Foundation.IAsyncAction; + renameAsync(desiredName: string, option: Windows.Storage.NameCollisionOption): Windows.Foundation.IAsyncAction; + deleteAsync(): Windows.Foundation.IAsyncAction; + deleteAsync(option: Windows.Storage.StorageDeleteOption): Windows.Foundation.IAsyncAction; + getBasicPropertiesAsync(): Windows.Foundation.IAsyncOperation; + isOfType(type: Windows.Storage.StorageItemTypes): boolean; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number): Windows.Foundation.IAsyncOperation; + getThumbnailAsync(mode: Windows.Storage.FileProperties.ThumbnailMode, requestedSize: number, options: Windows.Storage.FileProperties.ThumbnailOptions): Windows.Foundation.IAsyncOperation; + getIndexedStateAsync(): Windows.Foundation.IAsyncOperation; + createFileQuery(): Windows.Storage.Search.StorageFileQueryResult; + createFileQuery(query: Windows.Storage.Search.CommonFileQuery): Windows.Storage.Search.StorageFileQueryResult; + createFileQueryWithOptions(queryOptions: Windows.Storage.Search.QueryOptions): Windows.Storage.Search.StorageFileQueryResult; + createFolderQuery(): Windows.Storage.Search.StorageFolderQueryResult; + createFolderQuery(query: Windows.Storage.Search.CommonFolderQuery): Windows.Storage.Search.StorageFolderQueryResult; + createFolderQueryWithOptions(queryOptions: Windows.Storage.Search.QueryOptions): Windows.Storage.Search.StorageFolderQueryResult; + createItemQuery(): Windows.Storage.Search.StorageItemQueryResult; + createItemQueryWithOptions(queryOptions: Windows.Storage.Search.QueryOptions): Windows.Storage.Search.StorageItemQueryResult; + getFilesAsync(query: Windows.Storage.Search.CommonFileQuery, startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getFilesAsync(query: Windows.Storage.Search.CommonFileQuery): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(query: Windows.Storage.Search.CommonFolderQuery, startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + getFoldersAsync(query: Windows.Storage.Search.CommonFolderQuery): Windows.Foundation.IAsyncOperation>; + getItemsAsync(startIndex: number, maxItemsToRetrieve: number): Windows.Foundation.IAsyncOperation>; + areQueryOptionsSupported(queryOptions: Windows.Storage.Search.QueryOptions): boolean; + isCommonFolderQuerySupported(query: Windows.Storage.Search.CommonFolderQuery): boolean; + isCommonFileQuerySupported(query: Windows.Storage.Search.CommonFileQuery): boolean; + } + } + } +} +declare module Windows { + export module Storage { + export module Pickers { + export enum PickerViewMode { + list, + thumbnail, + } + export enum PickerLocationId { + documentsLibrary, + computerFolder, + desktop, + downloads, + homeGroup, + musicLibrary, + picturesLibrary, + videosLibrary, + } + export class FilePickerSelectedFilesArray implements Windows.Foundation.Collections.IVectorView, Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): Windows.Storage.StorageFile; + indexOf(value: Windows.Storage.StorageFile): { index: number; returnValue: boolean; }; + getMany(startIndex: number): { items: Windows.Storage.StorageFile[]; returnValue: number; }; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: Windows.Storage.StorageFile[][]): Windows.Storage.StorageFile[]; + join(seperator: string): string; + pop(): Windows.Storage.StorageFile; + push(...items: Windows.Storage.StorageFile[]): void; + reverse(): Windows.Storage.StorageFile[]; + shift(): Windows.Storage.StorageFile; + slice(start: number): Windows.Storage.StorageFile[]; + slice(start: number, end: number): Windows.Storage.StorageFile[]; + sort(): Windows.Storage.StorageFile[]; + sort(compareFn: (a: Windows.Storage.StorageFile, b: Windows.Storage.StorageFile) => number): Windows.Storage.StorageFile[]; + splice(start: number): Windows.Storage.StorageFile[]; + splice(start: number, deleteCount: number, ...items: Windows.Storage.StorageFile[]): Windows.Storage.StorageFile[]; + unshift(...items: Windows.Storage.StorageFile[]): number; + lastIndexOf(searchElement: Windows.Storage.StorageFile): number; + lastIndexOf(searchElement: Windows.Storage.StorageFile, fromIndex: number): number; + every(callbackfn: (value: Windows.Storage.StorageFile, index: number, array: Windows.Storage.StorageFile[]) => boolean): boolean; + every(callbackfn: (value: Windows.Storage.StorageFile, index: number, array: Windows.Storage.StorageFile[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: Windows.Storage.StorageFile, index: number, array: Windows.Storage.StorageFile[]) => boolean): boolean; + some(callbackfn: (value: Windows.Storage.StorageFile, index: number, array: Windows.Storage.StorageFile[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: Windows.Storage.StorageFile, index: number, array: Windows.Storage.StorageFile[]) => void ): void; + forEach(callbackfn: (value: Windows.Storage.StorageFile, index: number, array: Windows.Storage.StorageFile[]) => void , thisArg: any): void; + map(callbackfn: (value: Windows.Storage.StorageFile, index: number, array: Windows.Storage.StorageFile[]) => any): any[]; + map(callbackfn: (value: Windows.Storage.StorageFile, index: number, array: Windows.Storage.StorageFile[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: Windows.Storage.StorageFile, index: number, array: Windows.Storage.StorageFile[]) => boolean): Windows.Storage.StorageFile[]; + filter(callbackfn: (value: Windows.Storage.StorageFile, index: number, array: Windows.Storage.StorageFile[]) => boolean, thisArg: any): Windows.Storage.StorageFile[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.StorageFile[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.StorageFile[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.StorageFile[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Windows.Storage.StorageFile[]) => any, initialValue: any): any; + length: number; + } + export class FilePickerFileTypesOrderedMap implements Windows.Foundation.Collections.IMap>, Windows.Foundation.Collections.IIterable>> { + size: number; + lookup(key: string): Windows.Foundation.Collections.IVector; + hasKey(key: string): boolean; + getView(): Windows.Foundation.Collections.IMapView>; + insert(key: string, value: Windows.Foundation.Collections.IVector): boolean; + remove(key: string): void; + clear(): void; + first(): Windows.Foundation.Collections.IIterator>>; + } + export class FileExtensionVector implements Windows.Foundation.Collections.IVector, Windows.Foundation.Collections.IIterable { + size: number; + getAt(index: number): string; + getView(): Windows.Foundation.Collections.IVectorView; + indexOf(value: string): { index: number; returnValue: boolean; }; + setAt(index: number, value: string): void; + insertAt(index: number, value: string): void; + removeAt(index: number): void; + append(value: string): void; + removeAtEnd(): void; + clear(): void; + getMany(startIndex: number): { items: string[]; returnValue: number; }; + replaceAll(items: string[]): void; + first(): Windows.Foundation.Collections.IIterator; + toString(): string; + toLocaleString(): string; + concat(...items: string[][]): string[]; + join(seperator: string): string; + pop(): string; + push(...items: string[]): void; + reverse(): string[]; + shift(): string; + slice(start: number): string[]; + slice(start: number, end: number): string[]; + sort(): string[]; + sort(compareFn: (a: string, b: string) => number): string[]; + splice(start: number): string[]; + splice(start: number, deleteCount: number, ...items: string[]): string[]; + unshift(...items: string[]): number; + lastIndexOf(searchElement: string): number; + lastIndexOf(searchElement: string, fromIndex: number): number; + every(callbackfn: (value: string, index: number, array: string[]) => boolean): boolean; + every(callbackfn: (value: string, index: number, array: string[]) => boolean, thisArg: any): boolean; + some(callbackfn: (value: string, index: number, array: string[]) => boolean): boolean; + some(callbackfn: (value: string, index: number, array: string[]) => boolean, thisArg: any): boolean; + forEach(callbackfn: (value: string, index: number, array: string[]) => void ): void; + forEach(callbackfn: (value: string, index: number, array: string[]) => void , thisArg: any): void; + map(callbackfn: (value: string, index: number, array: string[]) => any): any[]; + map(callbackfn: (value: string, index: number, array: string[]) => any, thisArg: any): any[]; + filter(callbackfn: (value: string, index: number, array: string[]) => boolean): string[]; + filter(callbackfn: (value: string, index: number, array: string[]) => boolean, thisArg: any): string[]; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: string[]) => any): any; + reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: string[]) => any, initialValue: any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: string[]) => any): any; + reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: string[]) => any, initialValue: any): any; + length: number; + } + export interface IFileOpenPicker { + commitButtonText: string; + fileTypeFilter: Windows.Foundation.Collections.IVector; + settingsIdentifier: string; + suggestedStartLocation: Windows.Storage.Pickers.PickerLocationId; + viewMode: Windows.Storage.Pickers.PickerViewMode; + pickSingleFileAsync(): Windows.Foundation.IAsyncOperation; + pickMultipleFilesAsync(): Windows.Foundation.IAsyncOperation>; + } + export interface IFileSavePicker { + commitButtonText: string; + defaultFileExtension: string; + fileTypeChoices: Windows.Foundation.Collections.IMap>; + settingsIdentifier: string; + suggestedFileName: string; + suggestedSaveFile: Windows.Storage.StorageFile; + suggestedStartLocation: Windows.Storage.Pickers.PickerLocationId; + pickSaveFileAsync(): Windows.Foundation.IAsyncOperation; + } + export interface IFolderPicker { + commitButtonText: string; + fileTypeFilter: Windows.Foundation.Collections.IVector; + settingsIdentifier: string; + suggestedStartLocation: Windows.Storage.Pickers.PickerLocationId; + viewMode: Windows.Storage.Pickers.PickerViewMode; + pickSingleFolderAsync(): Windows.Foundation.IAsyncOperation; + } + export class FileOpenPicker implements Windows.Storage.Pickers.IFileOpenPicker { + commitButtonText: string; + fileTypeFilter: Windows.Foundation.Collections.IVector; + settingsIdentifier: string; + suggestedStartLocation: Windows.Storage.Pickers.PickerLocationId; + viewMode: Windows.Storage.Pickers.PickerViewMode; + pickSingleFileAsync(): Windows.Foundation.IAsyncOperation; + pickMultipleFilesAsync(): Windows.Foundation.IAsyncOperation>; + } + export class FileSavePicker implements Windows.Storage.Pickers.IFileSavePicker { + commitButtonText: string; + defaultFileExtension: string; + fileTypeChoices: Windows.Foundation.Collections.IMap>; + settingsIdentifier: string; + suggestedFileName: string; + suggestedSaveFile: Windows.Storage.StorageFile; + suggestedStartLocation: Windows.Storage.Pickers.PickerLocationId; + pickSaveFileAsync(): Windows.Foundation.IAsyncOperation; + } + export class FolderPicker implements Windows.Storage.Pickers.IFolderPicker { + commitButtonText: string; + fileTypeFilter: Windows.Foundation.Collections.IVector; + settingsIdentifier: string; + suggestedStartLocation: Windows.Storage.Pickers.PickerLocationId; + viewMode: Windows.Storage.Pickers.PickerViewMode; + pickSingleFolderAsync(): Windows.Foundation.IAsyncOperation; + } + } + } +} +declare module Windows { + export module Storage { + export module Compression { + export enum CompressAlgorithm { + invalidAlgorithm, + nullAlgorithm, + mszip, + xpress, + xpressHuff, + lzms, + } + export interface ICompressor extends Windows.Storage.Streams.IOutputStream, Windows.Foundation.IClosable { + finishAsync(): Windows.Foundation.IAsyncOperation; + detachStream(): Windows.Storage.Streams.IOutputStream; + } + export class Compressor implements Windows.Storage.Compression.ICompressor, Windows.Storage.Streams.IOutputStream, Windows.Foundation.IClosable { + constructor(underlyingStream: Windows.Storage.Streams.IOutputStream); + constructor(underlyingStream: Windows.Storage.Streams.IOutputStream, algorithm: Windows.Storage.Compression.CompressAlgorithm, blockSize: number); + finishAsync(): Windows.Foundation.IAsyncOperation; + detachStream(): Windows.Storage.Streams.IOutputStream; + writeAsync(buffer: Windows.Storage.Streams.IBuffer): Windows.Foundation.IAsyncOperationWithProgress; + flushAsync(): Windows.Foundation.IAsyncOperation; + dispose(): void; + close(): void; + } + export interface IDecompressor extends Windows.Storage.Streams.IInputStream, Windows.Foundation.IClosable { + detachStream(): Windows.Storage.Streams.IInputStream; + } + export class Decompressor implements Windows.Storage.Compression.IDecompressor, Windows.Storage.Streams.IInputStream, Windows.Foundation.IClosable { + constructor(underlyingStream: Windows.Storage.Streams.IInputStream); + detachStream(): Windows.Storage.Streams.IInputStream; + readAsync(buffer: Windows.Storage.Streams.IBuffer, count: number, options: Windows.Storage.Streams.InputStreamOptions): Windows.Foundation.IAsyncOperationWithProgress; + dispose(): void; + close(): void; + } + export interface ICompressorFactory { + createCompressor(underlyingStream: Windows.Storage.Streams.IOutputStream): Windows.Storage.Compression.Compressor; + createCompressorEx(underlyingStream: Windows.Storage.Streams.IOutputStream, algorithm: Windows.Storage.Compression.CompressAlgorithm, blockSize: number): Windows.Storage.Compression.Compressor; + } + export interface IDecompressorFactory { + createDecompressor(underlyingStream: Windows.Storage.Streams.IInputStream): Windows.Storage.Compression.Decompressor; + } + } + } +} +declare module Windows { + export module System { + export module Profile { + export interface IHardwareToken { + certificate: Windows.Storage.Streams.IBuffer; + id: Windows.Storage.Streams.IBuffer; + signature: Windows.Storage.Streams.IBuffer; + } + export class HardwareToken implements Windows.System.Profile.IHardwareToken { + certificate: Windows.Storage.Streams.IBuffer; + id: Windows.Storage.Streams.IBuffer; + signature: Windows.Storage.Streams.IBuffer; + } + export interface IHardwareIdentificationStatics { + getPackageSpecificToken(nonce: Windows.Storage.Streams.IBuffer): Windows.System.Profile.HardwareToken; + } + export class HardwareIdentification { + static getPackageSpecificToken(nonce: Windows.Storage.Streams.IBuffer): Windows.System.Profile.HardwareToken; + } + } + } +} +declare module Windows { + export module System { + export module Threading { + export enum WorkItemPriority { + low, + normal, + high, + } + export enum WorkItemOptions { + none, + timeSliced, + } + export interface TimerElapsedHandler { + (timer: Windows.System.Threading.ThreadPoolTimer): void; + } + export class ThreadPoolTimer implements Windows.System.Threading.IThreadPoolTimer { + delay: number; + period: number; + cancel(): void; + static createPeriodicTimer(handler: Windows.System.Threading.TimerElapsedHandler, period: number): Windows.System.Threading.ThreadPoolTimer; + static createTimer(handler: Windows.System.Threading.TimerElapsedHandler, delay: number): Windows.System.Threading.ThreadPoolTimer; + static createPeriodicTimer(handler: Windows.System.Threading.TimerElapsedHandler, period: number, destroyed: Windows.System.Threading.TimerDestroyedHandler): Windows.System.Threading.ThreadPoolTimer; + static createTimer(handler: Windows.System.Threading.TimerElapsedHandler, delay: number, destroyed: Windows.System.Threading.TimerDestroyedHandler): Windows.System.Threading.ThreadPoolTimer; + } + export interface TimerDestroyedHandler { + (timer: Windows.System.Threading.ThreadPoolTimer): void; + } + export interface WorkItemHandler { + (operation: Windows.Foundation.IAsyncAction): void; + } + export interface IThreadPoolStatics { + runAsync(handler: Windows.System.Threading.WorkItemHandler): Windows.Foundation.IAsyncAction; + runAsync(handler: Windows.System.Threading.WorkItemHandler, priority: Windows.System.Threading.WorkItemPriority): Windows.Foundation.IAsyncAction; + runAsync(handler: Windows.System.Threading.WorkItemHandler, priority: Windows.System.Threading.WorkItemPriority, options: Windows.System.Threading.WorkItemOptions): Windows.Foundation.IAsyncAction; + } + export interface IThreadPoolTimer { + delay: number; + period: number; + cancel(): void; + } + export interface IThreadPoolTimerStatics { + createPeriodicTimer(handler: Windows.System.Threading.TimerElapsedHandler, period: number): Windows.System.Threading.ThreadPoolTimer; + createTimer(handler: Windows.System.Threading.TimerElapsedHandler, delay: number): Windows.System.Threading.ThreadPoolTimer; + createPeriodicTimer(handler: Windows.System.Threading.TimerElapsedHandler, period: number, destroyed: Windows.System.Threading.TimerDestroyedHandler): Windows.System.Threading.ThreadPoolTimer; + createTimer(handler: Windows.System.Threading.TimerElapsedHandler, delay: number, destroyed: Windows.System.Threading.TimerDestroyedHandler): Windows.System.Threading.ThreadPoolTimer; + } + export class ThreadPool { + static runAsync(handler: Windows.System.Threading.WorkItemHandler): Windows.Foundation.IAsyncAction; + static runAsync(handler: Windows.System.Threading.WorkItemHandler, priority: Windows.System.Threading.WorkItemPriority): Windows.Foundation.IAsyncAction; + static runAsync(handler: Windows.System.Threading.WorkItemHandler, priority: Windows.System.Threading.WorkItemPriority, options: Windows.System.Threading.WorkItemOptions): Windows.Foundation.IAsyncAction; + } + } + } +} +declare module Windows { + export module System { + export module Threading { + export module Core { + export interface SignalHandler { + (signalNotifier: Windows.System.Threading.Core.SignalNotifier, timedOut: boolean): void; + } + export class SignalNotifier implements Windows.System.Threading.Core.ISignalNotifier { + enable(): void; + terminate(): void; + static attachToEvent(name: string, handler: Windows.System.Threading.Core.SignalHandler): Windows.System.Threading.Core.SignalNotifier; + static attachToEvent(name: string, handler: Windows.System.Threading.Core.SignalHandler, timeout: number): Windows.System.Threading.Core.SignalNotifier; + static attachToSemaphore(name: string, handler: Windows.System.Threading.Core.SignalHandler): Windows.System.Threading.Core.SignalNotifier; + static attachToSemaphore(name: string, handler: Windows.System.Threading.Core.SignalHandler, timeout: number): Windows.System.Threading.Core.SignalNotifier; + } + export interface ISignalNotifierStatics { + attachToEvent(name: string, handler: Windows.System.Threading.Core.SignalHandler): Windows.System.Threading.Core.SignalNotifier; + attachToEvent(name: string, handler: Windows.System.Threading.Core.SignalHandler, timeout: number): Windows.System.Threading.Core.SignalNotifier; + attachToSemaphore(name: string, handler: Windows.System.Threading.Core.SignalHandler): Windows.System.Threading.Core.SignalNotifier; + attachToSemaphore(name: string, handler: Windows.System.Threading.Core.SignalHandler, timeout: number): Windows.System.Threading.Core.SignalNotifier; + } + export interface IPreallocatedWorkItemFactory { + createWorkItem(handler: Windows.System.Threading.WorkItemHandler): Windows.System.Threading.Core.PreallocatedWorkItem; + createWorkItemWithPriority(handler: Windows.System.Threading.WorkItemHandler, priority: Windows.System.Threading.WorkItemPriority): Windows.System.Threading.Core.PreallocatedWorkItem; + createWorkItemWithPriorityAndOptions(handler: Windows.System.Threading.WorkItemHandler, priority: Windows.System.Threading.WorkItemPriority, options: Windows.System.Threading.WorkItemOptions): Windows.System.Threading.Core.PreallocatedWorkItem; + } + export class PreallocatedWorkItem implements Windows.System.Threading.Core.IPreallocatedWorkItem { + constructor(handler: Windows.System.Threading.WorkItemHandler); + constructor(handler: Windows.System.Threading.WorkItemHandler, priority: Windows.System.Threading.WorkItemPriority); + constructor(handler: Windows.System.Threading.WorkItemHandler, priority: Windows.System.Threading.WorkItemPriority, options: Windows.System.Threading.WorkItemOptions); + runAsync(): Windows.Foundation.IAsyncAction; + } + export interface IPreallocatedWorkItem { + runAsync(): Windows.Foundation.IAsyncAction; + } + export interface ISignalNotifier { + enable(): void; + terminate(): void; + } + } + } + } +} +declare module Windows { + export module System { + export module UserProfile { + export enum AccountPictureKind { + smallImage, + largeImage, + video, + } + export enum SetAccountPictureResult { + success, + changeDisabled, + largeOrDynamicError, + videoFrameSizeError, + fileSizeError, + failure, + } + export interface IUserInformationStatics { + accountPictureChangeEnabled: boolean; + nameAccessAllowed: boolean; + getAccountPicture(kind: Windows.System.UserProfile.AccountPictureKind): Windows.Storage.IStorageFile; + setAccountPictureAsync(image: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + setAccountPicturesAsync(smallImage: Windows.Storage.IStorageFile, largeImage: Windows.Storage.IStorageFile, video: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + setAccountPictureFromStreamAsync(image: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + setAccountPicturesFromStreamsAsync(smallImage: Windows.Storage.Streams.IRandomAccessStream, largeImage: Windows.Storage.Streams.IRandomAccessStream, video: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + onaccountpicturechanged: any/* TODO */; + getDisplayNameAsync(): Windows.Foundation.IAsyncOperation; + getFirstNameAsync(): Windows.Foundation.IAsyncOperation; + getLastNameAsync(): Windows.Foundation.IAsyncOperation; + getPrincipalNameAsync(): Windows.Foundation.IAsyncOperation; + getSessionInitiationProtocolUriAsync(): Windows.Foundation.IAsyncOperation; + getDomainNameAsync(): Windows.Foundation.IAsyncOperation; + } + export class UserInformation { + static accountPictureChangeEnabled: boolean; + static nameAccessAllowed: boolean; + static getAccountPicture(kind: Windows.System.UserProfile.AccountPictureKind): Windows.Storage.IStorageFile; + static setAccountPictureAsync(image: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + static setAccountPicturesAsync(smallImage: Windows.Storage.IStorageFile, largeImage: Windows.Storage.IStorageFile, video: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + static setAccountPictureFromStreamAsync(image: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + static setAccountPicturesFromStreamsAsync(smallImage: Windows.Storage.Streams.IRandomAccessStream, largeImage: Windows.Storage.Streams.IRandomAccessStream, video: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncOperation; + static onaccountpicturechanged: any/* TODO */; + static getDisplayNameAsync(): Windows.Foundation.IAsyncOperation; + static getFirstNameAsync(): Windows.Foundation.IAsyncOperation; + static getLastNameAsync(): Windows.Foundation.IAsyncOperation; + static getPrincipalNameAsync(): Windows.Foundation.IAsyncOperation; + static getSessionInitiationProtocolUriAsync(): Windows.Foundation.IAsyncOperation; + static getDomainNameAsync(): Windows.Foundation.IAsyncOperation; + } + export interface ILockScreenStatics { + originalImageFile: Windows.Foundation.Uri; + getImageStream(): Windows.Storage.Streams.IRandomAccessStream; + setImageFileAsync(value: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + setImageStreamAsync(value: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncAction; + } + export class LockScreen { + static originalImageFile: Windows.Foundation.Uri; + static getImageStream(): Windows.Storage.Streams.IRandomAccessStream; + static setImageFileAsync(value: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncAction; + static setImageStreamAsync(value: Windows.Storage.Streams.IRandomAccessStream): Windows.Foundation.IAsyncAction; + } + export interface IGlobalizationPreferencesStatics { + calendars: Windows.Foundation.Collections.IVectorView; + clocks: Windows.Foundation.Collections.IVectorView; + currencies: Windows.Foundation.Collections.IVectorView; + homeGeographicRegion: string; + languages: Windows.Foundation.Collections.IVectorView; + weekStartsOn: Windows.Globalization.DayOfWeek; + } + export class GlobalizationPreferences { + static calendars: Windows.Foundation.Collections.IVectorView; + static clocks: Windows.Foundation.Collections.IVectorView; + static currencies: Windows.Foundation.Collections.IVectorView; + static homeGeographicRegion: string; + static languages: Windows.Foundation.Collections.IVectorView; + static weekStartsOn: Windows.Globalization.DayOfWeek; + } + } + } +} +declare module Windows { + export module System { + export interface ILauncherUIOptions { + invocationPoint: Windows.Foundation.Point; + preferredPlacement: Windows.UI.Popups.Placement; + selectionRect: Windows.Foundation.Rect; + } + export class LauncherUIOptions implements Windows.System.ILauncherUIOptions { + invocationPoint: Windows.Foundation.Point; + preferredPlacement: Windows.UI.Popups.Placement; + selectionRect: Windows.Foundation.Rect; + } + export interface ILauncherOptions { + contentType: string; + displayApplicationPicker: boolean; + fallbackUri: Windows.Foundation.Uri; + preferredApplicationDisplayName: string; + preferredApplicationPackageFamilyName: string; + treatAsUntrusted: boolean; + uI: Windows.System.LauncherUIOptions; + } + export class LauncherOptions implements Windows.System.ILauncherOptions { + contentType: string; + displayApplicationPicker: boolean; + fallbackUri: Windows.Foundation.Uri; + preferredApplicationDisplayName: string; + preferredApplicationPackageFamilyName: string; + treatAsUntrusted: boolean; + uI: Windows.System.LauncherUIOptions; + } + export interface ILauncherStatics { + launchFileAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + launchFileAsync(file: Windows.Storage.IStorageFile, options: Windows.System.LauncherOptions): Windows.Foundation.IAsyncOperation; + launchUriAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + launchUriAsync(uri: Windows.Foundation.Uri, options: Windows.System.LauncherOptions): Windows.Foundation.IAsyncOperation; + } + export class Launcher { + static launchFileAsync(file: Windows.Storage.IStorageFile): Windows.Foundation.IAsyncOperation; + static launchFileAsync(file: Windows.Storage.IStorageFile, options: Windows.System.LauncherOptions): Windows.Foundation.IAsyncOperation; + static launchUriAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperation; + static launchUriAsync(uri: Windows.Foundation.Uri, options: Windows.System.LauncherOptions): Windows.Foundation.IAsyncOperation; + } + export enum ProcessorArchitecture { + x86, + arm, + x64, + neutral, + unknown, + } + export enum VirtualKeyModifiers { + none, + control, + menu, + shift, + windows, + } + export enum VirtualKey { + none, + leftButton, + rightButton, + cancel, + middleButton, + xButton1, + xButton2, + back, + tab, + clear, + enter, + shift, + control, + menu, + pause, + capitalLock, + kana, + hangul, + junja, + final, + hanja, + kanji, + escape, + convert, + nonConvert, + accept, + modeChange, + space, + pageUp, + pageDown, + end, + home, + left, + up, + right, + down, + select, + print, + execute, + snapshot, + insert, + delete_, + help, + number0, + number1, + number2, + number3, + number4, + number5, + number6, + number7, + number8, + number9, + a, + b, + c, + d, + e, + f, + g, + h, + i, + j, + k, + l, + m, + n, + o, + p, + q, + r, + s, + t, + u, + v, + w, + x, + y, + z, + leftWindows, + rightWindows, + application, + sleep, + numberPad0, + numberPad1, + numberPad2, + numberPad3, + numberPad4, + numberPad5, + numberPad6, + numberPad7, + numberPad8, + numberPad9, + multiply, + add, + separator, + subtract, + decimal, + divide, + f1, + f2, + f3, + f4, + f5, + f6, + f7, + f8, + f9, + f10, + f11, + f12, + f13, + f14, + f15, + f16, + f17, + f18, + f19, + f20, + f21, + f22, + f23, + f24, + numberKeyLock, + scroll, + leftShift, + rightShift, + leftControl, + rightControl, + leftMenu, + rightMenu, + } + } +} +declare module Windows { + export module System { + export module Display { + export interface IDisplayRequest { + requestActive(): void; + requestRelease(): void; + } + export class DisplayRequest implements Windows.System.Display.IDisplayRequest { + requestActive(): void; + requestRelease(): void; + } + } + } +} +declare module Windows { + export module System { + export module RemoteDesktop { + export interface IInteractiveSessionStatics { + isRemote: boolean; + } + export class InteractiveSession { + static isRemote: boolean; + } + } + } +} +declare module Windows { + export module UI { + export module ApplicationSettings { + export interface ISettingsCommandFactory { + create(settingsCommandId: any, label: string, handler: Windows.UI.Popups.UICommandInvokedHandler): Windows.UI.ApplicationSettings.SettingsCommand; + } + export class SettingsCommand implements Windows.UI.Popups.IUICommand { + constructor(settingsCommandId: any, label: string, handler: Windows.UI.Popups.UICommandInvokedHandler); + id: any; + invoked: Windows.UI.Popups.UICommandInvokedHandler; + label: string; + } + export interface ISettingsPaneCommandsRequest { + applicationCommands: Windows.Foundation.Collections.IVector; + } + export class SettingsPaneCommandsRequest implements Windows.UI.ApplicationSettings.ISettingsPaneCommandsRequest { + applicationCommands: Windows.Foundation.Collections.IVector; + } + export interface ISettingsPaneCommandsRequestedEventArgs { + request: Windows.UI.ApplicationSettings.SettingsPaneCommandsRequest; + } + export class SettingsPaneCommandsRequestedEventArgs implements Windows.UI.ApplicationSettings.ISettingsPaneCommandsRequestedEventArgs { + request: Windows.UI.ApplicationSettings.SettingsPaneCommandsRequest; + } + export enum SettingsEdgeLocation { + right, + left, + } + export interface ISettingsPaneStatics { + edge: Windows.UI.ApplicationSettings.SettingsEdgeLocation; + getForCurrentView(): Windows.UI.ApplicationSettings.SettingsPane; + show(): void; + } + export class SettingsPane implements Windows.UI.ApplicationSettings.ISettingsPane { + oncommandsrequested: any/* TODO */; + static edge: Windows.UI.ApplicationSettings.SettingsEdgeLocation; + static getForCurrentView(): Windows.UI.ApplicationSettings.SettingsPane; + static show(): void; + } + export interface ISettingsPane { + oncommandsrequested: any/* TODO */; + } + } + } +} +declare module Windows { + export module UI { + export module ViewManagement { + export enum ApplicationViewState { + fullScreenLandscape, + filled, + snapped, + fullScreenPortrait, + } + export interface IApplicationViewStatics { + value: Windows.UI.ViewManagement.ApplicationViewState; + tryUnsnap(): boolean; + } + export class ApplicationView { + static value: Windows.UI.ViewManagement.ApplicationViewState; + static tryUnsnap(): boolean; + } + export interface IInputPaneVisibilityEventArgs { + ensuredFocusedElementInView: boolean; + occludedRect: Windows.Foundation.Rect; + } + export class InputPaneVisibilityEventArgs implements Windows.UI.ViewManagement.IInputPaneVisibilityEventArgs { + ensuredFocusedElementInView: boolean; + occludedRect: Windows.Foundation.Rect; + } + export interface IInputPane { + occludedRect: Windows.Foundation.Rect; + onshowing: any/* TODO */; + onhiding: any/* TODO */; + } + export class InputPane implements Windows.UI.ViewManagement.IInputPane { + occludedRect: Windows.Foundation.Rect; + onshowing: any/* TODO */; + onhiding: any/* TODO */; + static getForCurrentView(): Windows.UI.ViewManagement.InputPane; + } + export interface IInputPaneStatics { + getForCurrentView(): Windows.UI.ViewManagement.InputPane; + } + export enum HandPreference { + leftHanded, + rightHanded, + } + export enum UIElementType { + activeCaption, + background, + buttonFace, + buttonText, + captionText, + grayText, + highlight, + highlightText, + hotlight, + inactiveCaption, + inactiveCaptionText, + window, + windowText, + } + export interface IAccessibilitySettings { + highContrast: boolean; + highContrastScheme: string; + onhighcontrastchanged: any/* TODO */; + } + export class AccessibilitySettings implements Windows.UI.ViewManagement.IAccessibilitySettings { + highContrast: boolean; + highContrastScheme: string; + onhighcontrastchanged: any/* TODO */; + } + export interface IUISettings { + animationsEnabled: boolean; + caretBlinkRate: number; + caretBrowsingEnabled: boolean; + caretWidth: number; + cursorSize: Windows.Foundation.Size; + doubleClickTime: number; + handPreference: Windows.UI.ViewManagement.HandPreference; + messageDuration: number; + mouseHoverTime: number; + scrollBarArrowSize: Windows.Foundation.Size; + scrollBarSize: Windows.Foundation.Size; + scrollBarThumbBoxSize: Windows.Foundation.Size; + uIElementColor(desiredElement: Windows.UI.ViewManagement.UIElementType): Windows.UI.Color; + } + export class UISettings implements Windows.UI.ViewManagement.IUISettings { + animationsEnabled: boolean; + caretBlinkRate: number; + caretBrowsingEnabled: boolean; + caretWidth: number; + cursorSize: Windows.Foundation.Size; + doubleClickTime: number; + handPreference: Windows.UI.ViewManagement.HandPreference; + messageDuration: number; + mouseHoverTime: number; + scrollBarArrowSize: Windows.Foundation.Size; + scrollBarSize: Windows.Foundation.Size; + scrollBarThumbBoxSize: Windows.Foundation.Size; + uIElementColor(desiredElement: Windows.UI.ViewManagement.UIElementType): Windows.UI.Color; + } + } + } +} +declare module Windows { + export module UI { + export module Input { + export enum EdgeGestureKind { + touch, + keyboard, + mouse, + } + export interface IEdgeGestureEventArgs { + kind: Windows.UI.Input.EdgeGestureKind; + } + export class EdgeGestureEventArgs implements Windows.UI.Input.IEdgeGestureEventArgs { + kind: Windows.UI.Input.EdgeGestureKind; + } + export interface IEdgeGestureStatics { + getForCurrentView(): Windows.UI.Input.EdgeGesture; + } + export class EdgeGesture implements Windows.UI.Input.IEdgeGesture { + onstarting: any/* TODO */; + oncompleted: any/* TODO */; + oncanceled: any/* TODO */; + static getForCurrentView(): Windows.UI.Input.EdgeGesture; + } + export interface IEdgeGesture { + onstarting: any/* TODO */; + oncompleted: any/* TODO */; + oncanceled: any/* TODO */; + } + export enum HoldingState { + started, + completed, + canceled, + } + export enum DraggingState { + started, + continuing, + completed, + } + export enum CrossSlidingState { + started, + dragging, + selecting, + selectSpeedBumping, + speedBumping, + rearranging, + completed, + } + export enum GestureSettings { + none, + tap, + doubleTap, + hold, + holdWithMouse, + rightTap, + drag, + manipulationTranslateX, + manipulationTranslateY, + manipulationTranslateRailsX, + manipulationTranslateRailsY, + manipulationRotate, + manipulationScale, + manipulationTranslateInertia, + manipulationRotateInertia, + manipulationScaleInertia, + crossSlide, + } + export interface ManipulationDelta { + translation: Windows.Foundation.Point; + scale: number; + rotation: number; + expansion: number; + } + export interface ManipulationVelocities { + linear: Windows.Foundation.Point; + angular: number; + expansion: number; + } + export interface CrossSlideThresholds { + selectionStart: number; + speedBumpStart: number; + speedBumpEnd: number; + rearrangeStart: number; + } + export interface ITappedEventArgs { + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + tapCount: number; + } + export interface IRightTappedEventArgs { + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + } + export interface IHoldingEventArgs { + holdingState: Windows.UI.Input.HoldingState; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + } + export interface IDraggingEventArgs { + draggingState: Windows.UI.Input.DraggingState; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + } + export interface IManipulationStartedEventArgs { + cumulative: Windows.UI.Input.ManipulationDelta; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + } + export interface IManipulationUpdatedEventArgs { + cumulative: Windows.UI.Input.ManipulationDelta; + delta: Windows.UI.Input.ManipulationDelta; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + velocities: Windows.UI.Input.ManipulationVelocities; + } + export interface IManipulationInertiaStartingEventArgs { + cumulative: Windows.UI.Input.ManipulationDelta; + delta: Windows.UI.Input.ManipulationDelta; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + velocities: Windows.UI.Input.ManipulationVelocities; + } + export interface IManipulationCompletedEventArgs { + cumulative: Windows.UI.Input.ManipulationDelta; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + velocities: Windows.UI.Input.ManipulationVelocities; + } + export interface ICrossSlidingEventArgs { + crossSlidingState: Windows.UI.Input.CrossSlidingState; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + } + export interface IMouseWheelParameters { + charTranslation: Windows.Foundation.Point; + deltaRotationAngle: number; + deltaScale: number; + pageTranslation: Windows.Foundation.Point; + } + export interface IGestureRecognizer { + autoProcessInertia: boolean; + crossSlideExact: boolean; + crossSlideHorizontally: boolean; + crossSlideThresholds: Windows.UI.Input.CrossSlideThresholds; + gestureSettings: Windows.UI.Input.GestureSettings; + inertiaExpansion: number; + inertiaExpansionDeceleration: number; + inertiaRotationAngle: number; + inertiaRotationDeceleration: number; + inertiaTranslationDeceleration: number; + inertiaTranslationDisplacement: number; + isActive: boolean; + isInertial: boolean; + manipulationExact: boolean; + mouseWheelParameters: Windows.UI.Input.MouseWheelParameters; + pivotCenter: Windows.Foundation.Point; + pivotRadius: number; + showGestureFeedback: boolean; + canBeDoubleTap(value: Windows.UI.Input.PointerPoint): boolean; + processDownEvent(value: Windows.UI.Input.PointerPoint): void; + processMoveEvents(value: Windows.Foundation.Collections.IVector): void; + processUpEvent(value: Windows.UI.Input.PointerPoint): void; + processMouseWheelEvent(value: Windows.UI.Input.PointerPoint, isShiftKeyDown: boolean, isControlKeyDown: boolean): void; + processInertia(): void; + completeGesture(): void; + ontapped: any/* TODO */; + onrighttapped: any/* TODO */; + onholding: any/* TODO */; + ondragging: any/* TODO */; + onmanipulationstarted: any/* TODO */; + onmanipulationupdated: any/* TODO */; + onmanipulationinertiastarting: any/* TODO */; + onmanipulationcompleted: any/* TODO */; + oncrosssliding: any/* TODO */; + } + export class MouseWheelParameters implements Windows.UI.Input.IMouseWheelParameters { + charTranslation: Windows.Foundation.Point; + deltaRotationAngle: number; + deltaScale: number; + pageTranslation: Windows.Foundation.Point; + } + export class GestureRecognizer implements Windows.UI.Input.IGestureRecognizer { + autoProcessInertia: boolean; + crossSlideExact: boolean; + crossSlideHorizontally: boolean; + crossSlideThresholds: Windows.UI.Input.CrossSlideThresholds; + gestureSettings: Windows.UI.Input.GestureSettings; + inertiaExpansion: number; + inertiaExpansionDeceleration: number; + inertiaRotationAngle: number; + inertiaRotationDeceleration: number; + inertiaTranslationDeceleration: number; + inertiaTranslationDisplacement: number; + isActive: boolean; + isInertial: boolean; + manipulationExact: boolean; + mouseWheelParameters: Windows.UI.Input.MouseWheelParameters; + pivotCenter: Windows.Foundation.Point; + pivotRadius: number; + showGestureFeedback: boolean; + canBeDoubleTap(value: Windows.UI.Input.PointerPoint): boolean; + processDownEvent(value: Windows.UI.Input.PointerPoint): void; + processMoveEvents(value: Windows.Foundation.Collections.IVector): void; + processUpEvent(value: Windows.UI.Input.PointerPoint): void; + processMouseWheelEvent(value: Windows.UI.Input.PointerPoint, isShiftKeyDown: boolean, isControlKeyDown: boolean): void; + processInertia(): void; + completeGesture(): void; + ontapped: any/* TODO */; + onrighttapped: any/* TODO */; + onholding: any/* TODO */; + ondragging: any/* TODO */; + onmanipulationstarted: any/* TODO */; + onmanipulationupdated: any/* TODO */; + onmanipulationinertiastarting: any/* TODO */; + onmanipulationcompleted: any/* TODO */; + oncrosssliding: any/* TODO */; + } + export class TappedEventArgs implements Windows.UI.Input.ITappedEventArgs { + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + tapCount: number; + } + export class RightTappedEventArgs implements Windows.UI.Input.IRightTappedEventArgs { + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + } + export class HoldingEventArgs implements Windows.UI.Input.IHoldingEventArgs { + holdingState: Windows.UI.Input.HoldingState; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + } + export class DraggingEventArgs implements Windows.UI.Input.IDraggingEventArgs { + draggingState: Windows.UI.Input.DraggingState; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + } + export class ManipulationStartedEventArgs implements Windows.UI.Input.IManipulationStartedEventArgs { + cumulative: Windows.UI.Input.ManipulationDelta; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + } + export class ManipulationUpdatedEventArgs implements Windows.UI.Input.IManipulationUpdatedEventArgs { + cumulative: Windows.UI.Input.ManipulationDelta; + delta: Windows.UI.Input.ManipulationDelta; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + velocities: Windows.UI.Input.ManipulationVelocities; + } + export class ManipulationInertiaStartingEventArgs implements Windows.UI.Input.IManipulationInertiaStartingEventArgs { + cumulative: Windows.UI.Input.ManipulationDelta; + delta: Windows.UI.Input.ManipulationDelta; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + velocities: Windows.UI.Input.ManipulationVelocities; + } + export class ManipulationCompletedEventArgs implements Windows.UI.Input.IManipulationCompletedEventArgs { + cumulative: Windows.UI.Input.ManipulationDelta; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + velocities: Windows.UI.Input.ManipulationVelocities; + } + export class CrossSlidingEventArgs implements Windows.UI.Input.ICrossSlidingEventArgs { + crossSlidingState: Windows.UI.Input.CrossSlidingState; + pointerDeviceType: Windows.Devices.Input.PointerDeviceType; + position: Windows.Foundation.Point; + } + export interface IPointerPointStatics { + getCurrentPoint(pointerId: number): Windows.UI.Input.PointerPoint; + getIntermediatePoints(pointerId: number): Windows.Foundation.Collections.IVector; + getCurrentPoint(pointerId: number, transform: Windows.UI.Input.IPointerPointTransform): Windows.UI.Input.PointerPoint; + getIntermediatePoints(pointerId: number, transform: Windows.UI.Input.IPointerPointTransform): Windows.Foundation.Collections.IVector; + } + export class PointerPoint implements Windows.UI.Input.IPointerPoint { + frameId: number; + isInContact: boolean; + pointerDevice: Windows.Devices.Input.PointerDevice; + pointerId: number; + position: Windows.Foundation.Point; + properties: Windows.UI.Input.PointerPointProperties; + rawPosition: Windows.Foundation.Point; + timestamp: number; + static getCurrentPoint(pointerId: number): Windows.UI.Input.PointerPoint; + static getIntermediatePoints(pointerId: number): Windows.Foundation.Collections.IVector; + static getCurrentPoint(pointerId: number, transform: Windows.UI.Input.IPointerPointTransform): Windows.UI.Input.PointerPoint; + static getIntermediatePoints(pointerId: number, transform: Windows.UI.Input.IPointerPointTransform): Windows.Foundation.Collections.IVector; + } + export interface IPointerPointTransform { + inverse: Windows.UI.Input.IPointerPointTransform; + tryTransform(inPoint: Windows.Foundation.Point): { outPoint: Windows.Foundation.Point; returnValue: boolean; }; + transformBounds(rect: Windows.Foundation.Rect): Windows.Foundation.Rect; + } + export interface IPointerPoint { + frameId: number; + isInContact: boolean; + pointerDevice: Windows.Devices.Input.PointerDevice; + pointerId: number; + position: Windows.Foundation.Point; + properties: Windows.UI.Input.PointerPointProperties; + rawPosition: Windows.Foundation.Point; + timestamp: number; + } + export class PointerPointProperties implements Windows.UI.Input.IPointerPointProperties { + contactRect: Windows.Foundation.Rect; + contactRectRaw: Windows.Foundation.Rect; + isBarrelButtonPressed: boolean; + isCanceled: boolean; + isEraser: boolean; + isHorizontalMouseWheel: boolean; + isInRange: boolean; + isInverted: boolean; + isLeftButtonPressed: boolean; + isMiddleButtonPressed: boolean; + isPrimary: boolean; + isRightButtonPressed: boolean; + isXButton1Pressed: boolean; + isXButton2Pressed: boolean; + mouseWheelDelta: number; + orientation: number; + pointerUpdateKind: Windows.UI.Input.PointerUpdateKind; + pressure: number; + touchConfidence: boolean; + twist: number; + xTilt: number; + yTilt: number; + hasUsage(usagePage: number, usageId: number): boolean; + getUsageValue(usagePage: number, usageId: number): number; + } + export enum PointerUpdateKind { + other, + leftButtonPressed, + leftButtonReleased, + rightButtonPressed, + rightButtonReleased, + middleButtonPressed, + middleButtonReleased, + xButton1Pressed, + xButton1Released, + xButton2Pressed, + xButton2Released, + } + export interface IPointerPointProperties { + contactRect: Windows.Foundation.Rect; + contactRectRaw: Windows.Foundation.Rect; + isBarrelButtonPressed: boolean; + isCanceled: boolean; + isEraser: boolean; + isHorizontalMouseWheel: boolean; + isInRange: boolean; + isInverted: boolean; + isLeftButtonPressed: boolean; + isMiddleButtonPressed: boolean; + isPrimary: boolean; + isRightButtonPressed: boolean; + isXButton1Pressed: boolean; + isXButton2Pressed: boolean; + mouseWheelDelta: number; + orientation: number; + pointerUpdateKind: Windows.UI.Input.PointerUpdateKind; + pressure: number; + touchConfidence: boolean; + twist: number; + xTilt: number; + yTilt: number; + hasUsage(usagePage: number, usageId: number): boolean; + getUsageValue(usagePage: number, usageId: number): number; + } + export interface IPointerVisualizationSettings { + isBarrelButtonFeedbackEnabled: boolean; + isContactFeedbackEnabled: boolean; + } + export interface IPointerVisualizationSettingsStatics { + getForCurrentView(): Windows.UI.Input.PointerVisualizationSettings; + } + export class PointerVisualizationSettings implements Windows.UI.Input.IPointerVisualizationSettings { + isBarrelButtonFeedbackEnabled: boolean; + isContactFeedbackEnabled: boolean; + static getForCurrentView(): Windows.UI.Input.PointerVisualizationSettings; + } + } + } +} +declare module Windows { + export module UI { + export module Popups { + export enum MessageDialogOptions { + none, + acceptUserInputAfterDelay, + } + export interface IMessageDialog { + cancelCommandIndex: number; + commands: Windows.Foundation.Collections.IVector; + content: string; + defaultCommandIndex: number; + options: Windows.UI.Popups.MessageDialogOptions; + title: string; + showAsync(): Windows.Foundation.IAsyncOperation; + } + export interface IMessageDialogFactory { + create(content: string): Windows.UI.Popups.MessageDialog; + createWithTitle(content: string, title: string): Windows.UI.Popups.MessageDialog; + } + export class MessageDialog implements Windows.UI.Popups.IMessageDialog { + constructor(content: string); + constructor(content: string, title: string); + cancelCommandIndex: number; + commands: Windows.Foundation.Collections.IVector; + content: string; + defaultCommandIndex: number; + options: Windows.UI.Popups.MessageDialogOptions; + title: string; + showAsync(): Windows.Foundation.IAsyncOperation; + } + export enum Placement { + default, + above, + below, + left, + right, + } + export interface UICommandInvokedHandler { + (command: Windows.UI.Popups.IUICommand): void; + } + export interface IUICommand { + id: any; + invoked: Windows.UI.Popups.UICommandInvokedHandler; + label: string; + } + export interface IUICommandFactory { + create(label: string): Windows.UI.Popups.UICommand; + createWithHandler(label: string, action: Windows.UI.Popups.UICommandInvokedHandler): Windows.UI.Popups.UICommand; + createWithHandlerAndId(label: string, action: Windows.UI.Popups.UICommandInvokedHandler, commandId: any): Windows.UI.Popups.UICommand; + } + export class UICommand implements Windows.UI.Popups.IUICommand { + constructor(label: string); + constructor(label: string, action: Windows.UI.Popups.UICommandInvokedHandler); + constructor(label: string, action: Windows.UI.Popups.UICommandInvokedHandler, commandId: any); + constructor(); + id: any; + invoked: Windows.UI.Popups.UICommandInvokedHandler; + label: string; + } + export class UICommandSeparator implements Windows.UI.Popups.IUICommand { + id: any; + invoked: Windows.UI.Popups.UICommandInvokedHandler; + label: string; + } + export interface IPopupMenu { + commands: Windows.Foundation.Collections.IVector; + showAsync(invocationPoint: Windows.Foundation.Point): Windows.Foundation.IAsyncOperation; + showForSelectionAsync(selection: Windows.Foundation.Rect): Windows.Foundation.IAsyncOperation; + showForSelectionAsync(selection: Windows.Foundation.Rect, preferredPlacement: Windows.UI.Popups.Placement): Windows.Foundation.IAsyncOperation; + } + export class PopupMenu implements Windows.UI.Popups.IPopupMenu { + commands: Windows.Foundation.Collections.IVector; + showAsync(invocationPoint: Windows.Foundation.Point): Windows.Foundation.IAsyncOperation; + showForSelectionAsync(selection: Windows.Foundation.Rect): Windows.Foundation.IAsyncOperation; + showForSelectionAsync(selection: Windows.Foundation.Rect, preferredPlacement: Windows.UI.Popups.Placement): Windows.Foundation.IAsyncOperation; + } + } + } +} +declare module Windows { + export module UI { + export module StartScreen { + export enum TileOptions { + none, + showNameOnLogo, + showNameOnWideLogo, + copyOnDeployment, + } + export enum ForegroundText { + dark, + light, + } + export interface ISecondaryTile { + arguments: string; + backgroundColor: Windows.UI.Color; + displayName: string; + foregroundText: Windows.UI.StartScreen.ForegroundText; + lockScreenBadgeLogo: Windows.Foundation.Uri; + lockScreenDisplayBadgeAndTileText: boolean; + logo: Windows.Foundation.Uri; + shortName: string; + smallLogo: Windows.Foundation.Uri; + tileId: string; + tileOptions: Windows.UI.StartScreen.TileOptions; + wideLogo: Windows.Foundation.Uri; + requestCreateAsync(): Windows.Foundation.IAsyncOperation; + requestCreateAsync(invocationPoint: Windows.Foundation.Point): Windows.Foundation.IAsyncOperation; + requestCreateForSelectionAsync(selection: Windows.Foundation.Rect): Windows.Foundation.IAsyncOperation; + requestCreateForSelectionAsync(selection: Windows.Foundation.Rect, preferredPlacement: Windows.UI.Popups.Placement): Windows.Foundation.IAsyncOperation; + requestDeleteAsync(): Windows.Foundation.IAsyncOperation; + requestDeleteAsync(invocationPoint: Windows.Foundation.Point): Windows.Foundation.IAsyncOperation; + requestDeleteForSelectionAsync(selection: Windows.Foundation.Rect): Windows.Foundation.IAsyncOperation; + requestDeleteForSelectionAsync(selection: Windows.Foundation.Rect, preferredPlacement: Windows.UI.Popups.Placement): Windows.Foundation.IAsyncOperation; + updateAsync(): Windows.Foundation.IAsyncOperation; + } + export interface ISecondaryTileFactory { + createTile(tileId: string, shortName: string, displayName: string, arguments: string, tileOptions: Windows.UI.StartScreen.TileOptions, logoReference: Windows.Foundation.Uri): Windows.UI.StartScreen.SecondaryTile; + createWideTile(tileId: string, shortName: string, displayName: string, arguments: string, tileOptions: Windows.UI.StartScreen.TileOptions, logoReference: Windows.Foundation.Uri, wideLogoReference: Windows.Foundation.Uri): Windows.UI.StartScreen.SecondaryTile; + createWithId(tileId: string): Windows.UI.StartScreen.SecondaryTile; + } + export class SecondaryTile implements Windows.UI.StartScreen.ISecondaryTile { + constructor(tileId: string, shortName: string, displayName: string, arguments: string, tileOptions: Windows.UI.StartScreen.TileOptions, logoReference: Windows.Foundation.Uri); + constructor(tileId: string, shortName: string, displayName: string, arguments: string, tileOptions: Windows.UI.StartScreen.TileOptions, logoReference: Windows.Foundation.Uri, wideLogoReference: Windows.Foundation.Uri); + constructor(tileId: string); + constructor(); + arguments: string; + backgroundColor: Windows.UI.Color; + displayName: string; + foregroundText: Windows.UI.StartScreen.ForegroundText; + lockScreenBadgeLogo: Windows.Foundation.Uri; + lockScreenDisplayBadgeAndTileText: boolean; + logo: Windows.Foundation.Uri; + shortName: string; + smallLogo: Windows.Foundation.Uri; + tileId: string; + tileOptions: Windows.UI.StartScreen.TileOptions; + wideLogo: Windows.Foundation.Uri; + requestCreateAsync(): Windows.Foundation.IAsyncOperation; + requestCreateAsync(invocationPoint: Windows.Foundation.Point): Windows.Foundation.IAsyncOperation; + requestCreateForSelectionAsync(selection: Windows.Foundation.Rect): Windows.Foundation.IAsyncOperation; + requestCreateForSelectionAsync(selection: Windows.Foundation.Rect, preferredPlacement: Windows.UI.Popups.Placement): Windows.Foundation.IAsyncOperation; + requestDeleteAsync(): Windows.Foundation.IAsyncOperation; + requestDeleteAsync(invocationPoint: Windows.Foundation.Point): Windows.Foundation.IAsyncOperation; + requestDeleteForSelectionAsync(selection: Windows.Foundation.Rect): Windows.Foundation.IAsyncOperation; + requestDeleteForSelectionAsync(selection: Windows.Foundation.Rect, preferredPlacement: Windows.UI.Popups.Placement): Windows.Foundation.IAsyncOperation; + updateAsync(): Windows.Foundation.IAsyncOperation; + static exists(tileId: string): boolean; + static findAllAsync(): Windows.Foundation.IAsyncOperation>; + static findAllAsync(applicationId: string): Windows.Foundation.IAsyncOperation>; + static findAllForPackageAsync(): Windows.Foundation.IAsyncOperation>; + } + export interface ISecondaryTileStatics { + exists(tileId: string): boolean; + findAllAsync(): Windows.Foundation.IAsyncOperation>; + findAllAsync(applicationId: string): Windows.Foundation.IAsyncOperation>; + findAllForPackageAsync(): Windows.Foundation.IAsyncOperation>; + } + } + } +} +declare module Windows { + export module UI { + export module Text { + export enum CaretType { + normal, + null_, + } + export enum FindOptions { + none, + word, + case_, + } + export enum FormatEffect { + off, + on, + toggle, + undefined, + } + export enum HorizontalCharacterAlignment { + left, + right, + center, + } + export enum LetterCase { + lower, + upper, + } + export enum LineSpacingRule { + undefined, + single, + oneAndHalf, + double, + atLeast, + exactly, + multiple, + percent, + } + export enum LinkType { + undefined, + notALink, + clientLink, + friendlyLinkName, + friendlyLinkAddress, + autoLink, + autoLinkEmail, + autoLinkPhone, + autoLinkPath, + } + export enum MarkerAlignment { + undefined, + left, + center, + right, + } + export enum MarkerStyle { + undefined, + parenthesis, + parentheses, + period, + plain, + minus, + noNumber, + } + export enum MarkerType { + undefined, + none, + bullet, + arabic, + lowercaseEnglishLetter, + uppercaseEnglishLetter, + lowercaseRoman, + uppercaseRoman, + unicodeSequence, + circledNumber, + blackCircleWingding, + whiteCircleWingding, + arabicWide, + simplifiedChinese, + traditionalChinese, + japanSimplifiedChinese, + japanKorea, + arabicDictionary, + arabicAbjad, + hebrew, + thaiAlphabetic, + thaiNumeric, + devanagariVowel, + devanagariConsonant, + devanagariNumeric, + } + export enum ParagraphAlignment { + undefined, + left, + center, + right, + justify, + } + export enum ParagraphStyle { + undefined, + none, + normal, + heading1, + heading2, + heading3, + heading4, + heading5, + heading6, + heading7, + heading8, + heading9, + } + export enum PointOptions { + none, + includeInset, + start, + clientCoordinates, + allowOffClient, + transform, + noHorizontalScroll, + noVerticalScroll, + } + export enum RangeGravity { + uIBehavior, + backward, + forward, + inward, + outward, + } + export enum SelectionOptions { + startActive, + atEndOfLine, + overtype, + active, + replace, + } + export enum SelectionType { + none, + insertionPoint, + normal, + inlineShape, + shape, + } + export enum TabAlignment { + left, + center, + right, + decimal, + bar, + } + export enum TabLeader { + spaces, + dots, + dashes, + lines, + thickLines, + equals, + } + export enum TextGetOptions { + none, + adjustCrlf, + useCrlf, + useObjectText, + allowFinalEop, + noHidden, + includeNumbering, + formatRtf, + } + export enum TextSetOptions { + none, + unicodeBidi, + unlink, + unhide, + checkTextLimit, + formatRtf, + applyRtfDocumentDefaults, + } + export enum TextRangeUnit { + character, + word, + sentence, + paragraph, + line, + story, + screen, + section, + window, + characterFormat, + paragraphFormat, + object, + hardParagraph, + cluster, + bold, + italic, + underline, + strikethrough, + protectedText, + link, + smallCaps, + allCaps, + hidden, + outline, + shadow, + imprint, + disabled, + revised, + subscript, + superscript, + fontBound, + linkProtected, + } + export enum TextScript { + undefined, + ansi, + eastEurope, + cyrillic, + greek, + turkish, + hebrew, + arabic, + baltic, + vietnamese, + default, + symbol, + thai, + shiftJis, + gB2312, + hangul, + big5, + pC437, + oem, + mac, + armenian, + syriac, + thaana, + devanagari, + bengali, + gurmukhi, + gujarati, + oriya, + tamil, + telugu, + kannada, + malayalam, + sinhala, + lao, + tibetan, + myanmar, + georgian, + jamo, + ethiopic, + cherokee, + aboriginal, + ogham, + runic, + khmer, + mongolian, + braille, + yi, + limbu, + taiLe, + newTaiLue, + sylotiNagri, + kharoshthi, + kayahli, + unicodeSymbol, + emoji, + glagolitic, + lisu, + vai, + nKo, + osmanya, + phagsPa, + gothic, + deseret, + tifinagh, + } + export enum UnderlineType { + undefined, + none, + single, + words, + double, + dotted, + dash, + dashDot, + dashDotDot, + wave, + thick, + thin, + doubleWave, + heavyWave, + longDash, + thickDash, + thickDashDot, + thickDashDotDot, + thickDotted, + thickLongDash, + } + export enum VerticalCharacterAlignment { + top, + baseline, + bottom, + } + export class TextConstants { + static autoColor: Windows.UI.Color; + static maxUnitCount: number; + static minUnitCount: number; + static undefinedColor: Windows.UI.Color; + static undefinedFloatValue: number; + static undefinedFontStretch: Windows.UI.Text.FontStretch; + static undefinedFontStyle: Windows.UI.Text.FontStyle; + static undefinedInt32Value: number; + } + export interface ITextConstantsStatics { + autoColor: Windows.UI.Color; + maxUnitCount: number; + minUnitCount: number; + undefinedColor: Windows.UI.Color; + undefinedFloatValue: number; + undefinedFontStretch: Windows.UI.Text.FontStretch; + undefinedFontStyle: Windows.UI.Text.FontStyle; + undefinedInt32Value: number; + } + export interface ITextDocument { + caretType: Windows.UI.Text.CaretType; + defaultTabStop: number; + selection: Windows.UI.Text.ITextSelection; + undoLimit: number; + canCopy(): boolean; + canPaste(): boolean; + canRedo(): boolean; + canUndo(): boolean; + applyDisplayUpdates(): number; + batchDisplayUpdates(): number; + beginUndoGroup(): void; + endUndoGroup(): void; + getDefaultCharacterFormat(): Windows.UI.Text.ITextCharacterFormat; + getDefaultParagraphFormat(): Windows.UI.Text.ITextParagraphFormat; + getRange(startPosition: number, endPosition: number): Windows.UI.Text.ITextRange; + getRangeFromPoint(point: Windows.Foundation.Point, options: Windows.UI.Text.PointOptions): Windows.UI.Text.ITextRange; + getText(options: Windows.UI.Text.TextGetOptions): string; + loadFromStream(options: Windows.UI.Text.TextSetOptions, value: Windows.Storage.Streams.IRandomAccessStream): void; + redo(): void; + saveToStream(options: Windows.UI.Text.TextGetOptions, value: Windows.Storage.Streams.IRandomAccessStream): void; + setDefaultCharacterFormat(value: Windows.UI.Text.ITextCharacterFormat): void; + setDefaultParagraphFormat(value: Windows.UI.Text.ITextParagraphFormat): void; + setText(options: Windows.UI.Text.TextSetOptions, value: string): void; + undo(): void; + } + export interface ITextRange { + character: string; + characterFormat: Windows.UI.Text.ITextCharacterFormat; + endPosition: number; + formattedText: Windows.UI.Text.ITextRange; + gravity: Windows.UI.Text.RangeGravity; + length: number; + link: string; + paragraphFormat: Windows.UI.Text.ITextParagraphFormat; + startPosition: number; + storyLength: number; + text: string; + canPaste(format: number): boolean; + changeCase(value: Windows.UI.Text.LetterCase): void; + collapse(value: boolean): void; + copy(): void; + cut(): void; + delete_(unit: Windows.UI.Text.TextRangeUnit, count: number): number; + endOf(unit: Windows.UI.Text.TextRangeUnit, extend: boolean): number; + expand(unit: Windows.UI.Text.TextRangeUnit): number; + findText(value: string, scanLength: number, options: Windows.UI.Text.FindOptions): number; + getCharacterUtf32(offset: number): number; + getClone(): Windows.UI.Text.ITextRange; + getIndex(unit: Windows.UI.Text.TextRangeUnit): number; + getPoint(horizontalAlign: Windows.UI.Text.HorizontalCharacterAlignment, verticalAlign: Windows.UI.Text.VerticalCharacterAlignment, options: Windows.UI.Text.PointOptions): Windows.Foundation.Point; + getRect(options: Windows.UI.Text.PointOptions): { rect: Windows.Foundation.Rect; hit: number; }; + getText(options: Windows.UI.Text.TextGetOptions): string; + getTextViaStream(options: Windows.UI.Text.TextGetOptions, value: Windows.Storage.Streams.IRandomAccessStream): void; + inRange(range: Windows.UI.Text.ITextRange): boolean; + insertImage(width: number, height: number, ascent: number, verticalAlign: Windows.UI.Text.VerticalCharacterAlignment, alternateText: string, value: Windows.Storage.Streams.IRandomAccessStream): void; + inStory(range: Windows.UI.Text.ITextRange): boolean; + isEqual(range: Windows.UI.Text.ITextRange): boolean; + move(unit: Windows.UI.Text.TextRangeUnit, count: number): number; + moveEnd(unit: Windows.UI.Text.TextRangeUnit, count: number): number; + moveStart(unit: Windows.UI.Text.TextRangeUnit, count: number): number; + paste(format: number): void; + scrollIntoView(value: Windows.UI.Text.PointOptions): void; + matchSelection(): void; + setIndex(unit: Windows.UI.Text.TextRangeUnit, index: number, extend: boolean): void; + setPoint(point: Windows.Foundation.Point, options: Windows.UI.Text.PointOptions, extend: boolean): void; + setRange(startPosition: number, endPosition: number): void; + setText(options: Windows.UI.Text.TextSetOptions, value: string): void; + setTextViaStream(options: Windows.UI.Text.TextSetOptions, value: Windows.Storage.Streams.IRandomAccessStream): void; + startOf(unit: Windows.UI.Text.TextRangeUnit, extend: boolean): number; + } + export interface ITextSelection extends Windows.UI.Text.ITextRange { + options: Windows.UI.Text.SelectionOptions; + type: Windows.UI.Text.SelectionType; + endKey(unit: Windows.UI.Text.TextRangeUnit, extend: boolean): number; + homeKey(unit: Windows.UI.Text.TextRangeUnit, extend: boolean): number; + moveDown(unit: Windows.UI.Text.TextRangeUnit, count: number, extend: boolean): number; + moveLeft(unit: Windows.UI.Text.TextRangeUnit, count: number, extend: boolean): number; + moveRight(unit: Windows.UI.Text.TextRangeUnit, count: number, extend: boolean): number; + moveUp(unit: Windows.UI.Text.TextRangeUnit, count: number, extend: boolean): number; + typeText(value: string): void; + } + export interface ITextCharacterFormat { + allCaps: Windows.UI.Text.FormatEffect; + backgroundColor: Windows.UI.Color; + bold: Windows.UI.Text.FormatEffect; + fontStretch: Windows.UI.Text.FontStretch; + fontStyle: Windows.UI.Text.FontStyle; + foregroundColor: Windows.UI.Color; + hidden: Windows.UI.Text.FormatEffect; + italic: Windows.UI.Text.FormatEffect; + kerning: number; + languageTag: string; + linkType: Windows.UI.Text.LinkType; + name: string; + outline: Windows.UI.Text.FormatEffect; + position: number; + protectedText: Windows.UI.Text.FormatEffect; + size: number; + smallCaps: Windows.UI.Text.FormatEffect; + spacing: number; + strikethrough: Windows.UI.Text.FormatEffect; + subscript: Windows.UI.Text.FormatEffect; + superscript: Windows.UI.Text.FormatEffect; + textScript: Windows.UI.Text.TextScript; + underline: Windows.UI.Text.UnderlineType; + weight: number; + setClone(value: Windows.UI.Text.ITextCharacterFormat): void; + getClone(): Windows.UI.Text.ITextCharacterFormat; + isEqual(format: Windows.UI.Text.ITextCharacterFormat): boolean; + } + export interface ITextParagraphFormat { + alignment: Windows.UI.Text.ParagraphAlignment; + firstLineIndent: number; + keepTogether: Windows.UI.Text.FormatEffect; + keepWithNext: Windows.UI.Text.FormatEffect; + leftIndent: number; + lineSpacing: number; + lineSpacingRule: Windows.UI.Text.LineSpacingRule; + listAlignment: Windows.UI.Text.MarkerAlignment; + listLevelIndex: number; + listStart: number; + listStyle: Windows.UI.Text.MarkerStyle; + listTab: number; + listType: Windows.UI.Text.MarkerType; + noLineNumber: Windows.UI.Text.FormatEffect; + pageBreakBefore: Windows.UI.Text.FormatEffect; + rightIndent: number; + rightToLeft: Windows.UI.Text.FormatEffect; + spaceAfter: number; + spaceBefore: number; + style: Windows.UI.Text.ParagraphStyle; + tabCount: number; + widowControl: Windows.UI.Text.FormatEffect; + addTab(position: number, align: Windows.UI.Text.TabAlignment, leader: Windows.UI.Text.TabLeader): void; + clearAllTabs(): void; + deleteTab(position: number): void; + getClone(): Windows.UI.Text.ITextParagraphFormat; + getTab(index: number): { position: number; align: Windows.UI.Text.TabAlignment; leader: Windows.UI.Text.TabLeader; }; + isEqual(format: Windows.UI.Text.ITextParagraphFormat): boolean; + setClone(format: Windows.UI.Text.ITextParagraphFormat): void; + setIndents(start: number, left: number, right: number): void; + setLineSpacing(rule: Windows.UI.Text.LineSpacingRule, spacing: number): void; + } + export enum FontStyle { + normal, + oblique, + italic, + } + export enum FontStretch { + undefined, + ultraCondensed, + extraCondensed, + condensed, + semiCondensed, + normal, + semiExpanded, + expanded, + extraExpanded, + ultraExpanded, + } + export interface FontWeight { + weight: number; + } + export interface IFontWeights { + } + export interface IFontWeightsStatics { + black: Windows.UI.Text.FontWeight; + bold: Windows.UI.Text.FontWeight; + extraBlack: Windows.UI.Text.FontWeight; + extraBold: Windows.UI.Text.FontWeight; + extraLight: Windows.UI.Text.FontWeight; + light: Windows.UI.Text.FontWeight; + medium: Windows.UI.Text.FontWeight; + normal: Windows.UI.Text.FontWeight; + semiBold: Windows.UI.Text.FontWeight; + semiLight: Windows.UI.Text.FontWeight; + thin: Windows.UI.Text.FontWeight; + } + export class FontWeights implements Windows.UI.Text.IFontWeights { + static black: Windows.UI.Text.FontWeight; + static bold: Windows.UI.Text.FontWeight; + static extraBlack: Windows.UI.Text.FontWeight; + static extraBold: Windows.UI.Text.FontWeight; + static extraLight: Windows.UI.Text.FontWeight; + static light: Windows.UI.Text.FontWeight; + static medium: Windows.UI.Text.FontWeight; + static normal: Windows.UI.Text.FontWeight; + static semiBold: Windows.UI.Text.FontWeight; + static semiLight: Windows.UI.Text.FontWeight; + static thin: Windows.UI.Text.FontWeight; + } + } + } +} +declare module Windows { + export module UI { + export module Core { + export module AnimationMetrics { + export enum PropertyAnimationType { + scale, + translation, + opacity, + } + export interface IPropertyAnimation { + control1: Windows.Foundation.Point; + control2: Windows.Foundation.Point; + delay: number; + duration: number; + type: Windows.UI.Core.AnimationMetrics.PropertyAnimationType; + } + export interface IScaleAnimation extends Windows.UI.Core.AnimationMetrics.IPropertyAnimation { + finalScaleX: number; + finalScaleY: number; + initialScaleX: number; + initialScaleY: number; + normalizedOrigin: Windows.Foundation.Point; + } + export interface IOpacityAnimation extends Windows.UI.Core.AnimationMetrics.IPropertyAnimation { + finalOpacity: number; + initialOpacity: number; + } + export enum AnimationEffect { + expand, + collapse, + reposition, + fadeIn, + fadeOut, + addToList, + deleteFromList, + addToGrid, + deleteFromGrid, + addToSearchGrid, + deleteFromSearchGrid, + addToSearchList, + deleteFromSearchList, + showEdgeUI, + showPanel, + hideEdgeUI, + hidePanel, + showPopup, + hidePopup, + pointerDown, + pointerUp, + dragSourceStart, + dragSourceEnd, + transitionContent, + reveal, + hide, + dragBetweenEnter, + dragBetweenLeave, + swipeSelect, + swipeDeselect, + swipeReveal, + enterPage, + transitionPage, + crossFade, + peek, + updateBadge, + } + export enum AnimationEffectTarget { + primary, + added, + affected, + background, + content, + deleted, + deselected, + dragSource, + hidden, + incoming, + outgoing, + outline, + remaining, + revealed, + rowIn, + rowOut, + selected, + selection, + shown, + tapped, + } + export interface IAnimationDescription { + animations: Windows.Foundation.Collections.IVectorView; + delayLimit: number; + staggerDelay: number; + staggerDelayFactor: number; + zOrder: number; + } + export interface IAnimationDescriptionFactory { + createInstance(effect: Windows.UI.Core.AnimationMetrics.AnimationEffect, target: Windows.UI.Core.AnimationMetrics.AnimationEffectTarget): Windows.UI.Core.AnimationMetrics.AnimationDescription; + } + export class AnimationDescription implements Windows.UI.Core.AnimationMetrics.IAnimationDescription { + constructor(effect: Windows.UI.Core.AnimationMetrics.AnimationEffect, target: Windows.UI.Core.AnimationMetrics.AnimationEffectTarget); + animations: Windows.Foundation.Collections.IVectorView; + delayLimit: number; + staggerDelay: number; + staggerDelayFactor: number; + zOrder: number; + } + export class PropertyAnimation implements Windows.UI.Core.AnimationMetrics.IPropertyAnimation { + control1: Windows.Foundation.Point; + control2: Windows.Foundation.Point; + delay: number; + duration: number; + type: Windows.UI.Core.AnimationMetrics.PropertyAnimationType; + } + export class ScaleAnimation implements Windows.UI.Core.AnimationMetrics.IScaleAnimation, Windows.UI.Core.AnimationMetrics.IPropertyAnimation { + finalScaleX: number; + finalScaleY: number; + initialScaleX: number; + initialScaleY: number; + normalizedOrigin: Windows.Foundation.Point; + control1: Windows.Foundation.Point; + control2: Windows.Foundation.Point; + delay: number; + duration: number; + type: Windows.UI.Core.AnimationMetrics.PropertyAnimationType; + } + export class TranslationAnimation implements Windows.UI.Core.AnimationMetrics.IPropertyAnimation { + control1: Windows.Foundation.Point; + control2: Windows.Foundation.Point; + delay: number; + duration: number; + type: Windows.UI.Core.AnimationMetrics.PropertyAnimationType; + } + export class OpacityAnimation implements Windows.UI.Core.AnimationMetrics.IOpacityAnimation, Windows.UI.Core.AnimationMetrics.IPropertyAnimation { + finalOpacity: number; + initialOpacity: number; + control1: Windows.Foundation.Point; + control2: Windows.Foundation.Point; + delay: number; + duration: number; + type: Windows.UI.Core.AnimationMetrics.PropertyAnimationType; + } + } + } + } +} +declare module Windows { + export module UI { + export module Core { + export enum CoreWindowActivationState { + codeActivated, + deactivated, + pointerActivated, + } + export enum CoreCursorType { + arrow, + cross, + custom, + hand, + help, + iBeam, + sizeAll, + sizeNortheastSouthwest, + sizeNorthSouth, + sizeNorthwestSoutheast, + sizeWestEast, + universalNo, + upArrow, + wait, + } + export enum CoreDispatcherPriority { + low, + normal, + high, + } + export enum CoreProcessEventsOption { + processOneAndAllPending, + processOneIfPresent, + processUntilQuit, + processAllIfPresent, + } + export enum CoreWindowFlowDirection { + leftToRight, + rightToLeft, + } + export enum CoreVirtualKeyStates { + none, + down, + locked, + } + export enum CoreAcceleratorKeyEventType { + character, + deadCharacter, + keyDown, + keyUp, + systemCharacter, + systemDeadCharacter, + systemKeyDown, + systemKeyUp, + unicodeCharacter, + } + export enum CoreProximityEvaluationScore { + closest, + farthest, + } + export interface CorePhysicalKeyStatus { + repeatCount: number; + scanCode: number; + isExtendedKey: boolean; + isMenuKeyDown: boolean; + wasKeyDown: boolean; + isKeyReleased: boolean; + } + export interface CoreProximityEvaluation { + score: number; + adjustedPoint: Windows.Foundation.Point; + } + export interface ICoreWindowEventArgs { + handled: boolean; + } + export interface IAutomationProviderRequestedEventArgs extends Windows.UI.Core.ICoreWindowEventArgs { + automationProvider: any; + } + export interface ICharacterReceivedEventArgs extends Windows.UI.Core.ICoreWindowEventArgs { + keyCode: number; + keyStatus: Windows.UI.Core.CorePhysicalKeyStatus; + } + export interface IInputEnabledEventArgs extends Windows.UI.Core.ICoreWindowEventArgs { + inputEnabled: boolean; + } + export interface IKeyEventArgs extends Windows.UI.Core.ICoreWindowEventArgs { + keyStatus: Windows.UI.Core.CorePhysicalKeyStatus; + virtualKey: Windows.System.VirtualKey; + } + export interface IPointerEventArgs extends Windows.UI.Core.ICoreWindowEventArgs { + currentPoint: Windows.UI.Input.PointerPoint; + keyModifiers: Windows.System.VirtualKeyModifiers; + getIntermediatePoints(): Windows.Foundation.Collections.IVector; + } + export interface ITouchHitTestingEventArgs extends Windows.UI.Core.ICoreWindowEventArgs { + boundingBox: Windows.Foundation.Rect; + point: Windows.Foundation.Point; + proximityEvaluation: Windows.UI.Core.CoreProximityEvaluation; + evaluateProximity(controlBoundingBox: Windows.Foundation.Rect): Windows.UI.Core.CoreProximityEvaluation; + evaluateProximity(controlVertices: Windows.Foundation.Point[]): Windows.UI.Core.CoreProximityEvaluation; + } + export interface IWindowActivatedEventArgs extends Windows.UI.Core.ICoreWindowEventArgs { + windowActivationState: Windows.UI.Core.CoreWindowActivationState; + } + export interface IWindowSizeChangedEventArgs extends Windows.UI.Core.ICoreWindowEventArgs { + size: Windows.Foundation.Size; + } + export interface IVisibilityChangedEventArgs extends Windows.UI.Core.ICoreWindowEventArgs { + visible: boolean; + } + export interface ICoreWindow { + automationHostProvider: any; + bounds: Windows.Foundation.Rect; + customProperties: Windows.Foundation.Collections.IPropertySet; + dispatcher: Windows.UI.Core.CoreDispatcher; + flowDirection: Windows.UI.Core.CoreWindowFlowDirection; + isInputEnabled: boolean; + pointerCursor: Windows.UI.Core.CoreCursor; + pointerPosition: Windows.Foundation.Point; + visible: boolean; + activate(): void; + close(): void; + getAsyncKeyState(virtualKey: Windows.System.VirtualKey): Windows.UI.Core.CoreVirtualKeyStates; + getKeyState(virtualKey: Windows.System.VirtualKey): Windows.UI.Core.CoreVirtualKeyStates; + releasePointerCapture(): void; + setPointerCapture(): void; + onactivated: any/* TODO */; + onautomationproviderrequested: any/* TODO */; + oncharacterreceived: any/* TODO */; + onclosed: any/* TODO */; + oninputenabled: any/* TODO */; + onkeydown: any/* TODO */; + onkeyup: any/* TODO */; + onpointercapturelost: any/* TODO */; + onpointerentered: any/* TODO */; + onpointerexited: any/* TODO */; + onpointermoved: any/* TODO */; + onpointerpressed: any/* TODO */; + onpointerreleased: any/* TODO */; + ontouchhittesting: any/* TODO */; + onpointerwheelchanged: any/* TODO */; + onsizechanged: any/* TODO */; + onvisibilitychanged: any/* TODO */; + } + export class CoreDispatcher implements Windows.UI.Core.ICoreDispatcher, Windows.UI.Core.ICoreAcceleratorKeys { + hasThreadAccess: boolean; + processEvents(options: Windows.UI.Core.CoreProcessEventsOption): void; + runAsync(priority: Windows.UI.Core.CoreDispatcherPriority, agileCallback: Windows.UI.Core.DispatchedHandler): Windows.Foundation.IAsyncAction; + runIdleAsync(agileCallback: Windows.UI.Core.IdleDispatchedHandler): Windows.Foundation.IAsyncAction; + onacceleratorkeyactivated: any/* TODO */; + } + export class CoreCursor implements Windows.UI.Core.ICoreCursor { + constructor(type: Windows.UI.Core.CoreCursorType, id: number); + id: number; + type: Windows.UI.Core.CoreCursorType; + } + export class CoreWindow implements Windows.UI.Core.ICoreWindow { + automationHostProvider: any; + bounds: Windows.Foundation.Rect; + customProperties: Windows.Foundation.Collections.IPropertySet; + dispatcher: Windows.UI.Core.CoreDispatcher; + flowDirection: Windows.UI.Core.CoreWindowFlowDirection; + isInputEnabled: boolean; + pointerCursor: Windows.UI.Core.CoreCursor; + pointerPosition: Windows.Foundation.Point; + visible: boolean; + activate(): void; + close(): void; + getAsyncKeyState(virtualKey: Windows.System.VirtualKey): Windows.UI.Core.CoreVirtualKeyStates; + getKeyState(virtualKey: Windows.System.VirtualKey): Windows.UI.Core.CoreVirtualKeyStates; + releasePointerCapture(): void; + setPointerCapture(): void; + onactivated: any/* TODO */; + onautomationproviderrequested: any/* TODO */; + oncharacterreceived: any/* TODO */; + onclosed: any/* TODO */; + oninputenabled: any/* TODO */; + onkeydown: any/* TODO */; + onkeyup: any/* TODO */; + onpointercapturelost: any/* TODO */; + onpointerentered: any/* TODO */; + onpointerexited: any/* TODO */; + onpointermoved: any/* TODO */; + onpointerpressed: any/* TODO */; + onpointerreleased: any/* TODO */; + ontouchhittesting: any/* TODO */; + onpointerwheelchanged: any/* TODO */; + onsizechanged: any/* TODO */; + onvisibilitychanged: any/* TODO */; + static getForCurrentThread(): Windows.UI.Core.CoreWindow; + } + export class WindowActivatedEventArgs implements Windows.UI.Core.IWindowActivatedEventArgs, Windows.UI.Core.ICoreWindowEventArgs { + windowActivationState: Windows.UI.Core.CoreWindowActivationState; + handled: boolean; + } + export class AutomationProviderRequestedEventArgs implements Windows.UI.Core.IAutomationProviderRequestedEventArgs, Windows.UI.Core.ICoreWindowEventArgs { + automationProvider: any; + handled: boolean; + } + export class CharacterReceivedEventArgs implements Windows.UI.Core.ICharacterReceivedEventArgs, Windows.UI.Core.ICoreWindowEventArgs { + keyCode: number; + keyStatus: Windows.UI.Core.CorePhysicalKeyStatus; + handled: boolean; + } + export class CoreWindowEventArgs implements Windows.UI.Core.ICoreWindowEventArgs { + handled: boolean; + } + export class InputEnabledEventArgs implements Windows.UI.Core.IInputEnabledEventArgs, Windows.UI.Core.ICoreWindowEventArgs { + inputEnabled: boolean; + handled: boolean; + } + export class KeyEventArgs implements Windows.UI.Core.IKeyEventArgs, Windows.UI.Core.ICoreWindowEventArgs { + keyStatus: Windows.UI.Core.CorePhysicalKeyStatus; + virtualKey: Windows.System.VirtualKey; + handled: boolean; + } + export class PointerEventArgs implements Windows.UI.Core.IPointerEventArgs, Windows.UI.Core.ICoreWindowEventArgs { + currentPoint: Windows.UI.Input.PointerPoint; + keyModifiers: Windows.System.VirtualKeyModifiers; + handled: boolean; + getIntermediatePoints(): Windows.Foundation.Collections.IVector; + } + export class TouchHitTestingEventArgs implements Windows.UI.Core.ITouchHitTestingEventArgs, Windows.UI.Core.ICoreWindowEventArgs { + boundingBox: Windows.Foundation.Rect; + point: Windows.Foundation.Point; + proximityEvaluation: Windows.UI.Core.CoreProximityEvaluation; + handled: boolean; + evaluateProximity(controlBoundingBox: Windows.Foundation.Rect): Windows.UI.Core.CoreProximityEvaluation; + evaluateProximity(controlVertices: Windows.Foundation.Point[]): Windows.UI.Core.CoreProximityEvaluation; + } + export class WindowSizeChangedEventArgs implements Windows.UI.Core.IWindowSizeChangedEventArgs, Windows.UI.Core.ICoreWindowEventArgs { + size: Windows.Foundation.Size; + handled: boolean; + } + export class VisibilityChangedEventArgs implements Windows.UI.Core.IVisibilityChangedEventArgs, Windows.UI.Core.ICoreWindowEventArgs { + visible: boolean; + handled: boolean; + } + export interface ICoreWindowStatic { + getForCurrentThread(): Windows.UI.Core.CoreWindow; + } + export interface DispatchedHandler { + (): void; + } + export interface IdleDispatchedHandler { + (e: Windows.UI.Core.IdleDispatchedHandlerArgs): void; + } + export class IdleDispatchedHandlerArgs implements Windows.UI.Core.IIdleDispatchedHandlerArgs { + isDispatcherIdle: boolean; + } + export interface IAcceleratorKeyEventArgs extends Windows.UI.Core.ICoreWindowEventArgs { + eventType: Windows.UI.Core.CoreAcceleratorKeyEventType; + keyStatus: Windows.UI.Core.CorePhysicalKeyStatus; + virtualKey: Windows.System.VirtualKey; + } + export interface ICoreAcceleratorKeys { + onacceleratorkeyactivated: any/* TODO */; + } + export class AcceleratorKeyEventArgs implements Windows.UI.Core.IAcceleratorKeyEventArgs, Windows.UI.Core.ICoreWindowEventArgs { + eventType: Windows.UI.Core.CoreAcceleratorKeyEventType; + keyStatus: Windows.UI.Core.CorePhysicalKeyStatus; + virtualKey: Windows.System.VirtualKey; + handled: boolean; + } + export interface ICoreDispatcher extends Windows.UI.Core.ICoreAcceleratorKeys { + hasThreadAccess: boolean; + processEvents(options: Windows.UI.Core.CoreProcessEventsOption): void; + runAsync(priority: Windows.UI.Core.CoreDispatcherPriority, agileCallback: Windows.UI.Core.DispatchedHandler): Windows.Foundation.IAsyncAction; + runIdleAsync(agileCallback: Windows.UI.Core.IdleDispatchedHandler): Windows.Foundation.IAsyncAction; + } + export interface IIdleDispatchedHandlerArgs { + isDispatcherIdle: boolean; + } + export class CoreAcceleratorKeys implements Windows.UI.Core.ICoreAcceleratorKeys { + onacceleratorkeyactivated: any/* TODO */; + } + export interface ICoreCursor { + id: number; + type: Windows.UI.Core.CoreCursorType; + } + export interface ICoreCursorFactory { + createCursor(type: Windows.UI.Core.CoreCursorType, id: number): Windows.UI.Core.CoreCursor; + } + export interface IInitializeWithCoreWindow { + initialize(window: Windows.UI.Core.CoreWindow): void; + } + export interface ICoreWindowResizeManager { + notifyLayoutCompleted(): void; + } + export interface ICoreWindowResizeManagerStatics { + getForCurrentView(): Windows.UI.Core.CoreWindowResizeManager; + } + export class CoreWindowResizeManager implements Windows.UI.Core.ICoreWindowResizeManager { + notifyLayoutCompleted(): void; + static getForCurrentView(): Windows.UI.Core.CoreWindowResizeManager; + } + export interface ICoreWindowPopupShowingEventArgs { + setDesiredSize(value: Windows.Foundation.Size): void; + } + export class CoreWindowPopupShowingEventArgs implements Windows.UI.Core.ICoreWindowPopupShowingEventArgs { + setDesiredSize(value: Windows.Foundation.Size): void; + } + export interface ICoreWindowDialog { + backButtonCommand: Windows.UI.Popups.UICommandInvokedHandler; + cancelCommandIndex: number; + commands: Windows.Foundation.Collections.IVector; + defaultCommandIndex: number; + isInteractionDelayed: number; + maxSize: Windows.Foundation.Size; + minSize: Windows.Foundation.Size; + title: string; + onshowing: any/* TODO */; + showAsync(): Windows.Foundation.IAsyncOperation; + } + export interface ICoreWindowDialogFactory { + createWithTitle(title: string): Windows.UI.Core.CoreWindowDialog; + } + export class CoreWindowDialog implements Windows.UI.Core.ICoreWindowDialog { + constructor(title: string); + constructor(); + backButtonCommand: Windows.UI.Popups.UICommandInvokedHandler; + cancelCommandIndex: number; + commands: Windows.Foundation.Collections.IVector; + defaultCommandIndex: number; + isInteractionDelayed: number; + maxSize: Windows.Foundation.Size; + minSize: Windows.Foundation.Size; + title: string; + onshowing: any/* TODO */; + showAsync(): Windows.Foundation.IAsyncOperation; + } + export interface ICoreWindowFlyout { + backButtonCommand: Windows.UI.Popups.UICommandInvokedHandler; + commands: Windows.Foundation.Collections.IVector; + defaultCommandIndex: number; + isInteractionDelayed: number; + maxSize: Windows.Foundation.Size; + minSize: Windows.Foundation.Size; + title: string; + onshowing: any/* TODO */; + showAsync(): Windows.Foundation.IAsyncOperation; + } + export interface ICoreWindowFlyoutFactory { + create(position: Windows.Foundation.Point): Windows.UI.Core.CoreWindowFlyout; + createWithTitle(position: Windows.Foundation.Point, title: string): Windows.UI.Core.CoreWindowFlyout; + } + export class CoreWindowFlyout implements Windows.UI.Core.ICoreWindowFlyout { + constructor(position: Windows.Foundation.Point); + constructor(position: Windows.Foundation.Point, title: string); + backButtonCommand: Windows.UI.Popups.UICommandInvokedHandler; + commands: Windows.Foundation.Collections.IVector; + defaultCommandIndex: number; + isInteractionDelayed: number; + maxSize: Windows.Foundation.Size; + minSize: Windows.Foundation.Size; + title: string; + onshowing: any/* TODO */; + showAsync(): Windows.Foundation.IAsyncOperation; + } + } + } +} +declare module Windows { + export module UI { + export module Input { + export module Inking { + export enum InkManipulationMode { + inking, + erasing, + selecting, + } + export enum InkRecognitionTarget { + all, + selected, + recent, + } + export enum PenTipShape { + circle, + rectangle, + } + export interface IInkDrawingAttributes { + color: Windows.UI.Color; + fitToCurve: boolean; + ignorePressure: boolean; + penTip: Windows.UI.Input.Inking.PenTipShape; + size: Windows.Foundation.Size; + } + export class InkDrawingAttributes implements Windows.UI.Input.Inking.IInkDrawingAttributes { + color: Windows.UI.Color; + fitToCurve: boolean; + ignorePressure: boolean; + penTip: Windows.UI.Input.Inking.PenTipShape; + size: Windows.Foundation.Size; + } + export interface IInkStrokeRenderingSegment { + bezierControlPoint1: Windows.Foundation.Point; + bezierControlPoint2: Windows.Foundation.Point; + position: Windows.Foundation.Point; + pressure: number; + tiltX: number; + tiltY: number; + twist: number; + } + export class InkStrokeRenderingSegment implements Windows.UI.Input.Inking.IInkStrokeRenderingSegment { + bezierControlPoint1: Windows.Foundation.Point; + bezierControlPoint2: Windows.Foundation.Point; + position: Windows.Foundation.Point; + pressure: number; + tiltX: number; + tiltY: number; + twist: number; + } + export interface IInkStroke { + boundingRect: Windows.Foundation.Rect; + drawingAttributes: Windows.UI.Input.Inking.InkDrawingAttributes; + recognized: boolean; + selected: boolean; + getRenderingSegments(): Windows.Foundation.Collections.IVectorView; + clone(): Windows.UI.Input.Inking.InkStroke; + } + export class InkStroke implements Windows.UI.Input.Inking.IInkStroke { + boundingRect: Windows.Foundation.Rect; + drawingAttributes: Windows.UI.Input.Inking.InkDrawingAttributes; + recognized: boolean; + selected: boolean; + getRenderingSegments(): Windows.Foundation.Collections.IVectorView; + clone(): Windows.UI.Input.Inking.InkStroke; + } + export interface IInkStrokeBuilder { + beginStroke(pointerPoint: Windows.UI.Input.PointerPoint): void; + appendToStroke(pointerPoint: Windows.UI.Input.PointerPoint): Windows.UI.Input.PointerPoint; + endStroke(pointerPoint: Windows.UI.Input.PointerPoint): Windows.UI.Input.Inking.InkStroke; + createStroke(points: Windows.Foundation.Collections.IIterable): Windows.UI.Input.Inking.InkStroke; + setDefaultDrawingAttributes(drawingAttributes: Windows.UI.Input.Inking.InkDrawingAttributes): void; + } + export class InkStrokeBuilder implements Windows.UI.Input.Inking.IInkStrokeBuilder { + beginStroke(pointerPoint: Windows.UI.Input.PointerPoint): void; + appendToStroke(pointerPoint: Windows.UI.Input.PointerPoint): Windows.UI.Input.PointerPoint; + endStroke(pointerPoint: Windows.UI.Input.PointerPoint): Windows.UI.Input.Inking.InkStroke; + createStroke(points: Windows.Foundation.Collections.IIterable): Windows.UI.Input.Inking.InkStroke; + setDefaultDrawingAttributes(drawingAttributes: Windows.UI.Input.Inking.InkDrawingAttributes): void; + } + export interface IInkRecognitionResult { + boundingRect: Windows.Foundation.Rect; + getTextCandidates(): Windows.Foundation.Collections.IVectorView; + getStrokes(): Windows.Foundation.Collections.IVectorView; + } + export class InkRecognitionResult implements Windows.UI.Input.Inking.IInkRecognitionResult { + boundingRect: Windows.Foundation.Rect; + getTextCandidates(): Windows.Foundation.Collections.IVectorView; + getStrokes(): Windows.Foundation.Collections.IVectorView; + } + export interface IInkStrokeContainer { + boundingRect: Windows.Foundation.Rect; + addStroke(stroke: Windows.UI.Input.Inking.InkStroke): void; + deleteSelected(): Windows.Foundation.Rect; + moveSelected(translation: Windows.Foundation.Point): Windows.Foundation.Rect; + selectWithPolyLine(polyline: Windows.Foundation.Collections.IIterable): Windows.Foundation.Rect; + selectWithLine(from: Windows.Foundation.Point, to: Windows.Foundation.Point): Windows.Foundation.Rect; + copySelectedToClipboard(): void; + pasteFromClipboard(position: Windows.Foundation.Point): Windows.Foundation.Rect; + canPasteFromClipboard(): boolean; + loadAsync(inputStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncActionWithProgress; + saveAsync(outputStream: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncOperationWithProgress; + updateRecognitionResults(recognitionResults: Windows.Foundation.Collections.IVectorView): void; + getStrokes(): Windows.Foundation.Collections.IVectorView; + getRecognitionResults(): Windows.Foundation.Collections.IVectorView; + } + export class InkStrokeContainer implements Windows.UI.Input.Inking.IInkStrokeContainer { + boundingRect: Windows.Foundation.Rect; + addStroke(stroke: Windows.UI.Input.Inking.InkStroke): void; + deleteSelected(): Windows.Foundation.Rect; + moveSelected(translation: Windows.Foundation.Point): Windows.Foundation.Rect; + selectWithPolyLine(polyline: Windows.Foundation.Collections.IIterable): Windows.Foundation.Rect; + selectWithLine(from: Windows.Foundation.Point, to: Windows.Foundation.Point): Windows.Foundation.Rect; + copySelectedToClipboard(): void; + pasteFromClipboard(position: Windows.Foundation.Point): Windows.Foundation.Rect; + canPasteFromClipboard(): boolean; + loadAsync(inputStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncActionWithProgress; + saveAsync(outputStream: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncOperationWithProgress; + updateRecognitionResults(recognitionResults: Windows.Foundation.Collections.IVectorView): void; + getStrokes(): Windows.Foundation.Collections.IVectorView; + getRecognitionResults(): Windows.Foundation.Collections.IVectorView; + } + export interface IInkRecognizer { + name: string; + } + export class InkRecognizer implements Windows.UI.Input.Inking.IInkRecognizer { + name: string; + } + export interface IInkRecognizerContainer { + setDefaultRecognizer(recognizer: Windows.UI.Input.Inking.InkRecognizer): void; + recognizeAsync(strokeCollection: Windows.UI.Input.Inking.InkStrokeContainer, recognitionTarget: Windows.UI.Input.Inking.InkRecognitionTarget): Windows.Foundation.IAsyncOperation>; + getRecognizers(): Windows.Foundation.Collections.IVectorView; + } + export class InkRecognizerContainer implements Windows.UI.Input.Inking.IInkRecognizerContainer { + setDefaultRecognizer(recognizer: Windows.UI.Input.Inking.InkRecognizer): void; + recognizeAsync(strokeCollection: Windows.UI.Input.Inking.InkStrokeContainer, recognitionTarget: Windows.UI.Input.Inking.InkRecognitionTarget): Windows.Foundation.IAsyncOperation>; + getRecognizers(): Windows.Foundation.Collections.IVectorView; + } + export interface IInkManager extends Windows.UI.Input.Inking.IInkStrokeContainer, Windows.UI.Input.Inking.IInkRecognizerContainer { + mode: Windows.UI.Input.Inking.InkManipulationMode; + processPointerDown(pointerPoint: Windows.UI.Input.PointerPoint): void; + processPointerUpdate(pointerPoint: Windows.UI.Input.PointerPoint): any; + processPointerUp(pointerPoint: Windows.UI.Input.PointerPoint): Windows.Foundation.Rect; + setDefaultDrawingAttributes(drawingAttributes: Windows.UI.Input.Inking.InkDrawingAttributes): void; + recognizeAsync(strokeCollection: Windows.UI.Input.Inking.InkStrokeContainer, recognitionTarget: Windows.UI.Input.Inking.InkRecognitionTarget): Windows.Foundation.IAsyncOperation>; + recognizeAsync(recognitionTarget: Windows.UI.Input.Inking.InkRecognitionTarget): Windows.Foundation.IAsyncOperation>; + } + export class InkManager implements Windows.UI.Input.Inking.IInkManager, Windows.UI.Input.Inking.IInkStrokeContainer, Windows.UI.Input.Inking.IInkRecognizerContainer { + mode: Windows.UI.Input.Inking.InkManipulationMode; + boundingRect: Windows.Foundation.Rect; + processPointerDown(pointerPoint: Windows.UI.Input.PointerPoint): void; + processPointerUpdate(pointerPoint: Windows.UI.Input.PointerPoint): any; + processPointerUp(pointerPoint: Windows.UI.Input.PointerPoint): Windows.Foundation.Rect; + setDefaultDrawingAttributes(drawingAttributes: Windows.UI.Input.Inking.InkDrawingAttributes): void; + recognizeAsync(recognitionTarget: Windows.UI.Input.Inking.InkRecognitionTarget): Windows.Foundation.IAsyncOperation>; + addStroke(stroke: Windows.UI.Input.Inking.InkStroke): void; + deleteSelected(): Windows.Foundation.Rect; + moveSelected(translation: Windows.Foundation.Point): Windows.Foundation.Rect; + selectWithPolyLine(polyline: Windows.Foundation.Collections.IIterable): Windows.Foundation.Rect; + selectWithLine(from: Windows.Foundation.Point, to: Windows.Foundation.Point): Windows.Foundation.Rect; + copySelectedToClipboard(): void; + pasteFromClipboard(position: Windows.Foundation.Point): Windows.Foundation.Rect; + canPasteFromClipboard(): boolean; + loadAsync(inputStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncActionWithProgress; + saveAsync(outputStream: Windows.Storage.Streams.IOutputStream): Windows.Foundation.IAsyncOperationWithProgress; + updateRecognitionResults(recognitionResults: Windows.Foundation.Collections.IVectorView): void; + getStrokes(): Windows.Foundation.Collections.IVectorView; + getRecognitionResults(): Windows.Foundation.Collections.IVectorView; + setDefaultRecognizer(recognizer: Windows.UI.Input.Inking.InkRecognizer): void; + recognizeAsync(strokeCollection: Windows.UI.Input.Inking.InkStrokeContainer, recognitionTarget: Windows.UI.Input.Inking.InkRecognitionTarget): Windows.Foundation.IAsyncOperation>; + getRecognizers(): Windows.Foundation.Collections.IVectorView; + } + } + } + } +} +declare module Windows { + export module UI { + export module WebUI { + export interface IActivatedDeferral { + complete(): void; + } + export class ActivatedDeferral implements Windows.UI.WebUI.IActivatedDeferral { + complete(): void; + } + export interface IActivatedOperation { + getDeferral(): Windows.UI.WebUI.ActivatedDeferral; + } + export class ActivatedOperation implements Windows.UI.WebUI.IActivatedOperation { + getDeferral(): Windows.UI.WebUI.ActivatedDeferral; + } + export interface IActivatedEventArgsDeferral { + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUILaunchActivatedEventArgs implements Windows.ApplicationModel.Activation.ILaunchActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + arguments: string; + tileId: string; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUISearchActivatedEventArgs implements Windows.ApplicationModel.Activation.ISearchActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + language: string; + queryText: string; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUIShareTargetActivatedEventArgs implements Windows.ApplicationModel.Activation.IShareTargetActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + shareOperation: Windows.ApplicationModel.DataTransfer.ShareTarget.ShareOperation; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUIFileActivatedEventArgs implements Windows.ApplicationModel.Activation.IFileActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + files: Windows.Foundation.Collections.IVectorView; + verb: string; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUIProtocolActivatedEventArgs implements Windows.ApplicationModel.Activation.IProtocolActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + uri: Windows.Foundation.Uri; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUIFileOpenPickerActivatedEventArgs implements Windows.ApplicationModel.Activation.IFileOpenPickerActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + fileOpenPickerUI: Windows.Storage.Pickers.Provider.FileOpenPickerUI; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUIFileSavePickerActivatedEventArgs implements Windows.ApplicationModel.Activation.IFileSavePickerActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + fileSavePickerUI: Windows.Storage.Pickers.Provider.FileSavePickerUI; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUICachedFileUpdaterActivatedEventArgs implements Windows.ApplicationModel.Activation.ICachedFileUpdaterActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + cachedFileUpdaterUI: Windows.Storage.Provider.CachedFileUpdaterUI; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUIContactPickerActivatedEventArgs implements Windows.ApplicationModel.Activation.IContactPickerActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + contactPickerUI: Windows.ApplicationModel.Contacts.Provider.ContactPickerUI; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUIDeviceActivatedEventArgs implements Windows.ApplicationModel.Activation.IDeviceActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + deviceInformationId: string; + verb: string; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUIPrintTaskSettingsActivatedEventArgs implements Windows.ApplicationModel.Activation.IPrintTaskSettingsActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + configuration: Windows.Devices.Printers.Extensions.PrintTaskConfiguration; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export class WebUICameraSettingsActivatedEventArgs implements Windows.ApplicationModel.Activation.ICameraSettingsActivatedEventArgs, Windows.ApplicationModel.Activation.IActivatedEventArgs, Windows.UI.WebUI.IActivatedEventArgsDeferral { + videoDeviceController: any; + videoDeviceExtension: any; + kind: Windows.ApplicationModel.Activation.ActivationKind; + previousExecutionState: Windows.ApplicationModel.Activation.ApplicationExecutionState; + splashScreen: Windows.ApplicationModel.Activation.SplashScreen; + activatedOperation: Windows.UI.WebUI.ActivatedOperation; + } + export interface ActivatedEventHandler { + (sender: any, eventArgs: Windows.ApplicationModel.Activation.IActivatedEventArgs): void; + } + export interface ResumingEventHandler { + (sender: any): void; + } + export interface SuspendingEventHandler { + (sender: any, e: Windows.ApplicationModel.ISuspendingEventArgs): void; + } + export interface NavigatedEventHandler { + (sender: any, e: Windows.UI.WebUI.IWebUINavigatedEventArgs): void; + } + export interface IWebUINavigatedEventArgs { + navigatedOperation: Windows.UI.WebUI.WebUINavigatedOperation; + } + export class WebUINavigatedOperation implements Windows.UI.WebUI.IWebUINavigatedOperation { + getDeferral(): Windows.UI.WebUI.WebUINavigatedDeferral; + } + export class SuspendingDeferral implements Windows.ApplicationModel.ISuspendingDeferral { + complete(): void; + } + export class SuspendingOperation implements Windows.ApplicationModel.ISuspendingOperation { + deadline: Date; + getDeferral(): Windows.ApplicationModel.SuspendingDeferral; + } + export class SuspendingEventArgs implements Windows.ApplicationModel.ISuspendingEventArgs { + suspendingOperation: Windows.ApplicationModel.SuspendingOperation; + } + export interface IWebUIBackgroundTaskInstance { + succeeded: boolean; + } + export interface IWebUIBackgroundTaskInstanceStatics { + current: Windows.UI.WebUI.IWebUIBackgroundTaskInstance; + } + export class WebUIBackgroundTaskInstanceRuntimeClass implements Windows.UI.WebUI.IWebUIBackgroundTaskInstance, Windows.ApplicationModel.Background.IBackgroundTaskInstance { + succeeded: boolean; + instanceId: string; + progress: number; + suspendedCount: number; + task: Windows.ApplicationModel.Background.BackgroundTaskRegistration; + triggerDetails: any; + oncanceled: any/* TODO */; + getDeferral(): Windows.ApplicationModel.Background.BackgroundTaskDeferral; + } + export class WebUIBackgroundTaskInstance { + static current: Windows.UI.WebUI.IWebUIBackgroundTaskInstance; + } + export interface IWebUINavigatedDeferral { + complete(): void; + } + export class WebUINavigatedDeferral implements Windows.UI.WebUI.IWebUINavigatedDeferral { + complete(): void; + } + export interface IWebUINavigatedOperation { + getDeferral(): Windows.UI.WebUI.WebUINavigatedDeferral; + } + export class WebUINavigatedEventArgs implements Windows.UI.WebUI.IWebUINavigatedEventArgs { + navigatedOperation: Windows.UI.WebUI.WebUINavigatedOperation; + } + export interface IWebUIActivationStatics { + onactivated: any/* TODO */; + onsuspending: any/* TODO */; + onresuming: any/* TODO */; + onnavigated: any/* TODO */; + } + export class WebUIApplication { + static onactivated: any/* TODO */; + static onsuspending: any/* TODO */; + static onresuming: any/* TODO */; + static onnavigated: any/* TODO */; + } + } + } +} +declare module Windows { + export module UI { + export interface IColors { + } + export interface IColorsStatics { + aliceBlue: Windows.UI.Color; + antiqueWhite: Windows.UI.Color; + aqua: Windows.UI.Color; + aquamarine: Windows.UI.Color; + azure: Windows.UI.Color; + beige: Windows.UI.Color; + bisque: Windows.UI.Color; + black: Windows.UI.Color; + blanchedAlmond: Windows.UI.Color; + blue: Windows.UI.Color; + blueViolet: Windows.UI.Color; + brown: Windows.UI.Color; + burlyWood: Windows.UI.Color; + cadetBlue: Windows.UI.Color; + chartreuse: Windows.UI.Color; + chocolate: Windows.UI.Color; + coral: Windows.UI.Color; + cornflowerBlue: Windows.UI.Color; + cornsilk: Windows.UI.Color; + crimson: Windows.UI.Color; + cyan: Windows.UI.Color; + darkBlue: Windows.UI.Color; + darkCyan: Windows.UI.Color; + darkGoldenrod: Windows.UI.Color; + darkGray: Windows.UI.Color; + darkGreen: Windows.UI.Color; + darkKhaki: Windows.UI.Color; + darkMagenta: Windows.UI.Color; + darkOliveGreen: Windows.UI.Color; + darkOrange: Windows.UI.Color; + darkOrchid: Windows.UI.Color; + darkRed: Windows.UI.Color; + darkSalmon: Windows.UI.Color; + darkSeaGreen: Windows.UI.Color; + darkSlateBlue: Windows.UI.Color; + darkSlateGray: Windows.UI.Color; + darkTurquoise: Windows.UI.Color; + darkViolet: Windows.UI.Color; + deepPink: Windows.UI.Color; + deepSkyBlue: Windows.UI.Color; + dimGray: Windows.UI.Color; + dodgerBlue: Windows.UI.Color; + firebrick: Windows.UI.Color; + floralWhite: Windows.UI.Color; + forestGreen: Windows.UI.Color; + fuchsia: Windows.UI.Color; + gainsboro: Windows.UI.Color; + ghostWhite: Windows.UI.Color; + gold: Windows.UI.Color; + goldenrod: Windows.UI.Color; + gray: Windows.UI.Color; + green: Windows.UI.Color; + greenYellow: Windows.UI.Color; + honeydew: Windows.UI.Color; + hotPink: Windows.UI.Color; + indianRed: Windows.UI.Color; + indigo: Windows.UI.Color; + ivory: Windows.UI.Color; + khaki: Windows.UI.Color; + lavender: Windows.UI.Color; + lavenderBlush: Windows.UI.Color; + lawnGreen: Windows.UI.Color; + lemonChiffon: Windows.UI.Color; + lightBlue: Windows.UI.Color; + lightCoral: Windows.UI.Color; + lightCyan: Windows.UI.Color; + lightGoldenrodYellow: Windows.UI.Color; + lightGray: Windows.UI.Color; + lightGreen: Windows.UI.Color; + lightPink: Windows.UI.Color; + lightSalmon: Windows.UI.Color; + lightSeaGreen: Windows.UI.Color; + lightSkyBlue: Windows.UI.Color; + lightSlateGray: Windows.UI.Color; + lightSteelBlue: Windows.UI.Color; + lightYellow: Windows.UI.Color; + lime: Windows.UI.Color; + limeGreen: Windows.UI.Color; + linen: Windows.UI.Color; + magenta: Windows.UI.Color; + maroon: Windows.UI.Color; + mediumAquamarine: Windows.UI.Color; + mediumBlue: Windows.UI.Color; + mediumOrchid: Windows.UI.Color; + mediumPurple: Windows.UI.Color; + mediumSeaGreen: Windows.UI.Color; + mediumSlateBlue: Windows.UI.Color; + mediumSpringGreen: Windows.UI.Color; + mediumTurquoise: Windows.UI.Color; + mediumVioletRed: Windows.UI.Color; + midnightBlue: Windows.UI.Color; + mintCream: Windows.UI.Color; + mistyRose: Windows.UI.Color; + moccasin: Windows.UI.Color; + navajoWhite: Windows.UI.Color; + navy: Windows.UI.Color; + oldLace: Windows.UI.Color; + olive: Windows.UI.Color; + oliveDrab: Windows.UI.Color; + orange: Windows.UI.Color; + orangeRed: Windows.UI.Color; + orchid: Windows.UI.Color; + paleGoldenrod: Windows.UI.Color; + paleGreen: Windows.UI.Color; + paleTurquoise: Windows.UI.Color; + paleVioletRed: Windows.UI.Color; + papayaWhip: Windows.UI.Color; + peachPuff: Windows.UI.Color; + peru: Windows.UI.Color; + pink: Windows.UI.Color; + plum: Windows.UI.Color; + powderBlue: Windows.UI.Color; + purple: Windows.UI.Color; + red: Windows.UI.Color; + rosyBrown: Windows.UI.Color; + royalBlue: Windows.UI.Color; + saddleBrown: Windows.UI.Color; + salmon: Windows.UI.Color; + sandyBrown: Windows.UI.Color; + seaGreen: Windows.UI.Color; + seaShell: Windows.UI.Color; + sienna: Windows.UI.Color; + silver: Windows.UI.Color; + skyBlue: Windows.UI.Color; + slateBlue: Windows.UI.Color; + slateGray: Windows.UI.Color; + snow: Windows.UI.Color; + springGreen: Windows.UI.Color; + steelBlue: Windows.UI.Color; + tan: Windows.UI.Color; + teal: Windows.UI.Color; + thistle: Windows.UI.Color; + tomato: Windows.UI.Color; + transparent: Windows.UI.Color; + turquoise: Windows.UI.Color; + violet: Windows.UI.Color; + wheat: Windows.UI.Color; + white: Windows.UI.Color; + whiteSmoke: Windows.UI.Color; + yellow: Windows.UI.Color; + yellowGreen: Windows.UI.Color; + } + export class Colors implements Windows.UI.IColors { + static aliceBlue: Windows.UI.Color; + static antiqueWhite: Windows.UI.Color; + static aqua: Windows.UI.Color; + static aquamarine: Windows.UI.Color; + static azure: Windows.UI.Color; + static beige: Windows.UI.Color; + static bisque: Windows.UI.Color; + static black: Windows.UI.Color; + static blanchedAlmond: Windows.UI.Color; + static blue: Windows.UI.Color; + static blueViolet: Windows.UI.Color; + static brown: Windows.UI.Color; + static burlyWood: Windows.UI.Color; + static cadetBlue: Windows.UI.Color; + static chartreuse: Windows.UI.Color; + static chocolate: Windows.UI.Color; + static coral: Windows.UI.Color; + static cornflowerBlue: Windows.UI.Color; + static cornsilk: Windows.UI.Color; + static crimson: Windows.UI.Color; + static cyan: Windows.UI.Color; + static darkBlue: Windows.UI.Color; + static darkCyan: Windows.UI.Color; + static darkGoldenrod: Windows.UI.Color; + static darkGray: Windows.UI.Color; + static darkGreen: Windows.UI.Color; + static darkKhaki: Windows.UI.Color; + static darkMagenta: Windows.UI.Color; + static darkOliveGreen: Windows.UI.Color; + static darkOrange: Windows.UI.Color; + static darkOrchid: Windows.UI.Color; + static darkRed: Windows.UI.Color; + static darkSalmon: Windows.UI.Color; + static darkSeaGreen: Windows.UI.Color; + static darkSlateBlue: Windows.UI.Color; + static darkSlateGray: Windows.UI.Color; + static darkTurquoise: Windows.UI.Color; + static darkViolet: Windows.UI.Color; + static deepPink: Windows.UI.Color; + static deepSkyBlue: Windows.UI.Color; + static dimGray: Windows.UI.Color; + static dodgerBlue: Windows.UI.Color; + static firebrick: Windows.UI.Color; + static floralWhite: Windows.UI.Color; + static forestGreen: Windows.UI.Color; + static fuchsia: Windows.UI.Color; + static gainsboro: Windows.UI.Color; + static ghostWhite: Windows.UI.Color; + static gold: Windows.UI.Color; + static goldenrod: Windows.UI.Color; + static gray: Windows.UI.Color; + static green: Windows.UI.Color; + static greenYellow: Windows.UI.Color; + static honeydew: Windows.UI.Color; + static hotPink: Windows.UI.Color; + static indianRed: Windows.UI.Color; + static indigo: Windows.UI.Color; + static ivory: Windows.UI.Color; + static khaki: Windows.UI.Color; + static lavender: Windows.UI.Color; + static lavenderBlush: Windows.UI.Color; + static lawnGreen: Windows.UI.Color; + static lemonChiffon: Windows.UI.Color; + static lightBlue: Windows.UI.Color; + static lightCoral: Windows.UI.Color; + static lightCyan: Windows.UI.Color; + static lightGoldenrodYellow: Windows.UI.Color; + static lightGray: Windows.UI.Color; + static lightGreen: Windows.UI.Color; + static lightPink: Windows.UI.Color; + static lightSalmon: Windows.UI.Color; + static lightSeaGreen: Windows.UI.Color; + static lightSkyBlue: Windows.UI.Color; + static lightSlateGray: Windows.UI.Color; + static lightSteelBlue: Windows.UI.Color; + static lightYellow: Windows.UI.Color; + static lime: Windows.UI.Color; + static limeGreen: Windows.UI.Color; + static linen: Windows.UI.Color; + static magenta: Windows.UI.Color; + static maroon: Windows.UI.Color; + static mediumAquamarine: Windows.UI.Color; + static mediumBlue: Windows.UI.Color; + static mediumOrchid: Windows.UI.Color; + static mediumPurple: Windows.UI.Color; + static mediumSeaGreen: Windows.UI.Color; + static mediumSlateBlue: Windows.UI.Color; + static mediumSpringGreen: Windows.UI.Color; + static mediumTurquoise: Windows.UI.Color; + static mediumVioletRed: Windows.UI.Color; + static midnightBlue: Windows.UI.Color; + static mintCream: Windows.UI.Color; + static mistyRose: Windows.UI.Color; + static moccasin: Windows.UI.Color; + static navajoWhite: Windows.UI.Color; + static navy: Windows.UI.Color; + static oldLace: Windows.UI.Color; + static olive: Windows.UI.Color; + static oliveDrab: Windows.UI.Color; + static orange: Windows.UI.Color; + static orangeRed: Windows.UI.Color; + static orchid: Windows.UI.Color; + static paleGoldenrod: Windows.UI.Color; + static paleGreen: Windows.UI.Color; + static paleTurquoise: Windows.UI.Color; + static paleVioletRed: Windows.UI.Color; + static papayaWhip: Windows.UI.Color; + static peachPuff: Windows.UI.Color; + static peru: Windows.UI.Color; + static pink: Windows.UI.Color; + static plum: Windows.UI.Color; + static powderBlue: Windows.UI.Color; + static purple: Windows.UI.Color; + static red: Windows.UI.Color; + static rosyBrown: Windows.UI.Color; + static royalBlue: Windows.UI.Color; + static saddleBrown: Windows.UI.Color; + static salmon: Windows.UI.Color; + static sandyBrown: Windows.UI.Color; + static seaGreen: Windows.UI.Color; + static seaShell: Windows.UI.Color; + static sienna: Windows.UI.Color; + static silver: Windows.UI.Color; + static skyBlue: Windows.UI.Color; + static slateBlue: Windows.UI.Color; + static slateGray: Windows.UI.Color; + static snow: Windows.UI.Color; + static springGreen: Windows.UI.Color; + static steelBlue: Windows.UI.Color; + static tan: Windows.UI.Color; + static teal: Windows.UI.Color; + static thistle: Windows.UI.Color; + static tomato: Windows.UI.Color; + static transparent: Windows.UI.Color; + static turquoise: Windows.UI.Color; + static violet: Windows.UI.Color; + static wheat: Windows.UI.Color; + static white: Windows.UI.Color; + static whiteSmoke: Windows.UI.Color; + static yellow: Windows.UI.Color; + static yellowGreen: Windows.UI.Color; + } + export interface Color { + a: number; + r: number; + g: number; + b: number; + } + export interface IColorHelper { + } + export interface IColorHelperStatics { + fromArgb(a: number, r: number, g: number, b: number): Windows.UI.Color; + } + export class ColorHelper implements Windows.UI.IColorHelper { + static fromArgb(a: number, r: number, g: number, b: number): Windows.UI.Color; + } + } +} +declare module Windows { + export module UI { + export module Notifications { + export enum NotificationSetting { + enabled, + disabledForApplication, + disabledForUser, + disabledByGroupPolicy, + disabledByManifest, + } + export enum ToastDismissalReason { + userCanceled, + applicationHidden, + timedOut, + } + export enum BadgeTemplateType { + badgeGlyph, + badgeNumber, + } + export enum TileTemplateType { + tileSquareImage, + tileSquareBlock, + tileSquareText01, + tileSquareText02, + tileSquareText03, + tileSquareText04, + tileSquarePeekImageAndText01, + tileSquarePeekImageAndText02, + tileSquarePeekImageAndText03, + tileSquarePeekImageAndText04, + tileWideImage, + tileWideImageCollection, + tileWideImageAndText01, + tileWideImageAndText02, + tileWideBlockAndText01, + tileWideBlockAndText02, + tileWidePeekImageCollection01, + tileWidePeekImageCollection02, + tileWidePeekImageCollection03, + tileWidePeekImageCollection04, + tileWidePeekImageCollection05, + tileWidePeekImageCollection06, + tileWidePeekImageAndText01, + tileWidePeekImageAndText02, + tileWidePeekImage01, + tileWidePeekImage02, + tileWidePeekImage03, + tileWidePeekImage04, + tileWidePeekImage05, + tileWidePeekImage06, + tileWideSmallImageAndText01, + tileWideSmallImageAndText02, + tileWideSmallImageAndText03, + tileWideSmallImageAndText04, + tileWideSmallImageAndText05, + tileWideText01, + tileWideText02, + tileWideText03, + tileWideText04, + tileWideText05, + tileWideText06, + tileWideText07, + tileWideText08, + tileWideText09, + tileWideText10, + tileWideText11, + } + export enum ToastTemplateType { + toastImageAndText01, + toastImageAndText02, + toastImageAndText03, + toastImageAndText04, + toastText01, + toastText02, + toastText03, + toastText04, + } + export enum PeriodicUpdateRecurrence { + halfHour, + hour, + sixHours, + twelveHours, + daily, + } + export interface IToastDismissedEventArgs { + reason: Windows.UI.Notifications.ToastDismissalReason; + } + export interface IToastFailedEventArgs { + errorCode: number; + } + export interface ITileUpdateManagerStatics { + createTileUpdaterForApplication(): Windows.UI.Notifications.TileUpdater; + createTileUpdaterForApplication(applicationId: string): Windows.UI.Notifications.TileUpdater; + createTileUpdaterForSecondaryTile(tileId: string): Windows.UI.Notifications.TileUpdater; + getTemplateContent(type: Windows.UI.Notifications.TileTemplateType): Windows.Data.Xml.Dom.XmlDocument; + } + export class TileUpdater implements Windows.UI.Notifications.ITileUpdater { + setting: Windows.UI.Notifications.NotificationSetting; + update(notification: Windows.UI.Notifications.TileNotification): void; + clear(): void; + enableNotificationQueue(enable: boolean): void; + addToSchedule(scheduledTile: Windows.UI.Notifications.ScheduledTileNotification): void; + removeFromSchedule(scheduledTile: Windows.UI.Notifications.ScheduledTileNotification): void; + getScheduledTileNotifications(): Windows.Foundation.Collections.IVectorView; + startPeriodicUpdate(tileContent: Windows.Foundation.Uri, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + startPeriodicUpdate(tileContent: Windows.Foundation.Uri, startTime: Date, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + stopPeriodicUpdate(): void; + startPeriodicUpdateBatch(tileContents: Windows.Foundation.Collections.IIterable, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + startPeriodicUpdateBatch(tileContents: Windows.Foundation.Collections.IIterable, startTime: Date, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + } + export interface ITileUpdater { + setting: Windows.UI.Notifications.NotificationSetting; + update(notification: Windows.UI.Notifications.TileNotification): void; + clear(): void; + enableNotificationQueue(enable: boolean): void; + addToSchedule(scheduledTile: Windows.UI.Notifications.ScheduledTileNotification): void; + removeFromSchedule(scheduledTile: Windows.UI.Notifications.ScheduledTileNotification): void; + getScheduledTileNotifications(): Windows.Foundation.Collections.IVectorView; + startPeriodicUpdate(tileContent: Windows.Foundation.Uri, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + startPeriodicUpdate(tileContent: Windows.Foundation.Uri, startTime: Date, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + stopPeriodicUpdate(): void; + startPeriodicUpdateBatch(tileContents: Windows.Foundation.Collections.IIterable, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + startPeriodicUpdateBatch(tileContents: Windows.Foundation.Collections.IIterable, startTime: Date, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + } + export class TileNotification implements Windows.UI.Notifications.ITileNotification { + constructor(content: Windows.Data.Xml.Dom.XmlDocument); + content: Windows.Data.Xml.Dom.XmlDocument; + expirationTime: Date; + tag: string; + } + export class ScheduledTileNotification implements Windows.UI.Notifications.IScheduledTileNotification { + constructor(content: Windows.Data.Xml.Dom.XmlDocument, deliveryTime: Date); + content: Windows.Data.Xml.Dom.XmlDocument; + deliveryTime: Date; + expirationTime: Date; + id: string; + tag: string; + } + export interface IBadgeUpdateManagerStatics { + createBadgeUpdaterForApplication(): Windows.UI.Notifications.BadgeUpdater; + createBadgeUpdaterForApplication(applicationId: string): Windows.UI.Notifications.BadgeUpdater; + createBadgeUpdaterForSecondaryTile(tileId: string): Windows.UI.Notifications.BadgeUpdater; + getTemplateContent(type: Windows.UI.Notifications.BadgeTemplateType): Windows.Data.Xml.Dom.XmlDocument; + } + export class BadgeUpdater implements Windows.UI.Notifications.IBadgeUpdater { + update(notification: Windows.UI.Notifications.BadgeNotification): void; + clear(): void; + startPeriodicUpdate(badgeContent: Windows.Foundation.Uri, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + startPeriodicUpdate(badgeContent: Windows.Foundation.Uri, startTime: Date, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + stopPeriodicUpdate(): void; + } + export interface IBadgeUpdater { + update(notification: Windows.UI.Notifications.BadgeNotification): void; + clear(): void; + startPeriodicUpdate(badgeContent: Windows.Foundation.Uri, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + startPeriodicUpdate(badgeContent: Windows.Foundation.Uri, startTime: Date, requestedInterval: Windows.UI.Notifications.PeriodicUpdateRecurrence): void; + stopPeriodicUpdate(): void; + } + export class BadgeNotification implements Windows.UI.Notifications.IBadgeNotification { + constructor(content: Windows.Data.Xml.Dom.XmlDocument); + content: Windows.Data.Xml.Dom.XmlDocument; + expirationTime: Date; + } + export interface IToastNotificationManagerStatics { + createToastNotifier(): Windows.UI.Notifications.ToastNotifier; + createToastNotifier(applicationId: string): Windows.UI.Notifications.ToastNotifier; + getTemplateContent(type: Windows.UI.Notifications.ToastTemplateType): Windows.Data.Xml.Dom.XmlDocument; + } + export class ToastNotifier implements Windows.UI.Notifications.IToastNotifier { + setting: Windows.UI.Notifications.NotificationSetting; + show(notification: Windows.UI.Notifications.ToastNotification): void; + hide(notification: Windows.UI.Notifications.ToastNotification): void; + addToSchedule(scheduledToast: Windows.UI.Notifications.ScheduledToastNotification): void; + removeFromSchedule(scheduledToast: Windows.UI.Notifications.ScheduledToastNotification): void; + getScheduledToastNotifications(): Windows.Foundation.Collections.IVectorView; + } + export interface IToastNotifier { + setting: Windows.UI.Notifications.NotificationSetting; + show(notification: Windows.UI.Notifications.ToastNotification): void; + hide(notification: Windows.UI.Notifications.ToastNotification): void; + addToSchedule(scheduledToast: Windows.UI.Notifications.ScheduledToastNotification): void; + removeFromSchedule(scheduledToast: Windows.UI.Notifications.ScheduledToastNotification): void; + getScheduledToastNotifications(): Windows.Foundation.Collections.IVectorView; + } + export class ToastNotification implements Windows.UI.Notifications.IToastNotification { + constructor(content: Windows.Data.Xml.Dom.XmlDocument); + content: Windows.Data.Xml.Dom.XmlDocument; + expirationTime: Date; + ondismissed: any/* TODO */; + onactivated: any/* TODO */; + onfailed: any/* TODO */; + } + export class ScheduledToastNotification implements Windows.UI.Notifications.IScheduledToastNotification { + constructor(content: Windows.Data.Xml.Dom.XmlDocument, deliveryTime: Date); + constructor(content: Windows.Data.Xml.Dom.XmlDocument, deliveryTime: Date, snoozeInterval: number, maximumSnoozeCount: number); + content: Windows.Data.Xml.Dom.XmlDocument; + deliveryTime: Date; + id: string; + maximumSnoozeCount: number; + snoozeInterval: number; + } + export interface ITileNotificationFactory { + createTileNotification(content: Windows.Data.Xml.Dom.XmlDocument): Windows.UI.Notifications.TileNotification; + } + export interface ITileNotification { + content: Windows.Data.Xml.Dom.XmlDocument; + expirationTime: Date; + tag: string; + } + export interface IBadgeNotificationFactory { + createBadgeNotification(content: Windows.Data.Xml.Dom.XmlDocument): Windows.UI.Notifications.BadgeNotification; + } + export interface IBadgeNotification { + content: Windows.Data.Xml.Dom.XmlDocument; + expirationTime: Date; + } + export interface IToastNotificationFactory { + createToastNotification(content: Windows.Data.Xml.Dom.XmlDocument): Windows.UI.Notifications.ToastNotification; + } + export interface IToastNotification { + content: Windows.Data.Xml.Dom.XmlDocument; + expirationTime: Date; + ondismissed: any/* TODO */; + onactivated: any/* TODO */; + onfailed: any/* TODO */; + } + export class ToastDismissedEventArgs implements Windows.UI.Notifications.IToastDismissedEventArgs { + reason: Windows.UI.Notifications.ToastDismissalReason; + } + export class ToastFailedEventArgs implements Windows.UI.Notifications.IToastFailedEventArgs { + errorCode: number; + } + export interface IScheduledToastNotificationFactory { + createScheduledToastNotification(content: Windows.Data.Xml.Dom.XmlDocument, deliveryTime: Date): Windows.UI.Notifications.ScheduledToastNotification; + createScheduledToastNotification(content: Windows.Data.Xml.Dom.XmlDocument, deliveryTime: Date, snoozeInterval: number, maximumSnoozeCount: number): Windows.UI.Notifications.ScheduledToastNotification; + } + export interface IScheduledToastNotification { + content: Windows.Data.Xml.Dom.XmlDocument; + deliveryTime: Date; + id: string; + maximumSnoozeCount: number; + snoozeInterval: number; + } + export interface IScheduledTileNotificationFactory { + createScheduledTileNotification(content: Windows.Data.Xml.Dom.XmlDocument, deliveryTime: Date): Windows.UI.Notifications.ScheduledTileNotification; + } + export interface IScheduledTileNotification { + content: Windows.Data.Xml.Dom.XmlDocument; + deliveryTime: Date; + expirationTime: Date; + id: string; + tag: string; + } + export class TileUpdateManager { + static createTileUpdaterForApplication(): Windows.UI.Notifications.TileUpdater; + static createTileUpdaterForApplication(applicationId: string): Windows.UI.Notifications.TileUpdater; + static createTileUpdaterForSecondaryTile(tileId: string): Windows.UI.Notifications.TileUpdater; + static getTemplateContent(type: Windows.UI.Notifications.TileTemplateType): Windows.Data.Xml.Dom.XmlDocument; + } + export class BadgeUpdateManager { + static createBadgeUpdaterForApplication(): Windows.UI.Notifications.BadgeUpdater; + static createBadgeUpdaterForApplication(applicationId: string): Windows.UI.Notifications.BadgeUpdater; + static createBadgeUpdaterForSecondaryTile(tileId: string): Windows.UI.Notifications.BadgeUpdater; + static getTemplateContent(type: Windows.UI.Notifications.BadgeTemplateType): Windows.Data.Xml.Dom.XmlDocument; + } + export class ToastNotificationManager { + static createToastNotifier(): Windows.UI.Notifications.ToastNotifier; + static createToastNotifier(applicationId: string): Windows.UI.Notifications.ToastNotifier; + static getTemplateContent(type: Windows.UI.Notifications.ToastTemplateType): Windows.Data.Xml.Dom.XmlDocument; + } + } + } +} +declare module Windows { + export module Web { + export enum WebErrorStatus { + unknown, + certificateCommonNameIsIncorrect, + certificateExpired, + certificateContainsErrors, + certificateRevoked, + certificateIsInvalid, + serverUnreachable, + timeout, + errorHttpInvalidServerResponse, + connectionAborted, + connectionReset, + disconnected, + httpToHttpsOnRedirection, + httpsToHttpOnRedirection, + cannotConnect, + hostNameNotResolved, + operationCanceled, + redirectFailed, + unexpectedStatusCode, + unexpectedRedirection, + unexpectedClientError, + unexpectedServerError, + multipleChoices, + movedPermanently, + found, + seeOther, + notModified, + useProxy, + temporaryRedirect, + badRequest, + unauthorized, + paymentRequired, + forbidden, + notFound, + methodNotAllowed, + notAcceptable, + proxyAuthenticationRequired, + requestTimeout, + conflict, + gone, + lengthRequired, + preconditionFailed, + requestEntityTooLarge, + requestUriTooLong, + unsupportedMediaType, + requestedRangeNotSatisfiable, + expectationFailed, + internalServerError, + notImplemented, + badGateway, + serviceUnavailable, + gatewayTimeout, + httpVersionNotSupported, + } + export interface IWebErrorStatics { + getStatus(hresult: number): Windows.Web.WebErrorStatus; + } + export class WebError { + static getStatus(hresult: number): Windows.Web.WebErrorStatus; + } + } +} +declare module Windows { + export module Web { + export module Syndication { + export interface RetrievalProgress { + bytesRetrieved: number; + totalBytesToRetrieve: number; + } + export interface TransferProgress { + bytesSent: number; + totalBytesToSend: number; + bytesRetrieved: number; + totalBytesToRetrieve: number; + } + export enum SyndicationFormat { + atom10, + rss20, + rss10, + rss092, + rss091, + atom03, + } + export enum SyndicationErrorStatus { + unknown, + missingRequiredElement, + missingRequiredAttribute, + invalidXml, + unexpectedContent, + unsupportedFormat, + } + export interface ISyndicationAttribute { + name: string; + namespace: string; + value: string; + } + export class SyndicationAttribute implements Windows.Web.Syndication.ISyndicationAttribute { + constructor(attributeName: string, attributeNamespace: string, attributeValue: string); + constructor(); + name: string; + namespace: string; + value: string; + } + export interface ISyndicationAttributeFactory { + createSyndicationAttribute(attributeName: string, attributeNamespace: string, attributeValue: string): Windows.Web.Syndication.SyndicationAttribute; + } + export interface ISyndicationNode { + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export class SyndicationNode implements Windows.Web.Syndication.ISyndicationNode { + constructor(nodeName: string, nodeNamespace: string, nodeValue: string); + constructor(); + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export interface ISyndicationNodeFactory { + createSyndicationNode(nodeName: string, nodeNamespace: string, nodeValue: string): Windows.Web.Syndication.SyndicationNode; + } + export interface ISyndicationGenerator { + text: string; + uri: Windows.Foundation.Uri; + version: string; + } + export class SyndicationGenerator implements Windows.Web.Syndication.ISyndicationGenerator, Windows.Web.Syndication.ISyndicationNode { + constructor(text: string); + constructor(); + text: string; + uri: Windows.Foundation.Uri; + version: string; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export interface ISyndicationGeneratorFactory { + createSyndicationGenerator(text: string): Windows.Web.Syndication.SyndicationGenerator; + } + export interface ISyndicationText extends Windows.Web.Syndication.ISyndicationNode { + text: string; + type: string; + xml: Windows.Data.Xml.Dom.XmlDocument; + } + export class SyndicationText implements Windows.Web.Syndication.ISyndicationText, Windows.Web.Syndication.ISyndicationNode { + constructor(text: string); + constructor(text: string, type: Windows.Web.Syndication.SyndicationTextType); + constructor(); + text: string; + type: string; + xml: Windows.Data.Xml.Dom.XmlDocument; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export enum SyndicationTextType { + text, + html, + xhtml, + } + export interface ISyndicationTextFactory { + createSyndicationText(text: string): Windows.Web.Syndication.SyndicationText; + createSyndicationText(text: string, type: Windows.Web.Syndication.SyndicationTextType): Windows.Web.Syndication.SyndicationText; + } + export interface ISyndicationContent extends Windows.Web.Syndication.ISyndicationText, Windows.Web.Syndication.ISyndicationNode { + sourceUri: Windows.Foundation.Uri; + } + export class SyndicationContent implements Windows.Web.Syndication.ISyndicationText, Windows.Web.Syndication.ISyndicationNode, Windows.Web.Syndication.ISyndicationContent { + constructor(text: string, type: Windows.Web.Syndication.SyndicationTextType); + constructor(sourceUri: Windows.Foundation.Uri); + constructor(); + text: string; + type: string; + xml: Windows.Data.Xml.Dom.XmlDocument; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + sourceUri: Windows.Foundation.Uri; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export interface ISyndicationContentFactory { + createSyndicationContent(text: string, type: Windows.Web.Syndication.SyndicationTextType): Windows.Web.Syndication.SyndicationContent; + createSyndicationContent(sourceUri: Windows.Foundation.Uri): Windows.Web.Syndication.SyndicationContent; + } + export interface ISyndicationLink extends Windows.Web.Syndication.ISyndicationNode { + length: number; + mediaType: string; + relationship: string; + resourceLanguage: string; + title: string; + uri: Windows.Foundation.Uri; + } + export class SyndicationLink implements Windows.Web.Syndication.ISyndicationLink, Windows.Web.Syndication.ISyndicationNode { + constructor(uri: Windows.Foundation.Uri); + constructor(uri: Windows.Foundation.Uri, relationship: string, title: string, mediaType: string, length: number); + constructor(); + length: number; + mediaType: string; + relationship: string; + resourceLanguage: string; + title: string; + uri: Windows.Foundation.Uri; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export interface ISyndicationLinkFactory { + createSyndicationLink(uri: Windows.Foundation.Uri): Windows.Web.Syndication.SyndicationLink; + createSyndicationLink(uri: Windows.Foundation.Uri, relationship: string, title: string, mediaType: string, length: number): Windows.Web.Syndication.SyndicationLink; + } + export interface ISyndicationPerson extends Windows.Web.Syndication.ISyndicationNode { + email: string; + name: string; + uri: Windows.Foundation.Uri; + } + export class SyndicationPerson implements Windows.Web.Syndication.ISyndicationPerson, Windows.Web.Syndication.ISyndicationNode { + constructor(name: string); + constructor(name: string, email: string, uri: Windows.Foundation.Uri); + constructor(); + email: string; + name: string; + uri: Windows.Foundation.Uri; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export interface ISyndicationPersonFactory { + createSyndicationPerson(name: string): Windows.Web.Syndication.SyndicationPerson; + createSyndicationPerson(name: string, email: string, uri: Windows.Foundation.Uri): Windows.Web.Syndication.SyndicationPerson; + } + export interface ISyndicationCategory extends Windows.Web.Syndication.ISyndicationNode { + label: string; + scheme: string; + term: string; + } + export class SyndicationCategory implements Windows.Web.Syndication.ISyndicationCategory, Windows.Web.Syndication.ISyndicationNode { + constructor(term: string); + constructor(term: string, scheme: string, label: string); + constructor(); + label: string; + scheme: string; + term: string; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export interface ISyndicationCategoryFactory { + createSyndicationCategory(term: string): Windows.Web.Syndication.SyndicationCategory; + createSyndicationCategory(term: string, scheme: string, label: string): Windows.Web.Syndication.SyndicationCategory; + } + export interface ISyndicationItem extends Windows.Web.Syndication.ISyndicationNode { + authors: Windows.Foundation.Collections.IVector; + categories: Windows.Foundation.Collections.IVector; + commentsUri: Windows.Foundation.Uri; + content: Windows.Web.Syndication.SyndicationContent; + contributors: Windows.Foundation.Collections.IVector; + eTag: string; + editMediaUri: Windows.Foundation.Uri; + editUri: Windows.Foundation.Uri; + id: string; + itemUri: Windows.Foundation.Uri; + lastUpdatedTime: Date; + links: Windows.Foundation.Collections.IVector; + publishedDate: Date; + rights: Windows.Web.Syndication.ISyndicationText; + source: Windows.Web.Syndication.SyndicationFeed; + summary: Windows.Web.Syndication.ISyndicationText; + title: Windows.Web.Syndication.ISyndicationText; + load(item: string): void; + loadFromXml(itemDocument: Windows.Data.Xml.Dom.XmlDocument): void; + } + export class SyndicationFeed implements Windows.Web.Syndication.ISyndicationFeed, Windows.Web.Syndication.ISyndicationNode { + constructor(title: string, subtitle: string, uri: Windows.Foundation.Uri); + constructor(); + authors: Windows.Foundation.Collections.IVector; + categories: Windows.Foundation.Collections.IVector; + contributors: Windows.Foundation.Collections.IVector; + firstUri: Windows.Foundation.Uri; + generator: Windows.Web.Syndication.SyndicationGenerator; + iconUri: Windows.Foundation.Uri; + id: string; + imageUri: Windows.Foundation.Uri; + items: Windows.Foundation.Collections.IVector; + lastUpdatedTime: Date; + lastUri: Windows.Foundation.Uri; + links: Windows.Foundation.Collections.IVector; + nextUri: Windows.Foundation.Uri; + previousUri: Windows.Foundation.Uri; + rights: Windows.Web.Syndication.ISyndicationText; + sourceFormat: Windows.Web.Syndication.SyndicationFormat; + subtitle: Windows.Web.Syndication.ISyndicationText; + title: Windows.Web.Syndication.ISyndicationText; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + load(feed: string): void; + loadFromXml(feedDocument: Windows.Data.Xml.Dom.XmlDocument): void; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export class SyndicationItem implements Windows.Web.Syndication.ISyndicationItem, Windows.Web.Syndication.ISyndicationNode { + constructor(title: string, content: Windows.Web.Syndication.SyndicationContent, uri: Windows.Foundation.Uri); + constructor(); + authors: Windows.Foundation.Collections.IVector; + categories: Windows.Foundation.Collections.IVector; + commentsUri: Windows.Foundation.Uri; + content: Windows.Web.Syndication.SyndicationContent; + contributors: Windows.Foundation.Collections.IVector; + eTag: string; + editMediaUri: Windows.Foundation.Uri; + editUri: Windows.Foundation.Uri; + id: string; + itemUri: Windows.Foundation.Uri; + lastUpdatedTime: Date; + links: Windows.Foundation.Collections.IVector; + publishedDate: Date; + rights: Windows.Web.Syndication.ISyndicationText; + source: Windows.Web.Syndication.SyndicationFeed; + summary: Windows.Web.Syndication.ISyndicationText; + title: Windows.Web.Syndication.ISyndicationText; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + load(item: string): void; + loadFromXml(itemDocument: Windows.Data.Xml.Dom.XmlDocument): void; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export interface ISyndicationItemFactory { + createSyndicationItem(title: string, content: Windows.Web.Syndication.SyndicationContent, uri: Windows.Foundation.Uri): Windows.Web.Syndication.SyndicationItem; + } + export interface ISyndicationFeed extends Windows.Web.Syndication.ISyndicationNode { + authors: Windows.Foundation.Collections.IVector; + categories: Windows.Foundation.Collections.IVector; + contributors: Windows.Foundation.Collections.IVector; + firstUri: Windows.Foundation.Uri; + generator: Windows.Web.Syndication.SyndicationGenerator; + iconUri: Windows.Foundation.Uri; + id: string; + imageUri: Windows.Foundation.Uri; + items: Windows.Foundation.Collections.IVector; + lastUpdatedTime: Date; + lastUri: Windows.Foundation.Uri; + links: Windows.Foundation.Collections.IVector; + nextUri: Windows.Foundation.Uri; + previousUri: Windows.Foundation.Uri; + rights: Windows.Web.Syndication.ISyndicationText; + sourceFormat: Windows.Web.Syndication.SyndicationFormat; + subtitle: Windows.Web.Syndication.ISyndicationText; + title: Windows.Web.Syndication.ISyndicationText; + load(feed: string): void; + loadFromXml(feedDocument: Windows.Data.Xml.Dom.XmlDocument): void; + } + export interface ISyndicationFeedFactory { + createSyndicationFeed(title: string, subtitle: string, uri: Windows.Foundation.Uri): Windows.Web.Syndication.SyndicationFeed; + } + export interface ISyndicationClient { + bypassCacheOnRetrieve: boolean; + maxResponseBufferSize: number; + proxyCredential: Windows.Security.Credentials.PasswordCredential; + serverCredential: Windows.Security.Credentials.PasswordCredential; + timeout: number; + setRequestHeader(name: string, value: string): void; + retrieveFeedAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperationWithProgress; + } + export class SyndicationClient implements Windows.Web.Syndication.ISyndicationClient { + constructor(serverCredential: Windows.Security.Credentials.PasswordCredential); + constructor(); + bypassCacheOnRetrieve: boolean; + maxResponseBufferSize: number; + proxyCredential: Windows.Security.Credentials.PasswordCredential; + serverCredential: Windows.Security.Credentials.PasswordCredential; + timeout: number; + setRequestHeader(name: string, value: string): void; + retrieveFeedAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperationWithProgress; + } + export interface ISyndicationClientFactory { + createSyndicationClient(serverCredential: Windows.Security.Credentials.PasswordCredential): Windows.Web.Syndication.SyndicationClient; + } + export interface ISyndicationErrorStatics { + getStatus(hresult: number): Windows.Web.Syndication.SyndicationErrorStatus; + } + export class SyndicationError { + static getStatus(hresult: number): Windows.Web.Syndication.SyndicationErrorStatus; + } + } + } +} +declare module Windows { + export module Web { + export module AtomPub { + export interface IResourceCollection extends Windows.Web.Syndication.ISyndicationNode { + accepts: Windows.Foundation.Collections.IVectorView; + categories: Windows.Foundation.Collections.IVectorView; + title: Windows.Web.Syndication.ISyndicationText; + uri: Windows.Foundation.Uri; + } + export class ResourceCollection implements Windows.Web.AtomPub.IResourceCollection, Windows.Web.Syndication.ISyndicationNode { + accepts: Windows.Foundation.Collections.IVectorView; + categories: Windows.Foundation.Collections.IVectorView; + title: Windows.Web.Syndication.ISyndicationText; + uri: Windows.Foundation.Uri; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export interface IWorkspace extends Windows.Web.Syndication.ISyndicationNode { + collections: Windows.Foundation.Collections.IVectorView; + title: Windows.Web.Syndication.ISyndicationText; + } + export class Workspace implements Windows.Web.AtomPub.IWorkspace, Windows.Web.Syndication.ISyndicationNode { + collections: Windows.Foundation.Collections.IVectorView; + title: Windows.Web.Syndication.ISyndicationText; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export interface IServiceDocument extends Windows.Web.Syndication.ISyndicationNode { + workspaces: Windows.Foundation.Collections.IVectorView; + } + export class ServiceDocument implements Windows.Web.AtomPub.IServiceDocument, Windows.Web.Syndication.ISyndicationNode { + workspaces: Windows.Foundation.Collections.IVectorView; + attributeExtensions: Windows.Foundation.Collections.IVector; + baseUri: Windows.Foundation.Uri; + elementExtensions: Windows.Foundation.Collections.IVector; + language: string; + nodeName: string; + nodeNamespace: string; + nodeValue: string; + getXmlDocument(format: Windows.Web.Syndication.SyndicationFormat): Windows.Data.Xml.Dom.XmlDocument; + } + export interface IAtomPubClient extends Windows.Web.Syndication.ISyndicationClient { + retrieveServiceDocumentAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperationWithProgress; + retrieveMediaResourceAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperationWithProgress; + retrieveResourceAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperationWithProgress; + createResourceAsync(uri: Windows.Foundation.Uri, description: string, item: Windows.Web.Syndication.SyndicationItem): Windows.Foundation.IAsyncOperationWithProgress; + createMediaResourceAsync(uri: Windows.Foundation.Uri, mediaType: string, description: string, mediaStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncOperationWithProgress; + updateMediaResourceAsync(uri: Windows.Foundation.Uri, mediaType: string, mediaStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncActionWithProgress; + updateResourceAsync(uri: Windows.Foundation.Uri, item: Windows.Web.Syndication.SyndicationItem): Windows.Foundation.IAsyncActionWithProgress; + updateResourceItemAsync(item: Windows.Web.Syndication.SyndicationItem): Windows.Foundation.IAsyncActionWithProgress; + deleteResourceAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncActionWithProgress; + deleteResourceItemAsync(item: Windows.Web.Syndication.SyndicationItem): Windows.Foundation.IAsyncActionWithProgress; + cancelAsyncOperations(): void; + } + export class AtomPubClient implements Windows.Web.AtomPub.IAtomPubClient, Windows.Web.Syndication.ISyndicationClient { + constructor(serverCredential: Windows.Security.Credentials.PasswordCredential); + constructor(); + bypassCacheOnRetrieve: boolean; + maxResponseBufferSize: number; + proxyCredential: Windows.Security.Credentials.PasswordCredential; + serverCredential: Windows.Security.Credentials.PasswordCredential; + timeout: number; + retrieveServiceDocumentAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperationWithProgress; + retrieveMediaResourceAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperationWithProgress; + retrieveResourceAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperationWithProgress; + createResourceAsync(uri: Windows.Foundation.Uri, description: string, item: Windows.Web.Syndication.SyndicationItem): Windows.Foundation.IAsyncOperationWithProgress; + createMediaResourceAsync(uri: Windows.Foundation.Uri, mediaType: string, description: string, mediaStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncOperationWithProgress; + updateMediaResourceAsync(uri: Windows.Foundation.Uri, mediaType: string, mediaStream: Windows.Storage.Streams.IInputStream): Windows.Foundation.IAsyncActionWithProgress; + updateResourceAsync(uri: Windows.Foundation.Uri, item: Windows.Web.Syndication.SyndicationItem): Windows.Foundation.IAsyncActionWithProgress; + updateResourceItemAsync(item: Windows.Web.Syndication.SyndicationItem): Windows.Foundation.IAsyncActionWithProgress; + deleteResourceAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncActionWithProgress; + deleteResourceItemAsync(item: Windows.Web.Syndication.SyndicationItem): Windows.Foundation.IAsyncActionWithProgress; + cancelAsyncOperations(): void; + setRequestHeader(name: string, value: string): void; + retrieveFeedAsync(uri: Windows.Foundation.Uri): Windows.Foundation.IAsyncOperationWithProgress; + } + export interface IAtomPubClientFactory { + createAtomPubClientWithCredentials(serverCredential: Windows.Security.Credentials.PasswordCredential): Windows.Web.AtomPub.AtomPubClient; + } + } + } +} +declare module Windows.Foundation { + export interface IPromise { + then(success?: (value: T) => IPromise, error?: (error: any) => IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: T) => IPromise, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: T) => U, error?: (error: any) => IPromise, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + then(success?: (value: T) => U, error?: (error: any) => U, progress?: (progress: any) => void ): Windows.Foundation.IPromise; + done?(success?: (value: T) => any, error?: (error: any) => any, progress?: (progress: any) => void ): void; + } +} From e21cc1db029042242640ac428035f7ff865c66a9 Mon Sep 17 00:00:00 2001 From: Simon Sarris Date: Wed, 28 Aug 2013 14:18:43 -0400 Subject: [PATCH 372/756] updated GoJS definitions for 1.2 and various fixes --- goJS/goJS.d.ts | 4514 +++++++++++++++++++++++++----------------------- 1 file changed, 2331 insertions(+), 2183 deletions(-) diff --git a/goJS/goJS.d.ts b/goJS/goJS.d.ts index 532bd90feb..3ef2fbd149 100644 --- a/goJS/goJS.d.ts +++ b/goJS/goJS.d.ts @@ -1,9 +1,1837 @@ // Type definitions for GoJS 1.2 // Project: http://gojs.net/beta/api/index.html -// Definitions by: Barbara Duckworth +// Definitions by: Barbara Duckworth and Simon Sarris Barbara Duckworth // Definitions: https://github.com/borisyankov/DefinitelyTyped +/* +* Copyright 1998-2013 by Northwoods Software Corporation. +*/ + declare module go { + /** + * An adornment is a special kind of Part that is associated with another Part, + * the Adornment#adornedPart. + * Adornments are normally associated with a particular GraphObject in the adorned part -- + * that is the value of #adornedObject. + * However, the #adornedObject may be null, in which case the #adornedPart will also be null. + */ + class Adornment extends Part { + /* @param {EnumValue= } type if not supplied, the default Panel type is Panel#Position.*/ + constructor(type?: EnumValue); + /**Gets or sets the GraphObject that is adorned.*/ + adornedObject: GraphObject; + /**Gets the Part that contains the adorned object.*/ + adornedPart: Part; + /**Gets a Placeholder that this Adornment may contain in its visual tree.*/ + placeholder: Placeholder; + } + + /** + * The Diagram#commandHandler implements various + * commands such as CommandHandler#deleteSelection or CommandHandler#redo. + * The CommandHandler includes keyboard event handling to interpret + * key presses as commands. + */ + class CommandHandler { + /**The constructor produces a CommandHandler with the default key bindings.*/ + constructor(); + /**Gets or sets a data object that is copied by #groupSelection when creating a new Group.*/ + archetypeGroupData: Object; + /**Gets or sets whether #copySelection should also copy subtrees.*/ + copiesTree: boolean; + /**Gets or sets whether #deleteSelection should also delete subtrees.*/ + deletesTree: boolean; + /**Gets the Diagram that is using this CommandHandler.*/ + diagram: Diagram; + /**Gets or sets the predicate that determines whether or not a node may become a member of a group.*/ + memberValidation: (g: Group, p: Part) => boolean; + /**Gets or sets the amount by which #decreaseZoom and #increaseZoom change the Diagram#scale.*/ + zoomFactor: number; + /**Make sure all of the unnested Parts in the given collection are removed from any containing Groups. + * @param {Iterable} coll a collection of Parts. + * @param {boolean=} check whether to call #isValidMember to confirm that changing the Part to be a top-level Part is valid. + */ + addTopLevelParts(coll: Iterable, check?: boolean): boolean; + /**This predicate controls whether the user can collapse any selected expanded Groups. + * @param {Group=} group if supplied, ignore the selection and consider collapsing this particular Group. + */ + canCollapseSubGraph(group?: Group): boolean; + /**This predicate controls whether the user can collapse any selected expanded subtrees of Nodes. + * @param {Node=} node if supplied, ignore the selection and consider collapsing this particular Node. + */ + canCollapseTree(node?: Node): boolean; + /**This predicate controls whether or not the user can invoke the #copySelection command.*/ + canCopySelection(): boolean; + /**This predicate controls whether or not the user can invoke the #cutSelection command.*/ + canCutSelection(): boolean; + /**This predicate controls whether or not the user can invoke the #decreaseZoom command. + * @param {number=} factor This defaults to 5%, #zoomFactor. The value should be less than one. + */ + canDecreaseZoom(factor?: number): boolean; + /**This predicate controls whether or not the user can invoke the #deleteSelection command.*/ + canDeleteSelection(): boolean; + /**This predicate controls whether or not the user can invoke the #editTextBlock command. + * @param {TextBlock=} textblock the TextBlock to consider editing.*/ + canEditTextBlock(textblock?: TextBlock): boolean; + /**This predicate controls whether the user can expand any selected collapsed Groups. + * @param {Group=} group if supplied, ignore the selection and consider expanding this particular Group. + */ + canExpandSubGraph(group?: Group): boolean; + /**This predicate controls whether the user can expand any selected collapsed subtrees of Nodes. + * @param {Node=} node if supplied, ignore the selection and consider expanding this particular Node. + */ + canExpandTree(node?: Node): boolean; + /**This predicate controls whether or not the user can invoke the #groupSelection command.*/ + canGroupSelection(): boolean; + /**This predicate controls whether or not the user can invoke the #increaseZoom command. + * @param {number=} factor This defaults to 5%, #zoomFactor. The value should be greater than one. + */ + canIncreaseZoom(factor?: number): boolean; + /**This predicate controls whether or not the user can invoke the #pasteSelection command.*/ + canPasteSelection(): boolean; + /**This predicate controls whether or not the user can invoke the #redo command.*/ + canRedo(): boolean; + /**This predicate controls whether or not the user can invoke the #resetZoom command. + * @param {number=} newscale This defaults to 1. The value should be greater than zero. + */ + canResetZoom(newscale?: number): boolean; + /**This predicate controls whether or not the user can invoke the #selectAll command.*/ + canSelectAll(): boolean; + /**This predicate controls whether the user may stop the current tool.*/ + canStopCommand(): boolean; + /**This predicate controls whether or not the user can invoke the #undo command.*/ + canUndo(): boolean; + /**This predicate controls whether or not the user can invoke the #ungroupSelection command. + * @param {Group=} group if supplied, ignore the selection and consider ungrouping this particular Group. + */ + canUngroupSelection(group?: Group): boolean; + /**This predicate controls whether or not the user can invoke the #zoomToFit command.*/ + canZoomToFit(): boolean; + /**Collapse all expanded selected Groups. + * @param {Group=} group if supplied, ignore the selection and collapse this particular Group. + */ + collapseSubGraph(group?: Group); + /**Collapse all expanded selected Nodes. + * @param {Node=} node if supplied, ignore the selection and collapse this particular Node subtree.*/ + collapseTree(node?: Node); + /**Copy the currently selected parts, Diagram#selection, from the Diagram into the clipboard.*/ + copySelection(); + /**This makes a copy of the given collection of Parts and stores it in a static variable acting as the clipboard. + * @param {Iterable} coll A collection of Parts.*/ + copyToClipboard(coll: Iterable); + /**Execute a #copySelection followed by a #deleteSelection.*/ + cutSelection(); + /**Decrease the Diagram#scale by a given factor. + * @param {number=} factor This defaults to #zoomFactor. The value should be less than one.*/ + decreaseZoom(factor?: number); + /**Delete the currently selected parts from the diagram.*/ + deleteSelection(); + /**This is called by tools to handle keyboard commands.*/ + doKeyDown(); + /**This is called by tools to handle keyboard commands.*/ + doKeyUp(); + /**Start in-place editing of a TextBlock in the selected Part. + * @param {TextBlock=} textblock the TextBlock to start editing.*/ + editTextBlock(textblock?: TextBlock); + /**Expand all collapsed selected Groups. + * @param {Group=} group if supplied, ignore the selection and expand this particular Group.*/ + expandSubGraph(group?: Group); + /**Expand all collapsed selected Nodes. + * @param {Node=} node if supplied, ignore the selection and collapse this particular Node subtree.*/ + expandTree(node?: Node); + /**Add a copy of #archetypeGroupData and add it to the diagram's model to create a new Group and then add the selected Parts to that new group.*/ + groupSelection(); + /**Increase the Diagram#scale by a given factor.*/ + increaseZoom(factor?: Number); + /**This predicate is called to determine whether a Node may be added as a member of a Group. + * @param {Group} group this may be null if the node is being added as a top-level node. + * @param {Part} part a Part, usually a Node, possibly another Group, but not a Link or an Adornment.*/ + isValidMember(group: Group, part: Part): boolean; + /**If the clipboard holds a collection of Parts, and if the Model#dataFormat matches that stored in the clipboard, this makes a copy of the clipboard's parts and adds the copies to this Diagram.*/ + pasteFromClipboard(): Iterable; + /**Copy the contents of the clipboard into this diagram, and make those new parts the new selection. + * @param {Point=} pos Point at which to center the newly pasted parts; if not present the parts are not moved. + */ + pasteSelection(pos?: Point); + /**Call UndoManager#redo.*/ + redo(); + /**Set the Diagram#scale to a new scale value, by default 1. + * @param {number=} newscale This defaults to 1. The value should be greater than zero.*/ + resetZoom(newscale?: number); + /**Select all of the selectable Parts in the diagram.*/ + selectAll(); + /**Cancel the operation of the current tool.*/ + stopCommand(); + /**Call UndoManager#undo.*/ + undo(); + /**Remove the group from the diagram without removing its members from the diagram. + * @param {Group=} group if supplied, ignore the selection and consider ungrouping this particular Group.*/ + ungroupSelection(group?: Group); + /**Change the Diagram#scale so that the Diagram#documentBounds fits within the viewport.*/ + zoomToFit(); + } + + /** + * A Diagram is associated with an HTML div element. Constructing a Diagram creates + * an HTML Canvas element which it places inside of the given div element, in addition to several helper divs. + * GoJS will manage the contents of this div, and the contents should not be modified otherwise, + * though the given div may be styled (background, border, etc) and positioned as needed. + */ + class Diagram { + /** Construct an empty Diagram for a particular DIV HTML element. + * @param {HTMLDivElement|string=} div A reference to a div or its ID as a string. + * If no div is supplied one will be created in memory. The Diagram's Diagram#div property + * can then be set later on.*/ + constructor(div: HTMLDivElement); + constructor(div?: string); + /**Gets or sets whether the user may copy to or paste parts from the internal clipboard.*/ + allowClipboard: boolean; + /**Gets or sets whether the user may copy objects.*/ + allowCopy: boolean; + /**Gets or sets whether the user may delete objects from the Diagram.*/ + allowDelete: boolean; + /**Gets or sets whether the user may start a drag-and-drop in this Diagram, possibly dropping in a different element.*/ + allowDragOut: boolean; + /**Gets or sets whether the user may end a drag-and-drop operation in this Diagram.*/ + allowDrop: boolean; + /**Gets or sets whether the user may group parts together.*/ + allowGroup: boolean; + /**Gets or sets whether the user is allowed to use the horizontal scrollbar.*/ + allowHorizontalScroll: boolean; + /**Gets or sets whether the user may add parts to the Diagram.*/ + allowInsert: boolean; + /**Gets or sets whether the user may draw new links.*/ + allowLink: boolean; + /**Gets or sets whether the user may move objects.*/ + allowMove: boolean; + /**Gets or sets whether the user may reconnect existing links.*/ + allowRelink: boolean; + /**Gets or sets whether the user may reshape parts.*/ + allowReshape: boolean; + /**Gets or sets whether the user may resize parts.*/ + allowResize: boolean; + /**Gets or sets whether the user may rotate parts.*/ + allowRotate: boolean; + /**Gets or sets whether the user may select objects.*/ + allowSelect: boolean; + /**Gets or sets whether the user may do in-place text editing.*/ + allowTextEdit: boolean; + /**Gets or sets whether the user may undo or redo any changes.*/ + allowUndo: boolean; + /**Gets or sets whether the user may ungroup existing groups.*/ + allowUngroup: boolean; + /**Gets or sets whether the user is allowed to use the vertical scrollbar.*/ + allowVerticalScroll: boolean; + /**Gets or sets whether the user may zoom into or out of the Diagram.*/ + allowZoom: boolean; + /**Gets or sets the autoScale of the Diagram, controlling whether or not the Diagram's bounds automatically scale to fit the view.*/ + autoScale: EnumValue; + /**Gets or sets the Margin (or number for a uniform Margin) that describes the Diagram's autoScrollRegion.*/ + autoScrollRegion: any; + /**Gets or sets the function to execute when the user single-primary-clicks on the background of the Diagram.*/ + click: (e: InputEvent) => void; + /**Gets or sets the CommandHandler for this Diagram.*/ + commandHandler: CommandHandler; + /**Gets or sets the content alignment Spot of this Diagram, to be used in determining how parts are positioned when the #viewportBounds width or height is smaller than the #documentBounds.*/ + contentAlignment: Spot; + /**Gets or sets the function to execute when the user single-secondary-clicks on the background of the Diagram.*/ + contextClick: (e: InputEvent) => void; + /**This Adornment is shown when the use context clicks in the background.*/ + contextMenu: Adornment; + /**Gets or sets the current cursor for the Diagram, overriding the #defaultCursor.*/ + currentCursor: string; + /**Gets or sets the current tool for this Diagram that handles all input events.*/ + currentTool: Tool; + /**Gets or sets the cursor to be used for the Diagram when no GraphObject specifies a different cursor.*/ + defaultCursor: string; + /**Gets or sets the default tool for this Diagram that becomes the current tool when the current tool stops.*/ + defaultTool: Tool; + /**Gets or sets the Diagram's HTMLDivElement, via an HTML Element ID.*/ + div: HTMLDivElement; + /**Gets the model-coordinate bounds of the Diagram.*/ + documentBounds: Rect; + /**Gets or sets the function to execute when the user double-primary-clicks on the background of the Diagram.*/ + doubleClick: (e: InputEvent) => void; + /**Gets or sets the most recent mouse-down InputEvent that occurred.*/ + firstInput: InputEvent; + /**Gets or sets a fixed bounding rectangle to be returned by #documentBounds and #computeBounds.*/ + fixedBounds: Rect; + /**Gets or sets a Panel of type Panel#Grid acting as the background grid extending across the whole viewport of this diagram.*/ + grid: Panel; + /**Gets or sets the default selection Adornment template, used to adorn selected Groups.*/ + groupSelectionAdornmentTemplate: Adornment; + /**Gets or sets the default Group template used as the archetype for group data that is added to the #model.*/ + groupTemplate: Group; + /**Gets or sets a Map mapping template names to Groups.*/ + groupTemplateMap: Map; + /**Gets or sets whether the Diagram has a horizontal Scrollbar.*/ + hasHorizontalScrollbar: boolean; + /**Gets or sets whether the Diagram has a vertical Scrollbar.*/ + hasVerticalScrollbar: boolean; + /**Gets or sets the initialAutoScale of the Diagram.*/ + initialAutoScale: EnumValue; + /**Gets or sets the intial content alignment Spot of this Diagram, to be used in determining how parts are positioned initially relative to the viewport.*/ + initialContentAlignment: Spot; + /**Gets or sets the spot in the document's area that should be coincident with the #initialViewportSpot of the viewport when the document is first initialized.*/ + initialDocumentSpot: Spot; + /**Gets or sets the initial coordinates of this Diagram in the viewport, eventually setting the #position.*/ + initialPosition: Point; + /**Gets or sets the initial scale of this Diagram in the viewport, eventually setting the #scale.*/ + initialScale: number; + /**Gets or sets the spot in the viewport that should be coincident with the #initialDocumentSpot of the document when the document is first initialized.*/ + initialViewportSpot: Spot; + /**Gets or sets whether the user may interact with the Diagram.*/ + isEnabled: boolean; + /**Gets or sets whether the Diagram's Diagram#model is Model#isReadOnly.*/ + isModelReadOnly: boolean; + /**Gets or sets whether this Diagram's state has been modified.*/ + isModified: boolean; + /**Gets or sets whether mouse events initiated within the Diagram will be captured.*/ + isMouseCaptured: boolean; + /**Gets or sets whether the Diagram may be modified by the user, while still allowing the user to scroll, zoom, and select.*/ + isReadOnly: boolean; + /**Gets or sets whether the Diagram tree structure is defined by links going from the parent node to their children, or vice-versa.*/ + isTreePathToChildren: boolean; + /**Gets or sets the last InputEvent that occurred.*/ + lastInput: InputEvent; + /**Gets an iterator for this Diagram's Layers.*/ + layers: Iterator; + /**Gets or sets the Layout used to position all of the top-level nodes and links in this Diagram.*/ + layout: Layout; + /**Returns an iterator of all Links in the Diagram.*/ + links: Iterator; + /**Gets or sets the default selection Adornment template, used to adorn selected Links.*/ + linkSelectionAdornmentTemplate: Adornment; + /**Gets or sets the default Link template used as the archetype for link data that is added to the #model.*/ + linkTemplate: Link; + /**Gets or sets a Map mapping template names to Links.*/ + linkTemplateMap: Map; + /**Gets or sets the largest value that #scale may take.*/ + maxScale: number; + /**Gets or sets the maximum number of selected objects.*/ + maxSelectionCount: number; + /**Gets or sets the smallest value greater than zero that #scale may take.*/ + minScale: number; + /**Gets or sets the Model holding data corresponding to the data-bound nodes and links of this Diagram.*/ + model: Model; + /**Gets or sets the function to execute when the user is dragging the selection in the background of the Diagram during a DraggingTool drag-and-drop, not over any GraphObjects.*/ + mouseDragOver: (e: InputEvent) => void; + /**Gets or sets the function to execute when the user drops the selection in the background of the Diagram at the end of a DraggingTool drag-and-drop, not onto any GraphObjects.*/ + mouseDrop: (e: InputEvent) => void; + /**Gets or sets the function to execute when the user holds the mouse stationary in the background of the Diagram while holding down a button, not over any GraphObjects.*/ + mouseHold: (e: InputEvent) => void; + /**Gets or sets the function to execute when the user holds the mouse stationary in the background of the Diagram without holding down any buttons, not over any GraphObjects.*/ + mouseHover: (e: InputEvent) => void; + /**Gets or sets the function to execute when the user moves the mouse in the background of the Diagram without holding down any buttons, not over any GraphObjects.*/ + mouseOver: (e: InputEvent) => void; + /**Returns an iterator of all Nodes and Groups in the Diagram.*/ + nodes: Iterator; + /**Gets or sets the default selection Adornment template, used to adorn selected Parts other than Groups or Links.*/ + nodeSelectionAdornmentTemplate: Adornment; + /**Gets or sets the default Node template used as the archetype for node data that is added to the #model.*/ + nodeTemplate: Part; + /**Gets or sets a Map mapping template names to Parts.*/ + nodeTemplateMap: Map; + /**Gets or sets the Margin (or number for a uniform Margin) that describes the Diagram's padding, which controls how much extra space there is around the area occupied by the document.*/ + padding: any; + /**Returns an iterator of all Parts in the Diagram that are not Nodes or Links or Adornments.*/ + parts: Iterator; + /**Gets or sets the coordinates of this Diagram in the viewport.*/ + position: Point; + /**Gets or sets the scale transform of this Diagram.*/ + scale: number; + /**Gets or sets the distance in screen pixels that the horizontal scrollbar will scroll when scrolling by a line.*/ + scrollHorizontalLineChange: number; + /**Gets or sets the distance in screen pixels that the vertical scrollbar will scroll when scrolling by a line.*/ + scrollVerticalLineChange: number; + /**Gets the read-only collection of selected objects.*/ + selection: Set; + /**Gets or sets whether ChangedEvents are not recorded by the UndoManager.*/ + skipsUndoManager: boolean; + /**Gets the UndoManager for this Diagram, which actually belongs to the #model.*/ + toolManager: ToolManager; + /**This Adornment is shown when the mouse stays motionless in the background.*/ + toolTip: Adornment; + /**Gets the UndoManager for this Diagram, which actually belongs to the #model.*/ + undoManager: UndoManager; + /**Gets or sets what kinds of graphs this diagram allows the user to draw.*/ + validCycle: EnumValue; + /**Gets the bounds of the portion of the Diagram that is viewable from its HTML Canvas.*/ + viewportBounds: Rect; + /**Adds a Part to the Layer that matches the Part's Part#layerName, or else the default layer, which is named with the empty string. + * @param {Part} part*/ + add(part: Part); + /**Register an event handler that is called when there is a ChangedEvent. + * @param {function(ChangedEvent)} listener a function that takes a ChangedEvent as its argument. + */ + addChangedListener(listener: (e: ChangedEvent) => void); + /**Register an event handler that is called when there is a DiagramEvent of a given name. + * @param {string} name the name is normally capitalized, but this method uses case-insensitive comparison. + * @param {function(DiagramEvent)} listener a function that takes a DiagramEvent as its argument. + */ + addDiagramListener(name: string, listener: (e: DiagramEvent) => void); + /**Adds a Layer to the list of layers. + * @param {Layer} layer The Layer to add.*/ + addLayer(layer: Layer); + /**Adds a layer to the list of layers after a specified layer. + * @param {Layer} layer The Layer to add. + * @param {Layer} existingLayer The layer to insert after.*/ + addLayerAfter(layer: Layer, existingLayer: Layer); + /**Adds a layer to the list of layers before a specified layer. + * @param {Layer} layer The Layer to add. + * @param {Layer} existingLayer The layer to insert before.*/ + addLayerBefore(layer: Layer, existingLayer: Layer); + /**Aligns the Diagram's #position based on a desired document Spot and viewport Spot. + * @param {Spot} documentspot + * @param {Spot} viewportspot*/ + alignDocument(documentspot: Spot, viewportspot: Spot); + /**Modifies the #position to show a given Rect of the Diagram by centering the viewport on that Rect. + * @param {Rect} r*/ + centerRect(r: Rect); + /**Removes all Parts from the Diagram, including unbound Parts and the background grid, and also clears out the Model and UndoManager.*/ + clear(); + /**Deselect all selected Parts.*/ + clearSelection(); + /**Commit the changes of the current transaction. + * @param {string} tname a descriptive name for the transaction.*/ + commitTransaction(tname: string): boolean; + /**This is called during a Diagram update to determine a new value for #documentBounds.*/ + computeBounds(): Rect; + /**Find the union of the GraphObject#actualBounds of all of the Parts in the given collection. + * @param {Iterable} coll a collection of Parts.*/ + computePartsBounds(coll: Iterable): Rect; + /**Updates the diagram immediately, then resets initialization flags so that actions taken in the argument function will be considered part of Diagram initialization, and will participate in initial layouts, #initialAutoScale, #initialContentAlignment, etc. + * @param {function()|null=} func an optional function of actions to perform as part of another diagram initialization.*/ + delayInitialization(func?: () => void); + /**Finds a layer with a given name. + * @param {string} name*/ + findLayer(name: string): Layer; + /**Look for a Link corresponding to a GraphLinksModel's link data object. + * @param {Object} linkdata*/ + findLinkForData(linkdata: Object): Link; + /**Look for a Node or Group corresponding to a model's node data object. + * @param {Object} nodedata*/ + findNodeForData(nodedata: Object): Node; + /**Look for a Node or Group corresponding to a model's node data object's unique key. + * @param {*} key a string or number.*/ + findNodeForKey(key: any): Node; + /**Find the front-most GraphObject at the given point in document coordinates. + * @param {Point} p A Point in document coordinates. + * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and + * returning a GraphObject, defaulting to the identity. + * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject + * returned by navig and returning true if that object should be returned, + * defaulting to a predicate that always returns true.*/ + findObjectAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean): GraphObject; + /**Return a collection of the GraphObjects at the given point in document coordinates. + * @param {Point} p A Point in document coordinates. + * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and + * returning a GraphObject, defaulting to the identity. + * If this function returns null, the given GraphObject will not be included in the results. + * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject + * returned by navig and returning true if that object should be returned, + * defaulting to a predicate that always returns true. + * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ + findObjectsAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, coll?: List): Iterable; + findObjectsAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, coll?: Set): Iterable; + /**Returns a collection of all GraphObjects that are inside or that intersect a given Rect in document coordinates. + * @param {Rect} r A Rect in document coordinates. + * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and + * returning a GraphObject, defaulting to the identity. + * If this function returns null, the given GraphObject will not be included in the results. + * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject + * returned by navig and returning true if that object should be returned, + * defaulting to a predicate that always returns true. + * @param {boolean=} partialInclusion Whether an object can match if it merely intersects the rectangular area (true) or + * if it must be entirely inside the rectangular area (false). The default value is false. + * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ + findObjectsIn(r: Rect, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: boolean, coll?: List): Iterable; + findObjectsIn(r: Rect, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: boolean, coll?: Set): Iterable; + /**Returns a collection of all GraphObjects that are within a certain distance of a given point in document coordinates. + * @param {Point} p A Point in document coordinates. + * @param {number} dist The distance from the point. + * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and + * returning a GraphObject, defaulting to the identity. + * If this function returns null, the given GraphObject will not be included in the results. + * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject + * returned by navig and returning true if that object should be returned, + * defaulting to a predicate that always returns true. + * @param {boolean=} partialInclusion Whether an object can match if it merely intersects the circular area (true) or + * if it must be entirely inside the circular area (false). The default value is true. + * The default is true. + * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ + findObjectsNear(p: Point, dist: number, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: boolean, coll?: List): Iterable; + findObjectsNear(p: Point, dist: number, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: boolean, coll?: Set): Iterable; + /**This convenience function finds the front-most Part that is at a given point and that might be selectable. + * @param {Point} p a Point in document coordinates. + * @param {boolean} selectable Whether to only consider parts that are Part#selectable.*/ + findPartAt(p: Point, selectable: boolean): Part; + /**Look for a Part, Node, Group, or Link corresponding to a Model's data object. + * @param {Object} data*/ + findPartForData(data: Object): Part; + /**Look for a Part or Node or Group corresponding to a model's data object's unique key. + * @param {*} key a string or number.*/ + findPartForKey(key: any): Part; + /**Returns an iterator of all Groups that are at top-level, in other words that are not themselves inside other Groups.*/ + findTopLevelGroups(): Iterator; + /**Returns an iterator of all top-level Nodes that have no tree parents.*/ + findTreeRoots(): Iterator; + /**Explicitly bring focus to the Diagram's canvas.*/ + focus(); + /**This static method gets the Diagram that is attached to an HTML DIV element.*/ + static fromDiv(div: any): Diagram; + /**This static function declares that a class (constructor function) derives from another class -- but please note that most classes do not support inheritance. + * @param {Function} derivedclass + * @param {Function} baseclass*/ + static inherit(derivedclass: any, baseclass: any); + /**Perform all invalid layouts. + * @param {boolean=} invalidateAll If true, this will explicitly set Layout#isValidLayout to false on each Layout in the diagram. + */ + layoutDiagram(invalidateAll?: boolean); + /** Create an HTMLImageElement that contains a bitmap of the current Diagram.*/ + makeImage(properties?: any): HTMLImageElement; + /**Create a bitmap of the current Diagram encoded as a base64 string. + * @param {{ size: Size, + scale: number, + maxSize: Size, + position: Point, + parts: Iterable, + padding: (Margin|number), + showTemporary: boolean, + showGrid: boolean, + + type: string, + details: * + }|Object=} properties a JavaScript object detailing optional arguments for image creation, to be passed to makeImageData. + */ + makeImageData(properties?: any): string; + /**Remove all of the Parts created from model data and then create them again.*/ + rebuildParts(); + /**Removes a Part from its Layer, provided the Layer is in this Diagram. + * @param {Part} part*/ + remove(part: Part); + /**Unregister an event handler listener. + * @param {function(ChangedEvent)} listener a function that takes a ChangedEvent as its argument. + */ + removeChangedListener(listener: (e: ChangedEvent) => void); + /**Unregister a DiagramEvent handler. + * @param {string} name the name is normally capitalized, but this method uses case-insensitive comparison. + * @param {function(DiagramEvent)} listener a function that takes a DiagramEvent as its argument. + */ + removeDiagramListener(name: string, listener: (e: DiagramEvent) => void); + /**Removes the given layer from the list of layers. + * @param {Layer} layer*/ + removeLayer(layer: Layer); + /**Rollback the current transaction, undoing any recorded changes.*/ + rollbackTransaction(): boolean; + /**Scrolling function used by primarily by #commandHandler's CommandHandler#doKeyDown. + * @param {string} unit A string representing the unit of the scroll operation. Can be 'pixel', 'line', or 'page'. + * @param {string} dir The direction of the scroll operation. Can be 'up', 'down', 'left', or 'right'. + * @param {number=} dist An optional distance multiplier, for multiple pixels, lines, or pages. Default is 1. + */ + scroll(unit: string, dir: string, dist?: number); + /**Modifies the #position to show a given Rect of the Diagram by centering the viewport on that Rect. + * @param {Rect} r*/ + scrollToRect(r: Rect); + /**Make the given object the only selected object. + * @param {GraphObject} part a GraphObject that is already in a layer of this Diagram. + * If the value is null, this does nothing.*/ + select(part: Part); + /**Select all of the Parts supplied in the given collection. + * @param {Iterable} coll a List or Set of Parts to be selected.*/ + selectCollection(coll: Iterable); + /**Begin a transaction, where the changes are held by a Transaction object in the UndoManager. + * @param {string=} tname a descriptive name for the transaction.*/ + startTransaction(tname?: string): boolean; + /**Given a Point in document coorindates, return a new Point in viewport coordinates. + * @param {Point} p*/ + transformDocToView(p: Point): Point; + /**Given a point in viewport coorindates, return a new point in document coordinates. + * @param {Point} p*/ + transformViewToDoc(p: Point): Point; + /**Update all of the data-bound properties of Nodes and Links in this diagram.*/ + updateAllTargetBindings(); + /**Scales the Diagram to uniformly fit into the viewport.*/ + zoomToFit(); + /**Modifies the #scale and #position of the Diagram so that the viewport displays a given document-coordinates rectangle. + * @param {Rect} r rectangular bounds in document coordinates. + * @param {EnumValue=} scaling an optional value of either #Uniform (the default) or #UniformToFill. + */ + zoomToRect(r: Rect, scaling?: EnumValue); + /**This value for Diagram#validCycle states that there are no restrictions on making cycles of links.*/ + static CycleAll: EnumValue; + /**This value for Diagram#validCycle states that any number of destination links may go out of a node, but at most one source link may come into a node, and there are no directed cycles.*/ + static CycleDestinationTree: EnumValue; + /**This value for Diagram#validCycle states that a valid link from a node will not produce a directed cycle in the graph.*/ + static CycleNotDirected: EnumValue; + /**This value for Diagram#validCycle states that a valid link from a node will not produce an undirected cycle in the graph.*/ + static CycleNotUndirected: EnumValue; + /**This value for Diagram#validCycle states that any number of source links may come into a node, but at most one destination link may go out of a node, and there are no directed cycles.*/ + static CycleSourceTree: EnumValue; + /**The default autoScale type, used as the value of Diagram#autoScale: The Diagram does not attempt to scale its bounds to fit the view.*/ + static None: EnumValue; + /**Diagrams with this autoScale type, used as the value of Diagram#autoScale, are scaled uniformly until the documentBounds fits in the view.*/ + static Uniform: EnumValue; + /**Diagrams with this autoScale type, used as the value of Diagram#autoScale, are scaled uniformly until the documentBounds fits in the view.*/ + static UniformToFill: EnumValue; + maybeUpdate(); + } + + /** + * A DiagramEvent represents a more abstract event than an InputEvent. + * They are raised on the Diagram class. + * One can receive such events by registering a DiagramEvent listener on a Diagram + * by calling Diagram#addDiagramListener. + * Some DiagramEvents such as "ObjectSingleClicked" are normally + * associated with InputEvents. + * Some DiagramEvents such as "SelectionMoved" or "PartRotated" are associated with the + * results of Tool-handled gestures or CommandHandler actions. + * Some DiagramEvents are not necessarily associated with any input events at all, + * such as "ViewportBoundsChanged", which can happen due to programmatic + * changes to the Diagram#position and Diagram#scale properties. + */ + class DiagramEvent { + /**The DiagramEvent class constructor produces an empty DiagramEvent.*/ + constructor(); + /**Gets or sets whether any default actions associated with this diagram event should be avoided or cancelled.*/ + cancel: boolean; + /**Gets the diagram associated with the event.*/ + diagram: Diagram; + /**Gets or sets the name of the kind of diagram event that this represents.*/ + name: string; + /**Gets or sets an optional object that describes the change to the subject of the diagram event.*/ + parameter: any; + /**Gets or sets an optional object that is the subject of the diagram event.*/ + subject: Object; + } + + /** + * This is the abstract base class for all graphical objects. + */ + class GraphObject { + /**This is an abstract class, so you should not use this constructor.*/ + constructor(); + /**Gets or sets the function to execute when the ActionTool is cancelled and this GraphObject's #isActionable is set to true.*/ + actionCancel: (e: InputEvent, obj: GraphObject) => void; + /**Gets or sets the function to execute on a mouse-down event when this GraphObject's #isActionable is set to true.*/ + actionDown: (e: InputEvent, obj: GraphObject) => void; + /**Gets or sets the function to execute on a mouse-move event when this GraphObject's #isActionable is set to true.*/ + actionMove: (e: InputEvent, obj: GraphObject) => void; + /**Gets or sets the function to execute on a mouse-up event when this GraphObject's #isActionable is set to true.*/ + actionUp: (e: InputEvent, obj: GraphObject) => void; + /**Gets the bounds of this GraphObject in container coordinates.*/ + actualBounds: Rect; + /**Gets or sets the alignment Spot of this GraphObject used in Panel layouts, to determine where in the area allocated by the panel this object should be placed.*/ + alignment: Spot; + /**Gets or sets the spot on this GraphObject to be used as the alignment point in Spot and Fixed Panels.*/ + alignmentFocus: Spot; + /**Gets or sets the angle transform, in degrees, of this GraphObject.*/ + angle: number; + /**Gets or sets the areaBackground Brush (or CSS color string) of this GraphObject.*/ + areaBackground: any; + /**Gets or sets the background Brush (or CSS color string) of this GraphObject, filling the rectangle of this object's local coordinate space.*/ + background: any; + /**Gets or sets the function to execute when the user single-primary-clicks on this object.*/ + click: (e: InputEvent, obj: GraphObject) => void; + /**Gets or sets the column of this GraphObject if it is in a Table Panel.*/ + column: number; + /**Gets or sets the number of columns spanned by this GraphObject if it is in a Table Panel.*/ + columnSpan: number; + /**Gets or sets the function to execute when the user single-secondary-clicks on this object.*/ + contextClick: (e: InputEvent, obj: GraphObject) => void; + /**This Adornment is shown upon a context click on this object.*/ + contextMenu: Adornment; + /**Gets or sets the mouse cursor to use when the mouse is over this object with no mouse buttons pressed.*/ + cursor: string; + /**Gets or sets the desired size of this GraphObject in local coordinates.*/ + desiredSize: Size; + /**Gets the Diagram that this GraphObject is in, if it is.*/ + diagram: Diagram; + /**Gets or sets the function to execute when the user double-primary-clicks on this object.*/ + doubleClick: (e: InputEvent, obj: GraphObject) => void; + /**Gets or sets how the direction of the last segment of a link coming from this port is computed when the node is rotated.*/ + fromEndSegmentDirection: EnumValue; + /**Gets or sets the length of the last segment of a link coming from this port.*/ + fromEndSegmentLength: number; + /**Gets or sets whether the user may draw Links from this port.*/ + fromLinkable: any; + /**Gets or sets whether the user may draw duplicate Links from this port.*/ + fromLinkableDuplicates: boolean; + /**Gets or sets whether the user may draw Links that connect from this port's Node.*/ + fromLinkableSelfNode: boolean; + /**Gets or sets the maximum number of links that may come out of this port.*/ + fromMaxLinks: number; + /**Gets or sets how far the end segment of a link coming from this port stops short of the actual port.*/ + fromShortLength: number; + /**Gets or sets where a link should connect from this port.*/ + fromSpot: Spot; + /**Gets or sets the desired height of this GraphObject in local coordinates.*/ + height: number; + /**This property determines whether or not this GraphObject's events occur before all other events, including selection.*/ + isActionable: boolean; + /**Gets or sets whether a GraphObject is the "main" object for some types of Panel.*/ + isPanelMain: boolean; + /**Gets the GraphObject's containing Layer, if there is any.*/ + layer: Layer; + /**Gets or sets the size of empty area around this GraphObject, as a Margin (or number for a uniform Margin), in the containing Panel coordinates.*/ + margin: any; + /**Gets or sets the maximum size of this GraphObject in container coordinates (either a Panel or the document).*/ + maxSize: Size; + /**Gets the measuredBounds of the GraphObject in container coordinates (either a Panel or the document).*/ + measuredBounds: Rect; + /**Gets or sets the minimum size of this GraphObject in container coordinates (either a Panel or the document).*/ + minSize: Size; + /**Gets or sets the function to execute when the user moves the mouse into this stationary object during a DraggingTool drag.*/ + mouseDragEnter: (e: InputEvent, obj: GraphObject, prev: GraphObject) => void; + /**Gets or sets the function to execute when the user moves the mouse out of this stationary object during a DraggingTool drag.*/ + mouseDragLeave: (e: InputEvent, obj: GraphObject, prev: GraphObject) => void; + /**Gets or sets the function to execute when a user drops the selection on this object at the end of a DraggingTool drag.*/ + mouseDrop: (e: InputEvent, obj: GraphObject) => void; + /**Gets or sets the function to execute when the user moves the mouse into this object without holding down any buttons.*/ + mouseEnter: (e: InputEvent, obj: GraphObject, prev: GraphObject) => void; + /**Gets or sets the function to execute when the user holds the mouse stationary in the background of the diagram while holding down a button over this object.*/ + mouseHold: (e: InputEvent, obj: GraphObject) => void; + /**Gets or sets the function to execute when the user holds the mouse stationary in the background of the diagram without holding down any buttons over this object.*/ + mouseHover: (e: InputEvent, obj: GraphObject) => void; + /**Gets or sets the function to execute when the user moves the mouse into this object without holding down any buttons.*/ + mouseLeave: (e: InputEvent, obj: GraphObject, prev: GraphObject) => void; + /**Gets or sets the function to execute when the user moves the mouse over this object without holding down any buttons.*/ + mouseOver: (e: InputEvent, obj: GraphObject) => void; + /**Gets or sets the name for this object.*/ + name: string; + /**Gets the natural bounding rectangle of this GraphObject in local coordinates, before any transformation by #scale or #angle, and before any resizing due to #minSize or #maxSize or #stretch.*/ + naturalBounds: Rect; + /**Gets the GraphObject's containing Panel, or null if this object is not in a Panel.*/ + panel: Panel; + /**Gets the Part containing this object, if any.*/ + part: Part; + /**Gets or sets whether or not this GraphObject can be chosen by visual "find" methods such as Diagram#findObjectAt.*/ + pickable: boolean; + /**Gets or sets an identifier for an object acting as a port on a Node.*/ + portId: string; + /**Gets or sets the position of this GraphObject in container coordinates (either a Panel or the document).*/ + position: Point; + /**Gets or sets the row of this GraphObject if it is in a Table Panel.*/ + row: number; + /**Gets or sets the number of rows spanned by this GraphObject if it is in a Table Panel.*/ + rowSpan: number; + /**Gets or sets the scale transform of this GraphObject.*/ + scale: number; + /**Gets or sets the fractional distance along a segment of a GraphObject that is in a Link.*/ + segmentFraction: number; + /**Gets or sets the segment index of a GraphObject that is in a Link.*/ + segmentIndex: number; + /**Gets or sets the offset of a GraphObject that is in a Link from a point on a segment.*/ + segmentOffset: Point; + /**Gets or sets the orientation of a GraphObject that is in a Link.*/ + segmentOrientation: EnumValue; + /**Gets or sets the stretch of the GraphObject.*/ + stretch: EnumValue; + /**Gets or sets how the direction of the last segment of a link going to this port is computed when the node is rotated.*/ + toEndSegmentDirection: EnumValue; + /**Gets or sets the length of the last segment of a link going to this port.*/ + toEndSegmentLength: number; + /**Gets or sets whether the user may draw Links to this port.*/ + toLinkable: any; + /**Gets or sets whether the user may draw duplicate Links to this port.*/ + toLinkableDuplicates: boolean; + /**Gets or sets whether the user may draw Links that connect to this port's Node.*/ + toLinkableSelfNode: boolean; + /**Gets or sets the maximum number of links that may go into this port.*/ + toMaxLinks: number; + /**This Adornment is shown when the mouse hovers over this object.*/ + toolTip: Adornment; + /**Gets or sets how far the end segment of a link going to this port stops short of the actual port.*/ + toShortLength: number; + /**Gets or sets where a link should connect to this port.*/ + toSpot: Spot; + /**Gets or sets whether a GraphObject is visible.*/ + visible: boolean; + /**Gets or sets the desired width of this GraphObject in local coordinates.*/ + width: number; + /**Add a data-binding of a property on this GraphObject to a property on a data object. + * @param {Binding} binding*/ + bind(binding: Binding); + /**Creates a deep copy of this GraphObject and returns it.*/ + copy(): GraphObject; + /**Returns the effective angle that the object is drawn at, in document coordinates.*/ + getDocumentAngle(): number; + /**Returns the Point in document coordinates for a given Spot in this object's bounds. + * @param {Spot} s a real Spot describing a location relative to the GraphObject. + * @param {Point=} result an optional Point that is modified and returned.*/ + getDocumentPoint(s: Spot, result?: Point): Point; + /**Returns the total scale that the object is drawn at, in document coordinates.*/ + getDocumentScale(): number; + /**Given a Point in document coordinates, returns a new Point in local coordinates. + * @param {Point} p a Point in document coordinates. + * @param {Point=} result an optional Point that is modified and returned.*/ + getLocalPoint(p: Point, result?: Point): Point; + /**This predicate is true if this object is an element, perhaps indirectly, of the given panel. + * @param {GraphObject} panel + * or if it is contained by another panel that is contained by the given panel, + * to any depth; false if the argument is null or is not a Panel.*/ + isContainedBy(panel: Panel): boolean; + /**This predicate is true if this object is #visible and each of its visual containing panels are also visible.*/ + isVisibleObject(): boolean; + /**This static function builds an object given its class and additional arguments providing initial properties or GraphObjects that become Panel elements. + * @param {function()|string} type a class function or the name of a class in the "go" namespace, + * or one of several predefined kinds of Panels: "Button", "TreeExpanderButton", + * "SubGraphExpanderButton", or "ContextMenuButton". + * @param {...*} initializers zero or more values that initialize the new object, + * typically an Object with properties whose values that get set on the new object, + * or a GraphObject that is added to a Panel, + * or a Binding for one of the new object's properties, + * or an EnumValue as the initial value of a single property of the new object that + * is recognized to take that value, + * or a string that is used as the value of a commonly set property.*/ + static make(type: any, ...initializers: any[]): any; + /**GraphObjects with this as the value of GraphObject#stretch are stretched depending on the context they are used.*/ + static Default: EnumValue; + /**GraphObjects with this as the value of GraphObject#stretch are scaled in both directions so as to fit exactly in the given bounds; there is no clipping but the aspect ratio may change, causing the object to appear stretched.*/ + static Fill: EnumValue; + /**GraphObjects with this as the value of GraphObject#stretch are scaled as much as possible in the x-axis*/ + static Horizontal: EnumValue; + /**GraphObjects with this as the value of GraphObject#stretch are not automatically scaled to fit in the given bounds; there may be clipping in one or both directions.*/ + static None: EnumValue; + /**Pictures with this as the value of Picture#imageStretch are drawn with equal scale in both directions to fit the arranged (actual) bounds.*/ + static Uniform: EnumValue; + /**Pictures with this as the value of Picture#imageStretch are drawn with equal scale in both directions to fit the larger side of the image bounds.*/ + static UniformToFill: EnumValue; + /**GraphObjects with this as the value of GraphObject#stretch are scaled as much as possible in the y-axis*/ + static Vertical: EnumValue; + } + + /** + * This simple layout places all of the Parts in a grid-like arrangement, ordered, spaced apart, + * and wrapping as needed. It ignores any Links connecting the Nodes being laid out. + */ + class Group extends Node { + /**Constructs an empty Group with no visual elements and no member parts; normally a Group will have some visual elements surrounding a Placeholder. + * @param {EnumValue=} type if not supplied, the default Panel type is {@link Panel#Position}. + */ + constructor(type?: EnumValue); + /**Gets or sets whether the size of the area of the Group's #placeholder should remain the same during a DraggingTool move until a drop occurs.*/ + computesBoundsAfterDrag: boolean; + /**Gets or sets whether the subgraph contained by this group is expanded.*/ + isSubGraphExpanded: boolean; + /**Gets or sets the Layout used to position all of the immediate member nodes and links in this group.*/ + layout: Layout; + /**Gets or sets the function that is called after a member Part has been added to this Group.*/ + memberAdded: (a: Group, b: Part) => void; + /**Gets an iterator over the member Parts of this Group.*/ + memberParts: Iterator; + /**Gets or sets the function that is called after a member Part has been removed from this Group.*/ + memberRemoved: (a: Group, b: Part) => void; + /**Gets or sets the predicate that determines whether or not a Part may become a member of this group.*/ + memberValidation: (a: Group, b: Part) => boolean; + /**Gets a Placeholder that this group may contain in its visual tree.*/ + placeholder: Placeholder; + /**Gets or sets the function that is called when #isSubGraphExpanded has changed value.*/ + subGraphExpandedChanged: (a: Group) => void; + /**Gets or sets whether the user may ungroup this group.*/ + ungroupable: boolean; + /**Gets or sets whether the subgraph starting at this group had been collapsed by a call to #expandSubGraph on the containing Group.*/ + wasSubGraphExpanded: boolean; + /**Add the Parts in the given collection as members of this Group for those Parts for which CommandHandler#isValidMember returns true. + * @param {Iterable} coll + * @param {boolean=} check whether to call CommandHandler#isValidMember to confirm that it is valid to add the Part to be a member of this Group. + */ + addMembers(coll: Iterable, check?: boolean): boolean; + /**See if the given collection of Parts contains non-Links all for which CommandHandler#isValidMember returns true. + * @param {Iterable} coll*/ + canAddMembers(coll: Iterable): boolean; + /**This predicate returns true if #ungroupable is true, if the layer's Layer#allowUngroup is true, and if the diagram's Diagram#allowUngroup is true.*/ + canUngroup(): boolean; + /**Hide each of the member nodes and links of this group, and recursively collapse any member groups.*/ + collapseSubGraph(); + /**Show each member node and link, and perhaps recursively expand nested subgraphs.*/ + expandSubGraph(); + /**Return a collection of Parts that are all of the nodes and links that are members of this group, including inside nested groups, but excluding this group itself.*/ + findSubGraphParts(): Set; + /**Move this Group and all of its member parts, recursively. + * @param {Point} newpos a new Point in document coordinates.*/ + move(newpos: Point); + } + + /** + * An InputEvent represents a mouse or keyboard event. + * The principal properties hold information about a particular input event. + * These properties include the #documentPoint at which a mouse event + * occurred in document coordinates, + * the corresponding point in view/element coordinates, #viewPoint, + * the #key for keyboard events, + * and the #modifiers and #button at the time. + * Additional descriptive properties include #clickCount, #delta, + * #timestamp, and the source event #event (if available). + */ + class InputEvent { + /**The InputEvent class constructor produces an empty InputEvent.*/ + constructor(); + /**Gets whether the alt key is being held down.*/ + alt: boolean; + /**Gets or sets whether the underlying #event is prevented from bubbling up the hierarchy of HTML elements outside of the Diagram and whether any default action is canceled.*/ + bubbles: boolean; + /**Gets or sets the button that caused this event.*/ + button: number; + /**Gets or sets whether this event represents a click or a double-click.*/ + clickCount: number; + /**Gets whether the control key is being held down.*/ + control: boolean; + /**Gets or sets the amount of change associated with a mouse-wheel rotation.*/ + delta: number; + /**Gets the source diagram associated with the event.*/ + diagram: Diagram; + /**Gets or sets the point at which this input event occurred, in document coordinates.*/ + documentPoint: Point; + /**Gets or sets whether the InputEvent represents a mouse-down or a key-down event.*/ + down: boolean; + /**Gets or sets the platform's user-agent-supplied event for this event.*/ + event: Event; + /**Gets or sets whether an InputEvent that applies to a GraphObject and bubbles up the chain of containing Panels is stopped from continuing up the chain.*/ + handled: boolean; + /**Gets or sets the key pressed or released as this event.*/ + key: string; + /**Gets whether the logical left mouse button is being held down.*/ + left: boolean; + /**Gets whether the meta key is being held down.*/ + meta: boolean; + /**Gets whether the logical middle mouse button is being held down.*/ + middle: boolean; + /**Gets or sets the modifier keys that were used with the mouse or keyboard event.*/ + modifiers: number; + /**Gets whether the logical right mouse button is being held down.*/ + right: boolean; + /**Gets whether the shift key is being held down.*/ + shift: boolean; + /**Gets or sets the diagram associated with the canvas that the event is currently targeting.*/ + targetDiagram: Diagram; + /**Gets or sets the GraphObject that is at the current mouse point, if any.*/ + targetObject: GraphObject; + /**Gets or sets the time at which the event occurred, in milliseconds.*/ + timestamp: number; + /**Gets or sets whether the InputEvent represents a mouse-up or a key-up event.*/ + up: boolean; + /**Gets or sets the point at which this input event occurred.*/ + viewPoint: Point; + /**Make a copy of this InputEvent.*/ + copy(): InputEvent; + } + + /** + * Layers are how named collections of Part}s are drawn in front or behind other collections of Parts in a Diagram}. + * Layers can only contain Part}s -- they cannot hold GraphObject}s directly. + */ + class Layer { + /**This constructs an empty Layer; you should set the #name before adding the Layer to a Diagram.*/ + constructor(); + /**Gets or sets whether the user may copy objects in this layer.*/ + allowCopy: boolean; + /**Gets or sets whether the user may delete objects in this layer.*/ + allowDelete: boolean; + /**Gets or sets whether the user may group parts together in this layer.*/ + allowGroup: boolean; + /**Gets or sets whether the user may draw new links in this layer.*/ + allowLink: boolean; + /**Gets or sets whether the user may move objects in this layer.*/ + allowMove: boolean; + /**Gets or sets whether the user may reconnect existing links in this layer.*/ + allowRelink: boolean; + /**Gets or sets whether the user may reshape parts in this layer.*/ + allowReshape: boolean; + /**Gets or sets whether the user may resize parts in this layer.*/ + allowResize: boolean; + /**Gets or sets whether the user may rotate parts in this layer.*/ + allowRotate: boolean; + /**Gets or sets whether the user may select objects in this layer.*/ + allowSelect: boolean; + /**Gets or sets whether the user may do in-place text editing in this layer.*/ + allowTextEdit: boolean; + /**Gets or sets whether the user may ungroup existing groups in this layer.*/ + allowUngroup: boolean; + /**Gets the Diagram that is using this Layer.*/ + diagram: Diagram; + /**Gets or sets whether the objects in this layer are considered temporary.*/ + isTemporary: boolean; + /**Gets or sets the name for this layer.*/ + name: string; + /**Gets or sets the opacity for all parts in this layer.*/ + opacity: number; + /**Gets an iterator for this Layer's Parts.*/ + parts: Iterator; + /**Gets a backwards iterator for this Layer's Parts, for iterating over the parts in reverse order.*/ + partsBackwards: Iterator; + /**Gets or sets whether methods such as #findObjectAt find any of the objects in this layer.*/ + pickable: boolean; + /**Gets or sets whether the user may view any of the objects in this layer.*/ + visible: boolean; + /**Find the front-most GraphObject in this layer at the given point in document coordinates. + * @param {Point} p A Point in document coordinates. + * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and + * returning a GraphObject, defaulting to the identity. + * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject + * returned by navig and returning true if that object should be returned, + * defaulting to a predicate that always returns true.*/ + findObjectAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean): GraphObject; + /**Return a collection of the GraphObjects of this layer at the given point in document coordinates. + * @param {Point} p A Point in document coordinates. + * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and + * returning a GraphObject, defaulting to the identity. + * If this function returns null, the given GraphObject will not be included in the results. + * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject + * returned by navig and returning true if that object should be returned, + * defaulting to a predicate that always returns true. + * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ + findObjectsAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, coll?: List): Iterable; + findObjectsAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, coll?: Set): Iterable; + /**Returns a collection of all GraphObjects that are inside or that intersect a given Rect in document coordinates. + * @param {Rect} r A Rect in document coordinates. + * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and + * returning a GraphObject, defaulting to the identity. + * If this function returns null, the given GraphObject will not be included in the results. + * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject + * returned by navig and returning true if that object should be returned, + * defaulting to a predicate that always returns true. + * @param {boolean=} partialInclusion Whether an object can match if it merely intersects the rectangular area (true) or + * if it must be entirely inside the rectangular area (false). The default value is false. + * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ + findObjectsIn(r: Rect, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: boolean, coll?: List): Iterable; + findObjectsIn(r: Rect, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: boolean, coll?: Set): Iterable; + /**Returns a collection of all GraphObjects that are within a certain distance of a given point in document coordinates. + * @param {Point} p A Point in document coordinates. + * @param {number} dist The distance from the point. + * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and + * returning a GraphObject, defaulting to the identity. + * If this function returns null, the given GraphObject will not be included in the results. + * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject + * returned by navig and returning true if that object should be returned, + * defaulting to a predicate that always returns true. + * @param {boolean=} partialInclusion Whether an object can match if it merely intersects the circular area (true) or + * if it must be entirely inside the circular area (false). The default value is true. + * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ + findObjectsNear(p: Point, dist: number, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: boolean, coll?: List): Iterable; + findObjectsNear(p: Point, dist: number, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: boolean, coll?: Set): Iterable; + } + + /** + * A Link is a Part that connects Nodes. + * The link relationship is directional, going from Link#fromNode to Link#toNode. + * A link can connect to a specific port element in a node, as named by the Link#fromPortId + * and Link#toPortId properties. + */ + class Link extends Part { + /**Constructs an empty link that does not connect any nodes.*/ + constructor(); + /**Gets or sets how the route is computed, including whether it uses the points of its old route to determine the new route.*/ + adjusting: EnumValue; + /**Gets or sets how rounded the corners are for adjacent line segments when the #curve is #None #JumpGap, or #JumpOver and the two line segments are orthogonal to each other.*/ + corner: number; + /**Gets or sets the way the path is generated from the route's points.*/ + curve: EnumValue; + /**Gets or sets how far the control points are offset when the #curve is #Bezier or when there are multiple links between the same two ports.*/ + curviness: number; + /**Gets or sets how the direction of the last segment is computed when the node is rotated.*/ + fromEndSegmentDirection: EnumValue; + /**Gets or sets the length of the last segment.*/ + fromEndSegmentLength: number; + /**Gets or sets the Node that this link comes from.*/ + fromNode: Node; + /**Gets a GraphObject that is the "from" port that this link is connected from.*/ + fromPort: GraphObject; + /**Gets or sets the function that is called after this Link changes which Node or port it connects from.*/ + fromPortChanged: (a: Link, b: GraphObject, c: GraphObject) => void; + /**Gets or sets the identifier of the port that this link comes from.*/ + fromPortId: string; + /**Gets or sets how far the end segment stops short of the actual port.*/ + fromShortLength: number; + /**Gets or sets where this link should connect at the #fromPort.*/ + fromSpot: Spot; + /**Gets the Geometry that is used by the #path, the link Shape based on the route points.*/ + geometry: Geometry; + /**This read-only property is true when this Link has any label Nodes, Nodes that are owned by this Link and are arranged along its path.*/ + isLabeledLink: boolean; + /**This read-only property true if #routing is a value that implies that the points of the route should be orthogonal, such that each point shares a common X or a common Y value with the immediately previous and next points.*/ + isOrthogonal: boolean; + /**Gets or sets whether this Link is part of the tree for tree operations such as Node#findTreeChildrenNodes or Node#collapseTree.*/ + isTreeLink: boolean; + /**Gets an iterator over the Nodes that act as labels on this Link.*/ + labelNodes: Iterator; + /**Gets the angle of the path at the #midPoint.*/ + midAngle: number; + /**Gets the point at the middle of the path.*/ + midPoint: Point; + /**Gets the Shape representing the path of this Link.*/ + path: Shape; + /**Gets or sets the List of Points in the route.*/ + points: List; + /**Gets the number of points in the route.*/ + pointsCount: number; + /**Gets or sets whether the user may reconnect an existing link at the "from" end.*/ + relinkableFrom: boolean; + /**Gets or sets whether the user may reconnect an existing link at the "to" end.*/ + relinkableTo: boolean; + /**Gets or sets whether the user may change the number of segments in this Link, if the link has straight segments.*/ + resegmentable: boolean; + /**Gets or sets whether the link's path tries to avoid other nodes.*/ + routing: EnumValue; + /**Gets or sets how far the control points are from the points of the route when #routing is #Orthogonal and #curve is #Bezier.*/ + smoothness: number; + /**Gets or sets how far the control points are from the points of the route when #routing is #Orthogonal and #curve is #Bezier.*/ + toEndSegmentDirection: EnumValue; + /**Gets or sets the length of the last segment.*/ + toEndSegmentLength: number; + /**Gets or sets the Node that this link goes to.*/ + toNode: Node; + /**Gets a GraphObject that is the "to" port that this link is connected to.*/ + toPort: GraphObject; + /**Gets or sets the function that is called after this Link changes which Node or port it connects to.*/ + toPortChanged: (a: Link, b: GraphObject, c: GraphObject) => void; + /**Gets or sets the identifier of the port that this link goes to.*/ + toPortId: string; + /**Gets or sets how far the end segment stops short of the actual port.*/ + toShortLength: number; + /**Gets or sets where this link should connect at the #toPort.*/ + toSpot: Spot; + /**This predicate returns true if #relinkableFrom is true, if the layer's Layer#allowRelink is true, and if the diagram's Diagram#allowRelink is true.*/ + canRelinkFrom(): boolean; + /**This predicate returns true if #relinkableTo is true, if the layer's Layer#allowRelink is true, and if the diagram's Diagram#allowRelink is true.*/ + canRelinkTo(): boolean; + /**Find the index of the segment that is closest to a given point. + * @param {Point} p the Point, in document coordinates. + */ + findClosestSegment(p: Point): number; + /**Compute the direction in which a link should go from a given connection point. + * @param {Node} node + * @param {GraphObject} port the GraphObject representing a port on the node. + * @param {Point} linkpoint the connection point, in document coordinates. + * @param {Spot} spot a Spot value describing where the link should connect. + * @param {boolean} from true if the link is coming out of the port; false if going to the port. + * @param {boolean} ortho whether the link should have orthogonal segments. + * @param {Node} othernode the node at the other end of the link. + * @param {GraphObject} otherport the GraphObject port at the other end of the link.*/ + getLinkDirection(node: Node, port: GraphObject, linkpoint: Point, spot: Spot, from: boolean, ortho: boolean, othernode: Node, otherport: GraphObject): number; + /**Compute the point on a node/port at which the route of a link should end. + * @param {Node} node + * @param {GraphObject} port the GraphObject representing a port on the node. + * @param {Spot} spot a Spot value describing where the link should connect. + * @param {boolean} from true if the link is coming out of the port; false if going to the port. + * @param {boolean} ortho whether the link should have orthogonal segments. + * @param {Node} othernode the node at the other end of the link. + * @param {GraphObject} otherport the GraphObject port at the other end of the link. + * @param {Point=} result an optional Point that is modified and returned; otherwise it allocates and returns a new Point + */ + getLinkPoint(node: Node, port: GraphObject, spot: Spot, from: boolean, ortho: boolean, othernode: Node, otherport: GraphObject, result?: Point) + /**Compute the intersection point for the edge of a particular port GraphObject, given a point, when no particular spot or side has been specified. + * @param {Node} node + * @param {GraphObject} port the GraphObject representing a port on the node. + * @param {Point} focus the point in document coordinates to/from which the link should point, + * normally the center of the port. + * @param {Point} p often this point is far away from the node, to give a general direction, + * particularly an orthogonal one. + * @param {boolean} from true if the link is coming out of the port; false if going to the port. + * @param {Point=} result an optional Point that is modified and returned; otherwise it allocates and returns a new Point + */ + getLinkPointFromPoint(node: Node, port: GraphObject, focus: Point, p: Point, from: boolean, result?: Point): Point; + /**Given a Node, return the node at the other end of this link. + * @param {Node} node + */ + getOtherNode(node: Node): Node; + /**Given a GraphObject that is a "port", return the port at the other end of this link. + * @param {GraphObject} port + */ + getOtherPort(port: GraphObject): GraphObject; + /**Gets a particular point of the route. + * @param {number} i The zero-based index of the desired point.*/ + getPoint(i: number): Point; + /**Move this link to a new position. + * @param {number} dx + * @param {number} dy*/ + move(newpos: Point); + /**Used as a value for Link#routing: each segment is horizontal or vertical, but the route tries to avoid crossing over nodes.*/ + static AvoidsNodes: EnumValue; + /**Used as a value for Link#curve, to indicate that the link path uses Bezier curve segments.*/ + static Bezier: EnumValue; + /**Used as a value for Link#adjusting, to indicate that the link route computation should keep the intermediate points of the previous route, just modifying the first and/or last points; if the routing is orthogonal, it will only modify the first two and/or last two points.*/ + static End: EnumValue; + /**Used as a value for Link#curve, to indicate that orthogonal link segments will be discontinuous where they cross over other orthogonal link segments that have a Link#curve or JumpOver or JumpGap.*/ + static JumpGap: EnumValue; + /**Used as a value for Link#curve, to indicate that orthogonal link segments will veer around where they cross over other orthogonal link segments that have a Link#curve or JumpOver or JumpGap.*/ + static JumpOver: EnumValue; + /**This is the default value for Link#curve and Link#adjusting, to indicate that the path geometry consists of straight line segments and to indicate that the link route computation does not depend on any previous route points; this can also be used as a value for GraphObject#segmentOrientation to indicate that the object is never rotated along the link route -- its angle is unchanged.*/ + static None: EnumValue; + /**Used as the default value for Link#routing: the route goes fairly straight between ports.*/ + static Normal: EnumValue; + /**This value for GraphObject#segmentOrientation results in the GraphObject turned to have the same angle as the route: the GraphObject's angle is always the same as the angle of the link's route at the segment where the GraphObject is attached; use this orientation for arrow heads.*/ + static OrientAlong: EnumValue; + /**This value for GraphObject#segmentOrientation results in the GraphObject being turned counter-clockwise to be perpendicular to the route: the GraphObject's angle is always 90 degrees less than the angle of the link's route at the segment where the GraphObject is attached.*/ + static OrientMinus90: EnumValue; + /**This value for GraphObject#segmentOrientation results in the GraphObject turned counter-clockwise to be perpendicular to the route, just like Link#OrientMinus90, but is never upside down: the GraphObject's angle always being 90 degrees less than the angle of the link's route at the segment where the GraphObject is attached; this is typically only used for TextBlocks or Panels that contain text.*/ + static OrientMinus90Upright: EnumValue; + /**This value for GraphObject#segmentOrientation results in the GraphObject's angle always being 180 degrees opposite from the angle of the link's route at the segment where the GraphObject is attached.*/ + static OrientOpposite: EnumValue; + /**This value for GraphObject#segmentOrientation results in the GraphObject is turned clockwise to be perpendicular to the route: the GraphObject's angle is always 90 degrees more than the angle of the link's route at the segment where the GraphObject is attached.*/ + static OrientPlus90: EnumValue; + /**This value for GraphObject#segmentOrientation results in the GraphObject turned clockwise to be perpendicular to the route, just like Link#OrientPlus90, but is never upside down: the GraphObject's angle always being 90 degrees more than the angle of the link's route at the segment where the GraphObject is attached; this is typically only used for TextBlocks or Panels that contain text.*/ + static OrientPlus90Upright: EnumValue; + /**This value for GraphObject#segmentOrientation results in the GraphObject turned to have the same angle as the route, just like Link#OrientAlong, but is never upside down: the GraphObject's angle always following the angle of the link's route at the segment where the GraphObject is attached; this is typically only used for TextBlocks or Panels that contain text.*/ + static OrientUpright: EnumValue; + /**This value for GraphObject#segmentOrientation results in the GraphObject's angle always following the angle of the link's route at the segment where the GraphObject is attached, but never upside down and never angled more than +/- 45 degrees: when the route's angle is within 45 degrees of vertical (90 or 270 degrees), the GraphObject's angle is set to zero; this is typically only used for TextBlocks or Panels that contain text.*/ + static OrientUpright45: EnumValue; + /**Used as a value for Link#routing: each segment is horizontal or vertical.*/ + static Orthogonal: EnumValue; + /**Used as a value for Link#adjusting, to indicate that the link route computation should scale and rotate the intermediate points so that the link's shape looks approximately the same; if the routing is orthogonal, this value is treated as if it were Link#End.*/ + static Scale: EnumValue; + /**Used as a value for Link#adjusting, to indicate that the link route computation should linearly interpolate the intermediate points so that the link's shape looks stretched; if the routing is orthogonal, this value is treated as if it were Link#End.*/ + static Stretch: EnumValue; + } + + /** + * A Node is a Part that may connect to other nodes with Links, + * or that may be a member of a Group. + * Group inherits from Node, + * enabling nodes to logically contain other nodes and links. + */ + class Node extends Part { + /**Constructs an empty Node. + * @param {EnumValue=} type if not supplied, the default Panel type is Panel#Position. + */ + constructor(type?: EnumValue); + /**Gets or sets whether this Node is to be avoided by Links whose Link#routing is Link#AvoidsNodes.*/ + avoidable: boolean; + /**Gets or sets the Margin (or number for a uniform Margin) around this Node in which avoidable links will not be routed.*/ + avoidableMargin: any; + /**Gets whether a Node is a label node for a Link.*/ + isLinkLabel: boolean; + /**Gets or sets whether the subtree graph starting at this node is expanded.*/ + isTreeExpanded: boolean; + /**Gets whether this node has no tree children.*/ + isTreeLeaf: boolean; + /**Gets or sets the Link for which this Node is acting as a smart label.*/ + labeledLink: Link; + /**Gets or sets the function that is called after a Link has been connected with this Node.*/ + linkConnected: (a: Node, b: Link, c: GraphObject) => void; + /**Gets or sets the function that is called after a Link has been disconnected from this Node.*/ + linkDisconnected: (a: Node, b: Link, c: GraphObject) => void; + /**Gets an iterator over all of the Links that are connected with this node.*/ + linksConnected: Iterator; + /**Get the primary GraphObject representing a port in this node.*/ + port: GraphObject; + /**Gets an iterator over all of the GraphObjects in this node that act as ports.*/ + ports: Iterator; + /**Gets or sets the function that is called when #isTreeExpanded has changed value.*/ + treeExpandedChanged: (node: Node) => void; + /**Gets or sets whether the subtree graph starting at this node had been collapsed by a call to #expandTree on the parent node.*/ + wasTreeExpanded: boolean; + /**Hide each child node and the connecting link, and recursively collapse each child node. + * @param {number=} level How many levels of the tree, starting at this node, to keep expanded if already expanded; + * the default is 1, hiding all tree children of this node. Values less than 1 are treated as 1. + */ + collapseTree(level?: number); + /**Show each child node and the connecting link, and perhaps recursively expand their child nodes. + * @param {number=} level How many levels of the tree should be expanded; + * the default is 2, showing all tree children of this node and potentially more. + * Values less than 2 are treated as 2.*/ + expandTree(level?: number); + /**Returns an iterator over all of the Links that go from this node to another node or vice-versa, perhaps limited to a given port id on this node and a port id on the other node. + * @param {Node} othernode + * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. + * @param {string|null=} otherpid A port identifier string; if null the link's portId is ignored and all links are included in the search. + */ + findLinksBetween(othernode: Node, pid?: string, otherpid?: string): Iterator; + /**Returns an iterator over all of the Links that connect with this node in either direction, perhaps limited to the given port id on this node. + * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. + */ + findLinksConnected(pid?: string): Iterator; + /**Returns an iterator over all of the Links that go into this node, perhaps limited to the given port id on this node. + * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. + */ + findLinksInto(pid?: string): Iterator; + /**Returns an iterator over all of the Links that come out of this node, perhaps limited to the given port id on this node. + * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. + */ + findLinksOutOf(pid?: string): Iterator; + /**Returns an iterator over all of the Links that go from this node to another node, perhaps limited to a given port id on this node and a port id on the other node. + * @param {Node} othernode + * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. + * @param {string|null=} otherpid A port identifier string; if null the link's portId is ignored and all links are included in the search. + */ + findLinksTo(othernode: Node, pid?: string, otherpid?: string): Iterator; + /**Returns an iterator over the Nodes that are connected with this node in either direction, perhaps limited to the given port id on this node. + * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. + */ + findNodesConnected(pid?: string): Iterator; + /**Returns an iterator over the Nodes that are connected with this node by links going into this node, perhaps limited to the given port id on this node. + * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. + */ + findNodesInto(pid?: string): Iterator; + /**Returns an iterator over the Nodes that are connected with this node by links coming out of this node, perhaps limited to the given port id on this node. + * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. + */ + findNodesOutOf(pid?: string): Iterator; + /**Find a GraphObject with a given GraphObject#portId. + * @param {string} pid*/ + findPort(pid: string): GraphObject; + /**Returns an Iterator for the collection of Links that connect with the immediate tree children of this node.*/ + findTreeChildrenLinks(): Iterator; + /**Returns an Iterator for the collection of Nodes that are the immediate tree children of this node.*/ + findTreeChildrenNodes(): Iterator; + /**Returns the Link that connects with the tree parent Node of this node if the graph is tree-structured, if there is such a link and Link#isTreeLink is true.*/ + findTreeParentLink(): Link; + /**Returns the Node that is the tree parent of this node if the graph is tree-structured, if there is a parent.*/ + findTreeParentNode(): Node; + /**Return a collection of Parts including this Node, all of the Links going to child Nodes, and all of their tree child nodes and links. + * @param {number=} level How many levels of the tree, starting at this node, to include; + * the default is Infinity, including all tree children of this node. Values less than 1 are treated as 1. + */ + findTreeParts(level?: number): Set; + /**Return the Node that is at the root of the tree that this node is in, perhaps this node itself.*/ + findTreeRoot(): Node; + /**This predicate is true if this node is a child of the given Node, perhaps indirectly as a descendant. + * @param {Node} node the Node that might be a parent or ancestor of this node.*/ + isInTreeOf(node: Node): boolean; + /**This value for GraphObject#fromEndSegmentDirection and GraphObject#toEndSegmentDirection indicates that the link's end segment angle stays the same even if the node is rotated.*/ + static DirectionAbsolute: EnumValue; + /**This value for Link#fromEndSegmentDirection and Link#toEndSegmentDirection indicates that the real value is inherited from the corresponding connected port.*/ + static DirectionDefault: EnumValue; + /**This value for GraphObject#fromEndSegmentDirection and GraphObject#toEndSegmentDirection indicates that the link's end segment angle is rotated to match the node's angle.*/ + static DirectionRotatedNode: EnumValue; + /**This value for GraphObject#fromEndSegmentDirection and GraphObject#toEndSegmentDirection indicates that the link's end segment angle is rotated to match the node's angle, but only in increments of 90 degrees.*/ + static DirectionRotatedNodeOrthogonal: EnumValue; + } + + /** + * An Overview is a Diagram that displays all of a different diagram, + * with a rectangular box showing the viewport displayed by that other diagram. + * All you need to do is set Overview#observed. + */ + class Overview extends Diagram { + /* @param {HTMLDivElement|string } div A reference to a div or its ID as a string.*/ + constructor(div: string); + constructor(div?: HTMLDivElement); + /**Gets pr sets the rectangular Part that represents the viewport of the #observed Diagram.*/ + box: Part; + /**Gets pr sets whether this overview draws the temporary layers of the observed Diagram.*/ + drawsTemporaryLayers: boolean; + /**Gets or sets the Diagram for which this Overview is displaying a model and showing its viewport into that model.*/ + observed: Diagram; + } + + /** + * Palette extends the Diagram class to allow objects to be dragged and placed onto other Diagrams. + * Its Diagram#layout is a GridLayout. + * The Palette is Diagram#isReadOnly but to support drag-and-drop its Diagram#allowDragOut is true. + */ + class Palette extends Diagram { + /* @param {HTMLDivElement|string } div A reference to a div or its ID as a string.*/ + constructor(div: string); + constructor(div?: HTMLDivElement); + } + + /** + * A Panel is a GraphObject that holds other GraphObjects as its elements. + * A Panel is responsible for sizing and positioning its elements. + * Every Panel has a #type and establishes its own coordinate system. The #type of a Panel + * determines how it will size and arrange its elements. + */ + class Panel extends GraphObject { + /**Constructs an empty Panel of the given #type. + * @param {EnumValue=} type If not supplied, the default Panel type is Panel#Position. + */ + constructor(type?: EnumValue); + /**Gets the number of columns in this Panel if it is of #type Panel#Table.*/ + columnCount: number; + /**Gets or sets how this Panel's columns deal with extra space if the Panel is of #type Panel#Table.*/ + columnSizing: EnumValue; + /**Gets or sets the optional model data to which this panel is data-bound.*/ + data: Object; + /**Gets or sets the default alignment spot of this Panel, used as the alignment for an element when its GraphObject#alignment value is Spot#Default.*/ + defaultAlignment: Spot; + /**Gets or sets the default dash array for a particular column's separator.*/ + defaultColumnSeparatorDashArray: Array; + /**Gets or sets the default Brush stroke (or CSS color string) for columns in a Table Panel provided a given column has a nonzero RowColumnDefinition#separatorStrokeWidth.*/ + defaultColumnSeparatorStroke: any; + /**Gets or sets the default stroke width for a particular column's separator.*/ + defaultColumnSeparatorStrokeWidth: number; + /**Gets or sets the default dash array for a particular row's separator.*/ + defaultRowSeparatorDashArray: Array; + /**Gets or sets the default Brush stroke (or CSS color string) for rows in a Table Panel provided a given row has a nonzero RowColumnDefinition#separatorStrokeWidth.*/ + defaultRowSeparatorStroke: any; + /**Gets or sets the default stroke width for a particular row's separator.*/ + defaultRowSeparatorStrokeWidth: number; + /**Gets or sets the additional padding for a particular row or column.*/ + defaultSeparatorPadding: Margin; + /**Gets or sets the default stretch of this Panel, used as the stretch for an element when its GraphObject#stretch value is GraphObject#Default.*/ + defaultStretch: EnumValue; + /**Gets an iterator over the collection of the GraphObjects that this panel manages.*/ + elements: Iterator; + /**Gets or sets the distance between lines in a #Grid panel.*/ + gridCellSize: Size; + /**Gets or sets an origin point for the grid cells in a #Grid panel.*/ + gridOrigin: Point; + /**Gets or sets a JavaScript Array of values or objects, each of which will be represented by a Panel as elements in this Panel.*/ + itemArray: Array; + /**Gets or sets the name of the item data property that returns a string describing that data's category, or a function that takes an item data object and returns that string; the default value is the name 'category'.*/ + itemCategoryProperty: any; + /**Gets or sets the default Panel template used as the archetype for item data that are in #itemArray.*/ + itemTemplate: Panel; + /**Gets or sets a Map mapping template names to Panels.*/ + itemTemplateMap: Map; + /**Gets or sets the first column that this Panel of #type Panel#Table displays.*/ + leftIndex: number; + /**Gets or sets the multiplicative opacity for this Panel and all children.*/ + opacity: number; + /**Gets or sets the space between this Panel's border and its content, as a Margin (or number for a uniform Margin), depending on the type of panel.*/ + padding: any; + /**Gets the number of row in this Panel if it is of #type Panel#Table.*/ + rowCount: number; + /**Gets or sets how this Panel's rows deal with extra space if the Panel is of #type Panel#Table.*/ + rowSizing: EnumValue; + /**Gets or sets the first row that this this Panel of #type Panel#Table displays.*/ + topIndex: number; + /**Gets or sets the type of the Panel.*/ + type: EnumValue; + /**Gets or sets how a #Viewbox panel will resize its content.*/ + viewboxStretch: EnumValue; + /**Adds a GraphObject to the end of this Panel's list of elements, visually in front of all of the other elements. + * @param {GraphObject} element A GraphObject.*/ + add(element: GraphObject); + /**Creates a deep copy of this Panel and returns it.*/ + copy(): Panel; + /**Returns the GraphObject in this Panel's list of elements at the specified index.*/ + elt(idx: number): GraphObject; + /**Returns the cell at a given x-coordinate in local coordinates. + * @param {number} x*/ + findColumnForLocalX(x: number): number; + /**Search the visual tree starting at this Panel for a GraphObject whose GraphObject#name is the given name. + * @param {string} name The name to search for, using a case-sensitive string comparison.*/ + findObject(name: string): GraphObject; + /**Returns the row at a given y-coordinate in local coordinates. + * @param {number} y*/ + findRowForLocalY(y: number): number; + /**Gets the RowColumnDefinition for a particular column in this Table Panel. + * @param {number} idx the non-negative zero-based integer column index.*/ + getColumnDefinition(idx: number): RowColumnDefinition; + /**Gets the RowColumnDefinition for a particular row in this Table Panel. + * @param {number} idx the non-negative zero-based integer row index.*/ + getRowDefinition(idx: number): RowColumnDefinition; + /**Adds a GraphObject to the Panel's list of elements at the specified index. + * @param {number} index + * @param {GraphObject} element A GraphObject.*/ + insertAt(index: number, element: GraphObject); + /**Create and add new GraphObjects corresponding to and bound to the data in the #itemArray, after removing all existing elements from this Panel.*/ + rebuildItemElements(); + /**Removes a GraphObject from this Panel's list of elements. + * @param {GraphObject} element A GraphObject.*/ + remove(element: GraphObject); + /**Removes an GraphObject from this Panel's list of elements at the specified index. + * @param {number} idx*/ + removeAt(idx: number); + /**Removes the RowColumnDefinition for a particular row in this Table Panel. + * @param {number} idx the non-negative zero-based integer row index.*/ + removeColumnDefinition(idx: number); + /**Removes the RowColumnDefinition for a particular row in this Table Panel. + * @param {number} idx the non-negative zero-based integer row index.*/ + removeRowDefinition(idx: number); + /**Re-evaluate all data bindings on this panel, in order to assign new property values to the GraphObjects in this visual tree based on this this object's #data property values. + * @param {string=} srcprop An optional source data property name: + * when provided, only evaluates those Bindings that use that particular property; + * when not provided or when it is the empty string, all bindings are evaluated. + */ + updateTargetBindings(srcprop?: string); + /**This value for #type resizes the main element to fit around the other elements; the main element is the first GraphObject with GraphObject#isPanelMain set to true, or else the first GraphObject if none have that property set to true.*/ + static Auto: EnumValue; + /**This value for #type is used to draw regular patterns of lines.*/ + static Grid: EnumValue; + /**This value for #type lays out the elements horizontally with their GraphObject#alignment property dictating their alignment on the Y-axis.*/ + static Horizontal: EnumValue; + /**This value for #type is used for Links and adornments that act as Links.*/ + static Link: EnumValue; + /**The default #type arranges each element according to their GraphObject#position.*/ + static Position: EnumValue; + /**This value for #type arranges GraphObjects about a main element using the GraphObject#alignment and GraphObject#alignmentFocus properties; the main element is the first GraphObject with GraphObject#isPanelMain set to true, or else the first GraphObject if none have that property set to true.*/ + static Spot: EnumValue; + /**This value for #type arranges GraphObjects into rows and columns; set the GraphObject#row and GraphObject#column properties on each element.*/ + static Table: EnumValue; + /**Organizational Panel type that is only valid inside of a Table panel.*/ + static TableColumn: EnumValue; + /**Organizational Panel type that is only valid inside of a Table panel.*/ + static TableRow: EnumValue; + /**This value for #type lays out the elements vertically with their GraphObject#alignment property dictating their alignment on the X-axis.*/ + static Vertical: EnumValue; + /**This value for #type rescales a single GraphObject to fit inside the panel depending on the element's GraphObject#stretch property.*/ + static Viewbox: EnumValue; + } + + /** + * This is the base class for all user-manipulated top-level objects. + * Because it inherits from Panel}, it is automatically a visual container + * of other GraphObject}s. + * Because it thus also inherits from GraphObject}, it also has properties such as + * GraphObject#actualBounds}, GraphObject#contextMenu}, and GraphObject#visible}. + */ + class Part extends Panel { + /**The constructor builds an empty Part. + * @param {EnumValue=} type if not supplied, the default Panel type is Panel#Position. + */ + constructor(type?: EnumValue); + /**Gets an iterator over all of the Adornments associated with this part.*/ + adornments: Iterator; + /**Gets or sets the category of this part, typically used to distinguish different kinds of nodes or links.*/ + category: string; + /**Gets or sets the Group of which this Part or Node is a member.*/ + containingGroup: Group; + /**Gets or sets the function that is called after this Part has changed which Group it belongs to, if any.*/ + containingGroupChanged: (member: Part, oldgrp: Group, newgrp: Group) => void; + /**Gets or sets whether the user may copy this part.*/ + copyable: boolean; + /**Gets or sets whether the user may delete this part.*/ + deletable: boolean; + /**Gets the Diagram that this Part is in.*/ + diagram: Diagram; + /**Gets or sets the function used to determine the location that this Part can be dragged to.*/ + dragComputation: (part: Part, oldloc: Point, newloc: Point) => Point; + /**Gets or sets whether the user may group this part to be a member of a new Group.*/ + groupable: boolean; + /**Gets or sets whether this Part is part of the document bounds.*/ + isInDocumentBounds: boolean; + /**Gets or sets whether a Layout positions this Node or routes this Link.*/ + isLayoutPositioned: boolean; + /**Gets or sets whether this Part is selected.*/ + isSelected: boolean; + /**Gets or sets whether this part will draw shadows.*/ + isShadowed: boolean; + /**Gets whether this part is not member of any Group node nor is it a label node for a Link.*/ + isTopLevel: boolean; + /**Gets the Layer that this Part is in.*/ + layer: Layer; + /**Gets or sets the function to execute when this part changes layers.*/ + layerChanged: (part: Part, oldlayer: Layer, newlayer: Layer) => void; + /**Gets or sets the layer name for this part.*/ + layerName: string; + /**Gets or sets "Layout..." flags that control when the Layout that is responsible for this Part is invalidated.*/ + layoutConditions: number; + /**Gets or sets the position of this part in document coordinates, based on the #locationSpot in this part's #locationObject.*/ + location: Point; + /**Gets the GraphObject that determines the location of this Part.*/ + locationObject: GraphObject; + /**Gets or sets the name of the GraphObject that provides the location of this Part.*/ + locationObjectName: string; + /**Gets or sets the location Spot of this Node, the spot on the #locationObject that is used in positioning this part in the diagram.*/ + locationSpot: Spot; + /**Gets or sets the maximum location of this Part to which the user may drag using the DraggingTool.*/ + maxLocation: Point; + /**Gets or sets the minimum location of this Part to which the user may drag using the DraggingTool.*/ + minLocation: Point; + /**Gets or sets whether the user may move this part.*/ + movable: boolean; + /**Gets or sets whether the user may reshape this part.*/ + reshapable: boolean; + /**Gets or sets whether the user may resize this part.*/ + resizable: boolean; + /**Gets or sets the adornment template used to create a resize handle Adornment for this part.*/ + resizeAdornmentTemplate: Adornment; + /**Gets or sets the width and height multiples used when resizing.*/ + resizeCellSize: Size; + /**Gets the GraphObject that should get resize handles when this part is selected.*/ + resizeObject: GraphObject; + /**Gets or sets the name of the GraphObject that should get a resize handle when this part is selected.*/ + resizeObjectName: string; + /**Gets or sets whether the user may rotate this part.*/ + rotatable: boolean; + /**Gets or sets the adornment template used to create a rotation handle Adornment for this part.*/ + rotateAdornmentTemplate: Adornment; + /**Gets the GraphObject that should get rotate handles when this part is selected.*/ + rotateObject: GraphObject; + /**Gets or sets the name of the GraphObject that should get a rotate handle when this part is selected.*/ + rotateObjectName: string; + /**Gets or sets whether the user may select this part.*/ + selectable: boolean; + /**Gets or sets whether a selection adornment is shown for this part when it is selected.*/ + selectionAdorned: boolean; + /**Gets or sets the Adornment template used to create a selection handle for this Part.*/ + selectionAdornmentTemplate: Adornment; + /**Gets or sets the function to execute when this part is selected or deselected.*/ + selectionChanged: (p: Part) => void; + /**Gets the GraphObject that should get a selection handle when this part is selected.*/ + selectionObject: GraphObject; + /**Gets or sets the name of the GraphObject that should get a selection handle when this part is selected.*/ + selectionObjectName: string; + /**Gets or sets the numerical value that describes the shadow's blur.*/ + shadowBlur: number; + /**Gets or sets the CSS string that describes a shadow color.*/ + shadowColor: string; + /**Gets or sets the X and Y offset of this part's shadow.*/ + shadowOffset: Point; + /**Gets or sets a text string that is associated with this part.*/ + text: string; + /**Gets or sets whether the user may do in-place text editing on TextBlocks in this part that have TextBlock#editable set to true.*/ + textEditable: boolean; + /**Associate an Adornment with this Part, perhaps replacing any existing adornment. + * @param {string} category a string identifying the kind or role of the given adornment for this Part. + * @param {Adornment} ad*/ + addAdornment(category: string, ad: Adornment); + /**This predicate returns true if #copyable is true, if the layer's Layer#allowCopy is true, and if the diagram's Diagram#allowCopy is true.*/ + canCopy(): boolean; + /**This predicate returns true if #deletable is true, if the layer's Layer#allowDelete is true, and if the diagram's Diagram#allowDelete is true.*/ + canDelete(): boolean; + /**This predicate returns true if #textEditable is true, if the layer's Layer#allowTextEdit is true, and if the diagram's Diagram#allowTextEdit is true.*/ + canEdit(): boolean; + /**This predicate returns true if #groupable is true, if the layer's Layer#allowGroup is true, and if the diagram's Diagram#allowGroup is true.*/ + canGroup(): boolean; + /**This predicate is called by Layout implementations to decide whether this Part should be positioned and might affect the positioning of other Parts.*/ + canLayout(): boolean; + /**This predicate returns true if #movable is true, if the layer's Layer#allowMove is true, and if the diagram's Diagram#allowMove is true.*/ + canMove(): boolean; + /**This predicate returns true if #reshapable is true, if the layer's Layer#allowReshape is true, and if the diagram's Diagram#allowReshape is true.*/ + canReshape(): boolean; + /**This predicate returns true if #resizable is true, if the layer's Layer#allowResize is true, and if the diagram's Diagram#allowResize is true.*/ + canResize(): boolean; + /**This predicate returns true if #rotatable is true, if the layer's Layer#allowRotate is true, and if the diagram's Diagram#allowRotate is true.*/ + canRotate(): boolean; + /**This predicate returns true if #selectable is true, if the layer's Layer#allowSelect is true, and if the diagram's Diagram#allowSelect is true.*/ + canSelect(): boolean; + /**Remove all adornments associated with this part.*/ + clearAdornments(); + /**Find an Adornment of a given category associated with this Part. + * @param {string} category*/ + findAdornment(category: string): Adornment; + /**Find the Group that contains both this part and another one. + * @param {Part} other*/ + findCommonContainingGroup(other: Part): Group; + /**Gets the top-level Part for this part, which is itself when #isTopLevel is true.*/ + findTopLevelPart(): Part; + /**Invalidate the Layout that is responsible for positioning this Part. + * @param {number=} condition the reason that the layout should be invalidated -- + * some combination of "Layout..." flag values; + * if this argument is not supplied, any value of #layoutConditions other than Part#LayoutNone + * will allow the layout to be invalidated.*/ + invalidateLayout(condition?: number); + /**This predicate is true if this part is a member of the given Part, perhaps indirectly. + * @param {Part} part*/ + isMemberOf(part: Part): boolean; + /**This predicate is true if this Part can be seen.*/ + isVisible(): boolean; + /**Move this part and any parts that are owned by this part to a new position. + * @param {Point} newpos a new Point in document coordinates.*/ + move(newpos: Point); + /**Remove any Adornment of the given category that may be associated with this Part. + * @param {string} category a string identifying the kind or role of the given adornment for this Part. + */ + removeAdornment(category: string); + /**This is responsible for creating any selection Adornment (if this Part #isSelected) and any tool adornments for this part.*/ + updateAdornments(); + /**Re-evaluate all data bindings on this Part, in order to assign new property values to the GraphObjects in this visual tree based on this this object's #data property values. + * @param {string=} srcprop An optional source data property name: + * when provided, only evaluates those Bindings that use that particular property; + * when not provided or when it is the empty string, all bindings are evaluated.*/ + updateTargetBindings(srcprop?: string); + /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Part is added to a Diagram or Group, it invalidates the Layout responsible for the Part.*/ + LayoutAdded: number; + /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Group has been laid out, it invalidates the Layout responsible for that Group; this flag is ignored for Parts that are not Groups.*/ + LayoutGroupLayout: number; + /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Part's GraphObject#visible becomes false, it invalidates the Layout responsible for the Part.*/ + LayoutHidden: number; + /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Part's GraphObject#actualBounds changes size, it invalidates the Layout responsible for the Part; this flag is ignored for Parts that are Links.*/ + LayoutNodeSized: number; + /**This value may be used as the value of the Part#layoutConditions property to indicate that no operation on this Part causes invalidation of the Layout responsible for this Part.*/ + LayoutNone: number; + /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Part is removed from a Diagram or Group, it invalidates the Layout responsible for the Part.*/ + LayoutRemoved: number; + /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Part's GraphObject#visible becomes true, it invalidates the Layout responsible for the Part.*/ + LayoutShown: number; + /**This is the default value for the Part#layoutConditions property: the Layout responsible for the Part is invalidated when the Part is added or removed from the Diagram or Group or when it changes visibility or size or when a Group's layout has been performed.*/ + LayoutStandard: number; + ensureBounds(); + } + + /** + * A Picture is a GraphObject that shows an image, video-frame, or Canvas element. + * You can specify what to show by either setting the #source URL property + * to a URL string or the #element property to an HTMLImageElement, + * HTMLCanvasElement, or HTMLVideoElement. + */ + class Picture extends GraphObject { + /**The constructor creates a picture that shows nothing until the #source or #element is specified.*/ + constructor(); + /**Gets or sets the Picture's HTML element, an Image or Video or Canvas element.*/ + element: HTMLElement; + /**Gets or sets the function to call if an image fails to load.*/ + errorFunction: (pic: Picture, e: Event) => void; + /**Gets or sets how the Picture's image is stretched within its bounding box.*/ + imageStretch: EnumValue; + /**Gets the natural size of this picture as determined by its source's width and height.*/ + naturalBounds: Rect; + /**Gets or sets the Picture's source URL, which can be any valid image (png, jpg, gif, etc) URL.*/ + source: string; + /**Gets or sets the rectangular area of the source image that this picture should display.*/ + sourceRect: Rect; + } + + /** + * If a Placeholder is in the visual tree of a Group, it represents the area of all of the member Parts of that Group. + * If a Placeholder is in the visual tree of an Adornment, it represents the area of the Adornment#adornedObject. + * It can only be used in the visual tree of a Group node or an Adornment. + * There can be at most one Placeholder in a Group or an Adornment. + */ + class Placeholder extends GraphObject { + constructor(); + /**Gets or sets the padding as a Margin (or number for a uniform Margin) around the members of the Group or around the Adornment#adornedObject GraphObject.*/ + padding: any; + } + + /** + * The RowColumnDefinition class describes constraints on a row or a column + * in a Panel of type Panel#Table. + * It also provides information about the actual layout after the + * Table Panel has been arranged. + */ + class RowColumnDefinition { + /**You do not need to use this constructor, because calls to Panel#getRowDefinition or Panel#getColumnDefinition will automatically create and remember a RowColumnDefinition for you.*/ + constructor(); + /**Gets the usable row height or column width, after arrangement, that objects in this row or column can be placed within.*/ + actual: number; + /**Gets or sets a default alignment for elements that are in this row or column.*/ + alignment: Spot; + /**Gets or sets the background Brush (or CSS color string) for a particular row or column, which fills the entire span of the column, including any separatorPadding.*/ + background: any; + /**Determines whether or not the background, if there is one, is in front of or behind the separators.*/ + coversSeparators: boolean; + /**Gets or sets the row height.*/ + height: number; + /**Gets which row or column this RowColumnDefinition describes in the #panel.*/ + index: number; + /**Gets whether this describes a row or a column in the #panel.*/ + isRow: boolean; + /**Gets or sets the maximum row height or column width.*/ + maximum: number; + /**Gets or sets the minimum row height or column width.*/ + minimum: number; + /**Gets the Panel that this row or column definition is in.*/ + panel: Panel; + /**Gets the actual arranged row or column starting position, after arrangement.*/ + position: number; + /**Gets or sets the dash array for dashing the spacing provided this row or column has a nonzero RowColumnDefinition#separatorStrokeWidth and non-null RowColumnDefinition#separatorStroke.*/ + separatorDashArray: Array; + /**Gets or sets the additional padding for a particular row or column.*/ + separatorPadding: Margin; + /**Gets or sets the Brush (or CSS color string) for a particular row or column, provided that row or column has a nonzero RowColumnDefinition#separatorStrokeWidth.*/ + separatorStroke: any; + /**Gets or sets the stroke width for a particular row or column's separator,*/ + separatorStrokeWidth: number; + /**Gets or sets how this row or column deals with a Table Panel's extra space.*/ + sizing: EnumValue; + /**Gets or sets the default stretch for elements that are in this row or column.*/ + stretch: EnumValue; + /**Gets the total arranged row height or column width, after arrangement.*/ + total: number; + /**Gets or sets the column width.*/ + width: number; + /**Add a data-binding of a property on this object to a property on a data object. + * @param {Binding} binding*/ + bind(binding: Binding); + /**The default #sizing, which resolves to RowColumnDefinition#None or else the Table Panel's rowSizing and columnSizing if present.*/ + static Default: EnumValue; + /**The default #sizing if none is specified on the Table Panel's rowSizing and columnSizing.*/ + static None: EnumValue; + /**If a Table Panel is larger than all the rows then this #sizing grants this row and any others with the same value the extra space, apportinoed proportionally between them*/ + static ProportionalExtra: EnumValue; + } + + /** + * A Shape is a GraphObject that shows a geometric figure. + * The Geometry determines what is drawn; + * the properties #fill and #stroke + * (and other stroke properties) determine how it is drawn. + */ + class Shape extends GraphObject { + /**A newly constructed Shape has a default #figure of "None", which constructs a rectangular geometry, and is filled and stroked with a black brush.*/ + constructor(); + /**Gets or sets the figure name, used to construct a Geometry.*/ + figure: string; + /**Gets or sets the Brush (or CSS color string) that describes the fill of the Shape.*/ + fill: any; + /**Gets or sets the name of the kind of arrowhead that this shape should take when this shape is an element of a Link.*/ + fromArrow: string; + /**Gets or sets the Shape's Geometry that defines the Shape's figure.*/ + geometry: Geometry; + /**Gets or sets how the shape's geometry is proportionally created given its computed size.*/ + geometryStretch: EnumValue; + /**When set, creates a Geometry and normalizes it from a given path string, then sets the Geometry on this Shape and offsets the GraphObject#position by an appropriate amount.*/ + geometryString: string; + /**Gets or sets how frequently this shape should be drawn within a Grid Panel, in multiples of the Panel#gridCellSize.*/ + interval: number; + /**Gets or sets the whether the #position denotes the panel coordinates of the geometry or of the stroked area.*/ + isGeometryPositioned: boolean; + /**Gets the natural bounds of this Shape as determined by its #geometry's bounds.*/ + naturalBounds: Rect; + /**Gets or sets a property for parameterizing the construction of a Geometry from a figure.*/ + parameter1: number; + /**Gets or sets a property for parameterizing the construction of a Geometry from a figure.*/ + parameter2: number; + /**Gets or sets the top-left Spot used by some Panels for determining where in the shape other objects may be placed.*/ + spot1: Spot; + /**Gets or sets the bottom-right Spot used by some Panels for determining where in the shape other objects may be placed.*/ + spot2: Spot; + /**Gets or sets the Brush (or CSS color string) that describes the stroke of the Shape.*/ + stroke: any; + /**Gets or sets the style for the stroke's line cap.*/ + strokeCap: string; + /**Gets or sets the dash array for creating dashed lines.*/ + strokeDashArray: Array; + /**Gets or sets the offset for dashed lines, used in the phase pattern.*/ + strokeDashOffset: number; + /**Gets or sets the type of corner that will be drawn when two lines meet.*/ + strokeJoin: string; + /**Gets or sets the style for the stroke's mitre limit ratio.*/ + strokeMiterLimit: number; + /**Gets or sets a stroke's width.*/ + strokeWidth: number; + /**Gets or sets the name of the kind of arrowhead that this shape should take when this shape is an element of a Link.*/ + toArrow: string; + } + + /** + * A TextBlock is a GraphObject that displays a #text string in a given #font. + */ + class TextBlock extends GraphObject { + /**A newly constructed TextBlock has no string to show; if it did, it would draw the text, wrapping if needed, in the default font using a black stroke.*/ + constructor(); + /**Gets or sets whether or not this TextBlock allows in-place editing of the #text string by the user with the help of the TextEditingTool.*/ + editable: boolean; + /**Gets or sets the function to call if a text edit made with the TextEditingTool is invalid.*/ + errorFunction: (tool: TextEditingTool, oldst: string, newstr: string) => void; + /**Gets or sets the current font settings.*/ + font: string; + /**Gets or sets whether or not the text allows or displays multiple lines or embedded newlines.*/ + isMultiline: boolean; + /**Gets or sets whether or not the text has a strikethrough line (line-through).*/ + isStrikethrough: boolean; + /**Gets or sets whether or not the text is underlined.*/ + isUnderline: boolean; + /**Gets the total number of lines in this TextBlock, including lines created from returns and wrapping.*/ + lineCount: number; + /**Gets the natural bounds of this TextBlock in local coordinates, as determined by its #font and #text string.*/ + naturalBounds: Rect; + /**Gets or sets the Brush (or CSS color string) that describes the stroke (color) of the #font.*/ + stroke: any; + /**Gets or sets the current text string.*/ + text: string; + /**Gets or sets the current text alignment property.*/ + textAlign: string; + /**Gets or sets the HTMLElement that this TextBlock uses as its text editor in the TextEditingTool.*/ + textEditor: HTMLElement; + /**Gets or sets the predicate that determines whether or not a string of text is valid.*/ + textValidation: (tb: TextBlock, oldstr: string, newstr: string) => boolean; + /**Gets or sets whether the text should be wrapped if it is too long to fit on one line.*/ + wrap: EnumValue; + /**The TextBlock will not wrap its text.*/ + static None: EnumValue; + /**The TextBlock will wrap text and the width of the TextBlock will be the desiredSize's width, if any.*/ + static WrapDesiredSize: EnumValue; + /**The TextBlock will wrap text, making the width of the TextBlock equal to the width of the longest line.*/ + static WrapFit: EnumValue; + } + + /** * A Brush holds color information and describes how to draw the inside * of a Shape or the stroke of a shape or a TextBlock or the @@ -20,7 +1848,8 @@ declare module go { * one of the values Brush#Solid, Brush#Linear, Brush#Radial, * Brush#Pattern, or a well-formed CSS string describing a solid color brush. No parameter * defaults to a Brush.Solid with a color description of 'black'.*/ - constructor(...args: any[]); + constructor(type: EnumValue); + constructor(type?: string); /**Gets or sets the color of a solid Brush.*/ color: string; /**Gets or sets a Map holding all of the color stops used in this gradient, where the key is a number, the fractional distance between zero and one (inclusive), and where the corresponding value is a color string.*/ @@ -29,8 +1858,8 @@ declare module go { end: Spot; /**Gets or sets the radius of a radial brush at the end location.*/ endRadius: number; - /**Gets or sets the pattern of a brush of type Brush#Pattern.*/ - pattern: HTMLCanvasElement; + /**Gets or sets the pattern of a brush of type Brush#Pattern, an HTMLImageElement or HTMLCanvasElement.*/ + pattern: any; /**Gets or sets the starting location for a linear or radial gradient.*/ start: Spot; /**Gets or sets the radius of a radial brush at the start location.*/ @@ -43,26 +1872,27 @@ declare module go { * You should have a color stop at zero and a color stop at one. * You should not have duplicate color stop values at the same fractional distance. * @param {number} loc between zero and one, inclusive. - * @param {string} color + * @param {string} color a CSS color string */ addColorStop(loc: number, color: string); /**Create a copy of this Brush, with the same values.*/ copy(): Brush; /** - * This static method can be used to generate a random color. + * This static method can be used to generate a random color string. * @param {number=} min a number between zero and 255, defaults to 128. * @param {number=} max a number between zero and 255, defaults to 255. */ static randomColor(min?: number, max?: number): string; /**For linear gradient brushes, used as the value for Brush#type.*/ - Linear: EnumValue; + static Linear: EnumValue; /**For pattern brushes, used as the value for Brush#type.*/ - Pattern: EnumValue; + static Pattern: EnumValue; /**For radial gradient brushes, used as the value for Brush#type.*/ - Radial: EnumValue; + static Radial: EnumValue; /**For simple, solid color brushes, used as the value for Brush#type.*/ - Solid: EnumValue; + static Solid: EnumValue; } + /** * The Geometry class is used to define the "shape" of a Shape. * A Geometry can be simple straight lines, rectangles, or ellipses. @@ -98,9 +1928,9 @@ declare module go { /**Computes the Geometry's bounds without adding an origin point, and returns those bounds as a rect.*/ computeBoundsWithoutOrigin(): Rect; /**Create a copy of this Geometry, with the same values and figures.*/ - copy(): Rect; + copy(): Geometry; /** - * Given a SVG or GoJS path string, returns a congruent path string with each pathfigure filled. + * Given a SVG or GoJS path string, returns a congruent path string with each PathFigure filled. * For instance, "M0 0 L22 22 L33 0" would become "F M0 0 L22 22 L33 0". * @param {string} str */ @@ -147,14 +1977,15 @@ declare module go { */ static stringify(val: Geometry): string; /**For drawing an ellipse fitting within a rectangle; a value for Geometry#type.*/ - Ellipse: EnumValue; + static Ellipse: EnumValue; /**For drawing a simple straight line; a value for Geometry#type.*/ - Line: EnumValue; + static Line: EnumValue; /**For drawing a complex path made of a list of PathFigures; a value for Geometry#type.*/ - Path: EnumValue; + static Path: EnumValue; /**For drawing a rectangle; a value for Geometry#type.*/ - Rectangle: EnumValue; + static Rectangle: EnumValue; } + /** * A Margin represents a band of space outside or inside a rectangular area, * with possibly different values on each of the four sides. @@ -223,6 +2054,7 @@ declare module go { */ static stringify(val: Margin): string; } + /** * A PathFigure represents a section of a Geometry}. * It is a single connected series of @@ -251,6 +2083,7 @@ declare module go { /**Create a copy of this PathFigure, with the same values and segments.*/ copy(): PathFigure; } + /** * A PathSegment represents a straight line or curved segment of a path between * two or more points that are part of a PathFigure}. @@ -265,10 +2098,10 @@ declare module go { * @param {number=} x1 optional: the X coordinate of the first bezier control point. * @param {number=} y1 optional: the Y coordinate of the first bezier control point. * @param {number=} x2 optional: the X coordinate of the second cubic bezier control point. - * @param {number|boolean=} y2 optional: the Y coordinate of the second cubic bezier control point, + * @param {number=} y2 optional: the Y coordinate of the second cubic bezier control point, * or the large-arc-flag of an SvgArc. * @param {boolean=} clockwise optional: whether an SvgArc goes clockwise or counterclockwise.*/ - constructor(type: EnumValue, ex: number, ey: number, x1: number, y1: number, x2: number, y2: number, clockwise: boolean); + constructor(type: EnumValue, ex?: number, ey?: number, x1?: number, y1?: number, x2?: number, y2?: number, clockwise?: boolean); /**Gets or sets the center X value of the Arc for a PathSegment of type #Arc.*/ centerX: number; /**Gets or sets the center Y value of the Arc for a PathSegment of type #Arc.*/ @@ -308,18 +2141,161 @@ declare module go { /**Closes the path after this PathSegment*/ copy(): PathSegment; /**For drawing an arc segment, a value for PathSegment#type.*/ - Arc: EnumValue; + static Arc: EnumValue; /**For drawing a cubic bezier segment, a value for PathSegment#type.*/ - Bezier: EnumValue; + static Bezier: EnumValue; /**For drawing a straight line segment, a value for PathSegment#type.*/ - Line: EnumValue; + static Line: EnumValue; /**For beginning a new subpath, a value for PathSegment#type.*/ - Move: EnumValue; + static Move: EnumValue; /**For drawing a quadratic bezier segment, a value for PathSegment#type.*/ - QuadraticBezier: EnumValue; + static QuadraticBezier: EnumValue; /**For drawing an SVG arc segment, a value for PathSegment#type.*/ - SvgArc: EnumValue; + static SvgArc: EnumValue; } + + /** + * A Point represents an x- and y-coordinate pair in two-dimensional space. + */ + class Point { + /**The default constructor produces the Point(0,0). + * @param {number} x + * @param {number} y + */ + constructor(); + constructor(x: number, y: number); + /**Gets or sets the x value of the Point.*/ + x: number; + /**Gets or sets the y value of the Point.*/ + y: number; + /** + * Modify this point so that is the sum of the current Point and the + * x and y co-ordinates of the given Point. + * @param {Point} p The Point to add to this Point.*/ + add(p: Point): Point; + /**Create a copy of this Point, with the same values.*/ + copy(): Point; + /** + * This static method returns the angle in degrees of the line from point P to point Q. + * @param {number} px + * @param {number} py + * @param {number} qx + * @param {number} qy + */ + static direction(px: number, py: number, qx: number, qy: number): number; + /** + * Compute the angle from this Point to a given (px,py) point. + * However, if the point is the same as this Point, the direction is zero. + * @param {number} px + * @param {number} py*/ + direction(px: number, py: number): number; + /** + * Compute the angle from this Point to a given Point. + * However, if the given Point is the same as this Point, the direction is zero. + * @param {Point} p the other Point to which to measure the relative angle.*/ + directionPoint(p: Point): number; + /** + * This static method returns the square of the distance from the point P + * to the finite line segment from point A to point B. + * @param {number} px + * @param {number} py + * @param {number} ax + * @param {number} ay + * @param {number} bx + * @param {number} by*/ + static distanceLineSegmentSquared(px: number, py: number, ax: number, ay: number, bx: number, by: number): number; + /** + * Returns the square of the distance from this point to a given point (px, py). + * @param {number} px + * @param {number} py*/ + distanceSquared(px: number, py: number): number; + /** + * This static method returns the square of the distance from the point P to the point Q. + * @param {number} px + * @param {number} py + * @param {number} qx + * @param {number} qy*/ + static distanceSquared(px: number, py: number, qx: number, qy: number): number; + /** + * Returns the square of the distance from this Point to a given Point. + * @param {Point} p the other Point to measure to.*/ + distanceSquaredPoint(p: Point): number; + /** + * Indicates whether the given Point is equal to this Point. + * @param {Point} p The Point to compare to the current Point. + * false otherwise.*/ + equals(p: Point): boolean; + /** + * Indicates whether the given point (x, y) is equal to this Point. + * @param {number} x + * @param {number} y + * false otherwise.*/ + equalTo(x: number, y: number): boolean; + /** + * True if this Point has X and Y values that are real numbers and not infinity. + * */ + isReal(): boolean; + /** + * Modify this Point so that its X and Y values have been normalized to a unit length. + * However, if this Point is the origin (zero, zero), its length remains zero. + * */ + normalize(): Point; + /** + * Modify this point by shifting its values with the given DX and DY offsets. + * @param {number} dx + * @param {number} dy*/ + offset(dx: number, dy: number): Point; + /** + * This static method can be used to read in a Size from a string that was produced by Size.stringify. + * @param {string} str*/ + static parse(str: string): Point; + /** + * Modify this Point so that has been rotated about the origin by the given angle. + * @param {number} angle an angle in degrees.*/ + rotate(angle: number): Point; + /** + * Modify this Point so that its X and Y values have been scaled by given factors along the X and Y axes. + * @param {number} sx + * @param {number} sy*/ + scale(sx: number, sy: number): Point; + /** + * Modify this Point so that its X and Y values are the same as the given Point. + * + * @param {Point} p the given Point.*/ + set(p: Point): Point; + /** + * Modify this Point so that its X and Y values correspond to a particular Spot + * in a given Rect. + * The result is meaningless if Spot#isNoSpot is true for the given Spot. + * @param {Rect} r the Rect for which we are finding the point. + * @param {Spot} spot the Spot; Spot#isSpot must be true for this Spot.*/ + setRectSpot(r: Rect, spot: Spot): Point; + /** + * Modify this Point so that its X and Y values correspond to a particular Spot + * in a given rectangle. + * The result is meaningless if Spot#isNoSpot is true for the given Spot. + * @param {number} x The X coordinate of the Rect for which we are finding the point. + * @param {number} y The Y coordinate of the Rect for which we are finding the point. + * @param {number} w The Width of the Rect for which we are finding the point. + * @param {number} h The Height of the Rect for which we are finding the point. + * @param {Spot} spot the Spot; Spot#isSpot must be true for this Spot.*/ + setSpot(x: number, y: number, w: number, h: number, spot: Spot): Point; + /** + * Modify this Point with new X and Y values. + * @param {number} x + * @param {number} y*/ + setTo(x: number, y: number): Point; + /** + * This static method can be used to write out a Size as a string that can be read by Size.parse. + * @param {Size} val*/ + static stringify(val: Point): string; + /** + * Modify this point so that is the difference of this Point and the + * x and y co-ordinates of the given Point. + * @param {Point} p The Point to subtract from the current Point.*/ + subtract(p: Point): Point; + } + /** * A Rect describes a rectangular two-dimensional area as a top-left point (x and y values) * and a size (width and height values). @@ -335,9 +2311,16 @@ declare module go { * must be non-negative. * @param {number=} h Height to be used if x,y are specified; * must be non-negative.*/ - constructor(x: Point, y: Point); - constructor(x: Point, y: Size); constructor(x?: number, y?: number, w?: number, h?: number); + /** + * This constructor produces a new Rect that covers the two given Points. + */ + constructor(p1: Point, p2: Point); + /** + * This constructor produces a new Rect that is positioned at the given Point p + * and has a width and height given by the Size s. + */ + constructor(p: Point, s: Size); /**Gets or sets the y-axis value of the bottom of the Rect.*/ bottom: number; /**Gets or sets the Point at the center of this Rect.*/ @@ -368,7 +2351,7 @@ declare module go { * Modify this Rect by adding the given Margin to each side of the Rect. * @param {Margin} m The Margin to add to the Rect. */ - addMargin(m): Rect; + addMargin(m: Margin): Rect; /** * Indicates whether this Rect contains the given Point/Rect. * @param {number} x The X coordinate of the Point or Rect to include in the new bounds. @@ -541,152 +2524,12 @@ declare module go { unionPoint(p: Point): Rect; /** * Modify this Rect to be exactly big enough to contain this Rect and the given Rect. - * + * * @param {Rect} r The Rect to include in the new bounds. */ unionRect(r: Rect): Rect; } - /** - * A Point represents an x- and y-coordinate pair in two-dimensional space. - */ - class Point { - /**The default constructor produces the Point(0,0). - * @param {number} x - * @param {number} y - */ - constructor(); - constructor(x: number, y: number); - /**Gets or sets the x value of the Point.*/ - x: number; - /**Gets or sets the y value of the Point.*/ - y: number; - /** - * Modify this point so that is the sum of the current Point and the - * x and y co-ordinates of the given Point. - * @param {Point} p The Point to add to this Point.*/ - add(p: Point): Point; - /**Create a copy of this Point, with the same values.*/ - copy(): Point; - /** - * This static method returns the angle in degrees of the line from point P to point Q. - * @param {number} px - * @param {number} py - * @param {number} qx - * @param {number} qy - */ - static direction(px: number, py: number, qx: number, qy: number): number; - /** - * Compute the angle from this Point to a given (px,py) point. - * However, if the point is the same as this Point, the direction is zero. - * @param {number} px - * @param {number} py*/ - direction(px: number, py: number): number; - /** - * Compute the angle from this Point to a given Point. - * However, if the given Point is the same as this Point, the direction is zero. - * @param {Point} p the other Point to which to measure the relative angle.*/ - directionPoint(p: Point): number; - /** - * This static method returns the square of the distance from the point P - * to the finite line segment from point A to point B. - * @param {number} px - * @param {number} py - * @param {number} ax - * @param {number} ay - * @param {number} bx - * @param {number} by*/ - static distanceLineSegmentSquared(px: number, py: number, ax: number, ay: number, bx: number, by: number): number; - /** - * Returns the square of the distance from this point to a given point (px, py). - * @param {number} px - * @param {number} py*/ - distanceSquared(px: number, py: number): number; - /** - * This static method returns the square of the distance from the point P to the point Q. - * @param {number} px - * @param {number} py - * @param {number} qx - * @param {number} qy*/ - static distanceSquared(px: number, py: number, qx: number, qy: number): number; - /** - * Returns the square of the distance from this Point to a given Point. - * @param {Point} p the other Point to measure to.*/ - distanceSquaredPoint(p: Point): number; - /** - * Indicates whether the given Point is equal to this Point. - * @param {Point} p The Point to compare to the current Point. - * false otherwise.*/ - equals(p: boolean): number; - /** - * Indicates whether the given point (x, y) is equal to this Point. - * @param {number} x - * @param {number} y - * false otherwise.*/ - equalTo(x: number, y: number): boolean; - /** - * True if this Point has X and Y values that are real numbers and not infinity. - * */ - isReal(): boolean; - /** - * Modify this Point so that its X and Y values have been normalized to a unit length. - * However, if this Point is the origin (zero, zero), its length remains zero. - * */ - normalize(): Point; - /** - * Modify this point by shifting its values with the given DX and DY offsets. - * @param {number} dx - * @param {number} dy*/ - offset(dx: number, dy: number): Point; - /** - * This static method can be used to read in a Size from a string that was produced by Size.stringify. - * @param {string} str*/ - static parse(str: string): Point; - /** - * Modify this Point so that has been rotated about the origin by the given angle. - * @param {number} angle an angle in degrees.*/ - rotate(angle: number): Point; - /** - * Modify this Point so that its X and Y values have been scaled by given factors along the X and Y axes. - * @param {number} sx - * @param {number} sy*/ - scale(sx: number, sy: number): Point; - /** - * Modify this Point so that its X and Y values are the same as the given Point. - * - * @param {Point} p the given Point.*/ - set(p: Point): Point; - /** - * Modify this Point so that its X and Y values correspond to a particular Spot - * in a given Rect. - * The result is meaningless if Spot#isNoSpot is true for the given Spot. - * @param {Rect} r the Rect for which we are finding the point. - * @param {Spot} spot the Spot; Spot#isSpot must be true for this Spot.*/ - setRectSpot(r: Rect, spot: Spot): Point; - /** - * Modify this Point so that its X and Y values correspond to a particular Spot - * in a given rectangle. - * The result is meaningless if Spot#isNoSpot is true for the given Spot. - * @param {number} x The X coordinate of the Rect for which we are finding the point. - * @param {number} y The Y coordinate of the Rect for which we are finding the point. - * @param {number} w The Width of the Rect for which we are finding the point. - * @param {number} h The Height of the Rect for which we are finding the point. - * @param {Spot} spot the Spot; Spot#isSpot must be true for this Spot.*/ - setSpot(x: number, y: number, w: number, h: number, spot: Spot): Point; - /** - * Modify this Point with new X and Y values. - * @param {number} x - * @param {number} y*/ - setTo(x: number, y: number): Point; - /** - * This static method can be used to write out a Size as a string that can be read by Size.parse. - * @param {Size} val*/ - static stringify(val: Point): string; - /** - * Modify this point so that is the difference of this Point and the - * x and y co-ordinates of the given Point. - * @param {Point} p The Point to subtract from the current Point.*/ - subtract(p: Point): Point; - } + /** * A Size describes a width and a height in two-dimensional coordinates. * The width and height must both be non-negative. @@ -696,7 +2539,7 @@ declare module go { * @param {number} w * @param {number} h */ - constructor(); + constructor(); constructor(w: number, h: number); /**Gets or sets the height value of the Size.*/ height: number; @@ -732,10 +2575,11 @@ declare module go { setTo(w: number, h: number): Size; static stringify(val: Size): string; } - /** - * A Spot represents a relative point from(0, 0) to(1, 1) within the bounds of - * a rectangular area plus an absolute offset. - */ + + /** + * A Spot represents a relative point from(0, 0) to(1, 1) within the bounds of + * a rectangular area plus an absolute offset. + */ class Spot { /**The default constructor produces the Spot(0, 0, 0, 0), at the top-left corner. * @param {number} x @@ -744,7 +2588,7 @@ declare module go { * @param {number} offy */ constructor(); - constructor(x: number, y: number); + constructor(x: number, y: number); constructor(x: number, y: number, offx: number, offy: number); /**Gets or sets the offsetX value of the Spot.*/ offsetX: number; @@ -779,7 +2623,7 @@ declare module go { static parse(str: string): Spot; /** * Modify this Spot so that its X, Y, OffsetX, and OffsetY values are the same as the given Spot. - * + * * @param {Spot} s the given Spot.*/ set(s: Spot): Spot; /** @@ -860,6 +2704,8 @@ declare module go { /**The set of points at the top side of the bounding rectangle.*/ static TopSide: Spot; } + + /** * A Binding describes how to automatically set a property on a GraphObject} * to a value of a property of data in the model. @@ -884,7 +2730,7 @@ declare module go { /**Gets or sets the directions and frequency in which the binding may be evaluated.*/ mode: EnumValue; /**Gets or sets the name of the GraphObject that should act as a source object whose property should be gotten by this data binding.*/ - sourceName: (a: any, b?: any) => any; + sourceName: string; /**Gets or sets the name of the property to get from the bound data object, the value of Panel#data.*/ sourceProperty: string; /**Gets or sets the name of the property to be set on the target GraphObject.*/ @@ -893,7 +2739,7 @@ declare module go { * Modify this Binding to set its #mode to be Binding#TwoWay, and * provide an optional conversion function to convert GraphObject property * values back to data values. - * + * * You should not have a TwoWay binding on a node data object's key property. * @param {function(*,*=) | null=} backconv*/ makeTwoWay(backconv?: (a: any, b?: any) => any): Binding; @@ -904,14 +2750,15 @@ declare module go { * use an empty string to refer to the root panel of that visual tree.*/ ofObject(srcname?: string): Binding; /**This static method can be used to create a function that parses a string into an enumerated value, given the class that the enumeration values are defined on and a default value if the string cannot be parsed successfully.*/ - static parseEnum(ctor: (...args: any[]) => any, defval: EnumValue): (a: string) => EnumValue; + static parseEnum(ctor: () => Object, defval: EnumValue): (a: string) => EnumValue; /**This static method can be used to convert an object to a string, looking for commonly defined data properties, such as "text", "name", "key", or "id".*/ static toString(val: any): string; /**This value for Binding#mode uses data source values and sets GraphObject properties.*/ - static OneWay: EnumValue; + static OneWay: EnumValue; /**This value for Binding#mode uses data source values and GraphObject properties and keeps them in sync.*/ - static TwoWay: EnumValue; + static TwoWay: EnumValue; } + /** * A ChangedEvent represents a change to an object, typically a GraphObject, * but also for model data, a Model, or a Diagram. @@ -919,7 +2766,6 @@ declare module go { * and the before-and-after values for that property. * You can listen for changed events on the model using Model#addChangedListener * and on the Diagram using Diagram#addChangedListener. - * */ class ChangedEvent { /**The ChangedEvent class constructor produces an empty ChangedEvent object.*/ @@ -947,7 +2793,7 @@ declare module go { /**This predicate returns true if you can call redo().*/ canRedo(): boolean; /**This predicate returns true if you can call undo().*/ - canUndo: boolean; + canUndo(): boolean; /**Forget any object references that this ChangedEvent may have.*/ clear(); /**Make a copy of this ChangedEvent.*/ @@ -967,14 +2813,15 @@ declare module go { /**Reverse the effects of this object change.*/ undo(); /**For inserting into collections, and used as the value for ChangedEvent#change.*/ - static Insert: EnumValue; + static Insert: EnumValue; /**For simple property changes, and used as the value for ChangedEvent#change.*/ - static Property: EnumValue; + static Property: EnumValue; /**For removing from collections, and used as the value for ChangedEvent#change.*/ - static Remove: EnumValue; + static Remove: EnumValue; /**For informational events, such as transactions and undo/redo operations, and used as the value for ChangedEvent#change.*/ - static Transaction: EnumValue; + static Transaction: EnumValue; } + /** * GraphLinksModels support links between nodes and grouping nodes and links into subgraphs. * GraphLinksModels hold node data and link data in separate arrays. @@ -987,11 +2834,11 @@ declare module go { * @param {Array=} nodedataarray an optional Array containing JavaScript objects to be represented by Nodes. * @param {Array=} linkdataarray an optional Array containing JavaScript objects to be represented by Links. */ - constructor(nodedataarray?: Array[], linkdataarray?: Array[]); + constructor(nodedataarray?: Array, linkdataarray?: Array); /**Gets or sets a data object that will be copied and added to the model as a new node data each time there is a link reference (either the "to" or the "from" of a link data) to a node key that does not yet exist in the model.*/ archetypeNodeData: Object; /**Gets or sets a function that makes a copy of a link data object.*/ - copyLinkDataFunction: (obj: Object, a: GraphLinksModel) => any; + copyLinkDataFunction: (obj: Object, model: GraphLinksModel) => Object; /**Gets or sets the name of the data property that returns a string describing that data's category, or a function that takes a link data object and returns that category string; the default value is the name 'category'.*/ linkCategoryProperty: any; /**Gets or sets the array of link data objects that correspond to Links in the Diagram.*/ @@ -1007,7 +2854,7 @@ declare module go { */ linkFromKeyProperty: any; /**Gets or sets the name of the data property that returns the optional parameter naming a "port" element on the node that the link data is connected from, or a function that takes a link data object and returns that string.*/ - linkFromPortIdProperty: any; + linkFromPortIdProperty: any; /**Gets or sets the name of the data property that returns an array of keys of node data that are labels on that link data, or a function that takes a link data object and returns such an array; the default value is the empty string: ''.*/ linkLabelKeysProperty: any; /**Gets or sets the name of the data property that returns the key of the node data that the link data is going to, or a function that takes a link data object and returns that key; the default value is the name 'to'.*/ @@ -1046,7 +2893,7 @@ declare module go { * to data that does not share certain data structures between the original link data and the copied link data. * The value may be null in order to cause #copyLinkData to make a shallow copy of a JavaScript Object. * The default value is null.*/ - copyLinkData:(linkdata: Object)=> Object; + copyLinkData(linkdata: Object): Object; /** * Find the category of a given link data, a string naming the link template * that the Diagram should use to represent the link data. @@ -1070,7 +2917,7 @@ declare module go { * Gets an Array of node key values that identify node data acting as labels on the given link data. * This method only works if #linkLabelKeysProperty has been set to something other than an empty string. * @param {Object} linkdata a JavaScript object representing a link.*/ - getLabelKeysForLinkData(linkdata: Object): Array; + getLabelKeysForLinkData(linkdata: Object): Array; /** * From a link data retrieve a value uniquely identifying the node data * to which this link is connected. @@ -1107,7 +2954,7 @@ declare module go { * This will remove that data from the #linkDataArray and * notify all listeners that a link data object has been removed from the collection. * Removing a link data from a model does not automatically remove - * any associated label node data from the model. + * any associated label node data from the model. * This operation does nothing if the link data is not present in the #linkDataArray. * @param {Object} linkdata a JavaScript object representing a link.*/ removeLinkData(linkdata: Object); @@ -1126,7 +2973,7 @@ declare module go { * @param {Object} linkdata a JavaScript object representing a link. * @param {number|string|undefined} key This may be undefined if * the link should no longer come from any node.*/ - setFromKeyForLinkData(linkdata: Object, cat: string); + setFromKeyForLinkData(linkdata: Object, key: any); /** * Change the information that the given link data uses to identify the * particular "port" that the link is coming from. @@ -1144,14 +2991,14 @@ declare module go { * This method only works if #linkLabelKeysProperty has been set to something other than an empty string. * @param {Object} linkdata a JavaScript object representing a link. * @param arr an Array of node keys; an empty Array if the property was not present.*/ - setLabelKeysForLinkData(linkdata: Object, arr: Array); + setLabelKeysForLinkData(linkdata: Object, arr: Array); /** * Change the node key that the given link data references as the * destination of the link. * @param {Object} linkdata a JavaScript object representing a link. * @param {number|string|undefined} key This may be undefined if * the link should no longer go to any node.*/ - setToKeyForLinkData(linkdata: Object, key: Array); + setToKeyForLinkData(linkdata: Object, key: any); /** * Change the information that the given link data uses to identify the * particular "port" that the link is going to. @@ -1160,6 +3007,7 @@ declare module go { * the link should no longer be associated with any particular "port".*/ setToPortIdForLinkData(linkdata: Object, portname: string); } + /* * Models hold the essential data of a diagram, describing the basic entities and their properties and relationships * without specifying the appearance and behavior of the Nodes and Links and Groups that represent them visually. @@ -1169,15 +3017,15 @@ declare module go { /**You probably don't want to call this constructor, because this class does not support links (relationships between nodes) or groups (nodes and links and subgraphs as nodes): instead, create instances of a subclass such as GraphLinksModel or TreeModel. * @param {Array=} nodedataarray an optional Array containing JavaScript objects to be represented by {@link Part}s. */ - constructor(nodedataarray?: Array[]); + constructor(nodedataarray?: Array); /**Gets or sets a function that makes a copy of a node data object.*/ - copyNodeDataFunction: (obj: Object, model: Model) => Object; + copyNodeDataFunction: (obj: Object, model: Model) => Object; /**Gets or sets the name of the format of the diagram data.*/ dataFormat: string; /**Gets or sets whether this model may be modified, such as adding nodes.*/ isReadOnly: boolean; /**Gets or sets a function that returns a unique id number or string for a node data object.*/ - makeUniqueKeyFunction: (model: Model, obj:Object)=>any; + makeUniqueKeyFunction: (model: Model, obj:Object) => any; /**Gets or sets the name of this model.*/ name: string; /**Gets or sets the name of the node data property that returns a string describing that data's category, or a function that takes a node data object and returns the category name; the default value is the name 'category'.*/ @@ -1200,9 +3048,9 @@ declare module go { addArrayItem(arr: Array, val: any); /** * Register an event handler that is called when there is a ChangedEvent. - * This registration does not raise a ChangedEvent. + * This registration does not raise a ChangedEvent. * @param {function(ChangedEvent)} listener a function that takes a ChangedEvent as its argument.*/ - addChangedListener(listener: (a: ChangedEvent)=>any); + addChangedListener(listener: (e: ChangedEvent)=>void); /** * When you want to add a node or group to the diagram, * call this method with a new data object. @@ -1236,6 +3084,7 @@ declare module go { * that uses the given value as its unique key. * @param {*} key a string or a number.*/ findNodeDataForKey(key: any): Object; + /**This static method parses a string in JSON format and constructs, initializes, and returns a model.*/ static fromJson(s: any, model?: Model): Model; /** * Find the category of a given node data, a string naming the node template @@ -1312,7 +3161,7 @@ declare module go { * This deregistration does not raise a ChangedEvent. * @param {function(ChangedEvent)} listener a function that takes a ChangedEvent as its argument. */ - removeChangedListener(listener: (a:ChangedEvent)=>any); + removeChangedListener(listener: (e:ChangedEvent) => void); /** * When you want to remove a node or group from the diagram, * call this method with an existing data object. @@ -1393,6 +3242,7 @@ declare module go { */ updateTargetBindings(data: Object, srcpropname?: string); } + /** * A Transaction holds a list of ChangedEvent}s collected during a transaction, * as the value of the read-only #changes} property. @@ -1417,6 +3267,7 @@ declare module go { /**Undo all of the changes, in reverse order.*/ undo(); } + /** * TreeModels support tree-structured graphs of nodes and links. * Each node can have at most one "tree parent"; cycles are not permitted. @@ -1425,7 +3276,7 @@ declare module go { class TreeModel extends Model { /**This constructs an empty TreeModel unless one provides arguments as the initial data array values for the Model#nodeDataArray property. * @param {Array= } nodedataarray an optional Array containing JavaScript objects to be represented by Nodes.*/ - constructor(nodedataarray?: Array); + constructor(nodedataarray?: Array); /**Gets or sets the name of the property on node data that specifies the string or number key of the node data that acts as the "parent" for this "child" node data, or a function that takes a node data object and returns that parent key; the default value is the name 'parent'.*/ nodeParentKeyProperty: any; /**Gets or sets the name of the data property that returns a string describing that node data's parent link's category, or a function that takes a node data object and returns its parent link's category string; the default value is the name 'parentLinkCategory'.*/ @@ -1447,7 +3298,7 @@ declare module go { /** * Change the category for the parent link of a given child node data, a string naming the link template * that the Diagram should use to represent the link. - * + * * Changing the link template will cause any existing Link * to be removed from the Diagram and replaced with a new Link * created by copying the new link template and applying any data-bindings. @@ -1455,6 +3306,7 @@ declare module go { * @param {string} cat Must not be null.*/ setParentLinkCategoryForNodeData(childdata: Object, cat: string); } + /** * A Transaction holds a list of ChangedEvent}s collected during a transaction, * as the value of the read-only #changes} property. @@ -1486,6 +3338,7 @@ declare module go { transactionToRedo: Transaction; /**Gets the Transaction in the #history to be undone next.*/ transactionToUndo: Transaction; + /**Make sure this UndoManager knows about a Model for which it may receive ChangedEvents when the given Model is changed.*/ addModel(model: Model); /**This predicate returns true if you can call #redo.*/ canRedo(): boolean; @@ -1555,6 +3408,8 @@ declare module go { /**Reverse the effects of this object change.*/ undo(); } + + /** * This layout positions nodes in a circular arrangement. * This layout makes use of a LayoutNetwork of @@ -1577,7 +3432,7 @@ declare module go { /**Gets or sets the ratio of the arrangement's height to its width (1 for a circle, >1 for a vertically elongated ellipse).*/ aspectRatio: number; /**Gets or sets the comparer which sorts the data when #sorting is set to CircularLayout#Ascending or CircularLayout#Descending.*/ - comparer: any; + comparer: (a: CircularVertex, b: CircularVertex) => number; /**Gets or sets whether the nodes are arranged clockwise or counterclockwise.*/ direction: EnumValue; /**Specifies how the diameter of nodes will be calculated.*/ @@ -1637,6 +3492,21 @@ declare module go { /**Nodes are arranged in the reverse of the order given; This value is used for CircularLayout#sorting.*/ static Reverse: EnumValue; } + + /** This holds {@link CircularLayout}-specific information about {@link Link} s.*/ + class CircularEdge extends LayoutEdge { + constructor(); + } + + /** This holds {@link CircularLayout}-specific information about {@link Node}s.*/ + class CircularVertex extends LayoutVertex { + constructor(); + /**Gets or sets the value used as the vertex's angle.*/ + actualAngle: number; + /**Gets or sets the value used as the vertex's diameter.*/ + diameter: number; + } + /** * Force-directed layout treats the graph as if it were a system of physical * bodies with forces acting on them and between them. @@ -1679,7 +3549,7 @@ declare module go { /**Commit the position and routing of all edge links.*/ commitLinks(); /**Commit the position of all vertex nodes.*/ - commiteNodes(); + commitNodes(); /**Create a new LayoutNetwork of ForceDirectedVertexes and ForceDirectedEdges.*/ createNetwork(): LayoutNetwork; /** @@ -1697,7 +3567,7 @@ declare module go { electricalCharge(v: ForceDirectedVertex): number; /** * Returns the electrical field in the X direction acting on a vertex at the given point. - * + * * Used to define an external electrical field at a point * independent of the vertex charges. * A vertex L is acted upon by a force in the X direction of magnitude @@ -1706,7 +3576,7 @@ declare module go { electricalFieldX(x: number, y: number): number; /** * Returns the electrical field in the Y direction acting on a vertex at the given point. - * + * * Used to define an external electrical field at a point * independent of the vertex charges. * A vertex L is acted upon by a force in the Y direction of magnitude @@ -1715,7 +3585,7 @@ declare module go { electricalFieldY(x: number, y: number): number; /** * This returns the gravitational field in the X direction acting on a vertex at the given point. - * + * * Used to define an external gravitational field at a point * independent of the vertex masses. * A vertex L is acted upon by a force in the X direction of magnitude @@ -1724,7 +3594,7 @@ declare module go { gravitationalFieldX(x: number, y: number): number; /** * This returns the gravitational field in the Y direction acting on a vertex at the given point. - * + * * Used to define an external gravitational field at a point * independent of the vertex masses. * A vertex L is acted upon by a force in the Y direction of magnitude @@ -1754,81 +3624,17 @@ declare module go { * @param {ForceDirectedEdge} e*/ springStiffness(e: ForceDirectedEdge): number; } - /** A vertex represents a node in a LayoutNetwork. - * It holds layout - specific data for the node.*/ - class LayoutVertex { - /** This constructs a vertex that does not know about any Node.*/ + + /** This holds {@link ForceDirectedLayout}-specific information about {@link Link}s.*/ + class ForceDirectedEdge extends LayoutEdge { constructor(); - /**Gets or sets the Bounds of this vertex, in document coordinates.*/ - bounds: Rect; - /**Gets or sets the center Point.x of this vertex, in document coordinates.*/ - centerX: number; - /**Gets or sets the center Point.y of this vertex, in document coordinates.*/ - centerY: number; - /**Gets an iterator for all of the edges that go out of this vertex.*/ - destinationEdges: Iterator; - /**Gets an iterator for all of the vertexes that are connected with edges going out of this vertex.*/ - destinationVertexes: Iterator; - /**Gets an iterator for all of the edges that are connected with this vertex in either direction.*/ - edges: Iterator; - /**Gets the total number of edges that are connected with this vertex in either direction.*/ - edgesCount: number; - /**Gets or sets the offset of the #centerX and #centerY from the #bounds position.*/ - focus: Point; - /**Gets or sets the relative X position of the "center" point, the focus.*/ - focusX: number; - /**Gets or sets the relative Y position of the "center" point, the focus.*/ - focusY: number; - /**Gets or sets the height of this vertex.*/ - height: number; - /**Gets or sets the LayoutNetwork that owns this vertex.*/ - network: LayoutNetwork; - /**Gets or sets the Node associated with this vertex, if any.*/ - node: Node; - /**Gets an iterator for all of the edges that come into this vertex.*/ - sourceEdges: Iterator; - /**Gets an iterator for all of the vertexes that are connected with edges coming into this vertex.*/ - sourceVertexes: Iterator; - /**Gets an iterator for all of the vertexes that are connected in either direction with this vertex.*/ - vertexes: Iterator; - /**Gets or sets the width of this vertex.*/ - width: number; - /**Gets or sets the left point of this vertex.*/ - x: number; - /**Gets or sets the top point of this vertex.*/ - y: number; - /**Adds a LayoutEdge to the list of successors (the edge will be going out from this vertex). - * @param {LayoutEdge} edge - */ - addDestinationEdge(edge: LayoutEdge); - /**Adds a LayoutEdge to the list of predecessors (the edge will be coming into this vertex). - * @param {LayoutEdge} edge - */ - addSourceEdge(edge: LayoutEdge); - /**Moves the Node corresponding to this vertex so that its position is at the current #bounds point.*/ - commit(); - /**Deletes a LayoutEdge from the list of successors (the edge was going out from this vertex). - * @param {LayoutEdge} edge - */ - deleteDestinationEdge(edge: LayoutEdge); - /**Deletes a LayoutEdge from the list of predecessors (the edge was coming into this vertex). - * @param {LayoutEdge} edge - */ - deleteSourceEdge(edge: LayoutEdge); - /**This static method is used to compare the Part#text values of the #nodes of the argument LayoutVertexes. - * @param {LayoutVertex} m - * @param {LayoutVertex} n*/ - static smartComparer(m: LayoutVertex, n: LayoutVertex): number; - /**This static method is used to compare the Part#text values of the #nodes of the argument LayoutVertexes. - * @param {LayoutVertex} m - * @param {LayoutVertex} n*/ - static standardComparer(m: LayoutVertex, n: LayoutVertex): number; + /**Gets or sets the length of this edge.*/ + length: number; + /**Gets or sets this edge's stiffness or resistence to compression or stretching.*/ + stiffness: number; } - /** Force - directed layout treats the graph as if it were a system of physical - * bodies with forces acting on them and between them. - * The algorithm seeks a configuration of the bodies with locally minimal energy, - * i.e.vertex positions such that the sum of the forces on each vertex is zero. - */ + + /** This holds {@link ForceDirectedLayout}-specific information about {@link Node}s.*/ class ForceDirectedVertex extends LayoutVertex { constructor(); /**Gets or sets the electrical charge for this vertex.*/ @@ -1842,32 +3648,7 @@ declare module go { /**Gets or sets the gravitational mass for this vertex.*/ mass: number; } - class LayoutEdge { - /**This constructs an edge that does not know about any Link.*/ - constructor(); - /**Gets or sets the LayoutVertex that this edge comes from.*/ - fromVertex: LayoutVertex; - /**Gets or sets the Link associated with this edge, if any.*/ - link: Link; - /**Gets or sets the LayoutNetwork that owns this edge.*/ - network: LayoutNetwork; - /**Gets or sets the LayoutVertex that this edge goes to.*/ - toVertex: LayoutVertex; - /**Commits the route of this edge to the corresponding Link, if any.*/ - commit(); - /**Returns the edge's vertex at the other of this edge from the given vertex. - * @param {LayoutVertex} v - */ - getOtherVertex(v: LayoutVertex); - } - /** This holds {@link ForceDirectedLayout} -specific information about {@link Link} s.*/ - class ForceDirectedEdge extends LayoutEdge { - constructor(); - /**Gets or sets the length of this edge.*/ - length: number; - /**Gets or sets this edge's stiffness or resistence to compression or stretching.*/ - stiffness: number; - } + /** * This simple layout places all of the Parts in a grid-like arrangement, ordered, spaced apart, * and wrapping as needed. It ignores any Links connecting the Nodes being laid out. @@ -1884,7 +3665,7 @@ declare module go { /**Gets or sets the minimum part size by which each part is positioned in the grid.*/ cellSize: Size; /**Gets or sets the comparison function used to sort the parts.*/ - comparer: (a:Part, b:Part)=>number; + comparer: (a:Part, b:Part) => number; /**Gets or sets what order to place the parts.*/ sorting: EnumValue; /**Gets or sets the minimum horizontal and vertical space between parts.*/ @@ -1917,6 +3698,7 @@ declare module go { /**Fill each row from right to left; This value is used for GridLayout#arrangement.*/ static RightToLeft: EnumValue; } + /** * This arranges nodes into layers. * The method uses a hierarchical approach @@ -2006,6 +3788,41 @@ declare module go { /**This option tries to have the packing algorithm straighten many of the links that cross layers, a valid value for LayeredDigraphLayout#packOption.*/ static PackStraighten: number; } + + /** This holds {@link LayeredDigraphLayout}-specific information about {@link Link} s.*/ + class LayeredDigraphEdge extends LayoutEdge { + constructor(); + /**True if the link is part of the depth first forest.*/ + forest: boolean; + /**Approximate column offset of the from port of the link from the from node column used in straightening.*/ + portFromColOffset: number; + /**Location of the port at the from node of the link.*/ + portFromPos: number; + /**Approximate column offset of the to port of the link from the to node column used in straightening.*/ + portToColOffset: number; + /**Location of the port at the to node of the link.*/ + portToPos: number; + /**True if the link was reversed during cycle removal.*/ + rev: boolean; + /**True if the link is part of the proper digraph.*/ + valid: boolean; + } + + /** This holds {@link LayeredDigraphLayout}-specific information about {@link Node}s.*/ + class LayeredDigraphVertex extends LayoutVertex { + constructor(); + /**The column to which the node is assigned.*/ + column: number; + /**The connected component to which the node is assigned.*/ + component: number; + /**The index to which the node is assigned.*/ + index: number; + /**The layer to which the node is assigned.*/ + layer: number; + /**Another LayeredDigraphVertex in the same layer that this node should be near.*/ + near: LayeredDigraphVertex; + } + /** * This is the base class for all of the predefined diagram layout implementations. * They only arrange Part}s (primarily Node}s and Link}s) in a Diagram}, @@ -2037,7 +3854,7 @@ declare module go { /**When using a LayoutNetwork, commit changes to the diagram by setting Node positions and by routing the Links.*/ commitLayout(); /**Creates a copy of this Layout and returns it.*/ - copy(); + copy(): Layout; /**Create a new LayoutNetwork of LayoutVertexes and LayoutEdges.*/ createNetwork(): LayoutNetwork; /**Position all of the nodes that do not have an assigned Part#location in the manner of a simple rectangular array. @@ -2051,12 +3868,15 @@ declare module go { /**Create and initialize a LayoutNetwork with the given nodes and links. * @param {Diagram|Group|Iterable} coll A Diagram or a Group or a collection of Parts. */ - makeNetwork(coll: any); + makeNetwork(coll: Diagram): LayoutNetwork; + makeNetwork(coll: Group): LayoutNetwork; + makeNetwork(coll: Iterable): LayoutNetwork; /**When using a LayoutNetwork, update the "physical" node positionings and link routings.*/ updateParts(); } + /** - * This provides an abstract view of a diagram as a + * This provides an abstract view of a diagram as a * network (graph) of vertexes and directed edges. * The network contains vertexes and edges corresponding to Node}s and Link}s. */ @@ -2064,11 +3884,11 @@ declare module go { /**This constructs an empty network.*/ constructor(); /**Gets a collection of all of the LayoutEdges in this network.*/ - edges: Iterable; + edges: Set; /**Gets the Layout that uses this network of LayoutVertexes and LayoutEdges.*/ layout: Layout; /**Gets a collection of all of the LayoutVertexes in this network.*/ - vertexes: Iterable; + vertexes: Set; /**Adds a LayoutEdge to the network. * @param {LayoutEdge} edge*/ addEdge(edge: LayoutEdge); @@ -2120,6 +3940,97 @@ declare module go { /**Modify this network by splitting it up into separate subnetworks, each of which has all of its vertexes connected to each other, but not to any vertexes in any other subnetworks.*/ splitIntoSubNetworks(): Iterable; } + + /** An edge represents a link in a LayoutNetwork. It holds layout-specific data for the link. */ + class LayoutEdge { + /**This constructs an edge that does not know about any Link.*/ + constructor(); + /**Gets or sets the LayoutVertex that this edge comes from.*/ + fromVertex: LayoutVertex; + /**Gets or sets the Link associated with this edge, if any.*/ + link: Link; + /**Gets or sets the LayoutNetwork that owns this edge.*/ + network: LayoutNetwork; + /**Gets or sets the LayoutVertex that this edge goes to.*/ + toVertex: LayoutVertex; + /**Commits the route of this edge to the corresponding Link, if any.*/ + commit(); + /**Returns the edge's vertex at the other of this edge from the given vertex. + * @param {LayoutVertex} v + */ + getOtherVertex(v: LayoutVertex); + } + + /** A vertex represents a node in a LayoutNetwork. It holds layout-specific data for the node. */ + class LayoutVertex { + /** This constructs a vertex that does not know about any Node.*/ + constructor(); + /**Gets or sets the Bounds of this vertex, in document coordinates.*/ + bounds: Rect; + /**Gets or sets the center Point.x of this vertex, in document coordinates.*/ + centerX: number; + /**Gets or sets the center Point.y of this vertex, in document coordinates.*/ + centerY: number; + /**Gets an iterator for all of the edges that go out of this vertex.*/ + destinationEdges: Iterator; + /**Gets an iterator for all of the vertexes that are connected with edges going out of this vertex.*/ + destinationVertexes: Iterator; + /**Gets an iterator for all of the edges that are connected with this vertex in either direction.*/ + edges: Iterator; + /**Gets the total number of edges that are connected with this vertex in either direction.*/ + edgesCount: number; + /**Gets or sets the offset of the #centerX and #centerY from the #bounds position.*/ + focus: Point; + /**Gets or sets the relative X position of the "center" point, the focus.*/ + focusX: number; + /**Gets or sets the relative Y position of the "center" point, the focus.*/ + focusY: number; + /**Gets or sets the height of this vertex.*/ + height: number; + /**Gets or sets the LayoutNetwork that owns this vertex.*/ + network: LayoutNetwork; + /**Gets or sets the Node associated with this vertex, if any.*/ + node: Node; + /**Gets an iterator for all of the edges that come into this vertex.*/ + sourceEdges: Iterator; + /**Gets an iterator for all of the vertexes that are connected with edges coming into this vertex.*/ + sourceVertexes: Iterator; + /**Gets an iterator for all of the vertexes that are connected in either direction with this vertex.*/ + vertexes: Iterator; + /**Gets or sets the width of this vertex.*/ + width: number; + /**Gets or sets the left point of this vertex.*/ + x: number; + /**Gets or sets the top point of this vertex.*/ + y: number; + /**Adds a LayoutEdge to the list of successors (the edge will be going out from this vertex). + * @param {LayoutEdge} edge + */ + addDestinationEdge(edge: LayoutEdge); + /**Adds a LayoutEdge to the list of predecessors (the edge will be coming into this vertex). + * @param {LayoutEdge} edge + */ + addSourceEdge(edge: LayoutEdge); + /**Moves the Node corresponding to this vertex so that its position is at the current #bounds point.*/ + commit(); + /**Deletes a LayoutEdge from the list of successors (the edge was going out from this vertex). + * @param {LayoutEdge} edge + */ + deleteDestinationEdge(edge: LayoutEdge); + /**Deletes a LayoutEdge from the list of predecessors (the edge was coming into this vertex). + * @param {LayoutEdge} edge + */ + deleteSourceEdge(edge: LayoutEdge); + /**This static method is used to compare the Part#text values of the #nodes of the argument LayoutVertexes. + * @param {LayoutVertex} m + * @param {LayoutVertex} n*/ + static smartComparer(m: LayoutVertex, n: LayoutVertex): number; + /**This static method is used to compare the Part#text values of the #nodes of the argument LayoutVertexes. + * @param {LayoutVertex} m + * @param {LayoutVertex} n*/ + static standardComparer(m: LayoutVertex, n: LayoutVertex): number; + } + /** * This layout positions nodes in a tree-like arrangement. */ @@ -2143,7 +4054,7 @@ declare module go { /**Gets or sets how closely to pack the child nodes of a subtree.*/ alternateCompaction: EnumValue; /**Gets or sets the default comparison function used for sorting.*/ - alternateComparer: (a:TreeVertex, b:TreeVertex)=>number; + alternateComparer: (a:TreeVertex, b:TreeVertex) => number; /**Gets or sets the object holding the default values for alternate layer TreeVertexes, used when the #treeStyle is #StyleAlternating or #StyleLastParents.*/ alternateDefaults: TreeVertex; /**Gets or sets the distance between a parent node and its children.*/ @@ -2185,7 +4096,7 @@ declare module go { /**Gets or sets how closely to pack the child nodes of a subtree.*/ compaction: EnumValue; /**Gets or sets the default comparison function used for sorting.*/ - comparer: (a:TreeVertex, b:TreeVertex)=>number; + comparer: (a:TreeVertex, b:TreeVertex) => number; /**Gets or sets the distance between a parent node and its children.*/ layerSpacing: number; /**Gets or sets the fraction of the node's depth for which the children's layer starts overlapped with the parent's layer.*/ @@ -2244,10 +4155,6 @@ declare module go { * @param {LayoutVertex} v */ layoutComments(v: LayoutVertex); - /**Create and initialize a TreeNetwork with the given nodes and links. - * @param {Diagram|Group|Iterable} coll A Diagram or a Group or a collection of Parts. - */ - makeNetwork(coll: any): LayoutNetwork; /**The children are positioned in a bus, only on the bottom or right side of the parent; This value is used for TreeLayout#alignment or TreeLayout#alternateAlignment.*/ static AlignmentBottomRightBus: EnumValue; /**The children are positioned in a bus on both sides of an "aisle" where the links to them go, with the last odd child (if any) placed at the end of the aisle in the middle.*/ @@ -2297,9 +4204,17 @@ declare module go { /**All of the nodes get the alternate properties, except the root node gets the default properties; This value is used for TreeLayout#treeStyle.*/ static StyleRootOnly: EnumValue; } - /** - * This holds TreeLayout-specific information about Nodes. - */ + + /** This holds {@link TreeLayout}-specific information about {@link Link}s.*/ + class TreeEdge extends LayoutEdge { + constructor(); + /**Gets or sets a Point, relative to the parent node, that may be useful in routing this link.*/ + relativePoint: Point; + /**Commits the position of the Link and routes it.*/ + commit(); + } + + /** This holds {@link TreeLayout}-specific information about {@link Node}s.*/ class TreeVertex extends LayoutVertex { constructor(); /**Gets or sets how this parent node should be aligned relative to its children.*/ @@ -2323,7 +4238,7 @@ declare module go { /**Gets or sets how the children of this node should be packed together.*/ compaction: EnumValue; /**Gets or sets how the children should be sorted.*/ - comparer: any; + comparer: (a: TreeVertex, b: TreeVertex) => number; /**Gets or sets the number of descendants this node has.*/ descendantCount: number; /**Gets or sets whether this node has been initialized as part of TreeLayout#doLayout when building the tree structures.*/ @@ -2370,6 +4285,8 @@ declare module go { */ copyInheritedPropertiesFrom(copy: TreeVertex); } + + /** * The ActionTool is responsible for handling and dispatching mouse events on GraphObjects * that have GraphObject#isActionable set to true. @@ -2390,6 +4307,7 @@ declare module go { /**Calls the GraphObject#actionUp event if defined, then effectively calls Tool#standardMouseClick to perform the normal click behaviors, and then stops this tool.*/ doMouseUp(); } + /** * The ClickCreatingTool lets the user create a node by clicking where they want the new node to be. * By default a double-click is required to start this tool; @@ -2411,6 +4329,7 @@ declare module go { */ insertPart(loc: Point): Part; } + /** * The ClickSelectingTool selects and deselects Parts when there is a click. * It does this by calling Tool#standardMouseSelect. @@ -2423,8 +4342,9 @@ declare module go { /**This tool can run when there was a click.*/ canStart(): boolean; /**Upon a click, this calls Tool#standardMouseSelect to change the Diagram#selection collection, then calls Tool#standardMouseClick to perform the normal click behaviors, and then stops this tool.*/ - doMouseUp(); + doMouseUp(); } + /** * The ContextMenuTool is used to create and show a context menu. * It automatically disables any browser context menu. @@ -2457,6 +4377,7 @@ declare module go { /**Show a series of HTML elements acting as a context menu.*/ showDefaultContextMenu(); } + /** * The DraggingTool is used to move or copy selected parts with the mouse. * Dragging the selection moves parts for which Part#canMove is true. @@ -2494,11 +4415,12 @@ declare module go { * @param {Iterable} parts A Set or List of Parts. */ computeEffectiveCollection(parts: Iterable): Map; - /**This method computes the new location for a Node or simple Part, given a new desired location and an optional Map of dragged parts, taking any grid-snapping into consideration, any Part#dragComputation function, and any Part#minLocation and Part#maxLocation.* @param {Node} n + /**This method computes the new location for a Node or simple Part, given a new desired location and an optional Map of dragged parts, taking any grid-snapping into consideration, any Part#dragComputation function, and any Part#minLocation and Part#maxLocation. + * @param {Part} n * @param {Point} newloc * @param {Map=} draggedparts an optional Map mapping Parts to JavaScript Objects that have a "point" property remembering the original location of that Part. * @param {Point=} result an optional Point that is modified and returned*/ - computeMove(n: Node, newloc: Point, draggedparts?: Map, result?: Point): Point; + computeMove(n: Part, newloc: Point, draggedparts?: Map, result?: Point): Point; /**Start the dragging operation.*/ doActivate(); /**Abort any dragging operation.*/ @@ -2531,8 +4453,6 @@ declare module go { doMouseUp(); /**Return the selectable and movable/copyable Part at the mouse-down point.*/ findDraggablePart(): Part; - /**Stop the dragging operation by stopping the transaction and cleaning up any temporary state.*/ - localDeactivate(); /**This predicate is true when the diagram allows objects to be copied and inserted, and some object in the selection is copyable, and the user is holding down the Control key.*/ mayCopy(): boolean; /**This predicate is true when the diagram allows objects to be moved, and some object in the selection is movable.*/ @@ -2545,6 +4465,7 @@ declare module go { /**This override prevents the Control modifier unselecting an already selected part.*/ standardMouseSelect(); } + /** * The DragSelectingTool lets the user select multiple parts with a rectangular area. * There is a temporary part, the #box, @@ -2578,46 +4499,7 @@ declare module go { *@param {Rect} r*/ selectInRect(r: Rect); } - /** - * This abstract class is the base class for the LinkingTool and RelinkingTool classes. - * This class includes properties for defining and accessing any temporary nodes and temporary link - * that are used during any linking operation, as well as access to the existing diagram's nodes and link - * (if any) that are involved with the linking operation. - */ - class LinkingTool extends LinkingBaseTool { - /**You do not normally need to create an instance of this tool because one already exists as the ToolManager#linkingTool, which you can modify.*/ - constructor(); - /**Gets or sets an optional node data object representing a link label, that is copied by #insertLink and added to the GraphLinksModel when creating a new Link.*/ - archetypeLabelNodeData: Object; - /**Gets or sets a data object that is copied by #insertLink and added to the GraphLinksModel when creating a new Link.*/ - archetypeLinkData: Object; - /**Gets or sets the direction in which new links may be drawn.*/ - direction: EnumValue; - /**Gets or sets the GraphObject at which #findLinkablePort should start its search.*/ - startObject: GraphObject; - /**This tool can run when the diagram allows linking, the model is modifiable, the left-button mouse drag has moved far enough away to not be a click, and when #findLinkablePort has returned a valid port.*/ - canStart(): boolean; - /**Start the linking operation.*/ - doActivate(); - /**Finishing the linking operation stops the transaction, releases the mouse, and resets the cursor.*/ - doDeactivate(); - /**A mouse-up ends the linking operation; if there is a valid #targetPort nearby, this adds a new Link by calling #insertLink.*/ - doMouseUp(); - /**Return the GraphObject at the mouse-down point, if it is part of a node and if it is valid to link with it.*/ - findLinkablePort(): GraphObject; - /**Make a copy of the #archetypeLinkData, set its node and port properties, and add it to the model. - * @param {Node} fromnode - * @param {GraphObject} fromport - * @param {Node} tonode - * @param {GraphObject} toport*/ - insertLink(fromnode: Node, fromport: GraphObject, tonode: Node, toport: GraphObject): Link; - /**This value for LinkingTool#direction indicates that users may draw new links backwards only (i.e.*/ - static BackwardsOnly: EnumValue; - /**This value for LinkingTool#direction indicates that users may draw new links in either direction.*/ - static Either: EnumValue; - /**This value for LinkingTool#direction indicates that users may draw new links forwards only (i.e.*/ - static ForwardsOnly: EnumValue; - } + /** * This abstract class is the base class for the LinkingTool and RelinkingTool classes. */ @@ -2627,7 +4509,7 @@ declare module go { /**Gets whether the linking operation is in the forwards direction, connecting from the "From" port to the "To" port.*/ isForwards: boolean; /**Gets or sets a predicate that determines whether or not a new link between two ports would be valid.*/ - linkValidation: any; + linkValidation: (fromNode: Node, fromPort: GraphObject, toNode: Node, toPort: GraphObject, link: Link) => boolean; /**Gets or sets the original Node from which the new link is being drawn or from which the #originalLink was connected when being relinked.*/ originalFromNode: Node; /**Gets or sets the GraphObject that is the port in the #originalFromNode.*/ @@ -2641,7 +4523,7 @@ declare module go { /**Gets or sets the distance at which link snapping occurs.*/ portGravity: number; /**Gets or sets a function that is called as the tool targets the nearest valid port.*/ - portTargeted: (a:Node, b:GraphObject, c:Node, d:GraphObject, e:boolean)=>any; + portTargeted: (realNode: Node, realPort: GraphObject, tempNode: Node, tempPort: GraphObject, toend: boolean) => void; /**Gets or sets a proposed GraphObject port for connecting a link.*/ targetPort: GraphObject; /**Gets or sets the temporary Node at the "from" end of the #temporaryLink while the user is drawing or reconnecting a link.*/ @@ -2711,6 +4593,48 @@ declare module go { * @param {boolean} toend*/ setNoTargetPortProperties(tempnode: Node, tempport: GraphObject, toend: boolean); } + + /** + * This abstract class is the base class for the LinkingTool and RelinkingTool classes. + * This class includes properties for defining and accessing any temporary nodes and temporary link + * that are used during any linking operation, as well as access to the existing diagram's nodes and link + * (if any) that are involved with the linking operation. + */ + class LinkingTool extends LinkingBaseTool { + /**You do not normally need to create an instance of this tool because one already exists as the ToolManager#linkingTool, which you can modify.*/ + constructor(); + /**Gets or sets an optional node data object representing a link label, that is copied by #insertLink and added to the GraphLinksModel when creating a new Link.*/ + archetypeLabelNodeData: Object; + /**Gets or sets a data object that is copied by #insertLink and added to the GraphLinksModel when creating a new Link.*/ + archetypeLinkData: Object; + /**Gets or sets the direction in which new links may be drawn.*/ + direction: EnumValue; + /**Gets or sets the GraphObject at which #findLinkablePort should start its search.*/ + startObject: GraphObject; + /**This tool can run when the diagram allows linking, the model is modifiable, the left-button mouse drag has moved far enough away to not be a click, and when #findLinkablePort has returned a valid port.*/ + canStart(): boolean; + /**Start the linking operation.*/ + doActivate(); + /**Finishing the linking operation stops the transaction, releases the mouse, and resets the cursor.*/ + doDeactivate(); + /**A mouse-up ends the linking operation; if there is a valid #targetPort nearby, this adds a new Link by calling #insertLink.*/ + doMouseUp(); + /**Return the GraphObject at the mouse-down point, if it is part of a node and if it is valid to link with it.*/ + findLinkablePort(): GraphObject; + /**Make a copy of the #archetypeLinkData, set its node and port properties, and add it to the model. + * @param {Node} fromnode + * @param {GraphObject} fromport + * @param {Node} tonode + * @param {GraphObject} toport*/ + insertLink(fromnode: Node, fromport: GraphObject, tonode: Node, toport: GraphObject): Link; + /**This value for LinkingTool#direction indicates that users may draw new links backwards only (i.e.*/ + static BackwardsOnly: EnumValue; + /**This value for LinkingTool#direction indicates that users may draw new links in either direction.*/ + static Either: EnumValue; + /**This value for LinkingTool#direction indicates that users may draw new links forwards only (i.e.*/ + static ForwardsOnly: EnumValue; + } + /** * The LinkReshapingTool is used to interactively change the route of a Link. * This tool makes use of an Adornment, shown when the adorned Link is selected, @@ -2751,7 +4675,16 @@ declare module go { reshape(newPoint: Point); /**Show an Adornment with reshape handles at each of the interesting points of the link's route, if the link is selected and visible and if Part#canReshape is true. @param {Part} part*/ updateAdornments(part: Part); + /**Allow dragging in any direction.*/ + static All: EnumValue; + /**Allow only horizontal (left-and-right) dragging.*/ + static Horizontal: EnumValue; + /**Disallow dragging.*/ + static None: EnumValue; + /**Allow only vertical (up-and-down) dragging.*/ + static Vertical: EnumValue; } + /** * The PanningTool supports manual panning, where the user can shift the * Diagram#position by dragging the mouse. @@ -2776,6 +4709,7 @@ declare module go { /**Modify the Diagram#position according to how much the mouse has moved.*/ doMouseUp(); } + /** * The RelinkingTool allows the user to reconnect an existing Link * if the Link#relinkableTo and/or Link#relinkableFrom properties are true. @@ -2807,6 +4741,7 @@ declare module go { /**Show an Adornment for each end of the Link that the user may reconnect. @param {Part} part*/ updateAdornments(part: Part); } + /** * The ResizingTool is used to interactively change the size of a GraphObject * in the selected Part or Node. @@ -2835,7 +4770,8 @@ declare module go { originalLocation: Point; /**This tool may run when there is a mouse-down event on a resize handle, the diagram is not read-only and it allows resizing, the left mouse button is being used, and this tool's adornment's resize handle is at the current mouse point.*/ canStart(): boolean; - /**The size should be a multiple of the value returned by this method.*/computeCellSize(): Size; + /**The size should be a multiple of the value returned by this method.*/ + computeCellSize(): Size; /**The effective maximum resizing size is the minimum of the #maxSize and the #adornedObject's GraphObject#maxSize.*/ computeMaxSize(): Size; /**The effective minimum resizing size is the maximum of #minSize and the #adornedObject's GraphObject#minSize.*/ @@ -2864,6 +4800,7 @@ declare module go { /**Show an Adornment with the resize handles at points along the edge of the bounds of the selected Part's Part#resizeObject. @param {Part} part*/ updateAdornments(part: Part); } + /** * The RotatingTool is used to interactively change the GraphObject#angle of a GraphObject. * This tool allows the user to rotate the Part#rotateObject of the selected Part. @@ -2904,6 +4841,7 @@ declare module go { /**Show an Adornment with a rotate handle at a point to the side of the adorned object if the part is selected and visible and if Part#canRotate() is true.*/ updateAdornments(part: Part); } + /** * The TextEditingTool is used to let the user interactively edit text in place. * You do not normally need to create an instance of this tool @@ -2911,7 +4849,7 @@ declare module go { */ class TextEditingTool extends Tool { /**You do not normally need to create an instance of this tool because one already exists as the ToolManager#textEditingTool, which you can modify.*/ - constructor(); + constructor(); /**Gets or sets the HTML element that edits the text.*/ currentTextEditor: Element; /**Gets or sets the HTML element that edits the text.*/ @@ -2921,7 +4859,7 @@ declare module go { /**Gets or sets the TextBlock that is being edited.*/ textBlock: TextBlock; /**Gets or sets the predicate that determines whether or not a string of text is valid.*/ - textValidation: any; + textValidation: (tb: TextBlock, oldstr: string, newstr: string) => boolean; /**Finish editing by trying to accept the new text. * @param {EnumValue} reason The reason must be either TextEditingTool#LostFocus, * TextEditingTool#MouseDown, TextEditingTool#Tab, or TextEditingTool#Enter.*/ @@ -2935,7 +4873,7 @@ declare module go { /**Release the mouse.*/ doDeactivate(); /**A click (mouse up) calls TextEditingTool#doActivate if this tool is not already active and if TextEditingTool#canStart returns true.*/ - doMouseDown(); + doMouseDown(); /**A click (mouse up) calls TextEditingTool#doActivate if this tool is not already active and if TextEditingTool#canStart returns true.*/ doMouseUp(); /**This calls TextEditingTool#doActivate if there is a TextBlock supplied.*/ @@ -2958,6 +4896,7 @@ declare module go { /**The user has typed TAB.*/ static Tab: EnumValue; } + /** * Tools handle mouse events and keyboard events. * The currently running tool, Diagram#currentTool, receives all input events from the Diagram. @@ -2974,7 +4913,7 @@ declare module go { /**Gets or sets the name of this tool.*/ name: string; /**Gets or sets the name of the transaction to be committed by #stopTransaction; if null, the transaction will be rolled back.*/ - transactionResult: any; + transactionResult: string; /**This is called to cancel any running "WaitAfter" timer.*/ cancelWaitAfter(); /**This predicate is used by the ToolManager to decide if this tool can be started mode-lessly by mouse and touch events.*/ @@ -3016,7 +4955,7 @@ declare module go { * @param {function(GraphObject):GraphObject | null=} navig An optional custom navigation * function to find target objects. * @param {function(GraphObject):boolean | null=} pred An optional custom predicate*/ - standardMouseClick(navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => GraphObject); + standardMouseClick(navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean); /**Implement the standard behavior for mouse enter, over, and leave events, where the mouse is moving but no button is pressed.*/ standardMouseOver(); /**Implement the standard behavior for selecting parts with the mouse, depending on the control and shift modifier keys.*/ @@ -3024,7 +4963,7 @@ declare module go { /**Implement the standard behavior for mouse wheel events.*/ standardMouseWheel(); /**This is called to start a new timer to call #doWaitAfter after a given delay. - * @param {number} delay*/ + * @param {number} delay in milliseconds*/ standardWaitAfter(delay: number); /**Call Diagram#startTransaction with the given transaction name.*/ startTransaction(tname?: string): boolean; @@ -3035,7 +4974,8 @@ declare module go { /**The diagram asks each tool to update any adornments the tool might use for a given part.*/ updateAdornments(part: Part); } - /** + + /** * This special Tool is responsible for managing all of the Diagram's * mode-less tools. */ @@ -3129,6 +5069,8 @@ declare module go { /**This value for #mouseWheelBehavior indicates that the mouse wheel events change the scale of the diagram.*/ static WheelZoom: EnumValue; } + + /** * This interface is implemented by the List, Set, and Map * classes; it provides the #iterator read-only property that returns an Iterator. @@ -3139,6 +5081,7 @@ declare module go { /**Gets an Iterator that can iterate over the items in the collection.*/ iterator: Iterator; } + /** * This interface defines properties and methods for iterating over a collection; * it provides the #next predicate and the #value read-only property. @@ -3161,6 +5104,7 @@ declare module go { /**Start this iterator all over again.*/ reset(); } + /** * An ordered iterable collection. * It optionally enforces the type of elements that may be added to the List. @@ -3168,7 +5112,7 @@ declare module go { class List { /**There are three possible constructors: List(), List(string) where string is a primitive type ('number', 'string', 'boolean', or 'function'), or List(func) where func is a class function/constructor, such as GraphObject.*/ constructor(type?: string); - constructor(type: (...args: any[]) => any); + constructor(type: (...args: any[]) => any); /**Gets the length of the List.*/ count: number; /**Gets an object that you can use for iterating over the List.*/ @@ -3179,7 +5123,7 @@ declare module go { length: number; /**Adds a given value to the end of the List.*/ add(val: any); - /**Adds all of the values of a collection to the end of this List.*/ + /**Adds all of the values of a collection (either an Iterable or an Array) to the end of this List.*/ addAll(coll: any): List; /**Clears the List.*/ clear(); @@ -3206,12 +5150,13 @@ declare module go { /**Set the element at the given index to a given value.*/ setElt(i: number, val: any); /**Sort the List according to a comparison function.*/ - sort(sortfunc: any): List; + sort(sortfunc: (a: any, b: any) => number): List; /**Produces a JavaScript Array from the contents of this List.*/ toArray(): Array; /**Converts the List to a Set.*/ toSet(): Set; } + /** * An unordered iterable collection of key/value pairs that cannot contain two instances of the * same key. @@ -3243,6 +5188,7 @@ declare module go { /**Produces a Set that provides a read-only view onto the keys of this Map.*/ toKeySet(): Set; } + /** * An unordered iterable collection that cannot contain two instances of the same kind of value. * It optionally enforces the type of elements that may be added to the Set. @@ -3250,14 +5196,14 @@ declare module go { class Set { /**There are three possible constructors: Set(), Set(string) where string is a primitive type ('number' or 'string'), or Set(func) where func is a class function/constructor, such as GraphObject.*/ constructor(type?: string); - constructor(type: (...args: any[]) => any); + constructor(type: (...args: any[]) => any); /**Gets the number of elements in the Set.*/ count: number; /**Gets an object that you can use for iterating over the Set.*/ iterator: Iterator; /**Adds a given value to the Set, if not already present.*/ add(val: any): boolean; - /**Adds all of the values of a collection to this Set.*/ + /**Adds all of the values of a collection (either an Iterable or an Array) to this Set.*/ addAll(coll: any): Set; /**Clears the Set.*/ clear(); @@ -3282,1805 +5228,7 @@ declare module go { /**Converts the Set to a List.*/ toList(): List; } - /** - * An adornment is a special kind of Part that is associated with another Part, - * the Adornment#adornedPart. - * Adornments are normally associated with a particular GraphObject in the adorned part -- - * that is the value of #adornedObject. - * However, the #adornedObject may be null, in which case the #adornedPart will also be null. - */ - class Adornment extends Part { - /* @param {EnumValue= } type if not supplied, the default Panel type is Panel#Position.*/ - constructor(type?: EnumValue); - /**Gets or sets the GraphObject that is adorned.*/ - adornedObject: GraphObject; - /**Gets the Part that contains the adorned object.*/ - adornedPart: Part; - /**Gets a Placeholder that this Adornment may contain in its visual tree.*/ - placeholder: Placeholder; - } - /** - * The Diagram#commandHandler implements various - * commands such as CommandHandler#deleteSelection or CommandHandler#redo. - * The CommandHandler includes keyboard event handling to interpret - * key presses as commands. - */ - class CommandHandler { - /**The constructor produces a CommandHandler with the default key bindings.*/ - constructor(); - /**Gets or sets a data object that is copied by #groupSelection when creating a new Group.*/ - archetypeGroupData: Object; - /**Gets or sets whether #copySelection should also copy subtrees.*/ - copiesTree: boolean; - /**Gets or sets whether #deleteSelection should also delete subtrees.*/ - deletesTree: boolean; - /**Gets the Diagram that is using this CommandHandler.*/ - diagram: Diagram; - /**Gets or sets the predicate that determines whether or not a node may become a member of a group.*/ - memberValidation: any; - /**Gets or sets the amount by which #decreaseZoom and #increaseZoom change the Diagram#scale.*/ - zoomFactor: number; - /**Make sure all of the unnested Parts in the given collection are removed from any containing Groups. - * @param {Iterable} coll a collection of Parts. - * @param {boolean=} check whether to call #isValidMember to confirm that changing the Part to be a top-level Part is valid. - */ - addTopLevelParts(coll: Iterable, check?: boolean): boolean; - /**This predicate controls whether the user can collapse any selected expanded Groups. - * @param {Group=} group if supplied, ignore the selection and consider collapsing this particular Group. - */ - canCollapseSubGraph(group?: Group): boolean; - /**This predicate controls whether the user can collapse any selected expanded subtrees of Nodes. - * @param {Node=} node if supplied, ignore the selection and consider collapsing this particular Node. - */ - canCollapseTree(node?: Node): boolean; - /**This predicate controls whether or not the user can invoke the #copySelection command.*/ - canCopySelection(): boolean; - /**This predicate controls whether or not the user can invoke the #cutSelection command.*/ - canCutSelection(): boolean; - /**This predicate controls whether or not the user can invoke the #decreaseZoom command. - * @param {number=} factor This defaults to 5%, #zoomFactor. The value should be less than one. - */ - canDecreaseZoom(factor?: number): boolean; - /**This predicate controls whether or not the user can invoke the #deleteSelection command.*/ - canDeleteSelection(): boolean; - /**This predicate controls whether or not the user can invoke the #editTextBlock command. - * @param {TextBlock=} textblock the TextBlock to consider editing.*/ - canEditTextBlock(textblock?: TextBlock): boolean; - /**This predicate controls whether the user can expand any selected collapsed Groups. - * @param {Group=} group if supplied, ignore the selection and consider expanding this particular Group. - */ - canExpandSubGraph(group?: Group): boolean; - /**This predicate controls whether the user can expand any selected collapsed subtrees of Nodes. - * @param {Node=} node if supplied, ignore the selection and consider expanding this particular Node. - */ - canExpandTree(node?: Node): boolean; - /**This predicate controls whether or not the user can invoke the #groupSelection command.*/ - canGroupSelection(): boolean; - /**This predicate controls whether or not the user can invoke the #increaseZoom command. - * @param {number=} factor This defaults to 5%, #zoomFactor. The value should be greater than one. - */ - canIncreaseZoom(factor?: number): boolean; - /**This predicate controls whether or not the user can invoke the #pasteSelection command.*/ - canPasteSelection(): boolean; - /**This predicate controls whether or not the user can invoke the #redo command.*/ - canRedo(): boolean; - /**This predicate controls whether or not the user can invoke the #resetZoom command. - * @param {number=} newscale This defaults to 1. The value should be greater than zero. - */ - canResetZoom(newscale?: number): boolean; - /**This predicate controls whether or not the user can invoke the #selectAll command.*/ - canSelectAll(): boolean; - /**This predicate controls whether the user may stop the current tool.*/ - canStopCommand(): boolean; - /**This predicate controls whether or not the user can invoke the #undo command.*/ - canUndo(): boolean; - /**This predicate controls whether or not the user can invoke the #ungroupSelection command. - * @param {Group=} group if supplied, ignore the selection and consider ungrouping this particular Group. - */ - canUngroupSelection(group?: Group): boolean; - /**This predicate controls whether or not the user can invoke the #zoomToFit command.*/ - canZoomToFit(): boolean; - /**Collapse all expanded selected Groups. - * @param {Group=} group if supplied, ignore the selection and collapse this particular Group. - */ - collapseSubGraph(group?: Group); - /**Collapse all expanded selected Nodes. - * @param {Node=} node if supplied, ignore the selection and collapse this particular Node subtree.*/ - collapseTree(node?: Node); - /**Copy the currently selected parts, Diagram#selection, from the Diagram into the clipboard.*/ - copySelection(); - /**This makes a copy of the given collection of Parts and stores it in a static variable acting as the clipboard. - * @param {Iterable} coll A collection of Parts.*/ - copyToClipboard(coll: Iterable); - /**Execute a #copySelection followed by a #deleteSelection.*/ - cutSelection(); - /**Decrease the Diagram#scale by a given factor. - * @param {number=} factor This defaults to #zoomFactor. The value should be less than one.*/ - decreaseZoom(factor?: number); - /**Delete the currently selected parts from the diagram.*/ - deleteSelection(); - /**This is called by tools to handle keyboard commands.*/ - doKeyDown(); - /**This is called by tools to handle keyboard commands.*/ - doKeyUp(); - /**Start in-place editing of a TextBlock in the selected Part. - * @param {TextBlock=} textblock the TextBlock to start editing.*/ - editTextBlock(textblock?: TextBlock); - /**Expand all collapsed selected Groups. - * @param {Group=} group if supplied, ignore the selection and expand this particular Group.*/ - expandSubGraph(group?: Group); - /**Expand all collapsed selected Nodes. - * @param {Node=} node if supplied, ignore the selection and collapse this particular Node subtree.*/ - expandTree(node?: Node); - /**Add a copy of #archetypeGroupData and add it to the diagram's model to create a new Group and then add the selected Parts to that new group.*/ - groupSelection(); - /**Increase the Diagram#scale by a given factor.*/ - increaseZoom(factor?: Number); - /**This predicate is called to determine whether a Node may be added as a member of a Group. - * @param {Group} group this may be null if the node is being added as a top-level node. - * @param {Part} part a Part, usually a Node, possibly another Group, but not a Link or an Adornment.*/ - isValidMember(group: Group, part: Part): boolean; - /**If the clipboard holds a collection of Parts, and if the Model#dataFormat matches that stored in the clipboard, this makes a copy of the clipboard's parts and adds the copies to this Diagram.*/ - pasteFromClipboard(): Iterable; - /**Copy the contents of the clipboard into this diagram, and make those new parts the new selection. - * @param {Point=} pos Point at which to center the newly pasted parts; if not present the parts are not moved. - */ - pasteSelection(pos?: Point); - /**Call UndoManager#redo.*/ - redo(); - /**Set the Diagram#scale to a new scale value, by default 1. - * @param {number=} newscale This defaults to 1. The value should be greater than zero.*/ - resetZoom(newscale?: number); - /**Select all of the selectable Parts in the diagram.*/ - selectAll(); - /**Cancel the operation of the current tool.*/ - stopCommand(); - /**Call UndoManager#undo.*/ - undo(); - /**Remove the group from the diagram without removing its members from the diagram. - * @param {Group=} group if supplied, ignore the selection and consider ungrouping this particular Group.*/ - ungroupSelection(group?: Group); - /**Change the Diagram#scale so that the Diagram#documentBounds fits within the viewport.*/ - zoomToFit(); - } - /** - * A Diagram is associated with an HTML div element. Constructing a Diagram creates - * an HTML Canvas element which it places inside of the given div element, in addition to several helper divs. - * GoJS will manage the contents of this div, and the contents should not be modified otherwise, - * though the given div may be styled (background, border, etc) and positioned as needed. - */ - class Diagram { - /** Construct an empty Diagram for a particular DIV HTML element. - * @param {Element|string=} div A reference to a div or its ID as a string. - * If no div is supplied one will be created in memory. The Diagram's Diagram#div property - * can then be set later on.*/ - constructor(div: Element); - constructor(div?: string); - /**Gets or sets whether the user may copy to or paste parts from the internal clipboard.*/ - allowClipboard: boolean; - /**Gets or sets whether the user may copy objects.*/ - allowCopy: boolean; - /**Gets or sets whether the user may delete objects from the Diagram.*/ - allowDelete: boolean; - /**Gets or sets whether the user may start a drag-and-drop in this Diagram, possibly dropping in a different element.*/ - allowDragOut: boolean; - /**Gets or sets whether the user may end a drag-and-drop operation in this Diagram.*/ - allowDrop: boolean; - /**Gets or sets whether the user may group parts together.*/ - allowGroup: boolean; - /**Gets or sets whether the user is allowed to use the horizontal scrollbar.*/ - allowHorizontalScroll: boolean; - /**Gets or sets whether the user may add parts to the Diagram.*/ - allowInsert: boolean; - /**Gets or sets whether the user may draw new links.*/ - allowLink: boolean; - /**Gets or sets whether the user may move objects.*/ - allowMove: boolean; - /**Gets or sets whether the user may reconnect existing links.*/ - allowRelink: boolean; - /**Gets or sets whether the user may reshape parts.*/ - allowReshape: boolean; - /**Gets or sets whether the user may resize parts.*/ - allowResize: boolean; - /**Gets or sets whether the user may rotate parts.*/ - allowRotate: boolean; - /**Gets or sets whether the user may select objects.*/ - allowSelect: boolean; - /**Gets or sets whether the user may do in-place text editing.*/ - allowTextEdit: boolean; - /**Gets or sets whether the user may undo or redo any changes.*/ - allowUndo: boolean; - /**Gets or sets whether the user may ungroup existing groups.*/ - allowUngroup: boolean; - /**Gets or sets whether the user is allowed to use the vertical scrollbar.*/ - allowVerticalScroll: boolean; - /**Gets or sets whether the user may zoom into or out of the Diagram.*/ - allowZoom: boolean; - /**Gets or sets the autoScale of the Diagram, controlling whether or not the Diagram's bounds automatically scale to fit the view.*/ - autoScale: EnumValue; - /**Gets or sets the Margin that describes the Diagram's autoScrollRegion.*/ - autoScrollRegion: any; - /**Gets or sets the function to execute when the user single-primary-clicks on the background of the Diagram.*/ - click: any; - /**Gets or sets the CommandHandler for this Diagram.*/ - commandHandler: CommandHandler; - /**Gets or sets the content alignment Spot of this Diagram, to be used in determining how parts are positioned when the #viewportBounds width or height is smaller than the #documentBounds.*/ - contentAlignment: Spot; - /**Gets or sets the function to execute when the user single-secondary-clicks on the background of the Diagram.*/ - contextClick: any; - /**This Adornment is shown when the use context clicks in the background.*/ - contextMenu: Adornment; - /**Gets or sets the current cursor for the Diagram, overriding the #defaultCursor.*/ - currentCursor: string; - /**Gets or sets the current tool for this Diagram that handles all input events.*/ - currentTool: Tool; - /**Gets or sets the cursor to be used for the Diagram when no GraphObject specifies a different cursor.*/ - defaultCursor: string; - /**Gets or sets the default tool for this Diagram that becomes the current tool when the current tool stops.*/ - defaultTool: Tool; - /**Gets or sets the Diagram's HTMLDivElement, via an HTML Element ID.*/ - div: HTMLDivElement; - /**Gets the model-coordinate bounds of the Diagram.*/ - documentBounds: Rect; - /**Gets or sets the function to execute when the user double-primary-clicks on the background of the Diagram.*/ - doubleClick: any; - /**Gets or sets the most recent mouse-down InputEvent that occurred.*/ - firstInput: InputEvent; - /**Gets or sets a fixed bounding rectangle to be returned by #documentBounds and #computeBounds.*/ - fixedBounds: Rect; - /**Gets or sets a Panel of type Panel#Grid acting as the background grid extending across the whole viewport of this diagram.*/ - grid: Panel; - /**Gets or sets the default selection Adornment template, used to adorn selected Groups.*/ - groupSelectionAdornmentTemplate: Adornment; - /**Gets or sets the default Group template used as the archetype for group data that is added to the #model.*/ - groupTemplate: Part; - /**Gets or sets a Map mapping template names to Groups.*/ - groupTemplateMap: Map; - /**Gets or sets whether the Diagram has a horizontal Scrollbar.*/ - hasHorizontalScrollbar: boolean; - /**Gets or sets whether the Diagram has a vertical Scrollbar.*/ - hasVerticalScrollbar: boolean; - height: number; - /**Gets or sets the initialAutoScale of the Diagram.*/ - initialAutoScale: EnumValue; - /**Gets or sets the intial content alignment Spot of this Diagram, to be used in determining how parts are positioned initially relative to the viewport.*/ - initialContentAlignment: Spot; - /**Gets or sets the spot in the document's area that should be coincident with the #initialViewportSpot of the viewport when the document is first initialized.*/ - initialDocumentSpot: Spot; - /**Gets or sets the initial coordinates of this Diagram in the viewport, eventually setting the #position.*/ - initialPosition: Point; - /**Gets or sets the initial scale of this Diagram in the viewport, eventually setting the #scale.*/ - initialScale: number; - /**Gets or sets the spot in the viewport that should be coincident with the #initialDocumentSpot of the document when the document is first initialized.*/ - initialViewportSpot: Spot; - /**Gets or sets whether the user may interact with the Diagram.*/ - isEnabled: boolean; - /**Gets or sets whether the Diagram's Diagram#model is Model#isReadOnly.*/ - isModelReadOnly: boolean; - /**Gets or sets whether this Diagram's state has been modified.*/ - isModified: boolean; - /**Gets or sets whether mouse events initiated within the Diagram will be captured.*/ - isMouseCaptured: boolean; - /**Gets or sets whether the Diagram may be modified by the user, while still allowing the user to scroll, zoom, and select.*/ - isReadOnly: boolean; - /**Gets or sets whether the Diagram tree structure is defined by links going from the parent node to their children, or vice-versa.*/ - isTreePathToChildren: boolean; - /**Gets or sets the last InputEvent that occurred.*/ - lastInput: InputEvent; - /**Gets an iterator for this Diagram's Layers.*/ - layers: Iterator; - /**Gets or sets the Layout used to position all of the top-level nodes and links in this Diagram.*/ - layout: Layout; - /**Returns an iterator of all Links in the Diagram.*/ - links: Iterator; - /**Gets or sets the default selection Adornment template, used to adorn selected Links.*/ - linkSelectionAdornmentTemplate: Adornment; - /**Gets or sets the default Link template used as the archetype for link data that is added to the #model.*/ - linkTemplate: Part; - /**Gets or sets a Map mapping template names to Links.*/ - linkTemplateMap: Map; - /**Gets or sets the largest value that #scale may take.*/ - maxScale: number; - /**Gets or sets the maximum number of selected objects.*/ - maxSelectionCount: number; - /**Gets or sets the smallest value greater than zero that #scale may take.*/ - minScale: number; - /**Gets or sets the Model holding data corresponding to the data-bound nodes and links of this Diagram.*/ - model: Model; - /**Gets or sets the function to execute when the user is dragging the selection in the background of the Diagram during a DraggingTool drag-and-drop, not over any GraphObjects.*/ - mouseDragOver: (a:InputEvent)=>any; - /**Gets or sets the function to execute when the user drops the selection in the background of the Diagram at the end of a DraggingTool drag-and-drop, not onto any GraphObjects.*/ - mouseDrop: (a: InputEvent) => any; - /**Gets or sets the function to execute when the user holds the mouse stationary in the background of the Diagram while holding down a button, not over any GraphObjects.*/ - mouseHold: (a: InputEvent) => any; - /**Gets or sets the function to execute when the user holds the mouse stationary in the background of the Diagram without holding down any buttons, not over any GraphObjects.*/ - mouseHover: (a: InputEvent) => any; - /**Gets or sets the function to execute when the user moves the mouse in the background of the Diagram without holding down any buttons, not over any GraphObjects.*/ - mouseOver: (a: InputEvent) => any; - /**Returns an iterator of all Nodes and Groups in the Diagram.*/ - nodes: Iterator; - /**Gets or sets the default selection Adornment template, used to adorn selected Parts other than Groups or Links.*/ - nodeSelectionAdornmentTemplate: Adornment; - /**Gets or sets the default Node template used as the archetype for node data that is added to the #model.*/ - nodeTemplate: Part; - /**Gets or sets a Map mapping template names to Parts.*/ - nodeTemplateMap: Map; - /**Gets or sets the Margin that describes the Diagram's padding, which controls how much extra space there is around the area occupied by the document.*/ - padding: any; - /**Returns an iterator of all Parts in the Diagram that are not Nodes or Links or Adornments.*/ - parts: Iterator; - /**Gets or sets the coordinates of this Diagram in the viewport.*/ - position: Point; - /**Gets or sets the scale transform of this Diagram.*/ - scale: number; - /**Gets or sets the distance in screen pixels that the horizontal scrollbar will scroll when scrolling by a line.*/ - scrollHorizontalLineChange: number; - /**Gets or sets the distance in screen pixels that the vertical scrollbar will scroll when scrolling by a line.*/ - scrollVerticalLineChange: number; - /**Gets the read-only collection of selected objects.*/ - selection: Set; - /**Gets or sets whether ChangedEvents are not recorded by the UndoManager.*/ - skipsUndoManager: boolean; - /**Gets the UndoManager for this Diagram, which actually belongs to the #model.*/ - toolManager: ToolManager; - /**This Adornment is shown when the mouse stays motionless in the background.*/ - toolTip: Adornment; - /**Gets the UndoManager for this Diagram, which actually belongs to the #model.*/ - undoManager: UndoManager; - /**Gets or sets what kinds of graphs this diagram allows the user to draw.*/ - validCycle: EnumValue; - /**Gets the bounds of the portion of the Diagram that is viewable from its HTML Canvas.*/ - viewportBounds: Rect; - width: number; - /**Adds a Part to the Layer that matches the Part's Part#layerName, or else the default layer, which is named with the empty string. - * @param {Part} part*/ - add(part: Part); - /**Register an event handler that is called when there is a ChangedEvent. - * @param {function(ChangedEvent)} listener a function that takes a ChangedEvent as its argument. - */ - addChangedListener(listener: (obj: ChangedEvent)=>any); - /**Register an event handler that is called when there is a DiagramEvent of a given name. - * @param {string} name the name is normally capitalized, but this method uses case-insensitive comparison. - * @param {function(DiagramEvent)} listener a function that takes a DiagramEvent as its argument. - */ - addDiagramListener(name: string, listener: (obj:DiagramEvent)=>any); - /**Adds a Layer to the list of layers. - * @param {Layer} layer The Layer to add.*/ - addLayer(layer: Layer); - /**Adds a layer to the list of layers after a specified layer. - * @param {Layer} layer The Layer to add. - * @param {Layer} existingLayer The layer to insert after.*/ - addLayerAfter(layer: Layer, existingLayer: Layer); - /**Adds a layer to the list of layers before a specified layer. - * @param {Layer} layer The Layer to add. - * @param {Layer} existingLayer The layer to insert before.*/ - addLayerBefore(layer: Layer, existingLayer: Layer); - /**Aligns the Diagram's #position based on a desired document Spot and viewport Spot. - * @param {Spot} documentspot - * @param {Spot} viewportspot*/ - alignDocument(documentspot: Spot, viewportspot: Spot); - /**Modifies the #position to show a given Rect of the Diagram by centering the viewport on that Rect. - * @param {Rect} r*/ - centerRect(r: Rect); - /**Removes all Parts from the Diagram, including unbound Parts and the background grid, and also clears out the Model and UndoManager.*/ - clear(); - /**Deselect all selected Parts.*/ - clearSelection(); - /**Commit the changes of the current transaction. - * @param {string} tname a descriptive name for the transaction.*/ - commitTransaction(tname: string): boolean; - /**This is called during a Diagram update to determine a new value for #documentBounds.*/ - computeBounds(): Rect; - /**Find the union of the GraphObject#actualBounds of all of the Parts in the given collection. - * @param {Iterable} coll a collection of Parts.*/ - computePartsBounds(coll: Iterable): Rect; - /**Updates the diagram immediately, then resets initialization flags so that actions taken in the argument function will be considered part of Diagram initialization, and will participate in initial layouts, #initialAutoScale, #initialContentAlignment, etc. - * @param {function()|null=} func an optional function of actions to perform as part of another diagram initialization.*/ - delayInitialization(func?: (a:any)=>any); - /**Finds a layer with a given name. - * @param {string} name*/ - findLayer(name: string): Layer; - /**Look for a Link corresponding to a GraphLinksModel's link data object. - * @param {Object} linkdata*/ - findLinkForData(linkdata: Object): Link; - /**Look for a Node or Group corresponding to a model's node data object. - * @param {Object} nodedata*/ - findNodeForData(nodedata: Object): Node; - /**Look for a Node or Group corresponding to a model's node data object's unique key. - * @param {*} key a string or number.*/ - findNodeForKey(key: any): Node; - /**Find the front-most GraphObject at the given point in document coordinates. - * @param {Point} p A Point in document coordinates. - * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and - * returning a GraphObject, defaulting to the identity. - * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject - * returned by navig and returning true if that object should be returned, - * defaulting to a predicate that always returns true.*/ - findObjectAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject)=>boolean): GraphObject; - /**Return a collection of the GraphObjects at the given point in document coordinates. - * @param {Point} p A Point in document coordinates. - * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and - * returning a GraphObject, defaulting to the identity. - * If this function returns null, the given GraphObject will not be included in the results. - * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject - * returned by navig and returning true if that object should be returned, - * defaulting to a predicate that always returns true. - * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ - findObjectsAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject)=>boolean, coll?: List): Iterable; - findObjectsAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, coll?: Set): Iterable; - /**Returns a collection of all GraphObjects that are inside or that intersect a given Rect in document coordinates. - * @param {Rect} r A Rect in document coordinates. - * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and - * returning a GraphObject, defaulting to the identity. - * If this function returns null, the given GraphObject will not be included in the results. - * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject - * returned by navig and returning true if that object should be returned, - * defaulting to a predicate that always returns true. - * @param {*=} partialInclusion Whether an object can match if it merely intersects the rectangular area (true) or - * if it must be entirely inside the rectangular area (false). The default value is false. - * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ - findObjectsIn(r: Rect, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: any, coll?: List): Iterable; - findObjectsIn(r: Rect, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: any, coll?: Set): Iterable; - /**Returns a collection of all GraphObjects that are within a certain distance of a given point in document coordinates. - * @param {Point} p A Point in document coordinates. - * @param {number} dist The distance from the point. - * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and - * returning a GraphObject, defaulting to the identity. - * If this function returns null, the given GraphObject will not be included in the results. - * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject - * returned by navig and returning true if that object should be returned, - * defaulting to a predicate that always returns true. - * @param {*=} partialInclusion Whether an object can match if it merely intersects the circular area (true) or - * if it must be entirely inside the circular area (false). The default value is true. - * The default is true. - * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ - findObjectsNear(p: Point, dist: number, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject)=>boolean, partialInclusion?: any, coll?: List): Iterable; - findObjectsNear(p: Point, dist: number, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: any, coll?: Set): Iterable; - /**This convenience function finds the front-most Part that is at a given point and that might be selectable. - * @param {Point} p a Point in document coordinates. - * @param {boolean} selectable Whether to only consider parts that are Part#selectable.*/ - findPartAt(p: Point, selectable: boolean): Part; - /**Look for a Part, Node, Group, or Link corresponding to a Model's data object. - * @param {Object} data*/ - findPartForData(data: Object): Part; - /**Look for a Part or Node or Group corresponding to a model's data object's unique key. - * @param {*} key a string or number.*/ - findPartForKey(key: any): Part; - /**Returns an iterator of all Groups that are at top-level, in other words that are not themselves inside other Groups.*/ - findTopLevelGroups(): Iterator; - /**Returns an iterator of all top-level Nodes that have no tree parents.*/ - findTreeRoots(): Iterator; - /**Explicitly bring focus to the Diagram's canvas.*/ - focus(); - /**This static method gets the Diagram that is attached to an HTML DIV element.*/ - static fromDiv(div: any): Diagram; - /**This static function declares that a class (constructor function) derives from another class -- but please note that most classes do not support inheritance. - * @param {Function} derivedclass - * @param {Function} baseclass*/ - static inherit(derivedclass: any, baseclass: any); - /**Perform all invalid layouts. - * @param {boolean=} invalidateAll If true, this will explicitly set Layout#isValidLayout to false on each Layout in the diagram. - */ - layoutDiagram(invalidateAll?: boolean); - /** Create an HTMLImageElement that contains a bitmap of the current Diagram.*/ - makeImage(properties?: any): HTMLImageElement; - /**Create a bitmap of the current Diagram encoded as a base64 string. - * @param {{ size: Size, - scale: number, - maxSize: Size, - position: Point, - parts: Iterable, - padding: (Margin|number), - showTemporary: boolean, - showGrid: boolean, - type: string, - details: * - }|Object=} properties a JavaScript object detailing optional arguments for image creation, to be passed to makeImageData. - */ - makeImageData(...properties: any[]): string; - /**Remove all of the Parts created from model data and then create them again.*/ - rebuildParts(); - /**Removes a Part from its Layer, provided the Layer is in this Diagram. - * @param {Part} part*/ - remove(part: Part); - /**Unregister an event handler listener. - * @param {function(ChangedEvent)} listener a function that takes a ChangedEvent as its argument. - */ - removeChangedListener(listener: (a:ChangedEvent)=>any); - /**Unregister a DiagramEvent handler. - * @param {string} name the name is normally capitalized, but this method uses case-insensitive comparison. - * @param {function(DiagramEvent)} listener a function that takes a DiagramEvent as its argument. - */ - removeDiagramListener(name: string, listener: (a:DiagramEvent)=>any); - /**Removes the given layer from the list of layers. - * @param {Layer} layer*/ - removeLayer(layer: Layer); - /**Rollback the current transaction, undoing any recorded changes.*/ - rollbackTransaction(): boolean; - /**Scrolling function used by primarily by #commandHandler's CommandHandler#doKeyDown. - * @param {string} unit A string representing the unit of the scroll operation. Can be 'pixel', 'line', or 'page'. - * @param {string} dir The direction of the scroll operation. Can be 'up', 'down', 'left', or 'right'. - * @param {number=} dist An optional distance multiplier, for multiple pixels, lines, or pages. Default is 1. - */ - scroll(unit: string, dir: string, dist?: number); - /**Modifies the #position to show a given Rect of the Diagram by centering the viewport on that Rect. - * @param {Rect} r*/ - scrollToRect(r: Rect); - /**Make the given object the only selected object. - * @param {GraphObject} part a GraphObject that is already in a layer of this Diagram. - * If the value is null, this does nothing.*/ - select(part: Part); - /**Select all of the Parts supplied in the given collection. - * @param {Iterable} coll a List or Set of Parts to be selected.*/ - selectCollection(coll: Iterable); - /**Begin a transaction, where the changes are held by a Transaction object in the UndoManager. - * @param {string=} tname a descriptive name for the transaction.*/ - startTransaction(tname?: string): boolean; - /**Given a Point in document coorindates, return a new Point in viewport coordinates. - * @param {Point} p*/ - transformDocToView(p: Point): Point; - /**Given a point in viewport coorindates, return a new point in document coordinates. - * @param {Point} p*/ - transformViewToDoc(p: Point): Point; - /**Update all of the data-bound properties of Nodes and Links in this diagram.*/ - updateAllTargetBindings(); - /**Scales the Diagram to uniformly fit into the viewport.*/ - zoomToFit(); - /**Modifies the #scale and #position of the Diagram so that the viewport displays a given document-coordinates rectangle. - * @param {Rect} r rectangular bounds in document coordinates. - * @param {EnumValue=} scaling an optional value of either #Uniform (the default) or #UniformToFill. - */ - zoomToRect(r: Rect, scaling?: EnumValue); - /**This value for Diagram#validCycle states that there are no restrictions on making cycles of links.*/ - static CycleAll: EnumValue; - /**This value for Diagram#validCycle states that any number of destination links may go out of a node, but at most one source link may come into a node, and there are no directed cycles.*/ - static CycleDestinationTree: EnumValue; - /**This value for Diagram#validCycle states that a valid link from a node will not produce a directed cycle in the graph.*/ - static CycleNotDirected: EnumValue; - /**This value for Diagram#validCycle states that a valid link from a node will not produce an undirected cycle in the graph.*/ - static CycleNotUndirected: EnumValue; - /**This value for Diagram#validCycle states that any number of source links may come into a node, but at most one destination link may go out of a node, and there are no directed cycles.*/ - static CycleSourceTree: EnumValue; - /**The default autoScale type, used as the value of Diagram#autoScale: The Diagram does not attempt to scale its bounds to fit the view.*/ - static None: EnumValue; - /**Diagrams with this autoScale type, used as the value of Diagram#autoScale, are scaled uniformly until the documentBounds fits in the view.*/ - static Uniform: EnumValue; - /**Diagrams with this autoScale type, used as the value of Diagram#autoScale, are scaled uniformly until the documentBounds fits in the view.*/ - UniformToFill: EnumValue; - maybeUpdate(); - } - /** - * A DiagramEvent represents a more abstract event than an InputEvent. - * They are raised on the Diagram class. - * One can receive such events by registering a DiagramEvent listener on a Diagram - * by calling Diagram#addDiagramListener. - * Some DiagramEvents such as "ObjectSingleClicked" are normally - * associated with InputEvents. - * Some DiagramEvents such as "SelectionMoved" or "PartRotated" are associated with the - * results of Tool-handled gestures or CommandHandler actions. - * Some DiagramEvents are not necessarily associated with any input events at all, - * such as "ViewportBoundsChanged", which can happen due to programmatic - * changes to the Diagram#position and Diagram#scale properties. - */ - class DiagramEvent { - /**The DiagramEvent class constructor produces an empty DiagramEvent.*/ - constructor(); - /**Gets or sets whether any default actions associated with this diagram event should be avoided or cancelled.*/ - cancel: boolean; - /**Gets the diagram associated with the event.*/ - diagram; - /**Gets or sets the name of the kind of diagram event that this represents.*/ - name: string; - /**Gets or sets an optional object that describes the change to the subject of the diagram event.*/ - parameter: any; - /**Gets or sets an optional object that is the subject of the diagram event.*/ - subject: Object; - } - /** - * This is the abstract base class for all graphical objects. - */ - class GraphObject { - /**This is an abstract class, so you should not use this constructor.*/ - constructor(); - /**Gets or sets the function to execute when the ActionTool is cancelled and this GraphObject's #isActionable is set to true.*/ - actionCancel: (a:InputEvent, b:GraphObject)=>any; - /**Gets or sets the function to execute on a mouse-down event when this GraphObject's #isActionable is set to true.*/ - actionDown: (a: InputEvent, b: GraphObject) => any; - /**Gets or sets the function to execute on a mouse-move event when this GraphObject's #isActionable is set to true.*/ - actionMove: (a: InputEvent, b: GraphObject) => any; - /**Gets or sets the function to execute on a mouse-up event when this GraphObject's #isActionable is set to true.*/ - actionUp: (a: InputEvent, b: GraphObject) => any; - /**Gets the bounds of this GraphObject in container coordinates.*/ - actualBounds: Rect; - /**Gets or sets the alignment Spot of this GraphObject used in Panel layouts, to determine where in the area allocated by the panel this object should be placed.*/ - alignment: Spot; - /**Gets or sets the spot on this GraphObject to be used as the alignment point in Spot and Fixed Panels.*/ - alignmentFocus: Spot; - /**Gets or sets the angle transform, in degrees, of this GraphObject.*/ - angle: number; - /**Gets or sets the areaBackground Brush of this GraphObject.*/ - areaBackground: any; - /**Gets or sets the background Brush of this GraphObject, filling the rectangle of this object's local coordinate space.*/ - background: any; - /**Gets or sets the function to execute when the user single-primary-clicks on this object.*/ - click: (a: InputEvent, b: GraphObject) => any; - /**Gets or sets the column of this GraphObject if it is in a Table Panel.*/ - column: number; - /**Gets or sets the number of columns spanned by this GraphObject if it is in a Table Panel.*/ - columnSpan: number; - /**Gets or sets the function to execute when the user single-secondary-clicks on this object.*/ - contextClick: (a: InputEvent, b: GraphObject) => any; - /**This Adornment is shown upon a context click on this object.*/ - contextMenu: Adornment; - /**Gets or sets the mouse cursor to use when the mouse is over this object with no mouse buttons pressed.*/ - cursor: string; - /**Gets or sets the desired size of this GraphObject in local coordinates.*/ - desiredSize: Size; - /**Gets the Diagram that this GraphObject is in, if it is.*/ - diagram: Diagram; - /**Gets or sets the function to execute when the user double-primary-clicks on this object.*/ - doubleClick: (a: InputEvent, b: GraphObject) => any; - /**Gets or sets how the direction of the last segment of a link coming from this port is computed when the node is rotated.*/ - fromEndSegmentDirection: EnumValue; - /**Gets or sets the length of the last segment of a link coming from this port.*/ - fromEndSegmentLength: number; - /**Gets or sets whether the user may draw Links from this port.*/ - fromLinkable: any; - /**Gets or sets whether the user may draw duplicate Links from this port.*/ - fromLinkableDuplicates: boolean; - /**Gets or sets whether the user may draw Links that connect from this port's Node.*/ - fromLinkableSelfNode: boolean; - /**Gets or sets the maximum number of links that may come out of this port.*/ - fromMaxLinks: number; - /**Gets or sets how far the end segment of a link coming from this port stops short of the actual port.*/ - fromShortLength: number; - /**Gets or sets where a link should connect from this port.*/ - fromSpot: Spot; - /**Gets or sets the desired height of this GraphObject in local coordinates.*/ - height: number; - /**This property determines whether or not this GraphObject's events occur before all other events, including selection.*/ - isActionable: boolean; - /**Gets or sets whether a GraphObject is the "main" object for some types of Panel.*/ - isPanelMain: boolean; - /**Gets the GraphObject's containing Layer, if there is any.*/ - layer: Layer; - /**Gets or sets the size of empty area around this GraphObject, as a Margin, in the containing Panel coordinates.*/ - margin: any; - /**Gets or sets the maximum size of this GraphObject in container coordinates (either a Panel or the document).*/ - maxSize: Size; - /**Gets the measuredBounds of the GraphObject in container coordinates (either a Panel or the document).*/ - measuredBounds: Rect; - /**Gets or sets the minimum size of this GraphObject in container coordinates (either a Panel or the document).*/ - minSize: Size; - /**Gets or sets the function to execute when the user moves the mouse into this stationary object during a DraggingTool drag.*/ - mouseDragEnter: (a:InputEvent, b:GraphObject, c:GraphObject)=>any; - /**Gets or sets the function to execute when the user moves the mouse out of this stationary object during a DraggingTool drag.*/ - mouseDragLeave: (a: InputEvent, b: GraphObject, c: GraphObject) => any; - /**Gets or sets the function to execute when a user drops the selection on this object at the end of a DraggingTool drag.*/ - mouseDrop: (a: InputEvent, b: GraphObject) => any; - /**Gets or sets the function to execute when the user moves the mouse into this object without holding down any buttons.*/ - mouseEnter: (a: InputEvent, b: GraphObject, c:GraphObject) => any; - /**Gets or sets the function to execute when the user holds the mouse stationary in the background of the diagram while holding down a button over this object.*/ - mouseHold: (a: InputEvent, b: GraphObject) => any; - /**Gets or sets the function to execute when the user holds the mouse stationary in the background of the diagram without holding down any buttons over this object.*/ - mouseHover: (a: InputEvent, b: GraphObject) => any; - /**Gets or sets the function to execute when the user moves the mouse into this object without holding down any buttons.*/ - mouseLeave: (a: InputEvent, b: GraphObject, c: GraphObject) => any; - /**Gets or sets the function to execute when the user moves the mouse over this object without holding down any buttons.*/ - mouseOver: (a: InputEvent, b: GraphObject) => any; - /**Gets or sets the name for this object.*/ - name: string; - /**Gets the natural bounding rectangle of this GraphObject in local coordinates, before any transformation by #scale or #angle, and before any resizing due to #minSize or #maxSize or #stretch.*/ - naturalBounds: Rect; - /**Gets the GraphObject's containing Panel, or null if this object is not in a Panel.*/ - panel: Panel; - /**Gets the Part containing this object, if any.*/ - part: Part; - /**Gets or sets whether or not this GraphObject can be chosen by visual "find" methods such as Diagram#findObjectAt.*/ - pickable: boolean; - /**Gets or sets an identifier for an object acting as a port on a Node.*/ - portId: string; - /**Gets or sets the position of this GraphObject in container coordinates (either a Panel or the document).*/ - position: Point; - /**Gets or sets the row of this GraphObject if it is in a Table Panel.*/ - row: number; - /**Gets or sets the number of rows spanned by this GraphObject if it is in a Table Panel.*/ - rowSpan: number; - /**Gets or sets the scale transform of this GraphObject.*/ - scale: number; - /**Gets or sets the fractional distance along a segment of a GraphObject that is in a Link.*/ - segmentFraction: number; - /**Gets or sets the segment index of a GraphObject that is in a Link.*/ - segmentIndex: number; - /**Gets or sets the offset of a GraphObject that is in a Link from a point on a segment.*/ - segmentOffset: Point; - /**Gets or sets the orientation of a GraphObject that is in a Link.*/ - segmentOrientation: EnumValue; - /**Gets or sets the stretch of the GraphObject.*/ - stretch: EnumValue; - /**Gets or sets how the direction of the last segment of a link going to this port is computed when the node is rotated.*/ - toEndSegmentDirection: EnumValue; - /**Gets or sets the length of the last segment of a link going to this port.*/ - toEndSegmentLength: number; - /**Gets or sets whether the user may draw Links to this port.*/ - toLinkable: any; - /**Gets or sets whether the user may draw duplicate Links to this port.*/ - toLinkableDuplicates: boolean; - /**Gets or sets whether the user may draw Links that connect to this port's Node.*/ - toLinkableSelfNode: boolean; - /**Gets or sets the maximum number of links that may go into this port.*/ - toMaxLinks: number; - /**This Adornment is shown when the mouse hovers over this object.*/ - toolTip: Adornment; - /**Gets or sets how far the end segment of a link going to this port stops short of the actual port.*/ - toShortLength: number; - /**Gets or sets where a link should connect to this port.*/ - toSpot: Spot; - /**Gets or sets whether a GraphObject is visible.*/ - visible: boolean; - /**Gets or sets the desired width of this GraphObject in local coordinates.*/ - width: number; - /**Add a data-binding of a property on this GraphObject to a property on a data object. - * @param {Binding} binding*/ - bind(binding: Binding); - /**Creates a deep copy of this GraphObject and returns it.*/ - copy(): GraphObject; - /**Returns the effective angle that the object is drawn at, in document coordinates.*/ - getDocumentAngle(): number; - /**Returns the Point in document coordinates for a given Spot in this object's bounds. - * @param {Spot} s a real Spot describing a location relative to the GraphObject. - * @param {Point=} result an optional Point that is modified and returned.*/ - getDocumentPoint(s: Spot, result?: Point): Point; - /**Returns the total scale that the object is drawn at, in document coordinates.*/ - getDocumentScale(): number; - /**Given a Point in document coordinates, returns a new Point in local coordinates. - * @param {Point} p a Point in document coordinates. - * @param {Point=} result an optional Point that is modified and returned.*/ - getLocalPoint(p: Point, result?: Point): Point; - /**This predicate is true if this object is an element, perhaps indirectly, of the given panel. - * @param {GraphObject} panel - * or if it is contained by another panel that is contained by the given panel, - * to any depth; false if the argument is null or is not a Panel.*/ - isContainedBy(panel: Panel): boolean; - /**This predicate is true if this object is #visible and each of its visual containing panels are also visible.*/ - isVisibleObject(): boolean; - /**This static function builds an object given its class and additional arguments providing initial properties or GraphObjects that become Panel elements. - * @param {function()|string} type a class function or the name of a class in the "go" namespace, - * or one of several predefined kinds of Panels: "Button", "TreeExpanderButton", - * "SubGraphExpanderButton", or "ContextMenuButton". - * @param {...*} initializers zero or more values that initialize the new object, - * typically an Object with properties whose values that get set on the new object, - * or a GraphObject that is added to a Panel, - * or a Binding for one of the new object's properties, - * or an EnumValue as the initial value of a single property of the new object that - * is recognized to take that value, - * or a string that is used as the value of a commonly set property.*/ - static make(type: any, ...initializers: any[]): any; - /**GraphObjects with this as the value of GraphObject#stretch are stretched depending on the context they are used.*/ - static Default: EnumValue; - /**GraphObjects with this as the value of GraphObject#stretch are scaled in both directions so as to fit exactly in the given bounds; there is no clipping but the aspect ratio may change, causing the object to appear stretched.*/ - static Fill: EnumValue; - /**GraphObjects with this as the value of GraphObject#stretch are scaled as much as possible in the x-axis*/ - static Horizontal: EnumValue; - /**GraphObjects with this as the value of GraphObject#stretch are not automatically scaled to fit in the given bounds; there may be clipping in one or both directions.*/ - static None: EnumValue; - /**Pictures with this as the value of Picture#imageStretch are drawn with equal scale in both directions to fit the arranged (actual) bounds.*/ - static Uniform: EnumValue; - /**Pictures with this as the value of Picture#imageStretch are drawn with equal scale in both directions to fit the larger side of the image bounds.*/ - static UniformToFill: EnumValue; - /**GraphObjects with this as the value of GraphObject#stretch are scaled as much as possible in the y-axis*/ - static Vertical: EnumValue; - } - /** - * This simple layout places all of the Parts in a grid-like arrangement, ordered, spaced apart, - * and wrapping as needed. It ignores any Links connecting the Nodes being laid out. - */ - class Group extends Node { - /**Constructs an empty Group with no visual elements and no member parts; normally a Group will have some visual elements surrounding a Placeholder. - * @param {EnumValue=} type if not supplied, the default Panel type is {@link Panel#Position}. - */ - constructor(type?: EnumValue); - /**Gets or sets whether the size of the area of the Group's #placeholder should remain the same during a DraggingTool move until a drop occurs.*/ - computesBoundsAfterDrag: boolean; - /**Gets or sets whether the subgraph contained by this group is expanded.*/ - isSubGraphExpanded: boolean; - /**Gets or sets the Layout used to position all of the immediate member nodes and links in this group.*/ - layout: Layout; - /**Gets or sets the function that is called after a member Part has been added to this Group.*/ - memberAdded: (a:Group, b:Part)=>any; - /**Gets an iterator over the member Parts of this Group.*/ - memberParts: Iterator; - /**Gets or sets the function that is called after a member Part has been removed from this Group.*/ - memberRemoved: (a: Group, b: Part) => any; - /**Gets or sets the predicate that determines whether or not a Part may become a member of this group.*/ - memberValidation: (a: Group, b: Part) => boolean; - /**Gets a Placeholder that this group may contain in its visual tree.*/ - placeholder: Placeholder; - /**Gets or sets the function that is called when #isSubGraphExpanded has changed value.*/ - subGraphExpandedChanged: (a: Group) => any; - /**Gets or sets whether the user may ungroup this group.*/ - ungroupable: boolean; - /**Gets or sets whether the subgraph starting at this group had been collapsed by a call to #expandSubGraph on the containing Group.*/ - wasSubGraphExpanded: boolean; - /**Add the Parts in the given collection as members of this Group for those Parts for which CommandHandler#isValidMember returns true. - * @param {Iterable} coll - * @param {boolean=} check whether to call CommandHandler#isValidMember to confirm that it is valid to add the Part to be a member of this Group. - */ - addMembers(coll: Iterable, check?: boolean): boolean; - /**See if the given collection of Parts contains non-Links all for which CommandHandler#isValidMember returns true. - * @param {Iterable} coll*/ - canAddMembers(coll: Iterable): boolean; - /**This predicate returns true if #ungroupable is true, if the layer's Layer#allowUngroup is true, and if the diagram's Diagram#allowUngroup is true.*/ - canUngroup(): boolean; - /**Hide each of the member nodes and links of this group, and recursively collapse any member groups.*/ - collapseSubGraph(); - /**Show each member node and link, and perhaps recursively expand nested subgraphs.*/ - expandSubGraph(); - /**Return a collection of Parts that are all of the nodes and links that are members of this group, including inside nested groups, but excluding this group itself.*/ - findSubGraphParts(): Set; - /**Move this Group and all of its member parts, recursively. - * @param {Point} newpos a new Point in document coordinates.*/ - move(newpos: Point); - } - /** - * An InputEvent represents a mouse or keyboard event. - * The principal properties hold information about a particular input event. - * These properties include the #documentPoint at which a mouse event - * occurred in document coordinates, - * the corresponding point in view/element coordinates, #viewPoint, - * the #key for keyboard events, - * and the #modifiers and #button at the time. - * Additional descriptive properties include #clickCount, #delta, - * #timestamp, and the source event #event (if available). - */ - class InputEvent { - /**The InputEvent class constructor produces an empty InputEvent.*/ - constructor(); - /**Gets whether the alt key is being held down.*/ - alt: boolean; - /**Gets or sets whether the underlying #event is prevented from bubbling up the hierarchy of HTML elements outside of the Diagram and whether any default action is canceled.*/ - bubbles: boolean; - /**Gets or sets the button that caused this event.*/ - button: number; - /**Gets or sets whether this event represents a click or a double-click.*/ - clickCount: number; - /**Gets whether the control key is being held down.*/ - control: boolean; - /**Gets or sets the amount of change associated with a mouse-wheel rotation.*/ - delta: number; - /**Gets the source diagram associated with the event.*/ - diagram: Diagram; - /**Gets or sets the point at which this input event occurred, in document coordinates.*/ - documentPoint: Point; - /**Gets or sets whether the InputEvent represents a mouse-down or a key-down event.*/ - down: boolean; - /**Gets or sets the platform's user-agent-supplied event for this event.*/ - event: Event; - /**Gets or sets whether an InputEvent that applies to a GraphObject and bubbles up the chain of containing Panels is stopped from continuing up the chain.*/ - handled: boolean; - /**Gets or sets the key pressed or released as this event.*/ - key: string; - /**Gets whether the logical left mouse button is being held down.*/ - left: boolean; - /**Gets whether the meta key is being held down.*/ - meta: boolean; - /**Gets whether the logical middle mouse button is being held down.*/ - middle: boolean; - /**Gets or sets the modifier keys that were used with the mouse or keyboard event.*/ - modifiers: number; - /**Gets whether the logical right mouse button is being held down.*/ - right: boolean; - /**Gets whether the shift key is being held down.*/ - shift: boolean; - /**Gets or sets the diagram associated with the canvas that the event is currently targeting.*/ - targetDiagram: Diagram; - /**Gets or sets the GraphObject that is at the current mouse point, if any.*/ - targetObject: GraphObject; - /**Gets or sets the time at which the event occurred, in milliseconds.*/ - timestamp: number; - /**Gets or sets whether the InputEvent represents a mouse-up or a key-up event.*/ - up: boolean; - /**Gets or sets the point at which this input event occurred.*/ - viewPoint: Point; - /**Make a copy of this InputEvent.*/ - copy(): InputEvent; - } - /** - * Layers are how named collections of Part}s are drawn in front or behind other collections of Parts in a Diagram}. - * Layers can only contain Part}s -- they cannot hold GraphObject}s directly. - */ - class Layer { - /**This constructs an empty Layer; you should set the #name before adding the Layer to a Diagram.*/ - constructor(); - /**Gets or sets whether the user may copy objects in this layer.*/ - allowCopy: boolean; - /**Gets or sets whether the user may delete objects in this layer.*/ - allowDelete: boolean; - /**Gets or sets whether the user may group parts together in this layer.*/ - allowGroup: boolean; - /**Gets or sets whether the user may draw new links in this layer.*/ - allowLink: boolean; - /**Gets or sets whether the user may move objects in this layer.*/ - allowMove: boolean; - /**Gets or sets whether the user may reconnect existing links in this layer.*/ - allowRelink: boolean; - /**Gets or sets whether the user may reshape parts in this layer.*/ - allowReshape: boolean; - /**Gets or sets whether the user may resize parts in this layer.*/ - allowResize: boolean; - /**Gets or sets whether the user may rotate parts in this layer.*/ - allowRotate: boolean; - /**Gets or sets whether the user may select objects in this layer.*/ - allowSelect: boolean; - /**Gets or sets whether the user may do in-place text editing in this layer.*/ - allowTextEdit: boolean; - /**Gets or sets whether the user may ungroup existing groups in this layer.*/ - allowUngroup: boolean; - /**Gets the Diagram that is using this Layer.*/ - diagram: Diagram; - /**Gets or sets whether the objects in this layer are considered temporary.*/ - isTemporary: boolean; - /**Gets or sets the name for this layer.*/ - name: string; - /**Gets or sets the opacity for all parts in this layer.*/ - opacity: number; - /**Gets an iterator for this Layer's Parts.*/ - parts: Iterator; - /**Gets a backwards iterator for this Layer's Parts, for iterating over the parts in reverse order.*/ - partsBackwards: Iterator; - /**Gets or sets whether methods such as #findObjectAt find any of the objects in this layer.*/ - pickable: boolean; - /**Gets or sets whether the user may view any of the objects in this layer.*/ - visible: boolean; - /**Find the front-most GraphObject in this layer at the given point in document coordinates. - * @param {Point} p A Point in document coordinates. - * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and - * returning a GraphObject, defaulting to the identity. - * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject - * returned by navig and returning true if that object should be returned, - * defaulting to a predicate that always returns true.*/ - findObjectAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject)=>boolean): GraphObject; - /**Return a collection of the GraphObjects of this layer at the given point in document coordinates. - * @param {Point} p A Point in document coordinates. - * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and - * returning a GraphObject, defaulting to the identity. - * If this function returns null, the given GraphObject will not be included in the results. - * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject - * returned by navig and returning true if that object should be returned, - * defaulting to a predicate that always returns true. - * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ - findObjectsAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, coll?: List): Iterable; - findObjectsAt(p: Point, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, coll?: Set): Iterable; - /**Returns a collection of all GraphObjects that are inside or that intersect a given Rect in document coordinates. - * @param {Rect} r A Rect in document coordinates. - * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and - * returning a GraphObject, defaulting to the identity. - * If this function returns null, the given GraphObject will not be included in the results. - * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject - * returned by navig and returning true if that object should be returned, - * defaulting to a predicate that always returns true. - * @param {*=} partialInclusion Whether an object can match if it merely intersects the rectangular area (true) or - * if it must be entirely inside the rectangular area (false). The default value is false. - * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ - findObjectsIn(r: Rect, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: any, coll?: List): Iterable; - findObjectsIn(r: Rect, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, partialInclusion?: any, coll?: Set): Iterable; - /**Returns a collection of all GraphObjects that are within a certain distance of a given point in document coordinates. - * @param {Point} p A Point in document coordinates. - * @param {number} dist The distance from the point. - * @param {function(GraphObject):GraphObject | null=} navig A function taking a GraphObject and - * returning a GraphObject, defaulting to the identity. - * If this function returns null, the given GraphObject will not be included in the results. - * @param {function(GraphObject):boolean | null=} pred A function taking the GraphObject - * returned by navig and returning true if that object should be returned, - * defaulting to a predicate that always returns true. - * @param {*=} partialInclusion Whether an object can match if it merely intersects the circular area (true) or - * if it must be entirely inside the circular area (false). The default value is true. - * @param {List|Set=} coll An optional collection (List or Set) to add the results to.*/ - findObjectsNear(p: Point, dist: number, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, coll?: List): Iterable; - findObjectsNear(p: Point, dist: number, navig?: (obj: GraphObject) => GraphObject, pred?: (obj: GraphObject) => boolean, coll?: Set): Iterable; - } - /** - * A Link is a Part that connects Nodes. - * The link relationship is directional, going from Link#fromNode to Link#toNode. - * A link can connect to a specific port element in a node, as named by the Link#fromPortId - * and Link#toPortId properties. - */ - class Link extends Part { - /**Constructs an empty link that does not connect any nodes.*/ - constructor(); - /**Gets or sets how the route is computed, including whether it uses the points of its old route to determine the new route.*/ - adjusting: EnumValue; - /**Gets or sets how rounded the corners are for adjacent line segments when the #curve is #None #JumpGap, or #JumpOver and the two line segments are orthogonal to each other.*/ - corner: number; - /**Gets or sets the way the path is generated from the route's points.*/ - curve: EnumValue; - /**Gets or sets how far the control points are offset when the #curve is #Bezier or when there are multiple links between the same two ports.*/ - curviness: number; - /**Gets or sets how the direction of the last segment is computed when the node is rotated.*/ - fromEndSegmentDirection: EnumValue; - /**Gets or sets the length of the last segment.*/ - fromEndSegmentLength: number; - /**Gets or sets the Node that this link comes from.*/ - fromNode: Node; - /**Gets a GraphObject that is the "from" port that this link is connected from.*/ - fromPort: GraphObject; - /**Gets or sets the function that is called after this Link changes which Node or port it connects from.*/ - fromPortChanged: (a:Link, b:GraphObject, c:GraphObject)=>any ; - /**Gets or sets the identifier of the port that this link comes from.*/ - fromPortId: string; - /**Gets or sets how far the end segment stops short of the actual port.*/ - fromShortLength: number; - /**Gets or sets where this link should connect at the #fromPort.*/ - fromSpot: Spot; - /**Gets the Geometry that is used by the #path, the link Shape based on the route points.*/ - geometry: Geometry; - /**This read-only property is true when this Link has any label Nodes, Nodes that are owned by this Link and are arranged along its path.*/ - isLabeledLink: boolean; - /**Gets or sets whether this Link is part of the tree for tree operations such as Node#findTreeChildrenNodes or Node#collapseTree.*/ - isTreeLink: boolean; - /**This read-only property true if #routing is a value that implies that the points of the route should be orthogonal, such that each point shares a common X or a common Y value with the immediately previous and next points.*/ - isOrthogonal: boolean; - /**Gets an iterator over the Nodes that act as labels on this Link.*/ - labelNodes: Iterator; - /**Gets the angle of the path at the #midPoint.*/ - midAngle: number; - /**Gets the point at the middle of the path.*/ - midPoint: Point; - /**Gets the Shape representing the path of this Link.*/ - path: Shape; - /**Gets or sets the List of Points in the route.*/ - points: List; - /**Gets the number of points in the route.*/ - pointsCount: number; - /**Gets or sets whether the user may reconnect an existing link at the "from" end.*/ - relinkableFrom: boolean; - /**Gets or sets whether the user may reconnect an existing link at the "to" end.*/ - relinkableTo: boolean; - /**Gets or sets whether the user may change the number of segments in this Link, if the link has straight segments.*/ - resegmentable: boolean; - /**Gets or sets whether the link's path tries to avoid other nodes.*/ - routing: EnumValue; - /**Gets or sets how far the control points are from the points of the route when #routing is #Orthogonal and #curve is #Bezier.*/ - smoothness: number; - /**Gets or sets how far the control points are from the points of the route when #routing is #Orthogonal and #curve is #Bezier.*/ - toEndSegmentDirection: EnumValue; - /**Gets or sets the length of the last segment.*/ - toEndSegmentLength: number; - /**Gets or sets the Node that this link goes to.*/ - toNode: Node; - /**Gets a GraphObject that is the "to" port that this link is connected to.*/ - toPort: GraphObject; - /**Gets or sets the function that is called after this Link changes which Node or port it connects to.*/ - toPortChanged: (a: Link, b: GraphObject, c: GraphObject) => any ; - /**Gets or sets the identifier of the port that this link goes to.*/ - toPortId: string; - /**Gets or sets how far the end segment stops short of the actual port.*/ - toShortLength: number; - /**Gets or sets where this link should connect at the #toPort.*/ - toSpot: Spot; - /**This predicate returns true if #relinkableFrom is true, if the layer's Layer#allowRelink is true, and if the diagram's Diagram#allowRelink is true.*/ - canRelinkFrom(): boolean; - /**This predicate returns true if #relinkableTo is true, if the layer's Layer#allowRelink is true, and if the diagram's Diagram#allowRelink is true.*/ - canRelinkTo(): boolean; - /**Find the index of the segment that is closest to a given point. - * @param {Point} p the Point, in document coordinates. - */ - findClosestSegment(p: Point): number; - /**Compute the direction in which a link should go from a given connection point. - * @param {Node} node - * @param {GraphObject} port the GraphObject representing a port on the node. - * @param {Point} linkpoint the connection point, in document coordinates. - * @param {Spot} spot a Spot value describing where the link should connect. - * @param {boolean} from true if the link is coming out of the port; false if going to the port. - * @param {boolean} ortho whether the link should have orthogonal segments. - * @param {Node} othernode the node at the other end of the link. - * @param {GraphObject} otherport the GraphObject port at the other end of the link.*/ - getLinkDirection(node: Node, port: GraphObject, linkpoint: Point, spot: Spot, from: boolean, ortho: boolean, othernode: Node, otherport: GraphObject): number; - /**Compute the point on a node/port at which the route of a link should end. - * @param {Node} node - * @param {GraphObject} port the GraphObject representing a port on the node. - * @param {Spot} spot a Spot value describing where the link should connect. - * @param {boolean} from true if the link is coming out of the port; false if going to the port. - * @param {boolean} ortho whether the link should have orthogonal segments. - * @param {Node} othernode the node at the other end of the link. - * @param {GraphObject} otherport the GraphObject port at the other end of the link. - * @param {Point=} result an optional Point that is modified and returned; otherwise it allocates and returns a new Point - */ - getLinkPoint(node: Node, port: GraphObject, spot: Spot, from: boolean, ortho: boolean, othernode: Node, otherport: GraphObject, result?: Point) - /**Compute the intersection point for the edge of a particular port GraphObject, given a point, when no particular spot or side has been specified. - * @param {Node} node - * @param {GraphObject} port the GraphObject representing a port on the node. - * @param {Point} focus the point in document coordinates to/from which the link should point, - * normally the center of the port. - * @param {Point} p often this point is far away from the node, to give a general direction, - * particularly an orthogonal one. - * @param {boolean} from true if the link is coming out of the port; false if going to the port. - * @param {Point=} result an optional Point that is modified and returned; otherwise it allocates and returns a new Point - */ - getLinkPointFromPoint(node: Node, port: GraphObject, focus: Point, p: Point, from: boolean, result?: Point): Point; - /**Given a Node, return the node at the other end of this link. - * @param {Node} node - */ - getOtherNode(node: Node): Node; - /**Given a GraphObject that is a "port", return the port at the other end of this link. - * @param {GraphObject} port - */ - getOtherPort(port: GraphObject): GraphObject; - /**Gets a particular point of the route. - * @param {number} i The zero-based index of the desired point.*/ - getPoint(i: number): Point; - /**Move this link to a new position. - * @param {number} dx - * @param {number} dy*/ - move(newpos: Point); - /**Used as a value for Link#routing: each segment is horizontal or vertical, but the route tries to avoid crossing over nodes.*/ - static AvoidsNodes: EnumValue; - /**Used as a value for Link#curve, to indicate that the link path uses Bezier curve segments.*/ - static Bezier: EnumValue; - /**Used as a value for Link#adjusting, to indicate that the link route computation should keep the intermediate points of the previous route, just modifying the first and/or last points; if the routing is orthogonal, it will only modify the first two and/or last two points.*/ - static End: EnumValue; - /**Used as a value for Link#curve, to indicate that orthogonal link segments will be discontinuous where they cross over other orthogonal link segments that have a Link#curve or JumpOver or JumpGap.*/ - static JumpGap: EnumValue; - /**Used as a value for Link#curve, to indicate that orthogonal link segments will veer around where they cross over other orthogonal link segments that have a Link#curve or JumpOver or JumpGap.*/ - static JumpOver: EnumValue; - /**This is the default value for Link#curve and Link#adjusting, to indicate that the path geometry consists of straight line segments and to indicate that the link route computation does not depend on any previous route points; this can also be used as a value for GraphObject#segmentOrientation to indicate that the object is never rotated along the link route -- its angle is unchanged.*/ - static None: EnumValue; - /**Used as the default value for Link#routing: the route goes fairly straight between ports.*/ - static Normal: EnumValue; - /**This value for GraphObject#segmentOrientation results in the GraphObject turned to have the same angle as the route: the GraphObject's angle is always the same as the angle of the link's route at the segment where the GraphObject is attached; use this orientation for arrow heads.*/ - static OrientAlong: EnumValue; - /**This value for GraphObject#segmentOrientation results in the GraphObject being turned counter-clockwise to be perpendicular to the route: the GraphObject's angle is always 90 degrees less than the angle of the link's route at the segment where the GraphObject is attached.*/ - static OrientMinus90: EnumValue; - /**This value for GraphObject#segmentOrientation results in the GraphObject turned counter-clockwise to be perpendicular to the route, just like Link#OrientMinus90, but is never upside down: the GraphObject's angle always being 90 degrees less than the angle of the link's route at the segment where the GraphObject is attached; this is typically only used for TextBlocks or Panels that contain text.*/ - static OrientMinus90Upright: EnumValue; - /**This value for GraphObject#segmentOrientation results in the GraphObject's angle always being 180 degrees opposite from the angle of the link's route at the segment where the GraphObject is attached.*/ - static OrientOpposite: EnumValue; - /**This value for GraphObject#segmentOrientation results in the GraphObject is turned clockwise to be perpendicular to the route: the GraphObject's angle is always 90 degrees more than the angle of the link's route at the segment where the GraphObject is attached.*/ - static OrientPlus90: EnumValue; - /**This value for GraphObject#segmentOrientation results in the GraphObject turned clockwise to be perpendicular to the route, just like Link#OrientPlus90, but is never upside down: the GraphObject's angle always being 90 degrees more than the angle of the link's route at the segment where the GraphObject is attached; this is typically only used for TextBlocks or Panels that contain text.*/ - static OrientPlus90Upright: EnumValue; - /**This value for GraphObject#segmentOrientation results in the GraphObject turned to have the same angle as the route, just like Link#OrientAlong, but is never upside down: the GraphObject's angle always following the angle of the link's route at the segment where the GraphObject is attached; this is typically only used for TextBlocks or Panels that contain text.*/ - static OrientUpright: EnumValue; - /**This value for GraphObject#segmentOrientation results in the GraphObject's angle always following the angle of the link's route at the segment where the GraphObject is attached, but never upside down and never angled more than +/- 45 degrees: when the route's angle is within 45 degrees of vertical (90 or 270 degrees), the GraphObject's angle is set to zero; this is typically only used for TextBlocks or Panels that contain text.*/ - static OrientUpright45: EnumValue; - /**Used as a value for Link#routing: each segment is horizontal or vertical.*/ - static Orthogonal: EnumValue; - /**Used as a value for Link#adjusting, to indicate that the link route computation should scale and rotate the intermediate points so that the link's shape looks approximately the same; if the routing is orthogonal, this value is treated as if it were Link#End.*/ - static Scale: EnumValue; - /**Used as a value for Link#adjusting, to indicate that the link route computation should linearly interpolate the intermediate points so that the link's shape looks stretched; if the routing is orthogonal, this value is treated as if it were Link#End.*/ - static Stretch: EnumValue; - } - /** - * A Node is a Part that may connect to other nodes with Links, - * or that may be a member of a Group. - * Group inherits from Node, - * enabling nodes to logically contain other nodes and links. - */ - class Node extends Part { - /**Constructs an empty Node. - * @param {EnumValue=} type if not supplied, the default Panel type is Panel#Position. - */ - constructor(type?: EnumValue); - /**Gets or sets whether this Node is to be avoided by Links whose Link#routing is Link#AvoidsNodes.*/ - avoidable: boolean; - /**Gets or sets the margin around this Node in which avoidable links will not be routed.*/ - avoidableMargin: Margin; - /**Gets whether a Node is a label node for a Link.*/ - isLinkLabel: boolean; - /**Gets or sets whether the subtree graph starting at this node is expanded.*/ - isTreeExpanded: boolean; - /**Gets whether this node has no tree children.*/ - isTreeLeaf: boolean; - /**Gets or sets the Link for which this Node is acting as a smart label.*/ - labeledLink: Link; - /**Gets or sets the function that is called after a Link has been connected with this Node.*/ - linkConnected: (a:Node, b:Link, c:GraphObject)=>any; - /**Gets or sets the function that is called after a Link has been disconnected from this Node.*/ - linkDisconnected: (a: Node, b: Link, c: GraphObject) => any; - /**Gets an iterator over all of the Links that are connected with this node.*/ - linksConnected: Iterator; - /**Get the primary GraphObject representing a port in this node.*/ - port: GraphObject; - /**Gets an iterator over all of the GraphObjects in this node that act as ports.*/ - ports: Iterator; - /**Gets or sets the function that is called when #isTreeExpanded has changed value.*/ - treeExpandedChanged: (node:Node)=>any; - /**Gets or sets whether the subtree graph starting at this node had been collapsed by a call to #expandTree on the parent node.*/ - wasTreeExpanded: boolean; - /**Hide each child node and the connecting link, and recursively collapse each child node. - * @param {number=} level How many levels of the tree, starting at this node, to keep expanded if already expanded; - * the default is 1, hiding all tree children of this node. Values less than 1 are treated as 1. - */ - collapseTree(level?: number); - /**Show each child node and the connecting link, and perhaps recursively expand their child nodes. - * @param {number=} level How many levels of the tree should be expanded; - * the default is 2, showing all tree children of this node and potentially more. - * Values less than 2 are treated as 2.*/ - expandTree(level?: number); - /**Returns an iterator over all of the Links that go from this node to another node or vice-versa, perhaps limited to a given port id on this node and a port id on the other node. - * @param {Node} othernode - * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. - * @param {string|null=} otherpid A port identifier string; if null the link's portId is ignored and all links are included in the search. - */ - findLinksBetween(othernode: Node, pid?: string, otherpid?: string): Iterator; - /**Returns an iterator over all of the Links that connect with this node in either direction, perhaps limited to the given port id on this node. - * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. - */ - findLinksConnected(pid?: string): Iterator; - /**Returns an iterator over all of the Links that go into this node, perhaps limited to the given port id on this node. - * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. - */ - findLinksInto(pid?: string): Iterator; - /**Returns an iterator over all of the Links that come out of this node, perhaps limited to the given port id on this node. - * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. - */ - findLinksOutOf(pid?: string): Iterator; - /**Returns an iterator over all of the Links that go from this node to another node, perhaps limited to a given port id on this node and a port id on the other node. - * @param {Node} othernode - * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. - * @param {string|null=} otherpid A port identifier string; if null the link's portId is ignored and all links are included in the search. - */ - findLinksTo(othernode: Node, pid?: string, otherpid?: string): Iterator; - /**Returns an iterator over the Nodes that are connected with this node in either direction, perhaps limited to the given port id on this node. - * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. - */ - findNodesConnected(pid?: string): Iterator; - /**Returns an iterator over the Nodes that are connected with this node by links going into this node, perhaps limited to the given port id on this node. - * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. - */ - findNodesInto(pid?: string): Iterator; - /**Returns an iterator over the Nodes that are connected with this node by links coming out of this node, perhaps limited to the given port id on this node. - * @param {string|null=} pid A port identifier string; if null the link's portId is ignored and all links are included in the search. - */ - findNodesOutOf(pid?: string): Iterator; - /**Find a GraphObject with a given GraphObject#portId. - * @param {string} pid*/ - findPort(pid: string): GraphObject; - /**Returns an Iterator for the collection of Links that connect with the immediate tree children of this node.*/ - findTreeChildrenLinks(): Iterator; - /**Returns an Iterator for the collection of Nodes that are the immediate tree children of this node.*/ - findTreeChildrenNodes(): Iterator; - /**Returns the Link that connects with the tree parent Node of this node if the graph is tree-structured, if there is such a link and Link#isTreeLink is true.*/ - findTreeParentLink(): Link; - /**Returns the Node that is the tree parent of this node if the graph is tree-structured, if there is a parent.*/ - findTreeParentNode(): Node; - /**Return a collection of Parts including this Node, all of the Links going to child Nodes, and all of their tree child nodes and links. - * @param {number=} level How many levels of the tree, starting at this node, to include; - * the default is Infinity, including all tree children of this node. Values less than 1 are treated as 1. - */ - findTreeParts(level?: number): Set; - /**Return the Node that is at the root of the tree that this node is in, perhaps this node itself.*/ - findTreeRoot(): Node; - /**This predicate is true if this node is a child of the given Node, perhaps indirectly as a descendant. - * @param {Node} node the Node that might be a parent or ancestor of this node.*/ - isInTreeOf(node: Node): boolean; - /**This value for GraphObject#fromEndSegmentDirection and GraphObject#toEndSegmentDirection indicates that the link's end segment angle stays the same even if the node is rotated.*/ - static DirectionAbsolute: EnumValue; - /**This value for Link#fromEndSegmentDirection and Link#toEndSegmentDirection indicates that the real value is inherited from the corresponding connected port.*/ - static DirectionDefault: EnumValue; - /**This value for GraphObject#fromEndSegmentDirection and GraphObject#toEndSegmentDirection indicates that the link's end segment angle is rotated to match the node's angle.*/ - static DirectionRotatedNode: EnumValue; - /**This value for GraphObject#fromEndSegmentDirection and GraphObject#toEndSegmentDirection indicates that the link's end segment angle is rotated to match the node's angle, but only in increments of 90 degrees.*/ - static DirectionRotatedNodeOrthogonal: EnumValue; - } - /** - * An Overview is a Diagram that displays all of a different diagram, - * with a rectangular box showing the viewport displayed by that other diagram. - * All you need to do is set Overview#observed. - */ - class Overview extends Diagram { - /* @param {Element|string } div A reference to a div or its ID as a string.*/ - constructor(div: string); - constructor(div?: Element); - /**Gets pr sets the rectangular Part that represents the viewport of the #observed Diagram.*/ - box: Part; - /**Gets or sets the Diagram for which this Overview is displaying a model and showing its viewport into that model.*/ - observed: Diagram; - } - /** - * Palette extends the Diagram class to allow objects to be dragged and placed onto other Diagrams. - * Its Diagram#layout is a GridLayout. - * The Palette is Diagram#isReadOnly but to support drag-and-drop its Diagram#allowDragOut is true. - */ - class Palette extends Diagram { - /* @param {HTMLDivElement|string } div A reference to a div or its ID as a string.*/ - constructor(...args: any[]); - } - /** - * A Panel is a GraphObject that holds other GraphObjects as its elements. - * A Panel is responsible for sizing and positioning its elements. - * Every Panel has a #type and establishes its own coordinate system. The #type of a Panel - * determines how it will size and arrange its elements. - */ - class Panel extends GraphObject { - /**Constructs an empty Panel of the given #type. - * @param {EnumValue=} type If not supplied, the default Panel type is Panel#Position. - */ - constructor(type?: EnumValue); - /**Gets the number of columns in this Panel if it is of #type Panel#Table.*/ - columnCount: number; - /**Gets or sets how this Panel's columns deal with extra space if the Panel is of #type Panel#Table.*/ - columnSizing: EnumValue; - /**Gets or sets the optional model data to which this panel is data-bound.*/ - data: Object; - /**Gets or sets the default alignment spot of this Panel, used as the alignment for an element when its GraphObject#alignment value is Spot#Default.*/ - defaultAlignment: Spot; - /**Gets or sets the default dash array for a particular column's separator.*/ - defaultColumnSeparatorDashArray: Array; - /**Gets or sets the default stroke (color) for columns in a Table Panel provided a given column has a nonzero RowColumnDefinition#separatorStrokeWidth.*/ - defaultColumnSeparatorStroke: any; - /**Gets or sets the default stroke width for a particular column's separator.*/ - defaultColumnSeparatorStrokeWidth: number; - /**Gets or sets the default dash array for a particular row's separator.*/ - defaultRowSeparatorDashArray: Array; - /**Gets or sets the default stroke (color) for rows in a Table Panel provided a given row has a nonzero RowColumnDefinition#separatorStrokeWidth.*/ - defaultRowSeparatorStroke: any; - /**Gets or sets the default stroke width for a particular row's separator.*/ - defaultRowSeparatorStrokeWidth: any; - /**Gets or sets the additional padding for a particular row or column.*/ - defaultSeparatorPadding: Margin; - /**Gets or sets the default stretch of this Panel, used as the stretch for an element when its GraphObject#stretch value is GraphObject#Default.*/ - defaultStretch: EnumValue; - /**Gets an iterator over the collection of the GraphObjects that this panel manages.*/ - elements: Iterator; - /**Gets or sets the distance between lines in a #Grid panel.*/ - gridCellSize: Size; - /**Gets or sets an origin point for the grid cells in a #Grid panel.*/ - gridOrigin: Point; - /**Gets or sets a JavaScript Array of values or objects, each of which will be represented by a Panel as elements in this Panel.*/ - itemArray: Array; - /**Gets or sets the name of the item data property that returns a string describing that data's category, or a function that takes an item data object and returns that string; the default value is the name 'category'.*/ - itemCategoryProperty: any; - /**Gets or sets the default Panel template used as the archetype for item data that are in #itemArray.*/ - itemTemplate: Panel; - /**Gets or sets a Map mapping template names to Panels.*/ - itemTemplateMap: Map; - /**Gets or sets the first column that this Panel of #type Panel#Table displays.*/ - leftIndex: number; - /**Gets or sets the multiplicative opacity for this Panel and all children.*/ - opacity: number; - /**Gets or sets the space between this Panel's border and its content, depending on the type of panel.*/ - padding: any; - /**Gets the number of row in this Panel if it is of #type Panel#Table.*/ - rowCount: number; - /**Gets or sets how this Panel's rows deal with extra space if the Panel is of #type Panel#Table.*/ - rowSizing: EnumValue; - /**Gets or sets the first row that this this Panel of #type Panel#Table displays.*/ - topIndex: number; - /**Gets or sets the type of the Panel.*/ - type: EnumValue; - /**Gets or sets how a #Viewbox panel will resize its content.*/ - viewboxStretch: EnumValue; - /**Adds a GraphObject to the end of this Panel's list of elements, visually in front of all of the other elements. - * @param {GraphObject} element A GraphObject.*/ - add(element: GraphObject); - /**Creates a deep copy of this Panel and returns it.*/ - copy(): Panel; - /**Returns the GraphObject in this Panel's list of elements at the specified index.*/ - elt(idx: number); - /**Returns the cell at a given x-coordinate in local coordinates. - * @param {number} x*/ - findColumnForLocalX(x: number); - /**Search the visual tree starting at this Panel for a GraphObject whose GraphObject#name is the given name. - * @param {string} name The name to search for, using a case-sensitive string comparison.*/ - findObject(name: string): GraphObject; - /**Returns the row at a given y-coordinate in local coordinates. - * @param {number} y*/ - findRowForLocalY(y: number); - /**Gets the RowColumnDefinition for a particular column in this Table Panel. - * @param {number} idx the non-negative zero-based integer column index.*/ - getColumnDefinition(idx: number): RowColumnDefinition; - /**Gets the RowColumnDefinition for a particular row in this Table Panel. - * @param {number} idx the non-negative zero-based integer row index.*/ - getRowDefinition(idx: number): RowColumnDefinition; - /**Adds a GraphObject to the Panel's list of elements at the specified index. - * @param {number} index - * @param {GraphObject} element A GraphObject.*/ - insertAt(index: number, element: GraphObject); - /**Removes a GraphObject from this Panel's list of elements. - * @param {GraphObject} element A GraphObject.*/ - remove(element: GraphObject); - /**Removes an GraphObject from this Panel's list of elements at the specified index. - * @param {number} idx*/ - removeAt(idx: number); - /**Removes the RowColumnDefinition for a particular row in this Table Panel. - * @param {number} idx the non-negative zero-based integer row index.*/ - removeColumnDefinition(idx: number); - /**Removes the RowColumnDefinition for a particular row in this Table Panel. - * @param {number} idx the non-negative zero-based integer row index.*/ - removeRowDefinition(idx: number); - /**Re-evaluate all data bindings on this panel, in order to assign new property values to the GraphObjects in this visual tree based on this this object's #data property values. - * @param {string=} srcprop An optional source data property name: - * when provided, only evaluates those Bindings that use that particular property; - * when not provided or when it is the empty string, all bindings are evaluated. - */ - updateTargetBindings(srcprop?: string); - /**This value for #type resizes the main element to fit around the other elements; the main element is the first GraphObject with GraphObject#isPanelMain set to true, or else the first GraphObject if none have that property set to true.*/ - static Auto: EnumValue; - /**This value for #type is used to draw regular patterns of lines.*/ - static Grid: EnumValue; - /**This value for #type lays out the elements horizontally with their GraphObject#alignment property dictating their alignment on the Y-axis.*/ - static Horizontal: EnumValue; - /**This value for #type is used for Links and adornments that act as Links.*/ - static Link: EnumValue; - /**The default #type arranges each element according to their GraphObject#position.*/ - static Position: EnumValue; - /**This value for #type arranges GraphObjects about a main element using the GraphObject#alignment and GraphObject#alignmentFocus properties; the main element is the first GraphObject with GraphObject#isPanelMain set to true, or else the first GraphObject if none have that property set to true.*/ - static Spot: EnumValue; - /**This value for #type arranges GraphObjects into rows and columns; set the GraphObject#row and GraphObject#column properties on each element.*/ - static Table: EnumValue; - /**Organizational Panel type that is only valid inside of a Table panel.*/ - static TableColumn: EnumValue; - /**Organizational Panel type that is only valid inside of a Table panel.*/ - static TableRow: EnumValue; - /**This value for #type lays out the elements vertically with their GraphObject#alignment property dictating their alignment on the X-axis.*/ - static Vertical: EnumValue; - /**This value for #type rescales a single GraphObject to fit inside the panel depending on the element's GraphObject#stretch property.*/ - static Viewbox: EnumValue; - } - /** - * This is the base class for all user-manipulated top-level objects. - * Because it inherits from Panel}, it is automatically a visual container - * of other GraphObject}s. - * Because it thus also inherits from GraphObject}, it also has properties such as - * GraphObject#actualBounds}, GraphObject#contextMenu}, and GraphObject#visible}. - */ - class Part extends Panel { - /**The constructor builds an empty Part. - * @param {EnumValue=} type if not supplied, the default Panel type is Panel#Position. - */ - constructor(type?: EnumValue); - /**Gets an iterator over all of the Adornments associated with this part.*/ - adornments: Iterator; - /**Gets or sets the category of this part, typically used to distinguish different kinds of nodes or links.*/ - category: string; - /**Gets or sets the Group of which this Part or Node is a member.*/ - containingGroup: Group; - /**Gets or sets the function that is called after this Part has changed which Group it belongs to, if any.*/ - containingGroupChanged: any; - /**Gets or sets whether the user may copy this part.*/ - copyable: boolean; - /**Gets or sets whether the user may delete this part.*/ - deletable: boolean; - /**Gets the Diagram that this Part is in.*/ - diagram: Diagram; - /**Gets or sets the function used to determine the location that this Part can be dragged to.*/ - dragComputation: (a:Part, b:Point, c:Point)=>Point; - /**Gets or sets whether the user may group this part to be a member of a new Group.*/ - groupable: boolean; - /**Gets or sets whether this Part is part of the document bounds.*/ - isInDocumentBounds: boolean; - /**Gets or sets whether a Layout positions this Node or routes this Link.*/ - isLayoutPositioned: boolean; - /**Gets or sets whether this Part is selected.*/ - isSelected: boolean; - /**Gets or sets whether this part will draw shadows.*/ - isShadowed: boolean; - /**Gets whether this part is not member of any Group node nor is it a label node for a Link.*/ - isTopLevel: boolean; - /**Gets the Layer that this Part is in.*/ - layer: Layer; - /**Gets or sets the function to execute when this part changes layers.*/ - layerChanged: (a:Part, b:Layer, c:Layer)=>any; - /**Gets or sets the layer name for this part.*/ - layerName: string; - /**Gets or sets flags that control when the Layout that is responsible for this Part is invalidated.*/ - layoutConditions: number; - /**Gets or sets the position of this part in document coordinates, based on the #locationSpot in this part's #locationObject.*/ - location: Point; - /**Gets the GraphObject that determines the location of this Part.*/ - locationObject: GraphObject; - /**Gets or sets the name of the GraphObject that provides the location of this Part.*/ - locationObjectName: string; - /**Gets or sets the location Spot of this Node, the spot on the #locationObject that is used in positioning this part in the diagram.*/ - locationSpot: Spot; - /**Gets or sets the maximum location of this Part to which the user may drag using the DraggingTool.*/ - maxLocation: Point; - /**Gets or sets the minimum location of this Part to which the user may drag using the DraggingTool.*/ - minLocation: Point; - /**Gets or sets whether the user may move this part.*/ - movable: boolean; - /**Gets or sets whether the user may reshape this part.*/ - reshapable: boolean; - /**Gets or sets whether the user may resize this part.*/ - resizable: boolean; - /**Gets or sets the adornment template used to create a resize handle Adornment for this part.*/ - resizeAdornmentTemplate: Adornment; - /**Gets or sets the width and height multiples used when resizing.*/ - resizeCellSize: Size; - /**Gets the GraphObject that should get resize handles when this part is selected.*/ - resizeObject: GraphObject; - /**Gets or sets the name of the GraphObject that should get a resize handle when this part is selected.*/ - resizeObjectName: string; - /**Gets or sets whether the user may rotate this part.*/ - rotatable: boolean; - /**Gets or sets the adornment template used to create a rotation handle Adornment for this part.*/ - rotateAdornmentTemplate: Adornment; - /**Gets the GraphObject that should get rotate handles when this part is selected.*/ - rotateObject: GraphObject; - /**Gets or sets the name of the GraphObject that should get a rotate handle when this part is selected.*/ - rotateObjectName: string; - /**Gets or sets whether the user may select this part.*/ - selectable: boolean; - /**Gets or sets whether a selection adornment is shown for this part when it is selected.*/ - selectionAdorned: boolean; - /**Gets or sets the Adornment template used to create a selection handle for this Part.*/ - selectionAdornmentTemplate: Adornment; - /**Gets or sets the function to execute when this part is selected or deselected.*/ - selectionChanged: (p:Part)=>any; - /**Gets the GraphObject that should get a selection handle when this part is selected.*/ - selectionObject: GraphObject; - /**Gets or sets the name of the GraphObject that should get a selection handle when this part is selected.*/ - selectionObjectName: string; - /**Gets or sets the numerical value that describes the shadow's blur.*/ - shadowBlur: number; - /**Gets or sets the CSS string that describes a shadow color.*/ - shadowColor: string; - /**Gets or sets the X and Y offset of this part's shadow.*/ - shadowOffset: Point; - /**Gets or sets a text string that is associated with this part.*/ - text: string; - /**Gets or sets whether the user may do in-place text editing on TextBlocks in this part that have TextBlock#editable set to true.*/ - textEditable: boolean; - /**Associate an Adornment with this Part, perhaps replacing any existing adornment. - * @param {string} category a string identifying the kind or role of the given adornment for this Part. - * @param {Adornment} ad*/ - addAdornment(category: string, ad: Adornment); - /**This predicate returns true if #copyable is true, if the layer's Layer#allowCopy is true, and if the diagram's Diagram#allowCopy is true.*/ - canCopy(): boolean; - /**This predicate returns true if #deletable is true, if the layer's Layer#allowDelete is true, and if the diagram's Diagram#allowDelete is true.*/ - canDelete(): boolean; - /**This predicate returns true if #textEditable is true, if the layer's Layer#allowTextEdit is true, and if the diagram's Diagram#allowTextEdit is true.*/ - canEdit(): boolean; - /**This predicate returns true if #groupable is true, if the layer's Layer#allowGroup is true, and if the diagram's Diagram#allowGroup is true.*/ - canGroup(): boolean; - /**This predicate is called by Layout implementations to decide whether this Part should be positioned and might affect the positioning of other Parts.*/ - canLayout(): boolean; - /**This predicate returns true if #movable is true, if the layer's Layer#allowMove is true, and if the diagram's Diagram#allowMove is true.*/ - canMove(): boolean; - /**This predicate returns true if #reshapable is true, if the layer's Layer#allowReshape is true, and if the diagram's Diagram#allowReshape is true.*/ - canReshape(): boolean; - /**This predicate returns true if #resizable is true, if the layer's Layer#allowResize is true, and if the diagram's Diagram#allowResize is true.*/ - canResize(): boolean; - /**This predicate returns true if #rotatable is true, if the layer's Layer#allowRotate is true, and if the diagram's Diagram#allowRotate is true.*/ - canRotate(): boolean; - /**This predicate returns true if #selectable is true, if the layer's Layer#allowSelect is true, and if the diagram's Diagram#allowSelect is true.*/ - canSelect(): boolean; - /**Remove all adornments associated with this part.*/ - clearAdornments(); - /**Find an Adornment of a given category associated with this Part. - * @param {string} category*/ - findAdornment(category: string): Adornment; - /**Find the Group that contains both this part and another one. - * @param {Part} other*/ - findCommonContainingGroup(other: Part): Group; - /**Gets the top-level Part for this part, which is itself when #isTopLevel is true.*/ - findTopLevelPart(): Part; - /**Invalidate the Layout that is responsible for positioning this Part. - * @param {number=} condition the reason that the layout should be invalidated; - * if this argument is not supplied, any value of #layoutConditions other than Part#LayoutNone - * will allow the layout to be invalidated.*/ - invalidateLayout(condition: number); - /**This predicate is true if this part is a member of the given Part, perhaps indirectly. - * @param {Part} part*/ - isMemberOf(part: Part): boolean; - /**This predicate is true if this Part can be seen.*/ - isVisible(): boolean; - /**Move this part and any parts that are owned by this part to a new position. - * @param {Point} newpos a new Point in document coordinates.*/ - move(newpos: Point); - /**Remove any Adornment of the given category that may be associated with this Part. - * @param {string} category a string identifying the kind or role of the given adornment for this Part. - */ - removeAdornment(category: string); - /**This is responsible for creating any selection Adornment (if this Part #isSelected) and any tool adornments for this part.*/ - updateAdornments(); - /**Re-evaluate all data bindings on this Part, in order to assign new property values to the GraphObjects in this visual tree based on this this object's #data property values. - * @param {string=} srcprop An optional source data property name: - * when provided, only evaluates those Bindings that use that particular property; - * when not provided or when it is the empty string, all bindings are evaluated.*/ - updateTargetBindings(srcprop?: string); - /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Part is added to a Diagram or Group, it invalidates the Layout responsible for the Part.*/ - LayoutAdded: number; - /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Group has been laid out, it invalidates the Layout responsible for that Group; this flag is ignored for Parts that are not Groups.*/ - LayoutGroupLayout: number; - /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Part's GraphObject#visible becomes false, it invalidates the Layout responsible for the Part.*/ - LayoutHidden: number; - /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Part's GraphObject#actualBounds changes size, it invalidates the Layout responsible for the Part; this flag is ignored for Parts that are Links.*/ - LayoutNodeSized: number; - /**This value may be used as the value of the Part#layoutConditions property to indicate that no operation on this Part causes invalidation of the Layout responsible for this Part.*/ - LayoutNone: number; - /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Part is removed from a Diagram or Group, it invalidates the Layout responsible for the Part.*/ - LayoutRemoved: number; - /**This flag may be combined with other "Layout" flags as the value of the Part#layoutConditions property to indicate that when a Part's GraphObject#visible becomes true, it invalidates the Layout responsible for the Part.*/ - LayoutShown: number; - /**This is the default value for the Part#layoutConditions property: the Layout responsible for the Part is invalidated when the Part is added or removed from the Diagram or Group or when it changes visibility or size or when a Group's layout has been performed.*/ - LayoutStandard: number; - ensureBounds(); - } - /** - * A Picture is a GraphObject that shows an image, video-frame, or Canvas element. - * You can specify what to show by either setting the #source URL property - * to a URL string or the #element property to an HTMLImageElement, - * HTMLCanvasElement, or HTMLVideoElement. - */ - class Picture extends GraphObject { - /**The constructor creates a picture that shows nothing until the #source or #element is specified.*/ - constructor(); - /**Gets or sets the Picture's HTML element.*/ - element: HTMLElement; - /**Gets or sets the function to call if an image fails to load.*/ - errorFunction: (a:Picture, b:Event)=>any; - /**Gets or sets how the Picture's image is stretched within its bounding box.*/ - imageStretch: EnumValue; - /**Gets the natural size of this picture as determined by its source's width and height.*/ - naturalBounds: Rect; - /**Gets or sets the Picture's source URL, which can be any valid image (png, jpg, gif, etc) URL.*/ - source: string; - /**Gets or sets the rectangular area of the source image that this picture should display.*/ - sourceRect: Rect; - } - /** - * If a Placeholder is in the visual tree of a Group, it represents the area of all of the member Parts of that Group. - * If a Placeholder is in the visual tree of an Adornment, it represents the area of the Adornment#adornedObject. - * It can only be used in the visual tree of a Group node or an Adornment. - * There can be at most one Placeholder in a Group or an Adornment. - */ - class Placeholder extends GraphObject { - constructor(); - padding: any; - } - /** - * The RowColumnDefinition class describes constraints on a row or a column - * in a Panel of type Panel#Table. - * It also provides information about the actual layout after the - * Table Panel has been arranged. - */ - class RowColumnDefinition { - /**You do not need to use this constructor, because calls to Panel#getRowDefinition or Panel#getColumnDefinition will automatically create and remember a RowColumnDefinition for you.*/ - constructor(); - /**Gets the usable row height or column width, after arrangement, that objects in this row or column can be placed within.*/ - actual: number; - /**Gets or sets a default alignment for elements that are in this row or column.*/ - alignment: Spot; - /**Gets or sets the background color for a particular row or column, which fills the entire span of the column, including any separatorPadding.*/ - background: any; - /**Determines whether or not the background, if there is one, is in front of or behind the separators.*/ - coversSeparators: boolean; - /**Gets or sets the row height.*/ - height: number; - /**Gets which row or column this RowColumnDefinition describes in the #panel.*/ - index: number; - /**Gets whether this describes a row or a column in the #panel.*/ - isRow: boolean; - /**Gets or sets the maximum row height or column width.*/ - maximum: number; - /**Gets or sets the minimum row height or column width.*/ - minimum: number; - /**Gets the Panel that this row or column definition is in.*/ - panel: Panel; - /**Gets the actual arranged row or column starting position, after arrangement.*/ - position: number; - /**Gets or sets the dash array for dashing the spacing provided this row or column has a nonzero RowColumnDefinition#separatorStrokeWidth and non-null RowColumnDefinition#separatorStroke.*/ - separatorDashArray: Array; - /**Gets or sets the additional padding for a particular row or column.*/ - separatorPadding: Margin; - /**Gets or sets the stroke (color) for a particular row or column, provided that row or column has a nonzero RowColumnDefinition#separatorStrokeWidth.*/ - separatorStroke: any; - /**Gets or sets the stroke width for a particular row or column's separator,*/ - separatorStrokeWidth: number; - /**Gets or sets how this row or column deals with a Table Panel's extra space.*/ - sizing: EnumValue; - /**Gets or sets the default stretch for elements that are in this row or column.*/ - stretch: EnumValue; - /**Gets the total arranged row height or column width, after arrangement.*/ - total: number; - /**Gets or sets the column width.*/ - width: number; - /**Add a data-binding of a property on this object to a property on a data object. - * @param {Binding} binding*/ - bind(binding: Binding); - /**The default #sizing, which resolves to RowColumnDefinition#None or else the Table Panel's rowSizing and columnSizing if present.*/ - static Default: EnumValue; - /**The default #sizing if none is specified on the Table Panel's rowSizing and columnSizing.*/ - static None: EnumValue; - /**If a Table Panel is larger than all the rows then this #sizing grants this row and any others with the same value the extra space, apportinoed proportionally between them*/ - static ProportionalExtra: EnumValue; - } - /** - * A Shape is a GraphObject that shows a geometric figure. - * The Geometry determines what is drawn; - * the properties #fill and #stroke - * (and other stroke properties) determine how it is drawn. - */ - class Shape extends GraphObject { - /**A newly constructed Shape has a default #figure of "None", which constructs a rectangular geometry, and is filled and stroked with a black brush.*/ - constructor(); - /**Gets or sets the figure name, used to construct a Geometry.*/ - figure: string; - /**Gets or sets the Brush or string that describes the fill of the Shape.*/ - fill: any; - /**Gets or sets the name of the kind of arrowhead that this shape should take when this shape is an element of a Link.*/ - fromArrow: string; - /**Gets or sets the Shape's Geometry that defines the Shape's figure.*/ - geometry: Geometry; - /**Gets or sets how the shape's geometry is proportionally created given its computed size.*/ - geometryStretch: EnumValue; - /**When set, creates a Geometry and normalizes it from a given path string, then sets the Geometry on this Shape and offsets the GraphObject#position by an appropriate amount.*/ - geometryString: string; - /**Gets or sets how frequently this shape should be drawn within a Grid Panel, in multiples of the Panel#gridCellSize.*/ - interval: number; - /**Gets or sets the whether the #position denotes the panel coordinates of the geometry or of the stroked area.*/ - isGeometryPositioned: boolean; - /**Gets the natural bounds of this Shape as determined by its #geometry's bounds.*/ - naturalBounds: Rect; - /**Gets or sets a property for parameterizing the construction of a Geometry from a figure.*/ - parameter1: number; - /**Gets or sets a property for parameterizing the construction of a Geometry from a figure.*/ - parameter2: number; - /**Gets or sets the top-left Spot used by some Panels for determining where in the shape other objects may be placed.*/ - spot1: Spot; - /**Gets or sets the bottom-right Spot used by some Panels for determining where in the shape other objects may be placed.*/ - spot2: Spot; - /**Gets or sets the Brush or string that describes the stroke of the Shape.*/ - stroke: any; - /**Gets or sets the style for the stroke's line cap.*/ - strokeCap: string; - /**Gets or sets the dash array for creating dashed lines.*/ - strokeDashArray: Array; - /**Gets or sets the offset for dashed lines, used in the phase pattern.*/ - strokeDashOffset: number; - /**Gets or sets the type of corner that will be drawn when two lines meet.*/ - strokeJoin: string; - /**Gets or sets the style for the stroke's mitre limit ratio.*/ - strokeMiterLimit: number; - /**Gets or sets a stroke's width.*/ - strokeWidth: number; - /**Gets or sets the name of the kind of arrowhead that this shape should take when this shape is an element of a Link.*/ - toArrow: string; - } - /** - * A TextBlock is a GraphObject that displays a #text string in a given #font. - */ - class TextBlock extends GraphObject { - /**A newly constructed TextBlock has no string to show; if it did, it would draw the text, wrapping if needed, in the default font using a black stroke.*/ - constructor(); - /**Gets or sets whether or not this TextBlock allows in-place editing of the #text string by the user with the help of the TextEditingTool.*/ - editable: boolean; - /**Gets or sets the function to call if a text edit made with the TextEditingTool is invalid.*/ - errorFunction: (a:TextEditingTool, b:string, c:string)=>any; - /**Gets or sets the current font settings.*/ - font: string; - /**Gets or sets whether or not the text allows or displays multiple lines or embedded newlines.*/ - isMultiline: boolean; - /**Gets or sets whether or not the text is underlined.*/ - isUnderline: boolean; - /**Gets or sets whether or not the text has a strikethrough line (line-through).*/ - isStrikethrough: boolean; - /**Gets the total number of lines in this TextBlock, including lines created from returns and wrapping.*/ - lineCount: number; - /**Gets the natural bounds of this TextBlock in local coordinates, as determined by its #font and #text string.*/ - naturalBounds: Rect; - /**Gets or sets the Brush or string that describes the stroke (color) of the #font.*/ - stroke: any; - /**Gets or sets the current text string.*/ - text: string; - /**Gets or sets the current text alignment property.*/ - textAlign: string; - /**Gets or sets the HTMLElement that this TextBlock uses as its text editor in the TextEditingTool.*/ - textEditor: HTMLElement; - /**Gets or sets the predicate that determines whether or not a string of text is valid.*/ - textValidation: any; - /**Gets or sets whether the text should be wrapped if it is too long to fit on one line.*/ - wrap: EnumValue; - /**The TextBlock will not wrap its text.*/ - static None: EnumValue; - /**The TextBlock will wrap text and the width of the TextBlock will be the desiredSize's width, if any.*/ - static WrapDesiredSize: EnumValue; - /**The TextBlock will wrap text, making the width of the TextBlock equal to the width of the longest line.*/ - static WrapFit: EnumValue; - } class EnumValue { //Rawr! } From 2a453fef509e26548db678aac29a292cd3f2e16f Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Wed, 28 Aug 2013 13:33:21 -0700 Subject: [PATCH 373/756] Changed some return types from type Object to type any so properties and methods of return types can be called --- meteor/meteor.d.ts | 43 ++++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/meteor/meteor.d.ts b/meteor/meteor.d.ts index 83c3c94285..3e270ce12d 100644 --- a/meteor/meteor.d.ts +++ b/meteor/meteor.d.ts @@ -89,19 +89,9 @@ interface IMeteor { /************ * Accounts * ************/ - user(): { - _id: string; - username: string; - emails?: { - address: string; - verified: boolean; - } - profile?: Object; - services?: Object; - createdAt?: number; - }; + user(): IMeteorUser; userId(): string; - users: IMeteorCollection; + users: IMeteorUserCollection; loggingIn(): boolean; logout(callback?: Function): void; loginWithPassword(user: Object, password: string, callback?: Function): void; @@ -191,8 +181,8 @@ interface IMeteor { ***************/ interface IMeteorCollection { find(selector?, options?: Object): IMeteorCursor; - findOne(selector, options?: Object): Object; - insert(doc, callback?: Function): number; + findOne(selector, options?: Object): any; + insert(doc: Object, callback?: Function): string; update(selector, modifier, options?: Object, callback?: Function): void; remove(selector, callback?: Function): void; allow(options: Object): boolean; @@ -244,7 +234,7 @@ interface IMeteorManager { created(callback: Function): void; destroyed(callback: Function): void; events(eventMap: {[eventType: string]: Function}): void; - helpers(helpers: Object): Object; + helpers(helpers: Object): any; preserve(selector: Object): void; } @@ -288,6 +278,29 @@ interface IMeteorHandle { /************************** * Accounts and Passwords * **************************/ +interface IMeteorUser { + _id?: string; + username?: string; + emails?: { + address: string; + verified: boolean; + } + profile?: any; + services?: any; + createdAt?: number; +} + +interface IMeteorUserCollection { + find(selector?, options?: Object): IMeteorCursor; + findOne(selector, options?: Object): IMeteorUser; + insert(doc: IMeteorUser, callback?: Function): IMeteorUser; + update(selector, modifier, options?: Object, callback?: Function): void; + remove(selector, callback?: Function): void; + allow(options: Object): boolean; + deny(options: Object): boolean; + ObjectID(hexString?: string): Object; +} + interface IMeteorAccounts { config(options: { sendVerificationEmail?: boolean; From 65567e417c935ff37830995fbbb370b47b0dc1a2 Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Wed, 28 Aug 2013 22:53:33 +0200 Subject: [PATCH 374/756] Add class documentation links --- mongodb/mongodb.d.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 15791a8e54..e9177f96ea 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -5,6 +5,7 @@ /// declare module "mongodb" { + // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/mongoclient.html export class MongoClient{ constructor(serverConfig: any, options: any); @@ -13,9 +14,12 @@ declare module "mongodb" { static connect(uri: string, callback: (err: any, db: Db) => void); } + // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/server.html export class Server { constructor (host: string, port: number, opts?: ServerOptions); } + + // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/db.html export class Db { constructor (databaseName: string, serverConfig: Server, db_options?: DBOptions); @@ -97,6 +101,7 @@ declare module "mongodb" { public addListener(event: string, handler:(param: any) => any); } + // Class documentation : http://mongodb.github.io/node-mongodb-native/api-bson-generated/objectid.html export class ObjectID { constructor (s: string); } From 6f67cf53914d7d0e2962c549ab5e5c75ae91bba0 Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Wed, 28 Aug 2013 22:54:59 +0200 Subject: [PATCH 375/756] Fix indentation --- mongodb/mongodb.d.ts | 52 ++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index e9177f96ea..403d3f9281 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -6,20 +6,20 @@ declare module "mongodb" { - // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/mongoclient.html - export class MongoClient{ - constructor(serverConfig: any, options: any); - - static connect(uri: string, options: any, callback: (err: any, db: Db) => void); - static connect(uri: string, callback: (err: any, db: Db) => void); - } + // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/mongoclient.html + export class MongoClient{ + constructor(serverConfig: any, options: any); - // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/server.html + static connect(uri: string, options: any, callback: (err: any, db: Db) => void); + static connect(uri: string, callback: (err: any, db: Db) => void); + } + + // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/server.html export class Server { constructor (host: string, port: number, opts?: ServerOptions); } - // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/db.html + // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/db.html export class Db { constructor (databaseName: string, serverConfig: Server, db_options?: DBOptions); @@ -101,7 +101,7 @@ declare module "mongodb" { public addListener(event: string, handler:(param: any) => any); } - // Class documentation : http://mongodb.github.io/node-mongodb-native/api-bson-generated/objectid.html + // Class documentation : http://mongodb.github.io/node-mongodb-native/api-bson-generated/objectid.html export class ObjectID { constructor (s: string); } @@ -177,36 +177,36 @@ declare module "mongodb" { export interface Collection { //constructor (db: Db, collectionName: string, pkFactory, options); - + insert(query: any, callback: (err: any, result: any) => void): void; insert(query: any, options: { safe?: any; continueOnError?: boolean; keepGoing?: boolean; serializeFunctions?: boolean; }, callback: (err: any, result: any) => void): void; - + remove(selector, callback?: (err: any, result: any) => void); remove(selector, options: { safe?: any; single?: boolean; }, callback?: (err: any, result: any) => void); - + rename(newName: String, callback?: (err, result) => void); - + save(doc: any, callback : (err, result) => void); save(doc: any, options: { safe: any; }, callback : (err, result) => void); - + update(selector: any, document: any, callback?: (err: any, result: any) => void): void; update(selector: any, document: any, options: { safe?; upsert?; multi?; serializeFunctions?; }, callback: (err: any, result: any) => void): void; - + distinct(key: string, query: Object, callback: (err, result) => void); distinct(key: string, query: Object, options: { readPreferences; }, callback: (err, result) => void); - + count(callback: (err, result) => void); count(query: Object, callback: (err, result) => void); count(query: Object, options: { readPreferences; }, callback: (err, result) => void); - + drop(callback?: (err, result) => void); - + findAndModify(query: Object, sort: any[], doc: Object, callback: (err, result) => void); findAndModify(query: Object, sort: any[], doc: Object, options: { safe?: any; remove?: boolean; upsert?: boolean; new?: boolean; }, callback: (err, result) => void); - + findAndRemove(query : Object, sort? : any[], callback?: (err, result) => void); findAndRemove(query : Object, sort? : any[], options?: { safe; }, callback?: (err, result) => void); - + find(callback?: (err: any, result: Cursor) => void): Cursor; find(selector: any, callback?: (err: any, result: Cursor) => void): Cursor; find(selector: any, fields: any, callback?: (err: any, result: Cursor) => void): Cursor; @@ -214,7 +214,7 @@ declare module "mongodb" { find(selector: any, fields: any, options: CollectionFindOptions, callback?: (err: any, result: Cursor) => void): Cursor; find(selector: any, fields: any, skip: number, limit: number, callback?: (err: any, result: Cursor) => void): Cursor; find(selector: any, fields: any, skip: number, limit: number, timeout: number, callback?: (err: any, result: Cursor) => void): Cursor; - + findOne(callback?: (err: any, result: any) => void): Cursor; findOne(selector: any, callback?: (err: any, result: any) => void): Cursor; findOne(selector: any, fields: any, callback?: (err: any, result: any) => void): Cursor; @@ -222,14 +222,14 @@ declare module "mongodb" { findOne(selector: any, fields: any, options: CollectionFindOptions, callback?: (err: any, result: any) => void): Cursor; findOne(selector: any, fields: any, skip: number, limit: number, callback?: (err: any, result: any) => void): Cursor; findOne(selector: any, fields: any, skip: number, limit: number, timeout: number, callback?: (err: any, result: any) => void): Cursor; - + createIndex(fieldOrSpec, options: IndexOptions, callback: (err: Error, indexName: string) => void); ensureIndex(fieldOrSpec, options: IndexOptions, callback: (err: Error, indexName: string) => void); indexInformation(options, callback); dropIndex(name, callback); dropAllIndexes(callback); // dropIndexes = dropAllIndexes - + reIndex(callback); mapReduce(map, reduce, options, callback); group(keys, condition, initial, reduce, finalize, command, options, callback); @@ -242,7 +242,7 @@ declare module "mongodb" { aggregate(pipeline: any[], callback: (err: Error, results: any) => void); aggregate(pipeline: any[], options, callback: (err: Error, results: any) => void); stats(options, callback); - + hint; } @@ -315,4 +315,4 @@ declare module "mongodb" { pkFactory?: any; readPreferences?: string; } -} +} \ No newline at end of file From 20dcd7154d1420523210acac361a94b943178bae Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Wed, 28 Aug 2013 23:02:18 +0200 Subject: [PATCH 376/756] Add connect to Server --- mongodb/mongodb.d.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 403d3f9281..8cb5214999 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -17,6 +17,8 @@ declare module "mongodb" { // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/server.html export class Server { constructor (host: string, port: number, opts?: ServerOptions); + + public connect(); } // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/db.html From 994417b277d8ede753e8bac311632f73efcc776e Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Wed, 28 Aug 2013 23:16:31 +0200 Subject: [PATCH 377/756] Update DBOptions --- mongodb/mongodb.d.ts | 70 ++++++++++++++++++++++++++++++++------------ 1 file changed, 52 insertions(+), 18 deletions(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 8cb5214999..00d74bff68 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -23,7 +23,7 @@ declare module "mongodb" { // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/db.html export class Db { - constructor (databaseName: string, serverConfig: Server, db_options?: DBOptions); + constructor (databaseName: string, serverConfig: Server, dbOptions?: DBOptions); public db(dbName: string): Db; @@ -133,27 +133,61 @@ declare module "mongodb" { createPk: () => number; } + // See : http://mongodb.github.io/node-mongodb-native/api-generated/db.html export interface DBOptions { - //- if true, use native BSON parser + // the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write. + w?: string; + + // set the timeout for waiting for write concern to finish (combines with w option). + wtimeout?: number; + + // write waits for fsync before returning. default:false. + fsync?: boolean; + + // write waits for journal sync before returning. default:false. + journal?: boolean; + + readPreference?: string; + + // use c++ bson parser. default:false. native_parser?: boolean; - //- sets strict mode , if true then existing collections can’t be “recreated” etc. - strict?: boolean; - //- custom primary key factory to generate _id values (see Custom primary keys). - pk?: PKFactory; - //- generation of objectid is delegated to the mongodb server instead of the driver. default is false + + // force server to create _id fields instead of client. default:false. forceServerObjectId?: boolean; - //- specify the number of milliseconds between connection attempts default:5000 - retryMiliSeconds?: number; - //- specify the number of retries for connection attempts default:3 - numberOfRetries?: number; - //- enable/disable reaper (true/false) default:false - reaper?: boolean; - //- specify the number of milliseconds between each reaper attempt default:10000 - reaperInterval?: number; - //- specify the number of milliseconds for timing out callbacks that don’t return default:30000 - reaperTimeout?: number; - //- driver expects Buffer raw bson document, default:false + + // custom primary key factory to generate _id values (see Custom primary keys). + pkFactory?: PKFactory; + + // serialize functions. default:false. + serializeFunctions?: boolean; + + // peform operations using raw bson buffers. default:false. raw?: boolean; + + // record query statistics during execution. default:false. + recordQueryStats?: boolean; + + // number of miliseconds between retries. default:5000. + retryMiliSeconds?: number; + + // number of retries off connection. default:5. + numberOfRetries?: number; + + // an object representing a logger that you want to use, needs to support functions debug, log, error. default:null. + logger?: Object + + // force setting of SlaveOk flag on queries (only use when explicitly connecting to a secondary server). default:null. + slaveOk?: number; + + // when deserializing a Long will fit it into a Number if it’s smaller than 53 bits. default:true. + promoteLongs?: boolean; + + // enable/disable reaper (true/false) default:false + reaper?: boolean; + // specify the number of milliseconds between each reaper attempt default:10000 + reaperInterval?: number; + // specify the number of milliseconds for timing out callbacks that don’t return default:30000 + reaperTimeout?: number; } export interface CollectionCreateOptions { From 2a85e74df1c5a5ed175a17eae19de5c955117b87 Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Wed, 28 Aug 2013 23:17:04 +0200 Subject: [PATCH 378/756] Remove reaper from DBOptions --- mongodb/mongodb.d.ts | 7 ------- 1 file changed, 7 deletions(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 00d74bff68..d0257ad539 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -181,13 +181,6 @@ declare module "mongodb" { // when deserializing a Long will fit it into a Number if it’s smaller than 53 bits. default:true. promoteLongs?: boolean; - - // enable/disable reaper (true/false) default:false - reaper?: boolean; - // specify the number of milliseconds between each reaper attempt default:10000 - reaperInterval?: number; - // specify the number of milliseconds for timing out callbacks that don’t return default:30000 - reaperTimeout?: number; } export interface CollectionCreateOptions { From 1aef8d9bb3bde5229031054c313667ddb6684ece Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Wed, 28 Aug 2013 23:28:16 +0200 Subject: [PATCH 379/756] Add ReadPreference class --- mongodb/mongodb.d.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index d0257ad539..303ec58994 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -134,6 +134,7 @@ declare module "mongodb" { } // See : http://mongodb.github.io/node-mongodb-native/api-generated/db.html + // Current definition by documentation version 1.3.13 (28.08.2013) export interface DBOptions { // the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write. w?: string; @@ -147,6 +148,7 @@ declare module "mongodb" { // write waits for journal sync before returning. default:false. journal?: boolean; + // the prefered read preference. use 'ReadPreference' class. readPreference?: string; // use c++ bson parser. default:false. @@ -183,6 +185,14 @@ declare module "mongodb" { promoteLongs?: boolean; } + export class ReadPreference { + public static PRIMARY: string; + public static PRIMARY_PREFERRED: string; + public static SECONDARY: string; + public static SECONDARY_PREFERRED: string; + public static NEAREST: string; + } + export interface CollectionCreateOptions { // {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. safe?: boolean; From 79808dd87f15b60d0f6300648b2983641000fb2d Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Wed, 28 Aug 2013 23:30:26 +0200 Subject: [PATCH 380/756] Update Collection constructor --- mongodb/mongodb.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 303ec58994..200c5cede4 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -215,7 +215,7 @@ declare module "mongodb" { } export interface Collection { - //constructor (db: Db, collectionName: string, pkFactory, options); + constructor (db: Db, collectionName: string, pkFactory?: Object, options?: CollectionCreateOptions); insert(query: any, callback: (err: any, result: any) => void): void; insert(query: any, options: { safe?: any; continueOnError?: boolean; keepGoing?: boolean; serializeFunctions?: boolean; }, callback: (err: any, result: any) => void): void; From ffac14f3a36151154d0f5a90da33277a4acec172 Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Wed, 28 Aug 2013 23:40:38 +0200 Subject: [PATCH 381/756] Update ObjectID class --- mongodb/mongodb.d.ts | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 200c5cede4..2650d7e460 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -104,8 +104,26 @@ declare module "mongodb" { } // Class documentation : http://mongodb.github.io/node-mongodb-native/api-bson-generated/objectid.html + // Last update: doc. version 1.3.13 (28.08.2013) export class ObjectID { constructor (s: string); + + // Returns the ObjectID id as a 24 byte hex string representation + public toHexString() : string; + + // Compares the equality of this ObjectID with otherID. + public equals(otherID: ObjectID) : boolean; + + // Returns the generation date (accurate up to the second) that this ID was generated. + public getTimestamp(): Date; + + // Creates an ObjectID from a second based number, with the rest of the ObjectID zeroed out. Used for comparisons or sorting the ObjectID. + // time – an integer number representing a number of seconds. + public static createFromTime(time: number): ObjectID; + + // Creates an ObjectID from a hex string representation of an ObjectID. + // hexString – create a ObjectID from a passed in 24 byte hexstring. + public static createFromHexString(hexString: string): ObjectID; } export interface SocketOptions { @@ -214,6 +232,7 @@ declare module "mongodb" { readPreference?: string; } + // Documentation : http://mongodb.github.io/node-mongodb-native/api-generated/collection.html export interface Collection { constructor (db: Db, collectionName: string, pkFactory?: Object, options?: CollectionCreateOptions); From 5c32d4aadbd655b43e8bcf9f373c7266e910b187 Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Wed, 28 Aug 2013 23:55:14 +0200 Subject: [PATCH 382/756] Add name to README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 811b1c5346..825e9cd79a 100755 --- a/README.md +++ b/README.md @@ -148,6 +148,7 @@ List of Definitions * [Meteor](https://www.meteor.com) (by [Dave Allen](https://github.com/fullflavedave)) * [Modernizr](http://modernizr.com/) (by [Boris Yankov](https://github.com/borisyankov) and [Theodore Brown](https://github.com/theodorejb/)) * [Moment.js](https://github.com/timrwood/moment) (by [Michael Lakerveld](https://github.com/Lakerfield)) +* [MongoDB](http://mongodb.github.io/node-mongodb-native/) (from TypeScript samples, updated by [Niklas Mollenhauer](https://github.com/nikeee)) * [Mousetrap](http://craig.is/killing/mice) (by [Dániel Tar](https://github.com/qcz)) * [Mustache.js](https://github.com/janl/mustache.js) (by [Boris Yankov](https://github.com/borisyankov)) * [Node.js](http://nodejs.org/) (from TypeScript samples) From 4f4de5f25f3ce35449f61a3a32396871e36cc46a Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Thu, 29 Aug 2013 00:09:31 +0200 Subject: [PATCH 383/756] Update CollectionCreateOptions --- mongodb/mongodb.d.ts | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 2650d7e460..444ae662a7 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -211,25 +211,23 @@ declare module "mongodb" { public static NEAREST: string; } + // See : http://mongodb.github.io/node-mongodb-native/api-generated/collection.html + // Current definition by documentation version 1.3.13 (28.08.2013) export interface CollectionCreateOptions { - // {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - safe?: boolean; - // {Boolean, default:false}, serialize functions on the document. + // the prefered read preference. use 'ReadPreference' class. + readPreference?: string; + + // Allow reads from secondaries. default:false. + slaveOk?: boolean; + + // serialize functions on the document. default:false. serializeFunctions?: boolean; - // {Boolean, default:false}, perform all operations using raw bson objects. + + // perform all operations using raw bson objects. default:false. raw?: boolean; + // object overriding the basic ObjectID primary key generation. pkFactory?: PKFactory; - // {Boolean, default:false}, create a capped collection. - capped?: boolean; - // {Number}, the size of the capped collection in bytes. - size?: number; - // {Number}, the maximum number of documents in the capped collection. - max?: number; - // {Boolean, default:false}, create an index on the _id field of the document, not created automatically on capped collections. - autoIndexId?: boolean; - // {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). - readPreference?: string; } // Documentation : http://mongodb.github.io/node-mongodb-native/api-generated/collection.html From 28ea779c1d69f425c12d0cbeaac773bbebec18c5 Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Thu, 29 Aug 2013 00:10:12 +0200 Subject: [PATCH 384/756] Rename DBOptions -> DbCreateOptions --- mongodb/mongodb.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 444ae662a7..23ecc33d7e 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -23,7 +23,7 @@ declare module "mongodb" { // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/db.html export class Db { - constructor (databaseName: string, serverConfig: Server, dbOptions?: DBOptions); + constructor (databaseName: string, serverConfig: Server, dbOptions?: DbCreateOptions); public db(dbName: string): Db; @@ -153,7 +153,7 @@ declare module "mongodb" { // See : http://mongodb.github.io/node-mongodb-native/api-generated/db.html // Current definition by documentation version 1.3.13 (28.08.2013) - export interface DBOptions { + export interface DbCreateOptions { // the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write. w?: string; From 046d38708117cb2bb675ab81ae16b21ed4393cdc Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Thu, 29 Aug 2013 00:19:54 +0200 Subject: [PATCH 385/756] Update Cursor --- mongodb/mongodb.d.ts | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 23ecc33d7e..1cc6f53591 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -310,28 +310,33 @@ declare module "mongodb" { v?: number; } + // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/cursor.html + // Last update: doc. version 1.3.13 (28.08.2013) export class Cursor { - constructor (db, collection, selector, fields, skip, limit, sort, hint, explain, snapshot, timeout, tailable, batchSize, slaveOk, raw, read, returnKey, maxScan, min, max, showDiskLoc, comment, awaitdata, numberOfRetries, dbName, tailableRetryInterval, exhaust, partial); + constructor (db: Db, collection: Collection, selector, fields, skip, limit, sort, hint, explain, snapshot, timeout, tailable, batchSize, slaveOk, raw, read, returnKey, maxScan, min, max, showDiskLoc, comment, awaitdata, numberOfRetries, dbName, tailableRetryInterval, exhaust, partial); rewind() : Cursor; toArray(callback: (err: any, results: any[]) => any) : void; each(callback: (err: Error, item: any) => void) : void; - count(callback: (err: any, count: number) => void) : void; + count(applySkipLimit: boolean, callback: (err: any, count: number) => void) : void; - sort(keyOrList : any, callback? : (err, result) => void): Cursor; - sort(keyOrList : String, direction : any, callback? : (err, result) => void): Cursor; + sort(keyOrList: any, callback? : (err, result) => void): Cursor; + // this determines how the results are sorted. "asc", "ascending" or 1 for asceding order while "desc", "desceding or -1 for descending order. Note that the strings are case insensitive. + sort(keyOrList: String, direction : string, callback : (err, result) => void): Cursor; limit(limit: number, callback?: (err, result) => void): Cursor; - setReadPreference(readPreferences, tags, callback?): Cursor; + setReadPreference(preference: string, callback?): Cursor; skip(skip: number, callback?: (err, result) => void): Cursor; - batchSize(batchSize, callback: (err, result) => void): Cursor; + batchSize(batchSize, callback?: (err, result) => void): Cursor; - nextObject(callback: (err:any, doc: any) => void); - explain(callback: (err, result) => void); + nextObject(callback: (err: any, doc: any) => void) : void; + explain(callback: (err, result) => void) : void; + + // TODO: //stream(): CursorStream; - close(callback?: (err, result) => void); - isClosed(): Boolean; + close(callback: (err, result) => void) : void; + isClosed(): boolean; static INIT; static OPEN; From 50bfbea725dec8dc89e845e6ca6f9a2e64b31697 Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Thu, 29 Aug 2013 00:20:51 +0200 Subject: [PATCH 386/756] Update Cursor constants --- mongodb/mongodb.d.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 1cc6f53591..35eea5bac9 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -338,9 +338,10 @@ declare module "mongodb" { close(callback: (err, result) => void) : void; isClosed(): boolean; - static INIT; - static OPEN; - static CLOSED; + public static INIT: number; + public static OPEN: number; + public static CLOSED: number; + public static GET_MORE: number; } export interface CollectionFindOptions { From 4bbd0c202aea849470ad7c85df467fc6dfa3dcc4 Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Thu, 29 Aug 2013 00:26:47 +0200 Subject: [PATCH 387/756] Remove Cursor constructor - 'INTERNAL TYPE' --- mongodb/mongodb.d.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 35eea5bac9..8f9f033483 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -313,7 +313,9 @@ declare module "mongodb" { // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/cursor.html // Last update: doc. version 1.3.13 (28.08.2013) export class Cursor { - constructor (db: Db, collection: Collection, selector, fields, skip, limit, sort, hint, explain, snapshot, timeout, tailable, batchSize, slaveOk, raw, read, returnKey, maxScan, min, max, showDiskLoc, comment, awaitdata, numberOfRetries, dbName, tailableRetryInterval, exhaust, partial); + // INTERNAL TYPE + // constructor (db: Db, collection: Collection, selector, fields, skip, limit, sort, hint, explain, snapshot, timeout, tailable, batchSize, slaveOk, raw, read, returnKey, maxScan, min, max, showDiskLoc, comment, awaitdata, numberOfRetries, dbName, tailableRetryInterval, exhaust, partial); + // constructor(db: Db, collection: Collection, selector, fields, options) rewind() : Cursor; toArray(callback: (err: any, results: any[]) => any) : void; From b668ec8e0705d6daac5f7f969750cd12e896a338 Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Thu, 29 Aug 2013 00:29:03 +0200 Subject: [PATCH 388/756] Add CursorStream --- mongodb/mongodb.d.ts | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 8f9f033483..31675c3662 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -311,11 +311,11 @@ declare module "mongodb" { } // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/cursor.html - // Last update: doc. version 1.3.13 (28.08.2013) + // Last update: doc. version 1.3.13 (29.08.2013) export class Cursor { // INTERNAL TYPE // constructor (db: Db, collection: Collection, selector, fields, skip, limit, sort, hint, explain, snapshot, timeout, tailable, batchSize, slaveOk, raw, read, returnKey, maxScan, min, max, showDiskLoc, comment, awaitdata, numberOfRetries, dbName, tailableRetryInterval, exhaust, partial); - // constructor(db: Db, collection: Collection, selector, fields, options) + // constructor(db: Db, collection: Collection, selector, fields, options); rewind() : Cursor; toArray(callback: (err: any, results: any[]) => any) : void; @@ -334,8 +334,7 @@ declare module "mongodb" { nextObject(callback: (err: any, doc: any) => void) : void; explain(callback: (err, result) => void) : void; - // TODO: - //stream(): CursorStream; + stream(): CursorStream; close(callback: (err, result) => void) : void; isClosed(): boolean; @@ -346,6 +345,16 @@ declare module "mongodb" { public static GET_MORE: number; } + // Class documentation : http://mongodb.github.io/node-mongodb-native/api-generated/cursorstream.html + // Last update: doc. version 1.3.13 (29.08.2013) + export class CursorStream { + constructor(cursor: Cursor); + + public pause(); + public resume(); + public destroy(); + } + export interface CollectionFindOptions { limit?; sort?; From b53ca376666a4fa9d60e0989d0df6151aa401cc2 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Wed, 28 Aug 2013 15:48:19 -0700 Subject: [PATCH 389/756] Added usage notes --- meteor/README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 meteor/README.md diff --git a/meteor/README.md b/meteor/README.md new file mode 100644 index 0000000000..6b8647e9b9 --- /dev/null +++ b/meteor/README.md @@ -0,0 +1,69 @@ +#Meteor Type Definitions Usage Notes + +In order to effectively write your Meteor app with TypeScript, there are a few things you will need to do since simply referencing this Meteor type definition file and renaming all of you *.js files to *.ts will not work. + +##Referencing Meteor type definitions in your app +- Place the meteor.d.ts file in a directory (maybe `/lib/typescript`) +- Add `/// ` to the top of any file + +This will make these Typescript variables/objects available across your application: + +- Meteor +- Session +- Deps +- Accounts +- Match +- Computation +- Dependency +- EJSON +- HTTO +- Email +- Assets +- DPP + +*Please note that the Template variable is not automatically available. You need to follow the instructions below to use the Template variable.* + +##Defining Templates +In order to call `Template.yourTemplateName.method`, you will need to create a simple TypeScript definition file that declares a Template variable containing a list of template view-models/managers of type IMeteorViewModel (or IMeteorManager, which contains the same contents). A good place for this definition could be `/client/views/view-model-types.d.ts`. Here is an example of that file: + + /// + + declare var Template: { + newPosts: IMeteorViewModel; + bestPosts: IMeteorViewModel; + postsList: IMeteorViewModel; + comment: IMeteorViewModel; + commentSubmit: IMeteorViewModel; + notifications: IMeteorViewModel; + postPage: IMeteorViewModel; + postEdit: IMeteorViewModel; + postItem: IMeteorViewModel; + postNew: IMeteorViewModel; + header: IMeteorViewModel; + } + +After you create this file, you may access the Template variable by declaring something like `/// ` at the top of any file containing references to Template. Something like Template.postsList would then be accessible and get all the benefits of typing. + + +##Defining Collections +In TypeScript, creating global variables is not allowed, and in a Meteor app, creating local variables (using `var `) limits their scope to the file they are in. However, it is often necessary in a Meteor app to define variables that can be used across files, such as collections. In the case of collections, one way to work around this is to wrap each collections within a module, and then make the module globally accessible. Here is an example of posts.ts: + + module PostsModel { + export var Posts = new Meteor.Collection('posts'); + }; + + this.PostsModel = PostsModel; + +You can then access the Posts collection by placing `/// ` at the top of a typescript file and creating a call like this: + + PostsModel.Posts.findOne(Session.get('currentPostId')); + + +##Reference app +A simple Meteor application created with TypeScript is listed below. It is based on the Microscope reference application in the [Discover Meteor](http://www.discovermeteor.com/ "http://www.discovermeteor.com/") book. + +- Sample Site: +- Code (TypeScript and transpiled JS): + +##Meteor package +There will hopefully be a Meteor package soon listed on [Atmosphere](http://atmosphere.meteor.com "http://atmosphere.meteor.com") that can be easily added using "mrt add meteor". \ No newline at end of file From cf9f92a8c9fe77c5e8c84998f5fad0fa328d7148 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Wed, 28 Aug 2013 16:01:38 -0700 Subject: [PATCH 390/756] Fixed some typos --- meteor/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/meteor/README.md b/meteor/README.md index 6b8647e9b9..2f429d13e7 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -1,10 +1,10 @@ #Meteor Type Definitions Usage Notes -In order to effectively write your Meteor app with TypeScript, there are a few things you will need to do since simply referencing this Meteor type definition file and renaming all of you *.js files to *.ts will not work. +In order to effectively write your Meteor app with TypeScript, there are a few things you will need to do since simply referencing this Meteor type definition file and renaming all of your *.js files to *.ts will not work. ##Referencing Meteor type definitions in your app - Place the meteor.d.ts file in a directory (maybe `/lib/typescript`) -- Add `/// ` to the top of any file +- Add `/// ` to the top of any TypeScript file This will make these Typescript variables/objects available across your application: @@ -24,7 +24,7 @@ This will make these Typescript variables/objects available across your applicat *Please note that the Template variable is not automatically available. You need to follow the instructions below to use the Template variable.* ##Defining Templates -In order to call `Template.yourTemplateName.method`, you will need to create a simple TypeScript definition file that declares a Template variable containing a list of template view-models/managers of type IMeteorViewModel (or IMeteorManager, which contains the same contents). A good place for this definition could be `/client/views/view-model-types.d.ts`. Here is an example of that file: +In order to call `Template.yourTemplateName.method`, you will need to create a simple TypeScript definition file that declares a Template variable containing a list of template view-models/managers of type IMeteorViewModel (or IMeteorManager, which is the same as IMeteorViewModel). A good place for this definition could be `/client/views/view-model-types.d.ts`. Here is an example of that file: /// @@ -46,7 +46,7 @@ After you create this file, you may access the Template variable by declaring so ##Defining Collections -In TypeScript, creating global variables is not allowed, and in a Meteor app, creating local variables (using `var `) limits their scope to the file they are in. However, it is often necessary in a Meteor app to define variables that can be used across files, such as collections. In the case of collections, one way to work around this is to wrap each collections within a module, and then make the module globally accessible. Here is an example of posts.ts: +In TypeScript, creating global variables is not allowed, and in a Meteor app, creating local variables (using `var `) limits variables' scope to the file. However, it is often necessary in a Meteor app to define variables that can be used across files, such as collections. In the case of collections, one way to work around this is to wrap each collection within a module, and then make the module globally accessible. Here is an example using posts.ts: module PostsModel { export var Posts = new Meteor.Collection('posts'); @@ -54,13 +54,13 @@ In TypeScript, creating global variables is not allowed, and in a Meteor app, cr this.PostsModel = PostsModel; -You can then access the Posts collection by placing `/// ` at the top of a typescript file and creating a call like this: +You can then access the Posts collection by placing `/// ` at the top of a TypeScript file. The call would look like this: PostsModel.Posts.findOne(Session.get('currentPostId')); ##Reference app -A simple Meteor application created with TypeScript is listed below. It is based on the Microscope reference application in the [Discover Meteor](http://www.discovermeteor.com/ "http://www.discovermeteor.com/") book. +A simple Meteor application created with TypeScript is listed below. It is based on the Microscope reference app in the [Discover Meteor](http://www.discovermeteor.com/ "http://www.discovermeteor.com/"). - Sample Site: - Code (TypeScript and transpiled JS): From 8661326d65f5e2f4f0269bce67d17652d177ba60 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Wed, 28 Aug 2013 16:16:50 -0700 Subject: [PATCH 391/756] More wordsmithing --- meteor/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/meteor/README.md b/meteor/README.md index 2f429d13e7..a040b5e6a5 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -6,7 +6,7 @@ In order to effectively write your Meteor app with TypeScript, there are a few t - Place the meteor.d.ts file in a directory (maybe `/lib/typescript`) - Add `/// ` to the top of any TypeScript file -This will make these Typescript variables/objects available across your application: +This will make these typed Meteor variables/objects available across your application: - Meteor - Session @@ -42,11 +42,11 @@ In order to call `Template.yourTemplateName.method`, you will need to create a s header: IMeteorViewModel; } -After you create this file, you may access the Template variable by declaring something like `/// ` at the top of any file containing references to Template. Something like Template.postsList would then be accessible and get all the benefits of typing. +After you create this file, you may access the Template variable by declaring something like `/// ` at the top of any TypeScript file containing references to Template. Something like `Template.postsList.helpers()` would then transpile successfully (and have the benefits of typing). ##Defining Collections -In TypeScript, creating global variables is not allowed, and in a Meteor app, creating local variables (using `var `) limits variables' scope to the file. However, it is often necessary in a Meteor app to define variables that can be used across files, such as collections. In the case of collections, one way to work around this is to wrap each collection within a module, and then make the module globally accessible. Here is an example using posts.ts: +In TypeScript, creating global variables is not allowed, and in a Meteor app, creating local variables (using `var `) limits variables' scope to the file. However, you will probably want to define variables, such as collections, that can be used across files. In the case of collections, one way to work around these limitations is to wrap each collection within a module, and then make the module globally accessible. Here is an example using posts.ts: module PostsModel { export var Posts = new Meteor.Collection('posts'); @@ -54,13 +54,13 @@ In TypeScript, creating global variables is not allowed, and in a Meteor app, cr this.PostsModel = PostsModel; -You can then access the Posts collection by placing `/// ` at the top of a TypeScript file. The call would look like this: +You can then access the Posts collection by placing `/// ` at the top of a TypeScript file. The code would look like this: PostsModel.Posts.findOne(Session.get('currentPostId')); ##Reference app -A simple Meteor application created with TypeScript is listed below. It is based on the Microscope reference app in the [Discover Meteor](http://www.discovermeteor.com/ "http://www.discovermeteor.com/"). +A simple Meteor application created with TypeScript is listed below. It is based on the Microscope reference app in [Discover Meteor](http://www.discovermeteor.com/ "http://www.discovermeteor.com/"). - Sample Site: - Code (TypeScript and transpiled JS): From 29f32ee4c4239684ed4cc660cbd2a1f5a5b2142b Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Wed, 28 Aug 2013 16:21:20 -0700 Subject: [PATCH 392/756] More wordsmithing --- meteor/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/meteor/README.md b/meteor/README.md index a040b5e6a5..16a58f4230 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -46,7 +46,7 @@ After you create this file, you may access the Template variable by declaring so ##Defining Collections -In TypeScript, creating global variables is not allowed, and in a Meteor app, creating local variables (using `var `) limits variables' scope to the file. However, you will probably want to define variables, such as collections, that can be used across files. In the case of collections, one way to work around these limitations is to wrap each collection within a module, and then make the module globally accessible. Here is an example using posts.ts: +In TypeScript, global variables are not allowed, and in a Meteor app, creating a local variable (using `var `) limits a variable's scope to the file. However, you will probably want to define variables, such as collections, that can be used across files. In the case of collections, one way to work around these limitations is to wrap each collection within a module, and then make the module globally accessible. Here is an example using posts.ts: module PostsModel { export var Posts = new Meteor.Collection('posts'); @@ -60,7 +60,7 @@ You can then access the Posts collection by placing `/// Date: Wed, 28 Aug 2013 16:28:17 -0700 Subject: [PATCH 395/756] Hopfeully last wordsmithing --- meteor/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meteor/README.md b/meteor/README.md index 6d8a39004c..7cb70c348d 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -66,4 +66,4 @@ A simple Meteor reference application created with TypeScript is listed below. - Code (TypeScript and transpiled JS): ##Meteor package -There will hopefully be a Meteor package soon listed on [Atmosphere](http://atmosphere.meteor.com "http://atmosphere.meteor.com") that can be easily added using 'mrt add meteor'. \ No newline at end of file +There will hopefully be a Meteor package soon listed on [Atmosphere](http://atmosphere.meteor.com "http://atmosphere.meteor.com") that can be easily added using `mrt add meteor`. \ No newline at end of file From e96690c7af5ae2854b2dcf33818d32a7139d09b3 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Wed, 28 Aug 2013 16:28:49 -0700 Subject: [PATCH 396/756] Hopfeully last wordsmithing --- meteor/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meteor/README.md b/meteor/README.md index 7cb70c348d..48ced7f844 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -66,4 +66,4 @@ A simple Meteor reference application created with TypeScript is listed below. - Code (TypeScript and transpiled JS): ##Meteor package -There will hopefully be a Meteor package soon listed on [Atmosphere](http://atmosphere.meteor.com "http://atmosphere.meteor.com") that can be easily added using `mrt add meteor`. \ No newline at end of file +There will hopefully be a Meteor package soon listed on [Atmosphere](http://atmosphere.meteor.com "http://atmosphere.meteor.com") that can be easily added using `mrt add typescript`. \ No newline at end of file From b75496dc6abfc6298f226a9ec7a655736013f083 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Wed, 28 Aug 2013 17:01:16 -0700 Subject: [PATCH 397/756] Hopfeully last wordsmithing --- meteor/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meteor/README.md b/meteor/README.md index 48ced7f844..9ea635d452 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -1,6 +1,6 @@ #Meteor Type Definitions Usage Notes -In order to effectively write your Meteor app with TypeScript, there are a few extra things you will need to do in addition to simply referencing the Meteor type definition file and renaming all of your *.js files to *.ts (which will not work). +In order to effectively write your Meteor app with TypeScript, there are a few extra things you will need to do in addition to simply referencing the Meteor type definition file and renaming all of your *.js files to *.ts (which alone will not work). ##Referencing Meteor type definitions in your app - Place the meteor.d.ts file in a directory (maybe `/lib/typescript`) From a0b3d5f130be56334da9dfa5646eb5c44bf0147b Mon Sep 17 00:00:00 2001 From: Georgios Diamantopoulos Date: Thu, 29 Aug 2013 16:48:36 +0300 Subject: [PATCH 398/756] Added overload for IPromise.then that will retain IHttpPromise type result --- angularjs/angular.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 86f0859b88..ff95dc327f 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -406,6 +406,7 @@ declare module ng { } interface IPromise { + then(successCallback: (promiseValue: T) => IHttpPromise, errorCallback?: (reason: any) => any): IHttpPromise; then(successCallback: (promiseValue: T) => IPromise, errorCallback?: (reason: any) => any): IPromise; then(successCallback: (promiseValue: T) => TResult, errorCallback?: (reason: any) => TResult): IPromise; } From 8c6037d9e51712e871ea37a8ee4fccdd8b301433 Mon Sep 17 00:00:00 2001 From: Georgios Diamantopoulos Date: Thu, 29 Aug 2013 17:19:30 +0300 Subject: [PATCH 399/756] Update angular.d.ts --- angularjs/angular.d.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index ff95dc327f..7dbe2cde0c 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -406,7 +406,7 @@ declare module ng { } interface IPromise { - then(successCallback: (promiseValue: T) => IHttpPromise, errorCallback?: (reason: any) => any): IHttpPromise; + then(successCallback: (promiseValue: T) => IHttpPromise, errorCallback?: (reason: any) => any): IPromise; then(successCallback: (promiseValue: T) => IPromise, errorCallback?: (reason: any) => any): IPromise; then(successCallback: (promiseValue: T) => TResult, errorCallback?: (reason: any) => TResult): IPromise; } @@ -551,9 +551,10 @@ declare module ng { } interface IHttpPromise extends IPromise { + interface IHttpPromise extends IPromise { success(callback: IHttpPromiseCallback): IHttpPromise; error(callback: IHttpPromiseCallback): IHttpPromise; - then(successCallback: (response: IHttpPromiseCallbackArg) => any, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; + then(successCallback: (response: IHttpPromiseCallbackArg) => TResult, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; } interface IHttpProvider extends IServiceProvider { From 538af0796f9e0a081f5aa88bf778d8090c4884a5 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Thu, 29 Aug 2013 09:32:23 -0700 Subject: [PATCH 400/756] Minor change to intro --- meteor/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/meteor/README.md b/meteor/README.md index 9ea635d452..3226bd8eec 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -1,6 +1,11 @@ #Meteor Type Definitions Usage Notes -In order to effectively write your Meteor app with TypeScript, there are a few extra things you will need to do in addition to simply referencing the Meteor type definition file and renaming all of your *.js files to *.ts (which alone will not work). +In order to effectively write your Meteor app with TypeScript, you will probably need to follow these steps: + +- Reference the type definitions file +- Create a Templates definitions file +- Create Collections within modules + ##Referencing Meteor type definitions in your app - Place the meteor.d.ts file in a directory (maybe `/lib/typescript`) @@ -23,6 +28,7 @@ This will make these typed Meteor variables/objects available across your applic *Please note that the Template variable is not automatically available. You need to follow the instructions below to use the Template variable.* + ##Defining Templates In order to call `Template.yourTemplateName.method`, you will need to create a simple TypeScript definition file that declares a Template variable containing a list of template view-models/managers of type IMeteorViewModel (or IMeteorManager, which is the same as IMeteorViewModel). A good place for this definition could be `/client/views/view-model-types.d.ts`. Here is an example of that file: From 692bbb95e2103613a5473a1b339f58c77a845ebc Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Thu, 29 Aug 2013 09:42:34 -0700 Subject: [PATCH 401/756] Minor change to intro --- meteor/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/meteor/README.md b/meteor/README.md index 3226bd8eec..f501dcf54e 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -1,9 +1,9 @@ #Meteor Type Definitions Usage Notes -In order to effectively write your Meteor app with TypeScript, you will probably need to follow these steps: +In order to effectively write your Meteor app with TypeScript, you will probably need to do these things: -- Reference the type definitions file -- Create a Templates definitions file +- Reference the Meteor type definitions file (meteor.d.ts) +- Create a Template definition file - Create Collections within modules From 9e716b9bcc2b1949c85241bd3594d17b77b3e623 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Thu, 29 Aug 2013 09:43:15 -0700 Subject: [PATCH 402/756] Minor change to intro --- meteor/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meteor/README.md b/meteor/README.md index f501dcf54e..092eaf02f0 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -1,6 +1,6 @@ #Meteor Type Definitions Usage Notes -In order to effectively write your Meteor app with TypeScript, you will probably need to do these things: +In order to effectively write a Meteor app with TypeScript, you will probably need to do these things: - Reference the Meteor type definitions file (meteor.d.ts) - Create a Template definition file From c13b2ed733cbb0b4d435d0c8eb9d647537a811e1 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Thu, 29 Aug 2013 09:50:05 -0700 Subject: [PATCH 403/756] Various changes to README --- meteor/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/meteor/README.md b/meteor/README.md index 092eaf02f0..b2320b54fc 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -48,7 +48,7 @@ In order to call `Template.yourTemplateName.method`, you will need to create a s header: IMeteorViewModel; } -After you create this file, you may access the Template variable by declaring something like `/// ` at the top of any TypeScript file containing references to Template. Something like `Template.postsList.helpers()` would then transpile successfully (and have the benefits of typing). +After you create this file, you may access the Template variable by declaring something similar to `/// ` at the top of any TypeScript file containing references to Template. Something like `Template.postsList.helpers()` would then transpile successfully (and also have the benefits of typing). ##Defining Collections @@ -60,7 +60,7 @@ In TypeScript, global variables are not allowed, and in a Meteor app, creating a this.PostsModel = PostsModel; -You can then access the Posts collection by placing `/// ` at the top of a TypeScript file. The code would look like this: +You can then access the Posts collection by placing something similar to `/// ` at the top of a TypeScript file. The code within the file something would look something like this: PostsModel.Posts.findOne(Session.get('currentPostId')); From 0ad9432d6178e61c5de0d15ad36a7c82c149d0c2 Mon Sep 17 00:00:00 2001 From: damianog Date: Thu, 29 Aug 2013 21:16:11 +0200 Subject: [PATCH 404/756] Node.js util.inspect must return a string As explained here: http://nodejs.org/api/util.html#util_util_inspect_object_options util.inspect return a string --- node/node.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/node/node.d.ts b/node/node.d.ts index a77ee58b9b..52560d36b3 100644 --- a/node/node.d.ts +++ b/node/node.d.ts @@ -1011,7 +1011,7 @@ declare module "util" { export function puts(...param: any[]): void; export function print(...param: any[]): void; export function log(string: string): void; - export function inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): void; + export function inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string; export function isArray(object: any): boolean; export function isRegExp(object: any): boolean; export function isDate(object: any): boolean; From bb999fd4e6c456a7b7416d484cf56854dcaaa27b Mon Sep 17 00:00:00 2001 From: benjaminjackman Date: Thu, 29 Aug 2013 14:25:57 -0500 Subject: [PATCH 405/756] Update angular.d.ts ILocationService.search() will return a hash of the query parameters in the current location, not a string. --- angularjs/angular.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 86f0859b88..e30df174e8 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -356,7 +356,7 @@ declare module ng { port(): number; protocol(): string; replace(): ILocationService; - search(): string; + search(): any; search(parametersMap: any): ILocationService; search(parameter: string, parameterValue: any): ILocationService; url(): string; From 4aedbf54623fb516aed8b2ec12cb037a32fc4114 Mon Sep 17 00:00:00 2001 From: "John St. Clair" Date: Fri, 30 Aug 2013 09:53:05 +0200 Subject: [PATCH 406/756] Added jquery reference to highchart and add overload to JQuery --- highcharts/highcharts-tests.ts | 14 ++++++++++++++ highcharts/highcharts.d.ts | 6 ++++++ 2 files changed, 20 insertions(+) diff --git a/highcharts/highcharts-tests.ts b/highcharts/highcharts-tests.ts index 0e951dbbd2..fd36d746eb 100644 --- a/highcharts/highcharts-tests.ts +++ b/highcharts/highcharts-tests.ts @@ -1,4 +1,5 @@ /// +/// var animate: HighchartsBoolOrAnimation; @@ -97,3 +98,16 @@ var div: HTMLDivElement; var r = new Highcharts.Renderer(div, 20, 30); var box = r.text("Hello", 10, 10).getBBox(); +var highChartSettings: HighchartsOptions = { + chart: { + width: 400, + height: 400 + }, + xAxis: [{ + }], + series: [{ + data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4] + }] +}; + +var chart = $("#container").highcharts(highChartSettings); diff --git a/highcharts/highcharts.d.ts b/highcharts/highcharts.d.ts index f1d1f51c95..8f151683f9 100644 --- a/highcharts/highcharts.d.ts +++ b/highcharts/highcharts.d.ts @@ -3,6 +3,8 @@ // Definitions by: Damiano Gambarotto // Definitions: https://github.com/borisyankov/DefinitelyTyped +/// + interface HighchartsPosition { align?: string; verticalAlign?: string; @@ -1106,3 +1108,7 @@ interface HighchartsSeriesObject { xAxis: HighchartsAxisObject; yAxis: HighchartsAxisObject; } + +interface JQuery { + highcharts(options: HighchartsOptions): HighchartsChart; +} From 1088cf1cab3025e48619cf549e18445c659e7a8b Mon Sep 17 00:00:00 2001 From: Basarat Syed Date: Fri, 30 Aug 2013 18:50:31 +1000 Subject: [PATCH 407/756] duplicate cleanup --- angularjs/angular.d.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 7b8ad64b96..cf01c85216 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -550,8 +550,7 @@ declare module ng { config?: IRequestConfig; } - interface IHttpPromise extends IPromise { - interface IHttpPromise extends IPromise { + interface IHttpPromise extends IPromise { success(callback: IHttpPromiseCallback): IHttpPromise; error(callback: IHttpPromiseCallback): IHttpPromise; then(successCallback: (response: IHttpPromiseCallbackArg) => TResult, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; From b2ab530a305af0b9c22b3c4e64cc40d7314c836e Mon Sep 17 00:00:00 2001 From: "John St. Clair" Date: Fri, 30 Aug 2013 13:11:28 +0200 Subject: [PATCH 408/756] Added getOptions to HighchartsStatic, and fixed setOptions() return type --- highcharts/highcharts-tests.ts | 4 ++++ highcharts/highcharts.d.ts | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/highcharts/highcharts-tests.ts b/highcharts/highcharts-tests.ts index fd36d746eb..8534bc837d 100644 --- a/highcharts/highcharts-tests.ts +++ b/highcharts/highcharts-tests.ts @@ -111,3 +111,7 @@ var highChartSettings: HighchartsOptions = { }; var chart = $("#container").highcharts(highChartSettings); + +var options = Highcharts.getOptions(); + +var options2 = Highcharts.setOptions(options); diff --git a/highcharts/highcharts.d.ts b/highcharts/highcharts.d.ts index 8f151683f9..fc14b91f7d 100644 --- a/highcharts/highcharts.d.ts +++ b/highcharts/highcharts.d.ts @@ -1051,7 +1051,8 @@ interface HighchartsStatic { dateFormat(format: string, time?: number, capitalize?: boolean): string; numberFormat(value: number, decimals?: number, decimalPoint?: string, thousandsSep?: string): string; - setOptions(options: HighchartsOptions): any; + setOptions(options: HighchartsOptions): HighchartsOptions; + getOptions(): HighchartsOptions; } declare var Highcharts: HighchartsStatic; From 9653895ef1f7d5051d3c059b4ab683a1ca7d8420 Mon Sep 17 00:00:00 2001 From: basarat Date: Sat, 31 Aug 2013 00:47:14 +1000 Subject: [PATCH 409/756] historyjs lib.d.ts collision comment --- history/history-tests.ts | 6 ++++++ history/history.d.ts | 8 ++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/history/history-tests.ts b/history/history-tests.ts index 5b46307ed3..7c136d94f0 100644 --- a/history/history-tests.ts +++ b/history/history-tests.ts @@ -1,5 +1,11 @@ /// +// Since History is defined in lib.d.ts as well +// the name for our interfaces was chosen to be Historyjs +// However at runtime you would need to do +// https://github.com/borisyankov/DefinitelyTyped/issues/277 +var Historyjs: Historyjs = History; + function tests() { if (!Historyjs.enabled) { return false; diff --git a/history/history.d.ts b/history/history.d.ts index d526576e3d..a8a3c4004d 100644 --- a/history/history.d.ts +++ b/history/history.d.ts @@ -10,6 +10,12 @@ interface HistoryAdapter { onDomLoad(callback); } +// Since History is defined in lib.d.ts as well +// the name for our interfaces was chosen to be Historyjs +// However at runtime you would need to do +// https://github.com/borisyankov/DefinitelyTyped/issues/277 +// var Historyjs: Historyjs = History; + interface Historyjs { enabled: boolean; pushState(data, title, url); @@ -23,5 +29,3 @@ interface Historyjs { log(...messages: any[]); debug(...messages: any[]); } - -declare var Historyjs: Historyjs; \ No newline at end of file From bd8293d2a5da2d0c2d1fdaf7327a329730e38980 Mon Sep 17 00:00:00 2001 From: Elmar Athmer Date: Fri, 30 Aug 2013 17:57:59 +0200 Subject: [PATCH 410/756] fix typo --- angularjs/angular-tests.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/angularjs/angular-tests.ts b/angularjs/angular-tests.ts index 500cb0b4f9..8e458de996 100644 --- a/angularjs/angular-tests.ts +++ b/angularjs/angular-tests.ts @@ -149,7 +149,7 @@ module HttpAndRegularPromiseTests { } } -// Test for AngularJS Syntac +// Test for AngularJS Syntax module My.Namespace { export var x; // need to export something for module to kick in From 01912ae5e7af39a981d9611c5769f5c39464353c Mon Sep 17 00:00:00 2001 From: Elmar Athmer Date: Fri, 30 Aug 2013 18:01:32 +0200 Subject: [PATCH 411/756] add support for angular.element angular.element augments the JQuery object for the given element with angular specific methods like e.g. access for the scope. --- angularjs/angular-tests.ts | 7 +++++++ angularjs/angular.d.ts | 34 +++++++++++++++++++++++++++++++++- 2 files changed, 40 insertions(+), 1 deletion(-) mode change 100644 => 100755 angularjs/angular.d.ts diff --git a/angularjs/angular-tests.ts b/angularjs/angular-tests.ts index 8e458de996..6a6892f57e 100644 --- a/angularjs/angular-tests.ts +++ b/angularjs/angular-tests.ts @@ -210,3 +210,10 @@ foo.then((x) => { // x is infered to be a number, which is the resolved value of a promise x.toFixed(); }); + + +// angular.element() tests +var element = angular.element("div.myApp"); +var scope: ng.IScope = element.scope(); + + diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts old mode 100644 new mode 100755 index cf01c85216..429a79b483 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -33,7 +33,7 @@ declare module ng { bootstrap(element: JQuery, modules?: any[]): auto.IInjectorService; bootstrap(element: Element, modules?: any[]): auto.IInjectorService; copy(source: any, destination?: any): any; - element: JQueryStatic; + element: IAugmentedJQueryStatic; equals(value1: any, value2: any): boolean; extend(destination: any, ...sources: any[]): any; forEach(obj: any, iterator: (value: any, key: any) => any, context?: any): any; @@ -669,6 +669,38 @@ declare module ng { compile?: Function; } + /////////////////////////////////////////////////////////////////////////// + // angular.element + // when calling angular.element, angular returns a jQuery object, + // augmented with additional methods like e.g. scope. + // see: http://docs.angularjs.org/api/angular.element + /////////////////////////////////////////////////////////////////////////// + interface IAugmentedJQueryStatic extends JQueryStatic { + (selector: string, context?: any): IAugmentedJQuery; + (element: Element): IAugmentedJQuery; + (object: {}): IAugmentedJQuery; + (elementArray: Element[]): IAugmentedJQuery; + (object: JQuery): IAugmentedJQuery; + (func: Function): IAugmentedJQuery; + (array: any[]): IAugmentedJQuery; + (): IAugmentedJQuery; + } + + interface IAugmentedJQuery extends JQuery { + // TODO: events, how to define? + //$destroy + + controller(name: string): any; + injector(): any; + scope(): IScope; + + inheritedData(key: string, value: any): JQuery; + inheritedData(obj: { [key: string]: any; }): JQuery; + inheritedData(key?: string): any; + + + } + /////////////////////////////////////////////////////////////////////////// // AUTO module (angular.js) From 82f84e6176450f23e1a3ccde0ec7f5aca7729b8d Mon Sep 17 00:00:00 2001 From: Theodore Brown Date: Fri, 30 Aug 2013 12:13:04 -0500 Subject: [PATCH 412/756] Fix incorrect library name in Ladda definition file --- ladda/ladda.d.ts | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/ladda/ladda.d.ts b/ladda/ladda.d.ts index 278f00379c..7b5204ad32 100644 --- a/ladda/ladda.d.ts +++ b/ladda/ladda.d.ts @@ -1,4 +1,4 @@ -// Type definitions for jStorage 0.4.0 +// Type definitions for Ladda 0.7.0 // Project: https://github.com/hakimel/Ladda // Definitions by: Danil Flores // Definitions: https://github.com/borisyankov/DefinitelyTyped @@ -31,5 +31,4 @@ declare module Ladda { function create(button: HTMLElement): ILaddaButton; - function stopAll(): void; -} \ No newline at end of file + function stopAll(): void;} From 40b08478e04dfad66435edbf61b02e63587050a0 Mon Sep 17 00:00:00 2001 From: Theodore Brown Date: Fri, 30 Aug 2013 12:16:22 -0500 Subject: [PATCH 413/756] Added additional tests (from project homepage) create() method should accept a parameter of type Element, rather than HTMLElement to work with document.querySelector() --- ladda/ladda-tests.ts | 26 +++++++++++++++++++++++++- ladda/ladda.d.ts | 5 +++-- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/ladda/ladda-tests.ts b/ladda/ladda-tests.ts index 9707534cce..24956950cb 100644 --- a/ladda/ladda-tests.ts +++ b/ladda/ladda-tests.ts @@ -1,5 +1,29 @@ /// +// Automatically trigger the loading animation on click +Ladda.bind('input[type=submit]'); + +// Same as the above but automatically stops after two seconds +Ladda.bind('input[type=submit]', { timeout: 2000 }); + +// Create a new instance of ladda for the specified button +var l = Ladda.create(document.querySelector('.my-button')); + +// Start loading +l.start(); + +// Will display a progress bar for 50% of the button width +l.setProgress(0.5); + +// Stop loading +l.stop(); + +// Toggle between loading/not loading states +l.toggle(); + +// Check the current state +l.isLoading(); + // Test bind Ladda.bind('button.ladda-button', { timeout: 42, callback: btn => alert('Clicked!!!') }); Ladda.bind('button.ladda-button'); @@ -17,4 +41,4 @@ var laddaBtn = Ladda.create(btnElement); laddaBtn.start().stop().toggle().setProgress(42).enable().disable().start(); // Test isLoading -console.assert(laddaBtn.isLoading() === true); \ No newline at end of file +console.assert(laddaBtn.isLoading() === true); diff --git a/ladda/ladda.d.ts b/ladda/ladda.d.ts index 7b5204ad32..fc4f43b410 100644 --- a/ladda/ladda.d.ts +++ b/ladda/ladda.d.ts @@ -29,6 +29,7 @@ declare module Ladda { function bind(target: HTMLElement, options?: ILaddaOptions): void; function bind(cssSelector: string, options?: ILaddaOptions): void; - function create(button: HTMLElement): ILaddaButton; + function create(button: Element): ILaddaButton; - function stopAll(): void;} + function stopAll(): void; +} From cb1b62852708536407d535aae31af77fef68cdd4 Mon Sep 17 00:00:00 2001 From: areel Date: Fri, 30 Aug 2013 21:29:47 +0100 Subject: [PATCH 414/756] eventName should be an object to support multiple event names: see code below taken from Backbone code base // Bind an event to a `callback` function. Passing `"all"` will bind // the callback to all events fired. on: function(name, callback, context) { if (!eventsApi(this, 'on', name, [callback, context]) || !callback) return this; ======== // Implement fancy features of the Events API such as multiple event // names `"change blur"` and jQuery-style event maps `{change: action}` // in terms of the existing API. var eventsApi = function(obj, action, name, rest) { if (!name) return true; // Handle event maps. if (typeof name === 'object') { for (var key in name) { obj[action].apply(obj, [key, name[key]].concat(rest)); } return false; } Signed-off-by: areel --- backbone/backbone.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backbone/backbone.d.ts b/backbone/backbone.d.ts index 0635a12471..1a6f3d8fe0 100644 --- a/backbone/backbone.d.ts +++ b/backbone/backbone.d.ts @@ -67,7 +67,7 @@ declare module Backbone { } class Events { - on(eventName: string, callback: (...args: any[]) => void , context?: any): any; + on(eventName: any, callback: (...args: any[]) => void , context?: any): any; off(eventName?: string, callback?: (...args: any[]) => void , context?: any): any; trigger(eventName: string, ...args: any[]): any; bind(eventName: string, callback: (...args: any[]) => void , context?: any): any; From e26d31d81d462565e931d3d337176ed2631a8fe8 Mon Sep 17 00:00:00 2001 From: Aaron Date: Fri, 30 Aug 2013 15:37:28 -0500 Subject: [PATCH 415/756] Update winjs.d.ts to include the class ErrorFromName From http://msdn.microsoft.com/en-us/library/windows/apps/br211689.aspx#methods, the class ErrorFromName was missing. --- winjs/winjs.d.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/winjs/winjs.d.ts b/winjs/winjs.d.ts index debd080d27..a76a81dbec 100644 --- a/winjs/winjs.d.ts +++ b/winjs/winjs.d.ts @@ -62,6 +62,9 @@ declare module WinJS { function start(): void; function stop(): void; } + class ErrorFromName { + constructor(name: string, message?: string); + } class Promise { constructor(init: (c: any, e: any, p: any) => void); then(success?: (value: T) => Promise, error?: (error: any) => Promise, progress?: (progress: any) => void ): Promise; From 34ce0b4ab98c930c8051671c93a992a080a33d27 Mon Sep 17 00:00:00 2001 From: areel Date: Sat, 31 Aug 2013 01:08:19 +0100 Subject: [PATCH 416/756] Correct ElementView to inherit from CellView Provide deepSupplement with options defaults. --- jointjs/jointjs.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/jointjs/jointjs.d.ts b/jointjs/jointjs.d.ts index d3e6a204ea..5472630211 100644 --- a/jointjs/jointjs.d.ts +++ b/jointjs/jointjs.d.ts @@ -77,7 +77,7 @@ declare module joint { snapToGrid(p): { x: number; y: number; }; } - class ElementView { + class ElementView extends CellView { scale(sx: number, sy: number); } class CellView extends Backbone.View { @@ -110,6 +110,6 @@ declare module joint { function mixin(objects: any[]): any; function supplement(objects: any[]): any; function deepMixin(objects: any[]): any; - function deepSupplement(objects: any[]): any; + function deepSupplement(objects: any[], defaultIndicator?: any): any; } } \ No newline at end of file From 641da752e331815c8f4c61a0de82cf0acdde9abe Mon Sep 17 00:00:00 2001 From: Qube Date: Sat, 31 Aug 2013 11:00:00 +1000 Subject: [PATCH 417/756] Populated IElement and IExtCore --- siesta/siesta.d.ts | 229 ++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 216 insertions(+), 13 deletions(-) diff --git a/siesta/siesta.d.ts b/siesta/siesta.d.ts index aa4f47aaac..4548fec1c9 100644 --- a/siesta/siesta.d.ts +++ b/siesta/siesta.d.ts @@ -1,7 +1,4 @@ declare module Siesta { - - //#region Harness - /** * @abstract */ @@ -177,10 +174,6 @@ declare module Siesta { var NodeJS: IHarnessNodeJS; } - //#endregion - - //#region Test - /** * @abstract */ @@ -188,9 +181,11 @@ declare module Siesta { } module Test { - interface IActionCall extends IAction { + interface IActionCall { (next: (...args: any[]) => void, ...previous: any[]): void; + } + interface IActionConfig extends IActionCall, IAction { action?: IActionCall; timeout?: number; @@ -475,7 +470,117 @@ declare module Siesta { type(el: any, text: string, callback?: Function, scope?: any, options?: any): void; } - module KeyCodes { + enum KeyCodes { + '\b' = 8, + 'BACKSPACE' = 8, + + '\t' = 9, + 'TAB' = 9, + + '\r' = 13, + 'RETURN' = 13, + 'ENTER' = 13, + + 'SHIFT' = 16, + 'CTRL' = 17, + 'ALT' = 18, + + 'PAUSE-BREAK' = 19, + 'CAPS' = 20, + 'ESCAPE' = 27, + 'NUM-LOCK' = 144, + 'SCROLL-LOCK' = 145, + 'PRINT' = 44, + + 'PAGE-UP' = 33, + 'PAGE-DOWN' = 34, + 'END' = 35, + 'HOME' = 36, + 'LEFT' = 37, + 'UP' = 38, + 'RIGHT' = 39, + 'DOWN' = 40, + 'INSERT' = 45, + 'DELETE' = 46, + + ' ' = 32, + '0' = 48, + '1' = 49, + '2' = 50, + '3' = 51, + '4' = 52, + '5' = 53, + '6' = 54, + '7' = 55, + '8' = 56, + '9' = 57, + 'A' = 65, + 'B' = 66, + 'C' = 67, + 'D' = 68, + 'E' = 69, + 'F' = 70, + 'G' = 71, + 'H' = 72, + 'I' = 73, + 'J' = 74, + 'K' = 75, + 'L' = 76, + 'M' = 77, + 'N' = 78, + 'O' = 79, + 'P' = 80, + 'Q' = 81, + 'R' = 82, + 'S' = 83, + 'T' = 84, + 'U' = 85, + 'V' = 86, + 'W' = 87, + 'X' = 88, + 'Y' = 89, + 'Z' = 90, + + 'NUM0' = 96, + 'NUM1' = 97, + 'NUM2' = 98, + 'NUM3' = 99, + 'NUM4' = 100, + 'NUM5' = 101, + 'NUM6' = 102, + 'NUM7' = 103, + 'NUM8' = 104, + 'NUM9' = 105, + 'NUM*' = 106, + 'NUM+' = 107, + //'NUM-' = 109, + //'NUM.' = 110, + //'NUM/' = 111, + + ';' = 186, + '=' = 187, + ',' = 188, + '-' = 189, + '.' = 190, + '/' = 191, + '`' = 192, + '[' = 219, + '\\' = 220, + ']' = 221, + '\'' = 222, + + 'F1' = 112, + 'F2' = 113, + 'F3' = 114, + 'F4' = 115, + 'F5' = 116, + 'F6' = 117, + 'F7' = 118, + 'F8' = 119, + 'F9' = 120, + 'F10' = 121, + 'F11' = 122, + 'F12' = 123 } /** @@ -524,7 +629,7 @@ declare module Siesta { /** * @class */ - interface Browser extends Simulate.IEvent, Simulate.IKeyboard, Simulate.IMouse, IElement, ITextSelection { + interface Browser extends ITest, Simulate.IEvent, Simulate.IKeyboard, Simulate.IMouse, IElement, ITextSelection { clearTimeout(timeoutId: number): void; elementFromPoint(x: number, y: number, shallow?: boolean): HTMLElement; @@ -559,12 +664,113 @@ declare module Siesta { * @mixin */ interface IElement { + chainClick(elements: any[], callback: Function): void; + + clickSelector(selector: string, callback: Function, scope?: any): void; + clickSelector(selector: string, root: any, callback: Function, scope?: any): void; + + contentLike(el: any, text: string, description?: string): void; + + contentNotLike(el: any, text: string, description?: string): void; + + elementIsAt(el: any, xy: number[], allowChildren: boolean, description?: string): void; + + elementIsInView(el: any): void; + + elementIsNotTopElement(el: any, allowChildren: boolean, description?: string): void; + + elementIsNotVisible(el: any, description?: string): void; + + elementIsTop(el: any, allowChildren: boolean): boolean; + + elementIsTopElement(el: any, allowChildren: boolean, description?: string, strict?): void; + + elementIsVisible(el: any, description?: string): void; + + findCenter(el: any, local?: boolean): number[]; + + hasCls(el: any, cls: string, description?: string): void; + + hasNotCls(el: any, cls: string, description?: string): void; + + hasNotStyle(el: any, property: string, value: string, description?: string): void; + + hasStyle(el: any, property: string, value: string, description?: string): void; + + isElementVisible(el: any): boolean; + + isInView(el: any, description?: string): void; + + monkeyTest(el: any, nbrInteractions: number, description?: string, callback?: Function, scope?: any): void; + + scrollHorizontallyTo(el: any, newLeft: number, delay?: number, callback?: Function): number; + + scrollVerticallyTo(el: any, newTop: number, delay?: number, callback?: Function): number; + + selectorCountIs(selector: string, count: number, description: string): void; + selectorCountIs(selector: string, root: any, count: number, description: string): void; + + selectorExists(selector: string, description?: string): void; + + selectorIsAt(selector: string, xy: number[], allowChildren: boolean, description?: string): void; + + selectorNotExists(selector: string, description?: string): void; + + waitForContentLike(el: any, text: string, callback: Function, scope: any, timeout: number): void; + + waitForContentNotLike(el: any, text: string, callback: Function, scope: any, timeout: number): void; + + waitForElementNotTop(el: any, callback: Function, scope: any, timeout: number): void; + + waitForElementNotVisible(el: any, callback: Function, scope: any, timeout: number): void; + + waitForElementTop(el: any, callback: Function, scope: any, timeout: number): void; + + waitForElementVisible(el: any, callback: Function, scope: any, timeout: number): void; + + waitForScrollChange(el: any, side: string, callback: Function, scope: any, timeout: number): void; + + waitForScrollLeftChange(el: any, callback: Function, scope: any, timeout: number): void; + + waitForScrollTopChange(el: any, callback: Function, scope: any, timeout: number): void; + + waitForSelector(selector: string, callback: Function, scope: any, timeout: number): void; + waitForSelector(selector: string, root: any, callback: Function, scope: any, timeout: number): void; + + waitForSelectorAt(xy: number[], selector: string, callback: Function, scope: any, timeout: number): void; + + waitForSelectorAtCursor(xy: number[], selector: string, callback: Function, scope: any, timeout: number): void; + + waitForSelectorNotFound(selector: string, callback: Function, scope: any, timeout: number): void; + waitForSelectorNotFound(selector: string, root: any, callback: Function, scope: any, timeout: number): void; + + waitForSelectors(selectors: string[], callback: Function, scope: any, timeout: number): void; + waitForSelectors(selectors: string[], root: any, callback: Function, scope: any, timeout: number): void; + + waitUntilInView(el: any, callback: Function, scope: any, timeout: number): void; } /** * @mixin */ interface IExtJSCore { + Ext(): any; + + clickCQ(selector: string, root: any, callback: Function); + + clickComponentQuery(selector: string, root: any, callback: Function); + + compositeQuery(selector: string, root: any, allowEmpty: boolean): HTMLElement[]; + + cq(selector: string); + + cq1(selector: string); + + getExt(): any; + + knownBugIn(frameworkVersion: string, fn: Function, reason: string); + + requireOk(...args: any[]): void; } /** @@ -695,9 +901,6 @@ declare module Siesta { interface ITextSelection { } } - - //#endregion - } declare function StartTest(testScript: (t: Siesta.ITest) => void): void; From 6e223523176b6b61ba649b58f47bf773de2acacb Mon Sep 17 00:00:00 2001 From: Jason Jarrett Date: Fri, 30 Aug 2013 21:04:36 -0700 Subject: [PATCH 418/756] Added support for LiosK's UUID.js --- UUID/UUID-tests.ts | 46 ++++++++++++++++++++++++ UUID/UUID.d.ts | 88 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 134 insertions(+) create mode 100644 UUID/UUID-tests.ts create mode 100644 UUID/UUID.d.ts diff --git a/UUID/UUID-tests.ts b/UUID/UUID-tests.ts new file mode 100644 index 0000000000..0c6d5874e2 --- /dev/null +++ b/UUID/UUID-tests.ts @@ -0,0 +1,46 @@ +/// +// Copied below from readme at https://github.com/LiosK/UUID.js + + + + +// the simplest way to get an UUID (as a hexadecimal string) +console.log(UUID.generate()); // "0db9a5fa-f532-4736-89d6-8819c7f3ac7b" + +// create a version 4 (random-numbers-based) UUID object +var objV4 = UUID.genV4(); + +// create a version 1 (time-based) UUID object +var objV1 = UUID.genV1(); + +// create an UUID object from a hexadecimal string +var uuid = UUID.parse("a0e0f130-8c21-11df-92d9-95795a3bcd40"); + + +// UUID object as a string +console.log(uuid.toString()); // "a0e0f130-8c21-11df-92d9-95795a3bcd40" +console.log(uuid.hexString); // "a0e0f130-8c21-11df-92d9-95795a3bcd40" +console.log(uuid.bitString); // "101000001110000 ... 1100110101000000" +console.log(uuid.urn); // "urn:uuid:a0e0f130-8c21-11df-92d9-95795a3bcd40" + +// compare UUID objects +console.log(objV4.equals(objV1)); // false + +// show version numbers +console.log(objV4.version); // 4 +console.log(objV1.version); // 1 + +// get UUID field values in 3 different formats by 2 different accessors +console.log(uuid.intFields.timeLow); // 2699096368 +console.log(uuid.bitFields.timeMid); // "1000110000100001" +console.log(uuid.hexFields.timeHiAndVersion); // "11df" +console.log(uuid.intFields.clockSeqHiAndReserved); // 146 +console.log(uuid.bitFields.clockSeqLow); // "11011001" +console.log(uuid.hexFields.node); // "95795a3bcd40" + +console.log(uuid.intFields[0]); // 2699096368 +console.log(uuid.bitFields[1]); // "1000110000100001" +console.log(uuid.hexFields[2]); // "11df" +console.log(uuid.intFields[3]); // 146 +console.log(uuid.bitFields[4]); // "11011001" +console.log(uuid.hexFields[5]); // "95795a3bcd40" diff --git a/UUID/UUID.d.ts b/UUID/UUID.d.ts new file mode 100644 index 0000000000..03aa3c216f --- /dev/null +++ b/UUID/UUID.d.ts @@ -0,0 +1,88 @@ +// Type definitions for UUID.js core-1.0 +// Project: https://github.com/LiosK/UUID.js +// Definitions by: Jason Jarrett +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +declare module UUID { + + interface UUIDStatic { + + /** + * The simplest function to get an UUID string. + * @returns {string} A version 4 UUID string. + */ + generate(): string; + + /** + * Generates a version 4 {@link UUID}. + * @returns {UUID} A version 4 {@link UUID} object. + * @since 3.0 + */ + genV4(): UUID; + + + /** + * Generates a version 1 {@link UUID}. + * @returns {UUID} A version 1 {@link UUID} object. + * @since 3.0 + */ + genV1(): UUID; + + /** + * Converts hexadecimal UUID string to an {@link UUID} object. + * @param {string} strId UUID hexadecimal string representation ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). + * @returns {UUID} {@link UUID} object or null. + * @since 3.0 + */ + parse(uuid: string): UUID; + + + /** + * Re-initializes version 1 UUID state. + * @since 3.0 + */ + resetState(): void; + + /** + * Reinstalls {@link UUID.generate} method to emulate the interface of UUID.js version 2.x. + * @since 3.1 + * @deprecated Version 2.x. compatible interface is not recommended. + */ + makeBackwardCompatible(): void; + } + + interface UUIDArray extends Array { + timeLow: string; + timeMid: string; + timeHiAndVersion: string; + clockSeqHiAndReserved: string; + clockSeqLow: string; + node: string; + } + + interface UUID { + intFields: UUIDArray; + bitFields: UUIDArray; + hexFields: UUIDArray; + version: number; + bitString: string; + hexString: string; + urn: string; + + + /** + * Tests if two {@link UUID} objects are equal. + * @param {UUID} uuid + * @returns {bool} True if two {@link UUID} objects are equal. + */ + equals(uuid: UUID): boolean; + + /** + * Returns UUID string representation. + * @returns {string} {@link UUID#hexString}. + */ + toString(): string; + } +} + +declare var UUID: UUID.UUIDStatic; From 8baa8698168bf487ae27a29fe9a41e8a5e7dd55e Mon Sep 17 00:00:00 2001 From: Jason Jarrett Date: Sat, 31 Aug 2013 09:45:22 -0700 Subject: [PATCH 419/756] Updated readme with UUIS.js --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 825e9cd79a..13115f9fdf 100755 --- a/README.md +++ b/README.md @@ -199,6 +199,7 @@ List of Definitions * [Underscore.js](http://underscorejs.org/) (by [Boris Yankov](https://github.com/borisyankov)) * [Underscore.js (Typed)](http://underscorejs.org/) (by [Josh Baldwin](https://github.com/jbaldwin/)) * [Underscore-ko.js](https://github.com/kamranayub/UnderscoreKO) (by [Maurits Elbers](https://github.com/MagicMau)) +* [UUID.js](https://github.com/LiosK/UUID.js) (by [Jason Jarrett](https://github.com/staxmanade)) * [Viewporter](https://github.com/zynga/viewporter) (by [Boris Yankov](https://github.com/borisyankov)) * [Vimeo](http://developer.vimeo.com/player/js-api) (by [Daz Wilkin](https://github.com/DazWilkin/)) * [WebRTC](http://dev.w3.org/2011/webrtc/editor/webrtc.html) (by [Ken Smith](https://github.com/smithkl42)) From 2b81fbd73f018cfd2c34c5bff425d2ad885c8512 Mon Sep 17 00:00:00 2001 From: nikeee13 Date: Sun, 1 Sep 2013 01:21:03 +0200 Subject: [PATCH 420/756] Update selector to type Object (not any) --- mongodb/mongodb.d.ts | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts index 31675c3662..51c14166ca 100644 --- a/mongodb/mongodb.d.ts +++ b/mongodb/mongodb.d.ts @@ -56,8 +56,8 @@ declare module "mongodb" { public createCollection(collectionName: string, callback?: (err: Error, result: Collection) => void ); public createCollection(collectionName: string, options: CollectionCreateOptions, callback?: (err, result) => void ); - public command(selector: any, callback?: (err, result) => void ); - public command(selector: any, options: any, callback?: (err, result) => void ); + public command(selector: Object, callback?: (err, result) => void ); + public command(selector: Object, options: any, callback?: (err, result) => void ); public dropCollection(collectionName: string, callback?: (err, result) => void ); public renameCollection(fromCollection: string, toCollection: string, callback?: (err, result) => void ); @@ -237,16 +237,16 @@ declare module "mongodb" { insert(query: any, callback: (err: any, result: any) => void): void; insert(query: any, options: { safe?: any; continueOnError?: boolean; keepGoing?: boolean; serializeFunctions?: boolean; }, callback: (err: any, result: any) => void): void; - remove(selector, callback?: (err: any, result: any) => void); - remove(selector, options: { safe?: any; single?: boolean; }, callback?: (err: any, result: any) => void); + remove(selector: Object, callback?: (err: any, result: any) => void); + remove(selector: Object, options: { safe?: any; single?: boolean; }, callback?: (err: any, result: any) => void); rename(newName: String, callback?: (err, result) => void); save(doc: any, callback : (err, result) => void); save(doc: any, options: { safe: any; }, callback : (err, result) => void); - update(selector: any, document: any, callback?: (err: any, result: any) => void): void; - update(selector: any, document: any, options: { safe?; upsert?; multi?; serializeFunctions?; }, callback: (err: any, result: any) => void): void; + update(selector: Object, document: any, callback?: (err: any, result: any) => void): void; + update(selector: Object, document: any, options: { safe?; upsert?; multi?; serializeFunctions?; }, callback: (err: any, result: any) => void): void; distinct(key: string, query: Object, callback: (err, result) => void); distinct(key: string, query: Object, options: { readPreferences; }, callback: (err, result) => void); @@ -264,20 +264,20 @@ declare module "mongodb" { findAndRemove(query : Object, sort? : any[], options?: { safe; }, callback?: (err, result) => void); find(callback?: (err: any, result: Cursor) => void): Cursor; - find(selector: any, callback?: (err: any, result: Cursor) => void): Cursor; - find(selector: any, fields: any, callback?: (err: any, result: Cursor) => void): Cursor; - find(selector: any, options: CollectionFindOptions, callback?: (err: any, result: Cursor) => void): Cursor; - find(selector: any, fields: any, options: CollectionFindOptions, callback?: (err: any, result: Cursor) => void): Cursor; - find(selector: any, fields: any, skip: number, limit: number, callback?: (err: any, result: Cursor) => void): Cursor; - find(selector: any, fields: any, skip: number, limit: number, timeout: number, callback?: (err: any, result: Cursor) => void): Cursor; + find(selector: Object, callback?: (err: any, result: Cursor) => void): Cursor; + find(selector: Object, fields: any, callback?: (err: any, result: Cursor) => void): Cursor; + find(selector: Object, options: CollectionFindOptions, callback?: (err: any, result: Cursor) => void): Cursor; + find(selector: Object, fields: any, options: CollectionFindOptions, callback?: (err: any, result: Cursor) => void): Cursor; + find(selector: Object, fields: any, skip: number, limit: number, callback?: (err: any, result: Cursor) => void): Cursor; + find(selector: Object, fields: any, skip: number, limit: number, timeout: number, callback?: (err: any, result: Cursor) => void): Cursor; findOne(callback?: (err: any, result: any) => void): Cursor; - findOne(selector: any, callback?: (err: any, result: any) => void): Cursor; - findOne(selector: any, fields: any, callback?: (err: any, result: any) => void): Cursor; - findOne(selector: any, options: CollectionFindOptions, callback?: (err: any, result: any) => void): Cursor; - findOne(selector: any, fields: any, options: CollectionFindOptions, callback?: (err: any, result: any) => void): Cursor; - findOne(selector: any, fields: any, skip: number, limit: number, callback?: (err: any, result: any) => void): Cursor; - findOne(selector: any, fields: any, skip: number, limit: number, timeout: number, callback?: (err: any, result: any) => void): Cursor; + findOne(selector: Object, callback?: (err: any, result: any) => void): Cursor; + findOne(selector: Object, fields: any, callback?: (err: any, result: any) => void): Cursor; + findOne(selector: Object, options: CollectionFindOptions, callback?: (err: any, result: any) => void): Cursor; + findOne(selector: Object, fields: any, options: CollectionFindOptions, callback?: (err: any, result: any) => void): Cursor; + findOne(selector: Object, fields: any, skip: number, limit: number, callback?: (err: any, result: any) => void): Cursor; + findOne(selector: Object, fields: any, skip: number, limit: number, timeout: number, callback?: (err: any, result: any) => void): Cursor; createIndex(fieldOrSpec, options: IndexOptions, callback: (err: Error, indexName: string) => void); ensureIndex(fieldOrSpec, options: IndexOptions, callback: (err: Error, indexName: string) => void); From 291d5f5644d76ed0fdf09d388e6e0c11c80403bc Mon Sep 17 00:00:00 2001 From: Qube Date: Sun, 1 Sep 2013 09:24:16 +1000 Subject: [PATCH 421/756] jQuery and Sencha Touch. --- siesta/siesta.d.ts | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/siesta/siesta.d.ts b/siesta/siesta.d.ts index 4548fec1c9..9dba36c938 100644 --- a/siesta/siesta.d.ts +++ b/siesta/siesta.d.ts @@ -809,6 +809,7 @@ declare module Siesta { * @class */ interface jQuery extends Browser { + get$(): any; } interface IWaitForConfig { @@ -889,16 +890,40 @@ declare module Siesta { waitFor(config: IWaitForConfig): IWaitForReturn; } + interface IPositionConfig { + x?: number; + + y?: number; + } + /** * @class */ interface SenchaTouch extends Browser, IExtJSComponent, IExtJSElement, IExtJSFormField, IExtJSObservable, IExtJSStore, IExtJSCore { + doubleTap(target: any, callback?: Function, scope?: any, offset?: number[]): void; + + longpress(target: any, callback?: Function, scope?: any, offset?: number[]): void; + + moveFingerBy(delta: number[], callback?: Function, scope?: any): void; + + moveFingerTo(target: any, callback?: Function, scope?: any, offset?: number[]): void; + + scrollUntilElementVisible(scrollable: any, direction: string, actionTarget: any, callback: Function, scope: any): void; + + swipe(target: any, direction: string, callback?: Function, scope?: any): void; + + tap(target: any, callback?: Function, scope?: any): void; + + waitForScrollerPosition(scroller: any, position: IPositionConfig, callback: Function, scope: any, timeout: number): void; } /** * @mixin */ interface ITextSelection { + getSelectedText(el: any): string; + + selectText(el: any, start?: number, end?: number): void; } } } From 00f60714238b5ce709362f62caa10b5fc86b3639 Mon Sep 17 00:00:00 2001 From: basarat Date: Sun, 1 Sep 2013 11:24:01 +1000 Subject: [PATCH 422/756] sammyjs Updated definitions + fixed compile errors in tests. --- sammyjs/sammyjs-tests.ts | 340 ++++++++++++++++++++------------------- sammyjs/sammyjs.d.ts | 59 +++++-- 2 files changed, 221 insertions(+), 178 deletions(-) diff --git a/sammyjs/sammyjs-tests.ts b/sammyjs/sammyjs-tests.ts index 7ad95f6c06..da0da616e8 100644 --- a/sammyjs/sammyjs-tests.ts +++ b/sammyjs/sammyjs-tests.ts @@ -1,8 +1,9 @@ /// function test_general() { + // Example from homepage var app = Sammy('#main', function () { - var _this: Sammy.Application; + var _this: Sammy.Application = this; _this.use('Mustache'); _this.get('#/', function () { var _this: Sammy.RenderContext; @@ -64,7 +65,7 @@ function test_app() { }); var app = $.sammy(), - context = { verb: 'get', path: '#/mypath' }; + context = { verb: 'get', path: '#/mypath' }; app.contextMatchesOptions(context, '#/mypath'); app.contextMatchesOptions(context, '#/otherpath'); @@ -98,15 +99,13 @@ function test_app() { var app = $.sammy(function () { var _this: Sammy.Application; - _this.helpers({ + var better = _this.helpers({ upcase: function (text) { return text.toString().toUpperCase(); } }); - _this.get('#/', function () { - with (_this) { - $('#main').html(upcase($('#main').text())); - } + better.get('#/', function () { + $('#main').html(better.upcase($('#main').text())); }); }); @@ -137,7 +136,7 @@ function test_app() { context.$element().html(content); context.$element().fadeIn('slow', function () { if (callback) { - callback.apply(); + callback.apply(this); } }); }); @@ -179,146 +178,156 @@ function test_misc() { $.sammy(function () { var _this: Sammy.Application; _this.get('#/:name', function () { - if (_this.params['name'] == 'sammy') { - _this.partial('name.html.erb', { name: 'Sammy' }); + var _evt: Sammy.EventContext = this; + if (_evt.params['name'] == 'sammy') { + _evt.partial('name.html.erb', { name: 'Sammy' }); } else { - _this.redirect('#/somewhere-else') + _evt.redirect('#/somewhere-else') } }); }); - var _this: Sammy.Application; - _this.redirect('#/other/route'); - _this.redirect('#', 'other', 'route'); - _this.render('mytemplate.mustache', { name: 'quirkey' }) - .appendTo('ul'); - _this.renderEach('mytemplate.mustache', [{ name: 'quirkey' }, { name: 'endor' }]); + function evtContextTests() { + var _this: Sammy.EventContext; + _this.redirect('#/other/route'); + _this.redirect('#', 'other', 'route'); + _this.render('mytemplate.mustache', { name: 'quirkey' }) + .appendTo('ul'); + _this.renderEach('mytemplate.mustache', [{ name: 'quirkey' }, { name: 'endor' }]); - var item = { - name: 'My Item', - price: '$25.50', - meta: { - id: '123' - } - }; - var form = new Sammy.FormBuilder('item', item); - form.text('name'); + var item = { + name: 'My Item', + price: '$25.50', + meta: { + id: '123' + } + }; + var form = new Sammy.FormBuilder('item', item); + form.text('name'); - var options = [ - ['Small', 's'], - ['Medium', 'm'], - ['Large', 'l'] - ]; - form.select('size', options); + var options = [ + ['Small', 's'], + ['Medium', 'm'], + ['Large', 'l'] + ]; + form.select('size', options); - $.sammy(function () { - var _this: Sammy.Application; - _this.use('GoogleAnalytics') + $.sammy(function () { + var _this: Sammy.Application; + _this.use('GoogleAnalytics') _this.get('#/dont/track/me', function () { - _this.noTrack(); + var evt: Sammy.GoogleAnalytics = this; + evt.noTrack(); + }); }); - }); + + var app = $.sammy(function () { + var _this: Sammy.Application; + _this.use(Sammy.Haml); + _this.get('#/hello/:name', function () { + var evt: Sammy.Haml = this; + evt.title = 'Hello!'; + evt.name = evt.params.name; + evt.partial('mytemplate.haml'); + }); + }); + app.run() var app = $.sammy(function () { - var _this: Sammy.Application; - _this.use(Sammy.Haml); - _this.get('#/hello/:name', function () { - _this.title = 'Hello!' - _this.name = _this.params.name; - _this.partial('mytemplate.haml'); + var _this: Sammy.Application; + _this.use('Handlebars', 'hb'); + _this.get('#/hello/:name', function () { + var evt: Sammy.Handlebars = this; + evt.title = 'Hello!' + evt.name = evt.params.name; + evt.partial('mytemplate.hb'); + }); }); - }); - app.run() + + var app = $.sammy(function () { + var _this: Sammy.Application; + _this.use('Handlebars', 'hb'); + _this.get('#/hello/:name/to/:friend', function (context: Sammy.Handlebars) { + context.load('mypartial.hb') + .then(function (partial) { + context.partials = { hello_friend: partial }; + context.name = context.params.name; + // dynamically add a property to the context + (context).friend = context.params.friend; + context.partial('mytemplate.hb'); + }); + }); + }); + + var app = $.sammy(function () { + var _this: Sammy.Application; + _this.use('Hogan', 'hg'); + _this.get('#/hello/:name', function () { + var evt: Sammy.Hogan = this; + evt.title = 'Hello!' + evt.name = evt.params.name; + evt.partial('mytemplate.hg'); + }); + }); + + var app = $.sammy(function () { + var _this: Sammy.Application; + _this.use('Hogan', 'hg'); + _this.get('#/hello/:name/to/:friend', function (context) { + context.load('mypartial.hg') + .then(function (partial) { + context.partials = { hello_friend: partial }; + context.name = context.params.name; + context.friend = context.params.friend; + context.partial('mytemplate.hg'); + }); + }); + }); + + var app = $.sammy(function () { + var _this: Sammy.Application; + _this.use(Sammy.JSON); + _this.get('#/', function () { + var evt: Sammy.JSON = this; + evt.json({ user_id: 123 }); + evt.json("{\"user_id\":\"123\"}"); + evt.json("{\"user_id\":\"123\"}").user_id; + }); + }) var app = $.sammy(function () { - var _this: Sammy.Application; - _this.use('Handlebars', 'hb'); - _this.get('#/hello/:name', function () { - _this.title = 'Hello!' - _this.name = _this.params.name; - _this.partial('mytemplate.hb'); + var _this: Sammy.Application; + _this.use('Mustache', 'ms'); + _this.get('#/hello/:name', function () { + var evt: Sammy.Mustache = this; + evt.title = 'Hello!' + evt.name = evt.params.name; + evt.partial('mytemplate.ms'); + }); }); - }); - var app = $.sammy(function () { - var _this: Sammy.Application; - _this.use('Handlebars', 'hb'); - _this.get('#/hello/:name/to/:friend', function (context) { - _this.load('mypartial.hb') - .then(function (partial) { - context.partials = { hello_friend: partial }; - context.name = context.params.name; - context.friend = context.params.friend; - context.partial('mytemplate.hb'); - }); + var app = $.sammy(function () { + var _this: Sammy.Application; + _this.use('Mustache', 'ms'); + _this.get('#/hello/:name/to/:friend', function (context: Sammy.Mustache) { + context.load('mypartial.ms') + .then(function (partial) { + context.partials = { hello_friend: partial }; + context.name = context.params.name; + (context).friend = context.params.friend; + context.partial('mytemplate.ms'); + }); + }); }); - }); - var app = $.sammy(function () { - var _this: Sammy.Application; - _this.use('Hogan', 'hg'); - _this.get('#/hello/:name', function () { - _this.title = 'Hello!' - _this.name = _this.params.name; - _this.partial('mytemplate.hg'); + var app = $.sammy(function (app) { + var _this: Sammy.Application; + _this.use(Sammy.NestedParams); + _this.post('#/parse_me', function (context) { + $.log(context.params); + }); }); - }); - - var app = $.sammy(function () { - var _this: Sammy.Application; - _this.use('Hogan', 'hg'); - _this.get('#/hello/:name/to/:friend', function (context) { - _this.load('mypartial.hg') - .then(function (partial) { - context.partials = { hello_friend: partial }; - context.name = context.params.name; - context.friend = context.params.friend; - context.partial('mytemplate.hg'); - }); - }); - }); - - var app = $.sammy(function () { - var _this: Sammy.Application; - _this.use(Sammy.JSON); - _this.get('#/', function () { - _this.json({ user_id: 123 }); - _this.json("{\"user_id\":\"123\"}"); - _this.json("{\"user_id\":\"123\"}").user_id; - }); - }) - - var app = $.sammy(function () { - var _this: Sammy.Application; - _this.use('Mustache', 'ms'); - _this.get('#/hello/:name', function () { - _this.title = 'Hello!' - _this.name = _this.params.name; - _this.partial('mytemplate.ms'); - }); - }); - - var app = $.sammy(function () { - var _this: Sammy.Application; - _this.use('Mustache', 'ms'); - _this.get('#/hello/:name/to/:friend', function (context) { - _this.load('mypartial.ms') - .then(function (partial) { - context.partials = { hello_friend: partial }; - context.name = context.params.name; - context.friend = context.params.friend; - context.partial('mytemplate.ms'); - }); - }); - }); - - var app = $.sammy(function (app) { - var _this: Sammy.Application; - _this.use(Sammy.NestedParams); - _this.post('#/parse_me', function (context) { - $.log(_this.params); - }); - }); + }; var _this: Sammy.Application; _this.use('Storage'); @@ -333,7 +342,7 @@ function test_misc() { _this.bind("oauth.connected", function () { $("#signin").hide() }); _this.bind("oauth.disconnected", function () { $("#signin").show() }); _this.bind("oauth.denied", function (evt, error) { - _this.partial("admin/views/no_access.tmpl", { error: error.message }); + evt.partial("admin/views/no_access.tmpl", { error: error.message }); }); _this.get("#/signout", function (context) { context.loseAccessToken(); @@ -341,27 +350,29 @@ function test_misc() { }); _this.get('#/', function () { - _this.render('mytemplate.template', { name: 'test' }); + this.render('mytemplate.template', { name: 'test' }); }); _this.send($.getJSON, '/app.json') .then(function (json) { $('#message').text(json['message']); } - ); + ); _this.get('#/', function () { - _this.load('myfile.txt') + var evt: Sammy.EventContext = this; + evt.load('myfile.txt') .then(function (content) { $('#main').html(content); }); }); _this.get('#/', function () { - _this.load('mytext.json') + var evt: Sammy.EventContext = this; + evt.load('mytext.json') .then(function (content) { - var context = _this, - data = JSON.parse(content); + var context = this, + data = JSON.parse(content); context.wait(); $.post(data.url, {}, function (response) { context.next(JSON.parse(response)); @@ -386,7 +397,8 @@ function test_misc() { store.each(function (key, value) { Sammy.log('key', key, 'value', value); }); - var store = new Sammy.Store; + + store = new Sammy.Store(); store.exists('foo'); store.fetch('foo', function () { return 'bar!'; @@ -396,7 +408,7 @@ function test_misc() { return 'baz!'; }); - var store = new Sammy.Store; + store = new Sammy.Store(); store.set('one', 'two'); store.set('two', 'three'); store.set('1', 'two'); @@ -404,12 +416,12 @@ function test_misc() { return value === 'two'; }); - var store = new Sammy.Store; + var store = new Sammy.Store(); store.load('mytemplate', '/mytemplate.tpl', function () { - s.get('mytemplate') + store.get('mytemplate') }); - var store = new Sammy.Store({ name: 'kvo' }); + store = new Sammy.Store({ name: 'kvo' }); $('body').bind('set-kvo-foo', function (e, data) { Sammy.log(data.key + ' changed to ' + data.value); }); @@ -418,17 +430,19 @@ function test_misc() { $.sammy(function () { _this.use('Template'); _this.get('#/', function () { - _this.user = { name: 'Aaron Quint' }; - _this.partial('user.template'); + var evt: Sammy.EventContext = this; + // Adding a dynamic property + (evt).user = { name: 'Aaron Quint' }; + evt.partial('user.template'); }) }); _this.use(Sammy.Template, 'tpl'); _this.get('#/', function () { - _this.partial('myfile.tpl'); + this.partial('myfile.tpl'); }); _this.get('#/', function () { - _this.template('myform.tpl', { form: "
" }, { escape_html: false }); + this.template('myform.tpl', { form: "
" }, { escape_html: false }); }); } @@ -440,21 +454,21 @@ function test_routes() { _this.put('#/post/form', function () { return false; }); - _thisget('/test/123', function () { + _this.get('/test/123', function () { }); - _thisget('#/by_name/:name', function () { - alert(_this.params['name']); + _this.get('#/by_name/:name', function () { + alert(this.params['name']); }); - _thisget(/\#\/by_name\/(.*)/, function () { - alert(_this.params['splat']); + _this.get(/\#\/by_name\/(.*)/, function () { + alert(this.params['splat']); }); - _thisget('#/by_name/:name', function () { - _this.redirect('#', _this.params['name']); + _this.get('#/by_name/:name', function () { + this.redirect('#', this.params['name']); }); - _thisget('#/by_name/:name', function (context) { - context.redirect('#', _this.params['name']); + _this.get('#/by_name/:name', function (context) { + context.redirect('#', this.params['name']); }); } @@ -466,16 +480,16 @@ function test_events() { _this.redirect('#/'); }); - var app = $.sammy(function () { + var app1 = $.sammy(function () { var _this: Sammy.Application; _this.bind('test', function () { var _this: Sammy.EventContext; _this.trigger('other-event'); }); }); - app.trigger('other-event'); + app1.trigger('other-event'); - var app = $.sammy(function () { + var app2 = $.sammy(function () { var _this: Sammy.Application; _this.bind('test', function (e, data) { alert(data['my_data']); @@ -495,12 +509,12 @@ function test_plugins() { } }); }; - var app = $.sammy(function () { + var app1 = $.sammy(function () { var _this: Sammy.Application; _this.use(MyPlugin); _this.get('#/', function () { var _this: Sammy.EventContext; - _this.alert("I'm home"); + alert("I'm home"); }); }); var MyAdvancedPlugin = function (app, prefix, suffix) { @@ -516,25 +530,25 @@ function test_plugins() { var _this: Sammy.Application; _this.use(MyAdvancedPlugin, 'BEFORE!', 'AFTER!'); _this.get('#/', function () { - _this.alert("I'm home"); + alert("I'm home"); }); }); var dbLoadAndDisplay = function (app) { var _this: Sammy.Application; _this.get('#/', function () { - _this.record = _this.app.db[_this.app.element_selector]; - _this.app.swap(_this.record.toHTML()); + this.record = this.app.db[this.app.element_selector]; + this.app.swap(this.record.toHTML()); }); _this.bind('run', function () { }); }; var app1 = Sammy('#div_1', function () { - _this.use(dbLoadAndDisplay); + this.use(dbLoadAndDisplay); }); var app2 = Sammy('#div_2', function () { - _this.use(dbLoadAndDisplay); + this.use(dbLoadAndDisplay); }); } \ No newline at end of file diff --git a/sammyjs/sammyjs.d.ts b/sammyjs/sammyjs.d.ts index 40fdab6679..1c9ca48771 100644 --- a/sammyjs/sammyjs.d.ts +++ b/sammyjs/sammyjs.d.ts @@ -20,18 +20,20 @@ declare function Sammy(selector: string, handler: Function): Sammy.Application; interface JQueryStatic { sammy: SammyFunc; + log: Function; } declare module Sammy { export function Cache(app, options); export function DataCacheProxy(initial, $element); - export function DataLocationProxy(app, data_name, href_attribute); + export var DataLocationProxy:DataLocationProxy; export function DefaultLocationProxy(app, run_interval_every); export function EJS(app, method_alias); export function Exceptional(app, errorReporter); export function Flash(app); + export var FormBuilder: FormBuilder; export function Form(app); // formFor ( name, object, content_callback ) export function Haml(app, method_alias); @@ -49,15 +51,17 @@ declare module Sammy { export function PushLocationProxy(app); export function Session(app, options); export function Storage(app); + export var Store: Store; export function Title(); + export function Template(app, method_alias); export function Tmpl(app, method_alias); export function addLogger(logger); - export function log(); + export function log(...args:any[]); - export interface Object { + export class Object { - new (obj: any); + constructor(obj: any); escapeHTML(s: string): string; h(s: string): string; @@ -82,6 +86,7 @@ declare module Sammy { after(callback: Function): Application; any(verb: string, path: string, callback: Function): void; around(callback: Function): Application; + before(callback: Function): Application; before(options: any, callback: Function): Application; bind(name: string, callback: Function): Application; bind(name: string, data: any, callback: Function): Application; @@ -96,8 +101,8 @@ declare module Sammy { get(path: string, callback: Function): Application; get(path: RegExp, callback: Function): Application; getLocation(): string; - helper(name: string, method: Function): Application; - helpers(extensions: any): Application; + helper(name: string, method: Function): any; // Behaviour similar to _.extend + helpers(extensions: any): any; // Behaviour similar to _.extend isRunning(): boolean; log(...params: any[]): void; lookupRoute(verb: string, path: string): any; @@ -113,19 +118,27 @@ declare module Sammy { route(verb: string, path: RegExp, callback: Function): Application; run(start_url?: string): Application; runRoute(verb: string, path?: string, params?: any, target?: any): any; + send(...params: any[]); setLocation(new_location: string): string; setLocationProxy(new_proxy: DataLocationProxy): void; - swap(content: any, callback: Function): string; + swap(content: any, callback: Function): any; templateCache(key: string, value: any): any; toString(): string; trigger(name: string, data?: any): Application; unload(): Application; use(...params: any[]): void; + + // Features provided by oauth2 plugin + oauthorize: string; + requireOAuth(); + requireOAuth(path?:string); + requireOAuth(callback?: Function); } export interface DataLocationProxy { - new (app, run_interval_every): DataLocationProxy; + new (app, run_interval_every?): DataLocationProxy; + new (app, data_name, href_attribute): DataLocationProxy; fullPath(location_obj): string; bind(): void; @@ -142,19 +155,25 @@ declare module Sammy { engineFor(engine: any): any; eventNamespace(): string; interpolate(content: any, data: any, engine: any, partials): EventContext; + json(str: any): any; json(str: string): any; load(location: any, options?: any, callback?: Function): any; loadPartials(partials); notFound(): any; - partial(location: string, data: any, callback: Function, partials): RenderContext; - params: Object; + partial(location: string, data?: any, callback?: Function, partials?): RenderContext; + partials: any; + params: any; redirect(...params: any[]): void; - render(location: string, data: any, callback: Function, partials): RenderContext; - renderEach(location: any, name?: string, data?: any, callback?: Function): RenderContext; + render(location: string, data?: any, callback?: Function, partials?): RenderContext; + renderEach(location: any, data?: { name: string;data?:any}[],callback?: Function): RenderContext; send(...params: any[]): RenderContext; swap(contents: any, callback: Function): string; toString(): string; trigger(name: string, data?: any): EventContext; + + // Provided by common sammy modules: + name: any; + title: any; } export interface FormBuilder { @@ -186,6 +205,16 @@ declare module Sammy { track(path); } + export interface Haml extends EventContext { } + + export interface Handlebars extends EventContext { } + + export interface Hogan extends EventContext { } + + export interface JSON extends EventContext { } + + export interface Mustache extends EventContext { } + export interface RenderContext extends Object { new (event_context); @@ -204,10 +233,10 @@ declare module Sammy { render(location: string, callback: Function, partials?: any): RenderContext; render(location: string, data: any, callback: Function): RenderContext; render(location: string, data: any, callback: Function, partials: any): RenderContext; - renderEach(location: string, name: string, data: any, callback: Function): RenderContext; + renderEach(location: string, name?: string, data?: any, callback?: Function): RenderContext; replace(selector: string): RenderContext; send(...params: any[]): RenderContext; - swap(callback: Function): RenderContext; + swap(callback?: Function): RenderContext; then(callback: Function): RenderContext; trigger(name, data); wait(): void; @@ -228,7 +257,7 @@ declare module Sammy { stores: any; - new (options); + new (options?:any); clear(key: string): any; clearAll(): void; From 73c3b95565d54edf3fcebe62ce6b681599cafc13 Mon Sep 17 00:00:00 2001 From: Qube Date: Sun, 1 Sep 2013 14:44:15 +1000 Subject: [PATCH 423/756] Ext Ajax, Component and DataView. --- siesta/siesta.d.ts | 51 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/siesta/siesta.d.ts b/siesta/siesta.d.ts index 9dba36c938..c4c42331ad 100644 --- a/siesta/siesta.d.ts +++ b/siesta/siesta.d.ts @@ -401,18 +401,69 @@ declare module Siesta { * @mixin */ interface IExtJSAjax { + ajaxRequestAndThen(url: string, callback: Function, scope: any): void; + + isAjaxLoading(object?: any, description?: string): void; + + waitForAjaxRequest(callback: Function, scope: any, timeout: number): void; + waitForAjaxRequest(object: any, callback: Function, scope: any, timeout: number): void; } /** * @mixin */ interface IExtJSComponent { + destroysOk(components: any[], description?: string): void; + destroysOk(components: string, description?: string): void; + destroysOk(components: any, description?: string): void; + + hasPosition(component: string, x: number, y: number, description?: string): void; + hasPosition(component: any, x: number, y: number, description?: string): void; + + hasSize(component: string, width: number, height: number, description?: string): void; + hasSize(component: any, width: number, height: number, description?: string): void; + + waitForCQ(query: string, root: any, callback: Function, scope: any, timeout: number): void; + + waitForCQNotFound(query: string, callback: Function, scope: any, timeout: number): void; + + waitForCQNotVisible(query: string, callback: Function, scope: any, timeout: number): void; + + waitForCQVisible(query: string, callback: Function, scope: any, timeout: number): void; + + waitForComponent(component: string, rendered: boolean, callback: Function, scope: any, timeout: number): void; + + waitForComponentNotVisible(component: string, callback: Function, scope: any, timeout: number): void; + waitForComponentNotVisible(component: any, callback: Function, scope: any, timeout: number): void; + + waitForComponentQuery(query: string, root: any, callback: Function, scope: any, timeout: number): void; + + waitForComponentQueryNotFound(query: string, root: any, callback: Function, scope: any, timeout: number): void; + + waitForComponentQueryNotVisible(query: string, root: any, callback: Function, scope: any, timeout: number): void; + + waitForComponentQueryVisible(query: string, root: any, callback: Function, scope: any, timeout: number): void; + + waitForComponentVisible(component: string, callback: Function, scope: any, timeout: number): void; + waitForComponentVisible(component: any, callback: Function, scope: any, timeout: number): void; + + waitForCompositeQuery(query: string, root: any, callback: Function, scope: any, timeout: number): void; + + waitForCompositeQueryNotFound(query: string, root: any, callback: Function, scope: any, timeout: number): void; + + waitForXType(xtype: string, callback: Function, scope: any, timeout: number): void; + waitForXType(xtype: string, root: any, callback: Function, scope: any, timeout: number): void; } /** * @mixin */ interface IExtJSDataView { + getFirstItem(view: string): any; + getFirstItem(view: any): any; + + waitForViewRendered(view: string, callback: Function, scope: any, timeout: number): void; + waitForViewRendered(view: any, callback: Function, scope: any, timeout: number): void; } /** From b620577785f939a2629c68227c46d85d1511e28d Mon Sep 17 00:00:00 2001 From: Qube Date: Sun, 1 Sep 2013 15:06:46 +1000 Subject: [PATCH 424/756] Ext Element, FormField, Grid, Observable and Store. --- siesta/siesta.d.ts | 51 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 43 insertions(+), 8 deletions(-) diff --git a/siesta/siesta.d.ts b/siesta/siesta.d.ts index c4c42331ad..de066a5bd0 100644 --- a/siesta/siesta.d.ts +++ b/siesta/siesta.d.ts @@ -413,14 +413,10 @@ declare module Siesta { * @mixin */ interface IExtJSComponent { - destroysOk(components: any[], description?: string): void; - destroysOk(components: string, description?: string): void; destroysOk(components: any, description?: string): void; - hasPosition(component: string, x: number, y: number, description?: string): void; hasPosition(component: any, x: number, y: number, description?: string): void; - hasSize(component: string, width: number, height: number, description?: string): void; hasSize(component: any, width: number, height: number, description?: string): void; waitForCQ(query: string, root: any, callback: Function, scope: any, timeout: number): void; @@ -433,7 +429,6 @@ declare module Siesta { waitForComponent(component: string, rendered: boolean, callback: Function, scope: any, timeout: number): void; - waitForComponentNotVisible(component: string, callback: Function, scope: any, timeout: number): void; waitForComponentNotVisible(component: any, callback: Function, scope: any, timeout: number): void; waitForComponentQuery(query: string, root: any, callback: Function, scope: any, timeout: number): void; @@ -444,7 +439,6 @@ declare module Siesta { waitForComponentQueryVisible(query: string, root: any, callback: Function, scope: any, timeout: number): void; - waitForComponentVisible(component: string, callback: Function, scope: any, timeout: number): void; waitForComponentVisible(component: any, callback: Function, scope: any, timeout: number): void; waitForCompositeQuery(query: string, root: any, callback: Function, scope: any, timeout: number): void; @@ -459,10 +453,8 @@ declare module Siesta { * @mixin */ interface IExtJSDataView { - getFirstItem(view: string): any; getFirstItem(view: any): any; - waitForViewRendered(view: string, callback: Function, scope: any, timeout: number): void; waitForViewRendered(view: any, callback: Function, scope: any, timeout: number): void; } @@ -470,36 +462,79 @@ declare module Siesta { * @mixin */ interface IExtJSElement { + hasRegion(el: any, region: any, description?: string): void; } /** * @mixin */ interface IExtJSFormField { + fieldHasValue(field: any, value: any, description?: string): void; + + isFieldEmpty(field: any, description?: string): void; } /** * @mixin */ interface IExtJSGrid { + getCell(panel: any, row: number, column: number): HTMLElement; + + getFirstCell(panel: any): HTMLElement; + + getFirstRow(panel: any): any; + + getLastCellInRow(panel: any, row: number): HTMLElement; + + getRow(panel: any, index: number): any; + + matchGridCellContent(panel: any, row: number, column: number, string: RegExp, description?: string): void; + matchGridCellContent(panel: any, row: number, column: number, string: string, description?: string): void; + + waitForRowsVisible(panel: any, callback: Function, scope: any, timeout: number): void; } /** * @mixin */ interface IExtJSObservable { + firesAtLeastNTimes(observable: any, event: string, n: number, desc: string): void; + + firesOnce(observable: any, event: string, desc: string): void; + + hasListener(observable: any, eventName: string, description?: string): void; + + isFiredWithSignature(observable: any, event: string, checkerFn: Function, desc: string): void; + + waitForEvent(observable: any, event: string, callback: Function, scope: any, timeout: number): void; + + wontFire(observable: any, event: string, desc: string): void; } /** * @mixin */ interface IExtJSStore { + isStoreEmpty(store: any, description?: string): void; + + loadStoresAndThen(...args: any[]): void; + + waitForStoresToLoad(...args: any[]): void; } /** * @class */ interface ExtJS extends Browser, IExtJSAjax, IExtJSComponent, IExtJSDataView, IExtJSElement, IExtJSFormField, IExtJSGrid, IExtJSObservable, IExtJSStore, IExtJSCore { + assertMaxNumberOfGlobalExtOverrides(maxNumber: number, description?): void; + + assertNoGlobalExtOverrides(description?: string): void; + + assertNoLayoutTriggered(fn: Function, scope: any, description?: string): void; + + getTotalLayoutCounter(): number; + + waitForPageLoad(callback: Function, scope: any): void; } module Simulate { From cb6db2460c0bc9a4b71a3ae9d5e3795057d9cd0a Mon Sep 17 00:00:00 2001 From: Qube Date: Sun, 1 Sep 2013 16:27:28 +1000 Subject: [PATCH 425/756] Optional scope, tests. --- siesta/siesta-tests.ts | 13 ++++++ siesta/siesta.d.ts | 95 +++++++++++++++++++++++------------------- 2 files changed, 64 insertions(+), 44 deletions(-) diff --git a/siesta/siesta-tests.ts b/siesta/siesta-tests.ts index e800d5d7ff..e0af1d74a5 100644 --- a/siesta/siesta-tests.ts +++ b/siesta/siesta-tests.ts @@ -1,12 +1,25 @@ /// StartTest(function (t: Siesta.Test.ExtJS) { + t.waitForComponentQuery('#myItemId', () => { + t.ajaxRequestAndThen('http://some/url', () => { + t.isBoolean(123, 'not a boolean'); + }, null); + }, null, 2000); }); startTest(function (t: Siesta.Test.Browser) { + t.waitForSelectors(['.class', '#id'], () => { }); }); describe(function (t: Siesta.Test.jQuery) { + var library = t.get$(); + + t.describe('My Module', () => { + t.it('should do something', () => { + t.expect('some string').not.toBe('some other string'); + }); + }); }); var Harness = Siesta.Harness.Browser; diff --git a/siesta/siesta.d.ts b/siesta/siesta.d.ts index de066a5bd0..dfffdb45dc 100644 --- a/siesta/siesta.d.ts +++ b/siesta/siesta.d.ts @@ -405,8 +405,8 @@ declare module Siesta { isAjaxLoading(object?: any, description?: string): void; - waitForAjaxRequest(callback: Function, scope: any, timeout: number): void; - waitForAjaxRequest(object: any, callback: Function, scope: any, timeout: number): void; + waitForAjaxRequest(callback: Function, scope?: any, timeout?: number): void; + waitForAjaxRequest(object: any, callback: Function, scope?: any, timeout?: number): void; } /** @@ -419,34 +419,41 @@ declare module Siesta { hasSize(component: any, width: number, height: number, description?: string): void; - waitForCQ(query: string, root: any, callback: Function, scope: any, timeout: number): void; + waitForCQ(query: string, callback: Function, scope?: any, timeout?: number): void; + waitForCQ(query: string, root: any, callback: Function, scope?: any, timeout?: number): void; - waitForCQNotFound(query: string, callback: Function, scope: any, timeout: number): void; + waitForCQNotFound(query: string, callback: Function, scope?: any, timeout?: number): void; - waitForCQNotVisible(query: string, callback: Function, scope: any, timeout: number): void; + waitForCQNotVisible(query: string, callback: Function, scope?: any, timeout?: number): void; - waitForCQVisible(query: string, callback: Function, scope: any, timeout: number): void; + waitForCQVisible(query: string, callback: Function, scope?: any, timeout?: number): void; - waitForComponent(component: string, rendered: boolean, callback: Function, scope: any, timeout: number): void; + waitForComponent(component: string, rendered: boolean, callback: Function, scope?: any, timeout?: number): void; - waitForComponentNotVisible(component: any, callback: Function, scope: any, timeout: number): void; + waitForComponentNotVisible(component: any, callback: Function, scope?: any, timeout?: number): void; - waitForComponentQuery(query: string, root: any, callback: Function, scope: any, timeout: number): void; + waitForComponentQuery(query: string, callback: Function, scope?: any, timeout?: number): void; + waitForComponentQuery(query: string, root: any, callback: Function, scope?: any, timeout?: number): void; - waitForComponentQueryNotFound(query: string, root: any, callback: Function, scope: any, timeout: number): void; + waitForComponentQueryNotFound(query: string, callback: Function, scope?: any, timeout?: number): void; + waitForComponentQueryNotFound(query: string, root: any, callback: Function, scope?: any, timeout?: number): void; - waitForComponentQueryNotVisible(query: string, root: any, callback: Function, scope: any, timeout: number): void; + waitForComponentQueryNotVisible(query: string, callback: Function, scope?: any, timeout?: number): void; + waitForComponentQueryNotVisible(query: string, root: any, callback: Function, scope?: any, timeout?: number): void; - waitForComponentQueryVisible(query: string, root: any, callback: Function, scope: any, timeout: number): void; + waitForComponentQueryVisible(query: string, callback: Function, scope?: any, timeout?: number): void; + waitForComponentQueryVisible(query: string, root: any, callback: Function, scope?: any, timeout?: number): void; - waitForComponentVisible(component: any, callback: Function, scope: any, timeout: number): void; + waitForComponentVisible(component: any, callback: Function, scope?: any, timeout?: number): void; - waitForCompositeQuery(query: string, root: any, callback: Function, scope: any, timeout: number): void; + waitForCompositeQuery(query: string, callback: Function, scope?: any, timeout?: number): void; + waitForCompositeQuery(query: string, root: any, callback: Function, scope?: any, timeout?: number): void; - waitForCompositeQueryNotFound(query: string, root: any, callback: Function, scope: any, timeout: number): void; + waitForCompositeQueryNotFound(query: string, callback: Function, scope?: any, timeout?: number): void; + waitForCompositeQueryNotFound(query: string, root: any, callback: Function, scope?: any, timeout?: number): void; - waitForXType(xtype: string, callback: Function, scope: any, timeout: number): void; - waitForXType(xtype: string, root: any, callback: Function, scope: any, timeout: number): void; + waitForXType(xtype: string, callback: Function, scope?: any, timeout?: number): void; + waitForXType(xtype: string, root: any, callback: Function, scope?: any, timeout?: number): void; } /** @@ -455,7 +462,7 @@ declare module Siesta { interface IExtJSDataView { getFirstItem(view: any): any; - waitForViewRendered(view: any, callback: Function, scope: any, timeout: number): void; + waitForViewRendered(view: any, callback: Function, scope?: any, timeout?: number): void; } /** @@ -491,7 +498,7 @@ declare module Siesta { matchGridCellContent(panel: any, row: number, column: number, string: RegExp, description?: string): void; matchGridCellContent(panel: any, row: number, column: number, string: string, description?: string): void; - waitForRowsVisible(panel: any, callback: Function, scope: any, timeout: number): void; + waitForRowsVisible(panel: any, callback: Function, scope?: any, timeout?: number): void; } /** @@ -506,7 +513,7 @@ declare module Siesta { isFiredWithSignature(observable: any, event: string, checkerFn: Function, desc: string): void; - waitForEvent(observable: any, event: string, callback: Function, scope: any, timeout: number): void; + waitForEvent(observable: any, event: string, callback: Function, scope?: any, timeout?: number): void; wontFire(observable: any, event: string, desc: string): void; } @@ -534,7 +541,7 @@ declare module Siesta { getTotalLayoutCounter(): number; - waitForPageLoad(callback: Function, scope: any): void; + waitForPageLoad(callback: Function, scope?: any): void; } module Simulate { @@ -730,9 +737,9 @@ declare module Siesta { setTimeout(func: Function, delay: number): number; - waitForEvent(observable: any, event: string, callback: Function, scope: any, timeout: number): void; + waitForEvent(observable: any, event: string, callback: Function, scope?: any, timeout?: number): void; - waitForPageLoad(callback: Function, scope: any): void; + waitForPageLoad(callback: Function, scope?: any): void; willFireNTimes(observable: any, event: string, n: number, desc: string): void; @@ -802,38 +809,38 @@ declare module Siesta { selectorNotExists(selector: string, description?: string): void; - waitForContentLike(el: any, text: string, callback: Function, scope: any, timeout: number): void; + waitForContentLike(el: any, text: string, callback: Function, scope?: any, timeout?: number): void; - waitForContentNotLike(el: any, text: string, callback: Function, scope: any, timeout: number): void; + waitForContentNotLike(el: any, text: string, callback: Function, scope?: any, timeout?: number): void; - waitForElementNotTop(el: any, callback: Function, scope: any, timeout: number): void; + waitForElementNotTop(el: any, callback: Function, scope?: any, timeout?: number): void; - waitForElementNotVisible(el: any, callback: Function, scope: any, timeout: number): void; + waitForElementNotVisible(el: any, callback: Function, scope?: any, timeout?: number): void; - waitForElementTop(el: any, callback: Function, scope: any, timeout: number): void; + waitForElementTop(el: any, callback: Function, scope?: any, timeout?: number): void; - waitForElementVisible(el: any, callback: Function, scope: any, timeout: number): void; + waitForElementVisible(el: any, callback: Function, scope?: any, timeout?: number): void; - waitForScrollChange(el: any, side: string, callback: Function, scope: any, timeout: number): void; + waitForScrollChange(el: any, side: string, callback: Function, scope?: any, timeout?: number): void; - waitForScrollLeftChange(el: any, callback: Function, scope: any, timeout: number): void; + waitForScrollLeftChange(el: any, callback: Function, scope?: any, timeout?: number): void; - waitForScrollTopChange(el: any, callback: Function, scope: any, timeout: number): void; + waitForScrollTopChange(el: any, callback: Function, scope?: any, timeout?: number): void; - waitForSelector(selector: string, callback: Function, scope: any, timeout: number): void; - waitForSelector(selector: string, root: any, callback: Function, scope: any, timeout: number): void; + waitForSelector(selector: string, callback: Function, scope?: any, timeout?: number): void; + waitForSelector(selector: string, root: any, callback: Function, scope?: any, timeout?: number): void; - waitForSelectorAt(xy: number[], selector: string, callback: Function, scope: any, timeout: number): void; + waitForSelectorAt(xy: number[], selector: string, callback: Function, scope?: any, timeout?: number): void; - waitForSelectorAtCursor(xy: number[], selector: string, callback: Function, scope: any, timeout: number): void; + waitForSelectorAtCursor(xy: number[], selector: string, callback: Function, scope?: any, timeout?: number): void; - waitForSelectorNotFound(selector: string, callback: Function, scope: any, timeout: number): void; - waitForSelectorNotFound(selector: string, root: any, callback: Function, scope: any, timeout: number): void; + waitForSelectorNotFound(selector: string, callback: Function, scope?: any, timeout?: number): void; + waitForSelectorNotFound(selector: string, root: any, callback: Function, scope?: any, timeout?: number): void; - waitForSelectors(selectors: string[], callback: Function, scope: any, timeout: number): void; - waitForSelectors(selectors: string[], root: any, callback: Function, scope: any, timeout: number): void; + waitForSelectors(selectors: string[], callback: Function, scope?: any, timeout?: number): void; + waitForSelectors(selectors: string[], root: any, callback: Function, scope?: any, timeout?: number): void; - waitUntilInView(el: any, callback: Function, scope: any, timeout: number): void; + waitUntilInView(el: any, callback: Function, scope?: any, timeout?: number): void; } /** @@ -971,8 +978,8 @@ declare module Siesta { verifyGlobals(...names: string[]): void; - waitFor(wait: number, callback: Function, scope: any, timeout: number, interval?: number): IWaitForReturn; - waitFor(method: Function, callback: Function, scope: any, timeout: number, interval?: number): IWaitForReturn; + waitFor(wait: number, callback: Function, scope?: any, timeout?: number, interval?: number): IWaitForReturn; + waitFor(method: Function, callback: Function, scope?: any, timeout?: number, interval?: number): IWaitForReturn; waitFor(config: IWaitForConfig): IWaitForReturn; } @@ -1000,7 +1007,7 @@ declare module Siesta { tap(target: any, callback?: Function, scope?: any): void; - waitForScrollerPosition(scroller: any, position: IPositionConfig, callback: Function, scope: any, timeout: number): void; + waitForScrollerPosition(scroller: any, position: IPositionConfig, callback: Function, scope?: any, timeout?: number): void; } /** From e0050868f9a9b064307a95527e84b55e8cac167a Mon Sep 17 00:00:00 2001 From: Qube Date: Sun, 1 Sep 2013 16:43:33 +1000 Subject: [PATCH 426/756] Test core. --- siesta/siesta.d.ts | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/siesta/siesta.d.ts b/siesta/siesta.d.ts index dfffdb45dc..449bf262ca 100644 --- a/siesta/siesta.d.ts +++ b/siesta/siesta.d.ts @@ -178,6 +178,49 @@ declare module Siesta { * @abstract */ interface ITest extends Test.IBDD, Test.IDate, Test.IFunction, Test.IMore { + isReadyTimeout: number; + + beginAsync(time: number, errback: Function): any; + + compareObjects(obj1: any, obj2: any, strict?: boolean, onlyPrimitives?: boolean, asObjects?: boolean): boolean; + + diag(desc: string): void; + + done(delay: number): void; + + endAsync(frame: any): void; + + endWait(title: string): void; + + fail(desc: string, annotation: any): void; + + getSubTest(name: string, code: (t: ITest) => void, timeout?: number): ITest; + + is(got: any, expected: any, desc: string): void; + + isNot(got: any, expected: any, desc: string): void; + + isNotStrict(got: any, expected: any, desc: string): void; + + isReady(): any; + + isStrict(got: any, expected: any, desc: string): void; + + launchSubTest(subTest: ITest, callback: Function): void; + + notOk(value: any, desc: string): void; + + ok(value: any, desc: string): void; + + pass(desc: string, annotation: any): void; + + subTest(desc: string, code: (t: ITest) => void, callback: Function, timeout?: number): void; + + todo(why: string, code: Function): void; + + typeOf(object: any): string; + + wait(title: string, howLong: number): void; } module Test { From 7d34352d8a80a98879048789b010b261e0a3b501 Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Sun, 1 Sep 2013 10:36:01 +0100 Subject: [PATCH 427/756] SimplePagination: fix onPageClick definition --- .../jquery.simplePagination-tests.ts | 14 ++++++++++++++ .../jquery.simplePagination.d.ts | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/jquery.simplePagination/jquery.simplePagination-tests.ts b/jquery.simplePagination/jquery.simplePagination-tests.ts index f804f87605..728ca03a85 100644 --- a/jquery.simplePagination/jquery.simplePagination-tests.ts +++ b/jquery.simplePagination/jquery.simplePagination-tests.ts @@ -11,6 +11,20 @@ $(function () { }); }); +$(function () { + $(selector).pagination({ + onPageClick: (page) => { + } + }); +}); + +$(function () { + $(selector).pagination({ + onPageClick: (page, event) => { + } + }); +}); + $(function () { $(selector).pagination('selectPage', 1); }); diff --git a/jquery.simplePagination/jquery.simplePagination.d.ts b/jquery.simplePagination/jquery.simplePagination.d.ts index d3c52b8c70..1f3bc15539 100644 --- a/jquery.simplePagination/jquery.simplePagination.d.ts +++ b/jquery.simplePagination/jquery.simplePagination.d.ts @@ -18,7 +18,7 @@ interface SimplePaginationOptions { nextText?: string; cssStyle?: string; selectOnClick?: boolean; - onPageClick?: (page?: number, event?: any) => void; + onPageClick?: (page: number, event: any) => void; onInit?: () => void; } From 8edb57ae1187b1293f54188e7464baedcb641752 Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Sun, 1 Sep 2013 11:00:31 +0100 Subject: [PATCH 428/756] FullCalendar: Fix method option --- fullCalendar/fullCalendar-tests.ts | 4 +- fullCalendar/fullCalendar.d.ts | 101 ++++++++++++++++++++++++++++- 2 files changed, 103 insertions(+), 2 deletions(-) diff --git a/fullCalendar/fullCalendar-tests.ts b/fullCalendar/fullCalendar-tests.ts index 6c60f3ddb3..33a5c97987 100644 --- a/fullCalendar/fullCalendar-tests.ts +++ b/fullCalendar/fullCalendar-tests.ts @@ -829,4 +829,6 @@ $(document).ready(function () { } }); -}); \ No newline at end of file +}); + +$('#calendar').fullCalendar('refetchEvents') \ No newline at end of file diff --git a/fullCalendar/fullCalendar.d.ts b/fullCalendar/fullCalendar.d.ts index b26920dc21..04698dec53 100644 --- a/fullCalendar/fullCalendar.d.ts +++ b/fullCalendar/fullCalendar.d.ts @@ -7,10 +7,25 @@ declare module FullCalendar { export interface Calendar { + /** + * Formats a Date object into a string. + */ formatDate(date: Date, format: string, options?: Options): string; + /** + * Formats a date range (two Date objects) into a string. + */ formatDates(date1: Date, date2: Date, format: string, options?: Options): string; + /** + * Parses a string into a Date object. + */ parseDate(dateString: string, ignoreTimezone?: boolean): Date; + /** + * Parses an ISO8601 string into a Date object. + */ parseISO8601(dateString: string, ignoreTimezone?: boolean): Date; + /** + * Gets the version of Fullcalendar + */ version: string; } @@ -179,33 +194,117 @@ declare module FullCalendar { } interface JQuery { + /** + * Create calendar object + */ fullCalendar(options: FullCalendar.Options): JQuery; + /** + * Generic method function + */ fullCalendar(method: string, arg1: any, arg2: any, arg3: any): void; + /** + * Get/Set option value + */ fullCalendar(method: 'option', option: string, value?: any): void; + /** + * Immediately forces the calendar to render and/or readjusts its size. + */ fullCalendar(method: 'render'): void; + /** + * Restores the element to the state before FullCalendar was initialized. + */ fullCalendar(method: 'destroy'): void; + /** + * Moves the calendar one step back (either by a month, week, or day). + */ fullCalendar(method: 'prev'): void; + /** + * Moves the calendar one step forward (either by a month, week, or day). + */ fullCalendar(method: 'next'): void; + /** + * Moves the calendar back one year. + */ fullCalendar(method: 'prevYear'): void; + /** + * Moves the calendar forward one year. + */ fullCalendar(method: 'nextYear'): void; + /** + * Moves the calendar to the current date. + */ fullCalendar(method: 'today'): void; + /** + * Returns the View Object for the current view. + */ fullCalendar(method: 'getView'): FullCalendar.View; + /** + * Immediately switches to a different view. + */ fullCalendar(method: 'changeView', viewName: string): void; + /** + * Moves the calendar to an arbitrary year/month/date. + */ fullCalendar(method: 'gotoDate', year: number, month?: number, date?: number): void; + /** + * Moves the calendar to an arbitrary date. + */ fullCalendar(method: 'gotoDate', date: Date): void; + /** + * Moves the calendar forward/backward an arbitrary amount of time. + */ fullCalendar(method: 'incrementDate', year: number, month?: number, date?: number): void; + /** + * Returns a Date object for the current date of the calendar. + */ fullCalendar(method: 'getDate'): Date; + /** + * A method for programmatically selecting a period of time. + */ fullCalendar(method: 'select', startDate: Date, endDate: Date, allDay: boolean): void; + /** + * A method for programmatically clearing the current selection. + */ fullCalendar(method: 'unselect'): void; + /** + * Reports changes to an event and renders them on the calendar. + */ fullCalendar(method: 'updateEvent', event: FullCalendar.EventObject): void; + /** + * Retrieves events that FullCalendar has in memory. + */ fullCalendar(method: 'clientEvents', idOrfilter?: any): Array; + /** + * Retrieves events that FullCalendar has in memory. + */ fullCalendar(method: 'clientEvents', idOrfilter?: (e: FullCalendar.EventObject) => boolean): Array; + /** + * Removes events from the calendar. + */ fullCalendar(method: 'removeEvents', idOrfilter?: any): void; + /** + * Removes events from the calendar. + */ fullCalendar(method: 'removeEvents', idOrfilter?: (e: FullCalendar.EventObject) => boolean): void; - fullCalendar(method: 'refreshEvents'): void; + /** + * Refetches events from all sources and rerenders them on the screen. + */ + fullCalendar(method: 'refetchEvents'): void; + /** + * Dynamically adds an event source. + */ fullCalendar(method: 'addEventSource', source: any): void; + /** + * Dynamically removes an event source. + */ fullCalendar(method: 'removeEventSource', source: any): void; + /** + * Renders a new event on the calendar. + */ fullCalendar(method: 'renderEvent', event: FullCalendar.EventObject, stick?: boolean): void; + /** + * Rerenders all events on the calendar. + */ fullCalendar(method: 'rerenderEvents'): void; } From f1a37d4cfa0a9ac5be4412093a4f739e9f26b085 Mon Sep 17 00:00:00 2001 From: Neil Stalker Date: Sun, 1 Sep 2013 11:03:07 +0100 Subject: [PATCH 429/756] Fix knockout tests --- knockout/tests/knockout-tests.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/knockout/tests/knockout-tests.ts b/knockout/tests/knockout-tests.ts index e2fbf4c023..b0755c12af 100644 --- a/knockout/tests/knockout-tests.ts +++ b/knockout/tests/knockout-tests.ts @@ -260,7 +260,7 @@ interface KnockoutExtenders { } interface KnockoutObservableArrayFunctions { - filterByProperty(propName, matchValue): KnockoutComputed; + filterByProperty(propName, matchValue): KnockoutComputed; } declare var validate; From 2e403eefa0f8f0819f48e2789e62fb9d1ef6e915 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Poul=20Kjeldager=20S=C3=B8rensen?= Date: Sun, 1 Sep 2013 22:14:52 +0200 Subject: [PATCH 430/756] Added jquery External Module definition for amd module --- jquery/jquery.d.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/jquery/jquery.d.ts b/jquery/jquery.d.ts index 7a3d4f844a..03cf993e57 100644 --- a/jquery/jquery.d.ts +++ b/jquery/jquery.d.ts @@ -807,6 +807,8 @@ interface JQuery { queue(queueName: string, newQueueOrCallback: any): JQuery; queue(newQueueOrCallback: any): JQuery; } - +declare module "jquery" { + export = $; +} declare var jQuery: JQueryStatic; declare var $: JQueryStatic; From 99b9ae87c669d71512842f6689fc3d878a6ac5ae Mon Sep 17 00:00:00 2001 From: NN Date: Mon, 2 Sep 2013 11:48:32 +0300 Subject: [PATCH 431/756] Update gridster.d.ts Semicolon is required in TypeScript --- jquery.gridster/gridster.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/jquery.gridster/gridster.d.ts b/jquery.gridster/gridster.d.ts index 9328cc5265..6019ebb067 100644 --- a/jquery.gridster/gridster.d.ts +++ b/jquery.gridster/gridster.d.ts @@ -32,8 +32,8 @@ interface GridsterDraggable { limit: boolean; offset_left: number; drag: (event: Event, ui: GridsterUi) => void; - start: (event: Event, ui: { helper: JQuery }) => void; - stop: (event: Event, ui: { helper: JQuery }) => void; + start: (event: Event, ui: { helper: JQuery; }) => void; + stop: (event: Event, ui: { helper: JQuery; }) => void; } interface GridsterUi { @@ -228,4 +228,4 @@ interface Gridster { * @return Returns the instance of the Gridster class. **/ disable(): Gridster; -} \ No newline at end of file +} From b4b426a2353c5004c836fbadd35dca0c67b6d4bf Mon Sep 17 00:00:00 2001 From: "John St. Clair" Date: Mon, 2 Sep 2013 12:16:08 +0200 Subject: [PATCH 432/756] FIX: return type should be jQuery selector, not chart --- highcharts/highcharts-tests.ts | 2 +- highcharts/highcharts.d.ts | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/highcharts/highcharts-tests.ts b/highcharts/highcharts-tests.ts index 8534bc837d..fe32a89312 100644 --- a/highcharts/highcharts-tests.ts +++ b/highcharts/highcharts-tests.ts @@ -110,7 +110,7 @@ var highChartSettings: HighchartsOptions = { }] }; -var chart = $("#container").highcharts(highChartSettings); +var container = $("#container").highcharts(highChartSettings); var options = Highcharts.getOptions(); diff --git a/highcharts/highcharts.d.ts b/highcharts/highcharts.d.ts index fc14b91f7d..8b940ef9cd 100644 --- a/highcharts/highcharts.d.ts +++ b/highcharts/highcharts.d.ts @@ -1111,5 +1111,11 @@ interface HighchartsSeriesObject { } interface JQuery { - highcharts(options: HighchartsOptions): HighchartsChart; + /** + * Creates a new Highcharts.Chart for the current JQuery selector; usually + * a div selected by $('#container') + * @param {HighchartsOptions} options Options for this chart + * @return current {JQuery} selector the current JQuery selector + **/ + highcharts(options: HighchartsOptions): JQuery; } From beb33fa2e31bc02a6a13beed2e0e20801614cccf Mon Sep 17 00:00:00 2001 From: Lasse Jul-Larsen Date: Mon, 2 Sep 2013 13:55:57 +0200 Subject: [PATCH 433/756] Fixed compiler errors 'error TS2173: Generic type references must include all type arguments.' --- slickgrid/SlickGrid.d.ts | 104 +++++++++++++++++++-------------------- 1 file changed, 52 insertions(+), 52 deletions(-) diff --git a/slickgrid/SlickGrid.d.ts b/slickgrid/SlickGrid.d.ts index 35e37c2efc..bc389db7ad 100644 --- a/slickgrid/SlickGrid.d.ts +++ b/slickgrid/SlickGrid.d.ts @@ -496,15 +496,15 @@ declare module Slick { **/ width?: number; } - + export interface EditorFactory { getEditor(column): Editors.Editor; } export interface FormatterFactory { - getFormatter(column: Column): Formatter; + getFormatter(column: Column): Formatter; } - + export interface GridOptions { /** @@ -518,7 +518,7 @@ declare module Slick { asyncEditorLoadDelay?: number; /** - * + * **/ asyncPostRenderDelay?: number; @@ -528,7 +528,7 @@ declare module Slick { autoEdit?: boolean; /** - * + * **/ autoHeight?: boolean; @@ -543,22 +543,22 @@ declare module Slick { cellHighlightCssClass?: string; /** - * + * **/ dataItemColumnValueExtractor?: any; /** - * + * **/ defaultColumnWidth?: number; /** - * + * **/ defaultFormatter?: Formatter; /** - * + * **/ editable?: boolean; @@ -598,7 +598,7 @@ declare module Slick { enableCellNavigation?: boolean; /** - * + * **/ enableColumnReorder?: boolean; @@ -608,7 +608,7 @@ declare module Slick { enableRowReordering?: any; /** - * + * **/ enableTextSelectionOnCells?: boolean; @@ -623,7 +623,7 @@ declare module Slick { forceFitColumns?: boolean; /** - * + * **/ forceSyncScrolling?: boolean; @@ -638,12 +638,12 @@ declare module Slick { fullWidthRows?: boolean; /** - * + * **/ headerRowHeight?: number; /** - * + * **/ leaveSpaceForNewRows?: boolean; @@ -653,22 +653,22 @@ declare module Slick { multiColumnSort?: boolean; /** - * + * **/ multiSelect?: boolean; /** - * + * **/ rowHeight?: number; /** - * + * **/ selectedCellCssClass?: string; /** - * + * **/ showHeaderRow?: boolean; @@ -678,11 +678,11 @@ declare module Slick { syncColumnCellResize?: boolean; /** - * + * **/ topPanelHeight?: number; } - + export interface DataProvider { getItem(index: number): SlickData; getLength(): number; @@ -697,7 +697,7 @@ declare module Slick { * Selection models are controllers responsible for handling user interactions and notifying subscribers of the changes in the selection. Selection is represented as an array of Slick.Range objects. * You can get the current selection model from the grid by calling getSelectionModel() and set a different one using setSelectionModel(selectionModel). By default, no selection model is set. * The grid also provides two helper methods to simplify development - getSelectedRows() and setSelectedRows(rowsArray), as well as an onSelectedRowsChanged event. - * SlickGrid includes two pre-made selection models - Slick.CellSelectionModel and Slick.RowSelectionModel, but you can easily write a custom one. + * SlickGrid includes two pre-made selection models - Slick.CellSelectionModel and Slick.RowSelectionModel, but you can easily write a custom one. **/ export class SelectionModel { /** @@ -712,7 +712,7 @@ declare module Slick { onSelectedRangesChanged: Slick.SlickEvent; } - + export class Grid { /** @@ -765,7 +765,7 @@ declare module Slick { //public getData(): DataView; /** - * Returns the databinding item at a given position. + * Returns the databinding item at a given position. * @param index Item index. * @return **/ @@ -774,12 +774,12 @@ declare module Slick { /** * Sets a new source for databinding and removes all rendered rows. Note that this doesn't render the new rows - you can follow it with a call to render() to do that. * @param newData New databinding source. This can either be a regular JavaScript array or a custom object exposing getItem(index) and getLength() functions. - * @param scrollToTop If true, the grid will reset the vertical scroll position to the top of the grid. + * @param scrollToTop If true, the grid will reset the vertical scroll position to the top of the grid. **/ public setData(newData: T[], scrollToTop: boolean): void; /** - * Returns the size of the databinding source. + * Returns the size of the databinding source. * @return **/ public getDataLength(): number; @@ -788,7 +788,7 @@ declare module Slick { * Returns an object containing all of the Grid options set on the grid. See a list of Grid Options here. * @return **/ - public getOptions(): GridOptions; + public getOptions(): GridOptions; /** * Returns an array of row indices corresponding to the currently selected rows. @@ -800,16 +800,16 @@ declare module Slick { * Returns the current SelectionModel. See here for more information about SelectionModels. * @return **/ - public getSelectionModel(): SelectionModel; + public getSelectionModel(): SelectionModel; /** - * Extends grid options with a given hash. If an there is an active edit, the grid will attempt to commit the changes and only continue if the attempt succeeds. + * Extends grid options with a given hash. If an there is an active edit, the grid will attempt to commit the changes and only continue if the attempt succeeds. * @options An object with configuration options. **/ public setOptions(options: GridOptions): void; /** - * Accepts an array of row indices and applies the current selectedCellCssClass to the cells in the row, respecting whether cells have been flagged as selectable. + * Accepts an array of row indices and applies the current selectedCellCssClass to the cells in the row, respecting whether cells have been flagged as selectable. * @param rowsArray An array of row numbers. **/ public setSelectedRows(rowsArray: number[]): void; @@ -843,7 +843,7 @@ declare module Slick { public getColumns(): Column[]; /** - * Sets grid columns. Column headers will be recreated and all rendered rows will be removed. To rerender the grid (if necessary), call render(). + * Sets grid columns. Column headers will be recreated and all rendered rows will be removed. To rerender the grid (if necessary), call render(). * @param columnDefinitions An array of column definitions. **/ public setColumns(columnDefinitions: Column[]): void; @@ -868,7 +868,7 @@ declare module Slick { public getSortColumns(): Column[]; /** - * Updates an existing column definition and a corresponding header DOM element with the new title and tooltip. + * Updates an existing column definition and a corresponding header DOM element with the new title and tooltip. * @param columnId Column id. * @param title New column name. * @param toolTip New column tooltip. @@ -913,7 +913,7 @@ declare module Slick { public canCellBeSelected(row: number, col: number): boolean; /** - * Attempts to switch the active cell into edit mode. Will throw an error if the cell is set to be not editable. Uses the specified editor, otherwise defaults to any default editor for that given cell. + * Attempts to switch the active cell into edit mode. Will throw an error if the cell is set to be not editable. Uses the specified editor, otherwise defaults to any default editor for that given cell. * @param editor A SlickGrid editor (see examples in slick.editors.js). **/ public editActiveCell(editor: Editors.Editor): void; @@ -927,10 +927,10 @@ declare module Slick { public flashCell(row: number, cell: number, speed?: number): void; /** - * Returns an object representing the coordinates of the currently active cell: + * Returns an object representing the coordinates of the currently active cell: * @example * { - * row: activeRow, + * row: activeRow, * cell: activeCell * } * @return @@ -938,7 +938,7 @@ declare module Slick { public getActiveCell(): Cell; /** - * Returns the DOM element containing the currently active cell. If no cell is active, null is returned. + * Returns the DOM element containing the currently active cell. If no cell is active, null is returned. * @return **/ public getActiveCellNode(): HTMLElement; @@ -960,7 +960,7 @@ declare module Slick { * Returns the active cell editor. If there is no actively edited cell, null is returned. * @return **/ - public getCellEditor(): Editors.Editor; + public getCellEditor(): Editors.Editor; /** * Returns a hash containing row and cell indexes from a standard W3C/jQuery event. @@ -1002,7 +1002,7 @@ declare module Slick { * @return **/ public gotoCell(row: number, cell: number, forceEdit?: boolean): void; - + /** * todo: no docs * @return @@ -1032,7 +1032,7 @@ declare module Slick { * @param columnId * @return **/ - public getHeaderRowColumn(columnId: string): Column; + public getHeaderRowColumn(columnId: string): Column; /** * todo: no docs @@ -1045,7 +1045,7 @@ declare module Slick { * @return **/ public navigateDown(): boolean; - + /** * Switches the active cell one cell left skipping unselectable cells. Unline navigatePrev, navigateLeft stops at the first cell of the row. Returns a boolean saying whether it was able to complete or not. * @return @@ -1103,7 +1103,7 @@ declare module Slick { * @param hash A hash of additional cell CSS classes keyed by row number and then by column id. Multiple CSS classes can be specified and separated by space. **/ public setCellCssStyles(key: string, hash: CellCssStylesHash): void; - + // #endregion Cells // #region Events @@ -1171,8 +1171,8 @@ declare module Slick { // #region Editors - public getEditorLock(): EditorLock; - public getEditController(): Editors.Editor; + public getEditorLock(): EditorLock; + public getEditController(): Editors.Editor; // #endregion Editors } @@ -1241,7 +1241,7 @@ declare module Slick { } export interface OnColumnsReorderedEventData { - + } export interface OnValidationErrorEventData { @@ -1316,13 +1316,13 @@ declare module Slick { export interface OnHeaderMouseEventData { column: Column; } - + // todo: merge with existing column definition export interface Column { sortCol?: string; sortAsc?: boolean; } - + export interface OnSortEventData { multiColumnSort: boolean; sortCol?: Column; @@ -1378,7 +1378,7 @@ declare module Slick { container: HTMLElement; grid: Grid; } - + export class Editor { constructor(args: EditorOptions); public init(): void; @@ -1393,7 +1393,7 @@ declare module Slick { export class Text extends Editor { constructor(args: EditorOptions); - + public getValue(): string; public setValue(val: string): void; public serializeValue(): string; @@ -1434,7 +1434,7 @@ declare module Slick { export class LongText extends Editor { constructor(args: EditorOptions); - + public handleKeyDown(e: Event): void; public save(): void; public cancel(): void; @@ -1489,12 +1489,12 @@ declare module Slick { * @deprecated **/ public groupBy(valueGetter, valueFormatter, sortComparer): void; - + /** * @deprecated **/ public setAggregators(groupAggregators, includeCollapsed): void; - + /** * @param level Optional level to collapse. If not specified, applies to all levels. **/ @@ -1596,11 +1596,11 @@ declare module Slick { } export class Min extends Aggregator { - + } export class Max extends Aggregator { - + } export class Sum extends Aggregator { From 16fa2ac72bad22204be6ca96a83b156002984244 Mon Sep 17 00:00:00 2001 From: Jason Jarrett Date: Mon, 2 Sep 2013 09:40:38 -0700 Subject: [PATCH 434/756] small spelling tweak to angular readme --- angularjs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/angularjs/README.md b/angularjs/README.md index cd9b2bcd98..1692d947c9 100644 --- a/angularjs/README.md +++ b/angularjs/README.md @@ -96,7 +96,7 @@ Since you are augmenting the $scope object, you should let the compiler know wha $scope.title = 'Yabadabadu'; } -## Exemples +## Examples ### Working with $resource @@ -151,4 +151,4 @@ Since you are augmenting the $scope object, you should let the compiler know wha article.$save(); article.$publish(); - } \ No newline at end of file + } From ce96d4a8757cc2e0340d49fd3d649562a114e779 Mon Sep 17 00:00:00 2001 From: Santi Albo Date: Mon, 2 Sep 2013 20:07:31 +0100 Subject: [PATCH 435/756] Add type definitions for Raven.js --- README.md | 1 + ravenjs/ravenjs-tests.ts | 42 +++++++++++++ ravenjs/ravenjs.d.ts | 124 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 167 insertions(+) create mode 100644 ravenjs/ravenjs-tests.ts create mode 100644 ravenjs/ravenjs.d.ts diff --git a/README.md b/README.md index 825e9cd79a..c16021741d 100755 --- a/README.md +++ b/README.md @@ -166,6 +166,7 @@ List of Definitions * [PouchDB](http://pouchdb.com) (by [Bill Sears](https://github.com/MrBigDog2U/)) * [PreloadJS](http://www.createjs.com/#!/PreloadJS) (by [Pedro Ferreira](https://bitbucket.org/drk4)) * [QUnit](http://qunitjs.com/) (by [Diullei Gomes](https://github.com/Diullei)) +* [Raven.js](https://github.com/getsentry/raven-js) (by [Santi Albo](https://github.com/santialbo)) * [Restify](https://github.com/mcavage/node-restify) (by [Bret Little](https://github.com/blittle)) * [Royalslider](http://dimsemenov.com/plugins/royal-slider/) (by [Christiaan Rakowski](https://github.com/csrakowski)) * [Rx.js](http://rx.codeplex.com/) (by [gsino](http://www.codeplex.com/site/users/view/gsino)) diff --git a/ravenjs/ravenjs-tests.ts b/ravenjs/ravenjs-tests.ts new file mode 100644 index 0000000000..d767308f70 --- /dev/null +++ b/ravenjs/ravenjs-tests.ts @@ -0,0 +1,42 @@ +/// + +var options: RavenOptions = { + logger: 'my-logger', + ignoreUrls: [ + /graph\.facebook\.com/i + ], + ignoreErrors: [ + 'fb_xd_fragment' + ], + includePaths: [ + /https?:\/\/(www\.)?getsentry\.com/, + /https?:\/\/d3nslu0hdya83q\.cloudfront\.net/ + ] +}; + +Raven.config('https://public@getsentry.com/1', options).install(); + +var throwsError = () => { + throw new Error('broken'); +}; + +try { + throwsError(); +} catch(e) { + Raven.captureException(e); + Raven.captureException(e, {tags: { key: "value" }}); +} + +Raven.context(throwsError); +Raven.context({tags: { key: "value" }}, throwsError); + +setTimeout(Raven.wrap(throwsError), 1000); +Raven.wrap({logger: "my.module"}, throwsError)(); + +Raven.setUser({ + email: 'matt@example.com', + id: '123' +}); + +Raven.captureMessage('Broken!'); +Raven.captureMessage('Broken!', {tags: { key: "value" }}); diff --git a/ravenjs/ravenjs.d.ts b/ravenjs/ravenjs.d.ts new file mode 100644 index 0000000000..c88aabc584 --- /dev/null +++ b/ravenjs/ravenjs.d.ts @@ -0,0 +1,124 @@ +// Type definitions for Raven.js +// Project: https://github.com/getsentry/raven-js +// Definitions by: Santi Albo +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +declare var Raven: RavenStatic; + +interface RavenOptions { + + /** The name of the logger used by Sentry. Default: javascript */ + logger?: string; + + /** List of messages to be fitlered out before being sent to Sentry. */ + ignoreErrors?: string[]; + + /** Similar to ignoreErrors, but will ignore errors from whole urls patching a regex pattern. */ + ignoreUrls?: RegExp[]; + + /** The inverse of ignoreUrls. Only report errors from whole urls matching a regex pattern. */ + whitelistUrls?: RegExp[]; + + /** An array of regex patterns to indicate which urls are a part of your app. */ + includePaths?: RegExp[]; + + /** Additional data to be tagged onto the error. */ + tags?: any; + + extra?: any; +} + +interface RavenStatic { + + /** Raven.js version. */ + VERSION: string; + + /* + * Allow Raven to be configured as soon as it is loaded + * It uses a global RavenConfig = {dsn: '...', config: {}} + * + * @return undefined + */ + afterLoad(): void; + + /* + * Allow multiple versions of Raven to be installed. + * Strip Raven from the global context and returns the instance. + * + * @return {Raven} + */ + noConflict(): RavenStatic; + + /* + * Configure Raven with a DSN and extra options + * + * @param {string} dsn The public Sentry DSN + * @param {object} options Optional set of of global options [optional] + * @return {Raven} + */ + config(dsn: string, options?: RavenOptions): RavenStatic; + + /* + * Installs a global window.onerror error handler + * to capture and report uncaught exceptions. + * At this point, install() is required to be called due + * to the way TraceKit is set up. + * + * @return {Raven} + */ + install(): RavenStatic; + + /* + * Wrap code within a context so Raven can capture errors + * reliably across domains that is executed immediately. + * + * @param {object} options A specific set of options for this context [optional] + * @param {function} func The callback to be immediately executed within the context + * @param {array} args An array of arguments to be called with the callback [optional] + */ + context(func: Function, ...args: any[]): void; + context(options: RavenOptions, func: Function, ...args: any[]): void; + + /* + * Wrap code within a context and returns back a new function to be executed + * + * @param {object} options A specific set of options for this context [optional] + * @param {function} func The function to be wrapped in a new context + * @return {function} The newly wrapped functions with a context + */ + wrap(func: Function): Function; + wrap(options: RavenOptions, func: Function): Function; + + /* + * Uninstalls the global error handler. + * + * @return {Raven} + */ + uninstall(): RavenStatic; + + /* + * Manually capture an exception and send it over to Sentry + * + * @param {error} ex An exception to be logged + * @param {object} options A specific set of options for this error [optional] + * @return {Raven} + */ + captureException(ex: Error, options?: RavenOptions): RavenStatic; + + /* + * Manually send a message to Sentry + * + * @param {string} msg A plain message to be captured in Sentry + * @param {object} options A specific set of options for this message [optional] + * @return {Raven} + */ + captureMessage(msg: string, options?: RavenOptions): RavenStatic; + + /* + * Set/clear a user to be sent along with the payload. + * + * @param {object} user An object representing user data [optional] + * @return {Raven} + */ + setUser(user?: any): RavenStatic; +} From aaa98de44706ea201abab6808b0e864f06279c9f Mon Sep 17 00:00:00 2001 From: soywiz Date: Mon, 2 Sep 2013 21:24:18 +0200 Subject: [PATCH 436/756] - Added Adobe Flash .jsfl support --- jsfl/jsfl.d.ts | 1399 +++++++++++++++++++++++++++++++++++++++++++++++ jsfl/xJSFL.d.ts | 93 ++++ 2 files changed, 1492 insertions(+) create mode 100644 jsfl/jsfl.d.ts create mode 100644 jsfl/xJSFL.d.ts diff --git a/jsfl/jsfl.d.ts b/jsfl/jsfl.d.ts new file mode 100644 index 0000000000..94e3d4d80d --- /dev/null +++ b/jsfl/jsfl.d.ts @@ -0,0 +1,1399 @@ +interface FlashPoint { + x: number; + y: number; +} + +interface FlashPoint3D extends FlashPoint { + z: number; +} + +interface FlashRectangle { + top: number; + right: number; + bottom: number; + left: number; +} + +interface FlashMatrix { + a: number; + b: number; + c: number; + d: number; + tx: number; + ty: number; +} + +interface FlashFilter { + angle: number; + blurX: number; + blurY: number; + brightness: number; + color: any; + contrast: number; + distance: number; + enabled: boolean; + hideObject: boolean; + highlightColor: any; + hue: number; + inner: boolean; + knockout: boolean; + name: string; + quality: string; + saturation: number; + shadowColor: any; + strength: number; + type: string; +} + +interface FlashDocument { + // "integer", "integerArray", "double", "doubleArray", "string", and "byteArray" + addDataToDocument(name: string, type: string, data: any): void; // Stores specified data with a document. + addDataToSelection(name: string, type: string, data: any): void; // Stores specified data with the selected object(s). + addFilter(filterName: string): void; // Applies a filter to the selected objects. + addItem(position: FlashPoint, item: FlashItem): boolean; // Adds an item from any open document or library + addNewLine(startPoint: FlashPoint, endpoint: FlashPoint):void; // Adds a new path between two points. + addNewOval(boundingRectangle: FlashRectangle, bSuppressFill?: boolean, bSuppressStroke?: boolean): void; // Adds a new Oval object in the specified + addNewPrimitiveOval(boundingRectangle: FlashRectangle, bSpupressFill?: boolean, bSuppressStroke?: boolean): void; + addNewRectangle(boundingRectangle: FlashRectangle, roundness: number, bSuppressFill?: boolean, bSuppressStroke?: boolean); // Adds a new rectangle or rounded rectangle, + addNewPrimitiveRectangle(boundingRectangle: FlashRectangle, roundness: number, bSuppressFill?: boolean, bSuppressStroke?: boolean); // Adds a new rectangle or rounded rectangle, + addNewPublishProfile(profileName?: string): void; + addNewScene(name: string): boolean; // Adds a new scene (Timeline object) as the next + addNewText(boundingRectangle: FlashRectangle, text?: string): void; // Inserts a new empty text field. + align(alignmode: string, bUseDocumentBounds?: boolean); // Aligns the selection. + allowScreens(): void; // Use this method before using the + /** Arranges the selection on the Stage. "back", "backward", "forward", and "front" */ + arrange(arrangeMode: string): void; + + /** Performs a break-apart operation on the current */ + breakApart(): void; + + /** Indicates whether the Edit Symbols menu and */ + canEditSymbol(): boolean; + + /** Determines whether you can use the */ + canRevert(): boolean; + + ///** Determines whether a version of the specified */ + //canSaveAVersion(): boolean; + + /** Determines whether you can use the */ + canTestMovie(): boolean; + + /** Determines whether you can use the */ + canTestScene(): boolean; + + /** Changes the index of the filter in the Filter list. */ + changeFilterOrder(oldIndex: number, newIndex: number): void; + + /** Copies the current selection from the document */ + clipCopy(): void; + + /** Cuts the current selection from the document */ + clipCut(): void; + + /** Pastes the contents of the Clipboard into the document. */ + clipPaste(bInPlace?: boolean): void; + + /** Closes the specified document. */ + close(bPromptToSaveChanges?: boolean): void; + + /** Converts lines to fills on the selected objects. */ + convertLinesToFills(): void; + + /** Converts the selected Stage item(s) to a new */ + convertToSymbol(type: string, name: string, registrationPoint: string): FlashSymbolInstance; + + /** Uses the top selected drawing object to crop all */ + crop(): void; + + /** Method; Invokes the Debug Movie command on the document. */ + debugMovie(abortIfErrorsExist?: boolean): void; + + /** Deletes the envelope (bounding box that */ + deleteEnvelope(): boolean; + + /** Deletes the currently active profile, if there is */ + deletePublishProfile(): boolean; + + /** Deletes the current scene (Timeline object), and */ + deleteScene(): boolean; + + /** Deletes the current selection on the Stage. */ + deleteSelection(): void; + + /** Disables all filters on the selected objects. */ + disableAllFilters(): void; + + /** Disables the specified filter in the Filters list. */ + disableFilter(filterIndex: number): void; + + /** Disables all filters except the one at the specified */ + disableOtherFilters(enabledFilterIndex: number): void; + + /** Distributes the selection. */ + distribute(distributemode: string, bUseDocumentBounds?: boolean): void; + + /** Performs a distribute-to-layers operation on the */ + distributeToLayers(): void; + + /** Checks the document for persistent data with the */ + documentHasData(name: string): boolean; + + /** Duplicates the currently active profile and gives */ + duplicatePublishProfile(profileName?: string): number; + + /** Makes a copy of the currently selected scene, */ + duplicateScene(): boolean; + + /** Duplicates the selection on the Stage. */ + duplicateSelection(): void; + + /** Makes the specified scene the currently selected */ + editScene(index: number): void; + + /** Enables all the filters on the Filters list for the */ + enableAllFilters(): void; + + /** Enables the specified filter for the selected */ + enableFilter(filterIndex: number): void; + + /** Switches the authoring tool into the editing mode */ + enterEditMode(editMode?: string): void; + + /** Exits from symbol-editing mode and returns */ + exitEditMode(): void; + + /** Exports the document as one or more PNG files. */ + exportPNG(fileURI: string, bCurrentPNGSettings?: boolean, bCurrentFrame?: boolean): boolean; + + /** Exports the currently active profile to an XML */ + exportPublishProfile(fileURI: string): void; + + /** returns a string that specifies, in XML format, the specified profile. If you dont pass a value for profileName, the current profile is exported. */ + exportPublishProfileString(profileName?: string): string; + + /** Exports the document in the Flash SWF format. */ + exportSWF(fileURI: string, bCurrentSettings?: boolean): void; + + /** Identical to retrieving the value of the To Stage */ + getAlignToDocument(): boolean; + + /** Returns a string that specifies the blending mode */ + getBlendMode(): string; + + /** Retrieves the fill object of the selected shape, or */ + getCustomFill(objectToFill?: string): FlashFill; + + /** Returns the stroke object of the selected shape, */ + getCustomStroke(locationOfStroke?: string): FlashStroke; + + /** Retrieves the value of the specified data. */ + getDataFromDocument(name: string): any; + + /** Gets the specified Element property for the */ + getElementProperty(propertyName: string): any; + + /** Gets a specified TextAttrs property of the*/ + getElementTextAttr(attrName: string, startIndex?: number, endIndex?: number): FlashTextAttrs; + + /** Returns an array that contains the list of filters*/ + getFilters(): FlashFilter[]; + + /** Returns a string containing the XML metadata */ + getMetadata(): string; + + /** returns the mobile XML settings for the document. */ + getMobileSettings(): string; + + /** Returns a string that represents the targeted */ + getPlayerVersion(): string; + + /** Gets the bounding rectangle of the current */ + getSelectionRect(): FlashRectangle; + + /** Gets the currently selected text. */ + getTextString(startIndex?: number, endIndex?: number): string; + + /** Retrieves the current Timeline object in the */ + getTimeline(): FlashTimeline; + + /** gets the location of the transformation point of the current selection. You can use the transformation point for commutations such as rotate and skew. */ + getTransformationPoint(): FlashPoint; + + /** Converts the current selection to a group.*/ + group(): void; + + /** Imports a file into the document. */ + importFile(fileURI: string, importToLibrary?: boolean): void; + + /** Imports a profile from a file. */ + importPublishProfile(fileURI: string): number; + + /** imports an XML string that represents a publish profile and sets it as the current profile. To generate an XML string to import, use document.exportPublishProfileString() before using this method. */ + importPublishProfileString(xmlString: string): number; + + /** Imports a SWF file into the document.*/ + importSWF(fileURI: string): void; + + /** creates an intersection drawing object from all selected drawing objects. This method returns false if there are no drawing objects selected, or if any of the selected items are not drawing objects. */ + intersect(): boolean; + + /** loads a cue point XML file. The format and DTD of the XML file is the same as the one imported and exported by the Cue Points Property inspector. The return value is the same as the string serialized in the Cue Point property of the object containing the instance of an FLVPlayback Component. */ + loadCuepointXML(uri: string): any[]; + + /** Makes the size of the selected objects the same. */ + match(bWidth: boolean, bHeight: boolean, bUseDocumentBounds?: boolean): void; + + /** Performs a mouse click from the Selection tool. */ + mouseClick(position: FlashPoint, bToggleSel: boolean, bShiftSel: boolean): void; + + /** Performs a double mouse click from the */ + mouseDblClk(position: FlashPoint, bAltDown: boolean, bShiftDown: boolean, bShiftSelect: boolean): void; + + /** If the selection contains at least one path with at */ + moveSelectedBezierPointsBy(delta: FlashPoint): void; + + /** Moves selected objects by a specified distance. */ + moveSelectionBy(distanceToMove: FlashPoint): void; + + /** Optimizes smoothing for the current selection, */ + optimizeCurves(smoothing: number, bUseMultiplePasses: boolean): void; + + /** Publishes the document according to the active */ + publish(): void; + + /** uses the top selected drawing object to punch through all selected drawing objects underneath it. This method returns false if there are no drawing objects selected or if any of the selected items are not drawing objects. */ + punch(): boolean; + + /** Removes all filters from the selected object(s).*/ + removeAllFilters(): void; + + /** Removes persistent data with the specified*/ + removeDataFromDocument(name: string): void; + + /** Removes persistent data with the specified */ + removeDataFromSelection(name: string): void; + + /** Removes the specified filter from the Filters list*/ + removeFilter(filterIndex: number): void; + + /** Renames the current profile.*/ + renamePublishProfile(profileNewName?: string): boolean; + + /** Renames the currently selected scene in the */ + renameScene(name: string): boolean; + + /** Moves the specified scene before another */ + reorderScene(sceneToMove: number, sceneToPutItBefore: number): void; + + /** Sets all values in the Property inspector to */ + resetOvalObject(): void; + + /** Sets all values in the Property inspector to */ + resetRectangleObject(): void; + + /** Resets the transformation matrix; equivalent to */ + resetTransformation(): void; + + /** Method; reverts the specified document to its previously saved version. This method is equivalent to selecting File > Revert. */ + revert(): void; + + ///** Reverts the specified document to the version */ + //revertToLastVersion(); + + /** applies a 3D rotation to the selection. This method is available only for movie clips. */ + rotate3DSelection(xyzCoordinate: FlashPoint3D, bGlobalTransform: boolean): void; + + /** Rotates the selection by a specified number of */ + rotateSelection(angle: number, rotationPoint?: string): void; + + /** Saves the document in its default location;*/ + save(bOkToSaveAs?: boolean): boolean; + + /** saves and compacts the file. This method is equivalent to selecting File > Save and Compact. */ + saveAndCompact(bOkToSaveAs?: boolean): boolean; + + //saveAsVersion(); // Saves a version of the specified document to the + + /** Scales the selection by a specified amount;*/ + scaleSelection(xScale: number, yScale: number, whichCorner?: string): void; + + /** Selects all items on the Stage; equivalent to*/ + selectAll(): void; + + /** Deselects any selected items. */ + selectNone(): void; + + /** Sets the preferences for document.align(),*/ + setAlignToDocument(bToStage?: boolean): void; + + /** Sets the blending mode for the selected objects.*/ + setBlendMode(mode: string): void; + + /** Sets the fill settings for the Tools panel, Property */ + setCustomFill(fill: FlashFill): void; + + /** Sets the stroke settings for the Tools panel,*/ + setCustomStroke(stroke: FlashStroke): void; + + /** Sets the specified Element property on selected */ + setElementProperty(property: string, value: number): void; + + /** Sets the specified TextAttrs property of the */ + setElementTextAttr(attrName: string, attrValue: FlashTextAttrs, startIndex?: number, endIndex?: number): boolean; + + /** Changes the fill color of the selection to the */ + setFillColor(color: any): void; + + /** Sets a specified filter property for the currently */ + setFilterProperty(property: string, filterIndex: number, value: any): void; + + /** Applies filters to the selected objects .*/ + setFilters(filterArray: FlashFilter[]): void; + + /** Sets the opacity of the instance. */ + setInstanceAlpha(opacity: number): void; + + /** Sets the brightness for the instance. */ + setInstanceBrightness(brightness: number): void; + + /** Sets the tint for the instance.*/ + setInstanceTint(color: any, strength: number): void; + + /** Sets the XML metadata for the specified */ + setMetadata(strMetadata: string): boolean; + + /** Sets the value of an XML settings string in a */ + setMobileSettings(xmlString: string): boolean; + + /** Specifies a value for a specified property of*/ + setOvalObjectProperty(propertyName: string, value: any): void; + + /** Sets the version of the Flash Player targeted by*/ + setPlayerVersion(version: string): boolean; + + /** Specifies a value for a specified property of*/ + setRectangleObjectProperty(propertyName: string, value: any): void; + + /** Moves and resizes the selection in a single */ + setSelectionBounds(boundingRectangle: FlashRectangle, bContactSensitiveSelection?: boolean): void; + + /** Draws a rectangular selection marquee relative */ + setSelectionRect(rect: FlashRectangle, bReplaceCurrentSelection?: boolean, bContactSensitiveSelection?: boolean): void; + + /** Specifies the vanishing point for viewing 3D objects. */ + setStageVanishingPoint(point: FlashPoint): void; + + setStageViewAngle(angle: number): void; + + /** Sets the color, width, and style of the selected */ + setStroke(color: any, size: number, strokeType: string): void; + + /** Changes the stroke color of the selection to the*/ + setStrokeColor(color: any): void; + + /** Changes the stroke size of the selection to the*/ + setStrokeSize(size: number): void; + + /** Changes the stroke style of the selection to the */ + setStrokeStyle(strokeType: string): void; + + /** Changes the bounding rectangle for the selected */ + setTextRectangle(boundingRectangle: FlashRectangle): boolean; + + /** Sets the text selection of the currently selected */ + setTextSelection(startIndex: number, endIndex: number): boolean; + + /** Inserts a string of text. */ + setTextString(text: string, startIndex?: number, endIndex?: number): boolean; + + /** Moves the transformation point of the current */ + setTransformationPoint(transformationPoint: FlashPoint): void; + + /** Skews the selection by a specified amount. */ + skewSelection(xSkew: number, ySkew: number, whichEdge?: string): void; + + /** Smooths the curve of each selected fill outline or */ + smoothSelection(): void; + + /** Spaces the objects in the selection evenly. */ + space(direction: string, bUseDocumentBounds?: boolean): void; + + /** Straightens the currently selected strokes; */ + straightenSelection(): void; + + /** Swaps the current selection with the specified */ + swapElement(name: string): void; + + /** Swaps the Stroke and Fill colors. */ + swapStrokeAndFill(): void; + //synchronizeWithHeadVersion(); // Synchronizes the specified document with the + + /** Executes a Test Movie operation on the */ + testMovie(): void; + + /** Executes a Test Scene operation on the current */ + testScene(): void; + + /** Performs a trace bitmap on the current selection; */ + traceBitmap(threshold: number, minimumArea: number, curveFit: string, cornerThreshold: string): void; + transformSelection(a: number, b: number, c: number, d: number): void; // Performs a general transformation on the current + unGroup(): void; // Ungroups the current selection. + union(): void; // Combines all selected shapes into a drawing + unlockAllElements(): void; // Unlocks all locked elements on the currently + xmlPanel(fileURI: string): any; // Posts a XMLUI dialog box. + accName: string; // A string that is equivalent to the Name field in the + as3AutoDeclare: boolean; // A Boolean value that describes whether the + as3Dialect: string; // A string that describes the ActionScript 3.0 + as3ExportFrame: number; // An integer that specifies in which frame to export + as3StrictMode: boolean; // A Boolean value that specifies whether the + as3WarningsMode: boolean; // A Boolean value that specifies whether the + asVersion: number; // An integer that specifies which version of + autoLabel: boolean; // A Boolean value that is equivalent to the Auto + backgroundColor: any; // A string, hexadecimal value, or integer that + currentPublishProfile: string; // A string that specifies the name of the active + currentTimeline: FlashTimeline; // An integer that specifies the index of the active + description: string; // A string that is equivalent to the Description field in + docClass; // Specifies the top-level ActionScript 3.0 class + forceSimple: boolean; // A Boolean value that specifies whether the children + frameRate: number; // A float value that specifies the number of frames + height: number; // An integer that specifies the height of the + id: number; // A unique integer (assigned automatically) that + library: FlashLibrary; // Read-only; the library object for a document. + livePreview: boolean; // A Boolean value that specifies if Live Preview is + name: number; // Read-only; a string that represents the name of a + path: number; // Read-only; a string that represents the path of the + publishProfiles: string[]; // Read-only; an array of the publish profile names for + + /** Read-only; the current ScreenOutline object for the */ + // Not available in CS5 + //screenOutline: FlashScreenOutline; + + /** An array of the selected objects in the document. */ + selection: FlashElement[]; + + /** A Boolean value that specifies whether the object */ + silent: boolean; + + /** Read-only; an array of Timeline objects (see */ + timelines: FlashTimeline[]; + + /** Read-only; a Matrix object. */ + viewMatrix: FlashMatrix; + + /** An integer that specifies the width of the document */ + width: number; + + /** Specifies the zoom percent of the Stage at author */ + zoomFactor: number; +} + +interface FlashText { + getTextAttr(); + getTextString(); + setTextAttr(); + setTextString(); + accName: string; + antiAliasSharpness: number; + antiAliasThickness: number; + autoExpand: boolean; + border: boolean; + description: string; + embeddedCharacters: string; +} + +interface FlashTextAttrs extends FlashText { + aliasText: boolean; + alignment: string; + autoKern: boolean; + bold: boolean; + characterPosition: string; + characterSpacing: number; + face: string; + fillColor: any; + indent: number; + italic: boolean; + leftMargin: number; + letterSpacing: number; + lineSpacing: number; + rightMargin: number; + rotation: boolean; + size: number; + target: string; + url: string; +} + +interface FlashFLfile { + copy(fileURI:string, copyURI:string): boolean; + createFolder(folderURI:string): boolean; + exists(fileURI:string): boolean; + getAttributes(fileOrFolderURI:string): string; + getCreationDate(fileOrFolderURI:string): string; + getCreationDateObj(fileOrFolderURI:string): Date; + getModificationDate(fileOrFolderURI:string): string; + getModificationDateObj(fileOrFolderURI: string): Date; + getSize(fileURI: string): number; + listFolder(folderURI: string, filesOrDirectories?: boolean): string[]; + platformPathToURI(fileName: string): string; + read(fileOrFolderURI: string): string; + remove(fileOrFolderURI: string): boolean; + setAttributes(fileURI: string, strAttrs: string): boolean; + uriToPlatformPath(fileURI: string): string; + write(fileURI: string, textToWrite: string, strAppendMode?: string): boolean; +} + +interface FlashSoundItem { +} + +// if FlashElement.elementType == 'instance' +interface FlashInstance { + instanceType?: string; + libraryItem?: FlashItem; +} + +interface _FlashBitmap { + width; height; depth; bits; cTab?: string[]; +} + +// if FlashElement.elementType == 'instance' +interface FlashBitmapInstance { + getBits(): _FlashBitmap; + setBits(bitmap: _FlashBitmap): void; + hPixels: number; + vPixels: number; + +} + +interface FlashCompiledClipInstance { + accName: string; + actionScript: string; + description: string; + forceSimple: boolean; + shortcut: string; + silent: boolean; + tabIndex: number; +} + +interface FlashSymbolInstance { + accName: string; + actionScript: string; + backgroundColor: string; + bitmapRenderMode: string; + blendMode: string; + buttonTracking: string; + cacheAsBitmap: boolean; + colorAlphaAmount: number; + colorAlphaPercent: number; + colorBlueAmount: number; + colorBluePercent: number; + colorGreenAmount: number; + colorGreenPercent: number; + colorMode: string; + colorRedAmount: number; + colorRedPercent: number; + description: string; + filters: FlashFilter[]; + firstFrame: number; + forceSimple: boolean; + loop: string; + shortcut: string; + silent: boolean; + symbolType: string; + tabIndex: number; + useBackgroundColor: boolean; + visible: boolean; +} + +interface FlashComponentInstance { + parameters: any[]; +} + +/** + * The Shape object is a subclass of the Element object. The Shape object provides more precise control + * than the drawing APIs when manipulating or creating geometry on the Stage. This control is necessary + * so that scripts can create useful effects and other drawing commands (seeElement object). + * All Shape methods and properties that change a shape or any of its subordinate parts must be placed between + * shape.beginEdit() and shape.endEdit() calls to function correctly. + */ +interface FlashShape extends FlashOval { + getCubicSegmentPoints(cubicSegmentIndex: number): FlashPoint[]; + beginEdit(): void; + deleteEdge(index: number): void; + endEdit(): void; + contours: FlashContour[]; + edges: FlashEdge[]; + isDrawingObject: boolean; + isGroup: boolean; + isOvalObject: boolean; + isRectangleObject: boolean; + members: FlashShape[]; + numCubicSegments: number; + vertices: FlashVertex[]; +} + +interface FlashElement extends FlashInstance, FlashBitmapInstance, FlashCompiledClipInstance, FlashSymbolInstance, FlashComponentInstance, FlashShape { + getPersistentData(name: string): any; + getTransformationPoint(): FlashPoint; + hasPersistentData(name:string): boolean; + removePersistentData(name:string): void; + setPersistentData(name:string, type:string, value: any):void; + setTransformationPoint(transformationPoint: FlashPoint): void; + depth: number; + + /** + * Read-only property; a string that represents the type of the specified element. + * The value is one of the following: "shape", "text", "instance", or "shapeObj". + * A "shapeObj" is created with an extensible tool. + */ + elementType: string; + height: number; + layer: FlashLayer; + left: number; + locked: boolean; + matrix: FlashMatrix; + name: string; + rotation: number; + scaleX: number; + scaleY: number; + selected: boolean; + skewX: number; + skewY: number; + top: number; + transformX: number; + transformY: number; + width: number; + x: number; + y: number; +} + +interface FlashFrame { + getCustomEase(); + setCustomEase(); + actionScript; + duration; + elements: FlashElement[]; + hasCustomEase; + labelType; + motionTweenOrientToPath; + motionTweenRotate; + motionTweenRotateTimes; + motionTweenScale; + motionTweenSnap; + motionTweenSync; + name; + shapeTweenBlend; + soundEffect; + soundLibraryItem:FlashSoundItem; + soundLoop; + soundLoopMode; + soundName; + soundSync; + startFrame; + tweenEasing; + tweenType; + useSingleEaseCurve; +} + +interface FlashSymbolItem { + convertToCompiledClip(): void; + exportSWC(outputURI: string): void; + exportSWF(outputURI: string): void; + scalingGrid: boolean; + scalingGridRect: FlashRectangle; + sourceAutoUpdate: boolean; + sourceFilePath: string; + sourceLibraryName: string; + symbolType: string; + timeline: FlashTimeline; +} + +interface FlashFolderItem { +} + +interface FlashFontItem { + // Specifies whether the Font item is bitmapped. + bitmap: boolean; + // Specifies whether the Font item is bold. + bold: boolean; + // Specifies characters to embed. + embeddedCharacters: string; + // Specifies items that can be selected in the Font Embedding dialog. + embedRanges: string; + // Specifies whether variant glyphs should be output in the font when publishing a SWF file. + embedVariantGlyphs: boolean; + // The name of the device font associated with the Font item. + font: string; + // Specifies the format of the font that is output when publishing a SWF filem. + isDefineFont4Symbol: boolean; + // Specifies whether the Font item is italic. + italic: boolean; + // The size of the Font item, in points. + size: number; +} + +interface FlashSoundItem { + exportToFile(fileURI: string): boolean; + bitRate: string; + bits: string; + compressionType: string; + convertStereoToMono: boolean; + fileLastModifiedDate: string; + originalCompressionType: string; + quality: string; + sampleRate: string; + sourceFileExists: boolean; +} + +interface FlashVideoItem { + exportToFLV(fileURI: string): boolean; + fileLastModifiedDate: string; + sourceFileExists: boolean; + sourceFileIsCurrent: boolean; + sourceFilePath: string; + videoType: string; +} + +interface FlashBitmapItem { + exportToFile(fileURI: string): boolean; + allowSmoothing: boolean; + compressionType: string; + fileLastModifiedDate: string; + originalCompressionType: string; + sourceFileExists: boolean; + sourceFileIsCurrent: boolean; + sourceFilePath: string; + useDeblocking: boolean; + useImportedJPEGQuality: boolean; +} + +interface FlashItem extends FlashSymbolItem, FlashFolderItem, FlashFontItem, FlashSoundItem, FlashVideoItem, FlashBitmapItem, FlashBitmapItem { + addData(name: string, type: string, data: any): void; + getData(name: string): any; + hasData(name: string): boolean; + removeData(name: string): void; + + /** Read-only; a string that specifies the type of element. "undefined", "component", "movie clip", "graphic", "button", "folder", "font", "sound", "bitmap", "compiled clip", "screen", or "video" */ + itemType: string; + linkageBaseClass: string; + linkageClassName: string; + linkageExportForAS: boolean; + linkageExportForRS: boolean; + linkageExportInFirstFrame: boolean; + linkageIdentifier: string; + linkageImportForRS: boolean; + linkageURL: string; + /** A string that specifies the name of the library item, which includes the folder structure. */ + name: string; +} + +interface FlashLayer { + color: any; + frameCount: number; + frames: FlashFrame[]; + height: number; + layerType: string; + locked: boolean; + name: string; + outline: boolean; + parentLayer: FlashLayer; + visible:boolean; +} + +interface FlashLibrary { + addItemToDocument(position: FlashPoint, namePath?: string): boolean; + /** "video", "movie clip", "button", "graphic", "bitmap", "screen", and "folder" */ + addNewItem(type: string, namePath?: string): boolean; + deleteItem(namePath?: string): boolean; + /** Method; makes a copy of the currently selected or specified item. The new item has a default name (such as item copy) and is set as the currently selected item. If more than one item is selected, the command fails. */ + duplicateItem(namePath: string): boolean; + editItem(namePath?: string): boolean; + expandFolder(bExpand: boolean, bRecurseNestedParents?: boolean, namePath?: string): boolean; + findItemIndex(namePath: string): number; + getItemProperty(property: string): string; + getItemType(namePath?: string): string; + + /** An array of values for all currently selected items in the library. */ + getSelectedItems(): FlashItem[]; + + importEmbeddedSWF(linkageName: string, swfData: any[], libName?: string): void; + + itemExists(namePath: string): boolean; + + moveToFolder(folderPath: string, itemToMove?: string, bReplace?: boolean): boolean; + + /** Method; creates a new folder with the specified name, or a default name ("untitled folder #" ) if no folderName parameter is provided, in the currently selected folder. */ + newFolder(folderPath?: string): boolean; + + /** Method; renames the currently selected library item in the Library panel. */ + renameItem(name: string): boolean; + + /** Method; selects or deselects all items in the library. */ + selectAll(bSelectAll?: boolean): void; + + /** Method; selects a specified library item. */ + selectItem(namePath: string, bReplaceCurrentSelection?: boolean, bSelect?: boolean): boolean; + + /** Method; deselects all the library items. */ + selectNone(): void; + + /** Method; sets the property for all selected library items (ignoring folders). */ + setItemProperty(property: string, value: any): void; + + /** Method; updates the specified item. */ + updateItem(namePath: string): boolean; + + /** Property; an array of item objects in the library. */ + items: FlashItem[]; +} + +interface FlashMath { + /** Method; performs a matrix concatenation and returns the result. */ + concatMatrix(mat1: FlashMatrix, mat2: FlashMatrix): FlashMatrix; + + /** A Matrix object that is the inverse of the original matrix. */ + invertMatrix(mat: FlashMatrix): FlashMatrix; + + /** A floating-point value that represents the distance between the points. */ + pointDistance(pt1: FlashPoint, pt2: FlashPoint): number; +} + +interface FlashOutputPanel { + /** Method; clears the contents of the Output panel. You can use this method in a batch processing application to clear a list of errors, or to save them incrementally by using this method withoutputPanel.save(). */ + clear(): void; + + save(fileURI: string, bAppendToFile?: boolean, bUseSystemEncoding?: boolean): void; + + trace(message:string):void; +} + +/** + * The HalfEdge object is the directed side of the edge of a Shape object. + * An edge has two half edges. You can transverse the contours of a shape by "walking around" + * these half edges. For example, starting from a half edge, you can trace all the half edges + * around a contour of a shape, and return to the original half edge. Half edges are ordered. + * One half edge represents one side of the edge; the other half edge represents the other side. + */ +interface FlashHalfEdge { + getEdge(): FlashEdge; + getNext(): FlashHalfEdge; + getOppositeHalfEdge(): FlashHalfEdge; + getPrev(): FlashHalfEdge; + getVertex(): FlashVertex; + id: number; + index: number; +} + +/** The Oval object is a shape that is drawn using the Oval Primitive tool. To determine if an item is an Oval object, use shape.isOvalObject. */ +interface FlashOval { + /** Read-only property; a Boolean value that specifies whether the Close Path check box in the Property inspector is selected. If the start angle and end angle values for the object are the same, setting this property has no effect until the values change. To set this value, use document.setOvalObjectProperty(). */ + closePath: boolean; + /** Read-only property; a float value that specifies the end angle of the Oval object. Acceptable values are from 0 to 360. */ + endAngle: number; + /** Read-only property; a float value that specifies the inner radius of the Oval object as a percentage. Acceptable values are from 0 to 99. */ + innerRadius: number; + /** Read-only property; a float value that specifies the start angle of the Oval object. Acceptable values are from 0 to 360. To set this value, use document.setOvalObjectProperty(). */ + startAngle: number; +} + +/** + * This object contains all the properties of the Fill color setting of the Tools panel or of a selected shape. To retrieve a Fill object, use document.getCustomFill(). + */ +interface FlashFill { + bitmapIsClipped: boolean; + bitmapPath: string; + /** Property; the color of the fill, in one of the following formats: + * - A string in the format "#RRGGBB" or "#RRGGBBAA" + * - A hexadecimal number in the format 0xRRGGBB + * - An integer that represents the decimal equivalent of a hexadecimal number + */ + color: any; + /** Property; an array of colors in the gradient, expressed as integers. This property is available only if the value of the fill.style property is either "radialGradient" or "linearGradient". See fill.style */ + colorArray: any[]; + focalPoint: number; + linearRGB: boolean; + matrix: FlashMatrix; + overflow: string; + posArray: number[]; + style: string; +} + +interface FlashContour { + getHalfEdge(): FlashHalfEdge; + fill: FlashFill; + interior: boolean; + orientation: number; +} + +interface FlashStroke { + /// A Boolean value, same as the Sharp Corners setting in the custom Stroke Style dialog box. + breakAtCorners: boolean; + /// A string that specifies the type of cap for the stroke. + capType: string; + /// A string, hexadecimal value, or integer that represents the stroke color. + color: any; + /// A string that specifies the type of hatching for the stroke. + curve: string; + /// An integer that specifies the lengths of the solid part of a dashed line. + dash1: number; + /// An integer that specifies the lengths of the blank part of a dashed line. + dash2: number; + /// A string that specifies the density of a stippled line. + density: string; + /// A string that specifies the dot size of a stippled line. + dotSize: string; + /// An integer that specifies the spacing between dots in a dotted line. + dotSpace: number; + /// A string that specifies the thickness of a hatch line. + hatchThickness: string; + /// A string that specifies the jiggle property of a hatched line. + jiggle: string; + /// A string that specifies the type of join for the stroke. + joinType: string; + /// A string that specifies the length of a hatch line. + length: string; + /// A float value that specifies the angle above which the tip of the miter will be truncated by a segment. + miterLimit: number; + /// A string that specifies the pattern of a ragged line. + pattern: string; + /// A string that specifies the rotation of a hatch line. + rotate: string; + /// A string that specifies the type of scale to be applied to the stroke. + scaleType: string; + /// A Fill object that represents the fill settings of the stroke. + shapeFill: FlashFill; + /// A string that specifies the spacing of a hatched line. + space: string; + /// A Boolean value that specifies whether stroke hinting is set on the stroke. + strokeHinting: boolean; + /// A string that describes the stroke style. + style: string; + /// An integer that specifies the stroke size. + thickness: number; + /// A string that specifies the variation of a stippled line. + variation: string; + /// A string that specifies the wave height of a ragged line. + waveHeight: string; + /// A string that specifies the wave length of a ragged line. + waveLength: string; +} + +interface FlashEdge { + getControl(i: number): FlashPoint; + getHalfEdge(index: number): FlashHalfEdge; + setControl(index: number, x:number, y:number): void; + splitEdge(t: number): void; + cubicSegmentIndex: number; + id: number; + isLine: boolean; + stroke: FlashStroke; +} + +interface FlashVertex { + getHalfEdge(): FlashHalfEdge; + setLocation(x: number, y: number); + x: number; + y: number; +} + + +interface FlashTimeline { + /** Adds a motion guide layer above the current layer and attaches the current layer to the newly added guide layer. */ + addMotionGuide(): number; + + /** Adds a new layer to the document and makes it the current layer. */ + addNewLayer(name?: string, layerType?: string, bAddAbove?: boolean); + + /** Deletes all the contents from a frame or range of frames on the current layer. */ + clearFrames(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Converts a keyframe to a regular frame and deletes its contents on the current layer. */ + clearKeyframes(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Converts frames to blank keyframes on the current layer. */ + convertToBlankKeyframes(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Converts a range of frames to keyframes (or converts the selection if no frames are specified) on the current layer. */ + convertToKeyframes(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Copies a range of frames on the current layer to the clipboard. */ + copyFrames(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Copies a range of Timeline layers to the clipboard. */ + copyLayers(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Copies motion on selected frames, either from a motion tween or from frame - by - frame animation, so it can be applied to other frames. */ + copyMotion(): void; + + /** Copies motion on selected frames, either from a motion tween or from frame - by - frame animation, to the clipboard as ActionScript 3.0 code. */ + copyMotionAsAS3(): void; + + /** Creates a new motion object at a designated start and end frame. */ + createMotionObject(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Sets the frame.tweenType property to motion for each selected keyframe on the current layer, and converts each frames contents to a single symbol instance if necessary. */ + createMotionTween(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Cuts a range of frames on the current layer from the timeline and saves them to the clipboard. */ + cutFrames(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Cuts a range of Timeline layers and saves them to the clipboard. */ + cutLayers(startLayerIndex?: number, endLayerIndex?: number): void; + + /** Deletes a layer. */ + deleteLayer(index: number): void; + + /** Duplicates the selected layers or specified layers. */ + duplicateLayers(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Expands or collapses the specified folder or folders. */ + expandFolder(bExpand: boolean, bRecurseNestedParents?: boolean, index?: number): void; + + /** Finds an array of indexes for the layers with the given name. */ + findLayerIndex(name: string): number[]; + + /** Retrieves the specified propertys value for the selected frames. */ + getFrameProperty(property: string, startframeIndex?: number, endFrameIndex?: number): any; + + /** Returns an XML string that represents the current positions of the horizontal and vertical guide lines for a timeline(View > Guides > Show Guides). */ + getGuidelines(): string; + + /** Retrieves the specified propertys value for the selected layers. */ + getLayerProperty(property: string): any; + + /** Retrieves the currently selected frames in an array. */ + getSelectedFrames(): FlashFrame[]; + + /** Retrieves the zero - based index values of the currently selected layers. */ + getSelectedLayers(): FlashLayer[]; + + /** Inserts a blank keyframe at the specified frame index; if the index is not specified, inserts the blank keyframe by using the playhead / selection. */ + insertBlankKeyframe(frameNumIndex?: number): void; + + /** Inserts the specified number of frames at the given frame number. */ + insertFrames(numFrames?: number, bAllLayers?: boolean, frameNumIndex?: number): void; + + /** Inserts a keyframe at the specified frame. */ + insertKeyframe(frameNumIndex?: number): void; + + /** Pastes the range of frames from the clipboard into the specified frames. */ + pasteFrames(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Pastes copied layers to the Timeline above the specified layer index. */ + pasteLayers(layerIndex: number): number; + + /** Pastes the range of motion frames retrieved by */ + pasteMotion(): void; + + /** Deletes the frame. */ + removeFrames(startFrameIndex?: number, endFrameIndex?: number): void; + + /** Removes the motion object created with timeline.createMotionObject(), and converts the frame(s) to static frames. */ + removeMotionObject(startFrame: number, endFrame: number):void + + /** Moves the first specified layer before or after the second specified layer. */ + reorderLayer(layerToMove: number, layerToPutItBy: number, bAddBefore?: boolean): void; + + /** Reverses a range of frames. */ + reverseFrames(startFrameIndex?: number, endFrameIndex?: number): void + + /** Selects all the frames in the current timeline. */ + selectAllFrames(): void; + + /** Sets the property of the Frame object for the selected frames. */ + setFrameProperty(property: string, value: any, startFrameIndex?: number, endFrameIndex?: number): void; + + /** Replaces the guide lines for the timeline with the information specified. */ + setGuidelines(xmlString: string): boolean; + + /** Sets the specified property on all the selected layers to a specified value. */ + setLayerProperty(property: string, value: any, layersToChange?: string): void; + + /** Selects a range of frames in the current layer or sets the selected frames to the selection array passed into this method. */ + setSelectedFrames(startFrameIndex: number, endFrameIndex: number, bReplaceCurrentSelection?: boolean): void; + setSelectedFrames(selectionList: number[], bReplaceCurrentSelection?: boolean): void; + + /** Sets the layer to be selected; also makes the specified layer the current layer. */ + setSelectedLayers(index: number, bReplaceCurrentSelection?: boolean): void; + + /** Shows the layer masking during authoring by locking the mask and masked layers. */ + showLayerMasking(layer: number): void; + + /** Starts automatic playback of the timeline if it is not currently playing. */ + startPlayback(): void; + + /** Stops autoumatic playback of the timeline if it is currently playing. */ + stopPlayback(): void; + + /** A zero-based index for the frame at the current */ + currentFrame: number; + + /** A zero-based index for the currently active layer. */ + currentLayer: number; + + /** Read-only; an integer that represents the number of */ + frameCount: number; + + /** Read-only; an integer that represents the number of */ + layerCount: number; + + /** Read-only; an array of layer objects. */ + layers: FlashLayer[]; + + /** A string that represents the name of the current */ + name: string; +} + +interface FlashPath { + /// Appends a cubic Bzier curve segment to the path. + addCubicCurve(xAnchor: number, yAnchor: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): void; + /// Appends a quadratic Bzier segment to the path. + addCurve(xAnchor: number, yAnchor: number, x2: number, y2: number, x3: number, y3: number): void; + /// Adds a point to the path. + addPoint(x: number, y: number): void; + /// Removes all points from the path. + clear(): void; + /// Appends a point at the location of the first point of the path and extends the path to that point, which closes the path. + close(); void; + /// Creates a shape on the Stage by using the current stroke and fill settings. + makeShape(bSupressFill?: boolean, bSupressStroke?: boolean): void; + /// Starts a new contour in the path. + newContour(): void; + /// Read-only; an integer representing the number of points in the path. + nPts: number; +} + +interface FlashDrawingLayer { + /// Puts Flash in drawing mode. + beginDraw(persistentDraw?: boolean): void; + /// Erases what was previously drawn using the drawingLayer and prepares for more drawing commands. + beginFrame(): void; + /// Draws a cubic curve from the current pen location using the parameters as the coordinates of the cubic segment. + cubicCurveTo(x1Ctrl: number, y1Ctrl: number, x2Ctl: number, y2Ctl: number, xEnd: number, yEnd: number): void; + /// Draws a quadratic curve segment starting at the current drawing position and ending at a specified point. + curveTo(xCtl: number, yCtl: number, xEnd: number, yEnd: number): void; + /// Draws the specified path. + drawPath(path: FlashPath): void; + /// Exits drawing mode. + endDraw(): void; + /// Signals the end of a group of drawing commands. + endFrame(): void; + /// Draws a line from the current drawing position to the point (x,y). + lineTo(x: number, y: number): void; + /// Sets the current drawing position. + moveTo(x: number, y: number): void; + /// Returns a new Path object. + newPath(): void; + /// Sets the color of subsequently drawn data. + setColor(color: any): void; + /// This method is not available. + setFill(): void; + /// This method is not available. + setStroke(): void; +} + +interface FlashXMLUI { + accept(); + cancel(); + get(); + getControlItemElement(); + getEnabled(); + getVisible(); + set(); + setControItemElement(); + setControItemElements(); + setEnabled(); + setVisible(); +} + +interface FlashActionsPanel { + getClassForObject(); + getScriptAssistMode(); + getSelectedText(); + getText(); + hasSelection(); + replaceSelectedText(); + setScriptAssistMode(); + setSelection(); + setText(); +} + +interface FlashCompilerErrors { + clear(); + save(); +} + +interface FlashComponentsPanel { + addItemToDocument(); + reload(); +} + +interface FlashPresetPanel { + addNewItem(); + applyPreset(); + deleteFolder(); + deleteItem(); + expandFolder(); + exportItem(); + findItemIndex(); + getSelectedItems(); + importItem(); + moveToFolder(); + newFolder(); + renameItem(); + selectItem(); +} + +interface FlashSwfPanel { + call(); + setFocus(); + name; + path; +} + +interface FlashTools { + constraintPoint(); + getKeyDown(); + setCreatingBbox(); + setCursor(); + snapPoint(); + activeTool; + altIsDown; + ctlIsDown; + mouseIsDown; + penDownLoc; + penLoc; + shiftIsDown; + toolObjs; +} + +interface FlashFL { + addEventListener(eventType, callbackFunction); + browseForFileURL(browseType, title?, previewArea?); + browseForFolderURL(description: string); + clearPublishCache(): void; + clipCopyString(string: string): void; + closeAll(bPromptToSave?: boolean): void; + closeAllPlayerDocuments(): boolean; + closeDocument(documentObject: FlashDocument, bPromptToSaveChanges?: boolean); + //closeProject(); + /** A string that specifies the type of document to create. Acceptable values are "timeline", "presentation", and "application". The default value is "timeline", which has the same effect as choosing File > New > Flash File (ActionScript 3.0). This parameter is optional. */ + createDocument(document?: string): FlashDocument; + + exportPublishProfileString(ucfURI: string, profileName: string): string; + + //createProject(); + //downloadLatestVersion(); // Not in CS5 + //enableImmediateUpdates(); + + fileExists(fileURI: string): boolean; + findDocumentDOM(id: number): FlashDocument; + findDocumentIndex(name: string): number[]; + findObjectInDocByName(instanceName: string, document: FlashDocument): { keyframe: FlashFrame; layer: FlashLayer; timeline: FlashTimeline; parent; }[]; + /** elementType = "shape", "text", "instance", or "shapeObj". */ + findObjectInDocByType(elementType: string, document: FlashDocument): any[]; + getAppMemoryInfo(memType: number); + + /* + * Method; retrieves the DOM (Document object) of the currently active document (FLA file). + * If one or more documents are open but a document does not currently have focus (for + * example, if a JSFL file has focus), retrieves the DOM of the most recently active document. + * getDocumentDOM(): Document; + */ + getDocumentDOM(): FlashDocument; + + //getProject(); + + getSwfPanel(); + + isFontInstalled(); + + + mapPlayerURL(URI: string, returnMBCS?: boolean): string; + + /** Method; opens a Flash document (FLA file) for editing in a new Flash Document window and gives it focus. For a user, the effect is the same as selecting File > Open and then selecting a file. If the specified file is already open, the window that contains the document comes to the front. The window that contains the specified file becomes the currently selected document. */ + openDocument(fileURI: string): FlashDocument; + + //openProject(); + + openScript(fileURI: string, createExtension?: string, className?: string): void; + + quit(bPromptIfNeeded?: boolean): void; + + //reloadEffects(): void; + + reloadTools(): void; + + /** documentNew", "documentOpened", "documentClosed", "mouseMove", "documentChanged", "layerChanged", and "frameChanged". */ + removeEventListener(eventType: string): boolean; + resetAS3PackagePaths(): void; + resetPackagePaths(): void; + revertDocument(document: FlashDocument): void; + //revertDocumentToLastVersion(); + + runScript(fileURI: string, funcName?: Function, args?: any[]): any; + + saveAll(): void; + + //saveVersionOfDocument(); + saveDocument(document: FlashDocument, fileURI?: string): boolean; + saveDocumentAs(document: FlashDocument): boolean; + + /** Method; enables selection or editing of an element. Generally, you will use this method on objects returned by fl.findObjectInDocByName() or fl.findObjectInDocByType(). */ + selectElement(elementObject: FlashElement, editMode: boolean): boolean; + + /** "arrow","bezierSelect","freeXform","fillXform","lasso","pen","penplus","penminus","penmodify","text","line","rect","oval","rectPrimitive","ovalPrimitive","polystar","pencil","brush","inkBottle","bucket","eyeDropper","eraser","hand", and "magnifier". */ + selectTool(toolName: string): void; + + selectActiveWindow(document: FlashDocument, bActivateFrame?: boolean): void; + + showIdleMessage(show: boolean): void; + + toggleBreakpoint(); + + //synchronizeDocumentWithHeadVersion(); + trace(message: any): void; + + actionsPanel: FlashActionsPanel; + //activeEffect; + as3PackagePaths: string; + compilerErrors: FlashCompilerErrors; + componentsPanel: FlashComponentsPanel; + configDirectory: string; + configURI: string; + contactSensitiveSelection: boolean; + createNewDocList: string[]; + createNewDocListType: string[]; + createNewTemplateList: string[]; + documents: FlashDocument[]; + drawingLayer: FlashDrawingLayer; + //effects; + externalLibraryPath: string; + flexSDKPath: string; + installedPlayers: any[]; + languageCode: string; + libraryPath: string; + Math: FlashMath; + mruRecentFileList: string[]; + mruRecentFileListType: string[]; + packagePaths: string[]; + publishCacheDiskSizeMax: number; + publishCacheEnabled: boolean; + publishCacheMemoryEntrySizeLimit: number; + publishCacheMemorySizeMax: number; + + objectDrawingMode: number; + outputPanel: FlashOutputPanel; + presetPanel: FlashPresetPanel; + scriptURI: string; + sourcePath: string; + swfPanels: FlashSwfPanel[]; + tools: FlashTools[]; + version: string; + xmlui: FlashXMLUI; +} + +declare var fl: FlashFL; +declare var FLfile: FlashFLfile; +declare function alert(alertText: string): void; +declare function confirm(strAlert: string): boolean; +declare function prompt(promptMsg: string, text?: string): string; \ No newline at end of file diff --git a/jsfl/xJSFL.d.ts b/jsfl/xJSFL.d.ts new file mode 100644 index 0000000000..7db97360b0 --- /dev/null +++ b/jsfl/xJSFL.d.ts @@ -0,0 +1,93 @@ +/// + +interface _xjsfl { + init(_this: any): void; + uri: string; +} + +declare class _File { + constructor(path: string); + copy(path: string): _File; + write(data: string): _File; + contents: string; +} + +declare class _Folder { + constructor(path: string); + contents: _File[]; +} + +declare class _Context { + static create(): _Context; + static from(frame: FlashFrame): _Context; + layer: FlashLayer; + frame: FlashFrame; + keyframes: FlashFrame[]; + elements: FlashElement[]; + setLayer(index: number); + update(); + goto(); +} + +interface GenericCollection { + elements: T[]; + rename(pattern: string): GenericCollection; + update(): GenericCollection; + select(): GenericCollection; + toGrid(x: number, y: number): GenericCollection; + randomize(info: any): GenericCollection; + each(callback: (element: T, index?: number, elements?: T[]) => void ); +} + +interface ElementCollection extends GenericCollection { +} + +interface ItemCollection extends GenericCollection { +} + +declare class _URI { + constructor(path: string); + uri: string; + folder: string; + name: string; + extension: string; + path: string; + type: string; + toURI(string: string): string; +} + +declare var xjsfl: _xjsfl; + +// Global variables +declare var $dom: FlashDocument; +declare var $timeline: FlashTimeline; +declare var $library: FlashLibrary; +declare var $selection: FlashElement[]; + +// Global functions + +// Output +declare function trace(...args: any[]): void; +declare function clear(): void; +declare function format(format: string, ...params: any[]): void; + +// Inspection and debugging +declare function inspect(item: any): void; +declare function list(item: any): void; +declare function debug(item: any): void; + +// Library / class loading +declare function include(className: string): void; +declare function require(className: string): void; + +// File +declare function load(filePath: string): string; +declare function save(filePath: string, data: string): void; + +// http://www.xjsfl.com/support/guides/working-with-flash/introduction-to-selectors + +// http://www.xjsfl.com/support/api/elements/ElementSelector +declare function $(selector: string): ElementCollection; // ElementSelector + +// http://www.xjsfl.com/support/api/elements/ItemSelector +declare function $$(selector: string): ItemCollection; // ItemSelector From c2a19737cbb9ce136088bae82df4b2ecb867687d Mon Sep 17 00:00:00 2001 From: anchann Date: Tue, 3 Sep 2013 14:51:57 +0900 Subject: [PATCH 437/756] AngularJS: fixing http promise typings Looks like defining only a single overload of the then function on the IHttpPromise interface is making the other overload of it defined on IPromise invisible to the compiler. As such, we need to expose both versions. Otherwise, the standard promise unwrapping behaviour does not type check correctly. --- angularjs/angular.d.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 429a79b483..140e56eee9 100755 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -518,8 +518,8 @@ declare module ng { pendingRequests: any[]; } - // This is just for hinting. - // Some opetions might not be available depending on the request. + // This is just for hinting. + // Some opetions might not be available depending on the request. // see http://docs.angularjs.org/api/ng.$http#Usage for options explanations interface IRequestConfig { method: string; @@ -550,10 +550,11 @@ declare module ng { config?: IRequestConfig; } - interface IHttpPromise extends IPromise { + interface IHttpPromise extends IPromise { success(callback: IHttpPromiseCallback): IHttpPromise; error(callback: IHttpPromiseCallback): IHttpPromise; then(successCallback: (response: IHttpPromiseCallbackArg) => TResult, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; + then(successCallback: (response: IHttpPromiseCallbackArg) => IPromise, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; } interface IHttpProvider extends IServiceProvider { From 8436b3fda0b8395f4b667e289ebbdf4857895687 Mon Sep 17 00:00:00 2001 From: "anti.veeranna" Date: Tue, 3 Sep 2013 03:00:09 -0400 Subject: [PATCH 438/756] type definitions for TableQuery class --- node-azure/azure.d.ts | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/node-azure/azure.d.ts b/node-azure/azure.d.ts index 374eec439e..1ed0e74368 100644 --- a/node-azure/azure.d.ts +++ b/node-azure/azure.d.ts @@ -184,7 +184,16 @@ declare module "azure" { } export class TableQuery { - + static select(...fields: string[]): TableQuery; + from(table: string): TableQuery; + whereKeys(partitionKey: string, rowKey: string): TableQuery; + whereNextKeys(partitionKey: string, rowKey: string): TableQuery; + where(condition: string, ...values: string[]): TableQuery; + and(condition: string, ...arguments: string[]): TableQuery; + or(condition: string, ...arguments: string[]): TableQuery; + top(integer): TableQuery; + toQueryObject(): any; + toPath(): string; } export class BatchServiceClient extends StorageServiceClient { @@ -361,4 +370,4 @@ declare module "azure" { //#endregion export function isEmulated(): boolean; -} \ No newline at end of file +} From 6cdeeeb2b2f8e4b5f5652d2202ceb01c8ebedb6d Mon Sep 17 00:00:00 2001 From: Santi Albo Date: Tue, 3 Sep 2013 09:41:21 +0100 Subject: [PATCH 439/756] Better type signatures for RestangularProvider methods --- restangular/restangular.d.ts | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/restangular/restangular.d.ts b/restangular/restangular.d.ts index e1c4856012..339e2444c6 100644 --- a/restangular/restangular.d.ts +++ b/restangular/restangular.d.ts @@ -11,7 +11,7 @@ interface Restangular extends RestangularCustom { one(route: string, id?: string): RestangularElement; all(route: string): RestangularCollection; copy(fromElement: any): RestangularElement; - withConfig(configurer: any): Restangular; + withConfig(configurer: (RestangularProvider) => any): Restangular; } interface RestangularElement extends Restangular { @@ -49,16 +49,26 @@ interface RestangularCustom { } interface RestangularProvider { - setBaseUrl(newValue: string): void; - setExtraFields(newValues: string[]): void; - setDefaultHttpFields(newValue: any): void; - setMethodOverriders(newValue: any): void; - setResponseExtractor(newValue: any): void; - setRequestInterceptor(newValue: any): void; - setListTypeIsArray(newValue: boolean): void; - setRestangularFields(newValue: any): void; - setRequestSuffix(newValue: any): void; - addElementTransformer(type, secondArg, thirdArg): void; + setBaseUrl(baseUrl: string): void; + setExtraFields(fields: string[]): void; + setParentless(parentless: boolean, routes: string[]): void; + setDefaultHttpFields(httpFields: any): void; + addElementTransformer(route: string, transformer: Function): void; + addElementTransformer(route: string, isCollection: boolean, transformer: Function): void; + setOnElemRestangularized(callback: (elem: any, isCollection: boolean, what: string, restangular: Restangular) => any): void; + setResponseInterceptor(responseInterceptor: (data: any, operation: string, what: string, url: string, response: any, deferred: ng.IDeferred) => any): void; + setResponseExtractor(responseInterceptor: (data: any, operation: string, what: string, url: string, response: any, deferred: ng.IDeferred) => any): void; + setRequestInterceptor(requestInterceptor: (element: any, operation: string, what: string, url: string) => any); + setFullRequestInterceptor(fullRequestInterceptor: (element: any, operation: string, what: string, url: string, headers: any, params: any) => {element: any; headers: any; params: any}); + setErrorInterceptor(errorInterceptor: (response: any) => any): void; + setRestangularFields(fields: {[fieldName: string]: string}): void; + setMethodOverriders(overriders: string[]): void; + setDefaultRequestParams(params: any): void; + setDefaultRequestParams(methods: any, params: any): void; + setFullResponse(fullResponse: boolean): void; + setDefaultHeaders(headers: any): void; + setRequestSuffix(suffix: string): void; + setUseCannonicalId(useCannonicalId: boolean): void; } declare var Restangular: Restangular; From d95465e400a6a403e2038bf25e341aaa49590516 Mon Sep 17 00:00:00 2001 From: Santi Albo Date: Tue, 3 Sep 2013 09:41:56 +0100 Subject: [PATCH 440/756] "setListTypeIsArray" is deprecated --- restangular/restangular-tests.ts | 2 -- 1 file changed, 2 deletions(-) diff --git a/restangular/restangular-tests.ts b/restangular/restangular-tests.ts index 400b67b388..fc79cad5bf 100644 --- a/restangular/restangular-tests.ts +++ b/restangular/restangular-tests.ts @@ -88,8 +88,6 @@ function test_config() { RestangularProvider.setDefaultHttpFields({ cache: true }); RestangularProvider.setMethodOverriders(["put", "patch"]); - RestangularProvider.setListTypeIsArray(true); - RestangularProvider.setRestangularFields({ id: "_id", route: "restangularRoute" From 835f1c84d865483145544e1f88f419b6fd2c0201 Mon Sep 17 00:00:00 2001 From: Santi Albo Date: Tue, 3 Sep 2013 10:22:16 +0100 Subject: [PATCH 441/756] Add typing for response objects --- restangular/restangular.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/restangular/restangular.d.ts b/restangular/restangular.d.ts index 339e2444c6..910eb23d7f 100644 --- a/restangular/restangular.d.ts +++ b/restangular/restangular.d.ts @@ -56,11 +56,11 @@ interface RestangularProvider { addElementTransformer(route: string, transformer: Function): void; addElementTransformer(route: string, isCollection: boolean, transformer: Function): void; setOnElemRestangularized(callback: (elem: any, isCollection: boolean, what: string, restangular: Restangular) => any): void; - setResponseInterceptor(responseInterceptor: (data: any, operation: string, what: string, url: string, response: any, deferred: ng.IDeferred) => any): void; - setResponseExtractor(responseInterceptor: (data: any, operation: string, what: string, url: string, response: any, deferred: ng.IDeferred) => any): void; + setResponseInterceptor(responseInterceptor: (data: any, operation: string, what: string, url: string, response: XMLHttpRequest, deferred: ng.IDeferred) => any): void; + setResponseExtractor(responseInterceptor: (data: any, operation: string, what: string, url: string, response: XMLHttpRequest, deferred: ng.IDeferred) => any): void; setRequestInterceptor(requestInterceptor: (element: any, operation: string, what: string, url: string) => any); setFullRequestInterceptor(fullRequestInterceptor: (element: any, operation: string, what: string, url: string, headers: any, params: any) => {element: any; headers: any; params: any}); - setErrorInterceptor(errorInterceptor: (response: any) => any): void; + setErrorInterceptor(errorInterceptor: (response: XMLHttpRequest) => any): void; setRestangularFields(fields: {[fieldName: string]: string}): void; setMethodOverriders(overriders: string[]): void; setDefaultRequestParams(params: any): void; From c66c1bd09f44db8bb39c403abaaf4da83deb271e Mon Sep 17 00:00:00 2001 From: Lasse Jul-Larsen Date: Tue, 3 Sep 2013 14:24:37 +0200 Subject: [PATCH 442/756] Fixed method signature on column formatter --- slickgrid/SlickGrid.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/slickgrid/SlickGrid.d.ts b/slickgrid/SlickGrid.d.ts index bc389db7ad..44acc4c1bb 100644 --- a/slickgrid/SlickGrid.d.ts +++ b/slickgrid/SlickGrid.d.ts @@ -1446,7 +1446,7 @@ declare module Slick { } export interface Formatter { - (row: number, cell: number, columnDef: Column, dataContext: SlickData): string; + (row: number, cell: number, value: any, columnDef: Column, dataContext: SlickData): string; } export module Formatters { From f9ff1d914a1a2075c41f56fdb063e5ffe9f846c2 Mon Sep 17 00:00:00 2001 From: Santi Albo Date: Tue, 3 Sep 2013 17:05:42 +0100 Subject: [PATCH 443/756] Fix Response type --- restangular/restangular.d.ts | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/restangular/restangular.d.ts b/restangular/restangular.d.ts index 910eb23d7f..e633d8ac25 100644 --- a/restangular/restangular.d.ts +++ b/restangular/restangular.d.ts @@ -56,11 +56,11 @@ interface RestangularProvider { addElementTransformer(route: string, transformer: Function): void; addElementTransformer(route: string, isCollection: boolean, transformer: Function): void; setOnElemRestangularized(callback: (elem: any, isCollection: boolean, what: string, restangular: Restangular) => any): void; - setResponseInterceptor(responseInterceptor: (data: any, operation: string, what: string, url: string, response: XMLHttpRequest, deferred: ng.IDeferred) => any): void; - setResponseExtractor(responseInterceptor: (data: any, operation: string, what: string, url: string, response: XMLHttpRequest, deferred: ng.IDeferred) => any): void; + setResponseInterceptor(responseInterceptor: (data: any, operation: string, what: string, url: string, response: RestangularResponse, deferred: ng.IDeferred) => any): void; + setResponseExtractor(responseInterceptor: (data: any, operation: string, what: string, url: string, response: RestangularResponse, deferred: ng.IDeferred) => any): void; setRequestInterceptor(requestInterceptor: (element: any, operation: string, what: string, url: string) => any); setFullRequestInterceptor(fullRequestInterceptor: (element: any, operation: string, what: string, url: string, headers: any, params: any) => {element: any; headers: any; params: any}); - setErrorInterceptor(errorInterceptor: (response: XMLHttpRequest) => any): void; + setErrorInterceptor(errorInterceptor: (response: RestangularResponse) => any): void; setRestangularFields(fields: {[fieldName: string]: string}): void; setMethodOverriders(overriders: string[]): void; setDefaultRequestParams(params: any): void; @@ -71,5 +71,15 @@ interface RestangularProvider { setUseCannonicalId(useCannonicalId: boolean): void; } +interface RestangularResponse { + status: number; + data: any; + config: { + method: string; + url: string; + params: any; + } +} + declare var Restangular: Restangular; declare var RestangularProvider: RestangularProvider; From ee99d701b54a27e9169f4f0999a9f8ac555d64f9 Mon Sep 17 00:00:00 2001 From: Santi Albo Date: Tue, 3 Sep 2013 17:24:42 +0100 Subject: [PATCH 444/756] Add tests for setErrorInterceptor --- restangular/restangular-tests.ts | 39 ++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/restangular/restangular-tests.ts b/restangular/restangular-tests.ts index fc79cad5bf..76a0ffd648 100644 --- a/restangular/restangular-tests.ts +++ b/restangular/restangular-tests.ts @@ -79,27 +79,32 @@ function test_basic() { } function test_config() { - RestangularProvider.setBaseUrl('/api/v1'); - RestangularProvider.setExtraFields(['name']); - RestangularProvider.setResponseExtractor(function (response, operation) { - return response.data; - }); + var myRestangular = Restangular.withConfig((configurer: RestangularProvider) => { + configurer.setBaseUrl('/api/v1'); + configurer.setExtraFields(['name']); - RestangularProvider.setDefaultHttpFields({ cache: true }); - RestangularProvider.setMethodOverriders(["put", "patch"]); + configurer.setErrorInterceptor(function (response) { + console.error('' + response.status + ' ' + response.data); + }); + configurer.setResponseExtractor(function (response, operation) { + return response.data; + }); + configurer.setDefaultHttpFields({ cache: true }); + configurer.setMethodOverriders(["put", "patch"]); - RestangularProvider.setRestangularFields({ - id: "_id", - route: "restangularRoute" - }); + configurer.setRestangularFields({ + id: "_id", + route: "restangularRoute" + }); - RestangularProvider.setRequestSuffix('.json'); + configurer.setRequestSuffix('.json'); - RestangularProvider.setRequestInterceptor(function (element, operation, route, url) { - }); + configurer.setRequestInterceptor(function (element, operation, route, url) { + }); - RestangularProvider.addElementTransformer('accounts', false, function (elem) { - elem.accountName = 'Changed'; - return elem; + configurer.addElementTransformer('accounts', false, function (elem) { + elem.accountName = 'Changed'; + return elem; + }); }); } From 3a99f271962955c985c7f3b22322251c05e6ddb3 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Tue, 3 Sep 2013 12:45:18 -0700 Subject: [PATCH 445/756] Changed section on collections --- meteor/README.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/meteor/README.md b/meteor/README.md index b2320b54fc..6ca88263d9 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -4,7 +4,7 @@ In order to effectively write a Meteor app with TypeScript, you will probably ne - Reference the Meteor type definitions file (meteor.d.ts) - Create a Template definition file -- Create Collections within modules +- Create Collections within a module or modules ##Referencing Meteor type definitions in your app @@ -52,17 +52,33 @@ After you create this file, you may access the Template variable by declaring so ##Defining Collections -In TypeScript, global variables are not allowed, and in a Meteor app, creating a local variable (using `var `) limits a variable's scope to the file. However, you will probably want to define variables, such as collections, that can be used across files. In the case of collections, one way to work around these limitations is to wrap each collection within a module, and then make the module globally accessible. Here is an example using posts.ts: +In TypeScript, global variables are not allowed, and in a Meteor app, creating a local variable (using `var `) limits a variable's scope to the file. However, you will probably want to define variables, such as collections, that can be used across files. In the case of collections, one way to work around these limitations is to wrap the definitions of all collections within a module, and then make the module globally accessible. Here is an example (collections/models.ts): - module PostsModel { + module Models { export var Posts = new Meteor.Collection('posts'); - }; + export var Comments = new Meteor.Collection('comments'); + export var Notifications = new Meteor.Collection('notifications'); - this.PostsModel = PostsModel; + export var createCommentNotification = function (comment) { + var post = Posts.findOne(comment.postId); + Notifications.insert({ + userId: post.userId, + postId: post._id, + commentId: comment._id, + commenterName: comment.author, + read: false + }); + }; -You can then access the Posts collection by placing something similar to `/// ` at the top of a TypeScript file. The code within the file something would look something like this: + } - PostsModel.Posts.findOne(Session.get('currentPostId')); + this.Models = Models; + +You can then access the Posts collection by placing something similar to `/// ` at the top of a TypeScript file. The code within the file something would look something like this: + + Models.Posts.findOne(Session.get('currentPostId')); + +For organizational purposes, any additional code related to each Collection can be placed in a separate file per each collection. Alternatively, you could wrap each collection in its own module (e.g. PostsModel for posts, CommentsModel for comments). ##Reference app From d6fe70c01b55aa3bae724a71a79bc6bbc7cfbfa7 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Tue, 3 Sep 2013 12:55:11 -0700 Subject: [PATCH 446/756] Minor changes to section on collections --- meteor/README.md | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/meteor/README.md b/meteor/README.md index 6ca88263d9..0c3fbe07a6 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -52,29 +52,17 @@ After you create this file, you may access the Template variable by declaring so ##Defining Collections -In TypeScript, global variables are not allowed, and in a Meteor app, creating a local variable (using `var `) limits a variable's scope to the file. However, you will probably want to define variables, such as collections, that can be used across files. In the case of collections, one way to work around these limitations is to wrap the definitions of all collections within a module, and then make the module globally accessible. Here is an example (collections/models.ts): +In TypeScript, global variables are not allowed, and in a Meteor app, creating a local variable (using `var `) limits a variable's scope to the file. However, you will probably want to define variables, such as collections, that can be used across multiple files. In the case of collections, one way to work around these limitations is to wrap the definitions of all collections within a module, and then make the module globally accessible. Here is an example (collections/models.ts): module Models { export var Posts = new Meteor.Collection('posts'); export var Comments = new Meteor.Collection('comments'); export var Notifications = new Meteor.Collection('notifications'); - - export var createCommentNotification = function (comment) { - var post = Posts.findOne(comment.postId); - Notifications.insert({ - userId: post.userId, - postId: post._id, - commentId: comment._id, - commenterName: comment.author, - read: false - }); - }; - } this.Models = Models; -You can then access the Posts collection by placing something similar to `/// ` at the top of a TypeScript file. The code within the file something would look something like this: +You can then access the Posts collection by placing something similar to `/// ` at the top of a TypeScript file. The code within the file would look something like this: Models.Posts.findOne(Session.get('currentPostId')); From 16db4e7088a13c354fe866e2f7dfdfc1ed8b36c7 Mon Sep 17 00:00:00 2001 From: Dave Allen Date: Tue, 3 Sep 2013 14:15:47 -0700 Subject: [PATCH 447/756] Minor changes to section on collections --- meteor/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meteor/README.md b/meteor/README.md index 0c3fbe07a6..a654e86da9 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -70,7 +70,7 @@ For organizational purposes, any additional code related to each Collection can ##Reference app -A simple Meteor reference application created with TypeScript is listed below. It is based on the Microscope reference app in [Discover Meteor](http://www.discovermeteor.com/ "http://www.discovermeteor.com/"). +Listed below is a simple Meteor reference application created with TypeScript is listed below. It is based on the Microscope reference app in [Discover Meteor](http://www.discovermeteor.com/ "http://www.discovermeteor.com/"). - Sample Site: - Code (TypeScript and transpiled JS): From 59b2a24150173115355e9f21ce43effac25ec325 Mon Sep 17 00:00:00 2001 From: Santi Albo Date: Tue, 3 Sep 2013 23:08:47 +0100 Subject: [PATCH 448/756] Add previous tests --- restangular/restangular-tests.ts | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/restangular/restangular-tests.ts b/restangular/restangular-tests.ts index 76a0ffd648..1bb4b01ee7 100644 --- a/restangular/restangular-tests.ts +++ b/restangular/restangular-tests.ts @@ -79,6 +79,34 @@ function test_basic() { } function test_config() { + RestangularProvider.setBaseUrl('/api/v1'); + RestangularProvider.setExtraFields(['name']); + RestangularProvider.setResponseExtractor(function (response, operation) { + return response.data; + }); + + RestangularProvider.setDefaultHttpFields({ cache: true }); + RestangularProvider.setMethodOverriders(["put", "patch"]); + + RestangularProvider.setErrorInterceptor(function (response) { + console.error('' + response.status + ' ' + response.data); + }); + + RestangularProvider.setRestangularFields({ + id: "_id", + route: "restangularRoute" + }); + + RestangularProvider.setRequestSuffix('.json'); + + RestangularProvider.setRequestInterceptor(function (element, operation, route, url) { + }); + + RestangularProvider.addElementTransformer('accounts', false, function (elem) { + elem.accountName = 'Changed'; + return elem; + }); + var myRestangular = Restangular.withConfig((configurer: RestangularProvider) => { configurer.setBaseUrl('/api/v1'); configurer.setExtraFields(['name']); From 4297a8fe892e1e2c51dc9d00d65675ad4c65fada Mon Sep 17 00:00:00 2001 From: mick delaney Date: Wed, 4 Sep 2013 10:22:24 +0100 Subject: [PATCH 449/756] Adding $setDirty(dirty: boolean): void; To IFormController Documented here: http://docs.angularjs.org/api/ng.directive:form.FormController --- angularjs/angular.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 140e56eee9..bf53673001 100755 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -138,6 +138,7 @@ declare module ng { $valid: boolean; $invalid: boolean; $error: any; + $setDirty(dirty: boolean): void; } /////////////////////////////////////////////////////////////////////////// From c1d25c84f1110ac1a95ef6bbee2fb1c714e6f53d Mon Sep 17 00:00:00 2001 From: "anti.veeranna" Date: Wed, 4 Sep 2013 06:17:10 -0400 Subject: [PATCH 450/756] describe stream.Readable class --- node/node.d.ts | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/node/node.d.ts b/node/node.d.ts index 52560d36b3..3451afd36d 100644 --- a/node/node.d.ts +++ b/node/node.d.ts @@ -1001,6 +1001,24 @@ declare module "stream" { pipe(destination: WritableStream, options?: { end?: boolean; }): void; } + export interface ReadableOptions { + highWaterMark?: number; + encoding?: string; + objectMode?: boolean; + } + + export class Readable extends events.EventEmitter implements ReadableStream { + readable: boolean; + constructor(opts?: ReadableOptions); + setEncoding(encoding: string): void; + pause(): void; + resume(): void; + destroy(): void; + pipe(destination: WritableStream, options?: { end?: boolean; }): void; + _read(): void; + push(chunk: any, encoding?: string): boolean; + } + export interface ReadWriteStream extends ReadableStream, WritableStream { } } From 0e3e659961b25920b8a8c9a416f7d526661b16ca Mon Sep 17 00:00:00 2001 From: lucapierobon Date: Wed, 4 Sep 2013 12:47:00 +0200 Subject: [PATCH 451/756] Added non-specialized signature for slider(methodName, values) to avoid compiler error TS2154 Compiling with TS 0.9.1.1 the compiler stopped with "error TS2154: Specialized overload signature is not subtype of any non-specialized signature." As a matter of fact the non-specialized signature for the slider(methodName, values) overload was missing. Adding it everything was fine. --- jqueryui/jqueryui.d.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/jqueryui/jqueryui.d.ts b/jqueryui/jqueryui.d.ts index e9fd785b1b..ae6ad593e0 100644 --- a/jqueryui/jqueryui.d.ts +++ b/jqueryui/jqueryui.d.ts @@ -955,6 +955,7 @@ interface JQuery { slider(methodName: 'values', index: number): number; slider(methodName: string, index: number, value: number): void; slider(methodName: 'values', index: number, value: number): void; + slider(methodName: string, values: Array): void; slider(methodName: 'values', values: Array): void; slider(methodName: 'widget'): JQuery; slider(options: JQueryUI.SliderOptions): JQuery; @@ -1072,4 +1073,4 @@ interface JQueryStatic { datepicker: JQueryUI.Datepicker; widget: JQueryUI.Widget; Widget: JQueryUI.Widget; -} \ No newline at end of file +} From 24368d42ff2536e661d9fd5b63ca0cb456a5cbdc Mon Sep 17 00:00:00 2001 From: "anti.veeranna" Date: Wed, 4 Sep 2013 09:38:34 -0400 Subject: [PATCH 452/756] add missing properties/methods to QueryEntitiesResultContinuation --- node-azure/azure.d.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/node-azure/azure.d.ts b/node-azure/azure.d.ts index 1ed0e74368..2fed47cfbd 100644 --- a/node-azure/azure.d.ts +++ b/node-azure/azure.d.ts @@ -332,6 +332,10 @@ declare module "azure" { export interface QueryEntitiesResultContinuation extends QueryResultContinuation { tableQuery: TableQuery; + nextPartitionKey: string; + nextRowKey: string; + getNextPage(callback?: QueryEntitiesCallback): void; + hasNextPage(): boolean; } export interface ModifyEntityCallback { @@ -370,4 +374,5 @@ declare module "azure" { //#endregion export function isEmulated(): boolean; + } From 819dbc4b33b942f3de1abbac261d638d9e9690fc Mon Sep 17 00:00:00 2001 From: "anti.veeranna" Date: Wed, 4 Sep 2013 15:48:03 -0400 Subject: [PATCH 453/756] describe LinearRetryPolicyFilter, ExponentionalRetryPolicyFilter classes --- node-azure/azure.d.ts | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/node-azure/azure.d.ts b/node-azure/azure.d.ts index 2fed47cfbd..4a8276c037 100644 --- a/node-azure/azure.d.ts +++ b/node-azure/azure.d.ts @@ -216,11 +216,17 @@ declare module "azure" { } export class LinearRetryPolicyFilter { - + constructor(retryCount?: number, retryInterval?: number); + retryCount: number; + retryInterval: number; } export class ExponentialRetryPolicyFilter { - + constructor(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number); + retryCount: number; + retryInterval: number; + minRetryInterval: number; + maxRetryInterval: number; } export class SharedAccessSignature { From 95b783e97256ef1955c4d698dbbecd316dcf74f6 Mon Sep 17 00:00:00 2001 From: Chris Scribner Date: Wed, 4 Sep 2013 18:11:20 -0400 Subject: [PATCH 454/756] Update node type definitions to compile under -noImplicitAny --- node/node.d.ts | 64 +++++++++++++++++++++++++------------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/node/node.d.ts b/node/node.d.ts index 3451afd36d..3ae37ed376 100644 --- a/node/node.d.ts +++ b/node/node.d.ts @@ -16,11 +16,11 @@ declare var __filename: string; declare var __dirname: string; declare function setTimeout(callback: () => void , ms: number): any; -declare function clearTimeout(timeoutId: any); +declare function clearTimeout(timeoutId: any): void; declare function setInterval(callback: () => void , ms: number): any; -declare function clearInterval(intervalId: any); +declare function clearInterval(intervalId: any): void; declare function setImmediate(callback: () => void ): any; -declare function clearImmediate(immediateId: any); +declare function clearImmediate(immediateId: any): void; declare var require: { (id: string): any; @@ -68,13 +68,13 @@ declare var Buffer: { ************************************************/ interface EventEmitter { - addListener(event: string, listener: Function); - on(event: string, listener: Function); + addListener(event: string, listener: Function): void; + on(event: string, listener: Function): void; once(event: string, listener: Function): void; removeListener(event: string, listener: Function): void; removeAllListeners(event?: string): void; setMaxListeners(n: number): void; - listeners(event: string): { Function; }[]; + listeners(event: string): Function[]; emit(event: string, arg1?: any, arg2?: any): void; } @@ -209,24 +209,24 @@ declare module "querystring" { declare module "events" { export interface NodeEventEmitter { - addListener(event: string, listener: Function); + addListener(event: string, listener: Function): void; on(event: string, listener: Function): any; once(event: string, listener: Function): void; removeListener(event: string, listener: Function): void; removeAllListeners(event?: string): void; setMaxListeners(n: number): void; - listeners(event: string): { Function; }[]; + listeners(event: string): Function[]; emit(event: string, arg1?: any, arg2?: any): void; } export class EventEmitter implements NodeEventEmitter { - addListener(event: string, listener: Function); + addListener(event: string, listener: Function): void; on(event: string, listener: Function): any; once(event: string, listener: Function): void; removeListener(event: string, listener: Function): void; removeAllListeners(event?: string): void; setMaxListeners(n: number): void; - listeners(event: string): { Function; }[]; + listeners(event: string): Function[]; emit(event: string, arg1?: any, arg2?: any): void; } } @@ -294,7 +294,7 @@ declare module "http" { } export interface Agent { maxSockets: number; sockets: any; requests: any; } - export var STATUS_CODES; + export var STATUS_CODES: any; export function createServer(requestListener?: (request: ServerRequest, response: ServerResponse) =>void ): Server; export function createClient(port?: number, host?: string): any; export function request(options: any, callback?: Function): ClientRequest; @@ -335,7 +335,7 @@ declare module "cluster" { export function removeListener(event: string, listener: Function): void; export function removeAllListeners(event?: string): void; export function setMaxListeners(n: number): void; - export function listeners(event: string): { Function; }[]; + export function listeners(event: string): Function[]; export function emit(event: string, arg1?: any, arg2?: any): void; } @@ -359,13 +359,13 @@ declare module "zlib" { export function createInflateRaw(options: ZlibOptions): InflateRaw; export function createUnzip(options: ZlibOptions): Unzip; - export function deflate(buf: NodeBuffer, callback: (error: Error, result) =>void ): void; - export function deflateRaw(buf: NodeBuffer, callback: (error: Error, result) =>void ): void; - export function gzip(buf: NodeBuffer, callback: (error: Error, result) =>void ): void; - export function gunzip(buf: NodeBuffer, callback: (error: Error, result) =>void ): void; - export function inflate(buf: NodeBuffer, callback: (error: Error, result) =>void ): void; - export function inflateRaw(buf: NodeBuffer, callback: (error: Error, result) =>void ): void; - export function unzip(buf: NodeBuffer, callback: (error: Error, result) =>void ): void; + export function deflate(buf: NodeBuffer, callback: (error: Error, result: any) =>void ): void; + export function deflateRaw(buf: NodeBuffer, callback: (error: Error, result: any) =>void ): void; + export function gzip(buf: NodeBuffer, callback: (error: Error, result: any) =>void ): void; + export function gunzip(buf: NodeBuffer, callback: (error: Error, result: any) =>void ): void; + export function inflate(buf: NodeBuffer, callback: (error: Error, result: any) =>void ): void; + export function inflateRaw(buf: NodeBuffer, callback: (error: Error, result: any) =>void ): void; + export function unzip(buf: NodeBuffer, callback: (error: Error, result: any) =>void ): void; // Constants export var Z_NO_FLUSH: number; @@ -480,7 +480,7 @@ declare module "punycode" { decode(string: string): string; encode(codePoints: number[]): string; } - export var version; + export var version: any; } declare module "repl" { @@ -599,7 +599,7 @@ declare module "url" { slashes: boolean; } - export function parse(urlStr: string, parseQueryString? , slashesDenoteHost? ): Url; + export function parse(urlStr: string, parseQueryString?: boolean , slashesDenoteHost?: boolean ): Url; export function format(url: Url): string; export function resolve(from: string, to: string): string; } @@ -771,19 +771,19 @@ declare module "fs" { export function futimesSync(fd: string, atime: number, mtime: number): void; export function fsync(fd: string, callback?: Function): void; export function fsyncSync(fd: string): void; - export function write(fd: string, buffer: NodeBuffer, offset: number, length: number, position: number, callback?: (err, written: number, buffer: NodeBuffer) =>any): void; + export function write(fd: string, buffer: NodeBuffer, offset: number, length: number, position: number, callback?: (err: Error, written: number, buffer: NodeBuffer) =>any): void; export function writeSync(fd: string, buffer: NodeBuffer, offset: number, length: number, position: number): void; - export function read(fd: string, buffer: NodeBuffer, offset: number, length: number, position: number, callback?: (err, bytesRead: number, buffer: NodeBuffer) => void): void; + export function read(fd: string, buffer: NodeBuffer, offset: number, length: number, position: number, callback?: (err: Error, bytesRead: number, buffer: NodeBuffer) => void): void; export function readSync(fd: string, buffer: NodeBuffer, offset: number, length: number, position: number): any[]; - export function readFile(filename: string, options: { encoding?: string; flag?: string; }, callback: (err, data: any) => void ): void; - export function readFile(filename: string, callback: (err, data: NodeBuffer) => void ): void; + export function readFile(filename: string, options: { encoding?: string; flag?: string; }, callback: (err: Error, data: any) => void ): void; + export function readFile(filename: string, callback: (err: Error, data: NodeBuffer) => void ): void; export function readFileSync(filename: string): NodeBuffer; export function readFileSync(filename: string, options: { encoding?: string; flag?: string; }): any; - export function writeFile(filename: string, data: any, callback?: (err) => void): void; - export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err) => void): void; + export function writeFile(filename: string, data: any, callback?: (err: Error) => void): void; + export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: Error) => void): void; export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; - export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err) => void): void; - export function appendFile(filename: string, data: any, callback?: (err) => void): void; + export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: Error) => void): void; + export function appendFile(filename: string, data: any, callback?: (err: Error) => void): void; export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; export function watchFile(filename: string, listener: { curr: Stats; prev: Stats; }): void; export function watchFile(filename: string, options: { persistent?: boolean; interval?: number; }, listener: { curr: Stats; prev: Stats; }): void; @@ -808,7 +808,7 @@ declare module "fs" { declare module "path" { export function normalize(p: string): string; export function join(...paths: any[]): string; - export function resolve(to: string); + export function resolve(to: string): string; export function resolve(from: string, to: string): string; export function resolve(from: string, from2: string, to: string): string; export function resolve(from: string, from2: string, from3: string, to: string): string; @@ -975,7 +975,7 @@ declare module "crypto" { } export function getDiffieHellman(group_name: string): DiffieHellman; export function pbkdf2(password: string, salt: string, iterations: number, keylen: number, callback: (err: Error, derivedKey: string) => any): void; - export function randomBytes(size: number, callback?: (err: Error, buf: NodeBuffer) =>void ); + export function randomBytes(size: number, callback?: (err: Error, buf: NodeBuffer) =>void ): void; } declare module "stream" { @@ -1083,4 +1083,4 @@ declare module "domain" { export function bind(cb: (er: Error, data: any) =>any): any; export function intercept(cb: (data: any) => any): any; export function dispose(): void; -} +} \ No newline at end of file From b88f66b4a7375ea4a6fa896df62ce2d645d94a48 Mon Sep 17 00:00:00 2001 From: Brian Kotek Date: Thu, 5 Sep 2013 00:58:21 -0400 Subject: [PATCH 455/756] Update Sencha Touch definition to TypeScript 0.9.1 --- sencha_touch/SenchaTouch.d.ts | 15348 ++++++++++++++++++++------------ 1 file changed, 9737 insertions(+), 5611 deletions(-) diff --git a/sencha_touch/SenchaTouch.d.ts b/sencha_touch/SenchaTouch.d.ts index 54d79d3dcd..b2865706dd 100644 --- a/sencha_touch/SenchaTouch.d.ts +++ b/sencha_touch/SenchaTouch.d.ts @@ -14,6 +14,7 @@ declare module Ext { /** [Method] Creates and returns an instance of whatever this manager manages based on the supplied type and config object * @param config Object The config object. * @param defaultType String If no type is discovered in the config object, we fall back to this type. + * @returns Object The instance of whatever this manager is managing. */ create?( config?:any, defaultType?:string ): any; /** [Method] Executes the specified function once for each item in the collection @@ -23,12 +24,16 @@ declare module Ext { each?( fn?:any, scope?:any ): void; /** [Method] Returns an item by id * @param id String The id of the item. + * @returns Object The item, undefined if not found. */ get?( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ getCount?(): number; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up. + * @returns Boolean Whether the type is registered. */ isRegistered?( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -66,17 +71,29 @@ declare module Ext { left?: any; /** [Config Option] (Number/String) */ right?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns Number + */ getBottom?(): number; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of height */ + /** [Method] Returns the value of height + * @returns String + */ getHeight?(): string; - /** [Method] Returns the value of left */ + /** [Method] Returns the value of left + * @returns Number + */ getLeft?(): number; - /** [Method] Returns the value of right */ + /** [Method] Returns the value of right + * @returns Number + */ getRight?(): number; /** [Method] Sets the value of baseCls * @param baseCls String @@ -120,16 +137,14 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -141,9 +156,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -151,24 +164,22 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object */ static clearListeners(): void; /** [Method] */ @@ -176,71 +187,111 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of async */ + /** [Method] Returns the value of async + * @returns Boolean + */ static getAsync(): boolean; - /** [Method] Returns the value of autoAbort */ + /** [Method] Returns the value of autoAbort + * @returns Boolean + */ static getAutoAbort(): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Returns the value of defaultHeaders */ + /** [Method] Returns the value of defaultHeaders + * @returns Object + */ static getDefaultHeaders(): any; - /** [Method] Returns the value of defaultPostHeader */ + /** [Method] Returns the value of defaultPostHeader + * @returns String + */ static getDefaultPostHeader(): string; - /** [Method] Returns the value of defaultXhrHeader */ + /** [Method] Returns the value of defaultXhrHeader + * @returns String + */ static getDefaultXhrHeader(): string; - /** [Method] Returns the value of disableCaching */ + /** [Method] Returns the value of disableCaching + * @returns Boolean + */ static getDisableCaching(): boolean; - /** [Method] Returns the value of disableCachingParam */ + /** [Method] Returns the value of disableCachingParam + * @returns String + */ static getDisableCachingParam(): string; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ static getExtraParams(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns String + */ static getMethod(): string; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ static getPassword(): string; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ static getTimeout(): number; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ static getUrl(): string; - /** [Method] Returns the value of useDefaultHeader */ + /** [Method] Returns the value of useDefaultHeader + * @returns Boolean + */ static getUseDefaultHeader(): boolean; - /** [Method] Returns the value of useDefaultXhrHeader */ + /** [Method] Returns the value of useDefaultXhrHeader + * @returns Boolean + */ static getUseDefaultXhrHeader(): boolean; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ static getUsername(): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Determines whether this object has a request outstanding * @param request Object The request to check. + * @returns Boolean True if there is an outstanding request. */ static isLoading( request?:any ): boolean; /** [Method] Alias for addManagedListener @@ -250,18 +301,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -269,33 +316,31 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Checks if the response status was successful * @param status Number The status code. * @param xhr Object + * @returns Object An object containing success/status state. */ static parseStatus( status?:number, xhr?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -304,16 +349,14 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -321,20 +364,17 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Sends an HTTP request to a remote server * @param options Object An object which may contain the following properties: (The options object may also contain any other property which might be needed to perform post-processing in a callback because it is passed to callback functions.) + * @returns Object/null The request object. This may be used to cancel the request. */ static request( options?:any ): any; /** [Method] Resumes firing events see suspendEvents @@ -352,9 +392,7 @@ declare module Ext { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of defaultHeaders * @param defaultHeaders Object */ @@ -390,6 +428,7 @@ declare module Ext { /** [Method] Sets various options such as the url params for the request * @param options Object The initial options. * @param scope Object The scope to execute in. + * @returns Object The params for the request. */ static setOptions( options?:any, scope?:any ): any; /** [Method] Sets the value of password @@ -416,7 +455,9 @@ declare module Ext { * @param username String */ static setUsername( username?:string ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends the firing of all events */ static suspendEvents(): void; @@ -427,35 +468,28 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Uploads a form using a hidden iframe * @param form String/HTMLElement/Ext.Element The form to upload. * @param url String The url to post to. * @param params String Any extra parameters to pass. * @param options Object The initial options. */ - static upload( form?:any, url?:any, params?:any, options?:any ): any; - static upload( form?:string, url?:string, params?:string, options?:any ): void; - static upload( form?:HTMLElement, url?:string, params?:string, options?:any ): void; - static upload( form?:Ext.IElement, url?:string, params?:string, options?:any ): void; + static upload( form?:any, url?:string, params?:string, options?:any ): void; } } declare module Ext { @@ -464,28 +498,30 @@ declare module Ext { export class Anim { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param el Object * @param runConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( el?:any, runConfig?:any ): any; /** [Method] Used to run an animation on a specific element @@ -493,10 +529,10 @@ declare module Ext { * @param anim String The animation type, defined in Ext.anims. * @param config Object The config object for the animation. */ - static run( el?:any, anim?:any, config?:any ): any; - static run( el?:Ext.IElement, anim?:string, config?:any ): void; - static run( el?:HTMLElement, anim?:string, config?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + static run( el?:any, anim?:string, config?:any ): void; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -506,27 +542,29 @@ declare module Ext { export class AnimationQueue { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] @@ -535,7 +573,9 @@ declare module Ext { * @param args Object */ static start( fn?:any, scope?:any, args?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] * @param fn Object @@ -569,23 +609,41 @@ declare module Ext.app { url?: string; /** [Method] Starts execution of this Action by calling each of the beforeFilters in turn if any are specified before calling t */ execute?(): void; - /** [Method] Returns the value of action */ + /** [Method] Returns the value of action + * @returns String + */ getAction?(): string; - /** [Method] Returns the value of application */ + /** [Method] Returns the value of application + * @returns Ext.app.Application + */ getApplication?(): Ext.app.IApplication; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Array + */ getArgs?(): any[]; - /** [Method] Returns the value of beforeFilters */ + /** [Method] Returns the value of beforeFilters + * @returns Array + */ getBeforeFilters?(): any[]; - /** [Method] Returns the value of controller */ + /** [Method] Returns the value of controller + * @returns Ext.app.Controller + */ getController?(): Ext.app.IController; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns Object + */ getTitle?(): any; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; /** [Method] Resumes the execution of this Action or starts it if it had not been started already */ resume?(): void; @@ -668,33 +726,48 @@ declare module Ext.app { * @param addToHistory Boolean Sets the browser's url to the action's url. */ dispatch?( action?:Ext.app.IAction, addToHistory?:boolean ): void; - /** [Method] Returns the value of appFolder */ + /** [Method] Returns the value of appFolder + * @returns String + */ getAppFolder?(): string; /** [Method] Returns the Controller instance for the given controller name * @param name String The name of the Controller. * @param profileName String Optional profile name. If passed, this is the same as calling getController('profileName.controllerName'). + * @returns Ext.app.Controller controller instance or undefined. */ getController?( name?:string, profileName?:string ): Ext.app.IController; - /** [Method] Returns the value of controllers */ + /** [Method] Returns the value of controllers + * @returns Array + */ getControllers?(): any[]; - /** [Method] Returns the value of currentProfile */ + /** [Method] Returns the value of currentProfile + * @returns Ext.app.Profile + */ getCurrentProfile?(): Ext.app.IProfile; - /** [Method] Returns the value of history */ + /** [Method] Returns the value of history + * @returns Ext.app.History + */ getHistory?(): Ext.app.IHistory; - /** [Method] Returns the value of launch */ + /** [Method] Returns the value of launch + * @returns Function + */ getLaunch?(): any; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of profiles */ + /** [Method] Returns the value of profiles + * @returns Array + */ getProfiles?(): any[]; - /** [Method] Returns the value of router */ + /** [Method] Returns the value of router + * @returns Ext.app.Router + */ getRouter?(): Ext.app.IRouter; /** [Method] Redirects the browser to the given url * @param url String/Ext.data.Model The String url to redirect to. */ - redirectTo?( url?:any ): any; - redirectTo?( url?:string ): void; - redirectTo?( url?:Ext.data.IModel ): void; + redirectTo?( url?:any ): void; /** [Method] Sets the value of appFolder * @param appFolder String */ @@ -757,16 +830,14 @@ declare module Ext.app { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -778,9 +849,7 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -788,9 +857,7 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -798,52 +865,75 @@ declare module Ext.app { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of application */ + /** [Method] Returns the value of application + * @returns Ext.app.Application + */ getApplication?(): Ext.app.IApplication; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of control */ + /** [Method] Returns the value of control + * @returns Object + */ getControl?(): any; /** [Method] Returns a reference to another Controller * @param controllerName Object * @param profile Object + * @returns Object */ getController?( controllerName?:any, profile?:any ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Returns a reference to a Model * @param modelName Object + * @returns Object */ getModel?( modelName?:any ): any; - /** [Method] Returns the value of models */ + /** [Method] Returns the value of models + * @returns String[] + */ getModels?(): string[]; - /** [Method] Returns the value of refs */ + /** [Method] Returns the value of refs + * @returns Object + */ getRefs?(): any; - /** [Method] Returns the value of routes */ + /** [Method] Returns the value of routes + * @returns Object + */ getRoutes?(): any; - /** [Method] Returns the value of stores */ + /** [Method] Returns the value of stores + * @returns String[] + */ getStores?(): string[]; - /** [Method] Returns the value of views */ + /** [Method] Returns the value of views + * @returns Array + */ getViews?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -853,18 +943,14 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -872,32 +958,30 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Convenient way to redirect to a new url * @param place Object + * @returns Object */ redirectTo?( place?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -906,16 +990,14 @@ declare module Ext.app { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -923,18 +1005,14 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -950,9 +1028,7 @@ declare module Ext.app { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of control * @param control Object */ @@ -990,25 +1066,21 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.app { @@ -1030,16 +1102,14 @@ declare module Ext.app { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -1051,9 +1121,7 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -1061,9 +1129,7 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Navigate to the previous active action */ back?(): void; /** [Method] Removes all listeners for this object */ @@ -1073,33 +1139,44 @@ declare module Ext.app { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of actions */ + /** [Method] Returns the value of actions + * @returns Array + */ getActions?(): any[]; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of token */ + /** [Method] Returns the value of token + * @returns String + */ getToken?(): string; - /** [Method] Returns the value of updateUrl */ + /** [Method] Returns the value of updateUrl + * @returns Boolean + */ getUpdateUrl?(): boolean; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -1109,18 +1186,14 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -1128,28 +1201,25 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -1158,16 +1228,14 @@ declare module Ext.app { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -1175,18 +1243,14 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -1198,9 +1262,7 @@ declare module Ext.app { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -1222,25 +1284,21 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.app { @@ -1265,16 +1323,14 @@ declare module Ext.app { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -1286,9 +1342,7 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -1296,9 +1350,7 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -1306,44 +1358,65 @@ declare module Ext.app { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of application */ + /** [Method] Returns the value of application + * @returns Ext.app.Application + */ getApplication?(): Ext.app.IApplication; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of controllers */ + /** [Method] Returns the value of controllers + * @returns Array + */ getControllers?(): any[]; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of models */ + /** [Method] Returns the value of models + * @returns Array + */ getModels?(): any[]; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of namespace */ + /** [Method] Returns the value of namespace + * @returns String + */ getNamespace?(): string; - /** [Method] Returns the value of stores */ + /** [Method] Returns the value of stores + * @returns Array + */ getStores?(): any[]; - /** [Method] Returns the value of views */ + /** [Method] Returns the value of views + * @returns Array + */ getViews?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; - /** [Method] Determines whether or not this Profile is active on the device isActive is executed on */ + /** [Method] Determines whether or not this Profile is active on the device isActive is executed on + * @returns Boolean True if this Profile should be activated on the device it is running on, false otherwise + */ isActive?(): boolean; /** [Method] The launch function is called by the Application if this Profile s isActive function returned true */ launch?(): void; @@ -1354,18 +1427,14 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -1373,28 +1442,25 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -1403,16 +1469,14 @@ declare module Ext.app { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -1420,18 +1484,14 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -1443,9 +1503,7 @@ declare module Ext.app { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of controllers * @param controllers Array */ @@ -1483,25 +1541,21 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.app { @@ -1516,16 +1570,25 @@ declare module Ext.app { url?: string; /** [Property] (Object) */ paramsInMatchString?: any; - /** [Method] Returns the value of action */ + /** [Method] Returns the value of action + * @returns String + */ getAction?(): string; - /** [Method] Returns the value of conditions */ + /** [Method] Returns the value of conditions + * @returns Object + */ getConditions?(): any; - /** [Method] Returns the value of controller */ + /** [Method] Returns the value of controller + * @returns String + */ getController?(): string; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; /** [Method] Attempts to recognize a given url string and return controller action pair for it * @param url String The url to recognize. + * @returns Object/Boolean The matched data, or false if no match. */ recognize?( url?:string ): any; /** [Method] Sets the value of action @@ -1561,12 +1624,17 @@ declare module Ext.app { * @param fn Function The fn to call */ draw?( fn?:any ): void; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ getDefaults?(): any; - /** [Method] Returns the value of routes */ + /** [Method] Returns the value of routes + * @returns Array + */ getRoutes?(): any[]; /** [Method] Recognizes a url string connected to the Router return the controller action pair plus any additional config associa * @param url String The url to recognize. + * @returns Object/undefined If the url was recognized, the controller and action to call, else undefined. */ recognize?( url?:string ): any; /** [Method] Sets the value of defaults @@ -1585,20 +1653,24 @@ declare module Ext { export class Array { /** [Method] Filter through an array and remove empty item as defined in Ext isEmpty * @param array Array + * @returns Array results */ static clean( array?:any[] ): any[]; /** [Method] Clone a flat array without referencing the previous one * @param array Array The array + * @returns Array The clone array */ static clone( array?:any[] ): any[]; /** [Method] Checks whether or not the given array contains the specified item * @param array Array The array to check. * @param item Object The item to look for. + * @returns Boolean true if the array contains the item, false otherwise. */ static contains( array?:any[], item?:any ): boolean; /** [Method] Perform a set difference A B by subtracting all items in array B from array A * @param arrayA Array * @param arrayB Array + * @returns Array difference */ static difference( arrayA?:any[], arrayB?:any[] ): any[]; /** [Method] Iterates an array or an iterable value and invoke the given callback function for each item @@ -1606,28 +1678,33 @@ declare module Ext { * @param fn Function The callback function. If it returns false, the iteration stops and this method returns the current index. * @param scope Object The scope (this reference) in which the specified function is executed. * @param reverse Boolean Reverse the iteration order (loop from the end to the beginning). + * @returns Boolean See description for the fn parameter. */ static each( iterable?:any, fn?:any, scope?:any, reverse?:boolean ): boolean; /** [Method] Removes items from an array * @param array Array The Array on which to replace. * @param index Number The index in the array at which to operate. * @param removeCount Number The number of items to remove at index. + * @returns Array The array passed. */ static erase( array?:any[], index?:number, removeCount?:number ): any[]; /** [Method] Executes the specified function for each array element until the function returns a falsy value * @param array Array * @param fn Function Callback function for each item. * @param scope Object Callback function scope. + * @returns Boolean true if no false value is returned by the callback function. */ static every( array?:any[], fn?:any, scope?:any ): boolean; /** [Method] Creates a new array with all of the elements of this array for which the provided filtering function returns true * @param array Array * @param fn Function Callback function for each item. * @param scope Object Callback function scope. + * @returns Array results */ static filter( array?:any[], fn?:any, scope?:any ): any[]; /** [Method] Recursively flattens into 1 d Array * @param array Array The array to flatten + * @returns Array The 1-d array. */ static flatten( array?:any[] ): any[]; /** [Method] Iterates an array and invoke the given callback function for each item @@ -1639,6 +1716,7 @@ declare module Ext { /** [Method] Converts a value to an array if it s not already an array returns An empty array if given value is undefined or n * @param value Object The value to convert to an array if it's not already is an array. * @param newReference Boolean true to clone the given array and return a new reference if necessary. + * @returns Array array */ static from( value?:any, newReference?:boolean ): any[]; /** [Method] Push an item into the array only if the array doesn t contain it yet @@ -1650,60 +1728,64 @@ declare module Ext { * @param array Array The array to check. * @param item Object The item to look for. * @param from Number The index at which to begin the search. + * @returns Number The index of item in the array (or -1 if it is not found). */ static indexOf( array?:any[], item?:any, from?:number ): number; /** [Method] Inserts items in to an array * @param array Array The Array on which to replace. * @param index Number The index in the array at which to operate. * @param items Array The array of items to insert at index. + * @returns Array The array passed. */ static insert( array?:any[], index?:number, items?:any[] ): any[]; /** [Method] Merge multiple arrays into one with unique items that exist in all of the arrays * @param array1 Array * @param array2 Array * @param etc Array + * @returns Array intersect */ static intersect( array1?:any[], array2?:any[], etc?:any[] ): any[]; /** [Method] Creates a new array with the results of calling a provided function on every element in this array * @param array Array * @param fn Function Callback function for each item. * @param scope Object Callback function scope. + * @returns Array results */ static map( array?:any[], fn?:any, scope?:any ): any[]; /** [Method] Returns the maximum value in the Array * @param array Array/NodeList The Array from which to select the maximum value. * @param comparisonFn Function a function to perform the comparison which determines maximization. If omitted the ">" operator will be used. Note: gt = 1; eq = 0; lt = -1 + * @returns Object maxValue The maximum value */ static max( array?:any, comparisonFn?:any ): any; - static max( array?:any[], comparisonFn?:any ): any; - static max( array?:NodeList, comparisonFn?:any ): any; /** [Method] Calculates the mean of all items in the array * @param array Array The Array to calculate the mean value of. + * @returns Number The mean. */ static mean( array?:any[] ): number; /** [Method] Merge multiple arrays into one with unique items * @param array1 Array * @param array2 Array * @param etc Array + * @returns Array merged */ static merge( array1?:any[], array2?:any[], etc?:any[] ): any[]; /** [Method] Returns the minimum value in the Array * @param array Array/NodeList The Array from which to select the minimum value. * @param comparisonFn Function a function to perform the comparison which determines minimization. If omitted the "<" operator will be used. Note: gt = 1; eq = 0; lt = -1 + * @returns Object minValue The minimum value. */ static min( array?:any, comparisonFn?:any ): any; - static min( array?:any[], comparisonFn?:any ): any; - static min( array?:NodeList, comparisonFn?:any ): any; /** [Method] Plucks the value of a property from each item in the Array * @param array Array/NodeList The Array of items to pluck the value from. * @param propertyName String The property name to pluck from each element. + * @returns Array The value from each item in the Array. */ - static pluck( array?:any, propertyName?:any ): any; - static pluck( array?:any[], propertyName?:string ): any[]; - static pluck( array?:NodeList, propertyName?:string ): any[]; + static pluck( array?:any, propertyName?:string ): any[]; /** [Method] Removes the specified item from the array if it exists * @param array Array The array. * @param item Object The item to remove. + * @returns Array The passed array itself. */ static remove( array?:any[], item?:any ): any[]; /** [Method] Replaces items in an array @@ -1711,49 +1793,58 @@ declare module Ext { * @param index Number The index in the array at which to operate. * @param removeCount Number The number of items to remove at index (can be 0). * @param insert Array An array of items to insert at index. + * @returns Array The array passed. */ static replace( array?:any[], index?:number, removeCount?:number, insert?:any[] ): any[]; /** [Method] Returns a shallow copy of a part of an array * @param array Array The array (or arguments object). * @param begin Number The index at which to begin. Negative values are offsets from the end of the array. * @param end Number The index at which to end. The copied items do not include end. Negative values are offsets from the end of the array. If end is omitted, all items up to the end of the array are copied. + * @returns Array The copied piece of the array. */ static slice( array?:any[], begin?:number, end?:number ): any[]; /** [Method] Executes the specified function for each array element until the function returns a truthy value * @param array Array * @param fn Function Callback function for each item. * @param scope Object Callback function scope. + * @returns Boolean true if the callback function returns a truthy value. */ static some( array?:any[], fn?:any, scope?:any ): boolean; /** [Method] Sorts the elements of an Array * @param array Array The array to sort. * @param sortFn Function The comparison function. + * @returns Array The sorted array. */ static sort( array?:any[], sortFn?:any ): any[]; /** [Method] Replaces items in an array * @param array Array The Array on which to replace. * @param index Number The index in the array at which to operate. * @param removeCount Number The number of items to remove at index (can be 0). + * @returns Array An array containing the removed items. */ static splice( array?:any[], index?:number, removeCount?:number ): any[]; /** [Method] Calculates the sum of all items in the given array * @param array Array The Array to calculate the sum value of. + * @returns Number The sum. */ static sum( array?:any[] ): number; /** [Method] Converts any iterable numeric indices and a length property into a true array * @param iterable Object the iterable object to be turned into a true Array. * @param start Number a zero-based index that specifies the start of extraction. * @param end Number a zero-based index that specifies the end of extraction. + * @returns Array */ static toArray( iterable?:any, start?:number, end?:number ): any[]; /** [Method] Merge multiple arrays into one with unique items * @param array1 Array * @param array2 Array * @param etc Array + * @returns Array merged */ static union( array1?:any[], array2?:any[], etc?:any[] ): any[]; /** [Method] Returns a new array with unique items * @param array Array + * @returns Array results */ static unique( array?:any[] ): any[]; } @@ -1764,9 +1855,13 @@ declare module Ext { cls?: any; /** [Config Option] (String) */ url?: string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; /** [Method] Sets the value of cls * @param cls String @@ -1784,27 +1879,29 @@ declare module Ext { self?: Ext.IClass; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ callOverridden?( args?:any ): any; - callOverridden?( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ callParent?( args?:any ): any; - callParent?( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ callSuper?( args?:any ): any; - callSuper?( args?:any[] ): any; /** [Method] */ destroy?(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ getInitialConfig?( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ initConfig?( instanceConfig?:any ): any; } @@ -1815,23 +1912,29 @@ declare module Ext { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] * @param args Object */ static callParent( args?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter * @param origin String/Object The original method name */ static createAlias( alias?:any, origin?:any ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns any className + */ static getName(): any; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -1858,34 +1961,39 @@ declare module Ext { export class Browser { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] A hybrid property can be either accessed as a method call for example if Ext browser is IE * @param value String The OS name to check. + * @returns Boolean */ static is( value?:string ): boolean; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -1923,33 +2031,61 @@ declare module Ext { text?: string; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of autoEvent */ + /** [Method] Returns the value of autoEvent + * @returns String + */ getAutoEvent?(): string; - /** [Method] Returns the value of badgeCls */ + /** [Method] Returns the value of badgeCls + * @returns String + */ getBadgeCls?(): string; - /** [Method] Returns the value of badgeText */ + /** [Method] Returns the value of badgeText + * @returns String + */ getBadgeText?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of handler */ + /** [Method] Returns the value of handler + * @returns Function + */ getHandler?(): any; - /** [Method] Returns the value of icon */ + /** [Method] Returns the value of icon + * @returns String + */ getIcon?(): string; - /** [Method] Returns the value of iconAlign */ + /** [Method] Returns the value of iconAlign + * @returns String + */ getIconAlign?(): string; - /** [Method] Returns the value of iconCls */ + /** [Method] Returns the value of iconCls + * @returns String + */ getIconCls?(): string; - /** [Method] Returns the value of labelCls */ + /** [Method] Returns the value of labelCls + * @returns String + */ getLabelCls?(): string; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; - /** [Method] Returns the value of pressedDelay */ + /** [Method] Returns the value of pressedDelay + * @returns Number/Boolean + */ getPressedDelay?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; - /** [Method] Returns the value of text */ + /** [Method] Returns the value of text + * @returns String + */ getText?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -2004,9 +2140,7 @@ declare module Ext { /** [Method] Sets the value of pressedDelay * @param pressedDelay Number/Boolean */ - setPressedDelay?( pressedDelay?:any ): any; - setPressedDelay?( pressedDelay?:number ): void; - setPressedDelay?( pressedDelay?:boolean ): void; + setPressedDelay?( pressedDelay?:any ): void; /** [Method] Sets the value of scope * @param scope Object */ @@ -2033,35 +2167,65 @@ declare module Ext.carousel { ui?: string; /** [Method] */ destroy?(): void; - /** [Method] Returns the index of the currently active card */ + /** [Method] Returns the index of the currently active card + * @returns Number The index of the currently active card. + */ getActiveIndex?(): number; - /** [Method] Returns the value of animation */ + /** [Method] Returns the value of animation + * @returns Object + */ getAnimation?(): any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bufferSize */ + /** [Method] Returns the value of bufferSize + * @returns Number + */ getBufferSize?(): number; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of directionLock */ + /** [Method] Returns the value of directionLock + * @returns Boolean + */ getDirectionLock?(): boolean; - /** [Method] Returns the value of indicator */ + /** [Method] Returns the value of indicator + * @returns any + */ getIndicator?(): any; - /** [Method] Returns the value of itemConfig */ + /** [Method] Returns the value of itemConfig + * @returns Object + */ getItemConfig?(): any; - /** [Method] Returns the value of itemLength */ + /** [Method] Returns the value of itemLength + * @returns Object + */ getItemLength?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns true when direction is horizontal */ + /** [Method] Returns true when direction is horizontal + * @returns Boolean + */ isHorizontal?(): boolean; - /** [Method] Returns true when direction is vertical */ + /** [Method] Returns true when direction is vertical + * @returns Boolean + */ isVertical?(): boolean; - /** [Method] Switches to the next card */ + /** [Method] Switches to the next card + * @returns Ext.carousel.Carousel this + */ next?(): Ext.carousel.ICarousel; - /** [Method] Switches to the previous card */ + /** [Method] Switches to the previous card + * @returns Ext.carousel.Carousel this + */ prev?(): Ext.carousel.ICarousel; - /** [Method] Switches to the previous card */ + /** [Method] Switches to the previous card + * @returns Ext.carousel.Carousel this + */ previous?(): Ext.carousel.ICarousel; /** [Method] Sets the value of animation * @param animation Object @@ -2113,35 +2277,65 @@ declare module Ext { ui?: string; /** [Method] */ destroy?(): void; - /** [Method] Returns the index of the currently active card */ + /** [Method] Returns the index of the currently active card + * @returns Number The index of the currently active card. + */ getActiveIndex?(): number; - /** [Method] Returns the value of animation */ + /** [Method] Returns the value of animation + * @returns Object + */ getAnimation?(): any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bufferSize */ + /** [Method] Returns the value of bufferSize + * @returns Number + */ getBufferSize?(): number; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of directionLock */ + /** [Method] Returns the value of directionLock + * @returns Boolean + */ getDirectionLock?(): boolean; - /** [Method] Returns the value of indicator */ + /** [Method] Returns the value of indicator + * @returns any + */ getIndicator?(): any; - /** [Method] Returns the value of itemConfig */ + /** [Method] Returns the value of itemConfig + * @returns Object + */ getItemConfig?(): any; - /** [Method] Returns the value of itemLength */ + /** [Method] Returns the value of itemLength + * @returns Object + */ getItemLength?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns true when direction is horizontal */ + /** [Method] Returns true when direction is horizontal + * @returns Boolean + */ isHorizontal?(): boolean; - /** [Method] Returns true when direction is vertical */ + /** [Method] Returns true when direction is vertical + * @returns Boolean + */ isVertical?(): boolean; - /** [Method] Switches to the next card */ + /** [Method] Switches to the next card + * @returns Ext.carousel.Carousel this + */ next?(): Ext.carousel.ICarousel; - /** [Method] Switches to the previous card */ + /** [Method] Switches to the previous card + * @returns Ext.carousel.Carousel this + */ prev?(): Ext.carousel.ICarousel; - /** [Method] Switches to the previous card */ + /** [Method] Switches to the previous card + * @returns Ext.carousel.Carousel this + */ previous?(): Ext.carousel.ICarousel; /** [Method] Sets the value of animation * @param animation Object @@ -2187,9 +2381,13 @@ declare module Ext.carousel { baseCls?: string; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -2205,11 +2403,17 @@ declare module Ext.carousel { export interface IInfinite extends Ext.carousel.ICarousel { /** [Config Option] (Boolean) */ indicator?: boolean; - /** [Method] Returns the value of indicator */ + /** [Method] Returns the value of indicator + * @returns Object + */ getIndicator?(): any; - /** [Method] Returns the value of innerItemConfig */ + /** [Method] Returns the value of innerItemConfig + * @returns Object + */ getInnerItemConfig?(): any; - /** [Method] Returns the value of maxItemIndex */ + /** [Method] Returns the value of maxItemIndex + * @returns Object + */ getMaxItemIndex?(): any; /** [Method] Sets the value of indicator * @param indicator Object @@ -2231,11 +2435,17 @@ declare module Ext.carousel { baseCls?: string; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of translatable */ + /** [Method] Returns the value of translatable + * @returns Boolean + */ getTranslatable?(): boolean; /** [Method] Sets the value of baseCls * @param baseCls String @@ -2285,43 +2495,70 @@ declare module Ext.chart { bindStore?( store?:Ext.data.IStore ): void; /** [Method] Cancel a scheduled layout */ cancelLayout?(): void; - /** [Method] Returns the value of axes */ + /** [Method] Returns the value of axes + * @returns Ext.chart.axis.Axis/Array/Object + */ getAxes?(): any; - /** [Method] Returns the value of background */ + /** [Method] Returns the value of background + * @returns Object + */ getBackground?(): any; - /** [Method] Returns the value of colors */ + /** [Method] Returns the value of colors + * @returns Boolean/Array + */ getColors?(): any; - /** [Method] Returns the value of highlightItem */ + /** [Method] Returns the value of highlightItem + * @returns Object + */ getHighlightItem?(): any; - /** [Method] Returns the value of innerPadding */ + /** [Method] Returns the value of innerPadding + * @returns Object + */ getInnerPadding?(): any; - /** [Method] Returns the value of insetPadding */ + /** [Method] Returns the value of insetPadding + * @returns Object|Number + */ getInsetPadding?(): any; - /** [Method] Returns the value of interactions */ + /** [Method] Returns the value of interactions + * @returns Array + */ getInteractions?(): any[]; /** [Method] Given an x y point relative to the chart find and return the first series item that matches that point * @param x Number * @param y Number + * @returns Object An object with series and item properties, or false if no item found. */ getItemForPoint?( x?:number, y?:number ): any; /** [Method] Given an x y point relative to the chart find and return all series items that match that point * @param x Number * @param y Number + * @returns Array An array of objects with series and item properties. */ getItemsForPoint?( x?:number, y?:number ): any[]; - /** [Method] Returns the value of legend */ + /** [Method] Returns the value of legend + * @returns Ext.chart.Legend/Object + */ getLegend?(): any; - /** [Method] Return the legend store that contains all the legend information */ + /** [Method] Return the legend store that contains all the legend information + * @returns Ext.data.Store + */ getLegendStore?(): Ext.data.IStore; - /** [Method] Returns the value of series */ + /** [Method] Returns the value of series + * @returns Ext.chart.series.Series/Array + */ getSeries?(): any; - /** [Method] Returns the value of shadow */ + /** [Method] Returns the value of shadow + * @returns Boolean/Object + */ getShadow?(): any; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.Store + */ getStore?(): Ext.data.IStore; /** [Method] Get a surface by the given id or create one if it doesn t exist * @param name Object * @param type Object + * @returns Ext.draw.Surface */ getSurface?( name?:any, type?:any ): Ext.draw.ISurface; /** [Method] Allows addition of behavior to the rendering phase */ @@ -2347,9 +2584,7 @@ declare module Ext.chart { /** [Method] Sets the value of colors * @param colors Boolean/Array */ - setColors?( colors?:any ): any; - setColors?( colors?:boolean ): void; - setColors?( colors?:any[] ): void; + setColors?( colors?:any ): void; /** [Method] Sets the value of highlightItem * @param highlightItem Object */ @@ -2373,9 +2608,7 @@ declare module Ext.chart { /** [Method] Sets the value of series * @param series Ext.chart.series.Series/Array */ - setSeries?( series?:any ): any; - setSeries?( series?:Ext.chart.series.ISeries ): void; - setSeries?( series?:any[] ): void; + setSeries?( series?:any ): void; /** [Method] Sets the value of shadow * @param shadow Boolean/Object */ @@ -2438,16 +2671,14 @@ declare module Ext.chart.axis { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -2459,9 +2690,7 @@ declare module Ext.chart.axis { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -2469,9 +2698,7 @@ declare module Ext.chart.axis { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -2479,78 +2706,128 @@ declare module Ext.chart.axis { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of background */ + /** [Method] Returns the value of background + * @returns Object + */ getBackground?(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of chart */ + /** [Method] Returns the value of chart + * @returns Ext.chart.AbstractChart + */ getChart?(): Ext.chart.IAbstractChart; /** [Method] Mapping data value into coordinate * @param value * * @param field String * @param idx Number * @param items Ext.util.MixedCollection + * @returns Number */ getCoordFor?( value?:any, field?:string, idx?:number, items?:Ext.util.IMixedCollection ): number; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Array + */ getFields?(): any[]; - /** [Method] Returns the value of grid */ + /** [Method] Returns the value of grid + * @returns Object + */ getGrid?(): any; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ getHidden?(): boolean; - /** [Method] Returns the value of increment */ + /** [Method] Returns the value of increment + * @returns Number + */ getIncrement?(): number; - /** [Method] Returns the value of label */ + /** [Method] Returns the value of label + * @returns Object + */ getLabel?(): any; - /** [Method] Returns the value of labelInSpan */ + /** [Method] Returns the value of labelInSpan + * @returns Boolean + */ getLabelInSpan?(): boolean; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object|Ext.chart.axis.layout.Layout + */ getLayout?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of maxZoom */ + /** [Method] Returns the value of maxZoom + * @returns Number + */ getMaxZoom?(): number; - /** [Method] Returns the value of maximum */ + /** [Method] Returns the value of maximum + * @returns Number + */ getMaximum?(): number; - /** [Method] Returns the value of minZoom */ + /** [Method] Returns the value of minZoom + * @returns Number + */ getMinZoom?(): number; - /** [Method] Returns the value of minimum */ + /** [Method] Returns the value of minimum + * @returns Number + */ getMinimum?(): number; - /** [Method] Returns the value of needHighPrecision */ + /** [Method] Returns the value of needHighPrecision + * @returns Boolean + */ getNeedHighPrecision?(): boolean; - /** [Method] Returns the value of position */ + /** [Method] Returns the value of position + * @returns String + */ getPosition?(): string; - /** [Method] Get the range derived from all the bound series */ + /** [Method] Get the range derived from all the bound series + * @returns Array + */ getRange?(): any[]; - /** [Method] Returns the value of renderer */ + /** [Method] Returns the value of renderer + * @returns Function + */ getRenderer?(): any; - /** [Method] Returns the value of segmenter */ + /** [Method] Returns the value of segmenter + * @returns Object|Ext.chart.axis.segmenter.Segmenter + */ getSegmenter?(): any; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns Object + */ getStyle?(): any; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String|Object + */ getTitle?(): any; - /** [Method] Returns the value of titleMargin */ + /** [Method] Returns the value of titleMargin + * @returns Number + */ getTitleMargin?(): number; - /** [Method] Returns the value of visibleRange */ + /** [Method] Returns the value of visibleRange + * @returns Array + */ getVisibleRange?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -2560,18 +2837,14 @@ declare module Ext.chart.axis { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -2579,30 +2852,27 @@ declare module Ext.chart.axis { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Invoked when data has changed */ processData?(): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -2611,16 +2881,14 @@ declare module Ext.chart.axis { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -2628,18 +2896,14 @@ declare module Ext.chart.axis { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Invokes renderFrame on this axis s surface s */ renderFrame?(): void; /** [Method] Resumes firing events see suspendEvents @@ -2653,9 +2917,7 @@ declare module Ext.chart.axis { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of chart * @param chart Ext.chart.AbstractChart */ @@ -2718,6 +2980,7 @@ declare module Ext.chart.axis { setPosition?( position?:string ): void; /** [Method] Sets the value of renderer * @param renderer Function + * @returns String The label to display. */ setRenderer?( renderer?:any ): string; /** [Method] Sets the value of segmenter @@ -2749,25 +3012,21 @@ declare module Ext.chart.axis { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.chart.axis { @@ -2776,9 +3035,13 @@ declare module Ext.chart.axis { layout?: any; /** [Config Option] (Object|Ext.chart.axis.segmenter.Segmenter) */ segmenter?: any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns String + */ getLayout?(): string; - /** [Method] Returns the value of segmenter */ + /** [Method] Returns the value of segmenter + * @returns String + */ getSegmenter?(): string; /** [Method] Sets the value of layout * @param layout String @@ -2796,9 +3059,13 @@ declare module Ext.chart.axis.layout { } declare module Ext.chart.axis.layout { export interface IContinuous extends Ext.chart.axis.layout.ILayout { - /** [Method] Returns the value of adjustMaximumByMajorUnit */ + /** [Method] Returns the value of adjustMaximumByMajorUnit + * @returns Boolean + */ getAdjustMaximumByMajorUnit?(): boolean; - /** [Method] Returns the value of adjustMinimumByMajorUnit */ + /** [Method] Returns the value of adjustMinimumByMajorUnit + * @returns Boolean + */ getAdjustMinimumByMajorUnit?(): boolean; /** [Method] Sets the value of adjustMaximumByMajorUnit * @param adjustMaximumByMajorUnit Boolean @@ -2821,6 +3088,7 @@ declare module Ext.chart.axis.layout { export interface IDiscrete extends Ext.chart.axis.layout.ILayout { /** [Method] Calculates the position of tick marks for the axis * @param context Object + * @returns * */ calculateLayout?( context?:any ): any; /** [Method] Calculates the position of major ticks for the axis @@ -2851,6 +3119,7 @@ declare module Ext.chart.axis.layout { axis?: Ext.chart.axis.IAxis; /** [Method] Calculates the position of tick marks for the axis * @param context Object + * @returns * */ calculateLayout?( context?:any ): any; /** [Method] Calculates the position of major ticks for the axis @@ -2861,7 +3130,9 @@ declare module Ext.chart.axis.layout { * @param context Object */ calculateMinorTicks?( context?:any ): void; - /** [Method] Returns the value of axis */ + /** [Method] Returns the value of axis + * @returns Ext.chart.axis.Axis + */ getAxis?(): Ext.chart.axis.IAxis; /** [Method] Processes the data of the series bound to the axis * @param series Object The bound series. @@ -2893,11 +3164,17 @@ declare module Ext.chart.axis { layout?: any; /** [Config Option] (Object|Ext.chart.axis.segmenter.Segmenter) */ segmenter?: any; - /** [Method] Returns the value of aggregator */ + /** [Method] Returns the value of aggregator + * @returns String + */ getAggregator?(): string; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns String + */ getLayout?(): string; - /** [Method] Returns the value of segmenter */ + /** [Method] Returns the value of segmenter + * @returns String + */ getSegmenter?(): string; /** [Method] Sets the value of aggregator * @param aggregator String @@ -2925,12 +3202,14 @@ declare module Ext.chart.axis.segmenter { * @param value Object * @param step Object * @param unit Object + * @returns * Aligned value. */ align?( value?:any, step?:any, unit?:any ): any; /** [Method] Returns the difference between the min and max value based on the given unit scale * @param min Object * @param max Object * @param unit Object + * @returns Number The number of units between min and max. It is the minimum n that min + n * unit >= max. */ diff?( min?:any, max?:any, unit?:any ): number; /** [Method] Given a start point and estimated step size of a range determine the preferred step size @@ -2938,11 +3217,13 @@ declare module Ext.chart.axis.segmenter { * @param estStepSize Object * @param minIdx Object * @param data Object + * @returns Object Return the step size by an object of step x unit. */ preferredStep?( min?:any, estStepSize?:any, minIdx?:any, data?:any ): any; /** [Method] This method formats the value * @param value Object * @param context Object + * @returns String */ renderer?( value?:any, context?:any ): string; } @@ -2959,22 +3240,26 @@ declare module Ext.chart.axis.segmenter { * @param value Object * @param step Object * @param unit Object + * @returns * Aligned value. */ align?( value?:any, step?:any, unit?:any ): any; /** [Method] Returns the difference between the min and max value based on the given unit scale * @param min Object * @param max Object * @param unit Object + * @returns Number The number of units between min and max. It is the minimum n that min + n * unit >= max. */ diff?( min?:any, max?:any, unit?:any ): number; /** [Method] Given a start point and estimated step size of a range determine the preferred step size * @param min Object * @param estStepSize Object + * @returns Object Return the step size by an object of step x unit. */ preferredStep?( min?:any, estStepSize?:any ): any; /** [Method] This method formats the value * @param value Object * @param context Object + * @returns String */ renderer?( value?:any, context?:any ): string; } @@ -2993,28 +3278,35 @@ declare module Ext.chart.axis.segmenter { * @param value * The value to be aligned. * @param step Number The step of units. * @param unit * The unit. + * @returns * Aligned value. */ align?( value?:any, step?:number, unit?:any ): any; /** [Method] Returns the difference between the min and max value based on the given unit scale * @param min * The smaller value. * @param max * The larger value. * @param unit * The unit scale. Unit can be any type. + * @returns Number The number of units between min and max. It is the minimum n that min + n * unit >= max. */ diff?( min?:any, max?:any, unit?:any ): number; /** [Method] Convert from any data into the target type * @param value * The value to convert from + * @returns * The converted value. */ from?( value?:any ): any; - /** [Method] Returns the value of axis */ + /** [Method] Returns the value of axis + * @returns Ext.chart.axis.Axis + */ getAxis?(): Ext.chart.axis.IAxis; /** [Method] Given a start point and estimated step size of a range determine the preferred step size * @param start * The start point of range. * @param estStepSize * The estimated step size. + * @returns Object Return the step size by an object of step x unit. */ preferredStep?( start?:any, estStepSize?:any ): any; /** [Method] This method formats the value * @param value * The value to format. * @param context Object Axis layout context. + * @returns String */ renderer?( value?:any, context?:any ): string; /** [Method] Sets the value of axis @@ -3037,28 +3329,35 @@ declare module Ext.chart.axis.segmenter { * @param date Object * @param step Object * @param unit Object + * @returns * Aligned value. */ align?( date?:any, step?:any, unit?:any ): any; /** [Method] Returns the difference between the min and max value based on the given unit scale * @param min Object * @param max Object * @param unit Object + * @returns Number The number of units between min and max. It is the minimum n that min + n * unit >= max. */ diff?( min?:any, max?:any, unit?:any ): number; /** [Method] Convert from any data into the target type * @param value Object + * @returns * The converted value. */ from?( value?:any ): any; - /** [Method] Returns the value of step */ + /** [Method] Returns the value of step + * @returns Object + */ getStep?(): any; /** [Method] Given a start point and estimated step size of a range determine the preferred step size * @param min Object * @param estStepSize Object + * @returns Object Return the step size by an object of step x unit. */ preferredStep?( min?:any, estStepSize?:any ): any; /** [Method] This method formats the value * @param value Object * @param context Object + * @returns String */ renderer?( value?:any, context?:any ): string; /** [Method] Sets the value of step @@ -3124,22 +3423,33 @@ declare module Ext.chart.axis.sprite { * @param marker Object {Ext.chart.Markers} */ bindMarker?( name?:any, marker?:any ): void; - /** [Method] Returns the value of axis */ + /** [Method] Returns the value of axis + * @returns Ext.chart.axis.Axis + */ getAxis?(): Ext.chart.axis.IAxis; /** [Method] Returns the bounding box for the given Sprite as calculated with the Canvas engine */ getBBox?(): void; - /** [Method] Returns the value of label */ + /** [Method] Returns the value of label + * @returns Object + */ getLabel?(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object|Ext.chart.axis.layout.Layout + */ getLayout?(): any; - /** [Method] Returns the value of renderer */ + /** [Method] Returns the value of renderer + * @returns Function + */ getRenderer?(): any; - /** [Method] Returns the value of segmenter */ + /** [Method] Returns the value of segmenter + * @returns Object|Ext.chart.axis.segmenter.Segmenter + */ getSegmenter?(): any; /** [Method] Render method * @param surface Object * @param ctx Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any ): any; /** [Method] Sets the value of axis @@ -3180,25 +3490,42 @@ declare module Ext.chart.axis { step?: any[]; /** [Config Option] (Date) */ toDate?: any; - /** [Method] Returns the value of aggregator */ + /** [Method] Returns the value of aggregator + * @returns String + */ getAggregator?(): string; - /** [Method] Returns the value of calculateByLabelSize */ + /** [Method] Returns the value of calculateByLabelSize + * @returns Boolean + */ getCalculateByLabelSize?(): boolean; /** [Method] Mapping data value into coordinate * @param value Object + * @returns Number */ getCoordFor?( value?:any ): number; - /** [Method] Returns the value of dateFormat */ + /** [Method] Returns the value of dateFormat + * @returns String/Boolean + */ getDateFormat?(): any; - /** [Method] Returns the value of fromDate */ + /** [Method] Returns the value of fromDate + * @returns Date + */ getFromDate?(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns String + */ getLayout?(): string; - /** [Method] Returns the value of segmenter */ + /** [Method] Returns the value of segmenter + * @returns String + */ getSegmenter?(): string; - /** [Method] Returns the value of step */ + /** [Method] Returns the value of step + * @returns Array + */ getStep?(): any[]; - /** [Method] Returns the value of toDate */ + /** [Method] Returns the value of toDate + * @returns Date + */ getToDate?(): any; /** [Method] Sets the value of aggregator * @param aggregator String @@ -3211,9 +3538,7 @@ declare module Ext.chart.axis { /** [Method] Sets the value of dateFormat * @param dateFormat String/Boolean */ - setDateFormat?( dateFormat?:any ): any; - setDateFormat?( dateFormat?:string ): void; - setDateFormat?( dateFormat?:boolean ): void; + setDateFormat?( dateFormat?:any ): void; /** [Method] Sets the value of fromDate * @param fromDate Date */ @@ -3240,9 +3565,13 @@ declare module Ext.chart { export interface ICartesianChart extends Ext.chart.IAbstractChart { /** [Config Option] (Boolean) */ flipXY?: boolean; - /** [Method] Returns the value of flipXY */ + /** [Method] Returns the value of flipXY + * @returns Boolean + */ getFlipXY?(): boolean; - /** [Method] Returns the value of innerRegion */ + /** [Method] Returns the value of innerRegion + * @returns Array + */ getInnerRegion?(): any[]; /** [Method] Place water mark after resize */ onPlaceWatermark?(): void; @@ -3264,9 +3593,13 @@ declare module Ext.chart { export interface IChart extends Ext.chart.IAbstractChart { /** [Config Option] (Boolean) */ flipXY?: boolean; - /** [Method] Returns the value of flipXY */ + /** [Method] Returns the value of flipXY + * @returns Boolean + */ getFlipXY?(): boolean; - /** [Method] Returns the value of innerRegion */ + /** [Method] Returns the value of innerRegion + * @returns Array + */ getInnerRegion?(): any[]; /** [Method] Place water mark after resize */ onPlaceWatermark?(): void; @@ -3294,13 +3627,16 @@ declare module Ext.chart.grid { * @param surface Object * @param ctx Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any ): any; } } declare module Ext.chart.grid { export interface IRadialGrid extends Ext.draw.sprite.IPath { - /** [Method] Render method */ + /** [Method] Render method + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. + */ render?(): any; /** [Method] Update the path * @param path Object @@ -3315,6 +3651,7 @@ declare module Ext.chart.grid { * @param surface Object * @param ctx Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any ): any; } @@ -3335,16 +3672,14 @@ declare module Ext.chart.interactions { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -3356,9 +3691,7 @@ declare module Ext.chart.interactions { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -3366,9 +3699,7 @@ declare module Ext.chart.interactions { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -3376,41 +3707,54 @@ declare module Ext.chart.interactions { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of chart */ + /** [Method] Returns the value of chart + * @returns Ext.chart.AbstractChart + */ getChart?(): Ext.chart.IAbstractChart; - /** [Method] Returns the value of enabled */ + /** [Method] Returns the value of enabled + * @returns Boolean + */ getEnabled?(): boolean; - /** [Method] Returns the value of gesture */ + /** [Method] Returns the value of gesture + * @returns String + */ getGesture?(): string; /** [Method] Find and return a single series item corresponding to the given event or null if no matching item is found * @param e Event + * @returns Object the item object or null if none found. */ getItemForEvent?( e?:Event ): any; /** [Method] Find and return all series items corresponding to the given event * @param e Event + * @returns Array array of matching item objects */ getItemsForEvent?( e?:Event ): any[]; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] A method to be implemented by subclasses where all event attachment should occur */ @@ -3422,18 +3766,14 @@ declare module Ext.chart.interactions { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -3441,30 +3781,27 @@ declare module Ext.chart.interactions { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Placeholder method */ onGesture?(): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -3473,16 +3810,14 @@ declare module Ext.chart.interactions { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -3490,18 +3825,14 @@ declare module Ext.chart.interactions { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -3509,9 +3840,7 @@ declare module Ext.chart.interactions { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of chart * @param chart Ext.chart.AbstractChart */ @@ -3537,25 +3866,21 @@ declare module Ext.chart.interactions { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.chart.interactions { @@ -3564,11 +3889,17 @@ declare module Ext.chart.interactions { axes?: any; /** [Config Option] (String) */ gesture?: string; - /** [Method] Returns the value of axes */ + /** [Method] Returns the value of axes + * @returns Object/Array + */ getAxes?(): any; - /** [Method] Returns the value of gesture */ + /** [Method] Returns the value of gesture + * @returns String + */ getGesture?(): string; - /** [Method] Returns the value of undoButton */ + /** [Method] Returns the value of undoButton + * @returns Object + */ getUndoButton?(): any; /** [Method] Placeholder method * @param e Object @@ -3592,7 +3923,9 @@ declare module Ext.chart.interactions { export interface IItemHighlight extends Ext.chart.interactions.IAbstract { /** [Config Option] (String) */ gesture?: string; - /** [Method] Returns the value of gesture */ + /** [Method] Returns the value of gesture + * @returns String + */ getGesture?(): string; /** [Method] Placeholder method * @param series Object @@ -3612,9 +3945,13 @@ declare module Ext.chart.interactions { gesture?: string; /** [Config Option] (Object) */ panel?: any; - /** [Method] Returns the value of gesture */ + /** [Method] Returns the value of gesture + * @returns String + */ getGesture?(): string; - /** [Method] Returns the value of panel */ + /** [Method] Returns the value of panel + * @returns Object + */ getPanel?(): any; /** [Method] Placeholder method * @param series Object @@ -3641,21 +3978,37 @@ declare module Ext.chart.interactions { showOverflowArrows?: boolean; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of axes */ + /** [Method] Returns the value of axes + * @returns Object/Array + */ getAxes?(): any; - /** [Method] Returns the value of hideLabelInGesture */ + /** [Method] Returns the value of hideLabelInGesture + * @returns Boolean + */ getHideLabelInGesture?(): boolean; - /** [Method] Returns the value of maxZoom */ + /** [Method] Returns the value of maxZoom + * @returns Object + */ getMaxZoom?(): any; - /** [Method] Returns the value of minZoom */ + /** [Method] Returns the value of minZoom + * @returns Object + */ getMinZoom?(): any; - /** [Method] Returns the value of modeToggleButton */ + /** [Method] Returns the value of modeToggleButton + * @returns Object + */ getModeToggleButton?(): any; - /** [Method] Returns the value of panGesture */ + /** [Method] Returns the value of panGesture + * @returns String + */ getPanGesture?(): string; - /** [Method] Returns the value of showOverflowArrows */ + /** [Method] Returns the value of showOverflowArrows + * @returns Boolean + */ getShowOverflowArrows?(): boolean; - /** [Method] Returns the value of zoomOnPanGesture */ + /** [Method] Returns the value of zoomOnPanGesture + * @returns Boolean + */ getZoomOnPanGesture?(): boolean; /** [Method] Placeholder method * @param e Object @@ -3699,7 +4052,9 @@ declare module Ext.chart.interactions { export interface IRotate extends Ext.chart.interactions.IAbstract { /** [Config Option] (String) */ gesture?: string; - /** [Method] Returns the value of gesture */ + /** [Method] Returns the value of gesture + * @returns String + */ getGesture?(): string; /** [Method] Placeholder method * @param e Object @@ -3729,6 +4084,7 @@ declare module Ext.chart.label { /** [Method] Invoked when changes need to pushed down to the sprite * @param attr Object * @param changes Object + * @returns Mixed */ pushDown?( attr?:any, changes?:any ): any; } @@ -3737,12 +4093,15 @@ declare module Ext.chart.label { export interface ILabel extends Ext.draw.sprite.IText { /** [Config Option] (Object) */ fx?: any; - /** [Method] Returns the value of fx */ + /** [Method] Returns the value of fx + * @returns Object + */ getFx?(): any; /** [Method] Render method * @param surface Object * @param ctx Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any ): any; /** [Method] Sets the value of fx @@ -3769,23 +4128,41 @@ declare module Ext.chart { position?: string; /** [Config Option] (Boolean) */ toggleable?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of disableSelection */ + /** [Method] Returns the value of disableSelection + * @returns Boolean + */ getDisableSelection?(): boolean; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ getDocked?(): string; - /** [Method] Returns the value of horizontalHeight */ + /** [Method] Returns the value of horizontalHeight + * @returns Number + */ getHorizontalHeight?(): number; - /** [Method] Returns the value of inline */ + /** [Method] Returns the value of inline + * @returns Boolean + */ getInline?(): boolean; - /** [Method] Returns the value of itemTpl */ + /** [Method] Returns the value of itemTpl + * @returns Array + */ getItemTpl?(): any[]; - /** [Method] Returns the value of padding */ + /** [Method] Returns the value of padding + * @returns Number + */ getPadding?(): number; - /** [Method] Returns the value of toggleable */ + /** [Method] Returns the value of toggleable + * @returns Boolean + */ getToggleable?(): boolean; - /** [Method] Returns the value of verticalWidth */ + /** [Method] Returns the value of verticalWidth + * @returns Number + */ getVerticalWidth?(): number; /** [Method] Sets the value of baseCls * @param baseCls String @@ -3844,7 +4221,9 @@ declare module Ext.chart { * @param category String */ clear?( category?:string ): void; - /** [Method] Not supported */ + /** [Method] Not supported + * @returns null + */ getBBox?(): any; /** [Method] * @param category String @@ -3859,13 +4238,12 @@ declare module Ext.chart { * @param canonical Boolean * @param keepRevision Boolean */ - putMarkerFor?( category?:any, markerAttr?:any, index?:any, canonical?:any, keepRevision?:any ): any; - putMarkerFor?( category?:string, markerAttr?:any, index?:string, canonical?:boolean, keepRevision?:boolean ): void; - putMarkerFor?( category?:string, markerAttr?:any, index?:number, canonical?:boolean, keepRevision?:boolean ): void; + putMarkerFor?( category?:string, markerAttr?:any, index?:any, canonical?:boolean, keepRevision?:boolean ): void; /** [Method] Render method * @param surface Object * @param ctx Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any ): any; } @@ -3876,9 +4254,13 @@ declare module Ext.chart { center?: any[]; /** [Config Option] (Number) */ radius?: number; - /** [Method] Returns the value of center */ + /** [Method] Returns the value of center + * @returns Array + */ getCenter?(): any[]; - /** [Method] Returns the value of radius */ + /** [Method] Returns the value of radius + * @returns Number + */ getRadius?(): number; /** [Method] Redraw the chart */ redraw?(): void; @@ -3909,6 +4291,7 @@ declare module Ext.chart.series { /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object + * @returns Object An object describing the item, or null if there is no matching item. The exact contents of this object will vary by series type, but should always contain at least the following: */ getItemForPoint?( x?:any, y?:any ): any; } @@ -3927,13 +4310,21 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of closeField */ + /** [Method] Returns the value of closeField + * @returns String + */ getCloseField?(): string; - /** [Method] Returns the value of highField */ + /** [Method] Returns the value of highField + * @returns String + */ getHighField?(): string; - /** [Method] Returns the value of lowField */ + /** [Method] Returns the value of lowField + * @returns String + */ getLowField?(): string; - /** [Method] Returns the value of openField */ + /** [Method] Returns the value of openField + * @returns String + */ getOpenField?(): string; /** [Method] Sets the value of closeField * @param closeField String @@ -3966,17 +4357,26 @@ declare module Ext.chart.series { /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object + * @returns Object An object describing the item, or null if there is no matching item. The exact contents of this object will vary by series type, but should always contain at least the following: */ getItemForPoint?( x?:any, y?:any ): any; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of xAxis */ + /** [Method] Returns the value of xAxis + * @returns Ext.chart.axis.Axis + */ getXAxis?(): Ext.chart.axis.IAxis; - /** [Method] Returns the value of xField */ + /** [Method] Returns the value of xField + * @returns String + */ getXField?(): string; - /** [Method] Returns the value of yAxis */ + /** [Method] Returns the value of yAxis + * @returns Ext.chart.axis.Axis + */ getYAxis?(): Ext.chart.axis.IAxis; - /** [Method] Returns the value of yField */ + /** [Method] Returns the value of yField + * @returns String + */ getYField?(): string; /** [Method] Provide legend information to target array * @param target Object @@ -4034,45 +4434,83 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of angleField */ + /** [Method] Returns the value of angleField + * @returns String + */ getAngleField?(): string; - /** [Method] Returns the value of center */ + /** [Method] Returns the value of center + * @returns Array + */ getCenter?(): any[]; - /** [Method] Returns the value of colors */ + /** [Method] Returns the value of colors + * @returns Array + */ getColors?(): any[]; - /** [Method] Returns the value of donut */ + /** [Method] Returns the value of donut + * @returns Number + */ getDonut?(): number; - /** [Method] Returns the value of field */ + /** [Method] Returns the value of field + * @returns String + */ getField?(): string; - /** [Method] Returns the value of maximum */ + /** [Method] Returns the value of maximum + * @returns Number + */ getMaximum?(): number; - /** [Method] Returns the value of minimum */ + /** [Method] Returns the value of minimum + * @returns Number + */ getMinimum?(): number; - /** [Method] Returns the value of needle */ + /** [Method] Returns the value of needle + * @returns Boolean + */ getNeedle?(): boolean; - /** [Method] Returns the value of needleLength */ + /** [Method] Returns the value of needleLength + * @returns Number + */ getNeedleLength?(): number; - /** [Method] Returns the value of needleLengthRatio */ + /** [Method] Returns the value of needleLengthRatio + * @returns Number + */ getNeedleLengthRatio?(): number; - /** [Method] Returns the value of needleWidth */ + /** [Method] Returns the value of needleWidth + * @returns Number + */ getNeedleWidth?(): number; - /** [Method] Returns the value of radius */ + /** [Method] Returns the value of radius + * @returns Number + */ getRadius?(): number; - /** [Method] Returns the value of region */ + /** [Method] Returns the value of region + * @returns Array + */ getRegion?(): any[]; - /** [Method] Returns the value of rotation */ + /** [Method] Returns the value of rotation + * @returns Number + */ getRotation?(): number; - /** [Method] Returns the value of sectors */ + /** [Method] Returns the value of sectors + * @returns Array + */ getSectors?(): any[]; - /** [Method] Returns the value of showInLegend */ + /** [Method] Returns the value of showInLegend + * @returns Boolean + */ getShowInLegend?(): boolean; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of totalAngle */ + /** [Method] Returns the value of totalAngle + * @returns Object + */ getTotalAngle?(): any; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number + */ getValue?(): number; - /** [Method] Returns the value of wholeDisk */ + /** [Method] Returns the value of wholeDisk + * @returns Boolean + */ getWholeDisk?(): boolean; /** [Method] Sets the value of angleField * @param angleField String @@ -4172,15 +4610,25 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of aggregator */ + /** [Method] Returns the value of aggregator + * @returns Object + */ getAggregator?(): any; - /** [Method] Returns the value of fill */ + /** [Method] Returns the value of fill + * @returns Boolean + */ getFill?(): boolean; - /** [Method] Returns the value of selectionTolerance */ + /** [Method] Returns the value of selectionTolerance + * @returns Number + */ getSelectionTolerance?(): number; - /** [Method] Returns the value of smooth */ + /** [Method] Returns the value of smooth + * @returns Boolean/Number + */ getSmooth?(): any; - /** [Method] Returns the value of step */ + /** [Method] Returns the value of step + * @returns Boolean + */ getStep?(): boolean; /** [Method] Sets the value of aggregator * @param aggregator Object @@ -4197,9 +4645,7 @@ declare module Ext.chart.series { /** [Method] Sets the value of smooth * @param smooth Boolean/Number */ - setSmooth?( smooth?:any ): any; - setSmooth?( smooth?:boolean ): void; - setSmooth?( smooth?:number ): void; + setSmooth?( smooth?:any ): void; /** [Method] Sets the value of step * @param step Boolean */ @@ -4226,22 +4672,33 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of donut */ + /** [Method] Returns the value of donut + * @returns Boolean/Number + */ getDonut?(): any; /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object + * @returns Object An object describing the item, or null if there is no matching item. The exact contents of this object will vary by series type, but should always contain at least the following: */ getItemForPoint?( x?:any, y?:any ): any; - /** [Method] Returns the value of labelField */ + /** [Method] Returns the value of labelField + * @returns String + */ getLabelField?(): string; - /** [Method] Returns the value of rotation */ + /** [Method] Returns the value of rotation + * @returns Number + */ getRotation?(): number; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns Object + */ getStyle?(): any; - /** [Method] Returns the value of totalAngle */ + /** [Method] Returns the value of totalAngle + * @returns Number + */ getTotalAngle?(): number; /** [Method] Provide legend information to target array * @param target Object @@ -4250,9 +4707,7 @@ declare module Ext.chart.series { /** [Method] Sets the value of donut * @param donut Boolean/Number */ - setDonut?( donut?:any ): any; - setDonut?( donut?:boolean ): void; - setDonut?( donut?:number ): void; + setDonut?( donut?:any ): void; /** [Method] Sets the value of hidden * @param hidden Array */ @@ -4287,19 +4742,31 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of distortion */ + /** [Method] Returns the value of distortion + * @returns Number + */ getDistortion?(): number; - /** [Method] Returns the value of donut */ + /** [Method] Returns the value of donut + * @returns Boolean/Number + */ getDonut?(): any; - /** [Method] Returns the value of field */ + /** [Method] Returns the value of field + * @returns String + */ getField?(): string; - /** [Method] Returns the value of region */ + /** [Method] Returns the value of region + * @returns Array + */ getRegion?(): any[]; - /** [Method] Returns the value of rotation */ + /** [Method] Returns the value of rotation + * @returns Number + */ getRotation?(): number; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of thickness */ + /** [Method] Returns the value of thickness + * @returns Number + */ getThickness?(): number; /** [Method] Sets the value of distortion * @param distortion Number @@ -4308,9 +4775,7 @@ declare module Ext.chart.series { /** [Method] Sets the value of donut * @param donut Boolean/Number */ - setDonut?( donut?:any ): any; - setDonut?( donut?:boolean ): void; - setDonut?( donut?:number ): void; + setDonut?( donut?:any ): void; /** [Method] Sets the value of field * @param field String */ @@ -4347,25 +4812,45 @@ declare module Ext.chart.series { xField?: string; /** [Config Option] (String) */ yField?: string; - /** [Method] Returns the value of center */ + /** [Method] Returns the value of center + * @returns Array + */ getCenter?(): any[]; - /** [Method] Returns the value of offsetX */ + /** [Method] Returns the value of offsetX + * @returns Number + */ getOffsetX?(): number; - /** [Method] Returns the value of offsetY */ + /** [Method] Returns the value of offsetY + * @returns Number + */ getOffsetY?(): number; - /** [Method] Returns the value of radius */ + /** [Method] Returns the value of radius + * @returns Number + */ getRadius?(): number; - /** [Method] Returns the value of rotation */ + /** [Method] Returns the value of rotation + * @returns Number + */ getRotation?(): number; - /** [Method] Returns the value of showInLegend */ + /** [Method] Returns the value of showInLegend + * @returns Boolean + */ getShowInLegend?(): boolean; - /** [Method] Returns the value of xAxis */ + /** [Method] Returns the value of xAxis + * @returns Object + */ getXAxis?(): any; - /** [Method] Returns the value of xField */ + /** [Method] Returns the value of xField + * @returns String + */ getXField?(): string; - /** [Method] Returns the value of yAxis */ + /** [Method] Returns the value of yAxis + * @returns Object + */ getYAxis?(): any; - /** [Method] Returns the value of yField */ + /** [Method] Returns the value of yField + * @returns String + */ getYField?(): string; /** [Method] Sets the value of center * @param center Array @@ -4420,6 +4905,7 @@ declare module Ext.chart.series { /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object + * @returns Object An object describing the item, or null if there is no matching item. The exact contents of this object will vary by series type, but should always contain at least the following: */ getItemForPoint?( x?:any, y?:any ): any; } @@ -4432,7 +4918,9 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of itemInstancing */ + /** [Method] Returns the value of itemInstancing + * @returns Object + */ getItemInstancing?(): any; /** [Method] Provide legend information to target array * @param target Object @@ -4496,16 +4984,14 @@ declare module Ext.chart.series { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -4517,9 +5003,7 @@ declare module Ext.chart.series { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -4527,9 +5011,7 @@ declare module Ext.chart.series { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -4537,73 +5019,117 @@ declare module Ext.chart.series { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of animate */ + /** [Method] Returns the value of animate + * @returns Object + */ getAnimate?(): any; - /** [Method] Returns the value of background */ + /** [Method] Returns the value of background + * @returns Object + */ getBackground?(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of colors */ + /** [Method] Returns the value of colors + * @returns Array + */ getColors?(): any[]; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean|Array + */ getHidden?(): any; - /** [Method] Returns the value of highlightCfg */ + /** [Method] Returns the value of highlightCfg + * @returns Object + */ getHighlightCfg?(): any; - /** [Method] Returns the value of highlightItem */ + /** [Method] Returns the value of highlightItem + * @returns Object + */ getHighlightItem?(): any; /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Number * @param y Number * @param target Object optional target to receive the result + * @returns Object An object describing the item, or null if there is no matching item. The exact contents of this object will vary by series type, but should always contain at least the following: */ getItemForPoint?( x?:number, y?:number, target?:any ): any; - /** [Method] Returns the value of itemInstancing */ + /** [Method] Returns the value of itemInstancing + * @returns Object + */ getItemInstancing?(): any; - /** [Method] Returns the value of label */ + /** [Method] Returns the value of label + * @returns Object + */ getLabel?(): any; - /** [Method] Returns the value of labelField */ + /** [Method] Returns the value of labelField + * @returns String + */ getLabelField?(): string; - /** [Method] Returns the value of labelOverflowPadding */ + /** [Method] Returns the value of labelOverflowPadding + * @returns Number + */ getLabelOverflowPadding?(): number; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of marker */ + /** [Method] Returns the value of marker + * @returns Object + */ getMarker?(): any; - /** [Method] Returns the value of markerSubStyle */ + /** [Method] Returns the value of markerSubStyle + * @returns Object + */ getMarkerSubStyle?(): any; - /** [Method] Returns the value of overlaySurface */ + /** [Method] Returns the value of overlaySurface + * @returns Object + */ getOverlaySurface?(): any; - /** [Method] Returns the value of renderer */ + /** [Method] Returns the value of renderer + * @returns Function + */ getRenderer?(): any; - /** [Method] Returns the value of showInLegend */ + /** [Method] Returns the value of showInLegend + * @returns Boolean + */ getShowInLegend?(): boolean; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns Object + */ getStyle?(): any; - /** [Method] Returns the value of subStyle */ + /** [Method] Returns the value of subStyle + * @returns Object + */ getSubStyle?(): any; - /** [Method] Returns the value of surface */ + /** [Method] Returns the value of surface + * @returns Object + */ getSurface?(): any; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -4613,18 +5139,14 @@ declare module Ext.chart.series { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -4632,25 +5154,21 @@ declare module Ext.chart.series { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Provide legend information to target array * @param target Array The information consists: */ @@ -4658,6 +5176,7 @@ declare module Ext.chart.series { /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -4666,16 +5185,14 @@ declare module Ext.chart.series { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -4683,18 +5200,14 @@ declare module Ext.chart.series { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -4710,9 +5223,7 @@ declare module Ext.chart.series { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of colors * @param colors Array */ @@ -4720,9 +5231,7 @@ declare module Ext.chart.series { /** [Method] Sets the value of hidden * @param hidden Boolean|Array */ - setHidden?( hidden?:any ): any; - setHidden?( hidden?:boolean ): void; - setHidden?( hidden?:any[] ): void; + setHidden?( hidden?:any ): void; /** [Method] * @param index Number * @param value Boolean @@ -4770,6 +5279,7 @@ declare module Ext.chart.series { setOverlaySurface?( overlaySurface?:any ): void; /** [Method] Sets the value of renderer * @param renderer Function + * @returns Object The attributes that have been changed or added. Note: it is usually possible to add or modify the attributes directly into the config parameter and not return anything, but returning an object with only those attributes that have been changed may allow for optimizations in the rendering of some series. Example to draw every other item in red: renderer: function (sprite, config, rendererData, index) { if (index % 2 == 0) { return { strokeStyle: 'red' }; } } */ setRenderer?( renderer?:any ): any; /** [Method] Sets the value of showInLegend @@ -4805,25 +5315,21 @@ declare module Ext.chart.series { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.chart.series.sprite { @@ -4836,7 +5342,9 @@ declare module Ext.chart.series.sprite { dataLow?: any; /** [Config Option] (Object) */ dataOpen?: any; - /** [Method] Returns the value of aggregator */ + /** [Method] Returns the value of aggregator + * @returns Object + */ getAggregator?(): any; /** [Method] Render the given visible clip range * @param surface Object @@ -4879,6 +5387,7 @@ declare module Ext.chart.series.sprite { /** [Method] Get the nearest item index from point x y * @param x Object * @param y Object + * @returns Number The index */ getIndexNearPoint?( x?:any, y?:any ): number; /** [Method] Render the given visible clip range @@ -4925,6 +5434,7 @@ declare module Ext.chart.series.sprite { selectionTolerance?: number; /** [Method] Does a binary search of the data on the x axis using the given key * @param key Object + * @returns * */ binarySearch?( key?:any ): any; /** [Method] @@ -4932,19 +5442,25 @@ declare module Ext.chart.series.sprite { * @param marker Object {Ext.chart.Markers} */ bindMarker?( name?:any, marker?:any ): void; - /** [Method] Returns the value of field */ + /** [Method] Returns the value of field + * @returns String + */ getField?(): string; - /** [Method] Returns the value of flipXY */ + /** [Method] Returns the value of flipXY + * @returns Boolean + */ getFlipXY?(): boolean; /** [Method] Get the nearest item index from point x y * @param x Number * @param y Number + * @returns Number The index */ getIndexNearPoint?( x?:number, y?:number ): number; /** [Method] Render method * @param surface Object * @param ctx Object * @param region Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, region?:any ): any; /** [Method] Render the given visible clip range @@ -5044,12 +5560,15 @@ declare module Ext.chart.series.sprite { * @param marker Object {Ext.chart.Markers} */ bindMarker?( name?:any, marker?:any ): void; - /** [Method] Returns the value of rendererIndex */ + /** [Method] Returns the value of rendererIndex + * @returns Number + */ getRendererIndex?(): number; /** [Method] Render method * @param ctx Object * @param surface Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( ctx?:any, surface?:any, clipRegion?:any ): any; /** [Method] Sets the value of rendererIndex @@ -5095,7 +5614,9 @@ declare module Ext.chart.series.sprite { * @param marker Object {Ext.chart.Markers} */ bindMarker?( name?:any, marker?:any ): void; - /** [Method] Returns the value of field */ + /** [Method] Returns the value of field + * @returns Object + */ getField?(): any; /** [Method] Sets the value of field * @param field Object @@ -5112,6 +5633,7 @@ declare module Ext.chart.series.sprite { /** [Method] Render method * @param surface Object * @param ctx Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any ): any; } @@ -5132,6 +5654,7 @@ declare module Ext.chart.series.sprite { /** [Method] Get the nearest item index from point x y * @param x Object * @param y Object + * @returns Number The index */ getIndexNearPoint?( x?:any, y?:any ): number; } @@ -5145,11 +5668,14 @@ declare module Ext.chart.series { /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object + * @returns Object An object describing the item, or null if there is no matching item. The exact contents of this object will vary by series type, but should always contain at least the following: */ getItemForPoint?( x?:any, y?:any ): any; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of stacked */ + /** [Method] Returns the value of stacked + * @returns Boolean + */ getStacked?(): boolean; /** [Method] Provide legend information to target array * @param target Object @@ -5201,70 +5727,83 @@ declare module Ext { export class ClassManager { /** [Method] Adds a batch of class name to alias mappings * @param aliases Object The set of mappings of the form className : [values...] + * @returns Ext.ClassManager this */ static addNameAliasMappings( aliases?:any ): Ext.IClassManager; /** [Method] * @param alternates Object The set of mappings of the form className : [values...] + * @returns Ext.ClassManager this */ static addNameAlternateMappings( alternates?:any ): Ext.IClassManager; /** [Method] Retrieve a class by its name * @param name String + * @returns Ext.Class class */ static get( name?:string ): Ext.IClass; /** [Method] Get the aliases of a class by the class name * @param name String + * @returns Array aliases */ static getAliasesByName( name?:string ): any[]; /** [Method] Get a reference to the class by its alias * @param alias String + * @returns Ext.Class class */ static getByAlias( alias?:string ): Ext.IClass; /** [Method] Get the class of the provided object returns null if it s not an instance of any class created with Ext define * @param object Object + * @returns Ext.Class class */ static getClass( object?:any ): Ext.IClass; /** [Method] Get the name of the class by its reference or its instance usually invoked by the shorthand Ext getClassName Ext Cl * @param object Ext.Class/Object + * @returns String className */ static getName( object?:any ): string; /** [Method] Get the name of a class by its alias * @param alias String + * @returns String className */ static getNameByAlias( alias?:string ): string; /** [Method] Get the name of a class by its alternate name * @param alternate String + * @returns String className */ static getNameByAlternate( alternate?:string ): string; /** [Method] Converts a string expression to an array of matching class names * @param expression String + * @returns Array classNames */ static getNamesByExpression( expression?:string ): any[]; /** [Method] Instantiate a class by either full name alias or alternate name usually invoked by the convenient shorthand Ext cre * @param name String * @param args Mixed Additional arguments after the name will be passed to the class' constructor. + * @returns Object instance */ static instantiate( name?:string, args?:any ): any; /** [Method] Instantiate a class by its alias usually invoked by the convenient shorthand Ext createByAlias If Ext Loader is enab * @param alias String * @param args Mixed... Additional arguments after the alias will be passed to the class constructor. + * @returns Object instance */ static instantiateByAlias( alias:string, ...args:any[] ): any; /** [Method] Checks if a class has already been created * @param className String + * @returns Boolean exist */ static isCreated( className?:string ): boolean; /** [Method] Sets a name reference to a class * @param name String * @param value Object + * @returns Ext.ClassManager this */ static set( name?:string, value?:any ): Ext.IClassManager; /** [Method] Register the alias for a class * @param cls Ext.Class/String a reference to a class or a className. * @param alias String Alias to use when referring to this class. + * @returns Ext.ClassManager this */ - static setAlias( cls?:any, alias?:any ): any; - static setAlias( cls?:Ext.IClass, alias?:string ): Ext.IClassManager; - static setAlias( cls?:string, alias?:string ): Ext.IClassManager; + static setAlias( cls?:any, alias?:string ): Ext.IClassManager; /** [Method] Creates a namespace and assign the value to the created object * @param name String * @param value Mixed @@ -5392,111 +5931,209 @@ declare module Ext { disable?(): void; /** [Method] Enables this Component */ enable?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of border */ + /** [Method] Returns the value of border + * @returns Number/String + */ getBorder?(): any; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns any + */ getBottom?(): any; - /** [Method] Returns the value of centered */ + /** [Method] Returns the value of centered + * @returns Boolean + */ getCentered?(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns any + */ getCls?(): any; - /** [Method] Returns the value of contentEl */ + /** [Method] Returns the value of contentEl + * @returns Ext.Element/HTMLElement/String + */ getContentEl?(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ getDisabled?(): boolean; - /** [Method] Returns the value of disabledCls */ + /** [Method] Returns the value of disabledCls + * @returns String + */ getDisabledCls?(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ getDocked?(): string; - /** [Method] Retrieves the top level element representing this component */ + /** [Method] Retrieves the top level element representing this component + * @returns Ext.dom.Element + */ getEl?(): Ext.dom.IElement; - /** [Method] Returns the value of enterAnimation */ + /** [Method] Returns the value of enterAnimation + * @returns String/Mixed + */ getEnterAnimation?(): any; - /** [Method] Returns the value of exitAnimation */ + /** [Method] Returns the value of exitAnimation + * @returns String/Mixed + */ getExitAnimation?(): any; - /** [Method] Returns the value of flex */ + /** [Method] Returns the value of flex + * @returns Number + */ getFlex?(): number; - /** [Method] Returns the value of floatingCls */ + /** [Method] Returns the value of floatingCls + * @returns String + */ getFloatingCls?(): string; - /** [Method] Returns the value of height */ + /** [Method] Returns the value of height + * @returns Number/String + */ getHeight?(): any; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ getHidden?(): boolean; - /** [Method] Returns the value of hiddenCls */ + /** [Method] Returns the value of hiddenCls + * @returns String + */ getHiddenCls?(): string; - /** [Method] Returns the value of hideAnimation */ + /** [Method] Returns the value of hideAnimation + * @returns String/Mixed + */ getHideAnimation?(): any; - /** [Method] Returns the value of html */ + /** [Method] Returns the value of html + * @returns String/Ext.Element/HTMLElement + */ getHtml?(): any; - /** [Method] Returns the value of itemId */ + /** [Method] Returns the value of itemId + * @returns String + */ getItemId?(): string; - /** [Method] Returns the value of left */ + /** [Method] Returns the value of left + * @returns Number/String + */ getLeft?(): any; - /** [Method] Returns the value of margin */ + /** [Method] Returns the value of margin + * @returns Number/String + */ getMargin?(): any; - /** [Method] Returns the value of maxHeight */ + /** [Method] Returns the value of maxHeight + * @returns Number/String + */ getMaxHeight?(): any; - /** [Method] Returns the value of maxWidth */ + /** [Method] Returns the value of maxWidth + * @returns Number/String + */ getMaxWidth?(): any; - /** [Method] Returns the value of minHeight */ + /** [Method] Returns the value of minHeight + * @returns Number/String + */ getMinHeight?(): any; - /** [Method] Returns the value of minWidth */ + /** [Method] Returns the value of minWidth + * @returns Number/String + */ getMinWidth?(): any; - /** [Method] Returns the value of padding */ + /** [Method] Returns the value of padding + * @returns Number/String + */ getPadding?(): any; - /** [Method] Returns the parent of this component if it has one */ + /** [Method] Returns the parent of this component if it has one + * @returns Ext.Component The parent of this component. + */ getParent?(): Ext.IComponent; - /** [Method] Returns the value of plugins */ + /** [Method] Returns the value of plugins + * @returns Object/Array + */ getPlugins?(): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of renderTo */ + /** [Method] Returns the value of renderTo + * @returns Ext.Element + */ getRenderTo?(): Ext.IElement; - /** [Method] Returns the value of right */ + /** [Method] Returns the value of right + * @returns Number/String + */ getRight?(): any; - /** [Method] Returns the value of showAnimation */ + /** [Method] Returns the value of showAnimation + * @returns String/Mixed + */ getShowAnimation?(): any; - /** [Method] Returns the height and width of the Component */ + /** [Method] Returns the height and width of the Component + * @returns Object The current height and width of the Component. + */ getSize?(): any; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns String/Object + */ getStyle?(): any; - /** [Method] Returns the value of styleHtmlCls */ + /** [Method] Returns the value of styleHtmlCls + * @returns String + */ getStyleHtmlCls?(): string; - /** [Method] Returns the value of styleHtmlContent */ + /** [Method] Returns the value of styleHtmlContent + * @returns Boolean + */ getStyleHtmlContent?(): boolean; - /** [Method] Returns the value of top */ + /** [Method] Returns the value of top + * @returns Number/String + */ getTop?(): any; - /** [Method] Returns the value of tpl */ + /** [Method] Returns the value of tpl + * @returns String/String[]/Ext.Template[]/Ext.XTemplate[] + */ getTpl?(): any; - /** [Method] Returns the value of tplWriteMode */ + /** [Method] Returns the value of tplWriteMode + * @returns String + */ getTplWriteMode?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of width */ + /** [Method] Returns the value of width + * @returns Number/String + */ getWidth?(): any; - /** [Method] Returns this Component s xtype hierarchy as a slash delimited string */ + /** [Method] Returns this Component s xtype hierarchy as a slash delimited string + * @returns String The xtype hierarchy string. + */ getXTypes?(): string; - /** [Method] Returns the value of zIndex */ + /** [Method] Returns the value of zIndex + * @returns Number + */ getZIndex?(): number; - /** [Method] Returns true if this component has a parent */ + /** [Method] Returns true if this component has a parent + * @returns Boolean true if this component has a parent. + */ hasParent?(): boolean; /** [Method] Hides this Component * @param animation Object/Boolean + * @returns Ext.Component */ hide?( animation?:any ): Ext.IComponent; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; - /** [Method] Returns true if this Component is currently disabled */ + /** [Method] Returns true if this Component is currently disabled + * @returns Boolean true if currently disabled. + */ isDisabled?(): boolean; - /** [Method] Returns true if this Component is currently hidden */ + /** [Method] Returns true if this Component is currently hidden + * @returns Boolean true if currently hidden. + */ isHidden?(): boolean; /** [Method] Tests whether or not this Component is of a specific xtype * @param xtype String The xtype to check for this Component. * @param shallow Boolean false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ isXType?( xtype?:string, shallow?:boolean ): boolean; /** [Method] Removes the given CSS class es from this Component s rendered element @@ -5521,15 +6158,11 @@ declare module Ext { /** [Method] Sets the value of border * @param border Number/String */ - setBorder?( border?:any ): any; - setBorder?( border?:number ): void; - setBorder?( border?:string ): void; + setBorder?( border?:any ): void; /** [Method] Sets the value of bottom * @param bottom Number/String */ - setBottom?( bottom?:any ): any; - setBottom?( bottom?:number ): void; - setBottom?( bottom?:string ): void; + setBottom?( bottom?:any ): void; /** [Method] Sets the value of centered * @param centered Boolean */ @@ -5537,16 +6170,11 @@ declare module Ext { /** [Method] Sets the value of cls * @param cls String/String[] */ - setCls?( cls?:any ): any; - setCls?( cls?:string ): void; - setCls?( cls?:string[] ): void; + setCls?( cls?:any ): void; /** [Method] Sets the value of contentEl * @param contentEl Ext.Element/HTMLElement/String */ - setContentEl?( contentEl?:any ): any; - setContentEl?( contentEl?:Ext.IElement ): void; - setContentEl?( contentEl?:HTMLElement ): void; - setContentEl?( contentEl?:string ): void; + setContentEl?( contentEl?:any ): void; /** [Method] Sets the value of data * @param data Object */ @@ -5570,13 +6198,11 @@ declare module Ext { /** [Method] Sets the value of enterAnimation * @param enterAnimation String/Mixed */ - setEnterAnimation?( enterAnimation?:any ): any; - setEnterAnimation?( enterAnimation?:string ): void; + setEnterAnimation?( enterAnimation?:any ): void; /** [Method] Sets the value of exitAnimation * @param exitAnimation String/Mixed */ - setExitAnimation?( exitAnimation?:any ): any; - setExitAnimation?( exitAnimation?:string ): void; + setExitAnimation?( exitAnimation?:any ): void; /** [Method] Sets the value of flex * @param flex Number */ @@ -5592,9 +6218,7 @@ declare module Ext { /** [Method] Sets the value of height * @param height Number/String */ - setHeight?( height?:any ): any; - setHeight?( height?:number ): void; - setHeight?( height?:string ): void; + setHeight?( height?:any ): void; /** [Method] Sets the value of hidden * @param hidden Boolean */ @@ -5606,15 +6230,11 @@ declare module Ext { /** [Method] Sets the value of hideAnimation * @param hideAnimation String/Mixed */ - setHideAnimation?( hideAnimation?:any ): any; - setHideAnimation?( hideAnimation?:string ): void; + setHideAnimation?( hideAnimation?:any ): void; /** [Method] Sets the value of html * @param html String/Ext.Element/HTMLElement */ - setHtml?( html?:any ): any; - setHtml?( html?:string ): void; - setHtml?( html?:Ext.IElement ): void; - setHtml?( html?:HTMLElement ): void; + setHtml?( html?:any ): void; /** [Method] Sets the value of itemId * @param itemId String */ @@ -5622,45 +6242,31 @@ declare module Ext { /** [Method] Sets the value of left * @param left Number/String */ - setLeft?( left?:any ): any; - setLeft?( left?:number ): void; - setLeft?( left?:string ): void; + setLeft?( left?:any ): void; /** [Method] Sets the value of margin * @param margin Number/String */ - setMargin?( margin?:any ): any; - setMargin?( margin?:number ): void; - setMargin?( margin?:string ): void; + setMargin?( margin?:any ): void; /** [Method] Sets the value of maxHeight * @param maxHeight Number/String */ - setMaxHeight?( maxHeight?:any ): any; - setMaxHeight?( maxHeight?:number ): void; - setMaxHeight?( maxHeight?:string ): void; + setMaxHeight?( maxHeight?:any ): void; /** [Method] Sets the value of maxWidth * @param maxWidth Number/String */ - setMaxWidth?( maxWidth?:any ): any; - setMaxWidth?( maxWidth?:number ): void; - setMaxWidth?( maxWidth?:string ): void; + setMaxWidth?( maxWidth?:any ): void; /** [Method] Sets the value of minHeight * @param minHeight Number/String */ - setMinHeight?( minHeight?:any ): any; - setMinHeight?( minHeight?:number ): void; - setMinHeight?( minHeight?:string ): void; + setMinHeight?( minHeight?:any ): void; /** [Method] Sets the value of minWidth * @param minWidth Number/String */ - setMinWidth?( minWidth?:any ): any; - setMinWidth?( minWidth?:number ): void; - setMinWidth?( minWidth?:string ): void; + setMinWidth?( minWidth?:any ): void; /** [Method] Sets the value of padding * @param padding Number/String */ - setPadding?( padding?:any ): any; - setPadding?( padding?:number ): void; - setPadding?( padding?:string ): void; + setPadding?( padding?:any ): void; /** [Method] Sets the value of plugins * @param plugins Object/Array */ @@ -5676,16 +6282,13 @@ declare module Ext { /** [Method] Sets the value of right * @param right Number/String */ - setRight?( right?:any ): any; - setRight?( right?:number ): void; - setRight?( right?:string ): void; + setRight?( right?:any ): void; /** [Method] This method has moved to Ext Container */ setScrollable?(): void; /** [Method] Sets the value of showAnimation * @param showAnimation String/Mixed */ - setShowAnimation?( showAnimation?:any ): any; - setShowAnimation?( showAnimation?:string ): void; + setShowAnimation?( showAnimation?:any ): void; /** [Method] Sets the size of the Component * @param width Number The new width for the Component. * @param height Number The new height for the Component. @@ -5706,17 +6309,11 @@ declare module Ext { /** [Method] Sets the value of top * @param top Number/String */ - setTop?( top?:any ): any; - setTop?( top?:number ): void; - setTop?( top?:string ): void; + setTop?( top?:any ): void; /** [Method] Sets the value of tpl * @param tpl String/String[]/Ext.Template[]/Ext.XTemplate[] */ - setTpl?( tpl?:any ): any; - setTpl?( tpl?:string ): void; - setTpl?( tpl?:string[] ): void; - setTpl?( tpl?:Ext.ITemplate[] ): void; - setTpl?( tpl?:Ext.IXTemplate[] ): void; + setTpl?( tpl?:any ): void; /** [Method] Sets the value of tplWriteMode * @param tplWriteMode String */ @@ -5728,15 +6325,14 @@ declare module Ext { /** [Method] Sets the value of width * @param width Number/String */ - setWidth?( width?:any ): any; - setWidth?( width?:number ): void; - setWidth?( width?:string ): void; + setWidth?( width?:any ): void; /** [Method] Sets the value of zIndex * @param zIndex Number */ setZIndex?( zIndex?:number ): void; /** [Method] Shows this component * @param animation Object/Boolean + * @returns Ext.Component */ show?( animation?:any ): Ext.IComponent; /** [Method] Shows this component by another component @@ -5746,6 +6342,7 @@ declare module Ext { showBy?( component?:Ext.IComponent, alignment?:string ): void; /** [Method] Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector * @param selector String The simple selector to test. + * @returns Ext.Container The matching ancestor Container (or undefined if no match was found). */ up?( selector?:string ): Ext.IContainer; /** [Method] Updates the HTML content of the Component */ @@ -5877,111 +6474,209 @@ declare module Ext.lib { disable?(): void; /** [Method] Enables this Component */ enable?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of border */ + /** [Method] Returns the value of border + * @returns Number/String + */ getBorder?(): any; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns any + */ getBottom?(): any; - /** [Method] Returns the value of centered */ + /** [Method] Returns the value of centered + * @returns Boolean + */ getCentered?(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns any + */ getCls?(): any; - /** [Method] Returns the value of contentEl */ + /** [Method] Returns the value of contentEl + * @returns Ext.Element/HTMLElement/String + */ getContentEl?(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ getDisabled?(): boolean; - /** [Method] Returns the value of disabledCls */ + /** [Method] Returns the value of disabledCls + * @returns String + */ getDisabledCls?(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ getDocked?(): string; - /** [Method] Retrieves the top level element representing this component */ + /** [Method] Retrieves the top level element representing this component + * @returns Ext.dom.Element + */ getEl?(): Ext.dom.IElement; - /** [Method] Returns the value of enterAnimation */ + /** [Method] Returns the value of enterAnimation + * @returns String/Mixed + */ getEnterAnimation?(): any; - /** [Method] Returns the value of exitAnimation */ + /** [Method] Returns the value of exitAnimation + * @returns String/Mixed + */ getExitAnimation?(): any; - /** [Method] Returns the value of flex */ + /** [Method] Returns the value of flex + * @returns Number + */ getFlex?(): number; - /** [Method] Returns the value of floatingCls */ + /** [Method] Returns the value of floatingCls + * @returns String + */ getFloatingCls?(): string; - /** [Method] Returns the value of height */ + /** [Method] Returns the value of height + * @returns Number/String + */ getHeight?(): any; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ getHidden?(): boolean; - /** [Method] Returns the value of hiddenCls */ + /** [Method] Returns the value of hiddenCls + * @returns String + */ getHiddenCls?(): string; - /** [Method] Returns the value of hideAnimation */ + /** [Method] Returns the value of hideAnimation + * @returns String/Mixed + */ getHideAnimation?(): any; - /** [Method] Returns the value of html */ + /** [Method] Returns the value of html + * @returns String/Ext.Element/HTMLElement + */ getHtml?(): any; - /** [Method] Returns the value of itemId */ + /** [Method] Returns the value of itemId + * @returns String + */ getItemId?(): string; - /** [Method] Returns the value of left */ + /** [Method] Returns the value of left + * @returns Number/String + */ getLeft?(): any; - /** [Method] Returns the value of margin */ + /** [Method] Returns the value of margin + * @returns Number/String + */ getMargin?(): any; - /** [Method] Returns the value of maxHeight */ + /** [Method] Returns the value of maxHeight + * @returns Number/String + */ getMaxHeight?(): any; - /** [Method] Returns the value of maxWidth */ + /** [Method] Returns the value of maxWidth + * @returns Number/String + */ getMaxWidth?(): any; - /** [Method] Returns the value of minHeight */ + /** [Method] Returns the value of minHeight + * @returns Number/String + */ getMinHeight?(): any; - /** [Method] Returns the value of minWidth */ + /** [Method] Returns the value of minWidth + * @returns Number/String + */ getMinWidth?(): any; - /** [Method] Returns the value of padding */ + /** [Method] Returns the value of padding + * @returns Number/String + */ getPadding?(): any; - /** [Method] Returns the parent of this component if it has one */ + /** [Method] Returns the parent of this component if it has one + * @returns Ext.Component The parent of this component. + */ getParent?(): Ext.IComponent; - /** [Method] Returns the value of plugins */ + /** [Method] Returns the value of plugins + * @returns Object/Array + */ getPlugins?(): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of renderTo */ + /** [Method] Returns the value of renderTo + * @returns Ext.Element + */ getRenderTo?(): Ext.IElement; - /** [Method] Returns the value of right */ + /** [Method] Returns the value of right + * @returns Number/String + */ getRight?(): any; - /** [Method] Returns the value of showAnimation */ + /** [Method] Returns the value of showAnimation + * @returns String/Mixed + */ getShowAnimation?(): any; - /** [Method] Returns the height and width of the Component */ + /** [Method] Returns the height and width of the Component + * @returns Object The current height and width of the Component. + */ getSize?(): any; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns String/Object + */ getStyle?(): any; - /** [Method] Returns the value of styleHtmlCls */ + /** [Method] Returns the value of styleHtmlCls + * @returns String + */ getStyleHtmlCls?(): string; - /** [Method] Returns the value of styleHtmlContent */ + /** [Method] Returns the value of styleHtmlContent + * @returns Boolean + */ getStyleHtmlContent?(): boolean; - /** [Method] Returns the value of top */ + /** [Method] Returns the value of top + * @returns Number/String + */ getTop?(): any; - /** [Method] Returns the value of tpl */ + /** [Method] Returns the value of tpl + * @returns String/String[]/Ext.Template[]/Ext.XTemplate[] + */ getTpl?(): any; - /** [Method] Returns the value of tplWriteMode */ + /** [Method] Returns the value of tplWriteMode + * @returns String + */ getTplWriteMode?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of width */ + /** [Method] Returns the value of width + * @returns Number/String + */ getWidth?(): any; - /** [Method] Returns this Component s xtype hierarchy as a slash delimited string */ + /** [Method] Returns this Component s xtype hierarchy as a slash delimited string + * @returns String The xtype hierarchy string. + */ getXTypes?(): string; - /** [Method] Returns the value of zIndex */ + /** [Method] Returns the value of zIndex + * @returns Number + */ getZIndex?(): number; - /** [Method] Returns true if this component has a parent */ + /** [Method] Returns true if this component has a parent + * @returns Boolean true if this component has a parent. + */ hasParent?(): boolean; /** [Method] Hides this Component * @param animation Object/Boolean + * @returns Ext.Component */ hide?( animation?:any ): Ext.IComponent; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; - /** [Method] Returns true if this Component is currently disabled */ + /** [Method] Returns true if this Component is currently disabled + * @returns Boolean true if currently disabled. + */ isDisabled?(): boolean; - /** [Method] Returns true if this Component is currently hidden */ + /** [Method] Returns true if this Component is currently hidden + * @returns Boolean true if currently hidden. + */ isHidden?(): boolean; /** [Method] Tests whether or not this Component is of a specific xtype * @param xtype String The xtype to check for this Component. * @param shallow Boolean false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ isXType?( xtype?:string, shallow?:boolean ): boolean; /** [Method] Removes the given CSS class es from this Component s rendered element @@ -6006,15 +6701,11 @@ declare module Ext.lib { /** [Method] Sets the value of border * @param border Number/String */ - setBorder?( border?:any ): any; - setBorder?( border?:number ): void; - setBorder?( border?:string ): void; + setBorder?( border?:any ): void; /** [Method] Sets the value of bottom * @param bottom Number/String */ - setBottom?( bottom?:any ): any; - setBottom?( bottom?:number ): void; - setBottom?( bottom?:string ): void; + setBottom?( bottom?:any ): void; /** [Method] Sets the value of centered * @param centered Boolean */ @@ -6022,16 +6713,11 @@ declare module Ext.lib { /** [Method] Sets the value of cls * @param cls String/String[] */ - setCls?( cls?:any ): any; - setCls?( cls?:string ): void; - setCls?( cls?:string[] ): void; + setCls?( cls?:any ): void; /** [Method] Sets the value of contentEl * @param contentEl Ext.Element/HTMLElement/String */ - setContentEl?( contentEl?:any ): any; - setContentEl?( contentEl?:Ext.IElement ): void; - setContentEl?( contentEl?:HTMLElement ): void; - setContentEl?( contentEl?:string ): void; + setContentEl?( contentEl?:any ): void; /** [Method] Sets the value of data * @param data Object */ @@ -6055,13 +6741,11 @@ declare module Ext.lib { /** [Method] Sets the value of enterAnimation * @param enterAnimation String/Mixed */ - setEnterAnimation?( enterAnimation?:any ): any; - setEnterAnimation?( enterAnimation?:string ): void; + setEnterAnimation?( enterAnimation?:any ): void; /** [Method] Sets the value of exitAnimation * @param exitAnimation String/Mixed */ - setExitAnimation?( exitAnimation?:any ): any; - setExitAnimation?( exitAnimation?:string ): void; + setExitAnimation?( exitAnimation?:any ): void; /** [Method] Sets the value of flex * @param flex Number */ @@ -6077,9 +6761,7 @@ declare module Ext.lib { /** [Method] Sets the value of height * @param height Number/String */ - setHeight?( height?:any ): any; - setHeight?( height?:number ): void; - setHeight?( height?:string ): void; + setHeight?( height?:any ): void; /** [Method] Sets the value of hidden * @param hidden Boolean */ @@ -6091,15 +6773,11 @@ declare module Ext.lib { /** [Method] Sets the value of hideAnimation * @param hideAnimation String/Mixed */ - setHideAnimation?( hideAnimation?:any ): any; - setHideAnimation?( hideAnimation?:string ): void; + setHideAnimation?( hideAnimation?:any ): void; /** [Method] Sets the value of html * @param html String/Ext.Element/HTMLElement */ - setHtml?( html?:any ): any; - setHtml?( html?:string ): void; - setHtml?( html?:Ext.IElement ): void; - setHtml?( html?:HTMLElement ): void; + setHtml?( html?:any ): void; /** [Method] Sets the value of itemId * @param itemId String */ @@ -6107,45 +6785,31 @@ declare module Ext.lib { /** [Method] Sets the value of left * @param left Number/String */ - setLeft?( left?:any ): any; - setLeft?( left?:number ): void; - setLeft?( left?:string ): void; + setLeft?( left?:any ): void; /** [Method] Sets the value of margin * @param margin Number/String */ - setMargin?( margin?:any ): any; - setMargin?( margin?:number ): void; - setMargin?( margin?:string ): void; + setMargin?( margin?:any ): void; /** [Method] Sets the value of maxHeight * @param maxHeight Number/String */ - setMaxHeight?( maxHeight?:any ): any; - setMaxHeight?( maxHeight?:number ): void; - setMaxHeight?( maxHeight?:string ): void; + setMaxHeight?( maxHeight?:any ): void; /** [Method] Sets the value of maxWidth * @param maxWidth Number/String */ - setMaxWidth?( maxWidth?:any ): any; - setMaxWidth?( maxWidth?:number ): void; - setMaxWidth?( maxWidth?:string ): void; + setMaxWidth?( maxWidth?:any ): void; /** [Method] Sets the value of minHeight * @param minHeight Number/String */ - setMinHeight?( minHeight?:any ): any; - setMinHeight?( minHeight?:number ): void; - setMinHeight?( minHeight?:string ): void; + setMinHeight?( minHeight?:any ): void; /** [Method] Sets the value of minWidth * @param minWidth Number/String */ - setMinWidth?( minWidth?:any ): any; - setMinWidth?( minWidth?:number ): void; - setMinWidth?( minWidth?:string ): void; + setMinWidth?( minWidth?:any ): void; /** [Method] Sets the value of padding * @param padding Number/String */ - setPadding?( padding?:any ): any; - setPadding?( padding?:number ): void; - setPadding?( padding?:string ): void; + setPadding?( padding?:any ): void; /** [Method] Sets the value of plugins * @param plugins Object/Array */ @@ -6161,16 +6825,13 @@ declare module Ext.lib { /** [Method] Sets the value of right * @param right Number/String */ - setRight?( right?:any ): any; - setRight?( right?:number ): void; - setRight?( right?:string ): void; + setRight?( right?:any ): void; /** [Method] This method has moved to Ext Container */ setScrollable?(): void; /** [Method] Sets the value of showAnimation * @param showAnimation String/Mixed */ - setShowAnimation?( showAnimation?:any ): any; - setShowAnimation?( showAnimation?:string ): void; + setShowAnimation?( showAnimation?:any ): void; /** [Method] Sets the size of the Component * @param width Number The new width for the Component. * @param height Number The new height for the Component. @@ -6191,17 +6852,11 @@ declare module Ext.lib { /** [Method] Sets the value of top * @param top Number/String */ - setTop?( top?:any ): any; - setTop?( top?:number ): void; - setTop?( top?:string ): void; + setTop?( top?:any ): void; /** [Method] Sets the value of tpl * @param tpl String/String[]/Ext.Template[]/Ext.XTemplate[] */ - setTpl?( tpl?:any ): any; - setTpl?( tpl?:string ): void; - setTpl?( tpl?:string[] ): void; - setTpl?( tpl?:Ext.ITemplate[] ): void; - setTpl?( tpl?:Ext.IXTemplate[] ): void; + setTpl?( tpl?:any ): void; /** [Method] Sets the value of tplWriteMode * @param tplWriteMode String */ @@ -6213,15 +6868,14 @@ declare module Ext.lib { /** [Method] Sets the value of width * @param width Number/String */ - setWidth?( width?:any ): any; - setWidth?( width?:number ): void; - setWidth?( width?:string ): void; + setWidth?( width?:any ): void; /** [Method] Sets the value of zIndex * @param zIndex Number */ setZIndex?( zIndex?:number ): void; /** [Method] Shows this component * @param animation Object/Boolean + * @returns Ext.Component */ show?( animation?:any ): Ext.IComponent; /** [Method] Shows this component by another component @@ -6231,6 +6885,7 @@ declare module Ext.lib { showBy?( component?:Ext.IComponent, alignment?:string ): void; /** [Method] Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector * @param selector String The simple selector to test. + * @returns Ext.Container The matching ancestor Container (or undefined if no match was found). */ up?( selector?:string ): Ext.IContainer; /** [Method] Updates the HTML content of the Component */ @@ -6248,47 +6903,54 @@ declare module Ext { export class ComponentManager { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new Component from the specified config object using the config object s xtype to determine the class to in * @param component Object A configuration object for the Component you wish to create. * @param defaultType Function The constructor to provide the default Component type if the config object does not contain a xtype. (Optional if the config contains an xtype). + * @returns Ext.Component The newly instantiated Component. */ static create( component?:any, defaultType?:any ): Ext.IComponent; /** [Method] */ static destroy(): void; /** [Method] Returns an item by id * @param id String The id of the item. + * @returns Object The item, or undefined if not found. */ static get( id?:string ): any; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Checks if an item type is registered * @param component String The mnemonic string by which the class may be looked up. + * @returns Boolean Whether the type is registered. */ static isRegistered( component?:string ): boolean; /** [Method] Registers an item to be managed * @param component Object The item to register. */ static register( component?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param component Object The item to unregister. @@ -6302,47 +6964,54 @@ declare module Ext { export class ComponentMgr { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new Component from the specified config object using the config object s xtype to determine the class to in * @param component Object A configuration object for the Component you wish to create. * @param defaultType Function The constructor to provide the default Component type if the config object does not contain a xtype. (Optional if the config contains an xtype). + * @returns Ext.Component The newly instantiated Component. */ static create( component?:any, defaultType?:any ): Ext.IComponent; /** [Method] */ static destroy(): void; /** [Method] Returns an item by id * @param id String The id of the item. + * @returns Object The item, or undefined if not found. */ static get( id?:string ): any; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Checks if an item type is registered * @param component String The mnemonic string by which the class may be looked up. + * @returns Boolean Whether the type is registered. */ static isRegistered( component?:string ): boolean; /** [Method] Registers an item to be managed * @param component Object The item to register. */ static register( component?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param component Object The item to unregister. @@ -6357,11 +7026,13 @@ declare module Ext { /** [Method] Tests whether the passed Component matches the selector string * @param component Ext.Component The Component to test. * @param selector String The selector string to test against. + * @returns Boolean true if the Component matches the selector. */ static is( component?:Ext.IComponent, selector?:string ): boolean; /** [Method] Returns an array of matched Components from within the passed root object * @param selector String The selector string to filter returned Components * @param root Ext.Container The Container within which to perform the query. If omitted, all Components within the document are included in the search. This parameter may also be an array of Components to filter according to the selector. + * @returns Ext.Component[] The matched Components. */ static query( selector?:string, root?:Ext.IContainer ): Ext.IComponent[]; } @@ -6396,10 +7067,12 @@ declare module Ext { scrollable?: any; /** [Method] Adds one or more Components to this Container * @param newItems Object/Object[]/Ext.Component/Ext.Component[] The new items to add to the Container. + * @returns Ext.Component The last item added to the Container from the newItems array. */ add?( newItems?:any ): Ext.IComponent; /** [Method] Adds an array of Components to this Container * @param items Array The array of items to add to this container. + * @returns Array The array of items after they have been added. */ addAll?( items?:any[] ): any[]; /** [Method] Animates to the supplied activeItem with a specified animation @@ -6409,57 +7082,83 @@ declare module Ext { animateActiveItem?( activeItem?:any, animation?:any ): void; /** [Method] Changes the masked configuration when its setter is called which will convert the value into a proper object instanc * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask + * @returns Object */ applyMasked?( masked?:any ): any; /** [Method] Retrieves the first direct child of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ child?( selector?:string ): Ext.IComponent; /** [Method] */ destroy?(): void; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ down?( selector?:string ): Ext.IComponent; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ getActiveItem?(): any; /** [Method] Returns the Component for a given index in the Container s items * @param index Number The index of the Component to return. + * @returns Ext.Component The item at the specified index, if found. */ getAt?( index?:number ): Ext.IComponent; - /** [Method] Returns the value of autoDestroy */ + /** [Method] Returns the value of autoDestroy + * @returns Boolean + */ getAutoDestroy?(): boolean; /** [Method] Examines this container s items property and gets a direct child component of this container * @param component String/Number This parameter may be any of the following: {String} : representing the itemId or id of the child component. {Number} : representing the position of the child component within the items property. For additional information see Ext.util.MixedCollection.get. + * @returns Ext.Component The component (if found). + */ + getComponent?( component?:any ): Ext.IComponent; + /** [Method] Returns the value of control + * @returns Object */ - getComponent?( component?:any ): any; - getComponent?( component?:string ): Ext.IComponent; - getComponent?( component?:number ): Ext.IComponent; - /** [Method] Returns the value of control */ getControl?(): any; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ getDefaults?(): any; /** [Method] Finds a docked item of this container using a reference idor an index of its location in getDockedItems * @param component String/Number The id or index of the component to find. + * @returns Ext.Component/Boolean The docked component, if found. */ getDockedComponent?( component?:any ): any; - getDockedComponent?( component?:string ): Ext.IComponent; - getDockedComponent?( component?:number ): Ext.IComponent; - /** [Method] Returns all the Ext Component docked items in this container */ + /** [Method] Returns all the Ext Component docked items in this container + * @returns Array The docked items of this container. + */ getDockedItems?(): any[]; - /** [Method] Returns the value of hideOnMaskTap */ + /** [Method] Returns the value of hideOnMaskTap + * @returns Boolean + */ getHideOnMaskTap?(): boolean; - /** [Method] Returns all inner items of this container */ + /** [Method] Returns all inner items of this container + * @returns Array The inner items of this container. + */ getInnerItems?(): any[]; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ getItems?(): any; - /** [Method] Returns the value of masked */ + /** [Method] Returns the value of masked + * @returns Boolean/Object/Ext.Mask/Ext.LoadMask + */ getMasked?(): any; - /** [Method] Returns the value of modal */ + /** [Method] Returns the value of modal + * @returns Boolean + */ getModal?(): boolean; - /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class */ + /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class + * @returns Ext.scroll.View The scroll view. + */ getScrollable?(): Ext.scroll.IView; /** [Method] Adds a child Component at the given index * @param index Number The index to insert the Component at. @@ -6472,29 +7171,35 @@ declare module Ext { mask?( mask?:any ): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. + * @returns Array Ext.Component's which matched the selector. */ query?( selector?:string ): any[]; /** [Method] Removes an item from this Container optionally destroying it * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ remove?( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes all items currently in the Container optionally destroying them all * @param destroy Boolean If true, destroys each removed Component. * @param everything Boolean If true, completely remove all items including docked / centered and floating items. + * @returns Ext.Component this */ removeAll?( destroy?:boolean, everything?:boolean ): Ext.IComponent; /** [Method] Removes the Component at the specified index myContainer removeAt 0 removes the first item * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ removeAt?( index?:number ): Ext.IContainer; /** [Method] Removes a docked item from this Container * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ removeDocked?( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes an inner Component at the specified index myContainer removeInnerAt 0 removes the first item of the in * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ removeInnerAt?( index?:number ): Ext.IContainer; /** [Method] Sets the value of activeItem @@ -6575,10 +7280,12 @@ declare module Ext.lib { scrollable?: any; /** [Method] Adds one or more Components to this Container * @param newItems Object/Object[]/Ext.Component/Ext.Component[] The new items to add to the Container. + * @returns Ext.Component The last item added to the Container from the newItems array. */ add?( newItems?:any ): Ext.IComponent; /** [Method] Adds an array of Components to this Container * @param items Array The array of items to add to this container. + * @returns Array The array of items after they have been added. */ addAll?( items?:any[] ): any[]; /** [Method] Animates to the supplied activeItem with a specified animation @@ -6588,57 +7295,83 @@ declare module Ext.lib { animateActiveItem?( activeItem?:any, animation?:any ): void; /** [Method] Changes the masked configuration when its setter is called which will convert the value into a proper object instanc * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask + * @returns Object */ applyMasked?( masked?:any ): any; /** [Method] Retrieves the first direct child of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ child?( selector?:string ): Ext.IComponent; /** [Method] */ destroy?(): void; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ down?( selector?:string ): Ext.IComponent; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ getActiveItem?(): any; /** [Method] Returns the Component for a given index in the Container s items * @param index Number The index of the Component to return. + * @returns Ext.Component The item at the specified index, if found. */ getAt?( index?:number ): Ext.IComponent; - /** [Method] Returns the value of autoDestroy */ + /** [Method] Returns the value of autoDestroy + * @returns Boolean + */ getAutoDestroy?(): boolean; /** [Method] Examines this container s items property and gets a direct child component of this container * @param component String/Number This parameter may be any of the following: {String} : representing the itemId or id of the child component. {Number} : representing the position of the child component within the items property. For additional information see Ext.util.MixedCollection.get. + * @returns Ext.Component The component (if found). + */ + getComponent?( component?:any ): Ext.IComponent; + /** [Method] Returns the value of control + * @returns Object */ - getComponent?( component?:any ): any; - getComponent?( component?:string ): Ext.IComponent; - getComponent?( component?:number ): Ext.IComponent; - /** [Method] Returns the value of control */ getControl?(): any; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ getDefaults?(): any; /** [Method] Finds a docked item of this container using a reference idor an index of its location in getDockedItems * @param component String/Number The id or index of the component to find. + * @returns Ext.Component/Boolean The docked component, if found. */ getDockedComponent?( component?:any ): any; - getDockedComponent?( component?:string ): Ext.IComponent; - getDockedComponent?( component?:number ): Ext.IComponent; - /** [Method] Returns all the Ext Component docked items in this container */ + /** [Method] Returns all the Ext Component docked items in this container + * @returns Array The docked items of this container. + */ getDockedItems?(): any[]; - /** [Method] Returns the value of hideOnMaskTap */ + /** [Method] Returns the value of hideOnMaskTap + * @returns Boolean + */ getHideOnMaskTap?(): boolean; - /** [Method] Returns all inner items of this container */ + /** [Method] Returns all inner items of this container + * @returns Array The inner items of this container. + */ getInnerItems?(): any[]; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ getItems?(): any; - /** [Method] Returns the value of masked */ + /** [Method] Returns the value of masked + * @returns Boolean/Object/Ext.Mask/Ext.LoadMask + */ getMasked?(): any; - /** [Method] Returns the value of modal */ + /** [Method] Returns the value of modal + * @returns Boolean + */ getModal?(): boolean; - /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class */ + /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class + * @returns Ext.scroll.View The scroll view. + */ getScrollable?(): Ext.scroll.IView; /** [Method] Adds a child Component at the given index * @param index Number The index to insert the Component at. @@ -6651,29 +7384,35 @@ declare module Ext.lib { mask?( mask?:any ): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. + * @returns Array Ext.Component's which matched the selector. */ query?( selector?:string ): any[]; /** [Method] Removes an item from this Container optionally destroying it * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ remove?( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes all items currently in the Container optionally destroying them all * @param destroy Boolean If true, destroys each removed Component. * @param everything Boolean If true, completely remove all items including docked / centered and floating items. + * @returns Ext.Component this */ removeAll?( destroy?:boolean, everything?:boolean ): Ext.IComponent; /** [Method] Removes the Component at the specified index myContainer removeAt 0 removes the first item * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ removeAt?( index?:number ): Ext.IContainer; /** [Method] Removes a docked item from this Container * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ removeDocked?( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes an inner Component at the specified index myContainer removeInnerAt 0 removes the first item of the in * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ removeInnerAt?( index?:number ): Ext.IContainer; /** [Method] Sets the value of activeItem @@ -6728,7 +7467,9 @@ declare module Ext.data { export interface IArrayStore extends Ext.data.IStore { /** [Config Option] (String/Ext.data.proxy.Proxy/Object) */ proxy?: any; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Object + */ getProxy?(): any; /** [Method] Loads an array of data straight into the Store * @param data Object @@ -6757,23 +7498,41 @@ declare module Ext.data.association { reader?: Ext.data.reader.IReader; /** [Config Option] (String) */ type?: string; - /** [Method] Returns the value of associatedModel */ + /** [Method] Returns the value of associatedModel + * @returns String + */ getAssociatedModel?(): string; - /** [Method] Returns the value of associatedName */ + /** [Method] Returns the value of associatedName + * @returns String + */ getAssociatedName?(): string; - /** [Method] Returns the value of associationKey */ + /** [Method] Returns the value of associationKey + * @returns String + */ getAssociationKey?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns Object + */ getName?(): any; - /** [Method] Returns the value of ownerModel */ + /** [Method] Returns the value of ownerModel + * @returns Ext.data.Model/String + */ getOwnerModel?(): any; - /** [Method] Returns the value of ownerName */ + /** [Method] Returns the value of ownerName + * @returns String + */ getOwnerName?(): string; - /** [Method] Returns the value of primaryKey */ + /** [Method] Returns the value of primaryKey + * @returns String + */ getPrimaryKey?(): string; - /** [Method] Returns the value of reader */ + /** [Method] Returns the value of reader + * @returns Ext.data.reader.Reader + */ getReader?(): Ext.data.reader.IReader; - /** [Method] Returns the value of type */ + /** [Method] Returns the value of type + * @returns String + */ getType?(): string; /** [Method] Sets the value of associatedModel * @param associatedModel String @@ -6794,9 +7553,7 @@ declare module Ext.data.association { /** [Method] Sets the value of ownerModel * @param ownerModel Ext.data.Model/String */ - setOwnerModel?( ownerModel?:any ): any; - setOwnerModel?( ownerModel?:Ext.data.IModel ): void; - setOwnerModel?( ownerModel?:string ): void; + setOwnerModel?( ownerModel?:any ): void; /** [Method] Sets the value of ownerName * @param ownerName String */ @@ -6831,23 +7588,41 @@ declare module Ext.data { reader?: Ext.data.reader.IReader; /** [Config Option] (String) */ type?: string; - /** [Method] Returns the value of associatedModel */ + /** [Method] Returns the value of associatedModel + * @returns String + */ getAssociatedModel?(): string; - /** [Method] Returns the value of associatedName */ + /** [Method] Returns the value of associatedName + * @returns String + */ getAssociatedName?(): string; - /** [Method] Returns the value of associationKey */ + /** [Method] Returns the value of associationKey + * @returns String + */ getAssociationKey?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns Object + */ getName?(): any; - /** [Method] Returns the value of ownerModel */ + /** [Method] Returns the value of ownerModel + * @returns Ext.data.Model/String + */ getOwnerModel?(): any; - /** [Method] Returns the value of ownerName */ + /** [Method] Returns the value of ownerName + * @returns String + */ getOwnerName?(): string; - /** [Method] Returns the value of primaryKey */ + /** [Method] Returns the value of primaryKey + * @returns String + */ getPrimaryKey?(): string; - /** [Method] Returns the value of reader */ + /** [Method] Returns the value of reader + * @returns Ext.data.reader.Reader + */ getReader?(): Ext.data.reader.IReader; - /** [Method] Returns the value of type */ + /** [Method] Returns the value of type + * @returns String + */ getType?(): string; /** [Method] Sets the value of associatedModel * @param associatedModel String @@ -6868,9 +7643,7 @@ declare module Ext.data { /** [Method] Sets the value of ownerModel * @param ownerModel Ext.data.Model/String */ - setOwnerModel?( ownerModel?:any ): any; - setOwnerModel?( ownerModel?:Ext.data.IModel ): void; - setOwnerModel?( ownerModel?:string ): void; + setOwnerModel?( ownerModel?:any ): void; /** [Method] Sets the value of ownerName * @param ownerName String */ @@ -6897,13 +7670,21 @@ declare module Ext.data.association { getterName?: string; /** [Config Option] (String) */ setterName?: string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of getterName */ + /** [Method] Returns the value of getterName + * @returns String + */ getGetterName?(): string; - /** [Method] Returns the value of instanceName */ + /** [Method] Returns the value of instanceName + * @returns Object + */ getInstanceName?(): any; - /** [Method] Returns the value of setterName */ + /** [Method] Returns the value of setterName + * @returns String + */ getSetterName?(): string; /** [Method] Sets the value of foreignKey * @param foreignKey String @@ -6931,13 +7712,21 @@ declare module Ext.data { getterName?: string; /** [Config Option] (String) */ setterName?: string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of getterName */ + /** [Method] Returns the value of getterName + * @returns String + */ getGetterName?(): string; - /** [Method] Returns the value of instanceName */ + /** [Method] Returns the value of instanceName + * @returns Object + */ getInstanceName?(): any; - /** [Method] Returns the value of setterName */ + /** [Method] Returns the value of setterName + * @returns String + */ getSetterName?(): string; /** [Method] Sets the value of foreignKey * @param foreignKey String @@ -6975,17 +7764,29 @@ declare module Ext.data.association { storeConfig?: any; /** [Config Option] (String) */ storeName?: string; - /** [Method] Returns the value of autoLoad */ + /** [Method] Returns the value of autoLoad + * @returns Boolean + */ getAutoLoad?(): boolean; - /** [Method] Returns the value of autoSync */ + /** [Method] Returns the value of autoSync + * @returns Boolean + */ getAutoSync?(): boolean; - /** [Method] Returns the value of filterProperty */ + /** [Method] Returns the value of filterProperty + * @returns String + */ getFilterProperty?(): string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Object + */ getStore?(): any; - /** [Method] Returns the value of storeName */ + /** [Method] Returns the value of storeName + * @returns String + */ getStoreName?(): string; /** [Method] Sets the value of autoLoad * @param autoLoad Boolean @@ -7031,17 +7832,29 @@ declare module Ext.data { storeConfig?: any; /** [Config Option] (String) */ storeName?: string; - /** [Method] Returns the value of autoLoad */ + /** [Method] Returns the value of autoLoad + * @returns Boolean + */ getAutoLoad?(): boolean; - /** [Method] Returns the value of autoSync */ + /** [Method] Returns the value of autoSync + * @returns Boolean + */ getAutoSync?(): boolean; - /** [Method] Returns the value of filterProperty */ + /** [Method] Returns the value of filterProperty + * @returns String + */ getFilterProperty?(): string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Object + */ getStore?(): any; - /** [Method] Returns the value of storeName */ + /** [Method] Returns the value of storeName + * @returns String + */ getStoreName?(): string; /** [Method] Sets the value of autoLoad * @param autoLoad Boolean @@ -7077,13 +7890,21 @@ declare module Ext.data.association { getterName?: string; /** [Config Option] (String) */ setterName?: string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of getterName */ + /** [Method] Returns the value of getterName + * @returns String + */ getGetterName?(): string; - /** [Method] Returns the value of instanceName */ + /** [Method] Returns the value of instanceName + * @returns Object + */ getInstanceName?(): any; - /** [Method] Returns the value of setterName */ + /** [Method] Returns the value of setterName + * @returns String + */ getSetterName?(): string; /** [Method] Sets the value of foreignKey * @param foreignKey String @@ -7111,13 +7932,21 @@ declare module Ext.data { getterName?: string; /** [Config Option] (String) */ setterName?: string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of getterName */ + /** [Method] Returns the value of getterName + * @returns String + */ getGetterName?(): string; - /** [Method] Returns the value of instanceName */ + /** [Method] Returns the value of instanceName + * @returns Object + */ getInstanceName?(): any; - /** [Method] Returns the value of setterName */ + /** [Method] Returns the value of setterName + * @returns String + */ getSetterName?(): string; /** [Method] Sets the value of foreignKey * @param foreignKey String @@ -7167,16 +7996,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -7188,9 +8015,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -7198,9 +8023,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -7208,33 +8031,44 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of autoStart */ + /** [Method] Returns the value of autoStart + * @returns Boolean + */ getAutoStart?(): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of pauseOnException */ + /** [Method] Returns the value of pauseOnException + * @returns Boolean + */ getPauseOnException?(): boolean; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Ext.data.Proxy + */ getProxy?(): Ext.data.IProxy; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -7244,18 +8078,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -7263,30 +8093,27 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Pauses execution of the batch but does not cancel the current operation */ pause?(): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -7295,16 +8122,14 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -7312,18 +8137,14 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -7339,9 +8160,7 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -7365,25 +8184,21 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.data { @@ -7418,16 +8233,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -7439,9 +8252,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -7449,9 +8260,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -7459,61 +8268,97 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of async */ + /** [Method] Returns the value of async + * @returns Boolean + */ getAsync?(): boolean; - /** [Method] Returns the value of autoAbort */ + /** [Method] Returns the value of autoAbort + * @returns Boolean + */ getAutoAbort?(): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of defaultHeaders */ + /** [Method] Returns the value of defaultHeaders + * @returns Object + */ getDefaultHeaders?(): any; - /** [Method] Returns the value of defaultPostHeader */ + /** [Method] Returns the value of defaultPostHeader + * @returns String + */ getDefaultPostHeader?(): string; - /** [Method] Returns the value of defaultXhrHeader */ + /** [Method] Returns the value of defaultXhrHeader + * @returns String + */ getDefaultXhrHeader?(): string; - /** [Method] Returns the value of disableCaching */ + /** [Method] Returns the value of disableCaching + * @returns Boolean + */ getDisableCaching?(): boolean; - /** [Method] Returns the value of disableCachingParam */ + /** [Method] Returns the value of disableCachingParam + * @returns String + */ getDisableCachingParam?(): string; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ getExtraParams?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns String + */ getMethod?(): string; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ getPassword?(): string; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; - /** [Method] Returns the value of useDefaultHeader */ + /** [Method] Returns the value of useDefaultHeader + * @returns Boolean + */ getUseDefaultHeader?(): boolean; - /** [Method] Returns the value of useDefaultXhrHeader */ + /** [Method] Returns the value of useDefaultXhrHeader + * @returns Boolean + */ getUseDefaultXhrHeader?(): boolean; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ getUsername?(): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Determines whether this object has a request outstanding * @param request Object The request to check. + * @returns Boolean True if there is an outstanding request. */ isLoading?( request?:any ): boolean; /** [Method] Alias for addManagedListener @@ -7523,18 +8368,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -7542,33 +8383,31 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Checks if the response status was successful * @param status Number The status code. * @param xhr Object + * @returns Object An object containing success/status state. */ parseStatus?( status?:number, xhr?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -7577,16 +8416,14 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -7594,20 +8431,17 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Sends an HTTP request to a remote server * @param options Object An object which may contain the following properties: (The options object may also contain any other property which might be needed to perform post-processing in a callback because it is passed to callback functions.) + * @returns Object/null The request object. This may be used to cancel the request. */ request?( options?:any ): any; /** [Method] Resumes firing events see suspendEvents @@ -7625,9 +8459,7 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of defaultHeaders * @param defaultHeaders Object */ @@ -7663,6 +8495,7 @@ declare module Ext.data { /** [Method] Sets various options such as the url params for the request * @param options Object The initial options. * @param scope Object The scope to execute in. + * @returns Object The params for the request. */ setOptions?( options?:any, scope?:any ): any; /** [Method] Sets the value of password @@ -7698,42 +8531,37 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Uploads a form using a hidden iframe * @param form String/HTMLElement/Ext.Element The form to upload. * @param url String The url to post to. * @param params String Any extra parameters to pass. * @param options Object The initial options. */ - upload?( form?:any, url?:any, params?:any, options?:any ): any; - upload?( form?:string, url?:string, params?:string, options?:any ): void; - upload?( form?:HTMLElement, url?:string, params?:string, options?:any ): void; - upload?( form?:Ext.IElement, url?:string, params?:string, options?:any ): void; + upload?( form?:any, url?:string, params?:string, options?:any ): void; } } declare module Ext.data { export interface IDirectStore extends Ext.data.IStore { /** [Config Option] (String/Ext.data.proxy.Proxy/Object) */ proxy?: any; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Object + */ getProxy?(): any; /** [Method] Sets the value of proxy * @param proxy Object @@ -7747,9 +8575,13 @@ declare module Ext.data { field?: string; /** [Config Option] (String) */ message?: string; - /** [Method] Returns the value of field */ + /** [Method] Returns the value of field + * @returns String + */ getField?(): string; - /** [Method] Returns the value of message */ + /** [Method] Returns the value of message + * @returns String + */ getMessage?(): string; /** [Method] Sets the value of field * @param field String @@ -7763,13 +8595,18 @@ declare module Ext.data { } declare module Ext.data { export interface IErrors extends Ext.util.ICollection { - /** [Method] Adds an item to the collection */ + /** [Method] Adds an item to the collection + * @returns Object The item added. + */ add?(): any; /** [Method] Returns all of the errors for the given field * @param fieldName String The field to get errors for. + * @returns Object[] All errors for the given field. */ getByField?( fieldName?:string ): any[]; - /** [Method] Returns true if there are no errors in the collection */ + /** [Method] Returns true if there are no errors in the collection + * @returns Boolean + */ isValid?(): boolean; } } @@ -7797,31 +8634,57 @@ declare module Ext.data { type?: any; /** [Config Option] (Boolean) */ useNull?: boolean; - /** [Method] Returns the value of allowNull */ + /** [Method] Returns the value of allowNull + * @returns Boolean + */ getAllowNull?(): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String + */ getBubbleEvents?(): string; - /** [Method] Returns the value of convert */ + /** [Method] Returns the value of convert + * @returns Function + */ getConvert?(): any; - /** [Method] Returns the value of dateFormat */ + /** [Method] Returns the value of dateFormat + * @returns String + */ getDateFormat?(): string; - /** [Method] Returns the value of decode */ + /** [Method] Returns the value of decode + * @returns Object + */ getDecode?(): any; - /** [Method] Returns the value of defaultValue */ + /** [Method] Returns the value of defaultValue + * @returns Object + */ getDefaultValue?(): any; - /** [Method] Returns the value of encode */ + /** [Method] Returns the value of encode + * @returns Object + */ getEncode?(): any; - /** [Method] Returns the value of mapping */ + /** [Method] Returns the value of mapping + * @returns String/Number + */ getMapping?(): any; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of persist */ + /** [Method] Returns the value of persist + * @returns Boolean + */ getPersist?(): boolean; - /** [Method] Returns the value of sortDir */ + /** [Method] Returns the value of sortDir + * @returns String + */ getSortDir?(): string; - /** [Method] Returns the value of sortType */ + /** [Method] Returns the value of sortType + * @returns Function + */ getSortType?(): any; - /** [Method] Returns the value of type */ + /** [Method] Returns the value of type + * @returns String/Object + */ getType?(): any; /** [Method] Sets the value of allowNull * @param allowNull Boolean @@ -7854,9 +8717,7 @@ declare module Ext.data { /** [Method] Sets the value of mapping * @param mapping String/Number */ - setMapping?( mapping?:any ): any; - setMapping?( mapping?:string ): void; - setMapping?( mapping?:number ): void; + setMapping?( mapping?:any ): void; /** [Method] Sets the value of name * @param name String */ @@ -7885,9 +8746,13 @@ declare module Ext.data.identifier { prefix?: string; /** [Config Option] (Number) */ seed?: number; - /** [Method] Returns the value of prefix */ + /** [Method] Returns the value of prefix + * @returns String + */ getPrefix?(): string; - /** [Method] Returns the value of seed */ + /** [Method] Returns the value of seed + * @returns Number + */ getSeed?(): number; /** [Method] Sets the value of prefix * @param prefix String @@ -7901,7 +8766,9 @@ declare module Ext.data.identifier { } declare module Ext.data.identifier { export interface ISimple extends Ext.IBase { - /** [Method] Returns the value of prefix */ + /** [Method] Returns the value of prefix + * @returns String + */ getPrefix?(): string; /** [Method] Sets the value of prefix * @param prefix String @@ -7919,9 +8786,13 @@ declare module Ext.data.identifier { salt?: any; /** [Property] (Number/Object) */ timestamp?: any; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns Object + */ getId?(): any; - /** [Method] Returns the value of version */ + /** [Method] Returns the value of version + * @returns Number + */ getVersion?(): number; /** [Method] Reconfigures this generator given new config properties * @param config Object @@ -7947,34 +8818,39 @@ declare module Ext.data { static abort( request?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Makes a JSONP request * @param options Object An object which may contain the following properties. Note that options will take priority over any defaults that are specified in the class. + * @returns Object request An object containing the request details. */ static request( options?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -7988,34 +8864,39 @@ declare module Ext.util { static abort( request?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Makes a JSONP request * @param options Object An object which may contain the following properties. Note that options will take priority over any defaults that are specified in the class. + * @returns Object request An object containing the request details. */ static request( options?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -8023,7 +8904,9 @@ declare module Ext.data { export interface IJsonStore extends Ext.data.IStore { /** [Config Option] (String/Ext.data.proxy.Proxy/Object) */ proxy?: any; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Object + */ getProxy?(): any; /** [Method] Sets the value of proxy * @param proxy Object @@ -8073,16 +8956,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -8094,9 +8975,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -8104,9 +8983,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Begins an edit */ beginEdit?(): void; /** [Method] Cancels all changes made in the current edit operation */ @@ -8119,6 +8996,7 @@ declare module Ext.data { commit?( silent?:boolean ): void; /** [Method] Creates a copy clone of this Model instance * @param id String A new id. If you don't specify this a new id will be generated for you. To generate a phantom instance with a new id use: var rec = record.copy(); // clone the record with a new id + * @returns Ext.data.Model */ copy?( id?:string ): Ext.data.IModel; /** [Method] Destroys this model instance */ @@ -8126,9 +9004,7 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Ends an edit * @param silent Boolean true to not notify the store of the change. * @param modifiedFieldNames String[] Array of field names changed during edit. @@ -8137,6 +9013,7 @@ declare module Ext.data { /** [Method] Destroys the record using the configured proxy * @param options Object/Function Options to pass to the proxy. Config object for Ext.data.Operation. If you pass a function, this will automatically become the callback method. For convenience the config object may also contain success and failure methods in addition to callback - they will all be invoked with the Model and Operation as arguments. * @param scope Object The scope to run your callback method in. This is only used if you passed a function as the first argument. + * @returns Ext.data.Model The Model instance. */ erase?( options?:any, scope?:any ): Ext.data.IModel; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste @@ -8144,64 +9021,104 @@ declare module Ext.data { * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Returns the value of the given field * @param fieldName String The field to fetch the value for. + * @returns Object The value. */ get?( fieldName?:string ): any; - /** [Method] Gets all of the data from this Models loaded associations */ + /** [Method] Gets all of the data from this Models loaded associations + * @returns Object The nested data set for the Model's loaded associations. + */ getAssociatedData?(): any; - /** [Method] Returns the value of associations */ + /** [Method] Returns the value of associations + * @returns Object[] + */ getAssociations?(): any[]; - /** [Method] Returns the value of belongsTo */ + /** [Method] Returns the value of belongsTo + * @returns String/Object/String[]/Object[] + */ getBelongsTo?(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Gets a hash of only the fields that have been modified since this Model was created or committed */ + /** [Method] Gets a hash of only the fields that have been modified since this Model was created or committed + * @returns Object + */ getChanges?(): any; - /** [Method] Returns the value of clientIdProperty */ + /** [Method] Returns the value of clientIdProperty + * @returns String + */ getClientIdProperty?(): string; /** [Method] Returns an object containing the data set on this record * @param includeAssociated Boolean true to include the associated data. + * @returns Object The data. */ getData?( includeAssociated?:boolean ): any; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Object[]/String[] + */ getFields?(): any; - /** [Method] Returns the value of hasMany */ + /** [Method] Returns the value of hasMany + * @returns String/Object/String[]/Object[] + */ getHasMany?(): any; - /** [Method] Returns the value of hasOne */ + /** [Method] Returns the value of hasOne + * @returns String/Object/String[]/Object[] + */ getHasOne?(): any; - /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty */ - getId?(): string; - /** [Method] Returns the value of idProperty */ + /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty + * @returns Number/String The id. + */ + getId?(): any; + /** [Method] Returns the value of idProperty + * @returns String + */ getIdProperty?(): string; - /** [Method] Returns the value of identifier */ + /** [Method] Returns the value of identifier + * @returns Object/String + */ getIdentifier?(): any; /** [Method] Returns true if the record has been erased on the server */ getIsErased?(): void; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Object/Ext.data.Proxy + */ getProxy?(): any; - /** [Method] Returns the value of useCache */ + /** [Method] Returns the value of useCache + * @returns Boolean + */ getUseCache?(): boolean; - /** [Method] Returns the value of validations */ + /** [Method] Returns the value of validations + * @returns Object[] + */ getValidations?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Returns true if the passed field name has been modified since the load or last commit * @param fieldName String Ext.data.Field.name + * @returns Boolean */ isModified?( fieldName?:string ): boolean; - /** [Method] Checks if the model is valid */ + /** [Method] Checks if the model is valid + * @returns Boolean true if the model is valid. + */ isValid?(): boolean; /** [Method] By joining this model to an instance of a class this model will automatically try to call certain template methods o * @param store Ext.data.Store The store to which this model has been added. @@ -8214,18 +9131,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -8233,25 +9146,21 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Usually called by the Ext data Store to which this model instance has been joined * @param silent Boolean true to skip notification of the owning store of the change. */ @@ -8259,6 +9168,7 @@ declare module Ext.data { /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -8267,45 +9177,37 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. - * @param scope Object The scope originally specified for the handler. It must be the same as the scope argument specified in - * the original call to addListener or the listener will not be removed. + * @param scope Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed. * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ resumeEvents?( discardQueuedEvents?:boolean ): void; /** [Method] Saves the model instance using the configured proxy - * @param options Object/Function Options to pass to the proxy. Config object for Ext.data.Operation. If you pass a function, this - * will automatically become the callback method. For convenience the config object may also contain success and failure methods in - * addition to callback - they will all be invoked with the Model and Operation as arguments. + * @param options Object/Function Options to pass to the proxy. Config object for Ext.data.Operation. If you pass a function, this will automatically become the callback method. For convenience the config object may also contain success and failure methods in addition to callback - they will all be invoked with the Model and Operation as arguments. * @param scope Object The scope to run your callback method in. This is only used if you passed a function as the first argument. + * @returns Ext.data.Model The Model instance */ save?( options?:any, scope?:any ): Ext.data.IModel; /** [Method] Sets the given field to the given value marks the instance as dirty @@ -8324,25 +9226,26 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of clientIdProperty * @param clientIdProperty String */ setClientIdProperty?( clientIdProperty?:string ): void; /** [Method] This sets the data directly without converting and applying default values * @param data Object + * @returns Ext.data.Model This Record. */ setConvertedData?( data?:any ): Ext.data.IModel; /** [Method] This method is used to set the data for this Record instance * @param rawData Object + * @returns Ext.data.Model This record. */ setData?( rawData?:any ): Ext.data.IModel; /** [Method] Marks this Record as dirty */ setDirty?(): void; /** [Method] Updates the collection of Fields that all instances of this Model use * @param fields Array + * @returns any */ setFields?( fields?:any[] ): any; /** [Method] Sets the value of hasMany @@ -8356,9 +9259,7 @@ declare module Ext.data { /** [Method] Sets the model instance s id field to the given id * @param id Number/String The new id */ - setId?( id?:any ): any; - setId?( id?:number ): void; - setId?( id?:string ): void; + setId?( id?:any ): void; /** [Method] Sets the value of idProperty * @param idProperty String */ @@ -8385,7 +9286,9 @@ declare module Ext.data { setValidations?( validations?:any[] ): void; /** [Method] Suspends the firing of all events */ suspendEvents?(): void; - /** [Method] Returns a url suitable string for this model instance */ + /** [Method] Returns a url suitable string for this model instance + * @returns String The url string for this model instance. + */ toUrl?(): string; /** [Method] Alias for removeListener * @param eventName String/String[]/Object The type of event the handler was associated with. @@ -8394,30 +9297,28 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] This un joins this record from an instance of a class * @param store Ext.data.Store The store from which this model has been removed. */ unjoin?( store?:Ext.data.IStore ): void; - /** [Method] Validates the current data against all of its configured validations */ + /** [Method] Validates the current data against all of its configured validations + * @returns Ext.data.Errors The errors object. + */ validate?(): Ext.data.IErrors; } export class Model { @@ -8427,20 +9328,25 @@ declare module Ext.data { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] * @param args Object */ static callParent( args?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter * @param origin String/Object The original method name */ static createAlias( alias?:any, origin?:any ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Asynchronously loads a model instance by id * @param id Number The id of the model to load @@ -8450,6 +9356,7 @@ declare module Ext.data { static load( id?:number, config?:any, scope?:any ): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -8496,16 +9403,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -8517,9 +9422,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -8527,9 +9430,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Begins an edit */ beginEdit?(): void; /** [Method] Cancels all changes made in the current edit operation */ @@ -8542,6 +9443,7 @@ declare module Ext.data { commit?( silent?:boolean ): void; /** [Method] Creates a copy clone of this Model instance * @param id String A new id. If you don't specify this a new id will be generated for you. To generate a phantom instance with a new id use: var rec = record.copy(); // clone the record with a new id + * @returns Ext.data.Model */ copy?( id?:string ): Ext.data.IModel; /** [Method] Destroys this model instance */ @@ -8549,9 +9451,7 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Ends an edit * @param silent Boolean true to not notify the store of the change. * @param modifiedFieldNames String[] Array of field names changed during edit. @@ -8560,6 +9460,7 @@ declare module Ext.data { /** [Method] Destroys the record using the configured proxy * @param options Object/Function Options to pass to the proxy. Config object for Ext.data.Operation. If you pass a function, this will automatically become the callback method. For convenience the config object may also contain success and failure methods in addition to callback - they will all be invoked with the Model and Operation as arguments. * @param scope Object The scope to run your callback method in. This is only used if you passed a function as the first argument. + * @returns Ext.data.Model The Model instance. */ erase?( options?:any, scope?:any ): Ext.data.IModel; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste @@ -8567,64 +9468,104 @@ declare module Ext.data { * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Returns the value of the given field * @param fieldName String The field to fetch the value for. + * @returns Object The value. */ get?( fieldName?:string ): any; - /** [Method] Gets all of the data from this Models loaded associations */ + /** [Method] Gets all of the data from this Models loaded associations + * @returns Object The nested data set for the Model's loaded associations. + */ getAssociatedData?(): any; - /** [Method] Returns the value of associations */ + /** [Method] Returns the value of associations + * @returns Object[] + */ getAssociations?(): any[]; - /** [Method] Returns the value of belongsTo */ + /** [Method] Returns the value of belongsTo + * @returns String/Object/String[]/Object[] + */ getBelongsTo?(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Gets a hash of only the fields that have been modified since this Model was created or committed */ + /** [Method] Gets a hash of only the fields that have been modified since this Model was created or committed + * @returns Object + */ getChanges?(): any; - /** [Method] Returns the value of clientIdProperty */ + /** [Method] Returns the value of clientIdProperty + * @returns String + */ getClientIdProperty?(): string; /** [Method] Returns an object containing the data set on this record * @param includeAssociated Boolean true to include the associated data. + * @returns Object The data. */ getData?( includeAssociated?:boolean ): any; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Object[]/String[] + */ getFields?(): any; - /** [Method] Returns the value of hasMany */ + /** [Method] Returns the value of hasMany + * @returns String/Object/String[]/Object[] + */ getHasMany?(): any; - /** [Method] Returns the value of hasOne */ + /** [Method] Returns the value of hasOne + * @returns String/Object/String[]/Object[] + */ getHasOne?(): any; - /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty */ - getId?(): string; - /** [Method] Returns the value of idProperty */ + /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty + * @returns Number/String The id. + */ + getId?(): any; + /** [Method] Returns the value of idProperty + * @returns String + */ getIdProperty?(): string; - /** [Method] Returns the value of identifier */ + /** [Method] Returns the value of identifier + * @returns Object/String + */ getIdentifier?(): any; /** [Method] Returns true if the record has been erased on the server */ getIsErased?(): void; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Object/Ext.data.Proxy + */ getProxy?(): any; - /** [Method] Returns the value of useCache */ + /** [Method] Returns the value of useCache + * @returns Boolean + */ getUseCache?(): boolean; - /** [Method] Returns the value of validations */ + /** [Method] Returns the value of validations + * @returns Object[] + */ getValidations?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Returns true if the passed field name has been modified since the load or last commit * @param fieldName String Ext.data.Field.name + * @returns Boolean */ isModified?( fieldName?:string ): boolean; - /** [Method] Checks if the model is valid */ + /** [Method] Checks if the model is valid + * @returns Boolean true if the model is valid. + */ isValid?(): boolean; /** [Method] By joining this model to an instance of a class this model will automatically try to call certain template methods o * @param store Ext.data.Store The store to which this model has been added. @@ -8637,18 +9578,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -8656,25 +9593,21 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Usually called by the Ext data Store to which this model instance has been joined * @param silent Boolean true to skip notification of the owning store of the change. */ @@ -8682,6 +9615,7 @@ declare module Ext.data { /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -8690,16 +9624,14 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -8707,18 +9639,14 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -8726,6 +9654,7 @@ declare module Ext.data { /** [Method] Saves the model instance using the configured proxy * @param options Object/Function Options to pass to the proxy. Config object for Ext.data.Operation. If you pass a function, this will automatically become the callback method. For convenience the config object may also contain success and failure methods in addition to callback - they will all be invoked with the Model and Operation as arguments. * @param scope Object The scope to run your callback method in. This is only used if you passed a function as the first argument. + * @returns Ext.data.Model The Model instance */ save?( options?:any, scope?:any ): Ext.data.IModel; /** [Method] Sets the given field to the given value marks the instance as dirty @@ -8744,25 +9673,26 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of clientIdProperty * @param clientIdProperty String */ setClientIdProperty?( clientIdProperty?:string ): void; /** [Method] This sets the data directly without converting and applying default values * @param data Object + * @returns Ext.data.Model This Record. */ setConvertedData?( data?:any ): Ext.data.IModel; /** [Method] This method is used to set the data for this Record instance * @param rawData Object + * @returns Ext.data.Model This record. */ setData?( rawData?:any ): Ext.data.IModel; /** [Method] Marks this Record as dirty */ setDirty?(): void; /** [Method] Updates the collection of Fields that all instances of this Model use * @param fields Array + * @returns any */ setFields?( fields?:any[] ): any; /** [Method] Sets the value of hasMany @@ -8776,9 +9706,7 @@ declare module Ext.data { /** [Method] Sets the model instance s id field to the given id * @param id Number/String The new id */ - setId?( id?:any ): any; - setId?( id?:number ): void; - setId?( id?:string ): void; + setId?( id?:any ): void; /** [Method] Sets the value of idProperty * @param idProperty String */ @@ -8805,7 +9733,9 @@ declare module Ext.data { setValidations?( validations?:any[] ): void; /** [Method] Suspends the firing of all events */ suspendEvents?(): void; - /** [Method] Returns a url suitable string for this model instance */ + /** [Method] Returns a url suitable string for this model instance + * @returns String The url string for this model instance. + */ toUrl?(): string; /** [Method] Alias for removeListener * @param eventName String/String[]/Object The type of event the handler was associated with. @@ -8814,30 +9744,28 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] This un joins this record from an instance of a class * @param store Ext.data.Store The store from which this model has been removed. */ unjoin?( store?:Ext.data.IStore ): void; - /** [Method] Validates the current data against all of its configured validations */ + /** [Method] Validates the current data against all of its configured validations + * @returns Ext.data.Errors The errors object. + */ validate?(): Ext.data.IErrors; } export class Record { @@ -8847,20 +9775,25 @@ declare module Ext.data { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] * @param args Object */ static callParent( args?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter * @param origin String/Object The original method name */ static createAlias( alias?:any, origin?:any ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Asynchronously loads a model instance by id * @param id Number The id of the model to load @@ -8870,6 +9803,7 @@ declare module Ext.data { static load( id?:number, config?:any, scope?:any ): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -8880,23 +9814,24 @@ declare module Ext.data { export class ModelManager { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new instance of a Model using the given data * @param data Object Data to initialize the Model's fields with. * @param name String The name of the model to create. * @param id Number Unique id of the Model instance (see Ext.data.Model). + * @returns Object */ static create( data?:any, name?:string, id?:number ): any; /** [Method] */ @@ -8908,24 +9843,31 @@ declare module Ext.data { static each( fn?:any, scope?:any ): void; /** [Method] Returns an item by id * @param id String The id of the item. + * @returns Object The item, undefined if not found. */ static get( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ static getCount(): number; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Returns the Ext data Model for a given model name * @param id String/Object The id of the model or the model instance. + * @returns Ext.data.Model A model class. */ static getModel( id?:any ): Ext.data.IModel; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up. + * @returns Boolean Whether the type is registered. */ static isRegistered( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -8941,9 +9883,12 @@ declare module Ext.data { /** [Method] Registers a model definition * @param name Object * @param config Object + * @returns Object */ static registerType( name?:any, config?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param item Object The item to unregister. @@ -8957,23 +9902,24 @@ declare module Ext { export class ModelMgr { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new instance of a Model using the given data * @param data Object Data to initialize the Model's fields with. * @param name String The name of the model to create. * @param id Number Unique id of the Model instance (see Ext.data.Model). + * @returns Object */ static create( data?:any, name?:string, id?:number ): any; /** [Method] */ @@ -8985,24 +9931,31 @@ declare module Ext { static each( fn?:any, scope?:any ): void; /** [Method] Returns an item by id * @param id String The id of the item. + * @returns Object The item, undefined if not found. */ static get( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ static getCount(): number; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Returns the Ext data Model for a given model name * @param id String/Object The id of the model or the model instance. + * @returns Ext.data.Model A model class. */ static getModel( id?:any ): Ext.data.IModel; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up. + * @returns Boolean Whether the type is registered. */ static isRegistered( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -9018,9 +9971,12 @@ declare module Ext { /** [Method] Registers a model definition * @param name Object * @param config Object + * @returns Object */ static registerType( name?:any, config?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param item Object The item to unregister. @@ -9034,23 +9990,24 @@ declare module Ext { export class ModelManager { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new instance of a Model using the given data * @param data Object Data to initialize the Model's fields with. * @param name String The name of the model to create. * @param id Number Unique id of the Model instance (see Ext.data.Model). + * @returns Object */ static create( data?:any, name?:string, id?:number ): any; /** [Method] */ @@ -9062,24 +10019,31 @@ declare module Ext { static each( fn?:any, scope?:any ): void; /** [Method] Returns an item by id * @param id String The id of the item. + * @returns Object The item, undefined if not found. */ static get( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ static getCount(): number; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Returns the Ext data Model for a given model name * @param id String/Object The id of the model or the model instance. + * @returns Ext.data.Model A model class. */ static getModel( id?:any ): Ext.data.IModel; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up. + * @returns Boolean Whether the type is registered. */ static isRegistered( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -9095,9 +10059,12 @@ declare module Ext { /** [Method] Registers a model definition * @param name Object * @param config Object + * @returns Object */ static registerType( name?:any, config?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param item Object The item to unregister. @@ -9121,10 +10088,9 @@ declare module Ext.data { previousSibling?: any; /** [Method] Insert node s as the last child node of this node * @param node Ext.data.NodeInterface/Ext.data.NodeInterface[] The node or Array of nodes to append. + * @returns Ext.data.NodeInterface The appended node if single append, or null if an array was passed. */ - appendChild?( node?:any ): any; - appendChild?( node?:Ext.data.INodeInterface ): Ext.data.INodeInterface; - appendChild?( node?:Ext.data.INodeInterface[] ): Ext.data.INodeInterface; + appendChild?( node?:any ): Ext.data.INodeInterface; /** [Method] Bubbles up the tree from this node calling the specified function with each node * @param fn Function The function to call. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the current Node. @@ -9145,11 +10111,13 @@ declare module Ext.data { collapse?( recursive?:any, callback?:any, scope?:any ): void; /** [Method] Returns true if this node is an ancestor at any point of the passed node * @param node Ext.data.NodeInterface + * @returns Boolean */ contains?( node?:Ext.data.INodeInterface ): boolean; /** [Method] Creates a copy clone of this Node * @param newId String A new id, defaults to this Node's id. * @param deep Boolean If passed as true, all child Nodes are recursively copied into the new Node. If omitted or false, the copy will have no child Nodes. + * @returns Ext.data.NodeInterface A copy of this Node. */ copy?( newId?:string, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Destroys the node @@ -9172,79 +10140,113 @@ declare module Ext.data { * @param attribute String The attribute name. * @param value Object The value to search for. * @param deep Boolean true to search through nodes deeper than the immediate children. + * @returns Ext.data.NodeInterface The found child or null if none was found. */ findChild?( attribute?:string, value?:any, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Finds the first child by a custom function * @param fn Function A function which must return true if the passed Node is the required Node. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Node being tested. * @param deep Boolean True to search through nodes deeper than the immediate children. + * @returns Ext.data.NodeInterface The found child or null if none was found. */ findChildBy?( fn?:any, scope?:any, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Returns the child node at the specified index * @param index Number + * @returns Ext.data.NodeInterface */ getChildAt?( index?:number ): Ext.data.INodeInterface; - /** [Method] Returns depth of this node the root node has a depth of 0 */ + /** [Method] Returns depth of this node the root node has a depth of 0 + * @returns Number + */ getDepth?(): number; /** [Method] Gets the hierarchical path from the root of the current node * @param field String The field to construct the path from. Defaults to the model idProperty. * @param separator String A separator to use. + * @returns String The node path */ getPath?( field?:string, separator?:string ): string; - /** [Method] Returns true if this node has one or more child nodes else false */ + /** [Method] Returns true if this node has one or more child nodes else false + * @returns Boolean + */ hasChildNodes?(): boolean; /** [Method] Returns the index of a child node * @param child Ext.data.NodeInterface + * @returns Number The index of the node or -1 if it was not found. */ indexOf?( child?:Ext.data.INodeInterface ): number; /** [Method] Inserts the first node before the second node in this nodes childNodes collection * @param node Ext.data.NodeInterface The node to insert. * @param refNode Ext.data.NodeInterface The node to insert before (if null the node is appended). + * @returns Ext.data.NodeInterface The inserted node. */ insertBefore?( node?:Ext.data.INodeInterface, refNode?:Ext.data.INodeInterface ): Ext.data.INodeInterface; /** [Method] Insert a node into this node * @param index Number The zero-based index to insert the node at. * @param node Ext.data.Model The node to insert. + * @returns Ext.data.Model The record you just inserted. */ insertChild?( index?:number, node?:Ext.data.IModel ): Ext.data.IModel; /** [Method] Returns true if the passed node is an ancestor at any point of this node * @param node Ext.data.NodeInterface + * @returns Boolean */ isAncestor?( node?:Ext.data.INodeInterface ): boolean; - /** [Method] Returns true if this node has one or more child nodes or if the expandable node attribute is explicitly specified as */ + /** [Method] Returns true if this node has one or more child nodes or if the expandable node attribute is explicitly specified as + * @returns Boolean + */ isExpandable?(): boolean; - /** [Method] Returns true if this node is expanded */ + /** [Method] Returns true if this node is expanded + * @returns Boolean + */ isExpanded?(): boolean; - /** [Method] Returns true if this node is the first child of its parent */ + /** [Method] Returns true if this node is the first child of its parent + * @returns Boolean + */ isFirst?(): boolean; - /** [Method] Returns true if this node is the last child of its parent */ + /** [Method] Returns true if this node is the last child of its parent + * @returns Boolean + */ isLast?(): boolean; - /** [Method] Returns true if this node is a leaf */ + /** [Method] Returns true if this node is a leaf + * @returns Boolean + */ isLeaf?(): boolean; - /** [Method] Returns true if this node is loaded */ + /** [Method] Returns true if this node is loaded + * @returns Boolean + */ isLoaded?(): boolean; - /** [Method] Returns true if this node is loading */ + /** [Method] Returns true if this node is loading + * @returns Boolean + */ isLoading?(): boolean; - /** [Method] Returns true if this node is the root node */ + /** [Method] Returns true if this node is the root node + * @returns Boolean + */ isRoot?(): boolean; - /** [Method] Returns true if this node is visible */ + /** [Method] Returns true if this node is visible + * @returns Boolean + */ isVisible?(): boolean; /** [Method] Removes this node from its parent * @param destroy Boolean true to destroy the node upon removal. + * @returns Ext.data.NodeInterface this */ remove?( destroy?:boolean ): Ext.data.INodeInterface; /** [Method] Removes all child nodes from this node * @param destroy Boolean true to destroy the node upon removal. + * @returns Ext.data.NodeInterface this */ removeAll?( destroy?:boolean ): Ext.data.INodeInterface; /** [Method] Removes a child node from this node * @param node Ext.data.NodeInterface The node to remove. * @param destroy Boolean true to destroy the node upon removal. + * @returns Ext.data.NodeInterface The removed node. */ removeChild?( node?:Ext.data.INodeInterface, destroy?:boolean ): Ext.data.INodeInterface; /** [Method] Replaces one child node in this node with another * @param newChild Ext.data.NodeInterface The replacement node. * @param oldChild Ext.data.NodeInterface The node to replace. + * @returns Ext.data.NodeInterface The replaced node. */ replaceChild?( newChild?:Ext.data.INodeInterface, oldChild?:Ext.data.INodeInterface ): Ext.data.INodeInterface; /** [Method] Sorts this nodes children using the supplied sort function @@ -9255,6 +10257,7 @@ declare module Ext.data { sort?( sortFn?:any, recursive?:boolean, suppressEvent?:boolean ): void; /** [Method] Updates general data of this node like isFirst isLast depth * @param silent Object + * @returns Boolean */ updateInfo?( silent?:any ): boolean; } @@ -9265,13 +10268,16 @@ declare module Ext.data { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] * @param args Object */ static callParent( args?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -9282,10 +10288,13 @@ declare module Ext.data { * @param record Ext.data.Model The Record you want to decorate the prototype of. */ static decorate( record?:Ext.data.IModel ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -9306,10 +10315,9 @@ declare module Ext.data { previousSibling?: any; /** [Method] Insert node s as the last child node of this node * @param node Ext.data.NodeInterface/Ext.data.NodeInterface[] The node or Array of nodes to append. + * @returns Ext.data.NodeInterface The appended node if single append, or null if an array was passed. */ - appendChild?( node?:any ): any; - appendChild?( node?:Ext.data.INodeInterface ): Ext.data.INodeInterface; - appendChild?( node?:Ext.data.INodeInterface[] ): Ext.data.INodeInterface; + appendChild?( node?:any ): Ext.data.INodeInterface; /** [Method] Bubbles up the tree from this node calling the specified function with each node * @param fn Function The function to call. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the current Node. @@ -9330,11 +10338,13 @@ declare module Ext.data { collapse?( recursive?:any, callback?:any, scope?:any ): void; /** [Method] Returns true if this node is an ancestor at any point of the passed node * @param node Ext.data.NodeInterface + * @returns Boolean */ contains?( node?:Ext.data.INodeInterface ): boolean; /** [Method] Creates a copy clone of this Node * @param newId String A new id, defaults to this Node's id. * @param deep Boolean If passed as true, all child Nodes are recursively copied into the new Node. If omitted or false, the copy will have no child Nodes. + * @returns Ext.data.NodeInterface A copy of this Node. */ copy?( newId?:string, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Destroys the node @@ -9357,79 +10367,113 @@ declare module Ext.data { * @param attribute String The attribute name. * @param value Object The value to search for. * @param deep Boolean true to search through nodes deeper than the immediate children. + * @returns Ext.data.NodeInterface The found child or null if none was found. */ findChild?( attribute?:string, value?:any, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Finds the first child by a custom function * @param fn Function A function which must return true if the passed Node is the required Node. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Node being tested. * @param deep Boolean True to search through nodes deeper than the immediate children. + * @returns Ext.data.NodeInterface The found child or null if none was found. */ findChildBy?( fn?:any, scope?:any, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Returns the child node at the specified index * @param index Number + * @returns Ext.data.NodeInterface */ getChildAt?( index?:number ): Ext.data.INodeInterface; - /** [Method] Returns depth of this node the root node has a depth of 0 */ + /** [Method] Returns depth of this node the root node has a depth of 0 + * @returns Number + */ getDepth?(): number; /** [Method] Gets the hierarchical path from the root of the current node * @param field String The field to construct the path from. Defaults to the model idProperty. * @param separator String A separator to use. + * @returns String The node path */ getPath?( field?:string, separator?:string ): string; - /** [Method] Returns true if this node has one or more child nodes else false */ + /** [Method] Returns true if this node has one or more child nodes else false + * @returns Boolean + */ hasChildNodes?(): boolean; /** [Method] Returns the index of a child node * @param child Ext.data.NodeInterface + * @returns Number The index of the node or -1 if it was not found. */ indexOf?( child?:Ext.data.INodeInterface ): number; /** [Method] Inserts the first node before the second node in this nodes childNodes collection * @param node Ext.data.NodeInterface The node to insert. * @param refNode Ext.data.NodeInterface The node to insert before (if null the node is appended). + * @returns Ext.data.NodeInterface The inserted node. */ insertBefore?( node?:Ext.data.INodeInterface, refNode?:Ext.data.INodeInterface ): Ext.data.INodeInterface; /** [Method] Insert a node into this node * @param index Number The zero-based index to insert the node at. * @param node Ext.data.Model The node to insert. + * @returns Ext.data.Model The record you just inserted. */ insertChild?( index?:number, node?:Ext.data.IModel ): Ext.data.IModel; /** [Method] Returns true if the passed node is an ancestor at any point of this node * @param node Ext.data.NodeInterface + * @returns Boolean */ isAncestor?( node?:Ext.data.INodeInterface ): boolean; - /** [Method] Returns true if this node has one or more child nodes or if the expandable node attribute is explicitly specified as */ + /** [Method] Returns true if this node has one or more child nodes or if the expandable node attribute is explicitly specified as + * @returns Boolean + */ isExpandable?(): boolean; - /** [Method] Returns true if this node is expanded */ + /** [Method] Returns true if this node is expanded + * @returns Boolean + */ isExpanded?(): boolean; - /** [Method] Returns true if this node is the first child of its parent */ + /** [Method] Returns true if this node is the first child of its parent + * @returns Boolean + */ isFirst?(): boolean; - /** [Method] Returns true if this node is the last child of its parent */ + /** [Method] Returns true if this node is the last child of its parent + * @returns Boolean + */ isLast?(): boolean; - /** [Method] Returns true if this node is a leaf */ + /** [Method] Returns true if this node is a leaf + * @returns Boolean + */ isLeaf?(): boolean; - /** [Method] Returns true if this node is loaded */ + /** [Method] Returns true if this node is loaded + * @returns Boolean + */ isLoaded?(): boolean; - /** [Method] Returns true if this node is loading */ + /** [Method] Returns true if this node is loading + * @returns Boolean + */ isLoading?(): boolean; - /** [Method] Returns true if this node is the root node */ + /** [Method] Returns true if this node is the root node + * @returns Boolean + */ isRoot?(): boolean; - /** [Method] Returns true if this node is visible */ + /** [Method] Returns true if this node is visible + * @returns Boolean + */ isVisible?(): boolean; /** [Method] Removes this node from its parent * @param destroy Boolean true to destroy the node upon removal. + * @returns Ext.data.NodeInterface this */ remove?( destroy?:boolean ): Ext.data.INodeInterface; /** [Method] Removes all child nodes from this node * @param destroy Boolean true to destroy the node upon removal. + * @returns Ext.data.NodeInterface this */ removeAll?( destroy?:boolean ): Ext.data.INodeInterface; /** [Method] Removes a child node from this node * @param node Ext.data.NodeInterface The node to remove. * @param destroy Boolean true to destroy the node upon removal. + * @returns Ext.data.NodeInterface The removed node. */ removeChild?( node?:Ext.data.INodeInterface, destroy?:boolean ): Ext.data.INodeInterface; /** [Method] Replaces one child node in this node with another * @param newChild Ext.data.NodeInterface The replacement node. * @param oldChild Ext.data.NodeInterface The node to replace. + * @returns Ext.data.NodeInterface The replaced node. */ replaceChild?( newChild?:Ext.data.INodeInterface, oldChild?:Ext.data.INodeInterface ): Ext.data.INodeInterface; /** [Method] Sorts this nodes children using the supplied sort function @@ -9440,6 +10484,7 @@ declare module Ext.data { sort?( sortFn?:any, recursive?:boolean, suppressEvent?:boolean ): void; /** [Method] Updates general data of this node like isFirst isLast depth * @param silent Object + * @returns Boolean */ updateInfo?( silent?:any ): boolean; } @@ -9450,13 +10495,16 @@ declare module Ext.data { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] * @param args Object */ static callParent( args?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -9467,10 +10515,13 @@ declare module Ext.data { * @param record Ext.data.Model The Record you want to decorate the prototype of. */ static decorate( record?:Ext.data.IModel ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -9489,20 +10540,33 @@ declare module Ext.data { rootVisible?: boolean; /** [Config Option] (Object[]) */ sorters?: any[]; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Object + */ getFilters?(): any; - /** [Method] Returns the value of folderSort */ + /** [Method] Returns the value of folderSort + * @returns Boolean + */ getFolderSort?(): boolean; - /** [Method] Returns the value of node */ + /** [Method] Returns the value of node + * @returns Ext.data.Model + */ getNode?(): Ext.data.IModel; - /** [Method] Returns the value of recursive */ + /** [Method] Returns the value of recursive + * @returns Boolean + */ getRecursive?(): boolean; - /** [Method] Returns the value of rootVisible */ + /** [Method] Returns the value of rootVisible + * @returns Boolean + */ getRootVisible?(): boolean; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Object + */ getSorters?(): any; /** [Method] * @param node Object + * @returns Boolean */ isVisible?( node?:any ): boolean; /** [Method] Sets the value of filters @@ -9569,57 +10633,109 @@ declare module Ext.data { synchronous?: boolean; /** [Config Option] (Boolean) */ withCredentials?: boolean; - /** [Method] Checks whether this operation should cause writing to occur */ + /** [Method] Checks whether this operation should cause writing to occur + * @returns Boolean Whether the operation should cause a write to occur. + */ allowWrite?(): boolean; - /** [Method] Returns the value of action */ + /** [Method] Returns the value of action + * @returns String + */ getAction?(): string; - /** [Method] Returns the value of addRecords */ + /** [Method] Returns the value of addRecords + * @returns Boolean + */ getAddRecords?(): boolean; - /** [Method] Returns the value of batch */ + /** [Method] Returns the value of batch + * @returns Ext.data.Batch + */ getBatch?(): Ext.data.IBatch; - /** [Method] Returns the value of callback */ + /** [Method] Returns the value of callback + * @returns Function + */ getCallback?(): any; - /** [Method] Returns the error string or object that was set using setException */ + /** [Method] Returns the error string or object that was set using setException + * @returns String/Object The error object. + */ getError?(): any; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Ext.util.Filter[] + */ getFilters?(): Ext.util.IFilter[]; - /** [Method] Returns the value of grouper */ + /** [Method] Returns the value of grouper + * @returns Ext.util.Grouper + */ getGrouper?(): Ext.util.IGrouper; - /** [Method] Returns the value of limit */ + /** [Method] Returns the value of limit + * @returns Number + */ getLimit?(): number; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns Ext.data.Model + */ getModel?(): Ext.data.IModel; - /** [Method] Returns the value of node */ + /** [Method] Returns the value of node + * @returns Object + */ getNode?(): any; - /** [Method] Returns the value of page */ + /** [Method] Returns the value of page + * @returns Object + */ getPage?(): any; - /** [Method] Returns the value of params */ + /** [Method] Returns the value of params + * @returns Object + */ getParams?(): any; - /** [Method] Returns the value of request */ + /** [Method] Returns the value of request + * @returns Ext.data.Request + */ getRequest?(): Ext.data.IRequest; - /** [Method] Returns the value of response */ + /** [Method] Returns the value of response + * @returns Object + */ getResponse?(): any; - /** [Method] Returns the value of resultSet */ + /** [Method] Returns the value of resultSet + * @returns Ext.data.ResultSet + */ getResultSet?(): Ext.data.IResultSet; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Ext.util.Sorter[] + */ getSorters?(): Ext.util.ISorter[]; - /** [Method] Returns the value of start */ + /** [Method] Returns the value of start + * @returns Number + */ getStart?(): number; - /** [Method] Returns the value of synchronous */ + /** [Method] Returns the value of synchronous + * @returns Boolean + */ getSynchronous?(): boolean; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns Object + */ getUrl?(): any; - /** [Method] Returns the value of withCredentials */ + /** [Method] Returns the value of withCredentials + * @returns Boolean + */ getWithCredentials?(): boolean; - /** [Method] Returns true if this Operation encountered an exception see also getError */ + /** [Method] Returns true if this Operation encountered an exception see also getError + * @returns Boolean true if there was an exception. + */ hasException?(): boolean; - /** [Method] Returns true if the Operation has been completed */ + /** [Method] Returns true if the Operation has been completed + * @returns Boolean true if the Operation is complete + */ isComplete?(): boolean; - /** [Method] Returns true if the Operation has been started but has not yet completed */ + /** [Method] Returns true if the Operation has been started but has not yet completed + * @returns Boolean true if the Operation is currently running + */ isRunning?(): boolean; - /** [Method] Returns true if the Operation has been started */ + /** [Method] Returns true if the Operation has been started + * @returns Boolean true if the Operation has started + */ isStarted?(): boolean; /** [Method] Sets the value of action * @param action String @@ -9715,7 +10831,9 @@ declare module Ext.data { * @param withCredentials Boolean */ setWithCredentials?( withCredentials?:boolean ): void; - /** [Method] Returns true if the Operation has completed and was successful */ + /** [Method] Returns true if the Operation has completed and was successful + * @returns Boolean true if successful + */ wasSuccessful?(): boolean; } } @@ -9737,21 +10855,33 @@ declare module Ext.data.proxy { * @param operation Object * @param callback Object * @param scope Object + * @returns Object */ doRequest?( operation?:any, callback?:any, scope?:any ): any; - /** [Method] Returns the value of headers */ + /** [Method] Returns the value of headers + * @returns Object + */ getHeaders?(): any; /** [Method] Returns the HTTP method name for a given request * @param request Ext.data.Request The request object. + * @returns String The HTTP method to use (should be one of 'GET', 'POST', 'PUT' or 'DELETE'). */ getMethod?( request?:Ext.data.IRequest ): string; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ getPassword?(): string; - /** [Method] Returns the value of useDefaultXhrHeader */ + /** [Method] Returns the value of useDefaultXhrHeader + * @returns Boolean + */ getUseDefaultXhrHeader?(): boolean; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ getUsername?(): string; - /** [Method] Returns the value of withCredentials */ + /** [Method] Returns the value of withCredentials + * @returns Boolean + */ getWithCredentials?(): boolean; /** [Method] Sets the value of headers * @param headers Object @@ -9793,21 +10923,33 @@ declare module Ext.data { * @param operation Object * @param callback Object * @param scope Object + * @returns Object */ doRequest?( operation?:any, callback?:any, scope?:any ): any; - /** [Method] Returns the value of headers */ + /** [Method] Returns the value of headers + * @returns Object + */ getHeaders?(): any; /** [Method] Returns the HTTP method name for a given request * @param request Ext.data.Request The request object. + * @returns String The HTTP method to use (should be one of 'GET', 'POST', 'PUT' or 'DELETE'). */ getMethod?( request?:Ext.data.IRequest ): string; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ getPassword?(): string; - /** [Method] Returns the value of useDefaultXhrHeader */ + /** [Method] Returns the value of useDefaultXhrHeader + * @returns Boolean + */ getUseDefaultXhrHeader?(): boolean; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ getUsername?(): string; - /** [Method] Returns the value of withCredentials */ + /** [Method] Returns the value of withCredentials + * @returns Boolean + */ getWithCredentials?(): boolean; /** [Method] Sets the value of headers * @param headers Object @@ -9849,21 +10991,33 @@ declare module Ext.data { * @param operation Object * @param callback Object * @param scope Object + * @returns Object */ doRequest?( operation?:any, callback?:any, scope?:any ): any; - /** [Method] Returns the value of headers */ + /** [Method] Returns the value of headers + * @returns Object + */ getHeaders?(): any; /** [Method] Returns the HTTP method name for a given request * @param request Ext.data.Request The request object. + * @returns String The HTTP method to use (should be one of 'GET', 'POST', 'PUT' or 'DELETE'). */ getMethod?( request?:Ext.data.IRequest ): string; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ getPassword?(): string; - /** [Method] Returns the value of useDefaultXhrHeader */ + /** [Method] Returns the value of useDefaultXhrHeader + * @returns Boolean + */ getUseDefaultXhrHeader?(): boolean; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ getUsername?(): string; - /** [Method] Returns the value of withCredentials */ + /** [Method] Returns the value of withCredentials + * @returns Boolean + */ getWithCredentials?(): boolean; /** [Method] Sets the value of headers * @param headers Object @@ -9911,7 +11065,9 @@ declare module Ext.data.proxy { paramOrder?: any; /** [Config Option] (Boolean) */ paramsAsHash?: boolean; - /** [Method] Generates a url based on a given Ext data Request object */ + /** [Method] Generates a url based on a given Ext data Request object + * @returns String The url + */ buildUrl?(): string; /** [Method] In ServerProxy subclasses the create read update and destroy methods all pass through to doRequest * @param operation Object @@ -9919,15 +11075,25 @@ declare module Ext.data.proxy { * @param scope Object */ doRequest?( operation?:any, callback?:any, scope?:any ): void; - /** [Method] Returns the value of api */ + /** [Method] Returns the value of api + * @returns Object + */ getApi?(): any; - /** [Method] Returns the value of directFn */ + /** [Method] Returns the value of directFn + * @returns Function/String + */ getDirectFn?(): any; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ getExtraParams?(): any; - /** [Method] Returns the value of paramOrder */ + /** [Method] Returns the value of paramOrder + * @returns String/String[] + */ getParamOrder?(): any; - /** [Method] Returns the value of paramsAsHash */ + /** [Method] Returns the value of paramsAsHash + * @returns Boolean + */ getParamsAsHash?(): boolean; /** [Method] Sets the value of api * @param api Object @@ -9936,8 +11102,7 @@ declare module Ext.data.proxy { /** [Method] Sets the value of directFn * @param directFn Function/String */ - setDirectFn?( directFn?:any ): any; - setDirectFn?( directFn?:string ): void; + setDirectFn?( directFn?:any ): void; /** [Method] Sets the value of extraParams * @param extraParams Object */ @@ -9945,9 +11110,7 @@ declare module Ext.data.proxy { /** [Method] Sets the value of paramOrder * @param paramOrder String/String[] */ - setParamOrder?( paramOrder?:any ): any; - setParamOrder?( paramOrder?:string ): void; - setParamOrder?( paramOrder?:string[] ): void; + setParamOrder?( paramOrder?:any ): void; /** [Method] Sets the value of paramsAsHash * @param paramsAsHash Boolean */ @@ -9966,7 +11129,9 @@ declare module Ext.data { paramOrder?: any; /** [Config Option] (Boolean) */ paramsAsHash?: boolean; - /** [Method] Generates a url based on a given Ext data Request object */ + /** [Method] Generates a url based on a given Ext data Request object + * @returns String The url + */ buildUrl?(): string; /** [Method] In ServerProxy subclasses the create read update and destroy methods all pass through to doRequest * @param operation Object @@ -9974,15 +11139,25 @@ declare module Ext.data { * @param scope Object */ doRequest?( operation?:any, callback?:any, scope?:any ): void; - /** [Method] Returns the value of api */ + /** [Method] Returns the value of api + * @returns Object + */ getApi?(): any; - /** [Method] Returns the value of directFn */ + /** [Method] Returns the value of directFn + * @returns Function/String + */ getDirectFn?(): any; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ getExtraParams?(): any; - /** [Method] Returns the value of paramOrder */ + /** [Method] Returns the value of paramOrder + * @returns String/String[] + */ getParamOrder?(): any; - /** [Method] Returns the value of paramsAsHash */ + /** [Method] Returns the value of paramsAsHash + * @returns Boolean + */ getParamsAsHash?(): boolean; /** [Method] Sets the value of api * @param api Object @@ -9991,8 +11166,7 @@ declare module Ext.data { /** [Method] Sets the value of directFn * @param directFn Function/String */ - setDirectFn?( directFn?:any ): any; - setDirectFn?( directFn?:string ): void; + setDirectFn?( directFn?:any ): void; /** [Method] Sets the value of extraParams * @param extraParams Object */ @@ -10000,9 +11174,7 @@ declare module Ext.data { /** [Method] Sets the value of paramOrder * @param paramOrder String/String[] */ - setParamOrder?( paramOrder?:any ): any; - setParamOrder?( paramOrder?:string ): void; - setParamOrder?( paramOrder?:string[] ): void; + setParamOrder?( paramOrder?:any ): void; /** [Method] Sets the value of paramsAsHash * @param paramsAsHash Boolean */ @@ -10021,6 +11193,7 @@ declare module Ext.data.proxy { abort?(): void; /** [Method] Generates a url based on a given Ext data Request object * @param request Ext.data.Request The request object. + * @returns String The url. */ buildUrl?( request?:Ext.data.IRequest ): string; /** [Method] Performs the given destroy operation */ @@ -10029,15 +11202,24 @@ declare module Ext.data.proxy { * @param operation Ext.data.Operation The Operation object to execute. * @param callback Function A callback function to execute when the Operation has been completed. * @param scope Object The scope to execute the callback in. + * @returns Object */ doRequest?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): any; - /** [Method] Returns the value of autoAppendParams */ + /** [Method] Returns the value of autoAppendParams + * @returns Boolean + */ getAutoAppendParams?(): boolean; - /** [Method] Returns the value of callbackKey */ + /** [Method] Returns the value of callbackKey + * @returns String + */ getCallbackKey?(): string; - /** [Method] Returns the value of defaultWriterType */ + /** [Method] Returns the value of defaultWriterType + * @returns String + */ getDefaultWriterType?(): string; - /** [Method] Returns the value of recordParam */ + /** [Method] Returns the value of recordParam + * @returns String + */ getRecordParam?(): string; /** [Method] Sets the value of autoAppendParams * @param autoAppendParams Boolean @@ -10069,6 +11251,7 @@ declare module Ext.data { abort?(): void; /** [Method] Generates a url based on a given Ext data Request object * @param request Ext.data.Request The request object. + * @returns String The url. */ buildUrl?( request?:Ext.data.IRequest ): string; /** [Method] Performs the given destroy operation */ @@ -10077,15 +11260,24 @@ declare module Ext.data { * @param operation Ext.data.Operation The Operation object to execute. * @param callback Function A callback function to execute when the Operation has been completed. * @param scope Object The scope to execute the callback in. + * @returns Object */ doRequest?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): any; - /** [Method] Returns the value of autoAppendParams */ + /** [Method] Returns the value of autoAppendParams + * @returns Boolean + */ getAutoAppendParams?(): boolean; - /** [Method] Returns the value of callbackKey */ + /** [Method] Returns the value of callbackKey + * @returns String + */ getCallbackKey?(): string; - /** [Method] Returns the value of defaultWriterType */ + /** [Method] Returns the value of defaultWriterType + * @returns String + */ getDefaultWriterType?(): string; - /** [Method] Returns the value of recordParam */ + /** [Method] Returns the value of recordParam + * @returns String + */ getRecordParam?(): string; /** [Method] Sets the value of autoAppendParams * @param autoAppendParams Boolean @@ -10131,7 +11323,9 @@ declare module Ext.data.proxy { * @param scope Object Scope to execute the callback function in */ destroy?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; /** [Method] Reads data from the configured data object * @param operation Ext.data.Operation The read Operation @@ -10169,7 +11363,9 @@ declare module Ext.data { * @param scope Object Scope to execute the callback function in */ destroy?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; /** [Method] Reads data from the configured data object * @param operation Ext.data.Operation The read Operation @@ -10203,6 +11399,7 @@ declare module Ext.data.proxy { writer?: any; /** [Method] Performs a batch of Operations in the order specified by batchOrder * @param options Object Object containing one or more properties supported by the batch method: + * @returns Ext.data.Batch The newly created Batch */ batch?( options?:any ): Ext.data.IBatch; /** [Method] Performs the given create operation @@ -10217,15 +11414,25 @@ declare module Ext.data.proxy { * @param scope Object Scope to execute the callback function in */ destroy?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; - /** [Method] Returns the value of batchActions */ + /** [Method] Returns the value of batchActions + * @returns Boolean + */ getBatchActions?(): boolean; - /** [Method] Returns the value of batchOrder */ + /** [Method] Returns the value of batchOrder + * @returns String + */ getBatchOrder?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns String/Ext.data.Model + */ getModel?(): any; - /** [Method] Returns the value of reader */ + /** [Method] Returns the value of reader + * @returns Object/String/Ext.data.reader.Reader + */ getReader?(): any; - /** [Method] Returns the value of writer */ + /** [Method] Returns the value of writer + * @returns Object/String/Ext.data.writer.Writer + */ getWriter?(): any; /** [Method] Performs the given read operation * @param operation Ext.data.Operation The Operation to perform @@ -10244,9 +11451,7 @@ declare module Ext.data.proxy { /** [Method] Sets the value of model * @param model String/Ext.data.Model */ - setModel?( model?:any ): any; - setModel?( model?:string ): void; - setModel?( model?:Ext.data.IModel ): void; + setModel?( model?:any ): void; /** [Method] Sets the value of reader * @param reader Object/String/Ext.data.reader.Reader */ @@ -10277,6 +11482,7 @@ declare module Ext.data { writer?: any; /** [Method] Performs a batch of Operations in the order specified by batchOrder * @param options Object Object containing one or more properties supported by the batch method: + * @returns Ext.data.Batch The newly created Batch */ batch?( options?:any ): Ext.data.IBatch; /** [Method] Performs the given create operation @@ -10291,15 +11497,25 @@ declare module Ext.data { * @param scope Object Scope to execute the callback function in */ destroy?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; - /** [Method] Returns the value of batchActions */ + /** [Method] Returns the value of batchActions + * @returns Boolean + */ getBatchActions?(): boolean; - /** [Method] Returns the value of batchOrder */ + /** [Method] Returns the value of batchOrder + * @returns String + */ getBatchOrder?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns String/Ext.data.Model + */ getModel?(): any; - /** [Method] Returns the value of reader */ + /** [Method] Returns the value of reader + * @returns Object/String/Ext.data.reader.Reader + */ getReader?(): any; - /** [Method] Returns the value of writer */ + /** [Method] Returns the value of writer + * @returns Object/String/Ext.data.writer.Writer + */ getWriter?(): any; /** [Method] Performs the given read operation * @param operation Ext.data.Operation The Operation to perform @@ -10318,9 +11534,7 @@ declare module Ext.data { /** [Method] Sets the value of model * @param model String/Ext.data.Model */ - setModel?( model?:any ): any; - setModel?( model?:string ): void; - setModel?( model?:Ext.data.IModel ): void; + setModel?( model?:any ): void; /** [Method] Sets the value of reader * @param reader Object/String/Ext.data.reader.Reader */ @@ -10351,6 +11565,7 @@ declare module Ext.data { writer?: any; /** [Method] Performs a batch of Operations in the order specified by batchOrder * @param options Object Object containing one or more properties supported by the batch method: + * @returns Ext.data.Batch The newly created Batch */ batch?( options?:any ): Ext.data.IBatch; /** [Method] Performs the given create operation @@ -10365,15 +11580,25 @@ declare module Ext.data { * @param scope Object Scope to execute the callback function in */ destroy?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; - /** [Method] Returns the value of batchActions */ + /** [Method] Returns the value of batchActions + * @returns Boolean + */ getBatchActions?(): boolean; - /** [Method] Returns the value of batchOrder */ + /** [Method] Returns the value of batchOrder + * @returns String + */ getBatchOrder?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns String/Ext.data.Model + */ getModel?(): any; - /** [Method] Returns the value of reader */ + /** [Method] Returns the value of reader + * @returns Object/String/Ext.data.reader.Reader + */ getReader?(): any; - /** [Method] Returns the value of writer */ + /** [Method] Returns the value of writer + * @returns Object/String/Ext.data.writer.Writer + */ getWriter?(): any; /** [Method] Performs the given read operation * @param operation Ext.data.Operation The Operation to perform @@ -10392,9 +11617,7 @@ declare module Ext.data { /** [Method] Sets the value of model * @param model String/Ext.data.Model */ - setModel?( model?:any ): any; - setModel?( model?:string ): void; - setModel?( model?:Ext.data.IModel ): void; + setModel?( model?:any ): void; /** [Method] Sets the value of reader * @param reader Object/String/Ext.data.reader.Reader */ @@ -10419,17 +11642,21 @@ declare module Ext.data.proxy { batchActions?: boolean; /** [Config Option] (String) */ format?: string; - /** [Method] Specialized version of buildUrl that incorporates the appendId and format options into the generated url - * @param request Object + /** [Method] Returns the value of actionMethods + * @returns Object */ - buildUrl?( request?:any ): string; - /** [Method] Returns the value of actionMethods */ getActionMethods?(): any; - /** [Method] Returns the value of appendId */ + /** [Method] Returns the value of appendId + * @returns Boolean + */ getAppendId?(): boolean; - /** [Method] Returns the value of batchActions */ + /** [Method] Returns the value of batchActions + * @returns Boolean + */ getBatchActions?(): boolean; - /** [Method] Returns the value of format */ + /** [Method] Returns the value of format + * @returns String + */ getFormat?(): string; /** [Method] Sets the value of actionMethods * @param actionMethods Object @@ -10457,17 +11684,21 @@ declare module Ext.data { batchActions?: boolean; /** [Config Option] (String) */ format?: string; - /** [Method] Specialized version of buildUrl that incorporates the appendId and format options into the generated url - * @param request Object + /** [Method] Returns the value of actionMethods + * @returns Object */ - buildUrl?( request?:any ): string; - /** [Method] Returns the value of actionMethods */ getActionMethods?(): any; - /** [Method] Returns the value of appendId */ + /** [Method] Returns the value of appendId + * @returns Boolean + */ getAppendId?(): boolean; - /** [Method] Returns the value of batchActions */ + /** [Method] Returns the value of batchActions + * @returns Boolean + */ getBatchActions?(): boolean; - /** [Method] Returns the value of format */ + /** [Method] Returns the value of format + * @returns String + */ getFormat?(): string; /** [Method] Sets the value of actionMethods * @param actionMethods Object @@ -10526,10 +11757,12 @@ declare module Ext.data.proxy { afterRequest?( request?:Ext.data.IRequest, success?:boolean ): void; /** [Method] Creates and returns an Ext data Request object based on the options passed by the Store that this Proxy is attached to * @param operation Ext.data.Operation The Operation object to execute + * @returns Ext.data.Request The request object */ buildRequest?( operation?:Ext.data.IOperation ): Ext.data.IRequest; /** [Method] Generates a url based on a given Ext data Request object * @param request Ext.data.Request The request object + * @returns String The url */ buildUrl?( request?:Ext.data.IRequest ): string; /** [Method] in a ServerProxy all four CRUD operations are executed in the same manner so we delegate to doRequest in each case */ @@ -10544,39 +11777,69 @@ declare module Ext.data.proxy { doRequest?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; /** [Method] Encodes the array of Ext util Filter objects into a string to be sent in the request url * @param filters Ext.util.Filter[] The array of Filter objects + * @returns String The encoded filters */ encodeFilters?( filters?:Ext.util.IFilter[] ): string; /** [Method] Encodes the array of Ext util Sorter objects into a string to be sent in the request url * @param sorters Ext.util.Sorter[] The array of Sorter objects + * @returns String The encoded sorters */ encodeSorters?( sorters?:Ext.util.ISorter[] ): string; - /** [Method] Returns the value of api */ + /** [Method] Returns the value of api + * @returns Object + */ getApi?(): any; - /** [Method] Returns the value of cacheString */ + /** [Method] Returns the value of cacheString + * @returns String + */ getCacheString?(): string; - /** [Method] Returns the value of directionParam */ + /** [Method] Returns the value of directionParam + * @returns String + */ getDirectionParam?(): string; - /** [Method] Returns the value of enablePagingParams */ + /** [Method] Returns the value of enablePagingParams + * @returns Boolean + */ getEnablePagingParams?(): boolean; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ getExtraParams?(): any; - /** [Method] Returns the value of filterParam */ + /** [Method] Returns the value of filterParam + * @returns String + */ getFilterParam?(): string; - /** [Method] Returns the value of groupParam */ + /** [Method] Returns the value of groupParam + * @returns String + */ getGroupParam?(): string; - /** [Method] Returns the value of limitParam */ + /** [Method] Returns the value of limitParam + * @returns String + */ getLimitParam?(): string; - /** [Method] Returns the value of noCache */ + /** [Method] Returns the value of noCache + * @returns Boolean + */ getNoCache?(): boolean; - /** [Method] Returns the value of pageParam */ + /** [Method] Returns the value of pageParam + * @returns String + */ getPageParam?(): string; - /** [Method] Returns the value of simpleSortMode */ + /** [Method] Returns the value of simpleSortMode + * @returns Boolean + */ getSimpleSortMode?(): boolean; - /** [Method] Returns the value of sortParam */ + /** [Method] Returns the value of sortParam + * @returns String + */ getSortParam?(): string; - /** [Method] Returns the value of startParam */ + /** [Method] Returns the value of startParam + * @returns String + */ getStartParam?(): string; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; /** [Method] This method handles the processing of the response and is usually overridden by subclasses to do additional processing * @param success Boolean Whether or not this request was successful @@ -10697,10 +11960,12 @@ declare module Ext.data { afterRequest?( request?:Ext.data.IRequest, success?:boolean ): void; /** [Method] Creates and returns an Ext data Request object based on the options passed by the Store that this Proxy is attached to * @param operation Ext.data.Operation The Operation object to execute + * @returns Ext.data.Request The request object */ buildRequest?( operation?:Ext.data.IOperation ): Ext.data.IRequest; /** [Method] Generates a url based on a given Ext data Request object * @param request Ext.data.Request The request object + * @returns String The url */ buildUrl?( request?:Ext.data.IRequest ): string; /** [Method] in a ServerProxy all four CRUD operations are executed in the same manner so we delegate to doRequest in each case */ @@ -10715,39 +11980,69 @@ declare module Ext.data { doRequest?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; /** [Method] Encodes the array of Ext util Filter objects into a string to be sent in the request url * @param filters Ext.util.Filter[] The array of Filter objects + * @returns String The encoded filters */ encodeFilters?( filters?:Ext.util.IFilter[] ): string; /** [Method] Encodes the array of Ext util Sorter objects into a string to be sent in the request url * @param sorters Ext.util.Sorter[] The array of Sorter objects + * @returns String The encoded sorters */ encodeSorters?( sorters?:Ext.util.ISorter[] ): string; - /** [Method] Returns the value of api */ + /** [Method] Returns the value of api + * @returns Object + */ getApi?(): any; - /** [Method] Returns the value of cacheString */ + /** [Method] Returns the value of cacheString + * @returns String + */ getCacheString?(): string; - /** [Method] Returns the value of directionParam */ + /** [Method] Returns the value of directionParam + * @returns String + */ getDirectionParam?(): string; - /** [Method] Returns the value of enablePagingParams */ + /** [Method] Returns the value of enablePagingParams + * @returns Boolean + */ getEnablePagingParams?(): boolean; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ getExtraParams?(): any; - /** [Method] Returns the value of filterParam */ + /** [Method] Returns the value of filterParam + * @returns String + */ getFilterParam?(): string; - /** [Method] Returns the value of groupParam */ + /** [Method] Returns the value of groupParam + * @returns String + */ getGroupParam?(): string; - /** [Method] Returns the value of limitParam */ + /** [Method] Returns the value of limitParam + * @returns String + */ getLimitParam?(): string; - /** [Method] Returns the value of noCache */ + /** [Method] Returns the value of noCache + * @returns Boolean + */ getNoCache?(): boolean; - /** [Method] Returns the value of pageParam */ + /** [Method] Returns the value of pageParam + * @returns String + */ getPageParam?(): string; - /** [Method] Returns the value of simpleSortMode */ + /** [Method] Returns the value of simpleSortMode + * @returns Boolean + */ getSimpleSortMode?(): boolean; - /** [Method] Returns the value of sortParam */ + /** [Method] Returns the value of sortParam + * @returns String + */ getSortParam?(): string; - /** [Method] Returns the value of startParam */ + /** [Method] Returns the value of startParam + * @returns String + */ getStartParam?(): string; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; /** [Method] This method handles the processing of the response and is usually overridden by subclasses to do additional processing * @param success Boolean Whether or not this request was successful @@ -10855,21 +12150,34 @@ declare module Ext.data.proxy { * @param scope Object */ destroy?( operation?:any, callback?:any, scope?:any ): void; - /** [Method] Returns the value of columns */ + /** [Method] Returns the value of columns + * @returns String + */ getColumns?(): string; - /** [Method] Returns the value of database */ + /** [Method] Returns the value of database + * @returns String + */ getDatabase?(): string; - /** [Method] Returns the value of defaultDateFormat */ + /** [Method] Returns the value of defaultDateFormat + * @returns String + */ getDefaultDateFormat?(): string; /** [Method] Formats the data for each record before sending it to the server * @param record Object The record that we are writing to the server. + * @returns Object An object literal of name/value keys to be written to the server. By default this method returns the data property on the record. */ getRecordData?( record?:any ): any; - /** [Method] Returns the value of table */ + /** [Method] Returns the value of table + * @returns String + */ getTable?(): string; - /** [Method] Returns the value of tableExists */ + /** [Method] Returns the value of tableExists + * @returns Boolean + */ getTableExists?(): boolean; - /** [Method] Returns the value of uniqueIdStrategy */ + /** [Method] Returns the value of uniqueIdStrategy + * @returns Boolean + */ getUniqueIdStrategy?(): boolean; /** [Method] Performs the given read operation * @param operation Object @@ -10931,11 +12239,17 @@ declare module Ext.data.proxy { * @param scope Object */ destroy?( operation?:any, callback?:any, scope?:any ): void; - /** [Method] Returns the value of defaultDateFormat */ + /** [Method] Returns the value of defaultDateFormat + * @returns String + */ getDefaultDateFormat?(): string; - /** [Method] Returns the value of enablePagingParams */ + /** [Method] Returns the value of enablePagingParams + * @returns Boolean + */ getEnablePagingParams?(): boolean; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns String + */ getId?(): string; /** [Method] inherit docs * @param operation Object @@ -10990,11 +12304,17 @@ declare module Ext.data { * @param scope Object */ destroy?( operation?:any, callback?:any, scope?:any ): void; - /** [Method] Returns the value of defaultDateFormat */ + /** [Method] Returns the value of defaultDateFormat + * @returns String + */ getDefaultDateFormat?(): string; - /** [Method] Returns the value of enablePagingParams */ + /** [Method] Returns the value of enablePagingParams + * @returns Boolean + */ getEnablePagingParams?(): boolean; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns String + */ getId?(): string; /** [Method] inherit docs * @param operation Object @@ -11033,9 +12353,13 @@ declare module Ext.data.reader { successProperty?: string; /** [Config Option] (String) */ totalProperty?: string; - /** [Method] Returns the value of successProperty */ + /** [Method] Returns the value of successProperty + * @returns Object + */ getSuccessProperty?(): any; - /** [Method] Returns the value of totalProperty */ + /** [Method] Returns the value of totalProperty + * @returns Object + */ getTotalProperty?(): any; /** [Method] Sets the value of successProperty * @param successProperty Object @@ -11053,9 +12377,13 @@ declare module Ext.data { successProperty?: string; /** [Config Option] (String) */ totalProperty?: string; - /** [Method] Returns the value of successProperty */ + /** [Method] Returns the value of successProperty + * @returns Object + */ getSuccessProperty?(): any; - /** [Method] Returns the value of totalProperty */ + /** [Method] Returns the value of totalProperty + * @returns Object + */ getTotalProperty?(): any; /** [Method] Sets the value of successProperty * @param successProperty Object @@ -11073,13 +12401,18 @@ declare module Ext.data.reader { record?: string; /** [Config Option] (Boolean) */ useSimpleAccessors?: boolean; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] Takes a raw response object as passed to this read and returns the useful data segment of it * @param response Object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; - /** [Method] Returns the value of useSimpleAccessors */ + /** [Method] Returns the value of useSimpleAccessors + * @returns Boolean + */ getUseSimpleAccessors?(): boolean; /** [Method] Sets the value of record * @param record String @@ -11097,13 +12430,18 @@ declare module Ext.data { record?: string; /** [Config Option] (Boolean) */ useSimpleAccessors?: boolean; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] Takes a raw response object as passed to this read and returns the useful data segment of it * @param response Object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; - /** [Method] Returns the value of useSimpleAccessors */ + /** [Method] Returns the value of useSimpleAccessors + * @returns Boolean + */ getUseSimpleAccessors?(): boolean; /** [Method] Sets the value of record * @param record String @@ -11143,16 +12481,14 @@ declare module Ext.data.reader { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -11164,9 +12500,7 @@ declare module Ext.data.reader { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -11174,9 +12508,7 @@ declare module Ext.data.reader { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -11184,47 +12516,69 @@ declare module Ext.data.reader { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of clientIdProperty */ + /** [Method] Returns the value of clientIdProperty + * @returns String + */ getClientIdProperty?(): string; - /** [Method] Returns the value of idProperty */ + /** [Method] Returns the value of idProperty + * @returns String + */ getIdProperty?(): string; - /** [Method] Returns the value of implicitIncludes */ + /** [Method] Returns the value of implicitIncludes + * @returns Boolean + */ getImplicitIncludes?(): boolean; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of messageProperty */ + /** [Method] Returns the value of messageProperty + * @returns String + */ getMessageProperty?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns Object + */ getModel?(): any; /** [Method] Takes a raw response object as passed to this read and returns the useful data segment of it * @param response Object The response object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; - /** [Method] Returns the value of rootProperty */ + /** [Method] Returns the value of rootProperty + * @returns String + */ getRootProperty?(): string; - /** [Method] Returns the value of successProperty */ + /** [Method] Returns the value of successProperty + * @returns any + */ getSuccessProperty?(): any; - /** [Method] Returns the value of totalProperty */ + /** [Method] Returns the value of totalProperty + * @returns any + */ getTotalProperty?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -11234,18 +12588,14 @@ declare module Ext.data.reader { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -11253,36 +12603,35 @@ declare module Ext.data.reader { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Reads the given response object * @param response Object The response object. This may be either an XMLHttpRequest object or a plain JS object + * @returns Ext.data.ResultSet The parsed ResultSet object */ read?( response?:any ): Ext.data.IResultSet; /** [Method] Abstracts common functionality used by all Reader subclasses * @param data Object The raw data object + * @returns Ext.data.ResultSet A ResultSet object */ readRecords?( data?:any ): Ext.data.IResultSet; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -11291,16 +12640,14 @@ declare module Ext.data.reader { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -11308,18 +12655,14 @@ declare module Ext.data.reader { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -11327,9 +12670,7 @@ declare module Ext.data.reader { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of clientIdProperty * @param clientIdProperty String */ @@ -11375,25 +12716,21 @@ declare module Ext.data.reader { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.data { @@ -11424,16 +12761,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -11445,9 +12780,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -11455,9 +12788,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -11465,47 +12796,69 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of clientIdProperty */ + /** [Method] Returns the value of clientIdProperty + * @returns String + */ getClientIdProperty?(): string; - /** [Method] Returns the value of idProperty */ + /** [Method] Returns the value of idProperty + * @returns String + */ getIdProperty?(): string; - /** [Method] Returns the value of implicitIncludes */ + /** [Method] Returns the value of implicitIncludes + * @returns Boolean + */ getImplicitIncludes?(): boolean; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of messageProperty */ + /** [Method] Returns the value of messageProperty + * @returns String + */ getMessageProperty?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns Object + */ getModel?(): any; /** [Method] Takes a raw response object as passed to this read and returns the useful data segment of it * @param response Object The response object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; - /** [Method] Returns the value of rootProperty */ + /** [Method] Returns the value of rootProperty + * @returns String + */ getRootProperty?(): string; - /** [Method] Returns the value of successProperty */ + /** [Method] Returns the value of successProperty + * @returns any + */ getSuccessProperty?(): any; - /** [Method] Returns the value of totalProperty */ + /** [Method] Returns the value of totalProperty + * @returns any + */ getTotalProperty?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -11515,18 +12868,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -11534,36 +12883,35 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Reads the given response object * @param response Object The response object. This may be either an XMLHttpRequest object or a plain JS object + * @returns Ext.data.ResultSet The parsed ResultSet object */ read?( response?:any ): Ext.data.IResultSet; /** [Method] Abstracts common functionality used by all Reader subclasses * @param data Object The raw data object + * @returns Ext.data.ResultSet A ResultSet object */ readRecords?( data?:any ): Ext.data.IResultSet; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -11572,16 +12920,14 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -11589,18 +12935,14 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -11608,9 +12950,7 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of clientIdProperty * @param clientIdProperty String */ @@ -11656,25 +12996,21 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.data { @@ -11705,16 +13041,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -11726,9 +13060,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -11736,9 +13068,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -11746,47 +13076,69 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of clientIdProperty */ + /** [Method] Returns the value of clientIdProperty + * @returns String + */ getClientIdProperty?(): string; - /** [Method] Returns the value of idProperty */ + /** [Method] Returns the value of idProperty + * @returns String + */ getIdProperty?(): string; - /** [Method] Returns the value of implicitIncludes */ + /** [Method] Returns the value of implicitIncludes + * @returns Boolean + */ getImplicitIncludes?(): boolean; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of messageProperty */ + /** [Method] Returns the value of messageProperty + * @returns String + */ getMessageProperty?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns Object + */ getModel?(): any; /** [Method] Takes a raw response object as passed to this read and returns the useful data segment of it * @param response Object The response object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; - /** [Method] Returns the value of rootProperty */ + /** [Method] Returns the value of rootProperty + * @returns String + */ getRootProperty?(): string; - /** [Method] Returns the value of successProperty */ + /** [Method] Returns the value of successProperty + * @returns any + */ getSuccessProperty?(): any; - /** [Method] Returns the value of totalProperty */ + /** [Method] Returns the value of totalProperty + * @returns any + */ getTotalProperty?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -11796,18 +13148,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -11815,36 +13163,35 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Reads the given response object * @param response Object The response object. This may be either an XMLHttpRequest object or a plain JS object + * @returns Ext.data.ResultSet The parsed ResultSet object */ read?( response?:any ): Ext.data.IResultSet; /** [Method] Abstracts common functionality used by all Reader subclasses * @param data Object The raw data object + * @returns Ext.data.ResultSet A ResultSet object */ readRecords?( data?:any ): Ext.data.IResultSet; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -11853,16 +13200,14 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -11870,18 +13215,14 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -11889,9 +13230,7 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of clientIdProperty * @param clientIdProperty String */ @@ -11937,25 +13276,21 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.data.reader { @@ -11964,16 +13299,21 @@ declare module Ext.data.reader { record?: string; /** [Method] Normalizes the data object * @param data Object The raw data object. + * @returns Object Returns the documentElement property of the data object if present, or the same object if not. */ getData?( data?:any ): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] inherit docs * @param response Object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; /** [Method] Parses an XML document and returns a ResultSet containing the model instances * @param doc Object Parsed XML document. + * @returns Ext.data.ResultSet The parsed result set. */ readRecords?( doc?:any ): Ext.data.IResultSet; /** [Method] Sets the value of record @@ -11988,16 +13328,21 @@ declare module Ext.data { record?: string; /** [Method] Normalizes the data object * @param data Object The raw data object. + * @returns Object Returns the documentElement property of the data object if present, or the same object if not. */ getData?( data?:any ): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] inherit docs * @param response Object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; /** [Method] Parses an XML document and returns a ResultSet containing the model instances * @param doc Object Parsed XML document. + * @returns Ext.data.ResultSet The parsed result set. */ readRecords?( doc?:any ): Ext.data.IResultSet; /** [Method] Sets the value of record @@ -12038,45 +13383,85 @@ declare module Ext.data { withCredentials?: boolean; /** [Config Option] (Object) */ xmlData?: any; - /** [Method] Returns the value of action */ + /** [Method] Returns the value of action + * @returns String + */ getAction?(): string; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Object + */ getArgs?(): any; - /** [Method] Returns the value of callback */ + /** [Method] Returns the value of callback + * @returns Object + */ getCallback?(): any; - /** [Method] Returns the value of callbackKey */ + /** [Method] Returns the value of callbackKey + * @returns String + */ getCallbackKey?(): string; - /** [Method] Returns the value of directFn */ + /** [Method] Returns the value of directFn + * @returns Object + */ getDirectFn?(): any; - /** [Method] Returns the value of disableCaching */ + /** [Method] Returns the value of disableCaching + * @returns Boolean + */ getDisableCaching?(): boolean; - /** [Method] Returns the value of headers */ + /** [Method] Returns the value of headers + * @returns Object + */ getHeaders?(): any; - /** [Method] Returns the value of jsonData */ + /** [Method] Returns the value of jsonData + * @returns Object + */ getJsonData?(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns String + */ getMethod?(): string; - /** [Method] Returns the value of operation */ + /** [Method] Returns the value of operation + * @returns Ext.data.Operation + */ getOperation?(): Ext.data.IOperation; - /** [Method] Returns the value of params */ + /** [Method] Returns the value of params + * @returns Object + */ getParams?(): any; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ getPassword?(): string; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Ext.data.proxy.Proxy + */ getProxy?(): Ext.data.proxy.IProxy; - /** [Method] Returns the value of records */ + /** [Method] Returns the value of records + * @returns Object + */ getRecords?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ getUsername?(): string; - /** [Method] Returns the value of withCredentials */ + /** [Method] Returns the value of withCredentials + * @returns Boolean + */ getWithCredentials?(): boolean; - /** [Method] Returns the value of xmlData */ + /** [Method] Returns the value of xmlData + * @returns Object + */ getXmlData?(): any; /** [Method] Sets the value of action * @param action String @@ -12174,17 +13559,29 @@ declare module Ext.data { success?: boolean; /** [Config Option] (Number) */ total?: number; - /** [Method] Returns the value of count */ + /** [Method] Returns the value of count + * @returns Number + */ getCount?(): number; - /** [Method] Returns the value of loaded */ + /** [Method] Returns the value of loaded + * @returns Boolean + */ getLoaded?(): boolean; - /** [Method] Returns the value of message */ + /** [Method] Returns the value of message + * @returns String + */ getMessage?(): string; - /** [Method] Returns the value of records */ + /** [Method] Returns the value of records + * @returns Ext.data.Model[] + */ getRecords?(): Ext.data.IModel[]; - /** [Method] Returns the value of success */ + /** [Method] Returns the value of success + * @returns Boolean + */ getSuccess?(): boolean; - /** [Method] Returns the value of total */ + /** [Method] Returns the value of total + * @returns Number + */ getTotal?(): number; /** [Method] Sets the value of count * @param count Number @@ -12218,58 +13615,69 @@ declare module Ext.data { export class SortTypes { /** [Method] Date sorting * @param value Object The value being converted. + * @returns Number The comparison value. */ static asDate( value?:any ): number; /** [Method] Float sorting * @param value Object The value being converted. + * @returns Number The comparison value. */ static asFloat( value?:any ): number; /** [Method] Integer sorting * @param value Object The value being converted. + * @returns Number The comparison value. */ static asInt( value?:any ): number; /** [Method] Strips all HTML tags to sort on text only * @param value Object The value being converted. + * @returns String The comparison value. */ static asText( value?:any ): string; /** [Method] Case insensitive string * @param value Object The value being converted. + * @returns String The comparison value. */ static asUCString( value?:any ): string; /** [Method] Strips all HTML tags to sort on text only case insensitive * @param value Object The value being converted. + * @returns String The comparison value. */ static asUCText( value?:any ): string; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Default sort that does nothing * @param value Object The value being converted. + * @returns Object The comparison value. */ static none( value?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -12321,16 +13729,16 @@ declare module Ext.data { currentPage?: number; /** [Method] Adds Model instance to the Store * @param model Ext.data.Model[]/Ext.data.Model... An array of Model instances or Model configuration objects, or variable number of Model instance or config arguments. + * @returns Ext.data.Model[] The model instances that were added. */ - add?( model?:any ): any; - add?( model?:Ext.data.IModel[] ): Ext.data.IModel[]; - add?( model:Ext.data.IModel ): Ext.data.IModel[]; + add?( model?:any ): Ext.data.IModel[]; /** [Method] We are using applyData so that we can return nothing and prevent the this data property to be overridden * @param data Object */ applyData?( data?:any ): void; /** [Method] Gets the average value in the store * @param field String The field in each record you want to get the average for. + * @returns Number The average value, if no items exist, 0. */ average?( field?:string ): number; /** [Method] Reverts to a view of the Record cache with no filtering applied @@ -12363,20 +13771,21 @@ declare module Ext.data { * @param anyMatch Boolean true to match any part of the string, not just the beginning. * @param caseSensitive Boolean true for case sensitive comparison. * @param exactMatch Boolean true to force exact match (^ and $ characters added to the regex). + * @returns Number The matched index or -1 */ - find?( fieldName?:any, value?:any, startIndex?:any, anyMatch?:any, caseSensitive?:any, exactMatch?:any ): any; - find?( fieldName?:string, value?:string, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): number; - find?( fieldName?:string, value?:RegExp, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): number; + find?( fieldName?:string, value?:any, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): number; /** [Method] Find the index of the first matching Record in this Store by a function * @param fn Function The function to be called. It will be passed the following parameters: * @param scope Object The scope (this reference) in which the function is executed. Defaults to this Store. * @param startIndex Number The index to start searching at. + * @returns Number The matched index or -1. */ findBy?( fn?:any, scope?:any, startIndex?:number ): number; /** [Method] Finds the index of the first matching Record in this store by a specific field value * @param fieldName String The name of the Record field to test. * @param value Object The value to match the field against. * @param startIndex Number The index to start searching at. + * @returns Number The matched index or -1. */ findExact?( fieldName?:string, value?:any, startIndex?:number ): number; /** [Method] Finds the first matching Record in this store by a specific field value @@ -12386,109 +13795,182 @@ declare module Ext.data { * @param anyMatch Boolean true to match any part of the string, not just the beginning. * @param caseSensitive Boolean true for case sensitive comparison. * @param exactMatch Boolean true to force exact match (^ and $ characters added to the regex). + * @returns Ext.data.Model The matched record or null. + */ + findRecord?( fieldName?:string, value?:any, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): Ext.data.IModel; + /** [Method] Convenience function for getting the first model instance in the store + * @returns Ext.data.Model/undefined The first model instance in the store, or undefined. */ - findRecord?( fieldName?:any, value?:any, startIndex?:any, anyMatch?:any, caseSensitive?:any, exactMatch?:any ): any; - findRecord?( fieldName?:string, value?:string, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): Ext.data.IModel; - findRecord?( fieldName?:string, value?:RegExp, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): Ext.data.IModel; - /** [Method] Convenience function for getting the first model instance in the store */ first?(): any; - /** [Method] Gets the number of all cached records including the ones currently filtered */ + /** [Method] Gets the number of all cached records including the ones currently filtered + * @returns Number The number of all Records in the Store's cache. + */ getAllCount?(): number; /** [Method] Get the Record at the specified index * @param index Number The index of the Record to find. + * @returns Ext.data.Model/undefined The Record at the passed index. Returns undefined if not found. */ getAt?( index?:number ): any; - /** [Method] Returns the value of autoLoad */ + /** [Method] Returns the value of autoLoad + * @returns Boolean/Object + */ getAutoLoad?(): any; - /** [Method] Returns the value of autoSync */ + /** [Method] Returns the value of autoSync + * @returns Boolean + */ getAutoSync?(): boolean; /** [Method] Get the Record with the specified id * @param id String The id of the Record to find. + * @returns Ext.data.Model/undefined The Record with the passed id. Returns undefined if not found. */ getById?( id?:string ): any; - /** [Method] Returns the value of clearOnPageLoad */ + /** [Method] Returns the value of clearOnPageLoad + * @returns Boolean + */ getClearOnPageLoad?(): boolean; - /** [Method] Gets the number of cached records */ + /** [Method] Gets the number of cached records + * @returns Number The number of Records in the Store's cache. + */ getCount?(): number; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object[]/Ext.data.Model[] + */ getData?(): any; - /** [Method] Returns the value of destroyRemovedRecords */ + /** [Method] Returns the value of destroyRemovedRecords + * @returns Boolean + */ getDestroyRemovedRecords?(): boolean; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Object[] + */ getFields?(): any[]; - /** [Method] Returns the value of getGroupString */ + /** [Method] Returns the value of getGroupString + * @returns Function + */ getGetGroupString?(): any; - /** [Method] Returns the value of groupDir */ + /** [Method] Returns the value of groupDir + * @returns String + */ getGroupDir?(): string; - /** [Method] Returns the value of groupField */ + /** [Method] Returns the value of groupField + * @returns String + */ getGroupField?(): string; - /** [Method] Returns the value of grouper */ + /** [Method] Returns the value of grouper + * @returns Object + */ getGrouper?(): any; /** [Method] Returns an array containing the result of applying the grouper to the records in this store * @param groupName String Pass in an optional groupName argument to access a specific group as defined by grouper. + * @returns Object/Object[] The grouped data. */ getGroups?( groupName?:string ): any; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns String + */ getModel?(): string; - /** [Method] Returns the value of modelDefaults */ + /** [Method] Returns the value of modelDefaults + * @returns Object + */ getModelDefaults?(): any; - /** [Method] Returns all Model instances that are either currently a phantom e g */ + /** [Method] Returns all Model instances that are either currently a phantom e g + * @returns Ext.data.Model[] The Model instances. + */ getNewRecords?(): Ext.data.IModel[]; - /** [Method] Returns the value of pageSize */ + /** [Method] Returns the value of pageSize + * @returns Number + */ getPageSize?(): number; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns String/Ext.data.proxy.Proxy/Object + */ getProxy?(): any; /** [Method] Returns a range of Records between specified indices * @param startIndex Number The starting index. * @param endIndex Number The ending index (defaults to the last Record in the Store). + * @returns Ext.data.Model[] An array of Records. */ getRange?( startIndex?:number, endIndex?:number ): Ext.data.IModel[]; - /** [Method] Returns the value of remoteFilter */ + /** [Method] Returns the value of remoteFilter + * @returns Boolean + */ getRemoteFilter?(): boolean; - /** [Method] Returns the value of remoteGroup */ + /** [Method] Returns the value of remoteGroup + * @returns Boolean + */ getRemoteGroup?(): boolean; - /** [Method] Returns the value of remoteSort */ + /** [Method] Returns the value of remoteSort + * @returns Boolean + */ getRemoteSort?(): boolean; - /** [Method] Returns any records that have been removed from the store but not yet destroyed on the proxy */ + /** [Method] Returns any records that have been removed from the store but not yet destroyed on the proxy + * @returns Ext.data.Model[] The removed Model instances. + */ getRemovedRecords?(): Ext.data.IModel[]; - /** [Method] Returns the value of storeId */ + /** [Method] Returns the value of storeId + * @returns String + */ getStoreId?(): string; - /** [Method] Returns the value of syncRemovedRecords */ + /** [Method] Returns the value of syncRemovedRecords + * @returns Boolean + */ getSyncRemovedRecords?(): boolean; - /** [Method] Returns the value of totalCount */ + /** [Method] Returns the value of totalCount + * @returns Number + */ getTotalCount?(): number; - /** [Method] Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy */ + /** [Method] Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy + * @returns Ext.data.Model[] The updated Model instances. + */ getUpdatedRecords?(): Ext.data.IModel[]; /** [Method] Get the index within the cache of the passed Record * @param record Ext.data.Model The Ext.data.Model object to find. + * @returns Number The index of the passed Record. Returns -1 if not found. */ indexOf?( record?:Ext.data.IModel ): number; /** [Method] Get the index within the cache of the Record with the passed id * @param id String The id of the Record to find. + * @returns Number The index of the Record. Returns -1 if not found. */ indexOfId?( id?:string ): number; /** [Method] Inserts Model instances into the Store at the given index and fires the add event * @param index Number The start index at which to insert the passed Records. * @param records Ext.data.Model[] An Array of Ext.data.Model objects to add to the cache. + * @returns Object */ insert?( index?:number, records?:Ext.data.IModel[] ): any; - /** [Method] Returns true if the Store is set to autoLoad or is a type which loads upon instantiation */ + /** [Method] Returns true if the Store is set to autoLoad or is a type which loads upon instantiation + * @returns Boolean + */ isAutoLoading?(): boolean; - /** [Method] Returns true if this store is currently filtered */ + /** [Method] Returns true if this store is currently filtered + * @returns Boolean + */ isFiltered?(): boolean; - /** [Method] This method tells you if this store has a grouper defined on it */ + /** [Method] This method tells you if this store has a grouper defined on it + * @returns Boolean true if this store has a grouper defined. + */ isGrouped?(): boolean; - /** [Method] Returns true if the Store has been loaded */ + /** [Method] Returns true if the Store has been loaded + * @returns Boolean true if the Store has been loaded. + */ isLoaded?(): boolean; - /** [Method] Returns true if the Store is currently performing a load operation */ + /** [Method] Returns true if the Store is currently performing a load operation + * @returns Boolean true if the Store is currently loading. + */ isLoading?(): boolean; - /** [Method] Returns true if this store is currently sorted */ + /** [Method] Returns true if this store is currently sorted + * @returns Boolean + */ isSorted?(): boolean; - /** [Method] Convenience function for getting the last model instance in the store */ + /** [Method] Convenience function for getting the last model instance in the store + * @returns Ext.data.Model/undefined The last model instance in the store, or undefined. + */ last?(): any; /** [Method] Loads data into the Store via the configured proxy * @param options Object/Function config object, passed into the Ext.data.Operation object before loading. * @param scope Object Scope for the function. + * @returns Object */ load?( options?:any, scope?:any ): any; /** [Method] Loads an array of data straight into the Store @@ -12504,16 +13986,17 @@ declare module Ext.data { loadPage?( page?:number, options?:any, scope?:any ): void; /** [Method] Adds Model instance to the Store * @param model Ext.data.Model[]/Ext.data.Model... An array of Model instances or Model configuration objects, or variable number of Model instance or config arguments. + * @returns Ext.data.Model[] The model instances that were added. */ - loadRecords?( model?:any ): any; - loadRecords?( model?:Ext.data.IModel[] ): Ext.data.IModel[]; - loadRecords?( model:Ext.data.IModel ): Ext.data.IModel[]; + loadRecords?( model?:any ): Ext.data.IModel[]; /** [Method] Gets the maximum value in the store * @param field String The field in each record. + * @returns Object/undefined The maximum value, if no items exist, undefined. */ max?( field?:string ): any; /** [Method] Gets the minimum value in the store * @param field String The field in each record. + * @returns Object/undefined The minimum value, if no items exist, undefined. */ min?( field?:string ): any; /** [Method] Loads the next page in the current data set @@ -12527,14 +14010,13 @@ declare module Ext.data { /** [Method] Query the cached records in this Store using a filtering function * @param fn Function The function to be called. It will be passed the following parameters: * @param scope Object The scope (this reference) in which the function is executed. Defaults to this Store. + * @returns Ext.util.MixedCollection Returns an Ext.util.MixedCollection of the matched records. */ queryBy?( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Removes the given record from the Store firing the removerecords event passing all the instances that are removed * @param records Ext.data.Model/Ext.data.Model[] Model instance or array of instances to remove. */ - remove?( records?:any ): any; - remove?( records?:Ext.data.IModel ): void; - remove?( records?:Ext.data.IModel[] ): void; + remove?( records?:any ): void; /** [Method] Remove all items from the store * @param silent Boolean Prevent the clear event from being fired. */ @@ -12636,14 +14118,15 @@ declare module Ext.data { * @param defaultDirection String The default overall direction to sort the data by. * @param where String This can be either 'prepend' or 'append'. If you leave this undefined it will clear the current sorters. */ - sort?( sorters?:any, defaultDirection?:any, where?:any ): any; - sort?( sorters?:string, defaultDirection?:string, where?:string ): void; - sort?( sorters?:Ext.util.ISorter[], defaultDirection?:string, where?:string ): void; + sort?( sorters?:any, defaultDirection?:string, where?:string ): void; /** [Method] Sums the value of property for each record between start and end and returns the result * @param field String The field in each record. + * @returns Number The sum. */ sum?( field?:string ): number; - /** [Method] Synchronizes the Store with its Proxy */ + /** [Method] Synchronizes the Store with its Proxy + * @returns Object + */ sync?(): any; } } @@ -12654,6 +14137,7 @@ declare module Ext.data { /** [Method] Adds an item to the collection * @param key String The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param item Object The item to add. + * @returns Object The item added. */ static add( key?:string, item?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -12666,6 +14150,7 @@ declare module Ext.data { static addFilter( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Object + * @returns Object */ static addFilters( filters?:any ): any; /** [Method] This method adds a sorter @@ -12680,29 +14165,33 @@ declare module Ext.data { static addSorters( sorters?:any[], defaultDirection?:string ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all items from the collection */ static clear(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ static clone(): Ext.util.IMixedCollection; /** [Method] Returns true if the collection contains the passed Object as an item * @param item Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ static contains( item?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean true if the collection contains the Object as a key. */ static containsKey( key?:string ): boolean; /** [Method] */ @@ -12722,106 +14211,141 @@ declare module Ext.data { * @param value Object * @param anyMatch Object * @param caseSensitive Object + * @returns Array */ static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any[]; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ static filterBy( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function. */ static findBy( fn?:any, scope?:any ): any; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index, or -1 if the item was not found. */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ static findInsertionIndex( items?:any[], item?:any ): number; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection. + */ static first(): any; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ static get( key?:any ): any; - static get( key?:string ): any; - static get( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ static getAt( index?:number ): any; - /** [Method] Returns the value of autoFilter */ + /** [Method] Returns the value of autoFilter + * @returns Boolean + */ static getAutoFilter(): boolean; - /** [Method] Returns the value of autoSort */ + /** [Method] Returns the value of autoSort + * @returns Boolean + */ static getAutoSort(): boolean; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ static getByKey( key?:any ): any; - static getByKey( key?:string ): any; - static getByKey( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ static getCount(): number; - /** [Method] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ static getDefaultSortDirection(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ static getFilterFn(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ static getFilterRoot(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ static getFilters(): any[]; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] getKey implementation for MixedCollection * @param o Object + * @returns Object The key for the passed item. */ static getKey( o?:any ): any; /** [Method] Returns a range of items in this collection * @param start Number The starting index. * @param end Number The ending index. Defaults to the last item. + * @returns Array An array of items. */ static getRange( start?:number, end?:number ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ static getSortFn(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ static getSortRoot(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ static getSorters(): any[]; /** [Method] Returns index within the collection of the passed Object * @param item Object The item to find the index of. + * @returns Number Index of the item. Returns -1 if not found. */ static indexOf( item?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number Index of the key. */ static indexOfKey( key?:string ): number; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String The key to associate with the new item, or the item itself. * @param item Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ static insert( index?:number, key?:string, item?:any ): any; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ static insertFilter( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ static insertFilters( index?:number, filters?:any[] ): any[]; /** [Method] This method adds a sorter at a given index @@ -12830,12 +14354,17 @@ declare module Ext.data { * @param defaultDirection String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'. */ static insertSorter( index?:number, sorter?:any, defaultDirection?:string ): void; - /** [Method] This method inserts all the sorters in the passed array at the given index */ + /** [Method] This method inserts all the sorters in the passed array at the given index + * @returns Ext.util.Collection this + */ static insertSorters(): Ext.util.ICollection; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection. + */ static last(): any; /** [Method] Gets a registered Store by id * @param store String/Object The id of the Store, or a Store instance, or a store configuration. + * @returns Ext.data.Store */ static lookup( store?:any ): Ext.data.IStore; /** [Method] Registers one or more Stores with the StoreManager @@ -12844,22 +14373,27 @@ declare module Ext.data { static register( stores:Ext.data.IStore ): void; /** [Method] Remove an item from the collection * @param item Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( item?:any ): any; /** [Method] Remove all items in the passed array from the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ static removeAll( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ static removeAt( index?:number ): any; /** [Method] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] This method removes all the filters in a passed array * @param filters Object + * @returns Ext.util.Collection this */ static removeFilters( filters?:any ): Ext.util.ICollection; /** [Method] This method removes a sorter @@ -12868,11 +14402,13 @@ declare module Ext.data { static removeSorter( sorter?:any ): void; /** [Method] This method removes all the sorters in a passed array * @param sorters Object + * @returns Ext.util.Collection this */ static removeSorters( sorters?:any ): Ext.util.ICollection; /** [Method] Replaces an item in the collection * @param oldKey String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param item Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( oldKey?:string, item?:any ): any; /** [Method] Sets the value of autoFilter @@ -12906,9 +14442,12 @@ declare module Ext.data { /** [Method] This method will sort an array based on the currently configured sorters * @param sorters Object * @param defaultDirection Object + * @returns Array The array you passed after it is sorted. */ static sort( sorters?:any, defaultDirection?:any ): any[]; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters one or more Stores with the StoreManager * @param stores String/Object... Any number of Store instances or ID-s. @@ -12923,6 +14462,7 @@ declare module Ext { /** [Method] Adds an item to the collection * @param key String The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param item Object The item to add. + * @returns Object The item added. */ static add( key?:string, item?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -12935,6 +14475,7 @@ declare module Ext { static addFilter( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Object + * @returns Object */ static addFilters( filters?:any ): any; /** [Method] This method adds a sorter @@ -12949,29 +14490,33 @@ declare module Ext { static addSorters( sorters?:any[], defaultDirection?:string ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all items from the collection */ static clear(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ static clone(): Ext.util.IMixedCollection; /** [Method] Returns true if the collection contains the passed Object as an item * @param item Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ static contains( item?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean true if the collection contains the Object as a key. */ static containsKey( key?:string ): boolean; /** [Method] */ @@ -12991,106 +14536,141 @@ declare module Ext { * @param value Object * @param anyMatch Object * @param caseSensitive Object + * @returns Array */ static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any[]; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ static filterBy( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function. */ static findBy( fn?:any, scope?:any ): any; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index, or -1 if the item was not found. */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ static findInsertionIndex( items?:any[], item?:any ): number; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection. + */ static first(): any; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ static get( key?:any ): any; - static get( key?:string ): any; - static get( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ static getAt( index?:number ): any; - /** [Method] Returns the value of autoFilter */ + /** [Method] Returns the value of autoFilter + * @returns Boolean + */ static getAutoFilter(): boolean; - /** [Method] Returns the value of autoSort */ + /** [Method] Returns the value of autoSort + * @returns Boolean + */ static getAutoSort(): boolean; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ static getByKey( key?:any ): any; - static getByKey( key?:string ): any; - static getByKey( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ static getCount(): number; - /** [Method] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ static getDefaultSortDirection(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ static getFilterFn(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ static getFilterRoot(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ static getFilters(): any[]; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] getKey implementation for MixedCollection * @param o Object + * @returns Object The key for the passed item. */ static getKey( o?:any ): any; /** [Method] Returns a range of items in this collection * @param start Number The starting index. * @param end Number The ending index. Defaults to the last item. + * @returns Array An array of items. */ static getRange( start?:number, end?:number ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ static getSortFn(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ static getSortRoot(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ static getSorters(): any[]; /** [Method] Returns index within the collection of the passed Object * @param item Object The item to find the index of. + * @returns Number Index of the item. Returns -1 if not found. */ static indexOf( item?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number Index of the key. */ static indexOfKey( key?:string ): number; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String The key to associate with the new item, or the item itself. * @param item Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ static insert( index?:number, key?:string, item?:any ): any; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ static insertFilter( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ static insertFilters( index?:number, filters?:any[] ): any[]; /** [Method] This method adds a sorter at a given index @@ -13099,12 +14679,17 @@ declare module Ext { * @param defaultDirection String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'. */ static insertSorter( index?:number, sorter?:any, defaultDirection?:string ): void; - /** [Method] This method inserts all the sorters in the passed array at the given index */ + /** [Method] This method inserts all the sorters in the passed array at the given index + * @returns Ext.util.Collection this + */ static insertSorters(): Ext.util.ICollection; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection. + */ static last(): any; /** [Method] Gets a registered Store by id * @param store String/Object The id of the Store, or a Store instance, or a store configuration. + * @returns Ext.data.Store */ static lookup( store?:any ): Ext.data.IStore; /** [Method] Registers one or more Stores with the StoreManager @@ -13113,22 +14698,27 @@ declare module Ext { static register( stores:Ext.data.IStore ): void; /** [Method] Remove an item from the collection * @param item Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( item?:any ): any; /** [Method] Remove all items in the passed array from the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ static removeAll( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ static removeAt( index?:number ): any; /** [Method] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] This method removes all the filters in a passed array * @param filters Object + * @returns Ext.util.Collection this */ static removeFilters( filters?:any ): Ext.util.ICollection; /** [Method] This method removes a sorter @@ -13137,11 +14727,13 @@ declare module Ext { static removeSorter( sorter?:any ): void; /** [Method] This method removes all the sorters in a passed array * @param sorters Object + * @returns Ext.util.Collection this */ static removeSorters( sorters?:any ): Ext.util.ICollection; /** [Method] Replaces an item in the collection * @param oldKey String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param item Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( oldKey?:string, item?:any ): any; /** [Method] Sets the value of autoFilter @@ -13175,9 +14767,12 @@ declare module Ext { /** [Method] This method will sort an array based on the currently configured sorters * @param sorters Object * @param defaultDirection Object + * @returns Array The array you passed after it is sorted. */ static sort( sorters?:any, defaultDirection?:any ): any[]; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters one or more Stores with the StoreManager * @param stores String/Object... Any number of Store instances or ID-s. @@ -13192,6 +14787,7 @@ declare module Ext.data { /** [Method] Adds an item to the collection * @param key String The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param item Object The item to add. + * @returns Object The item added. */ static add( key?:string, item?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -13204,6 +14800,7 @@ declare module Ext.data { static addFilter( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Object + * @returns Object */ static addFilters( filters?:any ): any; /** [Method] This method adds a sorter @@ -13218,29 +14815,33 @@ declare module Ext.data { static addSorters( sorters?:any[], defaultDirection?:string ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all items from the collection */ static clear(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ static clone(): Ext.util.IMixedCollection; /** [Method] Returns true if the collection contains the passed Object as an item * @param item Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ static contains( item?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean true if the collection contains the Object as a key. */ static containsKey( key?:string ): boolean; /** [Method] */ @@ -13260,106 +14861,141 @@ declare module Ext.data { * @param value Object * @param anyMatch Object * @param caseSensitive Object + * @returns Array */ static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any[]; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ static filterBy( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function. */ static findBy( fn?:any, scope?:any ): any; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index, or -1 if the item was not found. */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ static findInsertionIndex( items?:any[], item?:any ): number; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection. + */ static first(): any; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ static get( key?:any ): any; - static get( key?:string ): any; - static get( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ static getAt( index?:number ): any; - /** [Method] Returns the value of autoFilter */ + /** [Method] Returns the value of autoFilter + * @returns Boolean + */ static getAutoFilter(): boolean; - /** [Method] Returns the value of autoSort */ + /** [Method] Returns the value of autoSort + * @returns Boolean + */ static getAutoSort(): boolean; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ static getByKey( key?:any ): any; - static getByKey( key?:string ): any; - static getByKey( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ static getCount(): number; - /** [Method] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ static getDefaultSortDirection(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ static getFilterFn(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ static getFilterRoot(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ static getFilters(): any[]; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] getKey implementation for MixedCollection * @param o Object + * @returns Object The key for the passed item. */ static getKey( o?:any ): any; /** [Method] Returns a range of items in this collection * @param start Number The starting index. * @param end Number The ending index. Defaults to the last item. + * @returns Array An array of items. */ static getRange( start?:number, end?:number ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ static getSortFn(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ static getSortRoot(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ static getSorters(): any[]; /** [Method] Returns index within the collection of the passed Object * @param item Object The item to find the index of. + * @returns Number Index of the item. Returns -1 if not found. */ static indexOf( item?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number Index of the key. */ static indexOfKey( key?:string ): number; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String The key to associate with the new item, or the item itself. * @param item Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ static insert( index?:number, key?:string, item?:any ): any; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ static insertFilter( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ static insertFilters( index?:number, filters?:any[] ): any[]; /** [Method] This method adds a sorter at a given index @@ -13368,12 +15004,17 @@ declare module Ext.data { * @param defaultDirection String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'. */ static insertSorter( index?:number, sorter?:any, defaultDirection?:string ): void; - /** [Method] This method inserts all the sorters in the passed array at the given index */ + /** [Method] This method inserts all the sorters in the passed array at the given index + * @returns Ext.util.Collection this + */ static insertSorters(): Ext.util.ICollection; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection. + */ static last(): any; /** [Method] Gets a registered Store by id * @param store String/Object The id of the Store, or a Store instance, or a store configuration. + * @returns Ext.data.Store */ static lookup( store?:any ): Ext.data.IStore; /** [Method] Registers one or more Stores with the StoreManager @@ -13382,22 +15023,27 @@ declare module Ext.data { static register( stores:Ext.data.IStore ): void; /** [Method] Remove an item from the collection * @param item Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( item?:any ): any; /** [Method] Remove all items in the passed array from the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ static removeAll( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ static removeAt( index?:number ): any; /** [Method] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] This method removes all the filters in a passed array * @param filters Object + * @returns Ext.util.Collection this */ static removeFilters( filters?:any ): Ext.util.ICollection; /** [Method] This method removes a sorter @@ -13406,11 +15052,13 @@ declare module Ext.data { static removeSorter( sorter?:any ): void; /** [Method] This method removes all the sorters in a passed array * @param sorters Object + * @returns Ext.util.Collection this */ static removeSorters( sorters?:any ): Ext.util.ICollection; /** [Method] Replaces an item in the collection * @param oldKey String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param item Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( oldKey?:string, item?:any ): any; /** [Method] Sets the value of autoFilter @@ -13444,9 +15092,12 @@ declare module Ext.data { /** [Method] This method will sort an array based on the currently configured sorters * @param sorters Object * @param defaultDirection Object + * @returns Array The array you passed after it is sorted. */ static sort( sorters?:any, defaultDirection?:any ): any[]; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters one or more Stores with the StoreManager * @param stores String/Object... Any number of Store instances or ID-s. @@ -13461,6 +15112,7 @@ declare module Ext { /** [Method] Adds an item to the collection * @param key String The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param item Object The item to add. + * @returns Object The item added. */ static add( key?:string, item?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -13473,6 +15125,7 @@ declare module Ext { static addFilter( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Object + * @returns Object */ static addFilters( filters?:any ): any; /** [Method] This method adds a sorter @@ -13487,29 +15140,33 @@ declare module Ext { static addSorters( sorters?:any[], defaultDirection?:string ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all items from the collection */ static clear(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ static clone(): Ext.util.IMixedCollection; /** [Method] Returns true if the collection contains the passed Object as an item * @param item Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ static contains( item?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean true if the collection contains the Object as a key. */ static containsKey( key?:string ): boolean; /** [Method] */ @@ -13529,106 +15186,141 @@ declare module Ext { * @param value Object * @param anyMatch Object * @param caseSensitive Object + * @returns Array */ static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any[]; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ static filterBy( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function. */ static findBy( fn?:any, scope?:any ): any; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index, or -1 if the item was not found. */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ static findInsertionIndex( items?:any[], item?:any ): number; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection. + */ static first(): any; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ static get( key?:any ): any; - static get( key?:string ): any; - static get( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ static getAt( index?:number ): any; - /** [Method] Returns the value of autoFilter */ + /** [Method] Returns the value of autoFilter + * @returns Boolean + */ static getAutoFilter(): boolean; - /** [Method] Returns the value of autoSort */ + /** [Method] Returns the value of autoSort + * @returns Boolean + */ static getAutoSort(): boolean; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ static getByKey( key?:any ): any; - static getByKey( key?:string ): any; - static getByKey( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ static getCount(): number; - /** [Method] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ static getDefaultSortDirection(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ static getFilterFn(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ static getFilterRoot(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ static getFilters(): any[]; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] getKey implementation for MixedCollection * @param o Object + * @returns Object The key for the passed item. */ static getKey( o?:any ): any; /** [Method] Returns a range of items in this collection * @param start Number The starting index. * @param end Number The ending index. Defaults to the last item. + * @returns Array An array of items. */ static getRange( start?:number, end?:number ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ static getSortFn(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ static getSortRoot(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ static getSorters(): any[]; /** [Method] Returns index within the collection of the passed Object * @param item Object The item to find the index of. + * @returns Number Index of the item. Returns -1 if not found. */ static indexOf( item?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number Index of the key. */ static indexOfKey( key?:string ): number; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String The key to associate with the new item, or the item itself. * @param item Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ static insert( index?:number, key?:string, item?:any ): any; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ static insertFilter( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ static insertFilters( index?:number, filters?:any[] ): any[]; /** [Method] This method adds a sorter at a given index @@ -13637,12 +15329,17 @@ declare module Ext { * @param defaultDirection String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'. */ static insertSorter( index?:number, sorter?:any, defaultDirection?:string ): void; - /** [Method] This method inserts all the sorters in the passed array at the given index */ + /** [Method] This method inserts all the sorters in the passed array at the given index + * @returns Ext.util.Collection this + */ static insertSorters(): Ext.util.ICollection; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection. + */ static last(): any; /** [Method] Gets a registered Store by id * @param store String/Object The id of the Store, or a Store instance, or a store configuration. + * @returns Ext.data.Store */ static lookup( store?:any ): Ext.data.IStore; /** [Method] Registers one or more Stores with the StoreManager @@ -13651,22 +15348,27 @@ declare module Ext { static register( stores:Ext.data.IStore ): void; /** [Method] Remove an item from the collection * @param item Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( item?:any ): any; /** [Method] Remove all items in the passed array from the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ static removeAll( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ static removeAt( index?:number ): any; /** [Method] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] This method removes all the filters in a passed array * @param filters Object + * @returns Ext.util.Collection this */ static removeFilters( filters?:any ): Ext.util.ICollection; /** [Method] This method removes a sorter @@ -13675,11 +15377,13 @@ declare module Ext { static removeSorter( sorter?:any ): void; /** [Method] This method removes all the sorters in a passed array * @param sorters Object + * @returns Ext.util.Collection this */ static removeSorters( sorters?:any ): Ext.util.ICollection; /** [Method] Replaces an item in the collection * @param oldKey String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param item Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( oldKey?:string, item?:any ): any; /** [Method] Sets the value of autoFilter @@ -13713,9 +15417,12 @@ declare module Ext { /** [Method] This method will sort an array based on the currently configured sorters * @param sorters Object * @param defaultDirection Object + * @returns Array The array you passed after it is sorted. */ static sort( sorters?:any, defaultDirection?:any ): any[]; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters one or more Stores with the StoreManager * @param stores String/Object... Any number of Store instances or ID-s. @@ -13735,26 +15442,39 @@ declare module Ext.data { nodeParam?: string; /** [Config Option] (Ext.data.Model/Ext.data.NodeInterface/Object) */ root?: any; - /** [Method] Returns the value of clearOnLoad */ + /** [Method] Returns the value of clearOnLoad + * @returns Boolean + */ getClearOnLoad?(): boolean; - /** [Method] Returns the value of defaultRootId */ + /** [Method] Returns the value of defaultRootId + * @returns String + */ getDefaultRootId?(): string; - /** [Method] Returns the value of defaultRootProperty */ + /** [Method] Returns the value of defaultRootProperty + * @returns String + */ getDefaultRootProperty?(): string; /** [Method] Returns the record node by id * @param id Object + * @returns Ext.data.NodeInterface */ getNodeById?( id?:any ): Ext.data.INodeInterface; - /** [Method] Returns the value of nodeParam */ + /** [Method] Returns the value of nodeParam + * @returns String + */ getNodeParam?(): string; - /** [Method] Returns the value of root */ + /** [Method] Returns the value of root + * @returns Ext.data.Model/Ext.data.NodeInterface/Object + */ getRoot?(): any; /** [Method] Returns the root node for this tree * @param node Object + * @returns Ext.data.Model */ getRootNode?( node?:any ): Ext.data.IModel; /** [Method] Loads the Store using its configured proxy * @param options Object config object. This is passed into the Operation object that is created and then sent to the proxy's Ext.data.proxy.Proxy.read function. The options can also contain a node, which indicates which node is to be loaded. If not specified, it will default to the root node. + * @returns Object */ load?( options?:any ): any; /** [Method] Called internally when a Proxy has completed a load request @@ -13787,6 +15507,7 @@ declare module Ext.data { setRoot?( root?:any ): void; /** [Method] Sets the root node for this tree * @param node Ext.data.Model + * @returns Ext.data.Model */ setRootNode?( node?:Ext.data.IModel ): Ext.data.IModel; } @@ -13797,30 +15518,34 @@ declare module Ext.data { export class Types { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -13830,64 +15555,75 @@ declare module Ext.data { export class Validations { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Validates that an email string is in the correct format * @param config Object Config object. * @param email String The email address. + * @returns Boolean true if the value passes validation. */ static email( config?:any, email?:string ): boolean; /** [Method] Validates that the given value is present in the configured list * @param config Object Config object. * @param value String The value to validate. + * @returns Boolean true if the value is not present in the list. */ static exclusion( config?:any, value?:string ): boolean; /** [Method] Returns true if the given value passes validation against the configured matcher regex * @param config Object Config object. * @param value String The value to validate. + * @returns Boolean true if the value passes the format validation. */ static format( config?:any, value?:string ): boolean; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Returns the configured error message for any of the validation types * @param type String The type of validation you want to get the error message for. + * @returns Object */ static getMessage( type?:string ): any; /** [Method] Validates that the given value is present in the configured list * @param config Object Config object. * @param value String The value to validate. + * @returns Boolean true if the value is present in the list. */ static inclusion( config?:any, value?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Returns true if the given value is between the configured min and max values * @param config Object Config object. * @param value String The value to validate. + * @returns Boolean true if the value passes validation. */ static length( config?:any, value?:string ): boolean; /** [Method] Validates that the given value is present * @param config Object Config object. * @param value Object The value to validate. + * @returns Boolean true if validation passed. */ static presence( config?:any, value?:any ): boolean; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -13901,13 +15637,21 @@ declare module Ext.data.writer { root?: string; /** [Config Option] (String) */ rootProperty?: string; - /** [Method] Returns the value of allowSingle */ + /** [Method] Returns the value of allowSingle + * @returns Boolean + */ getAllowSingle?(): boolean; - /** [Method] Returns the value of encode */ + /** [Method] Returns the value of encode + * @returns Boolean + */ getEncode?(): boolean; - /** [Method] Returns the value of encodeRequest */ + /** [Method] Returns the value of encodeRequest + * @returns Boolean + */ getEncodeRequest?(): boolean; - /** [Method] Returns the value of rootProperty */ + /** [Method] Returns the value of rootProperty + * @returns String + */ getRootProperty?(): string; /** [Method] Sets the value of allowSingle * @param allowSingle Boolean @@ -13937,13 +15681,21 @@ declare module Ext.data { root?: string; /** [Config Option] (String) */ rootProperty?: string; - /** [Method] Returns the value of allowSingle */ + /** [Method] Returns the value of allowSingle + * @returns Boolean + */ getAllowSingle?(): boolean; - /** [Method] Returns the value of encode */ + /** [Method] Returns the value of encode + * @returns Boolean + */ getEncode?(): boolean; - /** [Method] Returns the value of encodeRequest */ + /** [Method] Returns the value of encodeRequest + * @returns Boolean + */ getEncodeRequest?(): boolean; - /** [Method] Returns the value of rootProperty */ + /** [Method] Returns the value of rootProperty + * @returns String + */ getRootProperty?(): string; /** [Method] Sets the value of allowSingle * @param allowSingle Boolean @@ -13969,13 +15721,18 @@ declare module Ext.data.writer { nameProperty?: string; /** [Config Option] (Boolean) */ writeAllFields?: boolean; - /** [Method] Returns the value of nameProperty */ + /** [Method] Returns the value of nameProperty + * @returns String + */ getNameProperty?(): string; /** [Method] Formats the data for each record before sending it to the server * @param record Object The record that we are writing to the server. + * @returns Object An object literal of name/value keys to be written to the server. By default this method returns the data property on the record. */ getRecordData?( record?:any ): any; - /** [Method] Returns the value of writeAllFields */ + /** [Method] Returns the value of writeAllFields + * @returns Boolean + */ getWriteAllFields?(): boolean; /** [Method] Sets the value of nameProperty * @param nameProperty String @@ -13987,6 +15744,7 @@ declare module Ext.data.writer { setWriteAllFields?( writeAllFields?:boolean ): void; /** [Method] Prepares a Proxy s Ext data Request object * @param request Ext.data.Request The request object. + * @returns Ext.data.Request The modified request object. */ write?( request?:Ext.data.IRequest ): Ext.data.IRequest; } @@ -13997,13 +15755,18 @@ declare module Ext.data { nameProperty?: string; /** [Config Option] (Boolean) */ writeAllFields?: boolean; - /** [Method] Returns the value of nameProperty */ + /** [Method] Returns the value of nameProperty + * @returns String + */ getNameProperty?(): string; /** [Method] Formats the data for each record before sending it to the server * @param record Object The record that we are writing to the server. + * @returns Object An object literal of name/value keys to be written to the server. By default this method returns the data property on the record. */ getRecordData?( record?:any ): any; - /** [Method] Returns the value of writeAllFields */ + /** [Method] Returns the value of writeAllFields + * @returns Boolean + */ getWriteAllFields?(): boolean; /** [Method] Sets the value of nameProperty * @param nameProperty String @@ -14015,6 +15778,7 @@ declare module Ext.data { setWriteAllFields?( writeAllFields?:boolean ): void; /** [Method] Prepares a Proxy s Ext data Request object * @param request Ext.data.Request The request object. + * @returns Ext.data.Request The modified request object. */ write?( request?:Ext.data.IRequest ): Ext.data.IRequest; } @@ -14025,13 +15789,18 @@ declare module Ext.data { nameProperty?: string; /** [Config Option] (Boolean) */ writeAllFields?: boolean; - /** [Method] Returns the value of nameProperty */ + /** [Method] Returns the value of nameProperty + * @returns String + */ getNameProperty?(): string; /** [Method] Formats the data for each record before sending it to the server * @param record Object The record that we are writing to the server. + * @returns Object An object literal of name/value keys to be written to the server. By default this method returns the data property on the record. */ getRecordData?( record?:any ): any; - /** [Method] Returns the value of writeAllFields */ + /** [Method] Returns the value of writeAllFields + * @returns Boolean + */ getWriteAllFields?(): boolean; /** [Method] Sets the value of nameProperty * @param nameProperty String @@ -14043,6 +15812,7 @@ declare module Ext.data { setWriteAllFields?( writeAllFields?:boolean ): void; /** [Method] Prepares a Proxy s Ext data Request object * @param request Ext.data.Request The request object. + * @returns Ext.data.Request The modified request object. */ write?( request?:Ext.data.IRequest ): Ext.data.IRequest; } @@ -14057,13 +15827,21 @@ declare module Ext.data.writer { header?: string; /** [Config Option] (String) */ record?: string; - /** [Method] Returns the value of defaultDocumentRoot */ + /** [Method] Returns the value of defaultDocumentRoot + * @returns String + */ getDefaultDocumentRoot?(): string; - /** [Method] Returns the value of documentRoot */ + /** [Method] Returns the value of documentRoot + * @returns String + */ getDocumentRoot?(): string; - /** [Method] Returns the value of header */ + /** [Method] Returns the value of header + * @returns String + */ getHeader?(): string; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] Sets the value of defaultDocumentRoot * @param defaultDocumentRoot String @@ -14084,6 +15862,7 @@ declare module Ext.data.writer { /** [Method] * @param request Object * @param data Object + * @returns Object */ writeRecords?( request?:any, data?:any ): any; } @@ -14098,13 +15877,21 @@ declare module Ext.data { header?: string; /** [Config Option] (String) */ record?: string; - /** [Method] Returns the value of defaultDocumentRoot */ + /** [Method] Returns the value of defaultDocumentRoot + * @returns String + */ getDefaultDocumentRoot?(): string; - /** [Method] Returns the value of documentRoot */ + /** [Method] Returns the value of documentRoot + * @returns String + */ getDocumentRoot?(): string; - /** [Method] Returns the value of header */ + /** [Method] Returns the value of header + * @returns String + */ getHeader?(): string; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] Sets the value of defaultDocumentRoot * @param defaultDocumentRoot String @@ -14125,6 +15912,7 @@ declare module Ext.data { /** [Method] * @param request Object * @param data Object + * @returns Object */ writeRecords?( request?:any, data?:any ): any; } @@ -14151,17 +15939,29 @@ declare module Ext.dataview.component { record?: Ext.data.IModel; /** [Config Option] (Number/String) */ width?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of dataMap */ + /** [Method] Returns the value of dataMap + * @returns Object + */ getDataMap?(): any; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of itemCls */ + /** [Method] Returns the value of itemCls + * @returns String + */ getItemCls?(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array + */ getItems?(): any[]; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; /** [Method] Sets the value of baseCls * @param baseCls String @@ -14205,15 +16005,25 @@ declare module Ext.dataview.component { tpl?: any; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of body */ + /** [Method] Returns the value of body + * @returns Object + */ getBody?(): any; - /** [Method] Returns the value of dataMap */ + /** [Method] Returns the value of dataMap + * @returns Object + */ getDataMap?(): any; - /** [Method] Returns the value of disclosure */ + /** [Method] Returns the value of disclosure + * @returns Object + */ getDisclosure?(): any; - /** [Method] Returns the value of header */ + /** [Method] Returns the value of header + * @returns Object + */ getHeader?(): any; /** [Method] Sets the value of baseCls * @param baseCls String @@ -14253,13 +16063,21 @@ declare module Ext.dataview.component { record?: Ext.data.IModel; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of disclosure */ + /** [Method] Returns the value of disclosure + * @returns Object + */ getDisclosure?(): any; - /** [Method] Returns the value of header */ + /** [Method] Returns the value of header + * @returns Object + */ getHeader?(): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -14351,10 +16169,7 @@ declare module Ext.dataview { * @param records Number/Array/Ext.data.Model The record(s) to deselect. Can also be a number to reference by index. * @param suppressEvent Boolean If true the deselect event will not be fired. */ - deselect?( records?:any, suppressEvent?:any ): any; - deselect?( records?:number, suppressEvent?:boolean ): void; - deselect?( records?:any[], suppressEvent?:boolean ): void; - deselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; + deselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Deselects all records * @param supress Object */ @@ -14365,119 +16180,181 @@ declare module Ext.dataview { * @param records Ext.data.Model/Number An array of records or an index. * @param suppressEvent Boolean Set to false to not fire a deselect event. */ - doDeselect?( records?:any, suppressEvent?:any ): any; - doDeselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; - doDeselect?( records?:number, suppressEvent?:boolean ): void; + doDeselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Selects a record instance by record instance or index * @param records Ext.data.Model/Number An array of records or an index. * @param keepExisting Boolean * @param suppressEvent Boolean Set to false to not fire a select event. */ - doSelect?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - doSelect?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - doSelect?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; + doSelect?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; /** [Method] Returns the template node the passed child belongs to or null if it doesn t belong to one */ findItemByChild?(): void; /** [Method] Returns the template node by the Ext EventObject or null if it is not found */ findTargetByEvent?(): void; - /** [Method] Returns the value of allowDeselect */ + /** [Method] Returns the value of allowDeselect + * @returns Boolean + */ getAllowDeselect?(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getCount?(): number; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object[] + */ getData?(): any[]; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of deferEmptyText */ + /** [Method] Returns the value of deferEmptyText + * @returns Boolean + */ getDeferEmptyText?(): boolean; - /** [Method] Returns the value of deselectOnContainerClick */ + /** [Method] Returns the value of deselectOnContainerClick + * @returns Boolean + */ getDeselectOnContainerClick?(): boolean; - /** [Method] Returns the value of disableSelection */ + /** [Method] Returns the value of disableSelection + * @returns Boolean + */ getDisableSelection?(): boolean; - /** [Method] Returns the value of emptyText */ + /** [Method] Returns the value of emptyText + * @returns String + */ getEmptyText?(): string; - /** [Method] Returns the value of inline */ + /** [Method] Returns the value of inline + * @returns Boolean/Object + */ getInline?(): any; /** [Method] Returns an item at the specified index * @param index Number Index of the item. + * @returns Ext.dom.Element/Ext.dataview.component.DataItem item Item at the specified index. */ getItemAt?( index?:number ): any; - /** [Method] Returns the value of itemCls */ + /** [Method] Returns the value of itemCls + * @returns String + */ getItemCls?(): string; - /** [Method] Returns the value of itemConfig */ + /** [Method] Returns the value of itemConfig + * @returns Object + */ getItemConfig?(): any; /** [Method] Returns an index for the specified item * @param item Number The item to locate. + * @returns Number Index for the specified item. */ getItemIndex?( item?:number ): number; - /** [Method] Returns the value of itemTpl */ + /** [Method] Returns the value of itemTpl + * @returns String/String[]/Ext.XTemplate + */ getItemTpl?(): any; - /** [Method] Returns the array of previously selected items */ + /** [Method] Returns the array of previously selected items + * @returns Array The previous selection. + */ getLastSelected?(): any[]; - /** [Method] Returns the value of loadingText */ + /** [Method] Returns the value of loadingText + * @returns String + */ getLoadingText?(): string; - /** [Method] Returns the value of maxItemCache */ + /** [Method] Returns the value of maxItemCache + * @returns Number + */ getMaxItemCache?(): number; - /** [Method] Returns the value of mode */ + /** [Method] Returns the value of mode + * @returns String + */ getMode?(): string; /** [Method] Gets a template node */ getNode?(): void; /** [Method] Gets a range nodes */ getNodes?(): void; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; - /** [Method] Returns the value of pressedDelay */ + /** [Method] Returns the value of pressedDelay + * @returns Number + */ getPressedDelay?(): number; /** [Method] Gets an array of the records from an array of nodes */ getRecords?(): void; - /** [Method] Returns the value of scrollToTopOnRefresh */ + /** [Method] Returns the value of scrollToTopOnRefresh + * @returns Boolean + */ getScrollToTopOnRefresh?(): boolean; - /** [Method] Returns the value of scrollable */ + /** [Method] Returns the value of scrollable + * @returns Boolean + */ getScrollable?(): boolean; - /** [Method] Returns the value of selectedCls */ + /** [Method] Returns the value of selectedCls + * @returns String + */ getSelectedCls?(): string; /** [Method] Gets the currently selected nodes */ getSelectedNodes?(): void; /** [Method] Gets an array of the selected records */ getSelectedRecords?(): void; - /** [Method] Returns an array of the currently selected records */ + /** [Method] Returns an array of the currently selected records + * @returns Array An array of selected records. + */ getSelection?(): any[]; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getSelectionCount?(): number; - /** [Method] Returns the selection mode currently used by this Selectable */ + /** [Method] Returns the selection mode currently used by this Selectable + * @returns String The current mode. + */ getSelectionMode?(): string; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.Store/Object + */ getStore?(): any; - /** [Method] Returns the value of triggerCtEvent */ + /** [Method] Returns the value of triggerCtEvent + * @returns String + */ getTriggerCtEvent?(): string; - /** [Method] Returns the value of triggerEvent */ + /** [Method] Returns the value of triggerEvent + * @returns String + */ getTriggerEvent?(): string; - /** [Method] Returns the value of useComponents */ + /** [Method] Returns the value of useComponents + * @returns Boolean + */ getUseComponents?(): boolean; - /** [Method] Returns an array of the current items in the DataView */ + /** [Method] Returns an array of the current items in the DataView + * @returns Ext.dom.Element[]/Ext.dataview.component.DataItem[] Array of Items. + */ getViewItems?(): any; /** [Method] Method called when the Store s Reader throws an exception */ handleException?(): void; - /** [Method] Returns true if there is a selected record */ + /** [Method] Returns true if there is a selected record + * @returns Boolean + */ hasSelection?(): boolean; /** [Method] Finds the index of the passed node */ indexOf?(): void; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; - /** [Method] Returns true if the Selectable is currently locked */ + /** [Method] Returns true if the Selectable is currently locked + * @returns Boolean True if currently locked + */ isLocked?(): boolean; /** [Method] Returns true if the specified row is selected * @param record Ext.data.Model/Number The record or index of the record to check. + * @returns Boolean */ - isSelected?( record?:any ): any; - isSelected?( record?:Ext.data.IModel ): boolean; - isSelected?( record?:number ): boolean; + isSelected?( record?:any ): boolean; /** [Method] Function which can be overridden to provide custom formatting for each Record that is used by this DataView s templat * @param data Object/Object[] The raw data object that was used to create the Record. * @param index Number the index number of the Record being prepared for rendering. * @param record Ext.data.Model The Record being prepared for rendering. + * @returns Array/Object The formatted data in a format expected by the internal template's overwrite() method. (either an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})) */ prepareData?( data?:any, index?:number, record?:Ext.data.IModel ): any; /** [Method] Refreshes the view by reloading the data from the store and re rendering the template */ @@ -14489,10 +16366,7 @@ declare module Ext.dataview { * @param keepExisting Boolean If true, the existing selection will be added to (if not, the old selection is replaced). * @param suppressEvent Boolean If true, the select event will not be fired. */ - select?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - select?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:any[], keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; + select?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; /** [Method] Selects all records * @param silent Boolean true to suppress all select events. */ @@ -14550,10 +16424,7 @@ declare module Ext.dataview { /** [Method] Sets the value of itemTpl * @param itemTpl String/String[]/Ext.XTemplate */ - setItemTpl?( itemTpl?:any ): any; - setItemTpl?( itemTpl?:string ): void; - setItemTpl?( itemTpl?:string[] ): void; - setItemTpl?( itemTpl?:Ext.IXTemplate ): void; + setItemTpl?( itemTpl?:any ): void; /** [Method] This was an internal function accidentally exposed in 1 x and now deprecated */ setLastFocused?(): void; /** [Method] Sets the value of loadingText @@ -14681,10 +16552,7 @@ declare module Ext { * @param records Number/Array/Ext.data.Model The record(s) to deselect. Can also be a number to reference by index. * @param suppressEvent Boolean If true the deselect event will not be fired. */ - deselect?( records?:any, suppressEvent?:any ): any; - deselect?( records?:number, suppressEvent?:boolean ): void; - deselect?( records?:any[], suppressEvent?:boolean ): void; - deselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; + deselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Deselects all records * @param supress Object */ @@ -14695,119 +16563,181 @@ declare module Ext { * @param records Ext.data.Model/Number An array of records or an index. * @param suppressEvent Boolean Set to false to not fire a deselect event. */ - doDeselect?( records?:any, suppressEvent?:any ): any; - doDeselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; - doDeselect?( records?:number, suppressEvent?:boolean ): void; + doDeselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Selects a record instance by record instance or index * @param records Ext.data.Model/Number An array of records or an index. * @param keepExisting Boolean * @param suppressEvent Boolean Set to false to not fire a select event. */ - doSelect?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - doSelect?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - doSelect?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; + doSelect?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; /** [Method] Returns the template node the passed child belongs to or null if it doesn t belong to one */ findItemByChild?(): void; /** [Method] Returns the template node by the Ext EventObject or null if it is not found */ findTargetByEvent?(): void; - /** [Method] Returns the value of allowDeselect */ + /** [Method] Returns the value of allowDeselect + * @returns Boolean + */ getAllowDeselect?(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getCount?(): number; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object[] + */ getData?(): any[]; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of deferEmptyText */ + /** [Method] Returns the value of deferEmptyText + * @returns Boolean + */ getDeferEmptyText?(): boolean; - /** [Method] Returns the value of deselectOnContainerClick */ + /** [Method] Returns the value of deselectOnContainerClick + * @returns Boolean + */ getDeselectOnContainerClick?(): boolean; - /** [Method] Returns the value of disableSelection */ + /** [Method] Returns the value of disableSelection + * @returns Boolean + */ getDisableSelection?(): boolean; - /** [Method] Returns the value of emptyText */ + /** [Method] Returns the value of emptyText + * @returns String + */ getEmptyText?(): string; - /** [Method] Returns the value of inline */ + /** [Method] Returns the value of inline + * @returns Boolean/Object + */ getInline?(): any; /** [Method] Returns an item at the specified index * @param index Number Index of the item. + * @returns Ext.dom.Element/Ext.dataview.component.DataItem item Item at the specified index. */ getItemAt?( index?:number ): any; - /** [Method] Returns the value of itemCls */ + /** [Method] Returns the value of itemCls + * @returns String + */ getItemCls?(): string; - /** [Method] Returns the value of itemConfig */ + /** [Method] Returns the value of itemConfig + * @returns Object + */ getItemConfig?(): any; /** [Method] Returns an index for the specified item * @param item Number The item to locate. + * @returns Number Index for the specified item. */ getItemIndex?( item?:number ): number; - /** [Method] Returns the value of itemTpl */ + /** [Method] Returns the value of itemTpl + * @returns String/String[]/Ext.XTemplate + */ getItemTpl?(): any; - /** [Method] Returns the array of previously selected items */ + /** [Method] Returns the array of previously selected items + * @returns Array The previous selection. + */ getLastSelected?(): any[]; - /** [Method] Returns the value of loadingText */ + /** [Method] Returns the value of loadingText + * @returns String + */ getLoadingText?(): string; - /** [Method] Returns the value of maxItemCache */ + /** [Method] Returns the value of maxItemCache + * @returns Number + */ getMaxItemCache?(): number; - /** [Method] Returns the value of mode */ + /** [Method] Returns the value of mode + * @returns String + */ getMode?(): string; /** [Method] Gets a template node */ getNode?(): void; /** [Method] Gets a range nodes */ getNodes?(): void; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; - /** [Method] Returns the value of pressedDelay */ + /** [Method] Returns the value of pressedDelay + * @returns Number + */ getPressedDelay?(): number; /** [Method] Gets an array of the records from an array of nodes */ getRecords?(): void; - /** [Method] Returns the value of scrollToTopOnRefresh */ + /** [Method] Returns the value of scrollToTopOnRefresh + * @returns Boolean + */ getScrollToTopOnRefresh?(): boolean; - /** [Method] Returns the value of scrollable */ + /** [Method] Returns the value of scrollable + * @returns Boolean + */ getScrollable?(): boolean; - /** [Method] Returns the value of selectedCls */ + /** [Method] Returns the value of selectedCls + * @returns String + */ getSelectedCls?(): string; /** [Method] Gets the currently selected nodes */ getSelectedNodes?(): void; /** [Method] Gets an array of the selected records */ getSelectedRecords?(): void; - /** [Method] Returns an array of the currently selected records */ + /** [Method] Returns an array of the currently selected records + * @returns Array An array of selected records. + */ getSelection?(): any[]; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getSelectionCount?(): number; - /** [Method] Returns the selection mode currently used by this Selectable */ + /** [Method] Returns the selection mode currently used by this Selectable + * @returns String The current mode. + */ getSelectionMode?(): string; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.Store/Object + */ getStore?(): any; - /** [Method] Returns the value of triggerCtEvent */ + /** [Method] Returns the value of triggerCtEvent + * @returns String + */ getTriggerCtEvent?(): string; - /** [Method] Returns the value of triggerEvent */ + /** [Method] Returns the value of triggerEvent + * @returns String + */ getTriggerEvent?(): string; - /** [Method] Returns the value of useComponents */ + /** [Method] Returns the value of useComponents + * @returns Boolean + */ getUseComponents?(): boolean; - /** [Method] Returns an array of the current items in the DataView */ + /** [Method] Returns an array of the current items in the DataView + * @returns Ext.dom.Element[]/Ext.dataview.component.DataItem[] Array of Items. + */ getViewItems?(): any; /** [Method] Method called when the Store s Reader throws an exception */ handleException?(): void; - /** [Method] Returns true if there is a selected record */ + /** [Method] Returns true if there is a selected record + * @returns Boolean + */ hasSelection?(): boolean; /** [Method] Finds the index of the passed node */ indexOf?(): void; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; - /** [Method] Returns true if the Selectable is currently locked */ + /** [Method] Returns true if the Selectable is currently locked + * @returns Boolean True if currently locked + */ isLocked?(): boolean; /** [Method] Returns true if the specified row is selected * @param record Ext.data.Model/Number The record or index of the record to check. + * @returns Boolean */ - isSelected?( record?:any ): any; - isSelected?( record?:Ext.data.IModel ): boolean; - isSelected?( record?:number ): boolean; + isSelected?( record?:any ): boolean; /** [Method] Function which can be overridden to provide custom formatting for each Record that is used by this DataView s templat * @param data Object/Object[] The raw data object that was used to create the Record. * @param index Number the index number of the Record being prepared for rendering. * @param record Ext.data.Model The Record being prepared for rendering. + * @returns Array/Object The formatted data in a format expected by the internal template's overwrite() method. (either an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})) */ prepareData?( data?:any, index?:number, record?:Ext.data.IModel ): any; /** [Method] Refreshes the view by reloading the data from the store and re rendering the template */ @@ -14819,10 +16749,7 @@ declare module Ext { * @param keepExisting Boolean If true, the existing selection will be added to (if not, the old selection is replaced). * @param suppressEvent Boolean If true, the select event will not be fired. */ - select?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - select?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:any[], keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; + select?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; /** [Method] Selects all records * @param silent Boolean true to suppress all select events. */ @@ -14880,10 +16807,7 @@ declare module Ext { /** [Method] Sets the value of itemTpl * @param itemTpl String/String[]/Ext.XTemplate */ - setItemTpl?( itemTpl?:any ): any; - setItemTpl?( itemTpl?:string ): void; - setItemTpl?( itemTpl?:string[] ): void; - setItemTpl?( itemTpl?:Ext.IXTemplate ): void; + setItemTpl?( itemTpl?:any ): void; /** [Method] This was an internal function accidentally exposed in 1 x and now deprecated */ setLastFocused?(): void; /** [Method] Sets the value of loadingText @@ -14973,15 +16897,25 @@ declare module Ext.dataview { ui?: string; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of letters */ + /** [Method] Returns the value of letters + * @returns Array + */ getLetters?(): any[]; - /** [Method] Returns the value of listPrefix */ + /** [Method] Returns the value of listPrefix + * @returns String + */ getListPrefix?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Returns true when direction is horizontal */ isHorizontal?(): void; @@ -15031,15 +16965,25 @@ declare module Ext { ui?: string; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of letters */ + /** [Method] Returns the value of letters + * @returns Array + */ getLetters?(): any[]; - /** [Method] Returns the value of listPrefix */ + /** [Method] Returns the value of listPrefix + * @returns String + */ getListPrefix?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Returns true when direction is horizontal */ isHorizontal?(): void; @@ -15103,49 +17047,87 @@ declare module Ext.dataview { useSimpleItems?: boolean; /** [Config Option] (Boolean) */ variableHeights?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of disclosureProperty */ + /** [Method] Returns the value of disclosureProperty + * @returns String + */ getDisclosureProperty?(): string; - /** [Method] Returns the value of grouped */ + /** [Method] Returns the value of grouped + * @returns Boolean + */ getGrouped?(): boolean; - /** [Method] Returns the value of icon */ + /** [Method] Returns the value of icon + * @returns Object + */ getIcon?(): any; - /** [Method] Returns the value of indexBar */ + /** [Method] Returns the value of indexBar + * @returns Boolean/Object + */ getIndexBar?(): any; - /** [Method] Returns the value of infinite */ + /** [Method] Returns the value of infinite + * @returns Boolean + */ getInfinite?(): boolean; /** [Method] Returns an item at the specified index * @param index Number Index of the item. + * @returns Ext.dom.Element/Ext.dataview.component.DataItem item Item at the specified index. */ getItemAt?( index?:number ): any; - /** [Method] Returns the value of itemHeight */ + /** [Method] Returns the value of itemHeight + * @returns Number + */ getItemHeight?(): number; /** [Method] Returns an index for the specified item * @param item Number The item to locate. + * @returns Number Index for the specified item. */ getItemIndex?( item?:number ): number; - /** [Method] Returns the value of onItemDisclosure */ + /** [Method] Returns the value of onItemDisclosure + * @returns Boolean/Function/Object + */ getOnItemDisclosure?(): any; - /** [Method] Returns the value of pinHeaders */ + /** [Method] Returns the value of pinHeaders + * @returns Boolean + */ getPinHeaders?(): boolean; - /** [Method] Returns the value of preventSelectionOnDisclose */ + /** [Method] Returns the value of preventSelectionOnDisclose + * @returns Boolean + */ getPreventSelectionOnDisclose?(): boolean; - /** [Method] Returns the value of refreshHeightOnUpdate */ + /** [Method] Returns the value of refreshHeightOnUpdate + * @returns Boolean + */ getRefreshHeightOnUpdate?(): boolean; - /** [Method] Returns all the items that are docked in the scroller in this list */ + /** [Method] Returns all the items that are docked in the scroller in this list + * @returns Array An array of the scrollDock items + */ getScrollDockedItems?(): any[]; - /** [Method] Returns the value of striped */ + /** [Method] Returns the value of striped + * @returns Boolean + */ getStriped?(): boolean; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of useSimpleItems */ + /** [Method] Returns the value of useSimpleItems + * @returns Boolean + */ getUseSimpleItems?(): boolean; - /** [Method] Returns the value of variableHeights */ + /** [Method] Returns the value of variableHeights + * @returns Boolean + */ getVariableHeights?(): boolean; - /** [Method] Returns an array of the current items in the DataView */ + /** [Method] Returns an array of the current items in the DataView + * @returns Ext.dom.Element[]/Ext.dataview.component.DataItem[] Array of Items. + */ getViewItems?(): any; /** [Method] We override DataView s initialize method with an empty function */ initialize?(): void; @@ -15253,49 +17235,87 @@ declare module Ext { useSimpleItems?: boolean; /** [Config Option] (Boolean) */ variableHeights?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of disclosureProperty */ + /** [Method] Returns the value of disclosureProperty + * @returns String + */ getDisclosureProperty?(): string; - /** [Method] Returns the value of grouped */ + /** [Method] Returns the value of grouped + * @returns Boolean + */ getGrouped?(): boolean; - /** [Method] Returns the value of icon */ + /** [Method] Returns the value of icon + * @returns Object + */ getIcon?(): any; - /** [Method] Returns the value of indexBar */ + /** [Method] Returns the value of indexBar + * @returns Boolean/Object + */ getIndexBar?(): any; - /** [Method] Returns the value of infinite */ + /** [Method] Returns the value of infinite + * @returns Boolean + */ getInfinite?(): boolean; /** [Method] Returns an item at the specified index * @param index Number Index of the item. + * @returns Ext.dom.Element/Ext.dataview.component.DataItem item Item at the specified index. */ getItemAt?( index?:number ): any; - /** [Method] Returns the value of itemHeight */ + /** [Method] Returns the value of itemHeight + * @returns Number + */ getItemHeight?(): number; /** [Method] Returns an index for the specified item * @param item Number The item to locate. + * @returns Number Index for the specified item. */ getItemIndex?( item?:number ): number; - /** [Method] Returns the value of onItemDisclosure */ + /** [Method] Returns the value of onItemDisclosure + * @returns Boolean/Function/Object + */ getOnItemDisclosure?(): any; - /** [Method] Returns the value of pinHeaders */ + /** [Method] Returns the value of pinHeaders + * @returns Boolean + */ getPinHeaders?(): boolean; - /** [Method] Returns the value of preventSelectionOnDisclose */ + /** [Method] Returns the value of preventSelectionOnDisclose + * @returns Boolean + */ getPreventSelectionOnDisclose?(): boolean; - /** [Method] Returns the value of refreshHeightOnUpdate */ + /** [Method] Returns the value of refreshHeightOnUpdate + * @returns Boolean + */ getRefreshHeightOnUpdate?(): boolean; - /** [Method] Returns all the items that are docked in the scroller in this list */ + /** [Method] Returns all the items that are docked in the scroller in this list + * @returns Array An array of the scrollDock items + */ getScrollDockedItems?(): any[]; - /** [Method] Returns the value of striped */ + /** [Method] Returns the value of striped + * @returns Boolean + */ getStriped?(): boolean; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of useSimpleItems */ + /** [Method] Returns the value of useSimpleItems + * @returns Boolean + */ getUseSimpleItems?(): boolean; - /** [Method] Returns the value of variableHeights */ + /** [Method] Returns the value of variableHeights + * @returns Boolean + */ getVariableHeights?(): boolean; - /** [Method] Returns an array of the current items in the DataView */ + /** [Method] Returns an array of the current items in the DataView + * @returns Ext.dom.Element[]/Ext.dataview.component.DataItem[] Array of Items. + */ getViewItems?(): any; /** [Method] We override DataView s initialize method with an empty function */ initialize?(): void; @@ -15375,9 +17395,13 @@ declare module Ext.dataview { baseCls?: string; /** [Config Option] (String) */ docked?: string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ getDocked?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -15437,55 +17461,97 @@ declare module Ext.dataview { useToolbar?: boolean; /** [Config Option] (Boolean) */ variableHeights?: boolean; - /** [Method] Returns the value of allowDeselect */ + /** [Method] Returns the value of allowDeselect + * @returns Boolean + */ getAllowDeselect?(): boolean; - /** [Method] Returns the value of backButton */ + /** [Method] Returns the value of backButton + * @returns Object + */ getBackButton?(): any; - /** [Method] Returns the value of backText */ + /** [Method] Returns the value of backText + * @returns String + */ getBackText?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of detailCard */ + /** [Method] Returns the value of detailCard + * @returns Ext.Component + */ getDetailCard?(): Ext.IComponent; - /** [Method] Returns the value of detailContainer */ + /** [Method] Returns the value of detailContainer + * @returns Ext.Container + */ getDetailContainer?(): Ext.IContainer; - /** [Method] Returns the value of displayField */ + /** [Method] Returns the value of displayField + * @returns String + */ getDisplayField?(): string; - /** [Method] Returns the value of emptyText */ + /** [Method] Returns the value of emptyText + * @returns String + */ getEmptyText?(): string; - /** [Method] Returns the value of itemHeight */ + /** [Method] Returns the value of itemHeight + * @returns Number + */ getItemHeight?(): number; /** [Method] Override this method to provide custom template rendering of individual nodes * @param node Ext.data.Record + * @returns String */ getItemTextTpl?( node?:Ext.data.IRecord ): string; - /** [Method] Returns the value of listConfig */ + /** [Method] Returns the value of listConfig + * @returns Object + */ getListConfig?(): any; - /** [Method] Returns the value of loadingText */ + /** [Method] Returns the value of loadingText + * @returns String + */ getLoadingText?(): string; - /** [Method] Returns the value of onItemDisclosure */ + /** [Method] Returns the value of onItemDisclosure + * @returns Boolean/Function + */ getOnItemDisclosure?(): any; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.TreeStore/String + */ getStore?(): any; /** [Method] Returns the subList for a specified node */ getSubList?(): void; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Override this method to provide custom template rendering of titles back buttons when useTitleAsBackText is enabled * @param node Ext.data.Record + * @returns String */ getTitleTextTpl?( node?:Ext.data.IRecord ): string; - /** [Method] Returns the value of toolbar */ + /** [Method] Returns the value of toolbar + * @returns Ext.Toolbar/Object/Boolean + */ getToolbar?(): any; - /** [Method] Returns the value of updateTitleText */ + /** [Method] Returns the value of updateTitleText + * @returns Boolean + */ getUpdateTitleText?(): boolean; - /** [Method] Returns the value of useSimpleItems */ + /** [Method] Returns the value of useSimpleItems + * @returns Boolean + */ getUseSimpleItems?(): boolean; - /** [Method] Returns the value of useTitleAsBackText */ + /** [Method] Returns the value of useTitleAsBackText + * @returns Boolean + */ getUseTitleAsBackText?(): boolean; - /** [Method] Returns the value of useToolbar */ + /** [Method] Returns the value of useToolbar + * @returns Boolean + */ getUseToolbar?(): boolean; - /** [Method] Returns the value of variableHeights */ + /** [Method] Returns the value of variableHeights + * @returns Boolean + */ getVariableHeights?(): boolean; /** [Method] The leaf you want to navigate to * @param node Ext.data.NodeInterface The specified node to navigate to. @@ -15552,14 +17618,11 @@ declare module Ext.dataview { /** [Method] Sets the value of onItemDisclosure * @param onItemDisclosure Boolean/Function */ - setOnItemDisclosure?( onItemDisclosure?:any ): any; - setOnItemDisclosure?( onItemDisclosure?:boolean ): void; + setOnItemDisclosure?( onItemDisclosure?:any ): void; /** [Method] Sets the value of store * @param store Ext.data.TreeStore/String */ - setStore?( store?:any ): any; - setStore?( store?:Ext.data.ITreeStore ): void; - setStore?( store?:string ): void; + setStore?( store?:any ): void; /** [Method] Sets the value of title * @param title String */ @@ -15642,55 +17705,97 @@ declare module Ext { useToolbar?: boolean; /** [Config Option] (Boolean) */ variableHeights?: boolean; - /** [Method] Returns the value of allowDeselect */ + /** [Method] Returns the value of allowDeselect + * @returns Boolean + */ getAllowDeselect?(): boolean; - /** [Method] Returns the value of backButton */ + /** [Method] Returns the value of backButton + * @returns Object + */ getBackButton?(): any; - /** [Method] Returns the value of backText */ + /** [Method] Returns the value of backText + * @returns String + */ getBackText?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of detailCard */ + /** [Method] Returns the value of detailCard + * @returns Ext.Component + */ getDetailCard?(): Ext.IComponent; - /** [Method] Returns the value of detailContainer */ + /** [Method] Returns the value of detailContainer + * @returns Ext.Container + */ getDetailContainer?(): Ext.IContainer; - /** [Method] Returns the value of displayField */ + /** [Method] Returns the value of displayField + * @returns String + */ getDisplayField?(): string; - /** [Method] Returns the value of emptyText */ + /** [Method] Returns the value of emptyText + * @returns String + */ getEmptyText?(): string; - /** [Method] Returns the value of itemHeight */ + /** [Method] Returns the value of itemHeight + * @returns Number + */ getItemHeight?(): number; /** [Method] Override this method to provide custom template rendering of individual nodes * @param node Ext.data.Record + * @returns String */ getItemTextTpl?( node?:Ext.data.IRecord ): string; - /** [Method] Returns the value of listConfig */ + /** [Method] Returns the value of listConfig + * @returns Object + */ getListConfig?(): any; - /** [Method] Returns the value of loadingText */ + /** [Method] Returns the value of loadingText + * @returns String + */ getLoadingText?(): string; - /** [Method] Returns the value of onItemDisclosure */ + /** [Method] Returns the value of onItemDisclosure + * @returns Boolean/Function + */ getOnItemDisclosure?(): any; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.TreeStore/String + */ getStore?(): any; /** [Method] Returns the subList for a specified node */ getSubList?(): void; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Override this method to provide custom template rendering of titles back buttons when useTitleAsBackText is enabled * @param node Ext.data.Record + * @returns String */ getTitleTextTpl?( node?:Ext.data.IRecord ): string; - /** [Method] Returns the value of toolbar */ + /** [Method] Returns the value of toolbar + * @returns Ext.Toolbar/Object/Boolean + */ getToolbar?(): any; - /** [Method] Returns the value of updateTitleText */ + /** [Method] Returns the value of updateTitleText + * @returns Boolean + */ getUpdateTitleText?(): boolean; - /** [Method] Returns the value of useSimpleItems */ + /** [Method] Returns the value of useSimpleItems + * @returns Boolean + */ getUseSimpleItems?(): boolean; - /** [Method] Returns the value of useTitleAsBackText */ + /** [Method] Returns the value of useTitleAsBackText + * @returns Boolean + */ getUseTitleAsBackText?(): boolean; - /** [Method] Returns the value of useToolbar */ + /** [Method] Returns the value of useToolbar + * @returns Boolean + */ getUseToolbar?(): boolean; - /** [Method] Returns the value of variableHeights */ + /** [Method] Returns the value of variableHeights + * @returns Boolean + */ getVariableHeights?(): boolean; /** [Method] The leaf you want to navigate to * @param node Ext.data.NodeInterface The specified node to navigate to. @@ -15757,14 +17862,11 @@ declare module Ext { /** [Method] Sets the value of onItemDisclosure * @param onItemDisclosure Boolean/Function */ - setOnItemDisclosure?( onItemDisclosure?:any ): any; - setOnItemDisclosure?( onItemDisclosure?:boolean ): void; + setOnItemDisclosure?( onItemDisclosure?:any ): void; /** [Method] Sets the value of store * @param store Ext.data.TreeStore/String */ - setStore?( store?:any ): any; - setStore?( store?:Ext.data.ITreeStore ): void; - setStore?( store?:string ): void; + setStore?( store?:any ): void; /** [Method] Sets the value of title * @param title String */ @@ -15807,103 +17909,126 @@ declare module Ext { * @param date Date The date to modify. * @param interval String A valid date interval enum value. * @param value Number The amount to add to the current date. + * @returns Date The new Date instance. */ static add( date?:any, interval?:string, value?:number ): any; /** [Method] Align the date to unit * @param date Date The date to be aligned. * @param unit String The unit. This unit is compatible with the date interval constants. + * @returns Date The aligned date. */ static align( date?:any, unit?:string ): any; /** [Method] Checks if a date falls on or between the given start and end dates * @param date Date The date to check. * @param start Date Start date. * @param end Date End date. + * @returns Boolean true if this date falls on or between the given start and end dates. */ static between( date?:any, start?:any, end?:any ): boolean; /** [Method] Attempts to clear all time information from this Date by setting the time to midnight of the same day automatically * @param date Date The date. * @param clone Boolean true to create a clone of this date, clear the time and return it. + * @returns Date this or the clone. */ static clearTime( date?:any, clone?:boolean ): any; /** [Method] Creates and returns a new Date instance with the exact same date value as the called instance * @param date Date The date. + * @returns Date The new Date instance. */ static clone( date?:any ): any; /** [Method] Calculate how many units are there between two time * @param min Date The first time. * @param max Date The second time. * @param unit String The unit. This unit is compatible with the date interval constants. + * @returns Number The maximum number n of units that min + n * unit <= max. */ static diff( min?:any, max?:any, unit?:string ): number; /** [Method] Formats a date given the supplied format string * @param date Date The date to format. * @param format String The format string. + * @returns String The formatted date. */ static format( date?:any, format?:string ): string; /** [Method] Get the numeric day number of the year adjusted for leap year * @param date Date The date. + * @returns Number 0 to 364 (365 in leap years). */ static getDayOfYear( date?:any ): number; /** [Method] Get the number of days in the current month adjusted for leap year * @param date Date The date. + * @returns Number The number of days in the month. */ static getDaysInMonth( date?:any ): number; /** [Method] Returns the number of milliseconds between two dates * @param dateA Date The first date. * @param dateB Date The second date, defaults to now. + * @returns Number The difference in milliseconds. */ static getElapsed( dateA?:any, dateB?:any ): number; /** [Method] Get the date of the first day of the month in which this date resides * @param date Date The date. + * @returns Date */ static getFirstDateOfMonth( date?:any ): any; /** [Method] Get the first day of the current month adjusted for leap year * @param date Date The date + * @returns Number The day number (0-6). */ static getFirstDayOfMonth( date?:any ): number; /** [Method] Get the offset from GMT of the current date equivalent to the format specifier O * @param date Date The date. * @param colon Boolean true to separate the hours and minutes with a colon. + * @returns String The 4-character offset string prefixed with + or - (e.g. '-0600'). */ static getGMTOffset( date?:any, colon?:boolean ): string; /** [Method] Get the date of the last day of the month in which this date resides * @param date Date The date. + * @returns Date */ static getLastDateOfMonth( date?:any ): any; /** [Method] Get the last day of the current month adjusted for leap year * @param date Date The date. + * @returns Number The day number (0-6). */ static getLastDayOfMonth( date?:any ): number; /** [Method] Get the zero based JavaScript month number for the given short full month name * @param name String The short/full month name. + * @returns Number The zero-based JavaScript month number. */ static getMonthNumber( name?:string ): number; /** [Method] Get the short day name for the given day number * @param day Number A zero-based JavaScript day number. + * @returns String The short day name. */ static getShortDayName( day?:number ): string; /** [Method] Get the short month name for the given month number * @param month Number A zero-based JavaScript month number. + * @returns String The short month name. */ static getShortMonthName( month?:number ): string; /** [Method] Get the English ordinal suffix of the current day equivalent to the format specifier S * @param date Date The date. + * @returns String 'st', 'nd', 'rd' or 'th'. */ static getSuffix( date?:any ): string; /** [Method] Get the timezone abbreviation of the current date equivalent to the format specifier T * @param date Date The date. + * @returns String The abbreviated timezone name (e.g. 'CST', 'PDT', 'EDT', 'MPST' ...). */ static getTimezone( date?:any ): string; /** [Method] Get the numeric ISO 8601 week number of the year equivalent to the format specifier W but without a leading zero * @param date Date The date. + * @returns Number 1 to 53. */ static getWeekOfYear( date?:any ): number; /** [Method] Checks if the current date is affected by Daylight Saving Time DST * @param date Date The date. + * @returns Boolean true if the current date is affected by DST. */ static isDST( date?:any ): boolean; /** [Method] Checks if the current date falls within a leap year * @param date Date The date. + * @returns Boolean true if the current date falls within a leap year, false otherwise. */ static isLeapYear( date?:any ): boolean; /** [Method] Checks if the passed Date parameters will cause a JavaScript Date rollover @@ -15914,14 +18039,18 @@ declare module Ext { * @param minute Number Minute. * @param second Number Second. * @param millisecond Number Millisecond. + * @returns Boolean true if the passed parameters do not cause a Date "rollover", false otherwise. */ static isValid( year?:number, month?:number, day?:number, hour?:number, minute?:number, second?:number, millisecond?:number ): boolean; - /** [Method] Returns the current timestamp */ + /** [Method] Returns the current timestamp + * @returns Number The current timestamp. + */ static now(): number; /** [Method] Parses the passed string using the specified date format * @param input String The raw date string. * @param format String The expected date string format. * @param strict Boolean true to validate date strings while parsing (i.e. prevents JavaScript Date "rollover"). Invalid date strings will return null when parsed. + * @returns Date/null The parsed Date, or null if an invalid date string. */ static parse( input?:string, format?:string, strict?:boolean ): any; } @@ -15934,103 +18063,126 @@ declare module Ext { * @param date Date The date to modify. * @param interval String A valid date interval enum value. * @param value Number The amount to add to the current date. + * @returns Date The new Date instance. */ static add( date?:any, interval?:string, value?:number ): any; /** [Method] Align the date to unit * @param date Date The date to be aligned. * @param unit String The unit. This unit is compatible with the date interval constants. + * @returns Date The aligned date. */ static align( date?:any, unit?:string ): any; /** [Method] Checks if a date falls on or between the given start and end dates * @param date Date The date to check. * @param start Date Start date. * @param end Date End date. + * @returns Boolean true if this date falls on or between the given start and end dates. */ static between( date?:any, start?:any, end?:any ): boolean; /** [Method] Attempts to clear all time information from this Date by setting the time to midnight of the same day automatically * @param date Date The date. * @param clone Boolean true to create a clone of this date, clear the time and return it. + * @returns Date this or the clone. */ static clearTime( date?:any, clone?:boolean ): any; /** [Method] Creates and returns a new Date instance with the exact same date value as the called instance * @param date Date The date. + * @returns Date The new Date instance. */ static clone( date?:any ): any; /** [Method] Calculate how many units are there between two time * @param min Date The first time. * @param max Date The second time. * @param unit String The unit. This unit is compatible with the date interval constants. + * @returns Number The maximum number n of units that min + n * unit <= max. */ static diff( min?:any, max?:any, unit?:string ): number; /** [Method] Formats a date given the supplied format string * @param date Date The date to format. * @param format String The format string. + * @returns String The formatted date. */ static format( date?:any, format?:string ): string; /** [Method] Get the numeric day number of the year adjusted for leap year * @param date Date The date. + * @returns Number 0 to 364 (365 in leap years). */ static getDayOfYear( date?:any ): number; /** [Method] Get the number of days in the current month adjusted for leap year * @param date Date The date. + * @returns Number The number of days in the month. */ static getDaysInMonth( date?:any ): number; /** [Method] Returns the number of milliseconds between two dates * @param dateA Date The first date. * @param dateB Date The second date, defaults to now. + * @returns Number The difference in milliseconds. */ static getElapsed( dateA?:any, dateB?:any ): number; /** [Method] Get the date of the first day of the month in which this date resides * @param date Date The date. + * @returns Date */ static getFirstDateOfMonth( date?:any ): any; /** [Method] Get the first day of the current month adjusted for leap year * @param date Date The date + * @returns Number The day number (0-6). */ static getFirstDayOfMonth( date?:any ): number; /** [Method] Get the offset from GMT of the current date equivalent to the format specifier O * @param date Date The date. * @param colon Boolean true to separate the hours and minutes with a colon. + * @returns String The 4-character offset string prefixed with + or - (e.g. '-0600'). */ static getGMTOffset( date?:any, colon?:boolean ): string; /** [Method] Get the date of the last day of the month in which this date resides * @param date Date The date. + * @returns Date */ static getLastDateOfMonth( date?:any ): any; /** [Method] Get the last day of the current month adjusted for leap year * @param date Date The date. + * @returns Number The day number (0-6). */ static getLastDayOfMonth( date?:any ): number; /** [Method] Get the zero based JavaScript month number for the given short full month name * @param name String The short/full month name. + * @returns Number The zero-based JavaScript month number. */ static getMonthNumber( name?:string ): number; /** [Method] Get the short day name for the given day number * @param day Number A zero-based JavaScript day number. + * @returns String The short day name. */ static getShortDayName( day?:number ): string; /** [Method] Get the short month name for the given month number * @param month Number A zero-based JavaScript month number. + * @returns String The short month name. */ static getShortMonthName( month?:number ): string; /** [Method] Get the English ordinal suffix of the current day equivalent to the format specifier S * @param date Date The date. + * @returns String 'st', 'nd', 'rd' or 'th'. */ static getSuffix( date?:any ): string; /** [Method] Get the timezone abbreviation of the current date equivalent to the format specifier T * @param date Date The date. + * @returns String The abbreviated timezone name (e.g. 'CST', 'PDT', 'EDT', 'MPST' ...). */ static getTimezone( date?:any ): string; /** [Method] Get the numeric ISO 8601 week number of the year equivalent to the format specifier W but without a leading zero * @param date Date The date. + * @returns Number 1 to 53. */ static getWeekOfYear( date?:any ): number; /** [Method] Checks if the current date is affected by Daylight Saving Time DST * @param date Date The date. + * @returns Boolean true if the current date is affected by DST. */ static isDST( date?:any ): boolean; /** [Method] Checks if the current date falls within a leap year * @param date Date The date. + * @returns Boolean true if the current date falls within a leap year, false otherwise. */ static isLeapYear( date?:any ): boolean; /** [Method] Checks if the passed Date parameters will cause a JavaScript Date rollover @@ -16041,14 +18193,18 @@ declare module Ext { * @param minute Number Minute. * @param second Number Second. * @param millisecond Number Millisecond. + * @returns Boolean true if the passed parameters do not cause a Date "rollover", false otherwise. */ static isValid( year?:number, month?:number, day?:number, hour?:number, minute?:number, second?:number, millisecond?:number ): boolean; - /** [Method] Returns the current timestamp */ + /** [Method] Returns the current timestamp + * @returns Number The current timestamp. + */ static now(): number; /** [Method] Parses the passed string using the specified date format * @param input String The raw date string. * @param format String The expected date string format. * @param strict Boolean true to validate date strings while parsing (i.e. prevents JavaScript Date "rollover"). Invalid date strings will return null when parsed. + * @returns Date/null The parsed Date, or null if an invalid date string. */ static parse( input?:string, format?:string, strict?:boolean ): any; } @@ -16059,7 +18215,9 @@ declare module Ext { component?: any; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of component * @param component Object @@ -16086,19 +18244,19 @@ declare module Ext.device { export class Camera { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Allows you to capture a photo * @param options Object The options to use when taking a photo. * @param scope Object The scope in which to call the success and failure functions, if specified. @@ -16112,13 +18270,17 @@ declare module Ext.device { static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -16144,7 +18306,9 @@ declare module Ext.device.camera { * @param options Object */ capture?( options?:any ): void; - /** [Method] Returns the value of samples */ + /** [Method] Returns the value of samples + * @returns Array + */ getSamples?(): any[]; /** [Method] Sets the value of samples * @param samples Array @@ -16166,30 +18330,34 @@ declare module Ext.device { export class Communicator { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -16215,16 +18383,14 @@ declare module Ext.device.connection { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -16236,9 +18402,7 @@ declare module Ext.device.connection { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -16246,9 +18410,7 @@ declare module Ext.device.connection { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -16256,34 +18418,45 @@ declare module Ext.device.connection { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of online */ + /** [Method] Returns the value of online + * @returns Boolean + */ getOnline?(): boolean; - /** [Method] Returns the current connection type */ + /** [Method] Returns the current connection type + * @returns String type + */ getType?(): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; - /** [Method] True if the device is currently online */ + /** [Method] True if the device is currently online + * @returns Boolean online + */ isOnline?(): boolean; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -16292,18 +18465,14 @@ declare module Ext.device.connection { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -16311,28 +18480,25 @@ declare module Ext.device.connection { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -16341,16 +18507,14 @@ declare module Ext.device.connection { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -16358,18 +18522,14 @@ declare module Ext.device.connection { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -16377,9 +18537,7 @@ declare module Ext.device.connection { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -16401,25 +18559,21 @@ declare module Ext.device.connection { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device { @@ -16432,16 +18586,14 @@ declare module Ext.device { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -16453,9 +18605,7 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -16463,24 +18613,22 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object */ static clearListeners(): void; /** [Method] */ @@ -16488,44 +18636,59 @@ declare module Ext.device { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; - /** [Method] Returns the value of online */ + /** [Method] Returns the value of online + * @returns Boolean + */ static getOnline(): boolean; - /** [Method] Returns the current connection type */ + /** [Method] Returns the current connection type + * @returns String type + */ static getType(): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] True if the device is currently online */ + /** [Method] True if the device is currently online + * @returns Boolean online + */ static isOnline(): boolean; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -16534,18 +18697,14 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -16553,28 +18712,25 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -16583,16 +18739,14 @@ declare module Ext.device { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -16600,18 +18754,14 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -16619,9 +18769,7 @@ declare module Ext.device { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -16634,7 +18782,9 @@ declare module Ext.device { * @param type Object */ static setType( type?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends the firing of all events */ static suspendEvents(): void; @@ -16645,32 +18795,32 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device.connection { export interface IPhoneGap extends Ext.device.connection.IAbstract { - /** [Method] Returns the value of online */ + /** [Method] Returns the value of online + * @returns Boolean + */ getOnline?(): boolean; - /** [Method] Returns the current connection type */ + /** [Method] Returns the current connection type + * @returns String type + */ getType?(): string; } } @@ -16680,7 +18830,9 @@ declare module Ext.device.connection { } declare module Ext.device.connection { export interface ISimulator extends Ext.device.connection.IAbstract { - /** [Method] Returns the value of online */ + /** [Method] Returns the value of online + * @returns Boolean + */ getOnline?(): boolean; } } @@ -16694,16 +18846,14 @@ declare module Ext.device.contacts { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -16715,9 +18865,7 @@ declare module Ext.device.contacts { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -16725,9 +18873,7 @@ declare module Ext.device.contacts { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -16735,41 +18881,51 @@ declare module Ext.device.contacts { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; /** [Method] Returns an Array of contact objects * @param config Object + * @returns Object[] An array of contact objects. */ getContacts?( config?:any ): any[]; - /** [Method] Returns the value of includeImages */ + /** [Method] Returns the value of includeImages + * @returns Boolean + */ getIncludeImages?(): boolean; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Returns localized user readable label for a contact field i e * @param config Object + * @returns String user readable string */ getLocalizedLabel?( config?:any ): string; /** [Method] Returns base64 encoded image thumbnail for a contact specified in config id * @param config Object + * @returns String base64 string */ getThumbnail?( config?:any ): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -16779,18 +18935,14 @@ declare module Ext.device.contacts { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -16798,28 +18950,25 @@ declare module Ext.device.contacts { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -16828,16 +18977,14 @@ declare module Ext.device.contacts { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -16845,18 +18992,14 @@ declare module Ext.device.contacts { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -16864,9 +19007,7 @@ declare module Ext.device.contacts { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of includeImages * @param includeImages Boolean */ @@ -16884,25 +19025,21 @@ declare module Ext.device.contacts { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device { @@ -16915,16 +19052,14 @@ declare module Ext.device { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -16936,9 +19071,7 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -16946,24 +19079,22 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object */ static clearListeners(): void; /** [Method] */ @@ -16971,51 +19102,65 @@ declare module Ext.device { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; /** [Method] Returns an Array of contact objects * @param config Object + * @returns Object[] An array of contact objects. */ static getContacts( config?:any ): any[]; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; - /** [Method] Returns the value of includeImages */ + /** [Method] Returns the value of includeImages + * @returns Boolean + */ static getIncludeImages(): boolean; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; /** [Method] Returns localized user readable label for a contact field i e * @param config Object + * @returns String user readable string */ static getLocalizedLabel( config?:any ): string; /** [Method] Returns base64 encoded image thumbnail for a contact specified in config id * @param config Object + * @returns String base64 string */ static getThumbnail( config?:any ): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Alias for addManagedListener @@ -17025,18 +19170,14 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -17044,28 +19185,25 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -17074,16 +19212,14 @@ declare module Ext.device { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -17091,18 +19227,14 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -17110,9 +19242,7 @@ declare module Ext.device { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of includeImages * @param includeImages Boolean */ @@ -17121,7 +19251,9 @@ declare module Ext.device { * @param listeners Object */ static setListeners( listeners?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends the firing of all events */ static suspendEvents(): void; @@ -17132,39 +19264,38 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device.contacts { export interface ISencha extends Ext.device.contacts.IAbstract { /** [Method] Returns an Array of contact objects * @param config Object + * @returns Object[] An array of contact objects. */ getContacts?( config?:any ): any[]; /** [Method] Returns localized user readable label for a contact field i e * @param config Object + * @returns String user readable string */ getLocalizedLabel?( config?:any ): string; /** [Method] Returns base64 encoded image thumbnail for a contact specified in config id * @param config Object + * @returns String base64 string */ getThumbnail?( config?:any ): string; } @@ -17185,16 +19316,14 @@ declare module Ext.device.device { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -17206,9 +19335,7 @@ declare module Ext.device.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -17216,9 +19343,7 @@ declare module Ext.device.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -17226,27 +19351,32 @@ declare module Ext.device.device { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -17256,18 +19386,14 @@ declare module Ext.device.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -17275,25 +19401,21 @@ declare module Ext.device.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Opens a specified URL * @param url String The URL to open */ @@ -17301,6 +19423,7 @@ declare module Ext.device.device { /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -17309,16 +19432,14 @@ declare module Ext.device.device { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -17326,18 +19447,14 @@ declare module Ext.device.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -17345,9 +19462,7 @@ declare module Ext.device.device { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -17361,25 +19476,21 @@ declare module Ext.device.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device { @@ -17392,16 +19503,14 @@ declare module Ext.device { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -17413,9 +19522,7 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -17423,24 +19530,22 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object */ static clearListeners(): void; /** [Method] */ @@ -17448,37 +19553,46 @@ declare module Ext.device { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Alias for addManagedListener @@ -17488,18 +19602,14 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -17507,25 +19617,21 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Opens a specified URL * @param url String The URL to open */ @@ -17533,6 +19639,7 @@ declare module Ext.device { /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -17541,16 +19648,14 @@ declare module Ext.device { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -17558,18 +19663,14 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -17577,14 +19678,14 @@ declare module Ext.device { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ static setListeners( listeners?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends the firing of all events */ static suspendEvents(): void; @@ -17595,25 +19696,21 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device.device { @@ -17644,17 +19741,25 @@ declare module Ext.device.geolocation { timeout?: number; /** [Method] If you are currently watching for the current position this will stop that task */ clearWatch?(): void; - /** [Method] Returns the value of allowHighAccuracy */ + /** [Method] Returns the value of allowHighAccuracy + * @returns Boolean + */ getAllowHighAccuracy?(): boolean; /** [Method] Attempts to get the current position of this device * @param config Object An object which contains the following config options: */ getCurrentPosition?( config?:any ): void; - /** [Method] Returns the value of frequency */ + /** [Method] Returns the value of frequency + * @returns Number + */ getFrequency?(): number; - /** [Method] Returns the value of maximumAge */ + /** [Method] Returns the value of maximumAge + * @returns Number + */ getMaximumAge?(): number; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; /** [Method] Sets the value of allowHighAccuracy * @param allowHighAccuracy Boolean @@ -17684,41 +19789,51 @@ declare module Ext.device { export class Geolocation { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] If you are currently watching for the current position this will stop that task */ static clearWatch(): void; /** [Method] */ static destroy(): void; - /** [Method] Returns the value of allowHighAccuracy */ + /** [Method] Returns the value of allowHighAccuracy + * @returns Boolean + */ static getAllowHighAccuracy(): boolean; /** [Method] Attempts to get the current position of this device * @param config Object An object which contains the following config options: */ static getCurrentPosition( config?:any ): void; - /** [Method] Returns the value of frequency */ + /** [Method] Returns the value of frequency + * @returns Number + */ static getFrequency(): number; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of maximumAge */ + /** [Method] Returns the value of maximumAge + * @returns Number + */ static getMaximumAge(): number; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ static getTimeout(): number; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Sets the value of allowHighAccuracy @@ -17737,7 +19852,9 @@ declare module Ext.device { * @param timeout Number */ static setTimeout( timeout?:number ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Watches for the current position and calls the callback when successful depending on the specified frequency * @param config Object An object which contains the following config options: @@ -17789,34 +19906,38 @@ declare module Ext.device { export class Notification { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] A simple way to show a notification * @param config Object An object which contains the following config options: */ static show( config?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Vibrates the device */ static vibrate(): void; @@ -17854,16 +19975,14 @@ declare module Ext.device.orientation { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -17875,9 +19994,7 @@ declare module Ext.device.orientation { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -17885,9 +20002,7 @@ declare module Ext.device.orientation { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -17895,27 +20010,32 @@ declare module Ext.device.orientation { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -17925,18 +20045,14 @@ declare module Ext.device.orientation { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -17944,28 +20060,25 @@ declare module Ext.device.orientation { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -17974,16 +20087,14 @@ declare module Ext.device.orientation { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -17991,18 +20102,14 @@ declare module Ext.device.orientation { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -18010,9 +20117,7 @@ declare module Ext.device.orientation { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -18026,25 +20131,21 @@ declare module Ext.device.orientation { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device.orientation { @@ -18061,16 +20162,14 @@ declare module Ext.device { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -18082,9 +20181,7 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -18092,24 +20189,22 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object */ static clearListeners(): void; /** [Method] */ @@ -18117,37 +20212,46 @@ declare module Ext.device { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Alias for addManagedListener @@ -18157,18 +20261,14 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -18176,28 +20276,25 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -18206,16 +20303,14 @@ declare module Ext.device { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -18223,18 +20318,14 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -18242,14 +20333,14 @@ declare module Ext.device { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ static setListeners( listeners?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends the firing of all events */ static suspendEvents(): void; @@ -18260,25 +20351,21 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device.orientation { @@ -18291,19 +20378,19 @@ declare module Ext.device { export class Purchases { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Checks if the current user is able to make payments * @param config Object */ @@ -18316,6 +20403,7 @@ declare module Ext.device { static getCompletedPurchases( config?:any ): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Returns a Ext data Store instance of all products available to purchase @@ -18328,9 +20416,12 @@ declare module Ext.device { static getPurchases( config?:any ): void; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -18338,7 +20429,9 @@ declare module Ext.device.purchases { export interface IProduct extends Ext.data.IModel { /** [Config Option] (Object[]/String[]) */ fields?: any; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Array + */ getFields?(): any[]; /** [Method] Will attempt to purchase this product * @param config Object @@ -18358,7 +20451,9 @@ declare module Ext.device.purchases { * @param config Object */ complete?( config?:any ): void; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Array + */ getFields?(): any[]; /** [Method] Sets the value of fields * @param fields Array @@ -18406,34 +20501,38 @@ declare module Ext.device { export class Push { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Registers a push notification * @param config Object The configuration for to pass when registering this push notification service. */ static register( config?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -18449,7 +20548,9 @@ declare module Ext.device.sqlite { * @param config Object The object which contains the following config options: */ changeVersion?( config?:any ): void; - /** [Method] Returns the current version of the database */ + /** [Method] Returns the current version of the database + * @returns String The current database version. + */ getVersion?(): string; /** [Method] Works same as transaction but performs a Ext device SQLite SQLTransaction instance with a read only mode * @param config Object @@ -18467,34 +20568,39 @@ declare module Ext.device { export class SQLite { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Returns a Ext device SQLite Database instance * @param config Object The object which contains the following config options: + * @returns Ext.device.SQLite.Database The opened database, null if an error occured. */ static openDatabase( config?:any ): Ext.device.sqlite.IDatabase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -18502,26 +20608,36 @@ declare module Ext.device.sqlite { export interface ISencha extends Ext.IBase { /** [Method] Returns a Ext device SQLite Database instance * @param config Object The object which contains the following config options: + * @returns Ext.device.SQLite.Database The opened database, null if an error occured. */ openDatabase?( config?:any ): Ext.device.sqlite.IDatabase; } } declare module Ext.device.sqlite { export interface ISQLResultSet extends Ext.IBase { - /** [Method] Returns the row ID of the last row that the SQL statement inserted into the database if the statement inserted any r */ + /** [Method] Returns the row ID of the last row that the SQL statement inserted into the database if the statement inserted any r + * @returns Number The inserted row ID. + */ getInsertId?(): number; - /** [Method] Returns a Ext device SQLite SQLResultSetRowList instance representing rows returned by the SQL statement */ + /** [Method] Returns a Ext device SQLite SQLResultSetRowList instance representing rows returned by the SQL statement + * @returns Ext.device.SQLite.SQLResultSetRowList The rows. + */ getRows?(): Ext.device.sqlite.ISQLResultSetRowList; - /** [Method] Returns the number of rows that were changed by the SQL statement */ + /** [Method] Returns the number of rows that were changed by the SQL statement + * @returns Number The number of rows affected. + */ getRowsAffected?(): number; } } declare module Ext.device.sqlite { export interface ISQLResultSetRowList extends Ext.IBase { - /** [Method] Returns the number of rows returned by the SQL statement */ + /** [Method] Returns the number of rows returned by the SQL statement + * @returns Number The number of rows. + */ getLength?(): number; /** [Method] Returns a row at specified index returned by the SQL statement * @param index Number The index of a row. This is required. + * @returns Object The row. */ item?( index?:number ): any; } @@ -18540,21 +20656,37 @@ declare module Ext.direct { data?: any; /** [Config Option] (String) */ name?: string; - /** [Method] Returns the value of code */ + /** [Method] Returns the value of code + * @returns Object + */ getCode?(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; - /** [Method] Returns the value of message */ + /** [Method] Returns the value of message + * @returns String + */ getMessage?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of result */ + /** [Method] Returns the value of result + * @returns Object + */ getResult?(): any; - /** [Method] Returns the value of status */ + /** [Method] Returns the value of status + * @returns Boolean + */ getStatus?(): boolean; - /** [Method] Returns the value of transaction */ + /** [Method] Returns the value of transaction + * @returns Object + */ getTransaction?(): any; - /** [Method] Returns the value of xhr */ + /** [Method] Returns the value of xhr + * @returns Object + */ getXhr?(): any; /** [Method] Sets the value of code * @param code Object @@ -18594,11 +20726,17 @@ declare module Ext.direct { export interface IExceptionEvent extends Ext.direct.IRemotingEvent { /** [Config Option] (String) */ name?: string; - /** [Method] Returns the value of error */ + /** [Method] Returns the value of error + * @returns Object + */ getError?(): any; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of status */ + /** [Method] Returns the value of status + * @returns Boolean + */ getStatus?(): boolean; /** [Method] Sets the value of error * @param error Object @@ -18618,6 +20756,7 @@ declare module Ext.direct { export interface IJsonProvider extends Ext.direct.IProvider { /** [Method] Create an event from a response object * @param response Object The XHR response object. + * @returns Ext.direct.Event The event. */ createEvent?( response?:any ): Ext.direct.IEvent; } @@ -18632,16 +20771,14 @@ declare module Ext.direct { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -18653,9 +20790,7 @@ declare module Ext.direct { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -18663,28 +20798,27 @@ declare module Ext.direct { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds an Ext Direct Provider and creates the proxy or stub methods to execute server side methods * @param provider Ext.direct.Provider/Object... Accepts any number of Provider descriptions (an instance or config object for a Provider). Each Provider description instructs Ext.Direct how to create client-side stub methods. + * @returns Object */ static addProvider( provider?:any ): any; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object */ static clearListeners(): void; /** [Method] */ @@ -18692,43 +20826,51 @@ declare module Ext.direct { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; /** [Method] Retrieves a provider by the id specified when the provider is added * @param id String/Ext.direct.Provider The id of the provider, or the provider instance. + * @returns Object */ static getProvider( id?:any ): any; - static getProvider( id?:string ): any; - static getProvider( id?:Ext.direct.IProvider ): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Alias for addManagedListener @@ -18738,18 +20880,14 @@ declare module Ext.direct { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -18757,33 +20895,30 @@ declare module Ext.direct { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Parses a direct function * @param fn String/Function The direct function + * @returns Function The function to use in the direct call. Null if not found */ static parseMethod( fn?:any ): any; - static parseMethod( fn?:string ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -18792,16 +20927,14 @@ declare module Ext.direct { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -18809,24 +20942,19 @@ declare module Ext.direct { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Removes the provider * @param provider String/Ext.direct.Provider The provider instance or the id of the provider. + * @returns Ext.direct.Provider/null The provider, null if not found. */ static removeProvider( provider?:any ): any; - static removeProvider( provider?:string ): any; - static removeProvider( provider?:Ext.direct.IProvider ): any; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -18834,14 +20962,14 @@ declare module Ext.direct { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ static setListeners( listeners?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends the firing of all events */ static suspendEvents(): void; @@ -18852,25 +20980,21 @@ declare module Ext.direct { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext { @@ -18883,16 +21007,14 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -18904,9 +21026,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -18914,28 +21034,27 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds an Ext Direct Provider and creates the proxy or stub methods to execute server side methods * @param provider Ext.direct.Provider/Object... Accepts any number of Provider descriptions (an instance or config object for a Provider). Each Provider description instructs Ext.Direct how to create client-side stub methods. + * @returns Object */ static addProvider( provider?:any ): any; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object */ static clearListeners(): void; /** [Method] */ @@ -18943,43 +21062,51 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; /** [Method] Retrieves a provider by the id specified when the provider is added * @param id String/Ext.direct.Provider The id of the provider, or the provider instance. + * @returns Object */ static getProvider( id?:any ): any; - static getProvider( id?:string ): any; - static getProvider( id?:Ext.direct.IProvider ): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Alias for addManagedListener @@ -18989,18 +21116,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -19008,33 +21131,30 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Parses a direct function * @param fn String/Function The direct function + * @returns Function The function to use in the direct call. Null if not found */ static parseMethod( fn?:any ): any; - static parseMethod( fn?:string ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -19043,16 +21163,14 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -19060,24 +21178,19 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Removes the provider * @param provider String/Ext.direct.Provider The provider instance or the id of the provider. + * @returns Ext.direct.Provider/null The provider, null if not found. */ static removeProvider( provider?:any ): any; - static removeProvider( provider?:string ): any; - static removeProvider( provider?:Ext.direct.IProvider ): any; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -19085,14 +21198,14 @@ declare module Ext { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ static setListeners( listeners?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends the firing of all events */ static suspendEvents(): void; @@ -19103,25 +21216,21 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.direct { @@ -19136,13 +21245,21 @@ declare module Ext.direct { connect?(): void; /** [Method] Disconnect from the server side and stop the polling process */ disconnect?(): void; - /** [Method] Returns the value of baseParams */ + /** [Method] Returns the value of baseParams + * @returns Object + */ getBaseParams?(): any; - /** [Method] Returns the value of interval */ + /** [Method] Returns the value of interval + * @returns Number + */ getInterval?(): number; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String/Function + */ getUrl?(): any; - /** [Method] Returns whether or not the server side is currently connected */ + /** [Method] Returns whether or not the server side is currently connected + * @returns Boolean + */ isConnected?(): boolean; /** [Method] Sets the value of baseParams * @param baseParams Object @@ -19155,8 +21272,7 @@ declare module Ext.direct { /** [Method] Sets the value of url * @param url String/Function */ - setUrl?( url?:any ): any; - setUrl?( url?:string ): void; + setUrl?( url?:any ): void; } } declare module Ext.direct { @@ -19169,16 +21285,14 @@ declare module Ext.direct { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -19190,9 +21304,7 @@ declare module Ext.direct { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -19200,9 +21312,7 @@ declare module Ext.direct { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] Abstract methods for subclasses to implement */ @@ -19214,32 +21324,41 @@ declare module Ext.direct { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns String + */ getId?(): string; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; - /** [Method] Returns whether or not the server side is currently connected */ + /** [Method] Returns whether or not the server side is currently connected + * @returns Boolean + */ isConnected?(): boolean; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -19248,18 +21367,14 @@ declare module Ext.direct { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -19267,28 +21382,25 @@ declare module Ext.direct { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -19297,16 +21409,14 @@ declare module Ext.direct { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -19314,18 +21424,14 @@ declare module Ext.direct { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -19333,9 +21439,7 @@ declare module Ext.direct { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of id * @param id String */ @@ -19353,36 +21457,38 @@ declare module Ext.direct { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.direct { export interface IRemotingEvent extends Ext.direct.IEvent { /** [Config Option] (String) */ name?: string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of tid */ + /** [Method] Returns the value of tid + * @returns Object + */ getTid?(): any; - /** [Method] Get the transaction associated with this event */ + /** [Method] Get the transaction associated with this event + * @returns Ext.direct.Transaction The transaction + */ getTransaction?(): Ext.direct.ITransaction; /** [Method] Sets the value of name * @param name String @@ -19402,17 +21508,28 @@ declare module Ext.direct { export interface IRemotingMethod extends Ext.IBase { /** [Method] Takes the arguments for the Direct function and splits the arguments from the scope and the callback * @param args Array The arguments passed to the direct call + * @returns Object An object with 3 properties, args, callback & scope. */ getCallData?( args?:any[] ): any; - /** [Method] Returns the value of formHandler */ + /** [Method] Returns the value of formHandler + * @returns Object + */ getFormHandler?(): any; - /** [Method] Returns the value of len */ + /** [Method] Returns the value of len + * @returns Object + */ getLen?(): any; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns Object + */ getName?(): any; - /** [Method] Returns the value of ordered */ + /** [Method] Returns the value of ordered + * @returns Boolean + */ getOrdered?(): boolean; - /** [Method] Returns the value of params */ + /** [Method] Returns the value of params + * @returns Object + */ getParams?(): any; /** [Method] Sets the value of formHandler * @param formHandler Object @@ -19456,21 +21573,37 @@ declare module Ext.direct { connect?(): void; /** [Method] Abstract methods for subclasses to implement */ disconnect?(): void; - /** [Method] Returns the value of actions */ + /** [Method] Returns the value of actions + * @returns Object + */ getActions?(): any; - /** [Method] Returns the value of enableBuffer */ + /** [Method] Returns the value of enableBuffer + * @returns Number/Boolean + */ getEnableBuffer?(): any; - /** [Method] Returns the value of enableUrlEncode */ + /** [Method] Returns the value of enableUrlEncode + * @returns String + */ getEnableUrlEncode?(): string; - /** [Method] Returns the value of maxRetries */ + /** [Method] Returns the value of maxRetries + * @returns Number + */ getMaxRetries?(): number; - /** [Method] Returns the value of namespace */ + /** [Method] Returns the value of namespace + * @returns String/Object + */ getNamespace?(): any; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; - /** [Method] Returns whether or not the server side is currently connected */ + /** [Method] Returns whether or not the server side is currently connected + * @returns Boolean + */ isConnected?(): boolean; /** [Method] Sets the value of actions * @param actions Object @@ -19479,9 +21612,7 @@ declare module Ext.direct { /** [Method] Sets the value of enableBuffer * @param enableBuffer Number/Boolean */ - setEnableBuffer?( enableBuffer?:any ): any; - setEnableBuffer?( enableBuffer?:number ): void; - setEnableBuffer?( enableBuffer?:boolean ): void; + setEnableBuffer?( enableBuffer?:any ): void; /** [Method] Sets the value of enableUrlEncode * @param enableUrlEncode String */ @@ -19506,23 +21637,41 @@ declare module Ext.direct { } declare module Ext.direct { export interface ITransaction extends Ext.IBase { - /** [Method] Returns the value of action */ + /** [Method] Returns the value of action + * @returns Object + */ getAction?(): any; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Object + */ getArgs?(): any; - /** [Method] Returns the value of callback */ + /** [Method] Returns the value of callback + * @returns Object + */ getCallback?(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; - /** [Method] Returns the value of form */ + /** [Method] Returns the value of form + * @returns Object + */ getForm?(): any; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns Object + */ getId?(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns Object + */ getMethod?(): any; - /** [Method] Returns the value of provider */ + /** [Method] Returns the value of provider + * @returns Object + */ getProvider?(): any; - /** [Method] Returns the value of retryCount */ + /** [Method] Returns the value of retryCount + * @returns Number + */ getRetryCount?(): number; /** [Method] Sets the value of action * @param action Object @@ -19577,16 +21726,14 @@ declare module Ext.dom { /** [Method] Adds elements to this Composite object * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an Array of DOM elements to add, or another Composite object who's elements should be added. * @param root HTMLElement/String The root element of the query or id of the root. + * @returns Ext.dom.CompositeElementLite This Composite object. */ - add?( els?:any, root?:any ): any; - add?( els?:HTMLElement[], root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:HTMLElement[], root?:string ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:string ): Ext.dom.ICompositeElementLite; + add?( els?:any, root?:any ): Ext.dom.ICompositeElementLite; /** [Method] Adds the given CSS class es to this Element * @param names String The CSS class(es) to add to this element. * @param prefix String Prefix to prepend to each class. * @param suffix String Suffix to append to each class. + * @returns Ext.dom.Element this */ addCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] fixes scope with flyweight @@ -19594,44 +21741,42 @@ declare module Ext.dom { * @param handler Object * @param scope Object * @param opt Object + * @returns Ext.dom.CompositeElementLite this */ addListener?( eventName?:any, handler?:any, scope?:any, opt?:any ): Ext.dom.ICompositeElementLite; /** [Method] Appends the passed element s to this element * @param element HTMLElement/Ext.dom.Element a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendChild?( element?:any ): any; - appendChild?( element?:HTMLElement ): Ext.dom.IElement; - appendChild?( element?:Ext.dom.IElement ): Ext.dom.IElement; + appendChild?( element?:any ): Ext.dom.IElement; /** [Method] Appends this element to the passed element * @param el String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IElement; - appendTo?( el?:HTMLElement ): Ext.dom.IElement; - appendTo?( el?:Ext.dom.IElement ): Ext.dom.IElement; + appendTo?( el?:any ): Ext.dom.IElement; /** [Method] More flexible version of setStyle for setting style properties * @param styles String/Object/Function A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification. + * @returns Ext.dom.Element this */ applyStyles?( styles?:any ): Ext.dom.IElement; /** [Method] Selects a single direct child based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector. * @param returnDom Boolean true to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true) */ child?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all elements */ clear?(): void; /** [Method] Returns true if this composite contains the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection. + * @returns Boolean */ - contains?( el?:any ): any; - contains?( el?:string ): boolean; - contains?( el?:HTMLElement ): boolean; - contains?( el?:Ext.IElement ): boolean; - contains?( el?:number ): boolean; + contains?( el?:any ): boolean; /** [Method] Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e * @param config Object DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be automatically generated with the specified attributes. * @param insertBefore HTMLElement a child element of this element. * @param returnDom Boolean true to return the dom node instead of creating an Element. + * @returns Ext.dom.Element The new child element. */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Translates an element using CSS 3 in 2D */ @@ -19641,90 +21786,103 @@ declare module Ext.dom { /** [Method] Selects a single child at any depth below this element based on the passed CSS selector the selector should not cont * @param selector String The CSS selector. * @param returnDom Boolean true to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true). */ down?( selector?:string, returnDom?:boolean ): any; /** [Method] Calls the passed function for each element in this composite * @param fn Function The function to call. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Element. + * @returns Ext.dom.CompositeElementLite this */ each?( fn?:any, scope?:any ): Ext.dom.ICompositeElementLite; /** [Method] Clears this Composite and adds the elements passed * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an array of DOM elements, or another Composite from which to fill this Composite. + * @returns Ext.dom.CompositeElementLite this */ - fill?( els?:any ): any; - fill?( els?:HTMLElement[] ): Ext.dom.ICompositeElementLite; - fill?( els?:Ext.dom.ICompositeElementLite ): Ext.dom.ICompositeElementLite; + fill?( els?:any ): Ext.dom.ICompositeElementLite; /** [Method] Filters this composite to only elements that match the passed selector * @param selector String/Function A string CSS selector or a comparison function. The comparison function will be called with the following arguments: + * @returns Ext.dom.CompositeElementLite this */ - filter?( selector?:any ): any; - filter?( selector?:string ): Ext.dom.ICompositeElementLite; + filter?( selector?:any ): Ext.dom.ICompositeElementLite; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParent?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParent?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParentNode?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParentNode?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. * @param offsets Array Offset the positioning by [x, y]. + * @returns Array [x, y] */ getAlignToXY?( element?:any, position?:string, offsets?:any[] ): any[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. * @param local Boolean true to get the local (element top/left-relative) anchor position instead of page coordinates. * @param size Object An object containing the size to use for calculating anchor position. {width: (target width), height: (target height)} (defaults to the element's current size) + * @returns Array [x, y] An array containing the element's x and y coordinates. */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): any[]; /** [Method] Returns the value of an attribute from the element s underlying DOM node * @param name String The attribute name. * @param namespace String The namespace in which to look for the attribute. + * @returns String The attribute value. */ getAttribute?( name?:string, namespace?:string ): string; /** [Method] Gets the width of the border s for the specified side s * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the border left width + the border right width. + * @returns Number The width of the sides passed added together */ getBorderWidth?( side?:string ): number; - /** [Method] Gets the bottom Y coordinate of the element element Y position element height */ + /** [Method] Gets the bottom Y coordinate of the element element Y position element height + * @returns Number + */ getBottom?(): number; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param contentBox Boolean If true a box for the content of the element is returned. * @param local Boolean If true the element's left and top are returned instead of page x/y. + * @returns Object An object in the format */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Returns the number of elements in this Composite */ + /** [Method] Returns the number of elements in this Composite + * @returns Number + */ getCount?(): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHTML?(): string; /** [Method] Returns the offset height of the element * @param contentHeight Boolean true to get the height minus borders and padding. + * @returns Number The element's height. */ getHeight?( contentHeight?:boolean ): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHtml?(): string; - /** [Method] Gets the left X coordinate */ + /** [Method] Gets the left X coordinate + * @returns Number + */ getLeft?(): number; /** [Method] Returns an object with properties top left right and bottom representing the margins of this element unless sides i * @param sides String Any combination of 'l', 'r', 't', 'b' to get the sum of those sides. + * @returns Object/Number */ getMargin?( sides?:string ): any; /** [Method] Returns the offsets of this element from the passed element * @param element Mixed The element to get the offsets from. + * @returns Array The XY page offsets (e.g. [100, -200]) */ getOffsetsTo?( element?:any ): any[]; /** [Method] Retrieves the height of the element account for the top and bottom margins */ @@ -19733,95 +21891,106 @@ declare module Ext.dom { getOuterWidth?(): void; /** [Method] Gets the width of the padding s for the specified side s * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the padding left + the padding right. + * @returns Number The padding of the sides passed added together. */ getPadding?( side?:string ): number; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param asRegion Boolean If true an Ext.util.Region will be returned. + * @returns Object box An object in the format: { x: <Element's X position>, y: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for setXY. */ getPageBox?( asRegion?:boolean ): any; - /** [Method] Gets the right X coordinate of the element element X position element width */ + /** [Method] Gets the right X coordinate of the element element X position element width + * @returns Number + */ getRight?(): number; /** [Method] Gets the Scroller instance of the first parent that has one */ getScrollParent?(): void; /** [Method] Returns the size of the element * @param contentSize Boolean true to get the width/size minus borders and padding. + * @returns Object An object containing the element's size: */ getSize?( contentSize?:boolean ): any; /** [Method] Normalizes currentStyle and computedStyle * @param prop String The style property whose value is returned. + * @returns String The current value of the style property for this element. */ getStyle?( prop?:string ): string; - /** [Method] Gets the top Y coordinate */ + /** [Method] Gets the top Y coordinate + * @returns Number + */ getTop?(): number; /** [Method] Returns the value of the value attribute * @param asNumber Boolean true to parse the value as a number. + * @returns String/Number */ getValue?( asNumber?:boolean ): any; - /** [Method] Returns the dimensions of the element available to lay content out in */ + /** [Method] Returns the dimensions of the element available to lay content out in + * @returns Object Object describing width and height: + */ getViewSize?(): any; /** [Method] Returns the offset width of the element * @param contentWidth Boolean true to get the width minus borders and padding. + * @returns Number The element's width. */ getWidth?( contentWidth?:boolean ): number; /** [Method] Gets the current X position of the element based on page coordinates * @param el Object + * @returns Number The X position of the element */ getX?( el?:any ): number; - /** [Method] Gets the current position of the element based on page coordinates */ + /** [Method] Gets the current position of the element based on page coordinates + * @returns Array The XY position of the element + */ getXY?(): any[]; /** [Method] Gets the current Y position of the element based on page coordinates * @param el Object + * @returns Number The Y position of the element */ getY?( el?:any ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param name String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( name?:string ): boolean; /** [Method] Hides this element */ hide?(): void; /** [Method] Find the index of the passed element within the composite collection * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.dom.Element, or an HtmlElement to find within the composite collection. + * @returns Number The index of the passed Ext.dom.Element in the composite collection, or -1 if not found. */ - indexOf?( el?:any ): any; - indexOf?( el?:string ): number; - indexOf?( el?:HTMLElement ): number; - indexOf?( el?:Ext.IElement ): number; - indexOf?( el?:number ): number; + indexOf?( el?:any ): number; /** [Method] Inserts this element after the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IElement; - insertAfter?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertAfter?( el?:any ): Ext.dom.IElement; /** [Method] Inserts this element before the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IElement; - insertBefore?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertBefore?( el?:any ): Ext.dom.IElement; /** [Method] Inserts an element as the first child of this element * @param element String/HTMLElement/Ext.dom.Element The id or element to insert. + * @returns Ext.dom.Element this */ - insertFirst?( element?:any ): any; - insertFirst?( element?:string ): Ext.dom.IElement; - insertFirst?( element?:HTMLElement ): Ext.dom.IElement; - insertFirst?( element?:Ext.dom.IElement ): Ext.dom.IElement; + insertFirst?( element?:any ): Ext.dom.IElement; /** [Method] Inserts an HTML fragment into this element * @param where String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean true to return an Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted). */ insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element * @param el String/HTMLElement/Ext.dom.Element/Object/Array The id, element to insert or a DomHelper config to create and insert or an array of any of those. * @param where String 'before' or 'after'. * @param returnDom Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Returns true if this element matches the passed simple selector e g * @param selector String The simple selector to test. + * @returns Boolean true if this element matches the selector, else false. */ is?( selector?:string ): boolean; /** [Method] Determines if this element is a descendant of the passed in Element */ @@ -19829,14 +21998,17 @@ declare module Ext.dom { /** [Method] Checks if the current value of a style is equal to a given value * @param style String property whose value is returned. * @param value String to check against. + * @returns Boolean true for when the current value equals the given value. */ isStyle?( style?:string, value?:string ): boolean; /** [Method] Returns true if the value of the given property is visually transparent * @param prop String The style property whose value is to be tested. + * @returns Boolean true if the style property is visually transparent. */ isTransparent?( prop?:string ): boolean; /** [Method] Returns a flyweight Element of the dom element object at the specified index * @param index Number + * @returns Ext.dom.Element */ item?( index?:number ): Ext.dom.IElement; /** [Method] Puts a mask over this element to disable user interaction */ @@ -19844,30 +22016,33 @@ declare module Ext.dom { /** [Method] Gets the next sibling skipping text nodes * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw dom node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The next sibling or null. */ next?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The parent node or null. */ parent?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the previous sibling skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element + * @returns Ext.dom.Element/HTMLElement/null The previous sibling or null. */ prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector. + * @returns HTMLElement[] An array of the matched nodes. */ query?( selector?:string ): HTMLElement[]; /** [Method] Adds one or more CSS classes to this element and removes the same class es from all siblings * @param className String/String[] The CSS class to add, or an array of classes. + * @returns Ext.dom.Element this */ - radioCls?( className?:any ): any; - radioCls?( className?:string ): Ext.dom.IElement; - radioCls?( className?:string[] ): Ext.dom.IElement; + radioCls?( className?:any ): Ext.dom.IElement; /** [Method] Removes this element s DOM reference */ remove?(): void; /** [Method] Removes all listeners for this object */ @@ -19876,197 +22051,188 @@ declare module Ext.dom { * @param names String The CSS class(es) to remove from this element. * @param prefix String Prefix to prepend to each class to be removed. * @param suffix String Suffix to append to each class to be removed. + * @returns Ext.dom.Element this */ removeCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Removes the specified element s * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite or an array of any of those. * @param removeDom Boolean true to also remove the element from the document + * @returns Ext.dom.CompositeElementLite this + */ + removeElement?( el?:any, removeDom?:boolean ): Ext.dom.ICompositeElementLite; + /** [Method] Forces the browser to repaint this element + * @returns Ext.dom.Element this */ - removeElement?( el?:any, removeDom?:any ): any; - removeElement?( el?:string, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:HTMLElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:Ext.IElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:number, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - /** [Method] Forces the browser to repaint this element */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element * @param element String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - replace?( element?:any ): any; - replace?( element?:string ): Ext.dom.IElement; - replace?( element?:HTMLElement ): Ext.dom.IElement; - replace?( element?:Ext.dom.IElement ): Ext.dom.IElement; + replace?( element?:any ): Ext.dom.IElement; /** [Method] Replaces a CSS class on the element with another * @param oldName String The CSS class to replace. * @param newName String The replacement CSS class. * @param prefix String Prefix to prepend to each class to be replaced. * @param suffix String Suffix to append to each class to be replaced. + * @returns Ext.dom.Element this */ replaceCls?( oldName?:string, newName?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Replaces the specified element with the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite to replace. * @param replacement String/Ext.Element The id of an element or the Element itself. * @param domReplace Boolean true to remove and replace the element in the document too. + * @returns Ext.dom.CompositeElementLite this */ - replaceElement?( el?:any, replacement?:any, domReplace?:any ): any; - replaceElement?( el?:string, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:string, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; + replaceElement?( el?:any, replacement?:any, domReplace?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Replaces this element with the passed element * @param el String/HTMLElement/Ext.dom.Element/Object The new element (id of the node, a DOM Node or an existing Element) or a DomHelper config of an element to create. + * @returns Ext.dom.Element This element. */ replaceWith?( el?:any ): Ext.dom.IElement; /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in * @param selector String/HTMLElement[] The CSS selector or an array of elements * @param composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - select?( selector?:any, composite?:any ): any; - select?( selector?:string, composite?:boolean ): Ext.dom.ICompositeElementLite; - select?( selector?:HTMLElement[], composite?:boolean ): Ext.dom.ICompositeElementLite; + select?( selector?:any, composite?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Serializes a DOM form into a url encoded string * @param form Object The form + * @returns String The url encoded form */ serializeForm?( form?:any ): string; /** [Method] Sets the passed attributes as attributes of this element a style attribute can be a string object or function * @param attributes Object The object with the attributes. * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( attributes?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom String The bottom CSS property value. + * @returns Ext.dom.Element this */ setBottom?( bottom?:string ): Ext.dom.IElement; /** [Method] Sets the element s box * @param box Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... } + * @returns Ext.dom.Element this */ setBox?( box?:any ): Ext.dom.IElement; /** [Method] Sets the specified CSS class on this element s DOM node * @param className String/Array The CSS class to set on this element. */ - setCls?( className?:any ): any; - setCls?( className?:string ): void; - setCls?( className?:any[] ): void; + setCls?( className?:any ): void; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHTML?( html?:string ): void; /** [Method] Set the height of this Element * @param height Number/String The new height. + * @returns Ext.dom.Element this */ - setHeight?( height?:any ): any; - setHeight?( height?:number ): Ext.dom.IElement; - setHeight?( height?:string ): Ext.dom.IElement; + setHeight?( height?:any ): Ext.dom.IElement; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHtml?( html?:string ): void; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left String The left CSS property value. + * @returns Ext.dom.Element this */ setLeft?( left?:string ): Ext.dom.IElement; /** [Method] Set the maximum height of this Element * @param height Number/String The new maximum height. + * @returns Ext.dom.Element this */ - setMaxHeight?( height?:any ): any; - setMaxHeight?( height?:number ): Ext.dom.IElement; - setMaxHeight?( height?:string ): Ext.dom.IElement; + setMaxHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the maximum width of this Element * @param width Number/String The new maximum width. + * @returns Ext.dom.Element this */ - setMaxWidth?( width?:any ): any; - setMaxWidth?( width?:number ): Ext.dom.IElement; - setMaxWidth?( width?:string ): Ext.dom.IElement; + setMaxWidth?( width?:any ): Ext.dom.IElement; /** [Method] Set the minimum height of this Element * @param height Number/String The new minimum height. + * @returns Ext.dom.Element this */ - setMinHeight?( height?:any ): any; - setMinHeight?( height?:number ): Ext.dom.IElement; - setMinHeight?( height?:string ): Ext.dom.IElement; + setMinHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the minimum width of this Element * @param width Number/String The new minimum width. + * @returns Ext.dom.Element this */ - setMinWidth?( width?:any ): any; - setMinWidth?( width?:number ): Ext.dom.IElement; - setMinWidth?( width?:string ): Ext.dom.IElement; + setMinWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right String The right CSS property value. + * @returns Ext.dom.Element this */ setRight?( right?:string ): Ext.dom.IElement; /** [Method] Set the size of this Element * @param width Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels). A String used to set the CSS width style. Animation may not be used. A size object in the format {width: widthValue, height: heightValue}. * @param height Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used. + * @returns Ext.dom.Element this */ - setSize?( width?:any, height?:any ): any; - setSize?( width?:number, height?:number ): Ext.dom.IElement; - setSize?( width?:string, height?:number ): Ext.dom.IElement; - setSize?( width?:number, height?:string ): Ext.dom.IElement; - setSize?( width?:string, height?:string ): Ext.dom.IElement; + setSize?( width?:any, height?:any ): Ext.dom.IElement; /** [Method] Wrapper for setting style properties also takes single object parameter of multiple styles * @param property String/Object The style property to be set, or an object of multiple styles. * @param value String The value to apply to the given property, or null if an object was passed. + * @returns Ext.dom.Element this */ setStyle?( property?:any, value?:string ): Ext.dom.IElement; /** [Method] Sets the element s top position directly using CSS style instead of setY * @param top String The top CSS property value. + * @returns Ext.dom.Element this */ setTop?( top?:string ): Ext.dom.IElement; /** [Method] Sets the element s top and left positions directly using CSS style */ setTopLeft?(): void; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS * @param mode Object + * @returns Ext.dom.Element this */ setVisibilityMode?( mode?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible. + * @returns Ext.Element this */ setVisible?( visible?:boolean ): Ext.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. + * @returns Ext.dom.Element this */ - setWidth?( width?:any ): any; - setWidth?( width?:number ): Ext.dom.IElement; - setWidth?( width?:string ): Ext.dom.IElement; + setWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the X position of the element based on page coordinates * @param x Number The X position of the element + * @returns Ext.dom.Element this */ setX?( x?:number ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates regardless of how the element is positioned * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based). + * @returns Ext.dom.Element this */ setXY?( pos?:number[] ): Ext.dom.IElement; /** [Method] Sets the Y position of the element based on page coordinates * @param y Number The Y position of the element. + * @returns Ext.dom.Element this */ setY?( y?:number ): Ext.dom.IElement; /** [Method] Shows this element */ show?(): void; /** [Method] Toggles the specified CSS class on this element removes it if it already exists otherwise adds it * @param className String The CSS class to toggle. + * @returns Ext.dom.Element this */ toggleCls?( className?:string ): Ext.dom.IElement; /** [Method] Translates the passed page coordinates into left top CSS values for this element * @param x Number/Array The page x or an array containing [x, y]. * @param y Number The page y, required if x is not an array. + * @returns Object An object with left and top properties. e.g. {left: (value), top: (value)}. */ - translatePoints?( x?:any, y?:any ): any; - translatePoints?( x?:number, y?:number ): any; - translatePoints?( x?:any[], y?:number ): any; + translatePoints?( x?:any, y?:number ): any; /** [Method] Removes a previously applied mask */ unmask?(): void; /** [Method] Walks up the dom looking for a parent node that matches the passed simple selector e g * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). + * @returns Ext.dom.Element/null The matching DOM node (or null if no match was found). */ - up?( simpleSelector?:any, maxDepth?:any ): any; - up?( simpleSelector?:string, maxDepth?:number ): any; - up?( simpleSelector?:string, maxDepth?:string ): any; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; + up?( simpleSelector?:string, maxDepth?:any ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -20074,6 +22240,7 @@ declare module Ext.dom { /** [Method] Creates and wraps this element with another element * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param domNode Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The newly created wrapper element. */ wrap?( config?:any, domNode?:boolean ): any; } @@ -20085,16 +22252,14 @@ declare module Ext { /** [Method] Adds elements to this Composite object * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an Array of DOM elements to add, or another Composite object who's elements should be added. * @param root HTMLElement/String The root element of the query or id of the root. + * @returns Ext.dom.CompositeElementLite This Composite object. */ - add?( els?:any, root?:any ): any; - add?( els?:HTMLElement[], root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:HTMLElement[], root?:string ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:string ): Ext.dom.ICompositeElementLite; + add?( els?:any, root?:any ): Ext.dom.ICompositeElementLite; /** [Method] Adds the given CSS class es to this Element * @param names String The CSS class(es) to add to this element. * @param prefix String Prefix to prepend to each class. * @param suffix String Suffix to append to each class. + * @returns Ext.dom.Element this */ addCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] fixes scope with flyweight @@ -20102,44 +22267,42 @@ declare module Ext { * @param handler Object * @param scope Object * @param opt Object + * @returns Ext.dom.CompositeElementLite this */ addListener?( eventName?:any, handler?:any, scope?:any, opt?:any ): Ext.dom.ICompositeElementLite; /** [Method] Appends the passed element s to this element * @param element HTMLElement/Ext.dom.Element a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendChild?( element?:any ): any; - appendChild?( element?:HTMLElement ): Ext.dom.IElement; - appendChild?( element?:Ext.dom.IElement ): Ext.dom.IElement; + appendChild?( element?:any ): Ext.dom.IElement; /** [Method] Appends this element to the passed element * @param el String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IElement; - appendTo?( el?:HTMLElement ): Ext.dom.IElement; - appendTo?( el?:Ext.dom.IElement ): Ext.dom.IElement; + appendTo?( el?:any ): Ext.dom.IElement; /** [Method] More flexible version of setStyle for setting style properties * @param styles String/Object/Function A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification. + * @returns Ext.dom.Element this */ applyStyles?( styles?:any ): Ext.dom.IElement; /** [Method] Selects a single direct child based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector. * @param returnDom Boolean true to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true) */ child?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all elements */ clear?(): void; /** [Method] Returns true if this composite contains the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection. + * @returns Boolean */ - contains?( el?:any ): any; - contains?( el?:string ): boolean; - contains?( el?:HTMLElement ): boolean; - contains?( el?:Ext.IElement ): boolean; - contains?( el?:number ): boolean; + contains?( el?:any ): boolean; /** [Method] Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e * @param config Object DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be automatically generated with the specified attributes. * @param insertBefore HTMLElement a child element of this element. * @param returnDom Boolean true to return the dom node instead of creating an Element. + * @returns Ext.dom.Element The new child element. */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Translates an element using CSS 3 in 2D */ @@ -20149,90 +22312,103 @@ declare module Ext { /** [Method] Selects a single child at any depth below this element based on the passed CSS selector the selector should not cont * @param selector String The CSS selector. * @param returnDom Boolean true to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true). */ down?( selector?:string, returnDom?:boolean ): any; /** [Method] Calls the passed function for each element in this composite * @param fn Function The function to call. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Element. + * @returns Ext.dom.CompositeElementLite this */ each?( fn?:any, scope?:any ): Ext.dom.ICompositeElementLite; /** [Method] Clears this Composite and adds the elements passed * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an array of DOM elements, or another Composite from which to fill this Composite. + * @returns Ext.dom.CompositeElementLite this */ - fill?( els?:any ): any; - fill?( els?:HTMLElement[] ): Ext.dom.ICompositeElementLite; - fill?( els?:Ext.dom.ICompositeElementLite ): Ext.dom.ICompositeElementLite; + fill?( els?:any ): Ext.dom.ICompositeElementLite; /** [Method] Filters this composite to only elements that match the passed selector * @param selector String/Function A string CSS selector or a comparison function. The comparison function will be called with the following arguments: + * @returns Ext.dom.CompositeElementLite this */ - filter?( selector?:any ): any; - filter?( selector?:string ): Ext.dom.ICompositeElementLite; + filter?( selector?:any ): Ext.dom.ICompositeElementLite; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParent?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParent?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParentNode?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParentNode?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. * @param offsets Array Offset the positioning by [x, y]. + * @returns Array [x, y] */ getAlignToXY?( element?:any, position?:string, offsets?:any[] ): any[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. * @param local Boolean true to get the local (element top/left-relative) anchor position instead of page coordinates. * @param size Object An object containing the size to use for calculating anchor position. {width: (target width), height: (target height)} (defaults to the element's current size) + * @returns Array [x, y] An array containing the element's x and y coordinates. */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): any[]; /** [Method] Returns the value of an attribute from the element s underlying DOM node * @param name String The attribute name. * @param namespace String The namespace in which to look for the attribute. + * @returns String The attribute value. */ getAttribute?( name?:string, namespace?:string ): string; /** [Method] Gets the width of the border s for the specified side s * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the border left width + the border right width. + * @returns Number The width of the sides passed added together */ getBorderWidth?( side?:string ): number; - /** [Method] Gets the bottom Y coordinate of the element element Y position element height */ + /** [Method] Gets the bottom Y coordinate of the element element Y position element height + * @returns Number + */ getBottom?(): number; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param contentBox Boolean If true a box for the content of the element is returned. * @param local Boolean If true the element's left and top are returned instead of page x/y. + * @returns Object An object in the format */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Returns the number of elements in this Composite */ + /** [Method] Returns the number of elements in this Composite + * @returns Number + */ getCount?(): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHTML?(): string; /** [Method] Returns the offset height of the element * @param contentHeight Boolean true to get the height minus borders and padding. + * @returns Number The element's height. */ getHeight?( contentHeight?:boolean ): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHtml?(): string; - /** [Method] Gets the left X coordinate */ + /** [Method] Gets the left X coordinate + * @returns Number + */ getLeft?(): number; /** [Method] Returns an object with properties top left right and bottom representing the margins of this element unless sides i * @param sides String Any combination of 'l', 'r', 't', 'b' to get the sum of those sides. + * @returns Object/Number */ getMargin?( sides?:string ): any; /** [Method] Returns the offsets of this element from the passed element * @param element Mixed The element to get the offsets from. + * @returns Array The XY page offsets (e.g. [100, -200]) */ getOffsetsTo?( element?:any ): any[]; /** [Method] Retrieves the height of the element account for the top and bottom margins */ @@ -20241,95 +22417,106 @@ declare module Ext { getOuterWidth?(): void; /** [Method] Gets the width of the padding s for the specified side s * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the padding left + the padding right. + * @returns Number The padding of the sides passed added together. */ getPadding?( side?:string ): number; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param asRegion Boolean If true an Ext.util.Region will be returned. + * @returns Object box An object in the format: { x: <Element's X position>, y: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for setXY. */ getPageBox?( asRegion?:boolean ): any; - /** [Method] Gets the right X coordinate of the element element X position element width */ + /** [Method] Gets the right X coordinate of the element element X position element width + * @returns Number + */ getRight?(): number; /** [Method] Gets the Scroller instance of the first parent that has one */ getScrollParent?(): void; /** [Method] Returns the size of the element * @param contentSize Boolean true to get the width/size minus borders and padding. + * @returns Object An object containing the element's size: */ getSize?( contentSize?:boolean ): any; /** [Method] Normalizes currentStyle and computedStyle * @param prop String The style property whose value is returned. + * @returns String The current value of the style property for this element. */ getStyle?( prop?:string ): string; - /** [Method] Gets the top Y coordinate */ + /** [Method] Gets the top Y coordinate + * @returns Number + */ getTop?(): number; /** [Method] Returns the value of the value attribute * @param asNumber Boolean true to parse the value as a number. + * @returns String/Number */ getValue?( asNumber?:boolean ): any; - /** [Method] Returns the dimensions of the element available to lay content out in */ + /** [Method] Returns the dimensions of the element available to lay content out in + * @returns Object Object describing width and height: + */ getViewSize?(): any; /** [Method] Returns the offset width of the element * @param contentWidth Boolean true to get the width minus borders and padding. + * @returns Number The element's width. */ getWidth?( contentWidth?:boolean ): number; /** [Method] Gets the current X position of the element based on page coordinates * @param el Object + * @returns Number The X position of the element */ getX?( el?:any ): number; - /** [Method] Gets the current position of the element based on page coordinates */ + /** [Method] Gets the current position of the element based on page coordinates + * @returns Array The XY position of the element + */ getXY?(): any[]; /** [Method] Gets the current Y position of the element based on page coordinates * @param el Object + * @returns Number The Y position of the element */ getY?( el?:any ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param name String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( name?:string ): boolean; /** [Method] Hides this element */ hide?(): void; /** [Method] Find the index of the passed element within the composite collection * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.dom.Element, or an HtmlElement to find within the composite collection. + * @returns Number The index of the passed Ext.dom.Element in the composite collection, or -1 if not found. */ - indexOf?( el?:any ): any; - indexOf?( el?:string ): number; - indexOf?( el?:HTMLElement ): number; - indexOf?( el?:Ext.IElement ): number; - indexOf?( el?:number ): number; + indexOf?( el?:any ): number; /** [Method] Inserts this element after the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IElement; - insertAfter?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertAfter?( el?:any ): Ext.dom.IElement; /** [Method] Inserts this element before the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IElement; - insertBefore?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertBefore?( el?:any ): Ext.dom.IElement; /** [Method] Inserts an element as the first child of this element * @param element String/HTMLElement/Ext.dom.Element The id or element to insert. + * @returns Ext.dom.Element this */ - insertFirst?( element?:any ): any; - insertFirst?( element?:string ): Ext.dom.IElement; - insertFirst?( element?:HTMLElement ): Ext.dom.IElement; - insertFirst?( element?:Ext.dom.IElement ): Ext.dom.IElement; + insertFirst?( element?:any ): Ext.dom.IElement; /** [Method] Inserts an HTML fragment into this element * @param where String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean true to return an Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted). */ insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element * @param el String/HTMLElement/Ext.dom.Element/Object/Array The id, element to insert or a DomHelper config to create and insert or an array of any of those. * @param where String 'before' or 'after'. * @param returnDom Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Returns true if this element matches the passed simple selector e g * @param selector String The simple selector to test. + * @returns Boolean true if this element matches the selector, else false. */ is?( selector?:string ): boolean; /** [Method] Determines if this element is a descendant of the passed in Element */ @@ -20337,14 +22524,17 @@ declare module Ext { /** [Method] Checks if the current value of a style is equal to a given value * @param style String property whose value is returned. * @param value String to check against. + * @returns Boolean true for when the current value equals the given value. */ isStyle?( style?:string, value?:string ): boolean; /** [Method] Returns true if the value of the given property is visually transparent * @param prop String The style property whose value is to be tested. + * @returns Boolean true if the style property is visually transparent. */ isTransparent?( prop?:string ): boolean; /** [Method] Returns a flyweight Element of the dom element object at the specified index * @param index Number + * @returns Ext.dom.Element */ item?( index?:number ): Ext.dom.IElement; /** [Method] Puts a mask over this element to disable user interaction */ @@ -20352,30 +22542,33 @@ declare module Ext { /** [Method] Gets the next sibling skipping text nodes * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw dom node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The next sibling or null. */ next?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The parent node or null. */ parent?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the previous sibling skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element + * @returns Ext.dom.Element/HTMLElement/null The previous sibling or null. */ prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector. + * @returns HTMLElement[] An array of the matched nodes. */ query?( selector?:string ): HTMLElement[]; /** [Method] Adds one or more CSS classes to this element and removes the same class es from all siblings * @param className String/String[] The CSS class to add, or an array of classes. + * @returns Ext.dom.Element this */ - radioCls?( className?:any ): any; - radioCls?( className?:string ): Ext.dom.IElement; - radioCls?( className?:string[] ): Ext.dom.IElement; + radioCls?( className?:any ): Ext.dom.IElement; /** [Method] Removes this element s DOM reference */ remove?(): void; /** [Method] Removes all listeners for this object */ @@ -20384,197 +22577,188 @@ declare module Ext { * @param names String The CSS class(es) to remove from this element. * @param prefix String Prefix to prepend to each class to be removed. * @param suffix String Suffix to append to each class to be removed. + * @returns Ext.dom.Element this */ removeCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Removes the specified element s * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite or an array of any of those. * @param removeDom Boolean true to also remove the element from the document + * @returns Ext.dom.CompositeElementLite this + */ + removeElement?( el?:any, removeDom?:boolean ): Ext.dom.ICompositeElementLite; + /** [Method] Forces the browser to repaint this element + * @returns Ext.dom.Element this */ - removeElement?( el?:any, removeDom?:any ): any; - removeElement?( el?:string, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:HTMLElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:Ext.IElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:number, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - /** [Method] Forces the browser to repaint this element */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element * @param element String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - replace?( element?:any ): any; - replace?( element?:string ): Ext.dom.IElement; - replace?( element?:HTMLElement ): Ext.dom.IElement; - replace?( element?:Ext.dom.IElement ): Ext.dom.IElement; + replace?( element?:any ): Ext.dom.IElement; /** [Method] Replaces a CSS class on the element with another * @param oldName String The CSS class to replace. * @param newName String The replacement CSS class. * @param prefix String Prefix to prepend to each class to be replaced. * @param suffix String Suffix to append to each class to be replaced. + * @returns Ext.dom.Element this */ replaceCls?( oldName?:string, newName?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Replaces the specified element with the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite to replace. * @param replacement String/Ext.Element The id of an element or the Element itself. * @param domReplace Boolean true to remove and replace the element in the document too. + * @returns Ext.dom.CompositeElementLite this */ - replaceElement?( el?:any, replacement?:any, domReplace?:any ): any; - replaceElement?( el?:string, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:string, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; + replaceElement?( el?:any, replacement?:any, domReplace?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Replaces this element with the passed element * @param el String/HTMLElement/Ext.dom.Element/Object The new element (id of the node, a DOM Node or an existing Element) or a DomHelper config of an element to create. + * @returns Ext.dom.Element This element. */ replaceWith?( el?:any ): Ext.dom.IElement; /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in * @param selector String/HTMLElement[] The CSS selector or an array of elements * @param composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - select?( selector?:any, composite?:any ): any; - select?( selector?:string, composite?:boolean ): Ext.dom.ICompositeElementLite; - select?( selector?:HTMLElement[], composite?:boolean ): Ext.dom.ICompositeElementLite; + select?( selector?:any, composite?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Serializes a DOM form into a url encoded string * @param form Object The form + * @returns String The url encoded form */ serializeForm?( form?:any ): string; /** [Method] Sets the passed attributes as attributes of this element a style attribute can be a string object or function * @param attributes Object The object with the attributes. * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( attributes?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom String The bottom CSS property value. + * @returns Ext.dom.Element this */ setBottom?( bottom?:string ): Ext.dom.IElement; /** [Method] Sets the element s box * @param box Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... } + * @returns Ext.dom.Element this */ setBox?( box?:any ): Ext.dom.IElement; /** [Method] Sets the specified CSS class on this element s DOM node * @param className String/Array The CSS class to set on this element. */ - setCls?( className?:any ): any; - setCls?( className?:string ): void; - setCls?( className?:any[] ): void; + setCls?( className?:any ): void; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHTML?( html?:string ): void; /** [Method] Set the height of this Element * @param height Number/String The new height. + * @returns Ext.dom.Element this */ - setHeight?( height?:any ): any; - setHeight?( height?:number ): Ext.dom.IElement; - setHeight?( height?:string ): Ext.dom.IElement; + setHeight?( height?:any ): Ext.dom.IElement; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHtml?( html?:string ): void; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left String The left CSS property value. + * @returns Ext.dom.Element this */ setLeft?( left?:string ): Ext.dom.IElement; /** [Method] Set the maximum height of this Element * @param height Number/String The new maximum height. + * @returns Ext.dom.Element this */ - setMaxHeight?( height?:any ): any; - setMaxHeight?( height?:number ): Ext.dom.IElement; - setMaxHeight?( height?:string ): Ext.dom.IElement; + setMaxHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the maximum width of this Element * @param width Number/String The new maximum width. + * @returns Ext.dom.Element this */ - setMaxWidth?( width?:any ): any; - setMaxWidth?( width?:number ): Ext.dom.IElement; - setMaxWidth?( width?:string ): Ext.dom.IElement; + setMaxWidth?( width?:any ): Ext.dom.IElement; /** [Method] Set the minimum height of this Element * @param height Number/String The new minimum height. + * @returns Ext.dom.Element this */ - setMinHeight?( height?:any ): any; - setMinHeight?( height?:number ): Ext.dom.IElement; - setMinHeight?( height?:string ): Ext.dom.IElement; + setMinHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the minimum width of this Element * @param width Number/String The new minimum width. + * @returns Ext.dom.Element this */ - setMinWidth?( width?:any ): any; - setMinWidth?( width?:number ): Ext.dom.IElement; - setMinWidth?( width?:string ): Ext.dom.IElement; + setMinWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right String The right CSS property value. + * @returns Ext.dom.Element this */ setRight?( right?:string ): Ext.dom.IElement; /** [Method] Set the size of this Element * @param width Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels). A String used to set the CSS width style. Animation may not be used. A size object in the format {width: widthValue, height: heightValue}. * @param height Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used. + * @returns Ext.dom.Element this */ - setSize?( width?:any, height?:any ): any; - setSize?( width?:number, height?:number ): Ext.dom.IElement; - setSize?( width?:string, height?:number ): Ext.dom.IElement; - setSize?( width?:number, height?:string ): Ext.dom.IElement; - setSize?( width?:string, height?:string ): Ext.dom.IElement; + setSize?( width?:any, height?:any ): Ext.dom.IElement; /** [Method] Wrapper for setting style properties also takes single object parameter of multiple styles * @param property String/Object The style property to be set, or an object of multiple styles. * @param value String The value to apply to the given property, or null if an object was passed. + * @returns Ext.dom.Element this */ setStyle?( property?:any, value?:string ): Ext.dom.IElement; /** [Method] Sets the element s top position directly using CSS style instead of setY * @param top String The top CSS property value. + * @returns Ext.dom.Element this */ setTop?( top?:string ): Ext.dom.IElement; /** [Method] Sets the element s top and left positions directly using CSS style */ setTopLeft?(): void; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS * @param mode Object + * @returns Ext.dom.Element this */ setVisibilityMode?( mode?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible. + * @returns Ext.Element this */ setVisible?( visible?:boolean ): Ext.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. + * @returns Ext.dom.Element this */ - setWidth?( width?:any ): any; - setWidth?( width?:number ): Ext.dom.IElement; - setWidth?( width?:string ): Ext.dom.IElement; + setWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the X position of the element based on page coordinates * @param x Number The X position of the element + * @returns Ext.dom.Element this */ setX?( x?:number ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates regardless of how the element is positioned * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based). + * @returns Ext.dom.Element this */ setXY?( pos?:number[] ): Ext.dom.IElement; /** [Method] Sets the Y position of the element based on page coordinates * @param y Number The Y position of the element. + * @returns Ext.dom.Element this */ setY?( y?:number ): Ext.dom.IElement; /** [Method] Shows this element */ show?(): void; /** [Method] Toggles the specified CSS class on this element removes it if it already exists otherwise adds it * @param className String The CSS class to toggle. + * @returns Ext.dom.Element this */ toggleCls?( className?:string ): Ext.dom.IElement; /** [Method] Translates the passed page coordinates into left top CSS values for this element * @param x Number/Array The page x or an array containing [x, y]. * @param y Number The page y, required if x is not an array. + * @returns Object An object with left and top properties. e.g. {left: (value), top: (value)}. */ - translatePoints?( x?:any, y?:any ): any; - translatePoints?( x?:number, y?:number ): any; - translatePoints?( x?:any[], y?:number ): any; + translatePoints?( x?:any, y?:number ): any; /** [Method] Removes a previously applied mask */ unmask?(): void; /** [Method] Walks up the dom looking for a parent node that matches the passed simple selector e g * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). + * @returns Ext.dom.Element/null The matching DOM node (or null if no match was found). */ - up?( simpleSelector?:any, maxDepth?:any ): any; - up?( simpleSelector?:string, maxDepth?:number ): any; - up?( simpleSelector?:string, maxDepth?:string ): any; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; + up?( simpleSelector?:string, maxDepth?:any ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -20582,6 +22766,7 @@ declare module Ext { /** [Method] Creates and wraps this element with another element * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param domNode Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The newly created wrapper element. */ wrap?( config?:any, domNode?:boolean ): any; } @@ -20593,16 +22778,14 @@ declare module Ext { /** [Method] Adds elements to this Composite object * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an Array of DOM elements to add, or another Composite object who's elements should be added. * @param root HTMLElement/String The root element of the query or id of the root. + * @returns Ext.dom.CompositeElementLite This Composite object. */ - add?( els?:any, root?:any ): any; - add?( els?:HTMLElement[], root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:HTMLElement[], root?:string ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:string ): Ext.dom.ICompositeElementLite; + add?( els?:any, root?:any ): Ext.dom.ICompositeElementLite; /** [Method] Adds the given CSS class es to this Element * @param names String The CSS class(es) to add to this element. * @param prefix String Prefix to prepend to each class. * @param suffix String Suffix to append to each class. + * @returns Ext.dom.Element this */ addCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] fixes scope with flyweight @@ -20610,44 +22793,42 @@ declare module Ext { * @param handler Object * @param scope Object * @param opt Object + * @returns Ext.dom.CompositeElementLite this */ addListener?( eventName?:any, handler?:any, scope?:any, opt?:any ): Ext.dom.ICompositeElementLite; /** [Method] Appends the passed element s to this element * @param element HTMLElement/Ext.dom.Element a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendChild?( element?:any ): any; - appendChild?( element?:HTMLElement ): Ext.dom.IElement; - appendChild?( element?:Ext.dom.IElement ): Ext.dom.IElement; + appendChild?( element?:any ): Ext.dom.IElement; /** [Method] Appends this element to the passed element * @param el String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IElement; - appendTo?( el?:HTMLElement ): Ext.dom.IElement; - appendTo?( el?:Ext.dom.IElement ): Ext.dom.IElement; + appendTo?( el?:any ): Ext.dom.IElement; /** [Method] More flexible version of setStyle for setting style properties * @param styles String/Object/Function A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification. + * @returns Ext.dom.Element this */ applyStyles?( styles?:any ): Ext.dom.IElement; /** [Method] Selects a single direct child based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector. * @param returnDom Boolean true to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true) */ child?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all elements */ clear?(): void; /** [Method] Returns true if this composite contains the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection. + * @returns Boolean */ - contains?( el?:any ): any; - contains?( el?:string ): boolean; - contains?( el?:HTMLElement ): boolean; - contains?( el?:Ext.IElement ): boolean; - contains?( el?:number ): boolean; + contains?( el?:any ): boolean; /** [Method] Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e * @param config Object DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be automatically generated with the specified attributes. * @param insertBefore HTMLElement a child element of this element. * @param returnDom Boolean true to return the dom node instead of creating an Element. + * @returns Ext.dom.Element The new child element. */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Translates an element using CSS 3 in 2D */ @@ -20657,90 +22838,103 @@ declare module Ext { /** [Method] Selects a single child at any depth below this element based on the passed CSS selector the selector should not cont * @param selector String The CSS selector. * @param returnDom Boolean true to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true). */ down?( selector?:string, returnDom?:boolean ): any; /** [Method] Calls the passed function for each element in this composite * @param fn Function The function to call. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Element. + * @returns Ext.dom.CompositeElementLite this */ each?( fn?:any, scope?:any ): Ext.dom.ICompositeElementLite; /** [Method] Clears this Composite and adds the elements passed * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an array of DOM elements, or another Composite from which to fill this Composite. + * @returns Ext.dom.CompositeElementLite this */ - fill?( els?:any ): any; - fill?( els?:HTMLElement[] ): Ext.dom.ICompositeElementLite; - fill?( els?:Ext.dom.ICompositeElementLite ): Ext.dom.ICompositeElementLite; + fill?( els?:any ): Ext.dom.ICompositeElementLite; /** [Method] Filters this composite to only elements that match the passed selector * @param selector String/Function A string CSS selector or a comparison function. The comparison function will be called with the following arguments: + * @returns Ext.dom.CompositeElementLite this */ - filter?( selector?:any ): any; - filter?( selector?:string ): Ext.dom.ICompositeElementLite; + filter?( selector?:any ): Ext.dom.ICompositeElementLite; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParent?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParent?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParentNode?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParentNode?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. * @param offsets Array Offset the positioning by [x, y]. + * @returns Array [x, y] */ getAlignToXY?( element?:any, position?:string, offsets?:any[] ): any[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. * @param local Boolean true to get the local (element top/left-relative) anchor position instead of page coordinates. * @param size Object An object containing the size to use for calculating anchor position. {width: (target width), height: (target height)} (defaults to the element's current size) + * @returns Array [x, y] An array containing the element's x and y coordinates. */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): any[]; /** [Method] Returns the value of an attribute from the element s underlying DOM node * @param name String The attribute name. * @param namespace String The namespace in which to look for the attribute. + * @returns String The attribute value. */ getAttribute?( name?:string, namespace?:string ): string; /** [Method] Gets the width of the border s for the specified side s * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the border left width + the border right width. + * @returns Number The width of the sides passed added together */ getBorderWidth?( side?:string ): number; - /** [Method] Gets the bottom Y coordinate of the element element Y position element height */ + /** [Method] Gets the bottom Y coordinate of the element element Y position element height + * @returns Number + */ getBottom?(): number; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param contentBox Boolean If true a box for the content of the element is returned. * @param local Boolean If true the element's left and top are returned instead of page x/y. + * @returns Object An object in the format */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Returns the number of elements in this Composite */ + /** [Method] Returns the number of elements in this Composite + * @returns Number + */ getCount?(): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHTML?(): string; /** [Method] Returns the offset height of the element * @param contentHeight Boolean true to get the height minus borders and padding. + * @returns Number The element's height. */ getHeight?( contentHeight?:boolean ): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHtml?(): string; - /** [Method] Gets the left X coordinate */ + /** [Method] Gets the left X coordinate + * @returns Number + */ getLeft?(): number; /** [Method] Returns an object with properties top left right and bottom representing the margins of this element unless sides i * @param sides String Any combination of 'l', 'r', 't', 'b' to get the sum of those sides. + * @returns Object/Number */ getMargin?( sides?:string ): any; /** [Method] Returns the offsets of this element from the passed element * @param element Mixed The element to get the offsets from. + * @returns Array The XY page offsets (e.g. [100, -200]) */ getOffsetsTo?( element?:any ): any[]; /** [Method] Retrieves the height of the element account for the top and bottom margins */ @@ -20749,95 +22943,106 @@ declare module Ext { getOuterWidth?(): void; /** [Method] Gets the width of the padding s for the specified side s * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the padding left + the padding right. + * @returns Number The padding of the sides passed added together. */ getPadding?( side?:string ): number; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param asRegion Boolean If true an Ext.util.Region will be returned. + * @returns Object box An object in the format: { x: <Element's X position>, y: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for setXY. */ getPageBox?( asRegion?:boolean ): any; - /** [Method] Gets the right X coordinate of the element element X position element width */ + /** [Method] Gets the right X coordinate of the element element X position element width + * @returns Number + */ getRight?(): number; /** [Method] Gets the Scroller instance of the first parent that has one */ getScrollParent?(): void; /** [Method] Returns the size of the element * @param contentSize Boolean true to get the width/size minus borders and padding. + * @returns Object An object containing the element's size: */ getSize?( contentSize?:boolean ): any; /** [Method] Normalizes currentStyle and computedStyle * @param prop String The style property whose value is returned. + * @returns String The current value of the style property for this element. */ getStyle?( prop?:string ): string; - /** [Method] Gets the top Y coordinate */ + /** [Method] Gets the top Y coordinate + * @returns Number + */ getTop?(): number; /** [Method] Returns the value of the value attribute * @param asNumber Boolean true to parse the value as a number. + * @returns String/Number */ getValue?( asNumber?:boolean ): any; - /** [Method] Returns the dimensions of the element available to lay content out in */ + /** [Method] Returns the dimensions of the element available to lay content out in + * @returns Object Object describing width and height: + */ getViewSize?(): any; /** [Method] Returns the offset width of the element * @param contentWidth Boolean true to get the width minus borders and padding. + * @returns Number The element's width. */ getWidth?( contentWidth?:boolean ): number; /** [Method] Gets the current X position of the element based on page coordinates * @param el Object + * @returns Number The X position of the element */ getX?( el?:any ): number; - /** [Method] Gets the current position of the element based on page coordinates */ + /** [Method] Gets the current position of the element based on page coordinates + * @returns Array The XY position of the element + */ getXY?(): any[]; /** [Method] Gets the current Y position of the element based on page coordinates * @param el Object + * @returns Number The Y position of the element */ getY?( el?:any ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param name String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( name?:string ): boolean; /** [Method] Hides this element */ hide?(): void; /** [Method] Find the index of the passed element within the composite collection * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.dom.Element, or an HtmlElement to find within the composite collection. + * @returns Number The index of the passed Ext.dom.Element in the composite collection, or -1 if not found. */ - indexOf?( el?:any ): any; - indexOf?( el?:string ): number; - indexOf?( el?:HTMLElement ): number; - indexOf?( el?:Ext.IElement ): number; - indexOf?( el?:number ): number; + indexOf?( el?:any ): number; /** [Method] Inserts this element after the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IElement; - insertAfter?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertAfter?( el?:any ): Ext.dom.IElement; /** [Method] Inserts this element before the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IElement; - insertBefore?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertBefore?( el?:any ): Ext.dom.IElement; /** [Method] Inserts an element as the first child of this element * @param element String/HTMLElement/Ext.dom.Element The id or element to insert. + * @returns Ext.dom.Element this */ - insertFirst?( element?:any ): any; - insertFirst?( element?:string ): Ext.dom.IElement; - insertFirst?( element?:HTMLElement ): Ext.dom.IElement; - insertFirst?( element?:Ext.dom.IElement ): Ext.dom.IElement; + insertFirst?( element?:any ): Ext.dom.IElement; /** [Method] Inserts an HTML fragment into this element * @param where String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean true to return an Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted). */ insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element * @param el String/HTMLElement/Ext.dom.Element/Object/Array The id, element to insert or a DomHelper config to create and insert or an array of any of those. * @param where String 'before' or 'after'. * @param returnDom Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Returns true if this element matches the passed simple selector e g * @param selector String The simple selector to test. + * @returns Boolean true if this element matches the selector, else false. */ is?( selector?:string ): boolean; /** [Method] Determines if this element is a descendant of the passed in Element */ @@ -20845,14 +23050,17 @@ declare module Ext { /** [Method] Checks if the current value of a style is equal to a given value * @param style String property whose value is returned. * @param value String to check against. + * @returns Boolean true for when the current value equals the given value. */ isStyle?( style?:string, value?:string ): boolean; /** [Method] Returns true if the value of the given property is visually transparent * @param prop String The style property whose value is to be tested. + * @returns Boolean true if the style property is visually transparent. */ isTransparent?( prop?:string ): boolean; /** [Method] Returns a flyweight Element of the dom element object at the specified index * @param index Number + * @returns Ext.dom.Element */ item?( index?:number ): Ext.dom.IElement; /** [Method] Puts a mask over this element to disable user interaction */ @@ -20860,30 +23068,33 @@ declare module Ext { /** [Method] Gets the next sibling skipping text nodes * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw dom node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The next sibling or null. */ next?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The parent node or null. */ parent?( selector?:string, returnDom?:boolean ): any; - /** [Method] Gets the previous sibling skipping text nodes + /** [Method] Gets the previous sibling skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element + * @returns Ext.dom.Element/HTMLElement/null The previous sibling or null. */ prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector. + * @returns HTMLElement[] An array of the matched nodes. */ query?( selector?:string ): HTMLElement[]; /** [Method] Adds one or more CSS classes to this element and removes the same class es from all siblings * @param className String/String[] The CSS class to add, or an array of classes. + * @returns Ext.dom.Element this */ - radioCls?( className?:any ): any; - radioCls?( className?:string ): Ext.dom.IElement; - radioCls?( className?:string[] ): Ext.dom.IElement; + radioCls?( className?:any ): Ext.dom.IElement; /** [Method] Removes this element s DOM reference */ remove?(): void; /** [Method] Removes all listeners for this object */ @@ -20892,197 +23103,188 @@ declare module Ext { * @param names String The CSS class(es) to remove from this element. * @param prefix String Prefix to prepend to each class to be removed. * @param suffix String Suffix to append to each class to be removed. + * @returns Ext.dom.Element this */ removeCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Removes the specified element s * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite or an array of any of those. * @param removeDom Boolean true to also remove the element from the document + * @returns Ext.dom.CompositeElementLite this + */ + removeElement?( el?:any, removeDom?:boolean ): Ext.dom.ICompositeElementLite; + /** [Method] Forces the browser to repaint this element + * @returns Ext.dom.Element this */ - removeElement?( el?:any, removeDom?:any ): any; - removeElement?( el?:string, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:HTMLElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:Ext.IElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:number, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - /** [Method] Forces the browser to repaint this element */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element * @param element String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - replace?( element?:any ): any; - replace?( element?:string ): Ext.dom.IElement; - replace?( element?:HTMLElement ): Ext.dom.IElement; - replace?( element?:Ext.dom.IElement ): Ext.dom.IElement; + replace?( element?:any ): Ext.dom.IElement; /** [Method] Replaces a CSS class on the element with another * @param oldName String The CSS class to replace. * @param newName String The replacement CSS class. * @param prefix String Prefix to prepend to each class to be replaced. * @param suffix String Suffix to append to each class to be replaced. + * @returns Ext.dom.Element this */ replaceCls?( oldName?:string, newName?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Replaces the specified element with the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite to replace. * @param replacement String/Ext.Element The id of an element or the Element itself. * @param domReplace Boolean true to remove and replace the element in the document too. + * @returns Ext.dom.CompositeElementLite this */ - replaceElement?( el?:any, replacement?:any, domReplace?:any ): any; - replaceElement?( el?:string, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:string, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; + replaceElement?( el?:any, replacement?:any, domReplace?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Replaces this element with the passed element * @param el String/HTMLElement/Ext.dom.Element/Object The new element (id of the node, a DOM Node or an existing Element) or a DomHelper config of an element to create. + * @returns Ext.dom.Element This element. */ replaceWith?( el?:any ): Ext.dom.IElement; /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in * @param selector String/HTMLElement[] The CSS selector or an array of elements * @param composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - select?( selector?:any, composite?:any ): any; - select?( selector?:string, composite?:boolean ): Ext.dom.ICompositeElementLite; - select?( selector?:HTMLElement[], composite?:boolean ): Ext.dom.ICompositeElementLite; + select?( selector?:any, composite?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Serializes a DOM form into a url encoded string * @param form Object The form + * @returns String The url encoded form */ serializeForm?( form?:any ): string; /** [Method] Sets the passed attributes as attributes of this element a style attribute can be a string object or function * @param attributes Object The object with the attributes. * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( attributes?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom String The bottom CSS property value. + * @returns Ext.dom.Element this */ setBottom?( bottom?:string ): Ext.dom.IElement; /** [Method] Sets the element s box * @param box Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... } + * @returns Ext.dom.Element this */ setBox?( box?:any ): Ext.dom.IElement; /** [Method] Sets the specified CSS class on this element s DOM node * @param className String/Array The CSS class to set on this element. */ - setCls?( className?:any ): any; - setCls?( className?:string ): void; - setCls?( className?:any[] ): void; + setCls?( className?:any ): void; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHTML?( html?:string ): void; /** [Method] Set the height of this Element * @param height Number/String The new height. + * @returns Ext.dom.Element this */ - setHeight?( height?:any ): any; - setHeight?( height?:number ): Ext.dom.IElement; - setHeight?( height?:string ): Ext.dom.IElement; + setHeight?( height?:any ): Ext.dom.IElement; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHtml?( html?:string ): void; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left String The left CSS property value. + * @returns Ext.dom.Element this */ setLeft?( left?:string ): Ext.dom.IElement; /** [Method] Set the maximum height of this Element * @param height Number/String The new maximum height. + * @returns Ext.dom.Element this */ - setMaxHeight?( height?:any ): any; - setMaxHeight?( height?:number ): Ext.dom.IElement; - setMaxHeight?( height?:string ): Ext.dom.IElement; + setMaxHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the maximum width of this Element * @param width Number/String The new maximum width. + * @returns Ext.dom.Element this */ - setMaxWidth?( width?:any ): any; - setMaxWidth?( width?:number ): Ext.dom.IElement; - setMaxWidth?( width?:string ): Ext.dom.IElement; + setMaxWidth?( width?:any ): Ext.dom.IElement; /** [Method] Set the minimum height of this Element * @param height Number/String The new minimum height. + * @returns Ext.dom.Element this */ - setMinHeight?( height?:any ): any; - setMinHeight?( height?:number ): Ext.dom.IElement; - setMinHeight?( height?:string ): Ext.dom.IElement; + setMinHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the minimum width of this Element * @param width Number/String The new minimum width. + * @returns Ext.dom.Element this */ - setMinWidth?( width?:any ): any; - setMinWidth?( width?:number ): Ext.dom.IElement; - setMinWidth?( width?:string ): Ext.dom.IElement; + setMinWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right String The right CSS property value. + * @returns Ext.dom.Element this */ setRight?( right?:string ): Ext.dom.IElement; /** [Method] Set the size of this Element * @param width Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels). A String used to set the CSS width style. Animation may not be used. A size object in the format {width: widthValue, height: heightValue}. * @param height Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used. + * @returns Ext.dom.Element this */ - setSize?( width?:any, height?:any ): any; - setSize?( width?:number, height?:number ): Ext.dom.IElement; - setSize?( width?:string, height?:number ): Ext.dom.IElement; - setSize?( width?:number, height?:string ): Ext.dom.IElement; - setSize?( width?:string, height?:string ): Ext.dom.IElement; + setSize?( width?:any, height?:any ): Ext.dom.IElement; /** [Method] Wrapper for setting style properties also takes single object parameter of multiple styles * @param property String/Object The style property to be set, or an object of multiple styles. * @param value String The value to apply to the given property, or null if an object was passed. + * @returns Ext.dom.Element this */ setStyle?( property?:any, value?:string ): Ext.dom.IElement; /** [Method] Sets the element s top position directly using CSS style instead of setY * @param top String The top CSS property value. + * @returns Ext.dom.Element this */ setTop?( top?:string ): Ext.dom.IElement; /** [Method] Sets the element s top and left positions directly using CSS style */ setTopLeft?(): void; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS * @param mode Object + * @returns Ext.dom.Element this */ setVisibilityMode?( mode?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible. + * @returns Ext.Element this */ setVisible?( visible?:boolean ): Ext.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. + * @returns Ext.dom.Element this */ - setWidth?( width?:any ): any; - setWidth?( width?:number ): Ext.dom.IElement; - setWidth?( width?:string ): Ext.dom.IElement; + setWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the X position of the element based on page coordinates * @param x Number The X position of the element + * @returns Ext.dom.Element this */ setX?( x?:number ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates regardless of how the element is positioned * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based). + * @returns Ext.dom.Element this */ setXY?( pos?:number[] ): Ext.dom.IElement; /** [Method] Sets the Y position of the element based on page coordinates * @param y Number The Y position of the element. + * @returns Ext.dom.Element this */ setY?( y?:number ): Ext.dom.IElement; /** [Method] Shows this element */ show?(): void; /** [Method] Toggles the specified CSS class on this element removes it if it already exists otherwise adds it * @param className String The CSS class to toggle. + * @returns Ext.dom.Element this */ toggleCls?( className?:string ): Ext.dom.IElement; /** [Method] Translates the passed page coordinates into left top CSS values for this element * @param x Number/Array The page x or an array containing [x, y]. * @param y Number The page y, required if x is not an array. + * @returns Object An object with left and top properties. e.g. {left: (value), top: (value)}. */ - translatePoints?( x?:any, y?:any ): any; - translatePoints?( x?:number, y?:number ): any; - translatePoints?( x?:any[], y?:number ): any; + translatePoints?( x?:any, y?:number ): any; /** [Method] Removes a previously applied mask */ unmask?(): void; /** [Method] Walks up the dom looking for a parent node that matches the passed simple selector e g * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). + * @returns Ext.dom.Element/null The matching DOM node (or null if no match was found). */ - up?( simpleSelector?:any, maxDepth?:any ): any; - up?( simpleSelector?:string, maxDepth?:number ): any; - up?( simpleSelector?:string, maxDepth?:string ): any; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; + up?( simpleSelector?:string, maxDepth?:any ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -21090,6 +23292,7 @@ declare module Ext { /** [Method] Creates and wraps this element with another element * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param domNode Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The newly created wrapper element. */ wrap?( config?:any, domNode?:boolean ): any; } @@ -21114,20 +23317,19 @@ declare module Ext.dom { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the given CSS class es to this Element * @param names String The CSS class(es) to add to this element. * @param prefix String Prefix to prepend to each class. * @param suffix String Suffix to append to each class. + * @returns Ext.dom.Element this */ addCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Adds the specified events to the list of events which this Observable may fire @@ -21141,9 +23343,7 @@ declare module Ext.dom { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -21151,43 +23351,40 @@ declare module Ext.dom { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends the passed element s to this element * @param element HTMLElement/Ext.dom.Element a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendChild?( element?:any ): any; - appendChild?( element?:HTMLElement ): Ext.dom.IElement; - appendChild?( element?:Ext.dom.IElement ): Ext.dom.IElement; + appendChild?( element?:any ): Ext.dom.IElement; /** [Method] Appends this element to the passed element * @param el String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IElement; - appendTo?( el?:HTMLElement ): Ext.dom.IElement; - appendTo?( el?:Ext.dom.IElement ): Ext.dom.IElement; + appendTo?( el?:any ): Ext.dom.IElement; /** [Method] More flexible version of setStyle for setting style properties * @param styles String/Object/Function A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification. + * @returns Ext.dom.Element this */ applyStyles?( styles?:any ): Ext.dom.IElement; /** [Method] Selects a single direct child based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector. * @param returnDom Boolean true to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true) */ child?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] Returns true if this element is an ancestor of the passed element * @param element HTMLElement/String The element to check. + * @returns Boolean true if this element is an ancestor of el, else false. */ - contains?( element?:any ): any; - contains?( element?:HTMLElement ): boolean; - contains?( element?:string ): boolean; + contains?( element?:any ): boolean; /** [Method] Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e * @param config Object DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be automatically generated with the specified attributes. * @param insertBefore HTMLElement a child element of this element. * @param returnDom Boolean true to return the dom node instead of creating an Element. + * @returns Ext.dom.Element The new child element. */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Translates an element using CSS 3 in 2D */ @@ -21197,99 +23394,115 @@ declare module Ext.dom { /** [Method] Selects a single child at any depth below this element based on the passed CSS selector the selector should not cont * @param selector String The CSS selector. * @param returnDom Boolean true to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true). */ down?( selector?:string, returnDom?:boolean ): any; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParent?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParent?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParentNode?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParentNode?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Gets the first child skipping text nodes * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The first child or null. */ first?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. * @param offsets Array Offset the positioning by [x, y]. + * @returns Array [x, y] */ getAlignToXY?( element?:any, position?:string, offsets?:any[] ): any[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. * @param local Boolean true to get the local (element top/left-relative) anchor position instead of page coordinates. * @param size Object An object containing the size to use for calculating anchor position. {width: (target width), height: (target height)} (defaults to the element's current size) + * @returns Array [x, y] An array containing the element's x and y coordinates. */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): any[]; /** [Method] Returns the value of an attribute from the element s underlying DOM node * @param name String The attribute name. * @param namespace String The namespace in which to look for the attribute. + * @returns String The attribute value. */ getAttribute?( name?:string, namespace?:string ): string; /** [Method] Gets the width of the border s for the specified side s * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the border left width + the border right width. + * @returns Number The width of the sides passed added together */ getBorderWidth?( side?:string ): number; - /** [Method] Gets the bottom Y coordinate of the element element Y position element height */ + /** [Method] Gets the bottom Y coordinate of the element element Y position element height + * @returns Number + */ getBottom?(): number; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param contentBox Boolean If true a box for the content of the element is returned. * @param local Boolean If true the element's left and top are returned instead of page x/y. + * @returns Object An object in the format */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHTML?(): string; /** [Method] Returns the offset height of the element * @param contentHeight Boolean true to get the height minus borders and padding. + * @returns Number The element's height. */ getHeight?( contentHeight?:boolean ): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHtml?(): string; - /** [Method] Gets the left X coordinate */ + /** [Method] Gets the left X coordinate + * @returns Number + */ getLeft?(): number; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Returns an object with properties top left right and bottom representing the margins of this element unless sides i * @param sides String Any combination of 'l', 'r', 't', 'b' to get the sum of those sides. + * @returns Object/Number */ getMargin?( sides?:string ): any; /** [Method] Returns the offsets of this element from the passed element * @param element Mixed The element to get the offsets from. + * @returns Array The XY page offsets (e.g. [100, -200]) */ getOffsetsTo?( element?:any ): any[]; /** [Method] Retrieves the height of the element account for the top and bottom margins */ @@ -21298,91 +23511,106 @@ declare module Ext.dom { getOuterWidth?(): void; /** [Method] Gets the width of the padding s for the specified side s * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the padding left + the padding right. + * @returns Number The padding of the sides passed added together. */ getPadding?( side?:string ): number; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param asRegion Boolean If true an Ext.util.Region will be returned. + * @returns Object box An object in the format: { x: <Element's X position>, y: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for setXY. */ getPageBox?( asRegion?:boolean ): any; - /** [Method] Gets the right X coordinate of the element element X position element width */ + /** [Method] Gets the right X coordinate of the element element X position element width + * @returns Number + */ getRight?(): number; /** [Method] Gets the Scroller instance of the first parent that has one */ getScrollParent?(): void; /** [Method] Returns the size of the element * @param contentSize Boolean true to get the width/size minus borders and padding. + * @returns Object An object containing the element's size: */ getSize?( contentSize?:boolean ): any; /** [Method] Normalizes currentStyle and computedStyle * @param prop String The style property whose value is returned. + * @returns String The current value of the style property for this element. */ getStyle?( prop?:string ): string; - /** [Method] Gets the top Y coordinate */ + /** [Method] Gets the top Y coordinate + * @returns Number + */ getTop?(): number; /** [Method] Returns the value of the value attribute * @param asNumber Boolean true to parse the value as a number. + * @returns String/Number */ getValue?( asNumber?:boolean ): any; - /** [Method] Returns the dimensions of the element available to lay content out in */ + /** [Method] Returns the dimensions of the element available to lay content out in + * @returns Object Object describing width and height: + */ getViewSize?(): any; /** [Method] Returns the offset width of the element * @param contentWidth Boolean true to get the width minus borders and padding. + * @returns Number The element's width. */ getWidth?( contentWidth?:boolean ): number; /** [Method] Gets the current X position of the element based on page coordinates * @param el Object + * @returns Number The X position of the element */ getX?( el?:any ): number; - /** [Method] Gets the current position of the element based on page coordinates */ + /** [Method] Gets the current position of the element based on page coordinates + * @returns Array The XY position of the element + */ getXY?(): any[]; /** [Method] Gets the current Y position of the element based on page coordinates * @param el Object + * @returns Number The Y position of the element */ getY?( el?:any ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param name String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( name?:string ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Hides this element */ hide?(): void; /** [Method] Inserts this element after the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IElement; - insertAfter?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertAfter?( el?:any ): Ext.dom.IElement; /** [Method] Inserts this element before the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IElement; - insertBefore?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertBefore?( el?:any ): Ext.dom.IElement; /** [Method] Inserts an element as the first child of this element * @param element String/HTMLElement/Ext.dom.Element The id or element to insert. + * @returns Ext.dom.Element this */ - insertFirst?( element?:any ): any; - insertFirst?( element?:string ): Ext.dom.IElement; - insertFirst?( element?:HTMLElement ): Ext.dom.IElement; - insertFirst?( element?:Ext.dom.IElement ): Ext.dom.IElement; + insertFirst?( element?:any ): Ext.dom.IElement; /** [Method] Inserts an HTML fragment into this element * @param where String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean true to return an Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted). */ insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element * @param el String/HTMLElement/Ext.dom.Element/Object/Array The id, element to insert or a DomHelper config to create and insert or an array of any of those. * @param where String 'before' or 'after'. * @param returnDom Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Returns true if this element matches the passed simple selector e g * @param selector String The simple selector to test. + * @returns Boolean true if this element matches the selector, else false. */ is?( selector?:string ): boolean; /** [Method] Determines if this element is a descendant of the passed in Element */ @@ -21390,15 +23618,18 @@ declare module Ext.dom { /** [Method] Checks if the current value of a style is equal to a given value * @param style String property whose value is returned. * @param value String to check against. + * @returns Boolean true for when the current value equals the given value. */ isStyle?( style?:string, value?:string ): boolean; /** [Method] Returns true if the value of the given property is visually transparent * @param prop String The style property whose value is to be tested. + * @returns Boolean true if the style property is visually transparent. */ isTransparent?( prop?:string ): boolean; /** [Method] Gets the last child skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The last child or null. */ last?( selector?:string, returnDom?:boolean ): any; /** [Method] Puts a mask over this element to disable user interaction */ @@ -21410,21 +23641,18 @@ declare module Ext.dom { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Gets the next sibling skipping text nodes * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw dom node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The next sibling or null. */ next?( selector?:string, returnDom?:boolean ): any; /** [Method] Alias for addListener @@ -21434,50 +23662,49 @@ declare module Ext.dom { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The parent node or null. */ parent?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the previous sibling skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element + * @returns Ext.dom.Element/HTMLElement/null The previous sibling or null. */ prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector. + * @returns HTMLElement[] An array of the matched nodes. */ query?( selector?:string ): HTMLElement[]; /** [Method] Adds one or more CSS classes to this element and removes the same class es from all siblings * @param className String/String[] The CSS class to add, or an array of classes. + * @returns Ext.dom.Element this */ - radioCls?( className?:any ): any; - radioCls?( className?:string ): Ext.dom.IElement; - radioCls?( className?:string[] ): Ext.dom.IElement; + radioCls?( className?:any ): Ext.dom.IElement; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes this element s DOM reference */ @@ -21488,8 +23715,7 @@ declare module Ext.dom { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ removeAllListeners?(): void; /** [Method] Removes a before event handler @@ -21498,12 +23724,12 @@ declare module Ext.dom { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes the given CSS class es from this Element * @param names String The CSS class(es) to remove from this element. * @param prefix String Prefix to prepend to each class to be removed. * @param suffix String Suffix to append to each class to be removed. + * @returns Ext.dom.Element this */ removeCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Removes an event handler @@ -21513,36 +23739,34 @@ declare module Ext.dom { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; - /** [Method] Forces the browser to repaint this element */ + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; + /** [Method] Forces the browser to repaint this element + * @returns Ext.dom.Element this + */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element * @param element String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - replace?( element?:any ): any; - replace?( element?:string ): Ext.dom.IElement; - replace?( element?:HTMLElement ): Ext.dom.IElement; - replace?( element?:Ext.dom.IElement ): Ext.dom.IElement; + replace?( element?:any ): Ext.dom.IElement; /** [Method] Replaces a CSS class on the element with another * @param oldName String The CSS class to replace. * @param newName String The replacement CSS class. * @param prefix String Prefix to prepend to each class to be replaced. * @param suffix String Suffix to append to each class to be replaced. + * @returns Ext.dom.Element this */ replaceCls?( oldName?:string, newName?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Replaces this element with the passed element * @param el String/HTMLElement/Ext.dom.Element/Object The new element (id of the node, a DOM Node or an existing Element) or a DomHelper config of an element to create. + * @returns Ext.dom.Element This element. */ replaceWith?( el?:any ): Ext.dom.IElement; /** [Method] Resumes firing events see suspendEvents @@ -21551,49 +23775,49 @@ declare module Ext.dom { resumeEvents?( discardQueuedEvents?:boolean ): void; /** [Method] Serializes a DOM form into a url encoded string * @param form Object The form + * @returns String The url encoded form */ serializeForm?( form?:any ): string; /** [Method] Sets the passed attributes as attributes of this element a style attribute can be a string object or function * @param attributes Object The object with the attributes. * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( attributes?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom String The bottom CSS property value. + * @returns Ext.dom.Element this */ setBottom?( bottom?:string ): Ext.dom.IElement; /** [Method] Sets the element s box * @param box Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... } + * @returns Ext.dom.Element this */ setBox?( box?:any ): Ext.dom.IElement; /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the specified CSS class on this element s DOM node * @param className String/Array The CSS class to set on this element. */ - setCls?( className?:any ): any; - setCls?( className?:string ): void; - setCls?( className?:any[] ): void; + setCls?( className?:any ): void; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHTML?( html?:string ): void; /** [Method] Set the height of this Element * @param height Number/String The new height. + * @returns Ext.dom.Element this */ - setHeight?( height?:any ): any; - setHeight?( height?:number ): Ext.dom.IElement; - setHeight?( height?:string ): Ext.dom.IElement; + setHeight?( height?:any ): Ext.dom.IElement; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHtml?( html?:string ): void; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left String The left CSS property value. + * @returns Ext.dom.Element this */ setLeft?( left?:string ): Ext.dom.IElement; /** [Method] Sets the value of listeners @@ -21602,76 +23826,76 @@ declare module Ext.dom { setListeners?( listeners?:any ): void; /** [Method] Set the maximum height of this Element * @param height Number/String The new maximum height. + * @returns Ext.dom.Element this */ - setMaxHeight?( height?:any ): any; - setMaxHeight?( height?:number ): Ext.dom.IElement; - setMaxHeight?( height?:string ): Ext.dom.IElement; + setMaxHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the maximum width of this Element * @param width Number/String The new maximum width. + * @returns Ext.dom.Element this */ - setMaxWidth?( width?:any ): any; - setMaxWidth?( width?:number ): Ext.dom.IElement; - setMaxWidth?( width?:string ): Ext.dom.IElement; + setMaxWidth?( width?:any ): Ext.dom.IElement; /** [Method] Set the minimum height of this Element * @param height Number/String The new minimum height. + * @returns Ext.dom.Element this */ - setMinHeight?( height?:any ): any; - setMinHeight?( height?:number ): Ext.dom.IElement; - setMinHeight?( height?:string ): Ext.dom.IElement; + setMinHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the minimum width of this Element * @param width Number/String The new minimum width. + * @returns Ext.dom.Element this */ - setMinWidth?( width?:any ): any; - setMinWidth?( width?:number ): Ext.dom.IElement; - setMinWidth?( width?:string ): Ext.dom.IElement; + setMinWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right String The right CSS property value. + * @returns Ext.dom.Element this */ setRight?( right?:string ): Ext.dom.IElement; /** [Method] Set the size of this Element * @param width Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels). A String used to set the CSS width style. Animation may not be used. A size object in the format {width: widthValue, height: heightValue}. * @param height Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used. + * @returns Ext.dom.Element this */ - setSize?( width?:any, height?:any ): any; - setSize?( width?:number, height?:number ): Ext.dom.IElement; - setSize?( width?:string, height?:number ): Ext.dom.IElement; - setSize?( width?:number, height?:string ): Ext.dom.IElement; - setSize?( width?:string, height?:string ): Ext.dom.IElement; + setSize?( width?:any, height?:any ): Ext.dom.IElement; /** [Method] Wrapper for setting style properties also takes single object parameter of multiple styles * @param property String/Object The style property to be set, or an object of multiple styles. * @param value String The value to apply to the given property, or null if an object was passed. + * @returns Ext.dom.Element this */ setStyle?( property?:any, value?:string ): Ext.dom.IElement; /** [Method] Sets the element s top position directly using CSS style instead of setY * @param top String The top CSS property value. + * @returns Ext.dom.Element this */ setTop?( top?:string ): Ext.dom.IElement; /** [Method] Sets the element s top and left positions directly using CSS style */ setTopLeft?(): void; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS * @param mode Object + * @returns Ext.dom.Element this */ setVisibilityMode?( mode?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible. + * @returns Ext.Element this */ setVisible?( visible?:boolean ): Ext.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. + * @returns Ext.dom.Element this */ - setWidth?( width?:any ): any; - setWidth?( width?:number ): Ext.dom.IElement; - setWidth?( width?:string ): Ext.dom.IElement; + setWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the X position of the element based on page coordinates * @param x Number The X position of the element + * @returns Ext.dom.Element this */ setX?( x?:number ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates regardless of how the element is positioned * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based). + * @returns Ext.dom.Element this */ setXY?( pos?:number[] ): Ext.dom.IElement; /** [Method] Sets the Y position of the element based on page coordinates * @param y Number The Y position of the element. + * @returns Ext.dom.Element this */ setY?( y?:number ): Ext.dom.IElement; /** [Method] Shows this element */ @@ -21680,15 +23904,15 @@ declare module Ext.dom { suspendEvents?(): void; /** [Method] Toggles the specified CSS class on this element removes it if it already exists otherwise adds it * @param className String The CSS class to toggle. + * @returns Ext.dom.Element this */ toggleCls?( className?:string ): Ext.dom.IElement; /** [Method] Translates the passed page coordinates into left top CSS values for this element * @param x Number/Array The page x or an array containing [x, y]. * @param y Number The page y, required if x is not an array. + * @returns Object An object with left and top properties. e.g. {left: (value), top: (value)}. */ - translatePoints?( x?:any, y?:any ): any; - translatePoints?( x?:number, y?:number ): any; - translatePoints?( x?:any[], y?:number ): any; + translatePoints?( x?:any, y?:number ): any; /** [Method] Alias for removeListener * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -21696,36 +23920,29 @@ declare module Ext.dom { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a previously applied mask */ unmask?(): void; /** [Method] Walks up the dom looking for a parent node that matches the passed simple selector e g * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). + * @returns Ext.dom.Element/null The matching DOM node (or null if no match was found). */ - up?( simpleSelector?:any, maxDepth?:any ): any; - up?( simpleSelector?:string, maxDepth?:number ): any; - up?( simpleSelector?:string, maxDepth?:string ): any; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; + up?( simpleSelector?:string, maxDepth?:any ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -21733,6 +23950,7 @@ declare module Ext.dom { /** [Method] Creates and wraps this element with another element * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param domNode Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The newly created wrapper element. */ wrap?( config?:any, domNode?:boolean ): any; } @@ -21743,6 +23961,7 @@ declare module Ext.dom { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] @@ -21757,71 +23976,81 @@ declare module Ext.dom { /** [Method] Gets the globally shared flyweight Element with the passed node as the active element * @param element String/HTMLElement The DOM node or id. * @param named String Allows for creation of named reusable flyweights to prevent conflicts (e.g. internally Ext uses "_global"). + * @returns Ext.dom.Element The shared Element object (or null if no matching element was found). */ - static fly( element?:any, named?:any ): any; - static fly( element?:string, named?:string ): Ext.dom.IElement; - static fly( element?:HTMLElement, named?:string ): Ext.dom.IElement; + static fly( element?:any, named?:string ): Ext.dom.IElement; /** [Method] Returns the top Element that is located at the passed coordinates * @param x Number The x coordinate * @param y Number The y coordinate + * @returns String The found Element */ static fromPoint( x?:number, y?:number ): string; /** [Method] Retrieves Ext dom Element objects * @param element String/HTMLElement/Ext.Element The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element The Element object (or null if no matching element was found). + */ + static get( element?:any ): Ext.dom.IElement; + /** [Method] Retrieves the document height + * @returns Number documentHeight */ - static get( element?:any ): any; - static get( element?:string ): Ext.dom.IElement; - static get( element?:HTMLElement ): Ext.dom.IElement; - static get( element?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Retrieves the document height */ static getDocumentHeight(): number; - /** [Method] Retrieves the document width */ + /** [Method] Retrieves the document width + * @returns Number documentWidth + */ static getDocumentWidth(): number; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; - /** [Method] Retrieves the current orientation of the window */ + /** [Method] Retrieves the current orientation of the window + * @returns String Orientation of window: 'portrait' or 'landscape' + */ static getOrientation(): string; - /** [Method] Retrieves the viewport size of the window */ + /** [Method] Retrieves the viewport size of the window + * @returns Object object containing width and height properties + */ static getViewSize(): any; - /** [Method] Retrieves the viewport height of the window */ + /** [Method] Retrieves the viewport height of the window + * @returns Number viewportHeight + */ static getViewportHeight(): number; - /** [Method] Retrieves the viewport width of the window */ + /** [Method] Retrieves the viewport width of the window + * @returns Number viewportWidth + */ static getViewportWidth(): number; /** [Method] Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax * @param prop String The property to normalize + * @returns String The normalized string */ static normalize( prop?:string ): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String The encoded margins + * @returns Object An object with margin sizes for top, right, bottom and left containing the unit */ static parseBox( box?:any ): any; - static parseBox( box?:number ): any; - static parseBox( box?:string ): any; /** [Method] Converts a CSS string into an object with a property for each style * @param styles String A CSS string + * @returns Object styles */ static parseStyles( styles?:string ): any; /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in * @param selector String/HTMLElement[] The CSS selector or an array of elements * @param composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. * @param root HTMLElement/String The root element of the query or id of the root + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - static select( selector?:any, composite?:any, root?:any ): any; - static select( selector?:string, composite?:boolean, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - static select( selector?:HTMLElement[], composite?:boolean, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - static select( selector?:string, composite?:boolean, root?:string ): Ext.dom.ICompositeElementLite; - static select( selector?:HTMLElement[], composite?:boolean, root?:string ): Ext.dom.ICompositeElementLite; + static select( selector?:any, composite?:boolean, root?:any ): Ext.dom.ICompositeElementLite; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String The encoded margins * @param units String The type of units to add + * @returns String An string with unitized (px if units is not specified) metrics for top, right, bottom and left */ - static unitizeBox( box?:any, units?:any ): any; - static unitizeBox( box?:number, units?:string ): string; - static unitizeBox( box?:string, units?:string ): string; + static unitizeBox( box?:any, units?:string ): string; } } declare module Ext { @@ -21844,20 +24073,19 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the given CSS class es to this Element * @param names String The CSS class(es) to add to this element. * @param prefix String Prefix to prepend to each class. * @param suffix String Suffix to append to each class. + * @returns Ext.dom.Element this */ addCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Adds the specified events to the list of events which this Observable may fire @@ -21871,9 +24099,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -21881,43 +24107,40 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends the passed element s to this element * @param element HTMLElement/Ext.dom.Element a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendChild?( element?:any ): any; - appendChild?( element?:HTMLElement ): Ext.dom.IElement; - appendChild?( element?:Ext.dom.IElement ): Ext.dom.IElement; + appendChild?( element?:any ): Ext.dom.IElement; /** [Method] Appends this element to the passed element * @param el String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IElement; - appendTo?( el?:HTMLElement ): Ext.dom.IElement; - appendTo?( el?:Ext.dom.IElement ): Ext.dom.IElement; + appendTo?( el?:any ): Ext.dom.IElement; /** [Method] More flexible version of setStyle for setting style properties * @param styles String/Object/Function A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification. + * @returns Ext.dom.Element this */ applyStyles?( styles?:any ): Ext.dom.IElement; /** [Method] Selects a single direct child based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector. * @param returnDom Boolean true to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true) */ child?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] Returns true if this element is an ancestor of the passed element * @param element HTMLElement/String The element to check. + * @returns Boolean true if this element is an ancestor of el, else false. */ - contains?( element?:any ): any; - contains?( element?:HTMLElement ): boolean; - contains?( element?:string ): boolean; + contains?( element?:any ): boolean; /** [Method] Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e * @param config Object DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be automatically generated with the specified attributes. * @param insertBefore HTMLElement a child element of this element. * @param returnDom Boolean true to return the dom node instead of creating an Element. + * @returns Ext.dom.Element The new child element. */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Translates an element using CSS 3 in 2D */ @@ -21927,99 +24150,115 @@ declare module Ext { /** [Method] Selects a single child at any depth below this element based on the passed CSS selector the selector should not cont * @param selector String The CSS selector. * @param returnDom Boolean true to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true). */ down?( selector?:string, returnDom?:boolean ): any; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParent?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParent?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParentNode?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParentNode?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Gets the first child skipping text nodes * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The first child or null. */ first?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. * @param offsets Array Offset the positioning by [x, y]. + * @returns Array [x, y] */ getAlignToXY?( element?:any, position?:string, offsets?:any[] ): any[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. * @param local Boolean true to get the local (element top/left-relative) anchor position instead of page coordinates. * @param size Object An object containing the size to use for calculating anchor position. {width: (target width), height: (target height)} (defaults to the element's current size) + * @returns Array [x, y] An array containing the element's x and y coordinates. */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): any[]; /** [Method] Returns the value of an attribute from the element s underlying DOM node * @param name String The attribute name. * @param namespace String The namespace in which to look for the attribute. + * @returns String The attribute value. */ getAttribute?( name?:string, namespace?:string ): string; /** [Method] Gets the width of the border s for the specified side s * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the border left width + the border right width. + * @returns Number The width of the sides passed added together */ getBorderWidth?( side?:string ): number; - /** [Method] Gets the bottom Y coordinate of the element element Y position element height */ + /** [Method] Gets the bottom Y coordinate of the element element Y position element height + * @returns Number + */ getBottom?(): number; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param contentBox Boolean If true a box for the content of the element is returned. * @param local Boolean If true the element's left and top are returned instead of page x/y. + * @returns Object An object in the format */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHTML?(): string; /** [Method] Returns the offset height of the element * @param contentHeight Boolean true to get the height minus borders and padding. + * @returns Number The element's height. */ getHeight?( contentHeight?:boolean ): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHtml?(): string; - /** [Method] Gets the left X coordinate */ + /** [Method] Gets the left X coordinate + * @returns Number + */ getLeft?(): number; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Returns an object with properties top left right and bottom representing the margins of this element unless sides i * @param sides String Any combination of 'l', 'r', 't', 'b' to get the sum of those sides. + * @returns Object/Number */ getMargin?( sides?:string ): any; /** [Method] Returns the offsets of this element from the passed element * @param element Mixed The element to get the offsets from. + * @returns Array The XY page offsets (e.g. [100, -200]) */ getOffsetsTo?( element?:any ): any[]; /** [Method] Retrieves the height of the element account for the top and bottom margins */ @@ -22028,91 +24267,106 @@ declare module Ext { getOuterWidth?(): void; /** [Method] Gets the width of the padding s for the specified side s * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the padding left + the padding right. + * @returns Number The padding of the sides passed added together. */ getPadding?( side?:string ): number; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param asRegion Boolean If true an Ext.util.Region will be returned. + * @returns Object box An object in the format: { x: <Element's X position>, y: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for setXY. */ getPageBox?( asRegion?:boolean ): any; - /** [Method] Gets the right X coordinate of the element element X position element width */ + /** [Method] Gets the right X coordinate of the element element X position element width + * @returns Number + */ getRight?(): number; /** [Method] Gets the Scroller instance of the first parent that has one */ getScrollParent?(): void; /** [Method] Returns the size of the element * @param contentSize Boolean true to get the width/size minus borders and padding. + * @returns Object An object containing the element's size: */ getSize?( contentSize?:boolean ): any; /** [Method] Normalizes currentStyle and computedStyle * @param prop String The style property whose value is returned. + * @returns String The current value of the style property for this element. */ getStyle?( prop?:string ): string; - /** [Method] Gets the top Y coordinate */ + /** [Method] Gets the top Y coordinate + * @returns Number + */ getTop?(): number; /** [Method] Returns the value of the value attribute * @param asNumber Boolean true to parse the value as a number. + * @returns String/Number */ getValue?( asNumber?:boolean ): any; - /** [Method] Returns the dimensions of the element available to lay content out in */ + /** [Method] Returns the dimensions of the element available to lay content out in + * @returns Object Object describing width and height: + */ getViewSize?(): any; /** [Method] Returns the offset width of the element * @param contentWidth Boolean true to get the width minus borders and padding. + * @returns Number The element's width. */ getWidth?( contentWidth?:boolean ): number; /** [Method] Gets the current X position of the element based on page coordinates * @param el Object + * @returns Number The X position of the element */ getX?( el?:any ): number; - /** [Method] Gets the current position of the element based on page coordinates */ + /** [Method] Gets the current position of the element based on page coordinates + * @returns Array The XY position of the element + */ getXY?(): any[]; /** [Method] Gets the current Y position of the element based on page coordinates * @param el Object + * @returns Number The Y position of the element */ getY?( el?:any ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param name String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( name?:string ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Hides this element */ hide?(): void; /** [Method] Inserts this element after the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IElement; - insertAfter?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertAfter?( el?:any ): Ext.dom.IElement; /** [Method] Inserts this element before the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IElement; - insertBefore?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertBefore?( el?:any ): Ext.dom.IElement; /** [Method] Inserts an element as the first child of this element * @param element String/HTMLElement/Ext.dom.Element The id or element to insert. + * @returns Ext.dom.Element this */ - insertFirst?( element?:any ): any; - insertFirst?( element?:string ): Ext.dom.IElement; - insertFirst?( element?:HTMLElement ): Ext.dom.IElement; - insertFirst?( element?:Ext.dom.IElement ): Ext.dom.IElement; + insertFirst?( element?:any ): Ext.dom.IElement; /** [Method] Inserts an HTML fragment into this element * @param where String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean true to return an Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted). */ insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element * @param el String/HTMLElement/Ext.dom.Element/Object/Array The id, element to insert or a DomHelper config to create and insert or an array of any of those. * @param where String 'before' or 'after'. * @param returnDom Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Returns true if this element matches the passed simple selector e g * @param selector String The simple selector to test. + * @returns Boolean true if this element matches the selector, else false. */ is?( selector?:string ): boolean; /** [Method] Determines if this element is a descendant of the passed in Element */ @@ -22120,15 +24374,18 @@ declare module Ext { /** [Method] Checks if the current value of a style is equal to a given value * @param style String property whose value is returned. * @param value String to check against. + * @returns Boolean true for when the current value equals the given value. */ isStyle?( style?:string, value?:string ): boolean; /** [Method] Returns true if the value of the given property is visually transparent * @param prop String The style property whose value is to be tested. + * @returns Boolean true if the style property is visually transparent. */ isTransparent?( prop?:string ): boolean; /** [Method] Gets the last child skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The last child or null. */ last?( selector?:string, returnDom?:boolean ): any; /** [Method] Puts a mask over this element to disable user interaction */ @@ -22140,21 +24397,18 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Gets the next sibling skipping text nodes * @param selector String Find the next sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw dom node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The next sibling or null. */ next?( selector?:string, returnDom?:boolean ): any; /** [Method] Alias for addListener @@ -22164,50 +24418,49 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @param selector String Find a parent node that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element. + * @returns Ext.dom.Element/HTMLElement/null The parent node or null. */ parent?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the previous sibling skipping text nodes * @param selector String Find the previous sibling that matches the passed simple selector. * @param returnDom Boolean true to return a raw DOM node instead of an Ext.dom.Element + * @returns Ext.dom.Element/HTMLElement/null The previous sibling or null. */ prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector. + * @returns HTMLElement[] An array of the matched nodes. */ query?( selector?:string ): HTMLElement[]; /** [Method] Adds one or more CSS classes to this element and removes the same class es from all siblings * @param className String/String[] The CSS class to add, or an array of classes. + * @returns Ext.dom.Element this */ - radioCls?( className?:any ): any; - radioCls?( className?:string ): Ext.dom.IElement; - radioCls?( className?:string[] ): Ext.dom.IElement; + radioCls?( className?:any ): Ext.dom.IElement; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes this element s DOM reference */ @@ -22218,8 +24471,7 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ removeAllListeners?(): void; /** [Method] Removes a before event handler @@ -22228,12 +24480,12 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes the given CSS class es from this Element * @param names String The CSS class(es) to remove from this element. * @param prefix String Prefix to prepend to each class to be removed. * @param suffix String Suffix to append to each class to be removed. + * @returns Ext.dom.Element this */ removeCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Removes an event handler @@ -22243,36 +24495,34 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; - /** [Method] Forces the browser to repaint this element */ + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; + /** [Method] Forces the browser to repaint this element + * @returns Ext.dom.Element this + */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element * @param element String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - replace?( element?:any ): any; - replace?( element?:string ): Ext.dom.IElement; - replace?( element?:HTMLElement ): Ext.dom.IElement; - replace?( element?:Ext.dom.IElement ): Ext.dom.IElement; + replace?( element?:any ): Ext.dom.IElement; /** [Method] Replaces a CSS class on the element with another * @param oldName String The CSS class to replace. * @param newName String The replacement CSS class. * @param prefix String Prefix to prepend to each class to be replaced. * @param suffix String Suffix to append to each class to be replaced. + * @returns Ext.dom.Element this */ replaceCls?( oldName?:string, newName?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Replaces this element with the passed element * @param el String/HTMLElement/Ext.dom.Element/Object The new element (id of the node, a DOM Node or an existing Element) or a DomHelper config of an element to create. + * @returns Ext.dom.Element This element. */ replaceWith?( el?:any ): Ext.dom.IElement; /** [Method] Resumes firing events see suspendEvents @@ -22281,49 +24531,49 @@ declare module Ext { resumeEvents?( discardQueuedEvents?:boolean ): void; /** [Method] Serializes a DOM form into a url encoded string * @param form Object The form + * @returns String The url encoded form */ serializeForm?( form?:any ): string; /** [Method] Sets the passed attributes as attributes of this element a style attribute can be a string object or function * @param attributes Object The object with the attributes. * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( attributes?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom String The bottom CSS property value. + * @returns Ext.dom.Element this */ setBottom?( bottom?:string ): Ext.dom.IElement; /** [Method] Sets the element s box * @param box Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... } + * @returns Ext.dom.Element this */ setBox?( box?:any ): Ext.dom.IElement; /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the specified CSS class on this element s DOM node * @param className String/Array The CSS class to set on this element. */ - setCls?( className?:any ): any; - setCls?( className?:string ): void; - setCls?( className?:any[] ): void; + setCls?( className?:any ): void; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHTML?( html?:string ): void; /** [Method] Set the height of this Element * @param height Number/String The new height. + * @returns Ext.dom.Element this */ - setHeight?( height?:any ): any; - setHeight?( height?:number ): Ext.dom.IElement; - setHeight?( height?:string ): Ext.dom.IElement; + setHeight?( height?:any ): Ext.dom.IElement; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHtml?( html?:string ): void; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left String The left CSS property value. + * @returns Ext.dom.Element this */ setLeft?( left?:string ): Ext.dom.IElement; /** [Method] Sets the value of listeners @@ -22332,76 +24582,76 @@ declare module Ext { setListeners?( listeners?:any ): void; /** [Method] Set the maximum height of this Element * @param height Number/String The new maximum height. + * @returns Ext.dom.Element this */ - setMaxHeight?( height?:any ): any; - setMaxHeight?( height?:number ): Ext.dom.IElement; - setMaxHeight?( height?:string ): Ext.dom.IElement; + setMaxHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the maximum width of this Element * @param width Number/String The new maximum width. + * @returns Ext.dom.Element this */ - setMaxWidth?( width?:any ): any; - setMaxWidth?( width?:number ): Ext.dom.IElement; - setMaxWidth?( width?:string ): Ext.dom.IElement; + setMaxWidth?( width?:any ): Ext.dom.IElement; /** [Method] Set the minimum height of this Element * @param height Number/String The new minimum height. + * @returns Ext.dom.Element this */ - setMinHeight?( height?:any ): any; - setMinHeight?( height?:number ): Ext.dom.IElement; - setMinHeight?( height?:string ): Ext.dom.IElement; + setMinHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the minimum width of this Element * @param width Number/String The new minimum width. + * @returns Ext.dom.Element this */ - setMinWidth?( width?:any ): any; - setMinWidth?( width?:number ): Ext.dom.IElement; - setMinWidth?( width?:string ): Ext.dom.IElement; + setMinWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right String The right CSS property value. + * @returns Ext.dom.Element this */ setRight?( right?:string ): Ext.dom.IElement; /** [Method] Set the size of this Element * @param width Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels). A String used to set the CSS width style. Animation may not be used. A size object in the format {width: widthValue, height: heightValue}. * @param height Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used. + * @returns Ext.dom.Element this */ - setSize?( width?:any, height?:any ): any; - setSize?( width?:number, height?:number ): Ext.dom.IElement; - setSize?( width?:string, height?:number ): Ext.dom.IElement; - setSize?( width?:number, height?:string ): Ext.dom.IElement; - setSize?( width?:string, height?:string ): Ext.dom.IElement; + setSize?( width?:any, height?:any ): Ext.dom.IElement; /** [Method] Wrapper for setting style properties also takes single object parameter of multiple styles * @param property String/Object The style property to be set, or an object of multiple styles. * @param value String The value to apply to the given property, or null if an object was passed. + * @returns Ext.dom.Element this */ setStyle?( property?:any, value?:string ): Ext.dom.IElement; /** [Method] Sets the element s top position directly using CSS style instead of setY * @param top String The top CSS property value. + * @returns Ext.dom.Element this */ setTop?( top?:string ): Ext.dom.IElement; /** [Method] Sets the element s top and left positions directly using CSS style */ setTopLeft?(): void; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS * @param mode Object + * @returns Ext.dom.Element this */ setVisibilityMode?( mode?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible. + * @returns Ext.Element this */ setVisible?( visible?:boolean ): Ext.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. + * @returns Ext.dom.Element this */ - setWidth?( width?:any ): any; - setWidth?( width?:number ): Ext.dom.IElement; - setWidth?( width?:string ): Ext.dom.IElement; + setWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the X position of the element based on page coordinates * @param x Number The X position of the element + * @returns Ext.dom.Element this */ setX?( x?:number ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates regardless of how the element is positioned * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based). + * @returns Ext.dom.Element this */ setXY?( pos?:number[] ): Ext.dom.IElement; /** [Method] Sets the Y position of the element based on page coordinates * @param y Number The Y position of the element. + * @returns Ext.dom.Element this */ setY?( y?:number ): Ext.dom.IElement; /** [Method] Shows this element */ @@ -22410,15 +24660,15 @@ declare module Ext { suspendEvents?(): void; /** [Method] Toggles the specified CSS class on this element removes it if it already exists otherwise adds it * @param className String The CSS class to toggle. + * @returns Ext.dom.Element this */ toggleCls?( className?:string ): Ext.dom.IElement; /** [Method] Translates the passed page coordinates into left top CSS values for this element * @param x Number/Array The page x or an array containing [x, y]. * @param y Number The page y, required if x is not an array. + * @returns Object An object with left and top properties. e.g. {left: (value), top: (value)}. */ - translatePoints?( x?:any, y?:any ): any; - translatePoints?( x?:number, y?:number ): any; - translatePoints?( x?:any[], y?:number ): any; + translatePoints?( x?:any, y?:number ): any; /** [Method] Alias for removeListener * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -22426,40 +24676,37 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a previously applied mask */ unmask?(): void; /** [Method] Walks up the dom looking for a parent node that matches the passed simple selector e g * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). + * @returns Ext.dom.Element/null The matching DOM node (or null if no match was found). + */ + up?( simpleSelector?:string, maxDepth?:any ): any; + /** [Method] Sets the innerHTML of this element + * @param html String The new HTML. */ - up?( simpleSelector?:any, maxDepth?:any ): any; - up?( simpleSelector?:string, maxDepth?:number ): any; - up?( simpleSelector?:string, maxDepth?:string ): any; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; update?( html?:string ): void; /** [Method] Creates and wraps this element with another element * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param domNode Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The newly created wrapper element. */ wrap?( config?:any, domNode?:boolean ): any; } @@ -22470,6 +24717,7 @@ declare module Ext { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] @@ -22484,71 +24732,81 @@ declare module Ext { /** [Method] Gets the globally shared flyweight Element with the passed node as the active element * @param element String/HTMLElement The DOM node or id. * @param named String Allows for creation of named reusable flyweights to prevent conflicts (e.g. internally Ext uses "_global"). + * @returns Ext.dom.Element The shared Element object (or null if no matching element was found). */ - static fly( element?:any, named?:any ): any; - static fly( element?:string, named?:string ): Ext.dom.IElement; - static fly( element?:HTMLElement, named?:string ): Ext.dom.IElement; + static fly( element?:any, named?:string ): Ext.dom.IElement; /** [Method] Returns the top Element that is located at the passed coordinates * @param x Number The x coordinate * @param y Number The y coordinate + * @returns String The found Element */ static fromPoint( x?:number, y?:number ): string; /** [Method] Retrieves Ext dom Element objects * @param element String/HTMLElement/Ext.Element The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element The Element object (or null if no matching element was found). + */ + static get( element?:any ): Ext.dom.IElement; + /** [Method] Retrieves the document height + * @returns Number documentHeight */ - static get( element?:any ): any; - static get( element?:string ): Ext.dom.IElement; - static get( element?:HTMLElement ): Ext.dom.IElement; - static get( element?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Retrieves the document height */ static getDocumentHeight(): number; - /** [Method] Retrieves the document width */ + /** [Method] Retrieves the document width + * @returns Number documentWidth + */ static getDocumentWidth(): number; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; - /** [Method] Retrieves the current orientation of the window */ + /** [Method] Retrieves the current orientation of the window + * @returns String Orientation of window: 'portrait' or 'landscape' + */ static getOrientation(): string; - /** [Method] Retrieves the viewport size of the window */ + /** [Method] Retrieves the viewport size of the window + * @returns Object object containing width and height properties + */ static getViewSize(): any; - /** [Method] Retrieves the viewport height of the window */ + /** [Method] Retrieves the viewport height of the window + * @returns Number viewportHeight + */ static getViewportHeight(): number; - /** [Method] Retrieves the viewport width of the window */ + /** [Method] Retrieves the viewport width of the window + * @returns Number viewportWidth + */ static getViewportWidth(): number; /** [Method] Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax * @param prop String The property to normalize + * @returns String The normalized string */ static normalize( prop?:string ): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String The encoded margins + * @returns Object An object with margin sizes for top, right, bottom and left containing the unit */ static parseBox( box?:any ): any; - static parseBox( box?:number ): any; - static parseBox( box?:string ): any; /** [Method] Converts a CSS string into an object with a property for each style * @param styles String A CSS string + * @returns Object styles */ static parseStyles( styles?:string ): any; /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in * @param selector String/HTMLElement[] The CSS selector or an array of elements * @param composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. * @param root HTMLElement/String The root element of the query or id of the root + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - static select( selector?:any, composite?:any, root?:any ): any; - static select( selector?:string, composite?:boolean, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - static select( selector?:HTMLElement[], composite?:boolean, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - static select( selector?:string, composite?:boolean, root?:string ): Ext.dom.ICompositeElementLite; - static select( selector?:HTMLElement[], composite?:boolean, root?:string ): Ext.dom.ICompositeElementLite; + static select( selector?:any, composite?:boolean, root?:any ): Ext.dom.ICompositeElementLite; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String The encoded margins * @param units String The type of units to add + * @returns String An string with unitized (px if units is not specified) metrics for top, right, bottom and left */ - static unitizeBox( box?:any, units?:any ): any; - static unitizeBox( box?:number, units?:string ): string; - static unitizeBox( box?:string, units?:string ): string; + static unitizeBox( box?:any, units?:string ): string; } } declare module Ext.dom { @@ -22556,25 +24814,21 @@ declare module Ext.dom { /** [Method] Returns true if the passed element s match the passed simple selector e g * @param el String/HTMLElement/Array An element id, element or array of elements * @param selector String The simple selector to test + * @returns Boolean */ - is?( el?:any, selector?:any ): any; - is?( el?:string, selector?:string ): boolean; - is?( el?:HTMLElement, selector?:string ): boolean; - is?( el?:any[], selector?:string ): boolean; + is?( el?:any, selector?:string ): boolean; /** [Method] Selects a group of elements * @param selector String The selector/xpath query (can be a comma separated list of selectors) * @param root HTMLElement/String The start of the query (defaults to document). + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ - select?( selector?:any, root?:any ): any; - select?( selector?:string, root?:HTMLElement ): HTMLElement[]; - select?( selector?:string, root?:string ): HTMLElement[]; + select?( selector?:string, root?:any ): HTMLElement[]; /** [Method] Selects a single element * @param selector String The selector/xpath query * @param root HTMLElement/String The start of the query (defaults to document). + * @returns HTMLElement The DOM element which matched the selector. */ - selectNode?( selector?:any, root?:any ): any; - selectNode?( selector?:string, root?:HTMLElement ): HTMLElement; - selectNode?( selector?:string, root?:string ): HTMLElement; + selectNode?( selector?:string, root?:any ): HTMLElement; } } declare module Ext { @@ -22583,75 +24837,65 @@ declare module Ext { * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - append?( el?:any, o?:any, returnElement?:any ): any; - append?( el?:string, o?:any, returnElement?:boolean ): any; - append?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - append?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + append?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Applies a style specification to an element * @param el String/HTMLElement The element to apply styles to * @param styles String/Object/Function A style specification string e.g. 'width:100px', or object in the form {width:'100px'}, or a function which returns such a specification. */ - applyStyles?( el?:any, styles?:any ): any; - applyStyles?( el?:string, styles?:any ): void; - applyStyles?( el?:HTMLElement, styles?:any ): void; + applyStyles?( el?:any, styles?:any ): void; /** [Method] Creates a new Ext Template from the DOM object spec * @param o Object The DOM object spec (and children) + * @returns Ext.Template The new template */ createTemplate?( o?:any ): Ext.ITemplate; /** [Method] Converts the styles from the given object to text * @param styles Object The object describing the styles. * @param buffer String[] The output buffer. + * @returns String/String[] If buffer is passed, it is returned. Otherwise the style string is returned. */ generateStyles?( styles?:any, buffer?:string[] ): any; /** [Method] Creates new DOM element s and inserts them after el * @param el String/HTMLElement/Ext.Element The context element * @param o Object The DOM object spec (and children) * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - insertAfter?( el?:any, o?:any, returnElement?:any ): any; - insertAfter?( el?:string, o?:any, returnElement?:boolean ): any; - insertAfter?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertAfter?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + insertAfter?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Creates new DOM element s and inserts them before el * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - insertBefore?( el?:any, o?:any, returnElement?:any ): any; - insertBefore?( el?:string, o?:any, returnElement?:boolean ): any; - insertBefore?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertBefore?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + insertBefore?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Creates new DOM element s and inserts them as the first child of el * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - insertFirst?( el?:any, o?:any, returnElement?:any ): any; - insertFirst?( el?:string, o?:any, returnElement?:boolean ): any; - insertFirst?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertFirst?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + insertFirst?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Inserts an HTML fragment into the DOM * @param where String Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd. For example take the following HTML: <div>Contents</div> Using different where values inserts element to the following places: beforeBegin: <HERE><div>Contents</div> afterBegin: <div><HERE>Contents</div> beforeEnd: <div>Contents<HERE></div> afterEnd: <div>Contents</div><HERE> * @param el HTMLElement/TextNode The context element * @param html String The HTML fragment + * @returns HTMLElement The new node */ - insertHtml?( where?:any, el?:any, html?:any ): any; - insertHtml?( where?:string, el?:HTMLElement, html?:string ): HTMLElement; insertHtml?( where?:string, el?:any, html?:string ): HTMLElement; /** [Method] Returns the markup for the passed Element s config * @param spec Object The DOM object spec (and children). + * @returns String */ markup?( spec?:any ): string; /** [Method] Creates new DOM element s and overwrites the contents of el with them * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - overwrite?( el?:any, o?:any, returnElement?:any ): any; - overwrite?( el?:string, o?:any, returnElement?:boolean ): any; - overwrite?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - overwrite?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + overwrite?( el?:any, o?:any, returnElement?:boolean ): any; } } declare module Ext.dom { @@ -22660,75 +24904,65 @@ declare module Ext.dom { * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - append?( el?:any, o?:any, returnElement?:any ): any; - append?( el?:string, o?:any, returnElement?:boolean ): any; - append?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - append?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + append?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Applies a style specification to an element * @param el String/HTMLElement The element to apply styles to * @param styles String/Object/Function A style specification string e.g. 'width:100px', or object in the form {width:'100px'}, or a function which returns such a specification. */ - applyStyles?( el?:any, styles?:any ): any; - applyStyles?( el?:string, styles?:any ): void; - applyStyles?( el?:HTMLElement, styles?:any ): void; + applyStyles?( el?:any, styles?:any ): void; /** [Method] Creates a new Ext Template from the DOM object spec * @param o Object The DOM object spec (and children) + * @returns Ext.Template The new template */ createTemplate?( o?:any ): Ext.ITemplate; /** [Method] Converts the styles from the given object to text * @param styles Object The object describing the styles. * @param buffer String[] The output buffer. + * @returns String/String[] If buffer is passed, it is returned. Otherwise the style string is returned. */ generateStyles?( styles?:any, buffer?:string[] ): any; /** [Method] Creates new DOM element s and inserts them after el * @param el String/HTMLElement/Ext.Element The context element * @param o Object The DOM object spec (and children) * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - insertAfter?( el?:any, o?:any, returnElement?:any ): any; - insertAfter?( el?:string, o?:any, returnElement?:boolean ): any; - insertAfter?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertAfter?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + insertAfter?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Creates new DOM element s and inserts them before el * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - insertBefore?( el?:any, o?:any, returnElement?:any ): any; - insertBefore?( el?:string, o?:any, returnElement?:boolean ): any; - insertBefore?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertBefore?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + insertBefore?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Creates new DOM element s and inserts them as the first child of el * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - insertFirst?( el?:any, o?:any, returnElement?:any ): any; - insertFirst?( el?:string, o?:any, returnElement?:boolean ): any; - insertFirst?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertFirst?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + insertFirst?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Inserts an HTML fragment into the DOM * @param where String Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd. For example take the following HTML: <div>Contents</div> Using different where values inserts element to the following places: beforeBegin: <HERE><div>Contents</div> afterBegin: <div><HERE>Contents</div> beforeEnd: <div>Contents<HERE></div> afterEnd: <div>Contents</div><HERE> * @param el HTMLElement/TextNode The context element * @param html String The HTML fragment + * @returns HTMLElement The new node */ - insertHtml?( where?:any, el?:any, html?:any ): any; - insertHtml?( where?:string, el?:HTMLElement, html?:string ): HTMLElement; insertHtml?( where?:string, el?:any, html?:string ): HTMLElement; /** [Method] Returns the markup for the passed Element s config * @param spec Object The DOM object spec (and children). + * @returns String */ markup?( spec?:any ): string; /** [Method] Creates new DOM element s and overwrites the contents of el with them * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - overwrite?( el?:any, o?:any, returnElement?:any ): any; - overwrite?( el?:string, o?:any, returnElement?:boolean ): any; - overwrite?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - overwrite?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + overwrite?( el?:any, o?:any, returnElement?:boolean ): any; } } declare module Ext { @@ -22737,52 +24971,52 @@ declare module Ext { export class DomQuery { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Returns true if the passed element s match the passed simple selector e g * @param el String/HTMLElement/Array An element id, element or array of elements * @param selector String The simple selector to test + * @returns Boolean */ - static is( el?:any, selector?:any ): any; - static is( el?:string, selector?:string ): boolean; - static is( el?:HTMLElement, selector?:string ): boolean; - static is( el?:any[], selector?:string ): boolean; + static is( el?:any, selector?:string ): boolean; /** [Method] Selects a group of elements * @param selector String The selector/xpath query (can be a comma separated list of selectors) * @param root HTMLElement/String The start of the query (defaults to document). + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ - static select( selector?:any, root?:any ): any; - static select( selector?:string, root?:HTMLElement ): HTMLElement[]; - static select( selector?:string, root?:string ): HTMLElement[]; + static select( selector?:string, root?:any ): HTMLElement[]; /** [Method] Selects a single element * @param selector String The selector/xpath query * @param root HTMLElement/String The start of the query (defaults to document). + * @returns HTMLElement The DOM element which matched the selector. + */ + static selectNode( selector?:string, root?:any ): HTMLElement; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class */ - static selectNode( selector?:any, root?:any ): any; - static selectNode( selector?:string, root?:HTMLElement ): HTMLElement; - static selectNode( selector?:string, root?:string ): HTMLElement; - /** [Method] Get the reference to the class from which this object was instantiated */ static statics(): Ext.IClass; } } @@ -22792,52 +25026,52 @@ declare module Ext.core { export class DomQuery { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Returns true if the passed element s match the passed simple selector e g * @param el String/HTMLElement/Array An element id, element or array of elements * @param selector String The simple selector to test + * @returns Boolean */ - static is( el?:any, selector?:any ): any; - static is( el?:string, selector?:string ): boolean; - static is( el?:HTMLElement, selector?:string ): boolean; - static is( el?:any[], selector?:string ): boolean; + static is( el?:any, selector?:string ): boolean; /** [Method] Selects a group of elements * @param selector String The selector/xpath query (can be a comma separated list of selectors) * @param root HTMLElement/String The start of the query (defaults to document). + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ - static select( selector?:any, root?:any ): any; - static select( selector?:string, root?:HTMLElement ): HTMLElement[]; - static select( selector?:string, root?:string ): HTMLElement[]; + static select( selector?:string, root?:any ): HTMLElement[]; /** [Method] Selects a single element * @param selector String The selector/xpath query * @param root HTMLElement/String The start of the query (defaults to document). + * @returns HTMLElement The DOM element which matched the selector. + */ + static selectNode( selector?:string, root?:any ): HTMLElement; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class */ - static selectNode( selector?:any, root?:any ): any; - static selectNode( selector?:string, root?:HTMLElement ): HTMLElement; - static selectNode( selector?:string, root?:string ): HTMLElement; - /** [Method] Get the reference to the class from which this object was instantiated */ static statics(): Ext.IClass; } } @@ -22852,43 +25086,51 @@ declare module Ext.draw { /** [Method] Register a recursive callback that will be called at every frame * @param callback Object * @param scope Object + * @returns String */ static addFrameCallback( callback?:any, scope?:any ): string; - /** [Method] Cross platform animationTime implementation */ + /** [Method] Cross platform animationTime implementation + * @returns Number + */ static animationTime(): number; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Cancel a registered one time callback * @param id Object */ static cancel( id?:any ): void; /** [Method] Returns true or false whether it contains the given animation or not * @param animation Object The animation to check for. + * @returns Boolean */ static contains( animation?:any ): boolean; /** [Method] */ static destroy(): void; - /** [Method] Returns true or false whether the pool is empty or not */ + /** [Method] Returns true or false whether the pool is empty or not + * @returns Boolean + */ static empty(): boolean; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Removes an animation from the pool @@ -22902,9 +25144,12 @@ declare module Ext.draw { /** [Method] Register an one time callback that will be called at the next frame * @param callback Object * @param scope Object + * @returns String */ static schedule( callback?:any, scope?:any ): string; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Given a frame time it will filter out finished animations from the pool * @param frameTime Number The frame's start time, in milliseconds. @@ -22918,35 +25163,43 @@ declare module Ext.draw { lightnessFactor?: number; /** [Method] Return a new color that is darker than this color * @param factor Number Darker factor (0..1). + * @returns Ext.draw.Color */ createDarker?( factor?:number ): Ext.draw.IColor; /** [Method] Return a new color that is lighter than this color * @param factor Number Lighter factor (0..1). + * @returns Ext.draw.Color */ createLighter?( factor?:number ): Ext.draw.IColor; - /** [Method] Returns the gray value 0 to 255 of the color */ + /** [Method] Returns the gray value 0 to 255 of the color + * @returns Number + */ getGrayscale?(): number; /** [Method] Get the equivalent HSL components of the color * @param target Array Optional array to receive the values. + * @returns Array */ getHSL?( target?:any[] ): any[]; /** [Method] Parse the string and set current color * @param str String Color in string. + * @returns Object this */ setFromString?( str?:string ): any; /** [Method] Set current color based on the specified HSL values * @param h Number Hue component (0..359) * @param s Number Saturation component (0..1) * @param l Number Lightness component (0..1) + * @returns Object this */ setHSL?( h?:number, s?:number, l?:number ): any; /** [Method] Convert a color to hexadecimal format * @param color String/Array The color value (i.e 'rgb(255, 255, 255)', 'color: #ffffff'). Can also be an Array, in this case the function handles the first member. + * @returns String The color in hexadecimal format. + */ + toHex?( color?:any ): string; + /** [Method] Return the color in the hex format i e + * @returns String */ - toHex?( color?:any ): any; - toHex?( color?:string ): string; - toHex?( color?:any[] ): string; - /** [Method] Return the color in the hex format i e */ toString?(): string; } export class Color { @@ -22956,6 +25209,7 @@ declare module Ext.draw { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] @@ -22967,12 +25221,9 @@ declare module Ext.draw { * @param green Number Green component (0..255) * @param blue Number Blue component (0..255) * @param alpha Number Alpha component (0..1) + * @returns Ext.draw.Color */ - static create( red?:any, green?:any, blue?:any, alpha?:any ): any; - static create( red?:Ext.draw.IColor, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; - static create( red?:string, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; - static create( red?:number[], green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; - static create( red?:number, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; + static create( red?:any, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter * @param origin String/Object The original method name @@ -22983,24 +25234,28 @@ declare module Ext.draw { * @param green Number Green component (0..255) * @param blue Number Blue component (0..255) * @param alpha Number Alpha component (0..1) + * @returns Ext.draw.Color */ - static fly( red?:any, green?:any, blue?:any, alpha?:any ): any; - static fly( red?:number, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; - static fly( red?:string, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; + static fly( red?:any, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; /** [Method] Create a new color based on the specified HSL values * @param h Number Hue component (0..359) * @param s Number Saturation component (0..1) * @param l Number Lightness component (0..1) + * @returns Ext.draw.Color */ static fromHSL( h?:number, s?:number, l?:number ): Ext.draw.IColor; /** [Method] Parse the string and create a new color * @param string String Color in string. + * @returns Ext.draw.Color */ static fromString( string?:string ): Ext.draw.IColor; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -23021,23 +25276,38 @@ declare module Ext.draw { viewBox?: boolean; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of autoSize */ + /** [Method] Returns the value of autoSize + * @returns Boolean + */ getAutoSize?(): boolean; - /** [Method] Returns the value of background */ + /** [Method] Returns the value of background + * @returns Object + */ getBackground?(): any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of fitSurface */ + /** [Method] Returns the value of fitSurface + * @returns Boolean + */ getFitSurface?(): boolean; - /** [Method] Returns the value of resizeHandler */ + /** [Method] Returns the value of resizeHandler + * @returns Function + */ getResizeHandler?(): any; - /** [Method] Returns the value of sprites */ + /** [Method] Returns the value of sprites + * @returns Object + */ getSprites?(): any; /** [Method] Get a surface by the given id or create one if it doesn t exist * @param id String + * @returns Ext.draw.Surface */ getSurface?( id?:string ): Ext.draw.ISurface; - /** [Method] Returns the value of viewBox */ + /** [Method] Returns the value of viewBox + * @returns Boolean + */ getViewBox?(): boolean; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -23081,52 +25351,60 @@ declare module Ext.draw { export class Draw { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Converting radians to degrees * @param radian Number + * @returns Number */ static degrees( radian?:number ): number; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] * @param bbox1 Object * @param bbox2 Object * @param padding Object + * @returns Boolean */ static isBBoxIntersect( bbox1?:any, bbox2?:any, padding?:any ): boolean; /** [Method] Converting degrees to radians * @param degrees Number + * @returns Number */ static rad( degrees?:number ): number; /** [Method] Function that returns its first element * @param a Mixed + * @returns Mixed */ static reflectFn( a?:any ): any; /** [Method] Natural cubic spline interpolation * @param points Array Array of numbers. */ static spline( points?:any[] ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -23140,7 +25418,9 @@ declare module Ext.draw.engine { clearTransform?(): void; /** [Method] Destroys the Canvas element and prepares it for Garbage Collection */ destroy?(): void; - /** [Method] Returns the value of highPrecision */ + /** [Method] Returns the value of highPrecision + * @returns Boolean + */ getHighPrecision?(): boolean; /** [Method] Initialize the canvas element */ initElement?(): void; @@ -23160,6 +25440,7 @@ declare module Ext.draw.engine { clearTransform?(): void; /** [Method] Creates a DOM element under the SVG namespace of the given type * @param type Object The type of the SVG DOM element. + * @returns * The created element. */ createSvgNode?( type?:any ): any; /** [Method] Destroys the Canvas element and prepares it for Garbage Collection @@ -23168,7 +25449,9 @@ declare module Ext.draw.engine { * @param band Object */ destroy?( path?:any, matrix?:any, band?:any ): void; - /** [Method] Returns the value of highPrecision */ + /** [Method] Returns the value of highPrecision + * @returns Boolean + */ getHighPrecision?(): boolean; /** [Method] Remove a given sprite from the surface optionally destroying the sprite in the process * @param sprite Object @@ -23177,6 +25460,7 @@ declare module Ext.draw.engine { remove?( sprite?:any, destroySprite?:any ): void; /** [Method] Renders a single sprite into the surface * @param sprite Ext.draw.sprite.Sprite The Sprite to be rendered. + * @returns Boolean returns false to stop the rendering to continue. */ renderSprite?( sprite?:Ext.draw.sprite.ISprite ): boolean; /** [Method] Sets the value of highPrecision @@ -23245,6 +25529,7 @@ declare module Ext.draw.engine { * @param y0 Object * @param x1 Object * @param y1 Object + * @returns Ext.draw.engine.SvgContext.Gradient */ createLinearGradient?( x0?:any, y0?:any, x1?:any, y1?:any ): Ext.draw.engine.svgcontext.IGradient; /** [Method] Returns a CanvasGradient object that represents a radial gradient that paints along the cone given by the circles rep @@ -23254,6 +25539,7 @@ declare module Ext.draw.engine { * @param x1 Object * @param y1 Object * @param r1 Object + * @returns Ext.draw.engine.SvgContext.Gradient */ createRadialGradient?( x0?:any, y0?:any, r0?:any, x1?:any, y1?:any, r1?:any ): Ext.draw.engine.svgcontext.IGradient; /** [Method] Draws the given image onto the canvas @@ -23362,9 +25648,12 @@ declare module Ext.draw.gradient { /** [Method] Generates the gradient for the given context * @param ctx Object The context. * @param bbox Object + * @returns Object */ generateGradient?( ctx?:any, bbox?:any ): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ getId?(): string; } } @@ -23375,6 +25664,7 @@ declare module Ext.draw.gradient { /** [Method] Generates the gradient for the given context * @param ctx Object The context. * @param bbox Object + * @returns Object */ generateGradient?( ctx?:any, bbox?:any ): any; } @@ -23388,11 +25678,16 @@ declare module Ext.draw.gradient { /** [Method] Generates the gradient for the given context * @param ctx Object The context. * @param bbox Object + * @returns Object */ generateGradient?( ctx?:any, bbox?:any ): any; - /** [Method] Returns the value of end */ + /** [Method] Returns the value of end + * @returns Object + */ getEnd?(): any; - /** [Method] Returns the value of start */ + /** [Method] Returns the value of start + * @returns Object + */ getStart?(): any; /** [Method] Sets the value of end * @param end Object @@ -23416,22 +25711,18 @@ declare module Ext.draw { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Add a list of sprites to group * @param sprites Array|Ext.draw.sprite.Sprite */ - addAll?( sprites?:any ): any; - addAll?( sprites?:any[] ): void; - addAll?( sprites?:Ext.draw.sprite.ISprite ): void; + addAll?( sprites?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -23443,9 +25734,7 @@ declare module Ext.draw { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -23453,9 +25742,7 @@ declare module Ext.draw { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Clear the group * @param destroySprite Boolean */ @@ -23471,43 +25758,50 @@ declare module Ext.draw { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Get the sprite with id or index * @param id String|Number + * @returns Ext.draw.sprite.Sprite */ - get?( id?:any ): any; - get?( id?:string ): Ext.draw.sprite.ISprite; - get?( id?:number ): Ext.draw.sprite.ISprite; + get?( id?:any ): Ext.draw.sprite.ISprite; /** [Method] Get the i th sprite of the group * @param index Number + * @returns Ext.draw.sprite.Sprite */ getAt?( index?:number ): Ext.draw.sprite.ISprite; /** [Method] Return the minimal bounding box that contains all the sprites bounding boxes in this group * @param isWithTransform Object */ getBBox?( isWithTransform?:any ): void; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of surface */ + /** [Method] Returns the value of surface + * @returns Object + */ getSurface?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Hide all sprites in the group @@ -23521,18 +25815,14 @@ declare module Ext.draw { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -23540,28 +25830,25 @@ declare module Ext.draw { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Remote sprite from group @@ -23575,16 +25862,14 @@ declare module Ext.draw { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -23592,18 +25877,14 @@ declare module Ext.draw { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -23615,9 +25896,7 @@ declare module Ext.draw { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Set dirty flag for all sprites in the group */ setDirty?(): void; /** [Method] Sets the value of listeners @@ -23641,25 +25920,21 @@ declare module Ext.draw { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.draw { @@ -23675,16 +25950,24 @@ declare module Ext.draw { /** [Method] Get a cached object * @param id String * @param args Mixed... Arguments appended to feeder. + * @returns Object */ get?( id:string, ...args:any[] ): any; - /** [Method] Returns the value of feeder */ + /** [Method] Returns the value of feeder + * @returns Function + */ getFeeder?(): any; - /** [Method] Returns the value of limit */ + /** [Method] Returns the value of limit + * @returns Number + */ getLimit?(): number; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; /** [Method] Sets the value of feeder * @param feeder Function + * @returns Number */ setFeeder?( feeder?:any ): number; /** [Method] Sets the value of limit @@ -23708,46 +25991,75 @@ declare module Ext.draw { * @param yy Object Coefficient from y to y. * @param dx Object Offset of x. * @param dy Object Offset of y. + * @returns Ext.draw.Matrix this */ append?( xx?:any, xy?:any, yx?:any, yy?:any, dx?:any, dy?:any ): Ext.draw.IMatrix; /** [Method] Postpend a matrix onto the current * @param matrix Ext.draw.Matrix + * @returns Ext.draw.Matrix this */ appendMatrix?( matrix?:Ext.draw.IMatrix ): Ext.draw.IMatrix; - /** [Method] Clone this matrix */ + /** [Method] Clone this matrix + * @returns Ext.draw.Matrix + */ clone?(): Ext.draw.IMatrix; /** [Method] Determines if this matrix has the same values as another matrix * @param matrix Ext.draw.Matrix + * @returns Boolean */ equals?( matrix?:Ext.draw.IMatrix ): boolean; - /** [Method] Horizontally flip the matrix */ + /** [Method] Horizontally flip the matrix + * @returns Ext.draw.Matrix this + */ flipX?(): Ext.draw.IMatrix; - /** [Method] Vertically flip the matrix */ + /** [Method] Vertically flip the matrix + * @returns Ext.draw.Matrix this + */ flipY?(): Ext.draw.IMatrix; - /** [Method] Get offset x component of the matrix */ + /** [Method] Get offset x component of the matrix + * @returns Number + */ getDX?(): number; - /** [Method] Get offset y component of the matrix */ + /** [Method] Get offset y component of the matrix + * @returns Number + */ getDY?(): number; - /** [Method] Get the x scale of the matrix */ + /** [Method] Get the x scale of the matrix + * @returns Number + */ getScaleX?(): number; - /** [Method] Get the y scale of the matrix */ + /** [Method] Get the y scale of the matrix + * @returns Number + */ getScaleY?(): number; - /** [Method] Get x to x component of the matrix */ + /** [Method] Get x to x component of the matrix + * @returns Number + */ getXX?(): number; - /** [Method] Get x to y component of the matrix */ + /** [Method] Get x to y component of the matrix + * @returns Number + */ getXY?(): number; - /** [Method] Get y to x component of the matrix */ + /** [Method] Get y to x component of the matrix + * @returns Number + */ getYX?(): number; - /** [Method] Get y to y component of the matrix */ + /** [Method] Get y to y component of the matrix + * @returns Number + */ getYY?(): number; /** [Method] Return a new matrix represents the opposite transformation of the current one * @param target Ext.draw.Matrix A target matrix. If present, it will receive the result of inversion to avoid creating a new object. + * @returns Ext.draw.Matrix */ inverse?( target?:Ext.draw.IMatrix ): Ext.draw.IMatrix; - /** [Method] Determines whether this matrix is an identity matrix no transform */ + /** [Method] Determines whether this matrix is an identity matrix no transform + * @returns Boolean + */ isIdentity?(): boolean; /** [Method] Postpend a matrix onto the current * @param matrix Ext.draw.Matrix + * @returns Ext.draw.Matrix this */ multiply?( matrix?:Ext.draw.IMatrix ): Ext.draw.IMatrix; /** [Method] Prepend a matrix onto the current @@ -23757,29 +26069,31 @@ declare module Ext.draw { * @param yy Object Coefficient from y to y. * @param dx Object Offset of x. * @param dy Object Offset of y. + * @returns Ext.draw.Matrix this */ prepend?( xx?:any, xy?:any, yx?:any, yy?:any, dx?:any, dy?:any ): Ext.draw.IMatrix; /** [Method] Prepend a matrix onto the current * @param matrix Ext.draw.Matrix + * @returns Ext.draw.Matrix this */ prependMatrix?( matrix?:Ext.draw.IMatrix ): Ext.draw.IMatrix; - /** [Method] Reset the matrix to identical */ + /** [Method] Reset the matrix to identical + * @returns Ext.draw.Matrix this + */ reset?(): Ext.draw.IMatrix; /** [Method] Rotate the matrix * @param angle Number Radians to rotate * @param rcx Number|null Center of rotation. * @param rcy Number|null Center of rotation. * @param prepend Boolean If true, this will transformation be prepended to the matrix. + * @returns Ext.draw.Matrix this */ - rotate?( angle?:any, rcx?:any, rcy?:any, prepend?:any ): any; - rotate?( angle?:number, rcx?:number, rcy?:number, prepend?:boolean ): Ext.draw.IMatrix; - rotate?( angle?:number, rcx?:any, rcy?:number, prepend?:boolean ): Ext.draw.IMatrix; - rotate?( angle?:number, rcx?:number, rcy?:any, prepend?:boolean ): Ext.draw.IMatrix; rotate?( angle?:number, rcx?:any, rcy?:any, prepend?:boolean ): Ext.draw.IMatrix; /** [Method] Rotate the matrix by the angle of a vector * @param x Number * @param y Number * @param prepend Boolean If true, this will transformation be prepended to the matrix. + * @returns Ext.draw.Matrix this */ rotateFromVector?( x?:number, y?:number, prepend?:boolean ): Ext.draw.IMatrix; /** [Method] Scale the matrix @@ -23788,6 +26102,7 @@ declare module Ext.draw { * @param scx Number * @param scy Number * @param prepend Boolean If true, this will transformation be prepended to the matrix. + * @returns Ext.draw.Matrix this */ scale?( sx?:number, sy?:number, scx?:number, scy?:number, prepend?:boolean ): Ext.draw.IMatrix; /** [Method] Set the elements of a Matrix @@ -23797,58 +26112,78 @@ declare module Ext.draw { * @param yy Number * @param dx Number * @param dy Number + * @returns Ext.draw.Matrix this */ set?( xx?:number, xy?:number, yx?:number, yy?:number, dx?:number, dy?:number ): Ext.draw.IMatrix; /** [Method] Skew the matrix * @param angle Number + * @returns Ext.draw.Matrix this */ skewX?( angle?:number ): Ext.draw.IMatrix; /** [Method] Skew the matrix * @param angle Number + * @returns Ext.draw.Matrix this */ skewY?( angle?:number ): Ext.draw.IMatrix; - /** [Method] Split matrix into Translate Scale Shear and Rotate */ + /** [Method] Split matrix into Translate Scale Shear and Rotate + * @returns Object + */ split?(): any; - /** [Method] Create an array of elements by horizontal order xx yx dx yx yy dy */ + /** [Method] Create an array of elements by horizontal order xx yx dx yx yy dy + * @returns Array + */ toArray?(): any[]; /** [Method] Apply the matrix to a drawing context * @param ctx Object + * @returns Ext.draw.Matrix this */ toContext?( ctx?:any ): Ext.draw.IMatrix; - /** [Method] Get an array of elements */ + /** [Method] Get an array of elements + * @returns Array + */ toString?(): any[]; - /** [Method] Return a string that can be used as transform attribute in SVG */ + /** [Method] Return a string that can be used as transform attribute in SVG + * @returns String + */ toSvg?(): string; - /** [Method] Create an array of elements by vertical order xx xy yx yy dx dy */ + /** [Method] Create an array of elements by vertical order xx xy yx yy dx dy + * @returns Array|String + */ toVerticalArray?(): any; /** [Method] * @param bbox Object Given as {x: Number, y: Number, width: Number, height: Number}. * @param radius Number * @param target Object Optional target object to recieve the result. Recommanded to use it for better gc. + * @returns Object Object with x, y, width and height. */ transformBBox?( bbox?:any, radius?:number, target?:any ): any; /** [Method] Transform a list for points * @param list Array + * @returns Array list */ transformList?( list?:any[] ): any[]; /** [Method] Transform a point to a new array * @param point Array + * @returns Array */ transformPoint?( point?:any[] ): any[]; /** [Method] Translate the matrix * @param x Number * @param y Number * @param prepend Boolean If true, this will transformation be prepended to the matrix. + * @returns Ext.draw.Matrix this */ translate?( x?:number, y?:number, prepend?:boolean ): Ext.draw.IMatrix; /** [Method] Transform point returning the x component of the result * @param x Number * @param y Number + * @returns Number x component of the result. */ x?( x?:number, y?:number ): number; /** [Method] Transform point returning the y component of the result * @param x Number * @param y Number + * @returns Number y component of the result. */ y?( x?:number, y?:number ): number; } @@ -23859,6 +26194,7 @@ declare module Ext.draw { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] @@ -23867,6 +26203,7 @@ declare module Ext.draw { static callParent( args?:any ): void; /** [Method] Create a matrix from mat * @param mat Mixed + * @returns Ext.draw.Matrix */ static create( mat?:any ): Ext.draw.IMatrix; /** [Method] Return the affine matrix that transform two points x0 y0 and x1 y1 to x0p y0p and x1p y1p @@ -23898,12 +26235,16 @@ declare module Ext.draw { static createPanZoomFromTwoPair( x0?:any, y0?:any, x1?:any, y1?:any, x0p?:any, y0p?:any, x1p?:any, y1p?:any ): void; /** [Method] Create a flyweight to wrap the given array * @param elements Array + * @returns Ext.draw.Matrix */ static fly( elements?:any[] ): Ext.draw.IMatrix; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -23924,16 +26265,14 @@ declare module Ext.draw.modifier { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -23945,9 +26284,7 @@ declare module Ext.draw.modifier { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -23955,9 +26292,7 @@ declare module Ext.draw.modifier { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Remove special easings on the given attributes * @param attrs Object The source attributes. */ @@ -23973,35 +26308,48 @@ declare module Ext.draw.modifier { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of customDuration */ + /** [Method] Returns the value of customDuration + * @returns Object + */ getCustomDuration?(): any; - /** [Method] Returns the value of customEasings */ + /** [Method] Returns the value of customEasings + * @returns Object + */ getCustomEasings?(): any; - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns Function + */ getEasing?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -24011,18 +26359,14 @@ declare module Ext.draw.modifier { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -24030,25 +26374,21 @@ declare module Ext.draw.modifier { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Invoked when changes need to be popped up to the top * @param attributes Object The source attributes. * @param changes Object The changes to be popped up. @@ -24061,11 +26401,13 @@ declare module Ext.draw.modifier { /** [Method] Invoked when changes need to pushed down to the sprite * @param attr Object The source attributes. * @param changes Object The changes to make. This object might be changed unexpectedly inside the method. + * @returns Mixed */ pushDown?( attr?:any, changes?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -24074,16 +26416,14 @@ declare module Ext.draw.modifier { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -24091,18 +26431,14 @@ declare module Ext.draw.modifier { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -24110,9 +26446,7 @@ declare module Ext.draw.modifier { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of customDuration * @param customDuration Object */ @@ -24154,25 +26488,21 @@ declare module Ext.draw.modifier { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.draw.modifier { @@ -24184,11 +26514,16 @@ declare module Ext.draw.modifier { /** [Method] Filter modifier changes if overriding source attributes * @param attr Object The source attributes. * @param changes Object The modifier changes. + * @returns * The filtered changes. */ filterChanges?( attr?:any, changes?:any ): any; - /** [Method] Returns the value of enabled */ + /** [Method] Returns the value of enabled + * @returns Boolean + */ getEnabled?(): boolean; - /** [Method] Returns the value of highlightStyle */ + /** [Method] Returns the value of highlightStyle + * @returns Object + */ getHighlightStyle?(): any; /** [Method] Invoked when changes need to be popped up to the top * @param attributes Object The source attributes. @@ -24202,6 +26537,7 @@ declare module Ext.draw.modifier { /** [Method] Invoked when changes need to pushed down to the sprite * @param attr Object The source attributes. * @param changes Object The changes to make. This object might be changed unexpectedly inside the method. + * @returns Mixed */ pushDown?( attr?:any, changes?:any ): any; /** [Method] Sets the value of enabled @@ -24222,11 +26558,17 @@ declare module Ext.draw.modifier { previous?: Ext.draw.modifier.IModifier; /** [Config Option] (Ext.draw.sprite.Sprite) */ sprite?: Ext.draw.sprite.ISprite; - /** [Method] Returns the value of next */ + /** [Method] Returns the value of next + * @returns Ext.draw.modifier.Modifier + */ getNext?(): Ext.draw.modifier.IModifier; - /** [Method] Returns the value of previous */ + /** [Method] Returns the value of previous + * @returns Ext.draw.modifier.Modifier + */ getPrevious?(): Ext.draw.modifier.IModifier; - /** [Method] Returns the value of sprite */ + /** [Method] Returns the value of sprite + * @returns Ext.draw.sprite.Sprite + */ getSprite?(): Ext.draw.sprite.ISprite; /** [Method] Invoked when changes need to be popped up to the top * @param attributes Object The source attributes. @@ -24240,6 +26582,7 @@ declare module Ext.draw.modifier { /** [Method] Invoked when changes need to pushed down to the sprite * @param attr Object The source attributes. * @param changes Object The changes to make. This object might be changed unexpectedly inside the method. + * @returns Mixed */ pushDown?( attr?:any, changes?:any ): any; /** [Method] Sets the value of next @@ -24270,6 +26613,7 @@ declare module Ext.draw.modifier { /** [Method] Invoked when changes need to pushed down to the sprite * @param attr Object The source attributes. * @param changes Object The changes to make. This object might be changed unexpectedly inside the method. + * @returns Mixed */ pushDown?( attr?:any, changes?:any ): any; } @@ -24316,7 +26660,9 @@ declare module Ext.draw { bezierCurveTo?( cx1?:number, cy1?:number, cx2?:number, cy2?:number, x?:number, y?:number ): void; /** [Method] Clear the path */ clear?(): void; - /** [Method] Clone this path */ + /** [Method] Clone this path + * @returns Ext.draw.Path + */ clone?(): Ext.draw.IPath; /** [Method] Close this path with a straight line */ closePath?(): void; @@ -24341,16 +26687,19 @@ declare module Ext.draw { fromSvgString?( pathString?:any ): void; /** [Method] Get the bounding box of this matrix * @param target Object Optional object to receive the result. + * @returns Object Object with x, y, width and height */ getDimension?( target?:any ): any; /** [Method] Get the bounding box as if the path is transformed by a matrix * @param matrix Ext.draw.Matrix * @param target Object Optional object to receive the result. + * @returns Object An object with x, y, width and height. */ getDimensionWithTransform?( matrix?:Ext.draw.IMatrix, target?:any ): any; /** [Method] Test wether the given point is on or inside the path * @param x Object * @param y Object + * @returns Boolean */ isPointInPath?( x?:any, y?:any ): boolean; /** [Method] A straight line to a position @@ -24377,10 +26726,13 @@ declare module Ext.draw { * @param height Object */ rect?( x?:any, y?:any, width?:any, height?:any ): void; - /** [Method] Return an svg path string for this path */ + /** [Method] Return an svg path string for this path + * @returns String + */ toString?(): string; /** [Method] Convert path to bezier curve stripes * @param target Array The optional array to receive the result. + * @returns Array */ toStripes?( target?:any[] ): any[]; /** [Method] Transform the current path by a matrix @@ -24395,9 +26747,12 @@ declare module Ext.draw { * @param min Number * @param max Number * @param estStep Number + * @returns Object The aggregation information. */ getAggregation?( min?:number, max?:number, estStep?:number ): any; - /** [Method] Returns the value of strategy */ + /** [Method] Returns the value of strategy + * @returns String + */ getStrategy?(): string; /** [Method] Sets the data of the segment tree * @param dataX Object @@ -24419,19 +26774,19 @@ declare module Ext.draw { export class Solver { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the function f x a x3 b x2 c x d and solver for f x y * @param a Object * @param b Object @@ -24447,10 +26802,12 @@ declare module Ext.draw { static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Returns the function f x a x b and solver for f x y @@ -24464,7 +26821,9 @@ declare module Ext.draw { * @param c Object */ static quadraticFunction( a?:any, b?:any, c?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -24474,30 +26833,34 @@ declare module Ext.draw.sprite { export class AnimationParser { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -24530,18 +26893,29 @@ declare module Ext.draw.sprite { processors?: any; /** [Config Option] (Object) */ updaters?: any; - /** [Method] Returns the value of aliases */ + /** [Method] Returns the value of aliases + * @returns Object + */ getAliases?(): any; - /** [Method] Returns the value of animationProcessors */ + /** [Method] Returns the value of animationProcessors + * @returns Object + */ getAnimationProcessors?(): any; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ getDefaults?(): any; - /** [Method] Returns the value of processors */ + /** [Method] Returns the value of processors + * @returns Object + */ getProcessors?(): any; - /** [Method] Returns the value of updaters */ + /** [Method] Returns the value of updaters + * @returns Object + */ getUpdaters?(): any; /** [Method] Normalizes the changes given via their processors before they are applied as attributes * @param changes Object The changes given. + * @returns Object The normalized values. */ normalize?( changes?:any ): any; /** [Method] Sets the value of aliases @@ -24572,30 +26946,34 @@ declare module Ext.draw.sprite { export class AttributeParser { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -24689,6 +27067,7 @@ declare module Ext.draw.sprite { /** [Method] Render method * @param surface Object * @param ctx Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any ): any; } @@ -24702,24 +27081,31 @@ declare module Ext.draw.sprite { * @param data Object * @param bypassNormalization Boolean 'true' to bypass attribute normalization. * @param avoidCopy Boolean 'true' to avoid copying. + * @returns Object The attributes of the instance. */ createInstance?( config?:any, data?:any, bypassNormalization?:boolean, avoidCopy?:boolean ): any; /** [Method] Removes the sprite and clears all listeners */ destroy?(): void; - /** [Method] Not supported */ + /** [Method] Not supported + * @returns null + */ getBBox?(): any; /** [Method] Returns the bounding box for the instance at the given index * @param index Number The index of the instance. * @param isWithoutTransform Boolean 'true' to not apply sprite transforms to the bounding box. + * @returns Object The bounding box for the instance. */ getBBoxFor?( index?:number, isWithoutTransform?:boolean ): any; - /** [Method] Returns the value of template */ + /** [Method] Returns the value of template + * @returns Object + */ getTemplate?(): any; /** [Method] Render method * @param surface Object * @param ctx Object * @param clipRegion Object * @param region Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any, region?:any ): any; /** [Method] Sets the attributes for the instance at the given index @@ -24741,6 +27127,7 @@ declare module Ext.draw.sprite { /** [Method] Render method * @param surface Object * @param ctx Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any ): any; /** [Method] Update the path @@ -24869,16 +27256,14 @@ declare module Ext.draw.sprite { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -24890,9 +27275,7 @@ declare module Ext.draw.sprite { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -24900,9 +27283,7 @@ declare module Ext.draw.sprite { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] Removes the sprite and clears all listeners */ @@ -24910,19 +27291,19 @@ declare module Ext.draw.sprite { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Returns the bounding box for the given Sprite as calculated with the Canvas engine @@ -24931,19 +27312,29 @@ declare module Ext.draw.sprite { getBBox?( isWithoutTransform?:boolean ): void; /** [Method] Subclass can rewrite this function to gain better performance * @param isWithoutTransform Boolean + * @returns Array */ getBBoxCenter?( isWithoutTransform?:boolean ): any[]; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of parent */ + /** [Method] Returns the value of parent + * @returns Object + */ getParent?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; - /** [Method] Hide the sprite */ + /** [Method] Hide the sprite + * @returns Ext.draw.sprite.Sprite this + */ hide?(): Ext.draw.sprite.ISprite; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -24952,18 +27343,14 @@ declare module Ext.draw.sprite { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -24971,30 +27358,27 @@ declare module Ext.draw.sprite { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Called before rendering */ preRender?(): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -25003,16 +27387,14 @@ declare module Ext.draw.sprite { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -25020,22 +27402,19 @@ declare module Ext.draw.sprite { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Render method * @param surface Ext.draw.Surface The surface. * @param ctx Object A context object compatible with CanvasRenderingContext2D. * @param region Array The clip region (or called dirty rect) of the current rendering. Not be confused with surface.getRegion(). + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:Ext.draw.ISurface, ctx?:any, region?:any[] ): any; /** [Method] Resumes firing events see suspendEvents @@ -25056,9 +27435,7 @@ declare module Ext.draw.sprite { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -25067,7 +27444,9 @@ declare module Ext.draw.sprite { * @param parent Object */ setParent?( parent?:any ): void; - /** [Method] Show the sprite */ + /** [Method] Show the sprite + * @returns Ext.draw.sprite.Sprite this + */ show?(): Ext.draw.sprite.ISprite; /** [Method] Suspends the firing of all events */ suspendEvents?(): void; @@ -25078,25 +27457,21 @@ declare module Ext.draw.sprite { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Subclass will fill the plain object with x y width height information of the plain bounding box of this sprite * @param plain Object Target object. */ @@ -25135,6 +27510,7 @@ declare module Ext.draw.sprite { /** [Method] Render method * @param surface Object * @param ctx Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any ): any; /** [Method] Subclass will fill the plain object with x y width height information of the plain bounding box of this sprite @@ -25166,21 +27542,33 @@ declare module Ext.draw { /** [Method] * @param sprite Object * @param isWithoutTransform Object + * @returns Object */ getBBox?( sprite?:any, isWithoutTransform?:any ): any; - /** [Method] Returns the value of background */ + /** [Method] Returns the value of background + * @returns Object + */ getBackground?(): any; - /** [Method] Returns true if the surface is dirty */ + /** [Method] Returns true if the surface is dirty + * @returns Boolean 'true' if the surface is dirty + */ getDirty?(): boolean; /** [Method] * @param id String The unique identifier of the group. + * @returns Ext.draw.Group The group. */ getGroup?( id?:string ): Ext.draw.IGroup; - /** [Method] Returns the value of groups */ + /** [Method] Returns the value of groups + * @returns Array + */ getGroups?(): any[]; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Ext.draw.Group + */ getItems?(): Ext.draw.IGroup; - /** [Method] Returns the value of region */ + /** [Method] Returns the value of region + * @returns Array + */ getRegion?(): any[]; /** [Method] Invoked when a sprite is adding to the surface * @param sprite Ext.draw.sprite.Sprite The sprite to be added. @@ -25201,6 +27589,7 @@ declare module Ext.draw { resetTransform?(): void; /** [Method] Round the number to align to the pixels on device * @param num Object The number to align. + * @returns Number The resultant alignment. */ roundPixel?( num?:any ): number; /** [Method] Sets the value of background @@ -25231,23 +27620,29 @@ declare module Ext.draw { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] * @param args Object */ static callParent( args?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter * @param origin String/Object The original method name */ static createAlias( alias?:any, origin?:any ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Stably sort the list of sprites by their zIndex @@ -25262,40 +27657,46 @@ declare module Ext.draw { export class TextMeasurer { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Measure a text with specific font * @param text String * @param font String + * @returns Object An object with width and height properties. */ static measureText( text?:string, font?:string ): any; /** [Method] Measure a single line text with specific font * @param text String * @param font String + * @returns Object An object with width and height properties. */ static measureTextSingleLine( text?:string, font?:string ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -25305,30 +27706,34 @@ declare module Ext.draw { export class TimingFunctions { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -25350,6 +27755,7 @@ declare module Ext.env { version?: Ext.IVersion; /** [Method] A hybrid property can be either accessed as a method call for example if Ext browser is IE * @param value String The OS name to check. + * @returns Boolean */ is?( value?:string ): boolean; } @@ -25366,6 +27772,7 @@ declare module Ext.env { version?: Ext.IVersion; /** [Method] A hybrid property can be either accessed as a method call i e if Ext os is Android * @param value String The OS name to check. + * @returns Boolean */ is?( value?:string ): boolean; } @@ -25376,7 +27783,9 @@ declare module Ext.event { } declare module Ext.event { export interface IDispatcher extends Ext.IBase { - /** [Method] Returns the value of publishers */ + /** [Method] Returns the value of publishers + * @returns Object + */ getPublishers?(): any; /** [Method] Sets the value of publishers * @param publishers Object @@ -25394,21 +27803,28 @@ declare module Ext.event { pageY?: number; /** [Property] (HTMLElement) */ target?: HTMLElement; - /** [Method] Gets the x coordinate of the event */ + /** [Method] Gets the x coordinate of the event + * @returns Number + */ getPageX?(): number; - /** [Method] Gets the y coordinate of the event */ + /** [Method] Gets the y coordinate of the event + * @returns Number + */ getPageY?(): number; /** [Method] Gets the target for the event * @param selector String A simple selector to filter the target or look for an ancestor of the target * @param maxDepth Number/Mixed The max depth to search as a number or element (defaults to 10 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement */ - getTarget?( selector?:any, maxDepth?:any, returnEl?:any ): any; - getTarget?( selector?:string, maxDepth?:number, returnEl?:boolean ): HTMLElement; getTarget?( selector?:string, maxDepth?:any, returnEl?:boolean ): HTMLElement; - /** [Method] Returns the time of the event */ + /** [Method] Returns the time of the event + * @returns Date + */ getTime?(): any; - /** [Method] Gets the X and Y coordinates of the event */ + /** [Method] Gets the X and Y coordinates of the event + * @returns Array + */ getXY?(): any[]; /** [Method] Prevents the browsers default handling of the event */ preventDefault?(): void; @@ -25426,9 +27842,13 @@ declare module Ext.event { rotation?: number; /** [Property] (Number) */ scale?: number; - /** [Method] Stop the event preventDefault and stopPropagation */ + /** [Method] Stop the event preventDefault and stopPropagation + * @returns Ext.event.Event this + */ stopEvent?(): Ext.event.IEvent; - /** [Method] Cancels bubbling of the event */ + /** [Method] Cancels bubbling of the event + * @returns Ext.event.Event this + */ stopPropagation?(): Ext.event.IEvent; } } @@ -25444,9 +27864,13 @@ declare module Ext { rotation?: number; /** [Property] (Number) */ scale?: number; - /** [Method] Stop the event preventDefault and stopPropagation */ + /** [Method] Stop the event preventDefault and stopPropagation + * @returns Ext.event.Event this + */ stopEvent?(): Ext.event.IEvent; - /** [Method] Cancels bubbling of the event */ + /** [Method] Cancels bubbling of the event + * @returns Ext.event.Event this + */ stopPropagation?(): Ext.event.IEvent; } } @@ -25484,9 +27908,13 @@ declare module Ext.event.publisher { } declare module Ext.event.publisher { export interface ITouchGesture extends Ext.event.publisher.IDom { - /** [Method] Returns the value of moveThrottle */ + /** [Method] Returns the value of moveThrottle + * @returns Number + */ getMoveThrottle?(): number; - /** [Method] Returns the value of recognizers */ + /** [Method] Returns the value of recognizers + * @returns Object + */ getRecognizers?(): any; /** [Method] Sets the value of moveThrottle * @param moveThrottle Number @@ -25500,7 +27928,9 @@ declare module Ext.event.publisher { } declare module Ext.event.recognizer { export interface IDoubleTap extends Ext.event.recognizer.ISingleTouch { - /** [Method] Returns the value of maxDuration */ + /** [Method] Returns the value of maxDuration + * @returns Number + */ getMaxDuration?(): number; /** [Method] Sets the value of maxDuration * @param maxDuration Number @@ -25512,7 +27942,9 @@ declare module Ext.event.recognizer { export interface IDrag extends Ext.event.recognizer.ISingleTouch { /** [Config Option] (Number) */ minDistance?: number; - /** [Method] Returns the value of minDistance */ + /** [Method] Returns the value of minDistance + * @returns Number + */ getMinDistance?(): number; /** [Method] Sets the value of minDistance * @param minDistance Number @@ -25526,7 +27958,9 @@ declare module Ext.event.recognizer { } declare module Ext.event.recognizer { export interface ILongPress extends Ext.event.recognizer.ISingleTouch { - /** [Method] Returns the value of minDuration */ + /** [Method] Returns the value of minDuration + * @returns Number + */ getMinDuration?(): number; /** [Method] Sets the value of minDuration * @param minDuration Number @@ -25544,13 +27978,21 @@ declare module Ext.event.recognizer { } declare module Ext.event.recognizer { export interface IRecognizer extends Ext.IBase,Ext.mixin.IIdentifiable { - /** [Method] Returns the value of callbackScope */ + /** [Method] Returns the value of callbackScope + * @returns Object + */ getCallbackScope?(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ getId?(): string; - /** [Method] Returns the value of onFailed */ + /** [Method] Returns the value of onFailed + * @returns Object + */ getOnFailed?(): any; - /** [Method] Returns the value of onRecognized */ + /** [Method] Returns the value of onRecognized + * @returns Object + */ getOnRecognized?(): any; /** [Method] Sets the value of callbackScope * @param callbackScope Object @@ -25576,11 +28018,17 @@ declare module Ext.event.recognizer { } declare module Ext.event.recognizer { export interface ISwipe extends Ext.event.recognizer.ISingleTouch { - /** [Method] Returns the value of maxDuration */ + /** [Method] Returns the value of maxDuration + * @returns Number + */ getMaxDuration?(): number; - /** [Method] Returns the value of maxOffset */ + /** [Method] Returns the value of maxOffset + * @returns Number + */ getMaxOffset?(): number; - /** [Method] Returns the value of minDistance */ + /** [Method] Returns the value of minDistance + * @returns Number + */ getMinDistance?(): number; /** [Method] Sets the value of maxDuration * @param maxDuration Number @@ -25600,7 +28048,9 @@ declare module Ext.event.recognizer { export interface ITap extends Ext.event.recognizer.ISingleTouch { /** [Config Option] (Number) */ moveDistance?: number; - /** [Method] Returns the value of moveDistance */ + /** [Method] Returns the value of moveDistance + * @returns Number + */ getMoveDistance?(): number; /** [Method] Sets the value of moveDistance * @param moveDistance Number @@ -25628,16 +28078,14 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -25649,9 +28097,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -25659,9 +28105,7 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -25669,27 +28113,32 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -25699,18 +28148,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -25718,28 +28163,25 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -25748,16 +28190,14 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -25765,18 +28205,14 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -25784,9 +28220,7 @@ declare module Ext { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -25800,25 +28234,21 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext { @@ -25829,16 +28259,14 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -25850,9 +28278,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -25860,9 +28286,7 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -25870,27 +28294,32 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -25900,18 +28329,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -25919,28 +28344,25 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -25949,16 +28371,14 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -25966,18 +28386,14 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -25985,9 +28401,7 @@ declare module Ext { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -26001,25 +28415,21 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext { @@ -26033,9 +28443,7 @@ declare module Ext { * @param scope Object The scope (this reference) in which the handler function is executed. Defaults to the Element. * @param options Object An object containing handler configuration properties. This may contain any of the following properties: */ - static addListener( el?:any, eventName?:any, handler?:any, scope?:any, options?:any ): any; - static addListener( el?:string, eventName?:string, handler?:any, scope?:any, options?:any ): void; - static addListener( el?:HTMLElement, eventName?:string, handler?:any, scope?:any, options?:any ): void; + static addListener( el?:any, eventName?:string, handler?:any, scope?:any, options?:any ): void; /** [Method] Appends an event handler to an element * @param el String/HTMLElement The html element or id to assign the event handler to. * @param eventName String The name of the event to listen for. @@ -26043,9 +28451,7 @@ declare module Ext { * @param scope Object (this reference) in which the handler function executes. Defaults to the Element. * @param options Object An object containing standard addListener options */ - static on( el?:any, eventName?:any, handler?:any, scope?:any, options?:any ): any; - static on( el?:string, eventName?:string, handler?:any, scope?:any, options?:any ): void; - static on( el?:HTMLElement, eventName?:string, handler?:any, scope?:any, options?:any ): void; + static on( el?:any, eventName?:string, handler?:any, scope?:any, options?:any ): void; /** [Method] Adds a listener to be notified when the document is ready before onload and before images are loaded */ static onDocumentReady(): void; /** [Method] Adds a listener to be notified when the browser window is resized and provides resize event buffering 50 millisecond @@ -26057,27 +28463,21 @@ declare module Ext { /** [Method] Removes all event handers from an element * @param el String/HTMLElement The id or html element from which to remove all event handlers. */ - static removeAll( el?:any ): any; - static removeAll( el?:string ): void; - static removeAll( el?:HTMLElement ): void; + static removeAll( el?:any ): void; /** [Method] Removes an event handler from an element * @param el String/HTMLElement The id or html element from which to remove the listener. * @param eventName String The name of the event. * @param fn Function The handler function to remove. This must be a reference to the function passed into the addListener call. * @param scope Object If a scope (this reference) was specified when the listener was added, then this must refer to the same object. */ - static removeListener( el?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeListener( el?:string, eventName?:string, fn?:any, scope?:any ): void; - static removeListener( el?:HTMLElement, eventName?:string, fn?:any, scope?:any ): void; + static removeListener( el?:any, eventName?:string, fn?:any, scope?:any ): void; /** [Method] Removes an event handler from an element * @param el String/HTMLElement The id or html element from which to remove the listener. * @param eventName String The name of the event. * @param fn Function The handler function to remove. This must be a reference to the function passed into the on call. * @param scope Object If a scope (this reference) was specified when the listener was added, then this must refer to the same object. */ - static un( el?:any, eventName?:any, fn?:any, scope?:any ): any; - static un( el?:string, eventName?:string, fn?:any, scope?:any ): void; - static un( el?:HTMLElement, eventName?:string, fn?:any, scope?:any ): void; + static un( el?:any, eventName?:string, fn?:any, scope?:any ): void; } } declare module Ext { @@ -26086,34 +28486,39 @@ declare module Ext { export class Feature { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Verifies if a browser feature exists or not on the current device * @param value String The feature name to check. + * @returns Boolean */ static has( value?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -26127,29 +28532,49 @@ declare module Ext.field { ui?: string; /** [Config Option] (String) */ value?: string; - /** [Method] Set the checked state of the checkbox to true */ + /** [Method] Set the checked state of the checkbox to true + * @returns Ext.field.Checkbox This checkbox. + */ check?(): Ext.field.ICheckbox; /** [Method] Method called when this Ext field Checkbox has been checked */ doChecked?(): void; /** [Method] Method called when this Ext field Checkbox has been unchecked */ doUnChecked?(): void; - /** [Method] Returns the field checked value */ + /** [Method] Returns the field checked value + * @returns Mixed The field value. + */ getChecked?(): any; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns an array of values from the checkboxes in the group that are checked */ + /** [Method] Returns an array of values from the checkboxes in the group that are checked + * @returns Array + */ getGroupValues?(): any[]; - /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ + /** [Method] Returns the submit value for the checkbox which can be used when submitting forms + * @returns Boolean/String value The value of value or true, if checked. + */ getSubmitValue?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns String + */ getValue?(): string; - /** [Method] Returns the checked state of the checkbox */ + /** [Method] Returns the checked state of the checkbox + * @returns Boolean true if checked, false otherwise. + */ isChecked?(): boolean; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; - /** [Method] Resets the status of all matched checkboxes in the same group to checked */ + /** [Method] Resets the status of all matched checkboxes in the same group to checked + * @returns Ext.field.Checkbox This checkbox. + */ resetGroupValues?(): Ext.field.ICheckbox; /** [Method] Sets the value of component * @param component Object @@ -26157,6 +28582,7 @@ declare module Ext.field { setComponent?( component?:any ): void; /** [Method] Set the status of all matched checkboxes in the same group to checked * @param values Array An array of values. + * @returns Ext.field.Checkbox This checkbox. */ setGroupValues?( values?:any[] ): Ext.field.ICheckbox; /** [Method] Sets the value of ui @@ -26167,7 +28593,9 @@ declare module Ext.field { * @param value String */ setValue?( value?:string ): void; - /** [Method] Set the checked state of the checkbox to false */ + /** [Method] Set the checked state of the checkbox to false + * @returns Ext.field.Checkbox This checkbox. + */ uncheck?(): Ext.field.ICheckbox; } } @@ -26181,29 +28609,49 @@ declare module Ext.form { ui?: string; /** [Config Option] (String) */ value?: string; - /** [Method] Set the checked state of the checkbox to true */ + /** [Method] Set the checked state of the checkbox to true + * @returns Ext.field.Checkbox This checkbox. + */ check?(): Ext.field.ICheckbox; /** [Method] Method called when this Ext field Checkbox has been checked */ doChecked?(): void; /** [Method] Method called when this Ext field Checkbox has been unchecked */ doUnChecked?(): void; - /** [Method] Returns the field checked value */ + /** [Method] Returns the field checked value + * @returns Mixed The field value. + */ getChecked?(): any; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns an array of values from the checkboxes in the group that are checked */ + /** [Method] Returns an array of values from the checkboxes in the group that are checked + * @returns Array + */ getGroupValues?(): any[]; - /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ + /** [Method] Returns the submit value for the checkbox which can be used when submitting forms + * @returns Boolean/String value The value of value or true, if checked. + */ getSubmitValue?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns String + */ getValue?(): string; - /** [Method] Returns the checked state of the checkbox */ + /** [Method] Returns the checked state of the checkbox + * @returns Boolean true if checked, false otherwise. + */ isChecked?(): boolean; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; - /** [Method] Resets the status of all matched checkboxes in the same group to checked */ + /** [Method] Resets the status of all matched checkboxes in the same group to checked + * @returns Ext.field.Checkbox This checkbox. + */ resetGroupValues?(): Ext.field.ICheckbox; /** [Method] Sets the value of component * @param component Object @@ -26211,6 +28659,7 @@ declare module Ext.form { setComponent?( component?:any ): void; /** [Method] Set the status of all matched checkboxes in the same group to checked * @param values Array An array of values. + * @returns Ext.field.Checkbox This checkbox. */ setGroupValues?( values?:any[] ): Ext.field.ICheckbox; /** [Method] Sets the value of ui @@ -26221,7 +28670,9 @@ declare module Ext.form { * @param value String */ setValue?( value?:string ): void; - /** [Method] Set the checked state of the checkbox to false */ + /** [Method] Set the checked state of the checkbox to false + * @returns Ext.field.Checkbox This checkbox. + */ uncheck?(): Ext.field.ICheckbox; } } @@ -26237,23 +28688,34 @@ declare module Ext.field { ui?: string; /** [Config Option] (Object/Date) */ value?: any; - /** [Method] Returns the value of dateFormat */ + /** [Method] Returns the value of dateFormat + * @returns String + */ getDateFormat?(): string; /** [Method] */ getDatePicker?(): void; - /** [Method] Returns the value of destroyPickerOnHide */ + /** [Method] Returns the value of destroyPickerOnHide + * @returns Boolean + */ getDestroyPickerOnHide?(): boolean; /** [Method] Returns the value of the field formatted using the specified format * @param format String The format to be returned. + * @returns String The formatted date. */ getFormattedValue?( format?:string ): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the Date value of this field */ + /** [Method] Returns the Date value of this field + * @returns Date The date selected + */ getValue?(): any; /** [Method] Override this or change event will be fired twice */ onChange?(): void; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of dateFormat * @param dateFormat String @@ -26289,23 +28751,34 @@ declare module Ext.form { ui?: string; /** [Config Option] (Object/Date) */ value?: any; - /** [Method] Returns the value of dateFormat */ + /** [Method] Returns the value of dateFormat + * @returns String + */ getDateFormat?(): string; /** [Method] */ getDatePicker?(): void; - /** [Method] Returns the value of destroyPickerOnHide */ + /** [Method] Returns the value of destroyPickerOnHide + * @returns Boolean + */ getDestroyPickerOnHide?(): boolean; /** [Method] Returns the value of the field formatted using the specified format * @param format String The format to be returned. + * @returns String The formatted date. */ getFormattedValue?( format?:string ): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the Date value of this field */ + /** [Method] Returns the Date value of this field + * @returns Date The date selected + */ getValue?(): any; /** [Method] Override this or change event will be fired twice */ onChange?(): void; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of dateFormat * @param dateFormat String @@ -26335,9 +28808,13 @@ declare module Ext.field { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -26355,9 +28832,13 @@ declare module Ext.form { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -26413,37 +28894,69 @@ declare module Ext.field { labelEl?: Ext.IElement; /** [Property] (Mixed) */ originalValue?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of clearIcon */ + /** [Method] Returns the value of clearIcon + * @returns Boolean + */ getClearIcon?(): boolean; - /** [Method] Returns the value of inputCls */ + /** [Method] Returns the value of inputCls + * @returns String + */ getInputCls?(): string; - /** [Method] Returns the value of inputType */ + /** [Method] Returns the value of inputType + * @returns String + */ getInputType?(): string; - /** [Method] Returns the value of label */ + /** [Method] Returns the value of label + * @returns String + */ getLabel?(): string; - /** [Method] Returns the value of labelAlign */ + /** [Method] Returns the value of labelAlign + * @returns String + */ getLabelAlign?(): string; - /** [Method] Returns the value of labelCls */ + /** [Method] Returns the value of labelCls + * @returns String + */ getLabelCls?(): string; - /** [Method] Returns the value of labelWidth */ + /** [Method] Returns the value of labelWidth + * @returns Number/String + */ getLabelWidth?(): any; - /** [Method] Returns the value of labelWrap */ + /** [Method] Returns the value of labelWrap + * @returns Boolean + */ getLabelWrap?(): boolean; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of required */ + /** [Method] Returns the value of required + * @returns Boolean + */ getRequired?(): boolean; - /** [Method] Returns the value of requiredCls */ + /** [Method] Returns the value of requiredCls + * @returns String + */ getRequiredCls?(): string; - /** [Method] Returns the value of tabIndex */ + /** [Method] Returns the value of tabIndex + * @returns Number + */ getTabIndex?(): number; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean true if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Resets the field s originalValue property so it matches the current value */ resetOriginalValue?(): void; @@ -26478,9 +28991,7 @@ declare module Ext.field { /** [Method] Sets the value of labelWidth * @param labelWidth Number/String */ - setLabelWidth?( labelWidth?:any ): any; - setLabelWidth?( labelWidth?:number ): void; - setLabelWidth?( labelWidth?:string ): void; + setLabelWidth?( labelWidth?:any ): void; /** [Method] Sets the value of labelWrap * @param labelWrap Boolean */ @@ -26551,37 +29062,69 @@ declare module Ext.form { labelEl?: Ext.IElement; /** [Property] (Mixed) */ originalValue?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of clearIcon */ + /** [Method] Returns the value of clearIcon + * @returns Boolean + */ getClearIcon?(): boolean; - /** [Method] Returns the value of inputCls */ + /** [Method] Returns the value of inputCls + * @returns String + */ getInputCls?(): string; - /** [Method] Returns the value of inputType */ + /** [Method] Returns the value of inputType + * @returns String + */ getInputType?(): string; - /** [Method] Returns the value of label */ + /** [Method] Returns the value of label + * @returns String + */ getLabel?(): string; - /** [Method] Returns the value of labelAlign */ + /** [Method] Returns the value of labelAlign + * @returns String + */ getLabelAlign?(): string; - /** [Method] Returns the value of labelCls */ + /** [Method] Returns the value of labelCls + * @returns String + */ getLabelCls?(): string; - /** [Method] Returns the value of labelWidth */ + /** [Method] Returns the value of labelWidth + * @returns Number/String + */ getLabelWidth?(): any; - /** [Method] Returns the value of labelWrap */ + /** [Method] Returns the value of labelWrap + * @returns Boolean + */ getLabelWrap?(): boolean; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of required */ + /** [Method] Returns the value of required + * @returns Boolean + */ getRequired?(): boolean; - /** [Method] Returns the value of requiredCls */ + /** [Method] Returns the value of requiredCls + * @returns String + */ getRequiredCls?(): string; - /** [Method] Returns the value of tabIndex */ + /** [Method] Returns the value of tabIndex + * @returns Number + */ getTabIndex?(): number; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean true if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Resets the field s originalValue property so it matches the current value */ resetOriginalValue?(): void; @@ -26616,9 +29159,7 @@ declare module Ext.form { /** [Method] Sets the value of labelWidth * @param labelWidth Number/String */ - setLabelWidth?( labelWidth?:any ): any; - setLabelWidth?( labelWidth?:number ): void; - setLabelWidth?( labelWidth?:string ): void; + setLabelWidth?( labelWidth?:any ): void; /** [Method] Sets the value of labelWrap * @param labelWrap Boolean */ @@ -26649,7 +29190,9 @@ declare module Ext.field { export interface IFile extends Ext.field.IInput { /** [Config Option] (String) */ type?: string; - /** [Method] Returns the value of type */ + /** [Method] Returns the value of type + * @returns String + */ getType?(): string; /** [Method] Sets the value of type * @param type String @@ -26663,9 +29206,13 @@ declare module Ext.field { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of component * @param component Object @@ -26683,9 +29230,13 @@ declare module Ext.form { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of component * @param component Object @@ -26743,57 +29294,107 @@ declare module Ext.field { value?: any; /** [Property] (Boolean) */ isFocused?: boolean; - /** [Method] Attempts to forcefully blur input focus for the field */ + /** [Method] Attempts to forcefully blur input focus for the field + * @returns Ext.field.Input this + */ blur?(): Ext.field.IInput; - /** [Method] Attempts to set the field as the active input focus */ + /** [Method] Attempts to set the field as the active input focus + * @returns Ext.field.Input this + */ focus?(): Ext.field.IInput; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of autoComplete */ + /** [Method] Returns the value of autoComplete + * @returns Boolean + */ getAutoComplete?(): boolean; - /** [Method] Returns the value of autoCorrect */ + /** [Method] Returns the value of autoCorrect + * @returns Boolean + */ getAutoCorrect?(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the checked value of this field */ + /** [Method] Returns the checked value of this field + * @returns Mixed value The field value + */ getChecked?(): any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ getDisabled?(): boolean; - /** [Method] Returns the value of focusCls */ + /** [Method] Returns the value of focusCls + * @returns String + */ getFocusCls?(): string; - /** [Method] Returns the value of maxLength */ + /** [Method] Returns the value of maxLength + * @returns Number + */ getMaxLength?(): number; - /** [Method] Returns the value of maxRows */ + /** [Method] Returns the value of maxRows + * @returns Number + */ getMaxRows?(): number; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of pattern */ + /** [Method] Returns the value of pattern + * @returns String + */ getPattern?(): string; - /** [Method] Returns the value of placeHolder */ + /** [Method] Returns the value of placeHolder + * @returns String + */ getPlaceHolder?(): string; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; - /** [Method] Returns the value of startValue */ + /** [Method] Returns the value of startValue + * @returns Mixed + */ getStartValue?(): any; - /** [Method] Returns the value of stepValue */ + /** [Method] Returns the value of stepValue + * @returns Number + */ getStepValue?(): number; - /** [Method] Returns the value of tabIndex */ + /** [Method] Returns the value of tabIndex + * @returns Number + */ getTabIndex?(): number; - /** [Method] Returns the value of type */ + /** [Method] Returns the value of type + * @returns String + */ getType?(): string; - /** [Method] Returns the field data value */ + /** [Method] Returns the field data value + * @returns Mixed value The field value. + */ getValue?(): any; - /** [Method] Returns true if the value of this Field has been changed from its original value */ + /** [Method] Returns true if the value of this Field has been changed from its original value + * @returns Boolean + */ isDirty?(): boolean; /** [Method] Resets the current field value to the original value */ reset?(): void; - /** [Method] Attempts to forcefully select all the contents of the input field */ + /** [Method] Attempts to forcefully select all the contents of the input field + * @returns Ext.field.Input this + */ select?(): Ext.field.IInput; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -26894,17 +29495,29 @@ declare module Ext.field { stepValue?: number; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of stepValue */ + /** [Method] Returns the value of stepValue + * @returns Number + */ getStepValue?(): number; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; /** [Method] Sets the value of component * @param component Object @@ -26940,17 +29553,29 @@ declare module Ext.form { stepValue?: number; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of stepValue */ + /** [Method] Returns the value of stepValue + * @returns Number + */ getStepValue?(): number; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; /** [Method] Sets the value of component * @param component Object @@ -26980,9 +29605,13 @@ declare module Ext.field { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27000,9 +29629,13 @@ declare module Ext.form { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27020,15 +29653,25 @@ declare module Ext.field { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the selected value if this radio is part of a group other radio fields with the same name in the same FormP */ + /** [Method] Returns the selected value if this radio is part of a group other radio fields with the same name in the same FormP + * @returns String + */ getGroupValue?(): string; - /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ + /** [Method] Returns the submit value for the checkbox which can be used when submitting forms + * @returns Boolean/String value The value of value or true, if checked. + */ getSubmitValue?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns String + */ getValue?(): string; /** [Method] Sets the value of component * @param component Object @@ -27036,6 +29679,7 @@ declare module Ext.field { setComponent?( component?:any ): void; /** [Method] Set the matched radio field s status that has the same value as the given string to checked * @param value String The value of the radio field to check. + * @returns Ext.field.Radio The field that is checked. */ setGroupValue?( value?:string ): Ext.field.IRadio; /** [Method] Sets the value of ui @@ -27044,6 +29688,7 @@ declare module Ext.field { setUi?( ui?:string ): void; /** [Method] Sets the value of value * @param value Object + * @returns Ext.field.Radio this */ setValue?( value?:any ): Ext.field.IRadio; } @@ -27054,15 +29699,25 @@ declare module Ext.form { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the selected value if this radio is part of a group other radio fields with the same name in the same FormP */ + /** [Method] Returns the selected value if this radio is part of a group other radio fields with the same name in the same FormP + * @returns String + */ getGroupValue?(): string; - /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ + /** [Method] Returns the submit value for the checkbox which can be used when submitting forms + * @returns Boolean/String value The value of value or true, if checked. + */ getSubmitValue?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns String + */ getValue?(): string; /** [Method] Sets the value of component * @param component Object @@ -27070,6 +29725,7 @@ declare module Ext.form { setComponent?( component?:any ): void; /** [Method] Set the matched radio field s status that has the same value as the given string to checked * @param value String The value of the radio field to check. + * @returns Ext.field.Radio The field that is checked. */ setGroupValue?( value?:string ): Ext.field.IRadio; /** [Method] Sets the value of ui @@ -27078,6 +29734,7 @@ declare module Ext.form { setUi?( ui?:string ): void; /** [Method] Sets the value of value * @param value Object + * @returns Ext.field.Radio this */ setValue?( value?:any ): Ext.field.IRadio; } @@ -27088,9 +29745,13 @@ declare module Ext.field { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of component * @param component Object @@ -27108,9 +29769,13 @@ declare module Ext.form { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of component * @param component Object @@ -27148,37 +29813,65 @@ declare module Ext.field { valueField?: any; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of autoSelect */ + /** [Method] Returns the value of autoSelect + * @returns Boolean + */ getAutoSelect?(): boolean; - /** [Method] Returns the value of defaultPhonePickerConfig */ + /** [Method] Returns the value of defaultPhonePickerConfig + * @returns Object + */ getDefaultPhonePickerConfig?(): any; - /** [Method] Returns the value of defaultTabletPickerConfig */ + /** [Method] Returns the value of defaultTabletPickerConfig + * @returns Object + */ getDefaultTabletPickerConfig?(): any; - /** [Method] Returns the value of displayField */ + /** [Method] Returns the value of displayField + * @returns String/Number + */ getDisplayField?(): any; - /** [Method] Returns the value of hiddenName */ + /** [Method] Returns the value of hiddenName + * @returns String + */ getHiddenName?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of options */ + /** [Method] Returns the value of options + * @returns Array + */ getOptions?(): any[]; - /** [Method] Returns the current selected record instance selected in this field */ + /** [Method] Returns the current selected record instance selected in this field + * @returns Ext.data.Model the record. + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.Store/Object/String + */ getStore?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of usePicker */ + /** [Method] Returns the value of usePicker + * @returns String/Boolean + */ getUsePicker?(): any; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [Method] Returns the value of valueField */ + /** [Method] Returns the value of valueField + * @returns String/Number + */ getValueField?(): any; /** [Method] Called when the internal store s data has changed * @param store Object */ onStoreDataChanged?( store?:any ): void; - /** [Method] Resets the Select field to the value of the first record in the store */ + /** [Method] Resets the Select field to the value of the first record in the store + * @returns Ext.field.Select this + */ reset?(): Ext.field.ISelect; /** [Method] Sets the value of autoSelect * @param autoSelect Boolean @@ -27195,9 +29888,7 @@ declare module Ext.field { /** [Method] Sets the value of displayField * @param displayField String/Number */ - setDisplayField?( displayField?:any ): any; - setDisplayField?( displayField?:string ): void; - setDisplayField?( displayField?:number ): void; + setDisplayField?( displayField?:any ): void; /** [Method] Sets the value of hiddenName * @param hiddenName String */ @@ -27221,19 +29912,16 @@ declare module Ext.field { /** [Method] Sets the value of usePicker * @param usePicker String/Boolean */ - setUsePicker?( usePicker?:any ): any; - setUsePicker?( usePicker?:string ): void; - setUsePicker?( usePicker?:boolean ): void; + setUsePicker?( usePicker?:any ): void; /** [Method] Sets the value of valueField * @param valueField String/Number */ - setValueField?( valueField?:any ): any; - setValueField?( valueField?:string ): void; - setValueField?( valueField?:number ): void; + setValueField?( valueField?:any ): void; /** [Method] Shows the picker for the select field whether that is a Ext picker Picker or a simple list */ showPicker?(): void; /** [Method] Updates the underlying lt options gt list with new values * @param newOptions Array An array of options configurations to insert or append. selectBox.setOptions([ {text: 'First Option', value: 'first'}, {text: 'Second Option', value: 'second'}, {text: 'Third Option', value: 'third'} ]).setValue('third'); Note: option object member names should correspond with defined valueField and displayField values. + * @returns Ext.field.Select this */ updateOptions?( newOptions?:any[] ): Ext.field.ISelect; } @@ -27264,37 +29952,65 @@ declare module Ext.form { valueField?: any; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of autoSelect */ + /** [Method] Returns the value of autoSelect + * @returns Boolean + */ getAutoSelect?(): boolean; - /** [Method] Returns the value of defaultPhonePickerConfig */ + /** [Method] Returns the value of defaultPhonePickerConfig + * @returns Object + */ getDefaultPhonePickerConfig?(): any; - /** [Method] Returns the value of defaultTabletPickerConfig */ + /** [Method] Returns the value of defaultTabletPickerConfig + * @returns Object + */ getDefaultTabletPickerConfig?(): any; - /** [Method] Returns the value of displayField */ + /** [Method] Returns the value of displayField + * @returns String/Number + */ getDisplayField?(): any; - /** [Method] Returns the value of hiddenName */ + /** [Method] Returns the value of hiddenName + * @returns String + */ getHiddenName?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of options */ + /** [Method] Returns the value of options + * @returns Array + */ getOptions?(): any[]; - /** [Method] Returns the current selected record instance selected in this field */ + /** [Method] Returns the current selected record instance selected in this field + * @returns Ext.data.Model the record. + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.Store/Object/String + */ getStore?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of usePicker */ + /** [Method] Returns the value of usePicker + * @returns String/Boolean + */ getUsePicker?(): any; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [Method] Returns the value of valueField */ + /** [Method] Returns the value of valueField + * @returns String/Number + */ getValueField?(): any; /** [Method] Called when the internal store s data has changed * @param store Object */ onStoreDataChanged?( store?:any ): void; - /** [Method] Resets the Select field to the value of the first record in the store */ + /** [Method] Resets the Select field to the value of the first record in the store + * @returns Ext.field.Select this + */ reset?(): Ext.field.ISelect; /** [Method] Sets the value of autoSelect * @param autoSelect Boolean @@ -27311,9 +30027,7 @@ declare module Ext.form { /** [Method] Sets the value of displayField * @param displayField String/Number */ - setDisplayField?( displayField?:any ): any; - setDisplayField?( displayField?:string ): void; - setDisplayField?( displayField?:number ): void; + setDisplayField?( displayField?:any ): void; /** [Method] Sets the value of hiddenName * @param hiddenName String */ @@ -27337,19 +30051,16 @@ declare module Ext.form { /** [Method] Sets the value of usePicker * @param usePicker String/Boolean */ - setUsePicker?( usePicker?:any ): any; - setUsePicker?( usePicker?:string ): void; - setUsePicker?( usePicker?:boolean ): void; + setUsePicker?( usePicker?:any ): void; /** [Method] Sets the value of valueField * @param valueField String/Number */ - setValueField?( valueField?:any ): any; - setValueField?( valueField?:string ): void; - setValueField?( valueField?:number ): void; + setValueField?( valueField?:any ): void; /** [Method] Shows the picker for the select field whether that is a Ext picker Picker or a simple list */ showPicker?(): void; /** [Method] Updates the underlying lt options gt list with new values * @param newOptions Array An array of options configurations to insert or append. selectBox.setOptions([ {text: 'First Option', value: 'first'}, {text: 'Second Option', value: 'second'}, {text: 'Third Option', value: 'third'} ]).setValue('third'); Note: option object member names should correspond with defined valueField and displayField values. + * @returns Ext.field.Select this */ updateOptions?( newOptions?:any[] ): Ext.field.ISelect; } @@ -27372,23 +30083,41 @@ declare module Ext.field { value?: any; /** [Config Option] (Number/Number[]) */ values?: any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of increment */ + /** [Method] Returns the value of increment + * @returns Number + */ getIncrement?(): number; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number/Number[] + */ getValue?(): any; - /** [Method] Convenience method */ + /** [Method] Convenience method + * @returns Object + */ getValues?(): any; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean true if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of cls * @param cls String @@ -27417,9 +30146,7 @@ declare module Ext.field { /** [Method] Sets the value of value * @param value Number/Number[] */ - setValue?( value?:any ): any; - setValue?( value?:number ): void; - setValue?( value?:number[] ): void; + setValue?( value?:any ): void; /** [Method] Convenience method * @param value Object */ @@ -27444,23 +30171,41 @@ declare module Ext.form { value?: any; /** [Config Option] (Number/Number[]) */ values?: any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of increment */ + /** [Method] Returns the value of increment + * @returns Number + */ getIncrement?(): number; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number/Number[] + */ getValue?(): any; - /** [Method] Convenience method */ + /** [Method] Convenience method + * @returns Object + */ getValues?(): any; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean true if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of cls * @param cls String @@ -27489,9 +30234,7 @@ declare module Ext.form { /** [Method] Sets the value of value * @param value Number/Number[] */ - setValue?( value?:any ): any; - setValue?( value?:number ): void; - setValue?( value?:number[] ): void; + setValue?( value?:any ): void; /** [Method] Convenience method * @param value Object */ @@ -27522,25 +30265,45 @@ declare module Ext.field { minValue?: number; /** [Config Option] (Number) */ stepValue?: number; - /** [Method] Returns the value of accelerateOnTapHold */ + /** [Method] Returns the value of accelerateOnTapHold + * @returns Boolean + */ getAccelerateOnTapHold?(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of cycle */ + /** [Method] Returns the value of cycle + * @returns Boolean + */ getCycle?(): boolean; - /** [Method] Returns the value of defaultValue */ + /** [Method] Returns the value of defaultValue + * @returns Number + */ getDefaultValue?(): number; - /** [Method] Returns the value of groupButtons */ + /** [Method] Returns the value of groupButtons + * @returns Boolean + */ getGroupButtons?(): boolean; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of stepValue */ + /** [Method] Returns the value of stepValue + * @returns Number + */ getStepValue?(): number; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of accelerateOnTapHold * @param accelerateOnTapHold Boolean @@ -27608,25 +30371,45 @@ declare module Ext.form { minValue?: number; /** [Config Option] (Number) */ stepValue?: number; - /** [Method] Returns the value of accelerateOnTapHold */ + /** [Method] Returns the value of accelerateOnTapHold + * @returns Boolean + */ getAccelerateOnTapHold?(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of cycle */ + /** [Method] Returns the value of cycle + * @returns Boolean + */ getCycle?(): boolean; - /** [Method] Returns the value of defaultValue */ + /** [Method] Returns the value of defaultValue + * @returns Number + */ getDefaultValue?(): number; - /** [Method] Returns the value of groupButtons */ + /** [Method] Returns the value of groupButtons + * @returns Boolean + */ getGroupButtons?(): boolean; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of stepValue */ + /** [Method] Returns the value of stepValue + * @returns Number + */ getStepValue?(): number; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of accelerateOnTapHold * @param accelerateOnTapHold Boolean @@ -27694,37 +30477,67 @@ declare module Ext.field { ui?: string; /** [Property] (String/Number) */ startValue?: any; - /** [Method] Attempts to forcefully blur input focus for the field */ + /** [Method] Attempts to forcefully blur input focus for the field + * @returns Ext.field.Text This field + */ blur?(): Ext.field.IText; - /** [Method] Attempts to set the field as the active input focus */ + /** [Method] Attempts to set the field as the active input focus + * @returns Ext.field.Text This field + */ focus?(): Ext.field.IText; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of autoComplete */ + /** [Method] Returns the value of autoComplete + * @returns Boolean + */ getAutoComplete?(): boolean; - /** [Method] Returns the value of autoCorrect */ + /** [Method] Returns the value of autoCorrect + * @returns Boolean + */ getAutoCorrect?(): boolean; - /** [Method] Returns the value of clearIcon */ + /** [Method] Returns the value of clearIcon + * @returns Boolean + */ getClearIcon?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxLength */ + /** [Method] Returns the value of maxLength + * @returns Number + */ getMaxLength?(): number; - /** [Method] Returns the value of placeHolder */ + /** [Method] Returns the value of placeHolder + * @returns String + */ getPlaceHolder?(): string; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean true if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Resets the field s originalValue property so it matches the current value */ resetOriginalValue?(): void; - /** [Method] Attempts to forcefully select all the contents of the input field */ + /** [Method] Attempts to forcefully select all the contents of the input field + * @returns Ext.field.Text this + */ select?(): Ext.field.IText; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27792,37 +30605,67 @@ declare module Ext.form { ui?: string; /** [Property] (String/Number) */ startValue?: any; - /** [Method] Attempts to forcefully blur input focus for the field */ + /** [Method] Attempts to forcefully blur input focus for the field + * @returns Ext.field.Text This field + */ blur?(): Ext.field.IText; - /** [Method] Attempts to set the field as the active input focus */ + /** [Method] Attempts to set the field as the active input focus + * @returns Ext.field.Text This field + */ focus?(): Ext.field.IText; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of autoComplete */ + /** [Method] Returns the value of autoComplete + * @returns Boolean + */ getAutoComplete?(): boolean; - /** [Method] Returns the value of autoCorrect */ + /** [Method] Returns the value of autoCorrect + * @returns Boolean + */ getAutoCorrect?(): boolean; - /** [Method] Returns the value of clearIcon */ + /** [Method] Returns the value of clearIcon + * @returns Boolean + */ getClearIcon?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxLength */ + /** [Method] Returns the value of maxLength + * @returns Number + */ getMaxLength?(): number; - /** [Method] Returns the value of placeHolder */ + /** [Method] Returns the value of placeHolder + * @returns String + */ getPlaceHolder?(): string; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean true if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Resets the field s originalValue property so it matches the current value */ resetOriginalValue?(): void; - /** [Method] Attempts to forcefully select all the contents of the input field */ + /** [Method] Attempts to forcefully select all the contents of the input field + * @returns Ext.field.Text this + */ select?(): Ext.field.IText; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27876,13 +30719,21 @@ declare module Ext.field { maxRows?: number; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxRows */ + /** [Method] Returns the value of maxRows + * @returns Number + */ getMaxRows?(): number; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27912,13 +30763,21 @@ declare module Ext.form { maxRows?: number; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxRows */ + /** [Method] Returns the value of maxRows + * @returns Number + */ getMaxRows?(): number; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27956,15 +30815,25 @@ declare module Ext.field { toggleOffLabel?: string; /** [Property] (String) */ toggleOnLabel?: string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of labelAlign */ + /** [Method] Returns the value of labelAlign + * @returns String + */ getLabelAlign?(): string; - /** [Method] Returns the value of maxValueCls */ + /** [Method] Returns the value of maxValueCls + * @returns String + */ getMaxValueCls?(): string; - /** [Method] Returns the value of minValueCls */ + /** [Method] Returns the value of minValueCls + * @returns String + */ getMinValueCls?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number/Number[] + */ getValue?(): any; /** [Method] Sets the value of cls * @param cls String @@ -27984,9 +30853,12 @@ declare module Ext.field { setMinValueCls?( minValueCls?:string ): void; /** [Method] Sets the value of the toggle * @param newValue Number 1 for toggled, 0 for untoggled. + * @returns Object this */ setValue?( newValue?:number ): any; - /** [Method] Toggles the value of this toggle field */ + /** [Method] Toggles the value of this toggle field + * @returns Object this + */ toggle?(): any; } } @@ -28004,15 +30876,25 @@ declare module Ext.form { toggleOffLabel?: string; /** [Property] (String) */ toggleOnLabel?: string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of labelAlign */ + /** [Method] Returns the value of labelAlign + * @returns String + */ getLabelAlign?(): string; - /** [Method] Returns the value of maxValueCls */ + /** [Method] Returns the value of maxValueCls + * @returns String + */ getMaxValueCls?(): string; - /** [Method] Returns the value of minValueCls */ + /** [Method] Returns the value of minValueCls + * @returns String + */ getMinValueCls?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number/Number[] + */ getValue?(): any; /** [Method] Sets the value of cls * @param cls String @@ -28032,9 +30914,12 @@ declare module Ext.form { setMinValueCls?( minValueCls?:string ): void; /** [Method] Sets the value of the toggle * @param newValue Number 1 for toggled, 0 for untoggled. + * @returns Object this */ setValue?( newValue?:number ): any; - /** [Method] Toggles the value of this toggle field */ + /** [Method] Toggles the value of this toggle field + * @returns Object this + */ toggle?(): any; } } @@ -28044,9 +30929,13 @@ declare module Ext.field { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -28064,9 +30953,13 @@ declare module Ext.form { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -28088,9 +30981,12 @@ declare module Ext.form { title?: string; /** [Method] A convenient method to disable all fields in this FieldSet * @param newDisabled Object + * @returns Ext.form.FieldSet This FieldSet */ doSetDisabled?( newDisabled?:any ): Ext.form.IFieldSet; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -28132,46 +31028,73 @@ declare module Ext.form { waitTpl?: any; /** [Method] A convenient method to disable all fields in this form * @param newDisabled Object + * @returns Ext.form.Panel This form. */ doSetDisabled?( newDisabled?:any ): Ext.form.IPanel; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of baseParams */ + /** [Method] Returns the value of baseParams + * @returns Object + */ getBaseParams?(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns String + */ getMethod?(): string; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of scrollable */ + /** [Method] Returns the value of scrollable + * @returns Object + */ getScrollable?(): any; - /** [Method] Returns the value of standardSubmit */ + /** [Method] Returns the value of standardSubmit + * @returns Boolean + */ getStandardSubmit?(): boolean; - /** [Method] Returns the value of submitOnAction */ + /** [Method] Returns the value of submitOnAction + * @returns Object + */ getSubmitOnAction?(): any; - /** [Method] Returns the value of trackResetOnLoad */ + /** [Method] Returns the value of trackResetOnLoad + * @returns Boolean + */ getTrackResetOnLoad?(): boolean; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; /** [Method] Returns an object containing the value of each field in the form keyed to the field s name * @param enabled Boolean true to return only enabled fields. * @param all Boolean true to return all fields even if they don't have a name configured. + * @returns Object Object mapping field name to its value. */ getValues?( enabled?:boolean, all?:boolean ): any; - /** [Method] Hides a previously shown wait mask See showMask */ + /** [Method] Hides a previously shown wait mask See showMask + * @returns Ext.form.Panel this + */ hideMask?(): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ load?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ loadModel?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ loadRecord?( record?:Ext.data.IModel ): Ext.form.IPanel; - /** [Method] Resets all fields in the form back to their original values */ + /** [Method] Resets all fields in the form back to their original values + * @returns Ext.form.Panel This form. + */ reset?(): Ext.form.IPanel; /** [Method] Sets the value of baseCls * @param baseCls String @@ -28187,6 +31110,7 @@ declare module Ext.form { setMethod?( method?:string ): void; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ setRecord?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Sets the value of scrollable @@ -28211,15 +31135,18 @@ declare module Ext.form { setUrl?( url?:string ): void; /** [Method] Sets the values of form fields in bulk * @param values Object field name => value mapping object. + * @returns Ext.form.Panel This form. */ setValues?( values?:any ): Ext.form.IPanel; /** [Method] Shows a generic custom mask over a designated Element * @param cfg String/Object Either a string message or a configuration object supporting the following options: { message : 'Please Wait', cls : 'form-mask' } * @param target Object + * @returns Ext.form.Panel This form */ showMask?( cfg?:any, target?:any ): Ext.form.IPanel; /** [Method] Performs a Ajax based submission of form values if standardSubmit is false or otherwise executes a standard HTML Fo * @param options Object The configuration when submitting this form. + * @returns Ext.data.Connection The request object. */ submit?( options?:any ): Ext.data.IConnection; } @@ -28250,46 +31177,73 @@ declare module Ext.form { waitTpl?: any; /** [Method] A convenient method to disable all fields in this form * @param newDisabled Object + * @returns Ext.form.Panel This form. */ doSetDisabled?( newDisabled?:any ): Ext.form.IPanel; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of baseParams */ + /** [Method] Returns the value of baseParams + * @returns Object + */ getBaseParams?(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns String + */ getMethod?(): string; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of scrollable */ + /** [Method] Returns the value of scrollable + * @returns Object + */ getScrollable?(): any; - /** [Method] Returns the value of standardSubmit */ + /** [Method] Returns the value of standardSubmit + * @returns Boolean + */ getStandardSubmit?(): boolean; - /** [Method] Returns the value of submitOnAction */ + /** [Method] Returns the value of submitOnAction + * @returns Object + */ getSubmitOnAction?(): any; - /** [Method] Returns the value of trackResetOnLoad */ + /** [Method] Returns the value of trackResetOnLoad + * @returns Boolean + */ getTrackResetOnLoad?(): boolean; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; /** [Method] Returns an object containing the value of each field in the form keyed to the field s name * @param enabled Boolean true to return only enabled fields. * @param all Boolean true to return all fields even if they don't have a name configured. + * @returns Object Object mapping field name to its value. */ getValues?( enabled?:boolean, all?:boolean ): any; - /** [Method] Hides a previously shown wait mask See showMask */ + /** [Method] Hides a previously shown wait mask See showMask + * @returns Ext.form.Panel this + */ hideMask?(): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ load?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ loadModel?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ loadRecord?( record?:Ext.data.IModel ): Ext.form.IPanel; - /** [Method] Resets all fields in the form back to their original values */ + /** [Method] Resets all fields in the form back to their original values + * @returns Ext.form.Panel This form. + */ reset?(): Ext.form.IPanel; /** [Method] Sets the value of baseCls * @param baseCls String @@ -28305,6 +31259,7 @@ declare module Ext.form { setMethod?( method?:string ): void; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ setRecord?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Sets the value of scrollable @@ -28329,15 +31284,18 @@ declare module Ext.form { setUrl?( url?:string ): void; /** [Method] Sets the values of form fields in bulk * @param values Object field name => value mapping object. + * @returns Ext.form.Panel This form. */ setValues?( values?:any ): Ext.form.IPanel; /** [Method] Shows a generic custom mask over a designated Element * @param cfg String/Object Either a string message or a configuration object supporting the following options: { message : 'Please Wait', cls : 'form-mask' } * @param target Object + * @returns Ext.form.Panel This form */ showMask?( cfg?:any, target?:any ): Ext.form.IPanel; /** [Method] Performs a Ajax based submission of form values if standardSubmit is false or otherwise executes a standard HTML Fo * @param options Object The configuration when submitting this form. + * @returns Ext.data.Connection The request object. */ submit?( options?:any ): Ext.data.IConnection; } @@ -28349,6 +31307,7 @@ declare module Ext { /** [Method] Create an alias to the provided method property with name methodName of object * @param object Object/Function * @param methodName String + * @returns Function aliasFn */ static alias( object?:any, methodName?:string ): any; /** [Method] Create a new function from the provided fn change this to the provided scope optionally overrides arguments for the @@ -28356,12 +31315,12 @@ declare module Ext { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if true args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Function The new function. */ - static bind( fn?:any, scope?:any, args?:any, appendArgs?:any ): any; - static bind( fn?:any, scope?:any, args?:any[], appendArgs?:boolean ): any; - static bind( fn?:any, scope?:any, args?:any[], appendArgs?:number ): any; + static bind( fn?:any, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Create a clone of the provided method * @param method Function + * @returns Function cloneFn */ static clone( method?:any ): any; /** [Method] Creates a delegate function optionally with a bound scope which when called buffers the execution of the passed fu @@ -28369,6 +31328,7 @@ declare module Ext { * @param buffer Number The number of milliseconds by which to buffer the invocation of the function. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope specified by the caller. * @param args Array Override arguments for the call. Defaults to the arguments passed by the caller. + * @returns Function A function which invokes the passed function after buffering for the specified time. */ static createBuffered( fn?:any, buffer?:number, scope?:any, args?:any[] ): any; /** [Method] Creates a delegate callback which when called executes after a specific delay @@ -28377,36 +31337,37 @@ declare module Ext { * @param scope Object The scope (this reference) used by the function at execution time. * @param args Array Override arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if True args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Function A function which, when called, executes the original function after the specified delay. */ - static createDelayed( fn?:any, delay?:any, scope?:any, args?:any, appendArgs?:any ): any; - static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:boolean ): any; - static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:number ): any; + static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Create a new function from the provided fn change this to the provided scope optionally overrides arguments for the * @param fn Function The function to delegate. * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if true args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Function The new function. */ - static createDelegate( fn?:any, scope?:any, args?:any, appendArgs?:any ): any; - static createDelegate( fn?:any, scope?:any, args?:any[], appendArgs?:boolean ): any; - static createDelegate( fn?:any, scope?:any, args?:any[], appendArgs?:number ): any; + static createDelegate( fn?:any, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Creates an interceptor function * @param origFn Function The original function. * @param newFn Function The function to call before the original. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope in which the original function is called or the browser window. * @param returnValue Object The value to return if the passed function return false. + * @returns Function The new function. */ static createInterceptor( origFn?:any, newFn?:any, scope?:any, returnValue?:any ): any; /** [Method] Create a combined function call sequence of the original function the passed function * @param originalFn Function The original function. * @param newFn Function The function to sequence. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope in which the original function is called or the browser window. + * @returns Function The new function. */ static createSequence( originalFn?:any, newFn?:any, scope?:any ): any; /** [Method] Creates a throttled version of the passed function which when called repeatedly and rapidly invokes the passed func * @param fn Function The function to execute at a regular time interval. * @param interval Number The interval, in milliseconds, on which the passed function is executed. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope specified by the caller. + * @returns Function A function which invokes the passed function at the specified interval. */ static createThrottled( fn?:any, interval?:number, scope?:any ): any; /** [Method] Calls this function after the number of milliseconds specified optionally in a specific scope @@ -28415,18 +31376,19 @@ declare module Ext { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. Defaults to the arguments passed by the caller. * @param appendArgs Boolean/Number if true, args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Number The timeout id that can be used with clearTimeout(). */ - static defer( fn?:any, millis?:any, scope?:any, args?:any, appendArgs?:any ): any; - static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:boolean ): number; - static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:number ): number; + static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:any ): number; /** [Method] A very commonly used method throughout the framework * @param fn Function + * @returns Function flexSetter */ static flexSetter( fn?:any ): any; /** [Method] Create a new function from the provided fn the arguments of which are pre set to args * @param fn Function The original function. * @param args Array The arguments to pass to new callback. * @param scope Object The scope (this reference) in which the function is executed. + * @returns Function The new callback function. */ static pass( fn?:any, args?:any[], scope?:any ): any; } @@ -28438,6 +31400,7 @@ declare module Ext.util { /** [Method] Create an alias to the provided method property with name methodName of object * @param object Object/Function * @param methodName String + * @returns Function aliasFn */ static alias( object?:any, methodName?:string ): any; /** [Method] Create a new function from the provided fn change this to the provided scope optionally overrides arguments for the @@ -28445,12 +31408,12 @@ declare module Ext.util { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if true args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Function The new function. */ - static bind( fn?:any, scope?:any, args?:any, appendArgs?:any ): any; - static bind( fn?:any, scope?:any, args?:any[], appendArgs?:boolean ): any; - static bind( fn?:any, scope?:any, args?:any[], appendArgs?:number ): any; + static bind( fn?:any, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Create a clone of the provided method * @param method Function + * @returns Function cloneFn */ static clone( method?:any ): any; /** [Method] Creates a delegate function optionally with a bound scope which when called buffers the execution of the passed fu @@ -28458,6 +31421,7 @@ declare module Ext.util { * @param buffer Number The number of milliseconds by which to buffer the invocation of the function. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope specified by the caller. * @param args Array Override arguments for the call. Defaults to the arguments passed by the caller. + * @returns Function A function which invokes the passed function after buffering for the specified time. */ static createBuffered( fn?:any, buffer?:number, scope?:any, args?:any[] ): any; /** [Method] Creates a delegate callback which when called executes after a specific delay @@ -28466,36 +31430,37 @@ declare module Ext.util { * @param scope Object The scope (this reference) used by the function at execution time. * @param args Array Override arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if True args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Function A function which, when called, executes the original function after the specified delay. */ - static createDelayed( fn?:any, delay?:any, scope?:any, args?:any, appendArgs?:any ): any; - static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:boolean ): any; - static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:number ): any; + static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Create a new function from the provided fn change this to the provided scope optionally overrides arguments for the * @param fn Function The function to delegate. * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if true args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Function The new function. */ - static createDelegate( fn?:any, scope?:any, args?:any, appendArgs?:any ): any; - static createDelegate( fn?:any, scope?:any, args?:any[], appendArgs?:boolean ): any; - static createDelegate( fn?:any, scope?:any, args?:any[], appendArgs?:number ): any; + static createDelegate( fn?:any, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Creates an interceptor function * @param origFn Function The original function. * @param newFn Function The function to call before the original. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope in which the original function is called or the browser window. * @param returnValue Object The value to return if the passed function return false. + * @returns Function The new function. */ static createInterceptor( origFn?:any, newFn?:any, scope?:any, returnValue?:any ): any; /** [Method] Create a combined function call sequence of the original function the passed function * @param originalFn Function The original function. * @param newFn Function The function to sequence. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope in which the original function is called or the browser window. + * @returns Function The new function. */ static createSequence( originalFn?:any, newFn?:any, scope?:any ): any; /** [Method] Creates a throttled version of the passed function which when called repeatedly and rapidly invokes the passed func * @param fn Function The function to execute at a regular time interval. * @param interval Number The interval, in milliseconds, on which the passed function is executed. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope specified by the caller. + * @returns Function A function which invokes the passed function at the specified interval. */ static createThrottled( fn?:any, interval?:number, scope?:any ): any; /** [Method] Calls this function after the number of milliseconds specified optionally in a specific scope @@ -28504,18 +31469,19 @@ declare module Ext.util { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. Defaults to the arguments passed by the caller. * @param appendArgs Boolean/Number if true, args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Number The timeout id that can be used with clearTimeout(). */ - static defer( fn?:any, millis?:any, scope?:any, args?:any, appendArgs?:any ): any; - static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:boolean ): number; - static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:number ): number; + static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:any ): number; /** [Method] A very commonly used method throughout the framework * @param fn Function + * @returns Function flexSetter */ static flexSetter( fn?:any ): any; /** [Method] Create a new function from the provided fn the arguments of which are pre set to args * @param fn Function The original function. * @param args Array The arguments to pass to new callback. * @param scope Object The scope (this reference) in which the function is executed. + * @returns Function The new callback function. */ static pass( fn?:any, args?:any[], scope?:any ): any; } @@ -28528,37 +31494,69 @@ declare module Ext.fx.animation { easing?: string; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of delay */ + /** [Method] Returns the value of delay + * @returns Number + */ getDelay?(): number; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of iteration */ + /** [Method] Returns the value of iteration + * @returns Number + */ getIteration?(): number; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of onBeforeEnd */ + /** [Method] Returns the value of onBeforeEnd + * @returns Object + */ getOnBeforeEnd?(): any; - /** [Method] Returns the value of onBeforeStart */ + /** [Method] Returns the value of onBeforeStart + * @returns Object + */ getOnBeforeStart?(): any; - /** [Method] Returns the value of onEnd */ + /** [Method] Returns the value of onEnd + * @returns Object + */ getOnEnd?(): any; - /** [Method] Returns the value of preserveEndState */ + /** [Method] Returns the value of preserveEndState + * @returns Boolean + */ getPreserveEndState?(): boolean; - /** [Method] Returns the value of replacePrevious */ + /** [Method] Returns the value of replacePrevious + * @returns Boolean + */ getReplacePrevious?(): boolean; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; /** [Method] Sets the value of after * @param after Object @@ -28632,13 +31630,21 @@ declare module Ext.fx.animation { before?: any; /** [Config Option] (String) */ direction?: string; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; /** [Method] Sets the value of after * @param after Object @@ -28664,13 +31670,21 @@ declare module Ext.fx.animation { before?: any; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of after * @param after Object @@ -28696,13 +31710,21 @@ declare module Ext.fx.animation { before?: any; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of after * @param after Object @@ -28726,7 +31748,9 @@ declare module Ext.fx.animation { export interface IFadeOut extends Ext.fx.animation.IFade { /** [Config Option] (Object) */ before?: any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; /** [Method] Sets the value of before * @param before Object @@ -28740,13 +31764,21 @@ declare module Ext.fx.animation { direction?: string; /** [Config Option] (String) */ easing?: string; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of half */ + /** [Method] Returns the value of half + * @returns Boolean + */ getHalf?(): boolean; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Object + */ getOut?(): any; /** [Method] Sets the value of direction * @param direction String @@ -28776,11 +31808,17 @@ declare module Ext.fx.animation { before?: any; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; /** [Method] Sets the value of after * @param after Object @@ -28802,11 +31840,17 @@ declare module Ext.fx.animation { before?: any; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; /** [Method] Sets the value of after * @param after Object @@ -28826,7 +31870,9 @@ declare module Ext.fx.animation { export interface IPopOut extends Ext.fx.animation.IPop { /** [Config Option] (Object) */ before?: any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; /** [Method] Sets the value of before * @param before Object @@ -28844,17 +31890,29 @@ declare module Ext.fx.animation { offset?: number; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of isElementBoxFit */ + /** [Method] Returns the value of isElementBoxFit + * @returns Boolean + */ getIsElementBoxFit?(): boolean; - /** [Method] Returns the value of offset */ + /** [Method] Returns the value of offset + * @returns Number + */ getOffset?(): number; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; - /** [Method] Returns the value of useCssTransform */ + /** [Method] Returns the value of useCssTransform + * @returns Boolean + */ getUseCssTransform?(): boolean; /** [Method] Sets the value of containerBox * @param containerBox String @@ -28900,17 +31958,29 @@ declare module Ext.fx.animation { offset?: number; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of isElementBoxFit */ + /** [Method] Returns the value of isElementBoxFit + * @returns Boolean + */ getIsElementBoxFit?(): boolean; - /** [Method] Returns the value of offset */ + /** [Method] Returns the value of offset + * @returns Number + */ getOffset?(): number; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; - /** [Method] Returns the value of useCssTransform */ + /** [Method] Returns the value of useCssTransform + * @returns Boolean + */ getUseCssTransform?(): boolean; /** [Method] Sets the value of containerBox * @param containerBox String @@ -28958,11 +32028,17 @@ declare module Ext.fx.animation { easing?: string; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; /** [Method] Sets the value of direction * @param direction String @@ -28986,11 +32062,17 @@ declare module Ext.fx.animation { easing?: string; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; /** [Method] Sets the value of direction * @param direction String @@ -29012,9 +32094,13 @@ declare module Ext.fx.animation { } declare module Ext.fx.easing { export interface IAbstract extends Ext.IBase { - /** [Method] Returns the value of startTime */ + /** [Method] Returns the value of startTime + * @returns Number + */ getStartTime?(): number; - /** [Method] Returns the value of startValue */ + /** [Method] Returns the value of startValue + * @returns Number + */ getStartValue?(): number; /** [Method] Sets the value of startTime * @param startTime Number @@ -29028,11 +32114,17 @@ declare module Ext.fx.easing { } declare module Ext.fx.easing { export interface IBounce extends Ext.fx.easing.IAbstract { - /** [Method] Returns the value of acceleration */ + /** [Method] Returns the value of acceleration + * @returns Number + */ getAcceleration?(): number; - /** [Method] Returns the value of springTension */ + /** [Method] Returns the value of springTension + * @returns Number + */ getSpringTension?(): number; - /** [Method] Returns the value of startVelocity */ + /** [Method] Returns the value of startVelocity + * @returns Number + */ getStartVelocity?(): number; /** [Method] Sets the value of acceleration * @param acceleration Number @@ -29058,17 +32150,29 @@ declare module Ext.fx.easing { momentum?: any; /** [Config Option] (Number) */ startVelocity?: number; - /** [Method] Returns the value of bounce */ + /** [Method] Returns the value of bounce + * @returns Object + */ getBounce?(): any; - /** [Method] Returns the value of maxMomentumValue */ + /** [Method] Returns the value of maxMomentumValue + * @returns Number + */ getMaxMomentumValue?(): number; - /** [Method] Returns the value of minMomentumValue */ + /** [Method] Returns the value of minMomentumValue + * @returns Number + */ getMinMomentumValue?(): number; - /** [Method] Returns the value of minVelocity */ + /** [Method] Returns the value of minVelocity + * @returns Number + */ getMinVelocity?(): number; - /** [Method] Returns the value of momentum */ + /** [Method] Returns the value of momentum + * @returns Object + */ getMomentum?(): any; - /** [Method] Returns the value of startVelocity */ + /** [Method] Returns the value of startVelocity + * @returns Number + */ getStartVelocity?(): number; /** [Method] Sets the value of bounce * @param bounce Object @@ -29098,9 +32202,13 @@ declare module Ext.fx.easing { } declare module Ext.fx.easing { export interface IEaseIn extends Ext.fx.easing.ILinear { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of exponent */ + /** [Method] Returns the value of exponent + * @returns Number + */ getExponent?(): number; /** [Method] Sets the value of duration * @param duration Number @@ -29114,9 +32222,13 @@ declare module Ext.fx.easing { } declare module Ext.fx.easing { export interface IEaseOut extends Ext.fx.easing.ILinear { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of exponent */ + /** [Method] Returns the value of exponent + * @returns Number + */ getExponent?(): number; /** [Method] Sets the value of duration * @param duration Number @@ -29134,9 +32246,13 @@ declare module Ext.fx { } declare module Ext.fx.easing { export interface ILinear extends Ext.fx.easing.IAbstract { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of endValue */ + /** [Method] Returns the value of endValue + * @returns Number + */ getEndValue?(): number; /** [Method] Sets the value of duration * @param duration Number @@ -29150,11 +32266,17 @@ declare module Ext.fx.easing { } declare module Ext.fx.easing { export interface IMomentum extends Ext.fx.easing.IAbstract { - /** [Method] Returns the value of acceleration */ + /** [Method] Returns the value of acceleration + * @returns Number + */ getAcceleration?(): number; - /** [Method] Returns the value of friction */ + /** [Method] Returns the value of friction + * @returns Number + */ getFriction?(): number; - /** [Method] Returns the value of startVelocity */ + /** [Method] Returns the value of startVelocity + * @returns Number + */ getStartVelocity?(): number; /** [Method] Sets the value of acceleration * @param acceleration Number @@ -29174,13 +32296,21 @@ declare module Ext.fx.layout.card { export interface IAbstract extends Ext.IEvented { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Object + */ getDuration?(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of direction * @param direction String @@ -29202,11 +32332,17 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface ICover extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29224,11 +32360,17 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface ICube extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29246,11 +32388,17 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface IFade extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29268,11 +32416,17 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface IFlip extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; /** [Method] Sets the value of duration * @param duration Number @@ -29294,11 +32448,17 @@ declare module Ext.fx.layout { } declare module Ext.fx.layout.card { export interface IPop extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; /** [Method] Sets the value of duration * @param duration Number @@ -29316,9 +32476,13 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface IReveal extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29332,7 +32496,9 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface IScroll extends Ext.fx.layout.card.IAbstract { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; /** [Method] Sets the value of duration * @param duration Number @@ -29350,9 +32516,13 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface ISlide extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29368,9 +32538,13 @@ declare module Ext.fx.layout.card { export interface IStyle extends Ext.fx.layout.card.IAbstract { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29416,17 +32590,29 @@ declare module Ext { src?: string; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of backgroundCls */ + /** [Method] Returns the value of backgroundCls + * @returns String + */ getBackgroundCls?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of imageCls */ + /** [Method] Returns the value of imageCls + * @returns String + */ getImageCls?(): string; - /** [Method] Returns the value of mode */ + /** [Method] Returns the value of mode + * @returns String + */ getMode?(): string; - /** [Method] Returns the value of src */ + /** [Method] Returns the value of src + * @returns String + */ getSrc?(): string; - /** [Method] Hides this Component */ + /** [Method] Hides this Component + * @returns Ext.Component + */ hide?(): Ext.IComponent; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -29450,7 +32636,9 @@ declare module Ext { * @param src String */ setSrc?( src?:string ): void; - /** [Method] Shows this component */ + /** [Method] Shows this component + * @returns Ext.Component + */ show?(): Ext.IComponent; } } @@ -29462,6 +32650,7 @@ declare module Ext { export interface IItemCollection extends Ext.util.IMixedCollection { /** [Method] MixedCollection has a generic way to fetch keys if you implement getKey * @param item Object + * @returns Object The key for the passed item. */ getKey?( item?:any ): any; } @@ -29491,11 +32680,13 @@ declare module Ext { * @param object Object The receiver of the properties. * @param config Object The source of the properties. * @param defaults Object A different object that will also be applied for default values. + * @returns Object returns obj */ export function apply( object?:any, config?:any, defaults?:any ): any; /** [Method] Copies all the properties of config to object if they don t already exist * @param object Object The receiver of the properties. * @param config Object The source of the properties. + * @returns Object returns obj */ export function applyIf( object?:any, config?:any ): any; /** [Method] Create a new function from the provided fn change this to the provided scope optionally overrides arguments for the @@ -29503,10 +32694,9 @@ declare module Ext { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if true args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Function The new function. */ - export function bind( fn?:any, scope?:any, args?:any, appendArgs?:any ): any; - export function bind( fn?:any, scope?:any, args?:any[], appendArgs?:boolean ): any; - export function bind( fn?:any, scope?:any, args?:any[], appendArgs?:number ): any; + export function bind( fn?:any, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Calls function after specified delay or right away when delay 0 * @param callback Function The callback to execute. * @param scope Object The scope to execute in. @@ -29516,10 +32706,12 @@ declare module Ext { export function callback( callback?:any, scope?:any, args?:any[], delay?:number ): void; /** [Method] Old alias to Ext Array clean * @param array Array + * @returns Array results */ export function clean( array?:any[] ): any[]; /** [Method] Clone almost any type of variable including array object DOM nodes and Date without keeping the old reference * @param item Object The variable to clone. + * @returns Object clone */ export function clone( item?:any ): any; /** [Method] Copies a set of named properties from the source object to the destination object @@ -29527,18 +32719,19 @@ declare module Ext { * @param source Object The source object. * @param names String/String[] Either an Array of property names, or a comma-delimited list of property names to copy. * @param usePrototypeKeys Boolean Pass true to copy keys off of the prototype as well as the instance. + * @returns Object The modified object. */ - export function copyTo( dest?:any, source?:any, names?:any, usePrototypeKeys?:any ): any; - export function copyTo( dest?:any, source?:any, names?:string, usePrototypeKeys?:boolean ): any; - export function copyTo( dest?:any, source?:any, names?:string[], usePrototypeKeys?:boolean ): any; + export function copyTo( dest?:any, source?:any, names?:any, usePrototypeKeys?:boolean ): any; /** [Method] Instantiate a class by either full name alias or alternate name * @param name String * @param args Mixed Additional arguments after the name will be passed to the class' constructor. + * @returns Object instance */ export function create( name?:string, args?:any ): any; /** [Method] Convenient shorthand see Ext ClassManager instantiateByAlias * @param alias String * @param args Mixed... Additional arguments after the alias will be passed to the class constructor. + * @returns Object instance */ export function createByAlias( alias:string, ...args:any[] ): any; /** [Method] Creates an interceptor function @@ -29546,6 +32739,7 @@ declare module Ext { * @param newFn Function The function to call before the original. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope in which the original function is called or the browser window. * @param returnValue Object The value to return if the passed function return false. + * @returns Function The new function. */ export function createInterceptor( origFn?:any, newFn?:any, scope?:any, returnValue?:any ): any; /** [Method] Old name for widget */ @@ -29553,6 +32747,7 @@ declare module Ext { /** [Method] Shorthand for Ext JSON decode * @param json String The JSON string. * @param safe Boolean Whether to return null or throw an exception if the JSON is invalid. + * @returns Object/null The resulting object. */ export function decode( json?:string, safe?:boolean ): any; /** [Method] Calls this function after the number of milliseconds specified optionally in a specific scope @@ -29561,14 +32756,14 @@ declare module Ext { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. Defaults to the arguments passed by the caller. * @param appendArgs Boolean/Number if true, args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Number The timeout id that can be used with clearTimeout(). */ - export function defer( fn?:any, millis?:any, scope?:any, args?:any, appendArgs?:any ): any; - export function defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:boolean ): number; - export function defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:number ): number; + export function defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:any ): number; /** [Method] Defines a class or override * @param className String The class name to create in string dot-namespaced format, for example: 'My.very.awesome.Class', 'FeedViewer.plugin.CoolPager' It is highly recommended to follow this simple convention: - The root and the class name are 'CamelCased' - Everything else is lower-cased * @param data Object The key - value pairs of properties to apply to this class. Property names can be of any valid strings, except those in the reserved listed below: mixins statics config alias self singleton alternateClassName override * @param createdFn Function Optional callback to execute after the class (or override) is created. The execution scope (this) will be the newly created class itself. + * @returns Ext.Base */ export function define( className?:string, data?:any, createdFn?:any ): Ext.IBase; /** [Method] Attempts to destroy any objects passed to it by removing all event listeners removing them from the DOM if applicab @@ -29582,19 +32777,23 @@ declare module Ext { * @param fn Function The callback function. If it returns false, the iteration stops and this method returns the current index. * @param scope Object The scope (this reference) in which the specified function is executed. * @param reverse Boolean Reverse the iteration order (loop from the end to the beginning). + * @returns Boolean See description for the fn parameter. */ export function each( iterable?:any, fn?:any, scope?:any, reverse?:boolean ): boolean; /** [Method] Shorthand for Ext JSON encode * @param o Object The variable to encode. + * @returns String The JSON string. */ export function encode( o?:any ): string; /** [Method] Convenient shortcut to Ext Loader exclude * @param excludes Array + * @returns Object object contains require method for chaining. */ export function exclude( excludes?:any[] ): any; /** [Method] This method deprecated * @param superclass Function * @param overrides Object + * @returns Function The subclass constructor from the overrides parameter, or a generated one if not provided. */ export function extend( superclass?:any, overrides?:any ): any; /** [Method] A global factory method to instantiate a class from a config object @@ -29606,124 +32805,151 @@ declare module Ext { export function factory( config?:any, classReference?:string, instance?:any, aliasNamespace?:any ): void; /** [Method] Old alias to Ext Array flatten * @param array Array The array to flatten + * @returns Array The 1-d array. */ export function flatten( array?:any[] ): any[]; /** [Method] Gets the globally shared flyweight Element with the passed node as the active element * @param element String/HTMLElement The DOM node or id. * @param named String Allows for creation of named reusable flyweights to prevent conflicts (e.g. internally Ext uses "_global"). + * @returns Ext.dom.Element The shared Element object (or null if no matching element was found). */ - export function fly( element?:any, named?:any ): any; - export function fly( element?:string, named?:string ): Ext.dom.IElement; - export function fly( element?:HTMLElement, named?:string ): Ext.dom.IElement; + export function fly( element?:any, named?:string ): Ext.dom.IElement; /** [Method] Retrieves Ext dom Element objects * @param element String/HTMLElement/Ext.Element The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element The Element object (or null if no matching element was found). + */ + export function get( element?:any ): Ext.dom.IElement; + /** [Method] Returns the current document body as an Ext Element + * @returns Ext.Element The document body. */ - export function get( element?:any ): any; - export function get( element?:string ): Ext.dom.IElement; - export function get( element?:HTMLElement ): Ext.dom.IElement; - export function get( element?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Returns the current document body as an Ext Element */ export function getBody(): Ext.IElement; /** [Method] Convenient shorthand see Ext ClassManager getClass */ export function getClass(): void; /** [Method] Convenient shorthand for Ext ClassManager getName * @param object Ext.Class/Object + * @returns String className */ export function getClassName( object?:any ): string; /** [Method] This is shorthand reference to Ext ComponentMgr get * @param id String The component id + * @returns Ext.Component The Component, undefined if not found, or null if a Class was found. */ export function getCmp( id?:string ): Ext.IComponent; /** [Method] Returns the display name for object * @param object Mixed The object who's display name to determine. + * @returns String The determined display name, or "Anonymous" if none found. */ export function getDisplayName( object?:any ): string; - /** [Method] Returns the current HTML document object as an Ext Element */ + /** [Method] Returns the current HTML document object as an Ext Element + * @returns Ext.Element The document. + */ export function getDoc(): Ext.IElement; /** [Method] Return the dom node for the passed String id dom node or Ext Element * @param el Mixed + * @returns HTMLElement */ export function getDom( el?:any ): HTMLElement; - /** [Method] Returns the current document head as an Ext Element */ + /** [Method] Returns the current document head as an Ext Element + * @returns Ext.Element The document head. + */ export function getHead(): Ext.IElement; /** [Method] Returns the current orientation of the mobile device */ export function getOrientation(): void; /** [Method] Shortcut to Ext data StoreManager lookup * @param store String/Object The id of the Store, or a Store instance, or a store configuration. + * @returns Ext.data.Store */ export function getStore( store?:any ): Ext.data.IStore; /** [Method] Old alias to Ext String htmlDecode * @param value String The string to decode. + * @returns String The decoded text. */ export function htmlDecode( value?:string ): string; /** [Method] Old alias to Ext String htmlEncode * @param value String The string to encode. + * @returns String The encoded text. */ export function htmlEncode( value?:string ): string; /** [Method] Generates unique ids * @param el Mixed The element to generate an id for. * @param prefix String The id prefix. + * @returns String The generated id. */ export function id( el?:any, prefix?:string ): string; /** [Method] Returns true if the passed value is a JavaScript Array false otherwise * @param target Object The target to test. + * @returns Boolean */ export function isArray( target?:any ): boolean; /** [Method] Returns true if the passed value is a Boolean * @param value Object The value to test. + * @returns Boolean */ export function isBoolean( value?:any ): boolean; /** [Method] Returns true if the passed value is a JavaScript Date object false otherwise * @param object Object The object to test. + * @returns Boolean */ export function isDate( object?:any ): boolean; /** [Method] Returns true if the passed value is defined * @param value Object The value to test. + * @returns Boolean */ export function isDefined( value?:any ): boolean; /** [Method] Returns true if the passed value is an HTMLElement * @param value Object The value to test. + * @returns Boolean */ export function isElement( value?:any ): boolean; /** [Method] Returns true if the passed value is empty false otherwise * @param value Object The value to test. * @param allowEmptyString Boolean true to allow empty strings. + * @returns Boolean */ export function isEmpty( value?:any, allowEmptyString?:boolean ): boolean; /** [Method] Returns true if the passed value is a JavaScript Function false otherwise * @param value Object The value to test. + * @returns Boolean */ export function isFunction( value?:any ): boolean; /** [Method] Returns true if the passed value is iterable false otherwise * @param value Object The value to test. + * @returns Boolean */ export function isIterable( value?:any ): boolean; /** [Method] Returns true if the passed value is a String that matches the MS Date JSON encoding format * @param value Object {String} The string to test + * @returns Boolean */ export function isMSDate( value?:any ): boolean; /** [Method] Returns true if the passed value is a number * @param value Object The value to test. + * @returns Boolean */ export function isNumber( value?:any ): boolean; /** [Method] Validates that a value is numeric * @param value Object Examples: 1, '1', '2.34' + * @returns Boolean true if numeric, false otherwise. */ export function isNumeric( value?:any ): boolean; /** [Method] Returns true if the passed value is a JavaScript Object false otherwise * @param value Object The value to test. + * @returns Boolean */ export function isObject( value?:any ): boolean; /** [Method] Returns true if the passed value is a JavaScript primitive a string number or Boolean * @param value Object The value to test. + * @returns Boolean */ export function isPrimitive( value?:any ): boolean; /** [Method] Returns true if the passed value is a string * @param value Object The value to test. + * @returns Boolean */ export function isString( value?:any ): boolean; /** [Method] Returns true if the passed value is a TextNode * @param value Object The value to test. + * @returns Boolean */ export function isTextNode( value?:any ): boolean; /** [Method] Iterates either an array or an object @@ -29735,12 +32961,12 @@ declare module Ext { /** [Method] Old alias to Ext Array max * @param array Array/NodeList The Array from which to select the maximum value. * @param comparisonFn Function a function to perform the comparison which determines maximization. If omitted the ">" operator will be used. Note: gt = 1; eq = 0; lt = -1 + * @returns Object maxValue The maximum value */ export function max( array?:any, comparisonFn?:any ): any; - export function max( array?:any[], comparisonFn?:any ): any; - export function max( array?:NodeList, comparisonFn?:any ): any; /** [Method] Old alias to Ext Array mean * @param array Array The Array to calculate the mean value of. + * @returns Number The mean. */ export function mean( array?:any[] ): number; /** [Method] A convenient alias method for Ext Object merge */ @@ -29748,14 +32974,14 @@ declare module Ext { /** [Method] Old alias to Ext Array min * @param array Array/NodeList The Array from which to select the minimum value. * @param comparisonFn Function a function to perform the comparison which determines minimization. If omitted the "<" operator will be used. Note: gt = 1; eq = 0; lt = -1 + * @returns Object minValue The minimum value. */ export function min( array?:any, comparisonFn?:any ): any; - export function min( array?:any[], comparisonFn?:any ): any; - export function min( array?:NodeList, comparisonFn?:any ): any; /** [Method] Creates namespaces to be used for scoping variables and classes so that they are not global * @param namespace1 String * @param namespace2 String * @param etc String + * @returns Object The namespace object. If multiple arguments are passed, this will be the last namespace created. */ export function namespace( namespace1?:string, namespace2?:string, etc?:string ): any; /** [Method] Convenient alias for Ext namespace */ @@ -29777,24 +33003,23 @@ declare module Ext { * @param fn Function The original function. * @param args Array The arguments to pass to new callback. * @param scope Object The scope (this reference) in which the function is executed. + * @returns Function The new callback function. */ export function pass( fn?:any, args?:any[], scope?:any ): any; /** [Method] Old alias to Ext Array pluck * @param array Array/NodeList The Array of items to pluck the value from. * @param propertyName String The property name to pluck from each element. + * @returns Array The value from each item in the Array. */ - export function pluck( array?:any, propertyName?:any ): any; - export function pluck( array?:any[], propertyName?:string ): any[]; - export function pluck( array?:NodeList, propertyName?:string ): any[]; + export function pluck( array?:any, propertyName?:string ): any[]; /** [Method] Registers a new ptype */ export function preg(): void; /** [Method] Shorthand of Ext dom Query select * @param selector String The selector/xpath query (can be a comma separated list of selectors) * @param root HTMLElement/String The start of the query (defaults to document). + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ - export function query( selector?:any, root?:any ): any; - export function query( selector?:string, root?:HTMLElement ): HTMLElement[]; - export function query( selector?:string, root?:string ): HTMLElement[]; + export function query( selector?:string, root?:any ): HTMLElement[]; /** [Method] Dispatches a request to a controller action adding to the History stack and updating the page url as necessary */ export function redirect(): void; /** [Method] Registers a new xtype */ @@ -29808,6 +33033,7 @@ declare module Ext { /** [Method] Old way for creating Model classes * @param name String Name of the Model class. * @param config Object A configuration object for the Model you wish to create. + * @returns Ext.data.Model The newly registered Model. */ export function regModel( name?:string, config?:any ): Ext.data.IModel; /** [Method] Creates a new store for the given id and config then registers it with the Store Manager @@ -29827,24 +33053,20 @@ declare module Ext { * @param scope Object The execution scope (this) of the callback function. * @param excludes String/Array Classes to be excluded, useful when being used with expressions. */ - export function require( expressions?:any, fn?:any, scope?:any, excludes?:any ): any; - export function require( expressions?:string, fn?:any, scope?:any, excludes?:string ): void; - export function require( expressions?:any[], fn?:any, scope?:any, excludes?:string ): void; - export function require( expressions?:string, fn?:any, scope?:any, excludes?:any[] ): void; - export function require( expressions?:any[], fn?:any, scope?:any, excludes?:any[] ): void; + export function require( expressions?:any, fn?:any, scope?:any, excludes?:any ): void; /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in * @param selector String/HTMLElement[] The CSS selector or an array of elements * @param composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - export function select( selector?:any, composite?:any ): any; - export function select( selector?:string, composite?:boolean ): Ext.dom.ICompositeElementLite; - export function select( selector?:HTMLElement[], composite?:boolean ): Ext.dom.ICompositeElementLite; + export function select( selector?:any, composite?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Ext setup is the entry point to initialize a Sencha Touch application * @param config Object An object with the following config options: */ export function setup( config?:any ): void; /** [Method] Old alias to Ext Array sum * @param array Array The Array to calculate the sum value of. + * @returns Number The sum. */ export function sum( array?:any[] ): number; /** [Method] Synchronous version of require convenient alias of Ext Loader syncRequire @@ -29853,32 +33075,33 @@ declare module Ext { * @param scope Object The execution scope (this) of the callback function * @param excludes String/Array Classes to be excluded, useful when being used with expressions */ - export function syncRequire( expressions?:any, fn?:any, scope?:any, excludes?:any ): any; - export function syncRequire( expressions?:string, fn?:any, scope?:any, excludes?:string ): void; - export function syncRequire( expressions?:any[], fn?:any, scope?:any, excludes?:string ): void; - export function syncRequire( expressions?:string, fn?:any, scope?:any, excludes?:any[] ): void; - export function syncRequire( expressions?:any[], fn?:any, scope?:any, excludes?:any[] ): void; + export function syncRequire( expressions?:any, fn?:any, scope?:any, excludes?:any ): void; /** [Method] Converts any iterable numeric indices and a length property into a true array * @param iterable Object the iterable object to be turned into a true Array. * @param start Number a zero-based index that specifies the start of extraction. * @param end Number a zero-based index that specifies the end of extraction. + * @returns Array */ export function toArray( iterable?:any, start?:number, end?:number ): any[]; /** [Method] Old alias to typeOf * @param value Object + * @returns String */ export function type( value?:any ): string; /** [Method] Returns the type of the given variable in string format * @param value Object + * @returns String */ export function typeOf( value?:any ): string; /** [Method] Old alias to Ext Array unique * @param array Array + * @returns Array results */ export function unique( array?:any[] ): any[]; /** [Method] Old alias to Ext String urlAppend * @param url String The URL to append to. * @param string String The content to append to the URL. + * @returns String The resulting URL. */ export function urlAppend( url?:string, string?:string ): string; /** [Method] A convenient alias method for Ext Object fromQueryString */ @@ -29889,10 +33112,12 @@ declare module Ext { * @param value Object The value to test. * @param defaultValue Object The value to return if the original value is empty. * @param allowBlank Boolean true to allow zero length strings to qualify as non-empty. + * @returns Object value, if non-empty, else defaultValue. */ export function valueFrom( value?:any, defaultValue?:any, allowBlank?:boolean ): any; /** [Method] Convenient shorthand to create a widget by its xtype also see Ext ClassManager instantiateByAlias var button Ext * @param name String + * @returns Object instance */ export function widget( name?:string ): any; } @@ -29903,14 +33128,17 @@ declare module Ext { /** [Method] Decodes parses a JSON string to an object * @param json String The JSON string. * @param safe Boolean Whether to return null or throw an exception if the JSON is invalid. + * @returns Object/null The resulting object. */ static decode( json?:string, safe?:boolean ): any; /** [Method] Encodes an Object Array or other value * @param o Object The variable to encode. + * @returns String The JSON string. */ static encode( o?:any ): string; /** [Method] Encodes a Date * @param d Date The Date to encode. + * @returns String The string literal to use in a JSON string. */ static encodeDate( d?:any ): string; } @@ -29921,7 +33149,9 @@ declare module Ext { baseCls?: string; /** [Config Option] (String) */ html?: string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -29937,16 +33167,14 @@ declare module Ext.layout { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -29958,9 +33186,7 @@ declare module Ext.layout { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -29968,9 +33194,7 @@ declare module Ext.layout { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -29978,27 +33202,32 @@ declare module Ext.layout { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -30008,18 +33237,14 @@ declare module Ext.layout { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -30027,28 +33252,25 @@ declare module Ext.layout { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -30057,16 +33279,14 @@ declare module Ext.layout { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -30074,18 +33294,14 @@ declare module Ext.layout { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -30093,9 +33309,7 @@ declare module Ext.layout { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -30109,25 +33323,21 @@ declare module Ext.layout { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.layout { @@ -30136,11 +33346,17 @@ declare module Ext.layout { align?: string; /** [Config Option] (String) */ pack?: string; - /** [Method] Returns the value of align */ + /** [Method] Returns the value of align + * @returns String + */ getAlign?(): string; - /** [Method] Returns the value of orient */ + /** [Method] Returns the value of orient + * @returns String + */ getOrient?(): string; - /** [Method] Returns the value of pack */ + /** [Method] Returns the value of pack + * @returns String + */ getPack?(): string; /** [Method] * @param item Object @@ -30179,7 +33395,9 @@ declare module Ext.layout { animation?: Ext.fx.layout.ICard; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of animation */ + /** [Method] Returns the value of animation + * @returns Ext.fx.layout.Card + */ getAnimation?(): Ext.fx.layout.ICard; /** [Method] * @param item Object @@ -30206,7 +33424,9 @@ declare module Ext.layout { export interface IFlexBox extends Ext.layout.IBox { /** [Config Option] (String) */ align?: string; - /** [Method] Returns the value of align */ + /** [Method] Returns the value of align + * @returns String + */ getAlign?(): string; /** [Method] * @param item Object @@ -30226,7 +33446,9 @@ declare module Ext.layout { } declare module Ext.layout { export interface IFloat extends Ext.layout.IDefault { - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; /** [Method] * @param item Object @@ -30245,7 +33467,9 @@ declare module Ext.layout { } declare module Ext.layout { export interface IVBox extends Ext.layout.IFlexBox { - /** [Method] Returns the value of orient */ + /** [Method] Returns the value of orient + * @returns String + */ getOrient?(): string; /** [Method] Sets the value of orient * @param orient String @@ -30257,17 +33481,29 @@ declare module Ext.layout.wrapper { export interface IBoxDock extends Ext.IBase { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of bodyElement */ + /** [Method] Returns the value of bodyElement + * @returns Object + */ getBodyElement?(): any; - /** [Method] Returns the value of container */ + /** [Method] Returns the value of container + * @returns Object + */ getContainer?(): any; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of innerWrapper */ + /** [Method] Returns the value of innerWrapper + * @returns Object + */ getInnerWrapper?(): any; - /** [Method] Returns the value of sizeState */ + /** [Method] Returns the value of sizeState + * @returns Boolean + */ getSizeState?(): boolean; /** [Method] Sets the value of bodyElement * @param bodyElement Object @@ -30299,17 +33535,29 @@ declare module Ext.layout.wrapper { export interface IDock extends Ext.IBase { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of bodyElement */ + /** [Method] Returns the value of bodyElement + * @returns Object + */ getBodyElement?(): any; - /** [Method] Returns the value of container */ + /** [Method] Returns the value of container + * @returns Object + */ getContainer?(): any; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of innerWrapper */ + /** [Method] Returns the value of innerWrapper + * @returns Object + */ getInnerWrapper?(): any; - /** [Method] Returns the value of sizeState */ + /** [Method] Returns the value of sizeState + * @returns Boolean + */ getSizeState?(): boolean; /** [Method] Sets the value of bodyElement * @param bodyElement Object @@ -30339,9 +33587,13 @@ declare module Ext.layout.wrapper { } declare module Ext.layout.wrapper { export interface IInner extends Ext.IBase { - /** [Method] Returns the value of container */ + /** [Method] Returns the value of container + * @returns Object + */ getContainer?(): any; - /** [Method] Returns the value of sizeState */ + /** [Method] Returns the value of sizeState + * @returns Object + */ getSizeState?(): any; /** [Method] Sets the value of container * @param container Object @@ -30359,18 +33611,22 @@ declare module Ext { export class Loader { /** [Method] Sets a batch of path entries * @param paths Object a set of className: path mappings + * @returns Ext.Loader this */ static addClassPathMappings( paths?:Object ): Ext.ILoader; /** [Method] Explicitly exclude files from being loaded * @param excludes Array + * @returns Object object contains require method for chaining. */ static exclude( excludes?:any[] ): any; /** [Method] Get the config value corresponding to the specified name * @param name String The config property name. + * @returns Object/Mixed */ static getConfig( name?:string ): any; /** [Method] Translates a className to a file path by adding the the proper prefix and converting the s to s * @param className String + * @returns String path */ static getPath( className?:string ): string; /** [Method] Add a new listener to be executed when all required scripts are fully loaded @@ -30385,19 +33641,17 @@ declare module Ext { * @param scope Object The execution scope (this) of the callback function. * @param excludes String/Array Classes to be excluded, useful when being used with expressions. */ - static require( expressions?:any, fn?:any, scope?:any, excludes?:any ): any; - static require( expressions?:string, fn?:any, scope?:any, excludes?:string ): void; - static require( expressions?:any[], fn?:any, scope?:any, excludes?:string ): void; - static require( expressions?:string, fn?:any, scope?:any, excludes?:any[] ): void; - static require( expressions?:any[], fn?:any, scope?:any, excludes?:any[] ): void; + static require( expressions?:any, fn?:any, scope?:any, excludes?:any ): void; /** [Method] Set the configuration for the loader * @param name Object/String The config object to override the default values or name of a single config setting when also passing the second parameter. * @param value Mixed The value for the config setting. + * @returns Ext.Loader this */ static setConfig( name?:any, value?:any ): Ext.ILoader; /** [Method] Sets the path of a namespace * @param name String/Object See flexSetter * @param path String See flexSetter + * @returns Ext.Loader this */ static setPath( name?:any, path?:string ): Ext.ILoader; /** [Method] Synchronously loads all classes by the given names and all their direct dependencies optionally executes the given c @@ -30406,11 +33660,7 @@ declare module Ext { * @param scope Object The execution scope (this) of the callback function * @param excludes String/Array Classes to be excluded, useful when being used with expressions */ - static syncRequire( expressions?:any, fn?:any, scope?:any, excludes?:any ): any; - static syncRequire( expressions?:string, fn?:any, scope?:any, excludes?:string ): void; - static syncRequire( expressions?:any[], fn?:any, scope?:any, excludes?:string ): void; - static syncRequire( expressions?:string, fn?:any, scope?:any, excludes?:any[] ): void; - static syncRequire( expressions?:any[], fn?:any, scope?:any, excludes?:any[] ): void; + static syncRequire( expressions?:any, fn?:any, scope?:any, excludes?:any ): void; } } declare module Ext { @@ -30431,11 +33681,17 @@ declare module Ext { * @param store Ext.data.Store The store to bind to this LoadMask */ bindStore?( store?:Ext.data.IStore ): void; - /** [Method] Returns the value of indicator */ + /** [Method] Returns the value of indicator + * @returns Boolean + */ getIndicator?(): boolean; - /** [Method] Returns the value of message */ + /** [Method] Returns the value of message + * @returns String + */ getMessage?(): string; - /** [Method] Returns the value of messageCls */ + /** [Method] Returns the value of messageCls + * @returns String + */ getMessageCls?(): string; /** [Method] Sets the value of indicator * @param indicator Boolean @@ -30464,6 +33720,7 @@ declare module Ext { /** [Method] Logs a message to help with debugging * @param message String Message to log. * @param priority Number Priority of the log message. + * @returns Ext.Logger this */ static log( message?:string, priority?:number ): Ext.ILogger; /** [Method] Convenience method for log with priority verbose */ @@ -30488,15 +33745,25 @@ declare module Ext { maskMapCls?: string; /** [Config Option] (Boolean/Ext.util.Geolocation) */ useCurrentLocation?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of geo */ + /** [Method] Returns the value of geo + * @returns Ext.util.Geolocation + */ getGeo?(): Ext.util.IGeolocation; - /** [Method] Returns the value of map */ + /** [Method] Returns the value of map + * @returns google.maps.Map + */ getMap?(): any; - /** [Method] Returns the state of the Map */ + /** [Method] Returns the state of the Map + * @returns Object mapOptions + */ getState?(): any; - /** [Method] Returns the value of useCurrentLocation */ + /** [Method] Returns the value of useCurrentLocation + * @returns Boolean/Ext.util.Geolocation + */ getUseCurrentLocation?(): any; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -30523,9 +33790,7 @@ declare module Ext { /** [Method] Sets the value of useCurrentLocation * @param useCurrentLocation Boolean/Ext.util.Geolocation */ - setUseCurrentLocation?( useCurrentLocation?:any ): any; - setUseCurrentLocation?( useCurrentLocation?:boolean ): void; - setUseCurrentLocation?( useCurrentLocation?:Ext.util.IGeolocation ): void; + setUseCurrentLocation?( useCurrentLocation?:any ): void; /** [Method] Moves the map center to the designated coordinates hash of the form latitude 37 381592 longitude 122 135672 * @param coordinates Object/google.maps.LatLng Object representing the desired Latitude and longitude upon which to center the map. */ @@ -30538,9 +33803,13 @@ declare module Ext { baseCls?: string; /** [Config Option] (Boolean) */ transparent?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of transparent */ + /** [Method] Returns the value of transparent + * @returns Boolean + */ getTransparent?(): boolean; /** [Method] Sets the value of baseCls * @param baseCls String @@ -30574,31 +33843,55 @@ declare module Ext { volume?: number; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of autoPause */ + /** [Method] Returns the value of autoPause + * @returns Boolean + */ getAutoPause?(): boolean; - /** [Method] Returns the value of autoResume */ + /** [Method] Returns the value of autoResume + * @returns Boolean + */ getAutoResume?(): boolean; - /** [Method] Returns the current time of the media in seconds */ + /** [Method] Returns the current time of the media in seconds + * @returns Number + */ getCurrentTime?(): number; - /** [Method] Returns the duration of the media in seconds */ + /** [Method] Returns the duration of the media in seconds + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of enableControls */ + /** [Method] Returns the value of enableControls + * @returns Boolean + */ getEnableControls?(): boolean; - /** [Method] Returns the value of loop */ + /** [Method] Returns the value of loop + * @returns Boolean + */ getLoop?(): boolean; - /** [Method] Returns the value of media */ + /** [Method] Returns the value of media + * @returns Ext.Element + */ getMedia?(): Ext.IElement; - /** [Method] Returns the value of muted */ + /** [Method] Returns the value of muted + * @returns Boolean + */ getMuted?(): boolean; - /** [Method] Returns the value of preload */ + /** [Method] Returns the value of preload + * @returns Boolean + */ getPreload?(): boolean; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; - /** [Method] Returns the value of volume */ + /** [Method] Returns the value of volume + * @returns Number + */ getVolume?(): number; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; - /** [Method] Returns if the media is currently playing */ + /** [Method] Returns if the media is currently playing + * @returns Boolean playing true if the media is playing. + */ isPlaying?(): boolean; /** [Method] Pauses media playback */ pause?(): void; @@ -30693,6 +33986,7 @@ declare module Ext { * @param message String The message box body text. * @param fn Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons. * @param scope Object The scope (this reference) in which the callback is executed. Defaults to: the browser window + * @returns Ext.MessageBox this */ alert?( title?:string, message?:string, fn?:any, scope?:any ): Ext.IMessageBox; /** [Method] Displays a confirmation message box with Yes and No buttons comparable to JavaScript s confirm @@ -30700,23 +33994,40 @@ declare module Ext { * @param message String The message box body text. * @param fn Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons. * @param scope Object The scope (this reference) in which the callback is executed. Defaults to: the browser window + * @returns Ext.MessageBox this */ confirm?( title?:string, message?:string, fn?:any, scope?:any ): Ext.IMessageBox; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of buttons */ + /** [Method] Returns the value of buttons + * @returns Array/Object + */ getButtons?(): any; - /** [Method] Returns the value of defaultTextHeight */ + /** [Method] Returns the value of defaultTextHeight + * @returns Number + */ getDefaultTextHeight?(): number; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of prompt */ + /** [Method] Returns the value of prompt + * @returns Object + */ getPrompt?(): any; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of zIndex */ + /** [Method] Returns the value of zIndex + * @returns Number + */ getZIndex?(): number; /** [Method] Sets the value of baseCls * @param baseCls String @@ -30736,6 +34047,7 @@ declare module Ext { setHideAnimation?( hideAnimation?:any ): void; /** [Method] Sets icon * @param iconCls String A CSS class name or empty string to clear the icon. + * @returns Ext.MessageBox this */ setIcon?( iconCls?:string ): Ext.IMessageBox; /** [Method] Sets the value of iconCls @@ -30772,10 +34084,12 @@ declare module Ext { setZIndex?( zIndex?:number ): void; /** [Method] Displays the Ext MessageBox with a specified configuration * @param config Object An object with the following config options: + * @returns Ext.MessageBox this */ show?( config?:any ): Ext.IMessageBox; /** [Method] Sets the value of message * @param message String + * @returns Ext.MessageBox this */ updateText?( message?:string ): Ext.IMessageBox; } @@ -30802,26 +34116,36 @@ declare module Ext.mixin { addFilter?( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Array An array with filters. A filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ addFilters?( filters?:any[] ): any; /** [Method] This method will sort an array based on the currently configured sorters * @param data Array The array you want to have sorted. + * @returns Array The array you passed after it is sorted. */ filter?( data?:any[] ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ getFilterFn?(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ getFilterRoot?(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ getFilters?(): any[]; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ insertFilter?( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ insertFilters?( index?:number, filters?:any[] ): any[]; /** [Method] This method removes all the filters in a passed array @@ -30840,8 +34164,10 @@ declare module Ext.mixin { } declare module Ext.mixin { export interface IIdentifiable extends Ext.IBase { - /** [Method] Retrieves the id of this component */ - getId?(): string; + /** [Method] Retrieves the id of this component + * @returns any id + */ + getId?(): any; } } declare module Ext.mixin { @@ -30860,16 +34186,14 @@ declare module Ext.mixin { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -30881,9 +34205,7 @@ declare module Ext.mixin { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -30891,9 +34213,7 @@ declare module Ext.mixin { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -30901,29 +34221,36 @@ declare module Ext.mixin { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Retrieves the id of this component */ - getId?(): string; - /** [Method] Returns the value of listeners */ + /** [Method] Retrieves the id of this component + * @returns any id + */ + getId?(): any; + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -30933,18 +34260,14 @@ declare module Ext.mixin { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -30952,28 +34275,25 @@ declare module Ext.mixin { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -30982,16 +34302,14 @@ declare module Ext.mixin { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -30999,18 +34317,14 @@ declare module Ext.mixin { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -31018,9 +34332,7 @@ declare module Ext.mixin { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -31034,25 +34346,21 @@ declare module Ext.mixin { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util { @@ -31067,16 +34375,14 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -31088,9 +34394,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -31098,9 +34402,7 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -31108,29 +34410,36 @@ declare module Ext.util { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Retrieves the id of this component */ - getId?(): string; - /** [Method] Returns the value of listeners */ + /** [Method] Retrieves the id of this component + * @returns any id + */ + getId?(): any; + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -31140,18 +34449,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -31159,28 +34464,25 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -31189,16 +34491,14 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -31206,18 +34506,14 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -31225,9 +34521,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -31241,25 +34535,21 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.mixin { @@ -31280,10 +34570,7 @@ declare module Ext.mixin { * @param records Number/Array/Ext.data.Model The record(s) to deselect. Can also be a number to reference by index. * @param suppressEvent Boolean If true the deselect event will not be fired. */ - deselect?( records?:any, suppressEvent?:any ): any; - deselect?( records?:number, suppressEvent?:boolean ): void; - deselect?( records?:any[], suppressEvent?:boolean ): void; - deselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; + deselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Deselects all records * @param supress Object */ @@ -31292,54 +34579,68 @@ declare module Ext.mixin { * @param records Ext.data.Model/Number An array of records or an index. * @param suppressEvent Boolean Set to false to not fire a deselect event. */ - doDeselect?( records?:any, suppressEvent?:any ): any; - doDeselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; - doDeselect?( records?:number, suppressEvent?:boolean ): void; + doDeselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Selects a record instance by record instance or index * @param records Ext.data.Model/Number An array of records or an index. * @param keepExisting Boolean * @param suppressEvent Boolean Set to false to not fire a select event. */ - doSelect?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - doSelect?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - doSelect?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; - /** [Method] Returns the value of allowDeselect */ + doSelect?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; + /** [Method] Returns the value of allowDeselect + * @returns Boolean + */ getAllowDeselect?(): boolean; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getCount?(): number; - /** [Method] Returns the value of deselectOnContainerClick */ + /** [Method] Returns the value of deselectOnContainerClick + * @returns Boolean + */ getDeselectOnContainerClick?(): boolean; - /** [Method] Returns the value of disableSelection */ + /** [Method] Returns the value of disableSelection + * @returns Boolean + */ getDisableSelection?(): boolean; - /** [Method] Returns the array of previously selected items */ + /** [Method] Returns the array of previously selected items + * @returns Array The previous selection. + */ getLastSelected?(): any[]; - /** [Method] Returns the value of mode */ + /** [Method] Returns the value of mode + * @returns String + */ getMode?(): string; - /** [Method] Returns an array of the currently selected records */ + /** [Method] Returns an array of the currently selected records + * @returns Array An array of selected records. + */ getSelection?(): any[]; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getSelectionCount?(): number; - /** [Method] Returns the selection mode currently used by this Selectable */ + /** [Method] Returns the selection mode currently used by this Selectable + * @returns String The current mode. + */ getSelectionMode?(): string; - /** [Method] Returns true if there is a selected record */ + /** [Method] Returns true if there is a selected record + * @returns Boolean + */ hasSelection?(): boolean; - /** [Method] Returns true if the Selectable is currently locked */ + /** [Method] Returns true if the Selectable is currently locked + * @returns Boolean True if currently locked + */ isLocked?(): boolean; /** [Method] Returns true if the specified row is selected * @param record Ext.data.Model/Number The record or index of the record to check. + * @returns Boolean */ - isSelected?( record?:any ): any; - isSelected?( record?:Ext.data.IModel ): boolean; - isSelected?( record?:number ): boolean; + isSelected?( record?:any ): boolean; /** [Method] Adds the given records to the currently selected set * @param records Ext.data.Model/Array/Number The records to select. * @param keepExisting Boolean If true, the existing selection will be added to (if not, the old selection is replaced). * @param suppressEvent Boolean If true, the select event will not be fired. */ - select?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - select?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:any[], keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; + select?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; /** [Method] Selects all records * @param silent Boolean true to suppress all select events. */ @@ -31402,15 +34703,24 @@ declare module Ext.mixin { /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ findInsertionIndex?( items?:any[], item?:any ): number; - /** [Method] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ getDefaultSortDirection?(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ getSortFn?(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ getSortRoot?(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ getSorters?(): any[]; /** [Method] This method adds a sorter at a given index * @param index Number The index at which to insert the sorter. @@ -31446,6 +34756,7 @@ declare module Ext.mixin { setSorters?( sorters?:any[] ): void; /** [Method] This method will sort an array based on the currently configured sorters * @param data Array The array you want to have sorted. + * @returns Array The array you passed after it is sorted. */ sort?( data?:any[] ): any[]; } @@ -31464,6 +34775,7 @@ declare module Ext { export class Msg { /** [Method] Adds one or more Components to this Container * @param newItems Object/Object[]/Ext.Component/Ext.Component[] The new items to add to the Container. + * @returns Ext.Component The last item added to the Container from the newItems array. */ static add( newItems?:any ): Ext.IComponent; /** [Method] Appends an after event handler @@ -31472,10 +34784,10 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds an array of Components to this Container * @param items Array The array of items to add to this container. + * @returns Array The array of items after they have been added. */ static addAll( items?:any[] ): any[]; /** [Method] Appends a before event handler @@ -31484,8 +34796,7 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds a CSS class or classes to this Component s rendered element * @param cls String The CSS class to add. * @param prefix String Optional prefix to add to each class. @@ -31503,9 +34814,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -31513,14 +34822,13 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Displays a standard read only message box with an OK button comparable to the basic JavaScript alert prompt * @param title String The title bar text. * @param message String The message box body text. * @param fn Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons. * @param scope Object The scope (this reference) in which the callback is executed. Defaults to: the browser window + * @returns Ext.MessageBox this */ static alert( title?:string, message?:string, fn?:any, scope?:any ): Ext.IMessageBox; /** [Method] Animates to the supplied activeItem with a specified animation @@ -31530,25 +34838,27 @@ declare module Ext { static animateActiveItem( activeItem?:any, animation?:any ): void; /** [Method] Changes the masked configuration when its setter is called which will convert the value into a proper object instanc * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask + * @returns Object */ static applyMasked( masked?:any ): any; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Retrieves the first direct child of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ static child( selector?:string ): Ext.IComponent; /** [Method] Removes all listeners for this object */ @@ -31558,6 +34868,7 @@ declare module Ext { * @param message String The message box body text. * @param fn Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons. * @param scope Object The scope (this reference) in which the callback is executed. Defaults to: the browser window + * @returns Ext.MessageBox this */ static confirm( title?:string, message?:string, fn?:any, scope?:any ): Ext.IMessageBox; /** [Method] */ @@ -31566,6 +34877,7 @@ declare module Ext { static disable(): void; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ static down( selector?:string ): Ext.IComponent; /** [Method] Enables this Component */ @@ -31573,195 +34885,342 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ static getActiveItem(): any; /** [Method] Returns the Component for a given index in the Container s items * @param index Number The index of the Component to return. + * @returns Ext.Component The item at the specified index, if found. */ static getAt( index?:number ): Ext.IComponent; - /** [Method] Returns the value of autoDestroy */ + /** [Method] Returns the value of autoDestroy + * @returns Boolean + */ static getAutoDestroy(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ static getBaseCls(): string; - /** [Method] Returns the value of bodyBorder */ + /** [Method] Returns the value of bodyBorder + * @returns Number/Boolean/String + */ static getBodyBorder(): any; - /** [Method] Returns the value of bodyMargin */ + /** [Method] Returns the value of bodyMargin + * @returns Number/Boolean/String + */ static getBodyMargin(): any; - /** [Method] Returns the value of bodyPadding */ + /** [Method] Returns the value of bodyPadding + * @returns Number/Boolean/String + */ static getBodyPadding(): any; - /** [Method] Returns the value of border */ + /** [Method] Returns the value of border + * @returns Number/String + */ static getBorder(): any; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns Number/String + */ static getBottom(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Returns the value of buttons */ + /** [Method] Returns the value of buttons + * @returns Array/Object + */ static getButtons(): any; - /** [Method] Returns the value of centered */ + /** [Method] Returns the value of centered + * @returns Boolean + */ static getCentered(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String/String[] + */ static getCls(): any; /** [Method] Examines this container s items property and gets a direct child component of this container * @param component String/Number This parameter may be any of the following: {String} : representing the itemId or id of the child component. {Number} : representing the position of the child component within the items property. For additional information see Ext.util.MixedCollection.get. + * @returns Ext.Component The component (if found). + */ + static getComponent( component?:any ): Ext.IComponent; + /** [Method] Returns the value of contentEl + * @returns Ext.Element/HTMLElement/String */ - static getComponent( component?:any ): any; - static getComponent( component?:string ): Ext.IComponent; - static getComponent( component?:number ): Ext.IComponent; - /** [Method] Returns the value of contentEl */ static getContentEl(): any; - /** [Method] Returns the value of control */ + /** [Method] Returns the value of control + * @returns Object + */ static getControl(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ static getData(): any; - /** [Method] Returns the value of defaultTextHeight */ + /** [Method] Returns the value of defaultTextHeight + * @returns Number + */ static getDefaultTextHeight(): number; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ static getDefaultType(): string; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ static getDefaults(): any; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ static getDisabled(): boolean; - /** [Method] Returns the value of disabledCls */ + /** [Method] Returns the value of disabledCls + * @returns String + */ static getDisabledCls(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ static getDocked(): string; /** [Method] Finds a docked item of this container using a reference idor an index of its location in getDockedItems * @param component String/Number The id or index of the component to find. + * @returns Ext.Component/Boolean The docked component, if found. */ static getDockedComponent( component?:any ): any; - static getDockedComponent( component?:string ): boolean; - static getDockedComponent( component?:number ): boolean; - /** [Method] Returns all the Ext Component docked items in this container */ + /** [Method] Returns all the Ext Component docked items in this container + * @returns Array The docked items of this container. + */ static getDockedItems(): any[]; - /** [Method] Retrieves the top level element representing this component */ + /** [Method] Retrieves the top level element representing this component + * @returns Ext.dom.Element + */ static getEl(): Ext.dom.IElement; - /** [Method] Returns the value of enter */ + /** [Method] Returns the value of enter + * @returns String + */ static getEnter(): string; - /** [Method] Returns the value of enterAnimation */ + /** [Method] Returns the value of enterAnimation + * @returns String/Mixed + */ static getEnterAnimation(): any; - /** [Method] Returns the value of exit */ + /** [Method] Returns the value of exit + * @returns String + */ static getExit(): string; - /** [Method] Returns the value of exitAnimation */ + /** [Method] Returns the value of exitAnimation + * @returns String/Mixed + */ static getExitAnimation(): any; - /** [Method] Returns the value of flex */ + /** [Method] Returns the value of flex + * @returns Number + */ static getFlex(): number; - /** [Method] Returns the value of floatingCls */ + /** [Method] Returns the value of floatingCls + * @returns String + */ static getFloatingCls(): string; - /** [Method] Returns the value of height */ + /** [Method] Returns the value of height + * @returns Number/String + */ static getHeight(): any; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ static getHidden(): boolean; - /** [Method] Returns the value of hiddenCls */ + /** [Method] Returns the value of hiddenCls + * @returns String + */ static getHiddenCls(): string; - /** [Method] Returns the value of hideAnimation */ + /** [Method] Returns the value of hideAnimation + * @returns Object + */ static getHideAnimation(): any; - /** [Method] Returns the value of hideOnMaskTap */ + /** [Method] Returns the value of hideOnMaskTap + * @returns Boolean + */ static getHideOnMaskTap(): boolean; - /** [Method] Returns the value of html */ + /** [Method] Returns the value of html + * @returns String/Ext.Element/HTMLElement + */ static getHtml(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns all inner items of this container */ + /** [Method] Returns all inner items of this container + * @returns Array The inner items of this container. + */ static getInnerItems(): any[]; - /** [Method] Returns the value of itemId */ + /** [Method] Returns the value of itemId + * @returns String + */ static getItemId(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ static getItems(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ static getLayout(): any; - /** [Method] Returns the value of left */ + /** [Method] Returns the value of left + * @returns Number/String + */ static getLeft(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; - /** [Method] Returns the value of margin */ + /** [Method] Returns the value of margin + * @returns Number/String + */ static getMargin(): any; - /** [Method] Returns the value of masked */ + /** [Method] Returns the value of masked + * @returns Boolean/Object/Ext.Mask/Ext.LoadMask + */ static getMasked(): any; - /** [Method] Returns the value of maxHeight */ + /** [Method] Returns the value of maxHeight + * @returns Number/String + */ static getMaxHeight(): any; - /** [Method] Returns the value of maxWidth */ + /** [Method] Returns the value of maxWidth + * @returns Number/String + */ static getMaxWidth(): any; - /** [Method] Returns the value of minHeight */ + /** [Method] Returns the value of minHeight + * @returns Number/String + */ static getMinHeight(): any; - /** [Method] Returns the value of minWidth */ + /** [Method] Returns the value of minWidth + * @returns Number/String + */ static getMinWidth(): any; - /** [Method] Returns the value of padding */ + /** [Method] Returns the value of padding + * @returns Number/String + */ static getPadding(): any; - /** [Method] Returns the parent of this component if it has one */ + /** [Method] Returns the parent of this component if it has one + * @returns Ext.Component The parent of this component. + */ static getParent(): Ext.IComponent; - /** [Method] Returns the value of plugins */ + /** [Method] Returns the value of plugins + * @returns Object/Array + */ static getPlugins(): any; - /** [Method] Returns the value of prompt */ + /** [Method] Returns the value of prompt + * @returns Object + */ static getPrompt(): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ static getRecord(): Ext.data.IModel; - /** [Method] Returns the value of renderTo */ + /** [Method] Returns the value of renderTo + * @returns Ext.Element + */ static getRenderTo(): Ext.IElement; - /** [Method] Returns the value of right */ + /** [Method] Returns the value of right + * @returns Number/String + */ static getRight(): any; - /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class */ + /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class + * @returns Ext.scroll.View The scroll view. + */ static getScrollable(): Ext.scroll.IView; - /** [Method] Returns the value of showAnimation */ + /** [Method] Returns the value of showAnimation + * @returns Object + */ static getShowAnimation(): any; - /** [Method] Returns the height and width of the Component */ + /** [Method] Returns the height and width of the Component + * @returns Object The current height and width of the Component. + */ static getSize(): any; - /** [Method] Returns the value of stretchX */ + /** [Method] Returns the value of stretchX + * @returns Boolean + */ static getStretchX(): boolean; - /** [Method] Returns the value of stretchY */ + /** [Method] Returns the value of stretchY + * @returns Boolean + */ static getStretchY(): boolean; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns String/Object + */ static getStyle(): any; - /** [Method] Returns the value of styleHtmlCls */ + /** [Method] Returns the value of styleHtmlCls + * @returns String + */ static getStyleHtmlCls(): string; - /** [Method] Returns the value of styleHtmlContent */ + /** [Method] Returns the value of styleHtmlContent + * @returns Boolean + */ static getStyleHtmlContent(): boolean; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ static getTitle(): string; - /** [Method] Returns the value of top */ + /** [Method] Returns the value of top + * @returns Number/String + */ static getTop(): any; - /** [Method] Returns the value of tpl */ + /** [Method] Returns the value of tpl + * @returns String/String[]/Ext.Template[]/Ext.XTemplate[] + */ static getTpl(): any; - /** [Method] Returns the value of tplWriteMode */ + /** [Method] Returns the value of tplWriteMode + * @returns String + */ static getTplWriteMode(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ static getUi(): string; - /** [Method] Returns the value of width */ + /** [Method] Returns the value of width + * @returns Number/String + */ static getWidth(): any; - /** [Method] Returns this Component s xtype hierarchy as a slash delimited string */ + /** [Method] Returns this Component s xtype hierarchy as a slash delimited string + * @returns String The xtype hierarchy string. + */ static getXTypes(): string; - /** [Method] Returns the value of zIndex */ + /** [Method] Returns the value of zIndex + * @returns Number + */ static getZIndex(): number; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; - /** [Method] Returns true if this component has a parent */ + /** [Method] Returns true if this component has a parent + * @returns Boolean true if this component has a parent. + */ static hasParent(): boolean; /** [Method] Hides this Component * @param animation Object/Boolean + * @returns Ext.Component */ static hide( animation?:any ): Ext.IComponent; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Allows addition of behavior to the rendering phase */ @@ -31771,13 +35230,18 @@ declare module Ext { * @param item Object The Component to insert. */ static insert( index?:number, item?:any ): void; - /** [Method] Returns true if this Component is currently disabled */ + /** [Method] Returns true if this Component is currently disabled + * @returns Boolean true if currently disabled. + */ static isDisabled(): boolean; - /** [Method] Returns true if this Component is currently hidden */ + /** [Method] Returns true if this Component is currently hidden + * @returns Boolean true if currently hidden. + */ static isHidden(): boolean; /** [Method] Tests whether or not this Component is of a specific xtype * @param xtype String The xtype to check for this Component. * @param shallow Boolean false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ static isXType( xtype?:string, shallow?:boolean ): boolean; /** [Method] Convenience method which calls setMasked with a value of true to show the mask @@ -31791,18 +35255,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -31810,25 +35270,21 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Displays a message box with OK and Cancel buttons prompting the user to enter some text comparable to JavaScript s p * @param title String The title bar text. * @param message String The message box body text. @@ -31837,22 +35293,24 @@ declare module Ext { * @param multiLine Boolean/Number true to create a multiline textbox using the defaultTextHeight property, or the height in pixels to create the textbox. * @param value String Default value of the text input element. * @param prompt Object The configuration for the prompt. See the prompt documentation in Ext.MessageBox for more information. + * @returns Ext.MessageBox this */ - static prompt( title?:any, message?:any, fn?:any, scope?:any, multiLine?:any, value?:any, prompt?:any ): any; - static prompt( title?:string, message?:string, fn?:any, scope?:any, multiLine?:boolean, value?:string, prompt?:any ): Ext.IMessageBox; - static prompt( title?:string, message?:string, fn?:any, scope?:any, multiLine?:number, value?:string, prompt?:any ): Ext.IMessageBox; + static prompt( title?:string, message?:string, fn?:any, scope?:any, multiLine?:any, value?:string, prompt?:any ): Ext.IMessageBox; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. + * @returns Array Ext.Component's which matched the selector. */ static query( selector?:string ): any[]; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes an item from this Container optionally destroying it * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ static remove( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes a before event handler @@ -31861,15 +35319,16 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all items currently in the Container optionally destroying them all * @param destroy Boolean If true, destroys each removed Component. * @param everything Boolean If true, completely remove all items including docked / centered and floating items. + * @returns Ext.Component this */ static removeAll( destroy?:boolean, everything?:boolean ): Ext.IComponent; /** [Method] Removes the Component at the specified index myContainer removeAt 0 removes the first item * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ static removeAt( index?:number ): Ext.IContainer; /** [Method] Removes a before event handler @@ -31878,8 +35337,7 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes the given CSS class es from this Component s rendered element * @param cls String The class(es) to remove. * @param prefix String Optional prefix to prepend before each class. @@ -31889,10 +35347,12 @@ declare module Ext { /** [Method] Removes a docked item from this Container * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ static removeDocked( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes an inner Component at the specified index myContainer removeInnerAt 0 removes the first item of the in * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ static removeInnerAt( index?:number ): Ext.IContainer; /** [Method] Removes an event handler @@ -31902,18 +35362,14 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Replaces specified classes with the newly specified classes * @param oldCls String The class(es) to remove. * @param newCls String The class(es) to add. @@ -31942,42 +35398,27 @@ declare module Ext { /** [Method] Sets the value of bodyBorder * @param bodyBorder Number/Boolean/String */ - static setBodyBorder( bodyBorder?:any ): any; - static setBodyBorder( bodyBorder?:number ): void; - static setBodyBorder( bodyBorder?:boolean ): void; - static setBodyBorder( bodyBorder?:string ): void; + static setBodyBorder( bodyBorder?:any ): void; /** [Method] Sets the value of bodyMargin * @param bodyMargin Number/Boolean/String */ - static setBodyMargin( bodyMargin?:any ): any; - static setBodyMargin( bodyMargin?:number ): void; - static setBodyMargin( bodyMargin?:boolean ): void; - static setBodyMargin( bodyMargin?:string ): void; + static setBodyMargin( bodyMargin?:any ): void; /** [Method] Sets the value of bodyPadding * @param bodyPadding Number/Boolean/String */ - static setBodyPadding( bodyPadding?:any ): any; - static setBodyPadding( bodyPadding?:number ): void; - static setBodyPadding( bodyPadding?:boolean ): void; - static setBodyPadding( bodyPadding?:string ): void; + static setBodyPadding( bodyPadding?:any ): void; /** [Method] Sets the value of border * @param border Number/String */ - static setBorder( border?:any ): any; - static setBorder( border?:number ): void; - static setBorder( border?:string ): void; + static setBorder( border?:any ): void; /** [Method] Sets the value of bottom * @param bottom Number/String */ - static setBottom( bottom?:any ): any; - static setBottom( bottom?:number ): void; - static setBottom( bottom?:string ): void; + static setBottom( bottom?:any ): void; /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of buttons * @param buttons Array/Object */ @@ -31989,16 +35430,11 @@ declare module Ext { /** [Method] Sets the value of cls * @param cls String/String[] */ - static setCls( cls?:any ): any; - static setCls( cls?:string ): void; - static setCls( cls?:string[] ): void; + static setCls( cls?:any ): void; /** [Method] Sets the value of contentEl * @param contentEl Ext.Element/HTMLElement/String */ - static setContentEl( contentEl?:any ): any; - static setContentEl( contentEl?:Ext.IElement ): void; - static setContentEl( contentEl?:HTMLElement ): void; - static setContentEl( contentEl?:string ): void; + static setContentEl( contentEl?:any ): void; /** [Method] Sets the value of control * @param control Object */ @@ -32042,8 +35478,7 @@ declare module Ext { /** [Method] Sets the value of enterAnimation * @param enterAnimation String/Mixed */ - static setEnterAnimation( enterAnimation?:any ): any; - static setEnterAnimation( enterAnimation?:string ): void; + static setEnterAnimation( enterAnimation?:any ): void; /** [Method] Sets the value of exit * @param exit String */ @@ -32051,8 +35486,7 @@ declare module Ext { /** [Method] Sets the value of exitAnimation * @param exitAnimation String/Mixed */ - static setExitAnimation( exitAnimation?:any ): any; - static setExitAnimation( exitAnimation?:string ): void; + static setExitAnimation( exitAnimation?:any ): void; /** [Method] Sets the value of flex * @param flex Number */ @@ -32068,9 +35502,7 @@ declare module Ext { /** [Method] Sets the value of height * @param height Number/String */ - static setHeight( height?:any ): any; - static setHeight( height?:number ): void; - static setHeight( height?:string ): void; + static setHeight( height?:any ): void; /** [Method] Sets the value of hidden * @param hidden Boolean */ @@ -32090,12 +35522,10 @@ declare module Ext { /** [Method] Sets the value of html * @param html String/Ext.Element/HTMLElement */ - static setHtml( html?:any ): any; - static setHtml( html?:string ): void; - static setHtml( html?:Ext.IElement ): void; - static setHtml( html?:HTMLElement ): void; + static setHtml( html?:any ): void; /** [Method] Sets icon * @param iconCls String A CSS class name or empty string to clear the icon. + * @returns Ext.MessageBox this */ static setIcon( iconCls?:string ): Ext.IMessageBox; /** [Method] Sets the value of iconCls @@ -32117,9 +35547,7 @@ declare module Ext { /** [Method] Sets the value of left * @param left Number/String */ - static setLeft( left?:any ): any; - static setLeft( left?:number ): void; - static setLeft( left?:string ): void; + static setLeft( left?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -32127,9 +35555,7 @@ declare module Ext { /** [Method] Sets the value of margin * @param margin Number/String */ - static setMargin( margin?:any ): any; - static setMargin( margin?:number ): void; - static setMargin( margin?:string ): void; + static setMargin( margin?:any ): void; /** [Method] Sets the value of masked * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask */ @@ -32137,15 +35563,11 @@ declare module Ext { /** [Method] Sets the value of maxHeight * @param maxHeight Number/String */ - static setMaxHeight( maxHeight?:any ): any; - static setMaxHeight( maxHeight?:number ): void; - static setMaxHeight( maxHeight?:string ): void; + static setMaxHeight( maxHeight?:any ): void; /** [Method] Sets the value of maxWidth * @param maxWidth Number/String */ - static setMaxWidth( maxWidth?:any ): any; - static setMaxWidth( maxWidth?:number ): void; - static setMaxWidth( maxWidth?:string ): void; + static setMaxWidth( maxWidth?:any ): void; /** [Method] Sets the value of message * @param message String */ @@ -32153,21 +35575,15 @@ declare module Ext { /** [Method] Sets the value of minHeight * @param minHeight Number/String */ - static setMinHeight( minHeight?:any ): any; - static setMinHeight( minHeight?:number ): void; - static setMinHeight( minHeight?:string ): void; + static setMinHeight( minHeight?:any ): void; /** [Method] Sets the value of minWidth * @param minWidth Number/String */ - static setMinWidth( minWidth?:any ): any; - static setMinWidth( minWidth?:number ): void; - static setMinWidth( minWidth?:string ): void; + static setMinWidth( minWidth?:any ): void; /** [Method] Sets the value of padding * @param padding Number/String */ - static setPadding( padding?:any ): any; - static setPadding( padding?:number ): void; - static setPadding( padding?:string ): void; + static setPadding( padding?:any ): void; /** [Method] Sets the value of plugins * @param plugins Object/Array */ @@ -32187,9 +35603,7 @@ declare module Ext { /** [Method] Sets the value of right * @param right Number/String */ - static setRight( right?:any ): any; - static setRight( right?:number ): void; - static setRight( right?:string ): void; + static setRight( right?:any ): void; /** [Method] Sets the value of scrollable * @param scrollable Boolean/String/Object */ @@ -32230,17 +35644,11 @@ declare module Ext { /** [Method] Sets the value of top * @param top Number/String */ - static setTop( top?:any ): any; - static setTop( top?:number ): void; - static setTop( top?:string ): void; + static setTop( top?:any ): void; /** [Method] Sets the value of tpl * @param tpl String/String[]/Ext.Template[]/Ext.XTemplate[] */ - static setTpl( tpl?:any ): any; - static setTpl( tpl?:string ): void; - static setTpl( tpl?:string[] ): void; - static setTpl( tpl?:Ext.ITemplate[] ): void; - static setTpl( tpl?:Ext.IXTemplate[] ): void; + static setTpl( tpl?:any ): void; /** [Method] Sets the value of tplWriteMode * @param tplWriteMode String */ @@ -32252,15 +35660,14 @@ declare module Ext { /** [Method] Sets the value of width * @param width Number/String */ - static setWidth( width?:any ): any; - static setWidth( width?:number ): void; - static setWidth( width?:string ): void; + static setWidth( width?:any ): void; /** [Method] Sets the value of zIndex * @param zIndex Number */ static setZIndex( zIndex?:number ): void; /** [Method] Displays the Ext MessageBox with a specified configuration * @param config Object An object with the following config options: + * @returns Ext.MessageBox this */ static show( config?:any ): Ext.IMessageBox; /** [Method] Shows this component by another component @@ -32268,7 +35675,9 @@ declare module Ext { * @param alignment String The specific alignment. */ static showBy( component?:Ext.IComponent, alignment?:string ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends the firing of all events */ static suspendEvents(): void; @@ -32279,29 +35688,26 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Convenience method which calls setMasked with a value of false to hide the mask */ static unmask(): void; /** [Method] Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector * @param selector String The simple selector to test. + * @returns Ext.Container The matching ancestor Container (or undefined if no match was found). */ static up( selector?:string ): Ext.IContainer; /** [Method] Updates the HTML content of the Component */ @@ -32313,6 +35719,7 @@ declare module Ext { static updateStyleHtmlCls( newHtmlCls?:any, oldHtmlCls?:any ): void; /** [Method] Sets the value of message * @param message String + * @returns Ext.MessageBox this */ static updateText( message?:string ): Ext.IMessageBox; } @@ -32327,13 +35734,21 @@ declare module Ext.navigation { cls?: string; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of androidAnimation */ + /** [Method] Returns the value of androidAnimation + * @returns Boolean + */ getAndroidAnimation?(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of androidAnimation * @param androidAnimation Boolean @@ -32365,27 +35780,43 @@ declare module Ext.navigation { navigationBar?: any; /** [Config Option] (Boolean) */ useTitleForBackButtonText?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultBackButtonText */ + /** [Method] Returns the value of defaultBackButtonText + * @returns String + */ getDefaultBackButtonText?(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ getItems?(): any; - /** [Method] Returns the value of navigationBar */ + /** [Method] Returns the value of navigationBar + * @returns Boolean/Object + */ getNavigationBar?(): any; - /** [Method] Returns the previous item if one exists */ + /** [Method] Returns the previous item if one exists + * @returns Mixed The previous view + */ getPreviousItem?(): any; - /** [Method] Returns the value of useTitleForBackButtonText */ + /** [Method] Returns the value of useTitleForBackButtonText + * @returns Boolean + */ getUseTitleForBackButtonText?(): boolean; /** [Method] Removes the current active view from the stack and sets the previous view using the default animation of this view * @param count Number The number of views you want to pop. + * @returns Ext.Component The new active item. */ pop?( count?:number ): Ext.IComponent; /** [Method] Pushes a new view into this navigation view using the default animation that this view has * @param view Object The view to push. + * @returns Ext.Component The new item you just pushed. */ push?( view?:any ): Ext.IComponent; - /** [Method] Resets the view by removing all items between the first and last item */ + /** [Method] Resets the view by removing all items between the first and last item + * @returns Ext.Component The view that is now active + */ reset?(): Ext.IComponent; /** [Method] Sets the value of baseCls * @param baseCls String @@ -32421,27 +35852,43 @@ declare module Ext { navigationBar?: any; /** [Config Option] (Boolean) */ useTitleForBackButtonText?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultBackButtonText */ + /** [Method] Returns the value of defaultBackButtonText + * @returns String + */ getDefaultBackButtonText?(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ getItems?(): any; - /** [Method] Returns the value of navigationBar */ + /** [Method] Returns the value of navigationBar + * @returns Boolean/Object + */ getNavigationBar?(): any; - /** [Method] Returns the previous item if one exists */ + /** [Method] Returns the previous item if one exists + * @returns Mixed The previous view + */ getPreviousItem?(): any; - /** [Method] Returns the value of useTitleForBackButtonText */ + /** [Method] Returns the value of useTitleForBackButtonText + * @returns Boolean + */ getUseTitleForBackButtonText?(): boolean; /** [Method] Removes the current active view from the stack and sets the previous view using the default animation of this view * @param count Number The number of views you want to pop. + * @returns Ext.Component The new active item. */ pop?( count?:number ): Ext.IComponent; /** [Method] Pushes a new view into this navigation view using the default animation that this view has * @param view Object The view to push. + * @returns Ext.Component The new item you just pushed. */ push?( view?:any ): Ext.IComponent; - /** [Method] Resets the view by removing all items between the first and last item */ + /** [Method] Resets the view by removing all items between the first and last item + * @returns Ext.Component The view that is now active + */ reset?(): Ext.IComponent; /** [Method] Sets the value of baseCls * @param baseCls String @@ -32473,11 +35920,13 @@ declare module Ext { * @param number Number The number to check * @param min Number The minimum number in the range * @param max Number The maximum number in the range + * @returns Number The constrained value if outside the range, otherwise the current value */ static constrain( number?:number, min?:number, max?:number ): number; /** [Method] Validate that a value is numeric and convert it to a number if necessary * @param value Object * @param defaultValue Number The value to return if the original value is non-numeric + * @returns Number value, if numeric, defaultValue otherwise */ static from( value?:any, defaultValue?:number ): number; /** [Method] Snaps the passed number between stopping points based upon a passed increment value @@ -32485,6 +35934,7 @@ declare module Ext { * @param increment Number The increment by which the value must move. * @param minValue Number The minimum value to which the returned value must be constrained. Overrides the increment.. * @param maxValue Number The maximum value to which the returned value must be constrained. Overrides the increment.. + * @returns Number The value of the nearest snap target. */ static snap( value?:number, increment?:number, minValue?:number, maxValue?:number ): number; /** [Method] Formats a number using fixed point notation @@ -32511,6 +35961,7 @@ declare module Ext { /** [Method] Converts a query string back into an object * @param queryString String The query string to decode. * @param recursive Boolean Whether or not to recursively decode the string. This format is supported by PHP / Ruby on Rails servers and similar. + * @returns Object */ static fromQueryString( queryString?:string, recursive?:boolean ): any; /** [Method] Returns the first matching key corresponding to the given value @@ -32520,30 +35971,36 @@ declare module Ext { static getKey( object?:any, value?:any ): void; /** [Method] Gets all keys of the given object as an array * @param object Object + * @returns String[] An array of keys from the object. */ static getKeys( object?:any ): string[]; /** [Method] Gets the total number of this object s own properties * @param object Object + * @returns Number size */ static getSize( object?:any ): number; /** [Method] Gets all values of the given object as an array * @param object Object + * @returns Array An array of values from the object. */ static getValues( object?:any ): any[]; /** [Method] Merges any number of objects recursively without referencing them or their children * @param source Object The first object into which to merge the others. * @param objs Object... One or more objects to be merged into the first. + * @returns Object The object that is created as a result of merging all the objects passed in. */ static merge( source:any, ...objs:any[] ): any; /** [Method] Convert a name value pair to an array of objects with support for nested structures useful to construct query stri * @param name String * @param value Object * @param recursive Boolean true to recursively encode any sub-objects. + * @returns Object[] Array of objects with name and value fields. */ static toQueryObjects( name?:string, value?:any, recursive?:boolean ): any[]; /** [Method] Takes an object and converts it to an encoded query string * @param object Object The object to encode. * @param recursive Boolean Whether or not to interpret the object in recursive format. (PHP / Ruby on Rails servers and similar). + * @returns String queryString */ static toQueryString( object?:any, recursive?:boolean ): string; } @@ -32554,34 +36011,39 @@ declare module Ext { export class Os { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] A hybrid property can be either accessed as a method call i e if Ext os is Android * @param value String The OS name to check. + * @returns Boolean */ static is( value?:string ): boolean; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -32595,13 +36057,21 @@ declare module Ext { bodyMargin?: any; /** [Config Option] (Number/Boolean/String) */ bodyPadding?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bodyBorder */ + /** [Method] Returns the value of bodyBorder + * @returns Number/Boolean/String + */ getBodyBorder?(): any; - /** [Method] Returns the value of bodyMargin */ + /** [Method] Returns the value of bodyMargin + * @returns Number/Boolean/String + */ getBodyMargin?(): any; - /** [Method] Returns the value of bodyPadding */ + /** [Method] Returns the value of bodyPadding + * @returns Number/Boolean/String + */ getBodyPadding?(): any; /** [Method] Sets the value of baseCls * @param baseCls String @@ -32610,24 +36080,15 @@ declare module Ext { /** [Method] Sets the value of bodyBorder * @param bodyBorder Number/Boolean/String */ - setBodyBorder?( bodyBorder?:any ): any; - setBodyBorder?( bodyBorder?:number ): void; - setBodyBorder?( bodyBorder?:boolean ): void; - setBodyBorder?( bodyBorder?:string ): void; + setBodyBorder?( bodyBorder?:any ): void; /** [Method] Sets the value of bodyMargin * @param bodyMargin Number/Boolean/String */ - setBodyMargin?( bodyMargin?:any ): any; - setBodyMargin?( bodyMargin?:number ): void; - setBodyMargin?( bodyMargin?:boolean ): void; - setBodyMargin?( bodyMargin?:string ): void; + setBodyMargin?( bodyMargin?:any ): void; /** [Method] Sets the value of bodyPadding * @param bodyPadding Number/Boolean/String */ - setBodyPadding?( bodyPadding?:any ): any; - setBodyPadding?( bodyPadding?:number ): void; - setBodyPadding?( bodyPadding?:boolean ): void; - setBodyPadding?( bodyPadding?:string ): void; + setBodyPadding?( bodyPadding?:any ): void; } } declare module Ext.lib { @@ -32640,13 +36101,21 @@ declare module Ext.lib { bodyMargin?: any; /** [Config Option] (Number/Boolean/String) */ bodyPadding?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bodyBorder */ + /** [Method] Returns the value of bodyBorder + * @returns Number/Boolean/String + */ getBodyBorder?(): any; - /** [Method] Returns the value of bodyMargin */ + /** [Method] Returns the value of bodyMargin + * @returns Number/Boolean/String + */ getBodyMargin?(): any; - /** [Method] Returns the value of bodyPadding */ + /** [Method] Returns the value of bodyPadding + * @returns Number/Boolean/String + */ getBodyPadding?(): any; /** [Method] Sets the value of baseCls * @param baseCls String @@ -32655,24 +36124,15 @@ declare module Ext.lib { /** [Method] Sets the value of bodyBorder * @param bodyBorder Number/Boolean/String */ - setBodyBorder?( bodyBorder?:any ): any; - setBodyBorder?( bodyBorder?:number ): void; - setBodyBorder?( bodyBorder?:boolean ): void; - setBodyBorder?( bodyBorder?:string ): void; + setBodyBorder?( bodyBorder?:any ): void; /** [Method] Sets the value of bodyMargin * @param bodyMargin Number/Boolean/String */ - setBodyMargin?( bodyMargin?:any ): any; - setBodyMargin?( bodyMargin?:number ): void; - setBodyMargin?( bodyMargin?:boolean ): void; - setBodyMargin?( bodyMargin?:string ): void; + setBodyMargin?( bodyMargin?:any ): void; /** [Method] Sets the value of bodyPadding * @param bodyPadding Number/Boolean/String */ - setBodyPadding?( bodyPadding?:any ): any; - setBodyPadding?( bodyPadding?:number ): void; - setBodyPadding?( bodyPadding?:boolean ): void; - setBodyPadding?( bodyPadding?:string ): void; + setBodyPadding?( bodyPadding?:any ): void; } } declare module Ext.picker { @@ -32693,23 +36153,38 @@ declare module Ext.picker { yearText?: string; /** [Config Option] (Number) */ yearTo?: number; - /** [Method] Returns the value of dayText */ + /** [Method] Returns the value of dayText + * @returns String + */ getDayText?(): string; - /** [Method] Returns the value of doneButton */ + /** [Method] Returns the value of doneButton + * @returns String/Mixed + */ getDoneButton?(): any; - /** [Method] Returns the value of monthText */ + /** [Method] Returns the value of monthText + * @returns String + */ getMonthText?(): string; - /** [Method] Returns the value of slotOrder */ + /** [Method] Returns the value of slotOrder + * @returns Array + */ getSlotOrder?(): any[]; /** [Method] Returns the values of each of the pickers slots * @param useDom Object + * @returns Object The values of the pickers slots */ getValue?( useDom?:any ): any; - /** [Method] Returns the value of yearFrom */ + /** [Method] Returns the value of yearFrom + * @returns Number + */ getYearFrom?(): number; - /** [Method] Returns the value of yearText */ + /** [Method] Returns the value of yearText + * @returns String + */ getYearText?(): string; - /** [Method] Returns the value of yearTo */ + /** [Method] Returns the value of yearTo + * @returns Number + */ getYearTo?(): number; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -32720,8 +36195,7 @@ declare module Ext.picker { /** [Method] Sets the value of doneButton * @param doneButton String/Mixed */ - setDoneButton?( doneButton?:any ): any; - setDoneButton?( doneButton?:string ): void; + setDoneButton?( doneButton?:any ): void; /** [Method] Sets the value of monthText * @param monthText String */ @@ -32733,6 +36207,7 @@ declare module Ext.picker { /** [Method] Sets the values of the pickers slots * @param value Object * @param animated Object + * @returns Ext.Picker this This picker. */ setValue?( value?:any, animated?:any ): Ext.IPicker; /** [Method] Sets the value of yearFrom @@ -32785,23 +36260,38 @@ declare module Ext { yearText?: string; /** [Config Option] (Number) */ yearTo?: number; - /** [Method] Returns the value of dayText */ + /** [Method] Returns the value of dayText + * @returns String + */ getDayText?(): string; - /** [Method] Returns the value of doneButton */ + /** [Method] Returns the value of doneButton + * @returns String/Mixed + */ getDoneButton?(): any; - /** [Method] Returns the value of monthText */ + /** [Method] Returns the value of monthText + * @returns String + */ getMonthText?(): string; - /** [Method] Returns the value of slotOrder */ + /** [Method] Returns the value of slotOrder + * @returns Array + */ getSlotOrder?(): any[]; /** [Method] Returns the values of each of the pickers slots * @param useDom Object + * @returns Object The values of the pickers slots */ getValue?( useDom?:any ): any; - /** [Method] Returns the value of yearFrom */ + /** [Method] Returns the value of yearFrom + * @returns Number + */ getYearFrom?(): number; - /** [Method] Returns the value of yearText */ + /** [Method] Returns the value of yearText + * @returns String + */ getYearText?(): string; - /** [Method] Returns the value of yearTo */ + /** [Method] Returns the value of yearTo + * @returns Number + */ getYearTo?(): number; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -32812,8 +36302,7 @@ declare module Ext { /** [Method] Sets the value of doneButton * @param doneButton String/Mixed */ - setDoneButton?( doneButton?:any ): any; - setDoneButton?( doneButton?:string ): void; + setDoneButton?( doneButton?:any ): void; /** [Method] Sets the value of monthText * @param monthText String */ @@ -32825,6 +36314,7 @@ declare module Ext { /** [Method] Sets the values of the pickers slots * @param value Object * @param animated Object + * @returns Ext.Picker this This picker. */ setValue?( value?:any, animated?:any ): Ext.IPicker; /** [Method] Sets the value of yearFrom @@ -32889,39 +36379,64 @@ declare module Ext.picker { value?: any; /** [Method] Updates the cancelButton configuration * @param config Object + * @returns Object */ applyCancelButton?( config?:any ): any; /** [Method] Updates the doneButton configuration * @param config Object + * @returns Object */ applyDoneButton?( config?:any ): any; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns Number + */ getBottom?(): number; - /** [Method] Returns the value of cancelButton */ + /** [Method] Returns the value of cancelButton + * @returns String/Mixed + */ getCancelButton?(): any; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ getCard?(): any; - /** [Method] Returns the value of doneButton */ + /** [Method] Returns the value of doneButton + * @returns String/Mixed + */ getDoneButton?(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of slots */ + /** [Method] Returns the value of slots + * @returns Array + */ getSlots?(): any[]; - /** [Method] Returns the value of toolbar */ + /** [Method] Returns the value of toolbar + * @returns Ext.TitleBar/Ext.Toolbar/Object + */ getToolbar?(): any; - /** [Method] Returns the value of toolbarPosition */ + /** [Method] Returns the value of toolbarPosition + * @returns String + */ getToolbarPosition?(): string; - /** [Method] Returns the value of useTitles */ + /** [Method] Returns the value of useTitles + * @returns Boolean + */ getUseTitles?(): boolean; /** [Method] Returns the values of each of the pickers slots * @param useDom Object + * @returns Object The values of the pickers slots */ getValue?( useDom?:any ): any; - /** [Method] Returns the values of each of the pickers slots */ + /** [Method] Returns the values of each of the pickers slots + * @returns Object The values of the pickers slots. + */ getValues?(): any; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -32936,8 +36451,7 @@ declare module Ext.picker { /** [Method] Sets the value of cancelButton * @param cancelButton String/Mixed */ - setCancelButton?( cancelButton?:any ): any; - setCancelButton?( cancelButton?:string ): void; + setCancelButton?( cancelButton?:any ): void; /** [Method] Sets the value of activeItem * @param activeItem Object/String/Number */ @@ -32945,8 +36459,7 @@ declare module Ext.picker { /** [Method] Sets the value of doneButton * @param doneButton String/Mixed */ - setDoneButton?( doneButton?:any ): any; - setDoneButton?( doneButton?:string ): void; + setDoneButton?( doneButton?:any ): void; /** [Method] Sets the value of height * @param height Number */ @@ -32982,9 +36495,12 @@ declare module Ext.picker { /** [Method] Sets the values of the pickers slots * @param values Object The values in a {name:'value'} format. * @param animated Boolean true to animate setting the values. + * @returns Ext.Picker this This picker. */ setValue?( values?:any, animated?:boolean ): Ext.IPicker; - /** [Method] Shows this component */ + /** [Method] Shows this component + * @returns Ext.Component + */ show?(): Ext.IComponent; } } @@ -33018,39 +36534,64 @@ declare module Ext { value?: any; /** [Method] Updates the cancelButton configuration * @param config Object + * @returns Object */ applyCancelButton?( config?:any ): any; /** [Method] Updates the doneButton configuration * @param config Object + * @returns Object */ applyDoneButton?( config?:any ): any; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns Number + */ getBottom?(): number; - /** [Method] Returns the value of cancelButton */ + /** [Method] Returns the value of cancelButton + * @returns String/Mixed + */ getCancelButton?(): any; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ getCard?(): any; - /** [Method] Returns the value of doneButton */ + /** [Method] Returns the value of doneButton + * @returns String/Mixed + */ getDoneButton?(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of slots */ + /** [Method] Returns the value of slots + * @returns Array + */ getSlots?(): any[]; - /** [Method] Returns the value of toolbar */ + /** [Method] Returns the value of toolbar + * @returns Ext.TitleBar/Ext.Toolbar/Object + */ getToolbar?(): any; - /** [Method] Returns the value of toolbarPosition */ + /** [Method] Returns the value of toolbarPosition + * @returns String + */ getToolbarPosition?(): string; - /** [Method] Returns the value of useTitles */ + /** [Method] Returns the value of useTitles + * @returns Boolean + */ getUseTitles?(): boolean; /** [Method] Returns the values of each of the pickers slots * @param useDom Object + * @returns Object The values of the pickers slots */ getValue?( useDom?:any ): any; - /** [Method] Returns the values of each of the pickers slots */ + /** [Method] Returns the values of each of the pickers slots + * @returns Object The values of the pickers slots. + */ getValues?(): any; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -33065,8 +36606,7 @@ declare module Ext { /** [Method] Sets the value of cancelButton * @param cancelButton String/Mixed */ - setCancelButton?( cancelButton?:any ): any; - setCancelButton?( cancelButton?:string ): void; + setCancelButton?( cancelButton?:any ): void; /** [Method] Sets the value of activeItem * @param activeItem Object/String/Number */ @@ -33074,8 +36614,7 @@ declare module Ext { /** [Method] Sets the value of doneButton * @param doneButton String/Mixed */ - setDoneButton?( doneButton?:any ): any; - setDoneButton?( doneButton?:string ): void; + setDoneButton?( doneButton?:any ): void; /** [Method] Sets the value of height * @param height Number */ @@ -33111,9 +36650,12 @@ declare module Ext { /** [Method] Sets the values of the pickers slots * @param values Object The values in a {name:'value'} format. * @param animated Boolean true to animate setting the values. + * @returns Ext.Picker this This picker. */ setValue?( values?:any, animated?:boolean ): Ext.IPicker; - /** [Method] Shows this component */ + /** [Method] Shows this component + * @returns Ext.Component + */ show?(): Ext.IComponent; } } @@ -33135,21 +36677,33 @@ declare module Ext.picker { valueField?: string; /** [Method] Looks at the data configuration and turns it into store * @param data Object + * @returns Object */ applyData?( data?:any ): any; /** [Method] Sets the title for this dataview by creating element * @param title String + * @returns String */ applyTitle?( title?:string ): string; - /** [Method] Returns the value of align */ + /** [Method] Returns the value of align + * @returns String + */ getAlign?(): string; - /** [Method] Returns the value of displayField */ + /** [Method] Returns the value of displayField + * @returns String + */ getDisplayField?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; - /** [Method] Returns the value of valueField */ + /** [Method] Returns the value of valueField + * @returns String + */ getValueField?(): string; /** [Method] Sets the value of align * @param align String @@ -33190,11 +36744,17 @@ declare module Ext.plugin { loadMoreText?: string; /** [Config Option] (String) */ noMoreRecordsText?: string; - /** [Method] Returns the value of autoPaging */ + /** [Method] Returns the value of autoPaging + * @returns Boolean + */ getAutoPaging?(): boolean; - /** [Method] Returns the value of loadMoreText */ + /** [Method] Returns the value of loadMoreText + * @returns String + */ getLoadMoreText?(): string; - /** [Method] Returns the value of noMoreRecordsText */ + /** [Method] Returns the value of noMoreRecordsText + * @returns String + */ getNoMoreRecordsText?(): string; /** [Method] Sets the value of autoPaging * @param autoPaging Boolean @@ -33234,29 +36794,53 @@ declare module Ext.plugin { releaseRefreshText?: string; /** [Config Option] (Number) */ snappingAnimationDuration?: number; - /** [Method] Returns the value of autoSnapBack */ + /** [Method] Returns the value of autoSnapBack + * @returns Boolean + */ getAutoSnapBack?(): boolean; - /** [Method] Returns the value of lastUpdatedDateFormat */ + /** [Method] Returns the value of lastUpdatedDateFormat + * @returns String + */ getLastUpdatedDateFormat?(): string; - /** [Method] Returns the value of lastUpdatedText */ + /** [Method] Returns the value of lastUpdatedText + * @returns String + */ getLastUpdatedText?(): string; - /** [Method] Returns the value of list */ + /** [Method] Returns the value of list + * @returns Ext.dataview.List + */ getList?(): Ext.dataview.IList; - /** [Method] Returns the value of loadedText */ + /** [Method] Returns the value of loadedText + * @returns String + */ getLoadedText?(): string; - /** [Method] Returns the value of loadingText */ + /** [Method] Returns the value of loadingText + * @returns String + */ getLoadingText?(): string; - /** [Method] Returns the value of overpullSnapBackDuration */ + /** [Method] Returns the value of overpullSnapBackDuration + * @returns Number + */ getOverpullSnapBackDuration?(): number; - /** [Method] Returns the value of pullRefreshText */ + /** [Method] Returns the value of pullRefreshText + * @returns String + */ getPullRefreshText?(): string; - /** [Method] Returns the value of pullTpl */ + /** [Method] Returns the value of pullTpl + * @returns Ext.XTemplate/String/Array + */ getPullTpl?(): any; - /** [Method] Returns the value of releaseRefreshText */ + /** [Method] Returns the value of releaseRefreshText + * @returns String + */ getReleaseRefreshText?(): string; - /** [Method] Returns the value of snappingAnimationDuration */ + /** [Method] Returns the value of snappingAnimationDuration + * @returns Number + */ getSnappingAnimationDuration?(): number; - /** [Method] Returns the value of translatable */ + /** [Method] Returns the value of translatable + * @returns Boolean + */ getTranslatable?(): boolean; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -33295,10 +36879,7 @@ declare module Ext.plugin { /** [Method] Sets the value of pullTpl * @param pullTpl Ext.XTemplate/String/Array */ - setPullTpl?( pullTpl?:any ): any; - setPullTpl?( pullTpl?:Ext.IXTemplate ): void; - setPullTpl?( pullTpl?:string ): void; - setPullTpl?( pullTpl?:any[] ): void; + setPullTpl?( pullTpl?:any ): void; /** [Method] Sets the value of releaseRefreshText * @param releaseRefreshText String */ @@ -33331,25 +36912,45 @@ declare module Ext.scroll.indicator { hidden?: boolean; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of active */ + /** [Method] Returns the value of active + * @returns Boolean + */ getActive?(): boolean; - /** [Method] Returns the value of axis */ + /** [Method] Returns the value of axis + * @returns String + */ getAxis?(): string; - /** [Method] Returns the value of barCls */ + /** [Method] Returns the value of barCls + * @returns String + */ getBarCls?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ getHidden?(): boolean; - /** [Method] Returns the value of length */ + /** [Method] Returns the value of length + * @returns Object + */ getLength?(): any; - /** [Method] Returns the value of minLength */ + /** [Method] Returns the value of minLength + * @returns Number + */ getMinLength?(): number; - /** [Method] Returns the value of ratio */ + /** [Method] Returns the value of ratio + * @returns Number + */ getRatio?(): number; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Object + */ getValue?(): any; /** [Method] Sets the value of active * @param active Boolean @@ -33397,7 +36998,9 @@ declare module Ext.scroll.indicator { export interface ICssTransform extends Ext.scroll.indicator.IAbstract { /** [Config Option] (String/String[]) */ cls?: any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; /** [Method] Sets the value of cls * @param cls String @@ -33417,7 +37020,9 @@ declare module Ext.scroll.indicator { export interface IRounded extends Ext.scroll.indicator.IAbstract { /** [Config Option] (String/String[]) */ cls?: any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; /** [Method] Sets the value of cls * @param cls String @@ -33429,7 +37034,9 @@ declare module Ext.scroll.indicator { export interface IScrollPosition extends Ext.scroll.indicator.IAbstract { /** [Config Option] (String/String[]) */ cls?: any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; /** [Method] Sets the value of cls * @param cls String @@ -33457,40 +37064,60 @@ declare module Ext.scroll { slotSnapSize?: any; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of directionLock */ + /** [Method] Returns the value of directionLock + * @returns Boolean + */ getDirectionLock?(): boolean; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ getDisabled?(): boolean; - /** [Method] Returns the value of initialOffset */ + /** [Method] Returns the value of initialOffset + * @returns Object/Number + */ getInitialOffset?(): any; - /** [Method] Returns the value of momentumEasing */ + /** [Method] Returns the value of momentumEasing + * @returns Object + */ getMomentumEasing?(): any; - /** [Method] Returns the value of slotSnapEasing */ + /** [Method] Returns the value of slotSnapEasing + * @returns Object + */ getSlotSnapEasing?(): any; - /** [Method] Returns the value of slotSnapSize */ + /** [Method] Returns the value of slotSnapSize + * @returns Number/Object + */ getSlotSnapSize?(): any; - /** [Method] Returns the value of translatable */ + /** [Method] Returns the value of translatable + * @returns Object + */ getTranslatable?(): any; /** [Method] Returns true if a specified axis is enabled * @param axis String The axis to check (x or y). + * @returns Boolean true if the axis is enabled. */ isAxisEnabled?( axis?:string ): boolean; /** [Method] Change the scroll offset by the given amount * @param x Number The offset to scroll by on the x axis. * @param y Number The offset to scroll by on the y axis. * @param animation Boolean/Object Whether or not to animate the scrolling to the new position. + * @returns Ext.scroll.Scroller this */ scrollBy?( x?:number, y?:number, animation?:any ): Ext.scroll.IScroller; /** [Method] Scrolls to the given location * @param x Number The scroll position on the x axis. * @param y Number The scroll position on the y axis. * @param animation Boolean/Object Whether or not to animate the scrolling to the new position. + * @returns Ext.scroll.Scroller this */ scrollTo?( x?:number, y?:number, animation?:any ): Ext.scroll.IScroller; /** [Method] Scrolls to the end of the scrollable view * @param animation Object + * @returns Ext.scroll.Scroller this */ scrollToEnd?( animation?:any ): Ext.scroll.IScroller; /** [Method] Sets the value of direction @@ -33515,6 +37142,7 @@ declare module Ext.scroll { setMomentumEasing?( momentumEasing?:any ): void; /** [Method] Sets the offset of this scroller * @param offset Object The offset to move to. + * @returns Ext.scroll.Scroller this */ setOffset?( offset?:any ): Ext.scroll.IScroller; /** [Method] Sets the value of slotSnapEasing @@ -33529,7 +37157,9 @@ declare module Ext.scroll { * @param translatable Object */ setTranslatable?( translatable?:any ): void; - /** [Method] Updates the boundary information for this scroller */ + /** [Method] Updates the boundary information for this scroller + * @returns Ext.scroll.Scroller this + */ updateBoundary?(): Ext.scroll.IScroller; } } @@ -33539,17 +37169,29 @@ declare module Ext.scroll { indicatorsUi?: string; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of indicators */ + /** [Method] Returns the value of indicators + * @returns Object + */ getIndicators?(): any; - /** [Method] Returns the value of indicatorsHidingDelay */ + /** [Method] Returns the value of indicatorsHidingDelay + * @returns Number + */ getIndicatorsHidingDelay?(): number; - /** [Method] Returns the value of indicatorsUi */ + /** [Method] Returns the value of indicatorsUi + * @returns String + */ getIndicatorsUi?(): string; - /** [Method] Returns the scroller instance in this view */ + /** [Method] Returns the scroller instance in this view + * @returns Ext.scroll.View The scroller + */ getScroller?(): Ext.scroll.IView; /** [Method] Sets the value of cls * @param cls String @@ -33583,17 +37225,29 @@ declare module Ext.util { indicatorsUi?: string; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of indicators */ + /** [Method] Returns the value of indicators + * @returns Object + */ getIndicators?(): any; - /** [Method] Returns the value of indicatorsHidingDelay */ + /** [Method] Returns the value of indicatorsHidingDelay + * @returns Number + */ getIndicatorsHidingDelay?(): number; - /** [Method] Returns the value of indicatorsUi */ + /** [Method] Returns the value of indicatorsUi + * @returns String + */ getIndicatorsUi?(): string; - /** [Method] Returns the scroller instance in this view */ + /** [Method] Returns the scroller instance in this view + * @returns Ext.scroll.View The scroller + */ getScroller?(): Ext.scroll.IView; /** [Method] Sets the value of cls * @param cls String @@ -33641,26 +37295,43 @@ declare module Ext { pressedCls?: string; /** [Method] We override initItems so we can check for the pressed config */ applyItems?(): void; - /** [Method] Returns the value of allowDepress */ + /** [Method] Returns the value of allowDepress + * @returns Boolean + */ getAllowDepress?(): boolean; - /** [Method] Returns the value of allowMultiple */ + /** [Method] Returns the value of allowMultiple + * @returns Boolean + */ getAllowMultiple?(): boolean; - /** [Method] Returns the value of allowToggle */ + /** [Method] Returns the value of allowToggle + * @returns Boolean + */ getAllowToggle?(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; /** [Method] Gets the currently pressed button s */ getPressed?(): void; - /** [Method] Returns the value of pressedButtons */ + /** [Method] Returns the value of pressedButtons + * @returns Array + */ getPressedButtons?(): any[]; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; /** [Method] Returns true if a specified Ext Button is pressed * @param button Ext.Button The button to check if pressed. + * @returns Boolean pressed */ isPressed?( button?:Ext.IButton ): boolean; /** [Method] Sets the value of allowDepress @@ -33692,10 +37363,7 @@ declare module Ext { * @param pressed Boolean If defined, sets the pressed state of the button, otherwise the pressed state is toggled. * @param suppressEvents Boolean true to suppress toggle events during the action. If allowMultiple is true, then setPressed will toggle the button state. */ - setPressed?( button?:any, pressed?:any, suppressEvents?:any ): any; - setPressed?( button?:number, pressed?:boolean, suppressEvents?:boolean ): void; - setPressed?( button?:string, pressed?:boolean, suppressEvents?:boolean ): void; - setPressed?( button?:Ext.IButton, pressed?:boolean, suppressEvents?:boolean ): void; + setPressed?( button?:any, pressed?:boolean, suppressEvents?:boolean ): void; /** [Method] Sets the value of pressedButtons * @param pressedButtons Array */ @@ -33726,19 +37394,33 @@ declare module Ext { stretchX?: boolean; /** [Config Option] (Boolean) */ stretchY?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of centered */ + /** [Method] Returns the value of centered + * @returns Boolean + */ getCentered?(): boolean; - /** [Method] Returns the value of enter */ + /** [Method] Returns the value of enter + * @returns String + */ getEnter?(): string; - /** [Method] Returns the value of exit */ + /** [Method] Returns the value of exit + * @returns String + */ getExit?(): string; - /** [Method] Returns the value of modal */ + /** [Method] Returns the value of modal + * @returns Boolean + */ getModal?(): boolean; - /** [Method] Returns the value of stretchX */ + /** [Method] Returns the value of stretchX + * @returns Boolean + */ getStretchX?(): boolean; - /** [Method] Returns the value of stretchY */ + /** [Method] Returns the value of stretchY + * @returns Boolean + */ getStretchY?(): boolean; /** [Method] Sets the value of baseCls * @param baseCls String @@ -33804,33 +37486,57 @@ declare module Ext.slider { values?: any; /** [Method] Sets the increment configuration * @param increment Number + * @returns Number */ applyIncrement?( increment?:number ): number; - /** [Method] Returns the value of allowThumbsOverlapping */ + /** [Method] Returns the value of allowThumbsOverlapping + * @returns Boolean + */ getAllowThumbsOverlapping?(): boolean; - /** [Method] Returns the value of animation */ + /** [Method] Returns the value of animation + * @returns Boolean/Object + */ getAnimation?(): any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of increment */ + /** [Method] Returns the value of increment + * @returns Number + */ getIncrement?(): number; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; /** [Method] Returns the Thumb instance bound to this Slider * @param index Number The index of Thumb to return. + * @returns Ext.slider.Thumb The thumb instance */ getThumb?( index?:number ): Ext.slider.IThumb; - /** [Method] Returns the value of thumbConfig */ + /** [Method] Returns the value of thumbConfig + * @returns Object + */ getThumbConfig?(): any; - /** [Method] Returns the Thumb instances bound to this Slider */ + /** [Method] Returns the Thumb instances bound to this Slider + * @returns Ext.slider.Thumb[] The thumb instances + */ getThumbs?(): Ext.slider.IThumb[]; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number/Number[] + */ getValue?(): any; - /** [Method] Convenience method */ + /** [Method] Convenience method + * @returns Object + */ getValues?(): any; /** [Method] Sets the value of allowThumbsOverlapping * @param allowThumbsOverlapping Boolean @@ -33867,9 +37573,7 @@ declare module Ext.slider { /** [Method] Sets the value of value * @param value Number/Number[] */ - setValue?( value?:any ): any; - setValue?( value?:number ): void; - setValue?( value?:number[] ): void; + setValue?( value?:any ): void; /** [Method] Convenience method * @param value Object */ @@ -33887,9 +37591,13 @@ declare module Ext.slider { baseCls?: string; /** [Config Option] (Object) */ draggable?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of draggable */ + /** [Method] Returns the value of draggable + * @returns Object + */ getDraggable?(): any; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -33911,13 +37619,21 @@ declare module Ext.slider { maxValueCls?: string; /** [Config Option] (String) */ minValueCls?: string; - /** [Method] Sets the increment configuration */ + /** [Method] Sets the increment configuration + * @returns Number + */ applyIncrement?(): number; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of maxValueCls */ + /** [Method] Returns the value of maxValueCls + * @returns String + */ getMaxValueCls?(): string; - /** [Method] Returns the value of minValueCls */ + /** [Method] Returns the value of minValueCls + * @returns String + */ getMinValueCls?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -33944,7 +37660,9 @@ declare module Ext { flex?: number; /** [Config Option] (Number) */ width?: number; - /** [Method] Returns the value of flex */ + /** [Method] Returns the value of flex + * @returns Number + */ getFlex?(): number; /** [Method] Sets the value of flex * @param flex Number @@ -33962,39 +37680,47 @@ declare module Ext { export class String { /** [Method] Capitalize the given string * @param string String + * @returns String */ static capitalize( string?:string ): string; /** [Method] Truncate a string and add an ellipsis to the end if it exceeds the specified length * @param value String The string to truncate. * @param length Number The maximum length to allow before truncating. * @param word Boolean true to try to find a common word break. + * @returns String The converted text. */ static ellipsis( value?:string, length?:number, word?:boolean ): string; /** [Method] Escapes the passed string for and * @param string String The string to escape. + * @returns String The escaped string. */ static escape( string?:string ): string; /** [Method] Escapes the passed string for use in a regular expression * @param string String + * @returns String */ static escapeRegex( string?:string ): string; /** [Method] Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens * @param string String The tokenized string to be formatted. * @param values String... First param value to replace token {0}, then next param to replace {1} etc. + * @returns String The formatted string. */ static format( string:string, ...values:any[] ): string; /** [Method] Convert certain characters amp lt and from their HTML character equivalents * @param value String The string to decode. + * @returns String The decoded text. */ static htmlDecode( value?:string ): string; /** [Method] Convert certain characters amp lt and to their HTML character equivalents for literal display in web pages * @param value String The string to encode. + * @returns String The encoded text. */ static htmlEncode( value?:string ): string; /** [Method] Pads the left side of a string with a specified character * @param string String The original string. * @param size Number The total length of the output string. * @param character String The character with which to pad the original string (defaults to empty string " "). + * @returns String The padded string. */ static leftPad( string?:string, size?:number, character?:string ): string; /** [Method] Returns a string with a specified number of repetitions a given string pattern @@ -34007,15 +37733,18 @@ declare module Ext { * @param string String The current string. * @param value String The value to compare to the current string. * @param other String The new value to use if the string already equals the first value passed in. + * @returns String The new value. */ static toggle( string?:string, value?:string, other?:string ): string; /** [Method] Trims whitespace from either end of a string leaving spaces within the string intact * @param string String The string to escape + * @returns String The trimmed string */ static trim( string?:string ): string; /** [Method] Appends content to the query string of a URL handling logic for whether to place a question mark or ampersand * @param url String The URL to append to. * @param string String The content to append to the URL. + * @returns String The resulting URL. */ static urlAppend( url?:string, string?:string ): string; } @@ -34040,19 +37769,20 @@ declare module Ext.tab { activeTab?: any; /** [Config Option] (String) */ baseCls?: string; - /** [Method] Returns the value of activeTab */ + /** [Method] Returns the value of activeTab + * @returns Number/String/Ext.Component + */ getActiveTab?(): any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; /** [Method] Sets the value of activeTab * @param activeTab Number/String/Ext.Component */ - setActiveTab?( activeTab?:any ): any; - setActiveTab?( activeTab?:number ): void; - setActiveTab?( activeTab?:string ): void; - setActiveTab?( activeTab?:Ext.IComponent ): void; + setActiveTab?( activeTab?:any ): void; /** [Method] Sets the value of baseCls * @param baseCls String */ @@ -34065,19 +37795,20 @@ declare module Ext { activeTab?: any; /** [Config Option] (String) */ baseCls?: string; - /** [Method] Returns the value of activeTab */ + /** [Method] Returns the value of activeTab + * @returns Number/String/Ext.Component + */ getActiveTab?(): any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; /** [Method] Sets the value of activeTab * @param activeTab Number/String/Ext.Component */ - setActiveTab?( activeTab?:any ): any; - setActiveTab?( activeTab?:number ): void; - setActiveTab?( activeTab?:string ): void; - setActiveTab?( activeTab?:Ext.IComponent ): void; + setActiveTab?( activeTab?:any ): void; /** [Method] Sets the value of baseCls * @param baseCls String */ @@ -34101,17 +37832,28 @@ declare module Ext.tab { /** [Method] Updates this container with the new active item * @param tabBar Object * @param newTab Object + * @returns Boolean */ doTabChange?( tabBar?:any, newTab?:any ): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of tabBar */ + /** [Method] Returns the value of tabBar + * @returns Object + */ getTabBar?(): any; - /** [Method] Returns the value of tabBarPosition */ + /** [Method] Returns the value of tabBarPosition + * @returns String + */ getTabBarPosition?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -34159,17 +37901,28 @@ declare module Ext { /** [Method] Updates this container with the new active item * @param tabBar Object * @param newTab Object + * @returns Boolean */ doTabChange?( tabBar?:any, newTab?:any ): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of tabBar */ + /** [Method] Returns the value of tabBar + * @returns Object + */ getTabBar?(): any; - /** [Method] Returns the value of tabBarPosition */ + /** [Method] Returns the value of tabBarPosition + * @returns String + */ getTabBarPosition?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -34212,15 +37965,25 @@ declare module Ext.tab { pressedCls?: string; /** [Config Option] (String) */ title?: string; - /** [Method] Returns the value of active */ + /** [Method] Returns the value of active + * @returns Boolean + */ getActive?(): boolean; - /** [Method] Returns the value of activeCls */ + /** [Method] Returns the value of activeCls + * @returns String + */ getActiveCls?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Sets the value of active * @param active Boolean @@ -34256,15 +38019,25 @@ declare module Ext { pressedCls?: string; /** [Config Option] (String) */ title?: string; - /** [Method] Returns the value of active */ + /** [Method] Returns the value of active + * @returns Boolean + */ getActive?(): boolean; - /** [Method] Returns the value of activeCls */ + /** [Method] Returns the value of activeCls + * @returns String + */ getActiveCls?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Sets the value of active * @param active Boolean @@ -34294,30 +38067,34 @@ declare module Ext { export class TaskQueue { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -34333,65 +38110,61 @@ declare module Ext { * @param el String/HTMLElement/Ext.Element The context element. * @param values Object/Array The template values. See applyTemplate for details. * @param returnElement Boolean true to return an Ext.Element. + * @returns HTMLElement/Ext.Element The new node or Element. */ - append?( el?:any, values?:any, returnElement?:any ): any; - append?( el?:string, values?:any, returnElement?:boolean ): any; - append?( el?:HTMLElement, values?:any, returnElement?:boolean ): any; - append?( el?:Ext.IElement, values?:any, returnElement?:boolean ): any; + append?( el?:any, values?:any, returnElement?:boolean ): any; /** [Method] Returns an HTML fragment of this template with the specified values applied * @param values Object/Array The template values. Can be an array if your params are numeric: var tpl = new Ext.Template('Name: {0}, Age: {1}'); tpl.apply(['John', 25]); or an object: var tpl = new Ext.Template('Name: {name}, Age: {age}'); tpl.apply({name: 'John', age: 25}); + * @returns String The HTML fragment. */ apply?( values?:any ): string; /** [Method] Appends the result of this template to the provided output array * @param values Object/Array The template values. See apply. * @param out Array The array to which output is pushed. + * @returns Array The given out array. */ applyOut?( values?:any, out?:any[] ): any[]; /** [Method] Alias for apply * @param values Object/Array The template values. Can be an array if your params are numeric: var tpl = new Ext.Template('Name: {0}, Age: {1}'); tpl.apply(['John', 25]); or an object: var tpl = new Ext.Template('Name: {name}, Age: {age}'); tpl.apply({name: 'John', age: 25}); + * @returns String The HTML fragment. */ applyTemplate?( values?:any ): string; - /** [Method] Compiles the template into an internal function eliminating the RegEx overhead */ + /** [Method] Compiles the template into an internal function eliminating the RegEx overhead + * @returns Ext.Template this + */ compile?(): Ext.ITemplate; /** [Method] Applies the supplied values to the template and inserts the new node s after el * @param el String/HTMLElement/Ext.Element The context element. * @param values Object/Array The template values. See applyTemplate for details. * @param returnElement Boolean true to return a Ext.Element. + * @returns HTMLElement/Ext.Element The new node or Element. */ - insertAfter?( el?:any, values?:any, returnElement?:any ): any; - insertAfter?( el?:string, values?:any, returnElement?:boolean ): any; - insertAfter?( el?:HTMLElement, values?:any, returnElement?:boolean ): any; - insertAfter?( el?:Ext.IElement, values?:any, returnElement?:boolean ): any; + insertAfter?( el?:any, values?:any, returnElement?:boolean ): any; /** [Method] Applies the supplied values to the template and inserts the new node s before el * @param el String/HTMLElement/Ext.Element The context element. * @param values Object/Array The template values. See applyTemplate for details. * @param returnElement Boolean true to return an Ext.Element. + * @returns HTMLElement/Ext.Element The new node or Element */ - insertBefore?( el?:any, values?:any, returnElement?:any ): any; - insertBefore?( el?:string, values?:any, returnElement?:boolean ): any; - insertBefore?( el?:HTMLElement, values?:any, returnElement?:boolean ): any; - insertBefore?( el?:Ext.IElement, values?:any, returnElement?:boolean ): any; + insertBefore?( el?:any, values?:any, returnElement?:boolean ): any; /** [Method] Applies the supplied values to the template and inserts the new node s as the first child of el * @param el String/HTMLElement/Ext.Element The context element. * @param values Object/Array The template values. See applyTemplate for details. * @param returnElement Boolean true to return a Ext.Element. + * @returns HTMLElement/Ext.Element The new node or Element. */ - insertFirst?( el?:any, values?:any, returnElement?:any ): any; - insertFirst?( el?:string, values?:any, returnElement?:boolean ): any; - insertFirst?( el?:HTMLElement, values?:any, returnElement?:boolean ): any; - insertFirst?( el?:Ext.IElement, values?:any, returnElement?:boolean ): any; + insertFirst?( el?:any, values?:any, returnElement?:boolean ): any; /** [Method] Applies the supplied values to the template and overwrites the content of el with the new node s * @param el String/HTMLElement/Ext.Element The context element. * @param values Object/Array The template values. See applyTemplate for details. * @param returnElement Boolean true to return a Ext.Element. + * @returns HTMLElement/Ext.Element The new node or Element. */ - overwrite?( el?:any, values?:any, returnElement?:any ): any; - overwrite?( el?:string, values?:any, returnElement?:boolean ): any; - overwrite?( el?:HTMLElement, values?:any, returnElement?:boolean ): any; - overwrite?( el?:Ext.IElement, values?:any, returnElement?:boolean ): any; + overwrite?( el?:any, values?:any, returnElement?:boolean ): any; /** [Method] Sets the HTML used as the template and optionally compiles it * @param html String * @param compile Boolean true to compile the template. + * @returns Ext.Template this */ set?( html?:string, compile?:boolean ): Ext.ITemplate; } @@ -34402,13 +38175,16 @@ declare module Ext { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] * @param args Object */ static callParent( args?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -34418,14 +38194,16 @@ declare module Ext { /** [Method] Creates a template from the passed element s value display none textarea preferred or innerHTML * @param el String/HTMLElement A DOM element or its id. * @param config Object Config object. + * @returns Ext.Template The created template. + */ + static from( el?:any, config?:any ): Ext.ITemplate; + /** [Method] Get the current class name in string format + * @returns String className */ - static from( el?:any, config?:any ): any; - static from( el?:string, config?:any ): Ext.ITemplate; - static from( el?:HTMLElement, config?:any ): Ext.ITemplate; - /** [Method] Get the current class name in string format */ static getName(): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -34436,9 +38214,13 @@ declare module Ext { baseCls?: string; /** [Config Option] (String) */ title?: string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -34466,17 +38248,29 @@ declare module Ext { title?: string; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ getItems?(): any; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -34528,17 +38322,29 @@ declare module Ext { titleCls?: boolean; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ getDocked?(): string; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object/String + */ getLayout?(): any; - /** [Method] Returns an Ext Title component */ + /** [Method] Returns an Ext Title component + * @returns Ext.Title + */ getTitle?(): Ext.ITitle; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Hides the title if it exists */ hideTitle?(): void; @@ -34565,9 +38371,7 @@ declare module Ext { /** [Method] Use this to update the title configuration * @param title String/Ext.Title You can either pass a String, or a config/instance of Ext.Title. */ - setTitle?( title?:any ): any; - setTitle?( title?:string ): void; - setTitle?( title?:Ext.ITitle ): void; + setTitle?( title?:any ): void; /** [Method] Sets the value of ui * @param ui String */ @@ -34583,6 +38387,7 @@ declare module Ext.util { /** [Method] Adds an item to the collection * @param key String The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param obj Object The item to add. + * @returns Object The item added. */ add?( key?:string, obj?:any ): any; /** [Method] Appends an after event handler @@ -34591,8 +38396,7 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds all elements of an Array or an Object to the collection * @param objs Object/Array An Object containing properties which will be added to the collection, or an Array of values, each of which are added to the collection. Functions references will be added to the collection if allowFunctions has been set to true. */ @@ -34603,8 +38407,7 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -34616,9 +38419,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -34626,27 +38427,30 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all items from the collection */ clear?(): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ clone?(): Ext.util.IMixedCollection; /** [Method] Collects unique values of a particular property in this MixedCollection * @param property String The property to collect on. * @param root String Optional 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the data object. * @param allowNull Boolean Pass true to allow null, undefined, or empty string values. + * @returns Array The unique values. */ collect?( property?:string, root?:string, allowNull?:boolean ): any[]; /** [Method] Returns true if the collection contains the passed Object as an item * @param o Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ contains?( o?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean true if the collection contains the Object as a key. */ containsKey?( key?:string ): boolean; /** [Method] */ @@ -34664,28 +38468,25 @@ declare module Ext.util { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Filters the objects in this collection by a set of Filters or by a single property value pair with optional paramete * @param property Ext.util.Filter[]/String A property on your objects, or an array of Filter objects * @param value String/RegExp Either string that the property values should start with or a RegExp to test against the property. * @param anyMatch Boolean true to match any part of the string, not just the beginning * @param caseSensitive Boolean true for case sensitive comparison. + * @returns Ext.util.MixedCollection The new filtered collection */ - filter?( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any; - filter?( property?:Ext.util.IFilter[], value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - filter?( property?:string, value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - filter?( property?:Ext.util.IFilter[], value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - filter?( property?:string, value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; + filter?( property?:any, value?:any, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; /** [Method] Filter by a function * @param fn Function The function to be called, it will receive the args o (the object), k (the key) * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection. */ filterBy?( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function. */ findBy?( fn?:any, scope?:any ): any; /** [Method] Finds the index of the first matching object in this collection by a specific property value @@ -34694,14 +38495,14 @@ declare module Ext.util { * @param start Number The index to start searching at. * @param anyMatch Boolean true to match any part of the string, not just the beginning. * @param caseSensitive Boolean true for case sensitive comparison. + * @returns Number The matched index or -1. */ - findIndex?( property?:any, value?:any, start?:any, anyMatch?:any, caseSensitive?:any ): any; - findIndex?( property?:string, value?:string, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; - findIndex?( property?:string, value?:RegExp, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; + findIndex?( property?:string, value?:any, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called, it will receive the args o (the object), k (the key). * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index or -1. */ findIndexBy?( fn?:any, scope?:any, start?:number ): number; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste @@ -34709,65 +38510,82 @@ declare module Ext.util { * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection.. + */ first?(): any; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ get?( key?:any ): any; - get?( key?:string ): any; - get?( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ getAt?( index?:number ): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ getByKey?( key?:any ): any; - getByKey?( key?:string ): any; - getByKey?( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ getCount?(): number; /** [Method] MixedCollection has a generic way to fetch keys if you implement getKey * @param item Object The item for which to find the key. + * @returns Object The key for the passed item. */ getKey?( item?:any ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Returns a range of items in this collection * @param start Number The starting index. * @param end Number The ending index. + * @returns Array An array of items */ getRange?( start?:number, end?:number ): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Returns index within the collection of the passed Object * @param o Object The item to find the index of. + * @returns Number index of the item. Returns -1 if not found. */ indexOf?( o?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number The index of the key. */ indexOfKey?( key?:string ): number; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String The key to associate with the new item, or the item itself. * @param obj Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ insert?( index?:number, key?:string, obj?:any ): any; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection.. + */ last?(): any; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -34776,18 +38594,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -34795,32 +38609,30 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Remove an item from the collection * @param o Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ remove?( o?:any ): any; /** [Method] Removes a before event handler @@ -34829,18 +38641,20 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Remove all items in the passed array from the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ removeAll?( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ removeAt?( index?:number ): any; /** [Method] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ removeAtKey?( key?:string ): any; /** [Method] Removes a before event handler @@ -34849,8 +38663,7 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -34858,21 +38671,18 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Replaces an item in the collection * @param key String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param o Object If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ replace?( key?:string, o?:any ): any; /** [Method] Resumes firing events see suspendEvents @@ -34882,9 +38692,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -34894,6 +38702,7 @@ declare module Ext.util { * @param root String Optional 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the data object * @param start Number The record index to start at. * @param end Number The record index to end at. + * @returns Number The total */ sum?( property?:string, root?:string, start?:number, end?:number ): number; /** [Method] Suspends the firing of all events */ @@ -34905,25 +38714,21 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util { @@ -34947,6 +38752,7 @@ declare module Ext.util { /** [Method] Adds an item to the collection * @param key String The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param item Object The item to add. + * @returns Object The item added. */ add?( key?:string, item?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -34959,6 +38765,7 @@ declare module Ext.util { addFilter?( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Object + * @returns Object */ addFilters?( filters?:any ): any; /** [Method] This method adds a sorter @@ -34973,14 +38780,18 @@ declare module Ext.util { addSorters?( sorters?:any[], defaultDirection?:string ): void; /** [Method] Removes all items from the collection */ clear?(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ clone?(): Ext.util.IMixedCollection; /** [Method] Returns true if the collection contains the passed Object as an item * @param item Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ contains?( item?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean true if the collection contains the Object as a key. */ containsKey?( key?:string ): boolean; /** [Method] */ @@ -35000,98 +38811,131 @@ declare module Ext.util { * @param value Object * @param anyMatch Object * @param caseSensitive Object + * @returns Array */ filter?( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any[]; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ filterBy?( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function. */ findBy?( fn?:any, scope?:any ): any; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index, or -1 if the item was not found. */ findIndexBy?( fn?:any, scope?:any, start?:number ): number; /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ findInsertionIndex?( items?:any[], item?:any ): number; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection. + */ first?(): any; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ get?( key?:any ): any; - get?( key?:string ): any; - get?( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ getAt?( index?:number ): any; - /** [Method] Returns the value of autoFilter */ + /** [Method] Returns the value of autoFilter + * @returns Boolean + */ getAutoFilter?(): boolean; - /** [Method] Returns the value of autoSort */ + /** [Method] Returns the value of autoSort + * @returns Boolean + */ getAutoSort?(): boolean; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ getByKey?( key?:any ): any; - getByKey?( key?:string ): any; - getByKey?( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ getCount?(): number; - /** [Method] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ getDefaultSortDirection?(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ getFilterFn?(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ getFilterRoot?(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ getFilters?(): any[]; /** [Method] MixedCollection has a generic way to fetch keys if you implement getKey * @param item Object The item for which to find the key. + * @returns Object The key for the passed item. */ getKey?( item?:any ): any; /** [Method] Returns a range of items in this collection * @param start Number The starting index. * @param end Number The ending index. Defaults to the last item. + * @returns Array An array of items. */ getRange?( start?:number, end?:number ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ getSortFn?(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ getSortRoot?(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ getSorters?(): any[]; /** [Method] Returns index within the collection of the passed Object * @param item Object The item to find the index of. + * @returns Number Index of the item. Returns -1 if not found. */ indexOf?( item?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number Index of the key. */ indexOfKey?( key?:string ): number; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String The key to associate with the new item, or the item itself. * @param item Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ insert?( index?:number, key?:string, item?:any ): any; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ insertFilter?( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ insertFilters?( index?:number, filters?:any[] ): any[]; /** [Method] This method adds a sorter at a given index @@ -35100,28 +38944,37 @@ declare module Ext.util { * @param defaultDirection String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'. */ insertSorter?( index?:number, sorter?:any, defaultDirection?:string ): void; - /** [Method] This method inserts all the sorters in the passed array at the given index */ + /** [Method] This method inserts all the sorters in the passed array at the given index + * @returns Ext.util.Collection this + */ insertSorters?(): Ext.util.ICollection; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection. + */ last?(): any; /** [Method] Remove an item from the collection * @param item Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ remove?( item?:any ): any; /** [Method] Remove all items in the passed array from the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ removeAll?( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ removeAt?( index?:number ): any; /** [Method] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ removeAtKey?( key?:string ): any; /** [Method] This method removes all the filters in a passed array * @param filters Object + * @returns Ext.util.Collection this */ removeFilters?( filters?:any ): Ext.util.ICollection; /** [Method] This method removes a sorter @@ -35130,11 +38983,13 @@ declare module Ext.util { removeSorter?( sorter?:any ): void; /** [Method] This method removes all the sorters in a passed array * @param sorters Object + * @returns Ext.util.Collection this */ removeSorters?( sorters?:any ): Ext.util.ICollection; /** [Method] Replaces an item in the collection * @param oldKey String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param item Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ replace?( oldKey?:string, item?:any ): any; /** [Method] Sets the value of autoFilter @@ -35168,6 +39023,7 @@ declare module Ext.util { /** [Method] This method will sort an array based on the currently configured sorters * @param sorters Object * @param defaultDirection Object + * @returns Array The array you passed after it is sorted. */ sort?( sorters?:any, defaultDirection?:any ): any[]; } @@ -35183,15 +39039,25 @@ declare module Ext.util { * @param newArgs Array Overrides the original args passed when instantiated. */ delay?( delay?:number, newFn?:any, newScope?:any, newArgs?:any[] ): void; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Object + */ getArgs?(): any; - /** [Method] Returns the value of delay */ + /** [Method] Returns the value of delay + * @returns Object + */ getDelay?(): any; - /** [Method] Returns the value of fn */ + /** [Method] Returns the value of fn + * @returns Object + */ getFn?(): any; - /** [Method] Returns the value of interval */ + /** [Method] Returns the value of interval + * @returns Object + */ getInterval?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; /** [Method] Sets the value of args * @param args Object @@ -35227,16 +39093,14 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -35248,9 +39112,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -35258,57 +39120,80 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ destroy?(): void; - /** [Method] Disable the Draggable */ + /** [Method] Disable the Draggable + * @returns Ext.util.Draggable This Draggable instance + */ disable?(): Ext.util.IDraggable; - /** [Method] Enable the Draggable */ + /** [Method] Enable the Draggable + * @returns Ext.util.Draggable This Draggable instance + */ enable?(): Ext.util.IDraggable; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of constraint */ + /** [Method] Returns the value of constraint + * @returns String + */ getConstraint?(): string; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Object + */ getDisabled?(): any; - /** [Method] Returns the value of draggingCls */ + /** [Method] Returns the value of draggingCls + * @returns String + */ getDraggingCls?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of initialOffset */ + /** [Method] Returns the value of initialOffset + * @returns Object/Number + */ getInitialOffset?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of translatable */ + /** [Method] Returns the value of translatable + * @returns Object + */ getTranslatable?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -35318,18 +39203,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -35337,28 +39218,25 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -35367,16 +39245,14 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -35384,18 +39260,14 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -35403,9 +39275,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of cls * @param cls String */ @@ -35451,25 +39321,21 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util { @@ -35494,16 +39360,14 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -35515,9 +39379,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -35525,9 +39387,7 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -35539,34 +39399,45 @@ declare module Ext.util { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; - /** [Method] Method to determine whether this Component is currently disabled */ + /** [Method] Method to determine whether this Component is currently disabled + * @returns Boolean the disabled state of this Component. + */ isDisabled?(): boolean; - /** [Method] Method to determine whether this Droppable is currently monitoring drag operations of Draggables */ + /** [Method] Method to determine whether this Droppable is currently monitoring drag operations of Draggables + * @returns Boolean the monitoring state of this Droppable + */ isMonitoring?(): boolean; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -35575,18 +39446,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -35594,28 +39461,25 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -35624,16 +39488,14 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -35641,18 +39503,14 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -35664,9 +39522,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -35680,25 +39536,21 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util { @@ -35721,23 +39573,41 @@ declare module Ext.util { scope?: any; /** [Config Option] (RegExp/Mixed) */ value?: any; - /** [Method] Returns the value of anyMatch */ + /** [Method] Returns the value of anyMatch + * @returns Boolean + */ getAnyMatch?(): boolean; - /** [Method] Returns the value of caseSensitive */ + /** [Method] Returns the value of caseSensitive + * @returns Boolean + */ getCaseSensitive?(): boolean; - /** [Method] Returns the value of exactMatch */ + /** [Method] Returns the value of exactMatch + * @returns Boolean + */ getExactMatch?(): boolean; - /** [Method] Returns the value of filterFn */ + /** [Method] Returns the value of filterFn + * @returns Function + */ getFilterFn?(): any; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns String + */ getId?(): string; - /** [Method] Returns the value of property */ + /** [Method] Returns the value of property + * @returns String + */ getProperty?(): string; - /** [Method] Returns the value of root */ + /** [Method] Returns the value of root + * @returns String + */ getRoot?(): string; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns RegExp/Mixed + */ getValue?(): any; /** [Method] Sets the value of anyMatch * @param anyMatch Boolean @@ -35774,8 +39644,7 @@ declare module Ext.util { /** [Method] Sets the value of value * @param value RegExp/Mixed */ - setValue?( value?:any ): any; - setValue?( value?:RegExp ): void; + setValue?( value?:any ): void; } } declare module Ext.util { @@ -35784,25 +39653,24 @@ declare module Ext.util { export class Format { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Parse a value into a formatted date using the specified format pattern * @param value String/Date The value to format. Strings must conform to the format expected by the JavaScript Date object's parse() method. * @param format String Any valid date format string. + * @returns String The formatted date string. */ - static date( value?:any, format?:any ): any; - static date( value?:string, format?:string ): string; static date( value?:any, format?:string ): string; /** [Method] */ static destroy(): void; @@ -35810,53 +39678,66 @@ declare module Ext.util { * @param value String The string to truncate. * @param length Number The maximum length to allow before truncating. * @param word Boolean True to try to find a common word break. + * @returns String The converted text. */ static ellipsis( value?:string, length?:number, word?:boolean ): string; /** [Method] Escapes the passed string for and * @param string String The string to escape. + * @returns String The escaped string. */ static escape( string?:string ): string; /** [Method] Escapes the passed string for use in a regular expression * @param str String + * @returns String */ static escapeRegex( str?:string ): string; /** [Method] Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens * @param string String The tokenized string to be formatted. * @param values String... The values to replace token {0}, {1}, etc. + * @returns String The formatted string. */ static format( string:string, ...values:any[] ): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Convert certain characters amp lt and from their HTML character equivalents * @param value String The string to decode. + * @returns String The decoded text. */ static htmlDecode( value?:string ): string; /** [Method] Convert certain characters amp lt and to their HTML character equivalents for literal display in web pages * @param value String The string to encode. + * @returns String The encoded text. */ static htmlEncode( value?:string ): string; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Pads the left side of a string with a specified character * @param string String The original string. * @param size Number The total length of the output string. * @param char String The character with which to pad the original string. + * @returns String The padded string. */ static leftPad( string?:string, size?:number, char?:string ): string; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Utility function that allows you to easily switch a string between two alternating values * @param string String The current string * @param value String The value to compare to the current string * @param other String The new value to use if the string already equals the first value passed in + * @returns String The new value */ static toggle( string?:string, value?:string, other?:string ): string; /** [Method] Trims whitespace from either end of a string leaving spaces within the string intact * @param string String The string to escape + * @returns String The trimmed string */ static trim( string?:string ): string; } @@ -35891,15 +39772,25 @@ declare module Ext.util { timestamp?: any; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of allowHighAccuracy */ + /** [Method] Returns the value of allowHighAccuracy + * @returns Boolean + */ getAllowHighAccuracy?(): boolean; - /** [Method] Returns the value of autoUpdate */ + /** [Method] Returns the value of autoUpdate + * @returns Boolean + */ getAutoUpdate?(): boolean; - /** [Method] Returns the value of frequency */ + /** [Method] Returns the value of frequency + * @returns Number + */ getFrequency?(): number; - /** [Method] Returns the value of maximumAge */ + /** [Method] Returns the value of maximumAge + * @returns Number + */ getMaximumAge?(): number; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; /** [Method] Sets the value of allowHighAccuracy * @param allowHighAccuracy Boolean @@ -35936,11 +39827,17 @@ declare module Ext.util { sortProperty?: string; /** [Config Option] (Function) */ sorterFn?: any; - /** [Method] Returns the value of groupFn */ + /** [Method] Returns the value of groupFn + * @returns Function + */ getGroupFn?(): any; - /** [Method] Returns the value of sortProperty */ + /** [Method] Returns the value of sortProperty + * @returns String + */ getSortProperty?(): string; - /** [Method] Returns the value of sorterFn */ + /** [Method] Returns the value of sorterFn + * @returns Function + */ getSorterFn?(): any; /** [Method] Sets the value of groupFn * @param groupFn Function @@ -35963,6 +39860,7 @@ declare module Ext.util { /** [Method] Add a new item to the hash * @param key String The key of the new item. * @param value Object The value of the new item. + * @returns Object The value of the new item added. */ add?( key?:string, value?:any ): any; /** [Method] Appends an after event handler @@ -35971,16 +39869,14 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -35992,9 +39888,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -36002,23 +39896,26 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all items from the hash * @param initial Object + * @returns Ext.util.HashMap this */ clear?( initial?:any ): Ext.util.IHashMap; /** [Method] Removes all listeners for this object */ clearListeners?(): void; - /** [Method] Performs a shallow copy on this hash */ + /** [Method] Performs a shallow copy on this hash + * @returns Ext.util.HashMap The new hash object. + */ clone?(): Ext.util.IHashMap; /** [Method] Checks whether a value exists in the hash * @param value Object The value to check for. + * @returns Boolean true if the value exists in the dictionary. */ contains?( value?:any ): boolean; /** [Method] Checks whether a key exists in the hash * @param key String The key to check for. + * @returns Boolean true if they key exists in the hash. */ containsKey?( key?:string ): boolean; /** [Method] */ @@ -36026,42 +39923,55 @@ declare module Ext.util { /** [Method] Executes the specified function once for each item in the hash * @param fn Function The function to execute. * @param scope Object The scope to execute in. + * @returns Ext.util.HashMap this */ each?( fn?:any, scope?:any ): Ext.util.IHashMap; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Retrieves an item with a particular key * @param key String The key to lookup. + * @returns Object The value at that key. If it doesn't exist, undefined is returned. */ get?( key?:string ): any; - /** [Method] Returns the value of bubbleEvents */ - getBubbleEvents? (): any; - /** [Method] Gets the number of items in the hash */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ + getBubbleEvents?(): any; + /** [Method] Gets the number of items in the hash + * @returns Number The number of items in the hash. + */ getCount?(): number; - /** [Method] Return all of the keys in the hash */ + /** [Method] Return all of the keys in the hash + * @returns Array An array of keys. + */ getKeys?(): any[]; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Return all of the values in the hash */ + /** [Method] Return all of the values in the hash + * @returns Array An array of values. + */ getValues?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -36071,18 +39981,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -36090,32 +39996,30 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Remove an item from the hash * @param o Object The value of the item to remove. + * @returns Boolean true if the item was successfully removed. */ remove?( o?:any ): boolean; /** [Method] Removes a before event handler @@ -36124,18 +40028,17 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Remove an item from the hash * @param key String The key to remove. + * @returns Boolean true if the item was successfully removed. */ removeByKey?( key?:string ): boolean; /** [Method] Removes an event handler @@ -36145,21 +40048,18 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Replaces an item in the hash * @param key String The key of the item. * @param value Object The new value for the item. + * @returns Object The new value of the item. */ replace?( key?:string, value?:any ): any; /** [Method] Resumes firing events see suspendEvents @@ -36169,9 +40069,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -36185,25 +40083,21 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util { @@ -36212,21 +40106,22 @@ declare module Ext.util { export class Inflector { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the correct Model name for a given string * @param word String The word to classify + * @returns String The classified version of the word */ static classify( word?:string ): string; /** [Method] Removes all registered pluralization rules */ @@ -36237,18 +40132,22 @@ declare module Ext.util { static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Returns true if the given word is transnumeral the word is its own singular and plural form e g * @param word String The word to test + * @returns Boolean True if the word is transnumeral */ static isTransnumeral( word?:string ): boolean; /** [Method] Ordinalizes a given number by adding a prefix such as st nd rd or th based on the last digit of the number * @param number Number The number to ordinalize + * @returns String The ordinalized number */ static ordinalize( number?:number ): string; /** [Method] Adds a new pluralization rule to the Inflector @@ -36258,6 +40157,7 @@ declare module Ext.util { static plural( matcher?:RegExp, replacer?:string ): void; /** [Method] Returns the pluralized form of a word e g * @param word String The word to pluralize + * @returns String The pluralized form of the word */ static pluralize( word?:string ): string; /** [Method] Adds a new singularization rule to the Inflector @@ -36267,9 +40167,12 @@ declare module Ext.util { static singular( matcher?:RegExp, replacer?:string ): void; /** [Method] Returns the singularized form of a word e g * @param word String The word to singularize + * @returns String The singularized form of the word */ static singularize( word?:string ): string; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -36281,9 +40184,12 @@ declare module Ext.util { export interface ILineSegment extends Ext.IBase { /** [Method] Returns the point where two lines intersect * @param lineSegment Ext.util.LineSegment The line to intersect with. + * @returns Ext.util.Point */ intersects?( lineSegment?:Ext.util.ILineSegment ): Ext.util.IPoint; - /** [Method] Returns string representation of the line */ + /** [Method] Returns string representation of the line + * @returns String For example Point[12,8] Point[0,0] + */ toString?(): string; } } @@ -36302,10 +40208,9 @@ declare module Ext.util { * @param direction String The overall direction to sort the data by. * @param where String * @param doSort Boolean + * @returns Ext.util.Sorter[] */ - sort?( sorters?:any, direction?:any, where?:any, doSort?:any ): any; - sort?( sorters?:string, direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; - sort?( sorters?:Ext.util.ISorter[], direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; + sort?( sorters?:any, direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; /** [Method] Sorts the collection by a single sorter function * @param sorterFn Function The function to sort by. */ @@ -36325,13 +40230,21 @@ declare module Ext.util.paintmonitor { export interface IAbstract extends Ext.IBase { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Array + */ getArgs?(): any[]; - /** [Method] Returns the value of callback */ + /** [Method] Returns the value of callback + * @returns Object + */ getCallback?(): any; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; /** [Method] Sets the value of args * @param args Array @@ -36365,34 +40278,47 @@ declare module Ext.util.paintmonitor { } declare module Ext.util { export interface IPoint extends Ext.IBase { - /** [Method] Copy a new instance of this point */ + /** [Method] Copy a new instance of this point + * @returns Ext.util.Point The new point. + */ clone?(): Ext.util.IPoint; - /** [Method] Clones this Point */ + /** [Method] Clones this Point + * @returns Ext.util.Point The new point. + */ copy?(): Ext.util.IPoint; /** [Method] Copy the x and y values of another point object to this point itself * @param point Ext.util.Point/Object . + * @returns Ext.util.Point This point. */ copyFrom?( point?:any ): Ext.util.IPoint; /** [Method] Compare this point and another point * @param point Ext.util.Point/Object The point to compare with, either an instance of Ext.util.Point or an object with x and y properties. + * @returns Boolean Returns whether they are equivalent. */ equals?( point?:any ): boolean; /** [Method] Whether the given point is not away from this point within the given threshold amount * @param point Ext.util.Point/Object The point to check with, either an instance of Ext.util.Point or an object with x and y properties. * @param threshold Object/Number Can be either an object with x and y properties or a number. + * @returns Boolean */ isCloseTo?( point?:any, threshold?:any ): boolean; - /** [Method] Returns true if this point is close to another one */ + /** [Method] Returns true if this point is close to another one + * @returns Boolean + */ isWithin?(): boolean; /** [Method] Compare this point with another point when the x and y values of both points are rounded * @param point Ext.util.Point/Object The point to compare with, either an instance of Ext.util.Point or an object with x and y properties. + * @returns Boolean */ roundedEquals?( point?:any ): boolean; - /** [Method] Returns a human eye friendly string that represents this point useful for debugging */ + /** [Method] Returns a human eye friendly string that represents this point useful for debugging + * @returns String For example Point[12,8]. + */ toString?(): string; /** [Method] Translate this point by the given amounts * @param x Number Amount to translate in the x-axis. * @param y Number Amount to translate in the y-axis. + * @returns Boolean */ translate?( x?:number, y?:number ): boolean; } @@ -36403,13 +40329,16 @@ declare module Ext.util { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] * @param args Object */ static callParent( args?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -36418,27 +40347,35 @@ declare module Ext.util { static createAlias( alias?:any, origin?:any ): void; /** [Method] Returns a new point from an object that has x and y properties if that object is not an instance of Ext util Point * @param object Object + * @returns Ext.util.Point */ static from( object?:any ): Ext.util.IPoint; /** [Method] Returns a new instance of Ext util Point based on the pageX pageY values of the given event * @param e Event The event. + * @returns Ext.util.Point */ static fromEvent( e?:Event ): Ext.util.IPoint; /** [Method] Returns a new instance of Ext util Point based on the pageX pageY values of the given touch * @param touch Event + * @returns Ext.util.Point */ static fromTouch( touch?:Event ): Ext.util.IPoint; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } } declare module Ext.util { export interface IPositionMap extends Ext.IBase { - /** [Method] Returns the value of minimumHeight */ + /** [Method] Returns the value of minimumHeight + * @returns Number + */ getMinimumHeight?(): number; /** [Method] Sets the value of minimumHeight * @param minimumHeight Number @@ -36453,64 +40390,81 @@ declare module Ext.util { * @param right Number Right offset * @param bottom Number Bottom offset * @param left Number Left offset + * @returns Ext.util.Region this */ adjust?( top?:number, right?:number, bottom?:number, left?:number ): Ext.util.IRegion; /** [Method] Modifies the current region to be constrained to the targetRegion * @param targetRegion Ext.util.Region + * @returns Ext.util.Region this */ constrainTo?( targetRegion?:Ext.util.IRegion ): Ext.util.IRegion; /** [Method] Checks if this region completely contains the region that is passed in * @param region Ext.util.Region + * @returns Boolean */ contains?( region?:Ext.util.IRegion ): boolean; - /** [Method] Copy a new instance */ + /** [Method] Copy a new instance + * @returns Ext.util.Region + */ copy?(): Ext.util.IRegion; /** [Method] Check whether this region is equivalent to the given region * @param region Ext.util.Region The region to compare with. + * @returns Boolean */ equals?( region?:Ext.util.IRegion ): boolean; /** [Method] Get the offset amount of a point outside the region * @param axis String/Object optional. * @param p Ext.util.Point The point. + * @returns Ext.util.Region */ getOutOfBoundOffset?( axis?:any, p?:Ext.util.IPoint ): Ext.util.IRegion; /** [Method] Get the offset amount on the x axis * @param p Number The offset. + * @returns Number */ getOutOfBoundOffsetX?( p?:number ): number; /** [Method] Get the offset amount on the y axis * @param p Number The offset. + * @returns Number */ getOutOfBoundOffsetY?( p?:number ): number; /** [Method] Checks if this region intersects the region passed in * @param region Ext.util.Region + * @returns Ext.util.Region/Boolean Returns the intersected region or false if there is no intersection. */ intersect?( region?:Ext.util.IRegion ): any; /** [Method] Check whether the point offset is out of bounds * @param axis String optional * @param p Ext.util.Point/Number The point / offset. + * @returns Boolean */ - isOutOfBound?( axis?:any, p?:any ): any; - isOutOfBound?( axis?:string, p?:Ext.util.IPoint ): boolean; - isOutOfBound?( axis?:string, p?:number ): boolean; + isOutOfBound?( axis?:string, p?:any ): boolean; /** [Method] Check whether the offset is out of bound in the x axis * @param p Number The offset. + * @returns Boolean */ isOutOfBoundX?( p?:number ): boolean; /** [Method] Check whether the offset is out of bound in the y axis * @param p Number The offset. + * @returns Boolean */ isOutOfBoundY?( p?:number ): boolean; - /** [Method] Round all the properties of this region */ + /** [Method] Round all the properties of this region + * @returns Ext.util.Region This Region. + */ round?(): Ext.util.IRegion; - /** [Method] Dump this to an eye friendly string great for debugging */ + /** [Method] Dump this to an eye friendly string great for debugging + * @returns String For example Region[0,1,3,2]. + */ toString?(): string; /** [Method] Translate this region by the given offset amount * @param offset Object + * @returns Ext.util.Region This Region. */ translateBy?( offset?:any ): Ext.util.IRegion; /** [Method] Returns the smallest region that contains the current AND targetRegion * @param region Ext.util.Region + * @returns Ext.util.Region */ union?( region?:Ext.util.IRegion ): Ext.util.IRegion; } @@ -36521,13 +40475,16 @@ declare module Ext.util { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] * @param args Object */ static callParent( args?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -36536,19 +40493,21 @@ declare module Ext.util { static createAlias( alias?:any, origin?:any ): void; /** [Method] Creates new Region from an object Ext util Region from top 0 right 5 bottom 3 left 1 the above is eq * @param o Object An object with top, right, bottom, and left properties. + * @returns Ext.util.Region The region constructed based on the passed object. */ static from( o?:any ): Ext.util.IRegion; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Retrieves an Ext util Region for a particular element * @param el String/HTMLElement/Ext.Element The element or its ID. + * @returns Ext.util.Region region */ - static getRegion( el?:any ): any; - static getRegion( el?:string ): Ext.util.IRegion; - static getRegion( el?:HTMLElement ): Ext.util.IRegion; - static getRegion( el?:Ext.IElement ): Ext.util.IRegion; + static getRegion( el?:any ): Ext.util.IRegion; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -36557,13 +40516,21 @@ declare module Ext.util.sizemonitor { export interface IAbstract extends Ext.IBase,Ext.mixin.ITemplatable { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Array + */ getArgs?(): any[]; - /** [Method] Returns the value of callback */ + /** [Method] Returns the value of callback + * @returns Object + */ getCallback?(): any; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; /** [Method] Sets the value of args * @param args Array @@ -36618,10 +40585,9 @@ declare module Ext.util { * @param direction String The overall direction to sort the data by. * @param where String * @param doSort Boolean + * @returns Ext.util.Sorter[] */ - sort?( sorters?:any, direction?:any, where?:any, doSort?:any ): any; - sort?( sorters?:string, direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; - sort?( sorters?:Ext.util.ISorter[], direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; + sort?( sorters?:any, direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; } } declare module Ext.util { @@ -36638,17 +40604,29 @@ declare module Ext.util { sorterFn?: any; /** [Config Option] (Function) */ transform?: any; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns Mixed + */ getId?(): any; - /** [Method] Returns the value of property */ + /** [Method] Returns the value of property + * @returns String + */ getProperty?(): string; - /** [Method] Returns the value of root */ + /** [Method] Returns the value of root + * @returns String + */ getRoot?(): string; - /** [Method] Returns the value of sorterFn */ + /** [Method] Returns the value of sorterFn + * @returns Function + */ getSorterFn?(): any; - /** [Method] Returns the value of transform */ + /** [Method] Returns the value of transform + * @returns Function + */ getTransform?(): any; /** [Method] Sets the value of direction * @param direction String @@ -36686,16 +40664,14 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. */ @@ -36707,9 +40683,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -36717,51 +40691,70 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of accelerate */ + /** [Method] Returns the value of accelerate + * @returns Boolean + */ getAccelerate?(): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of delay */ + /** [Method] Returns the value of delay + * @returns Number + */ getDelay?(): number; - /** [Method] Returns the value of el */ + /** [Method] Returns the value of el + * @returns Object + */ getEl?(): any; - /** [Method] Returns the value of interval */ + /** [Method] Returns the value of interval + * @returns Number + */ getInterval?(): number; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of pressCls */ + /** [Method] Returns the value of pressCls + * @returns Object + */ getPressCls?(): any; - /** [Method] Returns the value of preventDefault */ + /** [Method] Returns the value of preventDefault + * @returns Boolean + */ getPreventDefault?(): boolean; - /** [Method] Returns the value of stopDefault */ + /** [Method] Returns the value of stopDefault + * @returns Boolean + */ getStopDefault?(): boolean; - /** [Method] Returns the value of timer */ + /** [Method] Returns the value of timer + * @returns Number + */ getTimer?(): number; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -36771,18 +40764,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -36790,28 +40779,25 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -36820,16 +40806,14 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -36837,18 +40821,14 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -36860,9 +40840,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of delay * @param delay Number */ @@ -36904,38 +40882,42 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util.translatable { export interface IAbstract extends Ext.IEvented { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns Object + */ getEasing?(): any; - /** [Method] Returns the value of easingX */ + /** [Method] Returns the value of easingX + * @returns Object + */ getEasingX?(): any; - /** [Method] Returns the value of easingY */ + /** [Method] Returns the value of easingY + * @returns Object + */ getEasingY?(): any; - /** [Method] Returns the value of useWrapper */ + /** [Method] Returns the value of useWrapper + * @returns Object + */ getUseWrapper?(): any; /** [Method] Sets the value of easing * @param easing Object @@ -36969,7 +40951,9 @@ declare module Ext.util.translatable { } declare module Ext.util.translatable { export interface IDom extends Ext.util.translatable.IAbstract { - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; /** [Method] Sets the value of element * @param element Object @@ -36985,7 +40969,9 @@ declare module Ext.util.translatable { export interface IScrollPosition extends Ext.util.translatable.IDom { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of useWrapper */ + /** [Method] Returns the value of useWrapper + * @returns Boolean + */ getUseWrapper?(): boolean; /** [Method] Sets the value of useWrapper * @param useWrapper Boolean @@ -36995,11 +40981,17 @@ declare module Ext.util.translatable { } declare module Ext.util { export interface ITranslatableGroup extends Ext.util.translatable.IAbstract { - /** [Method] Returns the value of activeIndex */ + /** [Method] Returns the value of activeIndex + * @returns Number + */ getActiveIndex?(): number; - /** [Method] Returns the value of itemLength */ + /** [Method] Returns the value of itemLength + * @returns Object + */ getItemLength?(): any; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array + */ getItems?(): any[]; /** [Method] Sets the value of activeIndex * @param activeIndex Number @@ -37017,7 +41009,9 @@ declare module Ext.util { } declare module Ext.util { export interface ITranslatableList extends Ext.util.translatable.IAbstract { - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array + */ getItems?(): any[]; /** [Method] Sets the value of items * @param items Array @@ -37042,91 +41036,96 @@ declare module Ext { deprecate?( packageName?:string, since?:string, closure?:any, scope?:any ): void; /** [Method] Returns whether this version equals to the supplied argument * @param target String/Number The version to compare with. + * @returns Boolean true if this version equals to the target, false otherwise. + */ + equals?( target?:any ): boolean; + /** [Method] Returns the build component value + * @returns Number build */ - equals?( target?:any ): any; - equals?( target?:string ): boolean; - equals?( target?:number ): boolean; - /** [Method] Returns the build component value */ getBuild?(): number; - /** [Method] Returns the major component value */ + /** [Method] Returns the major component value + * @returns Number major + */ getMajor?(): number; - /** [Method] Returns the minor component value */ + /** [Method] Returns the minor component value + * @returns Number minor + */ getMinor?(): number; - /** [Method] Returns the patch component value */ + /** [Method] Returns the patch component value + * @returns Number patch + */ getPatch?(): number; - /** [Method] Returns the release component value */ + /** [Method] Returns the release component value + * @returns Number release + */ getRelease?(): number; - /** [Method] Returns shortVersion version without dots and release */ + /** [Method] Returns shortVersion version without dots and release + * @returns String + */ getShortVersion?(): string; /** [Method] Get the version number of the supplied package name will return the last registered version last Ext setVersion c * @param packageName String The package name, for example: 'core', 'touch', 'extjs'. + * @returns Ext.Version The version. */ getVersion?( packageName?:string ): Ext.IVersion; /** [Method] Convenient alias to isGreaterThan * @param target String/Number + * @returns Boolean */ - gt?( target?:any ): any; - gt?( target?:string ): boolean; - gt?( target?:number ): boolean; + gt?( target?:any ): boolean; /** [Method] Convenient alias to isGreaterThanOrEqual * @param target String/Number + * @returns Boolean */ - gtEq?( target?:any ): any; - gtEq?( target?:string ): boolean; - gtEq?( target?:number ): boolean; + gtEq?( target?:any ): boolean; /** [Method] Returns whether this version if greater than the supplied argument * @param target String/Number The version to compare with. + * @returns Boolean true if this version if greater than the target, false otherwise. */ - isGreaterThan?( target?:any ): any; - isGreaterThan?( target?:string ): boolean; - isGreaterThan?( target?:number ): boolean; + isGreaterThan?( target?:any ): boolean; /** [Method] Returns whether this version if greater than or equal to the supplied argument * @param target String/Number The version to compare with. + * @returns Boolean true if this version if greater than or equal to the target, false otherwise. */ - isGreaterThanOrEqual?( target?:any ): any; - isGreaterThanOrEqual?( target?:string ): boolean; - isGreaterThanOrEqual?( target?:number ): boolean; + isGreaterThanOrEqual?( target?:any ): boolean; /** [Method] Returns whether this version if smaller than the supplied argument * @param target String/Number The version to compare with. + * @returns Boolean true if this version if smaller than the target, false otherwise. */ - isLessThan?( target?:any ): any; - isLessThan?( target?:string ): boolean; - isLessThan?( target?:number ): boolean; + isLessThan?( target?:any ): boolean; /** [Method] Returns whether this version if less than or equal to the supplied argument * @param target String/Number The version to compare with. + * @returns Boolean true if this version if less than or equal to the target, false otherwise. */ - isLessThanOrEqual?( target?:any ): any; - isLessThanOrEqual?( target?:string ): boolean; - isLessThanOrEqual?( target?:number ): boolean; + isLessThanOrEqual?( target?:any ): boolean; /** [Method] Convenient alias to isLessThan * @param target String/Number + * @returns Boolean */ - lt?( target?:any ): any; - lt?( target?:string ): boolean; - lt?( target?:number ): boolean; + lt?( target?:any ): boolean; /** [Method] Convenient alias to isLessThanOrEqual * @param target String/Number + * @returns Boolean */ - ltEq?( target?:any ): any; - ltEq?( target?:string ): boolean; - ltEq?( target?:number ): boolean; + ltEq?( target?:any ): boolean; /** [Method] Returns whether this version matches the supplied argument * @param target String/Number The version to compare with. + * @returns Boolean true if this version matches the target, false otherwise. */ - match?( target?:any ): any; - match?( target?:string ): boolean; - match?( target?:number ): boolean; + match?( target?:any ): boolean; /** [Method] Set version number for the given package name * @param packageName String The package name, for example: 'core', 'touch', 'extjs'. * @param version String/Ext.Version The version, for example: '1.2.3alpha', '2.4.0-dev'. + * @returns any + */ + setVersion?( packageName?:string, version?:any ): any; + /** [Method] Returns this format major minor patch build release + * @returns Number[] */ - setVersion?( packageName?:any, version?:any ): any; - setVersion?( packageName?:string, version?:string ): any; - setVersion?( packageName?:string, version?:Ext.IVersion ): any; - /** [Method] Returns this format major minor patch build release */ toArray?(): number[]; /** [Method] * @param value Object + * @returns Number */ toNumber?( value?:any ): number; } @@ -37134,10 +41133,12 @@ declare module Ext { /** [Method] Compare 2 specified versions starting from left to right * @param current String The current version to compare to. * @param target String The target version to compare to. + * @returns Number Returns -1 if the current version is smaller than the target version, 1 if greater, and 0 if they're equivalent. */ static compare( current?:string, target?:string ): number; /** [Method] Converts a version component to a comparable value * @param value Object The value to convert + * @returns Object */ static getComponentValue( value?:any ): any; } @@ -37148,11 +41149,17 @@ declare module Ext { cls?: any; /** [Config Option] (String) */ posterUrl?: string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of posterUrl */ + /** [Method] Returns the value of posterUrl + * @returns String + */ getPosterUrl?(): string; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns string + */ getUrl?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -37167,9 +41174,7 @@ declare module Ext { /** [Method] Sets the value of url * @param url String/Array */ - setUrl?( url?:any ): any; - setUrl?( url?:string ): void; - setUrl?( url?:any[] ): void; + setUrl?( url?:any ): void; /** [Method] Updates the URL to the poster even if it is rendered * @param newUrl Object */ @@ -37182,7 +41187,9 @@ declare module Ext { } declare module Ext.viewport { export interface IAndroid extends Ext.viewport.IDefault { - /** [Method] Returns the value of autoBlurInput */ + /** [Method] Returns the value of autoBlurInput + * @returns Boolean + */ getAutoBlurInput?(): boolean; /** [Method] Sets the value of autoBlurInput * @param autoBlurInput Boolean @@ -37204,23 +41211,41 @@ declare module Ext.viewport { preventZooming?: boolean; /** [Property] (Boolean) */ isReady?: boolean; - /** [Method] Returns the value of autoMaximize */ + /** [Method] Returns the value of autoMaximize + * @returns Boolean + */ getAutoMaximize?(): boolean; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object/String + */ getLayout?(): any; - /** [Method] Returns the current orientation */ + /** [Method] Returns the current orientation + * @returns String portrait or landscape + */ getOrientation?(): string; - /** [Method] Returns the value of preventPanning */ + /** [Method] Returns the value of preventPanning + * @returns Boolean + */ getPreventPanning?(): boolean; - /** [Method] Returns the value of preventZooming */ + /** [Method] Returns the value of preventZooming + * @returns Boolean + */ getPreventZooming?(): boolean; - /** [Method] Returns the height and width of the Component */ + /** [Method] Returns the height and width of the Component + * @returns Object The current height and width of the Component. + */ getSize?(): any; - /** [Method] Returns the value of useBodyElement */ + /** [Method] Returns the value of useBodyElement + * @returns Boolean + */ getUseBodyElement?(): boolean; - /** [Method] Retrieves the document height */ + /** [Method] Retrieves the document height + * @returns Number height in pixels. + */ getWindowHeight?(): number; - /** [Method] Retrieves the document width */ + /** [Method] Retrieves the document width + * @returns Number width in pixels. + */ getWindowWidth?(): number; /** [Method] Sets the value of autoMaximize * @param autoMaximize Boolean @@ -37254,6 +41279,7 @@ declare module Ext { export class Viewport { /** [Method] Adds one or more Components to this Container * @param newItems Object/Object[]/Ext.Component/Ext.Component[] The new items to add to the Container. + * @returns Ext.Component The last item added to the Container from the newItems array. */ static add( newItems?:any ): Ext.IComponent; /** [Method] Appends an after event handler @@ -37262,10 +41288,10 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds an array of Components to this Container * @param items Array The array of items to add to this container. + * @returns Array The array of items after they have been added. */ static addAll( items?:any[] ): any[]; /** [Method] Appends a before event handler @@ -37274,8 +41300,7 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds a CSS class or classes to this Component s rendered element * @param cls String The CSS class to add. * @param prefix String Optional prefix to add to each class. @@ -37293,9 +41318,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -37303,9 +41326,7 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Animates to the supplied activeItem with a specified animation * @param activeItem Object/Number The item or item index to make active. * @param animation Object/Ext.fx.layout.Card Card animation configuration or instance. @@ -37313,25 +41334,27 @@ declare module Ext { static animateActiveItem( activeItem?:any, animation?:any ): void; /** [Method] Changes the masked configuration when its setter is called which will convert the value into a proper object instanc * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask + * @returns Object */ static applyMasked( masked?:any ): any; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Retrieves the first direct child of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ static child( selector?:string ): Ext.IComponent; /** [Method] Removes all listeners for this object */ @@ -37342,6 +41365,7 @@ declare module Ext { static disable(): void; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ static down( selector?:string ): Ext.IComponent; /** [Method] Enables this Component */ @@ -37349,185 +41373,322 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean Returns false if any of the handlers return false. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ static getActiveItem(): any; /** [Method] Returns the Component for a given index in the Container s items * @param index Number The index of the Component to return. + * @returns Ext.Component The item at the specified index, if found. */ static getAt( index?:number ): Ext.IComponent; - /** [Method] Returns the value of autoDestroy */ + /** [Method] Returns the value of autoDestroy + * @returns Boolean + */ static getAutoDestroy(): boolean; - /** [Method] Returns the value of autoMaximize */ + /** [Method] Returns the value of autoMaximize + * @returns Boolean + */ static getAutoMaximize(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ static getBaseCls(): string; - /** [Method] Returns the value of border */ + /** [Method] Returns the value of border + * @returns Number/String + */ static getBorder(): any; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns Number/String + */ static getBottom(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Returns the value of centered */ + /** [Method] Returns the value of centered + * @returns Boolean + */ static getCentered(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String/String[] + */ static getCls(): any; /** [Method] Examines this container s items property and gets a direct child component of this container * @param component String/Number This parameter may be any of the following: {String} : representing the itemId or id of the child component. {Number} : representing the position of the child component within the items property. For additional information see Ext.util.MixedCollection.get. + * @returns Ext.Component The component (if found). + */ + static getComponent( component?:any ): Ext.IComponent; + /** [Method] Returns the value of contentEl + * @returns Ext.Element/HTMLElement/String */ - static getComponent( component?:any ): any; - static getComponent( component?:string ): Ext.IComponent; - static getComponent( component?:number ): Ext.IComponent; - /** [Method] Returns the value of contentEl */ static getContentEl(): any; - /** [Method] Returns the value of control */ + /** [Method] Returns the value of control + * @returns Object + */ static getControl(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ static getData(): any; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ static getDefaultType(): string; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ static getDefaults(): any; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ static getDisabled(): boolean; - /** [Method] Returns the value of disabledCls */ + /** [Method] Returns the value of disabledCls + * @returns String + */ static getDisabledCls(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ static getDocked(): string; /** [Method] Finds a docked item of this container using a reference idor an index of its location in getDockedItems * @param component String/Number The id or index of the component to find. + * @returns Ext.Component/Boolean The docked component, if found. */ static getDockedComponent( component?:any ): any; - static getDockedComponent( component?:string ): any; - static getDockedComponent( component?:number ): any; - /** [Method] Returns all the Ext Component docked items in this container */ + /** [Method] Returns all the Ext Component docked items in this container + * @returns Array The docked items of this container. + */ static getDockedItems(): any[]; - /** [Method] Retrieves the top level element representing this component */ + /** [Method] Retrieves the top level element representing this component + * @returns Ext.dom.Element + */ static getEl(): Ext.dom.IElement; - /** [Method] Returns the value of enterAnimation */ + /** [Method] Returns the value of enterAnimation + * @returns String/Mixed + */ static getEnterAnimation(): any; - /** [Method] Returns the value of exitAnimation */ + /** [Method] Returns the value of exitAnimation + * @returns String/Mixed + */ static getExitAnimation(): any; - /** [Method] Returns the value of flex */ + /** [Method] Returns the value of flex + * @returns Number + */ static getFlex(): number; - /** [Method] Returns the value of floatingCls */ + /** [Method] Returns the value of floatingCls + * @returns String + */ static getFloatingCls(): string; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ static getHidden(): boolean; - /** [Method] Returns the value of hiddenCls */ + /** [Method] Returns the value of hiddenCls + * @returns String + */ static getHiddenCls(): string; - /** [Method] Returns the value of hideAnimation */ + /** [Method] Returns the value of hideAnimation + * @returns String/Mixed + */ static getHideAnimation(): any; - /** [Method] Returns the value of hideOnMaskTap */ + /** [Method] Returns the value of hideOnMaskTap + * @returns Boolean + */ static getHideOnMaskTap(): boolean; - /** [Method] Returns the value of html */ + /** [Method] Returns the value of html + * @returns String/Ext.Element/HTMLElement + */ static getHtml(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns all inner items of this container */ + /** [Method] Returns all inner items of this container + * @returns Array The inner items of this container. + */ static getInnerItems(): any[]; - /** [Method] Returns the value of itemId */ + /** [Method] Returns the value of itemId + * @returns String + */ static getItemId(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ static getItems(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object/String + */ static getLayout(): any; - /** [Method] Returns the value of left */ + /** [Method] Returns the value of left + * @returns Number/String + */ static getLeft(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; - /** [Method] Returns the value of margin */ + /** [Method] Returns the value of margin + * @returns Number/String + */ static getMargin(): any; - /** [Method] Returns the value of masked */ + /** [Method] Returns the value of masked + * @returns Boolean/Object/Ext.Mask/Ext.LoadMask + */ static getMasked(): any; - /** [Method] Returns the value of maxHeight */ + /** [Method] Returns the value of maxHeight + * @returns Number/String + */ static getMaxHeight(): any; - /** [Method] Returns the value of maxWidth */ + /** [Method] Returns the value of maxWidth + * @returns Number/String + */ static getMaxWidth(): any; - /** [Method] Returns the value of minHeight */ + /** [Method] Returns the value of minHeight + * @returns Number/String + */ static getMinHeight(): any; - /** [Method] Returns the value of minWidth */ + /** [Method] Returns the value of minWidth + * @returns Number/String + */ static getMinWidth(): any; - /** [Method] Returns the value of modal */ + /** [Method] Returns the value of modal + * @returns Boolean + */ static getModal(): boolean; - /** [Method] Returns the current orientation */ + /** [Method] Returns the current orientation + * @returns String portrait or landscape + */ static getOrientation(): string; - /** [Method] Returns the value of padding */ + /** [Method] Returns the value of padding + * @returns Number/String + */ static getPadding(): any; - /** [Method] Returns the parent of this component if it has one */ + /** [Method] Returns the parent of this component if it has one + * @returns Ext.Component The parent of this component. + */ static getParent(): Ext.IComponent; - /** [Method] Returns the value of plugins */ + /** [Method] Returns the value of plugins + * @returns Object/Array + */ static getPlugins(): any; - /** [Method] Returns the value of preventPanning */ + /** [Method] Returns the value of preventPanning + * @returns Boolean + */ static getPreventPanning(): boolean; - /** [Method] Returns the value of preventZooming */ + /** [Method] Returns the value of preventZooming + * @returns Boolean + */ static getPreventZooming(): boolean; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ static getRecord(): Ext.data.IModel; - /** [Method] Returns the value of renderTo */ + /** [Method] Returns the value of renderTo + * @returns Ext.Element + */ static getRenderTo(): Ext.IElement; - /** [Method] Returns the value of right */ + /** [Method] Returns the value of right + * @returns Number/String + */ static getRight(): any; - /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class */ + /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class + * @returns Ext.scroll.View The scroll view. + */ static getScrollable(): Ext.scroll.IView; - /** [Method] Returns the value of showAnimation */ + /** [Method] Returns the value of showAnimation + * @returns String/Mixed + */ static getShowAnimation(): any; - /** [Method] Returns the height and width of the Component */ + /** [Method] Returns the height and width of the Component + * @returns Object The current height and width of the Component. + */ static getSize(): any; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns String/Object + */ static getStyle(): any; - /** [Method] Returns the value of styleHtmlCls */ + /** [Method] Returns the value of styleHtmlCls + * @returns String + */ static getStyleHtmlCls(): string; - /** [Method] Returns the value of styleHtmlContent */ + /** [Method] Returns the value of styleHtmlContent + * @returns Boolean + */ static getStyleHtmlContent(): boolean; - /** [Method] Returns the value of top */ + /** [Method] Returns the value of top + * @returns Number/String + */ static getTop(): any; - /** [Method] Returns the value of tpl */ + /** [Method] Returns the value of tpl + * @returns String/String[]/Ext.Template[]/Ext.XTemplate[] + */ static getTpl(): any; - /** [Method] Returns the value of tplWriteMode */ + /** [Method] Returns the value of tplWriteMode + * @returns String + */ static getTplWriteMode(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ static getUi(): string; - /** [Method] Returns the value of useBodyElement */ + /** [Method] Returns the value of useBodyElement + * @returns Boolean + */ static getUseBodyElement(): boolean; - /** [Method] Retrieves the document height */ + /** [Method] Retrieves the document height + * @returns Number height in pixels. + */ static getWindowHeight(): number; - /** [Method] Retrieves the document width */ + /** [Method] Retrieves the document width + * @returns Number width in pixels. + */ static getWindowWidth(): number; - /** [Method] Returns this Component s xtype hierarchy as a slash delimited string */ + /** [Method] Returns this Component s xtype hierarchy as a slash delimited string + * @returns String The xtype hierarchy string. + */ static getXTypes(): string; - /** [Method] Returns the value of zIndex */ + /** [Method] Returns the value of zIndex + * @returns Number + */ static getZIndex(): number; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; - /** [Method] Returns true if this component has a parent */ + /** [Method] Returns true if this component has a parent + * @returns Boolean true if this component has a parent. + */ static hasParent(): boolean; /** [Method] Hides this Component * @param animation Object/Boolean + * @returns Ext.Component */ static hide( animation?:any ): Ext.IComponent; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Allows addition of behavior to the rendering phase */ @@ -37537,13 +41698,18 @@ declare module Ext { * @param item Object The Component to insert. */ static insert( index?:number, item?:any ): void; - /** [Method] Returns true if this Component is currently disabled */ + /** [Method] Returns true if this Component is currently disabled + * @returns Boolean true if currently disabled. + */ static isDisabled(): boolean; - /** [Method] Returns true if this Component is currently hidden */ + /** [Method] Returns true if this Component is currently hidden + * @returns Boolean true if currently hidden. + */ static isHidden(): boolean; /** [Method] Tests whether or not this Component is of a specific xtype * @param xtype String The xtype to check for this Component. * @param shallow Boolean false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ static isXType( xtype?:string, shallow?:boolean ): boolean; /** [Method] Convenience method which calls setMasked with a value of true to show the mask @@ -37557,18 +41723,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -37576,37 +41738,36 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. + * @returns Array Ext.Component's which matched the selector. */ static query( selector?:string ): any[]; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes an item from this Container optionally destroying it * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ static remove( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes a before event handler @@ -37615,15 +41776,16 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all items currently in the Container optionally destroying them all * @param destroy Boolean If true, destroys each removed Component. * @param everything Boolean If true, completely remove all items including docked / centered and floating items. + * @returns Ext.Component this */ static removeAll( destroy?:boolean, everything?:boolean ): Ext.IComponent; /** [Method] Removes the Component at the specified index myContainer removeAt 0 removes the first item * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ static removeAt( index?:number ): Ext.IContainer; /** [Method] Removes a before event handler @@ -37632,8 +41794,7 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes the given CSS class es from this Component s rendered element * @param cls String The class(es) to remove. * @param prefix String Optional prefix to prepend before each class. @@ -37643,10 +41804,12 @@ declare module Ext { /** [Method] Removes a docked item from this Container * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ static removeDocked( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes an inner Component at the specified index myContainer removeInnerAt 0 removes the first item of the in * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ static removeInnerAt( index?:number ): Ext.IContainer; /** [Method] Removes an event handler @@ -37656,18 +41819,14 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Replaces specified classes with the newly specified classes * @param oldCls String The class(es) to remove. * @param newCls String The class(es) to add. @@ -37700,21 +41859,15 @@ declare module Ext { /** [Method] Sets the value of border * @param border Number/String */ - static setBorder( border?:any ): any; - static setBorder( border?:number ): void; - static setBorder( border?:string ): void; + static setBorder( border?:any ): void; /** [Method] Sets the value of bottom * @param bottom Number/String */ - static setBottom( bottom?:any ): any; - static setBottom( bottom?:number ): void; - static setBottom( bottom?:string ): void; + static setBottom( bottom?:any ): void; /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of centered * @param centered Boolean */ @@ -37722,16 +41875,11 @@ declare module Ext { /** [Method] Sets the value of cls * @param cls String/String[] */ - static setCls( cls?:any ): any; - static setCls( cls?:string ): void; - static setCls( cls?:string[] ): void; + static setCls( cls?:any ): void; /** [Method] Sets the value of contentEl * @param contentEl Ext.Element/HTMLElement/String */ - static setContentEl( contentEl?:any ): any; - static setContentEl( contentEl?:Ext.IElement ): void; - static setContentEl( contentEl?:HTMLElement ): void; - static setContentEl( contentEl?:string ): void; + static setContentEl( contentEl?:any ): void; /** [Method] Sets the value of control * @param control Object */ @@ -37767,13 +41915,11 @@ declare module Ext { /** [Method] Sets the value of enterAnimation * @param enterAnimation String/Mixed */ - static setEnterAnimation( enterAnimation?:any ): any; - static setEnterAnimation( enterAnimation?:string ): void; + static setEnterAnimation( enterAnimation?:any ): void; /** [Method] Sets the value of exitAnimation * @param exitAnimation String/Mixed */ - static setExitAnimation( exitAnimation?:any ): any; - static setExitAnimation( exitAnimation?:string ): void; + static setExitAnimation( exitAnimation?:any ): void; /** [Method] Sets the value of flex * @param flex Number */ @@ -37797,8 +41943,7 @@ declare module Ext { /** [Method] Sets the value of hideAnimation * @param hideAnimation String/Mixed */ - static setHideAnimation( hideAnimation?:any ): any; - static setHideAnimation( hideAnimation?:string ): void; + static setHideAnimation( hideAnimation?:any ): void; /** [Method] Sets the value of hideOnMaskTap * @param hideOnMaskTap Boolean */ @@ -37806,10 +41951,7 @@ declare module Ext { /** [Method] Sets the value of html * @param html String/Ext.Element/HTMLElement */ - static setHtml( html?:any ): any; - static setHtml( html?:string ): void; - static setHtml( html?:Ext.IElement ): void; - static setHtml( html?:HTMLElement ): void; + static setHtml( html?:any ): void; /** [Method] Sets the value of itemId * @param itemId String */ @@ -37825,9 +41967,7 @@ declare module Ext { /** [Method] Sets the value of left * @param left Number/String */ - static setLeft( left?:any ): any; - static setLeft( left?:number ): void; - static setLeft( left?:string ): void; + static setLeft( left?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -37835,9 +41975,7 @@ declare module Ext { /** [Method] Sets the value of margin * @param margin Number/String */ - static setMargin( margin?:any ): any; - static setMargin( margin?:number ): void; - static setMargin( margin?:string ): void; + static setMargin( margin?:any ): void; /** [Method] Sets the value of masked * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask */ @@ -37845,27 +41983,19 @@ declare module Ext { /** [Method] Sets the value of maxHeight * @param maxHeight Number/String */ - static setMaxHeight( maxHeight?:any ): any; - static setMaxHeight( maxHeight?:number ): void; - static setMaxHeight( maxHeight?:string ): void; + static setMaxHeight( maxHeight?:any ): void; /** [Method] Sets the value of maxWidth * @param maxWidth Number/String */ - static setMaxWidth( maxWidth?:any ): any; - static setMaxWidth( maxWidth?:number ): void; - static setMaxWidth( maxWidth?:string ): void; + static setMaxWidth( maxWidth?:any ): void; /** [Method] Sets the value of minHeight * @param minHeight Number/String */ - static setMinHeight( minHeight?:any ): any; - static setMinHeight( minHeight?:number ): void; - static setMinHeight( minHeight?:string ): void; + static setMinHeight( minHeight?:any ): void; /** [Method] Sets the value of minWidth * @param minWidth Number/String */ - static setMinWidth( minWidth?:any ): any; - static setMinWidth( minWidth?:number ): void; - static setMinWidth( minWidth?:string ): void; + static setMinWidth( minWidth?:any ): void; /** [Method] Sets the value of modal * @param modal Boolean */ @@ -37873,9 +42003,7 @@ declare module Ext { /** [Method] Sets the value of padding * @param padding Number/String */ - static setPadding( padding?:any ): any; - static setPadding( padding?:number ): void; - static setPadding( padding?:string ): void; + static setPadding( padding?:any ): void; /** [Method] Sets the value of plugins * @param plugins Object/Array */ @@ -37899,9 +42027,7 @@ declare module Ext { /** [Method] Sets the value of right * @param right Number/String */ - static setRight( right?:any ): any; - static setRight( right?:number ): void; - static setRight( right?:string ): void; + static setRight( right?:any ): void; /** [Method] Sets the value of scrollable * @param scrollable Boolean/String/Object */ @@ -37909,8 +42035,7 @@ declare module Ext { /** [Method] Sets the value of showAnimation * @param showAnimation String/Mixed */ - static setShowAnimation( showAnimation?:any ): any; - static setShowAnimation( showAnimation?:string ): void; + static setShowAnimation( showAnimation?:any ): void; /** [Method] Sets the size of the Component * @param width Number The new width for the Component. * @param height Number The new height for the Component. @@ -37931,17 +42056,11 @@ declare module Ext { /** [Method] Sets the value of top * @param top Number/String */ - static setTop( top?:any ): any; - static setTop( top?:number ): void; - static setTop( top?:string ): void; + static setTop( top?:any ): void; /** [Method] Sets the value of tpl * @param tpl String/String[]/Ext.Template[]/Ext.XTemplate[] */ - static setTpl( tpl?:any ): any; - static setTpl( tpl?:string ): void; - static setTpl( tpl?:string[] ): void; - static setTpl( tpl?:Ext.ITemplate[] ): void; - static setTpl( tpl?:Ext.IXTemplate[] ): void; + static setTpl( tpl?:any ): void; /** [Method] Sets the value of tplWriteMode * @param tplWriteMode String */ @@ -37960,6 +42079,7 @@ declare module Ext { static setZIndex( zIndex?:number ): void; /** [Method] Shows this component * @param animation Object/Boolean + * @returns Ext.Component */ static show( animation?:any ): Ext.IComponent; /** [Method] Shows this component by another component @@ -37967,7 +42087,9 @@ declare module Ext { * @param alignment String The specific alignment. */ static showBy( component?:Ext.IComponent, alignment?:string ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends the firing of all events */ static suspendEvents(): void; @@ -37978,29 +42100,26 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Convenience method which calls setMasked with a value of false to hide the mask */ static unmask(): void; /** [Method] Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector * @param selector String The simple selector to test. + * @returns Ext.Container The matching ancestor Container (or undefined if no match was found). */ static up( selector?:string ): Ext.IContainer; /** [Method] Updates the HTML content of the Component */ @@ -38034,6 +42153,7 @@ declare module Ext { * @param values Object/Array The template values. See apply. * @param out Array The array to which output is pushed. * @param parent Object + * @returns Array The given out array. */ applyOut?( values?:any, out?:any[], parent?:any ): any[]; } @@ -38044,13 +42164,16 @@ declare module Ext { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] * @param args Object */ static callParent( args?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -38060,19 +42183,22 @@ declare module Ext { /** [Method] Creates a template from the passed element s value display none textarea preferred or innerHTML * @param el String/HTMLElement A DOM element or its id. * @param config Object Config object. + * @returns Ext.Template The created template. + */ + static from( el?:any, config?:any ): Ext.ITemplate; + /** [Method] Get the current class name in string format + * @returns String className */ - static from( el?:any, config?:any ): any; - static from( el?:string, config?:any ): Ext.ITemplate; - static from( el?:HTMLElement, config?:any ): Ext.ITemplate; - /** [Method] Get the current class name in string format */ static getName(): string; /** [Method] Gets an XTemplate from an object an instance of an Ext define d class * @param instance Object The object from which to get the XTemplate (must be an instance of an Ext.define'd class). * @param name String The name of the property by which to get the XTemplate. + * @returns Ext.XTemplate The XTemplate instance or null if not found. */ static getTpl( instance?:any, name?:string ): Ext.IXTemplate; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } From a9823af18849754870a8933e65cc66a8190abb52 Mon Sep 17 00:00:00 2001 From: Dick van den Brink Date: Thu, 5 Sep 2013 13:59:42 +0200 Subject: [PATCH 456/756] Added jquery mobile loader options to definition. --- jquerymobile/jquerymobile.d.ts | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/jquerymobile/jquerymobile.d.ts b/jquerymobile/jquerymobile.d.ts index b4c9298ea1..8dacdbc114 100644 --- a/jquerymobile/jquerymobile.d.ts +++ b/jquerymobile/jquerymobile.d.ts @@ -274,12 +274,19 @@ interface LoadPageOptions { type?: string; } +interface LoaderOptions { + theme?: string; + textVisible?: boolean; + html?: string; + text?: string; +} + interface JQueryMobile extends JQueryMobileOptions { changePage(to: any, options?: ChangePageOptions): void; initializePage(): void; loadPage(url: any, options?: LoadPageOptions): void; - loading(command: string, options? ): void; + loading(command: string, options?: LoaderOptions): void; base; silentScroll(yPos: number): void; @@ -378,4 +385,4 @@ interface JQuery { interface JQueryStatic { mobile: JQueryMobile; -} +} From b97d1e29f3d1170243fd11595a5fedfec506d501 Mon Sep 17 00:00:00 2001 From: Dick van den Brink Date: Thu, 5 Sep 2013 14:06:53 +0200 Subject: [PATCH 457/756] Missing textonly option. --- jquerymobile/jquerymobile.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/jquerymobile/jquerymobile.d.ts b/jquerymobile/jquerymobile.d.ts index 8dacdbc114..de51518d8e 100644 --- a/jquerymobile/jquerymobile.d.ts +++ b/jquerymobile/jquerymobile.d.ts @@ -279,6 +279,7 @@ interface LoaderOptions { textVisible?: boolean; html?: string; text?: string; + textonly?: boolean; } interface JQueryMobile extends JQueryMobileOptions { From ac138ae19caeea9e18a2f765adb269b51498b1ab Mon Sep 17 00:00:00 2001 From: Lasse Jul-Larsen Date: Thu, 5 Sep 2013 14:38:32 +0200 Subject: [PATCH 458/756] Made optional parameters optional, fixed DataView to implement DataProvider and corrected method signature in DataView to match DataProvider interface --- slickgrid/SlickGrid.d.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/slickgrid/SlickGrid.d.ts b/slickgrid/SlickGrid.d.ts index 44acc4c1bb..50c7c29046 100644 --- a/slickgrid/SlickGrid.d.ts +++ b/slickgrid/SlickGrid.d.ts @@ -1459,15 +1459,15 @@ declare module Slick { export module Data { export interface DataViewOptions { - groupItemMetadataProvider: GroupItemMetadataProvider; - inlineFilters: boolean; + groupItemMetadataProvider?: GroupItemMetadataProvider; + inlineFilters?: boolean; } /** * Item -> Data by index * Row -> Data by row **/ - export class DataView { + export class DataView implements DataProvider { constructor(options: DataViewOptions); @@ -1537,7 +1537,7 @@ declare module Slick { public syncGridCellCssStyles(grid: Grid, key: string): void; public getLength(): number; - public getItem(): void; + public getItem(index: number): SlickData; public getItemMetadata(): void; public onRowCountChanged: Slick.SlickEvent; From e349b79cbd4c2915a18a7e3464be8725deabd6b9 Mon Sep 17 00:00:00 2001 From: unknown Date: Thu, 5 Sep 2013 15:32:03 +0200 Subject: [PATCH 459/756] Added navbar options and method. --- jquerymobile/jquerymobile.d.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/jquerymobile/jquerymobile.d.ts b/jquerymobile/jquerymobile.d.ts index de51518d8e..40fec050fa 100644 --- a/jquerymobile/jquerymobile.d.ts +++ b/jquerymobile/jquerymobile.d.ts @@ -282,6 +282,10 @@ interface LoaderOptions { textonly?: boolean; } +interface NavbarOptions { + iconpos: string; +} + interface JQueryMobile extends JQueryMobileOptions { changePage(to: any, options?: ChangePageOptions): void; @@ -316,6 +320,7 @@ interface JQueryMobile extends JQueryMobileOptions { checkboxradio; selectmenu; listview; + navbar(options?: NavbarOptions); } interface JQuerySupport { From 0ee996cb6ad7bca5796579808291b02e5d883bcd Mon Sep 17 00:00:00 2001 From: unknown Date: Thu, 5 Sep 2013 15:40:26 +0200 Subject: [PATCH 460/756] Small mistake in previous commit. --- jquerymobile/jquerymobile.d.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/jquerymobile/jquerymobile.d.ts b/jquerymobile/jquerymobile.d.ts index 40fec050fa..d1be137a5e 100644 --- a/jquerymobile/jquerymobile.d.ts +++ b/jquerymobile/jquerymobile.d.ts @@ -288,6 +288,8 @@ interface NavbarOptions { interface JQueryMobile extends JQueryMobileOptions { + version: string; + changePage(to: any, options?: ChangePageOptions): void; initializePage(): void; loadPage(url: any, options?: LoadPageOptions): void; @@ -320,7 +322,6 @@ interface JQueryMobile extends JQueryMobileOptions { checkboxradio; selectmenu; listview; - navbar(options?: NavbarOptions); } interface JQuerySupport { @@ -386,6 +387,8 @@ interface JQuery { listview(command: string): JQuery; listview(options: ListViewOptions): JQuery; listview(events: ListViewEvents): JQuery; + + navbar(options?: NavbarOptions): JQuery; } From aa7e4926dcfdda4f8dfd0bb57f13277939002445 Mon Sep 17 00:00:00 2001 From: unknown Date: Thu, 5 Sep 2013 15:55:45 +0200 Subject: [PATCH 461/756] Moved NavbarOptions next to the other components. Added methods for table. --- jquerymobile/jquerymobile.d.ts | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/jquerymobile/jquerymobile.d.ts b/jquerymobile/jquerymobile.d.ts index d1be137a5e..956c7a0401 100644 --- a/jquerymobile/jquerymobile.d.ts +++ b/jquerymobile/jquerymobile.d.ts @@ -186,6 +186,10 @@ interface ListViewEvents { create?: JQueryMobileEvent; } +interface NavbarOptions { + iconpos: string; +} + interface JQueryMobileOptions { activeBtnClass?: string; activePageClass?: string; @@ -282,10 +286,6 @@ interface LoaderOptions { textonly?: boolean; } -interface NavbarOptions { - iconpos: string; -} - interface JQueryMobile extends JQueryMobileOptions { version: string; @@ -389,6 +389,9 @@ interface JQuery { listview(events: ListViewEvents): JQuery; navbar(options?: NavbarOptions): JQuery; + + table(): JQuery; + table(command: string): JQuery; } From 11e08e1d4ea877da0f94be4d4f082ceeaf90971d Mon Sep 17 00:00:00 2001 From: areel Date: Thu, 5 Sep 2013 18:38:15 +0100 Subject: [PATCH 462/756] If eventName is an instance of an event map e.g '{change:action}' then callback is not required. So callback should be marked as optional. Related to earlier commit (cb1b62852708536407d535aae31af77fef68cdd4) --- backbone/backbone.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backbone/backbone.d.ts b/backbone/backbone.d.ts index 1a6f3d8fe0..e2579c407f 100644 --- a/backbone/backbone.d.ts +++ b/backbone/backbone.d.ts @@ -67,7 +67,7 @@ declare module Backbone { } class Events { - on(eventName: any, callback: (...args: any[]) => void , context?: any): any; + on(eventName: any, callback?: (...args: any[]) => void , context?: any): any; off(eventName?: string, callback?: (...args: any[]) => void , context?: any): any; trigger(eventName: string, ...args: any[]): any; bind(eventName: string, callback: (...args: any[]) => void , context?: any): any; From 81d419bacf304ffc93728a3ec58c6e8195a914e2 Mon Sep 17 00:00:00 2001 From: marioK Date: Thu, 5 Sep 2013 13:12:43 -0700 Subject: [PATCH 463/756] Fixed withArgs return type on SinonStub and SinonSpy --- sinon/sinon-1.5.d.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sinon/sinon-1.5.d.ts b/sinon/sinon-1.5.d.ts index 17e3115cd0..0ae83aa4d6 100644 --- a/sinon/sinon-1.5.d.ts +++ b/sinon/sinon-1.5.d.ts @@ -59,7 +59,7 @@ interface SinonSpy extends SinonSpyCallApi { calledBefore(anotherSpy: SinonSpy): boolean; calledAfter(anotherSpy: SinonSpy): boolean; calledWithNew(spy: SinonSpy): boolean; - withArgs(...args: any[]): void; + withArgs(...args: any[]): SinonSpy; alwaysCalledOn(obj: any); alwaysCalledWith(...args: any[]); alwaysCalledWithExactly(...args: any[]); @@ -109,6 +109,7 @@ interface SinonStub extends SinonSpy { yieldsOnAsync(context: any, ...args: any[]): SinonStub; yieldsToAsync(property: string, ...args: any[]): SinonStub; yieldsToOnAsync(property: string, context: any, ...args: any[]): SinonStub; + withArgs(...args: any[]): SinonStub; } interface SinonStubStatic { From edd97d5bd52dc96042d715c83d82a8e6a70749fc Mon Sep 17 00:00:00 2001 From: Alex Varju Date: Thu, 5 Sep 2013 14:56:28 -0700 Subject: [PATCH 464/756] Add superagent and supertest definitions --- superagent/superagent-tests.ts | 12 +++++ superagent/superagent.d.ts | 84 ++++++++++++++++++++++++++++++++++ supertest/supertest-tests.ts | 16 +++++++ supertest/supertest.d.ts | 53 +++++++++++++++++++++ 4 files changed, 165 insertions(+) create mode 100644 superagent/superagent-tests.ts create mode 100644 superagent/superagent.d.ts create mode 100644 supertest/supertest-tests.ts create mode 100644 supertest/supertest.d.ts diff --git a/superagent/superagent-tests.ts b/superagent/superagent-tests.ts new file mode 100644 index 0000000000..23961b30ab --- /dev/null +++ b/superagent/superagent-tests.ts @@ -0,0 +1,12 @@ +/// + +import superagent = require('superagent') + +var agent = superagent.agent(); +agent + .post('http://localhost:3000/signin') + .send({ email: 'test@dummy.com', password: 'bacon' }) + .end((err, res) => { + if (err) throw err; + if (res.status !== 200) throw new Error('bad status ' + res.status); + }); diff --git a/superagent/superagent.d.ts b/superagent/superagent.d.ts new file mode 100644 index 0000000000..ee2aaa5f48 --- /dev/null +++ b/superagent/superagent.d.ts @@ -0,0 +1,84 @@ +// Type definitions for SuperAgent 0.15.4 +// Project: https://github.com/visionmedia/superagent +// Definitions by: Alex Varju +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +/// + +declare module "superagent" { + export interface Response { + text: string; + body: Object; + header: Object; + type: string; + charset: string; + status: number; + statusType: number; + info: boolean; + ok: boolean; + redirect: boolean; + clientError: boolean; + serverError: boolean; + error: any; + accepted: boolean; + noContent: boolean; + badRequest: boolean; + unauthorized: boolean; + notAcceptable: boolean; + notFound: boolean; + forbidden: boolean; + get(header: string): string; + } + + export interface Request { + attach(field: string, file: string, filename: string): Request; + redirects(n: number): Request; + part(): Request; + set(field: string, val: string): Request; + set(field: Object): Request; + get(field: string): string; + type(val: string): Request; + query(val: Object): Request; + send(data: string): Request; + send(data: Object): Request; + write(data: string, encoding: string): boolean; + write(data: NodeBuffer, encoding: string): boolean; + pipe(stream: WritableStream, options?: Object): WritableStream; + buffer(val: boolean): Request; + timeout(ms: number): Request; + clearTimeout(): Request; + abort(): void; + auth(user: string, name: string): Request; + field(name: string, val: string): Request; + end(callback?: (err: Error, res: Response) => void): Request; + } + + export interface Agent { + get(url: string, callback?: (err: Error, res: Response) => void): Request; + post(url: string, callback?: (err: Error, res: Response) => void): Request; + put(url: string, callback?: (err: Error, res: Response) => void): Request; + head(url: string, callback?: (err: Error, res: Response) => void): Request; + del(url: string, callback?: (err: Error, res: Response) => void): Request; + options(url: string, callback?: (err: Error, res: Response) => void): Request; + trace(url: string, callback?: (err: Error, res: Response) => void): Request; + copy(url: string, callback?: (err: Error, res: Response) => void): Request; + lock(url: string, callback?: (err: Error, res: Response) => void): Request; + mkcol(url: string, callback?: (err: Error, res: Response) => void): Request; + move(url: string, callback?: (err: Error, res: Response) => void): Request; + propfind(url: string, callback?: (err: Error, res: Response) => void): Request; + proppatch(url: string, callback?: (err: Error, res: Response) => void): Request; + unlock(url: string, callback?: (err: Error, res: Response) => void): Request; + report(url: string, callback?: (err: Error, res: Response) => void): Request; + mkactivity(url: string, callback?: (err: Error, res: Response) => void): Request; + checkout(url: string, callback?: (err: Error, res: Response) => void): Request; + merge(url: string, callback?: (err: Error, res: Response) => void): Request; + //m-search(url: string, callback?: (err: Error, res: Response) => void): Request; + notify(url: string, callback?: (err: Error, res: Response) => void): Request; + subscribe(url: string, callback?: (err: Error, res: Response) => void): Request; + unsubscribe(url: string, callback?: (err: Error, res: Response) => void): Request; + patch(url: string, callback?: (err: Error, res: Response) => void): Request; + parse(fn: Function): Request; + } + + export function agent(): Agent; +} diff --git a/supertest/supertest-tests.ts b/supertest/supertest-tests.ts new file mode 100644 index 0000000000..1a1d60db79 --- /dev/null +++ b/supertest/supertest-tests.ts @@ -0,0 +1,16 @@ +/// +/// + +import supertest = require('supertest') +import express = require('express'); + +var app = express(); + +supertest(app) + .get('/user') + .expect('Content-Type', /json/) + .expect('Content-Length', '20') + .expect(201) + .end((err, res) => { + if (err) throw err; + }); diff --git a/supertest/supertest.d.ts b/supertest/supertest.d.ts new file mode 100644 index 0000000000..8a2069d336 --- /dev/null +++ b/supertest/supertest.d.ts @@ -0,0 +1,53 @@ +// Type definitions for SuperTest 0.8.0 +// Project: https://github.com/visionmedia/supertest +// Definitions by: Alex Varju +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +/// + +declare module "supertest" { + import superagent = require('superagent'); + + module supertest { + interface Test extends superagent.Request { + url: string; + serverAddress(app: any, path: string): string; + expect(status: number, callback?: (err: Error, res: superagent.Response) => void): Test; + expect(status: number, body: string, callback?: (err: Error, res: superagent.Response) => void): Test; + expect(body: string, callback?: (err: Error, res: superagent.Response) => void): Test; + expect(body: RegExp, callback?: (err: Error, res: superagent.Response) => void): Test; + expect(body: Object, callback?: (err: Error, res: superagent.Response) => void): Test; + expect(field: string, val: string, callback?: (err: Error, res: superagent.Response) => void): Test; + expect(field: string, val: RegExp, callback?: (err: Error, res: superagent.Response) => void): Test; + } + + interface SuperTest { + get(url: string): Test; + post(url: string): Test; + put(url: string): Test; + head(url: string): Test; + del(url: string): Test; + options(url: string): Test; + trace(url: string): Test; + copy(url: string): Test; + lock(url: string): Test; + mkcol(url: string): Test; + move(url: string): Test; + propfind(url: string): Test; + proppatch(url: string): Test; + unlock(url: string): Test; + report(url: string): Test; + mkactivity(url: string): Test; + checkout(url: string): Test; + merge(url: string): Test; + //m-search(url: string): Test; + notify(url: string): Test; + subscribe(url: string): Test; + unsubscribe(url: string): Test; + patch(url: string): Test; + } + } + + function supertest(app: any): supertest.SuperTest; + export = supertest; +} From 3508bde7e665eef1c4a55193354de6c6c158ea36 Mon Sep 17 00:00:00 2001 From: Diullei Date: Thu, 5 Sep 2013 22:23:47 -0300 Subject: [PATCH 465/756] fix - gapi test failure --- gapi.youtube/gapi.youtube.d.ts | 770 ++++++++++++++++----------------- gapi/gapi.d.ts | 6 +- 2 files changed, 388 insertions(+), 388 deletions(-) diff --git a/gapi.youtube/gapi.youtube.d.ts b/gapi.youtube/gapi.youtube.d.ts index afef4a7aad..3d0930787f 100644 --- a/gapi.youtube/gapi.youtube.d.ts +++ b/gapi.youtube/gapi.youtube.d.ts @@ -15,7 +15,7 @@ declare module gapi.client.youtube { */ insert(object: { /** - * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. */ part: string; /** @@ -29,39 +29,39 @@ declare module gapi.client.youtube { */ list(object: { /** - * The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. + * The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. */ part: string; /** - * The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities. + * The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities. */ channelId?: string; /** - * Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user. + * Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user. */ home?: boolean; /** - * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * Set this parameter's value to true to retrieve a feed of the authenticated user's activities. + * Set this parameter's value to true to retrieve a feed of the authenticated user's activities. */ mine?: boolean; /** - * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAfter?: string; /** - * The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedBefore?: string; /** - * The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. + * The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. */ regionCode?: string; }): HttpRequest>; @@ -69,13 +69,13 @@ declare module gapi.client.youtube { } export interface channelBanners { - + /** * Uploads a channel banner to YouTube. */ insert(object: { /** - * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner: string; /** @@ -86,63 +86,63 @@ declare module gapi.client.youtube { } export interface channels { - + /** * Returns a collection of zero or more channel resources that match the request criteria. */ list(object: { /** - * The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, statistics, topicDetails, and invideoPromotion. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties. + * The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, statistics, topicDetails, and invideoPromotion. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties. */ part: string; /** - * The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category. + * The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category. */ categoryId?: string; /** - * The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username. + * The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username. */ forUsername?: string; /** - * The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID. + * The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID. */ id?: string; /** - * Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided. + * Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided. */ managedByMe?: boolean; /** - * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user. + * Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user. */ mine?: boolean; /** - * Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel. + * Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel. */ mySubscribers?: boolean; /** - * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; }): HttpRequest>; - + /** * Updates a channel's metadata. */ update(object: { /** - * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are id and invideoPromotion. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are id and invideoPromotion. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. */ part: string; /** - * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** @@ -154,25 +154,25 @@ declare module gapi.client.youtube { } export interface guideCategories { - + /** * Returns a list of categories that can be associated with YouTube channels. */ list(object: { /** - * The part parameter specifies a comma-separated list of one or more guideCategory resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a guideCategory resource, the snippet property contains other properties, such as the category's title. If you set part=snippet, the API response will also contain all of those nested properties. + * The part parameter specifies a comma-separated list of one or more guideCategory resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a guideCategory resource, the snippet property contains other properties, such as the category's title. If you set part=snippet, the API response will also contain all of those nested properties. */ part: string; /** - * The hl parameter specifies the language that will be used for text values in the API response. + * The hl parameter specifies the language that will be used for text values in the API response. */ hl?: string; /** - * The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a guideCategory resource, the id property specifies the YouTube channel category ID. + * The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a guideCategory resource, the id property specifies the YouTube channel category ID. */ id?: string; /** - * The regionCode parameter instructs the API to return the list of guide categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. + * The regionCode parameter instructs the API to return the list of guide categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. */ regionCode?: string; }): HttpRequest>; @@ -180,23 +180,23 @@ declare module gapi.client.youtube { } export interface playlistItems { - + /** * Deletes a playlist item. */ delete(object: { /** - * The id parameter specifies the YouTube playlist item ID for the playlist item that is being deleted. In a playlistItem resource, the id property specifies the playlist item's ID. + * The id parameter specifies the YouTube playlist item ID for the playlist item that is being deleted. In a playlistItem resource, the id property specifies the playlist item's ID. */ id: string; }): HttpRequest; - + /** * Adds a resource to a playlist. */ insert(object: { /** - * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. */ part: string; /** @@ -204,43 +204,43 @@ declare module gapi.client.youtube { */ RequestBody?: string; }): HttpRequest; - + /** * Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs. */ list(object: { /** - * The part parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set part=snippet, the API response will contain all of those properties. + * The part parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set part=snippet, the API response will contain all of those properties. */ part: string; /** - * The id parameter specifies a comma-separated list of one or more unique playlist item IDs. + * The id parameter specifies a comma-separated list of one or more unique playlist item IDs. */ id?: string; /** - * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The playlistId parameter specifies the unique ID of the playlist for which you want to retrieve playlist items. Note that even though this is an optional parameter, every request to retrieve playlist items must specify a value for either the id parameter or the playlistId parameter. + * The playlistId parameter specifies the unique ID of the playlist for which you want to retrieve playlist items. Note that even though this is an optional parameter, every request to retrieve playlist items must specify a value for either the id parameter or the playlistId parameter. */ playlistId?: string; /** - * The videoId parameter specifies that the request should return only the playlist items that contain the specified video. + * The videoId parameter specifies that the request should return only the playlist items that contain the specified video. */ videoId?: string; }): HttpRequest>; - + /** * Modifies a playlist item. For example, you could update the item's position in the playlist. */ update(object: { /** - * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist's privacy setting is contained in the status part. As such, if your request is updating a private playlist, and the request's part parameter value includes the status part, the playlist's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the playlist will revert to the default privacy setting. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist's privacy setting is contained in the status part. As such, if your request is updating a private playlist, and the request's part parameter value includes the status part, the playlist's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the playlist will revert to the default privacy setting. */ part: string; /** @@ -251,24 +251,24 @@ declare module gapi.client.youtube { } export interface playlists { - + /** * Deletes a playlist. */ delete(object: { /** - * The id parameter specifies the YouTube playlist ID for the playlist that is being deleted. In a playlist resource, the id property specifies the playlist's ID. + * The id parameter specifies the YouTube playlist ID for the playlist that is being deleted. In a playlist resource, the id property specifies the playlist's ID. */ id: string; }): HttpRequest; - + /** * Creates a playlist. */ insert(object: { /** - * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and status. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and status. */ part: string; /** @@ -276,43 +276,43 @@ declare module gapi.client.youtube { */ RequestBody?: string; }): HttpRequest; - + /** * Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs. */ list(object: { /** - * The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and status. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties. + * The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and status. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties. */ part: string; /** - * This value indicates that the API should only return the specified channel's playlists. + * This value indicates that the API should only return the specified channel's playlists. */ channelId?: string; /** - * The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved. In a playlist resource, the id property specifies the playlist's YouTube playlist ID. + * The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved. In a playlist resource, the id property specifies the playlist's YouTube playlist ID. */ id?: string; /** - * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user. + * Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user. */ mine?: boolean; /** - * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pagetoken: string; }): HttpRequest>; - + /** * Modifies a playlist. For example, you could change a playlist's title, description, or privacy status. */ update(object: { /** - * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist's privacy setting is contained in the status part. As such, if your request is updating a private playlist, and the request's part parameter value includes the status part, the playlist's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the playlist will revert to the default privacy setting. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist's privacy setting is contained in the status part. As such, if your request is updating a private playlist, and the request's part parameter value includes the status part, the playlist's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the playlist will revert to the default privacy setting. */ part: string; /** @@ -324,113 +324,113 @@ declare module gapi.client.youtube { } export interface search { - + /** * Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource. */ list(object: { /** - * The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a search result, the snippet property contains other properties that identify the result's title, description, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. + * The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a search result, the snippet property contains other properties that identify the result's title, description, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. */ part: string; /** - * The channelId parameter indicates that the API response should only contain resources created by the channel + * The channelId parameter indicates that the API response should only contain resources created by the channel */ channelId?: string; /** - * The channelType parameter lets you restrict a search to a particular type of channel. + * The channelType parameter lets you restrict a search to a particular type of channel. */ channelType?: string; /** - * The forContentOwner parameter restricts the search to only retrieve resources owned by the content owner specified by the onBehalfOfContentOwner parameter. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided. + * The forContentOwner parameter restricts the search to only retrieve resources owned by the content owner specified by the onBehalfOfContentOwner parameter. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided. */ forContentOwner?: boolean; /** - * The forMine parameter restricts the search to only retrieve videos owned by the authenticated user. + * The forMine parameter restricts the search to only retrieve videos owned by the authenticated user. */ forMine?: boolean; /** - * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The order parameter specifies the method that will be used to order resources in the API response. + * The order parameter specifies the method that will be used to order resources in the API response. */ order?: string; /** - * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The publishedAfter parameter indicates that the API response should only contain resources created after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). + * The publishedAfter parameter indicates that the API response should only contain resources created after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). */ publishedAfter?: string; /** - * The publishedBefore parameter indicates that the API response should only contain resources created before the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). + * The publishedBefore parameter indicates that the API response should only contain resources created before the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). */ publishedBefore?: string; /** - * The q parameter specifies the query term to search for. + * The q parameter specifies the query term to search for. */ q?: string; /** - * The regionCode parameter instructs the API to return search results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. + * The regionCode parameter instructs the API to return search results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. */ regionCode?: string; /** - * The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video. + * The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video. */ relatedToVideoId?: string; /** - * The safeSearch parameter indicates whether the search results should include restricted content as well as standard content. + * The safeSearch parameter indicates whether the search results should include restricted content as well as standard content. */ safeSearch?: string; /** - * The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID. + * The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID. */ topicId?: string; /** - * The type parameter restricts a search query to only retrieve a particular type of resource. + * The type parameter restricts a search query to only retrieve a particular type of resource. */ type?: string; /** - * The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions. + * The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions. */ videoCaption?: string; /** - * The videoCategoryId parameter filters video search results based on their category. + * The videoCategoryId parameter filters video search results based on their category. */ videoCategoryId?: string; /** - * The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available. + * The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available. */ videoDefinition?: string; /** - * The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos. + * The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos. */ videoDimension?: string; /** - * The videoDuration parameter filters video search results based on their duration. + * The videoDuration parameter filters video search results based on their duration. */ videoDuration?: string; /** - * The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage. + * The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage. */ videoEmbeddable?: string; /** - * The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos. + * The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos. */ videoLicense?: string; /** - * The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com. + * The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com. */ videoSyndicated?: string; /** - * The videoType parameter lets you restrict a search to a particular type of videos. + * The videoType parameter lets you restrict a search to a particular type of videos. */ videoType?: string; }): HttpRequest>; @@ -438,23 +438,23 @@ declare module gapi.client.youtube { } export interface subscriptions { - + /** * Deletes a subscription. */ delete(object: { /** - * The id parameter specifies the YouTube subscription ID for the resource that is being deleted. In a subscription resource, the id property specifies the YouTube subscription ID. + * The id parameter specifies the YouTube subscription ID for the resource that is being deleted. In a subscription resource, the id property specifies the YouTube subscription ID. */ id: string; }): HttpRequest; - + /** * Adds a subscription for the authenticated user's channel. */ insert(object: { /** - * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. */ part: string; /** @@ -462,143 +462,143 @@ declare module gapi.client.youtube { */ RequestBody: string; }): HttpRequest; - + /** * Returns subscription resources that match the API request criteria. */ list(object: { /** - * The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties. + * The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties. */ part: string; /** - * The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions. + * The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions. */ channelId?: string; /** - * The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels. + * The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels. */ forChannelId?: string; /** - * The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID. + * The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID. */ id?: string; /** - * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions. + * Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions. */ mine?: boolean; /** - * Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user. + * Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user. */ mySubscripbers?: boolean; /** - * The order parameter specifies the method that will be used to sort resources in the API response. + * The order parameter specifies the method that will be used to sort resources in the API response. */ order?: string; /** - * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; }): HttpRequest>; } export interface thumbnails { - + /** * Uploads a custom video thumbnail to YouTube and sets it for a video. */ set(object: { /** - * The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided. + * The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided. */ videoId: string; }): HttpRequest>; } - + export interface videoCategories { - + /** * Returns a list of categories that can be associated with YouTube videos. */ list(object: { /** - * The part parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet. + * The part parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet. */ part: string; /** - * The hl parameter specifies the language that should be used for text values in the API response. + * The hl parameter specifies the language that should be used for text values in the API response. */ hl?: string; /** - * The id parameter specifies a comma-separated list of video category IDs for the resources that you are retrieving. + * The id parameter specifies a comma-separated list of video category IDs for the resources that you are retrieving. */ id?: string; /** - * The regionCode parameter instructs the API to return the list of video categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. + * The regionCode parameter instructs the API to return the list of video categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. */ regionCode?: string; }): HttpRequest>; - + } export interface videos { - + /** * Deletes a YouTube video. */ delete(object: { /** - * The id parameter specifies the YouTube video ID for the resource that is being deleted. In a video resource, the id property specifies the video's ID. + * The id parameter specifies the YouTube video ID for the resource that is being deleted. In a video resource, the id property specifies the video's ID. */ id: string; /** - * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; }): HttpRequest; - + /** * Get user ratings for videos. */ getRating(object: { /** - * The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID. + * The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID. */ id: string; /** - * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; }): HttpRequest; - + /** * Uploads a video to YouTube and optionally sets the video's metadata. */ insert(object: { /** - * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet, contentDetails, player, statistics, status, and topicDetails. However, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet, contentDetails, player, statistics, status, and topicDetails. However, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. */ part: string; /** - * The autoLevels parameter specifies whether the video should be auto-leveled by YouTube. + * The autoLevels parameter specifies whether the video should be auto-leveled by YouTube. */ autoLevels?: boolean; /** - * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the channel specified in the parameter value. This parameter must be used in conjunction with the onBehalfOfContentOwner parameter, and the user must be authenticated using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. In addition, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the channel specified in the parameter value. This parameter must be used in conjunction with the onBehalfOfContentOwner parameter, and the user must be authenticated using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. In addition, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The stabilize parameter specifies whether the video should be stabilized by YouTube. + * The stabilize parameter specifies whether the video should be stabilized by YouTube. */ stabilize?: boolean; /** @@ -606,77 +606,77 @@ declare module gapi.client.youtube { */ RequestBody?: string; }): HttpRequest; - + /** * Returns a list of videos that match the API request parameters. */ list(object: { /** - * The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, player, statistics, status, and topicDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties. + * The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, player, statistics, status, and topicDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties. */ part: string; /** - * Set this parameter's value to mostPopular to instruct the API to return videos belonging to the chart of most popular videos. + * Set this parameter's value to mostPopular to instruct the API to return videos belonging to the chart of most popular videos. */ chart: string; /** - * The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID. + * The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID. */ id: string; /** - * The locale parameter selects a video chart available in the specified locale. If using this parameter, chart must also be set. The parameter value is an BCP 47 locale. Supported locales include ar_AE, ar_DZ, ar_EG, ar_JO, ar_MA, ar_SA, ar_TN, ar_YE, cs_CZ, de_DE, el_GR, en_AU, en_BE, en_CA, en_GB, en_GH, en_IE, en_IL, en_IN, en_KE, en_NG, en_NZ, en_SG, en_UG, en_US, en_ZA, es_AR, es_CL, es_CO, es_ES, es_MX, es_PE, fil_PH, fr_FR, hu_HU, id_ID, it_IT, ja_JP, ko_KR, ms_MY, nl_NL, pl_PL, pt_BR, ru_RU, sv_SE, tr_TR, zh_HK, zh_TW + * The locale parameter selects a video chart available in the specified locale. If using this parameter, chart must also be set. The parameter value is an BCP 47 locale. Supported locales include ar_AE, ar_DZ, ar_EG, ar_JO, ar_MA, ar_SA, ar_TN, ar_YE, cs_CZ, de_DE, el_GR, en_AU, en_BE, en_CA, en_GB, en_GH, en_IE, en_IL, en_IN, en_KE, en_NG, en_NZ, en_SG, en_UG, en_US, en_ZA, es_AR, es_CL, es_CO, es_ES, es_MX, es_PE, fil_PH, fr_FR, hu_HU, id_ID, it_IT, ja_JP, ko_KR, ms_MY, nl_NL, pl_PL, pt_BR, ru_RU, sv_SE, tr_TR, zh_HK, zh_TW */ locale: string; /** - * The maxResults parameter specifies the maximum number of items that should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults: number; /** - * Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user. + * Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user. */ myRating: string; /** - * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner: string; /** - * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken: string; /** - * The videoCategoryId parameter selects a video chart based on the category. If using this parameter, chart must also be set. + * The videoCategoryId parameter selects a video chart based on the category. If using this parameter, chart must also be set. */ videoCategoryId: string; }): HttpRequest>; - + /** * Like, dislike, or remove rating from a video. */ rate(object: { /** - * The id parameter specifies the YouTube video ID. + * The id parameter specifies the YouTube video ID. */ id: string; /** - * Specifies the rating to record. + * Specifies the rating to record. */ rating: string; /** - * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; - }): HttpRequest; - + }): HttpRequest; + /** * Updates a video's metadata. */ update(object: { /** - * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet, contentDetails, player, statistics, status, and topicDetails. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting. In addition, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet, contentDetails, player, statistics, status, and topicDetails. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting. In addition, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. */ part: string; /** - * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** @@ -690,15 +690,15 @@ declare module gapi.client.youtube { } interface GoogleApiYouTubePageInfo { - /** + /** * The type of the API response. For this operation, the value will be youtube#activityListResponse. */ kind: string; - /** + /** * The ETag of the response. */ etag: string; - /** + /** * A list of activities, or events, that match the request criteria. */ items: T[]; @@ -706,23 +706,23 @@ interface GoogleApiYouTubePageInfo { interface GoogleApiYouTubePaginationInfo { - /** + /** * The type of the API response. For this operation, the value will be youtube#activityListResponse. */ kind: string; - /** + /** * The ETag of the response. */ etag: string; - /** + /** * The pageInfo object encapsulates paging information for the result set. */ pageInfo: { - /** + /** * The total number of results in the result set. */ totalResults: number; - /** + /** * The number of results included in the API response. */ resultsPerPage: number; @@ -731,11 +731,11 @@ interface GoogleApiYouTubePaginationInfo { * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken: string; - /** + /** * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken: string; - /** + /** * A list of activities, or events, that match the request criteria. */ items: T[]; @@ -743,290 +743,290 @@ interface GoogleApiYouTubePaginationInfo { } interface GoogleApiYouTubeActivityResource { - /** + /** * The type of the API resource. For activity resources, the value will be youtube#activity. */ kind: string; - /** + /** * The ETag of the activity resource. */ etag: string; - /** + /** * The ID that YouTube uses to uniquely identify the activity. */ id: string; - /** + /** * The snippet object contains basic details about the activity, including the activitys type and group ID. */ snippet: { - /** + /** * The date and time that the activity occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt: string; - /** + /** * The ID that YouTube uses to uniquely identify the channel associated with the activity. */ channelId: string; - /** + /** * The title of the resource primarily associated with the activity. */ title: string; - /** + /** * The description of the resource primarily associated with the activity. */ description: string; - /** + /** * A map of thumbnail images associated with the resource that is primarily associated with the activity. */ thumbnails: GoogleApiYouTubeThumbnailItemResource[]; - /** + /** * Channel title for the channel responsible for this activity */ channelTitle: string; - /** + /** * The type of activity that the resource describes. */ type: string; - /** + /** * The group ID associated with the activity. */ groupId: string; } - /** + /** * The contentDetails object contains information about the content associated with the activity. */ contentDetails: { - /** + /** * The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload. */ upload: { - /** + /** * The ID that YouTube uses to uniquely identify the uploaded video. */ videoId: string; } - /** + /** * The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like. */ like: { - /** + /** * The resourceId object contains information that identifies the rated resource. */ resourceId: { - /** + /** * The type of the API resource. */ kind: string; - /** + /** * The ID that YouTube uses to uniquely identify the video, if the rated resource is a video. This property is only present if the resourceId.kind is youtube#video */ videoId: string; } } - /** + /** * The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite. */ favorite: { - /** + /** * The resourceId object contains information that identifies the resource that was marked as a favorite. */ resourceId: { - /** + /** * The type of the API resource. */ kind: string; - /** + /** * The ID that YouTube uses to uniquely identify the favorite video. This property is only present if the resourceId.kind is youtube#video. */ videoId: string; } } - /** + /** * The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment. */ comment: { - /** + /** * The resourceId object contains information that identifies the resource associated with the comment. */ resourceId: { - /** + /** * The type of the API resource. */ kind: string; - /** + /** * The ID that YouTube uses to uniquely identify the video associated with a comment. This property is only present if the resourceId.kind is youtube#video. */ videoId: string; - /** + /** * The ID that YouTube uses to uniquely identify the channel associated with a comment. This property is only present if the resourceId.kind is youtube#channel. */ channelId: string; } } - /** + /** * The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription. */ subscription: { - /** + /** * The resourceId object contains information that identifies the resource that the user subscribed to. */ resourceId: { - /** + /** * The type of the API resource. */ kind: string; - /** + /** * The ID that YouTube uses to uniquely identify the channel that the user subscribed to. This property is only present if the resourceId.kind is youtube#channel. */ channelId: string; } } - /** + /** * The playlistItem object contains information about an item that was added to a playlist. This property is only present if the snippet.type is playlistItem. */ playlistItem: { - /** + /** * The resourceId object contains information that identifies the resource that was added to the playlist. */ resourceId: { - /** + /** * The type of the API resource. */ kind: string; - /** + /** * The ID that YouTube uses to uniquely identify the video that was added to the playlist. This property is only present if the resourceId.kind is youtube#video. */ videoId: string; } - /** + /** * The value that YouTube uses to uniquely identify the playlist. */ playlistId: string; - /** + /** * The value that YouTube uses to uniquely identify the item in the playlist. */ playlistItemId: string; } - /** + /** * The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation. */ recommendation: { - /** + /** * The resourceId object contains information that identifies the recommended resource. */ resourceId: { - /** + /** * The type of the API resource. */ kind: string; - /** + /** * The ID that YouTube uses to uniquely identify the video, if the recommended resource is a video. This property is only present if the resourceId.kind is youtube#video. */ videoId: string; - /** + /** * The ID that YouTube uses to uniquely identify the channel, if the recommended resource is a channel. This property is only present if the resourceId.kind is youtube#channel. */ channelId: string; } - /** + /** * The reason that the resource is recommended to the user. */ reason: string; - /** + /** * The seedResourceId object contains information about the resource that caused the recommendation. */ seedResourceId: { - /** + /** * The type of the API resource. */ kind: string; - /** + /** * The ID that YouTube uses to uniquely identify the video, if the recommendation was caused by a particular video. This property is only present if the seedResourceId.kind is youtube#video. */ videoId: string; - /** + /** * The ID that YouTube uses to uniquely identify the channel, if the recommendation was caused by a particular channel. This property is only present if the seedResourceId.kind is youtube#channel. */ channelId: string; - /** + /** * The ID that YouTube uses to uniquely identify the playlist, if the recommendation was caused by a particular playlist. This property is only present if the seedResourceId.kind is youtube#playlist. */ playlistId: string; } } - /** + /** * The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin. */ bulletin: { - /** + /** * The resourceId object contains information that identifies the resource associated with a bulletin post. */ resourceId: { - /** + /** * The type of the API resource. */ kind: string; - /** + /** * The ID that YouTube uses to uniquely identify the video featured in a bulletin post, if the post refers to a video. This property will only be present if the value of the bulletin.resourceId.kind property is youtube#video. */ videoId: string; - /** + /** * The ID that YouTube uses to uniquely identify the channel featured in a bulletin post, if the post refers to a channel. This property will only be present if the value of the bulletin.resourceId.kind property is youtube#channel. */ channelId: string; - /** + /** * The ID that YouTube uses to uniquely identify the playlist featured in a bulletin post, if the post refers to a playlist. This property will only be present if the value of the bulletin.resourceId.kind property is youtube#playlist. */ playlistId: string; } } - /** + /** * The social object contains details about a social network post. This property is only present if the snippet.type is social. */ social: { - /** + /** * The name of the social network. */ type: string; - /** + /** * The resourceId object encapsulates information that identifies the resource associated with a social network post. */ resourceId: { - /** + /** * The type of the API resource. */ kind: string; - /** + /** * The ID that YouTube uses to uniquely identify the video featured in a social network post, if the post refers to a video. This property will only be present if the value of the social.resourceId.kind property is youtube#video. */ videoId: string; - /** + /** * The ID that YouTube uses to uniquely identify the channel featured in a social network post, if the post refers to a channel. This property will only be present if the value of the social.resourceId.kind property is youtube#channel. */ channelId: string; - /** + /** * The ID that YouTube uses to uniquely identify the playlist featured in a social network post, if the post refers to a playlist. This property will only be present if the value of the social.resourceId.kind property is youtube#playlist. */ playlistId: string; } - /** + /** * The author of the social network post. */ author: string; - /** + /** * The URL of the social network post. */ referenceUrl: string; - /** + /** * An image of the posts author. */ imageUrl: string; } - /** + /** * The channelItem object contains details about a resource that was added to a channel. This property is only present if the snippet.type is channelItem. */ channelItem: { - /** + /** * The resourceId object contains information that identifies the resource that was added to the channel. */ resourceId: { @@ -1040,421 +1040,421 @@ interface GoogleApiYouTubeChannelBannerResource { * The type of the API response. For this operation, the value will be youtube#channelBannerInsertResponse. */ kind: string; - /** + /** * The ETag of the response. */ etag: string; - /** + /** * The banner images URL. After calling the channelBanners.insert method, extract this value from the API response. Then call the channels.update method, and set the URL as the value of the brandingSettings.image.bannerExternalUrl property to set the banner image for a channel. */ url: string; } interface GoogleApiYouTubeChannelResource { - /** + /** * The ID that YouTube uses to uniquely identify the channel. */ id: string; - /** + /** * The type of the API resource. For channel resources, the value will be youtube#channel. */ kind: string; - /** + /** * The ETag for the channel resource. */ etag: string; - /** + /** * The snippet object contains basic details about the channel, such as its title, description, and thumbnail images. */ snippet: { - /** + /** * The channels title. */ title: string; - /** + /** * The channels description. */ description: string; - /** + /** * The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt: string; - /** + /** * A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails: GoogleApiYouTubeThumbnailItemResource[]; } - /** + /** * The contentDetails object encapsulates information about the channels content. */ - contentDetails: { - /** + contentDetails: { + /** * The relatedPlaylists object is a map that identifies playlists associated with the channel, such as the channels uploaded videos or favorite videos. You can retrieve any of these playlists using the playlists.list method. */ relatedPlaylists: { - /** + /** * The ID of the playlist that contains the channels liked videos. */ likes: string; - /** + /** * The ID of the playlist that contains the channels favorite videos. */ favorites: string; - /** + /** * The ID of the playlist that contains the channels uploaded videos. */ uploads: string; - /** - * The ID of the playlist that contains the channels watch history. + /** + * The ID of the playlist that contains the channels watch history. */ watchHistory: string; - /** + /** * The ID of the channels watch later playlist. */ watchLater: string; } - /** + /** * The googlePlusUserId object identifies the Google+ profile ID associated with this channel. */ googlePlusUserId: string; } - /** + /** * The statistics object encapsulates statistics for the channel. */ statistics: { - /** + /** * The number of times the channel has been viewed. */ viewCount: number; - /** + /** * The number of comments for the channel. */ commentCount: number; - /** + /** * The number of subscribers that the channel has. */ subscriberCount: number; - /** + /** * The number of videos uploaded to the channel. */ videoCount: number; } - /** + /** * The topicDetails object encapsulates information about Freebase topics associated with the channel. */ topicDetails: { - /** + /** * A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API. */ topicIds: string[]; } - /** + /** * The status object encapsulates information about the privacy status of the channel. */ status: { - /** + /** * Privacy status of the channel. */ privacyStatus: string; - /** + /** * Indicates whether the channel data identifies a user that is already linked to either a YouTube username or a Google+ account. A user that has one of these links already has a public YouTube identity, which is a prerequisite for several actions, such as uploading videos. */ isLinked: boolean; } - /** + /** * The brandingSettings object encapsulates information about the branding of the channel. */ brandingSettings: { - /** + /** * The channel object encapsulates branding properties of the channel page. */ channel: { - /** + /** * The channels title. The title has a maximum length of 30 characters. */ title: string; - /** + /** * The channel description, which appears in the channel information box on your channel page. */ description: string; - /** + /** * Keywords associated with your channel. The value is a comma-separated list of strings. */ keywords: string; - /** + /** * The content tab that users should display by default when viewers arrive at your channel page. */ defaultTab: string; - /** + /** * The ID for a Google Analytics account that you want to use to track and measure traffic to your channel. */ trackingAnalyticsAccountId: string; - /** + /** * This setting determines whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. The default value is false. */ moderateComments: boolean; - /** + /** * This setting indicates whether YouTube should show an algorithmically generated list of related channels on your channel page. */ showRelatedChannels: boolean; - /** + /** * This setting indicates whether the channel page should display content in a browse or feed view. */ showBrowseView: boolean; - /** + /** * The title that displays above the featured channels module. */ featuredChannelsTitle: string; - /** + /** * A list of up to 16 channels that you would like to link to from the featured channels module. The property value is a list of YouTube channel ID values, each of which uniquely identifies a channel. */ featuredChannelsUrls: string[]; - /** + /** * The video that should play in the featured video module in the channel pages browse view for unsubscribed viewers. Subscribed viewers may see a different view that highlights more recent channel activity. */ unsubscribedTrailer: string; } - /** + /** * The watch object encapsulates branding properties of the watch pages for the channels videos. */ watch: { - /** + /** * The background color for the video watch pages branded area. */ textColor: string; - /** + /** * The text color for the video watch pages branded area. */ backgroundColor: string; - /** + /** * An ID that uniquely identifies a playlist that displays next to the video player on the video watch page. */ featuredPlaylistId: string; } - /** + /** * The image object encapsulates information about images that display on the channels channel page or video watch pages. */ image: { - /** + /** * The URL for the banner image shown on the channel page on the YouTube website. The image is 1060px by 175px. */ bannerImageUrl: string; - /** + /** * The URL for the banner image shown on the channel page in mobile applications. The image is 640px by 175px. */ bannerMobileImageUrl: string; - /** + /** * The backgroundImageUrl object encapsulates settings for the background image shown on the video watch page. The image is 1200px by 615px, with a maximum file size of 128k. */ backgroundImageUrl: { - /** + /** * The default value for the property. */ default: string; - /** + /** * A list of objects that specify language-specific values for the property. */ localized: { - /** + /** * The property value for a specified language. */ value: string; - /** + /** * The language associated with the value. */ language: string; }[]; } - /** + /** * The largeBrandedBannerImageImapScript object encapsulates information about the image map script for the banner image shown on the channel page. */ largeBrandedBannerImageImapScript: { - /** + /** * The default value for the property. */ default: string; - /** + /** * A list of objects that specify language-specific values for the property. */ localized: { - /** + /** * The property value for a specified language. */ value: string; - /** + /** * The language associated with the value. */ language: string; }[]; } - /** + /** * The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page. */ largeBrandedBannerImageUrl: { - /** + /** * The default value for the property. */ default: string; - /** + /** * A list of objects that specify language-specific values for the property. */ localized: { - /** + /** * The property value for a specified language. */ value: string; - /** + /** * The language associated with the value. */ language: string; }[]; } - /** + /** * The image map script for the small banner image. The largeBrandedBannerImageImapScript object encapsulates information about the image map script for the banner image shown on the channel page in mobile applications. */ smallBrandedBannerImageImapScript: { - /** + /** * The default value for the property. */ default: string; - /** + /** * A list of objects that specify language-specific values for the property. */ localized: { - /** + /** * The property value for a specified language. */ value: string; - /** + /** * The language associated with the value. */ language: string; }[]; } - /** + /** * The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. */ smallBrandedBannerImageUrl: { - /** + /** * The default value for the property. */ default: string; - /** + /** * A list of objects that specify language-specific values for the property. */ localized: { - /** + /** * The property value for a specified language. */ value: string; - /** + /** * The language associated with the value. */ language: string; }[]; } - /** + /** * The URL for the image that appears above the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels. If you do not provide this image, your channel name will appear instead of an image. */ watchIconImageUrl: string; - /** + /** * The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages. */ trackingImageUrl: string; - /** + /** * The URL for a low-resolution banner image that displays on the channel page in tablet applications. The image is 1138px by 188px. */ bannerTabletLowImageUrl: string; - /** + /** * The URL for a banner image that displays on the channel page in tablet applications. The image is 1707px by 283px. */ bannerTabletImageUrl: string; - /** + /** * The URL for a high-resolution banner image that displays on the channel page in tablet applications. The image is 2276px by 377px. */ bannerTabletHdImageUrl: string; - /** + /** * The URL for an insanely high-resolution banner image that displays on the channel page in tablet applications. The image is 2560px by 424px. */ bannerTabletExtraHdImageUrl: string; - /** + /** * The URL for a low-resolution banner image that displays on the channel page in mobile applications. The image is 320px by 88px. */ bannerMobileLowImageUrl: string; - /** + /** * The URL for a medium-resolution banner image that displays on the channel page in mobile applications. The image is 960px by 263px. */ bannerMobileMediumImageUrl: string; - /** + /** * The URL for a high-resolution banner image that displays on the channel page in mobile applications. The image is 1280px by 360px. */ bannerMobileHdImageUrl: string; - /** + /** * The URL for a very high-resolution banner image that displays on the channel page in mobile applications. The image is 1440px by 395px. */ bannerMobileExtraHdImageUrl: string; - /** + /** * The URL for a banner image that displays on the channel page in television applications. The image is 2120px by 1192px. */ bannerTvImageUrl: string; - /** + /** * This property specifies the location of the banner image that YouTube will use to generate the various banner image sizes for a channel. To obtain the URL banner images external URL, you must first upload the channel banner image that you want to use by calling the channelBanners.insert method. */ bannerExternalUrl: string; } - /** + /** * The hints object encapsulates additional branding properties */ hints: { - /** + /** * A property. */ property: string; - /** + /** * The propertys value. */ value: string; }[]; } - /** + /** * The invideoPromotion object encapsulates information about a promotional campaign associated with the channel. A channel can use an in-video promotional campaign to display the thumbnail image of a promoted video in the video player during playback of the channels videos */ invideoPromotion: { - /** + /** * The timing object encapsulates information about the temporal position within the video when the promoted item will be displayed. */ timing: { - /** + /** * The timing method that determines when the promoted item is inserted during the video playback. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video. */ type: string; - /** + /** * The time offset, specified in milliseconds, that determines when the promoted item appears during video playbacks. The type propertys value determines whether the offset is measured from the start or end of the video. */ offsetMs: number; } - /** + /** * The position object encapsulates information about the spatial position within the video where the promoted item will be displayed. */ position: { - /** + /** * The manner in which the promoted item is positioned in the video player. */ type: string; - /** + /** * The corner of the player where the promoted item will appear. */ cornerPosition: string; } - /** + /** * The list of promoted items in the order that they will display across different playbacks to the same viewer. */ items: { - /** + /** * The promoted items type. */ type: string; - /** + /** * If the promoted item represents a video, then this value is present and identifies the YouTube ID that YouTube assigned to identify that video. This field is only present if the type propertys value is video. */ videoId: string; @@ -1463,27 +1463,27 @@ interface GoogleApiYouTubeChannelResource { } interface GoogleApiYouTubeGuideCategoryResource { - /** + /** * The ID that YouTube uses to uniquely identify the guide category. */ id: string; - /** + /** * The type of the API resource. For guideCategory resources, the value will be youtube#guideCategory. */ kind: string; - /** + /** * The ETag of the guideCategory resource. */ etag: string; - /** + /** * The snippet object contains basic details about the category, such as its title. */ snippet: { - /** + /** * The ID that YouTube uses to uniquely identify the channel publishing the guide category. */ channelId: string; - /** + /** * The categorys title. */ title: string; @@ -1491,94 +1491,94 @@ interface GoogleApiYouTubeGuideCategoryResource { } interface GoogleApiYouTubePlaylistItemResource { - /** + /** * The ID that YouTube uses to uniquely identify the playlist item. */ id: string; - /** + /** * The type of the API resource. For playlist item resources, the value will be youtube#playlistItem. */ kind: string; - /** + /** * The ETag for the playlist item resource. */ etag: string; - /** + /** * The snippet object contains basic details about the playlist item, such as its title and position in the playlist. */ snippet: { - /** + /** * The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt: string; - /** + /** * The ID that YouTube uses to uniquely identify the user that added the item to the playlist. */ channelId: string; - /** + /** * The items title. */ title: string; - /** + /** * The items description. */ description: string; - /** + /** * A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails: GoogleApiYouTubeThumbnailItemResource[]; - /** + /** * The channel title of the channel that the playlist item belongs to. */ channelTitle: string; - /** + /** * The ID that YouTube uses to uniquely identify the playlist that the playlist item is in. */ playlistId: string; - /** + /** * The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth. */ position: number; - /** + /** * The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item. */ resourceId: { - /** + /** * The kind, or type, of the referred resource. */ kind: string; - /** + /** * If the snippet.resourceId.kind propertys value is youtube#video, then this property will be present and its value will contain the ID that YouTube uses to uniquely identify the video in the playlist. */ videoId: string; } } - /** + /** * The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video. */ contentDetails: { - /** + /** * The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request. */ videoId: string; - /** + /** * The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0. */ startAt: string; - /** + /** * The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video. */ endAt: string; - /** + /** * A user-generated note for this item. */ note: string; } - /** + /** * The status object contains information about the playlist items privacy status. */ status: { - /** + /** * The playlist items privacy status. The channel that uploaded the video that the playlist item represents can set this value using either the videos.insert or videos.update method. */ privacyStatus: string; @@ -1586,74 +1586,74 @@ interface GoogleApiYouTubePlaylistItemResource { } interface GoogleApiYouTubePlaylistResource { - /** + /** * The ID that YouTube uses to uniquely identify the playlist. */ id: string; - /** + /** * The type of the API resource. For video resources, the value will be youtube#playlist. */ kind: string; - /** + /** * The ETag for the playlist resource. */ etag: string; - /** + /** * The snippet object contains basic details about the playlist, such as its title and description. */ snippet: { - /** + /** * The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt: string; - /** + /** * The ID that YouTube uses to uniquely identify the channel that published the playlist. */ channelId: string; - /** + /** * The playlists title. */ title: string; - /** + /** * The playlists description. */ description: string; - /** + /** * A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails: GoogleApiYouTubeThumbnailItemResource[]; - /** + /** * The channel title of the channel that the video belongs to. */ channelTitle: string; - /** + /** * Keyword tags associated with the playlist. */ tags: string[]; } - /** + /** * The status object contains status information for the playlist. */ status: { - /** + /** * The playlists privacy status. */ privacyStatus: string; } - /** + /** * The contentDetails object contains information about the playlist content, including the number of videos in the playlist. */ contentDetails: { - /** + /** * The number of videos in the playlist. */ itemCount: number; } - /** + /** * The player object contains information that you would use to play the playlist in an embedded player. */ player: { - /** + /** * An