OTRS API Reference JavaScript

Namespace: Core.Agent.Dashboard

Core.Agent. Dashboard

This namespace contains the special module functions for the Dashboard.
Author:
  • OTRS AG
Source:

Methods

(static) EventsTicketCalendarInit(Params)

Initializes the event ticket calendar.
Parameters:
Name Type Description
Params Object Hash with different config options.
Properties
Name Type Description
MonthNames Array Array containing the localized strings for each month.
MonthNamesShort Array Array containing the localized strings for each month on shorth format.
DayNames Array Array containing the localized strings for each week day.
DayNamesShort Array Array containing the localized strings for each week day on short format.
ButtonText Array Array containing the localized strings for each week day on short format.
Properties
Name Type Description
today String Localized string for the word "Today".
month String Localized string for the word "month".
week String Localized string for the word "week".
day String Localized string for the word "day".
Events Array Array of hashes including the data for each event.
Source:

(static) Init()

Initialize the dashboard module.
Source:

(static) InitCustomerIDAutocomplete($Input)

Initialize autocompletion for CustomerID.
Parameters:
Name Type Description
$Input jQueryObject Input element to add auto complete to.
Source:

(static) InitCustomerUserAutocomplete($Input)

Initialize autocompletion for CustomerUser.
Parameters:
Name Type Description
$Input jQueryObject Input element to add auto complete to.
Source:

(static) InitStatsConfiguration($Container)

Initializes the configuration page for a stats dashboard widget.
Parameters:
Name Type Description
$Container jQueryObject
Source:

(static) InitUserAutocomplete($Input, Subaction)

Initialize autocompletion for User.
Parameters:
Name Type Description
$Input jQueryObject Input element to add auto complete to.
Subaction String Subaction to execute, "SearchCustomerID" or "SearchCustomerUser".
Source:

(static) RegisterUpdatePreferences($ClickedElement, ElementID, $Form)

This function binds a click event on an html element to update the preferences of the given dahsboard widget
Parameters:
Name Type Description
$ClickedElement jQueryObject The jQuery object of the element(s) that get the event listener.
ElementID string The ID of the element whose content should be updated with the server answer.
$Form jQueryObject The jQuery object of the form with the data for the server request.
Source: