Class TweakableReferenceWithOptionsModel<T, M>

Type Parameters

T extends object
M extends ReferenceWithOptionsMetadata<T>

Hierarchy

TweakableReferenceModel<T, M, this> & BaseModel<{}, never, never, never, this> & Omit<{}, BaseModelKeys> & {}
- TweakableReferenceWithOptionsModel

Index

Constructors

constructor

new TweakableReferenceWithOptionsModel<T, M>(data): TweakableReferenceWithOptionsModel<T, M>
Type Parameters
- T extends object
- M extends ReferenceWithOptionsMetadata<T>
Parameters
- data: {} & {} & {
  valueRef?: Ref<T>;
  } & {}
Returns TweakableReferenceWithOptionsModel<T, M>
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, }))<T, M>.constructor
- Defined in node_modules/mobx-keystone/dist/types/model/Model.d.ts:15

Properties

`Readonly` $

$: {
valueRef: undefined | Ref<T>;
} & {}

Data part of the model, which is observable and will be serialized in snapshots. Use it if one of the data properties matches one of the model properties/functions.

`Readonly` $modelType

$modelType: string

Model type name.

[fromSnapshotOverrideTypeSymbol]

[fromSnapshotOverrideTypeSymbol]: never

[modelIdPropertyNameSymbol]

[modelIdPropertyNameSymbol]: never

[propsTypeSymbol]

[propsTypeSymbol]: {
valueRef: ModelProp<undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, never, false, string, never, never>;
}

Type declaration

valueRef: ModelProp<undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, never, false, string, never, never>

[toSnapshotOverrideTypeSymbol]

[toSnapshotOverrideTypeSymbol]: never

onAttachedComplete

onAttachedComplete: boolean = false

`Readonly` options

options: undefined | T[]

setValueRef

setValueRef: ((value) => void) = ...

Type declaration

- (value): void
- Parameters
  - value: undefined | Ref<T>
  Returns void

valueRef

valueRef: undefined | Ref<T> = ...

Accessors

$modelId

get $modelId(): ModelIdPropertyType<TProps, ModelIdPropertyName>
Model internal id. Can be modified inside a model action. It will return undefined if there's no id prop set.

Returns ModelIdPropertyType<TProps, ModelIdPropertyName>
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).$modelId
- Defined in node_modules/mobx-keystone/dist/types/model/BaseModel.d.ts:38
set $modelId(newId): void
Parameters
- newId: ModelIdPropertyType<TProps, ModelIdPropertyName>
Returns void
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).$modelId
- Defined in node_modules/mobx-keystone/dist/types/model/BaseModel.d.ts:39

label

get label(): string
Returns string
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).label
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:39

metadata

get metadata(): M
Returns M
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).metadata
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:18

optionLabelMap

get optionLabelMap(): OptionLabelMapFn<T>
Returns OptionLabelMapFn<T>
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceWithOptionsModel.ts:16

ownPropertyName

get ownPropertyName(): undefined | string
Returns undefined | string
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).ownPropertyName
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:34

value

get value(): undefined | T
Returns undefined | T
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).value
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:23

valuePath

get valuePath(): string
Returns string
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).valuePath
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:44

Methods

getRefId

getRefId(): undefined | string
Can be overridden to offer a reference id to be used in reference resolution. By default it will use the idProp if available or return undefined otherwise.

Returns undefined | string
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).getRefId
- Defined in node_modules/mobx-keystone/dist/types/model/BaseModel.d.ts:44

onAttachedToRootStore

onAttachedToRootStore(rootStore): void
Parameters
- rootStore: any
Returns void
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).onAttachedToRootStore
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:52
onAttachedToRootStore(rootStore): void | (() => void)
Optional hook that will run once this model instance is attached to the tree of a model marked as root store via registerRootStore. Basically this is the place where you know the full root store is complete and where things such as middlewares, effects (reactions, etc), and other side effects should be registered, since it means that the model is now part of the active application state.

It can return a disposer that will be run once this model instance is detached from such root store tree.
Parameters
- rootStore: object
Returns void | (() => void)
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).onAttachedToRootStore
- Defined in node_modules/mobx-keystone/dist/types/model/BaseModel.d.ts:66

onInit

onInit(): void
Returns void
Overrides ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).onInit
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceWithOptionsModel.ts:20

setValue

setValue(modelValue): void
Parameters
- modelValue: T
Returns void
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).setValue
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:28

toString

toString(options?): string
Parameters
- Optional options: {
  withData?: boolean;
  }
  - Optional withData?: boolean
Returns string
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).toString
- Defined in node_modules/mobx-keystone/dist/types/model/BaseModel.d.ts:78
toString(): string
Returns a string representation of an object.

Returns string
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).toString
- Defined in node_modules/typescript/lib/lib.es5.d.ts:128

typeCheck

typeCheck(): null | TypeCheckError
Performs a type check over the model instance. For this to work a data type has to be declared as part of the model properties.

Returns null | TypeCheckError
A TypeCheckError or null if there is no error.
Inherited from ExtendedModel(<T extends object, M extends ReferenceWithOptionsMetadata<T>>() => ({ baseModel: modelClass<TweakableReferenceModel<T, M>>(TweakableReferenceModel), props: {}, })).typeCheck
- Defined in node_modules/mobx-keystone/dist/types/model/BaseModel.d.ts:73

Class TweakableReferenceWithOptionsModel<T, M>

Type Parameters

T extends object

M extends ReferenceWithOptionsMetadata<T>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends object

M extends ReferenceWithOptionsMetadata<T>

Parameters

data: {} & {} & { valueRef?: Ref<T>; } & {}

Returns TweakableReferenceWithOptionsModel<T, M>

Properties

Readonly $

Readonly $modelType

[fromSnapshotOverrideTypeSymbol]

[modelIdPropertyNameSymbol]

[propsTypeSymbol]

Type declaration

valueRef: ModelProp<undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, never, false, string, never, never>

[toSnapshotOverrideTypeSymbol]

onAttachedComplete

Readonly options

setValueRef

Type declaration

Parameters

value: undefined | Ref<T>

Returns void

valueRef

Accessors

$modelId

Returns ModelIdPropertyType<TProps, ModelIdPropertyName>

Parameters

newId: ModelIdPropertyType<TProps, ModelIdPropertyName>

Returns void

label

Returns string

metadata

Returns M

optionLabelMap

Returns OptionLabelMapFn<T>

ownPropertyName

Returns undefined | string

value

Returns undefined | T

valuePath

Returns string

Methods

getRefId

Returns undefined | string

onAttachedToRootStore

Parameters

rootStore: any

Returns void

Parameters

rootStore: object

Returns void | (() => void)

onInit

Returns void

setValue

Parameters

modelValue: T

Returns void

toString

Parameters

Optional options: { withData?: boolean; }

Optional withData?: boolean

Returns string

Returns string

typeCheck

Returns null | TypeCheckError

Settings

Member Visibility

Theme

data: {} & {} & {
valueRef?: Ref<T>;
} & {}

`Readonly` $

`Readonly` $modelType

`Readonly` options

`Optional` options: {
withData?: boolean;
}

`Optional` withData?: boolean