# Interface: LineElement<T, O>

# Type parameters

Name Type
T extends LinePropsLineProps
O extends LineOptionsLineOptions

# Hierarchy

# Properties

# active

Readonly active: boolean

# Inherited from

Element.active

# Defined in

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


# options

Readonly options: O

# Inherited from

Element.options

# Defined in

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


# points

points: Point[]

# Defined in

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


# segments

Readonly segments: Segment[]

# Defined in

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


# x

Readonly x: number

# Inherited from

Element.x

# Defined in

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


# y

Readonly y: number

# Inherited from

Element.y

# Defined in

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

# Methods

# draw

draw(ctx): void

# Parameters

Name Type
ctx CanvasRenderingContext2D

# Returns

void

# Inherited from

VisualElement.draw

# Defined in

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


# first

first(): false | Point

# Returns

false | Point

# Defined in

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


# getCenterPoint

getCenterPoint(useFinalPosition?): Object

# Parameters

Name Type
useFinalPosition? boolean

# Returns

Object

Name Type
x number
y number

# Inherited from

VisualElement.getCenterPoint

# Defined in

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


# getProps

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

# Type parameters

Name Type
P extends string | number | symbol

# Parameters

Name Type
props [P]
final? boolean

# Returns

Pick<T, P>

# Inherited from

Element.getProps

# Defined in

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

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

# Type parameters

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

# Parameters

Name Type
props [P, P2]
final? boolean

# Returns

Pick<T, P | P2>

# Inherited from

Element.getProps

# Defined in

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

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

# Type parameters

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

# Parameters

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

# Returns

Pick<T, P | P2 | P3>

# Inherited from

Element.getProps

# Defined in

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

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

# Type parameters

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

# Parameters

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

# Returns

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

# Inherited from

Element.getProps

# Defined in

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

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

# Type parameters

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

# Parameters

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

# Returns

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

# Inherited from

Element.getProps

# Defined in

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

getProps(props, final?): T

# Parameters

Name Type
props keyof T[]
final? boolean

# Returns

T

# Inherited from

Element.getProps

# Defined in

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


# getRange

Optional getRange(axis): number

# Parameters

Name Type
axis "x" | "y"

# Returns

number

# Inherited from

VisualElement.getRange

# Defined in

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


# hasValue

hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

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


# inRange

inRange(mouseX, mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inRange

# Defined in

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


# inXRange

inXRange(mouseX, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inXRange

# Defined in

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


# inYRange

inYRange(mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inYRange

# Defined in

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


# interpolate

interpolate(point, property): Point | Point[]

# Parameters

Name Type
point Point
property "x" | "y"

# Returns

Point | Point[]

# Defined in

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


# last

last(): false | Point

# Returns

false | Point

# Defined in

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


# path

path(ctx): boolean

# Parameters

Name Type
ctx CanvasRenderingContext2D

# Returns

boolean

# Defined in

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


# pathSegment

pathSegment(ctx, segment, params): boolean

# Parameters

Name Type
ctx CanvasRenderingContext2D
segment Segment
params Record<string, unknown>

# Returns

boolean

# Defined in

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


# tooltipPosition

tooltipPosition(useFinalPosition?): Point

# Parameters

Name Type
useFinalPosition? boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

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


# updateControlPoints

updateControlPoints(chartArea, indexAxis?): void

# Parameters

Name Type
chartArea ChartArea
indexAxis? "x" | "y"

# Returns

void

# Defined in

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