ArcGISMapServiceSublayerInfo QML Type

  • Esri.ArcGISRuntime
  • ArcGISMapServiceSublayerInfo
  • Information about an individual sublayer in an ArcGIS map service. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.1
    Inherits:

    Object

    Properties

    Methods

    • Field field(string fieldName)

    Detailed Description

    Note: You cannot declare or create a component of this type in QML code.

    Property Documentation

    [read-only] attribution : string

    Returns the attribution information (read-only).


    [read-only] canModifyLayer : bool

    Returns whether the sublayer supports modifying its renderer or its data source. (read-only).


    [read-only] canScaleSymbols : bool

    Returns whether the text and symbols on the sublayer will change as the map scale varies. (read-only).


    [read-only] capabilities : MapServiceCapabilities

    Returns the capabilities supported by the sublayer (read-only).


    [read-only] dataVersioned : bool

    Returns whether data in the service is versioned (read-only).


    [read-only, since Esri.ArcGISRuntime 100.3] defaultSubtypeCode : var

    Returns the layer's default subtype code (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only] defaultVisibility : bool

    Returns whether the sublayer is visible by default (read-only).


    [read-only] definitionExpression : string

    Returns the sublayer's definition expression (read-only).

    The definition expression string uses the SQL-92 WHERE clause syntax. Be sure to escape special characters in the expression string as required for your platform. The DATE keyword expects the date format yyyy-mm-dd and the TIMESTAMP keyword expects the time stamp format yyyy-mm-dd hh:mm:ss. See the ArcGIS Blog article Querying Feature Services Date-Time Queries for more information.


    [read-only] description : string

    Returns the description of the sublayer or table in the service (read-only).


    [read-only] displayFieldName : string

    Returns the name of the field that is used to display a title for features in the sublayer (read-only).


    [read-only] drawingInfo : DrawingInfo

    Returns information about how features in the service should be displayed on a map (read-only).


    [read-only] effectiveMaxScale : double

    Returns the maximum scale at which this sublayer or any of its parents is visible (read-only).

    If the map is zoomed in beyond this scale, the sublayer will not be visible.

    The maximum or minimum scale of a sublayer can be set individually, but at display time it will be overridden by the maximum or minimum scale of the parent layer if the parent layer has one.


    [read-only] effectiveMinScale : double

    Returns the minimum scale at which this sublayer or any of its parents is visible (read-only).

    If the map is zoomed out beyond this scale, the sublayer will not be visible.

    The maximum or minimum scale of a sublayer can be set individually, but at display time it will be overridden by the maximum or minimum scale of the parent layer if the parent layer has one.


    [read-only] extent : Envelope

    Returns the geographic extent this sublayer covers (read-only).


    [read-only, since Esri.ArcGISRuntime 100.3] featureSubtypes : list<FeatureSubtype>

    Returns a list of FeatureSubtype objects describing the subtypes of the layer (read-only).

    This list is included for layers that have subtypes. The domains in the types list will match the domains in the subtype list for layers that have a unique value renderer based on the subtype column.

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only] featureTypes : list<FeatureType>

    Returns a list of feature types representing feature subtypes in the sublayer (read-only).

    For example, a roads sublayer may contain 2 feature subtypes: highways and streets.


    [read-only] fields : list<Field>

    Returns the attribute fields (columns) available in the data (read-only).


    [read-only] geometryType : Enums.GeometryType

    Returns the type of geometry contained by features in the sublayer (read-only).

    See also Enums.GeometryType.


    [read-only] hasAttachments : bool

    Returns whether features in the sublayer may have attachments (read-only).


    [read-only] hasLabels : bool

    Returns whether the sublayer has labels defined on it (read-only).


    [read-only] hasM : bool

    Returns whether features in the sublayer may contain m-values (read-only).


    [read-only] hasZ : bool

    Returns whether features in the sublayer may contain z-values (read-only).


    [read-only] maxRecordCount : string

    Returns the maximum number of results returned by the service for any query operation (read-only).

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

    See also maxRecordCountAsInt.


    [read-only, since Esri.ArcGISRuntime 100.3] maxRecordCountAsInt : int

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

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

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only] maxScale : double

    Returns the maximum scale at which this sublayer is visible (read-only).

    If the map is zoomed in beyond this scale, the sublayer will not be visible.


    [read-only] minScale : double

    Returns the minimum scale at which this sublayer is visible (read-only).

    If the map is zoomed out beyond this scale, the sublayer will not be visible.


    [read-only] ownershipBasedAccessControl : OwnershipBasedAccessControlInfo

    Returns information about ownership-based access policies governing who can edit, delete, and query features (read-only).


    [read-only] parentLayerInfo : IdInfo

    Returns information that identifies the sublayer's parent layer (read-only).


    [read-only, since Esri.ArcGISRuntime 100.2] relationshipInfos : list<RelationshipInfo>

    Returns a list of RelationshipInfo objects that describe this sublayer's relationships with other sublayers in the ArcGIS Map Service (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.2.


    [read-only] serviceLayerId : string

    Returns the ID of the sublayer or table in the service (read-only).

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

    See also serviceLayerIdAsInt.


    [read-only, since Esri.ArcGISRuntime 100.3] serviceLayerIdAsInt : int

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

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

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only] serviceLayerName : string

    Returns the name of the sublayer or table in the service (read-only).


    [read-only] sublayerInfos : list<IdInfo>

    Returns information that identifies the sublayers of this sublayer (read-only).


    [read-only] sublayerType : Enums.ArcGISMapServiceSublayerType

    Returns the sublayer type of the service, such as Feature Layer, Raster Layer, etc... (read-only).

    See also Enums.ArcGISMapServiceSublayerType.


    [read-only, since Esri.ArcGISRuntime 100.3] subtypeField : string

    Returns the layer's subtype field (read-only).

    This is the field whose value determines the subtype of a feature. The value of this field corresponds to a subtype code for that feature.

    This property was introduced in Esri.ArcGISRuntime 100.3.

    See also FeatureSubtype::code.


    [read-only] supportsAdvancedQueries : bool

    Returns whether the service supports advanced query operations (such as ordering results, or returning distinct results) (read-only).


    [read-only] supportsStatistics : bool

    Returns whether the service is capable of returning statistics for query results (read-only).


    [read-only] timeInfo : LayerTimeInfo

    Returns temporal information for the sublayer such as start time field and end time field (read-only).


    [read-only] typeIdFieldName : string

    Returns the name of the field that contains the subtype information for each feature (read-only).


    [read-only] url : url

    Returns the URL of the sublayer (read-only).


    [read-only] useStandardizedQueries : bool

    Returns whether the sublayer requires the use of standardized queries (read-only).


    [read-only] version : string

    Returns the version of the service (read-only).


    Method Documentation

    Field field(string fieldName)

    A convenience method to find a field in a sublayer with a given fieldName.

    Since Esri.ArcGISRuntime 100.1, the fieldName parameter only accepts a field name.


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