100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
UI: Remove or-data-viewer component (#2468)
Martin Peeters6ac300f553bd
diff --git a/ui/app/manager/package.json b/ui/app/manager/package.jsonindex 1d86ca701..f1085c84f 100644--- a/ui/app/manager/package.json+++ b/ui/app/manager/package.json@@ -38,7 +38,6 @@"@openremote/or-attribute-picker": "workspace:*","@openremote/or-components": "workspace:*","@openremote/or-dashboard-builder": "workspace:*",- "@openremote/or-data-viewer": "workspace:*","@openremote/or-icon": "workspace:*","@openremote/or-json-forms": "workspace:*","@openremote/or-log-viewer": "workspace:*",diff --git a/ui/app/manager/src/pages/page-insights.ts b/ui/app/manager/src/pages/page-insights.tsindex 08a9f6eac..3c14243d7 100644--- a/ui/app/manager/src/pages/page-insights.ts+++ b/ui/app/manager/src/pages/page-insights.ts@@ -1,7 +1,5 @@import {css, html, TemplateResult} from "lit";import {customElement, property, query, state } from "lit/decorators.js";-import "@openremote/or-data-viewer";-import {DataViewerConfig, OrDataViewer} from "@openremote/or-data-viewer";import {Page, PageProvider, router} from "@openremote/or-app";import {AppStateKeyed} from "@openremote/or-app";import {Store} from "@reduxjs/toolkit";@@ -13,7 +11,7 @@ import {getInsightsRoute} from "../routes";import { showSnackbar } from "@openremote/or-mwc-components/or-mwc-snackbar";export interface PageInsightsConfig {- dataViewer?: DataViewerConfig+}export function pageInsightsProvider(store: Store<AppStateKeyed>, config?: PageInsightsConfig): PageProvider<AppStateKeyed> {@@ -53,9 +51,6 @@ export class PageInsights extends Page<AppStateKeyed> {@property()public config?: PageInsightsConfig;- @query("#data-viewer")- protected _dataviewer!: OrDataViewer;-@property()protected _editMode: boolean = true;@@ -86,7 +81,6 @@ export class PageInsights extends Page<AppStateKeyed> {protected getRealmState = createSelector([this._realmSelector],async () => {- if (this._dataviewer) this._dataviewer.refresh();this._updateRoute(true);this.requestUpdate();}diff --git a/ui/component/or-app/tsconfig.json b/ui/component/or-app/tsconfig.jsonindex a054a3d7a..98ad8a632 100644--- a/ui/component/or-app/tsconfig.json+++ b/ui/component/or-app/tsconfig.json@@ -13,12 +13,12 @@{ "path": "../../component/or-mwc-components" },{ "path": "../../component/or-icon" },{ "path": "../../component/or-map" },+ { "path": "../../component/or-attribute-card" },{ "path": "../../component/or-attribute-input" },{ "path": "../../component/or-attribute-picker" },{ "path": "../../component/or-attribute-barchart" },{ "path": "../../component/or-asset-tree" },{ "path": "../../component/or-asset-viewer" },- { "path": "../../component/or-data-viewer" },{ "path": "../../component/or-log-viewer" },{ "path": "../../component/or-chart" },{ "path": "../../component/or-rules" },diff --git a/ui/component/or-data-viewer/.npmignore b/ui/component/or-data-viewer/.npmignoredeleted file mode 100644index b2544e0f1..000000000--- a/ui/component/or-data-viewer/.npmignore+++ /dev/null@@ -1,9 +0,0 @@-build/-build.gradle-test/-src/-webpack.config.js-rspack.config.js-tsconfig.json-dist/*.map-*.tsbuildinfodiff --git a/ui/component/or-data-viewer/README.md b/ui/component/or-data-viewer/README.mddeleted file mode 100644index 8d9e8cf9f..000000000--- a/ui/component/or-data-viewer/README.md+++ /dev/null@@ -1,87 +0,0 @@-# @openremote/or-data-viewer \<or-data-viewer\>-[![NPM Version][npm-image]][npm-url]-[![Linux Build][travis-image]][travis-url]-[![Test Coverage][coveralls-image]][coveralls-url]--Web Component for displaying an data tree. This component requires an OpenRemote Manager to retrieve, save and query data.--## Install-```bash-npm i @openremote/or-data-viewer-yarn add @openremote/or-data-viewer-```--## Usage-By default the or-data-viewer is using a 2 columns grid. This can be changed by using a different config.--4 column grid, 25% for each column:-```javascript-const viewerConfig = {- viewerStyles: {- gridTemplateColumns: "repeat(auto-fill, minmax(calc(25%),1fr))";- }-};-<or-data-viewer .config="${viewerConfig}"></or-data-viewer>-```---The position of a panel can also be changed by changing the config of or-data-viewer--To change the width of a panel use gridColumn:-```javascript-const viewerConfig = {- panels: {- "info": {- type: "property",- panelStyles: {- gridColumn: "1 / -1" // same as 1 / 3 in a 2 column grid: Start on column 1, End on column 3- }- }- }-};-```--gridColumn can also be used to change the position horizontally.-```javascript-const viewerConfig = {- panels: {- "info": {- type: "property",- panelStyles: {- gridColumnStart: "2" // start the panel in the second column- }- }- }-};-```--To change the vertical position of a panel use gridRowStart. To start the panel on the first row set gridRowStart to 1:-```javascript-const viewerConfig = {- panels: {- "info": {- type: "property",- panelStyles: {- gridRowStart: "1"- }- }- }-};-```--For a full list of properties, methods and options refer to the TypeDoc generated [documentation]().--## Supported Browsers-The last 2 versions of all modern browsers are supported, including Chrome, Safari, Opera, Firefox, Edge. In addition,-Internet Explorer 11 is also supported.---## License-[GNU AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)--[npm-image]: https://img.shields.io/npm/v/live-xxx.svg-[npm-url]: https://npmjs.org/package/@openremote/or-asset-list-[travis-image]: https://img.shields.io/travis/live-js/live-xxx/master.svg-[travis-url]: https://travis-ci.org/live-js/live-xxx-[coveralls-image]: https://img.shields.io/coveralls/live-js/live-xxx/master.svg-[coveralls-url]: https://coveralls.io/r/live-js/live-xxx?branch=masterdiff --git a/ui/component/or-data-viewer/build.gradle b/ui/component/or-data-viewer/build.gradledeleted file mode 100644index 715a0847b..000000000--- a/ui/component/or-data-viewer/build.gradle+++ /dev/null@@ -1,26 +0,0 @@-buildDir = "dist"--tasks.register('clean') {- doLast {- delete "dist"- delete "lib"- }-}--tasks.register('npmAnalyze', Exec) {- mustRunAfter npmClean- dependsOn getYarnInstallTask()- commandLine npmCommand("yarn"), "run", "analyze"-}--tasks.register('installDist') {- dependsOn npmAnalyze-}--tasks.register('prepareUi') {- dependsOn clean, npmAnalyze, npmPrepare-}--tasks.register('publishUi') {- dependsOn clean, npmPublish-}diff --git a/ui/component/or-data-viewer/package.json b/ui/component/or-data-viewer/package.jsondeleted file mode 100644index e49383000..000000000--- a/ui/component/or-data-viewer/package.json+++ /dev/null@@ -1,35 +0,0 @@-{- "name": "@openremote/or-data-viewer",- "version": "1.14.0-snapshot",- "description": "OpenRemote data Viewer",- "customElements": "custom-elements.json",- "main": "dist/umd/index.bundle.js",- "module": "lib/index.js",- "exports": {- ".": "./lib/index.js",- "./*": "./lib/*.js",- "./jsx": {- "types": "./custom-elements-jsx.d.ts"- }- },- "types": "lib/index.d.ts",- "scripts": {- "analyze": "npx cem analyze --config ../custom-elements-manifest.config.mjs",- "test": "echo \"No tests\" && exit 0",- "prepack": "npx rspack"- },- "author": "OpenRemote",- "license": "AGPL-3.0-or-later",- "dependencies": {- "@openremote/core": "workspace:*",- "@openremote/model": "workspace:*",- "@openremote/or-attribute-card": "workspace:*",- "@openremote/or-chart": "workspace:*",- "@openremote/or-components": "workspace:*",- "@openremote/or-translate": "workspace:*",- "lit": "^3.3.1"- },- "publishConfig": {- "access": "public"- }-}diff --git a/ui/component/or-data-viewer/rspack.config.js b/ui/component/or-data-viewer/rspack.config.jsdeleted file mode 100644index a5cdec63b..000000000--- a/ui/component/or-data-viewer/rspack.config.js+++ /dev/null@@ -1,10 +0,0 @@-const util = require("@openremote/util");--bundles = {- "index": {- excludeOr: true- },- "index.orbundle": undefined-};--module.exports = util.generateExports(__dirname);diff --git a/ui/component/or-data-viewer/src/index.ts b/ui/component/or-data-viewer/src/index.tsdeleted file mode 100644index bb0a54629..000000000--- a/ui/component/or-data-viewer/src/index.ts+++ /dev/null@@ -1,294 +0,0 @@-import {html, LitElement, PropertyValues, TemplateResult} from "lit";-import {customElement, property} from "lit/decorators.js";-import "@openremote/or-chart";-import "@openremote/or-translate";-import "@openremote/or-components/or-panel";-import {OrChartConfig, OrChartEvent} from "@openremote/or-chart";-import {Asset, Attribute} from "@openremote/model";-import {style} from "./style";-import {i18next, translate} from "@openremote/or-translate"-import {styleMap} from "lit/directives/style-map.js";-import {classMap} from "lit/directives/class-map.js";-import "@openremote/or-attribute-card";-import manager from "@openremote/core";--export type PanelType = "chart" | "kpi";--export interface DefaultAssets {- assetId?: string;- attributes?: string[];-}--export interface PanelConfig {- type?: PanelType;- hide?: boolean;- hideOnMobile?: boolean;- defaults?: DefaultAssets[];- include?: string[];- exclude?: string[];- readonly?: string[];- panelStyles?: { [style: string]: string };- fieldStyles?: { [field: string]: { [style: string]: string } };-}--export interface DataViewerConfig {- panels: {[name: string]: PanelConfig};- viewerStyles?: { [style: string]: string };- propertyViewProvider?: (property: string, value: any, viewerConfig: DataViewerConfig, panelConfig: PanelConfig) => TemplateResult | undefined;- attributeViewProvider?: (attribute: Attribute<any>, viewerConfig: DataViewerConfig, panelConfig: PanelConfig) => TemplateResult | undefined;- panelViewProvider?: (attributes: Attribute<any>[], panelName: string, viewerConfig: DataViewerConfig, panelConfig: PanelConfig) => TemplateResult | undefined;- chartConfig?: OrChartConfig;-}--export class OrDataViewerRenderCompleteEvent extends CustomEvent<void> {-- public static readonly NAME = "or-data-viewer-render-complete-event";-- constructor() {- super(OrDataViewerRenderCompleteEvent.NAME, {- bubbles: true,- composed: true- });- }-}--export class OrDataViewerConfigInvalidEvent extends CustomEvent<void> {-- public static readonly NAME = "or-data-viewer-config-invalid-event";-- constructor() {- super(OrDataViewerConfigInvalidEvent.NAME, {- bubbles: true,- composed: true- });- }-}--declare global {- export interface HTMLElementEventMap {- [OrDataViewerRenderCompleteEvent.NAME]: OrDataViewerRenderCompleteEvent;- [OrDataViewerConfigInvalidEvent.NAME]: OrDataViewerConfigInvalidEvent;- }-}--@customElement("or-data-viewer")-export class OrDataViewer extends translate(i18next)(LitElement) {-- static get styles() {- return [- style- ];- }-- public static DEFAULT_PANEL_TYPE: PanelType = "chart";-- public static DEFAULT_CONFIG: DataViewerConfig = {- viewerStyles: {-- },- panels: {- chart: {- type: "chart",- hideOnMobile: true,- panelStyles: {- gridColumn: "1 / -1"- }- },- kpi1: {- type: "kpi",- hideOnMobile: false- },- kpi2: {- type: "kpi",- hideOnMobile: false- },- kpi3: {- type: "kpi",- hideOnMobile: false- },- kpi4: {- type: "kpi",- hideOnMobile: false- },- kpi5: {- type: "kpi",- hideOnMobile: false- },- kpi6: {- type: "kpi",- hideOnMobile: false- },- kpi7: {- type: "kpi",- hideOnMobile: false- },- kpi8: {- type: "kpi",- hideOnMobile: false- },- chart2: {- type: "chart",- hideOnMobile: true,- panelStyles: {- gridColumn: "1 / -1"- }- },- chart3: {- type: "chart",- hideOnMobile: true,- panelStyles: {- gridColumn: "1 / -1"- }- }- }- };-- public static generateGrid(shadowRoot: ShadowRoot | null) {- if (shadowRoot) {- const grid = shadowRoot.querySelector("#container");- if (grid) {- const rowHeight = parseInt(window.getComputedStyle(grid).getPropertyValue("grid-auto-rows"), 10);- const rowGap = parseInt(window.getComputedStyle(grid).getPropertyValue("grid-row-gap"), 10);- const items = shadowRoot.querySelectorAll(".panel");- if (items) {- items.forEach((item) => {- const content = item.querySelector(".panel-content-wrapper");- if (content) {- const rowSpan = Math.ceil((content.getBoundingClientRect().height + rowGap) / (rowHeight + rowGap));- (item as HTMLElement).style.gridRowEnd = "span " + rowSpan;- }- });- }- }- }- }-- @property()- public config?: DataViewerConfig;-- @property({type: Array, attribute: false})- protected _assets?: Asset[];-- @property()- protected _loading: boolean = false;-- @property()- public realm?: string;-- protected _resizeHandler = () => {- OrDataViewer.generateGrid(this.shadowRoot)- };-- constructor() {- super();- this.addEventListener(OrChartEvent.NAME, () => OrDataViewer.generateGrid(this.shadowRoot));- }-- connectedCallback() {- super.connectedCallback();- window.addEventListener("resize", this._resizeHandler);- }-- disconnectedCallback() {- super.disconnectedCallback();- window.removeEventListener("resize", this._resizeHandler);- }-- public refresh() {- this.realm = manager.displayRealm;- }-- public getPanel(name: string, panelConfig: PanelConfig): TemplateResult {-- const content = this.getPanelContent(name, panelConfig);-- if (!content) {- return html``;- }-- return html`- <div class=${classMap({panel: true, mobileHidden: panelConfig.hideOnMobile === true})} id="${name}-panel" style="${panelConfig && panelConfig.panelStyles ? styleMap(panelConfig.panelStyles) : ""}">- <div class="panel-content-wrapper">- ${(panelConfig && panelConfig.type === "chart") ? html`- <div class="panel-title">- <or-translate value="${name}"></or-translate>- </div>- ` : ``}-- <div class="panel-content">- ${content}- </div>- </div>- </div>- `;- }-- public getPanelContent(panelName: string, panelConfig: PanelConfig): TemplateResult | undefined {- if (panelConfig.hide || !this.config) {- return;- }-- this.realm = manager.displayRealm;-- let content: TemplateResult | undefined;-- if (panelConfig && panelConfig.type === "chart") {- content = html`<or-chart id="chart" panelName="${panelName}" .config="${this.config.chartConfig}" .realm="${this.realm}"></or-chart>`;- }-- if (panelConfig && panelConfig.type === "kpi") {- content = html`- <or-attribute-card panelName="${panelName}" .config="${this.config.chartConfig}" .realm="${this.realm}"></or-attribute-card>- `;- }- return content;- }-- protected render() {-- if (this._loading) {- return html`- <div class="msg"><or-translate value="loading"></or-translate></div>- `;- }-- if (!this.config) {- this.config = {...OrDataViewer.DEFAULT_CONFIG};- }-- return html`- <div id="wrapper">- <div id="container" style="${this.config.viewerStyles ? styleMap(this.config.viewerStyles) : ""}">- ${this.renderConfig()}- </div>- </div>- `;- }-- protected renderConfig(): TemplateResult[] {- const hasConfig = !!this.config;- let config = hasConfig ? this.config : OrDataViewer.DEFAULT_CONFIG;- try {- return Object.entries(config!.panels).map(([name, panelConfig]) => this.getPanel(name, panelConfig))- } catch (e) {- console.warn("OR data viewer config is invalid");- this.config = undefined;- this.dispatchEvent(new OrDataViewerConfigInvalidEvent());- config = OrDataViewer.DEFAULT_CONFIG;- return Object.entries(config!.panels).map(([name, panelConfig]) => this.getPanel(name, panelConfig))- }- }-- protected updated(_changedProperties: PropertyValues) {- super.updated(_changedProperties);-- if (_changedProperties.has("realm")) {- this.refresh();- }-- this.updateComplete.then(() => {- this.dispatchEvent(new OrDataViewerRenderCompleteEvent());- OrDataViewer.generateGrid(this.shadowRoot);- });- }-}diff --git a/ui/component/or-data-viewer/src/style.ts b/ui/component/or-data-viewer/src/style.tsdeleted file mode 100644index 4bfef011f..000000000--- a/ui/component/or-data-viewer/src/style.ts+++ /dev/null@@ -1,158 +0,0 @@-import {css, unsafeCSS} from "lit";-import {DefaultBoxShadow, DefaultColor1, DefaultColor2, DefaultColor3, DefaultColor5} from "@openremote/core";--// language=CSS-export const style = css`-- :host {- --internal-or-asset-viewer-background-color: var(--or-asset-viewer-background-color, var(--or-app-color2, ${unsafeCSS(DefaultColor2)}));- --internal-or-asset-viewer-panel-margin: var(--or-asset-viewer-panel-margin, 20px);- --internal-or-asset-viewer-panel-padding: var(--or-asset-viewer-panel-padding, 24px);- --internal-or-asset-viewer-text-color: var(--or-asset-viewer-text-color, var(--or-app-color3, ${unsafeCSS(DefaultColor3)}));- --internal-or-asset-viewer-title-text-color: var(--or-asset-viewer-title-text-color, var(--or-app-color3, ${unsafeCSS(DefaultColor3)}));- --internal-or-asset-viewer-panel-color: var(--or-asset-viewer-panel-color, var(--or-app-color1, ${unsafeCSS(DefaultColor1)}));- --internal-or-asset-viewer-line-color: var(--or-asset-viewer-line-color, var(--or-app-color5, ${unsafeCSS(DefaultColor5)}));-- height: 100%;- width: 100%;- background-color: var(--internal-or-asset-viewer-background-color);- }-- *[hidden] {- display: none;- }-- #container {- width: 100%;- box-sizing: border-box;- display: grid;- margin: auto;- padding: 20px 20px;- grid-gap: 10px;- grid-template-columns: repeat(auto-fill, minmax(calc(25% - 8px), 1fr));- grid-auto-rows: 5px;-- -webkit-animation: fadein 0.3s; /* Safari, Chrome and Opera > 12.1 */- -moz-animation: fadein 0.3s; /* Firefox < 16 */- -ms-animation: fadein 0.3s; /* Internet Explorer */- -o-animation: fadein 0.3s; /* Opera < 12.1 */- animation: fadein 0.3s;- }-- @keyframes fadein {- from { opacity: 0; }- to { opacity: 1; }- }-- /* Firefox < 16 */- @-moz-keyframes fadein {- from { opacity: 0; }- to { opacity: 1; }- }-- /* Safari, Chrome and Opera > 12.1 */- @-webkit-keyframes fadein {- from { opacity: 0; }- to { opacity: 1; }- }-- /* Internet Explorer */- @-ms-keyframes fadein {- from { opacity: 0; }- to { opacity: 1; }- }-- /* Opera < 12.1 */- @-o-keyframes fadein {- from { opacity: 0; }- to { opacity: 1; }- }-- .panel {- background-color: var(--internal-or-asset-viewer-panel-color);- border: 1px solid #e5e5e5;- border-radius: 5px;- max-width: 100%;- }-- .panel-content-wrapper {- padding: var(--internal-or-asset-viewer-panel-padding);- }-- .panel-content {- display: flex;- flex-wrap: wrap;- }-- .panel-title {- text-transform: uppercase;- font-weight: bolder;- line-height: 1em;- color: var(--internal-or-asset-viewer-title-text-color);- margin-bottom: 25px;- flex: 0 0 auto;- }-- .field {- margin: 10px 0;- width: 100%;- flex: 0 0 auto;- min-height: 50px;- }-- .field > * {- width: 100%;- box-sizing: border-box;- }-- .msg {- display: flex;- justify-content: center;- align-items: center;- text-align: center;- height: 100%;- }-- .back-navigation {- display: none;- cursor: pointer;- }-- @media screen and (max-width: 1024px) {- #container {- grid-template-columns: repeat(auto-fill, minmax(calc(50% - 8px), 1fr));- }- }-- @media screen and (max-width: 769px) {- .back-navigation {- display: block;- }-- .mobileHidden {- display: none;- }-- #container {- grid-auto-rows: auto;- }-- .panel {- border-radius: 0;- border-right: none;- border-left: none;- }-- #chart-panel {- grid-row-start: 1;- }--- #container {- grid-template-columns: 100% !important;- padding: 20px 0;- }--- }-`;\ No newline at end of filediff --git a/ui/component/or-data-viewer/tsconfig.json b/ui/component/or-data-viewer/tsconfig.jsondeleted file mode 100644index 17e43a395..000000000--- a/ui/component/or-data-viewer/tsconfig.json+++ /dev/null@@ -1,19 +0,0 @@-{- "extends": "../../tsconfig",- "compilerOptions": {- "outDir": "./lib",- "rootDir": "src"- },- "include": [- "./src"- ],- "references": [- { "path": "../core" },- { "path": "../rest" },- { "path": "../model" },- { "path": "../or-chart" },- { "path": "../or-components" },- { "path": "../or-translate" },- { "path": "../or-attribute-card" }- ]-}diff --git a/yarn.lock b/yarn.lockindex c83430028..e6b2548a9 100644--- a/yarn.lock+++ b/yarn.lock@@ -1766,7 +1766,6 @@ __metadata:"@openremote/or-attribute-picker": "workspace:*""@openremote/or-components": "workspace:*""@openremote/or-dashboard-builder": "workspace:*"- "@openremote/or-data-viewer": "workspace:*""@openremote/or-icon": "workspace:*""@openremote/or-json-forms": "workspace:*""@openremote/or-log-viewer": "workspace:*"@@ -2008,20 +2007,6 @@ __metadata:languageName: unknownlinkType: soft-"@openremote/or-data-viewer@workspace:*, @openremote/or-data-viewer@workspace:ui/component/or-data-viewer":- version: 0.0.0-use.local- resolution: "@openremote/or-data-viewer@workspace:ui/component/or-data-viewer"- dependencies:- "@openremote/core": "workspace:*"- "@openremote/model": "workspace:*"- "@openremote/or-attribute-card": "workspace:*"- "@openremote/or-chart": "workspace:*"- "@openremote/or-components": "workspace:*"- "@openremote/or-translate": "workspace:*"- lit: "npm:^3.3.1"- languageName: unknown- linkType: soft-"@openremote/or-gauge@workspace:*, @openremote/or-gauge@workspace:ui/component/or-gauge":version: 0.0.0-use.localresolution: "@openremote/or-gauge@workspace:ui/component/or-gauge"