EntitySetting<I>

Deprecated

Extends

• AbstractUserSetting<EntityControl<I>, EntitySettingOptions<I>>

Type Parameters

Type Parameter
I

Constructors

Constructor

new EntitySetting<I>(options): EntitySetting<I>;

Parameters

Parameter	Type
options	EntitySettingOptions<I>

Returns

EntitySetting<I>

Overrides

AbstractUserSetting.constructor

Properties

Property	Type	Inherited from
deserialized	boolean	AbstractUserSetting.deserialized
logger	Logger	AbstractUserSetting.logger
options	EntitySettingOptions	AbstractUserSetting.options

Accessors

entity

Get Signature

get entity(): I;

Returns

I

---

initialized

Inherited from

AbstractUserSetting.initialized

Methods

canBeChanged()

canBeChanged(): boolean;

Returns

boolean

Inherited from

AbstractUserSetting.canBeChanged

---

deserialize()

deserialize(data): Promise<void>;

Parameters

Parameter	Type
data	{ entity: EncodedEntity<{ }>; }
data.entity	EncodedEntity<{ }>

Returns

Promise<void>

Overrides

AbstractUserSetting.deserialize

---

doDeserialize()

doDeserialize(data): void;

FYI: This is called after init()

Parameters

Parameter	Type
data	any

Returns

void

Inherited from

AbstractUserSetting.doDeserialize

---

doSerialize()

doSerialize(): any;

Returns

any

Inherited from

AbstractUserSetting.doSerialize

---

generateControl()

generateControl(): Element;

Returns

Element

Inherited from

AbstractUserSetting.generateControl

---

init()

init(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractUserSetting.init

---

reset()

reset(): void;

Returns

void

Inherited from

AbstractUserSetting.reset

---

save()

save(): void;

Returns

void

Inherited from

AbstractUserSetting.save

---

serialize()

serialize(): {
  entity: EncodedEntity<{
  }>;
};

Returns

{
  entity: EncodedEntity<{
  }>;
}

Name	Type
entity	EncodedEntity<{ }>

Overrides

AbstractUserSetting.serialize

---

setDefault()

setDefault(value): void;

Parameters

Parameter	Type
value	I

Returns

void

Inherited from

AbstractUserSetting.setDefault

---

setItem()

setItem(item): void;

Parameters

Parameter	Type
item	I

Returns

void

---

updateOptions()

updateOptions(options): void;

Parameters

Parameter	Type
options	Partial<EntitySettingOptions<I>>

Returns

void

Overrides

AbstractUserSetting.updateOptions

---

waitForReady()

waitForReady(): Promise<EntitySetting<I>>;

Returns

Promise<EntitySetting<I>>

Inherited from

AbstractUserSetting.waitForReady