Class ExportVectorTilesParameters


  • public final class ExportVectorTilesParameters
    extends Object
    Represents the input parameters for an ExportVectorTilesTask operation.
    Since:
    100.2.0
    • Constructor Detail

      • ExportVectorTilesParameters

        public ExportVectorTilesParameters()
        Creates an ExportVectorTilesParameters instance.
        Since:
        100.2.0
    • Method Detail

      • getAreaOfInterest

        public Geometry getAreaOfInterest()
        Gets the geometry that represents the area of vector tiles to be exported.

        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, features and tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting offline map. Note that the filtered set of tiles may vary, depending on the underlying service.

        Returns:
        the Geometry that represents the area of tiles to be exported. If null the full extent of the service will be exported.
        Since:
        100.2.0
      • setAreaOfInterest

        public void setAreaOfInterest​(Geometry areaOfInterest)
        Sets the geometry that represents the area of vector tiles to be exported.

        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, features and tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting offline map. Note that the filtered set of tiles may vary, depending on the underlying service.

        Parameters:
        areaOfInterest - the Geometry that represents the area of vector tiles to be exported, can be null in which case the full extent of the service will be exported.
        Throws:
        IllegalArgumentException - if the geometry is anything other than null or an Envelope or a Polygon
        Since:
        100.2.0
      • setMaxLevel

        public void setMaxLevel​(int maxLevel)
        Sets the maximum level of details to export vector tiles.

        This number 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.

        Parameters:
        maxLevel - the maximum level of details to export
        Throws:
        IllegalArgumentException - if maxLevel is negative
        Since:
        100.2.0
      • getMaxLevel

        public int getMaxLevel()
        Gets the maximum level of details to export.
        Returns:
        the maximum level of details to export
        Since:
        100.2.0