Guriddo » Topic: Extension points / plugin API

Extension points / plugin API

Guriddo
Extension points / plugin API

This topic has 4 replies, 2 voices, and was last updated 15 years, 11 months ago by Craig Stuntz.

Creator

Topic
May 14, 2010 at 9:48 pm #76232

Craig Stuntz
Participant

I'm working on a jqGrid/bbq extension to integrate jqGrid paging with browser history. Works pretty well, but I don't like the design.

I wrote a jqGridWithHistory function that the user calls. This returns a grid with the history extension. So instead of calling:

$(“#foo”).jqGrid(opts);

You call:

$(“#foo”).jqGridWithHistory(opts);

Instead.

It would make more sense to me to make the history integration an option, e.g.:

$(“#foo”).jqGrid({ url: url, history: true, … });

But I can't find an extension point in the grid source code which would allow this.

Essentially, I need to fiddle with the options before the grid is loaded, so that I can modify page, rowNum, and the like, if need be, and hook gridComplete. $.jgrid.default won't work because it's overwritten by options.

What would be ideal for me is if I could (inside my plugin) do something like:

$.jgrid.extend(“beforeCreate”, function() {
Creator

Topic

Viewing 4 replies - 1 through 4 (of 4 total)

Author

Replies
May 15, 2010 at 1:52 pm #94246

tony
Keymaster

Hello,

I'm not sure if this will do the job for you but there is exactley such event called beforeRequest – which is raised exactley before the request.

http://www.trirand.com/jqgridwiki/doku.php?id=wiki:events

Also I think it is easy to do such things – if I understand right the problem:

var gridoptions = { url : “…”, rowNum : 10,…}

if(some condition) {

gridoptions.rowNum = 20;

}

$(“#mygrid”).jqGrid(gridoptions);

Best Regards

Tony

May 17, 2010 at 7:13 pm #94269

Craig Stuntz
Participant

Tony,

Thanks for responding, but that doesn't answer my question. I will try to clarify.

I know that there is a beforeRequest event, but to handle it I need to change options to include a handler for beforeRequest. So a user of my plugin could write:

$(“#grid”).jqGrid({ beforeRequest: function() { $.gridHistory(this) } });

…but that's an incredibly awkward way to use a “plugin”, especially if the user is already hooking beforeRequest for something else.

I would prefer that the user could just write:

$(“#grid”).jqGrid({ history: true });

What I'm asking for, essentially, is a global beforeRequest handler (well, better still would be an event which ran once when the grid was created, not before every request — but even a global beforeRequest is better than what I have now). One which always runs for all grids, not one specific grid. Like I said, it would go in the global $.jgrid rather than the grid-specific options object.

Does that make more sense?

Thanks,

-Craig

May 17, 2010 at 7:29 pm #94270

tony
Keymaster

Hello,

this is maybe what you looking for:

$.extend($.jgrid.defaults,{…});

before creating a grid

Regards

Tony

May 19, 2010 at 4:49 pm #94330

Craig Stuntz
Participant

tony said:

Hello,

this is maybe what you looking for:

$.extend($.jgrid.defaults,{…});

before creating a grid

Regards

Tony

That doesn't fix the problem. If the grid user binds beforeRequest, then my code doesn't run. Existing plugins (e.g., treegrid, subgrid) require modification of grid.base.js. to work. That's bad; the grid should not depend on its plugins. What if I could do:

$.jgrid.plugins.bind("beforeRequest.jqGrid", function() { myPluginCode(); });

(or other events). Then a plugin author could write a plugin which works without having to change grid.base.js for every plugin.
Author

Replies