Class: BasePlatform

• new BasePlatform()

acquireContext

▸ acquireContext(canvas, options?): CanvasRenderingContext2D

Called at chart construction time, returns a context2d instance implementing the .

Parameters

Returns

CanvasRenderingContext2D

Defined in

addEventListener

▸ addEventListener(chart, type, listener): void

Registers the specified listener on the given chart.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	Chart from which to listen for event
`type`	`string`	The (ChartEvent) type to listen for
`listener`	(`e`: ) => `void`	Receives a notification (an object that implements the ChartEvent interface) when an event of the specified type occurs.

Returns

void

Defined in

Returns

the current devicePixelRatio of the device this platform is connected to.

Defined in

index.esm.d.ts:2022 (opens new window)

getMaximumSize

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

Parameters

Returns

Object

the maximum size available.

Name	Type
`height`	`number`
`width`	`number`

Defined in

isAttached

▸ isAttached(canvas): boolean

Parameters

Returns

true if the canvas is attached to the platform, false if not.

Defined in

index.esm.d.ts:2035 (opens new window)

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:2003 (opens new window)

removeEventListener

▸ removeEventListener(chart, type, listener): void

Removes the specified listener previously registered with addEventListener.

Parameters

Returns

void

Defined in

updateConfig

▸ updateConfig(config): void

Updates config with platform specific requirements

Parameters

Name	Type
`config`	ChartConfiguration<keyof , (`number` \| ScatterDataPoint \| )[], >

Returns

void