ReliefLayer Object

The ReliefLayer object has been deprecated. Use the ColorReliefLayer object with TerrainRepresentation set to srfTerrainRepresentationReflectance instead.

The ReliefLayer object contains the properties and methods for a shaded relief map created in Surfer with the Shapes method AddReliefLayer or AddReliefMap.

Derived from: Layer object, which is derived from Shape object(All methods and properties of Layer and Shape apply to this object.)

The following table provides the properties of the ReliefLayer object.

Property

Description

ColorMap

Returns the color map object. It is a read-only property.

GradientMethod

Returns/sets the gradient method.

Grid

Returns the grid object used to create the map. It is a read-only property.

GridFile

Returns/sets the name of the grid file used to create the map.

HLightAngle

Returns/sets the horizontal light position angle in degrees.

MissingDataColorRGBA

Returns the missing data RGBA color object. It is a read-only property.

Opacity

Returns/sets the opacity.

ShadingMethod

Returns/sets the shading method.

VLightAngle

Returns/sets the vertical light position angle in degrees.

zScale

Returns/sets the Z scale factor.

Example

The following script demonstrates how the ReliefLayer object is used in reference to the MapFrame object.

Sub Main

 

'Declares SurferApp as an object

Dim SurferApp As Object

 

'Creates an instance of the Surfer Application object and assigns it

'to the variable named "SurferApp"

Set SurferApp = CreateObject("Surfer.Application")

 

'Makes Surfer visible

SurferApp.Visible = True

 

'Declares Plot as an object

Dim Plot As Object

 

'Creates a plot document in Surfer and assigns it to the variable

'named "Plot"

Set Plot = SurferApp.Documents.Add(srfDocPlot)

 

'Declares Shapes as an object

Dim Shapes As Object

 

'Assigns the Shapes collection to the variable named "Shapes"

Set Shapes = Plot.Shapes

 

'Declares MapFrame as an object

Dim MapFrame As Object

 

'Creates a relief map and assigns the map coordinate system to the

'variable named "MapFrame"

Set MapFrame = Shapes.AddReliefMap(GridFileName:=SurferApp.Path+\Samples\demogrid.grd)

 

'Declares ReliefLayer as an object

Dim ReliefLayer As Object

 

'Assigns the relief map properties to the variable named "ReliefLayer"

Set ReliefLayer = MapFrame.Overlays(1)

 

End Sub