OrbCharts 文件
文件
返回首頁
Github
  • English
  • 繁體中文
文件
返回首頁
Github
  • English
  • 繁體中文
  • 指南
  • 基本概念

    • 6種資料格式
    • 核心技術
  • 快速開始 !

    • 安裝
    • 範例
  • 基礎使用

    • 建立圖表
    • 使用預設集(Preset)
    • 繪製圖表
    • 資料標籤
  • 圖表 API

    • plugins$
    • data$
    • chartParams$
    • dataFormatter$
    • event$
    • destroy()
  • Plugins

    • 建立 Plugin
    • Series

      • Bubbles
      • Pie
      • PieEventTexts
      • PieLabels
      • Rose
      • RoseLabels
      • SeriesLegend
      • SeriesTooltip
    • Grid

      • Bars
      • BarsPN
      • BarsTriangle
      • Dots
      • GridLegend
      • GridTooltip
      • GroupAux
      • GroupAxis
      • GroupZoom
      • Lines
      • LineAreas
      • StackedBars
      • StackedValueAxis
      • ValueAxis
    • MultiGrid

      • MultiBars
      • MultiBarsTriangle
      • MultiDots
      • MultiGridLegend
      • MultiGridTooltip
      • MultiGroupAxis
      • MultiStackedBars
      • MultiStackedValueAxis
      • MultiValueAxis
      • OverlappingValueAxes
      • OverlappingStackedValueAxes
    • MultiValue

      • MultiValueLegend
      • MultiValueTooltip
      • OrdinalAux
      • OrdinalAxis
      • OrdinalBubbles
      • OrdinalZoom
      • RacingBars
      • RacingCounterTexts
      • RacingValueAxis
      • Scatter
      • ScatterBubbles
      • XYAux
      • XYAxes
      • XYZoom
    • Relationship

      • ForceDirected
      • ForceDirectedBubbles
      • RelationshipLegend
      • RelationshipTooltip
    • Tree

      • TreeLegend
      • TreeMap
      • TreeTooltip

plugins$

API plugins$ 是繪製圖表的必要 API 之一,可以加入單個或多個(至少一個)Plugin 來繪製圖型。

OrbCharts 中的「Plugin」,指的就是一個用來繪製 SVG 圖形元素的物件,一個圖表會由一個或多個 Plugin 組合起來。6 種圖表物件可以使用的「Plugin」必須使用相同的資料格式,比如說 Pie 和 PieLabels 同屬於 Series,那他就不能在 GridChart 圖表類別建立的圖表物件中使用,只能使用在 SeriesChart 建立的圖表物件中使用。

TIP

可至 Playground 頁面透過選取取得所需要的圖表種類,從範例程式碼中取得所需要的 Plugins。

語法

建立資料的語法是 chart.plugins$.next([plugin])

範例:

chart.plugins$.next([new Pie(), new PieLabels()])

參數

Plugin[]

  • 型別:Array<PluginEntity<T extends ChartType, PluginName, PluginParams>>

  • 說明:陣列格式的「Plugin 物件」(可放多個 Plugin 物件)。