Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.mapping.floor

Class LayerFloorDefinition

java.lang.Object
com.esri.arcgisruntime.mapping.floor.LayerFloorDefinition
All Implemented Interfaces:
JsonSerializable
public final class LayerFloorDefinition extends Object implements JsonSerializable
Describes how features in a FloorAware layer are associated with floor levels of a facility.

LayerFloorDefinition defines the properties that are used to filter the levels, or floors, of a facility.

Since:
100.12.0
See Also:

  • Constructor Details

    • LayerFloorDefinition

      public LayerFloorDefinition(String floorField)
      Creates a new LayerFloorDefinition object with a name of an attribute field.
      Parameters:
      floorField - the name of the attribute field that contains each floor level's ID
      Throws:
      IllegalArgumentException - if floorField is null
      Since:
      100.12.0

  • Method Details

    • getFloorField

      public String getFloorField()
      Gets the name of the attribute field that contains each floor level's ID.
      Returns:
      the name of the attribute field that contains each floor level's ID
      Since:
      100.12.0

    • getUnknownJson

      public Map<String,Object> getUnknownJson()
      Description copied from interface: JsonSerializable
      Gets unknown data from the source JSON.

      Unknown JSON is a Map of values not defined in the ArcGIS specification used to create this object but found in the source JSON. If the object is written back to JSON, any unknown JSON data is not persisted. The ArcGIS specification may be for a web map, web scene, REST API, and so on.

      Specified by:
      getUnknownJson in interface JsonSerializable
      Returns:
      an unmodifiable Map containing unknown data from the source JSON

    • getUnsupportedJson

      public Map<String,Object> getUnsupportedJson()
      Description copied from interface: JsonSerializable
      Gets unsupported data from the source JSON.

      Unsupported JSON is a Map of values defined in the ArcGIS specification used to create this object but not currently used in this API. If the object is written back to JSON, any unsupported JSON data is persisted. The ArcGIS specification may be from a web map, web scene, REST API, and so on.

      Specified by:
      getUnsupportedJson in interface JsonSerializable
      Returns:
      an unmodifiable Map containing unsupported data from the source JSON

    • fromJson

      public static LayerFloorDefinition fromJson(String json)
      Creates a LayerFloorDefinition instance from a JSON string.
      Parameters:
      json - a valid string in JSON format
      Returns:
      a LayerFloorDefinition instance
      Throws:
      IllegalArgumentException - if json is null or empty
      Since:
      100.12.0

    • toJson

      public String toJson()
      Description copied from interface: JsonSerializable
      Serializes this object to a JSON string. Note that unknown JSON is omitted from the serialized string.
      Specified by:
      toJson in interface JsonSerializable
      Returns:
      a JSON string