CountlyHelpers

Methods

(static) addColumnSelector(dtable, config, tableName)

Description:

• Adds column selector to data table

Source:

• countly/countly.helpers.js, line 2144

Parameters:

(static) alert(msg, type, moreData)

Description:

• Display modal alert popup for quick short messages that require immediate user's attention, as error submitting form

Source:

• countly/countly.helpers.js, line 687

Example

CountlyHelpers.alert("Some error happened", "red");

Parameters:

(static) appIdsToNames(context) → {string}

Description:

• Convert array of app ids to comma separate string of app names

Source:

• countly/countly.helpers.js, line 2604

Example

//outputs Test1, Test2, Test3
CountlyHelpers.appIdsToNames(["586e3216326a8b0a07b8d87f", "586e339a326a8b0a07b8ecb9", "586e3343c32cb30a01558cc3"]);

Parameters:

Returns:

Type

string

(static) arrayUnique(array) → {Array}

Description:

• Function that clean duplicates from passed array.

Source:

• countly/countly.helpers.js, line 3715

Parameters:

Returns:

Type

Array

(static) changeDTableColVis(config, dtable, tableName, col, visible) → {boolean}

Description:

• function hides column in data table and stores config in local storage

Source:

• countly/countly.helpers.js, line 2392

Parameters:

Returns:

Type

boolean

(static) changeDialogHeight(dialog, animate)

Description:

• If contents of the popup change, you may want to resice the popup

Source:

• countly/countly.helpers.js, line 1414

Example

var dialog = $("#cly-popup").clone().removeAttr("id").addClass('campaign-create');
CountlyHelpers.revealDialog(dialog);
//when content changes
CountlyHelpers.changeDialogHeight(dialog, true)

Parameters:

(static) clip(fopt, nothingopt) → {function}

Description:

• Creates function to be used as mRender for datatables to clip long values

Source:

• countly/countly.helpers.js, line 2696

Parameters:

Returns:

Type

function

(static) closeRows(dTable)

Description:

• Close all opened datatables rows

Source:

• countly/countly.helpers.js, line 2581

Example

CountlyHelpers.closeRows(self.dtable);

Parameters:

(static) confirm(msg, type, callback, buttonTextopt, moreData, testId)

Description:

• Display modal popup that requires confirmation input from user

Source:

• countly/countly.helpers.js, line 743

Example

CountlyHelpers.confirm("Are you sure?", "red", function (result) {
   if (!result) {
       //user did not confirm, just exit
       return true;
   }
   //user confirmed, do what you need to do
});

Parameters:

(static) confirmWithCheckbox(msg, type, hasCheckbox, checkboxTitle, callback, buttonTextopt)

Description:

• Display modal popup that requires confirmation input from user and optional checkbox

Source:

• countly/countly.helpers.js, line 104

Example

CountlyHelpers.confirmWithCheckbox("Are you sure?", "red", true, "Chechbox label text", function (result) {
   if (!result) {
       //user did not confirm, just exit
       return true;
   }
   //user confirmed, do what you need to do
});

Parameters:

(static) createDrawer(options) → {object}

Description:

• Create drawer

Source:

• countly/countly.helpers.js, line 170

Example

var drawer = CountlyHelpers.createDrawer({
          id: "my-id",
          form: $('#id-of-elem'), //if using form
          title: 'My Drawer title',
          applyChangeTriggers: true, //add triggers
          onUpdate: function(){
             //check all fields here
           },
           resetForm: function() {
               //empty all fields. Text fields are emptied automatically because options.preventBaseReset is not set.
           },
           onClose: function(callback) {
               callback(true); //allow closing form
               callback(false); //don't close form
           },
           onClosed: function() {
               //form is closed
           }
       });
//After creation drawer object is returned. Object has multiple functions:
drawer.open() //opens drawer
drawer.close(force); //closes drawer. force - close anyway even if there is onClose function set. (Withot validating)
drawer.resetForm(); //resets drawer (Normally called after closing or before opening drawer)
   

Parameters:

Returns:

Type

object

(static) createMetricModel(countlyMetric, metric, $, fetchValueopt)

Description:

• Create Countly metric model to fetch metric data from server and provide it to views

Source:

• countly/countly.helpers.js, line 2730

Example

window.countlyDensity = {};
  countlyDensity.checkOS = function(os, density){
       var lastIndex = density.toUpperCase().lastIndexOf("DPI");
       if(os.toLowerCase() == "android" && lastIndex !== -1 && lastIndex === density.length - 3)
           return true;
       if(os.toLowerCase() == "ios" && density[0] == "@")
           return true;
       return false;
  };
  CountlyHelpers.createMetricModel(window.countlyDensity, {name: "density", estOverrideMetric: "densities"}, jQuery, function(val, data, separate){
       if(separate){
           //request separated/unprocessed data
           return val;
       }
       else{
           //we can preprocess data and group, for example, by first letter
           return val[0];
       }
  });

Parameters:

(static) expandRows(dTable, getData, context)

Description:

• In some cases you may want to allow expanding rows of your datatable. To do that you must add unique id to each row via datatables fnRowCallback property

Source:

• countly/countly.helpers.js, line 2507

Example

function formatData(data){
   // `data` is the original data object for the row
   //return string to display in subcell
   var str = '';
	if(data){
		str += '<div class="datatablesubrow">'+
       JSON.stringify(data)+
       '</div>';
   }
   return str;
}
this.dtable = $('.d-table').dataTable($.extend({}, $.fn.dataTable.defaults, {
     "aaData": crashData.data,
		"fnRowCallback": function( nRow, aData, iDisplayIndex, iDisplayIndexFull ) {
			$(nRow).attr("id", aData._id);
		},
     "aoColumns": [
			{ "mData": "ts"}, "sType":"format-ago", "sTitle": jQuery.i18n.map["crashes.crashed"]},
			{ "mData": "os", "sType":"string", "sTitle": jQuery.i18n.map["crashes.os_version"] },
			{ "mData": "device"}, "sType":"string", "sTitle": jQuery.i18n.map["crashes.device"]},
			{ "mData": "app_version", "sType":"string", "sTitle": jQuery.i18n.map["crashes.app_version"] }
     ]
 }));
 CountlyHelpers.expandRows(this.dtable, formatData);

Parameters:

(static) export(count, data, asDialog, exportByAPI, instance) → {object}

Description:

• Displays database export dialog

Source:

• countly/countly.helpers.js, line 977

Example

var dialog = CountlyHelpers.export(300000);
//later when done
CountlyHelpers.removeDialog(dialog);

Parameters:

Returns:

Type

object

(static) formatPercentage(value, decimalPlaces) → {number}

Description:

• Format number to percentage value

Source:

• countly/countly.helpers.js, line 3659

Parameters:

Returns:

Type

number

(static) generatePassword(length, no_special) → {string}

Description:

• Generate random password

Source:

• countly/countly.helpers.js, line 3536

Example

//outputs 4UBHvRBG1v
CountlyHelpers.generatePassword(10, true);

Parameters:

Returns:

Type

string

(static) getBacklink() → {object}

Source:

• countly/countly.helpers.js, line 423

Returns:

Type

object

(static) getPeriodUrlQueryParameter(period) → {string}

Description:

• Get currently selected period that can be used in ajax requests

Source:

• countly/countly.helpers.js, line 3644

Parameters:

Returns:

Type

string

(static) getRandomValue(charSet, length) → {string}

Description:

• Gets a random string from given character set string with given length

Source:

• countly/countly.helpers.js, line 3512

Parameters:

Returns:

Type

string

(static) goTo(options)

Source:

• countly/countly.helpers.js, line 401

Parameters:

(static) initBreadcrumbs(breadcrumbs, el)

Description:

• Function to add breadcrumbs

Source:

• countly/countly.helpers.js, line 3625

Parameters:

(static) initializeMultiSelect(element)

Description:

• Initialize countly dropdown multi select. In most cases it is done automatically, only in some cases, when content loaded via ajax request outside of view lifecycle, you may need to initialize it yourself for your content specifically

Source:

• countly/countly.helpers.js, line 1784

Example

CountlyHelpers.initializeMultiSelect($("#my-dynamic-div"));

Parameters:

(static) initializeSelect(element)

Description:

• Initialize countly dropdown select. In most cases it is done automatically, only in some cases, when content loaded via ajax request outside of view lifecycle, you may need to initialize it yourself for your content specifically

Source:

• countly/countly.helpers.js, line 1506

Example

CountlyHelpers.initializeSelect($("#my-dynamic-div"));

Parameters:

(static) initializeTableOptions(element)

Description:

• Initialize dropdown options list usually used on datatables. Firstly you need to add list with class 'cly-button-menu' to your template or add it in the view. Additionally you can add class dark to use dark theme. After that datatables last column for options should return a element with cly-list-options class and should have cell classes shrink and right and should not be sortable Then call this method in your view and you can start listening to events like: cly-list.click - when your cly-list-options element is clicked, passing click event as data cly-list.open - when list is opened, passing click event as data cly-list.close - when list is closed, passing click event as data cly-list.item - when item is clicked, passing click event as data

Source:

• countly/countly.helpers.js, line 2086

Examples

Adding list to HTML template

<div class="cly-button-menu dark cohorts-menu" tabindex="1">
    <a class="item delete-cohort" data-localize='common.delete'></a>
    <a class="item view-cohort" data-localize='cohorts.view-users'></a>
</div>

Creating last column in datatables

{ "mData": function(row, type){
    return '<a class="cly-list-options"></a>';
}, "sType":"string", "sTitle": "", "sClass":"shrink center", bSortable: false  }

Listening to events

$(".cly-button-menu").on("cly-list.click", function(event, data){
    var id = $(data.target).parents("tr").data("id");
});

Parameters:

(static) initializeTextSelect(element)

Description:

• Initialize countly text select. In most cases it is done automatically, only in some cases, when content loaded via ajax request outside of view lifecycle, you may need to initialize it yourself for your content specifically

Source:

• countly/countly.helpers.js, line 3421

Example

CountlyHelpers.initializeTextSelect($("#my-dynamic-div"));

Parameters:

(static) isJSON(val) → {boolean}

Description:

• Check the value which passing as parameter isJSON or not return result as boolean

Source:

• countly/countly.helpers.js, line 870

Example

CountlyHelpers.isJSON(variable);

Parameters:

Returns:

Type

boolean

(static) isPluginEnabled(name) → {boolean}

Description:

• This function checks if a Countly plugin is enabled.

Source:

• countly/countly.helpers.js, line 19

Parameters:

Returns:

Type

boolean

(static) loadCSS(css, callbackopt)

Description:

• Load CSS file

Source:

• countly/countly.helpers.js, line 2656

Example

CountlyHelpers.loadCSS("/myplugin/stylesheets/custom.css");

Parameters:

(static) loadJS(js, callbackopt)

Description:

• Load JS file

Source:

• countly/countly.helpers.js, line 2633

Example

CountlyHelpers.loadJS("/myplugin/javascripts/custom.js");

Parameters:

(static) loading(msg) → {object}

Description:

• Displays loading icong and returns reference to dialog so you could close it once loading is done

Source:

• countly/countly.helpers.js, line 799

Example

var dialog = CountlyHelpers.loading("we are doing something");
//later when done
CountlyHelpers.removeDialog(dialog);

Parameters:

Returns:

Type

object

(static) model()

Description:

• Create new model

Source:

• countly/countly.helpers.js, line 440

(static) newJSONEditor(json, typeopt, callbackopt)

Description:

• Create new model

Source:

• countly/countly.helpers.js, line 530

Parameters:

(static) notify(msg)

Description:

• Display dashboard notification using Amaran JS library

Source:

• countly/countly.helpers.js, line 334

Deprecated:

• Yes

Example

CountlyHelpers.notify({
   message: "Main message text",
});

Parameters:

(static) objectWithoutProperties(obj, excluded) → {Object}

Description:

• Function that creates a shallow copy of an object excluding specified fields. Warning: If no excluded fields specified, returns the original reference

Source:

• countly/countly.helpers.js, line 3748

Parameters:

Returns:

Type

Object

(static) openResource(url)

Description:

• Display modal popup with external resource from provided URL in iframe. Make sure to use https version of resource for it to work on both http and https dashboard

Source:

• countly/countly.helpers.js, line 669

Example

CountlyHelpers.openResource("http://resources.count.ly/docs");

Parameters:

(static) parseAndShowMsg(msg) → {boolean}

Description:

• Legacy method for displaying notifications. User CountlyHelpers.notify instead

Source:

• countly/countly.helpers.js, line 62

Parameters:

Returns:

Type

boolean

(static) popup(element, custClassopt, isHTMLopt)

Description:

• Display modal popup UI

Source:

• countly/countly.helpers.js, line 646

Example

CountlyHelpers.popup("<h1>Hello</h1>", "red", true);

Parameters:

(static) refreshTable(dTable, newDataArr)

Description:

• Refresh existing datatable instance on view refresh, providing new data

Source:

• countly/countly.helpers.js, line 2457

Example

CountlyHelpers.refreshTable(self.dtable, data);

Parameters:

(static) removeDialog(dialog)

Description:

• Remove existing dialog

Source:

• countly/countly.helpers.js, line 1455

Example

var dialog = $("#cly-popup").clone().removeAttr("id").addClass('campaign-create');
CountlyHelpers.revealDialog(dialog);
//when dialog not needed anymore
CountlyHelpers.removeDialog(dialog);

Parameters:

(static) removeEmptyValues(array) → {array}

Description:

• Function that remove empty values from array.

Source:

• countly/countly.helpers.js, line 3732

Parameters:

Returns:

Type

array

(static) removePersistentNotification(notificationId)

Description:

• Removes a notification from persistent notification list based on id.

Source:

• countly/countly.helpers.js, line 391

Parameters:

(static) reopenRows(dTable, getData, context)

Description:

• If you allow to open/expand rows, then when refreshing table they will close again. To avoid that you must call this function on each refresh after calling CountlyHelpers.refreshTable

Source:

• countly/countly.helpers.js, line 2561

Example

CountlyHelpers.refreshTable(self.dtable, data);
CountlyHelpers.reopenRows(self.dtable, formatData);

Parameters:

(static) revealDialog(dialog)

Description:

• Instead of creating dialog object you can use this method and directly pass jquery element to be used as dialog content, which means complete customization

Source:

• countly/countly.helpers.js, line 1387

Example

var dialog = $("#cly-popup").clone().removeAttr("id").addClass('campaign-create');
CountlyHelpers.revealDialog(dialog);

Parameters:

(static) sha1(str) → {string}

Description:

• function sha1

Source:

• countly/countly.helpers.js, line 3764

Parameters:

Returns:

Type

string

(static) showBlockerDialog(msg, moreData)

Description:

• Display modal popup that blocks the screen and cannot be closed

Source:

• countly/countly.helpers.js, line 816

Example

CountlyHelpers.showBlockerDialog("Some message");

Parameters:

(static) showQuickstartPopover(content)

Description:

• Display modal popup that shows quickstart guide

Source:

• countly/countly.helpers.js, line 842

Example

CountlyHelpers.showQuickstartDialog();

Parameters:

(static) shuffleString(text) → {string}

Description:

• Shuffle string using crypto.getRandomValues

Source:

• countly/countly.helpers.js, line 3494

Parameters:

Returns:

Type

string

(static) tableExport(dtable, data, asDialog, oSettings) → {object}

Description:

• Displays raw data table export dialog

Source:

• countly/countly.helpers.js, line 1255

Example

var dialog = CountlyHelpers.export(300000);
//later when done
CountlyHelpers.removeDialog(dialog);

Parameters:

Returns:

Type

object

(static) upload(el, url, data, callback)

Description:

• Upload file by the passed optional parameters

Source:

• countly/countly.helpers.js, line 3608

Parameters:

(static) validateEmail(email) → {boolean}

Description:

• Validate email address

Source:

• countly/countly.helpers.js, line 3575

Example

//outputs true
CountlyHelpers.validateEmail("test@test.test");

//outputs false
CountlyHelpers.validateEmail("test@test");

Parameters:

Returns:

Type

boolean

(static) validatePassword(password) → {boolean}

Description:

• Validate password based on settings provided via security configuration

Source:

• countly/countly.helpers.js, line 3585

Parameters:

Returns:

Type

boolean