Skip to main content

ToolbarPreference

Extends

Constructors

Constructor

new ToolbarPreference(key, defaults?): ToolbarPreference;

Parameters

ParameterTypeDefault value
keyToolbarPositionundefined
defaultsEncodedEntity<{ }>[][]

Returns

ToolbarPreference

Overrides

AbstractSetting.constructor

Properties

PropertyTypeInherited from
defaultsEncodedEntity<{ }>[]-
deserializedbooleanAbstractSetting.deserialized
loggerLoggerAbstractSetting.logger
optionsAbstractSettingOptionsAbstractSetting.options

Accessors

buttons

Get Signature

get buttons(): EncodedEntity<{
}>[];
Returns

EncodedEntity<{ }>[]


initialized

Inherited from

AbstractSetting.initialized


items

Methods

addButton()

addButton(item): void;

Parameters

ParameterType
itemEncodedEntity

Returns

void


deserialize()

deserialize(data): void;

Parameters

ParameterType
data{ items: EncodedEntity<{ }>[]; }
data.itemsEncodedEntity<{ }>[]

Returns

void

Overrides

AbstractSetting.deserialize

doDeserialize()

doDeserialize(data): void;

FYI: This is called after init()

Parameters

ParameterType
dataany

Returns

void

Inherited from

AbstractSetting.doDeserialize


doSerialize()

doSerialize(): any;

Returns

any

Inherited from

AbstractSetting.doSerialize


init()

init(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractSetting.init


removeButton()

removeButton(item): void;

Parameters

ParameterType
itemEncodedEntity

Returns

void


reset()

reset(): void;

Returns

void

Overrides

AbstractSetting.reset


save()

save(): void;

Returns

void

Inherited from

AbstractSetting.save


serialize()

serialize(): {
items: EncodedEntity<{
}>[];
};

Returns

{
items: EncodedEntity<{
}>[];
}
NameType
itemsEncodedEntity<{ }>[]

Overrides

AbstractSetting.serialize

updateOptions()

updateOptions(options): void;

Parameters

ParameterType
optionsPartial<T>

Returns

void

Inherited from

AbstractSetting.updateOptions


waitForReady()

waitForReady(): Promise<ToolbarPreference>;

Returns

Promise<ToolbarPreference>

Inherited from

AbstractSetting.waitForReady