Interface ApplicationPropertiesJson

The applicationProperties object is one of the objects at the top level of the JSON web map JSON schema. This is responsible for containing the viewing and editing properties of the web map. There are specific objects within this object that are applicable only to Collector and are explained within the property descriptions.

See https://developers.arcgis.com/web-map-specification/objects/applicationProperties/.

interface ApplicationPropertiesJson {
    editing?: {
        locationTracking?: {
            enabled?: boolean;
            info?: {
                layerId?: string;
                updateInterval?: number;
            };
        };
    };
    offline?: {
        connectedOnlineLayers?: [{
            id?: string;
        }];
        editableLayers?: {
            download?: "none" | "features" | "featuresAndAttachments";
            sync?: "syncFeaturesAndAttachments" | "syncFeaturesUploadAttachments" | "uploadFeaturesAndAttachments";
        };
        offlinebasemap?: {
            referenceBasemapName?: string;
        };
        readonlyLayers?: {
            downloadAttachments?: boolean;
        };
    };
    viewing?: {
        basemapGallery?: {
            enabled?: boolean;
        };
        measure?: {
            enabled?: boolean;
        };
        routing?: {
            enabled?: boolean;
        };
        search?: {
            disablePlaceFinder?: boolean;
            enabled?: boolean;
            hintText?: string;
            layers?: SublayerJson[];
        };
    };
}

Properties

editing? offline? viewing?

Properties

Optionalediting

editing?: {
    locationTracking?: {
        enabled?: boolean;
        info?: {
            layerId?: string;
            updateInterval?: number;
        };
    };
}

If locationTracking is set and enabled, the Collector application will update the feature service at the defined interval with the current location of the user logged into the Collector app. See https://developers.arcgis.com/web-map-specification/objects/editing/.

Type declaration

  • OptionallocationTracking?: {
        enabled?: boolean;
        info?: {
            layerId?: string;
            updateInterval?: number;
        };
    }

    If locationTracking is set and enabled, the collector app will update the feature service at the defined interval with the current location of the user logged into the collector application. See https://developers.arcgis.com/web-map-specification/objects/locationTracking/.

    • Optionalenabled?: boolean

      A boolean value indicating whether or not location tracking is enabled on the webmap.

    • Optionalinfo?: {
          layerId?: string;
          updateInterval?: number;
      }

      An object of additional information specifying layer and update interval time. See https://developers.arcgis.com/web-map-specification/objects/info/.

      • OptionallayerId?: string

        A string value indicating the given layer id specified in the web map.

      • OptionalupdateInterval?: number

        A numeric value indicating the time interval used to update the feature service. Default value is 300 seconds.

Optionaloffline

offline?: {
    connectedOnlineLayers?: [{
        id?: string;
    }];
    editableLayers?: {
        download?: "none" | "features" | "featuresAndAttachments";
        sync?: "syncFeaturesAndAttachments" | "syncFeaturesUploadAttachments" | "uploadFeaturesAndAttachments";
    };
    offlinebasemap?: {
        referenceBasemapName?: string;
    };
    readonlyLayers?: {
        downloadAttachments?: boolean;
    };
}

Use if working with offline maps. See https://developers.arcgis.com/web-map-specification/objects/offline/.

Type declaration

  • OptionalconnectedOnlineLayers?: [{
        id?: string;
    }]

    List of layers which should be included in an offline map as connected online layers. See https://developers.arcgis.com/web-map-specification/objects/connectedOnlineLayer/.

  • OptionaleditableLayers?: {
        download?: "none" | "features" | "featuresAndAttachments";
        sync?: "syncFeaturesAndAttachments" | "syncFeaturesUploadAttachments" | "uploadFeaturesAndAttachments";
    }

    Object detailing the available offline editing options. See https://developers.arcgis.com/web-map-specification/objects/editableLayers/.

    • Optionaldownload?: "none" | "features" | "featuresAndAttachments"

      When editing layers, the edits are always sent to the server. This string value indicates which data is retrieved. For example, none indicates that only the schema is written since neither the features nor attachments are retrieved. For a full sync without downloading attachments, indicate features. Lastly, the default behavior is to have a full sync using featuresAndAttachments where both features and attachments are retrieved.

    • Optionalsync?: "syncFeaturesAndAttachments" | "syncFeaturesUploadAttachments" | "uploadFeaturesAndAttachments"

      This string value indicates how the data is synced.

  • Optionalofflinebasemap?: {
        referenceBasemapName?: string;
    }

    Object detailing offline basemap options. See https://developers.arcgis.com/web-map-specification/objects/offlinebasemap/.

    • OptionalreferenceBasemapName?: string

      The filename of a basemap that has been copied to a mobile device. This can be used instead of the default basemap for the map to reduce downloads.

  • OptionalreadonlyLayers?: {
        downloadAttachments?: boolean;
    }

    Object indicating what to do with attachments in read-only layers. See https://developers.arcgis.com/web-map-specification/objects/readonlyLayers/.

    • OptionaldownloadAttachments?: boolean

      Indicates whether to include attachments with the read-only data.

Optionalviewing

viewing?: {
    basemapGallery?: {
        enabled?: boolean;
    };
    measure?: {
        enabled?: boolean;
    };
    routing?: {
        enabled?: boolean;
    };
    search?: {
        disablePlaceFinder?: boolean;
        enabled?: boolean;
        hintText?: string;
        layers?: SublayerJson[];
    };
}

An object containing all the viewing properties of the web map. If this is null or not defined, the client should assume a logical default. See https://developers.arcgis.com/web-map-specification/objects/viewing/.

Type declaration

  • OptionalbasemapGallery?: {
        enabled?: boolean;
    }

    The basemap tool which will use the basemap group defined in the Portal. See https://developers.arcgis.com/web-map-specification/objects/basemapGallery/.

    • Optionalenabled?: boolean

      Indicates whether to display the baseMapGallery.

  • Optionalmeasure?: {
        enabled?: boolean;
    }

    Measure tool setting for the application properties. See https://developers.arcgis.com/web-map-specification/objects/measure/.

    • Optionalenabled?: boolean

      Indicates if the measuring tool is enabled.

  • Optionalrouting?: {
        enabled?: boolean;
    }

    The route tool which will leverage the Portals defined route service. See https://developers.arcgis.com/web-map-specification/objects/routing/.

    • Optionalenabled?: boolean

      Indicates whether to set the route service.

  • Optionalsearch?: {
        disablePlaceFinder?: boolean;
        enabled?: boolean;
        hintText?: string;
        layers?: SublayerJson[];
    }

    An object specifying search parameters within the webmap. See https://developers.arcgis.com/web-map-specification/objects/search/.

    • OptionaldisablePlaceFinder?: boolean

      A boolean value indicating whether or not to disable the place finder.

    • Optionalenabled?: boolean

      A boolean value indicating whether search (find) functionality is enabled in the web map.

    • OptionalhintText?: string

      A string value used to indicate the hint provided with the search dialog.

    • Optionallayers?: SublayerJson[]

      An array of layer objects defining the styling, geometry, and attribute information for the features.

Settings

Member Visibility

On This Page

Properties