openmct/src/plugins/plot/stackedPlot/StackedPlotItem.vue

<!--
 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.
-->
<template>
  <div :aria-label="`Stacked Plot Item ${childObject.name}`">
    <Plot
      ref="plotComponent"
      :hide-legend="hideLegend"
      :limit-line-labels="showLimitLineLabels"
      :grid-lines="gridLines"
      :cursor-guide="cursorGuide"
      :options="options"
      :color-palette="colorPalette"
      :class="isStale && 'is-stale'"
      @config-loaded="onConfigLoaded"
      @lock-highlight-point="onLockHighlightPointUpdated"
      @highlights="onHighlightsUpdated"
      @cursor-guide="onCursorGuideChange"
      @grid-lines="onGridLinesChange"
    />
  </div>
</template>
<script>
import configStore from '@/plugins/plot/configuration/ConfigStore';
import PlotConfigurationModel from '@/plugins/plot/configuration/PlotConfigurationModel';
import stalenessMixin from '@/ui/mixins/staleness-mixin';

import Plot from '../PlotView.vue';
import conditionalStylesMixin from './mixins/objectStyles-mixin.js';

export default {
  components: {
    Plot
  },
  mixins: [conditionalStylesMixin, stalenessMixin],
  inject: ['openmct', 'domainObject', 'objectPath', 'renderWhenVisible'],
  provide() {
    return {
      openmct: this.openmct,
      domainObject: this.childObject
    };
  },
  props: {
    childObject: {
      type: Object,
      default() {
        return {};
      }
    },
    options: {
      type: Object,
      default() {
        return {};
      }
    },
    gridLines: {
      type: Boolean,
      default() {
        return true;
      }
    },
    cursorGuide: {
      type: Boolean,
      default() {
        return true;
      }
    },
    showLimitLineLabels: {
      type: Object,
      default() {
        return undefined;
      }
    },
    colorPalette: {
      type: Object,
      default() {
        return undefined;
      }
    },
    hideLegend: {
      type: Boolean,
      default() {
        return false;
      }
    }
  },
  emits: [
    'lock-highlight-point',
    'highlights',
    'config-loaded',
    'cursor-guide',
    'grid-lines',
    'plot-y-tick-width'
  ],
  beforeMount() {
    // We must do this before mounted to use any series configuration options set at the stacked plot level
    this.updateView();
  },
  mounted() {
    this.isEditing = this.openmct.editor.isEditing();
    this.openmct.editor.on('isEditing', this.setEditState);
    this.setupClockChangedEvent((domainObject) => {
      this.triggerUnsubscribeFromStaleness(domainObject);
      this.subscribeToStaleness(domainObject);
    });
  },
  beforeUnmount() {
    this.openmct.editor.off('isEditing', this.setEditState);
    if (this.composition) {
      this.composition.off('add', this.subscribeToStaleness);
      this.composition.off('remove', this.removeSubscription);
    }

    if (this.removeSelectable) {
      this.removeSelectable();
    }

    const configId = this.openmct.objects.makeKeyString(this.childObject.identifier);
    configStore.deleteStore(configId);

    if (this._destroy) {
      this._destroy();
    }
  },
  methods: {
    setEditState(isEditing) {
      this.isEditing = isEditing;

      if (this.isEditing) {
        this.setSelection();
      } else {
        if (this.removeSelectable) {
          this.removeSelectable();
        }
      }
    },
    removeSubscription(identifier) {
      this.triggerUnsubscribeFromStaleness({
        identifier
      });
    },
    updateView() {
      //If this object is not persistable, then package it with it's parent
      const plotObject = this.getPlotObject();

      if (plotObject === null) {
        return;
      }

      if (this.openmct.telemetry.isTelemetryObject(plotObject)) {
        this.subscribeToStaleness(plotObject);
      } else {
        // possibly overlay or other composition based plot
        this.composition = this.openmct.composition.get(plotObject);

        this.composition.on('add', this.subscribeToStaleness);
        this.composition.on('remove', this.removeSubscription);
        this.composition.load();
      }

      if (this.isEditing) {
        this.setSelection();
      }
    },
    onLockHighlightPointUpdated() {
      this.$emit('lock-highlight-point', ...arguments);
    },
    onHighlightsUpdated() {
      this.$emit('highlights', ...arguments);
    },
    onConfigLoaded() {
      this.$emit('config-loaded', ...arguments);
    },
    onCursorGuideChange() {
      this.$emit('cursor-guide', ...arguments);
    },
    onGridLinesChange() {
      this.$emit('grid-lines', ...arguments);
    },
    setSelection() {
      let childContext = {};
      childContext.item = this.childObject;
      this.context = childContext;
      if (this.removeSelectable) {
        this.removeSelectable();
      }

      this.removeSelectable = this.openmct.selection.selectable(this.$el, this.context);
    },
    getPlotObject() {
      this.checkPlotConfiguration();
      return this.childObject;
    },
    checkPlotConfiguration() {
      // If the object has its own configuration (like an overlay plot), don't initialize a stacked plot configuration
      // and instead use its configuration directly.
      // Otherwise ensure we've got a stacked plot item configuration ready for us.
      if (
        !this.openmct.objects.isMissing(this.childObject) &&
        !this.childObject.configuration?.series
      ) {
        this.ensureStackedSeriesConfigInitialization();
      }
    },
    ensureStackedSeriesConfigInitialization() {
      const configId = this.openmct.objects.makeKeyString(this.childObject.identifier);
      const existingConfig = configStore.get(configId);
      if (!existingConfig) {
        let persistedSeriesConfig = this.domainObject.configuration.series.find((seriesConfig) => {
          return this.openmct.objects.areIdsEqual(
            seriesConfig.identifier,
            this.childObject.identifier
          );
        });

        if (!persistedSeriesConfig) {
          persistedSeriesConfig = {
            series: {},
            yAxis: {}
          };
        }

        const newConfig = new PlotConfigurationModel({
          id: configId,
          domainObject: {
            ...this.childObject,
            configuration: {
              ...this.childObject.configuration,
              series: [
                {
                  identifier: this.childObject.identifier,
                  ...persistedSeriesConfig.series
                }
              ],
              yAxis: persistedSeriesConfig.yAxis,
              ...this.childObject.configuration
            }
          },
          openmct: this.openmct,
          palette: this.colorPalette,
          callback: (data) => {
            this.data = data;
          }
        });
        configStore.add(configId, newConfig);
      }
    }
  }
};
</script>