|
|
BaseManipulator
BaseManipulator should be used as the parent class to all manipulator classes.
|
|
|
ClipToShapeManipulator
required arguments:
target_shape: GEOSGeometry of the shape to be clipped, in srid GEOMETRY_CLIENT_SRID (4326)
clip_against: GEOSGeometry of the shape to clip against, in srid GEOMETRY_CLIENT_SRID (4326)
zero: this value may be used to prevent issues that seem to arise from trying to simplify very small geometric results
concerning **kwargs:
kwargs is included to prevent errors resulting from extra arguments being passed to this manipulator from the generic view
manipulate() return value:
a call to self.result()
with required parameter 'clipped_shape':
The returned shape geometry should be in srid GEOMETRY_CLIENT_SRID (4326)
The clipped shape will be the largest (in area) polygon result from intersecting 'target_shape' with 'clip_against'
and optional parameters 'html' and 'success':
The html is usually a template that will be displayed to the client, explaining the manipulation
if not provided, this will remain empty
The success parameter is defined as '1' for success and '0' for failure
if not provided, the default value, '1', is used
|
|
|
DifferenceFromShapeManipulator
required arguments:
target_shape: GEOSGeometry of the shape to be clipped, in srid GEOMETRY_CLIENT_SRID (4326)
clip_against: GEOSGeometry of the shape to clip against, in srid GEOMETRY_CLIENT_SRID (4326)
zero: this value may be used to prevent issues that seem to arise from trying to simplify very small geometric results
concerning **kwargs:
kwargs is included to prevent errors resulting from extra arguments being passed to this manipulator from the generic view
manipulate() return value:
a call to self.result()
with required parameter 'clipped_shape':
The returned shape geometry should be in srid GEOMETRY_CLIENT_SRID (4326)
The clipped shape will be the largest (in area) polygon result from taking the difference of 'target_shape' with 'clip_against'
and optional parameters 'html' and 'success':
The html is usually a template that will be displayed to the client, explaining the manipulation
if not provided, this will remain empty
The success parameter is defined as '1' for success and '0' for failure
if not provided, the default value, '1', is used
|
|
|
ClipToStudyRegionManipulator
required argument:
target_shape: GEOSGeometry of the shape to be clipped, in srid GEOMETRY_CLIENT_SRID (4326)
optional argument:
generally USED FOR TESTING ONLY
study_region: GEOSGeometry of the shape to be clipped, in srid GEOMETRY_CLIENT_SRID (4326)
concerning **kwargs:
kwargs is included to prevent errors resulting from extra arguments being passed to this manipulator from the generic view
manipulate() return value:
a call to self.result()
with required parameter 'clipped_shape':
The returned shape geometry should be in srid GEOMETRY_CLIENT_SRID (4326)
The clipped shape will be the largest (in area) polygon result from intersecting target_shape with the study region
and optional parameters 'html' and 'success':
The html is usually a template that will be displayed to the client, explaining the manipulation
if not provided, this will remain empty
The success parameter is defined as '1' for success and '0' for failure
if not provided, the default value, '1', is used
|
|
|
ClipToGraticuleManipulator
required argument:
target_shape: GEOSGeometry of the shape to be clipped, in srid GEOMETRY_CLIENT_SRID (4326)
optional arguments:
north, south, east, west: expressed in srid GEOMETRY_CLIENT_SRID (4326)
concerning **kwargs:
kwargs is included to prevent errors resulting from extra arguments being passed to this manipulator from the generic view
manipulate() return value:
a call to self.result()
with required parameter 'clipped_shape':
The returned shape geometry should be in srid GEOMETRY_CLIENT_SRID (4326)
The clipped shape will be the largest (in area) polygon result from clipping target_shape with the requested graticule(s)
and optional parameters 'html' and 'success':
The html is usually a template that will be displayed to the client, explaining the manipulation
if not provided, this will remain empty
The success parameter is defined as '1' for success and '0' for failure
if not provided, the default value, '1', is used
|
|
|
NullManipulator
This manipulator does nothing but ensure the geometry is clean.
|