Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PointSeriesOptions3D<T>

Interface that can be used to specify readonly parameters when creating a PointSeries3D.

PointSeries3D is created with Chart3D.addPointSeries method.

Index

Properties

Optional individualLookupValuesEnabled

individualLookupValuesEnabled : undefined | false | true

Flag that can be used to enable data points value property on top of x, y and z. By default this is disabled.

This feature can be used to color data points individually by dynamic color look up.

If required, this must be enabled when the series is created.

 // Example, enable PointSeries3D data `value` property.
 const pointSeries3D = chart3D.addPointSeries({
     individualLookupValuesEnabled: true
 })

 // 'value' property can now be included in data points.
 pointSeries3D.add([
     { x: 0, y: 0, z: 0, value: 5 }
 ])

individualLookupValuesEnabled must be enabled in order to style PointSeries3D with PalettedFill of lookUpProperty: 'value'. See PointSeries3D.setPointStyle for more detailed information.

Performance side-effects from enabling:

  • With detailed point geometry (like 'sphere'), the geometry precision will be maximized, resulting in considerable increase in GPU processing time.

Optional individualPointColorEnabled

individualPointColorEnabled : undefined | false | true

Flag that can be used to enable data points color property on top of x, y and z. By default this is disabled.

This feature can be used to color data points individually by user supplied color.

If required, this must be enabled when the series is created.

 // Example, enable PointSeries3D data `color` property.
 const pointSeries3D = chart3D.addPointSeries({
     individualPointColorEnabled: true
 })

 // 'color' property can now be included in data points.
 pointSeries3D.add([
     { x: 0, y: 0, z: 0, color: ColorRGBA(255, 0, 0) }
 ])

individualPointColorEnabled must be enabled in order to style PointSeries3D with IndividualPointFill. See PointSeries3D.setPointStyle for more detailed information.

Performance side-effects from enabling:

  • Increases CPU scripting time very slightly.
  • Slightly increased GPU memory usage.

Optional individualPointSizeAxisEnabled

individualPointSizeAxisEnabled : undefined | false | true

Flag that can be used to enable data points 'sizeAxisX', 'sizeAxisY' and 'sizeAxisZ' properties on top of x, y and z. By default this is disabled.

This feature can be used to size data points individually as 3D Axis dimensions.

If required, this must be enabled when the series is created.

 // Example, enable PointSeries3D data point individual axis size properties.
 const pointSeries3D = chart3D.addPointSeries({
     individualPointSizeAxisEnabled: true
 })

 // 'sizeAxisX', 'sizeAxisY' and 'sizeAxisZ' properties can now be included in data points.
 pointSeries3D.add([
     { x: 0, y: 0, z: 0, sizeAxisX: 1, sizeAxisY: 10, sizeAxisZ: 5 }
 ])

NOTE: in order for points to be sized based on sizeAxisX, sizeAxisY and sizeAxisZ properties, the active point style must also have a fallback point size definition as axis dimensions:

 pointSeries3D.setPointStyle(new PointStyle3D.Triangulated({
     // IMPORTANT: fallback `size` must be defined with { x, y, z } syntax!
     size: { x: 1, y: 1, z: 1 },
     shape: 'sphere',
     fillStyle: new SolidFill({ color: ColorRGBA(255, 0, 0) })
 }))

Performance side-effects from enabling:

  • With detailed point geometry (like 'sphere'), the geometry precision will be maximized, resulting in considerable increase in GPU processing time.

Optional individualPointSizeEnabled

individualPointSizeEnabled : undefined | false | true

Flag that can be used to enable data points size property on top of x, y and z. By default this is disabled.

This feature can be used to size data points individually by user supplied values.

If required, this must be enabled when the series is created.

 // Example, enable PointSeries3D data `size` property.
 const pointSeries3D = chart3D.addPointSeries({
     individualPointSizeEnabled: true
 })

 // 'size' property can now be included in data points.
 pointSeries3D.add([
     { x: 0, y: 0, z: 0, size: 5 }
 ])

**Performance side-effects from enabling**:
- With detailed point geometry (like 'sphere'), the geometry precision will be maximized, resulting in considerable increase in GPU processing time.

Optional type

type : T

Defines the type of Point Series 3D.

See PointSeriesTypes3D for a collection of options.

 // Example syntax,
 const pointSeries3D = chart3D.addPointSeries({
     type: PointSeriesTypes3D.Triangulated
 })