API Reference

Global API

Application

• createPtah()
• app.id
• app.modeType
• app.$load()
• app.$proxyData()
• app.$lifecycle()
• app.$blocks()
• app.$vueInstance()
• app.$mode()
• app.use()
• app.schema()
• app.mount()
• app.unmount()

Usage Instance

• usePtah()

Composition API

• usePtahInstance()
• useUI()
• useExecuteEvent()
• usePropsFormModel()
• useRenderListener()
• useSceneRendering()
• useSceneRendered()

Utility Functions

• createNumberProp()
• createObjectProp()
• createStringProp()
• createGroupProp()
• createBooleanProp()
• createArrayProp()
• createSlot()

Modes

• Web Mode
• Mobile Mode
• Canvas Mode
• Flow Mode
• 3D Mode

Types

• Module Types
• Resource Types
• Drag Types
• Lifecycle Types

Built-in Components

Components

• Provider
• BlocksWidget
• Workspace
• ModulesRenderer
• ModuleConfigureWidget
• ScenesWidget
• SceneConfigureWidget
• EventsWidget
• Preview
• DndItem
• DragCloneItem
• DropContainer