Namespace: Helper

Helper

Пространство имен для вспомогательных методов (работа с разметкой, форматирование и валидация значений, и т.д.)

Source:
helper.js

Classes

TimedCache

Methods


<static> addBodyClass(cls)

Добавляет класс для тэга body, дополняя уже имеющиеся классы.

Parameters:
Name Type Description
cls

название класса

Source:
helper.js

<static> addClass(id, cls)

Добавляет класс для HTML-элемента, дополняя уже имеющиеся классы.

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

cls

название класса

Source:
helper.js

<static> addClassForObject(obj, cls)

Добавляет класс для объекта HTML-элемента, дополняя уже имеющиеся классы.

Parameters:
Name Type Description
obj

объект HTML-элемента

cls

название класса

Source:
helper.js

<static> addCSSTag(src, callbackFunc, cls)

Подлкючает дополнительный CSS-файл к шаблону через тэг link

Parameters:
Name Type Description
src

путь к CSS-файлу

callbackFunc

метод, который выполнится после загрузки дополнительного файла

cls

название класса, который добавится к тэгу (необязательный)

Source:
helper.js

<static> addJSScriptListTag(src, callbackFunc)

Подключает несколько дополнительных javascript-файлов к шаблону через тэг script

Parameters:
Name Type Description
src

пути к javascript-файлам в виде массива

callbackFunc

метод, который выполнится после загрузки всех дополнительных файлов

Source:
helper.js

<static> addJSScriptTag(src, callbackFunc)

Подключает дополнительный javascript-файл к шаблону через тэг script

Parameters:
Name Type Description
src

путь к javascript-файлу

callbackFunc

метод, который выполнится после загрузки дополнительного файла

Source:
helper.js

<static> byClass(cls)

Возвращает список HTML-элементов с заданным классом

Parameters:
Name Type Description
cls

название класса

Source:
helper.js
Returns:
Type
Array

<static> byId(id)

Возвращает объект HTML-элемента по id

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

Source:
helper.js
Returns:
Type
Object

<static> changeCSSTag(filename, callbackFunc, cls)

Заменяет CSS-файл с заданным классом на другой, с сохранением названия класса для тэга нового файла

Parameters:
Name Type Description
filename

путь к новому CSS-файлу

callbackFunc

метод, который выполнится после подключения нового CSS-файла

cls

название класса

Source:
helper.js

<static> cropString(str, maxlen, strend)

Обрезает строку до заданной длины

Parameters:
Name Type Description
str

строка, которую необходимо обрезать

maxlen

максимальная длина строки (с учетом strend)

strend

строка, которая добавляется к концу обрезанной строки, по умолчанию используется ".."

Source:
helper.js

<static> cropStringIn2Line(str, maxlen, strend)

Обрезает текст таким образом, чтобы он помещался в две строки и не выходил за их пределы.

Parameters:
Name Type Description
str

текст, который необходимо обрезать

maxlen

максимальная длина одной строки (с учетом strend)

strend

строка, которая добавляется к концу обрезанного текста, по умолчанию используется ".."

Source:
helper.js

<static> delayedCall(callbackFunc, delay)

Откладывает выполнение метода

Parameters:
Name Type Description
callbackFunc

метод

delay

время задержки в миллисекундах

Source:
helper.js

<static> executeFunctionByName(functionName, context)

Запускает выполнение метода по его имени из указанного экрана/окна (контекста выполнения). Количество аргументов может быть больше двух, дополнительные аргументы передаются далее в метод.

Parameters:
Name Type Description
functionName

название метода

context

экран/окно, в котором находится метод (контекст выполнения)

Source:
helper.js

<static> formatSeconds(seconds, longFormat)

Форматирует секунды в виде ЧЧ:ММ либо ЧЧ:ММ:СС (например: длительность фильма, передачи)

Parameters:
Name Type Description
seconds

секунды для форматирования

longFormat

флаг выбора формата: true - ЧЧ:ММ:СС, false - ЧЧ:ММ

Source:
helper.js
Returns:
Type
String

<static> formatTime(timestamp)

Форматирует время в виде ЧЧ:ММ

Parameters:
Name Type Description
timestamp

строка со значением времени (формат Unix Timestamp UTC+0)

Source:
helper.js
Returns:
Type
String

<static> formatTimeWithSeconds(timestamp)

Форматирует время в виде ЧЧ:ММ:СС

Parameters:
Name Type Description
timestamp

строка со значением времени (формат Unix Timestamp UTC+0)

Source:
helper.js
Returns:
Type
String

<static> getCookie(name)

Возвращает значение для cookie по его имени

Parameters:
Name Type Description
name

имя cookie

Source:
helper.js
Returns:
Type
*

<static> getHtml(id)

Возвращает HTML-содержимое элемента по его id.

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

Source:
helper.js
Returns:
Type
String

<static> getLengthOfRarefiedArray(array)

Возвращает количество элементов в разреженном массиве

Parameters:
Name Type Description
array

разреженный массив

Source:
helper.js
Returns:
Type
Number

<static> getProgressWidth(begin, end, now)

Переводит текущее значение в проценты (например: для вычисления ширины прогресс-бара)

Parameters:
Name Type Description
begin

начальный показатель

end

конечный показатель

now

текущий показатель

Source:
helper.js
Returns:
Type
Number

<static> getValue(id)

Возвращает значение атрибута value для HTML-элемента по его id

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

Source:
helper.js
Returns:
Type
String

<static> getValueForObject(obj)

Возвращает значение атрибута value для объекта HTML-элемента

Parameters:
Name Type Description
obj

объект HTML-элемента

Source:
helper.js
Returns:
Type
String

<static> hasBodyClass(cls)

Проверка на наличие класса у тэга body

Parameters:
Name Type Description
cls

название класса

Source:
helper.js
Returns:

true - если класс найден, false - если класс не найден

Type
Boolean

<static> hasClass(id, cls)

Проверка на наличие класса у HTML-элемента

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

cls

название класса

Source:
helper.js
Returns:

true - если класс найден, false - если класс не найден

Type
Boolean

<static> hasClassForObject(obj, cls)

Проверка на наличие класса у объекта HTML-элемента

Parameters:
Name Type Description
obj

объект HTML-элемента

cls

название класса

Source:
helper.js
Returns:

true - если класс найден, false - если класс не найден

Type
Boolean

<static> hideByClass(cls)

Скрывает HTML-элемент по его классу. Если элементов с таким классом несколько, то скрываются все.

Parameters:
Name Type Description
cls

название класса

Source:
helper.js

<static> hideById(id)

Скрывает HTML-элемент по его id

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

Source:
helper.js

<static> hideObject(obj)

Скрывает объект HTML-элемента

Parameters:
Name Type Description
obj

объект HTML-элемента

Source:
helper.js

<static> isObjectVisible(obj)

Проверка на видимость объекта HTML-элемента

Parameters:
Name Type Description
obj

объект HTML-элемента

Source:
helper.js
Returns:
Type
Boolean

<static> isVisible(id)

Проверка на видимость HTML-элемента по его id

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

Source:
helper.js
Returns:
Type
Boolean

<static> preloadImg(imgs)

Используется для предварительной загрузки изображений

Parameters:
Name Type Description
imgs

пути изображений в виде массива

Source:
helper.js

<static> removeBodyClass(cls)

Удаляет класс для тэга body, не затрагивая остальные классы.

Parameters:
Name Type Description
cls

название класса

Source:
helper.js

<static> removeClass(id, cls)

Удаляет класс для HTML-элемента, не затрагивая остальные классы.

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

cls

название класса

Source:
helper.js

<static> removeClassForObject(obj, cls)

Удаляет класс для объекта HTML-элемента, не затрагивая остальные классы.

Parameters:
Name Type Description
obj

объект HTML-элемента

cls

название класса

Source:
helper.js

<static> resetDelayedCall()

Отменяет отложенное выполнение метода, которое было установлено с помощью delayedCall

Source:
helper.js

<static> setClass(id, cls)

Устанавливает класс для HTML-элемента по его id, удаляя уже имеющиеся классы.

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

cls

название класса

Source:
helper.js

<static> setClassForObject(obj, cls)

Устанавливает класс для объекта HTML-элемента, удаляя уже имеющиеся классы.

Parameters:
Name Type Description
obj

объект HTML-элемента

cls

название класса

Source:
helper.js

<static> setCookie(name, value, options)

Устанавливает значение для cookie

Parameters:
Name Type Description
name

имя cookie

value

значение для cookie

options

дополнительные параметры для cookie (время жизни, путь)

Source:
helper.js

<static> setHtml(id, html)

Устанавливает HTML-содержимое для элемента по его id.

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

html

HTML-содержимое

Source:
helper.js

<static> setHtmlByClass(cls, html)

Устанавливает HTML-содержимое для элемента по его классу. Если элементов с таким классом несколько, то содержимое добавляется во все.

Parameters:
Name Type Description
cls

название класса

html

HTML-содержимое

Source:
helper.js

<static> setHtmlForObject(obj, html)

Устанавливает HTML-содержимое напрямую в объект элемента.

Parameters:
Name Type Description
obj

объект HTML-элемента

html

HTML-содержимое

Source:
helper.js

<static> setValue(id, value)

Устанавливает значение атрибута value для HTML-элемента по его id

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

value

значение

Source:
helper.js

<static> setValueForObject(obj, value)

Устанавливает значение атрибута value для объекта HTML-элемента

Parameters:
Name Type Description
obj

объект HTML-элемента

value

значение

Source:
helper.js

<static> showByClass(cls)

Делает видимым HTML-элемент по его классу. Если элементов с таким классом несколько, то видимыми становятся все.

Parameters:
Name Type Description
cls

название класса

Source:
helper.js

<static> showById(id)

Делает видимым HTML-элемент по его id

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

Source:
helper.js

<static> showObject(obj)

Делает видимым объект HTML-элемента

Parameters:
Name Type Description
obj

объект HTML-элемента

Source:
helper.js

<static> stickyKeyPrevent(callbackFunc, minInterval)

Блокирует вызов методов, выполняющихся по нажатию кнопки пульта, если интервал между нажатиями был меньше заданного времени

Parameters:
Name Type Description
callbackFunc

метод, который должен выполняться по нажатию кнопки

minInterval

минимальное время в миллисекундах, которое должно пройти между нажатиями

Source:
helper.js

<static> stickyKeyPreventChecker(minInterval)

Сравнивает интервал между нажатиями кнопки пульта с заданным минимальным временем между нажатиями

Parameters:
Name Type Description
minInterval

минимальное время в миллисекундах, которое должно пройти между нажатиями

Source:
helper.js
Returns:

true - минимальное время прошло, false - в противном случае

Type
Boolean

<static> toInt(value)

Приводит значение к типу Integer

Parameters:
Name Type Description
value

значение

Source:
helper.js
Returns:
Type
Number

<static> totalIndentLeft(id)

Возвращает сумму свойств left и margin-left для HTML-элемента по его id.

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

Source:
helper.js
Returns:
Type
Number

<static> totalIndentRight(id)

Возвращает сумму свойств right и margin-right для HTML-элемента по его id.

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

Source:
helper.js
Returns:
Type
Number

<static> totalIndentVertical(id)

Возвращает сумму вертикальных отступов HTML-элемента по его id. Учитываются свойства: top, bottom, margin-top, margin-bottom, padding-top, padding-bottom.

Parameters:
Name Type Description
id

значение атрибута id HTML-элемента

Source:
helper.js
Returns:
Type
Number

<static> withTimezone(timestamp)

Корректирует время с учетом часового пояса, выбранного в шаблоне

Parameters:
Name Type Description
timestamp

строка со значением времени (формат Unix Timestamp UTC+0)

Source:
helper.js
Returns:
Type
Number