Options
All
  • Public
  • Public/Protected
  • All
Menu

Module types

Index

Interfaces

Type aliases

Type aliases

IColorPlatteUnitOption

IColorPlatteUnitOption: { colorArray: { border?: string; color: string }[] }

调色盘自定义配置

如果color颜色较浅，建议设置深色border，避免看不清该颜色

Type declaration

  • colorArray: { border?: string; color: string }[]

ICustomStateUnitOption

ICustomStateUnitOption: { backgroundImageByState?: {}; defaultState: string; clickCb: any }

自定义状态图标自定义配置

Type declaration

  • Optional backgroundImageByState?: {}

    根据图标当前状态选择背景图

    • [state: string]: string
  • defaultState: string

    默认状态

  • clickCb: function
    • clickCb(state: string): string

    • 点击图标后，给定当前状态，返回下一个状态

      Parameters

      • state: string

      Returns string

IDocUploadOption

IDocUploadOption: { supportDocToPic?: boolean; supportPptToH5?: boolean }

文档弹窗自定义配置：是否支持动态转码, 是否支持静态转码

example
{
     tool: 'docUpload',
     hint: '文档上传',
     supportPptToH5: true
     supportDocToPic: true
}

Type declaration

  • Optional supportDocToPic?: boolean

    若缺失，则默认为true

  • Optional supportPptToH5?: boolean

    若缺失，则默认为false

IDynamicDocParam

IDynamicDocParam: { height: number; pageCount: number; url: string; width: number }

动态文档转码结果

Type declaration

  • height: number

    文档高度

  • pageCount: number

    文档页面总数

  • url: string

    动态文档URL

  • width: number

    文档宽度

IMultiInOneOption

IMultiInOneOption: { itemPerRow?: number; subItems: IUnitOption[] }

收纳图标自定义配置

example
{
     tool: 'multiInOne',
     hint: '更多',
     itemPerRow: 4,
     subItems: [
         {
             item: 'video',
             hint: '上传视频‘
         },
         {
             item: 'audio',
             hint: '上传音频'
         },
     ]
}

Type declaration

  • Optional itemPerRow?: number

    每一行多少个图标。默认为4个

  • subItems: IUnitOption[]

    收纳盒中包含的子图标

IPlatform

IPlatform: "web" | "ios" | "android" | "pc" | "mac" | "pad"

sdk运行的目标设置

IPosition

IPosition: "leftBottom" | "left" | "leftTop" | "topLeft" | "top" | "topRight" | "rightTop" | "right" | "rightBottom" | "bottomRight" | "bottom" | "bottomLeft"

工具栏的位置

IPreviewUnitOption

IPreviewUnitOption: { previewSliderPosition: "left" | "right" }

预览图标自定义配置

控制预览图弹出的方位

example
{
     tool: 'preview',
     hint: '预览弹窗',
     previewSliderPosition: 'right'
}

Type declaration

  • previewSliderPosition: "left" | "right"

IShapeSelectOption

IShapeSelectOption: { subItems: IUnitOption[] }

图形选择图标的自定义配置

Type declaration

ITool

ITool: "select" | "laser" | "pen" | "shape" | "text" | "element-eraser" | "duplicate" | "clear" | "undo" | "redo" | "pan" | "image" | "zoomIn" | "zoomOut" | "reset" | "fitToContentDoc" | "zoomLevel" | "firstPage" | "lastPage" | "prevPage" | "nextPage" | "pageInfo" | "preview" | "docUpload" | "docSelect" | "pageBoardInfo" | "fitToContent" | "fitToDoc" | "platte" | "widthResize" | "shapeSelect" | "opacity"

工具栏工具类型

IToolCustomProperty

IToolCustomProperty: ICustomStateUnitOption | IPreviewUnitOption | IMultiInOneOption | IWidthResizeUnitOption | IColorPlatteUnitOption | IDocUploadOption | IShapeSelectOption

各类图标的私有配置

IUnitOption

IUnitOption: { backgroundImage?: string; hint?: string; size?: number; tool: ITool | string } & IToolCustomProperty
example

示例为收纳盒的配置

{
     tool: 'undo',
     hint: '撤销'
}

IVisionArgs

IVisionArgs: { broadcaster: string; broadcasterName: string | undefined }

broadcasterName: 主播名称。优先使用昵称(nickname), 若初始化时未设置nickname，则为主播uid

broadcaster: 主播uid

Type declaration

  • broadcaster: string
  • broadcasterName: string | undefined

IWidthResizeUnitOption

IWidthResizeUnitOption: { max: number; min: number; step: number }

画笔宽度调节器的自定义配置

Type declaration

  • max: number
  • min: number
  • step: number