ExportVectorTilesParameters Class

ExportVectorTilesJob."> ExportVectorTilesParameters Class | ArcGISQtCpp
  • ExportVectorTilesParameters
  • class Esri::ArcGISRuntime::ExportVectorTilesParameters

    The parameters that specify how a vector tile cache (.vtpk) is exported from a vector tile service using a ExportVectorTilesJob. More...

    Header: #include <ExportVectorTilesParameters.h>
    Since: Esri::ArcGISRuntime 100.2

    Public Functions

    ExportVectorTilesParameters(const Esri::ArcGISRuntime::Geometry &areaOfInterest)
    ExportVectorTilesParameters(const Esri::ArcGISRuntime::ExportVectorTilesParameters &other)
    ExportVectorTilesParameters(Esri::ArcGISRuntime::ExportVectorTilesParameters &&other)
    Esri::ArcGISRuntime::Geometry areaOfInterest() const
    Esri::ArcGISRuntime::ExportVectorTilesParameters clone() const
    Esri::ArcGISRuntime::EsriVectorTilesDownloadOption esriVectorTilesDownloadOption() const
    int maxLevel() const
    void setAreaOfInterest(const Esri::ArcGISRuntime::Geometry &areaOfInterest)
    void setEsriVectorTilesDownloadOption(Esri::ArcGISRuntime::EsriVectorTilesDownloadOption esriVectorTilesDownloadOption)
    void setMaxLevel(int maxLevel)
    Esri::ArcGISRuntime::ExportVectorTilesParameters &operator=(const Esri::ArcGISRuntime::ExportVectorTilesParameters &other)
    Esri::ArcGISRuntime::ExportVectorTilesParameters &operator=(Esri::ArcGISRuntime::ExportVectorTilesParameters &&other)

    Detailed Description

    To generate parameters populated with values from the vector tile service, call ExportVectorTilesTask::createDefaultExportVectorTilesParametersAsync(const Esri::ArcGISRuntime::Geometry&, double). You can then modify these parameters with any desired changes. Alternatively, you can generate an empty set of parameters using ExportVectorTilesParameters and set the parameter values individually. To export the vector tile cache, create an ExportVectorTilesJob, pass the parameters to the ExportVectorTilesTask::exportVectorTiles(const Esri::ArcGISRuntime::ExportVectorTilesParameters&, const QString&, QObject*) method and provide a path where the .vtpk file can be downloaded to on the device.

    You can also use the ExportVectorTilesParameters to provide more fine-grained control over the vector tiles that are exported when an offline map is generated. For more information, see the GenerateOfflineMapParameterOverrides class.

    Member Function Documentation


    Default constructor.

    [explicit] ExportVectorTilesParameters::ExportVectorTilesParameters(const Esri::ArcGISRuntime::Geometry &areaOfInterest)

    Constructor that takes an areaOfInterest Geometry.

    ExportVectorTilesParameters::ExportVectorTilesParameters(const Esri::ArcGISRuntime::ExportVectorTilesParameters &other)

    Copy constructor from other ExportVectorTilesParameters.

    ExportVectorTilesParameters::ExportVectorTilesParameters(Esri::ArcGISRuntime::ExportVectorTilesParameters &&other)

    Move constructor from other ExportVectorTilesParameters.



    Esri::ArcGISRuntime::Geometry ExportVectorTilesParameters::areaOfInterest() const

    Returns area of interest geometry. May be set to empty to specify retrieval of the full vector tiles extent.

    The supported geometry types for the area of interest are Envelope and Polygon. The area of interest must have a spatial reference. Where a Polygon is supplied, tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting tile package. Note that the filtered set of tiles may vary, depending on the underlying service.

    See also setAreaOfInterest().

    [since Esri::ArcGISRuntime 200.1] Esri::ArcGISRuntime::ExportVectorTilesParameters ExportVectorTilesParameters::clone() const

    Clones the ExportVectorTilesParameters to a new instance.

    Returns a new instance of the current ExportVectorTilesParameters.

    This function was introduced in Esri::ArcGISRuntime 200.1.

    [since Esri::ArcGISRuntime 100.10] Esri::ArcGISRuntime::EsriVectorTilesDownloadOption ExportVectorTilesParameters::esriVectorTilesDownloadOption() const

    Returns how Esri vector tiled basemap layers will be downloaded.

    This property lets you choose how to download Esri vector tiled basemap layers. This property only applies when taking an Esri vector tile basemap service offline.

    When taking an Esri vector tiled basemap service offline (e.g. to create a VectorTileCache on your device), you can choose from different versions of the service depending on your use case.

    Primary considerations are the download speed and the size of the resulting .vtpk file. Among other things, file size is influenced by the number of fonts downloaded from the service. Esri vector tiled basemap layers use fonts as part of their style resources - see the vector-tile-style documentation. When you take a vector tiled layer offline, these fonts are downloaded as part of the VectorTileCache.

    Esri services also offer an alternative version with a reduced font package size. This omits the large Arial Unicode font, which greatly reduces the download size. You can view the set of reduced font vector tile services here.

    • If you choose EsriVectorTilesDownloadOption::UseOriginalService, the full set of resources used by the original online service, including all fonts, will be downloaded. This increases the download size of the VectorTileCache but ensures that the offline layer will display the same as the original online data.
    • If you choose EsriVectorTilesDownloadOption::UseReducedFontsService, the smaller set of fonts used by the alternative, for export version of the service will be downloaded. This reduces the download size of the VectorTileCache but is not suitable for all locales or when your offline vector tiled layer includes certain language characters. For example, this option will not display Chinese, Japanese, Thai, Korean or Georgian characters. If an alternative, for export version of the service cannot be found, the original service will be used.

    The default value is EsriVectorTilesDownloadOption::UseOriginalService.

    This function was introduced in Esri::ArcGISRuntime 100.10.

    See also setEsriVectorTilesDownloadOption().

    int ExportVectorTilesParameters::maxLevel() const

    Returns the maximum level of detail at which the vector tiles are going to be exported.

    This represents the maximum level of detail to export. The vector tile export will always take levels 0 and all in between levels up to and including the value of max level. The larger the level the more tiles will be included. The default value is -1, which must be set to a valid value >= 0.

    See also setMaxLevel().

    void ExportVectorTilesParameters::setAreaOfInterest(const Esri::ArcGISRuntime::Geometry &areaOfInterest)

    Sets the areaOfInterest to areaOfInterest.

    See also areaOfInterest.

    [since Esri::ArcGISRuntime 100.10] void ExportVectorTilesParameters::setEsriVectorTilesDownloadOption(Esri::ArcGISRuntime::EsriVectorTilesDownloadOption esriVectorTilesDownloadOption)

    Sets the esriVectorTilesDownloadOption to esriVectorTilesDownloadOption.

    This function was introduced in Esri::ArcGISRuntime 100.10.

    See also esriVectorTilesDownloadOption.

    void ExportVectorTilesParameters::setMaxLevel(int maxLevel)

    Sets the maxLevel to maxLevel.

    See also maxLevel.

    Esri::ArcGISRuntime::ExportVectorTilesParameters &ExportVectorTilesParameters::operator=(const Esri::ArcGISRuntime::ExportVectorTilesParameters &other)

    Assignment operator from other ExportVectorTilesParameters.

    Esri::ArcGISRuntime::ExportVectorTilesParameters &ExportVectorTilesParameters::operator=(Esri::ArcGISRuntime::ExportVectorTilesParameters &&other)

    Move operator from other ExportVectorTilesParameters.

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