Class: BasePlatform

Hierarchy

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 standardBasePlatform - 图1 (opens new window).

Parameters

NameTypeDescription
canvasHTMLCanvasElementThe canvas from which to acquire context (platform specific)
options?CanvasRenderingContext2DSettingsThe chart options

Returns

CanvasRenderingContext2D

Defined in

index.esm.d.ts:2051BasePlatform - 图2 (opens new window)


addEventListener

addEventListener(chart, type, listener): void

Registers the specified listener on the given chart.

Parameters

NameTypeDescription
chartChart<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>Chart from which to listen for event
typestringThe (ChartEvent) type to listen for
listener(e: ChartEvent) => voidReceives 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:2069BasePlatform - 图3 (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:2080BasePlatform - 图4 (opens new window)


getMaximumSize

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

Parameters

NameTypeDescription
canvasHTMLCanvasElementThe canvas for which to calculate the maximum size
width?number-
height?number-
aspectRatio?number-

Returns

Object

the maximum size available.

NameType
heightnumber
widthnumber

Defined in

index.esm.d.ts:2088BasePlatform - 图5 (opens new window)


isAttached

isAttached(canvas): boolean

Parameters

NameType
canvasHTMLCanvasElement

Returns

boolean

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

Defined in

index.esm.d.ts:2093BasePlatform - 图6 (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

NameTypeDescription
contextCanvasRenderingContext2DThe context2d instance

Returns

boolean

true if the method succeeded, else false

Defined in

index.esm.d.ts:2061BasePlatform - 图7 (opens new window)


removeEventListener

removeEventListener(chart, type, listener): void

Removes the specified listener previously registered with addEventListener.

Parameters

NameTypeDescription
chartChart<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>Chart from which to remove the listener
typestringThe (ChartEvent) type to remove
listener(e: ChartEvent) => voidThe listener function to remove from the event target.

Returns

void

Defined in

index.esm.d.ts:2076BasePlatform - 图8 (opens new window)


updateConfig

updateConfig(config): void

Updates config with platform specific requirements

Parameters

NameType
configChartConfiguration<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown> | ChartConfigurationCustomTypesPerDataset<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>

Returns

void

Defined in

index.esm.d.ts:2098BasePlatform - 图9 (opens new window)