devextreme/cjs/__internal/ui/map/map.js

HTML5 JavaScript Component Suite for Responsive Web Development

/**
 * DevExtreme (cjs/__internal/ui/map/map.js)
 * Version: 25.2.3
 * Build date: Fri Dec 12 2025
 *
 * Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
 * Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
 */
"use strict";
Object.defineProperty(exports, "__esModule", {
    value: true
});
exports.default = void 0;
var _events_engine = _interopRequireDefault(require("../../../common/core/events/core/events_engine"));
var _pointer = _interopRequireDefault(require("../../../common/core/events/pointer"));
var _index = require("../../../common/core/events/utils/index");
var _component_registrator = _interopRequireDefault(require("../../../core/component_registrator"));
var _devices = _interopRequireDefault(require("../../../core/devices"));
var _renderer = _interopRequireDefault(require("../../../core/renderer"));
var _array = require("../../../core/utils/array");
var _extend = require("../../../core/utils/extend");
var _inflector = require("../../../core/utils/inflector");
var _type = require("../../../core/utils/type");
var _ui = _interopRequireDefault(require("../../../ui/widget/ui.errors"));
var _m_deferred = require("../../core/utils/m_deferred");
var _widget = _interopRequireDefault(require("../../core/widget/widget"));
var _providerDynamic = _interopRequireDefault(require("./provider.dynamic.azure"));
var _providerDynamic2 = _interopRequireDefault(require("./provider.dynamic.bing"));
var _providerDynamic3 = _interopRequireDefault(require("./provider.dynamic.google"));
var _provider = _interopRequireDefault(require("./provider.google_static"));

function _interopRequireDefault(e) {
    return e && e.__esModule ? e : {
        default: e
    }
}
const PROVIDERS = {
    azure: _providerDynamic.default,
    googleStatic: _provider.default,
    google: _providerDynamic3.default,
    bing: _providerDynamic2.default
};
const MAP_CLASS = "dx-map";
const MAP_CONTAINER_CLASS = "dx-map-container";
const MAP_SHIELD_CLASS = "dx-map-shield";
class Map extends _widget.default {
    _getDefaultOptions() {
        return Object.assign({}, super._getDefaultOptions(), {
            bounds: {
                northEast: null,
                southWest: null
            },
            center: {
                lat: 0,
                lng: 0
            },
            zoom: 1,
            width: 300,
            height: 300,
            type: "roadmap",
            provider: "google",
            autoAdjust: true,
            markers: [],
            markerIconSrc: null,
            onMarkerAdded: null,
            onMarkerRemoved: null,
            routes: [],
            onRouteAdded: null,
            onRouteRemoved: null,
            apiKey: {
                bing: "",
                google: "",
                googleStatic: ""
            },
            providerConfig: {
                mapId: "",
                useAdvancedMarkers: true
            },
            controls: false,
            onReady: null,
            onUpdated: null,
            onClick: null
        })
    }
    _defaultOptionsRules() {
        return super._defaultOptionsRules().concat([{
            device: () => "desktop" === _devices.default.real().deviceType && !_devices.default.isSimulator(),
            options: {
                focusStateEnabled: true
            }
        }])
    }
    ctor(element, options) {
        super.ctor(element, options);
        if (options) {
            if ("provider" in options && "bing" === options.provider) {
                this._logDeprecatedBingProvider()
            }
        }
    }
    _logDeprecatedBingProvider() {
        this._logDeprecatedOptionWarning("provider: bing", {
            since: "24.2",
            message: "Use other map providers, such as Azure, Google, or GoogleStatic."
        })
    }
    _setDeprecatedOptions() {
        super._setDeprecatedOptions();
        (0, _extend.extend)(this._deprecatedOptions, {
            "providerConfig.useAdvancedMarkers": {
                since: "24.2",
                message: "Google deprecated the original map markers. Transition to advanced markers for future compatibility."
            }
        })
    }
    _renderFocusTarget() {}
    _init() {
        super._init();
        this.$element().addClass("dx-map");
        this._lastAsyncAction = Promise.resolve();
        this._checkOption("provider");
        this._checkOption("markers");
        this._checkOption("routes");
        this._initContainer();
        this._grabEvents();
        this._rendered = {}
    }
    _useTemplates() {
        return false
    }
    _checkOption(option) {
        const value = this.option(option);
        if ("markers" === option && !Array.isArray(value)) {
            throw _ui.default.Error("E1022")
        }
        if ("routes" === option && !Array.isArray(value)) {
            throw _ui.default.Error("E1023")
        }
    }
    _initContainer() {
        this._$container = (0, _renderer.default)("<div>").addClass("dx-map-container");
        this.$element().append(this._$container)
    }
    _grabEvents() {
        const eventName = (0, _index.addNamespace)(_pointer.default.down, this.NAME);
        _events_engine.default.on(this.$element(), eventName, this._cancelEvent.bind(this))
    }
    _cancelEvent(e) {
        var _this$_provider;
        const {
            disabled: disabled
        } = this.option();
        const cancelByProvider = (null === (_this$_provider = this._provider) || void 0 === _this$_provider ? void 0 : _this$_provider.isEventsCanceled(e)) && !disabled;
        if (cancelByProvider) {
            e.stopPropagation()
        }
    }
    _saveRendered(option) {
        const {
            [option]: value = []
        } = this.option();
        this._rendered[option] = value.slice()
    }
    _render() {
        super._render();
        this._renderShield();
        this._saveRendered("markers");
        this._saveRendered("routes");
        const {
            provider: provider = "google"
        } = this.option();
        const Provider = PROVIDERS[provider];
        this._provider = new Provider(this, this._$container);
        this._queueAsyncAction("render", this._rendered.markers, this._rendered.routes)
    }
    _renderShield() {
        const {
            disabled: disabled
        } = this.option();
        if (disabled) {
            const $shield = (0, _renderer.default)("<div>").addClass("dx-map-shield");
            this.$element().append($shield);
            return
        }
        this.$element().find(".dx-map-shield").remove()
    }
    _clean() {
        this._cleanFocusState();
        if (this._provider) {
            this._provider.clean()
        }
        this._provider = null;
        this._lastAsyncAction = Promise.resolve();
        this.setOptionSilent("bounds", {
            northEast: null,
            southWest: null
        });
        delete this._suppressAsyncAction
    }
    _optionChanged(args) {
        const {
            name: name,
            value: value
        } = args;
        const changeBag = this._optionChangeBag;
        this._optionChangeBag = null;
        switch (name) {
            case "disabled":
                this._renderShield();
                super._optionChanged(args);
                this._queueAsyncAction("updateDisabled");
                break;
            case "width":
            case "height":
                super._optionChanged(args);
                this._dimensionChanged();
                break;
            case "provider":
                this._suppressAsyncAction = true;
                this._invalidate();
                if ("bing" === value) {
                    this._logDeprecatedBingProvider()
                }
                break;
            case "apiKey":
                _ui.default.log("W1001");
                break;
            case "bounds":
                this._queueAsyncAction("updateBounds");
                break;
            case "center":
                this._queueAsyncAction("updateCenter");
                break;
            case "zoom":
                this._queueAsyncAction("updateZoom");
                break;
            case "type":
                this._queueAsyncAction("updateMapType");
                break;
            case "controls":
                this._queueAsyncAction("updateControls", this._rendered.markers, this._rendered.routes);
                break;
            case "autoAdjust":
                this._queueAsyncAction("adjustViewport");
                break;
            case "markers":
            case "routes": {
                this._checkOption(name);
                const prevValue = this._rendered[name];
                this._saveRendered(name);
                this._queueAsyncAction("" + ("markers" === name ? "updateMarkers" : "updateRoutes"), changeBag ? changeBag.removed : prevValue, changeBag ? changeBag.added : this._rendered[name]).then((result => {
                    if (changeBag) {
                        changeBag.resolve(result)
                    }
                }));
                break
            }
            case "markerIconSrc":
                this._queueAsyncAction("updateMarkers", this._rendered.markers, this._rendered.markers);
                break;
            case "providerConfig":
                this._suppressAsyncAction = true;
                this._invalidate();
                break;
            case "onReady":
            case "onUpdated":
            case "onMarkerAdded":
            case "onMarkerRemoved":
            case "onRouteAdded":
            case "onRouteRemoved":
            case "onClick":
                break;
            default:
                super._optionChanged(args)
        }
    }
    _visibilityChanged(visible) {
        if (visible) {
            this._dimensionChanged()
        }
    }
    _dimensionChanged() {
        this._queueAsyncAction("updateDimensions")
    }
    _queueAsyncAction(name, markers, routes) {
        const markerAndRoutes = [markers, routes].filter(Boolean);
        const isActionSuppressed = this._suppressAsyncAction;
        this._lastAsyncAction = this._lastAsyncAction.then((() => {
            if (!this._provider || isActionSuppressed) {
                return Promise.resolve()
            }
            return this._provider[name](...markerAndRoutes).then((result => {
                const arrayResult = (0, _array.wrapToArray)(result);
                const mapRefreshed = arrayResult[0];
                if (mapRefreshed && !this._disposed) {
                    this._triggerReadyAction()
                }
                return arrayResult[1]
            }))
        }));
        return this._lastAsyncAction
    }
    _triggerReadyAction() {
        this._createActionByOption("onReady")({
            originalMap: this._provider.map()
        })
    }
    _triggerUpdateAction() {
        this._createActionByOption("onUpdated")()
    }
    setOptionSilent(name, value) {
        this._setOptionWithoutOptionChange(name, value)
    }
    addMarker(marker) {
        return this._addFunction("markers", marker)
    }
    removeMarker(marker) {
        return this._removeFunction("markers", marker)
    }
    addRoute(route) {
        return this._addFunction("routes", route)
    }
    removeRoute(route) {
        return this._removeFunction("routes", route)
    }
    _addFunction(optionName, addingValue) {
        const {
            [optionName]: optionValue = []
        } = this.option();
        const addingValues = (0, _array.wrapToArray)(addingValue);
        optionValue.push(...addingValues);
        return this._partialArrayOptionChange(optionName, optionValue, addingValues, [])
    }
    _removeFunction(optionName, removingValue) {
        const {
            [optionName]: optionValue = []
        } = this.option();
        const removingValues = (0, _array.wrapToArray)(removingValue);
        removingValues.forEach(((value, removingIndex) => {
            const index = (0, _type.isNumeric)(value) ? value : optionValue.indexOf(value);
            if (-1 !== index) {
                const removing = optionValue.splice(index, 1)[0];
                removingValues.splice(removingIndex, 1, removing)
            } else {
                throw _ui.default.log("E1021", (0, _inflector.titleize)(optionName.substring(0, optionName.length - 1)), value)
            }
        }));
        return this._partialArrayOptionChange(optionName, optionValue, [], removingValues)
    }
    _partialArrayOptionChange(optionName, optionValue, addingValues, removingValues) {
        return (0, _m_deferred.fromPromise)(new Promise((resolve => {
            this._optionChangeBag = {
                resolve: resolve,
                added: addingValues,
                removed: removingValues
            };
            this.option(optionName, optionValue)
        })).then((result => {
            const resultArray = Array.isArray(result) ? result : [result];
            return 1 === resultArray.length ? resultArray[0] : resultArray
        })), this)
    }
}(0, _component_registrator.default)("dxMap", Map);
var _default = exports.default = Map;