mapscript.layerObj

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

Overview

The layerObj has the following relationships:

../../../_images/layerObj_classObj.png ../../../_images/layerObj_hashTableObj.png ../../../_images/layerObj_mapObj.png

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)[source]
addFeature(shape: shapeObj) int[source]
addProcessing(directive: char const) void[source]
applySLD(sld: char, stylelayer: char) int[source]
applySLDURL(sld: char, stylelayer: char) int[source]
clearProcessing() int[source]
clone() layerObj[source]
close() void[source]
convertToString() char[source]
draw(map: mapObj, image: imageObj) int[source]
drawQuery(map: mapObj, image: imageObj) int[source]
executeWFSGetFeature(layer: layerObj) char[source]
generateSLD() char[source]
getClass()[source]
getClassIndex(map: mapObj, shape: shapeObj, classgroup: int | None = None, numclasses: int = 0) int[source]
getExtent() rectObj[source]
getFilterString() char[source]
getGeomTransform() char[source]
getItem(i: int) char[source]
getItemDefinitions()[source]

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[source]
getNumFeatures() int[source]
getNumResults() int[source]
getOpacity() int[source]
getProcessing(index: int) char[source]
getProcessingKey(key: char const) char[source]
getProjection() char[source]
getResult(i: int) resultObj[source]
getResults() resultCacheObj[source]
getResultsBounds() rectObj[source]
getShape(record: resultObj) shapeObj[source]
getWMSFeatureInfoURL(map: mapObj, click_x: int, click_y: int, feature_count: int, info_format: char) char[source]
insertClass()[source]
isVisible() int[source]
moveClassDown(index: int) int[source]
moveClassUp(index: int) int[source]
nextShape() shapeObj[source]
open() int[source]
queryByAttributes(map: mapObj, qitem: char, qstring: char, mode: int) int[source]
queryByFeatures(map: mapObj, slayer: int) int[source]
queryByFilter(map: mapObj, string: char) int[source]
queryByIndex(map: mapObj, tileindex: int, shapeindex: int, bAddToQuery: int = 0) int[source]
queryByPoint(map: mapObj, point: pointObj, mode: int, buffer: double) int[source]
queryByRect(map: mapObj, rect: rectObj) int[source]
queryByShape(map: mapObj, shape: shapeObj) int[source]
removeClass(index: int) classObj[source]
setConnectionType(connectiontype: int, library_str: char const) int[source]
setExtent(minx: double = -1.0, miny: double = -1.0, maxx: double = -1.0, maxy: double = -1.0) int[source]
setFilter(filter: char) int[source]
setGeomTransform(transform: char) void[source]
setItems(items: char, numitems: int) int[source]
setOpacity(opacity: int) void[source]
setProcessingKey(key: char const, value: char const) void[source]
setProjection(proj4: char) int[source]
setWKTProjection(wkt: char) int[source]
updateFromString(snippet: char) int[source]
whichShapes(rect: rectObj) int[source]