visualization-tools

Home > @visualization-tools/cartesian-2d

cartesian-2d package

Classes

Class Description
ACartesian2dUserTransform Provides a user transform that assumes maxes and mins will remain extrema.
CanvasCartesian2dAxisLabelGraphicsComponent Draws labels for cartesian 2d plots.
CanvasCartesian2dPlotFactory Provides TCanvasCartesianPlot for canvas charts.
CanvasCartesian2dTraceGraphicsComponent Draws traces for cartesian 2d plots.
CanvasCartesian2dUpdateArgProvider Canvas implementation of ICartesian2dUpdateArgProvider, inverts the Y direction as canvas expects the origin to be in the top left corner.
CanvasCartesianUpdateHooks Canvas update hook, called before and after a plot is drawn.
CanvasLineGraphicsComponent Draws lines with or without segments of different colors and sizes.
Cartesian2dAxisLabelConfig Provides dirty checking for generating axis config from axis options.
Cartesian2dAxisLabelGenerator Generates sprites for axis labels.
Cartesian2dFloatPrecisionRangeBounder Constrains the data range so that the mapping into screen space is not worse than per pixel because of float precision.
Cartesian2dIdentityTransform Apply no transform.
Cartesian2dInteractionHandler Default interaction handler for cartesian 2d. Allows panning, zooming with mouse and touch events like pinch zoom. Ranges are restricted to avoid float precision issues, see Cartesian2dFloatPrecisionRangeBounder.
Cartesian2dNaturalLogTransform Apply natural log as a transform, range must be greater than 0.
Cartesian2dPlotCtorArg The construction arg of ICartesian2dPlot.
Cartesian2dPlotRange Cartesian 2d data range, range is bounded by Cartesian2dInteractionHandler.
Cartesian2dPlotSharedQuadTree Default interaction groups implemented using a shared quad tree.
Cartesian2dTraceEntityConnector Generates traces in increments of 2, 5 or 10 in order to fit within maxTraceCount. The actual trace count may be up to maxTraceCount + 1.
Cartesian2dTransforms Provides data transforms useful for drawing and interaction handling. Created by ICartesian2dUpdateArgProvider.
Cartesian2dUpdateArg Update arg provided by ICartesian2dUpdateArg.
CartesianPlotConstructionOptions Construction options of ICartesian2dPlot.
CategoryStack2d Assigns a value to T2dRelativeZIndexTrait based on the position in the stack. Entities towards the top of the stack have higher values.
EntityCategory2d Update category for 2d plots. Provides Z-ordering.
GlCaplessLineGraphicsComponent Draws lines without caps, without generating any intermediate geometry. Caps can be added by combining with a cap drawing component. Handles sizes and colors per point.
GlCartesian2dAxisGraphicsComponent Draws labels for cartesian 2d plots.
GlCartesian2dCameraBinder Provides WebGL bindings for cartesian 2d graphics components.
GlCartesian2dPlotFactory Creates a Cartesian 2d plot.
GlCartesian2dTraceBinder Binds trace data to WebGL buffers.
GlCartesian2dTraceGraphicsComponent Draws traces for cartesian 2d plots.
GlCartesian2dUpdateArg  
GlCartesian2dUpdateArgProvider WebGL implementation of ICartesian2dUpdateArgProvider.
GlCartesianUpdateHooks Canvas update hook, called before and after a plot is drawn.
GlInterleaved2dPointBinder Provides bindings for an interleaved buffer that described points in 2d.
GlLineFlatCapGraphicsComponent Draws line caps, to be used with GlCaplessLineGraphicsComponent. Handles sizes and colors per point.
GlPoint2dGraphicsComponent Draws points of varying sizes and colors.
GlPoint2dNaturalLogTransformComponent Applies natural log to an indexable gl connector. The behavior of the transform is undefined if any point is less than 0.
GlTrace2dNaturalLogTransformComponent Applies natural log to a trace gl connector. The behavior of the transform is undefined if the range is less than 0.
InterleavedLine2dHitTestComponent Inserts line segments into a shared quad tree from a TIndexedPointTrait.
PinchZoomHandlerCartesian2d User interaction handler for pinch zooming.
Point2dDisplaySettings Point config where not specified per point. Colors are stored normalized.
Point2dSizeNormalizer Normalizes the arbitrary data point size into a screen space display size.
Point2dSubcategory Membership hooks for 2d points, normalizes point display size.
Scene2dCategorySorted sorts entities by z order.
SharedInterleavedCircle2dQuadIndexerFactory Creates a ISharedInterleavedPoint2dQuadIndexer for capless circles.
SharedInterleavedLine2dHitTestComponent Where an entity makes use of shared buffers it can be indexed natively, potentially providing a significant performance boost. Otherwise equivalent to InterleavedLine2dHitTestComponent.
SharedInterleavedLine2dQuadIndexerFactory Creates a ISharedInterleavedPoint2dQuadIndexer for capless lines.
SharedInterleavedPoint2dQuadIndexer Base 2d point quad indexer.
Sorted2dUpdateStrategy Sorts entities according to IScene2d and then batches entities to minimize draw calls. Respects ICompositeGraphicsComponent.groupUpdatesByEntity flag.
Update2dGroup Update group for drawable entities part of a 2d plot.

Enumerations

Enumeration Description
ECartesian2dUserTransform Supported 2d user transforms.
EScreenUnit Supported methods of describing screen space dimensions.

Functions

Function Description
createCartesianPlotCtor(axisFactory, metaUpdateHooks, dataUpdateHooks) Generates the constructor of ICartesian2dPlot. Use a factory to create an instance (CanvasCartesian2dPlotFactory, GlCartesian2dPlotFactory etc) unless extending.
getRangeFromIndexedConnector(connector, result) Provides the AABB (in data space) of an indexed point connector. The last parameter is an optional out parameter, if not supplied F64 will be assumed.
hoverHighlightLineSegment(entity, state, segments) Updates the state of an entity that receives a hover event.
populateCartesian2dTraceBindings(entity) Generates a typed array buffer of the entities current traces. Output structure is of the form [xMin, yMin, xMax, yMax] per trace, where min and max are the extrema of the data range being drawn. Vertical traces come first.

Interfaces

Interface Description
I2dEntityCategory  
I2dEntityCategoryRead  
ICartesian2dAxisFactory  
ICartesian2dAxisLabelConfig Provides dirty checking for generating axis config from axis options.
ICartesian2dAxisLabelOptions User options for axis settings in cartesian 2d plots.
ICartesian2dBindings Emscripten bindings exposed by cartesian 2d.
ICartesian2dGutterOptions  
ICartesian2dInteractionBounder Constrains a 2d draw range.
ICartesian2dPlot  
ICartesian2dPlotConstructionOptions Construction options of ICartesian2dPlot.
ICartesian2dPlotConstructorOptions  
ICartesian2dPlotCtor  
ICartesian2dPlotCtorArg The construction arg of ICartesian2dPlot.
ICartesian2dPlotRange Cartesian 2d data range, range is bounded by Cartesian2dInteractionHandler.
ICartesian2dTraceEntityConnector Trace provider for cartesian 2d. Update should be called every time the data range changes.
ICartesian2dTraceOptions  
ICartesian2dTransforms Provides data transforms useful for drawing and interaction handling. Created by ICartesian2dUpdateArgProvider.
ICartesian2dUpdateArg Update arg provided by ICartesian2dUpdateArg.
ICartesian2dUpdateArgProvider Created every frame and on interaction events, passed to graphics and interaction components.
ICartesian2dUserTransform A user transform to apply before the screen space transform. By default this is identity.
IDrawablePoint2dOffsets  
IGlCamera2dBinder Provides coordinate system invariant WebGL bindings for 2d graphics components.
IGlCartesian2dCameraBinder Provides WebGL bindings for cartesian 2d graphics components.
IGlIndexedPoint2dBinder  
IGlIndexedPoint2dTransformBinder  
IGlTraceBinder Binds trace data to WebGL buffers.
IGlTraceTransformBinder Binds trace data to WebGL transform feedback.
IInterleavedCircle2dQuadIndexerBindings  
IInterleavedLine2dQuadIndexerBindings  
IInterleavedPointGlBindings  
IPoint2dOffsets Offsets into a IIndexedDataConnector that represent a 2d point.
IScene2d  
ISharedInterleavedPoint2dQuadIndexer Indexes a ISharedInterleavedConnector which describes a collection of 2d points representing a continuous line.
IUpdate2dGroup Update group for drawable entities part of a 2d plot.

Type Aliases

Type Alias Description
T2dAbsoluteZIndexSettings  
T2dAbsoluteZIndexTrait  
T2dRelativeZIndexSettings  
T2dRelativeZIndexTrait  
T2dUpdateGroup  
T2dZIndexesTrait  
TAxisLabelEntity An entity that draws axis labels.
TCanvasCartesianPlot Canvas ICartesian2dPlot.
TCartesian2dAxisSettings  
TCartesian2dAxisSettingsTrait  
TCartesian2dAxisTrait  
TCartesianSharedQuadTree  
TCartesianSharedQuadTreeGroup Default interaction groups for cartesian 2d.
TCartesianUpdateStrategy  
TGlAxisEntity WebGL entity that draws axis labels.
TGlCartesianPlot  
TGlInterleavedPointBinderConfig  
TGlTraceEntity An entity that draws traces in cartesian 2d plot.
THighlightColorOverride  
THitTestableIndexedPoint2dTrait  
THitTestableSharedInterleavedPoint2dTrait  
TIInterleavedCircle2dQuadIndexerPrefix  
TIInterleavedLine2dQuadIndexerPrefix  
TIndexedPointTrait  
TInterleavedPoint2dQuadIndexerBindings  
TInterleavedPoint2dTrait  
TPoint2dDisplaySettings  
TPoint2dDisplaySettingsTrait  
TPoint2dSettings  
TPoint2dSizeNormalizer  
TPoint2dSizeNormalizerTrait  
TSharedInterleavedPoint2dTrait  
TTrace2dBindingsDisplaySetting  
TTrace2dBindingsTrait  
TTrace2dDisplaySettings  
TTrace2dDisplaySettingsTrait  
TTraceEntity Draws traces for cartesian 2d plots.