LevelLayerDefinition Class

  • LevelLayerDefinition
  • class Esri::ArcGISRuntime::LevelLayerDefinition

    The layer and field properties for the layer that contains floor levels. More...

    Header: #include <LevelLayerDefinition.h>
    Since: Esri::ArcGISRuntime 100.12
    Inherits: Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::JsonSerializable

    This class was introduced in Esri::ArcGISRuntime 100.12.

    Public Functions

    LevelLayerDefinition(const QString &layerId, const QString &levelIdField, const QString &levelNumberField, const QString &shortNameField, const QString &longNameField, const QString &verticalOrderField, const QString &facilityIdField, QObject *parent = nullptr)
    virtual ~LevelLayerDefinition() override
    QString facilityIdField() const
    QString layerId() const
    QString levelIdField() const
    QString levelNumberField() const
    QString longNameField() const
    QString shortNameField() const
    QString verticalOrderField() const

    Reimplemented Public Functions

    virtual QString toJson() const override
    virtual QJsonObject unknownJson() const override
    virtual QJsonObject unsupportedJson() const override

    Static Public Members

    Esri::ArcGISRuntime::LevelLayerDefinition *fromJson(const QString &json, QObject *parent = nullptr)

    Detailed Description

    A LevelLayerDefinition describes the footprint of each occupiable floor contained in a managed facility.

    See also GeoModelFloorDefinition.

    Member Function Documentation

    LevelLayerDefinition::LevelLayerDefinition(const QString &layerId, const QString &levelIdField, const QString &levelNumberField, const QString &shortNameField, const QString &longNameField, const QString &verticalOrderField, const QString &facilityIdField, QObject *parent = nullptr)

    Creates a new LevelLayerDefinition object using the specified layer id, level id field, level number field, short name field, long name field, vertical order field, and facility id field.

    • layerId - An ID that specifies a layer in the map or scene that describes floor levels.
    • levelIdField - The name of the attribute field that contains each level feature's unique identifier.
    • levelNumberField - The name of the attribute field that contains each level feature's level number specific to its facility.
    • shortNameField - The name of the attribute field that contains each level feature's short name.
    • longNameField - The name of the attribute field that contains each level feature's long name.
    • verticalOrderField - The name of the attribute field that contains each level feature's vertical order.
    • facilityIdField - The name of the attribute field that contains each level feature's facility identifier (a foreign key to the layer that contains facility features).
    • parent - The optional parent QObject.

    [override virtual] LevelLayerDefinition::~LevelLayerDefinition()

    Destructor.

    QString LevelLayerDefinition::facilityIdField() const

    Returns the name of the attribute field that contains each floor level feature's facility identifier (a foreign key to the layer that contains facility features).

    [static] Esri::ArcGISRuntime::LevelLayerDefinition *LevelLayerDefinition::fromJson(const QString &json, QObject *parent = nullptr)

    Converts a JSON string and returns an object.

    • json - The JSON string.
    • parent The parent object (optional).

    QString LevelLayerDefinition::layerId() const

    Returns an ID that specifies a layer in the map or scene that contains floor level features.

    QString LevelLayerDefinition::levelIdField() const

    Returns the name of the attribute field that contains each floor level feature's unique identifier.

    QString LevelLayerDefinition::levelNumberField() const

    Returns the name of the attribute field that contains each floor level feature's level number specific to its facility.

    QString LevelLayerDefinition::longNameField() const

    Returns the name of the attribute field that contains each floor level feature's long name.

    QString LevelLayerDefinition::shortNameField() const

    Returns the name of the attribute field that contains each floor level feature's short name.

    [override virtual] QString LevelLayerDefinition::toJson() const

    Reimplements: JsonSerializable::toJson() const.

    Converts an object and returns a JSON string.

    [override virtual] QJsonObject LevelLayerDefinition::unknownJson() const

    Reimplements: JsonSerializable::unknownJson() const.

    Returns unknown data from the source JSON.

    Unknown JSON is a dictionary of values that was in the source JSON but was unparsed by the Runtime.

    See also JsonSerializable.

    [override virtual] QJsonObject LevelLayerDefinition::unsupportedJson() const

    Reimplements: JsonSerializable::unsupportedJson() const.

    Returns unsupported data from the source JSON.

    Unsupported JSON is a dictionary of values that are supported by webmaps, but not exposed through the native Runtime API.

    See also JsonSerializable.

    QString LevelLayerDefinition::verticalOrderField() const

    Returns the name of the attribute field that contains each floor level feature's vertical order.

    The vertical order defines the order of display in a floor filtering UI component, and it also references the floor levels of an Indoor Positioning System.

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