notebooks/helper_convert_gridOptions_js_to_python.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "import re\n",
    "import json\n",
    "\n",
    "from IPython.display import display, Javascript"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [],
   "source": [
    "# copy pasted from https://www.ag-grid.com/javascript-grid-column-definitions/\n",
    "\n",
    "gridOptions_str = \"\"\"\n",
    "{\n",
    "    // define grid columns\n",
    "    columnDefs: [\n",
    "        // using default ColDef\n",
    "        {headerName: 'Athlete', field: 'athlete'},\n",
    "        {headerName: 'Sport', field: 'sport'},\n",
    "\n",
    "        // using number column type\n",
    "        {headerName: 'Age', field: 'age', type: 'numberColumn'},\n",
    "        {headerName: 'Year', field: 'year', type: 'numberColumn'},\n",
    "\n",
    "        // using date and non-editable column types\n",
    "        {headerName: 'Date', field: 'date', type: ['dateColumn', 'nonEditableColumn'], width: 200 },\n",
    "        {\n",
    "            headerName: 'Medals',\n",
    "            groupId: 'medalsGroup',\n",
    "            children: [\n",
    "                // using medal column type\n",
    "                {headerName: 'Gold', field: 'gold', type: 'medalColumn'},\n",
    "                {headerName: 'Silver', field: 'silver', type: 'medalColumn'},\n",
    "                {headerName: 'Bronze', field: 'bronze', type: 'medalColumn'}\n",
    "            ]\n",
    "        }\n",
    "    ],\n",
    "\n",
    "    // default ColDef, gets applied to every column\n",
    "    defaultColDef: {\n",
    "        // set the default column width\n",
    "        width: 150,\n",
    "        // make every column editable\n",
    "        editable: true,\n",
    "        // make every column use 'text' filter by default\n",
    "        filter: 'agTextColumnFilter'\n",
    "    },\n",
    "\n",
    "    // default ColGroupDef, get applied to every column group\n",
    "    defaultColGroupDef: {\n",
    "        marryChildren: true\n",
    "    },\n",
    "\n",
    "    // define specific column types\n",
    "    columnTypes: {\n",
    "        numberColumn: {width: 83, filter: 'agNumberColumnFilter'},\n",
    "        medalColumn: {width: 100, columnGroupShow: 'open', suppressFilter: true},\n",
    "        nonEditableColumn: {editable: false},\n",
    "        dateColumn: {\n",
    "            // specify we want to use the date filter\n",
    "            filter: 'agDateColumnFilter',\n",
    "\n",
    "            // add extra parameters for the date filter\n",
    "            filterParams: {\n",
    "                // provide comparator function\n",
    "                comparator: function(filterLocalDateAtMidnight, cellValue) {\n",
    "                    // In the example application, dates are stored as dd/mm/yyyy\n",
    "                    // We create a Date object for comparison against the filter date\n",
    "                    var dateParts = cellValue.split('/');\n",
    "                    var day = Number(dateParts[2]);\n",
    "                    var month = Number(dateParts[1]) - 1;\n",
    "                    var year = Number(dateParts[0]);\n",
    "                    var cellDate = new Date(day, month, year);\n",
    "\n",
    "                    // Now that both parameters are Date objects, we can compare\n",
    "                    if (cellDate < filterLocalDateAtMidnight) {\n",
    "                        return -1;\n",
    "                    } else if (cellDate > filterLocalDateAtMidnight) {\n",
    "                        return 1;\n",
    "                    } else {\n",
    "                        return 0;\n",
    "                    }\n",
    "                }\n",
    "            }\n",
    "        }\n",
    "    },\n",
    "\n",
    "    rowData: null,\n",
    "    enableFilter: true,\n",
    "    floatingFilter: true\n",
    "}\n",
    "\"\"\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [],
   "source": [
    "# remove comments from gridOptions_str\n",
    "\n",
    "def stripComments(code):\n",
    "    code = str(code)\n",
    "    return re.sub(r'(?m)^ *//.*\\n?', '', code)\n",
    "\n",
    "gridOptions_str = stripComments(gridOptions_str)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "application/javascript": [
       "\n",
       "var JSONfunc = {};\n",
       "\n",
       "JSONfunc.stringify = function (obj) {\n",
       "    return JSON.stringify(obj, function (key, value) {\n",
       "        return (typeof value === 'function') ? value.toString() : value;\n",
       "    });\n",
       "};\n",
       "\n",
       "var gridOptions = \n",
       "{\n",
       "    columnDefs: [\n",
       "        {headerName: 'Athlete', field: 'athlete'},\n",
       "        {headerName: 'Sport', field: 'sport'},\n",
       "\n",
       "        {headerName: 'Age', field: 'age', type: 'numberColumn'},\n",
       "        {headerName: 'Year', field: 'year', type: 'numberColumn'},\n",
       "\n",
       "        {headerName: 'Date', field: 'date', type: ['dateColumn', 'nonEditableColumn'], width: 200 },\n",
       "        {\n",
       "            headerName: 'Medals',\n",
       "            groupId: 'medalsGroup',\n",
       "            children: [\n",
       "                {headerName: 'Gold', field: 'gold', type: 'medalColumn'},\n",
       "                {headerName: 'Silver', field: 'silver', type: 'medalColumn'},\n",
       "                {headerName: 'Bronze', field: 'bronze', type: 'medalColumn'}\n",
       "            ]\n",
       "        }\n",
       "    ],\n",
       "\n",
       "    defaultColDef: {\n",
       "        width: 150,\n",
       "        editable: true,\n",
       "        filter: 'agTextColumnFilter'\n",
       "    },\n",
       "\n",
       "    defaultColGroupDef: {\n",
       "        marryChildren: true\n",
       "    },\n",
       "\n",
       "    columnTypes: {\n",
       "        numberColumn: {width: 83, filter: 'agNumberColumnFilter'},\n",
       "        medalColumn: {width: 100, columnGroupShow: 'open', suppressFilter: true},\n",
       "        nonEditableColumn: {editable: false},\n",
       "        dateColumn: {\n",
       "            filter: 'agDateColumnFilter',\n",
       "\n",
       "            filterParams: {\n",
       "                comparator: function(filterLocalDateAtMidnight, cellValue) {\n",
       "                    var dateParts = cellValue.split('/');\n",
       "                    var day = Number(dateParts[2]);\n",
       "                    var month = Number(dateParts[1]) - 1;\n",
       "                    var year = Number(dateParts[0]);\n",
       "                    var cellDate = new Date(day, month, year);\n",
       "\n",
       "                    if (cellDate < filterLocalDateAtMidnight) {\n",
       "                        return -1;\n",
       "                    } else if (cellDate > filterLocalDateAtMidnight) {\n",
       "                        return 1;\n",
       "                    } else {\n",
       "                        return 0;\n",
       "                    }\n",
       "                }\n",
       "            }\n",
       "        }\n",
       "    },\n",
       "\n",
       "    rowData: null,\n",
       "    enableFilter: true,\n",
       "    floatingFilter: true\n",
       "}\n",
       ";\n",
       "window.gridOptions = gridOptions;\n",
       "\n",
       "var gridOptionsJson = JSONfunc.stringify(gridOptions);\n",
       "window.gridOptionsJson = gridOptionsJson;\n",
       "\n",
       "console.log('type \"gridOptionsJson\", copy it from console and paste it into notebook Python variable data');\n",
       "//console.log(gridOptionsJson);\n"
      ],
      "text/plain": [
       "<IPython.core.display.Javascript object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Open console to read gridOptionsJson\n"
     ]
    }
   ],
   "source": [
    "js = \"\"\"\n",
    "var JSONfunc = {};\n",
    "\n",
    "JSONfunc.stringify = function (obj) {\n",
    "    return JSON.stringify(obj, function (key, value) {\n",
    "        return (typeof value === 'function') ? value.toString() : value;\n",
    "    });\n",
    "};\n",
    "\n",
    "var gridOptions = __gridOptions_str__;\n",
    "window.gridOptions = gridOptions;\n",
    "\n",
    "var gridOptionsJson = JSONfunc.stringify(gridOptions);\n",
    "window.gridOptionsJson = gridOptionsJson;\n",
    "\n",
    "console.log('type \"gridOptionsJson\", copy it from console and paste it into notebook Python variable data');\n",
    "//console.log(gridOptionsJson);\n",
    "\"\"\".replace('__gridOptions_str__', gridOptions_str)\n",
    "# print(js)\n",
    "display(Javascript(js))\n",
    "print('Open console to read gridOptionsJson')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [],
   "source": [
    "# copy from console\n",
    "data = \"{\\\"columnDefs\\\":[{\\\"headerName\\\":\\\"Athlete\\\",\\\"field\\\":\\\"athlete\\\"},{\\\"headerName\\\":\\\"Sport\\\",\\\"field\\\":\\\"sport\\\"},{\\\"headerName\\\":\\\"Age\\\",\\\"field\\\":\\\"age\\\",\\\"type\\\":\\\"numberColumn\\\"},{\\\"headerName\\\":\\\"Year\\\",\\\"field\\\":\\\"year\\\",\\\"type\\\":\\\"numberColumn\\\"},{\\\"headerName\\\":\\\"Date\\\",\\\"field\\\":\\\"date\\\",\\\"type\\\":[\\\"dateColumn\\\",\\\"nonEditableColumn\\\"],\\\"width\\\":200},{\\\"headerName\\\":\\\"Medals\\\",\\\"groupId\\\":\\\"medalsGroup\\\",\\\"children\\\":[{\\\"headerName\\\":\\\"Gold\\\",\\\"field\\\":\\\"gold\\\",\\\"type\\\":\\\"medalColumn\\\"},{\\\"headerName\\\":\\\"Silver\\\",\\\"field\\\":\\\"silver\\\",\\\"type\\\":\\\"medalColumn\\\"},{\\\"headerName\\\":\\\"Bronze\\\",\\\"field\\\":\\\"bronze\\\",\\\"type\\\":\\\"medalColumn\\\"}]}],\\\"defaultColDef\\\":{\\\"width\\\":150,\\\"editable\\\":true,\\\"filter\\\":\\\"agTextColumnFilter\\\"},\\\"defaultColGroupDef\\\":{\\\"marryChildren\\\":true},\\\"columnTypes\\\":{\\\"numberColumn\\\":{\\\"width\\\":83,\\\"filter\\\":\\\"agNumberColumnFilter\\\"},\\\"medalColumn\\\":{\\\"width\\\":100,\\\"columnGroupShow\\\":\\\"open\\\",\\\"suppressFilter\\\":true},\\\"nonEditableColumn\\\":{\\\"editable\\\":false},\\\"dateColumn\\\":{\\\"filter\\\":\\\"agDateColumnFilter\\\",\\\"filterParams\\\":{\\\"comparator\\\":\\\"function(filterLocalDateAtMidnight, cellValue) {\\\\n                    var dateParts = cellValue.split('/');\\\\n                    var day = Number(dateParts[2]);\\\\n                    var month = Number(dateParts[1]) - 1;\\\\n                    var year = Number(dateParts[0]);\\\\n                    var cellDate = new Date(day, month, year);\\\\n\\\\n                    if (cellDate < filterLocalDateAtMidnight) {\\\\n                        return -1;\\\\n                    } else if (cellDate > filterLocalDateAtMidnight) {\\\\n                        return 1;\\\\n                    } else {\\\\n                        return 0;\\\\n                    }\\\\n                }\\\"}}},\\\"rowData\\\":null,\\\"enableFilter\\\":true,\\\"floatingFilter\\\":true}\"\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'columnDefs': [{'field': 'athlete', 'headerName': 'Athlete'},\n",
       "  {'field': 'sport', 'headerName': 'Sport'},\n",
       "  {'field': 'age', 'headerName': 'Age', 'type': 'numberColumn'},\n",
       "  {'field': 'year', 'headerName': 'Year', 'type': 'numberColumn'},\n",
       "  {'field': 'date',\n",
       "   'headerName': 'Date',\n",
       "   'type': ['dateColumn', 'nonEditableColumn'],\n",
       "   'width': 200},\n",
       "  {'children': [{'field': 'gold', 'headerName': 'Gold', 'type': 'medalColumn'},\n",
       "    {'field': 'silver', 'headerName': 'Silver', 'type': 'medalColumn'},\n",
       "    {'field': 'bronze', 'headerName': 'Bronze', 'type': 'medalColumn'}],\n",
       "   'groupId': 'medalsGroup',\n",
       "   'headerName': 'Medals'}],\n",
       " 'columnTypes': {'dateColumn': {'filter': 'agDateColumnFilter',\n",
       "   'filterParams': {'comparator': \"function(filterLocalDateAtMidnight, cellValue) {\\n                    var dateParts = cellValue.split('/');\\n                    var day = Number(dateParts[2]);\\n                    var month = Number(dateParts[1]) - 1;\\n                    var year = Number(dateParts[0]);\\n                    var cellDate = new Date(day, month, year);\\n\\n                    if (cellDate < filterLocalDateAtMidnight) {\\n                        return -1;\\n                    } else if (cellDate > filterLocalDateAtMidnight) {\\n                        return 1;\\n                    } else {\\n                        return 0;\\n                    }\\n                }\"}},\n",
       "  'medalColumn': {'columnGroupShow': 'open',\n",
       "   'suppressFilter': True,\n",
       "   'width': 100},\n",
       "  'nonEditableColumn': {'editable': False},\n",
       "  'numberColumn': {'filter': 'agNumberColumnFilter', 'width': 83}},\n",
       " 'defaultColDef': {'editable': True,\n",
       "  'filter': 'agTextColumnFilter',\n",
       "  'width': 150},\n",
       " 'defaultColGroupDef': {'marryChildren': True},\n",
       " 'enableFilter': True,\n",
       " 'floatingFilter': True}"
      ]
     },
     "execution_count": 6,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "dic = json.loads(data)\n",
    "dic.pop('rowData')\n",
    "dic"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [],
   "source": [
    "dic2 = {'columnDefs': [{'field': 'athlete', 'headerName': 'Athlete'},\n",
    "  {'field': 'sport', 'headerName': 'Sport'},\n",
    "  {'field': 'age', 'headerName': 'Age', 'type': 'numberColumn'},\n",
    "  {'field': 'year', 'headerName': 'Year', 'type': 'numberColumn'},\n",
    "  {'field': 'date',\n",
    "   'headerName': 'Date',\n",
    "   'type': ['dateColumn', 'nonEditableColumn'],\n",
    "   'width': 200},\n",
    "  {'children': [{'field': 'gold', 'headerName': 'Gold', 'type': 'medalColumn'},\n",
    "    {'field': 'silver', 'headerName': 'Silver', 'type': 'medalColumn'},\n",
    "    {'field': 'bronze', 'headerName': 'Bronze', 'type': 'medalColumn'}],\n",
    "   'groupId': 'medalsGroup',\n",
    "   'headerName': 'Medals'}],\n",
    " 'columnTypes': {'dateColumn': {'filter': 'agDateColumnFilter',\n",
    "   'filterParams': {'comparator': \"function(filterLocalDateAtMidnight, cellValue) {\\n                    var dateParts = cellValue.split('/');\\n                    var day = Number(dateParts[2]);\\n                    var month = Number(dateParts[1]) - 1;\\n                    var year = Number(dateParts[0]);\\n                    var cellDate = new Date(day, month, year);\\n\\n                    if (cellDate < filterLocalDateAtMidnight) {\\n                        return -1;\\n                    } else if (cellDate > filterLocalDateAtMidnight) {\\n                        return 1;\\n                    } else {\\n                        return 0;\\n                    }\\n                }\"}},\n",
    "  'medalColumn': {'columnGroupShow': 'open',\n",
    "   'suppressFilter': True,\n",
    "   'width': 100},\n",
    "  'nonEditableColumn': {'editable': False},\n",
    "  'numberColumn': {'filter': 'agNumberColumnFilter', 'width': 83}},\n",
    " 'defaultColDef': {'editable': True,\n",
    "  'filter': 'agTextColumnFilter',\n",
    "  'width': 150},\n",
    " 'defaultColGroupDef': {'marryChildren': True},\n",
    " 'enableFilter': True,\n",
    " 'floatingFilter': True}"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}