Helper functions

TV variable for table view:
AppGiniHelper.TV

Version 2020/10

Due to some side-effects when customers initialized AppGiniTableView several times (for example in header-extras.php and in TABLENAME-tv.js) we have changed initialization and recommend using the following syntax from Version 2020/10 on:

jQuery(document).ready(function() {
  var tv = AppGiniHelper.TV;
  // your code here
});

You can use AppGiniHelper.TV multiple times even in different files because this is a singleton now. The old syntax var tv = new AppGiniTableView(); will still be available. There may be a warning in console output in future releases. We strongly recommend using the new syntax.

DV variable for detail view:
AppGiniHelper.DV

Version 2020/10

Due to some side-effects when customers initialized AppGiniDetailView several times (for example in header-extras.php and in TABLENAME-dv.js) we have changed initialization and recommend using the following syntax from Version 2020/10 on:

var dv = AppGiniHelper.DV;
// your code here

You can use AppGiniHelper.DV multiple times even in different files because this is a singleton now. The old syntax var dv = new AppGiniDetailView(); will still be available. There may be a warning in console output in future releases. We strongly recommend using the new syntax.

LV variable for login view:
AppGiniHelper.LV

Version 2021/07

var lv = AppGiniHelper.LV;
// your code here

URL-Helper:
AppGiniUrl

Version 2020/10

Helper function for building URLs.

var url = AppGiniUrl.get("tablename");
// url == 'tablename_view.php'

var url = AppGiniUrl.get("tablename", 123);
// url == 'tablename_view.php?SelectedID=123'

Tip: Those function are useful for example in combination with addButton or addLink function in table view or for Action Buttons in DetailView.

Parameter-Helper:
AppGiniParameter

Version 2020/10

Helper function for getting parameters in address (URL):

let arg = AppGiniParameter.get("test");
if (arg) {
    alert("Parameter:\r\ntest = " + arg);
}

Current user:
AppGiniHelper.getMemberID(fx)

Version 2020/10

// file: hooks/TABLENAME-dv.JS
AppGiniHelper.getMemberID(function(memberID) {
  alert("Hello " +  memberID );
});

See also: Pro-Tip at the bottom if this page here for fading out custom tabs depending on current user.

Various Helpers

Detect homepage: .isHomePage()

Version 2021/07

AppGiniHelper.isHomePage()

Detect login page: .isLoginPage()

Documentation has moved here

AppGiniHelper.isLoginPage()

Get unique Id as string

Version 2021/07

Sometimes you may need to generate a unique id, for example for dynamically creating <div>'s having a unique id="..." attribute.

AppGiniHelper.getUniqueId("PREFIX", "-")

Example

AppGiniHelper.getUniqueId("PREFIX", "-")
"PREFIX-1911E41A-4427-675C-8E10-013A27C39162"