ScaleAdjust

Read as Markdown

Import ScaleAdjust from @pibbl/core/viz. Supply x with xScale, y with yScale, or both pairs. Continuous coordinates are numbers; point-scale coordinates are string or numeric categories. Both accept core signals. Unknown point categories throw RangeError; band scales are unsupported. Omitted axes translate by zero; a coordinate without its matching ID is invalid.

The component maps the supplied coordinates and returns an ordinary translated core Group. It does not allocate space, paint a mark, add hit geometry, or change signal semantics. Children can be normal core shapes, text, or custom components. This is the low-level extension point for scaled markers and other composition.

API details from source

ScaleAdjust

Adjusts descendant placement using configured x and y scales.

ScaleAdjust: (props: ScaleAdjustProps) => JSX.Element

Related API: ScaleAdjust, ScaleAdjustProps, JSX.

Parameters

• props — Scale identity and domain or range adjustments for descendants. See ScaleAdjustProps .

Returns

Child content evaluated with the adjusted scale.

See also

ScaleAdjustProps

View source — packages/core/src/features/viz/lib/scale-adjust.tsx:13

ScaleAdjustProps

Authored inputs for ScaleAdjust, including the declared data and presentation options.

type ScaleAdjustProps = ScaleAdjustX &
  ScaleAdjustY & {
    /** Descendant content or the callback that supplies it. See {@link PibblNode}. */
    readonly children?: PibblNode;
  }

Related API: ScaleAdjustProps, PibblNode.

See also

PibblNode

ScaleAdjust

View source — packages/core/src/features/viz/lib/types.ts:537

Properties and methods

x (optional)

readonly x?: SignalValue<BandCategory> | undefined

Related API: SignalValue, BandCategory.

Horizontal coordinate or displacement in the containing coordinate system. See SignalValue. Not accepted in this variant; use the alternative fields instead. See ScaleAdjustX.

View source — packages/core/src/features/viz/lib/types.ts:499

xScale (optional)

readonly xScale?: ScaleId | undefined

Related API: ScaleId.

The scale used to map horizontal data coordinates. See ScaleId. Not accepted in this variant; use the alternative fields instead. See ScaleAdjustX.

View source — packages/core/src/features/viz/lib/types.ts:501

y (optional)

readonly y?: SignalValue<BandCategory> | undefined

Related API: SignalValue, BandCategory.

Vertical coordinate or displacement in the containing coordinate system. See SignalValue. Not accepted in this variant; use the alternative fields instead. See ScaleAdjustY.

View source — packages/core/src/features/viz/lib/types.ts:521

yScale (optional)

readonly yScale?: ScaleId | undefined

Related API: ScaleId.

The scale used to map vertical data coordinates. See ScaleId. Not accepted in this variant; use the alternative fields instead. See ScaleAdjustY.

View source — packages/core/src/features/viz/lib/types.ts:523

children (optional)

readonly children?: PibblNode

Related API: PibblNode.

Descendant content or the callback that supplies it. See PibblNode.

View source — packages/core/src/features/viz/lib/types.ts:540

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

• Line series: Plot readings with a nullable gap and a scale-adjusted marker. Plain source

Documentation version

Documentation built with @pibbl/core 0.0.2, revision 2dccb19. ALPHA — NOT FOR PRODUCTION USE.