Interface: LineElement<T, O>

VisualElement

↳ LineElement

• Readonly active: boolean

Inherited from

Element.active

Defined in

options

• Readonly options: O

Inherited from

Element.options

Defined in

points

• points: []

Defined in

segments

• Readonly segments: []

Defined in

x

• Readonly x: number

Inherited from

Element.x

Defined in

y

• Readonly y: number

Inherited from

Element.y

Defined in

draw

▸ draw(ctx): void

Parameters

Name	Type
`ctx`	`CanvasRenderingContext2D`

Returns

void

Inherited from

VisualElement.

Defined in

▸ 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

.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

Inherited from

Element.getProps

Defined in

▸ 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

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

Type parameters

Parameters

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

Returns

Pick<T, P | P2 | P3>

Inherited from

Element.getProps

Defined in

▸ 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

▸ 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`]
	`boolean`

Returns

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

Inherited from

Element.getProps

Defined in

▸ 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

.getRange

Defined in

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

hasValue

▸ hasValue(): boolean

Returns

boolean

Inherited from

Element.hasValue

Defined in

inRange

Parameters

Returns

boolean

Inherited from

VisualElement.

Defined in

inXRange

▸ inXRange(mouseX, useFinalPosition?): boolean

Parameters

Name	Type
`mouseX`	`number`
`useFinalPosition?`	`boolean`

Returns

boolean

Inherited from

VisualElement.

Defined in

▸ inYRange(mouseY, useFinalPosition?): boolean

Parameters

Name	Type
`mouseY`	`number`
`useFinalPosition?`	`boolean`

Returns

boolean

Inherited from

.inYRange

Defined in

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

interpolate

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

Parameters

Name	Type
`point`
`property`	`“x”` \| `“y”`

Returns

| 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

pathSegment

▸ pathSegment(ctx, segment, params): boolean

Parameters

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

Returns

boolean

Defined in

tooltipPosition

▸ tooltipPosition(useFinalPosition?):

Parameters

Name	Type
`useFinalPosition?`	`boolean`

Returns

Point

Inherited from

Element.tooltipPosition

Defined in

updateControlPoints

▸ updateControlPoints(chartArea, indexAxis?): void

Parameters

Name	Type
`chartArea`	`ChartArea`
`indexAxis?`	`“x”` \|

Returns

void