Skip to content
This repository was archived by the owner on Jan 17, 2023. It is now read-only.

v1tov2.md

Latest commit

 

History

History
42 lines (30 loc) · 2.98 KB

v1tov2.md

File metadata and controls

42 lines (30 loc) · 2.98 KB
Raw

Changes from verison 1.x to version 2.x

Move to Peer Dependencies

In 1.x most external libraries were bundled with the ui-widget-toolkit in order to simplify installation and/or sharing of the script without requiring multiple external dependencies. With the shift to more modern compilation tools like webpack this has been become less of an issue so the toolkit now leverages peer dependencies to help reduce the size of the package.

WebGL Rendering vs Canvas Rendering

PIXI.js has updated to make WebGL the default rendering mode for their library. As such the forceWebGLRenderer option has been deprecated. The following data types will render using WebGL unless the forceSvgRenderer or forceCanvasRenderer are set in the IOptions that is passed into the renderer:

  • Flame Chart Series
  • Heatmap
  • Scatter Plot XY Series
  • Port Diagram

Hover vs Focus vs Select

In version 1 hover was synonymous with focus in most, but not all cases. With 2.x the goal was to be consistent across all of the widgets. Each widget now supports 3 different common user interface concepts.

  • Hover is when the user interacts with the system and moves the mouse over an item.
  • Focus is when an item is highlighted temporarily to bring the users attention to an interaction. It generally goes away with a mouse or touch action when the user continues to interact with a widget.
  • Select is when an item is more permanently highlighted by the user and persists until it is removed programmatically or by a specific user action.

Changes to existing APIs

To support the breaking up of these concepts the following changes have been made:

  • New focus event types were added which map to hover event types. Since these commonly are tied together focus events have the same enumeration value as hover events
  • The programmatic hover function has been deprecated in favor of a focus function for all widgets. Note that previously hover acted as a select in the grid, so to maintain some backwards compatibility the hover event is synonymous with select for the grid.

Select functionality

  • A new select event type has been added. Each widget now supports a select function to allow widgets to programmatically select items in other widgets.
  • The user can configure how items are affected by selection using CSS. A selected item will have the selected class added to it.

Simplifying Widget Behavior

In 1.x each widget passed whatever data it felt necessary on click or through context menu items. To ensure a more consistent experience the behavior of existing widgets was normalized in the following ways:

Events

  • All click events will have both a data and a selection property.
  • data will be the original data used to create an item.
  • selection will be the widgets best guess as to what other widgets might associate with that piece of data

Context menu items

  • each context menu item will pass back the original data used to create an item if applicable in the data parameter