@gooddata/gdc-afm-connect

GoodData.UI AFM Redux Connector

This package may help to build react-redux apps with GoodData.UI faster. Use at your own risk.

Usage

• Install gdc-afm-connect yarn add '@gooddata/gdc-afm-connect'

• Import AFM reducers and combine

  import { createStore, combineReducers } from 'redux';
  import { AfmReducers } from '@gooddata/gdc-afm-connect';
  
  const configureStore = () => {
    const store = createStore(
      combineReducers({
        ...AfmReducers
      })
    );
  
    return store;
  };
  

• Wrap regular components with afmConnect

  import { ColumnChart as ColumnChartOrig } from '@gooddata/react-components';
  import { afmConnect } from '@gooddata/gdc-afm-connect';
  
  const ColumnChart = afmConnect(ColumnChartOrig);
  
  <ColumnChart
      projectId="<project-id"
      filterGroup="<filter-group>"
      measures="<measures>"
  />
  

• Wrap AFM components with afmWrapper

  import { AfmComponents } from '@gooddata/react-components';
  import { afmWrapper } from '@gooddata/gdc-afm-connect';
  
  const ColumnChart = afmWrapper(AfmComponents.ColumnChart);
  
  <ColumnChart
      projectId="<project-id"
      filterGroup="<filter-group>"
      afm="<afm>"
  />
  

❗️Please note that AFM components are being DEPRECATED. Use regular components as shown above.

Available Actions

UPDATE_POSITIVE_ATTRIBUTE_FILTER

updatePositiveAttributeFilter(
  filterGroup: '<string>',          // name of the filter group context
  attributeDisplayForm: '<string>', // uri or identifier of attribute display form
  inValues: '<array>'               // array of attribute element uris
)

UPDATE_NEGATIVE_ATTRIBUTE_FILTER

updateNegativeAttributeFilter(
  filterGroup: '<string>',          // name of the filter group context
  attributeDisplayForm: '<string>', // uri or identifier of attribute display form
  notInValues: '<array>'            // array of attribute element uris
)

REMOVE_ATTRIBUTE_FILTER

removeAttributeFilter(
  filterGroup: '<string>',          // name of the filter group context
  attributeDisplayForm: '<string>'  // uri or identifier of attribute display form
)

UPDATE_DATE_FILTER

updateDateFilter(
  filterGroup: '<string>', // name of the filter group context
  dataSet: '<string>',     // uri or identifier of date display form
  grain: '<string>',       // date granularity, currently only 'GDC.time.date' is supported
  start: '<string>',       // start date, can be absolute (i.e. 'YYYY-MM-DD') or relative (e.g. 0)
  end: '<string>'          // end date, can be absolute (i.e. 'YYYY-MM-DD') or relative (e.g. -1)
)

REMOVE_DATE_FILTER

  // TODO not yet implemented

Development

• yarn validate
• yarn build

Releasing / Publishing

• Bump [major|minor|patch] version in package.json accordingly
• Git commit
• npm publish --access=restricted