XYZ Maps Documentation
    Preparing search index...

    Class LineShape

    The LineShape represents a shape-point / coordinate of a Line feature. The LineShape is only existing if the corresponding Line feature is "selected" and user based geometry editing with touch/mouse interaction is activated.

    Line.select

    Hierarchy (View Summary)

    Index
    bbox? class geometry id properties type
    behavior getIndex getLength getLine getLineStringIndex getProvider isSelected remove select toJSON 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: string

    The feature class of a LineShape Feature is "LINE_SHAPE".

    geometry: { coordinates: [number, number, number?]; type: "Point" }

    Point geometry for the coordinate represented by this shape point.

    Type Declaration

    • coordinates: [number, number, number?]

      Coordinate of this LineShape in the parent Line geometry, as [x, y, z?].

    • type: "Point"

      Always "Point" because each LineShape represents one line coordinate.

    id: string | number

    id of the feature.

    properties: {
        button: number;
        index: number;
        LINE: any;
        lineStringIndex: number;
        moved: boolean;
        x: number;
        y: number;
        z: number;
    }

    Editor metadata for this shape point.

    type: string

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

    • Experimental

      Set the behavior options.

      Parameters

      • options: {
            dragAxis?: [number, number, number] | "X" | "Y" | "Z";
            dragPlane?: [number, number, number] | "XY" | "XZ" | "YZ";
        }
        • OptionaldragAxis?: [number, number, number] | "X" | "Y" | "Z"

          The drag axis across which the LineShape is dragged upon user interaction. Once "dragAxis" is set, "dragPlane" has no effect. In case "dragAxis" and "dragPlane" are set, "dragPlane" is preferred. In case "dragPlane" and "dragAxis" are both set, "dragPlane" is preferred.

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

          The normal of the plane over which the LineShape is dragged upon user interaction. Once "dragPlane" is set, "dragAxis" has no effect.

      Returns void

    • Experimental

      Set the value of a specific behavior option.

      Parameters

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

      Returns void

    • Experimental

      Get the value of a specific behavior option.

      Parameters

      • option: string

      Returns any

    • Experimental

      Get the behavior options.

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

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

        The drag axis across which the marker is dragged upon user interaction.

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

        The normal of the plane over which the marker is dragged upon user interaction.

    • Get the index of the shape point in the coordinates array of the respective LineString geometry.

      Returns number

      The index of the shape point.

    • Get the total number of coordinates of the LineString geometry.

      Returns number

      Number of coordinates

    • Get the Line feature to which the LineShape belongs.

      Returns Line

      the Line feature

    • Get the index of the coordinate array in the MultiLineString array of LineString coordinate arrays. For Line features with a geometry of type "LineString" the lineStringIndex is 0.

      Returns number

      the index of the coordinate array in the MultiLineString array of LineString coordinate arrays.

    • Will return true or false whether the Shape is currently selected.

      Returns boolean

    • Removes the shape point from the geometry of the Line feature.

      Returns void

    • Select the LineShape add it to the current selection. Multiple LineShapes can be selected at the same time. When a selected shape is dragged, all other shapes in the current selection are dragged as well.

      Returns void

    • Unselect the LineShape and remove from current selection.

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods