1v.label(1) Grass User's Manual v.label(1)
2
6 v.label - Create paint labels for GRASS vector file and attached
7 attributes.
8
10 vector, paint labels
11
13 v.label
14 v.label help
15 v.label [-ac] map=name [type=string[,string,...]] [layer=integer]
16 column=string labels=name [xoffset=float] [yoffset=float] [refer‐
17 ence=string[,string,...]] [font=string] [size=float]
18 [space=float] [fontsize=integer] [color=string] [rotation=angle]
19 [width=float] [hcolor=string] [hwidth=float] [background=string]
20 [border=string] [opaque=yes|no]
21 Flags:
23 -a Rotate labels to align with lines
24 -c Curl labels along lines
26 Parameters:
28 map=name
29 Name of input vector map
30 type=string[,string,...]
32 Type Options: point,line,boundary,centroid Default:
33 point,line,boundary,centroid
34 layer=integer
36 Layer number Default: 1
37 column=string
39 Name of attribute column to be used for labels
40 labels=name
42 Name for new paint-label file
43 xoffset=float
45 Offset label in x-direction Default: 0
46 yoffset=float
48 Offset label in y-direction Default: 0
49 reference=string[,string,...]
51 Reference position Options: center,left,right,upper,lower Default:
52 center
53 font=string
55 Font name Default: standard
56 size=float
58 Label size (in map-units) Default: 100
59 space=float
61 Space between letters for curled labels (in map-units)
62 fontsize=integer
64 Label size (in points) Options: 1-1000
65 color=string
67 Text color Options:
68 aqua,black,blue,brown,cyan,gray,green,grey,indigo,magenta,orange,pur‐
69 ple,red,violet,white,yellow Default: black
70 rotation=angle
72 Rotation angle (degrees counter-clockwise from East) Options: 0-360
73 Default: 0
74 width=float
76 Border width (only for ps.map output) Default: 1
77 hcolor=string
79 Highlight color for text Options:
80 none,aqua,black,blue,brown,cyan,gray,green,grey,indigo,magenta,orange,pur‐
81 ple,red,violet,white,yellow Default: none
82 hwidth=float
84 Width of highlight coloring Default: 0
85 background=string
87 Background color Options:
88 none,aqua,black,blue,brown,cyan,gray,green,grey,indigo,magenta,orange,pur‐
89 ple,red,violet,white,yellow Default: none
90 border=string
92 Border color Options:
93 none,aqua,black,blue,brown,cyan,gray,green,grey,indigo,magenta,orange,pur‐
94 ple,red,violet,white,yellow Default: none
95 opaque=yes|no
97 Opaque to vector (only relevant if background color is selected)
98 Options: yes,no Default: yes
99
101 v.label makes a label-file from a GRASS vector file with labels created
102 from attributes in the attached table.
103
105 If the fontsize option is given then the space option is determined
106 automatically from the current display window, otherwise the space
107 option should be set roughly the same as the size option.
108 A description of the labels file follows.
110 The file is located in $MAPSET/paint/labels/. The file is a plain-text
112 ASCII file containing the following fields:
113 Caution: The following information may be incomplete, out of date,
115 and wrong!
116 The label information that must be provided in the labels file is:
118 TEXT: Lines in multiple line labels will appear one above the next.
120 More than one line of text can be specified by notating the end
121 of a line with a '\n'.
122 (e.g. SPEARFISH\nSOUTH DAKOTA).
123 LOCATION:
125 Determines where the text will be located on the image. The
126 user specifies the easting and northing, and (optionally) speci‐
127 fies a vertical and horizontal offset from the specified east‐
128 ing/northing. These offsets are provided to allow finer place‐
129 ment of labels and are measured in local pixels. Thus in
130 d.labels the offset is measured in screen pixels, and in ps.map
131 the offset is measured in PostScript points (i.e. 1/72" steps).
132 PLACEMENT:
134 Determines which part of the label to which the location refers.
135 If placement is unspecified, the label is centered (center), by
136 default. Label placement may be specified as:
137 lower left (lower left corner of the text)
138 lower right (lower right corner of the text)
139 lower center (bottom center of the text)
140 upper left (upper left corner of the text)
141 upper right (upper right corner of the text)
142 upper center (top center of the text)
143 center (center of the text)
144 FONT: This specifies the font to use. The following fonts are avail‐
147 able:
148 cyrilc gothgbt gothgrt gothitt greekc greekcs greekp greeks italicc
150 italiccs italict romanc romancs romand romans romant scriptc scripts
151 The word standard can be used to specify the default font (which is
153 romans).
154 Note ps.map can override this setting to use other fonts; and d.labels
156 can be used with d.font to change the default font, or d.font.freetype
157 can be used to make the standard GRASS font something prettier.
158 TEXT SIZE:
160 This determines the size of the letters. The size specifies the
161 vertical height of the letters in meters on the ground. Thus
162 text will grow or shrink depending on the scale at which the map
163 is drawn. Alternatively fontsize can set the font size in nor‐
164 mal font points.
165 TEXT COLOR:
167 This selects the text color. If unspecified, the label's text
168 is drawn in black, by default. The text color can be specified
169 in one of four ways: By color name:
170 aqua black blue brown cyan gray green grey indigo magenta orange
171 purple red violet white yellow As red, green, blue percentages.
172 for example: .5 .4 .7
173 (This form is not supported by d.labels.) By printer color num‐
174 ber to get the exact printer color.
175 (This form is not supported by d.labels.) Specify none to sup‐
176 press the lettering.
177 WIDTH: This determines the line thickness of the border box.
179 (d.labels ignores this value and always uses 1.)
180 HIGHLIGHT COLOR:
182 The text can be highlighted in another color so that it appears
183 to be in two colors. The text is drawn first in this color at a
184 wider line width, and then redrawn in the text color at the reg‐
185 ular line width. No highlight color (none) is used, by default,
186 if unspecified by the user. To specify use of no highlight
187 color, specify none. (See TEXT COLOR above for a list of per‐
188 missible color names.)
189 HIGHLIGHT WIDTH:
191 Specifies how far from the text lines (in units of pixels) the
192 highlight color should extend. The default highlight width is
193 set to 0 (i.e., no highlight color).
194 BACKGROUND COLOR:
196 Text may be boxed in a solid color by specifying a background
197 color. Specify none for no background. The default background
198 color setting, if unspecified by the user, is white. (See TEXT
199 COLOR above for a list of permissible color names.)
200 BORDER COLOR:
202 Select a color for the border around the background. Specify
203 none to suppress the border. The default border color used, if
204 unspecified, is black. (See TEXT COLOR above for a list of per‐
205 missible color names.)
206 OPAQUE TO VECTORS:
208 yes|no. This field only has meaning if a background color is
209 selected. yes will prevent vector lines from entering the back‐
210 ground. no will allow vector lines to enter the background.
211 The default setting, if unspecified by the user, is yes.
212
214 d.labels
215 ps.map
216
218 Philip Verhagen (original s.label)
219 Radim Blazek
220 Last changed: $Date: 2005/11/01 00:01:58 $
222 Full index
224GRASS 6.2.2 v.label(1)