COM object EvGrid

EvApplication > EvFileCollection > EvFile > EvVariablesCollection > EvVariableAcoustic > EvVariableAcousticProperties > EvGrid

- OR -

EvApplication > EvFileCollection > EvFile > EvVariablesCollection > EvVariableVirtual > EvVariableAcousticProperties > EvGrid

 

View the COM map and the COM summary.

The EvGrid object provides information about and allows you to set the settings on the Grid page of the Variable Properties dialog box for the acoustic variable via the EvVariableAcousticProperties.Grid property.

EvGrid methods and properties:

DepthRangeMode
DepthRangeReferenceLine
DepthRangeSeparation
SetDepthRangeGrid
SetTimeDistanceGrid

TimeDistanceMode
TimeDistanceSeparation

 

Description

DepthRangeMode

(read-only) EDepthRangeGridMode DepthRangeMode

Summary

Get the depth/range grid mode.

Parameters

None

Return

An enum for EDepthRangeGridMode.

See also: Enum issue under VBS.

DepthRangeReferenceLine

EvLine DepthRangeReferenceLine

Summary

Get the reference-line for the depth/range grid.

Parameters

None.

Return

A depth/range reference line as EvLine.

Example

See SetDepthRangeGrid example

DepthRangeSeparation

(read-only) double DepthRangeSeparation

Summary

Get the depth/range separation of the grid.

Parameters

None.

Return

A number for the depth/range gride separation.

SetDepthRangeGrid

SetDepthRangeGrid(EDepthRangeGridMode eGridMode, double dSeparation)

Summary

Set the grid mode and separation of the depth/range grid lines.

Parameters
  • eGridMode
  • Specify the depth/range/reference-line mode of the depth/range grid. Use an enum for EDepthRangeGridMode.
  • See also: Enum issue under VBS.
  • dSeparation
  • The distance between depth/range grid lines.
Return

None.

Example
option explicit
Dim vEchoviewCom: Set vEchoviewCom = CreateObject("EchoviewCom.EvApplication")

Dim vEvFile: Set vEvFile = vEchoviewCom.OpenFile("C:\Echoview\Test.EV")
Dim vEvVariablesCollection: Set vEvVariablesCollection = vEvFile.Variables
Dim vEvVariable: Set vEvVariable = vEvVariablesCollection.FindByName("Sv V1 telegrams T1")

Dim vlineCollection: Set vlineCollection = vEvFile.Lines
Dim EvLine: Set EvLine = vlineCollection.FindByName("Line2")

vEvVariable.Properties.Grid.SetDepthRangeGrid 2, 20.0
' eReferenceLine = 2

vEvVariable.Properties.Grid.DepthRangeReferenceLine = EvLine
MsgBox "LINE is " + vEvVariable.Properties.Grid.DepthRangeReferenceLine.Name
Note: Test.EV is an EV file that contains a line called Line 2. The snippet uses Line 2 as a reference-line for the deph/range grid.

SetTimeDistanceGrid

SetTimeDistanceGrid(ETimeDistanceGridMode eGridMode, double dSeparation)

Summary

Set the grid mode and separation of the time/distance grid lines.

Parameters
  • eGridMode
  • Specify the time/distance mode of the grid to be used. Use an enum for ETimeDistanceGridMode.
  • See also: Enum issue under VBS.
  • dSeparation
  • The distance between time/distance grid lines.
Return

None.

TimeDistanceMode

(read-only) ETimeDistanceGridMode TimeDistanceMode

Summary

Get the time/distance grid mode.

Parameters

None.

Return

An enum for ETimeDistanceGridMode.

See also: Enum issue under VBS.

TimeDistanceSeparation

(read-only) double TimeDistanceSeparation

Summary

Get the time/distance separation of the grid.

Parameters

None.

Return

A number for the time/distance grid separation.

See also

Scripting with COM objects
COM object hierarchy