ENVIGridLinesLayer

This is a reference to an ENVIGridLinesLayer object. Use the ENVIView::CreateGridLinesLayer method to create an ENVIGridLinesLayer object.

Example

; Launch the application

e = ENVI()

; Select an input file

file = Filepath('qb_boulder_msi', $

  ROOT_DIR=e.Root_Dir, SUBDIRECTORY=['data'])

raster = e.OpenRaster(file)

; Display the image

view = e.GetView()

layer = view.CreateLayer(raster)

; Create a grid lines layer

gridlineslayer = view.CreateGridLinesLayer()

; Change the transparency

gridlineslayer.Transparency = 50

view.Zoom, /FULL_EXTENT

Return Value

This function returns a reference to an ENVIGridLinesLayer.

Methods

Properties

COORDINATE_SYSTEM (Get, Set)

A fully qualified coordinate system string associated with the view. If no coordinate system is specified, then the coordinate system of the parent view will be used.

GEOGRAPHIC_FORMAT (Get, Set)

An integer that specifies the format for displaying coordinates when the grid represents a geographic coordinate system. The choices are:

0: Decimal degrees
1: Degrees, minutes
2: Degrees, minutes, seconds

GEOGRAPHIC_PRECISION (Get, Set)

An integer value that specifies the number of decimal places displayed for any GEOGRAPHIC_FORMAT setting.

GRID_COLOR (Get, Set)

The color of the grid lines and bounding box. You can specify colors in the following ways:

A string that contains a standard color name. You can use any of the string values defined by the IDL !COLOR system variable.
A string that contains a hexadecimal color value, preceded by the # symbol.
A three-element RGB vector in the form of [red, green, blue].

For example, the following values all specify the same color:

"light_blue"

"#ADD8E6"

[173, 216, 230]

For vector points, this property describes the symbol color. For vector polylines and polygons, this property describes the line color.

Note: When you get the GRID_COLOR property, the returned value is a three-element RGB vector, regardless of how the color was initially specified.

GRID_STYLE (Get, Set)

An integer value that specifies the line style used to draw the polyline. The choices are:

0: Solid (default)
1: Dotted
2: Dashed
3: Dash dot
4: Dash dot dot dot
5: Long dash
6: No line

GRID_THICKNESS (Get, Set)

A floating-point value between 0.0 and 10.0 that specifies the line thickness (in points) used to draw the grid lines.

HIDE (Get, Set)

Set this property to 1 to hide the layer, or set it to 0 to display it. The default value is 0.

INTERSECTIONS_SYMBOL_SIZE (Get, Set)

A floating-point value that specifies the size of the intersection symbols, in points.

NAME (Get, Set)

A string value with the name of the layer.

SHOW_BOX (Get, Set)

A Boolean value that controls the display of a bounding box along the edge of the grid.

SHOW_INTERSECTIONS (Get, Set)

A Boolean value that controls the display of crosshairs at grid line intersections.

SHOW_LINES (Get, Set)

A Boolean value that controls the display of the inner grid lines.

SHOW_TEXT (Get, Set)

A Boolean value that controls the display of coordinate labels along the outside edge of the grid.

TEXT_COLOR (Get, Set)

The color of the text labels. You can specify colors in the following ways:

A string that contains a standard color name. You can use any of the string values defined by the IDL !COLOR system variable.
A string that contains a hexadecimal color value, preceded by the # symbol.
A three-element RGB vector in the form of [red, green, blue].

For example, the following values all specify the same color:

"light_blue"

"#ADD8E6"

[173, 216, 230]

For vector points, this property describes the symbol color. For vector polylines and polygons, this property describes the line color.

Note: When you get the TEXT_COLOR property, the returned value is a three-element RGB vector, regardless of how the color was initially specified.

TEXT_FONT_NAME (Get, Set)

A string containing the name of the font used.

TEXT_FONT_SIZE (Get, Set)

A floating-point value that specifies the point size of the font.

TEXT_OFFSET (Get, Set)

A floating-point value that specifies the distance (in points) from the coordinate labels to the grid lines.

TEXT_ORIENTATION_X (Get, Set)

An integer value that specifies the orientation of the X labels:

0: Horizontal
1: Vertical

TEXT_ORIENTATION_Y (Get, Set)

An integer value that specifies the orientation of the Y labels:

0: Horizontal
1: Vertical

TRANSPARENCY (Get, Set)

An integer value between 0 (opaque) and 100 (invisible) that specifies the transparency of the layer. The default value is 0.

X_SPACING (Get, Set)

The spacing of grid lines in the X-direction, in the units of the current coordinate system (for example, in meters for a UTM projection).

Y_SPACING (Get, Set)

The spacing of grid lines in the Y-direction, in the units of the current coordinate system (for example, in meters for a UTM projection).

Version History

ENVI 5.3.2

Introduced

API Version

4.2