Server
API Reference Guide
Product Documentation:

Visualization Server
Documentation Home
List of all members | Public Member Functions
javascript::IlsRepresentation Class Reference

Implements the representations associated with each dynamic view in the server. More...

#include <javascript/clientside.h>

Public Member Functions

void addOrigin (IlsRpObject origin)
 Adds the Server object associated with the representation object passed as the argument as a new origin to the view. More...
 
void beginC2STransaction ()
 Starts a transaction for the given representation.
 
void close ()
 Closes the view by calling its C++ counterpart IlsRepresentation::close() with IlsTrue as its argument.
 
void commitC2STransaction ()
 Commits the current transaction.
 
IlsMvComponent getComponent ()
 Returns the component associated with the representation. More...
 
Boolean isInC2STransaction ()
 Checks if there is a current transaction. More...
 
void removeOrigin (IlsRpObject origin)
 Removes the Server object associated with the representation object passed as the argument from the list of origin of the view. More...
 
void rollbackC2STransaction ()
 Rolls back the current transaction.
 
void setMainOrigin (IlsRpObject newOrigin, Boolean keepOldOrigin)
 Replaces the main origin of the corresponding dynamic view by the Server object associated with the representation object passed as the first argument. More...
 

Detailed Description

Implements the representations associated with each dynamic view in the server.

Warning
This class is a JavaScript class, not a C++ one.
See also
IlsRepresentation (C++), IlsRpObject (C++).

Member Function Documentation

◆ addOrigin()

void javascript::IlsRepresentation::addOrigin ( IlsRpObject  origin)

Adds the Server object associated with the representation object passed as the argument as a new origin to the view.

Parameters
originobject to add as origin

◆ getComponent()

IlsMvComponent javascript::IlsRepresentation::getComponent ( )

Returns the component associated with the representation.

Returns
the component associated with the representation.

◆ isInC2STransaction()

Boolean javascript::IlsRepresentation::isInC2STransaction ( )

Checks if there is a current transaction.

Returns
True if there is a current transaction.

◆ removeOrigin()

void javascript::IlsRepresentation::removeOrigin ( IlsRpObject  origin)

Removes the Server object associated with the representation object passed as the argument from the list of origin of the view.

Parameters
originobject to remove from origins

◆ setMainOrigin()

void javascript::IlsRepresentation::setMainOrigin ( IlsRpObject  newOrigin,
Boolean  keepOldOrigin 
)

Replaces the main origin of the corresponding dynamic view by the Server object associated with the representation object passed as the first argument.

See also
IlsRepresentation::setMainOrigin() (C++).
Parameters
newOriginnew origin
keepOldOriginif true, the previous main origin is kept as a view origin.