Ngx cumulio dashboard migrations

Table of contents

• From 4.x.x to 5.x.x
• From 3.x.x to 4.x.x
• From 2.x.x to 3.x.x
• From 2.0.x to 2.1.x
• From 1.x.x to 2.x.x

from 4.x.x to 5.x.x

• 5.x.x only supports Angular 16, All applications installing 5.x.x must migrate to angular 16.

From 3.x.x to 4.x.x

• Filters are represented as a FilterGroup array instead of a Filter array. FilterGroup is an object containing the list of filters and AND/OR condition describing their relation. FilterGroup also can have child groups to support complex filtering logic

// FilterGroup 
{
  id: string;
  condition: 'and' | 'or';
  filters: Filter[]; 
  subGroups: FilterGroup[];
  origin: string;
  datasetId?: string; // dataset id in case of dahsboard level filters
  itemId?: string; // chart id in case of chart level filters
}

// Filter
{
  expression: string;
  parameters: [];
  properties: {
    id: string;
    origin: string;
    type: string;
    itemId: string;
    ignore?: string[];
  }
}

• getFilters() method response and changedFilters event data now contain filters as an array of FilterGroup objects instead of Filter objects

getFilters(): Observable<FilterGroup[]>

// changedFilters event data
{
    changed: FilterGroup[]; // changed filters
    filters: FilterGroup[]; // all filters
  // ... other event properties
}

From 2.x.x to 3.x.x

• getFilters() now returns an observable that continues emitting instead of emitting only once.

From 2.0.x to 2.1.x

• Renamed ILoadEvent -> LoadEvent, IItemsRenderedEvent -> ItemsRenderedEvent, ICustomEvent -> CustomEvent, IChangedFiltersEvent -> ChangedFiltersEvent

From 1.x.x to 2.x.x

• All methods that were called on service e.g CumulioService.getFilters, CumulioService.getData ... shall now be called on component instance this.dashboardInstance.getFilters(), this.dashboardInstance.refreshData(). (see example above)
• chart is now called itemId, chartsRendered is now called itemsRendered, chartDimensions is now called itemDimensions
• All events are now of the format { data: { ...eventData } }, eventData is of the format

{
  dashboardId?: string;
  dashboardSlug?: string;
  itemId?: string;
  language: string;
  name: string;
  screenMode: string;
  type: string;
  dimensions?: object; // populated depending on the event
  changed?: [];  // populated depending on the event
  filters?: [];  // populated depending on the event
  item?: string;    // populated depending on the event
  origin?: string;  // populated depending on the event
  object?: string;  // populated depending on the event
  data?: object;       // populated depending on the event
}

• getFilters now returns an array of filters. [...objectOfFilters], objectOfFilters is of the format

[{
  expression: string;
  parameters: [];
  properties: {
    id: string;
    ignore?: string[];
    origin: string;
    type: string;
    viz: string;
  }
}]