我的书签
添加书签
移除书签Class: BasePlatform
Hierarchy
BasePlatform
Constructors
constructor
• new BasePlatform()
Methods
acquireContext
▸ acquireContext(canvas, options?): CanvasRenderingContext2D
Called at chart construction time, returns a context2d instance implementing the W3C Canvas 2D Context API standard
(opens new window).
Parameters
| Name | Type | Description |
|---|---|---|
canvas | HTMLCanvasElement | The canvas from which to acquire context (platform specific) |
options? | CanvasRenderingContext2DSettings | The chart options |
Returns
CanvasRenderingContext2D
Defined in
index.esm.d.ts:2051 (opens new window)
addEventListener
▸ addEventListener(chart, type, listener): void
Registers the specified listener on the given chart.
Parameters
| Name | Type | Description |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown> | Chart from which to listen for event |
type | string | The (ChartEvent) type to listen for |
listener | (e: ChartEvent) => void | Receives a notification (an object that implements the ChartEvent interface) when an event of the specified type occurs. |
Returns
void
Defined in
index.esm.d.ts:2069 (opens new window)
getDevicePixelRatio
▸ getDevicePixelRatio(): number
Returns
number
the current devicePixelRatio of the device this platform is connected to.
Defined in
index.esm.d.ts:2080 (opens new window)
getMaximumSize
▸ getMaximumSize(canvas, width?, height?, aspectRatio?): Object
Parameters
| Name | Type | Description |
|---|---|---|
canvas | HTMLCanvasElement | The canvas for which to calculate the maximum size |
width? | number | - |
height? | number | - |
aspectRatio? | number | - |
Returns
Object
the maximum size available.
| Name | Type |
|---|---|
height | number |
width | number |
Defined in
index.esm.d.ts:2088 (opens new window)
isAttached
▸ isAttached(canvas): boolean
Parameters
| Name | Type |
|---|---|
canvas | HTMLCanvasElement |
Returns
boolean
true if the canvas is attached to the platform, false if not.
Defined in
index.esm.d.ts:2093 (opens new window)
releaseContext
▸ releaseContext(context): boolean
Called at chart destruction time, releases any resources associated to the context previously returned by the acquireContext() method.
Parameters
| Name | Type | Description |
|---|---|---|
context | CanvasRenderingContext2D | The context2d instance |
Returns
boolean
true if the method succeeded, else false
Defined in
index.esm.d.ts:2061 (opens new window)
removeEventListener
▸ removeEventListener(chart, type, listener): void
Removes the specified listener previously registered with addEventListener.
Parameters
| Name | Type | Description |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown> | Chart from which to remove the listener |
type | string | The (ChartEvent) type to remove |
listener | (e: ChartEvent) => void | The listener function to remove from the event target. |
Returns
void
Defined in
index.esm.d.ts:2076 (opens new window)
updateConfig
▸ updateConfig(config): void
Updates config with platform specific requirements
Parameters
| Name | Type |
|---|---|
config | ChartConfiguration<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown> | ChartConfigurationCustomTypesPerDataset<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown> |
Returns
void
