defineSeries
Import from @pibbl/core/viz. Describes a dataset without acquiring observers or resources.
data accepts a readonly array or signal; x, y, and optional defined describe eligibility without invoking renderers. No subscription or scan occurs when constructing a descriptor or query.
API details from source
Section titled “API details from source”
defineSeries
Section titled “defineSeries”Creates a data descriptor without observing or copying its dataset.
defineSeries: <D>(options: HoverSeries<D>) => HoverSeries<D>Related API: defineSeries, HoverSeries.
Parameters
Section titled “Parameters”options— Data, accessors, and scales describing a hoverable series. See HoverSeries .
Returns
Section titled “Returns”The series descriptor with its datum type preserved. See HoverSeries.
See also
Section titled “See also”View source — packages/core/src/features/viz/lib/hover-queries.ts:19
HoverSeries
Section titled “HoverSeries”Data and coordinate accessors describing one series available to hover queries.
interface HoverSeries<D>Related API: HoverSeries.
See also
Section titled “See also”View source — packages/core/src/features/viz/lib/hover-types.ts:59
Properties and methods
Section titled “Properties and methods”
data
readonly data: SignalValue<readonly D[]>Related API: SignalValue.
Application data supplied to the component or reported by the event. See SignalValue.
View source — packages/core/src/features/viz/lib/hover-types.ts:63
x
readonly x: PointAccessor<D>Related API: PointAccessor.
Property key or callback extracting the horizontal domain coordinate. See PointAccessor.
View source — packages/core/src/features/viz/lib/hover-types.ts:65
y
readonly y: PointAccessor<D>Related API: PointAccessor.
Property key or callback extracting the vertical domain coordinate. See PointAccessor.
View source — packages/core/src/features/viz/lib/hover-types.ts:67
defined (optional)
readonly defined?: ((datum: D, index: number, data: readonly D[]) => boolean) | undefinedReturns whether a datum contributes drawable or queryable coordinates. See HoverSeries .
Parameters
Section titled “Parameters”-
datum— Datum to test. -
index— Zero-based index in the source data. -
data— Complete source data array.
Returns
Section titled “Returns”Whether this datum should participate in the series or query.
View source — packages/core/src/features/viz/lib/hover-types.ts:76
HoverSeriesMap
Section titled “HoverSeriesMap”Named series participating in a multi-series hover query.
type HoverSeriesMap = Readonly<Record<string, HoverSeries<any>>>Related API: HoverSeriesMap, HoverSeries.
See also
Section titled “See also”View source — packages/core/src/features/viz/lib/hover-types.ts:131
Implementation guidance for agents
Section titled “Implementation guidance for agents”Read the Data visualization companion for ownership, adaptation, failure modes, and verification. Agent start provides the version-selection workflow.
Complete minimal examples
Section titled “Complete minimal examples”- Hover query helpers: Run closest-point, closest-x, and interpolated-x queries against a scale context. Plain source
Documentation version
Section titled “Documentation version”Documentation built with @pibbl/core 0.0.2, revision 2dccb19. ALPHA — NOT FOR PRODUCTION USE.