Class TweakableReferenceModel<T, M>

Type Parameters

T extends object
M extends ReferenceMetadata

Hierarchy

BaseModel<{
    valueRef: ModelProp<undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, never, false, string, never, never>;
}, never, never, never, this> & Omit<{
    valueRef: undefined | Ref<T>;
}, BaseModelKeys> & {
    setValueRef: ((value) => void);
}
- TweakableReferenceModel

Index

Constructors

Constructors

constructor

new TweakableReferenceModel<T, M>(data): TweakableReferenceModel<T, M>
Type Parameters
- T extends object
- M extends ReferenceMetadata
Parameters
- data: ModelPropsToTransformedCreationData<{
  valueRef: ModelProp<undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, never, false, string, never, never>;
  }>
Returns TweakableReferenceModel<T, M>
Inherited from Model( <T extends object>() => ({ valueRef: prop<Ref<T> | undefined>().withSetter() }), )<T>.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.

Type declaration

valueRef: undefined | Ref<T>

`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

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 Model( <T extends object>() => ({ valueRef: prop<Ref<T> | undefined>().withSetter() }), ).$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 Model( <T extends object>() => ({ valueRef: prop<Ref<T> | undefined>().withSetter() }), ).$modelId
- Defined in node_modules/mobx-keystone/dist/types/model/BaseModel.d.ts:39

label

get label(): string
Returns string
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:39

metadata

get metadata(): M
Returns M
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:18

ownPropertyName

get ownPropertyName(): undefined | string
Returns undefined | string
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:34

value

get value(): undefined | T
Returns undefined | T
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:23

valuePath

get valuePath(): string
Returns string
- 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 Model( <T extends object>() => ({ valueRef: prop<Ref<T> | undefined>().withSetter() }), ).getRefId
- Defined in node_modules/mobx-keystone/dist/types/model/BaseModel.d.ts:44

onAttachedToRootStore

onAttachedToRootStore(rootStore): void
Parameters
- rootStore: any
Returns void
Overrides Model( <T extends object>() => ({ valueRef: prop<Ref<T> | undefined>().withSetter() }), ).onAttachedToRootStore
- Defined in packages/svg-widget-studio/src/models/TweakableReferenceModel.ts:52

`Protected` `Optional` onInit

onInit(): void
Called after the model has been created.

Returns void
Inherited from Model( <T extends object>() => ({ valueRef: prop<Ref<T> | undefined>().withSetter() }), ).onInit
- Defined in node_modules/mobx-keystone/dist/types/model/BaseModel.d.ts:48

setValue

setValue(modelValue): void
Parameters
- modelValue: T
Returns void
- 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 Model( <T extends object>() => ({ valueRef: prop<Ref<T> | undefined>().withSetter() }), ).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 Model( <T extends object>() => ({ valueRef: prop<Ref<T> | undefined>().withSetter() }), ).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 Model( <T extends object>() => ({ valueRef: prop<Ref<T> | undefined>().withSetter() }), ).typeCheck
- Defined in node_modules/mobx-keystone/dist/types/model/BaseModel.d.ts:73

Class TweakableReferenceModel<T, M>

Type Parameters

T extends object

M extends ReferenceMetadata

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends object

M extends ReferenceMetadata

Parameters

data: ModelPropsToTransformedCreationData<{ valueRef: ModelProp<undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, never, false, string, never, never>; }>

Returns TweakableReferenceModel<T, M>

Properties

Readonly $

Type declaration

valueRef: undefined | Ref<T>

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

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

ownPropertyName

Returns undefined | string

value

Returns undefined | T

valuePath

Returns string

Methods

getRefId

Returns undefined | string

onAttachedToRootStore

Parameters

rootStore: any

Returns void

Protected Optional 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

On This Page

data: ModelPropsToTransformedCreationData<{
valueRef: ModelProp<undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, undefined | Ref<T>, never, false, string, never, never>;
}>

`Readonly` $

`Readonly` $modelType

`Protected` `Optional` onInit

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

`Optional` withData?: boolean