Merge branch 'main' into compare

CHANGES.md

@@ -285,6 +285,7 @@ Change Log
 * Activates/deactivates terria timeline stack when the Timeline.jsx component mounts or unmounts.
 * Adds an `index` parameter to Workbench.add() method specifying the index where the item should be added 
 * [The next improvement]
+* Wraps tool title bar text using `...`.
 
 #### 8.0.0-alpha.84
 

lib/Models/Cesium.ts

@@ -67,7 +67,7 @@ import TerriaViewer from "../ViewModels/TerriaViewer";
 import CameraView from "./CameraView";
 import Feature from "./Feature";
 import GlobeOrMap from "./GlobeOrMap";
-import hasTraits from "./hasTraits";
+import hasTraits from "./Definition/hasTraits";
 import MapInteractionMode from "./MapInteractionMode";
 import Terria from "./Terria";
 import UserDrawing from "./UserDrawing";

lib/Models/Comparable.ts

@@ -1,16 +1,16 @@
 import CatalogMemberMixin from "../ModelMixins/CatalogMemberMixin";
 import MappableMixin from "../ModelMixins/MappableMixin";
-import CatalogMemberTraits from "../Traits/CatalogMemberTraits";
-import MappableTraits from "../Traits/MappableTraits";
-import SplitterTraits from "../Traits/SplitterTraits";
-import hasTraits from "./hasTraits";
-import Model from "./Model";
+import CatalogMemberTraits from "../Traits/TraitsClasses/CatalogMemberTraits";
+import MappableTraits from "../Traits/TraitsClasses/MappableTraits";
+import SplitterTraits from "../Traits/TraitsClasses/SplitterTraits";
+import hasTraits from "./Definition/hasTraits";
+import Model from "./Definition/Model";
 
 export type Comparable = Model<
   SplitterTraits & CatalogMemberTraits & MappableTraits
 > &
-  MappableMixin.MappableMixin &
-  CatalogMemberMixin.CatalogMemberMixin;
+  MappableMixin.Instance &
+  CatalogMemberMixin.Instance;
 
 /**
  * Returns true if the item is Comparable.
@@ -20,7 +20,6 @@ export function isComparableItem(item: any): item is Comparable {
     item &&
     MappableMixin.isMixedInto(item) &&
     CatalogMemberMixin.isMixedInto(item) &&
-    (item as any).supportsSplitting &&
     hasTraits(item, MappableTraits, "show") &&
     hasTraits(item, CatalogMemberTraits, "name") &&
     hasTraits(item, SplitterTraits, "splitDirection");

lib/Models/Terria.ts

@@ -274,7 +274,10 @@ interface ConfigParameters {
    */
   feedbackMinLength?: number;
 
-  useExperimentalCompareWorkflow?: boolean;
+  /**
+   * Extra links to show in the credit line at the bottom of the map (currently only the Cesium map).
+   */
+  extraCreditLinks?: { url: string; text: string }[];
 }
 
 interface StartOptions {
@@ -441,9 +444,16 @@ export default class Terria {
     customRequestSchedulerLimits: undefined,
     persistViewerMode: true,
     openAddData: false,
-    feedbackPreamble: "feedback.feedbackPreamble",
+    feedbackPreamble: "translate#feedback.feedbackPreamble",
     feedbackMinLength: 0,
-    useExperimentalCompareWorkflow: false
+    extraCreditLinks: [
+      // Default credit links (shown at the bottom of the Cesium map)
+      {
+        text: "map.extraCreditLinks.dataAttribution",
+        url: "about.html#data-attribution"
+      },
+      { text: "map.extraCreditLinks.disclaimer", url: "about.html#disclaimer" }
+    ]
   };
 
   @observable
@@ -532,6 +542,8 @@ export default class Terria {
    */
   @observable compareRightItemId?: string;
 
+  augmentedVirtuality?: any;
+
   readonly notificationState: NotificationState = new NotificationState();
 
   private readonly developmentEnv = process?.env?.NODE_ENV === "development";
@@ -1752,23 +1764,7 @@ async function interpretHash(
       if (["clean", "hideWelcomeMessage", "start", "share"].includes(property))
         return;
       const propertyValue = hashProperties[property];
-      if (property === "clean") {
-        terria.initSources.splice(0, terria.initSources.length);
-      } else if (property === "hideWelcomeMessage") {
-        terria.configParameters.showWelcomeMessage = false;
-      } else if (property === "start") {
-        try {
-          // a share link that hasn't been shortened: JSON embedded in URL (only works for small quantities of JSON)
-          const startData = JSON.parse(propertyValue);
-          interpretStartData(terria, startData, "Start data from hash");
-        } catch (e) {
-          throw TerriaError.from(e, {
-            message: { key: "parsingStartDataErrorMessage" }
-          });
-        }
-      } else if (property === "useExperimentalCompareWorkflow") {
-        terria.configParameters.useExperimentalCompareWorkflow = true;
-      } else if (defined(propertyValue) && propertyValue.length > 0) {
+      if (defined(propertyValue) && propertyValue.length > 0) {
         userProperties.set(property, propertyValue);
       } else {
         const initSourceFile = generateInitializationUrl(

lib/Models/Workbench.ts

@@ -168,33 +168,25 @@ export default class Workbench {
    *
    * @param item The item to add to or remove from the workbench.
    */
-  public async add(
-    item: BaseModel | BaseModel[],
-    index: number = 0
-  ): Promise<void> {
+  public async add(item: BaseModel | BaseModel[]): Promise<Result<unknown>> {
     if (Array.isArray(item)) {
-      await Promise.all(item.reverse().map(i => this.add(i, index)));
-      return;
+      const results = await Promise.all(item.reverse().map(i => this.add(i)));
+      return Result.combine(results, {
+        title: i18next.t("workbench.addItemErrorTitle"),
+        message: i18next.t("workbench.addItemErrorMessage"),
+        importance: -1
+      });
     }
 
-    try {
-      if (ReferenceMixin.is(item)) {
-        await item.loadReference();
+    this.insertItem(item);
+
+    let error: TerriaError | undefined;
 
-        const target = item.target;
-        if (
-          target &&
-          GroupMixin.isMixedInto(target) &&
-          !MappableMixin.isMixedInto(target) &&
-          !ChartableMixin.isMixedInto(target)
-        ) {
-          this.remove(item);
-        } else if (target) {
-          return this.add(target, index);
-        }
-      } else {
-        // Item is not a reference, so add the item
-        this.insertItem(item, index);
+    if (ReferenceMixin.isMixedInto(item)) {
+      error = (await item.loadReference()).error;
+      if (item.target) {
+        this.remove(item);
+        return this.add(item.target);
       }
     }
 

lib/Models/doesImageryFeatureBelongToCatalogItem.ts

@@ -1,6 +1,6 @@
 import MappableMixin, { ImageryParts } from "../ModelMixins/MappableMixin";
+import { BaseModel } from "./Definition/Model";
 import Feature from "./Feature";
-import { BaseModel } from "./Model";
 
 /**
  * Returns true if the given feature belongs to the catalog item

lib/ReactViews/Compare/Compare.tsx

@@ -6,23 +6,22 @@ import styled from "styled-components";
 import createGuid from "terriajs-cesium/Source/Core/createGuid";
 import ImagerySplitDirection from "terriajs-cesium/Source/Scene/ImagerySplitDirection";
 import filterOutUndefined from "../../Core/filterOutUndefined";
-import CommonStrata from "../../Models/CommonStrata";
+import SplitItemReference from "../../Models/Catalog/CatalogReferences/SplitItemReference";
 import { Comparable, isComparableItem } from "../../Models/Comparable";
-import hasTraits from "../../Models/hasTraits";
-import { BaseModel } from "../../Models/Model";
-import SplitItemReference from "../../Models/SplitItemReference";
+import CommonStrata from "../../Models/Definition/CommonStrata";
+import hasTraits from "../../Models/Definition/hasTraits";
+import { BaseModel } from "../../Models/Definition/Model";
 import Terria from "../../Models/Terria";
 import Workbench from "../../Models/Workbench";
 import ViewState from "../../ReactViewModels/ViewState";
 import { GLYPHS } from "../../Styled/Icon";
 import Text from "../../Styled/Text";
 import WorkflowPanel, { Box } from "../../Styled/WorkflowPanel";
-import CatalogMemberTraits from "../../Traits/CatalogMemberTraits";
-import MappableTraits from "../../Traits/MappableTraits";
-import SplitterTraits from "../../Traits/SplitterTraits";
-import Legend from "../Workbench/Controls/Legend";
+import CatalogMemberTraits from "../../Traits/TraitsClasses/CatalogMemberTraits";
+import MappableTraits from "../../Traits/TraitsClasses/MappableTraits";
+import SplitterTraits from "../../Traits/TraitsClasses/SplitterTraits";
+import CompareItemControls from "./CompareItemControls";
 import DatePicker from "./DatePicker";
-import DimensionSelectors from "./DimensionSelectors";
 import ItemList, { MappableCatalogItem } from "./ItemList";
 import ItemSelector from "./ItemSelector";
 import LocationDateFilter from "./LocationDateFilter";
@@ -182,8 +181,7 @@ const Compare: React.FC<PropsType> = observer(props => {
             }
             onChange={changeLeftItem}
           />
-          {leftItem && <DimensionSelectors item={leftItem} />}
-          {leftItem && <Legend item={leftItem} />}
+          {leftItem && <CompareItemControls item={leftItem} />}
         </Box>
         <Box icon={GLYPHS.rightSmall} title={t("compare.rightPanel")}>
           <ItemSelector
@@ -195,15 +193,9 @@ const Compare: React.FC<PropsType> = observer(props => {
             }
             onChange={changeRightItem}
           />
-          {rightItem && <DimensionSelectors item={rightItem} />}
-          {rightItem && <Legend item={rightItem} />}
+          {rightItem && <CompareItemControls item={rightItem} />}
         </Box>
-        <Box
-          icon={GLYPHS.bothPanels}
-          title={t("compare.bothPanels")}
-          collapsible
-          isCollapsed
-        >
+        <Box icon={GLYPHS.bothPanels} title={t("compare.bothPanels")}>
           <ItemList
             items={itemsInBothPanels}
             onChange={changeItemInBothPanels}
@@ -291,7 +283,7 @@ async function cloneItem(item: Comparable): Promise<string | undefined> {
   try {
     terria.addModel(ref);
     // Insert below the parent item in the workbench
-    await terria.workbench.add(ref, terria.workbench.indexOf(item) + 1);
+    await terria.workbench.add(ref /*terria.workbench.indexOf(item) + 1*/);
   } catch (e) {
     return undefined;
   }

lib/ReactViews/Compare/CompareItemControls.tsx

@@ -0,0 +1,25 @@
+import React from "react";
+import { Comparable } from "../../Models/Comparable";
+import SelectableDimensions, {
+  DEFAULT_PLACEMENT
+} from "../../Models/SelectableDimensions";
+import DimensionSelectorSection from "../Workbench/Controls/DimensionSelectorSection";
+import Legend from "../Workbench/Controls/Legend";
+import OpacitySection from "../Workbench/Controls/OpacitySection";
+
+const CompareItemControls: React.FC<{ item: Comparable }> = ({ item }) => {
+  return (
+    <>
+      <OpacitySection item={item} />
+      {SelectableDimensions.is(item) && (
+        <DimensionSelectorSection item={item} placement={DEFAULT_PLACEMENT} />
+      )}
+      <Legend item={item} />
+      {SelectableDimensions.is(item) && (
+        <DimensionSelectorSection item={item} placement={"belowLegend"} />
+      )}
+    </>
+  );
+};
+
+export default CompareItemControls;

lib/ReactViews/Compare/DatePicker.tsx

@@ -6,8 +6,8 @@ import { useTranslation } from "react-i18next";
 import styled, { DefaultTheme, ThemeProvider } from "styled-components";
 import JulianDate from "terriajs-cesium/Source/Core/JulianDate";
 import DiscretelyTimeVaryingMixin from "../../ModelMixins/DiscretelyTimeVaryingMixin";
-import CommonStrata from "../../Models/CommonStrata";
 import { Comparable } from "../../Models/Comparable";
+import CommonStrata from "../../Models/Definition/CommonStrata";
 import Button from "../../Styled/Button";
 import Icon, { StyledIcon } from "../../Styled/Icon";
 import { formatDateTime } from "../BottomDock/Timeline/DateFormats";
@@ -40,9 +40,7 @@ const DatePicker: React.FC<PropsType> = observer(props => {
   const [isPickerOpen, setIsPickerOpen] = useState(false);
 
   // Check if the item has dates, otherwise render nothing
-  const item:
-    | DiscretelyTimeVaryingMixin.DiscretelyTimeVaryingMixin
-    | undefined =
+  const item: DiscretelyTimeVaryingMixin.Instance | undefined =
     DiscretelyTimeVaryingMixin.isMixedInto(props.item) &&
     (props.item.discreteTimes?.length ?? 0) > 0
       ? props.item

lib/ReactViews/Compare/DimensionSelectors.tsx

@@ -1,8 +1,8 @@
 import { observer } from "mobx-react";
 import React from "react";
 import { useTranslation } from "react-i18next";
-import CommonStrata from "../../Models/CommonStrata";
 import { Comparable } from "../../Models/Comparable";
+import CommonStrata from "../../Models/Definition/CommonStrata";
 import SelectableDimensions, {
   SelectableDimension
 } from "../../Models/SelectableDimensions";

lib/ReactViews/Compare/ItemList.tsx

@@ -1,10 +1,11 @@
 import { observer } from "mobx-react";
 import React from "react";
 import styled from "styled-components";
-import Model from "../../Models/Model";
+import Model from "../../Models/Definition/Model";
 import Checkbox from "../../Styled/Checkbox/Checkbox";
-import CatalogMemberTraits from "../../Traits/CatalogMemberTraits";
-import MappableTraits from "../../Traits/MappableTraits";
+import CatalogMemberTraits from "../../Traits/TraitsClasses/CatalogMemberTraits";
+import MappableTraits from "../../Traits/TraitsClasses/MappableTraits";
+import Text from "../../Styled/Text";
 
 export type MappableCatalogItem = Model<MappableTraits & CatalogMemberTraits>;
 
@@ -20,10 +21,10 @@ const ItemList: React.FC<PropsType> = observer(({ items, onChange }) => {
         item =>
           item.uniqueId && (
             <li key={item.uniqueId}>
-              <Selector
-                item={item}
-                selected={item.show}
-                onChange={show => onChange(item, show)}
+              <Checkbox
+                isChecked={item.show}
+                onChange={ev => onChange(item, ev.target.checked)}
+                label={<SelectorText medium>{item.name}</SelectorText>}
               />
             </li>
           )
@@ -38,19 +39,6 @@ type SelectorProps = {
   onChange: (selected: boolean) => void;
 };
 
-const Selector: React.FC<SelectorProps> = observer(props => {
-  const { item, selected, onChange } = props;
-  return (
-    <Label>
-      <Checkbox
-        isChecked={selected}
-        onChange={ev => onChange(ev.target.checked)}
-      />
-      <div>{item.name}</div>
-    </Label>
-  );
-});
-
 const UList = styled.ul`
   list-style: none;
   padding: 0px;
@@ -59,6 +47,7 @@ const UList = styled.ul`
   > li {
     display: flex;
     align-items: center;
+    height: 32px;
   }
 `;
 
@@ -71,4 +60,8 @@ const Label = styled.label`
   }
 `;
 
+const SelectorText = styled(Text)`
+  margin-left: 10px;
+`;
+
 export default ItemList;

lib/ReactViews/Compare/LocationDateFilter.tsx

@@ -8,7 +8,7 @@ import { Comparable } from "../../Models/Comparable";
 import doesImageryFeatureBelongToItem from "../../Models/doesImageryFeatureBelongToCatalogItem";
 import Feature from "../../Models/Feature";
 import ViewState from "../../ReactViewModels/ViewState";
-import { TimeFilterCoordinates } from "../../Traits/TimeFilterTraits";
+import { TimeFilterCoordinates } from "../../Traits/TraitsClasses/TimeFilterTraits";
 import LocationPicker from "./LocationPicker";
 
 type PropsType = {