Settings

Type class

Base class for Entity objects that support Settings.

Sources

This information about Settings is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

Settings does not extend any other symbol.

Settings is extended by Entity, DataItem.

Settings does not have any settings.

Private settings

Settings does not have any private settings.

Properties

uid #	Type `number` Default `++counter` Unique ID.

uid
#

Type number

Default ++counter

Unique ID.

Methods

animate( options: `AnimationOptions` ) #	Returns `Animation` Animates setting values from current/start values to new ones. Click here for more info
constructor( settings: `ISettingsSettings` ) #	Returns `Settings`
dispose() #	Returns `void` Disposes this object.
get( key: `Key`, fallback: `F` ) #	Returns `NonNullable` \| `F` Returns settings value for the specified `key`. If there is no value, `fallback` is returned instead (if set). Click here for more info
has( key: `Key` ) #	Returns `boolean` Returns `true` if the setting exists. Click here for more info
isDisposed() #	Returns `boolean` Returns `true` if this element is disposed.
off( key: `Key`, callback?: `undefined` \| ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `void` Removes a callback for when value of a setting changes. Click here for more info @since 5.9.2
offPrivate( key: `Key`, callback?: `undefined` \| ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `void` Removes a callback for when value of a private setting changes. Click here for more info @since 5.9.2
on( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `IDisposer` Sets a callback function to invoke when specific key of settings changes or is set. Click here for more info
onPrivate( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `IDisposer` Sets a callback function to invoke when specific key of private settings changes or is set. Click here for more info
remove( key: `Key` ) #	Returns `void` Removes a setting value for the specified `key`; Click here for more info
removeAll() #	Returns `void` Removes all keys; Click here for more info
set( key: `Key`, value: `Value` ) #	Returns `Value` Sets a setting `value` for the specified `key`, and returns the same `value`. Click here for more info
setAll( settings: `Partial` ) #	Returns `void` Sets multiple settings at once. `settings` must be an object with key: value pairs. Click here for more info

animate(

options: AnimationOptions

)

Returns Animation

Animates setting values from current/start values to new ones.

Click here for more info

constructor(

settings: ISettingsSettings

)

Returns Settings

dispose()

Returns void

Disposes this object.

get(

key: Key,
fallback: F

)

Returns NonNullable | F

Returns settings value for the specified key.

If there is no value, fallback is returned instead (if set).

Click here for more info

has(

key: Key

)

Returns boolean

Returns true if the setting exists.

Click here for more info

isDisposed()

Returns boolean

Returns true if this element is disposed.

off(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

Returns void

Removes a callback for when value of a setting changes.

Click here for more info
@since 5.9.2

offPrivate(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

Returns void

Removes a callback for when value of a private setting changes.

Click here for more info
@since 5.9.2

on(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

Returns IDisposer

Sets a callback function to invoke when specific key of settings changes or is set.

Click here for more info

onPrivate(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

Returns IDisposer

Sets a callback function to invoke when specific key of private settings changes or is set.

Click here for more info

remove(

key: Key

)

Returns void

Removes a setting value for the specified key;

Click here for more info

removeAll()

Returns void

Removes all keys;

Click here for more info

set(

key: Key,
value: Value

)

Returns Value

Sets a setting value for the specified key, and returns the same value.

Click here for more info

setAll(

settings: Partial

)

Returns void

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

Events

Settings does not have any events.