SymbolStyleSearchResult QML Type

  • Esri.ArcGISRuntime
  • SymbolStyleSearchResult
  • A search result object returned by symbol style. More...

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





    Detailed Description

    This object is returned by symbol style based on the search performed using search parameters. It contains the information related to name, tags, category, class type, and key associated to a symbol. It also returns the symbol.

    This object returns the results based on search performed in the symbol style using the search parameters. This returns the symbol and all the parameters associated with it.

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

    See also Cancelable, DictionarySymbolStyle, SymbolStyle, and SymbolStyleSearchParameters.

    Property Documentation

    [read-only] category : string

    Returns the category of this item (read-only).

    [read-only, since Esri.ArcGISRuntime 100.10] fetchSymbolResult : Symbol

    The result returned when the asynchronous fetchSymbol operation completes (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.10.

    [read-only, since Esri.ArcGISRuntime 100.10] fetchSymbolStatus : Enums.TaskStatus

    The current status of the asynchronous fetchSymbol operation (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.10.

    [read-only] key : string

    Returns the key of this item (read-only).

    [read-only] name : string

    Returns the name of this item (read-only).

    [read-only] symbolClass : string

    Returns the symbolClass of this item (read-only).

    [read-only] tags : list<string>

    Returns a string list of all the associated tags with this item (read-only).

    Signal Documentation

    [since Esri.ArcGISRuntime 100.10] fetchSymbolStatusChanged()

    Emitted when the fetchSymbolStatus property changes.

    Note: The corresponding handler is onFetchSymbolStatusChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.10.

    Method Documentation

    bool cancelTask(string taskId)

    Cancel the task with the ID taskId.

    Returns false if the task cannot be canceled or there is no task with the specified id taskId.

    See also Cancelable.

    [since Esri.ArcGISRuntime 100.10] string fetchSymbol()

    Asynchronously returns a symbol from the search result.

    Returns a string representing the task ID of the asynchronous task.

    This method was introduced in Esri.ArcGISRuntime 100.10.

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