-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathmapscript.layerObj.html
More file actions
912 lines (811 loc) · 126 KB
/
mapscript.layerObj.html
File metadata and controls
912 lines (811 loc) · 126 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
<!DOCTYPE html>
<html lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>mapscript.layerObj — MapServer 8.6.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../../_static/sphinx.css?v=48f05237" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../../_static/sphinx_collapse.css?v=226d88b4" />
<link rel="stylesheet" type="text/css" href="../../../_static/custom.css?v=dd298242" />
<link rel="stylesheet" type="text/css" href="../../../_static/ribbon.css?v=ea091bf4" />
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=9a6d5eae"></script>
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../_static/copybutton.js?v=f281be69"></script>
<link rel="icon" href="../../../_static/mapserver.ico"/>
<link rel="author" title="About these documents" href="../../../about.html" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="copyright" title="Copyright" href="../../../copyright.html" />
<link rel="next" title="mapscript.legendObj" href="mapscript.legendObj.html" />
<link rel="prev" title="mapscript.labelObj" href="mapscript.labelObj.html" />
</head><body>
<!-- for main branch only, do not backport this -->
<table width="100%" style="width: 100%; background-color: white;">
<tr>
<td rowspan="2" style="padding: 10px 0px 10px 10px;">
<a href="../../../index.html" title="Home"><img src="../../../_static/banner.png" alt="MapServer banner" border="0" /></a>
</td>
<td style="padding: 10px 10px 0px 0px; text-align: right; vertical-align: top;">
<a href="../../../index.html" title="Home">Home</a> |
<a href="../../../products.html" title="Products (MapServer core, MapCache, TinyOWS">Products</a> |
<a href="https://github.com/mapserver/mapserver/issues/" title="Issue Tracker (MapServer core)">Issue Tracker</a> |
<a href="../../../community/service_providers.html" title="Professional Service Providers">Service Providers</a> |
<a href="../../../faq.html" title="Frequently Asked Questions">FAQ</a> |
<a href="https://fosstodon.org/@mapserver" title="Mastodon" target="_blank">Mastodon</a> |
<a href="../../../download.html" title="Download Source or Binaries">Download </a> |
<a class="badge" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KRJ2X44N3HA6U&source=url" target="_blank">
<img src="https://img.shields.io/badge/donate-%E2%9D%A4%C2%A0-ff69b4.svg?style=flat" alt="Donate to MapServer">
</a>
</td>
</tr>
<tr>
<td style="padding: 0px 10px 0px 0px; text-align: right; vertical-align: bottom;">
<img src="../../../_static/flagicons/en.png" alt="en" title="en" border="0" width="18px" height="13px"/>
<a href="../../../ar/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/ar.png" alt="ar" title="ar" border="0" /></a>
<a href="../../../de/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/de.png" alt="de" title="de" border="0" /></a>
<a href="../../../el/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/el.png" alt="el" title="el" border="0" /></a>
<a href="../../../es/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/es.png" alt="es" title="es" border="0" /></a>
<a href="../../../fr/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/fr.png" alt="fr" title="fr" border="0" /></a>
<a href="../../../id/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/id.png" alt="id" title="id" border="0" /></a>
<a href="../../../it/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/it.png" alt="it" title="it" border="0" /></a>
<a href="../../../ja/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/ja.png" alt="ja" title="ja" border="0" /></a>
<a href="../../../nl_NL/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/nl_NL.png" alt="nl_NL" title="nl_NL" border="0" /></a>
<a href="../../../pl/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/pl.png" alt="pl" title="pl" border="0" /></a>
<a href="../../../ru/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/ru.png" alt="ru" title="ru" border="0" /></a>
<a href="../../../sq/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/sq.png" alt="sq" title="sq" border="0" /></a>
<a href="../../../tr/mapscript/mapscript-api/stub/mapscript.layerObj.html"><img src="../../../_static/flagicons/tr.png" alt="tr" title="tr" border="0" /></a>
</td>
</tr>
</table>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="mapscript.legendObj.html" title="mapscript.legendObj"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="mapscript.labelObj.html" title="mapscript.labelObj"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../../../documentation.html" >MapServer 8.6.2 Documentation</a> »</li>
<li class="nav-item nav-item-2"><a href="../../index.html" >MapScript</a> »</li>
<li class="nav-item nav-item-3"><a href="../index.html" accesskey="U">SWIG MapScript API Reference</a> »</li>
<li class="nav-item nav-item-this"><a href="">mapscript.layerObj</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="mapscript-layerobj">
<h1>mapscript.layerObj<a class="headerlink" href="#mapscript-layerobj" title="Link to this heading">¶</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="mapscript.layerObj">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">mapscript.</span></span><span class="sig-name descname"><span class="pre">layerObj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mapscript.layerObj" title="Link to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="../../../mapfile/layer.html#layer"><span class="std std-ref">LAYER</span></a> object</p>
<p class="rubric">Overview</p>
<p>The layerObj has the following relationships:</p>
<img alt="../../../_images/layerObj_classObj.png" src="../../../_images/layerObj_classObj.png" />
<img alt="../../../_images/layerObj_hashTableObj.png" src="../../../_images/layerObj_hashTableObj.png" />
<img alt="../../../_images/layerObj_mapObj.png" src="../../../_images/layerObj_mapObj.png" />
<p class="rubric">Attributes</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">bandsitem</span></code></p></td>
<td><p><strong>char</strong> The attribute from the index file used to select the source raster band(s) to be used - normally NULL for default bands processing</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">bindvals</span></code></p></td>
<td><p><a class="reference internal" href="mapscript.hashTableObj.html#mapscript.hashTableObj" title="mapscript.hashTableObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">hashTableObj</span></code></a> <em>immutable</em> Relates to RFC59</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">classgroup</span></code></p></td>
<td><p><strong>char</strong> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-classgroup"><span class="std std-ref">CLASSGROUP</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">classitem</span></code></p></td>
<td><p><strong>char</strong> the attribute used to classify layer data - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-classitem"><span class="std std-ref">CLASSITEM</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">cluster</span></code></p></td>
<td><p><a class="reference internal" href="mapscript.clusterObj.html#mapscript.clusterObj" title="mapscript.clusterObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">clusterObj</span></code></a> <em>immutable</em> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-cluster"><span class="std std-ref">CLUSTER</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">compositer</span></code></p></td>
<td><p><strong>LayerCompositer</strong> <em>immutable</em> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-composite"><span class="std std-ref">COMPOSITE</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">connection</span></code></p></td>
<td><p><strong>char</strong> layer connection or data source name - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-connection"><span class="std std-ref">CONNECTION</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">connectionoptions</span></code></p></td>
<td><p><a class="reference internal" href="mapscript.hashTableObj.html#mapscript.hashTableObj" title="mapscript.hashTableObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">hashTableObj</span></code></a> <em>immutable</em> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-connectionoptions"><span class="std std-ref">CONNECTIONOPTIONS</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">connectiontype</span></code></p></td>
<td><p><strong>enum MS_CONNECTION_TYPE</strong> the layer connection type - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-connectiontype"><span class="std std-ref">CONNECTIONTYPE</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">data</span></code></p></td>
<td><p><strong>char</strong> Layer data definition, values depend upon connectiontype - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-data"><span class="std std-ref">DATA</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">debug</span></code></p></td>
<td><p><strong>int</strong> Enable debugging of layer- <a class="reference internal" href="../index.html#mapscript.MS_ON" title="mapscript.MS_ON"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_ON</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_OFF" title="mapscript.MS_OFF"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_OFF</span></code></a> (default) - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-debug"><span class="std std-ref">DEBUG</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">encoding</span></code></p></td>
<td><p><strong>char</strong> For iconving shape attributes, ignored if NULL or "utf-8" - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-encoding"><span class="std std-ref">ENCODING</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">extent</span></code></p></td>
<td><p><a class="reference internal" href="mapscript.rectObj.html#mapscript.rectObj" title="mapscript.rectObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">rectObj</span></code></a> <em>immutable</em> optional limiting extent for layer features - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-extent"><span class="std std-ref">EXTENT</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">filteritem</span></code></p></td>
<td><p><strong>char</strong> Attribute defining filter - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-filteritem"><span class="std std-ref">FILTERITEM</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">footer</span></code></p></td>
<td><p><strong>char</strong> filename to a template for result's footer - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-footer"><span class="std std-ref">FOOTER</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">group</span></code></p></td>
<td><p><strong>char</strong> Name of a group of layers - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-group"><span class="std std-ref">GROUP</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">header</span></code></p></td>
<td><p><strong>char</strong> filename to a template for result's header - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-header"><span class="std std-ref">HEADER</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">identificationclassauto</span></code></p></td>
<td><p><strong>int</strong> whether we should use the style of the WMS GetFeatureInfo request to precisely identify features.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">identificationclassgroup</span></code></p></td>
<td><p><strong>char</strong> name of the class group to use for WMS GetFeatureInfo request to precisely identify features.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">index</span></code></p></td>
<td><p><strong>int</strong> <em>immutable</em> Index of layer within parent map's layers array</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">labelcache</span></code></p></td>
<td><p><strong>int</strong> <a class="reference internal" href="../index.html#mapscript.MS_ON" title="mapscript.MS_ON"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_ON</span></code></a> (default) or <a class="reference internal" href="../index.html#mapscript.MS_OFF" title="mapscript.MS_OFF"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_OFF</span></code></a> - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-labelcache"><span class="std std-ref">LABELCACHE</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">labelitem</span></code></p></td>
<td><p><strong>char</strong> attribute defining feature label text - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-labelitem"><span class="std std-ref">LABELITEM</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">labelmaxscaledenom</span></code></p></td>
<td><p><strong>double</strong> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-labelmaxscaledenom"><span class="std std-ref">LABELMAXSCALEDENOM</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">labelminscaledenom</span></code></p></td>
<td><p><strong>double</strong> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-labelminscaledenom"><span class="std std-ref">LABELMINSCALEDENOM</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">labelrequires</span></code></p></td>
<td><p><strong>char</strong> Simple logical expression - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-labelrequires"><span class="std std-ref">LABELREQUIRES</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">map</span></code></p></td>
<td><p><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">mapObj</span></code></a> <em>immutable</em> Reference to parent map</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">mask</span></code></p></td>
<td><p><strong>char</strong> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-mask"><span class="std std-ref">MASK</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">maxclasses</span></code></p></td>
<td><p><strong>int</strong> <em>immutable</em> Used to track of the maximum number of classes - see RFC-17</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">maxfeatures</span></code></p></td>
<td><p><strong>int</strong> Maximum number of layer features that will be drawn - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-maxfeatures"><span class="std std-ref">MAXFEATURES</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">maxgeowidth</span></code></p></td>
<td><p><strong>double</strong> max map width (in map units) at which the layer should be drawn - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-maxgeowidth"><span class="std std-ref">MAXGEOWIDTH</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">maxscaledenom</span></code></p></td>
<td><p><strong>double</strong> Minimum scale at which layer will be drawn - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-maxscaledenom"><span class="std std-ref">MAXSCALEDENOM</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">metadata</span></code></p></td>
<td><p><a class="reference internal" href="mapscript.hashTableObj.html#mapscript.hashTableObj" title="mapscript.hashTableObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">hashTableObj</span></code></a> <em>immutable</em> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-metadata"><span class="std std-ref">METADATA</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">minfeaturesize</span></code></p></td>
<td><p><strong>int</strong> minimum feature size (in pixels) for shape</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">mingeowidth</span></code></p></td>
<td><p><strong>double</strong> min map width (in map units) at which the layer should be drawn - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-maxgeowidth"><span class="std std-ref">MAXGEOWIDTH</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">minscaledenom</span></code></p></td>
<td><p><strong>double</strong> Maximum scale at which layer will be drawn - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-minscaledenom"><span class="std std-ref">MINSCALEDENOM</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">name</span></code></p></td>
<td><p><strong>char</strong> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-name"><span class="std std-ref">NAME</span></a> - should be unique</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">numclasses</span></code></p></td>
<td><p><strong>int</strong> <em>immutable</em> Number of layer classes</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">numitems</span></code></p></td>
<td><p><strong>int</strong> <em>immutable</em> Number of layer feature attributes (items)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">numjoins</span></code></p></td>
<td><p><strong>int</strong> <em>immutable</em> Number of layer joins</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">numprocessing</span></code></p></td>
<td><p><strong>int</strong> <em>immutable</em> <strong>TODO</strong> Add documentation</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">offsite</span></code></p></td>
<td><p><a class="reference internal" href="mapscript.colorObj.html#mapscript.colorObj" title="mapscript.colorObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">colorObj</span></code></a> transparent pixel value for raster images - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-offsite"><span class="std std-ref">OFFSITE</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">plugin_library</span></code></p></td>
<td><p><strong>char</strong> Used to select the library to load by MapServer</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">plugin_library_original</span></code></p></td>
<td><p><strong>char</strong> this is needed for Mapfile writing</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">postlabelcache</span></code></p></td>
<td><p><strong>int</strong> <a class="reference internal" href="../index.html#mapscript.MS_ON" title="mapscript.MS_ON"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_ON</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_OFF" title="mapscript.MS_OFF"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_OFF</span></code></a> (default) - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-postlabelcache"><span class="std std-ref">POSTLABELCACHE</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">refcount</span></code></p></td>
<td><p><strong>int</strong> <em>immutable</em> reference counting, RFC24</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">rendermode</span></code></p></td>
<td><p><strong>enum MS_RENDER_MODE</strong> <a class="reference internal" href="../index.html#mapscript.MS_FIRST_MATCHING_CLASS" title="mapscript.MS_FIRST_MATCHING_CLASS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FIRST_MATCHING_CLASS</span></code></a> - default and historic MapServer behavior, <a class="reference internal" href="../index.html#mapscript.MS_ALL_MATCHING_CLASSES" title="mapscript.MS_ALL_MATCHING_CLASSES"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_ALL_MATCHING_CLASSES</span></code></a> - SLD behavior</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">requires</span></code></p></td>
<td><p><strong>char</strong> Context expressions, simple enough to not use expressionObj - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-requires"><span class="std std-ref">REQUIRES</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">sizeunits</span></code></p></td>
<td><p><strong>int</strong> applies to all classes - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-sizeunits"><span class="std std-ref">SIZEUNITS</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">startindex</span></code></p></td>
<td><p><strong>int</strong> Feature start index - used for paging</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">status</span></code></p></td>
<td><p><strong>int</strong> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-status"><span class="std std-ref">STATUS</span></a><a class="reference internal" href="../index.html#mapscript.MS_ON" title="mapscript.MS_ON"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_ON</span></code></a>, <a class="reference internal" href="../index.html#mapscript.MS_OFF" title="mapscript.MS_OFF"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_OFF</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_DEFAULT" title="mapscript.MS_DEFAULT"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_DEFAULT</span></code></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">styleitem</span></code></p></td>
<td><p><strong>char</strong> item to be used for style lookup - can also be 'AUTO' - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-styleitem"><span class="std std-ref">STYLEITEM</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">symbolscaledenom</span></code></p></td>
<td><p><strong>double</strong> scale at which symbols are default size - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-symbolscaledenom"><span class="std std-ref">SYMBOLSCALEDENOM</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">template</span></code></p></td>
<td><p><strong>char</strong> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-template"><span class="std std-ref">TEMPLATE</span></a> - global template, used across all classes</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">thisown</span></code></p></td>
<td><p>The membership flag</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">tileindex</span></code></p></td>
<td><p><strong>char</strong> layer index file for tiling support - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-tileindex"><span class="std std-ref">TILEINDEX</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">tileitem</span></code></p></td>
<td><p><strong>char</strong> attribute defining tile paths - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-tileitem"><span class="std std-ref">TILEITEM</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">tilesrs</span></code></p></td>
<td><p><strong>char</strong> name of the attribute that contains the SRS of an individual tile - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-tilesrs"><span class="std std-ref">TILESRS</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">tolerance</span></code></p></td>
<td><p><strong>double</strong> search buffer for point and line queries (in toleranceunits) - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-tolerance"><span class="std std-ref">TOLERANCE</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">toleranceunits</span></code></p></td>
<td><p><strong>int</strong> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-toleranceunits"><span class="std std-ref">TOLERANCEUNITS</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">transform</span></code></p></td>
<td><p><strong>int</strong> <a class="reference internal" href="../index.html#mapscript.MS_TRUE" title="mapscript.MS_TRUE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_TRUE</span></code></a> (default) or <a class="reference internal" href="../index.html#mapscript.MS_FALSE" title="mapscript.MS_FALSE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FALSE</span></code></a> whether or not layer data is to be transformed to image units - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-transform"><span class="std std-ref">TRANSFORM</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">type</span></code></p></td>
<td><p><strong>enum MS_LAYER_TYPE</strong> the layer type - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-type"><span class="std std-ref">TYPE</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">units</span></code></p></td>
<td><p><strong>int</strong> units of the layer - see <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-units"><span class="std std-ref">UNITS</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">utfdata</span></code></p></td>
<td><p><code class="xref py py-class docutils literal notranslate"><span class="pre">expressionObj</span></code> <em>immutable</em> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-utfdata"><span class="std std-ref">UTFDATA</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">utfitem</span></code></p></td>
<td><p><strong>char</strong> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-utfitem"><span class="std std-ref">UTFITEM</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">utfitemindex</span></code></p></td>
<td><p><strong>int</strong> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-classitem"><span class="std std-ref">CLASSITEM</span></a></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">validation</span></code></p></td>
<td><p><a class="reference internal" href="mapscript.hashTableObj.html#mapscript.hashTableObj" title="mapscript.hashTableObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">hashTableObj</span></code></a> <em>immutable</em> See <a class="reference internal" href="../../../mapfile/layer.html#mapfile-layer-validation"><span class="std std-ref">VALIDATION</span></a></p></td>
</tr>
</tbody>
</table>
<p class="rubric">Methods</p>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.__init__" title="Link to this definition">¶</a></dt>
<dd><p>A <a class="reference internal" href="#mapscript.layerObj" title="mapscript.layerObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">layerObj</span></code></a> is associated with <a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">mapObj</span></code></a>. An instance of
<a class="reference internal" href="#mapscript.layerObj" title="mapscript.layerObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">layerObj</span></code></a> can exist outside of a <a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">mapObj</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.addFeature">
<span class="sig-name descname"><span class="pre">addFeature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.shapeObj.html#mapscript.shapeObj" title="mapscript.shapeObj"><span class="pre">shapeObj</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.addFeature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.addFeature" title="Link to this definition">¶</a></dt>
<dd><p>Add a new inline feature on a layer. Returns -1 on error.
TODO: Is this similar to inline features in a mapfile? Does it work for any kind of layer or connection type?</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.addProcessing">
<span class="sig-name descname"><span class="pre">addProcessing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">directive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span> <span class="pre">const</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">void</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.addProcessing"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.addProcessing" title="Link to this definition">¶</a></dt>
<dd><p>Adds a new processing directive line to a layer, similar to the PROCESSING directive
in a map file. Processing directives supported are specific to the layer type and
underlying renderer.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.applySLD">
<span class="sig-name descname"><span class="pre">applySLD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sld</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stylelayer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.applySLD"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.applySLD" title="Link to this definition">¶</a></dt>
<dd><p>Apply the SLD document to the layer object. The matching between the SLD document and the
layer will be done using the layer’s name. If a <em>stylelayer</em> argument is passed (argument is optional),
the NamedLayer in the SLD that matches it will be used to style the layer.
See SLD HOWTO for more information on the SLD support.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.applySLDURL">
<span class="sig-name descname"><span class="pre">applySLDURL</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sld</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stylelayer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.applySLDURL"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.applySLDURL" title="Link to this definition">¶</a></dt>
<dd><p>Apply the SLD document pointed by the URL to the layer object. The matching between the SLD document and the
layer will be done using the layer’s name. If a <em>stylelayer</em> argument is passed (argument is optional),
the NamedLayer in the SLD that matches it will be used to style the layer.
See SLD HOWTO for more information on the SLD support.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.clearProcessing">
<span class="sig-name descname"><span class="pre">clearProcessing</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.clearProcessing"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.clearProcessing" title="Link to this definition">¶</a></dt>
<dd><p>Clears the layer’s raster processing directives.
Returns the subsequent number of directives, which will equal <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> if the
directives have been cleared.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.clone">
<span class="sig-name descname"><span class="pre">clone</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mapscript.layerObj" title="mapscript.layerObj"><span class="pre">layerObj</span></a></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.clone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.clone" title="Link to this definition">¶</a></dt>
<dd><p>Return an independent copy of the layer with no parent map.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In the Java & PHP modules this method is named <code class="docutils literal notranslate"><span class="pre">cloneLayer</span></code>.</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.close">
<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">void</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.close"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.close" title="Link to this definition">¶</a></dt>
<dd><p>Close the underlying layer.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.convertToString">
<span class="sig-name descname"><span class="pre">convertToString</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.convertToString"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.convertToString" title="Link to this definition">¶</a></dt>
<dd><p>Output the <a class="reference internal" href="#mapscript.layerObj" title="mapscript.layerObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">layerObj</span></code></a> object as a Mapfile string. Provides the inverse option for <a class="reference internal" href="#mapscript.layerObj.updateFromString" title="mapscript.layerObj.updateFromString"><code class="xref py py-func docutils literal notranslate"><span class="pre">layerObj.updateFromString()</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">image</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.imageObj.html#mapscript.imageObj" title="mapscript.imageObj"><span class="pre">imageObj</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.draw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.draw" title="Link to this definition">¶</a></dt>
<dd><p>Renders this layer into the target image, adding labels to the cache if required.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.drawQuery">
<span class="sig-name descname"><span class="pre">drawQuery</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">image</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.imageObj.html#mapscript.imageObj" title="mapscript.imageObj"><span class="pre">imageObj</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.drawQuery"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.drawQuery" title="Link to this definition">¶</a></dt>
<dd><p>Draw query map for a single layer into the target image.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.executeWFSGetFeature">
<span class="sig-name descname"><span class="pre">executeWFSGetFeature</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.executeWFSGetFeature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.executeWFSGetFeature" title="Link to this definition">¶</a></dt>
<dd><p>Executes a GetFeature request on a WFS layer and returns the name of the temporary GML file created. Returns an empty string on error.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.generateSLD">
<span class="sig-name descname"><span class="pre">generateSLD</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.generateSLD"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.generateSLD" title="Link to this definition">¶</a></dt>
<dd><p>Returns an SLD XML string based on all the classes found in the layer (the layer must have <code class="docutils literal notranslate"><span class="pre">STATUS</span> <span class="pre">ON`</span></code>).</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getClass">
<span class="sig-name descname"><span class="pre">getClass</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getClass"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getClass" title="Link to this definition">¶</a></dt>
<dd><p>Fetch the requested class object at <em>i</em>. Returns NULL if the class index is out of the legal range.
The numclasses field contains the number of classes available, and the first class is index 0.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getClassIndex">
<span class="sig-name descname"><span class="pre">getClassIndex</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.shapeObj.html#mapscript.shapeObj" title="mapscript.shapeObj"><span class="pre">shapeObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">classgroup</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numclasses</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getClassIndex"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getClassIndex" title="Link to this definition">¶</a></dt>
<dd><p>Get the class index for a shape in the layer.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getExtent">
<span class="sig-name descname"><span class="pre">getExtent</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="mapscript.rectObj.html#mapscript.rectObj" title="mapscript.rectObj"><span class="pre">rectObj</span></a></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getExtent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getExtent" title="Link to this definition">¶</a></dt>
<dd><p>Fetches the extents of the data in the layer. This normally requires a full read pass through the features of the layer and does not work for raster layers.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getFilterString">
<span class="sig-name descname"><span class="pre">getFilterString</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getFilterString"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getFilterString" title="Link to this definition">¶</a></dt>
<dd><p>Returns the current filter expression.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getGeomTransform">
<span class="sig-name descname"><span class="pre">getGeomTransform</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getGeomTransform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getGeomTransform" title="Link to this definition">¶</a></dt>
<dd><p>Return the geomtransform string for the layer.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getItem">
<span class="sig-name descname"><span class="pre">getItem</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">i</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getItem"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getItem" title="Link to this definition">¶</a></dt>
<dd><p>Returns the requested item. Items are attribute fields, and this method returns the
item name (field name). The numitems field contains the number of items available, and the first item is index zero.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getItemDefinitions">
<span class="sig-name descname"><span class="pre">getItemDefinitions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getItemDefinitions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getItemDefinitions" title="Link to this definition">¶</a></dt>
<dd><p><strong>Python MapScript only</strong></p>
<p>Return item (field) names and their types if available.
Field types are specified using GML metadata and can be one of the following:</p>
<p><code class="docutils literal notranslate"><span class="pre">Integer|Long|Real|Character|Date|Boolean</span></code></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getItemType">
<span class="sig-name descname"><span class="pre">getItemType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">i</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getItemType"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getItemType" title="Link to this definition">¶</a></dt>
<dd><p>Returns the requested item’s field type.
A layer must be open to retrieve the item definition.</p>
<p>Pass in the attribute index to retrieve the type. The
layer’s numitems property contains the number of items
available, and the first item is index zero.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getNumFeatures">
<span class="sig-name descname"><span class="pre">getNumFeatures</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getNumFeatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getNumFeatures" title="Link to this definition">¶</a></dt>
<dd><p>Returns the number of inline features in a layer.
TODO: is this really only online features or will it return the number of non-inline features on a regular layer?</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getNumProcessing">
<span class="sig-name descname"><span class="pre">getNumProcessing</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getNumProcessing"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getNumProcessing" title="Link to this definition">¶</a></dt>
<dd><p>Return the number of processing directives</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getNumResults">
<span class="sig-name descname"><span class="pre">getNumResults</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getNumResults"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getNumResults" title="Link to this definition">¶</a></dt>
<dd><p>Returns the number of entries in the query result cache for this layer.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getOpacity">
<span class="sig-name descname"><span class="pre">getOpacity</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getOpacity"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getOpacity" title="Link to this definition">¶</a></dt>
<dd><p>Returns the opacity value for the layer.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getProcessing">
<span class="sig-name descname"><span class="pre">getProcessing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getProcessing"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getProcessing" title="Link to this definition">¶</a></dt>
<dd><p>Return the raster processing directive at <em>index</em>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getProcessingKey">
<span class="sig-name descname"><span class="pre">getProcessingKey</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span> <span class="pre">const</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getProcessingKey"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getProcessingKey" title="Link to this definition">¶</a></dt>
<dd><p>Return the processing directive specified by <em>key</em>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getProjection">
<span class="sig-name descname"><span class="pre">getProjection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getProjection"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getProjection" title="Link to this definition">¶</a></dt>
<dd><p>Returns the PROJ definition of the layer’s projection.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getResult">
<span class="sig-name descname"><span class="pre">getResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">i</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="mapscript.resultObj.html#mapscript.resultObj" title="mapscript.resultObj"><span class="pre">resultObj</span></a></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getResult"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getResult" title="Link to this definition">¶</a></dt>
<dd><p>Fetches the requested query result cache entry, or NULL if the index is outside
the range of available results. This method would normally only be used after
issuing a query operation.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getResults">
<span class="sig-name descname"><span class="pre">getResults</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="mapscript.resultCacheObj.html#mapscript.resultCacheObj" title="mapscript.resultCacheObj"><span class="pre">resultCacheObj</span></a></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getResults"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getResults" title="Link to this definition">¶</a></dt>
<dd><p>Returns a reference to layer’s result cache. Should be NULL prior to any query, or after a failed query or query with no results.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getResultsBounds">
<span class="sig-name descname"><span class="pre">getResultsBounds</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="mapscript.rectObj.html#mapscript.rectObj" title="mapscript.rectObj"><span class="pre">rectObj</span></a></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getResultsBounds"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getResultsBounds" title="Link to this definition">¶</a></dt>
<dd><p>Returns the bounds of the features in the result cache.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getShape">
<span class="sig-name descname"><span class="pre">getShape</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">record</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.resultObj.html#mapscript.resultObj" title="mapscript.resultObj"><span class="pre">resultObj</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="mapscript.shapeObj.html#mapscript.shapeObj" title="mapscript.shapeObj"><span class="pre">shapeObj</span></a></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getShape"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getShape" title="Link to this definition">¶</a></dt>
<dd><p>Get a shape from layer data. Argument is a result cache member from <a class="reference internal" href="#mapscript.layerObj.getResult" title="mapscript.layerObj.getResult"><code class="xref py py-func docutils literal notranslate"><span class="pre">layerObj.getResult()</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.getWMSFeatureInfoURL">
<span class="sig-name descname"><span class="pre">getWMSFeatureInfoURL</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">click_x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">click_y</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">feature_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">char</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.getWMSFeatureInfoURL"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.getWMSFeatureInfoURL" title="Link to this definition">¶</a></dt>
<dd><p>Return a WMS GetFeatureInfo URL (works only for WMS layers) <em>clickX</em>, <em>clickY</em>
is the location of to query in pixel coordinates with (0,0) at the top
left of the image. <em>featureCount</em> is the number of results to return. <em>infoFormat</em>
is the format the format in which the result should be requested.
Depends on remote server’s capabilities. MapServer WMS servers support only “MIME”
(and should support “GML.1” soon). Returns “” and outputs a warning if layer is not a
WMS layer or if it is not queryable.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.insertClass">
<span class="sig-name descname"><span class="pre">insertClass</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.insertClass"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.insertClass" title="Link to this definition">¶</a></dt>
<dd><p>Insert a <strong>copy</strong> of the class into the layer at the requested <em>index</em>.
Default index of -1 means insertion at the end of the array of classes. Returns the index at which the class was inserted.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.isVisible">
<span class="sig-name descname"><span class="pre">isVisible</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.isVisible"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.isVisible" title="Link to this definition">¶</a></dt>
<dd><p>Returns <a class="reference internal" href="../index.html#mapscript.MS_TRUE" title="mapscript.MS_TRUE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_TRUE</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FALSE" title="mapscript.MS_FALSE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FALSE</span></code></a> after considering the layer status,
minscaledenom, and maxscaledenom within the context of the parent map.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.moveClassDown">
<span class="sig-name descname"><span class="pre">moveClassDown</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.moveClassDown"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.moveClassDown" title="Link to this definition">¶</a></dt>
<dd><p>The class specified by the class index will be moved up into the array of classes.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a>. For example <code class="docutils literal notranslate"><span class="pre">moveClassDown(1)</span></code> will have the effect
of moving class 1 down to position 2, and the class at position 2 will be moved to position 1.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.moveClassUp">
<span class="sig-name descname"><span class="pre">moveClassUp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.moveClassUp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.moveClassUp" title="Link to this definition">¶</a></dt>
<dd><p>The class specified by the class index will be moved up in the array of classes.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a>. For example <code class="docutils literal notranslate"><span class="pre">moveClassUp(1)</span></code> will have the effect
of moving class 1 up to position 0, and the class at position 0 will be moved to position 1.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.nextShape">
<span class="sig-name descname"><span class="pre">nextShape</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="mapscript.shapeObj.html#mapscript.shapeObj" title="mapscript.shapeObj"><span class="pre">shapeObj</span></a></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.nextShape"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.nextShape" title="Link to this definition">¶</a></dt>
<dd><p>Called after <a class="reference internal" href="#mapscript.layerObj.whichShapes" title="mapscript.layerObj.whichShapes"><code class="xref py py-func docutils literal notranslate"><span class="pre">layerObj.whichShapes()</span></code></a> has been called to actually
retrieve shapes within a given area returns a shape object or <a class="reference internal" href="../index.html#mapscript.MS_FALSE" title="mapscript.MS_FALSE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FALSE</span></code></a>
Example of usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mapObj</span> <span class="nb">map</span> <span class="o">=</span> <span class="n">new</span> <span class="n">mapObj</span><span class="p">(</span><span class="s2">"d:/msapps/gmap-ms40/htdocs/gmap75.map"</span><span class="p">);</span>
<span class="n">layerObj</span> <span class="n">layer</span> <span class="o">=</span> <span class="nb">map</span><span class="o">.</span><span class="n">getLayerByName</span><span class="p">(</span><span class="s1">'road'</span><span class="p">);</span>
<span class="nb">int</span> <span class="n">status</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">open</span><span class="p">();</span>
<span class="n">status</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">whichShapes</span><span class="p">(</span><span class="nb">map</span><span class="o">.</span><span class="n">extent</span><span class="p">);</span>
<span class="n">shapeObj</span> <span class="n">shape</span><span class="p">;</span>
<span class="k">while</span> <span class="p">((</span><span class="n">shape</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">nextShape</span><span class="p">())</span> <span class="o">!=</span> <span class="n">null</span><span class="p">)</span>
<span class="p">{</span>
<span class="o">...</span>
<span class="p">}</span>
<span class="n">layer</span><span class="o">.</span><span class="n">close</span><span class="p">();</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.open">
<span class="sig-name descname"><span class="pre">open</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.open"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.open" title="Link to this definition">¶</a></dt>
<dd><p>Opens the underlying layer. This is required before operations like <a class="reference internal" href="#mapscript.layerObj.getResult" title="mapscript.layerObj.getResult"><code class="xref py py-func docutils literal notranslate"><span class="pre">layerObj.getResult()</span></code></a>
will work, but is not required before a draw or query call.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.queryByAttributes">
<span class="sig-name descname"><span class="pre">queryByAttributes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">qitem</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qstring</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.queryByAttributes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.queryByAttributes" title="Link to this definition">¶</a></dt>
<dd><p>Query layer for shapes that intersect current map extents. <em>qitem</em> is the item (attribute)
on which the query is performed, and <em>qstring</em> is the expression to match.
The query is performed on all the shapes that are part of a CLASS that contains a TEMPLATE value or that match any class in a layer that contains a LAYER TEMPLATE value.
Note that the layer’s FILTER/FILTERITEM are ignored by this function. <em>mode</em> is <a class="reference internal" href="../index.html#mapscript.MS_SINGLE" title="mapscript.MS_SINGLE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SINGLE</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_MULTIPLE" title="mapscript.MS_MULTIPLE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_MULTIPLE</span></code></a> depending on number of results you want.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> if the query was successfully performed, regardless of whether any shapes were found, or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a> if an error occurred.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.queryByFeatures">
<span class="sig-name descname"><span class="pre">queryByFeatures</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">slayer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.queryByFeatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.queryByFeatures" title="Link to this definition">¶</a></dt>
<dd><p>Perform a query set based on a previous set of results from another layer.
At present the results MUST be based on a polygon layer.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> if the query was successfully performed, regardless of whether any shapes were found, or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a> if an error occurred.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.queryByFilter">
<span class="sig-name descname"><span class="pre">queryByFilter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.queryByFilter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.queryByFilter" title="Link to this definition">¶</a></dt>
<dd><p>Query by the filter <em>string</em>.
For querying, we switch layer status ON and then back to original
value before returning.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.queryByIndex">
<span class="sig-name descname"><span class="pre">queryByIndex</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">tileindex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shapeindex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bAddToQuery</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.queryByIndex"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.queryByIndex" title="Link to this definition">¶</a></dt>
<dd><p>Pop a query result member into the layer’s result cache. By default clobbers existing cache.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.queryByPoint">
<span class="sig-name descname"><span class="pre">queryByPoint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">point</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.pointObj.html#mapscript.pointObj" title="mapscript.pointObj"><span class="pre">pointObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">double</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.queryByPoint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.queryByPoint" title="Link to this definition">¶</a></dt>
<dd><p>Query layer at point location specified in georeferenced map coordinates (i.e. not pixels).
The query is performed on all the shapes that are part of a CLASS that contains a TEMPLATE value or that match any class in a layer that contains a LAYER TEMPLATE value.
Note that the layer’s FILTER/FILTERITEM are ignored by this function. <em>mode</em> is <a class="reference internal" href="../index.html#mapscript.MS_SINGLE" title="mapscript.MS_SINGLE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SINGLE</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_MULTIPLE" title="mapscript.MS_MULTIPLE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_MULTIPLE</span></code></a> depending on number of results you want.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> if the query was successfully performed, regardless of whether any shapes were found, or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a> if an error occurred.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.queryByRect">
<span class="sig-name descname"><span class="pre">queryByRect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">rect</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.rectObj.html#mapscript.rectObj" title="mapscript.rectObj"><span class="pre">rectObj</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.queryByRect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.queryByRect" title="Link to this definition">¶</a></dt>
<dd><p>Query layer using a rectangle specified in georeferenced map coordinates (i.e. not pixels).
The query is performed on all the shapes that are part of a CLASS that contains a TEMPLATE value or that match any class in a layer that contains a LAYER TEMPLATE value.
Note that the layer’s FILTER/FILTERITEM are ignored by this function. The <a class="reference internal" href="../index.html#mapscript.MS_MULTIPLE" title="mapscript.MS_MULTIPLE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_MULTIPLE</span></code></a> mode is set by default.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> if the query was successfully performed, regardless of whether any shapes were found, or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a> if an error occurred.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.queryByShape">
<span class="sig-name descname"><span class="pre">queryByShape</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.mapObj.html#mapscript.mapObj" title="mapscript.mapObj"><span class="pre">mapObj</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.shapeObj.html#mapscript.shapeObj" title="mapscript.shapeObj"><span class="pre">shapeObj</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.queryByShape"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.queryByShape" title="Link to this definition">¶</a></dt>
<dd><p>Query layer based on a single shape, the shape has to be a polygon at this point.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> if the query was successfully performed, regardless of whether any shapes were found, or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a> if an error occurred.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.removeClass">
<span class="sig-name descname"><span class="pre">removeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="mapscript.classObj.html#mapscript.classObj" title="mapscript.classObj"><span class="pre">classObj</span></a></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.removeClass"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.removeClass" title="Link to this definition">¶</a></dt>
<dd><p>Removes the class at <em>index</em> and returns a copy, or NULL in the case of a failure.
Note that subsequent classes will be renumbered by this operation.
The numclasses field contains the number of classes available.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.setConnectionType">
<span class="sig-name descname"><span class="pre">setConnectionType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connectiontype</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">library_str</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span> <span class="pre">const</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.setConnectionType"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.setConnectionType" title="Link to this definition">¶</a></dt>
<dd><p>Changes the connectiontype of the layer and recreates the vtable according to the new
connection type. This method should be used instead of setting the <em>connectiontype</em>
parameter directly. In case when the layer.connectiontype = <a class="reference internal" href="../index.html#mapscript.MS_PLUGIN" title="mapscript.MS_PLUGIN"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_PLUGIN</span></code></a> the <em>library_str</em>
parameter should also be specified so as to select the library to load by MapServer.
For the other connection types this parameter should be set to an empty string “”.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.setExtent">
<span class="sig-name descname"><span class="pre">setExtent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">minx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">double</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">miny</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">double</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">double</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">double</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-1.0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.setExtent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.setExtent" title="Link to this definition">¶</a></dt>
<dd><p>Sets the extent of a layer.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.setFilter">
<span class="sig-name descname"><span class="pre">setFilter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.setFilter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.setFilter" title="Link to this definition">¶</a></dt>
<dd><p>Sets a filter expression similarly to the FILTER expression in a map file.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a> if the expression fails to parse.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.setGeomTransform">
<span class="sig-name descname"><span class="pre">setGeomTransform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transform</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">void</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.setGeomTransform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.setGeomTransform" title="Link to this definition">¶</a></dt>
<dd><p>Set the geomtransform string for the layer.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.setItems">
<span class="sig-name descname"><span class="pre">setItems</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numitems</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.setItems"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.setItems" title="Link to this definition">¶</a></dt>
<dd><p>Set the items to be retrieved with a particular shape.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.setOpacity">
<span class="sig-name descname"><span class="pre">setOpacity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">opacity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">void</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.setOpacity"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.setOpacity" title="Link to this definition">¶</a></dt>
<dd><p>Sets an opacity for the layer, where the value is an integer in range [0, 100].
A new <a class="reference internal" href="../../../mapfile/composite.html#composite"><span class="std std-ref">COMPOSITE</span></a> block is generated, containing this <code class="docutils literal notranslate"><span class="pre">OPACITY</span></code> value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.setProcessingKey">
<span class="sig-name descname"><span class="pre">setProcessingKey</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span> <span class="pre">const</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span> <span class="pre">const</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">void</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.setProcessingKey"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.setProcessingKey" title="Link to this definition">¶</a></dt>
<dd><p>Adds or replaces a processing directive of the form “key=value”.
Unlike the <a class="reference internal" href="#mapscript.layerObj.addProcessing" title="mapscript.layerObj.addProcessing"><code class="xref py py-func docutils literal notranslate"><span class="pre">layerObj.addProcessing()</span></code></a> function, this will replace an existing processing directive
for the given key value. Processing directives supported are specific to the layer type
and underlying renderer.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.setProjection">
<span class="sig-name descname"><span class="pre">setProjection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proj4</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.setProjection"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.setProjection" title="Link to this definition">¶</a></dt>
<dd><p>Set the layer projection using a PROJ format projection definition
(i.e. “+proj=utm +zone=11 +datum=WGS84” or “init=EPSG:26911”).
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.setWKTProjection">
<span class="sig-name descname"><span class="pre">setWKTProjection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wkt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.setWKTProjection"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.setWKTProjection" title="Link to this definition">¶</a></dt>
<dd><p>Set the layer projection using OpenGIS Well Known Text format.
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.updateFromString">
<span class="sig-name descname"><span class="pre">updateFromString</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">snippet</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">char</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.updateFromString"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.updateFromString" title="Link to this definition">¶</a></dt>
<dd><p>Update a <a class="reference internal" href="#mapscript.layerObj" title="mapscript.layerObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">layerObj</span></code></a> from a string snippet. Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mapscript.layerObj.whichShapes">
<span class="sig-name descname"><span class="pre">whichShapes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rect</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mapscript.rectObj.html#mapscript.rectObj" title="mapscript.rectObj"><span class="pre">rectObj</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#layerObj.whichShapes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.layerObj.whichShapes" title="Link to this definition">¶</a></dt>
<dd><p>Performs a spatial, and optionally an attribute based feature search.
The function basically prepares things so that candidate features can be accessed by
query or drawing functions (e.g using <a class="reference internal" href="#mapscript.layerObj.nextShape" title="mapscript.layerObj.nextShape"><code class="xref py py-func docutils literal notranslate"><span class="pre">layerObj.nextShape()</span></code></a> function).
Returns <a class="reference internal" href="../index.html#mapscript.MS_SUCCESS" title="mapscript.MS_SUCCESS"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_SUCCESS</span></code></a>, <a class="reference internal" href="../index.html#mapscript.MS_FAILURE" title="mapscript.MS_FAILURE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_FAILURE</span></code></a> or <a class="reference internal" href="../index.html#mapscript.MS_DONE" title="mapscript.MS_DONE"><code class="xref py py-data docutils literal notranslate"><span class="pre">MS_DONE</span></code></a>.
MS_DONE is returned if the layer extent does not overlap <em>rect</em>.</p>
</dd></dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<p>
<a href="../../../about.html" title="About">About</a><br>
<a href="../../../products.html" title="Products">Products</a><br>
<a href="../../../community/index.html" title="Community">Community</a><br>
<a href="../../../development/index.html" title="Development">Development</a><br>
<a href="../../../download.html" title="Downloads">Downloads</a><br>
<a href="../../../documentation.html" title="Documentation">Documentation</a><br>
<a href="../../../faq.html" title="FAQ">FAQ</a><br>
<a href="../../../psc.html" title="PSC">PSC</a><br>
<a href="https://fosstodon.org/@mapserver" title="Mastodon">Mastodon</a>
</p>
<h3>Current Table Of Contents</h3>
<ul>
<li><a class="reference internal" href="#">mapscript.layerObj</a><ul>
<li><a class="reference internal" href="#mapscript.layerObj"><code class="docutils literal notranslate"><span class="pre">layerObj</span></code></a><ul>
<li><a class="reference internal" href="#mapscript.layerObj.__init__"><code class="docutils literal notranslate"><span class="pre">layerObj.__init__()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.addFeature"><code class="docutils literal notranslate"><span class="pre">layerObj.addFeature()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.addProcessing"><code class="docutils literal notranslate"><span class="pre">layerObj.addProcessing()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.applySLD"><code class="docutils literal notranslate"><span class="pre">layerObj.applySLD()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.applySLDURL"><code class="docutils literal notranslate"><span class="pre">layerObj.applySLDURL()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.clearProcessing"><code class="docutils literal notranslate"><span class="pre">layerObj.clearProcessing()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.clone"><code class="docutils literal notranslate"><span class="pre">layerObj.clone()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.close"><code class="docutils literal notranslate"><span class="pre">layerObj.close()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.convertToString"><code class="docutils literal notranslate"><span class="pre">layerObj.convertToString()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.draw"><code class="docutils literal notranslate"><span class="pre">layerObj.draw()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.drawQuery"><code class="docutils literal notranslate"><span class="pre">layerObj.drawQuery()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.executeWFSGetFeature"><code class="docutils literal notranslate"><span class="pre">layerObj.executeWFSGetFeature()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.generateSLD"><code class="docutils literal notranslate"><span class="pre">layerObj.generateSLD()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getClass"><code class="docutils literal notranslate"><span class="pre">layerObj.getClass()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getClassIndex"><code class="docutils literal notranslate"><span class="pre">layerObj.getClassIndex()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getExtent"><code class="docutils literal notranslate"><span class="pre">layerObj.getExtent()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getFilterString"><code class="docutils literal notranslate"><span class="pre">layerObj.getFilterString()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getGeomTransform"><code class="docutils literal notranslate"><span class="pre">layerObj.getGeomTransform()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getItem"><code class="docutils literal notranslate"><span class="pre">layerObj.getItem()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getItemDefinitions"><code class="docutils literal notranslate"><span class="pre">layerObj.getItemDefinitions()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getItemType"><code class="docutils literal notranslate"><span class="pre">layerObj.getItemType()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getNumFeatures"><code class="docutils literal notranslate"><span class="pre">layerObj.getNumFeatures()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getNumProcessing"><code class="docutils literal notranslate"><span class="pre">layerObj.getNumProcessing()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getNumResults"><code class="docutils literal notranslate"><span class="pre">layerObj.getNumResults()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getOpacity"><code class="docutils literal notranslate"><span class="pre">layerObj.getOpacity()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getProcessing"><code class="docutils literal notranslate"><span class="pre">layerObj.getProcessing()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getProcessingKey"><code class="docutils literal notranslate"><span class="pre">layerObj.getProcessingKey()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getProjection"><code class="docutils literal notranslate"><span class="pre">layerObj.getProjection()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getResult"><code class="docutils literal notranslate"><span class="pre">layerObj.getResult()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getResults"><code class="docutils literal notranslate"><span class="pre">layerObj.getResults()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getResultsBounds"><code class="docutils literal notranslate"><span class="pre">layerObj.getResultsBounds()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getShape"><code class="docutils literal notranslate"><span class="pre">layerObj.getShape()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.getWMSFeatureInfoURL"><code class="docutils literal notranslate"><span class="pre">layerObj.getWMSFeatureInfoURL()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.insertClass"><code class="docutils literal notranslate"><span class="pre">layerObj.insertClass()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.isVisible"><code class="docutils literal notranslate"><span class="pre">layerObj.isVisible()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.moveClassDown"><code class="docutils literal notranslate"><span class="pre">layerObj.moveClassDown()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.moveClassUp"><code class="docutils literal notranslate"><span class="pre">layerObj.moveClassUp()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.nextShape"><code class="docutils literal notranslate"><span class="pre">layerObj.nextShape()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.open"><code class="docutils literal notranslate"><span class="pre">layerObj.open()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.queryByAttributes"><code class="docutils literal notranslate"><span class="pre">layerObj.queryByAttributes()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.queryByFeatures"><code class="docutils literal notranslate"><span class="pre">layerObj.queryByFeatures()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.queryByFilter"><code class="docutils literal notranslate"><span class="pre">layerObj.queryByFilter()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.queryByIndex"><code class="docutils literal notranslate"><span class="pre">layerObj.queryByIndex()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.queryByPoint"><code class="docutils literal notranslate"><span class="pre">layerObj.queryByPoint()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.queryByRect"><code class="docutils literal notranslate"><span class="pre">layerObj.queryByRect()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.queryByShape"><code class="docutils literal notranslate"><span class="pre">layerObj.queryByShape()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.removeClass"><code class="docutils literal notranslate"><span class="pre">layerObj.removeClass()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.setConnectionType"><code class="docutils literal notranslate"><span class="pre">layerObj.setConnectionType()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.setExtent"><code class="docutils literal notranslate"><span class="pre">layerObj.setExtent()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.setFilter"><code class="docutils literal notranslate"><span class="pre">layerObj.setFilter()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.setGeomTransform"><code class="docutils literal notranslate"><span class="pre">layerObj.setGeomTransform()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.setItems"><code class="docutils literal notranslate"><span class="pre">layerObj.setItems()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.setOpacity"><code class="docutils literal notranslate"><span class="pre">layerObj.setOpacity()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.setProcessingKey"><code class="docutils literal notranslate"><span class="pre">layerObj.setProcessingKey()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.setProjection"><code class="docutils literal notranslate"><span class="pre">layerObj.setProjection()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.setWKTProjection"><code class="docutils literal notranslate"><span class="pre">layerObj.setWKTProjection()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.updateFromString"><code class="docutils literal notranslate"><span class="pre">layerObj.updateFromString()</span></code></a></li>
<li><a class="reference internal" href="#mapscript.layerObj.whichShapes"><code class="docutils literal notranslate"><span class="pre">layerObj.whichShapes()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="mapscript.legendObj.html" title="mapscript.legendObj"
>next</a> |</li>
<li class="right" >
<a href="mapscript.labelObj.html" title="mapscript.labelObj"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../../../documentation.html" >MapServer 8.6.2 Documentation</a> »</li>
<li class="nav-item nav-item-2"><a href="../../index.html" >MapScript</a> »</li>
<li class="nav-item nav-item-3"><a href="../index.html" >SWIG MapScript API Reference</a> »</li>
<li class="nav-item nav-item-this"><a href="">mapscript.layerObj</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© <a href="../../../copyright.html">Copyright</a> 2026, Open Source Geospatial Foundation.
Last updated on 2026-04-20.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
</html>