# Interface: BarElement<T, O>

# Type parameters

Name Type Default
T BarProps BarProps
O BarOptions BarOptions

# Hierarchy

# Properties

# active

Readonly active: boolean

Inherited from: void

Defined in: element.d.ts:6 (opens new window)


# options

Readonly options: O

Inherited from: void

Defined in: element.d.ts:7 (opens new window)


# x

Readonly x: number

Inherited from: void

Defined in: element.d.ts:4 (opens new window)


# y

Readonly y: number

Inherited from: void

Defined in: element.d.ts:5 (opens new window)

# Methods

# draw

draw(ctx: CanvasRenderingContext2D): void

# Parameters:

Name Type
ctx CanvasRenderingContext2D

Returns: void

Inherited from: VisualElement

Defined in: index.esm.d.ts:1571 (opens new window)


# getCenterPoint

getCenterPoint(useFinalPosition?: boolean): object

# Parameters:

Name Type
useFinalPosition? boolean

Returns: object

Name Type
x number
y number

Inherited from: VisualElement

Defined in: index.esm.d.ts:1575 (opens new window)


# getProps

getProps<P>(props: [P], final?: boolean): Pick<T, P>

# Type parameters:

Name Type
P string | number | symbol

# Parameters:

Name Type
props [P]
final? boolean

Returns: Pick<T, P>

Inherited from: void

Defined in: element.d.ts:11 (opens new window)

getProps<P, P2>(props: [P, P2], final?: boolean): Pick<T, P | P2>

# Type parameters:

Name Type
P string | number | symbol
P2 string | number | symbol

# Parameters:

Name Type
props [P, P2]
final? boolean

Returns: Pick<T, P | P2>

Inherited from: void

Defined in: element.d.ts:12 (opens new window)

getProps<P, P2, P3>(props: [P, P2, P3], final?: boolean): Pick<T, P | P2 | P3>

# Type parameters:

Name Type
P string | number | symbol
P2 string | number | symbol
P3 string | number | symbol

# Parameters:

Name Type
props [P, P2, P3]
final? boolean

Returns: Pick<T, P | P2 | P3>

Inherited from: void

Defined in: element.d.ts:13 (opens new window)

getProps<P, P2, P3, P4>(props: [P, P2, P3, P4], final?: boolean): Pick<T, P | P2 | P3 | P4>

# Type parameters:

Name Type
P string | number | symbol
P2 string | number | symbol
P3 string | number | symbol
P4 string | number | symbol

# Parameters:

Name Type
props [P, P2, P3, P4]
final? boolean

Returns: Pick<T, P | P2 | P3 | P4>

Inherited from: void

Defined in: element.d.ts:17 (opens new window)

getProps<P, P2, P3, P4, P5>(props: [P, P2, P3, P4, P5], final?: boolean): Pick<T, P | P2 | P3 | P4 | P5>

# Type parameters:

Name Type
P string | number | symbol
P2 string | number | symbol
P3 string | number | symbol
P4 string | number | symbol
P5 string | number | symbol

# Parameters:

Name Type
props [P, P2, P3, P4, P5]
final? boolean

Returns: Pick<T, P | P2 | P3 | P4 | P5>

Inherited from: void

Defined in: element.d.ts:21 (opens new window)

getProps(props: keyof T[], final?: boolean): T

# Parameters:

Name Type
props keyof T[]
final? boolean

Returns: T

Inherited from: void

Defined in: element.d.ts:25 (opens new window)


# getRange

OptionalgetRange(axis: x | y): number

# Parameters:

Name Type
axis x | y

Returns: number

Inherited from: VisualElement

Defined in: index.esm.d.ts:1576 (opens new window)


# hasValue

hasValue(): boolean

Returns: boolean

Inherited from: void

Defined in: element.d.ts:10 (opens new window)


# inRange

inRange(mouseX: number, mouseY: number, useFinalPosition?: boolean): boolean

# Parameters:

Name Type
mouseX number
mouseY number
useFinalPosition? boolean

Returns: boolean

Inherited from: VisualElement

Defined in: index.esm.d.ts:1572 (opens new window)


# inXRange

inXRange(mouseX: number, useFinalPosition?: boolean): boolean

# Parameters:

Name Type
mouseX number
useFinalPosition? boolean

Returns: boolean

Inherited from: VisualElement

Defined in: index.esm.d.ts:1573 (opens new window)


# inYRange

inYRange(mouseY: number, useFinalPosition?: boolean): boolean

# Parameters:

Name Type
mouseY number
useFinalPosition? boolean

Returns: boolean

Inherited from: VisualElement

Defined in: index.esm.d.ts:1574 (opens new window)


# tooltipPosition

tooltipPosition(useFinalPosition?: boolean): Point

# Parameters:

Name Type
useFinalPosition? boolean

Returns: Point

Inherited from: void

Defined in: element.d.ts:9 (opens new window)