BaseEntityWidgets

BaseEntityWidgets

Class to represent a label and textbox widget for selecting Entity ids

This is intended to be a base class for other classes to extend, so shouldn't be used directly.

Constructor

new BaseEntityWidgets(entity_type, label, textbox, tag, valid_tags, hoveropt)

Description:
  • Create a new BaseEntityWidgets
Source:
Example
let entity_widgets = new BaseEntityWidgets(label, textbox, "MY_TAG", ["MY_TAG", "MY_OTHER_TAG"], hover_text);
Parameters:
Name Type Attributes Default Description
entity_type string Entity type constant
label Widget The entity label widget
textbox Widget The entity textbox widget
tag string The entity tag
valid_tags Array.<string> Valid entity tags
hover string <optional>
"" The entity label hover text

Members

entity_type :string

Description:
  • Entity type constant
Source:
Entity type constant
Type:
  • string

hover :string

Description:
  • The hover text for the label
Source:
The hover text for the label
Type:
  • string

label :Widget

Description:
  • The entity label widget
Source:
The entity label widget
Type:
  • Widget

tag :string

Description:
  • The entity tag
Source:
The entity tag
Type:
  • string

textbox :Widget

Description:
  • The entity textbox widget
Source:
The entity textbox widget
Type:
  • Widget

valid_tags :Array.<string>

Description:
  • The valid tags
Source:
The valid tags
Type:
  • Array.<string>

Methods

Hide()

Description:
  • Hide the label and textbox widgets
Source:
Example
entity_widgets.Hide();

Show()

Description:
  • Show the label and textbox widgets
Source:
Example
entity_widgets.Show();