Landmark -> Story Segment

Author: gjmooney

examples/story_map.jGIS

@@ -57,7 +57,7 @@
         },
         "zoom": 14.080181481426658
       },
-      "type": "LandmarkLayer",
+      "type": "StorySegmentLayer",
       "visible": true
     },
     "8591b32f-11c0-4d70-a997-e94d258bb100": {
@@ -80,7 +80,7 @@
         },
         "zoom": 15.368058180489786
       },
-      "type": "LandmarkLayer",
+      "type": "StorySegmentLayer",
       "visible": true
     },
     "93080edc-815f-4364-a874-90fd53a60c35": {
@@ -127,18 +127,18 @@
         },
         "zoom": 15.230368389488868
       },
-      "type": "LandmarkLayer",
+      "type": "StorySegmentLayer",
       "visible": true
     }
   },
   "metadata": {},
   "options": {
     "bearing": 0.0,
     "extent": [
-      255874.06496440643,
-      6248688.604308756,
-      260496.085575599,
-      6252093.017728101
+      256226.31587442243,
+      6249293.335639824,
+      260143.83466558298,
+      6251488.286397033
     ],
     "latitude": 48.855574302496535,
     "longitude": 2.319315992465925,
@@ -200,31 +200,8 @@
   },
   "stories": {
     "1b181980-a95a-4f23-8e5d-980c66ff93ea": {
-      "landmarks": [
-        "5f790e80-230b-4c00-8426-b3a9385937a5",
-        "8591b32f-11c0-4d70-a997-e94d258bb100",
-        "bcd22241-e404-44b4-873b-81e6a4ccad84"
-      ],
       "storyType": "guided",
       "title": "Famous Statues"
-    },
-    "3ee5537b-0cf6-4a23-b373-3d5c9cc29893": {
-      "landmarks": [
-        "5f790e80-230b-4c00-8426-b3a9385937a5",
-        "8591b32f-11c0-4d70-a997-e94d258bb100",
-        "bcd22241-e404-44b4-873b-81e6a4ccad84"
-      ],
-      "storyType": "guided",
-      "title": "New Story"
-    },
-    "a7522918-43ea-490b-a4f2-cdcfb33a13e3": {
-      "landmarks": [
-        "5f790e80-230b-4c00-8426-b3a9385937a5",
-        "8591b32f-11c0-4d70-a997-e94d258bb100",
-        "bcd22241-e404-44b4-873b-81e6a4ccad84"
-      ],
-      "storyType": "guided",
-      "title": "New Story"
     }
   }
-}
+}

packages/base/src/commands/BaseCommandIDs.ts

@@ -67,4 +67,4 @@ export const showAnnotationsTab = 'jupytergis:showAnnotationsTab';
 export const showIdentifyPanelTab = 'jupytergis:showIdentifyPanelTab';
 
 // Story maps
-export const addLandmark = 'jupytergis:addLandmark';
+export const addStorySegment = 'jupytergis:addStorySegment';

packages/base/src/commands/index.ts

@@ -1054,7 +1054,7 @@ export function addCommands(
     ...icons.get(CommandIDs.addMarker),
   });
 
-  commands.addCommand(CommandIDs.addLandmark, {
+  commands.addCommand(CommandIDs.addStorySegment, {
     label: trans.__('Add Story Segment'),
     isEnabled: () => {
       return tracker.currentWidget
@@ -1068,7 +1068,7 @@ export function addCommands(
       }
       current.model.addStorySegment();
     },
-    ...icons.get(CommandIDs.addLandmark),
+    ...icons.get(CommandIDs.addStorySegment),
   });
 
   loadKeybindings(commands, keybindings);

packages/base/src/constants.ts

@@ -58,7 +58,7 @@ const iconObject = {
   [CommandIDs.identify]: { icon: infoIcon },
   [CommandIDs.temporalController]: { icon: clockIcon },
   [CommandIDs.addMarker]: { icon: markerIcon },
-  [CommandIDs.addLandmark]: { iconClass: 'fa fa-link' },
+  [CommandIDs.addStorySegment]: { iconClass: 'fa fa-link' },
 };
 
 /**

packages/base/src/formbuilder/formselectors.ts

@@ -3,7 +3,7 @@ import { LayerType, SourceType } from '@jupytergis/schema';
 import {
   HeatmapLayerPropertiesForm,
   HillshadeLayerPropertiesForm,
-  LandmarkLayerPropertiesForm,
+  StorySegmentLayerPropertiesForm,
   LayerPropertiesForm,
   VectorLayerPropertiesForm,
   WebGlLayerPropertiesForm,
@@ -35,8 +35,8 @@ export function getLayerTypeForm(
     case 'HeatmapLayer':
       LayerForm = HeatmapLayerPropertiesForm;
       break;
-    case 'LandmarkLayer':
-      LayerForm = LandmarkLayerPropertiesForm;
+    case 'StorySegmentLayer':
+      LayerForm = StorySegmentLayerPropertiesForm;
       break;
 
     // ADD MORE FORM TYPES HERE

packages/base/src/formbuilder/objectform/StoryEditorForm.tsx

@@ -12,6 +12,6 @@ export class StoryEditorPropertiesForm extends BaseForm {
     uiSchema: IDict,
   ) {
     super.processSchema(data, schema, uiSchema);
-    this.removeFormEntry('landmarks', data, schema, uiSchema);
+    this.removeFormEntry('storySegments', data, schema, uiSchema);
   }
 }

…/objectform/components/LandmarkReset.tsx …ectform/components/StorySegmentReset.tsxpackages/base/src/formbuilder/objectform/components/LandmarkReset.tsx renamed to packages/base/src/formbuilder/objectform/components/StorySegmentReset.tsx packages/base/src/formbuilder/objectform/components/LandmarkReset.tsx renamed to packages/base/src/formbuilder/objectform/components/StorySegmentReset.tsx

@@ -5,13 +5,13 @@ import React from 'react';
 import { targetWithCenterIcon } from '@/src/icons';
 import { Button } from '@/src/shared/components/Button';
 
-interface ILandmarkResetProps {
+interface IStorySegmentResetProps {
   model?: IJupyterGISModel;
   layerId?: string;
 }
 
-function LandmarkReset({ model, layerId }: ILandmarkResetProps) {
-  const handleSetLandmarkToCurrentView = () => {
+function StorySegmentReset({ model, layerId }: IStorySegmentResetProps) {
+  const handleSetStorySegmentToCurrentView = () => {
     if (!model || !layerId) {
       return;
     }
@@ -35,18 +35,18 @@ function LandmarkReset({ model, layerId }: ILandmarkResetProps) {
   return (
     <div>
       <Button
-        title="Set landmark to current viewport"
-        onClick={handleSetLandmarkToCurrentView}
+        title="Set story segment to current viewport"
+        onClick={handleSetStorySegmentToCurrentView}
       >
         <LabIcon.resolveReact
           icon={targetWithCenterIcon}
           className="jp-gis-layerIcon"
           tag="span"
         />
-        Set Landmark Extent
+        Set Story Segment Extent
       </Button>
     </div>
   );
 }
 
-export default LandmarkReset;
+export default StorySegmentReset;

packages/base/src/formbuilder/objectform/layer/index.ts

@@ -3,4 +3,4 @@ export * from './hillshadeLayerForm';
 export * from './layerform';
 export * from './vectorlayerform';
 export * from './webGlLayerForm';
-export * from './landmarkLayerForm';
+export * from './storySegmentLayerForm';

…er/objectform/layer/landmarkLayerForm.ts …bjectform/layer/storySegmentLayerForm.tspackages/base/src/formbuilder/objectform/layer/landmarkLayerForm.ts renamed to packages/base/src/formbuilder/objectform/layer/storySegmentLayerForm.ts packages/base/src/formbuilder/objectform/layer/landmarkLayerForm.ts renamed to packages/base/src/formbuilder/objectform/layer/storySegmentLayerForm.ts

@@ -3,9 +3,9 @@ import { FieldProps } from '@rjsf/core';
 import * as React from 'react';
 
 import { LayerPropertiesForm } from './layerform';
-import LandmarkReset from '../components/LandmarkReset';
+import StorySegmentReset from '../components/StorySegmentReset';
 
-export class LandmarkLayerPropertiesForm extends LayerPropertiesForm {
+export class StorySegmentLayerPropertiesForm extends LayerPropertiesForm {
   protected processSchema(
     data: IDict<any> | undefined,
     schema: IDict,
@@ -20,20 +20,19 @@ export class LandmarkLayerPropertiesForm extends LayerPropertiesForm {
     let layerId: string | undefined = undefined;
     const selectedKeys = Object.keys(this.props.model.selected);
 
-    // Find the first selected landmark
-    // TODO ! we still need to handle selections better, like there should at least be a getFirstSelected
-    // ! just do that
+    // Find the first selected story segment
+    // ! TODO we still need to handle selections better, like there should at least be a getFirstSelected
     for (const key of selectedKeys) {
       const layer = this.props.model.getLayer(key);
-      if (layer && layer.type === 'LandmarkLayer') {
+      if (layer && layer.type === 'StorySegmentLayer') {
         layerId = key;
         break;
       }
     }
 
     uiSchema['extent'] = {
       'ui:field': (props: FieldProps) =>
-        React.createElement(LandmarkReset, {
+        React.createElement(StorySegmentReset, {
           ...props,
           model: this.props.model,
           layerId,

packages/base/src/mainview/mainView.tsx

@@ -33,7 +33,7 @@ import {
   JgisCoordinates,
   JupyterGISModel,
   IMarkerSource,
-  ILandmarkLayer,
+  IStorySegmentLayer,
 } from '@jupytergis/schema';
 import { showErrorMessage } from '@jupyterlab/apputils';
 import { IObservableMap, ObservableMap } from '@jupyterlab/observables';
@@ -998,7 +998,7 @@ export class MainView extends React.Component<IProps, IStates> {
     let source: IJGISSource | undefined;
 
     // Sourceless layers
-    if (!['StacLayer', 'LandmarkLayer'].includes(layer.type)) {
+    if (!['StacLayer', 'StorySegmentLayer'].includes(layer.type)) {
       sourceId = layer.parameters?.source;
       if (!sourceId) {
         return;
@@ -1123,7 +1123,7 @@ export class MainView extends React.Component<IProps, IStates> {
         break;
       }
 
-      case 'LandmarkLayer': {
+      case 'StorySegmentLayer': {
         // Special layer not for this
         return;
       }
@@ -1348,7 +1348,7 @@ export class MainView extends React.Component<IProps, IStates> {
     mapLayer: Layer,
     oldLayer?: IDict,
   ): Promise<void> {
-    layer.type !== 'LandmarkLayer' && mapLayer.setVisible(layer.visible);
+    layer.type !== 'StorySegmentLayer' && mapLayer.setVisible(layer.visible);
 
     switch (layer.type) {
       case 'RasterLayer': {
@@ -2045,11 +2045,11 @@ export class MainView extends React.Component<IProps, IStates> {
     const layer = this.getLayer(id);
     const source = layer?.getSource();
 
-    // TODO: Landmark layers don't have an associated OL layer
+    // TODO: Story segment layers don't have an associated OL layer
     // This could be better
     if (!layer) {
       const jgisLayer = this._model.getLayer(id);
-      const layerParams = jgisLayer?.parameters as ILandmarkLayer;
+      const layerParams = jgisLayer?.parameters as IStorySegmentLayer;
       const coords = getCenter(layerParams.extent);
 
       // TODO: Should pass args through signal??