Package io.deephaven.web.client.api.console

Class JsVariableDefinition

java.lang.Object

io.deephaven.web.client.api.console.JsVariableDefinition

@TsInterface
@TsName(namespace="dh.ide",
        name="VariableDefinition")
public class JsVariableDefinition
extends Object

A format to describe a variable available to be read from the server. Application fields are optional, and only populated when a variable is provided by application mode.

APIs which take a JsVariableDefinition must at least be provided an object with a type and id field.

Constructor Summary

Constructors

Constructor	Description
JsVariableDefinition(FieldInfo field)
JsVariableDefinition(String type, String title, String id, String description)

Method Summary

Modifier and Type	Method	Description
String	getApplicationId()	Optional description for the variable's contents, typically used to provide more detail that wouldn't be reasonable to put in the title.
String	getApplicationName()	The name of the application which provided this variable.
String	getDescription()	Optional description for the variable's contents, typically used to provide more detail that wouldn't be reasonable to put in the title.
String	getId()	An opaque identifier for this variable.
String	getName()	Deprecated.
String	getTitle()	The name of the variable, to be used when rendering it to a user.
@TsTypeRef(JsVariableType.class) String	getType()	The type of the variable, one of dh.VariableType.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JsVariableDefinition

public JsVariableDefinition(String type,
 String title,
 String id,
 String description)

JsVariableDefinition

public JsVariableDefinition(FieldInfo field)

Method Details

getType

@JsProperty
@TsTypeRef(JsVariableType.class)
public @TsTypeRef(JsVariableType.class) String getType()

The type of the variable, one of dh.VariableType.

Returns:

dh.VariableType.

getName

@JsProperty
@Deprecated
public String getName()

Deprecated.

getTitle

@JsProperty
public String getTitle()

The name of the variable, to be used when rendering it to a user.

Returns:

String

getId

@JsProperty
public String getId()

An opaque identifier for this variable.

Returns:

String

getDescription

@JsProperty
public String getDescription()

Optional description for the variable's contents, typically used to provide more detail that wouldn't be reasonable to put in the title.

Returns:

String

getApplicationId

@JsProperty
public String getApplicationId()

Optional description for the variable's contents, typically used to provide more detail that wouldn't be reasonable to put in the title.

Returns:

String

getApplicationName

@JsProperty
public String getApplicationName()

The name of the application which provided this variable.

Returns:

String