-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Ensure previews work for plots #7459
Changes from all commits
7e2c338
2da0002
0a99ee5
53f873f
95d3f5e
6c4ed35
235dc64
97ba153
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
/***************************************************************************** | ||
* Open MCT, Copyright (c) 2014-2024, United States Government | ||
* as represented by the Administrator of the National Aeronautics and Space | ||
* Administration. All rights reserved. | ||
* | ||
* Open MCT is licensed under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* http://www.apache.org/licenses/LICENSE-2.0. | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
* License for the specific language governing permissions and limitations | ||
* under the License. | ||
* | ||
* Open MCT includes source code licensed under additional open source | ||
* licenses. See the Open Source Licenses file (LICENSES.md) included with | ||
* this source code distribution or the Licensing information page available | ||
* at runtime from the About dialog for additional information. | ||
*****************************************************************************/ | ||
|
||
import { createDomainObjectWithDefaults } from '../../../../appActions.js'; | ||
import { expect, test } from '../../../../pluginFixtures.js'; | ||
|
||
test.describe('Plots work in Previews', () => { | ||
test('We can preview plot in display layouts', async ({ page, openmctConfig }) => { | ||
const { myItemsFolderName } = openmctConfig; | ||
await page.goto('./', { waitUntil: 'domcontentloaded' }); | ||
// Create a Sinewave Generator | ||
const sineWaveObject = await createDomainObjectWithDefaults(page, { | ||
type: 'Sine Wave Generator' | ||
}); | ||
// Create a Display Layout | ||
await createDomainObjectWithDefaults(page, { | ||
type: 'Display Layout', | ||
name: 'Test Display Layout' | ||
}); | ||
// Edit Display Layout | ||
await page.getByLabel('Edit Object').click(); | ||
|
||
// Expand the 'My Items' folder in the left tree | ||
await page.getByLabel(`Expand ${myItemsFolderName} folder`).click(); | ||
// Add the Sine Wave Generator to the Display Layout and save changes | ||
const treePane = page.getByRole('tree', { | ||
name: 'Main Tree' | ||
}); | ||
const sineWaveGeneratorTreeItem = treePane.getByRole('treeitem', { | ||
name: new RegExp(sineWaveObject.name) | ||
}); | ||
const layoutGridHolder = page.getByLabel('Test Display Layout Layout Grid'); | ||
await sineWaveGeneratorTreeItem.dragTo(layoutGridHolder); | ||
await page.getByLabel('Save').click(); | ||
await page.getByRole('listitem', { name: 'Save and Finish Editing' }).click(); | ||
|
||
// right click on the plot and select view large | ||
await page.getByLabel('Sine', { exact: true }).click({ button: 'right' }); | ||
await page.getByLabel('View Historical Data').click(); | ||
await expect(page.getByLabel('Preview Container').getByLabel('Plot Canvas')).toBeVisible(); | ||
await page.getByLabel('Close').click(); | ||
await page.getByLabel('Expand Test Display Layout layout').click(); | ||
|
||
// change to a plot and ensure embiggen works | ||
await page.getByLabel('Edit Object').click(); | ||
await page.getByLabel('Move Sub-object Frame').click(); | ||
await page.getByText('View type').click(); | ||
await page.getByText('Overlay Plot').click(); | ||
await page.getByLabel('Save').click(); | ||
await page.getByRole('listitem', { name: 'Save and Finish Editing' }).click(); | ||
await expect( | ||
page.getByLabel('Test Display Layout Layout', { exact: true }).getByLabel('Plot Canvas') | ||
).toBeVisible(); | ||
await expect(page.getByLabel('Preview Container')).toBeHidden(); | ||
await page.getByLabel('Large View').click(); | ||
await expect(page.getByLabel('Preview Container').getByLabel('Plot Canvas')).toBeVisible(); | ||
await page.getByLabel('Close').click(); | ||
|
||
// get last sinewave tree item (in the display layout) | ||
await page | ||
.getByRole('treeitem', { name: /Sine Wave Generator/ }) | ||
.locator('a') | ||
.last() | ||
.click({ button: 'right' }); | ||
await page.getByLabel('View', { exact: true }).click(); | ||
await expect(page.getByLabel('Preview Container').getByLabel('Plot Canvas')).toBeVisible(); | ||
await page.getByLabel('Close').click(); | ||
}); | ||
}); |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,8 +22,20 @@ | |
|
||
<template> | ||
<div ref="chart" class="gl-plot-chart-area"> | ||
<canvas id="2dContext" :style="canvasStyle" class="js-overlay-canvas" role="img"></canvas> | ||
<canvas id="webglContext" :style="canvasStyle" class="js-main-canvas" role="img"></canvas> | ||
<canvas | ||
id="2dContext" | ||
:style="canvasStyle" | ||
class="js-overlay-canvas" | ||
role="img" | ||
aria-label="Overlay Canvas" | ||
></canvas> | ||
<canvas | ||
id="webglContext" | ||
:style="canvasStyle" | ||
class="js-main-canvas" | ||
role="img" | ||
aria-label="Plot Canvas" | ||
></canvas> | ||
<div ref="limitArea" class="js-limit-area" aria-hidden="true"> | ||
<limit-label | ||
v-for="(limitLabel, index) in visibleLimitLabels" | ||
|
@@ -202,9 +214,7 @@ | |
this.drawnOnce = false; | ||
const rootContainer = this.openmct.element; | ||
const options = { | ||
root: rootContainer, | ||
rootMargin: '0px', | ||
threshold: 1.0 | ||
root: rootContainer | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we need defaults here (specifically the |
||
}; | ||
this.visibilityObserver = new IntersectionObserver(this.visibilityChanged, options); | ||
eventHelpers.extend(this); | ||
|
@@ -286,20 +296,25 @@ | |
// and we need to use the Open MCT root element as the root of the intersection observer. | ||
if (entry.target === this.chartContainer) { | ||
const wasVisible = this.chartVisible; | ||
this.chartVisible = entry.isIntersecting; | ||
if (!this.chartVisible) { | ||
// destroy the chart | ||
const isNowVisible = entry.isIntersecting; | ||
const chartInOverlayWindow = this.chartContainer?.closest('.js-overlay') !== null; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. intersection observers in previews behave badly as the overlay covers our root element! try to detect that we're in one. |
||
|
||
if (!isNowVisible && !chartInOverlayWindow) { | ||
this.chartVisible = false; | ||
this.destroyCanvas(); | ||
} else if (!wasVisible && this.chartVisible) { | ||
} else if (!isNowVisible && chartInOverlayWindow) { | ||
this.chartVisible = true; | ||
} else if (!wasVisible && isNowVisible) { | ||
this.chartVisible = true; | ||
// rebuild the chart | ||
this.buildCanvasElements(); | ||
const canvasInitialized = this.readyCanvasForDrawing(); | ||
if (canvasInitialized) { | ||
this.draw(); | ||
} | ||
this.$emit('plot-reinitialize-canvas'); | ||
} else if (wasVisible && this.chartVisible) { | ||
// ignore, moving on | ||
} else { | ||
this.chartVisible = isNowVisible; | ||
} | ||
} | ||
}, | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -69,20 +69,23 @@ | |
} | ||
); | ||
|
||
let overlay = this._openmct.overlays.overlay({ | ||
const overlay = this._openmct.overlays.overlay({ | ||
element: vNode.el, | ||
size: 'large', | ||
autoHide: false, | ||
buttons: [ | ||
{ | ||
label: 'Done', | ||
callback: () => overlay.dismiss() | ||
callback: () => { | ||
overlay.dismiss(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. overlays were stacking up! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oooo nice catch |
||
} | ||
} | ||
], | ||
onDestroy: () => { | ||
PreviewAction.isVisible = false; | ||
destroy(); | ||
this.emit('isVisible', false); | ||
overlay.dismiss(); | ||
} | ||
}); | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,18 +43,24 @@ | |
this.isIntersecting = true; | ||
this.calledOnce = false; | ||
const options = { | ||
root: rootContainer, | ||
rootMargin: '0px', | ||
threshold: 1.0 | ||
root: rootContainer | ||
}; | ||
this.#observer = new IntersectionObserver(this.#observerCallback, options); | ||
this.lastUnfiredFunc = null; | ||
this.renderWhenVisible = this.renderWhenVisible.bind(this); | ||
} | ||
|
||
#inOverlay() { | ||
return this.#element.closest('.js-overlay') !== null; | ||
} | ||
|
||
#observerCallback = ([entry]) => { | ||
if (entry.target === this.#element) { | ||
this.isIntersecting = entry.isIntersecting; | ||
if (this.#inOverlay() && !entry.isIntersecting) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same issue as |
||
this.isIntersecting = true; | ||
} else { | ||
this.isIntersecting = entry.isIntersecting; | ||
} | ||
if (this.isIntersecting && this.lastUnfiredFunc) { | ||
window.requestAnimationFrame(this.lastUnfiredFunc); | ||
this.lastUnfiredFunc = null; | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
overlays were stacking up!