Class GridItemListPlugin

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

Hierarchy

  • AViewerPluginSync<"">
    • GridItemListPlugin

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

constructor

Properties

Protected_dirty

_dirty: boolean = false

Protected Optional_viewer

_viewer?: ThreeViewer

Protected_viewerListeners

_viewerListeners: PartialRecord<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => void,
> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

create

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

enabled: boolean = true

removeAll

removeAll: (tag?: string) => void = GridItemList.RemoveAll

toJSON

toJSON: any = undefined

OptionaluiConfig

uiConfig?: UiObjectConfig = undefined

Static Optional ReadonlyOldPluginType

OldPluginType?: string

Static ReadonlyPluginType

PluginType: string = 'AViewerPlugin'

Accessors

dirty

Methods

Protected_onViewerEvent

  • _onViewerEvent(e: IViewerEvent): IViewerEvent

  • Parameters

    • e: IViewerEvent

    Returns IViewerEvent

Protected_storeKey

  • _storeKey(prefix?: string): string

  • Parameters

    • Optionalprefix: string

    Returns string

disable

dispose

enable

exportState

  • exportState(): ISerializedConfig | Record<string, never>

  • Returns ISerializedConfig | Record<string, never>

fromJSON

importState

  • importState(state: any): Promise<void>

  • Parameters

    • state: any

    Returns Promise<void>

isDisabled

onAdded

  • onAdded(viewer: ThreeViewer): void

  • Parameters

    • viewer: ThreeViewer

    Returns void

onRemove

rebuildUi

OptionalsetDirty

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods