A map service that runs on the local server. More...
| Header: | #include <LocalMapService.h> |
| Inherits: | Esri::ArcGISRuntime::LocalService |
| Inherited By: |
Public Functions
| LocalMapService(const QString &packagePath, QObject *parent = nullptr) | |
| virtual | ~LocalMapService() override |
| QList<Esri::ArcGISRuntime::DynamicWorkspace *> | dynamicWorkspaces() const |
| int | maximumRecords() const |
| void | setDynamicWorkspaces(const QList<Esri::ArcGISRuntime::DynamicWorkspace *> &dynamicWorkspaces) |
| void | setMaximumRecords(int maxRecords) |
Detailed Description
Note: Local server is only available on Windows and Linux.
A local map service requires a map package file (.mpkx) which has been authored in ArcGIS Pro.
Relevant samples:
- Local Server map image layer: Start the Local Server and Local Map Service, create an ArcGIS Map Image Layer from the Local Map Service, and add it to a map.
- Local server services: Demonstrates how to start and stop the Local Server and start and stop a local map, feature, and geoprocessing service running on the Local Server.
Member Function Documentation
[explicit] LocalMapService::LocalMapService (const QString &packagePath , QObject *parent = nullptr)
Constructor that takes a path to the map package file (packagePath) and an optional parent.
[override virtual] LocalMapService::~LocalMapService ()
Destructor.
[since Esri::ArcGISRuntime 100.1] QList<Esri::ArcGISRuntime::DynamicWorkspace *> LocalMapService::dynamicWorkspaces () const
Returns the dynamic workspaces if any have been specified.
This function was introduced in Esri::ArcGISRuntime 100.1.
See also setDynamicWorkspaces().
int LocalMapService::maximumRecords () const
Returns the maximum number of records returned by the service.
The default value is 10000.
See also setMaximumRecords().
[since Esri::ArcGISRuntime 100.1] void LocalMapService::setDynamicWorkspaces (const QList<Esri::ArcGISRuntime::DynamicWorkspace *> &dynamicWorkspaces )
Sets the dynamic workspaces to dynamicWorkspaces.
This can only be set before the local map service has been started.
This function was introduced in Esri::ArcGISRuntime 100.1.
See also dynamicWorkspaces().
void LocalMapService::setMaximumRecords (int maxRecords )
Sets the maximum number of records returned by the service to maxRecords.
This number is limited to the maximum number of features visible in the map. The default value is 10000. This value must be set before the service starts.
See also maximumRecords().