Skip to content

API

Hook

配置项

名称类型默认值必填说明版本
boardRef<HTMLElement | undefined>undefined操作区域0.0.3
targetRef<HTMLElement | undefined>undefined操作目标0.0.3
zoomSpeednumber0.1缩放速度0.0.3
zoomMaxnumber3最大缩放比例0.0.3
zoomMinnumber0.2最小缩放比例0.0.3
padding[number, number, number, number]0.2内边距(主要影响 fitSize 方法)0.0.3
onReady() => voidundefined初始化完成0.0.3
onTargetChange(
  info: {
    width: number,
    height: number,
    left: number,
    top: number,
    zoom: number
  },
  methods: {
    fitSize: (animate = false)
    => void,
    focus: (dom: HTMLElement | null | undefined, padding?: number)
    => void,
    center: (dom: HTMLElement | null | undefined)
    => void,
    zoom: (value: number, animate = false, point?: { x: number; y: number } | null)
    => void,
 }
)
=> void
undefined操作目标变化0.3.0
onBoardChange(
  info: {
    width: number,
    height: number,
    left: number,
    top: number
  },
  methods: {
    fitSize: (animate = false)
    => void,
    focus: (dom: HTMLElement | null | undefined, padding?: number)
    => void,
    center: (dom: HTMLElement | null | undefined)
    => void,
    zoom: (value: number, animate = false, point?: { x: number; y: number } | null)
    => void,
  }
)
=> void
undefined操作区域变化0.3.0

Component

配置项

名称类型默认值必填说明版本
zoomSpeednumber0.1缩放速度0.0.3
zoomMaxnumber3最大缩放比例0.0.3
zoomMinnumber0.2最小缩放比例0.0.3
padding[number, number, number, number]0.2内边距(主要影响 fitSize 方法)0.0.3

事件

NameTypeDescVersion
ready()=>void初始化完成0.0.3
target-change(
  info: {
    width: number,
    height: number,
    left: number,
    top: number,
    zoom: number
  },
  methods: {
    fitSize: (animate = false)
    => void,
    focus: (dom: HTMLElement | null | undefined, padding?: number)
    => void,
    center: (dom: HTMLElement | null | undefined)
    => void,
    zoom: (value: number, animate = false, point?: { x: number; y: number } | null)
    => void,
  }
)
=> void
操作目标变化0.3.0
board-change(
  info: {
    width: number,
    height: number,
    left: number,
    top: number
  },
  methods: {
    fitSize: (animate = false)
    => void,
    focus: (dom: HTMLElement | null | undefined, padding?: number)
    => void,
    center: (dom: HTMLElement | null | undefined)
    => void,
    zoom: (value: number, animate = false, point?: { x: number; y: number } | null)
    => void,
 }
)
=> void
操作区域变化0.3.0

插槽

NameBindDescVersion
default(
  target: {
    width: number,
    height: number,
    left: number,
    top: number,
    zoom: number
  }
  board: {
    width: number,
    height: number,
    left: number,
    top: number
  },
  methods: {
    fitSize: (animate = false)
    => void,
    focus: (dom: HTMLElement | null | undefined, padding?: number)
    => void,
    center: (dom: HTMLElement | null | undefined)
    => void,
    zoom: (value: number, animate = false, point?: { x: number; y: number } | null)
    => void,
  }
)
默认插槽0.3.0

方法

NameTypeDescVersion
fitSize(animate = false)
=> void
适应区域大小0.0.3
foucs(dom: HTMLElement | null | undefined, padding?: number)
=> void
适应目标大小0.1.0
center(dom: HTMLElement | null | undefined)
=> void
目标居中0.2.0
zoom(value: number, animate = false, point?: { x: number; y: number } | null)
=> void
改变缩放大小(point默认为中心点)0.3.0

Directive

配置项

名称类型默认值必填说明版本
zoomSpeednumber0.1缩放速度0.0.3
zoomMaxnumber3最大缩放比例0.0.3
zoomMinnumber0.2最小缩放比例0.0.3
padding[number, number, number, number]0.2内边距(主要影响 fitSize 方法)0.0.3
onReady() => voidundefined初始化完成0.0.3
onTargetChange(
  info: {
    width: number,
    height: number,
    left: number,
    top: number,
    zoom: number
  },
  methods: {
    fitSize: (animate = false)
    => void,
    focus: (dom: HTMLElement | null | undefined, padding?: number)
    => void,
    center: (dom: HTMLElement | null | undefined)
    => void,
    zoom: (value: number, animate = false, point?: { x: number; y: number } | null)
    => void,
  }
)
=> void
undefined操作目标变化0.3.0
onBoardChange(
  info: {
    width: number,
    height: number,
    left: number,
    top: number
  },
  methods: {
    fitSize: (animate = false)
    => void,
    focus: (dom: HTMLElement | null | undefined, padding?: number)
    => void,
    center: (dom: HTMLElement | null | undefined)
    => void,
    zoom: (value: number, animate = false, point?: { x: number; y: number } | null)
    => void,
  }
)
=> void
undefined操作区域变化0.3.0