Obsolete Members for Map

  • Map
  • The following members of class Map are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

    Public Functions

    (deprecated) Esri::ArcGISRuntime::TaskWatcher namedTraceConfigurationsFromUtilityNetwork(Esri::ArcGISRuntime::UtilityNetwork *utilityNetwork)
    (deprecated) QUuid save(bool forceSaveToSupportedVersion)
    (deprecated) QUuid saveAs(Esri::ArcGISRuntime::Portal *portal, const QString &title, const QStringList &tags, bool forceSaveToSupportedVersion, const Esri::ArcGISRuntime::PortalFolder &folder = PortalFolder(), const QString &description = QString(), const QByteArray &thumbnailBytes = QByteArray())

    Signals

    (deprecated) void namedTraceConfigurationsFromUtilityNetworkCompleted(const QUuid &taskId, const QList<Esri::ArcGISRuntime::UtilityNamedTraceConfiguration *> &namedTraceConfigurationsResults)
    (deprecated) void saveAsCompleted(const QUuid &taskId, bool succeeded)
    (deprecated) void saveCompleted(const QUuid &taskId, bool succeeded)

    Member Function Documentation

    [since Esri::ArcGISRuntime 100.11] Esri::ArcGISRuntime::TaskWatcher Map::namedTraceConfigurationsFromUtilityNetwork(Esri::ArcGISRuntime::UtilityNetwork *utilityNetwork)

    This function is deprecated. We strongly advise against using it in new code.

    Returns a list of all the UtilityNamedTraceConfiguration objects referenced by UtilityNetwork's map.

    An empty collection is returned if the UtilityNetwork does not belong to the map or if the map does not contain any UtilityNamedTraceConfiguration objects.

    Returns a TaskWatcher for the asynchronous operation.

    This function was introduced in Esri::ArcGISRuntime 100.11.

    See also UtilityNamedTraceConfiguration.

    [signal, since Esri::ArcGISRuntime 100.11] void Map::namedTraceConfigurationsFromUtilityNetworkCompleted(const QUuid &taskId, const QList<Esri::ArcGISRuntime::UtilityNamedTraceConfiguration *> &namedTraceConfigurationsResults)

    This function is deprecated. We strongly advise against using it in new code.

    Signal emitted when the namedTraceConfigurationsFromUtilityNetwork operation completes.

    • taskId - The task ID of the asynchronous operation.
    • namedTraceConfigurationsResults.

    This function was introduced in Esri::ArcGISRuntime 100.11.

    QUuid Map::save(bool forceSaveToSupportedVersion)

    This function is deprecated. We strongly advise against using it in new code.

    Saves any changes that have been made to the map.

    The map must have been constructed using the PortalItem constructor, or been saved using saveAs to associate it with a PortalItem object.

    • forceSaveToSupportedVersion - Whether the map should be saved to the supported web map version that the API supports (see system requirements). This may cause data loss as unknown data is not saved. If true, unknown data will be removed and the map will be saved. If false, the asynchronous operation will fail if the map contains unknown data that will not be saved. This flag can be used to provide a warning to users that some map data may be lost when the map is saved.

    Updates the map content data on the portal and also updates the portal item properties stored on the portal to match those stored within the map's PortalItem object.

    If the portal is not loaded, it will be loaded automatically. If the portal requires a credential that has not been supplied, it should be loaded before calling this function.

    The map must be loaded to call this function. Calling this function will not force the map to start loading. If the map is not already associated with a PortalItem, calling save will produce an error.

    QUuid Map::saveAs(Esri::ArcGISRuntime::Portal *portal, const QString &title, const QStringList &tags, bool forceSaveToSupportedVersion, const Esri::ArcGISRuntime::PortalFolder &folder = PortalFolder(), const QString &description = QString(), const QByteArray &thumbnailBytes = QByteArray())

    This function is deprecated. We strongly advise against using it in new code.

    Saves the map to a portal as a portalItem.

    • portal - The portal to save the PortalItem to.
    • title - A title for the map.
    • tags - A list of tags to associate with the map.
    • forceSaveToSupportedVersion - Whether the map should be saved to the supported web map version that the API supports (see system requirements). This may cause data loss as unknown data is not saved. If true, unknown data will be removed and the map will be saved. If false, the asynchronous operation will fail if the map contains unknown data that will not be saved. This flag can be used to provide a warning to users that some map data may be lost when the map is saved.
    • folder - An optional PortalFolder belonging to the current user in which to save the map. If not specified the map will be saved in the user's root folder.
    • description - An optional description for the map.
    • thumbnailBytes - Optional bytes for the thumbnail image.

    Updates the map content data on the portal, and updates the portal item properties stored on the portal to match those stored within the map's PortalItem object.

    If the portal is not loaded, it will be loaded automatically. If the portal requires a credential that has not been supplied, it should be loaded before calling this function.

    The map must be loaded to call this function. Calling this function will not force the map to start loading.

    [signal] void Map::saveAsCompleted(const QUuid &taskId, bool succeeded)

    This function is deprecated. We strongly advise against using it in new code.

    The signal emitted when the saveAs operation completes.

    • taskId - The async task ID.
    • succeeded - Whether the async operation succeeded.

    [signal] void Map::saveCompleted(const QUuid &taskId, bool succeeded)

    This function is deprecated. We strongly advise against using it in new code.

    The signal emitted when the save operation completes.

    • taskId - The async task ID.
    • succeeded - Whether the async operation succeeded.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.