Available requests for JViews Diagrammer, JViews Maps and JViews TGO

image

image is the request for image generation.

Example URL:

http://hostname:port/your_webapp_context/_contr?request=image&layer=Links,Nodes&bbox=18.744629%2C-88.20932004101562%2C772.064208890625%2C450.37078851953123&format=PNG&width=600&height=350&again=Wed%2C%2005%20Jan%202011%2006%3A49%3A19%20GMT%20271&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&componentWidth=600&componentHeight=350&bgcolor=0xffffff

Name	Required	Expected value	Compared by default	Compare method	Description
`action`	`false`		`false`		The action name used for server action listener.
`again`	`false`		`false`		A time stamp for the requests
`bbox`	`false`		`false`		The rectangle that contains all the graphic objects.
`bgcolor`	`false`		`false`		The background color.
`css`	`false`		`false`		The style sheet.
`componentHeight`	`false`		`false`		The desired height, in pixels, of the component used in a JSF environment.
`componentWidth`	`false`		`false`		The desired width in pixels of the component used in a JSF environment.
`context`	`false`		`false`		The binding to a JViews TGO context bean
`dataSourceId`	`false`		`false`		The ID of a predefined data source.
`dynamic`	`false`	`true; false`	`true`	`LIST`	Determines whether it is a dynamic layer.
`expired`	`false`		`false`		Determines whether the content is expired.
`facesComponentId`	`false`		`false`		The ID of this component used under in a JSF environment.
`facesData`	`false`		`false`		The class of the servlet that generates the pop-up menu used in a JSF environment.
`facesDataSourceId`	`false`		`false`		The identifier of the data source in a JSF environment.
`facesService`	`false`	`forward`	`true`	`EQUALS`	The service to be handled by control servlet used in a JSF environment.
`format`	`true`	`JPEG; PNG; GIF; JPG`	`true`	`LIST`	The image format response on the client side.
`height`	`true`		`false`		The desired height, in pixels, of the component.
`imapGenerator`	`false`		`false`		The image map generator which will be invoked to create the image map dynamically.
`jviewsPageId`	`false`		`false`		Page identification from the request (when the multi-tab page feature is enabled).
`layer`	`false`		`false`		A comma-separated list of names of the visible layers.
`locale`	`false`		`false`		The expected locale sent by client.
`namespace`	`false`		`false`		The portlet namespace
`objectActionMB`	`false`		`false`		Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
`overview`	`false`	`true; false`	`true`	`LIST`	Determines whether it is an overview request.
`project`	`false`		`false`		The project file.
`request`	`true`		`false`		The JViews Web request will be handled by server side.
`slc`	`false`		`false`		The static layers count.
`stylesheets`	`false`		`false`		Comma-separated list of URLs of style sheets.
`tile`	`false`		`false`		The tile size.
`tiled`	`false`	`true; false`	`false`	`LIST`	Determines whether the view is tiled.
`tileMgr`	`false`		`false`		The tile manager is responsible for retrieving or storing image tiles on the server side.
`transparent`	`false`	`true; false`	`true`		Determines whether the layer is transparent.
`width`	`true`		`false`		The desired width, in pixels, of the component.

imageMap

image is the request for image map generation

Example URL:

http://hostname:port/your_webapp_context/_contr?request=imagemap&layer=Links,Nodes&bbox=-6.5585938%2C-855.3141540727343%2C2958.25341801875%2C2366.6027344149998&format=PNG&width=500&height=400&again=Wed%2C%2005%20Jan%202011%2006%3A49%3A53%20GMT%20100&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&componentWidth=500&componentHeight=400&bgcolor=0xffffff&image=http%3A//localhost%3A8082/jsf-diagrammer-gallery/_contr%3FfacesService%3Dforward%26facesData%3Dres%26v%3D8.7.0.7%26res%3D%24res%24/jviews/images/empty.gif

Name	Required	Expected value	Compared by default	Compare method	Description
`again`	`false`		`false`		A time stamp for the requests
`bbox`	`false`		`false`		The rectangle that contains all the graphic objects.
`bgcolor`	`false`		`false`		The background color.
`componentHeight`	`false`		`false`		The desired height, in pixels, of the component used in a JSF environment.
`componentWidth`	`false`		`false`		The desired width in pixels of the component used in a JSF environment.
`context`	`false`		`false`		The binding to a JViews TGO context bean
`dynamic`	`false`	`true; false`	`true`	`LIST`	Determines whether it is a dynamic layer.
`facesComponentId`	`false`		`false`		The ID of this component used under in a JSF environment.
`facesData`	`false`		`false`		The class of the servlet that generates the pop-up menu used in a JSF environment.
`facesService`	`false`	`forward`	`true`	`EQUALS`	The service to be handled by control servlet used in a JSF environment.
`format`	`true`	`JPEG; PNG; GIF; JPG`	`true`	`LIST`	The image format response on the client side.
`height`	`true`		`false`		The desired height, in pixels, of the component.
`image`	`false`	`script`	`false`	`NOT_CONTAINS`	The empty image path, and no <script> element can be included.
`imapGenerator`	`false`		`false`		The image map generator which will be invoked to create the image map dynamically.
`jviewsPageId`	`false`		`false`		Page identification from the request (when the multi-tab page feature is enabled).
`layer`	`false`		`false`		A comma-separated list of names of the visible layers.
`locale`	`false`		`false`		The expected locale sent by client.
`namespace`	`false`		`false`		The portlet namespace
`objectActionMB`	`false`		`false`		Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
`request`	`true`		`false`		The JViews Web request will be handled by server side.
`tiled`	`false`	`true; false`	`false`	`LIST`	Determines whether the view is tiled.
`tileMgr`	`false`		`false`		The tile manager is responsible for retrieving or storing image tiles on the server side.
`width`	`true`		`false`		The desired width, in pixels, of the component.

capabilities

capabilities is the request for the manager’s capabilities.

Example URL:

http://hostname:port/your_webapp_context/_contr?request=capabilities&format=json&width=500&height=400&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&action=imageModeAction%28false%29&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&project=/data/diagrammer.idpr&slc=undefined&componentWidth=500&componentHeight=400&again=Wed%2C%2005%20Jan%202011%2006%3A49%3A52%20GMT%20936

Name	Required	Expected value	Compared by default	Compare method	Description
`action`	`false`		`false`		The action name used for server action listener.
`again`	`false`		`false`		A time stamp for the requests
`bbox`	`false`		`false`		The rectangle that contains all the graphic objects.
`css`	`false`		`false`		The style sheet.
`componentHeight`	`false`		`false`		The desired height, in pixels, of the component used in a JSF environment.
`componentWidth`	`false`		`false`		The desired width in pixels of the component used in a JSF environment.
`context`	`false`		`false`		The binding to a JViews TGO context bean
`dataSourceId`	`false`		`false`		The ID of a predefined data source.
`dynamic`	`false`	`true; false`	`true`	`LIST`	Determines whether it is a dynamic layer.
`expired`	`false`		`false`		Determines whether the content is expired.
`facesComponentId`	`false`		`false`		The ID of this component used under in a JSF environment.
`facesData`	`false`		`false`		The class of the servlet that generates the pop-up menu used in a JSF environment.
`facesDataSourceId`	`false`		`false`		The identifier of the data source in a JSF environment.
`facesService`	`false`	`forward`	`true`	`EQUALS`	The service to be handled by control servlet used in a JSF environment.
`format`	`true`	`json`	`true`	`EQUALS`	The capabilities request needs json format.
`height`	`true`		`false`		The desired height, in pixels, of the component.
`infoProviderMB`	`false`		`false`		Method binding key to a method that accesses the selection property.
`jviewsPageId`	`false`		`false`		Page identification from the request (when the multi-tab page feature is enabled).
`layer`	`false`		`false`		A comma-separated list of names of the visible layers.
`locale`	`false`		`false`		The expected locale sent by client.
`namespace`	`false`		`false`		The portlet namespace
`objectActionMB`	`false`		`false`		Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
`overview`	`false`	`true; false`	`true`	`LIST`	Determines whether it is an overview request.
`project`	`false`		`false`		The project file.
`properties`	`false`		`false`		An object of properties containing keys and values for each of the property to be set at creation time.
`request`	`true`		`false`		The JViews Web request will be handled by server side.
`slc`	`false`		`false`		The static layers count.
`stylesheets`	`false`		`false`		Comma-separated list of URLs of style sheets.
`tile`	`false`		`false`		The tile size.
`tiled`	`false`	`true; false`	`false`	`LIST`	Determines whether the view is tiled.
`tileMgr`	`false`		`false`		The tile manager is responsible for retrieving or storing image tiles on the server side.
`transparent`	`false`	`true; false`	`true`		Determines whether the layer is transparent.
`width`	`true`		`false`		The desired width, in pixels, of the component.

dynamicAction

dynamicAction restores the context and executes actions without generating an image.

Example URL:


								http://hostname:port/your_webapp_context/_contr?request=dynamicAction&layer=Links,Nodes&bbox=18.744629%2C-88.20932004101562%2C772.064208890625%2C450.37078851953123&format=PNG&width=600&height=350&again=Wed%2C%2005%20Jan%202011%2006%3A49%3A19%20GMT%20271&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&componentWidth=600&componentHeight=350&bgcolor=0xffffff

Name	Required	Expected value	Compared by default	Compare method	Description
`action`	`false`		`false`		The action name used for server action listener.
`again`	`false`		`false`		A time stamp for the requests
`bbox`	`false`		`false`		The rectangle that contains all the graphic objects.
`bgcolor`	`false`		`false`		The background color.
`css`	`false`		`false`		The style sheet.
`componentHeight`	`false`		`false`		The desired height, in pixels, of the component used in a JSF environment.
`componentWidth`	`false`		`false`		The desired width in pixels of the component used in a JSF environment.
`context`	`false`		`false`		The binding to a JViews TGO context bean
`dataSourceId`	`false`		`false`		The ID of a predefined data source.
`dynamic`	`false`	`true; false`	`true`	`LIST`	Determines whether it is a dynamic layer.
`expired`	`false`		`false`		Determines whether the content is expired.
`facesComponentId`	`false`		`false`		The ID of this component used under in a JSF environment.
`facesData`	`false`		`false`		The class of the servlet that generates the pop-up menu used in a JSF environment.
`facesDataSourceId`	`false`		`false`		The identifier of the data source in a JSF environment.
`facesService`	`false`	`forward`	`true`	`EQUALS`	The service to be handled by control servlet used in a JSF environment.
`format`	`true`	`JPEG; PNG; GIF; JPG`	`true`	`LIST`	The image format response on the client side.
`height`	`true`		`false`		The desired height, in pixels, of the component.
`imapGenerator`	`false`		`false`		The image map generator which will be invoked to create the image map dynamically.
`jviewsPageId`	`false`		`false`		Page identification from the request (when the multi-tab page feature is enabled).
`layer`	`false`		`false`		A comma-separated list of names of the visible layers.
`locale`	`false`		`false`		The expected locale sent by client.
`namespace`	`false`		`false`		The portlet namespace
`objectActionMB`	`false`		`false`		Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
`overview`	`false`	`true; false`	`true`	`LIST`	Determines whether it is an overview request.
`project`	`false`		`false`		The project file.
`request`	`true`		`false`		The JViews Web request will be handled by server side.
`slc`	`false`		`false`		The static layers count.
`stylesheets`	`false`		`false`		Comma-separated list of URLs of style sheets.
`tile`	`false`		`false`		The tile size.
`tiled`	`false`	`true; false`	`false`	`LIST`	Determines whether the view is tiled.
`tileMgr`	`false`		`false`		The tile manager is responsible for retrieving or storing image tiles on the server side.
`transparent`	`false`	`true; false`	`true`		Determines whether the layer is transparent.
`width`	`true`		`false`		The desired width, in pixels, of the component.

hitmap

hitmap The hitmap request.

Example URL:

http://hostname:port/your_webapp_context/_contr?request=hitmap&layer=Links,Nodes&bbox=-6.5585938%2C-855.31415752%2C2958.2533938%2C2366.60271504&width=500&height=400&again=Wed%2C%2005%20Jan%202011%2006%3A52%3A39%20GMT%20306&facesData=ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServlet&facesService=forward&facesComponentId=diagrammer&locale=en_US&imapGenerator=%23%7BgalleryBean.imapGenerator%7D&componentWidth=500&componentHeight=400

Name	Required	Expected value	Compared by default	Compare method	Description
`again`	`false`		`false`		A time stamp for the requests
`bbox`	`false`		`false`		The rectangle that contains all the graphic objects.
`componentHeight`	`false`		`false`		The desired height, in pixels, of the component used in a JSF environment.
`componentWidth`	`false`		`false`		The desired width in pixels of the component used in a JSF environment.
`context`	`false`		`false`		The binding to a JViews TGO context bean
`dynamic`	`false`	`true; false`	`true`	`LIST`	Determines whether it is a dynamic layer.
`expired`	`false`		`false`		Determines whether the content is expired.
`facesComponentId`	`false`		`false`		The ID of this component used under in a JSF environment.
`facesData`	`false`		`false`		The class of the servlet that generates the pop-up menu used in a JSF environment.
`facesService`	`false`	`forward`	`true`	`EQUALS`	The service to be handled by control servlet used in a JSF environment.
`height`	`true`		`false`		The desired height, in pixels, of the component.
`imapGenerator`	`false`		`false`		The image map generator which will be invoked to create the image map dynamically.
`jviewsPageId`	`false`		`false`		Page identification from the request (when the multi-tab page feature is enabled).
`layer`	`false`		`false`		A comma-separated list of names of the visible layers.
`locale`	`false`		`false`		The expected locale sent by client.
`namespace`	`false`		`false`		The portlet namespace
`objectActionMB`	`false`		`false`		Method binding key to a method that will process a click in the view. This parameter is only used with JViews TGO.
`overview`	`false`	`true; false`	`true`	`LIST`	Determines whether it is an overview request.
`project`	`false`		`false`		The project file.
`request`	`true`		`false`		The JViews Web request will be handled by server side.
`tile`	`false`		`false`		The tile size.
`tiled`	`false`	`true; false`	`false`	`LIST`	Determines whether the view is tiled.
`tileMgr`	`false`		`false`		The tile manager is responsible for retrieving or storing image tiles on the server side.
`width`	`true`		`false`		The desired width, in pixels, of the component.