AnnotationSublayer QML Type

  • Esri.ArcGISRuntime
  • AnnotationSublayer
  • Allows you to interrogate the properties of a sublayer within an annotation layer and to change the visibility of the sublayer. More...

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




    Detailed Description

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

    You can get a list of AnnotationSublayer from AnnotationLayer using LayerContent.subLayerContents. AnnotationSublayer objects only exist as part of an AnnotationLayer object, populated when the AnnotationLayer is loaded. They cannot exist separately. Annotation sublayers offer finer control over your annotation, allowing you to set different visual properties from the parent annotation layer. These visual properties include font, size, color, or different minimum and maximum scale ranges.

    See also LayerContent.

    Property Documentation

    autoFetchLegendInfos : bool

    Returns whether legend infos are automatically fetched by the sublayer.

    See also LayerContent.

    [read-only] canChangeVisibility : bool

    Returns whether the sublayer's visibility can be changed (read-only).

    See also LayerContent.

    [read-only] definitionExpression : string

    Returns which annotation features from the feature table are selected into this sublayer (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] legendInfos : LegendInfoListModel

    Returns a list model containing legend infos for the sublayer and any nested sublayers (read-only).

    See also LayerContent.

    [read-only] maxScale : double

    Returns the maximum scale at which to display the sublayer (read-only).

    [read-only] minScale : double

    Returns the minimum scale at which to display the sublayer (read-only).

    [read-only] name : string

    Returns the sublayer's name (read-only).

    See also LayerContent.

    [read-only] opacity : real

    Returns the opacity with which to display the annotation text associated with this sublayer (read-only).

    Opacity is a value between 0 and 1, with 0 indicating that the annotation will be completely transparent, and 1 indicating that the annotation will be completely opaque.

    [read-only] scaleSymbols : bool

    Returns whether the annotation text scales with the MapView (read-only).

    showInLegend : bool

    Whether the sublayer will be shown in the legend.

    See also LayerContent.

    [read-only] subLayerContents : list<LayerContent>

    Returns a list of layer contents for any sublayer (read-only).

    See also LayerContent.

    [read-only] subLayerId : string

    Returns a non-negative integer id number of the AnnotationSublayer within its AnnotationLayer (read-only).

    See also subLayerIdAsInt.

    [read-only] subLayerIdAsInt : double

    The same as subLayerId 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.

    visible : bool

    The visiblity of the subLayer.

    See also LayerContent.

    Method Documentation

    bool isVisibleAtScale(double scale)

    Returns true if the sublayer is visible at a given scale.

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