Interface SampleXY

Reference to a sample in XY data set. Always has X + Y values. Situationally, may also have extra properties for:

  • lookup value
  • color
  • id

The SampleXY interface is utilized by cursor result table formatters SeriesXYFormatterNew, solve nearest APIs as well as interaction events ('pointermove', etc.)

Hierarchy

Properties

color? lookupValue? rotation? sample size? x y

Properties

Optional Readonly color

color?: number

Color value of the visualized sample after data mapping.

For original data properties, refer to sample

NOTE: Uint32 encoded RGBA where Red is least significant byte. Can be translated to Color object with ColorUint32

Optional Readonly lookupValue

lookupValue?: number

Look-up value of the visualized sample after data mapping.

For original data properties, refer to sample

Optional Readonly rotation

rotation?: number

Rotation value of the visualized sample after data mapping.

For original data properties, refer to sample

NOTE: Unit = Degrees

Readonly sample

sample: Record<string, number>

All sample values from the originating data set.

When interpolation is used, this will be either sample A or B (it shouldn't really be used in this case)

Optional Readonly size

size?: number

Size value of the visualized sample after data mapping.

For original data properties, refer to sample

NOTE: Unit = Pixels

Readonly x

x: number

X value of the visualized sample after data mapping.

For original data properties, refer to sample

Readonly y

y: number

Y value of the visualized sample after data mapping.

For original data properties, refer to sample

Settings

Member Visibility

Theme