Threepipe Configurator Plugins
    Preparing search index...

    Class GridItemListPlugin

    A helper plugin to create a a simple list of small grids like for material or object configurator

    Hierarchy

    • AViewerPluginSync
      • GridItemListPlugin
    Index

    Constructors

    constructor

    Properties

    _dirty _viewer? _viewerListeners constructor create enabled removeAll toJSON uiConfig? OldPluginType? PluginType

    Accessors

    dirty

    Methods

    _onViewerEvent _storeKey disable dispose enable exportState fromJSON importState isDisabled onAdded onRemove rebuildUi setDirty?

    Constructors

    Properties

    Protected_dirty

    _dirty: boolean = false

    Protected Optional_viewer

    _viewer?: ThreeViewer

    Protected_viewerListeners

    _viewerListeners: PartialRecord<
        | "preRender"
        | "postRender"
        | "preFrame"
        | "postFrame"
        | "dispose"
        | "update"
        | "*"
        | "addPlugin"
        | "removePlugin"
        | "renderEnabled"
        | "renderDisabled",
        (e: IViewerEvent) => void,
    > = {}
    constructor: typeof AViewerPluginSync & typeof AViewerPlugin
    create: <T extends GridItem>(
        tag: string,
        title: string,
        cols: number,
        x: number,
        y: number,
        items: T[],
        processDiv: (d: HTMLDivElement, item: T, container: HTMLElement) => void,
    ) => HTMLDivElement = GridItemList.Create
    enabled: boolean = true
    removeAll: (tag?: string) => void = GridItemList.RemoveAll
    toJSON: any = undefined
    uiConfig?: UiObjectConfig<any, string, any> = undefined
    OldPluginType?: string
    PluginType: string = 'AViewerPlugin'

    Accessors

    Methods

    Protected_onViewerEvent

    • _onViewerEvent(e: IViewerEvent): IViewerEvent

      Parameters

      • e: IViewerEvent

      Returns IViewerEvent

    Protected_storeKey

    • _storeKey(prefix?: string): string

      Parameters

      • Optionalprefix: string

      Returns string

    • Parameters

      • key: any
      • setDirty: boolean = true

      Returns void

    • Parameters

      • key: any
      • setDirty: boolean = true

      Returns void

    • Returns ISerializedConfig | Record<string, never>

    • Parameters

      • state: any

      Returns Promise<void>

    • Parameters

      • viewer: ThreeViewer

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods