Vue3 & TypeScript 组件:echart(resize、debounce)

resize使用了ResizeObserver https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver/ResizeObserver

echart的resize功能需要监听的不是window,所以window.onresize消耗太大关键有时甚至起不到作用。我们需要找到一个可以监听单个儿元素的方法。ResizeObserver就是这么个东西。监听时observer,走前用下unobserve。

debounce就是一个非常朴素的防抖:设置一个定时器,下次方法执行前先将定时器清除,再开始新一轮计时。
图就不放了,只是个非常朴素的柱状图,主要是为了练习Vue3的组件传值、封装有debounce的resize。

代码:

封装的俩函数 👇
/**
 * 防抖
 * @param fn 
 * @param time 
 */
type ArgsType = Element | ResizeObserver;
export const debounce = (fn: (...args: ArgsType[]) => void, delay = 200) => {
    let timer = 0;

    return (...args: ArgsType[]) => {
        if(timer) {
            clearTimeout(timer);
            timer = 0
        }

        timer = window.setTimeout(() => {
            fn(...args)
        }, delay)
    }
}
/**
 * 监听DOMresize:需要传入一个Element,和一个resize时的callback。使用时,需要在页面销毁前resizeObserver.unobserve()
 * @param el 
 */
export const domResize = (el: Element, callback: (...args: ArgsType[]) => void) => {

    const debounceCallback: (...args: ArgsType[]) => void = debounce(callback);

    const resizeObserver = new ResizeObserver((entries: ResizeObserverEntry[]) => {
        const dom = entries[0].target;
        debounceCallback(dom, resizeObserver)
    });

    // 监听元素
    resizeObserver.observe(el);
};

组件代码:



<script setup lang="ts">
import {ComponentInternalInstance} from 'vue'
import { getKey } from '@/utils/ancode'
import { init, registerTheme, EChartsOption } from 'echarts'
import {domResize} from '@/utils/utils'
import westeros from './westeros.json'

// #region ---- 组件传值

const props = defineProps({
    width: {
        type: String,
        default: '100%'
    },
    height: {
        type: String,
        default: '100%'
    },
    title: {
        type: Object,
        default: () => {
            return {
                text: ''
            }
        }
    },
    tooltip: {},
    xAxis: {},
    series: {}
})

const emit = defineEmits(['resize']);

// #endregion

// #region ---- DOM

const { proxy } = getCurrentInstance() as ComponentInternalInstance;
// ref随机名儿
const refEchart: Ref<string> = ref("");
// chart容器的DOM
const echartEl = ref();
// chart实例
const chartInstance = shallowRef(); // 页面注销时echart需要dispose
// resizeObserver实例
const resizeObserverObj = shallowRef(); // 页面注销时,监听元素的方法需要传值回去unobserve

const initRef = () => {
    // 给ref获取随机名字
    refEchart.value = getKey();

    nextTick(() => {
        // 获取echart元素
        echartEl.value = proxy?.$refs[refEchart.value];
    })
}

// #endregion


// 画图
const drawEchart = () => {
    // 注册更新的主题
    registerTheme('westeros', westeros);

    nextTick(() => {
        chartInstance.value = init(echartEl.value, 'westeros');
        // 绘制图表
        chartInstance.value.setOption({
            title: {
                text: props.title.text
            },
            tooltip: props.tooltip,
            xAxis: props.xAxis,
            yAxis: {},
            series: props.series
        } as EChartsOption);

        // 这个方法原本想着将动作传递出去,可以在页面中设置图表的宽高比。一旦容器宽高发生变化,我们就在页面中按照宽高比进行设置。可是这个有绕。所以呈现在页面中有卡顿情况。暂时先留着,但没用
        domResize(echartEl.value, (dom, resizeObserver) => {
            emit('resize', dom);
            chartInstance.value.resize();
            resizeObserverObj.value = resizeObserver;
        })
    })
}

onMounted(() => {
    initRef();
    drawEchart();
})

onBeforeUnmount(() => {
    // 这俩顺序不能乱,必须先将监听卸载,才能销毁echart实例
    resizeObserverObj.value.unobserve(echartEl.value);
    chartInstance.value?.dispose();
})
</script>

<template>
    <div :ref="refEchart" :style="{ width: props.width, height: props.height }"></div>
</template>

使用页面代码:



<script setup lang="ts">
import {ComponentInternalInstance} from 'vue'
import { getKey } from '@/utils/ancode'
import { init, registerTheme, EChartsOption } from 'echarts'
import {domResize} from '@/utils/utils'
import westeros from './westeros.json'

// #region ---- 组件传值

const props = defineProps({
    width: {
        type: String,
        default: '100%'
    },
    height: {
        type: String,
        default: '100%'
    },
    title: {
        type: Object,
        default: () => {
            return {
                text: ''
            }
        }
    },
    tooltip: {},
    xAxis: {},
    series: {}
})

const emit = defineEmits(['resize']);

// #endregion

// #region ---- DOM

const { proxy } = getCurrentInstance() as ComponentInternalInstance;
// ref随机名儿
const refEchart: Ref<string> = ref("");
// chart容器的DOM
const echartEl = ref();
// chart实例
const chartInstance = shallowRef(); // 页面注销时echart需要dispose
// resizeObserver实例
const resizeObserverObj = shallowRef(); // 页面注销时,监听元素的方法需要传值回去unobserve

const initRef = () => {
    // 给ref获取随机名字
    refEchart.value = getKey();

    nextTick(() => {
        // 获取echart元素
        echartEl.value = proxy?.$refs[refEchart.value];
    })
}

// #endregion


// 画图
const drawEchart = () => {
    // 注册更新的主题
    registerTheme('westeros', westeros);

    nextTick(() => {
        chartInstance.value = init(echartEl.value, 'westeros');
        // 绘制图表
        chartInstance.value.setOption({
            title: {
                text: props.title.text
            },
            tooltip: props.tooltip,
            xAxis: props.xAxis,
            yAxis: {},
            series: props.series
        } as EChartsOption);

        // 这个方法原本想着将动作传递出去,可以在页面中设置图表的宽高比。一旦容器宽高发生变化,我们就在页面中按照宽高比进行设置。可是这个有绕。所以呈现在页面中有卡顿情况。暂时先留着,但没用
        domResize(echartEl.value, (dom, resizeObserver) => {
            emit('resize', dom);
            chartInstance.value.resize();
            resizeObserverObj.value = resizeObserver;
        })
    })
}

onMounted(() => {
    initRef();
    drawEchart();
})

onBeforeUnmount(() => {
    // 这俩顺序不能乱,必须先将监听卸载,才能销毁echart实例
    resizeObserverObj.value.unobserve(echartEl.value);
    chartInstance.value?.dispose();
})
</script>

<template>
    <div :ref="refEchart" :style="{ width: props.width, height: props.height }"></div>
</template>

~tada一个具有防抖还可以resize的图表组件就完成啦

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容