@mappedin/mappedin-js 4.0.12 → 4.0.13

package/lib/esm/renderer/index.d.ts

@@ -1846,71 +1846,75 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartTooltip' {
     import { Vector3 } from 'three';
     import { TColliderStrategy } from '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider';
     /**
-      *
-      * A Tooltip is an html element that attempts to orient itself around an anchor in 3D space. It will always maintain the same size on the screen, but will attempt to change its orientation based on other colliders in the scene.
-      *
-      * Make your own and add it directly to the map with {{#crossLink "MapView/createTooltip:method"}}{{/crossLink}}, or use the constructor and add it when you want.
-      *
-      * You will need to specify at least `options.position` and one of `options.html` and `options.selector` OR `options.contentHtml`.
-      *
-      *
-      * @class Tooltip
-      *
-      * @constructor
-      * @param options {Object} Passes on options (e.g. html, text, position, map, padding, defaultAnchorType, enabledAnchorTypes, collisionRank) to MapView.Tooltip's options argument.
-      * @param [options.html] Pass in custom html for your marker, if using this method you must also pass in a selector for your content.
-      * @param [options.selector] Used in conjuction with the html property to select the div for repositioning
-      * @param [options.contentHtml] Use mappedin's default tooltip styling with custom inner html content
-      * @param [options.text] Instead of passing html pass in plain text to be displayed in the tooltip
-      * @param [options.position] should be something you got from {{#crossLink "MapView/getPositionPolygon:method"}}{{/crossLink}} or {{#crossLink "MapView/getPositionNode:method"}}{{/crossLink}}.
-      * @param [options.map] The map ID where the tooltip should be displayed
-      * @param [options.defaultAnchorType] The default orientation to place the tooltip.
-      * @param [options.padding] The distance in pixel to offset the tooltip from the anchor point.
-      * @param [options.enabledAnchorTypes] An object used to disable certain anchor positions from being used.
-      * @param [options.collisionRank]  The rank of the object used when comparing colliders to determine which should be shown.
-      */
+        *
+        * A Tooltip is an html element that attempts to orient itself around an anchor in 3D space. It will always maintain the same size on the screen, but will attempt to change its orientation based on other colliders in the scene.
+        *
+        * Make your own and add it directly to the map with {{#crossLink "MapView/createTooltip:method"}}{{/crossLink}}, or use the constructor and add it when you want.
+        *
+        * You will need to specify at least `options.position` and one of `options.html` and `options.selector` OR `options.contentHtml`.
+        *
+        *
+        * @class Tooltip
+        *
+        * @constructor
+        * @param options {Object} Passes on options (e.g. html, text, position, map, padding, defaultAnchorType, enabledAnchorTypes, collisionRank) to MapView.Tooltip's options argument.
+        * @param [options.html] Pass in custom html for your marker, if using this method you must also pass in a selector for your content.
+        * @param [options.selector] Used in conjuction with the html property to select the div for repositioning
+        * @param [options.contentHtml] Use mappedin's default tooltip styling with custom inner html content
+        * @param [options.text] Instead of passing html pass in plain text to be displayed in the tooltip
+        * @param [options.position] should be something you got from {{#crossLink "MapView/getPositionPolygon:method"}}{{/crossLink}} or {{#crossLink "MapView/getPositionNode:method"}}{{/crossLink}}.
+        * @param [options.map] The map ID where the tooltip should be displayed
+        * @param [options.defaultAnchorType] The default orientation to place the tooltip.
+        * @param [options.padding] The distance in pixel to offset the tooltip from the anchor point.
+        * @param [options.enabledAnchorTypes] An object used to disable certain anchor positions from being used.
+        * @param [options.collisionRank]  The rank of the object used when comparing colliders to determine which should be shown.
+        */
     export type TSmartTooltipOptions = {
-        html?: string;
-        contentHtml?: string;
-        text?: string;
-        position: Vector3;
-        selector?: string;
-        map: string;
-        padding?: number;
-        alwaysVisible?: boolean;
-        collisionRank?: COLLISION_RANKING_TIERS;
-        defaultAnchorType?: string;
-        enabledAnchorTypes?: {
-            [type: string]: boolean;
-        };
+            html?: string;
+            contentHtml?: string;
+            text?: string;
+            position: Vector3;
+            selector?: string;
+            map: string;
+            padding?: number;
+            alwaysVisible?: boolean;
+            collisionRank?: COLLISION_RANKING_TIERS;
+            defaultAnchorType?: string;
+            enabledAnchorTypes?: {
+                    [type: string]: boolean;
+            };
     };
     type TTooltipStyle = {
-        top?: string;
-        left?: string;
+            top?: string;
+            left?: string;
     };
     export type TOOLTIP_ANCHOR = {
-        top?: boolean;
-        left?: boolean;
-        topLeft?: boolean;
-        right?: boolean;
-        topRight?: boolean;
-        bottom?: boolean;
-        bottomLeft?: boolean;
-        bottomRight?: boolean;
+            top?: boolean;
+            left?: boolean;
+            topLeft?: boolean;
+            right?: boolean;
+            topRight?: boolean;
+            bottom?: boolean;
+            bottomLeft?: boolean;
+            bottomRight?: boolean;
     };
     class SmartTooltip extends HTMLCollider implements IHTMLCollider {
-        #private;
-        className: string;
-        _el: Element | null;
-        style: TTooltipStyle;
-        constructor(options: TSmartTooltipOptions);
-        updateClassName: (className: any) => void;
-        get strategies(): TColliderStrategy[];
-        colliderDidMount(): void;
-        setAction(action: any): void;
-        colliderDidNotFindAHome(): void;
-        colliderDidGoOffscreen(): void;
-        colliderDidUpdateVisiblity(): void;
+            #private;
+            className: string;
+            _el: Element | null;
+            style: TTooltipStyle;
+            constructor(options: TSmartTooltipOptions);
+            updateClassName: (className: any) => void;
+            get strategies(): TColliderStrategy[];
+            colliderDidMount(): void;
+            /**
+                * @internal
+                */
+            updateDimensionsImmediately(): void;
+            setAction(action: any): void;
+            colliderDidNotFindAHome(): void;
+            colliderDidGoOffscreen(): void;
+            colliderDidUpdateVisiblity(): void;
     }
     export default SmartTooltip;
 }