COM object EvGrid

EvApplication > EvFile > EvVariablesCollection > EvVariableBase As EvVariableAcoustic > EvVariableAcousticProperties > EvGrid

View the Echoview COM object hierarchy and the Echoview summary of COM objects.

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.

The following EvGrid methods and properties are detailed below:

Methods

Properties

SetDepthRangeGrid
SetTimeDistanceGrid

DepthRangeMode
TimeDistanceMode
DepthRangeReferenceLine
DepthRangeSeparation
TimeDistanceSeparation

EvGrid implements the following methods and properties:

EvGrid methods

Description

SetDepthRangeGrid

SetDepthRangeGrid(EDepthRangeGridMode GridMode, double Separation)

Summary

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

Parameters
  • GridMode
  • Specify the depth/range/reference-line mode of the depth/range grid. Use an enum for EDepthRangeGridMode.
  • Separation
  • 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:\Myriax\Echoview\Echoview5\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 GridMode, double Separation)

Summary

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

Parameters
  • GridMode
  • Specify the time/distance mode of the grid to be used. Use an enum for ETimeDistanceGridMode.
  • Separation
  • The distance between time/distance grid lines.
Return

None.

 

EvGrid properties

Description

DepthRangeMode

(read-only) EDepthRangeGridMode DepthRangeMode

Summary

Get the depth/range grid mode. This is specified by an enum for EDepthRangeGridMode.

TimeDistanceMode

(read-only) ETimeDistanceGridMode TimeDistanceMode

Summary

Get the time/distance grid mode. This is specified by an enum for ETimeDistanceGridMode.

DepthRangeReferenceLine

EvLine DepthRangeReferenceLine

Summary

Get the reference-line for the depth/range grid, this is provided as an EvLine.

Example

See SetDepthRangeGrid example

DepthRangeSeparation

(read-only) double DepthRangeSeparation

Summary

Get the depth/range separation of the grid.

TimeDistance Separation

(read-only) double TimeDistanceSeparation

Summary

Get the time/distance separation of the grid.

See also

Scripting with COM objects