# 类: BasePlatform
# 继承关系
BasePlatform
# 构造函数
# constructor
• new BasePlatform()
# 方法
# acquireContext
▸ acquireContext(canvas
, options?
): CanvasRenderingContext2D
在图表构建时调用,返回一个实现了[W3C Canvas 2D Context API 标准]https://www.w3.org/TR/2dcontext/ (在新窗口中打开) 的二维上下文实例。
# 参数
名称 | 类型 | 描述 |
---|---|---|
canvas | HTMLCanvasElement | 获取上下文的画布 (平台特定) |
options? | CanvasRenderingContext2DSettings | 图表选项 |
# 返回值
CanvasRenderingContext2D
# 定义位置
types/index.d.ts:2147 (在新窗口中打开)
# 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
# 定义位置
types/index.d.ts:2165 (在新窗口中打开)
# getDevicePixelRatio
▸ getDevicePixelRatio(): number
# 返回值
number
此平台连接的设备的当前 devicePixelRatio。
# 定义位置
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 |
# 定义位置
types/index.d.ts:2184 (在新窗口中打开)
# isAttached
▸ isAttached(canvas
): boolean
# 参数
名称 | 类型 |
---|---|
canvas | HTMLCanvasElement |
# 返回值
boolean
如果画布附加到平台,则为 true,否则为 false。
# 定义位置
types/index.d.ts:2189 (在新窗口中打开)
# releaseContext
▸ releaseContext(context
): boolean
在图表销毁时调用,释放之前由 acquireContext() 方法返回的上下文相关联的任何资源。
# 参数
名称 | 类型 | 描述 |
---|---|---|
context | CanvasRenderingContext2D | 二维上下文实例 |
# 返回值
boolean
如果方法成功,则为 true,否则为 false
# 定义位置
types/index.d.ts:2157 (在新窗口中打开)
# 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
# 定义位置
types/index.d.ts:2172 (在新窗口中打开)
# updateConfig
▸ updateConfig(config
): void
使用平台特定要求更新配置
# 参数
名称 | 类型 |
---|---|
config | ChartConfiguration <keyof ChartTypeRegistry , (number | [number , number ] | Point | BubbleDataPoint )[], unknown > | ChartConfigurationCustomTypesPerDataset <keyof ChartTypeRegistry , (number | [number , number ] | Point | BubbleDataPoint )[], unknown > |
# 返回值
void