Obsolete Members for DictionarySymbolStyle

  • DictionarySymbolStyle
  • The following members of class DictionarySymbolStyle are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

    Public Functions

    (deprecated) Esri::ArcGISRuntime::TaskWatcher fetchSymbol(const QVariantMap &keys)
    (deprecated) QFuture<Esri::ArcGISRuntime::Symbol *> fetchSymbolAsync(const QJsonObject &attributes, QObject *parent = nullptr)

    Member Function Documentation

    Esri::ArcGISRuntime::TaskWatcher DictionarySymbolStyle::fetchSymbol(const QVariantMap &keys)

    This function is deprecated. We strongly advise against using it in new code.

    Returns a Symbol, as defined by the input keys.

    This function is useful for obtaining a single, multi-layer symbol from supplied attributes. This is commonly used to create symbols and graphics on-the-fly. For example, with mil2525d, you may want to obtain a symbol where "symbolset" is 01 ("air"), "entity" is 110100 ("Military (Air) : Fixed-Wing"), "identity" is 3 ("friend"), and so on. All of these key/value pairs can be used to obtain the specific symbol that you need. Once you have that symbol, you can apply it to a Graphic or Renderer, obtain its swatch image, or serialize to JSON. The fetchSymbolCompleted signal emits once complete, giving access to the resulting symbol.

    If the DictionarySymbolStyle is not loaded then starting this task will start the load cycle.

    Note: For mil2525d, symbolset, entity, and identity fields are required to create a symbol.

    Note: Esri builds and maintains some dictionary web styles according to the US and NATO military symbol specifications. These desktop and web styles are hosted online and are publicly available. Refer to the ArcGIS Online Dictionary Symbology Styles group for the latest versions of the styles available.

    See also fetchSymbolCompleted.

    [since Esri::ArcGISRuntime 200.2] QFuture<Esri::ArcGISRuntime::Symbol *> DictionarySymbolStyle::fetchSymbolAsync(const QJsonObject &attributes, QObject *parent = nullptr)

    This function is deprecated. We strongly advise against using it in new code.

    Asynchronously returns a symbol based on the provided attributes.

    • attributes - a QJsonObject of QString type key and QVariant value. It is a key value pair for the attributes required to obtain symbol from the rule engine associated to Dictionary symbol style.
    • parent - The optional parent QObject

    This function is useful for obtaining a single, multi-layer symbol from supplied attributes. This is commonly used to create symbols and graphics on-the-fly. For example, with mil2525d, you may want to obtain a symbol where "symbolset" is 40, "modifier1" is "Incident Qualifier : Accident", "echelon" is "Army", and so on. All of these key/value pairs can be used to obtain the specific symbol that you need. Once you have that symbol, you can apply it to a Graphic or Renderer, obtain its swatch image, or serialize to JSON. If the DictionarySymbolStyle is not loaded then initiating this task will start the load cycle.

    This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

    See Working with QFuture for further details.

    This function was introduced in Esri::ArcGISRuntime 200.2.

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