';
- }
- }
-
return html;
}
+ /**
+ * Computes the aspect ratio for a card given its shape.
+ * @param {string} shape - Shape for which to get the aspect ratio.
+ * @returns {null|number} Ratio of the shape.
+ */
function getDesiredAspect(shape) {
-
if (shape) {
shape = shape.toLowerCase();
if (shape.indexOf('portrait') !== -1) {
@@ -445,18 +488,23 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
return null;
}
+ /** Get the URL of the card's image.
+ * @param {Object} item - Item for which to generate a card.
+ * @param {Object} apiClient - API client object.
+ * @param {Object} options - Options of the card.
+ * @param {string} shape - Shape of the desired image.
+ * @returns {Object} Object representing the URL of the card's image.
+ */
function getCardImageUrl(item, apiClient, options, shape) {
+ item = item.ProgramInfo || item;
- var imageItem = item.ProgramInfo || item;
- item = imageItem;
-
- var width = options.width;
- var height = null;
- var primaryImageAspectRatio = item.PrimaryImageAspectRatio;
- var forceName = false;
- var imgUrl = null;
- var coverImage = false;
- var uiAspect = null;
+ const width = options.width;
+ let height = null;
+ const primaryImageAspectRatio = item.PrimaryImageAspectRatio;
+ let forceName = false;
+ let imgUrl = null;
+ let coverImage = false;
+ let uiAspect = null;
if (options.preferThumb && item.ImageTags && item.ImageTags.Thumb) {
@@ -663,21 +711,32 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
};
}
+ /**
+ * Generates a random integer in a given range.
+ * @param {number} min - Minimum of the range.
+ * @param {number} max - Maximum of the range.
+ * @returns {number} Randomly generated number.
+ */
function getRandomInt(min, max) {
return Math.floor(Math.random() * (max - min + 1)) + min;
}
- var numRandomColors = 5;
+ /**
+ * Generates an index used to select the default color of a card based on a string.
+ * @param {string} str - String to use for generating the index.
+ * @returns {number} Index of the color.
+ */
function getDefaultColorIndex(str) {
+ const numRandomColors = 5;
if (str) {
- var charIndex = Math.floor(str.length / 2);
- var character = String(str.substr(charIndex, 1).charCodeAt());
- var sum = 0;
- for (var i = 0; i < character.length; i++) {
+ const charIndex = Math.floor(str.length / 2);
+ const character = String(str.substr(charIndex, 1).charCodeAt());
+ let sum = 0;
+ for (let i = 0; i < character.length; i++) {
sum += parseInt(character.charAt(i));
}
- var index = String(sum).substr(-1);
+ let index = String(sum).substr(-1);
return (index % numRandomColors) + 1;
} else {
@@ -685,18 +744,26 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
}
}
+ /**
+ * Generates the HTML markup for a card's text.
+ * @param {Array} lines - Array containing the text lines.
+ * @param {string} cssClass - Base CSS class to use for the lines.
+ * @param {boolean} forceLines - Flag to force the rendering of all lines.
+ * @param {boolean} isOuterFooter - Flag to mark the text lines as outer footer.
+ * @param {string} cardLayout - DEPRECATED
+ * @param {boolean} addRightMargin - Flag to add a right margin to the text.
+ * @param {number} maxLines - Maximum number of lines to render.
+ * @returns {string} HTML markup for the card's text.
+ */
function getCardTextLines(lines, cssClass, forceLines, isOuterFooter, cardLayout, addRightMargin, maxLines) {
+ let html = '';
- var html = '';
+ let valid = 0;
- var valid = 0;
- var i;
- var length;
+ for (let i = 0; i < lines.length; i++) {
- for (i = 0, length = lines.length; i < length; i++) {
-
- var currentCssClass = cssClass;
- var text = lines[i];
+ let currentCssClass = cssClass;
+ let text = lines[i];
if (valid > 0 && isOuterFooter) {
currentCssClass += ' cardText-secondary';
@@ -722,9 +789,9 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
if (forceLines) {
- length = maxLines || Math.min(lines.length, maxLines || lines.length);
+ let linesLength = maxLines || Math.min(lines.length, maxLines || lines.length);
- while (valid < length) {
+ while (valid < linesLength) {
html += "
";
valid++;
}
@@ -733,17 +800,29 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
return html;
}
+ /**
+ * Determines if the item is live TV.
+ * @param {Object} item - Item to use for the check.
+ * @returns {boolean} Flag showing if the item is live TV.
+ */
function isUsingLiveTvNaming(item) {
return item.Type === 'Program' || item.Type === 'Timer' || item.Type === 'Recording';
}
+ /**
+ * Returns the air time text for the item based on the given times.
+ * @param {object} item - Item used to generate the air time text.
+ * @param {string} showAirDateTime - ISO8601 date for the start of the show.
+ * @param {string} showAirEndTime - ISO8601 date for the end of the show.
+ * @returns {string} The air time text for the item based on the given dates.
+ */
function getAirTimeText(item, showAirDateTime, showAirEndTime) {
+ let airTimeText = '';
- var airTimeText = '';
if (item.StartDate) {
try {
- var date = datetime.parseISO8601Date(item.StartDate);
+ let date = datetime.parseISO8601Date(item.StartDate);
if (showAirDateTime) {
airTimeText += datetime.toLocaleDateString(date, { weekday: 'short', month: 'short', day: 'numeric' }) + ' ';
@@ -763,15 +842,29 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
return airTimeText;
}
+ /**
+ * Generates the HTML markup for the card's footer text.
+ * @param {Object} item - Item used to generate the footer text.
+ * @param {Object} apiClient - API client instance.
+ * @param {Object} options - Options used to generate the footer text.
+ * @param {string} showTitle - Flag to show the title in the footer.
+ * @param {boolean} forceName - Flag to force showing the name of the item.
+ * @param {boolean} overlayText - Flag to show overlay text.
+ * @param {Object} imgUrl - Object representing the card's image URL.
+ * @param {string} footerClass - CSS classes of the footer element.
+ * @param {string} progressHtml - HTML markup of the progress bar element.
+ * @param {string} logoUrl - URL of the logo for the item.
+ * @param {boolean} isOuterFooter - Flag to mark the text as outer footer.
+ * @returns {string} HTML markup of the card's footer text element.
+ */
function getCardFooterText(item, apiClient, options, showTitle, forceName, overlayText, imgUrl, footerClass, progressHtml, logoUrl, isOuterFooter) {
-
- var html = '';
+ let html = '';
if (logoUrl) {
html += '';
}
- var showOtherText = isOuterFooter ? !overlayText : overlayText;
+ const showOtherText = isOuterFooter ? !overlayText : overlayText;
if (isOuterFooter && options.cardLayout && layoutManager.mobile) {
@@ -780,12 +873,12 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
}
}
- var cssClass = options.centerText ? "cardText cardTextCentered" : "cardText";
- var serverId = item.ServerId || options.serverId;
+ const cssClass = options.centerText ? "cardText cardTextCentered" : "cardText";
+ const serverId = item.ServerId || options.serverId;
- var lines = [];
- var parentTitleUnderneath = item.Type === 'MusicAlbum' || item.Type === 'Audio' || item.Type === 'MusicVideo';
- var titleAdded;
+ let lines = [];
+ const parentTitleUnderneath = item.Type === 'MusicAlbum' || item.Type === 'Audio' || item.Type === 'MusicVideo';
+ let titleAdded;
if (showOtherText) {
if ((options.showParentTitle || options.showParentTitleOrTitle) && !parentTitleUnderneath) {
@@ -814,7 +907,7 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
}
} else {
- var parentTitle = item.SeriesName || item.Series || item.Album || item.AlbumArtist || "";
+ const parentTitle = item.SeriesName || item.Series || item.Album || item.AlbumArtist || "";
if (parentTitle || showTitle) {
lines.push(parentTitle);
@@ -824,14 +917,14 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
}
}
- var showMediaTitle = (showTitle && !titleAdded) || (options.showParentTitleOrTitle && !lines.length);
+ let showMediaTitle = (showTitle && !titleAdded) || (options.showParentTitleOrTitle && !lines.length);
if (!showMediaTitle && !titleAdded && (showTitle || forceName)) {
showMediaTitle = true;
}
if (showMediaTitle) {
- var name = options.showTitle === 'auto' && !item.IsFolder && item.MediaType === 'Photo' ? '' : itemHelper.getDisplayName(item, {
+ const name = options.showTitle === 'auto' && !item.IsFolder && item.MediaType === 'Photo' ? '' : itemHelper.getDisplayName(item, {
includeParentInfo: options.includeParentInfoInTitle
});
@@ -858,22 +951,18 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
}
if (options.showItemCounts) {
-
- var itemCountHtml = getItemCountsHtml(options, item);
-
- lines.push(itemCountHtml);
+ lines.push(getItemCountsHtml(options, item));
}
if (options.textLines) {
- var additionalLines = options.textLines(item);
- for (var i = 0, length = additionalLines.length; i < length; i++) {
+ const additionalLines = options.textLines(item);
+ for (let i = 0; i < additionalLines.length; i++) {
lines.push(additionalLines[i]);
}
}
if (options.showSongCount) {
-
- var songLine = '';
+ let songLine = '';
if (item.SongCount) {
songLine = item.SongCount === 1 ?
@@ -911,7 +1000,7 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
} else {
if (item.EndDate && item.ProductionYear) {
- var endYear = datetime.parseISO8601Date(item.EndDate).getFullYear();
+ const endYear = datetime.parseISO8601Date(item.EndDate).getFullYear();
lines.push(item.ProductionYear + ((endYear === item.ProductionYear) ? '' : (' - ' + endYear)));
} else {
lines.push(item.ProductionYear || '');
@@ -1006,7 +1095,7 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
lines = [];
}
- var addRightTextMargin = isOuterFooter && options.cardLayout && !options.centerText && options.cardFooterAside !== 'none' && layoutManager.mobile;
+ const addRightTextMargin = isOuterFooter && options.cardLayout && !options.centerText && options.cardFooterAside !== 'none' && layoutManager.mobile;
html += getCardTextLines(lines, cssClass, !options.overlayText, isOuterFooter, options.cardLayout, addRightTextMargin, options.lines);
@@ -1027,8 +1116,14 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
return html;
}
+ /**
+ * Generates the HTML markup for the action button.
+ * @param {Object} item - Item used to generate the action button.
+ * @param {string} text - Text of the action button.
+ * @param {string} serverId - ID of the server.
+ * @returns {string} HTML markup of the action button.
+ */
function getTextActionButton(item, text, serverId) {
-
if (!text) {
text = itemHelper.getDisplayName(item);
}
@@ -1037,18 +1132,22 @@ define(['datetime', 'imageLoader', 'connectionManager', 'itemHelper', 'focusMana
return text;
}
- var html = '';
}
- var cardScalableClass = 'cardScalable';
+ let cardScalableClass = 'cardScalable';
cardImageContainerOpen = '