Class ClipToGraticuleManipulator

source code

     object --+    
              |    
BaseManipulator --+
                  |
                 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

html_templates=='invalid'   
                    This represents an 'internal error' and is accessed by raising a ManipulatorInternalException
                    This should occur under the following circumstances:
                        if polygon could not be created from graticules
                        or intersection call failed
                    clipped_shape will be returned as None
html_templates=='invalid_geom'   
                    This represents an 'user error' and is accessed by raising a InvalidGeometryException
                    This should occur under the following circumstances:
                        if geometry can not be generated from target_shape 
                        or target_shape is not valid geometry
                    clipped_shape will be returned as None
html_templates==2   if the clipped geometry is empty
html_templates==0   if target_shape is successfully clipped to the requested graticule(s)