Welcome to the Protogrid Developer Wiki. A place to gather all the documentation and tips&tricks regarding Protogrid.

ScriptLibrary

Protogrid can be extended arbitrarily using Java script libraries. The libraries are located at the “Code”-Tab in the Design-Tab. We differentiate two types of script libraries: server-side and client-side. The can be several libraries per type. On creation of the libraries, they already contain some code and some explanations to fast understand what to do.

Server-ScriptLibrary

Server-ScriptLibraries contain code happening at the server before sending the data to the client. Every Proto can have a server side library attached. Whenever something is done with a Card of this Proto on the server, the Server takes the assigned library into account. The server side libraries contain mainly the following functions: on_render, on_save, get_shortname, get_title.

on_render

on_render gets called when opening a new Card. This function can be used for example to hide fields of the Card. Inside the on_render function, one has access to the card which is opening as well as to a predicate called “before_first_save” telling you whether the Card was already saved before or not (if not, it is a newly created Card).

function on_render(card, before_first_save) {
    ...
}

on_save

The on_save function can for example be used to do some computations or assertions before saving. The function has access to the card, the predicate “before_first_save” and an object called “ref_validation_errors” containing all previous validation errors thrown by Protogrid. For each field containing an error, the object contains a field key pointing to an Error String that is shown to the user. By adding new properties to this object, you can add validation Errors of your own. If this object is not empty when on_save returns, the Card will not be saved.

function on_save(card, before_first_save, ref_validation_errors) {
    ...
}

get_shortname

This function is supposed to return a string that defines a Card's Shortname. Shortnames are used in relation fields and TableView columns. They should somehow identify the individual Cards. Short names must not contain confidential information (information that only a subset of users in your app may access).

function get_shortname(card) {
    ...
    return ...
}

get_title

This function should return a string that defines a Card's title. Titles are being used exclusively in the Card's title row when it is opened. By default, the Card's title is defined by its shortname if you don't override it using this function. You have access to the card and the predicate “before_first_save”.

function get_title(card, before_first_save) {
    ...
    return ...
}

Client-ScriptLibrary

The client-side script library contains all the code happening locally on the clients machine. This contains all the code executed when triggered by a client action, especially the code that should be executed at button clicks.

Execute JS on card load

To execute some JavaScript code at the time, a card is loaded, there are two options.

If you want to execute this code only for one proto, you add the code inside a Client-ScriptLibrary and make sure you have a Trigger on the Proto which is linked with this ScriptLibrary. This will make the browser to load all code when the cards are loaded and the browser will execute all code on loading of the ScriptLibrary, which is not enclosed in a function. So just add in the ScriptLibrary:

on_load();
function on_load() {
    //do something useful
}

If you want the code to be executed on load of every card, write your code into a separate JavaScript file and load it into the attachments section on the “Code”-Card. This attachments will be loaded whenever any Card is loaded and therefore will be executed on any card load.

Execute JS on field change

To execute some JavaScript when a field value changes, you need to add the following code-snippet to a client-side Script library, which is linked to the Proto with some Trigger. The variable “field_key_my_field” has to be set to the fieldkey of the field you want to observe. “my_function()” is the function you want to call when something changes.

function my_function(){
    //do something here
}
 
function document_ready_trigger() {    
    $("#" + field_key_my_field).on('change', function () {
        my_function();
    });
}
 
$(document).ready(function () {
    document_ready_trigger();
});

The function document_ready_trigger tells your card that you want something to happen when a value changes. The call “$(document).ready(…)” itself calls the function “document_ready_trigger” as soon as the card is fully loaded.

Print/export