Skip to content

API 索引

EasyInk 的公共 API 按包组织。以下是各包的主要导出。

@easyink/designer

设计器组件和相关工具。

导出类型说明
EasyInkDesignerVue Component设计器根组件
DesignerStoreClass核心状态管理
provideDesignerStoreFunctionVue provide 注入 store
useDesignerStoreFunctionVue inject 获取 store
registerMaterialBundleFunction注册物料包
ContributionRegistryClass贡献注册表
TemplateHistoryManagerClass模板历史管理
createLocalStoragePreferenceProviderFunctionlocalStorage 偏好持久化
tableSectionFilterFunction表格属性面板过滤器

类型导出:DocumentSchema, DocumentSchemaInput, MaterialNode, DataSourceDescriptor, Contribution, ContributionContext, DesignerMaterialBundle, MaterialCapabilities, TemplateAutoSaveOptions, PreferenceProvider

@easyink/viewer

独立的预览/打印/导出引擎。

导出类型说明
createViewerFunction创建 ViewerRuntime
ViewerRuntimeClass核心运行时
MaterialRendererRegistryClass物料渲染注册表
renderPagesFunction渲染页面 DOM
createThumbnailsFunction生成缩略图
collectFontFamiliesFunction收集字体引用
loadAndInjectFontsFunction加载并注入字体
projectBindingsFunction解析数据绑定
applyBindingsToPropsFunction应用绑定到属性
resolvePrintPolicyFunction解析打印策略
createBrowserViewerHostFunctionBrowser Host
createIframeViewerHostFunctionIframe Host
createCustomViewerHostFunctionCustom Host

类型导出:ViewerHost, ViewerOptions, ViewerOpenInput, ViewerRenderResult, ViewerDiagnosticEvent, PrintDriver, ViewerPrintPolicy, ViewerExporter, ViewerExportContext

@easyink/schema

文档 Schema 类型定义和工具。

导出类型说明
getNodePropsFunction获取类型化的元素属性
isTableNodeFunction表格节点类型守卫
isTableDataNodeFunction数据表格节点类型守卫
createDefaultSchemaFunction创建完整默认 Schema
normalizeDocumentSchemaFunction将空对象或部分 Schema 输入补齐为完整 Schema
validateSchemaIssuesFunction返回结构化 Schema 校验问题
isValidSchemaFunction判断对象是否为完整合法 Schema

类型导出:DocumentSchema, DocumentSchemaInput, PageSchema, MaterialNode, TableNode, TableSchema, BindingRef, AnimationSchema

@easyink/export-runtime

导出运行时框架。

导出类型说明
createExportRuntimeFunction创建 ExportRuntime
ExportRuntimeClass导出运行时

类型导出:ExportFormatPlugin, ExportRuntimeContext, ExportDiagnostic, ExportProgress

@easyink/datasource

数据源管理。

类型导出:DataSourceDescriptor, DataFieldNode, DataUnionBinding, DataSourceProviderFactory, DataSourceRegistry