Files
Cloud-CMS/modules/dashboard.xml
Matt Batchelder 05ce0da296 Initial Upload
2025-12-02 10:32:59 -05:00

137 lines
8.2 KiB
XML

<!--
~ Copyright (C) 2023 Xibo Signage Ltd
~
~ Xibo - Digital Signage - https://xibosignage.com
~
~ This file is part of Xibo.
~
~ Xibo is free software: you can redistribute it and/or modify
~ it under the terms of the GNU Affero General Public License as published by
~ the Free Software Foundation, either version 3 of the License, or
~ any later version.
~
~ Xibo is distributed in the hope that it will be useful,
~ but WITHOUT ANY WARRANTY; without even the implied warranty of
~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
~ GNU Affero General Public License for more details.
~
~ You should have received a copy of the GNU Affero General Public License
~ along with Xibo. If not, see <http://www.gnu.org/licenses/>.
-->
<module>
<id>core-dashboard</id>
<name>Dashboards</name>
<author>Core</author>
<description>Securely connect to services like Microsoft PowerBI and display dashboards</description>
<icon>fa fa-file-image</icon>
<class>\Xibo\Widget\DashboardProvider</class>
<dataCacheKey>%widgetId%_%displayId%</dataCacheKey>
<type>dashboard</type>
<dataType>xibo-dashboard-service</dataType>
<schemaVersion>1</schemaVersion>
<assignable>1</assignable>
<regionSpecific>1</regionSpecific>
<renderAs>html</renderAs>
<defaultDuration>60</defaultDuration>
<settings></settings>
<properties>
<property id="type" type="connectorProperties">
<title>Type</title>
<helpText>Select the dashboards type below</helpText>
</property>
<property id="url" type="text" variant="uri">
<title>Link</title>
<helpText>The Location (URL) of the dashboard webpage</helpText>
<default></default>
<rule>
<test>
<condition type="required"></condition>
</test>
</rule>
</property>
<property id="updateInterval" type="number">
<title>Update Interval (mins)</title>
<helpText>Please enter the update interval in minutes. This should be kept as high as possible. For example, if the data will only change once per hour this could be set to 60.</helpText>
<default>60</default>
</property>
</properties>
<preview></preview>
<stencil>
<hbs><![CDATA[
<img id="loader" alt="Loading..." src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pgo8IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9HcmFwaGljcy9TVkcvMS4xL0RURC9zdmcxMS5kdGQiPgo8c3ZnIHdpZHRoPSI0MHB4IiBoZWlnaHQ9IjQwcHgiIHZpZXdCb3g9IjAgMCA0MCA0MCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4bWw6c3BhY2U9InByZXNlcnZlIiBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQ7Y2xpcC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjEuNDE0MjE7IiB4PSIwcHgiIHk9IjBweCI+CiAgICA8ZGVmcz4KICAgICAgICA8c3R5bGUgdHlwZT0idGV4dC9jc3MiPjwhW0NEQVRBWwogICAgICAgICAgICBALXdlYmtpdC1rZXlmcmFtZXMgc3BpbiB7CiAgICAgICAgICAgICAgZnJvbSB7CiAgICAgICAgICAgICAgICAtd2Via2l0LXRyYW5zZm9ybTogcm90YXRlKDBkZWcpCiAgICAgICAgICAgICAgfQogICAgICAgICAgICAgIHRvIHsKICAgICAgICAgICAgICAgIC13ZWJraXQtdHJhbnNmb3JtOiByb3RhdGUoMzU5ZGVnKQogICAgICAgICAgICAgIH0KICAgICAgICAgICAgfQogICAgICAgICAgICBAa2V5ZnJhbWVzIHNwaW4gewogICAgICAgICAgICAgIGZyb20gewogICAgICAgICAgICAgICAgdHJhbnNmb3JtOiByb3RhdGUoMGRlZykKICAgICAgICAgICAgICB9CiAgICAgICAgICAgICAgdG8gewogICAgICAgICAgICAgICAgdHJhbnNmb3JtOiByb3RhdGUoMzU5ZGVnKQogICAgICAgICAgICAgIH0KICAgICAgICAgICAgfQogICAgICAgICAgICBzdmcgewogICAgICAgICAgICAgICAgLXdlYmtpdC10cmFuc2Zvcm0tb3JpZ2luOiA1MCUgNTAlOwogICAgICAgICAgICAgICAgLXdlYmtpdC1hbmltYXRpb246IHNwaW4gMS41cyBsaW5lYXIgaW5maW5pdGU7CiAgICAgICAgICAgICAgICAtd2Via2l0LWJhY2tmYWNlLXZpc2liaWxpdHk6IGhpZGRlbjsKICAgICAgICAgICAgICAgIGFuaW1hdGlvbjogc3BpbiAxLjVzIGxpbmVhciBpbmZpbml0ZTsKICAgICAgICAgICAgfQogICAgICAgIF1dPjwvc3R5bGU+CiAgICA8L2RlZnM+CiAgICA8ZyBpZD0ib3V0ZXIiPgogICAgICAgIDxnPgogICAgICAgICAgICA8cGF0aCBkPSJNMjAsMEMyMi4yMDU4LDAgMjMuOTkzOSwxLjc4ODEzIDIzLjk5MzksMy45OTM5QzIzLjk5MzksNi4xOTk2OCAyMi4yMDU4LDcuOTg3ODEgMjAsNy45ODc4MUMxNy43OTQyLDcuOTg3ODEgMTYuMDA2MSw2LjE5OTY4IDE2LjAwNjEsMy45OTM5QzE2LjAwNjEsMS43ODgxMyAxNy43OTQyLDAgMjAsMFoiIHN0eWxlPSJmaWxsOmJsYWNrOyIvPgogICAgICAgIDwvZz4KICAgICAgICA8Zz4KICAgICAgICAgICAgPHBhdGggZD0iTTUuODU3ODYsNS44NTc4NkM3LjQxNzU4LDQuMjk4MTUgOS45NDYzOCw0LjI5ODE1IDExLjUwNjEsNS44NTc4NkMxMy4wNjU4LDcuNDE3NTggMTMuMDY1OCw5Ljk0NjM4IDExLjUwNjEsMTEuNTA2MUM5Ljk0NjM4LDEzLjA2NTggNy40MTc1OCwxMy4wNjU4IDUuODU3ODYsMTEuNTA2MUM0LjI5ODE1LDkuOTQ2MzggNC4yOTgxNSw3LjQxNzU4IDUuODU3ODYsNS44NTc4NloiIHN0eWxlPSJmaWxsOnJnYigyMTAsMjEwLDIxMCk7Ii8+CiAgICAgICAgPC9nPgogICAgICAgIDxnPgogICAgICAgICAgICA8cGF0aCBkPSJNMjAsMzIuMDEyMkMyMi4yMDU4LDMyLjAxMjIgMjMuOTkzOSwzMy44MDAzIDIzLjk5MzksMzYuMDA2MUMyMy45OTM5LDM4LjIxMTkgMjIuMjA1OCw0MCAyMCw0MEMxNy43OTQyLDQwIDE2LjAwNjEsMzguMjExOSAxNi4wMDYxLDM2LjAwNjFDMTYuMDA2MSwzMy44MDAzIDE3Ljc5NDIsMzIuMDEyMiAyMCwzMi4wMTIyWiIgc3R5bGU9ImZpbGw6cmdiKDEzMCwxMzAsMTMwKTsiLz4KICAgICAgICA8L2c+CiAgICAgICAgPGc+CiAgICAgICAgICAgIDxwYXRoIGQ9Ik0yOC40OTM5LDI4LjQ5MzlDMzAuMDUzNiwyNi45MzQyIDMyLjU4MjQsMjYuOTM0MiAzNC4xNDIxLDI4LjQ5MzlDMzUuNzAxOSwzMC4wNTM2IDM1LjcwMTksMzIuNTgyNCAzNC4xNDIxLDM0LjE0MjFDMzIuNTgyNCwzNS43MDE5IDMwLjA1MzYsMzUuNzAxOSAyOC40OTM5LDM0LjE0MjFDMjYuOTM0MiwzMi41ODI0IDI2LjkzNDIsMzAuMDUzNiAyOC40OTM5LDI4LjQ5MzlaIiBzdHlsZT0iZmlsbDpyZ2IoMTAxLDEwMSwxMDEpOyIvPgogICAgICAgIDwvZz4KICAgICAgICA8Zz4KICAgICAgICAgICAgPHBhdGggZD0iTTMuOTkzOSwxNi4wMDYxQzYuMTk5NjgsMTYuMDA2MSA3Ljk4NzgxLDE3Ljc5NDIgNy45ODc4MSwyMEM3Ljk4NzgxLDIyLjIwNTggNi4xOTk2OCwyMy45OTM5IDMuOTkzOSwyMy45OTM5QzEuNzg4MTMsMjMuOTkzOSAwLDIyLjIwNTggMCwyMEMwLDE3Ljc5NDIgMS43ODgxMywxNi4wMDYxIDMuOTkzOSwxNi4wMDYxWiIgc3R5bGU9ImZpbGw6cmdiKDE4NywxODcsMTg3KTsiLz4KICAgICAgICA8L2c+CiAgICAgICAgPGc+CiAgICAgICAgICAgIDxwYXRoIGQ9Ik01Ljg1Nzg2LDI4LjQ5MzlDNy40MTc1OCwyNi45MzQyIDkuOTQ2MzgsMjYuOTM0MiAxMS41MDYxLDI4LjQ5MzlDMTMuMDY1OCwzMC4wNTM2IDEzLjA2NTgsMzIuNTgyNCAxMS41MDYxLDM0LjE0MjFDOS45NDYzOCwzNS43MDE5IDcuNDE3NTgsMzUuNzAxOSA1Ljg1Nzg2LDM0LjE0MjFDNC4yOTgxNSwzMi41ODI0IDQuMjk4MTUsMzAuMDUzNiA1Ljg1Nzg2LDI4LjQ5MzlaIiBzdHlsZT0iZmlsbDpyZ2IoMTY0LDE2NCwxNjQpOyIvPgogICAgICAgIDwvZz4KICAgICAgICA8Zz4KICAgICAgICAgICAgPHBhdGggZD0iTTM2LjAwNjEsMTYuMDA2MUMzOC4yMTE5LDE2LjAwNjEgNDAsMTcuNzk0MiA0MCwyMEM0MCwyMi4yMDU4IDM4LjIxMTksMjMuOTkzOSAzNi4wMDYxLDIzLjk5MzlDMzMuODAwMywyMy45OTM5IDMyLjAxMjIsMjIuMjA1OCAzMi4wMTIyLDIwQzMyLjAxMjIsMTcuNzk0MiAzMy44MDAzLDE2LjAwNjEgMzYuMDA2MSwxNi4wMDYxWiIgc3R5bGU9ImZpbGw6cmdiKDc0LDc0LDc0KTsiLz4KICAgICAgICA8L2c+CiAgICAgICAgPGc+CiAgICAgICAgICAgIDxwYXRoIGQ9Ik0yOC40OTM5LDUuODU3ODZDMzAuMDUzNiw0LjI5ODE1IDMyLjU4MjQsNC4yOTgxNSAzNC4xNDIxLDUuODU3ODZDMzUuNzAxOSw3LjQxNzU4IDM1LjcwMTksOS45NDYzOCAzNC4xNDIxLDExLjUwNjFDMzIuNTgyNCwxMy4wNjU4IDMwLjA1MzYsMTMuMDY1OCAyOC40OTM5LDExLjUwNjFDMjYuOTM0Miw5Ljk0NjM4IDI2LjkzNDIsNy40MTc1OCAyOC40OTM5LDUuODU3ODZaIiBzdHlsZT0iZmlsbDpyZ2IoNTAsNTAsNTApOyIvPgogICAgICAgIDwvZz4KICAgIDwvZz4KPC9zdmc+Cg=="/>
<div id="dashboard"></div>
<!-- TOKEN= {{token}} -->
]]></hbs>
<style><![CDATA[
#loader {
display: block;
margin-left: auto;
margin-right: auto;
margin-top: 50px;
}
#dashboard {
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
}
#dashboard img {
margin: auto;
width: 100%;
height: 100%;
}
.error-message {
position: absolute;
bottom: 0;
left: 0;
text-align: center;
width: 100%;
padding: 8px 0;
background-color: #d05454;
color: white;
z-index: 2;
font-weight: bold;
font-size: 0.625rem;
opacity: 0.85;
}
]]></style>
</stencil>
<onRender><![CDATA[
var item = items[0];
var interval;
$(function() {
if (properties.url && properties.type) {
loadImage();
}
});
function loadImage() {
var image = new Image();
image.onload = function() {
$("#dashboard").html("");
$("#dashboard").append($("<img src=\"" + this.src + "\" >"));
$("#loader").hide();
if (interval) {
clearInterval(interval)
}
interval = setInterval(loadImage, properties.updateInterval * 60 * 1000);
}
image.onerror = function() {
$("#loader").show();
if (interval) {
clearInterval(interval)
}
interval = setInterval(loadImage, 60 * 1000);
}
if (item.url) {
image.src = item.url;
}
}
]]></onRender>
</module>