Class BarChart

BarChart widget.

Hierarchy

  • BaseSimpleChart
    • BarChart

Constructors

constructor

Properties

animationInstances barPercentage barSets categoryPercentage centerX centerY children data display eventInstances fillPaint hasSet isImplemented key last layout parent plugins progress registeredEvents setups status strokePaint style updates x y

Accessors

range singleRange

Methods

_isAsyncWidget add animate calculateIn calculateRange coordinateChildToParent coordinateParentToChild copy draw emitEvent hide init isIn kill on predraw preupdate processSetups registerEvent resurrect runAnimation setEventListener setUpdate setup show update use absoluteToRelative getAbsoluteCoordinates

Constructors

constructor

Properties

animationInstances

animationInstances: AnimationInstance<Widget>[] = []

barPercentage

barPercentage: number

The percentage of the bar width in the category width.

Default

0.8

barSets

barSets: Rect[][]

The bar sets of the BarChart.

categoryPercentage

categoryPercentage: number

The percentage of the category width in the grid width.

Default

0.8

centerX

centerX: number

centerY

centerY: number

children

children: Widget[] = []

The child-widgets of the widget.

data

data: BarChartData

The data of the BarChart.

display

display: boolean = true

eventInstances

eventInstances: EventInstance<Widget>[] = []

fillPaint

fillPaint: Paint

hasSet

hasSet: boolean = false

isImplemented

isImplemented: boolean = false

key

key: string = ...

last

last: Widget = ...

layout

layout: ChartLayout

Layout object for the chart.

parent

parent: Widget

plugins

plugins: WidgetPlugin[] = []

progress

progress: number

registeredEvents

registeredEvents: Map<string, Event<Widget>> = ...

setups

setups: {
    generator: Generator<number | {
        animation: Animation<any>;
        duration: number;
        mode: "async" | "sync";
        params: Record<string, any>;
        setAsync: (() => { animation: Animation<any>; mode: "async" | "sync"; duration: number; params: Record<string, any>; setAsync: () => ...; setSync: () => ...; });
        setSync: (() => { animation: Animation<any>; mode: "async" | "sync"; duration: number; params: Record<string, any>; setAsync: () => ...; setSync: () => ...; });
    }, void, unknown>;
    nextFrame: number;
}[] = []

Type declaration

  • generator: Generator<number | {
        animation: Animation<any>;
        duration: number;
        mode: "async" | "sync";
        params: Record<string, any>;
        setAsync: (() => { animation: Animation<any>; mode: "async" | "sync"; duration: number; params: Record<string, any>; setAsync: () => ...; setSync: () => ...; });
        setSync: (() => { animation: Animation<any>; mode: "async" | "sync"; duration: number; params: Record<string, any>; setAsync: () => ...; setSync: () => ...; });
    }, void, unknown>
  • nextFrame: number

status

status: Status = 'unborn'

strokePaint

strokePaint: Paint

style

style: BarChartStyle

The style of the BarChart.

updates

updates: (<T>(elapsed, widget) => void)[] = []

Type declaration

    • <T>(elapsed, widget): void

    • Type Parameters

      Parameters

      • elapsed: number
      • widget: T

      Returns void

x

x: number

y

y: number

Accessors

range

  • get range(): WidgetRange

  • The range of the widget, taking into account the children, based on the parent coordinate. To be noted that this method should not be overridden.

    Returns WidgetRange

    The range of the widget.

singleRange

  • get singleRange(): WidgetRange

  • The range of the widget, taking into account the children, based on the parent coordinate. To be noted that this method should not be overridden.

    Returns WidgetRange

    The range of the widget.

Methods

_isAsyncWidget

add

  • add(...children): this

  • Add children widgets for the widget.

    Parameters

    • Rest ...children: Widget[] | ((parent) => Widget)[]

      The added children.

    Returns this

animate

  • animate(animation, startAt, duration, params?): this

  • Parameters

    • animation: Animation<any>
    • startAt: number
    • duration: number
    • Optional params: Record<string, any>

    Returns this

calculateIn

  • calculateIn(_x, _y): boolean

  • Calculate the range of the widget, based on the self-coordinate. To be noted that this method should be overridden.

    Parameters

    • _x: number
    • _y: number

    Returns boolean

calculateRange

  • calculateRange(): WidgetRange

  • Calculate the range of the widget, based on the self-coordinate. To be noted that this method should be overridden.

    Returns WidgetRange

    The range of the widget.

coordinateChildToParent

  • coordinateChildToParent(x, y): {
        x: number;
        y: number;
    }

  • Parameters

    • x: number
    • y: number

    Returns {
        x: number;
        y: number;
    }

    • x: number
    • y: number

coordinateParentToChild

  • coordinateParentToChild(x, y): {
        x: number;
        y: number;
    }

  • Parameters

    • x: number
    • y: number

    Returns {
        x: number;
        y: number;
    }

    • x: number
    • y: number

copy

draw

emitEvent

  • emitEvent(name, ...args): this

  • Parameters

    • name: string
    • Rest ...args: any[]

    Returns this

hide

init

isIn

  • isIn(x, y): boolean

  • Determine whether the point is in the widget, based on the parent coordinate. To be noted that this method should not be overridden.

    Parameters

    • x: number
    • y: number

    Returns boolean

kill

on

  • on(event, effect): this

  • Parameters

    • event: string | Event<Widget>
    • effect: ((widget, ...args) => any)
        • (widget, ...args): any

        • Parameters

          • widget: Widget
          • Rest ...args: any[]

          Returns any

    Returns this

predraw

preupdate

  • preupdate(ck, propertyChanged?): void

  • Called when the parameters are changed.

    Parameters

    • ck: CanvasKit

      The namespace of CanvasKit-WASM.

    • Optional propertyChanged: string

    Returns void

processSetups

registerEvent

resurrect

runAnimation

  • runAnimation(elapsed, ck): void

  • Parameters

    • elapsed: number
    • ck: CanvasKit

    Returns void

setEventListener

  • setEventListener(element): void

  • Parameters

    • element: HTMLCanvasElement

    Returns void

setUpdate

  • setUpdate(updateFunc): this

  • Set up an update function to call it when the widget is changed.

    Parameters

    • updateFunc: (<T>(elapsed, widget) => void)

      The frame from having gone to current frame.

        • <T>(elapsed, widget): void

        • Type Parameters

          Parameters

          • elapsed: number
          • widget: T

          Returns void

    Returns this

setup

show

update

  • update(canvas): void

  • Update the object according to the style of the widget. Called when the style is changed.

    Parameters

    • canvas: Canvas

      The canvas object of CanvasKit-WASM.

    Returns void

use

Static absoluteToRelative

  • absoluteToRelative(widget, x, y): {
        x: number;
        y: number;
    }

  • Parameters

    • widget: Widget
    • x: number
    • y: number

    Returns {
        x: number;
        y: number;
    }

    • x: number
    • y: number

Static getAbsoluteCoordinates

  • getAbsoluteCoordinates(widget): {
        x: number;
        y: number;
    }

  • Parameters

    Returns {
        x: number;
        y: number;
    }

    • x: number
    • y: number

Settings

Member Visibility

Theme

On This Page

constructoranimationInstancesbarPercentagebarSetscategoryPercentagecenterXcenterYchildrendatadisplayeventInstancesfillPainthasSetisImplementedkeylastlayoutparentpluginsprogressregisteredEventssetupsstatusstrokePaintstyleupdatesxyrangesingleRange_isAsyncWidgetaddanimatecalculateIncalculateRangecoordinateChildToParentcoordinateParentToChildcopydrawemitEventhideinitisInkillonpredrawpreupdateprocessSetupsregisterEventresurrectrunAnimationsetEventListenersetUpdatesetupshowupdateuseabsoluteToRelativegetAbsoluteCoordinates