User Option : Default Display Grid Density?

Fri, 04 Feb 2022 13:30:07 +0000

Dear all,

Since Efficy 11.3 Release Build r18130, a new functionnality "grid density" appears.
The setting can be found in User Option : comfortable, intermediate, compact.

It seems in the documentation, that we can set the default User Option from SYS_SETTINGS : "gridDisplayDensity" (cf EDN : https://help.efficy.io/edn/dev/cust_definegridcolumns)

I try to find in SYS_SETTINGS the "gridDisplayDensity" option, but I cannot find it.
Should we add it manually, if so where in sys_settings should we do that ?

Best Regards

Implementing a UserOption feature through sys_storage and serverside scripts

Tue, 21 Jan 2020 15:46:34 +0000

Hi guys,

I recently needed to implement a session persistent user options feature in Efficy
since sys_storage is the recommended way to do so I ve made a module that will allow you to set and get user options from a serverjs module.

this is how to implement / use it :

/*
@import SUO from serverjs/storageUserOptions
*/

SUO.init({id: 123});      // optional: only if you  want to use options of another User (default is Efficy.currentUserId)

// for now there is no sys_storage named userOption_123 (yet)

var temp = SUO.get()    
// expected temp = "";

SUO.set("myOption", 12);
// there is now a sys_storage named userOption_123 whose value is : "{\"myOption\": 12}"    //---(string)

temp = SUO.get();
// expected temp = {"myOption: 12"}   //---(object)  

temp = SUO.get("myOption");
// expected temp = 12       //---(number)

SUO.set("myOption2", {
    mySubOption1: true,
    mySubOption2: "subOptionValue2",
    mySubOption3: {
        id: 1
    }
});
// there is now a sys_storage named userOption_123 whose value is : (string)
// {
//     "myOption": 12,
//     "myOption2": {
//         "mySubOption1": true,
//         "mySubOption2": "subOptionValue2",
//         "mySubOption3": {
//             "id": 1
//         }
//     }
// }

this is the code of the serverjs/storageUserOptions module :

/*
@import $ from serverjs/jUtils
*/
return (function(){
    var options = {
        id: Efficy.currentUserId
    };

    function test(_options){
        return "test"
    }

    function init(_options){
        if (typeof _options === "object"){
            $.forEach($.keys(_options), function(_key){
                if (options.hasOwnProperty(_key)) options[_key] = _options[_key];
            });
        }

        return options;
    }

    function get(_optionName){
        var result;
        var data = _getStorageUserOptions();

        if (typeof _optionName === "string") result = data[_optionName];
        else result = data;

        return result;
    }

    function set(_optionName, _optionValue){
        if(typeof _optionName !== "string") throw new Error("storageUserOptions.set() invalid arguments");

        var data = {};
        data[_optionName] = _optionValue;

        _setStorageUserOptions(data);

        return;
    }

    function _setStorageUserOptions(_options){

        var result = _getStorageUserOptions();
        result = $.merge(result, _options);

        Efficy.setSysStorageValue("userOption_" + options.id, JSON.stringify(result, null, "\t"));

        return result;
    }

    function _getStorageUserOptions(){
        var result = Efficy.getSysStorageValue("userOption_" + options.id) || "{}";

        try{
            result = JSON.parse(result);
        } catch(e){
            throw new Error(["",
                "_getStorageUserOption parse error", 
                "id: " + options.id,
                "value: " + result,
                "message: " + e.message
            ].join("<br/>"));
        }

        return result;
    }

    var public = {
        test: test,
        init: init,
        set: set,
        get: get

    };

    return public;
})();

and the serverjs/jUtils module that allow me to add some intresting polyfill (like object.keys, merge, ...)

return (function(){

    function forEach(_array, _iterator){
        var result;

        for (var i=0; i<_array.length; i++){
            result = _iterator.call(this, _array[i], i);
            if (result === false) break;
        }

        return result;
    }

    function each(_array, _iterator){
        var result;

        for (var i=0; i<_array.length; i++){
            result = _iterator.call(this, i, _array[i]);
            if (result === false) break;
        }
    }

    function merge(){
        var result = {};

        each(arguments, function(_index, _value){
            for(key in _value){
                if (!result[key]){
                    result[key] = _value[key];
                } else if (typeof result[key] === "object" && typeof result[key].length === "undefined") {
                    result[key] = merge(result[key], _value[key]);
                } else {
                    result[key] = _value[key];
                }
            }
        });

        return result;  
    }

    function getItem(_array, _searchFunction, _startIndex){
        _startIndex = _startIndex || 0;

        var result = undefined;

        forEach(_array, function(_value, _index){
            if (_searchFunction(_value, _index)){
                result = _value;
                return false;
            }
        });

        return result;
    }

    function format() {
        var args = arguments;
        var result = args[0].replace(/\$\d+/g, function (cap) {
            return args[1 + parseInt(cap.match(/\d+/), 10)];
        });
    }

    function indexOfObject(_array, _searchFunction){

        for (var i=0; i<_array.length; i++){
            if (_searchFunction(_array[i])) {
                return i;
            }
        }

        return -1;
    }

    function getFunctionName(_function){
        var result = _function.toString();
        result = result.substr('function '.length);
        result = result.substr(0, result.indexOf('('));
        return result;
    }

    var keys = (function() {
        'use strict';
        var hasOwnProperty = Object.prototype.hasOwnProperty,
          hasDontEnumBug = !({ toString: null }).propertyIsEnumerable('toString'),
          dontEnums = [
            'toString',
            'toLocaleString',
            'valueOf',
            'hasOwnProperty',
            'isPrototypeOf',
            'propertyIsEnumerable',
            'constructor'
          ],
          dontEnumsLength = dontEnums.length;

        return function(obj) {
          if (typeof obj !== 'function' && (typeof obj !== 'object' || obj === null)) {
            throw new TypeError('Object.keys called on non-object');
          }

          var result = [], prop, i;

          for (prop in obj) {
            if (hasOwnProperty.call(obj, prop)) {
              result.push(prop);
            }
          }

          if (hasDontEnumBug) {
            for (i = 0; i < dontEnumsLength; i++) {
              if (hasOwnProperty.call(obj, dontEnums[i])) {
                result.push(dontEnums[i]);
              }
            }
          }
          return result;
        };
      }());

    var public = {
        merge: merge,
        forEach: forEach,
        each: each,
        getItem: getItem,
        format: format,
        indexOfObject: indexOfObject,
        getFunctionName: getFunctionName,
        keys: keys
    };

    return public;
})();

Efficy Overflow Q&A - Recent questions tagged useroptions

User Option : Default Display Grid Density?

Implementing a UserOption feature through sys_storage and serverside scripts