mce
    Preparing search index...

    Interface Options

    interface Options {
        activeStrategy?: ActiveStrategy;
        autoSave?: { debounceMs?: number; enabled?: boolean };
        canvas?: {
            checkerboard?: {
                enabled?: boolean;
                style?: "grid" | "gridDark" | "dot" | "dotDark";
            };
            frame?: { gap?: number; outline?: boolean; thumbnail?: boolean };
            msaa?: { enabled?: boolean };
            pixelate?: { enabled?: boolean };
            pixelGrid?: { enabled?: boolean };
            watermark?: {
                alpha?: number;
                rotation?: number;
                url?: string;
                width?: number;
            };
        };
        clipboard?: boolean;
        customContextMenu?: (defaultMenu: MenuItem[], editor: Editor) => MenuItem[];
        db?: { local?: boolean };
        doc?: DocumentSource;
        doubleclickStrategy?: DoubleclickStrategy;
        hotkeys?: {
            command?: string;
            editable?: boolean;
            enabled?: boolean;
            key?: string | (string | undefined)[];
            preventDefault?: boolean;
            system?: boolean;
        }[];
        hoverStrategy?: HoverStrategy;
        http?: Http;
        interaction?: {
            transform?: {
                handleShape?: "rect"
                | "circle";
                handleStyle?: "8-points" | "4-points";
                lockAspectRatioStrategy?: "all" | "diagonal";
                rotator?: boolean;
            };
        };
        locale?: Locale;
        mode?: Mode;
        readonly?: boolean;
        resizeStrategy?: ResizeStrategy;
        t?: Translation;
        typography?: {
            defaultFont?: | string
            | { family?: string
            | (string | undefined)[]; src?: string };
            strategy?:
                | "autoHeight"
                | "autoWidth"
                | "fixedWidthHeight"
                | "autoFontSize";
        };
        ui?: {
            creator?: { visible?: boolean };
            madeWith?: { visible?: boolean };
            panels?: {
                [key: string]:
                    | {
                        size?: number;
                        transform?: {
                            height?: number;
                            left?: number;
                            top?: number;
                            width?: number;
                        };
                        visible?: boolean;
                    }
                    | undefined;
            };
            ruler?: {
                adsorbed?: boolean;
                boxColor?: string;
                lineColor?: string;
                locked?: boolean;
                visible?: boolean;
            };
            scrollbar?: { visible?: boolean };
            shortcuts?: { visible?: boolean };
            statusbar?: { visible?: boolean };
            timeline?: { visible?: boolean };
            toolbelt?: {
                offset?: number;
                placement?: "top" | "right" | "bottom" | "left";
                visible?: boolean;
            };
        };
        uploader?: Upload;
        viewport?: {
            camera?: { enabled?: boolean };
            screenPadding?: {
                bottom?: number;
                left?: number;
                right?: number;
                top?: number;
            };
            zoom?: {
                strategy?: "cover"
                | "contain"
                | "containWidth"
                | "containHeight";
            };
        };
    }

    Hierarchy

    Index

    Properties

    activeStrategy?: ActiveStrategy
    autoSave?: { debounceMs?: number; enabled?: boolean }

    Type Declaration

    • OptionaldebounceMs?: number

      变更后空闲多久(ms)才触发,debounce 合并连续编辑

    • Optionalenabled?: boolean

      是否在文档变更后自动触发 save 事件

    canvas?: {
        checkerboard?: {
            enabled?: boolean;
            style?: "grid" | "gridDark" | "dot" | "dotDark";
        };
        frame?: { gap?: number; outline?: boolean; thumbnail?: boolean };
        msaa?: { enabled?: boolean };
        pixelate?: { enabled?: boolean };
        pixelGrid?: { enabled?: boolean };
        watermark?: {
            alpha?: number;
            rotation?: number;
            url?: string;
            width?: number;
        };
    }
    clipboard?: boolean
    customContextMenu?: (defaultMenu: MenuItem[], editor: Editor) => MenuItem[]
    db?: { local?: boolean }
    doubleclickStrategy?: DoubleclickStrategy
    hotkeys?: {
        command?: string;
        editable?: boolean;
        enabled?: boolean;
        key?: string | (string | undefined)[];
        preventDefault?: boolean;
        system?: boolean;
    }[]
    hoverStrategy?: HoverStrategy
    http?: Http
    interaction?: {
        transform?: {
            handleShape?: "rect" | "circle";
            handleStyle?: "8-points" | "4-points";
            lockAspectRatioStrategy?: "all" | "diagonal";
            rotator?: boolean;
        };
    }
    locale?: Locale
    mode?: Mode

    编辑器初始模式,默认 'canvas'。见 Mode

    readonly?: boolean

    启动即只读:仅浏览 / 平移 / 缩放,禁用一切编辑。运行时可改 editor.readonly.value

    resizeStrategy?: ResizeStrategy
    typography?: {
        defaultFont?:
            | string
            | { family?: string
            | (string | undefined)[]; src?: string };
        strategy?: "autoHeight" | "autoWidth" | "fixedWidthHeight" | "autoFontSize";
    }
    ui?: {
        creator?: { visible?: boolean };
        madeWith?: { visible?: boolean };
        panels?: {
            [key: string]:
                | {
                    size?: number;
                    transform?: {
                        height?: number;
                        left?: number;
                        top?: number;
                        width?: number;
                    };
                    visible?: boolean;
                }
                | undefined;
        };
        ruler?: {
            adsorbed?: boolean;
            boxColor?: string;
            lineColor?: string;
            locked?: boolean;
            visible?: boolean;
        };
        scrollbar?: { visible?: boolean };
        shortcuts?: { visible?: boolean };
        statusbar?: { visible?: boolean };
        timeline?: { visible?: boolean };
        toolbelt?: {
            offset?: number;
            placement?: "top" | "right" | "bottom" | "left";
            visible?: boolean;
        };
    }

    Type Declaration

    • Optionalcreator?: { visible?: boolean }
    • OptionalmadeWith?: { visible?: boolean }
    • Optionalpanels?: {
          [key: string]:
              | {
                  size?: number;
                  transform?: {
                      height?: number;
                      left?: number;
                      top?: number;
                      width?: number;
                  };
                  visible?: boolean;
              }
              | undefined;
      }

      各面板的持久化运行时状态(显隐 / 浮动位置尺寸),按面板 name 索引。

    • Optionalruler?: {
          adsorbed?: boolean;
          boxColor?: string;
          lineColor?: string;
          locked?: boolean;
          visible?: boolean;
      }
    • Optionalscrollbar?: { visible?: boolean }
    • Optionalshortcuts?: { visible?: boolean }
    • Optionalstatusbar?: { visible?: boolean }
    • Optionaltimeline?: { visible?: boolean }
    • Optionaltoolbelt?: {
          offset?: number;
          placement?: "top" | "right" | "bottom" | "left";
          visible?: boolean;
      }
      • Optionaloffset?: number

        沿停靠边的中心坐标(上 / 下 为 x、左 / 右 为 y,相对画板像素)。undefined 表示居中。

      • Optionalplacement?: "top" | "right" | "bottom" | "left"

        浮动停靠方向:上 / 下 / 左 / 右。左右为竖向排列。默认 bottom。

      • Optionalvisible?: boolean
    uploader?: Upload

    上传实现:传入 blob,返回上传后的可访问 URL。也可运行时用 Editor.setUploader 设置。

    viewport?: {
        camera?: { enabled?: boolean };
        screenPadding?: {
            bottom?: number;
            left?: number;
            right?: number;
            top?: number;
        };
        zoom?: {
            strategy?: "cover"
            | "contain"
            | "containWidth"
            | "containHeight";
        };
    }