Documentation
Reference
2.1.55 (current version)
collection
interactivityModel
Interfaces

geometryEditor.model.ChildLineString

Note. The constructor of the geometryEditor.model.ChildLineString class is hidden, as this class is not intended for autonomous initialization.

Extends IGeometryEditorChildModel.

Model of the child polyline. The constructor is not available in the package.full (a standard set of modules). This module is loaded on demand.

Fields | Methods

Fields

NameTypeDescription
editorIGeometryEditor

Geometry editor.

Inherited from IGeometryEditorChildModel.

eventsIEventManager

Event manager.

Inherited from IEventEmitter.

geometryIBaseGeometry

Geometry of the model.

Inherited from IGeometryEditorChildModel.

Methods

NameReturnsDescription
destroy()

Destructor.

Inherited from IGeometryEditorModel.

getAllVerticesNumber()

Integer

Returns the total number of vertexes in the geometry being edited.

getEdgeModels()

geometryEditor.model.Edge[]

Returns an array of models for interim placemarks.

getIndex()

Integer

Returns the index of the child polyline in the parent model.

getParent()

IGeometryEditorModel

Returns the parent data model.

Inherited from IGeometryEditorChildModel.

getPixels()

Number[]

Returns the model's pixel data.

Inherited from IGeometryEditorModel.

getVertexModels()

geometryEditor.model.ChildVertex[]

Returns an array of models for child vertexes.

setIndex(index)

Sets the index of the child polyline in the parent model.

setPixels(pixels)

Sets the model's pixel data.

Inherited from IGeometryEditorChildModel.

spliceVertices(start, deleteCount)

Number[][]

Deletes a defined number of polyline vertexes, starting from the specified index. New vertexes can be added in place of the deleted ones. Global pixel coordinates of the new vertexes can be passed as additional arguments after the "deleteCount" parameter.

Methods details

getAllVerticesNumber

{Integer} getAllVerticesNumber()

Returns the total number of vertexes in the geometry being edited.

getEdgeModels

{geometryEditor.model.Edge[]} getEdgeModels()

Returns an array of models for interim placemarks.

getIndex

{Integer} getIndex()

Returns the index of the child polyline in the parent model.

getVertexModels

{geometryEditor.model.ChildVertex[]} getVertexModels()

Returns an array of models for child vertexes.

setIndex

{} setIndex(index)

Sets the index of the child polyline in the parent model.

Parameters:

ParameterDefault valueDescription
index*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Integer

Index of a child vertex.

* Mandatory parameter/option.

spliceVertices

{Number[][]} spliceVertices(start, deleteCount)

Deletes a defined number of polyline vertexes, starting from the specified index. New vertexes can be added in place of the deleted ones. Global pixel coordinates of the new vertexes can be passed as additional arguments after the "deleteCount" parameter.

Returns an array of coordinates of deleted vertexes.

Parameters:

ParameterDefault valueDescription
start*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Integer

The index to start from for removing and adding vertexes.

deleteCount*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Integer

The number of deleted vertexes.

* Mandatory parameter/option.