mapscript.layerObj

class mapscript.layerObj(map: mapObj | None = None)

Overview

The layerObj has the following relationships:

Attributes

bandsitem	char TODO Add documentation
bindvals	hashTableObj immutable TODO Add documentation
classgroup	char TODO Add documentation
classitem	char TODO Add documentation
cluster	clusterObj immutable TODO Add documentation
compositer	LayerCompositer immutable TODO Add documentation
connection	char TODO Add documentation
connectionoptions	hashTableObj immutable TODO Add documentation
connectiontype	enum MS_CONNECTION_TYPE TODO Add documentation
data	char TODO Add documentation
debug	int TODO Add documentation
encoding	char TODO Add documentation
extent	rectObj immutable TODO Add documentation
filteritem	char TODO Add documentation
footer	char TODO Add documentation
group	char TODO Add documentation
header	char TODO Add documentation
index	int immutable TODO Add documentation
labelcache	int TODO Add documentation
labelitem	char TODO Add documentation
labelmaxscaledenom	double TODO Add documentation
labelminscaledenom	double TODO Add documentation
labelrequires	char TODO Add documentation
map	mapObj immutable TODO Add documentation
mask	char TODO Add documentation
maxclasses	int immutable TODO Add documentation
maxfeatures	int TODO Add documentation
maxgeowidth	double TODO Add documentation
maxscaledenom	double TODO Add documentation
metadata	hashTableObj immutable TODO Add documentation
minfeaturesize	int TODO Add documentation
mingeowidth	double TODO Add documentation
minscaledenom	double TODO Add documentation
name	char TODO Add documentation
numclasses	int immutable TODO Add documentation
numitems	int immutable TODO Add documentation
numjoins	int immutable TODO Add documentation
numprocessing	int immutable TODO Add documentation
offsite	colorObj TODO Add documentation
plugin_library	char TODO Add documentation
plugin_library_original	char TODO Add documentation
postlabelcache	int TODO Add documentation
refcount	int immutable TODO Add documentation
rendermode	enum MS_RENDER_MODE TODO Add documentation
requires	char TODO Add documentation
sizeunits	int TODO Add documentation
startindex	int TODO Add documentation
status	int TODO Add documentation
styleitem	char TODO Add documentation
symbolscaledenom	double TODO Add documentation
template	char TODO Add documentation
thisown	The membership flag
tileindex	char TODO Add documentation
tileitem	char TODO Add documentation
tilesrs	char TODO Add documentation
tolerance	double TODO Add documentation
toleranceunits	int TODO Add documentation
transform	int TODO Add documentation
type	enum MS_LAYER_TYPE TODO Add documentation
units	int TODO Add documentation
utfdata	expressionObj immutable TODO Add documentation
utfitem	char TODO Add documentation
utfitemindex	int TODO Add documentation
validation	hashTableObj immutable TODO Add documentation

Methods

__init__(map: mapObj | None = None)

addFeature(shape: shapeObj) → int

addProcessing(directive: char const) → void

applySLD(sld: char, stylelayer: char) → int

applySLDURL(sld: char, stylelayer: char) → int

clearProcessing() → int

clone() → layerObj

close() → void

convertToString() → char

draw(map: mapObj, image: imageObj) → int

drawQuery(map: mapObj, image: imageObj) → int

executeWFSGetFeature(layer: layerObj) → char

generateSLD() → char

getClass()

getClassIndex(map: mapObj, shape: shapeObj, classgroup: int | None = None, numclasses: int = 0) → int

getExtent() → rectObj

getFilterString() → char

getGeomTransform() → char

getItem(i: int) → char

getItemDefinitions()

Python MapScript only

Return item (field) names and their types if available. Field types are specified using GML metadata and can be one of the following:

Integer|Long|Real|Character|Date|Boolean

getItemType(i: int) → char

getNumFeatures() → int

getNumResults() → int

getOpacity() → int

getProcessing(index: int) → char

getProcessingKey(key: char const) → char

getProjection() → char

getResult(i: int) → resultObj

getResults() → resultCacheObj

getResultsBounds() → rectObj

getShape(record: resultObj) → shapeObj

getWMSFeatureInfoURL(map: mapObj, click_x: int, click_y: int, feature_count: int, info_format: char) → char

insertClass()

isVisible() → int

moveClassDown(index: int) → int

moveClassUp(index: int) → int

nextShape() → shapeObj

open() → int

queryByAttributes(map: mapObj, qitem: char, qstring: char, mode: int) → int

queryByFeatures(map: mapObj, slayer: int) → int

queryByFilter(map: mapObj, string: char) → int

queryByIndex(map: mapObj, tileindex: int, shapeindex: int, bAddToQuery: int = 0) → int

queryByPoint(map: mapObj, point: pointObj, mode: int, buffer: double) → int

queryByRect(map: mapObj, rect: rectObj) → int

queryByShape(map: mapObj, shape: shapeObj) → int

removeClass(index: int) → classObj

setConnectionType(connectiontype: int, library_str: char const) → int

setExtent(minx: double = -1.0, miny: double = -1.0, maxx: double = -1.0, maxy: double = -1.0) → int

setFilter(filter: char) → int

setGeomTransform(transform: char) → void

setItems(items: char, numitems: int) → int

setOpacity(opacity: int) → void

setProcessingKey(key: char const, value: char const) → void

setProjection(proj4: char) → int

setWKTProjection(wkt: char) → int

updateFromString(snippet: char) → int

whichShapes(rect: rectObj) → int