SetLabelFrequency [Levels]

SetLabelFrequency turns on/off a range of labels in a contour map.

Syntax

object.SetLabelFrequency( FirstIndex, NumberToSet, NumberToSkip )

Parameter

Type

Required/

Optional

Default

Description

FirstIndex

Integer

Required

 

This specifies the first contour to label, the contour index starts at one not at the minimum elevation number.

NumberToSet

Integer

Required

 

This specifies the number of contour lines to label.

NumberToSkip

Integer

Required

 

This specifies the number of contour lines to skip between labeled lines.

Remarks

Whether or not a contour line is labeled depends on the above settings as well as the LabelEdgeDist, LabelLabelDist, and LabelTolerance settings. The following examples assume that every line can be labeled.

Examples:

If NumberToSet is set to 1 and NumberToSkip is set to 0, all lines are labeled.

If NumberToSet is set to 1 and NumberToSkip is set to 1, every other line is labeled.

Example

This example demonstrates how to label every fourth contour starting with the first contour level.

Levels.SetLabelFrequency(FirstIndex:=1, NumberToSet:=1, NumberToSkip:=3)

Used by: Levels collection