Configuring the client and server side of the equipment view component

To display an equipment view in the client application, you need business data and rendering information that defines how to display these data. This section explains how to connect to a source of business data and configure their rendering in the equipment JSF component.

The configuration for the rendering is split into two distinct groups:

client-side configuration: HTML configuration stored in the JavaScript page and the JavaScript™ objects
server-side configuration: stored in the equipment JSF implementation or in the image servlet

Client-side configuration relates to the behavior and look of the JSF component itself. Server-side configuration relates to the equipment model and the way the representation objects are displayed and laid out.

There are many ways to configure the client and server sides of the equipmentView component. In general, the client-side configuration is passed as tag attributes to the equipmentView . It is also through tag attributes that you connect auxiliary JSF components to enhance the equipmentView , like the dataSource, overview, selectInteractor, and others

Server-side configuration can be set through a CSS configuration file or through the IlpEquipment API, the easiest and preferred way being the CSS configuration. The tag attribute styleSheets is used to pass a list of Cascading Style Sheets (CSS) files to configure the equipment adapter (filters, node and link factories, for example), the equipment view (background and zoom policies, for example) and the equipment objects themselves.

The following table lists all the tag attributes defined for the equipmentView component.

Tag attributes of the equipmentView JSF component

Tag Attributes	Description
`id`	Defines the unique identifier for the component. Every component should have a unique identifier. Mandatory.
`context`	Defines the JViews TGO context to be used by the underlying `IlpEquipment` component. Mandatory.
`binding`	Allows the user to bind the component to a backing bean.
`width`	Defines the width, in pixels, of the view component. This attribute is inherited from the `view` JSF component.
`height`	Defines the height, in pixels, of the view component. This attribute is inherited from the `view` JSF component.
`style`	Provides CSS customization. This attribute is inherited from the JViews Framework JSF.
`styleClass`	Defines the style classes for the component. This attribute is inherited from the JViews Framework JSF.
`messageBox`	Binds the text output of the `equipmentView` component to a `messageBox` component. (A `messageBox` component is defined by the core JViews JSF library and displays text messages in a JSP™ page.) This attribute is inherited from the JViews Framework JSF.
`messageBoxId`	Similar to `messageBox` but binds the `messageBox` component by its unique identifier. This attribute is inherited from the JViews Framework JSF.
`interactor`	Specifies the default (initial) interactor set to the `equipmentView` component. It has no correspondence with a view interactor. It should be a JSF component (like the `selectInteractor` component). This attribute is inherited from the JViews Framework JSF.
`interactorId`	Similar to `interactor` but binds to the unique identifier of the interactor. This attribute is inherited from the JViews Framework JSF.
`zoomFactor`	Configures the zoom factor applied when zooming in or out. This attribute is inherited from the JViews Framework JSF.
`panFactor`	Configures the pan factor (how much the image is moved). It is mainly used when the `equipmentView` component is connected with the `panTool` component. This attribute is inherited from the JViews Framework JSF.
`updateInterval`	Defines the interval between automatic updates. The `equipmentView` component will then send an update request to the server on a regular basis. This attribute is inherited from the JViews Framework JSF.
`imageFormat`	The image encoding format, for example "JPG" or "PNG". This attribute is inherited from the JViews Framework JSF.
`waitingImage`	Defines the image to be displayed by the equipment JSF component while waiting for the image servlet to generate the response image. This attribute is inherited from the JViews Framework JSF.
`generateImageMap`	Indicates whether an image map should be generated for the equipment JSF component. This attribute is inherited from the JViews Framework JSF. See Adding an Image Map in the Advanced Features of JViews Framework documentation.
`imageMapVisible`	Indicates whether the image map should be made visible or not. This attribute is inherited from the JViews Framework JSF. See Adding an Image Map in the Advanced Features of JViews Framework documentation.
`imageMapGenerator`	Binds to a bean that subclasses the `ilog.views.servlet.IlvImageMapAreaGenerator` class and is responsible for generating the image map. This attribute is inherited from the JViews Framework JSF. See Adding an Image Map in the Advanced Features of JViews Framework documentation.
`imageMapGeneratorClass`	The name of a bean class that subclasses the `ilog.views.servlet.IlvImageMapAreaGenerator` class and is responsible for generating the image map. This attribute is inherited from the JViews Framework JSF. See Adding an Image Map in the Advanced Features of JViews Framework documentation.
`backgroundColor`	Specifies the background color to be displayed by the equipment JSF component when there is no background image. This attribute is inherited from the JViews Framework JSF.
`onImageLoaded`	Specifies the JavaScript code to be executed right after a refreshed image is loaded from the server. This attribute is inherited from the JViews Framework JSF.
`onCapabilitiesLoaded`	Similar to `onImageLoaded` , but this is executed right after a request for capabilities has been answered by the server. This attribute is inherited from the JViews Framework JSF.
`errorMessage`	The error message to be displayed in case of faulty client-server communication. This attribute is inherited from the JViews Framework JSF.
`servlet`	Overrides the default image servlet used to generate images. This attribute is inherited from the JViews Framework JSF.
`project`	Sets a JViews TGO project to the underlying `IlpEquipment` component.
`dataSource`	Binds the `equipmentView` component with a `dataSource` component. The data source component wraps an `IlpAbstractDataSource` component internally.
`dataSourceId`	Similar to `dataSource` , but binding is done through the data source’s unique identifier.
`equipment`	Specifies a custom `IlpEquipment` which replaces the default automatically instantiated equipment component.
`styleSheets`	Specifies a JViews TGO CSS configuration file for the underlying `IlpEquipment` component. It is different from the `styles` tag attribute as it provides server-side configuration, which is specific to JViews TGO. This CSS file may contain component and business data configuration.
`resizable`	Enables or disables the resizing of the equipment JSF component. This attribute is inherited from the JViews Framework JSF.
`boundingBox`	Defines the width and height of the equipment view component. This attribute is inherited from the JViews Framework JSF.
`data`	Defines the data to be displayed, which can be a JViews TGO project, a binding to an `IlpAbstractDataSource` instance, or the unique identifier of a `dataSource` component.
`zoomLevels`	Comma-separated list of fixed zoom levels used by the view. If the zoom levels are not specified, the zoom is bound only by the `maxZoomLevel` property.
maxZoomLevel	The maximum zoom level. This property is used if, and only if, the `zoomLevels` property is not used. The default value is 10.
tileSize	The size of a tile. If the tile size is greater than or equal to 0, the view will be set in tiled mode. The tile size must be carefully chosen for performance reasons.
tileManager	The tile manager is responsible for retrieving and/or storing image tiles on the server side. The tile manager is used when the view is tiled, that is, if `tileSize` is strictly positive.

Current section

Configuring an equipment view JSF component