# 類別: BasicPlatform

# 層級

# 建構函式

# 建構函式

new BasicPlatform()

# 繼承於

BasePlatform.建構函式

# 方法

# 取得內容

acquireContext(canvas, options?): CanvasRenderingContext2D

於圖表建立時間呼叫,傳回實作 [W3C Canvas 2D Context API 標準]https://www.w3.org/TR/2dcontext/ (opens new window) 的 context2d 實例。

# 參數

名稱 類型 說明
canvas HTMLCanvasElement 用於取得 context 的畫布(平台特定)
options? CanvasRenderingContext2DSettings 圖表選項

# 傳回

CanvasRenderingContext2D

# 繼承自

BasePlatform.acquireContext

# 定義於

types/index.d.ts:2147 (opens new window)


# addEventListener

addEventListener(chart, type, listener): void

在指定的圖表上註冊指定的監聽器。

# 參數

名稱 類型 說明
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 用於監聽事件的圖表
type 字串 要監聽的 (ChartEvent) 類型
listener (e: ChartEvent) => void 當指定的類型事件發生時,會收到一個通知(實作 ChartEvent 介面的物件)。

# 傳回

void

# 繼承自

BasePlatform.addEventListener

# 定義於

types/index.d.ts:2165 (開啟新視窗)


# getDevicePixelRatio

getDevicePixelRatio(): number

# 傳回

number

此平台所連線裝置目前的 devicePixelRatio。

# 繼承自

BasePlatform.getDevicePixelRatio

# 定義於

types/index.d.ts:2176 (開啟新視窗)


# getMaximumSize

getMaximumSize(canvas, width?, height?, aspectRatio?): Object

# 參數

名稱 類型 說明
canvas HTMLCanvasElement 用於計算最大尺寸的畫布
width? number 父元素的內容寬度
height? number 父元素的內容高度
aspectRatio? number 要維持的長寬比

# 傳回

Object

可用的最大尺寸。

名稱 類型
height number
width number

# 繼承自

BasePlatform.getMaximumSize

# 定義於

types/index.d.ts:2184 (開啟新視窗)


# isAttached

isAttached(canvas): boolean

# 參數

名稱 類型
canvas HTMLCanvasElement

# 傳回

boolean

如果畫布附加到平台,則為 true,否則為 false。

# 繼承自

BasePlatform.isAttached

# 定義於

types/index.d.ts:2189 (opens new window)


# releaseContext

releaseContext(context): boolean

在圖表銷毀時呼叫,釋放任何資源與先前由 acquireContext() 方法回傳的內容關聯。

# 參數

名稱 類型 說明
context CanvasRenderingContext2D context2d 執行個體

# 傳回

boolean

如果方法成功,傳回 true,否則傳回 false

# 繼承自

BasePlatform.releaseContext

# 定義於

types/index.d.ts:2157 (opens new window)


# removeEventListener

removeEventListener(chart, type, listener): void

移除先前透過 addEventListener 註冊的特定監聽器。

# 參數

名稱 類型 說明
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 要移除監聽器的圖表
type 字串 要移除的 (ChartEvent) 類型
listener (e: ChartEvent) => void 要從事件目標移除的監聽器函式。

# 傳回

void

# 繼承自

BasePlatform.removeEventListener

# 定義於

types/index.d.ts:2172 (opens new window)


# updateConfig

updateConfig(config): void

使用特定於平台的需求更新 config

# 參數

名稱 類型
config ChartConfiguration<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | ChartConfigurationCustomTypesPerDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# 傳回值

void

# 繼承自

BasePlatform.updateConfig

# 定義於

types/index.d.ts:2194 (開啟新視窗)