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

These extra properties are only present if the user has configured the DataSetXY to include them, using DataSetXYOptions and has supplied those properties when pushing data in.

The ID property can be used to identify any sample to any external, extra data that may need to be used in cursor formatting or custom logic. Note that the ID values should be supplied by user, they are not assigned automatically in any way.

The SampleXY interface is utilized by cursor result table formatters SeriesXYFormatterNew

Hierarchy

Properties

color? id? lookupValue? rotation? size? x y

Properties

Optional Readonly color

color?: number

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

Optional Readonly id

id?: number

NOTE: Uint32

Optional Readonly lookupValue

lookupValue?: number

NOTE: Float32

Optional Readonly rotation

rotation?: number

NOTE: Unit = Degrees

Optional Readonly size

size?: number

NOTE: Unit = Pixels

Readonly x

x: number

Readonly y

y: number

Settings

Member Visibility

Theme