記錄--Vue3 封裝 ECharts 通用組件

来源:https://www.cnblogs.com/smileZAZ/archive/2023/06/19/17491951.html
-Advertisement-
Play Games

這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 按需導入的配置文件 配置文件這裡就不再贅述,內容都是一樣的,主打一個隨用隨取,按需導入。 import * as echarts from "echarts/core"; // 引入用到的圖表 import { LineChart, ty ...


這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助

按需導入的配置文件

配置文件這裡就不再贅述,內容都是一樣的,主打一個隨用隨取,按需導入。

import * as echarts from "echarts/core";
// 引入用到的圖表
import { LineChart, type LineSeriesOption} from "echarts/charts";
// 引入提示框、數據集等組件
import {
  TitleComponent,
  TooltipComponent,
  GridComponent,
  LegendComponent,
  type TooltipComponentOption,
  type TitleComponentOption,
  type GridComponentOption,
  type LegendComponentOption
} from "echarts/components";
// 引入標簽自動佈局、全局過渡動畫等特性
import { LabelLayout } from "echarts/features";
// 引入 Canvas 渲染器,必須
import { CanvasRenderer } from "echarts/renderers";

import type { ComposeOption } from "echarts/core";

// 通過 ComposeOption 來組合出一個只有必須組件和圖表的 Option 類型
export type ECOption = ComposeOption<
  | LineSeriesOption
  | GridComponentOption
  | TitleComponentOption
  | TooltipComponentOption
  | LegendComponentOption
>;

// 註冊必須的組件
echarts.use([
  LineChart,
  TitleComponent,
  TooltipComponent,
  GridComponent,
  CanvasRenderer,
  LabelLayout,
  LegendComponent
]);

export default echarts;

基本封裝

DOM結構和實例化

<script setup lang="ts">
import { Ref, onMounted, onBeforeUnmount } from "vue";
import { type EChartsType } from "echarts/core";

interface Props {
  option: ECOption;
  theme?: Object | string; // 主題
}

const props = withDefaults(defineProps<Props>(), {
  theme: null
});

const chartRef = ref<Ref<HTMLDivElement>>(null);
const chartInstance = ref<EChartsType>();

// 繪製
const draw = () => {
  if (chartInstance.value) {
    chartInstance.value.setOption(props.option, { notMerge: true });
  }
};

// 初始化
const init = () => {
  if (!chartRef.value) return;

  // 校驗 Dom 節點上是否已經掛載了 ECharts 實例,只有未掛載時才初始化
  chartInstance.value = echarts.getInstanceByDom(chartRef.value);
  if (!chartInstance.value) {
    chartInstance.value = echarts.init(
        chartRef.value,
        props.theme,
        { renderer: "canvas" }
    );

    draw();
  }
};

watch(props, () => {
  draw();
});

onMounted(() => {
  init();
});

onBeforeUnmount(() => {
  // 容器被銷毀之後,銷毀實例,避免記憶體泄漏
  chartInstance.value?.dispose();
});
</script>

<template>
  <div id="echart" ref="chartRef" :style="{ width: '100px', height: '120px' }" />
</template>

chartRef:當前的 DOM 節點,即 ECharts 的容器;

chartInstance:當前 DOM 節點掛載的 ECharts 實例,可用於調用實例上的方法,註冊事件,自適應等;

draw:用於繪製 ECharts 圖表,本質是調用實例的 setOption 方法;

init:初始化,在此獲取 DOM 節點,掛載實例,註冊事件,並調用 draw 繪製圖表。

Cannot read properties of undefined (reading 'type')

請註意,上述代碼目前還不能正常運行,這裡會遇到第一個坑 —— 圖表無法顯示,這是 React 中沒有碰到的:

 出現這種問題是因為,我們使用 ref 接收了 echarts.init 的實例。這會導致 chartInstance 被代理成為響應式對象,影響了 ECharts 對內部屬性的訪問。Echarts 官方 FAQ 也闡述了該問題:

 

所以,我們有兩種解決方法:

  1. 使用 shallowRef 替換 ref
  2. 使用 ref + markRaw

shallowRef 和 ref() 不同之處在於,淺層 ref 的內部值將會原樣存儲和暴露,並且不會被深層遞歸地轉為響應式。只有對 .value 的訪問是響應式的。

markRaw 則會將一個對象標記為不可被轉為代理。返回該對象本身。在有些值不應該是響應式的場景中,例如複雜的第三方類實例或 Vue 組件對象,這很有用。

 我們這裡使用 markRaw 對 init 進行包裹:

chartInstance.value = markRaw(
  echarts.init(
      chartRef.value,
      props.theme,
      { renderer: "canvas" }
  )
);

視窗防抖自適應

這裡和 React 中就差不多了,主要安利一個 Vue 官方團隊維護的 hooks 庫:vueuse 。和 React 中的 ahooks 一樣,封裝了很多實用的 hooks,我們可以使用 useDebounceFn 來優化自適應函數:

import { useDebounceFn } from "@vueuse/core";

// 視窗自適應並開啟過渡動畫
const resize = () => {
  if (chartInstance.value) {
    chartInstance.value.resize({ animation: { duration: 300 } });
  }
};

// 自適應防抖優化
const debouncedResize = useDebounceFn(resize, 500, { maxWait: 800 });

onMounted(() => {
  window.addEventListener("resize", debouncedResize);
});

onBeforeUnmount(() => {
  window.removeEventListener("resize", debouncedResize);
});

額外監聽寬高

目前,圖標的大小還是寫死的,現在我們支持 props 傳遞寬高來自定義圖表大小:

interface Props {
  option: ECOption;
  theme?: Object | string;
  width: string;
  height: string;
}

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

請註意:在使用時,我們必須指定容器的寬高,否則無法顯示,因為圖表在繪製時會自動獲取父容器的寬高。

flex/grid 佈局下 resize 失效的問題

這個問題剛遇到著實有點蛋疼,摸了蠻久,而 bug 觸發的條件也比較奇葩,但也比較常見:

  1. 在父組件中,復用多個 ECharts 組件;
  2. 使用了 flex 或 grid 這種沒有明確給定寬高的佈局;

此時會發現:當前視窗放大,正常觸發 resize, 圖表會隨之放大。但是,此時再縮小視窗,雖然也會觸發 resize,但是圖表的大小卻縮不回來了......

一開始還以為是我封裝的寫法有問題,直到搜到了ECharts 官方的 issues 才發現原來不止我一個遇到了

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 大家好,我是 god23bin。歡迎來到《一分鐘學一個 Linux 命令》系列,每天只需一分鐘,記住一個 Linux 命令不成問題。今天要說的是 ps 命令。 ...
  • MVCC併發版本控制 本文大部分來自《MySQL是怎樣運行的》,這裡只是簡單總結,用於各位回憶和複習。 版本鏈 對於使用 InnoDB 存儲引擎的表來說,它的聚簇索引記錄中都包含兩個必要的隱藏列(不知道的快去看《MySQL是怎樣運行的》) trx_id :每次一個事務對某條聚簇索引記錄進行改動時,都 ...
  • Linux安裝MongoDB 4.0.3 1.準備 CentOS下安裝MongoDB 官網提供windows、Linux、OSX系統環境下的安裝包,這裡主要是記錄一下在Linux下的安裝。首先到官網下載安裝包。文中安裝的是4.0.3版本的。 官網地址:https://www.mongodb.com/ ...
  • 近日,華為全球智慧金融峰會2023在上海順利舉行,華為雲副總裁、戰略與產業發展部總裁黃瑾發表了《做強堅實數據底座,GaussDB與產業攜手共進》的主題演講。 以下為演講實錄: 尊敬的各位來賓,大家下午好!非常高興和大家探討關於做堅實數據底座,GaussDB與產業攜手共進的一些思考。 中國資料庫市場發 ...
  • #報錯信息: ``` ****: 第4 行附近出現錯誤: 不是 GROUP BY 表達式 ``` #修改辦法: ######達夢可以配置相容參數,COMPATIBLE_MODE=4,靜態參數,需要重啟資料庫後生效! ``` sp_set_para_value(2,'COMPATIBLE_MODE', ...
  • 本文主要測試驗證 Elasticsearch 各版本快照在 [Easysearch](https://www.infinilabs.com/docs/latest/easysearch/overview) 中進行數據恢復。 ## 準備測試數據 ### 索引 ![](https://www.infin ...
  • # 一、Android程式員需要具備的素養 1. 應該熱愛學習Android知識 2. 具備基本的自學能力和解決問題的能力 3. 具備實踐能力 # 二、Android程式員最終需要熟練掌握的語言 1. Java(基本) 2. C/C++(進階) 3. Kotlin(基本) 4. Python(可選) ...
  • Airtest是一個跨平臺的、基於圖像識別的UI自動化測試框架,適用於游戲和App,支持平臺有Windows、Android和iOS。Airtest框架基於一種圖形腳本語言Sikuli,引用該框架後,不再需要一行行的寫代碼,通過截取按鈕或輸入框的圖片,用圖片組成測試場景,這種方式學習成本低,簡單易上... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...