Skip to content

Component | Crosshair: Make data and leftNearestDatumIndex optional #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Component | Crosshair: Make data and leftNearestDatumIndex optional #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/dev/src/examples/xy-components/crosshair/free-crosshair/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export const component = (props: ExampleViewerDurationProps): React.ReactNode =>

// Custom template function that shows interpolated values
// eslint-disable-next-line padded-blocks
const template = (d: XYDataRecord | undefined, xVal: number | Date, data: XYDataRecord[], leftNearestDatumIndex: number): string => {
const template = (d: XYDataRecord | undefined, xVal: number | Date, data?: XYDataRecord[], leftNearestDatumIndex?: number): string => {
// eslint-disable-next-line no-console
console.log('X Value:', (+xVal).toFixed(1), 'Left Index:', leftNearestDatumIndex)

Expand Down
6 changes: 3 additions & 3 deletions packages/ts/src/components/crosshair/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface CrosshairConfigInterface<Datum> extends WithOptional<XYComponen
/** Tooltip template accessor. The function is supposed to return either a valid HTML string or an HTMLElement.
* When `snapToData` is `false`, `datum` will be `undefined` but `data` and `leftNearestDatumIndex` will be provided.
* Default: `d => ''` */
template?: (datum: Datum, x: number | Date, data: Datum[], leftNearestDatumIndex: number) => string | HTMLElement;
template?: (datum: Datum, x: number | Date, data?: Datum[], leftNearestDatumIndex?: number) => string | HTMLElement;
/** Hide Crosshair when the corresponding datum element is far from mouse pointer. Default: `true` */
hideWhenFarFromPointer?: boolean;
/** Distance in pixels to check in the hideWhenFarFromPointer condition. Default: `100` */
Expand All @@ -46,7 +46,7 @@ export interface CrosshairConfigInterface<Datum> extends WithOptional<XYComponen
* It has to return an array of the `CrosshairCircle` objects: `{ y: number; color: string; opacity?: number }[]`.
* Default: `undefined`
*/
getCircles?: (x: number | Date, data: Datum[], yScale: ContinuousScale, leftNearestDatumIndex: number) => CrosshairCircle[];
getCircles?: (x: number | Date, data: Datum[], yScale: ContinuousScale, leftNearestDatumIndex?: number) => CrosshairCircle[];
/** Callback function that is called when the crosshair is moved:
* - `x` is the horizontal position of the crosshair in the data space;
* - `datum` is the nearest datum to the crosshair;
Expand All @@ -66,7 +66,7 @@ export const CrosshairDefaultConfig: CrosshairConfigInterface<unknown> = {
baseline: null,
duration: 100,
tooltip: undefined,
template: <Datum>(d: Datum, x: number | Date, data: Datum[], leftNearestDatumIndex: number): string => '',
template: <Datum>(d: Datum, x: number | Date, data?: Datum[], leftNearestDatumIndex?: number): string => '',
hideWhenFarFromPointer: true,
hideWhenFarFromPointerDistance: 100,
snapToData: true,
Expand Down
Loading