Skip to content
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.

Sign up for GitHub

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

Jump to bottom

"units" displayed instead of "unit" in the plot top legend and legend form #5540

Closed
2 of 7 tasks
nunoguedelha opened this issue Jul 20, 2022 · 3 comments · Fixed by #5546
Closed
2 of 7 tasks

"units" displayed instead of "unit" in the plot top legend and legend form #5540

nunoguedelha opened this issue Jul 20, 2022 · 3 comments · Fixed by #5546
Labels
type:bug
Milestone
Target:2.1.1

Comments

@nunoguedelha
Copy link
Contributor

Summary

The options "Show When Collapsed" and "Show When Expanded" in the Overlay Plot right pane form display "units" instead of "unit" (we disregard the case intentionally here), when just viewing as well as editing. Not a big deal, but this is not coherent with the choice of naming this field "unit" elsewhere (refer to #3562 ) and can lead to confusion.

image
image

Expected vs Current Behavior

The user should always see the same reference to this field: "unit", "Unit". More specifically, the config.legend field should be called "unit", as the existing field PlotSeries.metadata["<some-y-key>"].unit and the "unit" field of the Telemetry "range" values.

Steps to Reproduce

  1. Create an Overlay Plot and drag in a telemetry entry.
  2. Still in editing mode, on the right pane, scroll down to the LEGEND form and observe the options "When Collapsed Show" and "When Expanded Show".
  3. Click "Save and finish editing", this switches the vue to view mode.
  4. Observe the options "Show When Collapsed" and "Show When Expanded".

Environment

`npx envinfo --system --browsers --npmPackages --binaries --markdown` command output

System:

  • OS: macOS 10.15.7
  • CPU: (16) x64 Intel(R) Core(TM) i9-9980HK CPU @ 2.40GHz
  • Memory: 21.07 GB / 64.00 GB
  • Shell: 3.2.57 - /bin/bash

Binaries:

  • Node: 14.19.1 - ~/.nvm/versions/node/v14.19.1/bin/node
  • npm: 6.14.16 - ~/.nvm/versions/node/v14.19.1/bin/npm

Browsers:

  • Chrome: 103.0.5060.134
  • Firefox: 99.0.1
  • Safari: 15.5

npmPackages:

  • @babel/eslint-parser: 7.18.2 => 7.18.2
  • @braintree/sanitize-url: 6.0.0 => 6.0.0
  • @percy/cli: 1.2.1 => 1.2.1
  • @percy/playwright: 1.0.4 => 1.0.4
  • @playwright/test: 1.23.0 => 1.23.0
  • @types/eventemitter3: ^1.0.0 => 1.2.0
  • @types/jasmine: ^4.0.1 => 4.0.3
  • @types/karma: ^6.3.2 => 6.3.3
  • @types/lodash: ^4.14.178 => 4.14.182
  • @types/mocha: ^9.1.0 => 9.1.1
  • ajv: ^6.9.1 => 6.12.6
  • babel-loader: 8.2.5 => 8.2.5
  • babel-plugin-istanbul: 6.1.1 => 6.1.1
  • codecov: 3.8.3 => 3.8.3
  • comma-separated-values: 3.6.4 => 3.6.4
  • copy-webpack-plugin: 11.0.0 => 11.0.0
  • cross-env: 7.0.3 => 7.0.3
  • css-loader: 4.0.0 => 4.0.0
  • d3-axis: 3.0.0 => 3.0.0
  • d3-scale: 3.3.0 => 3.3.0
  • d3-selection: 3.0.0 => 3.0.0
  • eslint: 8.18.0 => 8.18.0
  • eslint-plugin-compat: 4.0.2 => 4.0.2
  • eslint-plugin-playwright: 0.9.0 => 0.9.0
  • eslint-plugin-vue: 9.1.1 => 9.1.1
  • eslint-plugin-you-dont-need-lodash-underscore: 6.12.0 => 6.12.0
  • eventemitter3: 1.2.0 => 1.2.0
  • express: 4.18.1 => 4.18.1
  • file-saver: 2.0.5 => 2.0.5
  • git-rev-sync: 3.0.2 => 3.0.2
  • html2canvas: 1.4.1 => 1.4.1
  • imports-loader: 0.8.0 => 0.8.0
  • jasmine-core: 4.2.0 => 4.2.0
  • jsdoc: 3.5.5 => 3.5.5
  • karma: 6.3.20 => 6.3.20
  • karma-chrome-launcher: 3.1.1 => 3.1.1
  • karma-cli: 2.0.0 => 2.0.0
  • karma-coverage: 2.2.0 => 2.2.0
  • karma-coverage-istanbul-reporter: 3.0.3 => 3.0.3
  • karma-firefox-launcher: 2.1.2 => 2.1.2
  • karma-jasmine: 5.1.0 => 5.1.0
  • karma-junit-reporter: 2.0.1 => 2.0.1
  • karma-sourcemap-loader: 0.3.8 => 0.3.8
  • karma-spec-reporter: 0.0.34 => 0.0.34
  • karma-webpack: 5.0.0 => 5.0.0
  • lighthouse: 9.6.1 => 9.6.1
  • location-bar: 3.0.1 => 3.0.1
  • lodash: 4.17.21 => 4.17.21
  • mini-css-extract-plugin: 2.6.1 => 2.6.1
  • moment: 2.29.4 => 2.29.4
  • moment-duration-format: 2.3.2 => 2.3.2
  • moment-timezone: 0.5.34 => 0.5.34
  • node-bourbon: 4.2.3 => 4.2.3
  • nyc: 15.1.0 => 15.1.0
  • painterro: 1.2.78 => 1.2.78
  • playwright: >=1 => 1.21.1
  • plotly.js-basic-dist: 2.12.0 => 2.12.0
  • plotly.js-gl2d-dist: 2.12.0 => 2.12.0
  • printj: 1.3.1 => 1.3.1
  • request: 2.88.2 => 2.88.2
  • resolve-url-loader: 5.0.0 => 5.0.0
  • sass: 1.52.2 => 1.52.2
  • sass-loader: 13.0.2 => 13.0.2
  • sinon: 14.0.0 => 14.0.0
  • style-loader: ^1.0.1 => 1.3.0
  • uuid: 8.3.2 => 8.3.2
  • vue: 2.6.14 => 2.6.14
  • vue-eslint-parser: 9.0.2 => 9.0.2
  • vue-loader: 15.9.8 => 15.9.8
  • vue-template-compiler: 2.6.14 => 2.6.14
  • webpack: 5.68.0 => 5.68.0
  • webpack-cli: 4.10.0 => 4.10.0
  • webpack-dev-middleware: 5.3.3 => 5.3.3
  • webpack-hot-middleware: 2.25.1 => 2.25.1
  • webpack-merge: 5.8.0 => 5.8.0
  • Open MCT Version: master branch, SHA 488cd82
  • Deployment Type: openmct connected to yarp.js telemetry server
  • OS: MacOS Catalina version 10.15.7
  • Browser: Chrome Version 103.0.5060.134

Impact Check List

  • Data loss or misrepresented data?
  • Regression? Did this used to work or has it always been broken?
  • Is there a workaround available?
  • Does this impact a critical component?
  • Is this just a visual bug with no functional impact?
  • Does this block the execution of e2e tests?
  • Does this have an impact on Performance?

Additional Information
nunoguedelha added a commit to ami-iit/openmct that referenced this issue Jul 21, 2022
@nunoguedelha
[Plot] Rename the units attribute to unit when referencing the te…
f231dbc 
…lemetry data "unit" within the legend and form handling (nasa#5540)
nunoguedelha added a commit to ami-iit/openmct that referenced this issue Jul 21, 2022
@nunoguedelha
[Plot] Rename the units attribute to unit (nasa#5540)
9e545f7 
Rename the `units` attribute to `unit` when referencing the telemetry
data "unit" within:
- the legend-form vue for setting the `valueToShowWhenCollapsed` and
  `showUnitsWhenExpanded` and displaying the available choices in write
  mode,
- the plot-options-browse vue for displaying the selected choices
  within the form in read mode,
- the plot-legend-item-collapsed when checking which field to display.
This was referenced Jul 21, 2022
Merged
Open
jvigliotta pushed a commit that referenced this issue Aug 23, 2022
@nunoguedelha
[CLA Approved] Fix references to telemetry data "unit" in the plot LE…
d73cb2e 
…GEND form, top legend display and documentation (#5546)

* [Plot] Rename the `units` attribute to `unit` (#5540)

Rename the `units` attribute to `unit` when referencing the telemetry
data "unit" within:
- the legend-form vue for setting the `valueToShowWhenCollapsed` and
  `showUnitsWhenExpanded` and displaying the available choices in write
  mode,
- the plot-options-browse vue for displaying the selected choices
  within the form in read mode,
- the plot-legend-item-collapsed when checking which field to display.

* [Documentation] Update API documentation (#3562)
@shefalijoshi shefalijoshi added this to the Target:2.1.1 milestone Sep 30, 2022
@khalidadil
Copy link
Contributor

Verified Fixed in Testathon on 09/30/22

@ozyx
Copy link
Member

ozyx commented Sep 30, 2022 •
edited

Verified 09/30/22 Testathon

@rukmini-bose
Copy link
Contributor

Verified Testathon 9/30/22

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type:bug
Projects
None yet
Milestone
Target:2.1.1
7 participants
@khalidadil @shefalijoshi @nunoguedelha @ozyx @jvigliotta @unlikelyzero @rukmini-bose