EntityDefinition<T>

Type Parameters

Type Parameter	Default type
T extends any	any

Constructors

Constructor

new EntityDefinition<T>(options): EntityDefinition<T>;

Parameters

Parameter	Type
options	EntityDefinitionOptions

Returns

EntityDefinition<T>

Properties

Property	Type
system	System

Accessors

actionStore

---

category

Get Signature

get category(): string;

Returns

string

---

comboBoxStore

---

icon

Get Signature

get icon(): ReactorIcon;

Returns

ReactorIcon

---

iconColor

Get Signature

get iconColor(): string;

Returns

string

---

iconColorDefault

Get Signature

get iconColorDefault(): string;

Returns

string

---

label

Get Signature

get label(): string;

Returns

string

---

themeStore

---

type

Get Signature

get type(): string;

Returns

string

---

workspaceStore

Methods

decode()

decode(entity): Promise<T>;

Parameters

Parameter	Type
entity	EncodedEntity

Returns

Promise<T>

---

describeEntity()

describeEntity(t): EntityDescription;

Parameters

Parameter	Type
t	T

Returns

EntityDescription

---

encode()

encode(entity, throws?): EncodedEntity;

Parameters

Parameter	Type	Default value
entity	T	undefined
throws	boolean	true

Returns

EncodedEntity

---

getActionEventDataForEntity()

getActionEventDataForEntity(entity, a): {
};

Parameters

Parameter	Type
entity	T
a	Action

Returns

{
}

---

getActionsForEntity()

getActionsForEntity(entity): Action<Partial<ActionGenerics>, ActionGenerics & Partial<ActionGenerics>, ActionListener<ActionEvent>>[];

Parameters

Parameter	Type
entity	T

Returns

Action<Partial<ActionGenerics>, ActionGenerics & Partial<ActionGenerics>, ActionListener<ActionEvent>>[]

---

getAsComboBoxItem()

getAsComboBoxItem(t): EntityComboBoxItem<T>;

Parameters

Parameter	Type
t	T

Returns

EntityComboBoxItem<T>

---

getComboBoxDirective()

getComboBoxDirective(options): ComboBoxDirective<EntityComboBoxItem<T>>;

Parameters

Parameter	Type
options	EntityPickOptions<T>

Returns

ComboBoxDirective<EntityComboBoxItem<T>>

---

getDescribers()

getDescribers(): EntityDescriberComponent<T>[];

Returns

EntityDescriberComponent<T>[]

---

getDocumenters()

getDocumenters(): EntityDocsComponent<T>[];

Returns

EntityDocsComponent<T>[]

---

getEncoder()

getEncoder(version?): EntityEncoderComponent<T>;

Parameters

Parameter	Type
version?	number

Returns

EntityEncoderComponent<T>

---

getEncoders()

getEncoders(): EntityEncoderComponent<T, {
}>[];

Returns

EntityEncoderComponent<T, { }>[]

---

getEntityUID()

abstract getEntityUID(t): any;

Parameters

Parameter	Type
t	T

Returns

any

---

getExposers()

getExposers(): DescendantEntityProviderComponent<T, any>[];

Returns

DescendantEntityProviderComponent<T, any>[]

---

getHandlers()

getHandlers(): EntityHandlerComponent<any>[];

Returns

EntityHandlerComponent<any>[]

---

getPanelComponents()

getPanelComponents(): EntityPanelComponent<any>[];

Returns

EntityPanelComponent<any>[]

---

getPreferredDescriber()

getPreferredDescriber(): EntityDescriberComponent<T>;

Returns

EntityDescriberComponent<T>

---

getPresenters()

getPresenters(): EntityPresenterComponent<any, AbstractPresenterContext<any, {
}, AbstractPresenterContextSettings, PresenterContextListener>>[];

Returns

EntityPresenterComponent<any, AbstractPresenterContext<any, { }, AbstractPresenterContextSettings, PresenterContextListener>>[]

---

getSearchEngines()

getSearchEngines(): EntitySearchEngineComponent<T>[];

Returns

EntitySearchEngineComponent<T>[]

---

getSettings()

getSettings(): AbstractSetting<AbstractSettingOptions>[];

Returns

AbstractSetting<AbstractSettingOptions>[]

---

isActionAllowedForEntity()

isActionAllowedForEntity(action, entity): boolean;

Parameters

Parameter	Type
action	Action
entity	T

Returns

boolean

---

isMultiSelectable()

isMultiSelectable(): boolean;

Returns

boolean

---

matchEntity()

abstract matchEntity(t): boolean;

Parameters

Parameter	Type
t	any

Returns

boolean

---

registerAdditionalAction()

registerAdditionalAction(actionId): void;

Parameters

Parameter	Type
actionId	string

Returns

void

---

registerComponent()

registerComponent(component): void;

Parameters

Parameter	Type
component	EntityDefinitionComponent

Returns

void

---

resolveOneEntity()

resolveOneEntity(options?): Promise<T>;

Parameters

Parameter	Type
options	EntityPickOptions<T>

Returns

Promise<T>

---

selectEntity()

selectEntity(event): Promise<any>;

Parameters

Parameter	Type
event	OpenEntityEvent<T>

Returns

Promise<any>

---

setSystem()

setSystem(system): void;

Parameters

Parameter	Type
system	System

Returns

void

---

showContextMenuForEntity()

showContextMenuForEntity(
   entity, 
   event, 
   options?
): void;

Parameters

Parameter	Type
entity	T
event	MousePosition
options	ShowContextMenuForEntityOptions

Returns

void