421 lines
16 KiB
JavaScript
421 lines
16 KiB
JavaScript
/*!
|
|
* Piwik - Web Analytics
|
|
*
|
|
* @link http://piwik.org
|
|
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
|
*/
|
|
|
|
function widgetsHelper() {
|
|
}
|
|
|
|
/**
|
|
* Returns the available widgets fetched via AJAX (if not already done)
|
|
*
|
|
* @return {object} object containing available widgets
|
|
*/
|
|
widgetsHelper.getAvailableWidgets = function () {
|
|
if (!widgetsHelper.availableWidgets) {
|
|
var ajaxRequest = new ajaxHelper();
|
|
ajaxRequest.addParams({
|
|
module: 'Dashboard',
|
|
action: 'getAvailableWidgets'
|
|
}, 'get');
|
|
ajaxRequest.setCallback(
|
|
function (data) {
|
|
widgetsHelper.availableWidgets = data;
|
|
}
|
|
);
|
|
ajaxRequest.send(true);
|
|
}
|
|
|
|
return widgetsHelper.availableWidgets;
|
|
};
|
|
|
|
/**
|
|
* Returns the complete widget object by its unique id
|
|
*
|
|
* @param {string} uniqueId
|
|
* @return {object} widget object
|
|
*/
|
|
widgetsHelper.getWidgetObjectFromUniqueId = function (uniqueId) {
|
|
var widgets = widgetsHelper.getAvailableWidgets();
|
|
for (var widgetCategory in widgets) {
|
|
var widgetInCategory = widgets[widgetCategory];
|
|
for (var i in widgetInCategory) {
|
|
if (widgetInCategory[i]["uniqueId"] == uniqueId) {
|
|
return widgetInCategory[i];
|
|
}
|
|
}
|
|
}
|
|
return false;
|
|
};
|
|
|
|
/**
|
|
* Returns the name of a widget by its unique id
|
|
*
|
|
* @param {string} uniqueId unique id of the widget
|
|
* @return {string}
|
|
*/
|
|
widgetsHelper.getWidgetNameFromUniqueId = function (uniqueId) {
|
|
var widget = this.getWidgetObjectFromUniqueId(uniqueId);
|
|
if (widget == false) {
|
|
return false;
|
|
}
|
|
return widget["name"];
|
|
};
|
|
|
|
/**
|
|
* Sends and ajax request to query for the widgets html
|
|
*
|
|
* @param {string} widgetUniqueId unique id of the widget
|
|
* @param {object} widgetParameters parameters to be used for loading the widget
|
|
* @param {function} onWidgetLoadedCallback callback to be executed after widget is loaded
|
|
* @return {object}
|
|
*/
|
|
widgetsHelper.loadWidgetAjax = function (widgetUniqueId, widgetParameters, onWidgetLoadedCallback) {
|
|
var disableLink = broadcast.getValueFromUrl('disableLink');
|
|
if (disableLink.length) {
|
|
widgetParameters['disableLink'] = disableLink;
|
|
}
|
|
|
|
widgetParameters['widget'] = 1;
|
|
|
|
var ajaxRequest = new ajaxHelper();
|
|
ajaxRequest.addParams(widgetParameters, 'get');
|
|
ajaxRequest.setCallback(onWidgetLoadedCallback);
|
|
ajaxRequest.setFormat('html');
|
|
ajaxRequest.send(false);
|
|
return ajaxRequest;
|
|
};
|
|
|
|
(function ($, require) {
|
|
var exports = require('piwik/UI/Dashboard');
|
|
|
|
/**
|
|
* Singleton instance that creates widget elements. Normally not needed even
|
|
* when embedding/re-using dashboard widgets, but it can be useful when creating
|
|
* elements with the same look and feel as dashboard widgets, but different
|
|
* behavior (such as the widget preview in the dashboard manager control).
|
|
*
|
|
* @constructor
|
|
*/
|
|
var WidgetFactory = function () {
|
|
// empty
|
|
};
|
|
|
|
/**
|
|
* Creates an HTML element for displaying a widget.
|
|
*
|
|
* @param {string} uniqueId unique id of the widget
|
|
* @param {string} widgetName name of the widget
|
|
* @return {Element} the empty widget
|
|
*/
|
|
WidgetFactory.prototype.make = function (uniqueId, widgetName) {
|
|
var $result = this.getWidgetTemplate().clone();
|
|
$result.attr('id', uniqueId).find('.widgetName').append(widgetName);
|
|
return $result;
|
|
};
|
|
|
|
/**
|
|
* Returns the base widget template element. The template is stored in the
|
|
* element with id == 'widgetTemplate'.
|
|
*
|
|
* @return {Element} the widget template
|
|
*/
|
|
WidgetFactory.prototype.getWidgetTemplate = function () {
|
|
if (!this.widgetTemplate) {
|
|
this.widgetTemplate = $('#widgetTemplate').find('>.widget').detach();
|
|
}
|
|
return this.widgetTemplate;
|
|
};
|
|
|
|
exports.WidgetFactory = new WidgetFactory();
|
|
})(jQuery, require);
|
|
|
|
/**
|
|
* widgetPreview jQuery Extension
|
|
*
|
|
* Converts an dom element to a widget preview
|
|
* Widget preview contains an categorylist, widgetlist and a preview
|
|
*/
|
|
(function ($) {
|
|
$.extend({
|
|
widgetPreview: new function () {
|
|
|
|
/**
|
|
* Default settings for widgetPreview
|
|
* @type {object}
|
|
*/
|
|
var defaultSettings = {
|
|
/**
|
|
* handler called after a widget preview is loaded in preview element
|
|
* @type {function}
|
|
*/
|
|
onPreviewLoaded: function () {},
|
|
/**
|
|
* handler called on click on element in widgetlist or widget header
|
|
* @type {function}
|
|
*/
|
|
onSelect: function () {},
|
|
/**
|
|
* callback used to determine if a widget is available or not
|
|
* unavailable widgets aren't chooseable in widgetlist
|
|
* @type {function}
|
|
*/
|
|
isWidgetAvailable: function (widgetUniqueId) { return true; },
|
|
/**
|
|
* should the lists and preview be reset on widget selection?
|
|
* @type {boolean}
|
|
*/
|
|
resetOnSelect: false,
|
|
/**
|
|
* css classes for various elements
|
|
* @type {string}
|
|
*/
|
|
baseClass: 'widgetpreview-base',
|
|
categorylistClass: 'widgetpreview-categorylist',
|
|
widgetlistClass: 'widgetpreview-widgetlist',
|
|
widgetpreviewClass: 'widgetpreview-preview',
|
|
choosenClass: 'widgetpreview-choosen',
|
|
unavailableClass: 'widgetpreview-unavailable'
|
|
};
|
|
|
|
/**
|
|
* Returns the div to show category list in
|
|
* - if element doesn't exist it will be created and added
|
|
* - if element already exist it's content will be removed
|
|
*
|
|
* @return {$} category list element
|
|
*/
|
|
function createWidgetCategoryList(widgetPreview, availableWidgets) {
|
|
var settings = widgetPreview.settings;
|
|
|
|
if (!$('.' + settings.categorylistClass, widgetPreview).length) {
|
|
$(widgetPreview).append('<ul class="' + settings.categorylistClass + '"></ul>');
|
|
} else {
|
|
$('.' + settings.categorylistClass, widgetPreview).empty();
|
|
}
|
|
|
|
for (var widgetCategory in availableWidgets) {
|
|
|
|
$('.' + settings.categorylistClass, widgetPreview).append('<li>' + widgetCategory + '</li>');
|
|
}
|
|
|
|
return $('.' + settings.categorylistClass, widgetPreview);
|
|
}
|
|
|
|
/**
|
|
* Returns the div to show widget list in
|
|
* - if element doesn't exist it will be created and added
|
|
* - if element already exist it's content will be removed
|
|
*
|
|
* @return {$} widget list element
|
|
*/
|
|
function createWidgetList(widgetPreview) {
|
|
var settings = widgetPreview.settings;
|
|
|
|
if (!$('.' + settings.widgetlistClass, widgetPreview).length) {
|
|
$(widgetPreview).append('<ul class="' + settings.widgetlistClass + '"></ul>');
|
|
} else {
|
|
$('.' + settings.widgetlistClass + ' li', widgetPreview).off('mouseover');
|
|
$('.' + settings.widgetlistClass + ' li', widgetPreview).off('click');
|
|
$('.' + settings.widgetlistClass, widgetPreview).empty();
|
|
}
|
|
|
|
if ($('.' + settings.categorylistClass + ' .' + settings.choosenClass, widgetPreview).length) {
|
|
var position = $('.' + settings.categorylistClass + ' .' + settings.choosenClass, widgetPreview).position().top -
|
|
$('.' + settings.categorylistClass, widgetPreview).position().top;
|
|
|
|
$('.' + settings.widgetlistClass, widgetPreview).css('top', position);
|
|
$('.' + settings.widgetlistClass, widgetPreview).css('marginBottom', position);
|
|
}
|
|
|
|
return $('.' + settings.widgetlistClass, widgetPreview);
|
|
}
|
|
|
|
/**
|
|
* Display the given widgets in a widget list
|
|
*
|
|
* @param {object} widgets widgets to be displayed
|
|
* @return {void}
|
|
*/
|
|
function showWidgetList(widgets, widgetPreview) {
|
|
var settings = widgetPreview.settings;
|
|
|
|
var widgetList = createWidgetList(widgetPreview),
|
|
widgetPreviewTimer;
|
|
|
|
for (var j = 0; j < widgets.length; j++) {
|
|
var widgetName = widgets[j]["name"];
|
|
var widgetUniqueId = widgets[j]["uniqueId"];
|
|
// var widgetParameters = widgets[j]["parameters"];
|
|
var widgetClass = '';
|
|
if (!settings.isWidgetAvailable(widgetUniqueId)) {
|
|
widgetClass += ' ' + settings.unavailableClass;
|
|
}
|
|
|
|
widgetList.append('<li class="' + widgetClass + '" uniqueid="' + widgetUniqueId + '">' + widgetName + '</li>');
|
|
}
|
|
|
|
// delay widget preview a few millisconds
|
|
$('li', widgetList).on('mouseenter', function () {
|
|
var that = this,
|
|
widgetUniqueId = $(this).attr('uniqueid');
|
|
clearTimeout(widgetPreview);
|
|
widgetPreviewTimer = setTimeout(function () {
|
|
$('li', widgetList).removeClass(settings.choosenClass);
|
|
$(that).addClass(settings.choosenClass);
|
|
|
|
showPreview(widgetUniqueId, widgetPreview);
|
|
}, 400);
|
|
});
|
|
|
|
// clear timeout after mouse has left
|
|
$('li:not(.' + settings.unavailableClass + ')', widgetList).on('mouseleave', function () {
|
|
clearTimeout(widgetPreview);
|
|
});
|
|
|
|
$('li:not(.' + settings.unavailableClass + ')', widgetList).on('click', function () {
|
|
if (!$('.widgetLoading', widgetPreview).length) {
|
|
settings.onSelect($(this).attr('uniqueid'));
|
|
if (settings.resetOnSelect) {
|
|
resetWidgetPreview(widgetPreview);
|
|
}
|
|
}
|
|
return false;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Returns the div to show widget preview in
|
|
* - if element doesn't exist it will be created and added
|
|
* - if element already exist it's content will be removed
|
|
*
|
|
* @return {$} preview element
|
|
*/
|
|
function createPreviewElement(widgetPreview) {
|
|
var settings = widgetPreview.settings;
|
|
|
|
if (!$('.' + settings.widgetpreviewClass, widgetPreview).length) {
|
|
$(widgetPreview).append('<div class="' + settings.widgetpreviewClass + '"></div>');
|
|
} else {
|
|
$('.' + settings.widgetpreviewClass + ' .widgetTop', widgetPreview).off('click');
|
|
$('.' + settings.widgetpreviewClass, widgetPreview).empty();
|
|
}
|
|
|
|
return $('.' + settings.widgetpreviewClass, widgetPreview);
|
|
}
|
|
|
|
/**
|
|
* Show widget with the given uniqueId in preview
|
|
*
|
|
* @param {string} widgetUniqueId unique id of widget to display
|
|
* @return {void}
|
|
*/
|
|
function showPreview(widgetUniqueId, widgetPreview) {
|
|
// do not reload id widget already displayed
|
|
if ($('#' + widgetUniqueId, widgetPreview).length) return;
|
|
|
|
var settings = widgetPreview.settings;
|
|
|
|
var previewElement = createPreviewElement(widgetPreview);
|
|
|
|
var widget = widgetsHelper.getWidgetObjectFromUniqueId(widgetUniqueId);
|
|
var widgetParameters = widget['parameters'];
|
|
|
|
var emptyWidgetHtml = require('piwik/UI/Dashboard').WidgetFactory.make(
|
|
widgetUniqueId,
|
|
$('<div/>')
|
|
.attr('title', _pk_translate("Dashboard_AddPreviewedWidget"))
|
|
.text(_pk_translate('Dashboard_WidgetPreview'))
|
|
);
|
|
previewElement.html(emptyWidgetHtml);
|
|
|
|
var onWidgetLoadedCallback = function (response) {
|
|
var widgetElement = $('#' + widgetUniqueId);
|
|
$('.widgetContent', widgetElement).html($(response));
|
|
$('.widgetContent', widgetElement).trigger('widget:create');
|
|
settings.onPreviewLoaded(widgetUniqueId, widgetElement);
|
|
$('.' + settings.widgetpreviewClass + ' .widgetTop', widgetPreview).on('click', function () {
|
|
settings.onSelect(widgetUniqueId);
|
|
if (settings.resetOnSelect) {
|
|
resetWidgetPreview(widgetPreview);
|
|
}
|
|
return false;
|
|
});
|
|
};
|
|
|
|
// abort previous sent request
|
|
if (widgetPreview.widgetAjaxRequest) {
|
|
widgetPreview.widgetAjaxRequest.abort();
|
|
}
|
|
|
|
widgetPreview.widgetAjaxRequest = widgetsHelper.loadWidgetAjax(widgetUniqueId, widgetParameters, onWidgetLoadedCallback);
|
|
}
|
|
|
|
/**
|
|
* Reset function
|
|
*
|
|
* @return {void}
|
|
*/
|
|
function resetWidgetPreview(widgetPreview) {
|
|
var settings = widgetPreview.settings;
|
|
|
|
$('.' + settings.categorylistClass + ' li', widgetPreview).removeClass(settings.choosenClass);
|
|
createWidgetList(widgetPreview);
|
|
createPreviewElement(widgetPreview);
|
|
}
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param {object} userSettings Settings to be used
|
|
* @return {void}
|
|
*/
|
|
this.construct = function (userSettings) {
|
|
|
|
if (userSettings == 'reset') {
|
|
resetWidgetPreview(this);
|
|
return;
|
|
}
|
|
|
|
this.widgetAjaxRequest = null;
|
|
|
|
$(this).addClass('widgetpreview-base');
|
|
|
|
this.settings = jQuery.extend({}, defaultSettings, userSettings);
|
|
|
|
// set onSelect callback
|
|
if (typeof this.settings.onSelect == 'function') {
|
|
this.onSelect = this.settings.onSelect;
|
|
}
|
|
|
|
// set onPreviewLoaded callback
|
|
if (typeof this.settings.onPreviewLoaded == 'function') {
|
|
this.onPreviewLoaded = this.settings.onPreviewLoaded;
|
|
}
|
|
|
|
availableWidgets = widgetsHelper.getAvailableWidgets();
|
|
|
|
var categoryList = createWidgetCategoryList(this, availableWidgets);
|
|
|
|
var self = this;
|
|
$('li', categoryList).on('mouseover', function () {
|
|
var category = $(this).text();
|
|
var widgets = availableWidgets[category];
|
|
$('li', categoryList).removeClass(self.settings.choosenClass);
|
|
$(this).addClass(self.settings.choosenClass);
|
|
showWidgetList(widgets, self);
|
|
createPreviewElement(self); // empty preview
|
|
});
|
|
};
|
|
}
|
|
});
|
|
|
|
/**
|
|
* Makes widgetPreview available with $().widgetPreview()
|
|
*/
|
|
$.fn.extend({
|
|
widgetPreview: $.widgetPreview.construct
|
|
})
|
|
})(jQuery);
|