docs: fix viewer ctor examples with v3.0 api

mapillary · Jan 13, 2021 · 6967d16 · 6967d16
1 parent c1f38e6
commit 6967d16
Show file tree

Hide file tree

Showing 16 changed files with 142 additions and 157 deletions.
diff --git a/src/component/interfaces/ICacheConfiguration.ts b/src/component/interfaces/ICacheConfiguration.ts
@@ -1,29 +1,30 @@
-import {IComponentConfiguration} from "../../Component";
+import { IComponentConfiguration } from "../../Component";
 
 /**
  * Interface for configuration of cache depth.
  *
  * @interface
  * @example
  * ```
- * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
- *     {
- *         component: {
- *             cache: {
- *                 depth: {
- *                     pano: 2,
- *                     sequence: 3,
- *                 }
- *             },
+ * var viewer = new Mapillary.Viewer({
+ *     ...
+ *     component: {
+ *         cache: {
+ *             depth: {
+ *                 pano: 2,
+ *                 sequence: 3,
+ *             }
  *         },
- *     })
+ *     },
+ *     ...
+ * });
  * ```
  */
 export interface ICacheDepth {
     /**
      * Cache depth in the sequence directions.
      *
-     * @description Max value is 4. Value will be coerced
+     * @description Max value is 4. Value will be clamped
      * to the interval [0, 4].
      * @default 2
      */
@@ -32,7 +33,7 @@ export interface ICacheDepth {
     /**
      * Cache depth in the pano direction.
      *
-     * @description Max value is 2. Value will be coerced
+     * @description Max value is 2. Value will be clamped
      * to the interval [0, 2].
      * @default 1
      */
@@ -41,7 +42,7 @@ export interface ICacheDepth {
     /**
      * Cache depth in the step directions.
      *
-     * @description Max value is 3. Value will be coerced
+     * @description Max value is 3. Value will be clamped
      * to the interval [0, 3].
      * @default 1
      */
@@ -50,7 +51,7 @@ export interface ICacheDepth {
     /**
      * Cache depth in the turn directions.
      *
-     * @description Max value is 1. Value will be coerced
+     * @description Max value is 1. Value will be clamped
      * to the interval [0, 1].
      * @default 0
      */

diff --git a/src/component/interfaces/IDirectionConfiguration.ts b/src/component/interfaces/IDirectionConfiguration.ts
@@ -1,20 +1,21 @@
-import {IComponentConfiguration} from "../../Component";
+import { IComponentConfiguration } from "../../Component";
 
 /**
  * Interface for configuration of direction component.
  *
  * @interface
  * @example
  * ```
- * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
- *     {
- *         component: {
- *             direction: {
- *                 minWidth: 140,
- *                 maxWidth: 340,
- *             },
+ * var viewer = new Mapillary.Viewer({
+ *     ...
+ *     component: {
+ *         direction: {
+ *             minWidth: 140,
+ *             maxWidth: 340,
  *         },
- *     })
+ *     },
+ *     ...
+ * });
  * ```
  */
 export interface IDirectionConfiguration extends IComponentConfiguration {

diff --git a/src/component/interfaces/IKeyboardConfiguration.ts b/src/component/interfaces/IKeyboardConfiguration.ts
@@ -1,21 +1,22 @@
-import {IComponentConfiguration} from "../../Component";
+import { IComponentConfiguration } from "../../Component";
 
 /**
  * Interface for configuration of keyboard component.
  *
  * @interface
  * @example
  * ```
- * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
- *     {
- *         component: {
- *             keyboard: {
- *                 keyZoom: false,
- *                 keySequenceNavigation: false,
- *                 keySpatialNavigation: false,
- *             },
+ * var viewer = new Mapillary.Viewer({
+ *     ...
+ *     component: {
+ *         keyboard: {
+ *             keyZoom: false,
+ *             keySequenceNavigation: false,
+ *             keySpatialNavigation: false,
  *         },
- *     })
+ *     },
+ *     ...
+ * });
  * ```
  */
 export interface IKeyboardConfiguration extends IComponentConfiguration {

diff --git a/src/component/interfaces/IMarkerConfiguration.ts b/src/component/interfaces/IMarkerConfiguration.ts
@@ -1,19 +1,20 @@
-import {IComponentConfiguration} from "../../Component";
+import { IComponentConfiguration } from "../../Component";
 
 /**
  * Interface for configuration of marker component.
  *
  * @interface
  * @example
  * ```
- * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
- *     {
- *         component: {
- *             marker: {
- *                 visibleBBoxSize: 80,
- *             },
+ * var viewer = new Mapillary.Viewer({
+ *     ...
+ *     component: {
+ *         marker: {
+ *             visibleBBoxSize: 80,
  *         },
- *     })
+ *     },
+ *     ...
+ * });
  * ```
  */
 export interface IMarkerConfiguration extends IComponentConfiguration {

diff --git a/src/component/interfaces/IMouseConfiguration.ts b/src/component/interfaces/IMouseConfiguration.ts
@@ -1,22 +1,23 @@
-import {IComponentConfiguration} from "../../Component";
+import { IComponentConfiguration } from "../../Component";
 
 /**
  * Interface for configuration of mouse component.
  *
  * @interface
  * @example
  * ```
- * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
- *     {
- *         component: {
- *             mouse: {
- *                 doubleClickZoom: false,
- *                 dragPan: false,
- *                 scrollZoom: false,
- *                 touchZoom: false,
- *             },
+ * var viewer = new Mapillary.Viewer({
+ *     ...
+ *     component: {
+ *         mouse: {
+ *             doubleClickZoom: false,
+ *             dragPan: false,
+ *             scrollZoom: false,
+ *             touchZoom: false,
  *         },
- *     })
+ *     },
+ *     ...
+ * });
  * ```
  */
 export interface IMouseConfiguration extends IComponentConfiguration {

diff --git a/src/component/interfaces/INavigationConfiguration.ts b/src/component/interfaces/INavigationConfiguration.ts
@@ -1,19 +1,20 @@
-import {IComponentConfiguration} from "../../Component";
+import { IComponentConfiguration } from "../../Component";
 
 /**
  * Interface for configuration of navigation component.
  *
  * @interface
  *  @example
  * ```
- * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
- *     {
- *         component: {
- *             navigation: {
- *                 spatial: false,
- *             },
+ * var viewer = new Mapillary.Viewer({
+ *     ...
+ *     component: {
+ *         navigation: {
+ *             spatial: false,
  *         },
- *     })
+ *     },
+ *     ...
+ * });
  * ```
  */
 export interface INavigationConfiguration extends IComponentConfiguration {

diff --git a/src/component/interfaces/ISequenceConfiguration.ts b/src/component/interfaces/ISequenceConfiguration.ts
@@ -1,22 +1,23 @@
-import {IComponentConfiguration} from "../../Component";
-import {EdgeDirection} from "../../Edge";
+import { IComponentConfiguration } from "../../Component";
+import { EdgeDirection } from "../../Edge";
 
 /**
  * Interface for configuration of sequence component.
  *
  * @interface
  * @example
  * ```
- * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
- *     {
- *         component: {
- *             sequence: {
- *                 minWidth: 40,
- *                 maxWidth: 80,
- *                 visible: false,
- *             },
+ * var viewer = new Mapillary.Viewer({
+ *     ...
+ *     component: {
+ *         sequence: {
+ *             minWidth: 40,
+ *             maxWidth: 80,
+ *             visible: false,
  *         },
- *     })
+ *     },
+ *     ...
+ * });
  * ```
  */
 export interface ISequenceConfiguration extends IComponentConfiguration {

diff --git a/src/component/interfaces/ISliderConfiguration.ts b/src/component/interfaces/ISliderConfiguration.ts
@@ -1,4 +1,4 @@
-import {IComponentConfiguration} from "../../Component";
+import { IComponentConfiguration } from "../../Component";
 
 /**
  * Enumeration for slider mode.
@@ -59,19 +59,20 @@ export interface ISliderKeys {
  *
  * @interface
  * ```
- * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
- *     {
- *         component: {
- *             slider: {
- *                 initialPosition: 0.5,
- *                 keys: {
- *                     background: '<background-key>',
- *                     foreground: '<foreground-key>',
- *                 },
- *                 sliderVisible: true,
+ * var viewer = new Mapillary.Viewer({
+ *     ...
+ *     component: {
+ *         slider: {
+ *             initialPosition: 0.5,
+ *             keys: {
+ *                 background: '<background-key>',
+ *                 foreground: '<foreground-key>',
  *             },
+ *             sliderVisible: true,
  *         },
- *     })
+ *     },
+ *     ...
+ * });
  * ```
  */
 export interface ISliderConfiguration extends IComponentConfiguration {

diff --git a/src/component/interfaces/ITagConfiguration.ts b/src/component/interfaces/ITagConfiguration.ts
@@ -9,15 +9,16 @@ import {
  * @interface
  * @example
  * ```
- * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
- *     {
- *         component: {
- *             tag: {
- *                 createColor: 0xFF0000,
- *                 mode: Mapillary.TagComponent.TagMode.CreateRect,
- *             },
+ * var viewer = new Mapillary.Viewer({
+ *     ...
+ *     component: {
+ *         tag: {
+ *             createColor: 0xFF0000,
+ *             mode: Mapillary.TagComponent.TagMode.CreateRect,
  *         },
- *     })
+ *     },
+ *     ...
+ * });
  * ```
  */
 export interface ITagConfiguration extends IComponentConfiguration {

diff --git a/src/component/keyboard/KeyboardComponent.ts b/src/component/keyboard/KeyboardComponent.ts
@@ -1,4 +1,4 @@
-import {Subscription} from "rxjs";
+import { Subscription } from "rxjs";
 
 import {
     ComponentService,
@@ -27,10 +27,7 @@ import {
  *
  * @example
  * ```
- * var viewer = new Mapillary.Viewer(
- *     "<element-id>",
- *     "<client-id>",
- *     "<my key>");
+ * var viewer = new Mapillary.Viewer({ ... });
  *
  * var keyboardComponent = viewer.getComponent("keyboard");
  * ```

diff --git a/src/component/marker/MarkerComponent.ts b/src/component/marker/MarkerComponent.ts
@@ -80,11 +80,7 @@ import {
  *
  * @example
  * ```
- * var viewer = new Mapillary.Viewer(
- *     "<element-id>",
- *     "<client-id>",
- *     "<my key>",
- *     { component: { marker: true } });
+ * var viewer = new Mapillary.Viewer({ component: { marker: true }, ... });
  *
  * var markerComponent = viewer.getComponent("marker");
  * ```

diff --git a/src/component/mouse/MouseComponent.ts b/src/component/mouse/MouseComponent.ts
@@ -1,4 +1,4 @@
-import {Subscription} from "rxjs";
+import { Subscription } from "rxjs";
 
 import {
     BounceHandler,
@@ -29,10 +29,7 @@ import {
  *
  * @example
  * ```
- * var viewer = new Mapillary.Viewer(
- *     "<element-id>",
- *     "<client-id>",
- *     "<my key>");
+ * var viewer = new Mapillary.Viewer({ ... });
  *
  * var mouseComponent = viewer.getComponent("mouse");
  * ```

diff --git a/src/component/popup/PopupComponent.ts b/src/component/popup/PopupComponent.ts
@@ -52,11 +52,7 @@ import {
  *
  * @example
  * ```
- * var viewer = new Mapillary.Viewer(
- *     "<element-id>",
- *     "<client-id>",
- *     "<my key>",
- *     { component: { popup: true } });
+ * var viewer = new Mapillary.Viewer({ component: { popup: true }, ... });
  *
  * var popupComponent = viewer.getComponent("popup");
  * ```

diff --git a/src/component/slider/SliderComponent.ts b/src/component/slider/SliderComponent.ts
@@ -95,10 +95,7 @@ import {
  *
  * @example
  * ```
- * var viewer = new Mapillary.Viewer(
- *     "<element-id>",
- *     "<client-id>",
- *     "<my key>");
+ * var viewer = new Mapillary.Viewer({ ... });
  *
  * viewer.deactivateComponent("imagePlane");
  * viewer.deactivateComponent("direction");