Class: GoUpDown

GoUpDown

Interaction to call a hydraulic tool that lets you know which pipes and which Wells you must act on to upDown the service in a preselected pipe:

new GoUpDown(pipeId, tablePipe, tableWells, userStylePipes, APP_ROOT_URL)

Interactions/Hydraulics/interact/upDownStream/index.ts, line 46
Name Type Description
pipeId String

The id from a preselected pipe.From this pipe the geospatial calculation will begin
tablePipe String

The Pipe database table name.
tableWells String

The Wells database table name.
userStylePipes module:types~styleFromUser

The style we want to put on the Pipes layer
APP_ROOT_URL String

default "http://localhost:5000"
Properties:
Name Type Description
userStylePipes types.styleFromUser
dataPipesNames Array.<string>
dataWellsNames Array.<string>
pipeLayerName string
map unknown
goMap unknown
svgIconWell unknown
svgIconLastWell unknown
lastWell GeoJSON | undefined
idMap unknown
idUpDown unknown

Methods

changeStyleWells(userStyle)

Interactions/Hydraulics/interact/upDownStream/index.ts, line 190

Change Wells style layer

Name Type Description
userStyle module:types~styleFromUser

User Style to the feature

clearFeatures(){void}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 244

Clear both Layers Pipes and Wells

Returns:
Type Description
void Return nothing

clearFeaturesLastHole(){void}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 273

Clear Last Hole Layer

Returns:
Type Description
void Return nothing

clearFeaturesPipes(){void}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 264

Clear Pipe Layer

Returns:
Type Description
void Return nothing

clearFeaturesWells(){void}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 255

Clear Wells Layer

Returns:
Type Description
void Return nothing

asyncgetDataupDown(idPipe, pipeName, municipalityId){Promise.<void>}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 204

This function resolve de updown

Name Type Description
idPipe String

The id from a preselected pipe. From this pipe the geospatial calculation will begin
pipeName String

Name of Layer Pipe
municipalityId String optional

Municipality where the calculation will be computed
Returns:
Type Description
Promise.<void> Return promise

getLayerLastHole(){VectorLayer}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 235

Get layer Last Hole

Returns:
Type Description
VectorLayer Return Vector layer

getLayerParams(){types.UpDownParams}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 435

Retrieves the parameters for the UpDown service.

Returns:
Type Description
types.UpDownParams
  • The current parameters of the UpDown service.

getLayerPipes(){VectorLayer}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 226

Get Pipe layer

Returns:
Type Description
VectorLayer Return Vector layer

getLayerWells(){VectorLayer}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 218

Get Wells layer

Returns:
Type Description
VectorLayer Return Vector layer

asyncgetUpDownService(paramsService, userStylePipes)

Interactions/Hydraulics/interact/upDownStream/index.ts, line 345

Get the information from geoespatial Tool

Name Type Description
paramsService module:types~UpDownParams

User Style to the feature
userStylePipes module:types~styleFromUser optional

User Style to the Pipe layer

refreshUpDown(){void}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 321

Refresh the upDown tool

Returns:
Type Description
void Return nothing

setDefaultStyle(){void}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 282

Set the default style for pipes

Returns:
Type Description
void Return nothing

setZIndex(value){void}

Interactions/Hydraulics/interact/upDownStream/index.ts, line 446

Sets the z-index for the layers related to UpDown functionality.

Name Type Description
value number

The base z-index value to set.
Returns:
Type Description
void