Class representing a view in a Vitessce view config.
Details
View in a VitessceConfig
Methods
Method new()
Create a new view object.
Arguments
componentA component name.
coordination_scopesA list of the coordination scope mappings for each coordination type.
xThe x-coordinate of the view in the layout.
yThe y-coordinate of the view in the layout.
wThe width of the view in the layout.
hThe height of the view in the layout.
Returns
A new VitessceConfigView object.
Method use_coordination()
Link this view to existing coordination scope(s).
Usage
VitessceConfigView$use_coordination(c_scopes)
Arguments
c_scopesA list of VitessceConfigCoordinationScope objects to use.
Returns
Invisible self, to allow chaining.
Method use_coordination_by_dict()
Usage
VitessceConfigView$use_coordination_by_dict(scopes)
Usage
VitessceConfigView$use_meta_coordination(meta_scope)
Method set_xywh()
Set the dimensions of the view.
Usage
VitessceConfigView$set_xywh(x, y, w, h)
Arguments
xThe x-coordinate of the view in the layout.
yThe y-coordinate of the view in the layout.
wThe width of the view in the layout.
hThe height of the view in the layout.
Returns
Self, to allow chaining.
Method set_props()
Set additional props for this view.
Usage
VitessceConfigView$set_props(...)
Arguments
...Any named props to set.
Returns
Self, to allow chaining.
Method to_list()
Convert the object to an R list. Helpful when converting the config to JSON.
Usage
VitessceConfigView$to_list()
Returns
A list that can be serialized to JSON using rjson.
Method clone()
The objects of this class are cloneable with this method.
Usage
VitessceConfigView$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.