Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ionatan Wiznia committed Dec 12, 2011
1 parent d09a9bd commit 7ea64bb
Showing 1 changed file with 2 additions and 33 deletions.
35 changes: 2 additions & 33 deletions README.textile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,6 @@ h2. About

p. Exporter is a generic export class which takes any Ext.data.Store-based component (e.g. grids and similar) and exports the data in any format.

p. Exporter works completely client-side. It uses a Formatter class to generate a document (.xls, .csv etc) and then redirects the user's browser to a data url so that they can view or download it.
p. Exporter works completely client-side. It uses a Formatter class to generate a document (.xls, .csv etc) and then uses the donwloadify library so that the user can view or download it.

h2. Installation

p. Download the latest version in any of the following ways:

* git clone git://github.com/edspencer/Ext.ux.Exporter.git
* Download from http://github.com/edspencer/Ext.ux.Exporter/zipball/master
* Copy/paste Exporter-all.js from http://github.com/edspencer/Ext.ux.Exporter/blob/master/Exporter-all.js

p. To install Ext.ux.Exporter, just include Exporter-all.js somewhere on your page:

bc. <script type="text/javascript" src="Exporter-all.js"></script>

h2. Usage

p. The most common use case for the Exporter is exporting a grid to Excel, which is as simple as doing the following:

bc.. var grid = new Ext.grid.GridPanel({
store: someStore,
tbar : [
{
xtype: 'exportbutton',
store: someStore
}
],
//your normal grid config goes here
});

p. The provided 'exportbutton' is just a specialised Ext.Button subclass which redirects the user to the generated data url. If you want to provide your own implementation here, just check out the Button.js code (it's ridiculously simple).

h2. Example

Download or clone the code (see Installation section for details) and then drag the example/index.html file into any browser to see an example of the Exporter at work.
p. Right now, there isn't a readme or example. You can check this post for more info for now: http://www.sencha.com/forum/showthread.php?136598-Export-store-to-Excel

9 comments on commit 7ea64bb

@milesmatthias
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you break everything out to different files? Part of what is so nice about edspencer's plugin is that it's one file to include. I'm having a very hard time installing your plugin because of all of its dependencies.

Sorry for the weird place to comment, but you don't have any issues for this repo and you didn't give github an e-mail address so people can message you.

@iwiznia
Copy link
Owner

@iwiznia iwiznia commented on 7ea64bb Feb 2, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! It's divided for better organization, just like the Ext framework files. It uses the ext loader to load all the files or to compile a minimized version of the app.
I just enabled the issues on the repo.

@milesmatthias
Copy link

@milesmatthias milesmatthias commented on 7ea64bb Feb 2, 2012 via email

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iwiznia
Copy link
Owner

@iwiznia iwiznia commented on 7ea64bb Feb 2, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now I don't have the time to do it right now, but if you read the post in the sencha forums, you should have all the info you need.
Also if you make an example, make a pull request with it and I'll include it.
The basics are: configure the ext loader, include the css and js of downloadify, configure the button's properties.

@NeilMcGrane
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I use this for a commercial project? Are there any licence terms?

@iwiznia
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I based the plugin on another one, so I don't know about that. You can use my code everywhere.

@lisaWriteJava
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to export and entire store. I have a store with 9000 rows that pages by 100, and only the first 100 rows from the store is exported. I need the store to export the whole list of rows (9000). Is this possible. I tried doing it as a grid export also but no luck.

@iwiznia
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to load the store with all the rows if you want to export them. The plugin only exports what's loaded.

@lisaWriteJava
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

Please sign in to comment.