# 類別:DomPlatform
# 繼承關係
-
↳
DomPlatform
# 建構子
# 建構子
• new DomPlatform()
# 繼承自
# 方法
# acquireContext
▸ acquireContext(canvas
, options?
): CanvasRenderingContext2D
在圖表建構時呼叫,返回一個實作 [W3C Canvas 2D Context API 標準] https://www.w3.org/TR/2dcontext/ (開啟新視窗) 的 context2d 實例。
# 參數
名稱 | 類型 | 描述 |
---|---|---|
canvas | HTMLCanvasElement | 從中取得 context 的畫布 (平台特定) |
options? | CanvasRenderingContext2DSettings | 圖表選項 |
# 返回
CanvasRenderingContext2D
# 繼承自
# 定義於
# addEventListener
▸ addEventListener(chart
, type
, listener
): void
在給定的圖表上註冊指定的監聽器。
# 參數
名稱 | 類型 | 描述 |
---|---|---|
chart | Chart <keyof ChartTypeRegistry , (number | [number , number ] | Point | BubbleDataPoint )[], unknown > | 從哪個圖表監聽事件 |
type | string | 要監聽的 (ChartEvent) 類型 |
listener | (e : ChartEvent ) => void | 當指定類型的事件發生時,接收通知 (一個實作 ChartEvent 介面的物件)。 |
# 返回
void
# 繼承自
# 定義於
# getDevicePixelRatio
▸ getDevicePixelRatio(): number
# 返回
number
此平台連接的裝置的目前 devicePixelRatio。
# 繼承自
BasePlatform.getDevicePixelRatio
# 定義於
# getMaximumSize
▸ getMaximumSize(canvas
, width?
, height?
, aspectRatio?
): Object
# 參數
名稱 | 類型 | 描述 |
---|---|---|
canvas | HTMLCanvasElement | 要計算最大尺寸的畫布 |
width? | number | 父元素內容寬度 |
height? | number | 父元素內容高度 |
aspectRatio? | number | 要保持的縱橫比 |
# 返回
Object
可用的最大尺寸。
名稱 | 類型 |
---|---|
height | number |
width | number |
# 繼承自
# 定義於
# isAttached
▸ isAttached(canvas
): boolean
# 參數
名稱 | 類型 |
---|---|
canvas | HTMLCanvasElement |
# 返回
boolean
如果畫布已附加到平台,則為 true,否則為 false。
# 繼承自
# 定義於
# releaseContext
▸ releaseContext(context
): boolean
在圖表銷毀時呼叫,釋放先前由 acquireContext() 方法返回的 context 所關聯的任何資源。
# 參數
名稱 | 類型 | 描述 |
---|---|---|
context | CanvasRenderingContext2D | context2d 實例 |
# 返回
boolean
如果方法成功,則為 true,否則為 false
# 繼承自
# 定義於
# removeEventListener
▸ removeEventListener(chart
, type
, listener
): void
移除先前使用 addEventListener 註冊的指定監聽器。
# 參數
名稱 | 類型 | 描述 |
---|---|---|
chart | Chart <keyof ChartTypeRegistry , (number | [number , number ] | Point | BubbleDataPoint )[], unknown > | 從哪個圖表移除監聽器 |
type | string | 要移除的 (ChartEvent) 類型 |
listener | (e : ChartEvent ) => void | 要從事件目標移除的監聽器函式。 |
# 返回
void
# 繼承自
BasePlatform.removeEventListener
# 定義於
# updateConfig
▸ updateConfig(config
): void
使用平台特定的需求更新配置
# 參數
名稱 | 類型 |
---|---|
config | ChartConfiguration <keyof ChartTypeRegistry , (number | [number , number ] | Point | BubbleDataPoint )[], unknown > | ChartConfigurationCustomTypesPerDataset <keyof ChartTypeRegistry , (number | [number , number ] | Point | BubbleDataPoint )[], unknown > |
# 返回值
void