Class BaseWidgetClassAbstract

Hierarchy

  • BaseModel<{}, never, never, never, this> & Omit<{}, BaseModelKeys> & {}
    • BaseWidgetClass

Constructors

  • Parameters

    • data: ModelPropsToTransformedCreationData<{}>

    Returns BaseWidgetClass

Properties

$: {}

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

    $modelType: string

    Model type name.

    PanelContent?: FC
    WatermarkContent?: WatermarkContentComponent
    [fromSnapshotOverrideTypeSymbol]: never
    [modelIdPropertyNameSymbol]: never
    [propsTypeSymbol]: {}

    Type declaration

      [toSnapshotOverrideTypeSymbol]: never
      additionalFileMenuItems?: FileMenuItem[]
      additionalToolbarContent?: AdditionalToolbarItem[]
      history: undefined | UndoManager

      Accessors

      • 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>

      • set $modelId(newId): void
      • Parameters

        • newId: ModelIdPropertyType<TProps, ModelIdPropertyName>

        Returns void

      Methods

      • 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

      • 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)

      • Parameters

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

        Returns string

      • Returns a string representation of an object.

        Returns string

      • 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.

      Generated using TypeDoc