@cyclomedia/streetsmart-api 23.14.4 → 23.14.5

package/src/types/MeshViewer.d.ts

@@ -0,0 +1,81 @@
+/// <reference path="shared.d.ts" />
+declare module '@cyclomedia/streetsmart-api' {
+    /**
+     * Represents a MeshViewerContainer React component instance.
+     */
+    class MeshViewerContainer extends React.PureComponent {
+        /**
+         * Returns the ID of this viewer.
+         * @returns {string} The ID of this viewer.
+         */
+        getId(): string;
+
+        /**
+         * Returns whether the map is desaturated or not.
+         * @returns {boolean} Desaturation state of the map.
+         */
+        getMapDesaturated(): boolean;
+
+        /**
+         * Returns the expanded state of the navbar.
+         * @returns {boolean} Expanded state of the navbar.
+         */
+        getNavbarExpanded(): boolean;
+
+        /**
+         * Returns the visibility state of the navbar.
+         * @returns {boolean} Visibility state of the navbar.
+         */
+        getNavbarVisible(): boolean;
+
+        /**
+         * Returns the type of this viewer.
+         * @returns {ViewerType} The type of this viewer.
+         */
+        getType(): ViewerType;
+
+        /**
+         * Toggles the expanded state of the navbar.
+         * @param {boolean} [expanded] - If available, sets expanded to this value.
+         */
+        toggleNavbarExpanded(expanded?: boolean): void;
+
+        /**
+         * Toggles the visibility of the navbar.
+         * @param {boolean} [visible] - If available, sets visibility to this value.
+         */
+        toggleNavbarVisible(visible?: boolean): void;
+
+        /**
+         * Sets the texture of the meshes either to gray-scale (desaturated=true) or color.
+         * @param {boolean} [desaturated=true] - If provided and true, sets the meshes to gray-scale; otherwise, sets them to color.
+         */
+        setDesaturatedTexture(desaturated?: boolean): void;
+
+        /**
+         * Updates the height of the eye in LOS analysis.
+         * @param {number} eyeHeight - The new eye height.
+         */
+        setLOSEyeHeight(eyeHeight: number): void;
+
+        /**
+         * Sets the navigation state of the viewer.
+         * @param {boolean} enabled - Whether the viewer is able to interact with the RIA map or not.
+         */
+        setNavigationState(enabled: boolean): void;
+
+        /**
+         * Sets the visibility of an overlay layer.
+         * @param {string} layerId - The ID of the overlay layer.
+         * @param {boolean} visibility - The new visibility state.
+         * @returns {Promise<void>} A Promise that resolves when the visibility is updated.
+         */
+        setOverlayVisibility(layerId: string, visibility: boolean): Promise<void>;
+
+        /**
+         * Sets the time for the viewer.
+         * @param {Date} [time] - The new time.
+         */
+        setTime(time?: Date): void;
+    }
+}

package/src/types/ObliqueViewer.d.ts

@@ -0,0 +1,180 @@
+/// <reference path="shared.d.ts" />
+declare module '@cyclomedia/streetsmart-api' {
+    type ObliqueViewerEventCallback<T extends ObliqueViewerEvents | SharedViewerEvents> = (
+        event: ViewerEvent<ObliqueViewerEventDetails[T]>,
+    ) => void;
+
+    class ObliqueViewer extends React.PureComponent {
+        /**
+         * Returns the type of this viewer.
+         * @returns {ViewerType} The type of this viewer.
+         */
+        getType(): ViewerType;
+
+        /**
+         * Returns the ID of this viewer.
+         * @returns {string} The ID of this viewer.
+         */
+        getId(): string;
+
+        /**
+         * Sets the selected feature using the given properties.
+         * @param {Object} jsonProperties - The properties by which the feature should be determined.
+         * @param {?string} layerId - The layer Id to which the feature is added.
+         */
+        setSelectedFeatureByProperties(jsonProperties: Record<string, any>, layerId: string | undefined): void;
+
+        /**
+         * Toggles the visibility of the navbar in the ObliqueViewer.
+         * @param {Boolean} [visible] - If available, sets visibility to this value.
+         */
+        toggleNavbarVisible(visible?: boolean): void;
+
+        /**
+         * Returns the visibility state of the navbar.
+         * @returns {Boolean} The visibility state of the navbar.
+         */
+        getNavbarVisible(): boolean;
+
+        /**
+         * Modify the state of navbar expanded in the ObliqueViewer.
+         * @param {Boolean} [expanded] - If available, sets expanded to this value.
+         */
+        toggleNavbarExpanded(expanded?: boolean): void;
+
+        /**
+         * Returns the expanded state of the navbar.
+         * @returns {Boolean} The expanded state of the navbar.
+         */
+        getNavbarExpanded(): boolean;
+
+        /**
+         * Modify the state of sidebar expanded in the ObliqueViewer.
+         * @param {Boolean} [expanded] - If available, sets expanded to this value.
+         */
+        toggleSidebarExpanded(expanded?: boolean): void;
+
+        /**
+         * Returns the expanded state of the sidebar.
+         * @returns {Boolean} The expanded state of the sidebar.
+         */
+        getSidebarExpanded(): boolean;
+
+        /**
+         * Toggles the visibility of the sidebar in the ObliqueViewer.
+         * @param {Boolean} [visible] - If available, sets visibility to this value.
+         */
+        toggleSidebarVisible(visible?: boolean): void;
+
+        /**
+         * Returns the visibility state of the sidebar.
+         * @returns {Boolean} The visibility state of the sidebar.
+         */
+        getSidebarVisible(): boolean;
+
+        /**
+         * Enables/disables the ability to toggle the sidebar in the ObliqueViewer.
+         * @param {Boolean} [enabled] - If available, sets visibility to this value.
+         */
+        toggleSidebarEnabled(enabled?: boolean): void;
+
+        /**
+         * Returns the enabled state of the sidebar.
+         * @returns {Boolean} The enabled state of the sidebar.
+         */
+        getSidebarEnabled(): boolean;
+
+        /**
+         * Toggle the visibility of a button.
+         * @param {ObliqueViewerUi} buttonId - The ID of the button.
+         * @param {Boolean} [enabled] - If available, sets enabled to this value.
+         */
+        toggleButtonEnabled(buttonId: ObliqueViewerUi, enabled?: boolean): void;
+
+        /**
+         * Get the visibility of a button.
+         * @param {ObliqueViewerUi} buttonId - The ID of the button.
+         * @returns {Boolean} The visibility state of the button.
+         */
+        getButtonEnabled(buttonId: ObliqueViewerUi): boolean;
+
+        /**
+         * Enables or disables timetravel in the ObliqueViewer.
+         * @param {Boolean} [visible] - If available, value for enabling or disabling toggles time travel.
+         */
+        toggleTimeTravelVisible(visible?: boolean): void;
+
+        /**
+         * Returns whether timetravel is enabled for the ObliqueViewer.
+         * @returns {Boolean} Whether timetravel is enabled.
+         */
+        getTimeTravelVisible(): boolean;
+
+        /**
+         * Expands or hides the timetravel components.
+         * @param {Boolean} [expanded] - If available, value for expanding or hiding time travel.
+         */
+        toggleTimeTravelExpanded(expanded?: boolean): void;
+
+        /**
+         * Returns whether the timetravel component is visible or hidden.
+         * @returns {Boolean} Whether the timetravel component is visible.
+         */
+        getTimeTravelExpanded(): boolean;
+
+        /**
+         * Toggles the visibility of the compass in the ObliqueViewer.
+         * @param {Boolean} [visible] - If available, sets visibility to this value.
+         */
+        toggleCompass(visible?: boolean): void;
+
+        /**
+         * Set the brightness of the oblique viewer.
+         * @param {Number} [value] - Set brightness to a positive number, normally use a value between 50 and 150.
+         */
+        setBrightness(value?: number): void;
+
+        /**
+         * Set the contrast of the oblique viewer.
+         * @param {Number} [value] - Set contrast to a positive number, normally use a value between 50 and 150.
+         */
+        setContrast(value?: number): void;
+
+        /**
+         * Changes the viewing direction of the oblique viewer.
+         * @param {number} deltaDegrees - Change direction (-90, 90, 180).
+         */
+        switchViewingDirection(deltaDegrees: number): void;
+
+        /**
+         * Zoom in in the Oblique image.
+         */
+        zoomIn(): void;
+
+        /**
+         * Zoom out in the Oblique image.
+         */
+        zoomOut(): void;
+
+        /**
+         * Downloads an image of the current oblique image.
+         */
+        saveImage(): void;
+
+        /**
+         * Returns a base64 string representation of the current canvas.
+         * @returns {string|undefined} Base64 string representation of the current canvas.
+         */
+        canvasToBase(): string | undefined;
+
+        /**
+         * Toggle the visibility of an overlay.
+         * @param {Object} layer - The layer to toggle.
+         */
+        toggleOverlay(layer: Layer): void;
+
+        on<T extends ObliqueViewerEvents | SharedViewerEvents>(type: T, callback: ObliqueViewerEventCallback<T>): this;
+
+        off<T extends ObliqueViewerEvents | SharedViewerEvents>(type: T, callback: ObliqueViewerEventCallback<T>): this;
+    }
+}

package/src/types/PanoramaViewer.d.ts

@@ -0,0 +1,340 @@
+/// <reference path="shared.d.ts" />
+declare module '@cyclomedia/streetsmart-api' {
+    type RGBA = [r: number, g: number, b: number, alpha: number];
+    type Coordinate = [x: number, y: number, z: number];
+
+    type PanoramaViewerEventCallback<T extends PanoramaViewerEvents | SharedViewerEvents> = (
+        event: ViewerEvent<PanoramaViewerEventDetails[T]>,
+    ) => void;
+
+    class PanoramaViewer extends React.Component {
+        /**
+         * Sets cube program of a recording to defaults.
+         */
+        resetCubeProgram: () => void;
+
+        /**
+         * Set the brightness of the panorama viewer.
+         * @param {number} [value] - set brightness to a positive number, normally use a value between 50 and 150.
+         */
+        setBrightness: (value?: number) => void;
+
+        /**
+         * Set the contrast of the panorama viewer.
+         * @param {number} [value] - set contrast to a positive number, normally use a value between 50 and 150.
+         */
+        setContrast: (value?: number) => void;
+
+        /**
+         * Returns the type of this viewer.
+         * @returns {ViewerType} The type of this viewer.
+         */
+        getType: () => ViewerType;
+
+        /**
+         * Returns the ID of this viewer.
+         * @returns {string} The ID of this viewer.
+         * @example
+         * // Request the ID of a viewer:
+         * StreetSmartApi.open('5D4KX5SM', {
+         *   viewerType: [StreetSmartApi.ViewerType.PANORAMA],
+         *   srs: 'EPSG:28992',
+         *   panoramaViewer: { replace: false, },
+         * }).then(
+         *   function(result) {
+         *     console.log(StreetSmartApi.getViewers()[0].getId());
+         * });
+         */
+        getId: () => string;
+
+        /**
+         * Gets the viewer color.
+         * @returns {RGBA} - RGBA representation of the color.
+         */
+        getViewerColor: () => RGBA;
+
+        /**
+         * Returns the orientation (yaw, pitch, hFov), in degrees, for this PanoramaViewer.
+         * @returns {{yaw: number, pitch: number, hFov: number}}
+         */
+        getOrientation: () => { yaw: number; pitch: number; hFov: number };
+
+        /**
+         * Sets the orientation (yaw, pitch, hFov), in degrees, of the PanoramaViewer to specific values all at once.
+         * @param {Object} orientation - Object that contains values to change.
+         * @param {number} [orientation.yaw] - Optional value of the yaw.
+         * @param {number} [orientation.pitch] - Optional value of the pitch.
+         * @param {number} [orientation.hFov] - Optional value of the hFov.
+         */
+        setOrientation: (orientation?: { yaw?: number; pitch?: number; hFov?: number }) => void;
+
+        /**
+         * Gets the current active recording of the PanoramaViewer.
+         * @returns {Recording}
+         */
+        getRecording: () => Recording;
+
+        /**
+         * Returns whether the 3D cursor is visible.
+         * @returns {boolean}
+         */
+        get3DCursorVisible: () => boolean;
+
+        /**
+         * Returns whether recordings are visible.
+         * @returns {boolean}
+         */
+        getRecordingsVisible: () => boolean;
+
+        /**
+         * Returns the visibility state of the navbar.
+         * @returns {boolean}
+         */
+        getNavbarVisible: () => boolean;
+
+        /**
+         * Returns the expanded state of the navbar.
+         * @returns {boolean}
+         */
+        getNavbarExpanded: () => boolean;
+
+        /**
+         * Returns the visibility state of the sidebar.
+         * @returns {boolean}
+         */
+        getSidebarVisible: () => boolean;
+
+        /**
+         * Returns the enabled state of the sidebar.
+         * @returns {boolean}
+         */
+        getSidebarEnabled: () => boolean;
+
+        /**
+         * Returns the expanded state of the sidebar.
+         * @returns {boolean}
+         */
+        getSidebarExpanded: () => boolean;
+
+        /**
+         * Get the visibility of a button.
+         * @param {string} buttonId
+         * @returns {boolean}
+         */
+        getButtonEnabled: (buttonId: string) => boolean;
+
+        /**
+         * Returns whether timetravel is enabled for the PanoramaViewer.
+         * @returns {boolean}
+         */
+        getTimeTravelVisible: () => boolean;
+
+        /**
+         * Returns whether the timetravel component is visible or hidden.
+         * @returns {boolean}
+         */
+        getTimeTravelExpanded: () => boolean;
+
+        /**
+         * Sets the selected feature using the given properties.
+         * The selected feature can only be selected if the feature is in sight on the panorama viewer.
+         * @param {Object} jsonProperties - The properties by which the feature should be determined.
+         * @param {?string} layerId - The layer Id to which the feature is added.
+         * @param {string} additionalLayerId - The additional layer Id.
+         * @example
+         * // Having StreetSmartApi initialized:
+         * let viewer = streetSmartApi.addPanoramaViewer(viewerDomElement);
+         * var properties = {"MyAttribute1": "MyValue1", "MyAttribute2": "MyValue2"};
+         * viewer.setSelectedFeatureByProperties(properties, layerId, additionalLayerId);
+         */
+        setSelectedFeatureByProperties: (jsonProperties: any, layerId: string, additionalLayerId: string) => void;
+
+        /**
+         * Selected feature style and interaction.
+         * @param {Object} feature - The feature object.
+         */
+        setFeatureStyle: (feature?: Object) => void;
+
+        /**
+         * Opens an image by imageId.
+         * @param {string} imageId - ID of the image that needs to be opened. E.g. "5D38RPNF".
+         * @param {string} [srs] - Optional, coordinate system in which the panorama will be opened. E.g. "EPSG:28992".
+         * @returns {Promise<Recording|Error>} Returns a new promise for the result that may be used to chain additional functions.
+         */
+        openByImageId: (imageId: string, srs?: string) => Promise<Recording | Error>;
+
+        /**
+         * Opens an image by coordinates and accompanying coordinate system.
+         * @param {Coordinate} coordinate - Coordinate of location to open a panorama.
+         * @param {string} [srs] - If provided, will use to convert coordinate to viewer srs.
+         * @returns {Promise<Recording|Error>} Returns a new promise for the result that may be used to chain additional functions.
+         */
+        openByCoordinate: (coordinate: Coordinate, srs?: string) => Promise<Recording | Error>;
+
+        /**
+         * Opens a panorama closest to the given address.
+         * @param {string} query - Address you want to search.
+         * @param {string} [srs] - Optional, coordinate system in which the panorama will be opened. E.g. "EPSG:28992".
+         * @returns {Promise<Recording|Error>} Returns a new promise for the result that may be used to chain additional functions.
+         * @example
+         * // Having StreetSmartApi initialized:
+         * let viewer = streetSmartApi.addPanoramaViewer(viewerDomElement);
+         * // Now open the address
+         * viewer.openByAddress("Van Voordenpark 1B, Zaltbommel", "EPSG:29882").catch(function(err){ console.log(err.message)});
+         */
+        openByAddress: (query: string, srs?: string) => Promise<Recording | Error>;
+
+        /**
+         * Expands or hides the timetravel components.
+         * @param {boolean} [expanded] - If available, value for expanding or hiding time travel.
+         */
+        toggleTimeTravelExpanded: (expanded?: boolean) => void;
+
+        /**
+         * Enables or disables timetravel in the PanoramaViewer.
+         * @param {boolean} [visible] - If available, value for enabling or disabling toggles time travel.
+         */
+        toggleTimeTravelVisible: (visible?: boolean) => void;
+
+        /**
+         * Sets `turboLoaderActive` in the Panoramaviewer Redux state.
+         * If `active` param is true, no overlay http requests will be made in the panoramaviewer or in the mapviewer.
+         * @param {boolean} active
+         */
+        setSuppressLoading: (active: boolean) => void;
+
+        /**
+         * Toggle the visibility of a button.
+         * @param {string} buttonId
+         * @param {boolean} [enabled] - If available, set enabled to this value.
+         */
+        toggleButtonEnabled: (buttonId: string, enabled?: boolean) => void;
+
+        /**
+         * Modify the state of navbar expanded in the PanoramaViewer.
+         * @param {boolean} [expanded] - If available, sets expanded to this value.
+         */
+        toggleNavbarExpanded: (expanded?: boolean) => void;
+
+        /**
+         * Toggles the visibility of the navbar in the PanoramaViewer.
+         * @param {boolean} [visible] - If available, sets visibility to this value.
+         */
+        toggleNavbarVisible: (visible?: boolean) => void;
+
+        /**
+         * Modify the state of sidebar expanded in the PanoramaViewer.
+         * @param {boolean} [expanded] - If available, sets expanded to this value.
+         */
+        toggleSidebarExpanded: (expanded?: boolean) => void;
+
+        /**
+         * Toggles the visibility of the sidebar in the PanoramaViewer.
+         * @param {boolean} [visible] - If available, sets visibility to this value.
+         */
+        toggleSidebarVisible: (visible?: boolean) => void;
+
+        /**
+         * Enables/disables the ability to toggle the sidebar in the PanoramaViewer.
+         * @param {boolean} [enabled] - If available, sets visibility to this value.
+         */
+        toggleSidebarEnabled: (enabled?: boolean) => void;
+
+        /**
+         * Toggle the visibility of an overlay.
+         * @param {Layer} layer
+         */
+        toggleOverlay: (layer: Layer) => void;
+
+        /**
+         * Toggles the visibility of the 3D cursor in the PanoramaViewer.
+         * @param {boolean} [visible] - If available, sets visibility to this value.
+         */
+        toggle3DCursor: (visible?: boolean) => void;
+
+        /**
+         * Toggles the visibility of the compass in the PanoramaViewer.
+         * @param {boolean} [visible]
+         */
+        toggleCompass(visible?: boolean): void;
+
+        /**
+         * Toggles the visibility of the Attribute information panel, deciding if it should be shown on clicking on a feature.
+         * @param {boolean} [visible]
+         */
+        showAttributePanelOnFeatureClick(visible?: boolean): void;
+
+        /**
+         * Toggles the visibility of the recording features in the PanoramaViewer.
+         * @param {boolean} [visible]
+         */
+        toggleRecordingsVisible(visible?: boolean): void;
+
+        /**
+         * Toggles the visibility of the Address features in the PanoramaViewer.
+         * @param {boolean} [visible]
+         */
+        toggleAddressesVisible(visible?: boolean): void;
+
+        /**
+         * Sets the orientation of the PanoramaViewer to look at a certain coordinate.
+         * @param {Coordinate} coordinate
+         * @param {string} [srs]
+         */
+        lookAtCoordinate(coordinate: Coordinate, srs?: string): void;
+
+        /**
+         * Rotates the panorama horizontally by a certain amount, as if the camera is turning to the left.
+         * @param {number} deltaYaw
+         */
+        rotateLeft(deltaYaw: number): void;
+
+        /**
+         * Rotates the panorama horizontally by a certain amount, as if the camera is turning to the right.
+         * @param {number} deltaYaw
+         */
+        rotateRight(deltaYaw: number): void;
+
+        /**
+         * Rotates the panorama vertically by a certain amount, as if the camera is turning to the sky.
+         * @param {number} deltaPitch
+         */
+        rotateUp(deltaPitch: number): void;
+
+        /**
+         * Rotates the panorama vertically by a certain amount, as if the camera is turning to the ground.
+         * @param {number} deltaPitch
+         */
+        rotateDown(deltaPitch: number): void;
+
+        /**
+         * Returns a base64 string representation of the current canvas.
+         * @returns {string | undefined}
+         */
+        canvasToBase: () => string | undefined;
+
+        // Triggers a download request with the image of the current panorama
+        saveImage: VoidFunction;
+
+        /**
+         * Set the elevation slider level.
+         * @param {number} elevationLevel
+         */
+        setElevationSliderLevel(elevationLevel: number): void;
+
+        /**
+         * Toggle viewers from linked to unlinked and vice versa.
+         */
+        toggleLinkedViewers: () => void;
+
+        on<T extends PanoramaViewerEvents | SharedViewerEvents>(
+            type: T,
+            callback: PanoramaViewerEventCallback<T>,
+        ): this;
+
+        off<T extends PanoramaViewerEvents | SharedViewerEvents>(
+            type: T,
+            callback: PanoramaViewerEventCallback<T>,
+        ): this;
+    }
+}