Features

• Automatic level detection for your hierarchical data when using the sequential layout, meaning the top and level options are now optional when using this layout.
• There is a new Hierarchies story where you can explore the different sequential layout options.
• The Combos and Timebar story has been updated to fade nodes instead of removing them.
• Further styling updates to the SDK site in Docs, Storybook, and Playground. We'd love to hear what you think about the changes so far. Contact [email protected].

Bugs Fixed

• Fixed an issue where layouts were not accounting for combo summary links.
• Fixed an issue where nodes set back to default values weren't animating.
• Fixed an issue with options.selection and falsey values.

• Fixed an issue where summary link glyphs could not be cleared.
• Fixed an issue where link end1 and end2 did not update correctly.

• SDK site maintenance

Features

• A new Lazy Loading Combos story to help you load only the data your users want to see. This can significantly improve application performance.
• A new subItem argument on our event handlers. This supersedes the sub argument.
• A new onChartDragCancel event invoked when a state change animation cancels a drag.
• A fresh new look for our SDK site. There are further improvements planned, but we'd love to hear what you think about the changes so far. Contact [email protected].

Bugs Fixed

• The Chart component is now robust to user interaction during state change animations. See the related onChartDragCancel event, above.
• ReGraph no longer reveals contents links between closed combos on selection.

Deprecations

• The sub argument on event handlers has been deprecated in favor of subItem.

TypeScript Changes

• The donut.segments property is now correctly typed to accept an array rather than an object.

Features

• A new 'smooth' mode has been added to the time bar, drawing a continuous line with a colored area below it. To use it, set the mode prop to 'smooth'. See the Time Bar documentation and Smooth Mode example.
• A new Performance showcase has been added to the SDK site which demonstrates the performance of ReGraph's state changes and layouts when working with large datasets.
• New and updated documentation is available covering layouts, graph centrality measures, rendering, cross-origin images (CORS), and security.

Bugs Fixed

• Fixed several cases where ReGraph was waiting for non-visible animations.
• The ReGraph Chart will log a warning if an item is passed with an empty id like this:

<Chart items={ '': { color: 'red' }}) />

Deprecations

• The time bar option histogram has been deprecated in favor of style. Instead of:

<TimeBar items={items} options={ histogram: { color: 'red' } } />

you should now write:

<TimeBar items={items} options={ style: { color: 'red' } } />

Note: histogram will continue to function until the next major version of ReGraph.

TypeScript Changes

• The TypeScript definitions for the time bar have changed to accommodate the mode prop. The following changes may break existing code:
  • TimeBar.HistogramOptions has been renamed to TimeBar.StyleOptions.
  • The histo value for TimeBar.EventTypes has been removed. This affects the first argument of time bar event handlers.
  • The times property on items is now correctly typed. Check the API for more details.
  • The time bar highlight prop is now correctly typed. Check the API for more details.

Features

• The onCombineLinks event now gives significantly more control and flexibility on the handling of summary links connected to combos, see Summary and Content Links. Try out the new Summary Links and Selection Behavior demo.
• There is a new demo for using images in map mode. Check it out here
• Various improvements to the new playground

Bugs Fixed

• Zoom to ids now animates correctly
• When children of summary links are visible, they can be interacted with

TypeScript Changes

• Some TypeScript definitions were updated to match our documentation
  • Chart.ComboNode → Chart.Combo
  • Chart.ComboLink → Chart.Summary

Features

• There is now a ReGraph playground at regraph.io/playground! You can open the code examples all over the site in the live editor by clicking on the yellow edit icon.
• Instance methods to convert between view and world coordinates are now available. More details can be found here.

Bugs Fixed

• Improved performance of some combo animations
• Changing positions now respects the animation: {animate: false} property
• Fixed an issue where view was sometimes not reported in onChartChange

Features

• Stacked bars are now available in the Time Bar (see the Stacked Bars example).
• A major update to our TypeScript definitions file to make it clearer and easier to use. Note: breaking changes to the TS definitions are included in this release (see TypeScript Changes below).
• Evaluators will now see a watermark in downloaded versions of ReGraph.

Bugs Fixed

• Chart components created by ReGraph are now named 'rg-chart-#'.

TypeScript Changes

• Refactored several interfaces and removed the Formats namespace. Node and Link formats are now top-level interfaces.
• Utilized generics to type the data property on Nodes and Links, as well as the Combo object in onCombineNodes.
• Added a type definition for the FontLoader.
• Added TypeScript section to Storybook.
• #ts-changes-1-6.text-collapsable.text-collapsable--collapsed
  • Chart.ChartChangeEvent → Chart.ChangeEvent
  • Chart.ChartEvents namespace merged with Chart.Props
  • Chart.ChartInstanceMethods namespace merged into the Chart class
  • Chart.ChartLabelOptions → Chart.LabelOptions
  • Chart.ChartOptions → Chart.Options
  • Chart.ChartProps → Chart.Props
  • Chart.ChartViewOptions → Chart.ViewOptions
  • Chart.ComboLinkStyles → Chart.ComboLink
  • Chart.ComboNodeStyles → Chart.ComboNode
  • Chart view prop values have been consolidated into a View type
  • Formats.Border → Border
  • Formats.Donut → Donut
  • Formats.DonutBorder → DonutBorder
  • Formats.DonutSegment → DonutSegment
  • Formats.FontIcon → FontIcon
  • Formats.Glyph → Glyph
  • Formats.Halo → Halo
  • Formats.Item → Item
  • Formats.Label → Label
  • Formats.Link → Link
  • Formats.LinkEnd → LinkEnd
  • Formats.LinkFlowOptions → LinkFlowOptions
  • Formats.LinkStyle → LinkStyle
  • Formats.Location → Location
  • Formats.Node → Node
  • Formats.NodeLabel → NodeLabel
  • Formats.StyledBorder → StyledBorder
  • Formats.Time → Time
  • Formats.TimePeriod → TimePeriod
  • IdIndex → Index
  • TimeBar.TimeBarChangeEvent → TimeBar.ChangeEvent
  • TimeBar.TimeBarEvents namespace merged with TimeBar.Props
  • TimeBar.TimeBarLabelsOptions → TimeBar.LabelsOptions
  • TimeBar.TimeBarOptions → TimeBar.Options
  • TimeBar.TimeBarProps → TimeBar.Props
  • TimeBar.TimeBarRange → TimeBar.Range

Features

• Significant performance improvements when making changes to large charts (see note below).
• Labels and glyphs can now be added to link ends (see the Link Styles example).

Bugs Fixed

• Overlaps are less likely when adding new components to the chart with most layouts.

Note on performance changes

To respond to state updates more quickly, we've increased the strictness of our change detection algorithm. This means that sub-objects on items must be re-created when modified.

If you have code that mutates these sub-objects, like this:

const item = { ...items[id] };
item.label.color = 'red';

You will now need to rebuild those objects, like this:

const item = { ...items[id] };
item.label = {
    ...item.label,
    color: 'red',
};

• SDK maintenance

Features

• A significantly faster organic layout - typically between 2x and 5x faster than before.
• The ability to run sequential layouts by passing only a 'top' node - no need to specify levels for all nodes.
• Improved aesthetics of sequential layouts.
• Performance and stability improvements to the sequential layout on large datasets.
• Ability to pass a list of items to the view prop to trigger a zoom to those items.
• A new way to sign into the SDK site using email.
• Various documentation improvements.

Bugs Fixed

• Fixed an issue which could cause links in combos to have the wrong offset.
• Fixed a problem where the time bar would not always zoom to fit its contents.

TypeScript Changes

• Definitions for the Chart's view prop and onChartChange event have been expanded.
• The ViewSettings interface has been renamed to ViewOptions.

Features

• The chart now uses adaptive styling which adjusts how nodes, links, and labels are drawn to suit the current zoom level.
• Combos performance improvements.
• Improved SDK site support for IE11.

• Fixed an issue where initial chart render was waiting for image load.

Features

• Improved demo support for touch devices.
• Various documentation improvements.

Bugs Fixed

• Fixed combo labels default behavior with empty label property.
• Default selection color applied if supplied color is invalid.

• Fixed an issue where regraph/analysis could not access the core graph engine.

Features

• New link property flow to allow animated flow along a link (see the Link Styles example).
• New links.inlineLabels chart option for labels along links (see the Path Finding example).
• New orientation property added to layout options (only for hierarchy and sequential layouts).
• Organic layout has been improved and now has both rectangular and circular packing options.
• Changing id1 and/or id2 on a link is now allowed.
• Improved demo support for IE11 and Edge.
• Various documentation improvements.

Bugs Fixed

• Non-integer width containers caused ReGraph to continuously resize itself vertically.
• ReGraph can now work alongside KeyLines.
• Simplified the Chart and Time Bar example.
• Time Bar can now be given open-ended times.
• Various improvements to combos.

TypeScript changes

• Definitions for the return object of onCombineNodes and onCombineLinks now contain Node and Link styles.

• Combos sometimes crashed when combos contained non-string node labels.
• Layout now happens when transferring items to new combos.

Features

• Various documentation improvements

Bugs Fixed

• Fix for potential infinite loop in some circumstances.
• Shaking combo nodes could cause their contents to become detached.

TypeScript breaking changes

• Logo → LogoOptions
• Locale → LocaleOptions
• Zoom → ZoomOptions
• Changed type of TimeBar property items to be Items.
• Removed TimeBarChangeEvent.selection (this shouldn't have been there).

Known issues - we are working on fixes to these

• Non-integer width containers can cause ReGraph to continuously resize itself vertically.
• Interacting with ReGraph during state changes can cause unwanted side-effects.
• The performance of certain transitions can be improved.
• Under some circumstances nodes can be positioned outside of their containing combo.
• Some demos can fail to load under IE11 and Edge.