# 类: DomPlatform
# 层次结构
-
↳
DomPlatform
# 构造函数
# constructor
• new DomPlatform()
# 继承自
# 方法
# acquireContext
▸ acquireContext(canvas
, options?
): CanvasRenderingContext2D
在图表构建时调用,返回一个实现 [W3C Canvas 2D Context API 标准]https://www.w3.org/TR/2dcontext/ (新窗口打开) 的 context2d 实例。
# 参数
名称 | 类型 | 描述 |
---|---|---|
canvas | HTMLCanvasElement | 获取上下文画布 (平台特定) |
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 | 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