Skip To Content ArcGIS for Developers Sign In Dashboard

GenerateLayerOption QML Type

Options defining what data to generate for a specific layer or table when creating a sync-enabled mobile geodatabase. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Signals

Detailed Description

A new instance has the following default values:

The property includeRelated only applies when the property queryOption is Enums.GenerateLayerQueryOptionNone.

Property Documentation

includeRelated : bool

Whether to include any data from this layer that is related to data in other layers in the geodatabase.

This parameter applies only if the layer participates in any relationships, and if queryOption property is Enums.GenerateLayerQueryOption Enums.GenerateLayerQueryOptionNone}.

Set this property to true for a layer or table to retrieve only rows or features used in relationships. A typical scenario is a feature layer related to a large table. By setting the large table's includeRelated to true, you can reduce the offline table size to just rows related to features that are part of the offline extent.

The default value of this property is false.


layerId : string

The ID of the layer or table to be included in the service-generated geodatabase.

This corresponds to ArcGISFeatureLayerInfo.serviceLayerId.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

Note: layerId and layerIdAsInt can be used interchangeably. Both reference the same underlying Runtime property.

See also layerIdAsInt.


layerIdAsInt : int

The same as layerId but represented as an integer type (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

Note: layerIdAsInt and layerId can be used interchangeably. Both reference the same underlying Runtime property.

This QML property was introduced in Esri.ArcGISRuntime 100.3.


queryOption : Enums.GenerateLayerQueryOption

Determines whether all, filtered, related, or no features will be copied from the server when creating a geodatabase.

The default is Enums.GenerateLayerQueryOptionUseFilter.

Determines which properties of this class apply. Valid combinations are:

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also Enums.GenerateLayerQueryOption.


useGeometry : bool

Whether to filter features to include in the geodatabase based on geometry.

This property only applies when the queryOption property is Enums.GenerateLayerQueryOptionUseFilter.

When this property is true, features intersecting GenerateGeodatabaseParameters.extent are candidates for taking offline.

If whereClause is also set, it further filters the features by attribute values.

The default value is true. However, for non-spatial tables, this property must be set to false.


whereClause : string

The attribute query used to filter which features should be included in the geodatabase.

The whereClause property only applies when the queryOption property is Enums.GenerateLayerQueryOptionUseFilter. It can be empty, in which case features are not filtered based on whereClause.

The candidate features from a where clause are also filtered by GenerateGeodatabaseParameters.extent if useGeometry is true.


Signal Documentation

includeRelatedChanged()

Emitted when the includeRelated property changes.


layerIdAsIntChanged()

Emitted when the layerIdAsInt property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.3.


layerIdChanged()

Emitted when the layerId property changes.


queryOptionChanged()

Emitted when the queryOption property changes.


useGeometryChanged()

Emitted when the useGeometry property changes.


whereClauseChanged()

Emitted when the whereClause property changes.



Feedback on this topic?