VitessceConfigCoordinationScope: VitessceConfigCoordinationScope Class

VitessceConfigCoordinationScopeR Documentation

VitessceConfigCoordinationScope Class

Description

Class representing a coordination scope in a Vitessce view config.

Details

Coordination scope in a VitessceConfig

Public fields

c_type

The coordination type as a string.

c_scope

The coordination scope as a string.

c_value

The coordination value.

Methods

Public methods


Method new()

Create a new coordination scope object.

Usage
VitessceConfigCoordinationScope$new(c_type, c_scope, c_value = NA)
Arguments
c_type

A coordination type name.

c_scope

A coordination scope name.

c_value

An initial value for the coordination scope.

Returns

A new VitessceConfigCoordinationScope object.


Method set_value()

Set the coordination value of this coordination scope object.

Usage
VitessceConfigCoordinationScope$set_value(c_value)
Arguments
c_value

The value to set.

Returns

Invisible self, to allow chaining.


Method set_value_raw()

Set the coordination value of this coordination scope object, without unboxing.

Usage
VitessceConfigCoordinationScope$set_value_raw(c_value)
Arguments
c_value

The value to set.

Returns

Invisible self, to allow chaining.


Method clone()

The objects of this class are cloneable with this method.

Usage
VitessceConfigCoordinationScope$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


keller-mark/vitessce-htmlwidget documentation built on Oct. 4, 2023, 2:30 a.m.