jQuery UI Widgets Forums Grid API Documentation Update

This topic contains 4 replies, has 2 voices, and was last updated by  fritzfrancis 8 years, 1 month ago.

Viewing 5 posts - 1 through 5 (of 5 total)
  • Author
  • API Documentation Update #61127

    fritzfrancis
    Participant

    Hello jqxWidgets Development Team,

    I for one know how hard it is to keep documentation in sync with the code. But at some point we have to bite the bullet. I am finding that the API documentation is not complete. A few days ago, I looked at the API documentation for the jqxGrid component for a hover event. When I didn’t see one, I assumed that the grid did not support this functionality and I told my stakeholders such. Today, under more pressure from them for that functionality, I did a search in the forum and voila, you do have a cellhover property for the jqxGrid. Any chance you can include that in the API docs? I have other examples of out-of-sync docs, but I will send those separately.

    Regards,

    Fritz

    API Documentation Update #61132

    Dimitar
    Participant

    Hello Fritz,

    Thank you for your feedback. Please note that though we provided some workarounds with cellhover regarding jqxTooltip integration, it is an internal property and was not meant for public use. That is why it is not documented. We will consider your request, however, for adding it to the documentation in the future.

    Best Regards,
    Dimitar

    jQWidgets team
    http://www.jqwidgets.com/

    API Documentation Update #61205

    fritzfrancis
    Participant

    Dimitar,

    Thank for your prompt response. The cellhover event, getcellatposition method, and cell object are all very handy. Here’s the example I’m referring to regarding those three items in bold:

    $(“#jqxGrid15”).jqxGrid
    (
    {
    cellhover: function (element, X, Y)
    {
    var cell = $(“#jqxGrid15”).jqxGrid(“getcellatposition“, X, Y);
    alert(cell.column);
    }
    }
    );

    Until such time that the API documentation is updated, would you please give me whatever documentation you have on hand having to do with the items in bold? Most specifically, I would love to know all of the properties/methods/etc. associated with the cell object.

    Regards,

    Fritz

    API Documentation Update #61209

    Dimitar
    Participant

    Hi Fritz,

    cellhover is a callback function called when an unselected grid cell is hovered. The getcellatposition method and the object it returns are already documented and you can read more about them in jqxGrid’s API Documentation.

    Best Regards,
    Dimitar

    jQWidgets team
    http://www.jqwidgets.com/

    API Documentation Update #61260

    fritzfrancis
    Participant

    Dimitar,

    Thanks for pointing me to the appropriate documentation. This functionality, especially the cellhover function, have proven to be extremely useful for our website already. I do hope that you and your team decide to move cellhover from just an internally used function to a publicly supported one, whenever the time to decide arrives.

    Regards,

    Fritz

Viewing 5 posts - 1 through 5 (of 5 total)

You must be logged in to reply to this topic.