XYZ Maps Documentation
    Preparing search index...

    Class Address

    The Address Feature is a generic editable Feature with "Point" geometry. In addition to the Marker Feature, the Place feature must have a "routing point" located on a Navlink geometry. A Address must be linked/associated with a Navlink Feature.

    The Feature can be edited with the Editor.

    Instances are created with Editor.addFeature, the constructor is not part of the public API.

    const address = editor.addFeature({
        type: 'Feature',
        properties: {featureClass: 'ADDRESS'},
        geometry: {type: 'Point', coordinates: [78.3546, 17.3137]}
    }, layer);

    Hierarchy

    • Location
      • Address
    Index
    bbox class geometry id properties type
    behavior coord editable editState getLink getProvider prop remove select style toJSON toString transform unselect
    bbox: [number, number, number, number]

    Bounding box of the feature. The value of the bbox member is an array of length 4, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The "bbox" values define shapes with edges that follow lines of constant longitude and latitude.

    class: "ADDRESS"

    The feature class of an Address Feature is "ADDRESS".

    geometry: {
        _c?: any;
        coordinates:
            | GeoJSONCoordinate
            | GeoJSONCoordinate[]
            | GeoJSONCoordinate[][]
            | GeoJSONCoordinate[][][];
        type: | "Point"
        | "MultiPoint"
        | "LineString"
        | "MultiLineString"
        | "Polygon"
        | "MultiPolygon";
    }

    A geometry is a object where the type member's value is one of: "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon" or "MultiPolygon". A geometry object must have a member with the name "coordinates". The value of the coordinates member is always an array (referred to as the coordinates array below). The structure for the elements in this array are determined by the type of geometry.

    For type "Point", each element in the coordinates array is a number representing the point coordinate in one dimension. There must be at least two elements, and may be more. The order of elements must follow x, y, z order (or longitude, latitude, altitude for coordinates in a geographic coordinate reference system).

    For type "MultiPoint", each element in the coordinates array is a coordinates array as described for type "Point".

    For type "LineString", each element in the coordinates array is a coordinates array as described for type "Point". The coordinates array for a LineString must have two or more elements. A LinearRing is a special case of type LineString where the first and last elements in the coordinates array are equivalent (they represent equivalent points). Though a LinearRing is not explicitly represented as a geometry type, it is referred to in the Polygon geometry type definition.

    For type "MultiLineString", each element in the coordinates array is a coordinates array as described for type "LineString".

    For type "Polygon", each element in the coordinates array is a coordinates array as described for type "LineString". Furthermore, each LineString in the coordinates array must be a LinearRing. For Polygons with multiple LinearRings, the first must be the exterior ring and any others must be interior rings or holes.

    For type "MultiPolygon", each element in the coordinates array is a coordinates array as described for type "Polygon".

    Point:
    {
       "type": "Point",
       "coordinates": [100.0, 0.0]
    }

    Polygon:
    {
       "type": "Polygon",
       "coordinates": [
           [ [100.0, 0.0], [101.0, 0.0], [101.0, 1.0], [100.0, 1.0], [100.0, 0.0] ]
       ]
    }
    id: string | number

    id of the feature.

    properties: FeatureProperties

    The Properties of the feature

    type: string

    The type of the feature is a string with 'Feature' as its value.

    • Experimental

      Set or get behavior options for the location.

      Parameters

      • options: {
            autoResolveRoutingPoint?: boolean;
            dragAxis?: [number, number, number] | "X" | "Y" | "Z";
            dragPlane?: [number, number, number] | "XY" | "XZ" | "YZ";
            dragSurface?: "terrain";
        }
        • OptionalautoResolveRoutingPoint?: boolean

          Automatically resolves to the nearest Navlink when no valid routing point exists. Overrides the corresponding EditorOptions setting for this feature.

        • OptionaldragAxis?: [number, number, number] | "X" | "Y" | "Z"

          The axis along which the location can be dragged. Ignored if dragPlane or dragSurface is set.

        • OptionaldragPlane?: [number, number, number] | "XY" | "XZ" | "YZ"

          The normal of the plane over which the location is dragged. Overrides dragAxis if both are set. Ignored if dragSurface is set.

        • OptionaldragSurface?: "terrain"

          The surface over which the location is dragged. Takes precedence over both dragPlane and dragAxis.

      Returns void

    • Experimental

      Set a specific behavior option.

      Parameters

      • name: string
      • value: string | boolean | [number, number, number]

      Returns void

    • Experimental

      Get a specific behavior option.

      Parameters

      • option: string

      Returns any

    • Experimental

      Get all behavior options for the location.

      Returns {
          autoResolveRoutingPoint: boolean;
          dragAxis?: [number, number, number] | "X" | "Y" | "Z";
          dragPlane?: [number, number, number] | "XY" | "XZ" | "YZ";
          dragSurface?: "terrain";
      }

      • autoResolveRoutingPoint: boolean

        Includes the per-feature override and the global EditorOptions default.

      • OptionaldragAxis?: [number, number, number] | "X" | "Y" | "Z"

        The axis along which the location can be dragged.

      • OptionaldragPlane?: [number, number, number] | "XY" | "XZ" | "YZ"

        The normal of the plane over which the location is dragged.

      • OptionaldragSurface?: "terrain"

        The surface over which the location is dragged.

    • Define if the feature should be editable by the Editor module or not.

      Parameters

      • editable: boolean

        True, the feature can be edited, otherwise false.

      Returns Address

      // prevent the feature from being modified by the editor module
      object.editable(false);

    • Get a specific EditState of the feature.

      Parameters

      • state: "created" | "modified" | "removed" | "split" | "hovered" | "selected"

        the "EditState" to retrieve its value.

      • Optionalvalue: number | boolean

      Returns number | boolean

      the value of the respective "EditState".

    • Get the Navlink Feature that the feature is linked to/ associated with.

      Returns Navlink

      The Navlink Feature or null if the feature is not linked to a Navlink (floating).

    • Get a deep copy of the properties of the feature

      Returns { [name: string]: any }

    • Get the value of a specific property

      Parameters

      • property: string

        name of the property

      Returns any

      the value of the specific property

    • Set the value for a specific property

      Parameters

      • property: string

        name of the property

      • value: any

        the value that should be set for the property

      Returns void

    • Set one or more properties of the object.

      Parameters

      • properties: { [name: string]: any }

        the properties object literal that should be merged with the existing properties.

      Returns void

    • Remove the feature.

      Returns void

    • Select and highlight the feature. Selected features geometry is displayed and can easily be modified by mouse/touch interaction.

      Returns void

    • Get default or current style of the feature.

      Parameters

      • Optionaltype: "default" | "current"

        indicates which style to return. "default" -> layer default style for the feature or the "current" applied style.

      Returns CommonStyle[]

      the style of the feature

      • use layer.setStyleGroup instead
      "default"

    • Apply style to the feature.

      Parameters

      • style: CommonStyle[]

        the style to set for the feature

      Returns any

      • use layer.setStyleGroup instead

    • Returns a string representation of an object.

      Returns string

    • Enable Transform Utility to allow easy geometry transformation of the feature (move/scale/rotate) by mouse/touch interaction.

      Returns void

    • Unselect the feature.

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods