diff --git a/docs/api/internal/intercept-method.md b/docs/api/internal/intercept-method.md index e7079df..30a81e8 100644 --- a/docs/api/internal/intercept-method.md +++ b/docs/api/internal/intercept-method.md @@ -27,7 +27,7 @@ api.intercept( ### Events :::info -The full list of the Pivot internal events can be found [**here**](api/overview/main-overview.md/#root-events). +The full list of the Pivot internal events can be found [**here**](api/overview/main-overview.md/#pivot-events). Use the [`api.on()`](/api/internal/on-method) method if you want to listen to the actions without modifying them. To make changes to the actions, apply the `api.intercept()` method. ::: diff --git a/docs/api/internal/on-method.md b/docs/api/internal/on-method.md index 3c854e1..4af3ad8 100644 --- a/docs/api/internal/on-method.md +++ b/docs/api/internal/on-method.md @@ -27,7 +27,7 @@ api.on( ### Events :::info -The full list of the Pivot internal events can be found [**here**](/api/overview/main-overview/#root-events). +The full list of the Pivot internal events can be found [**here**](/api/overview/main-overview/#pivot-events). Use the `api.on()` method if you want to listen to the actions without modifying them. To make changes to the actions, apply the [`api.intercept()`](/api/internal/intercept-method) method. ::: diff --git a/docs/api/overview/main-overview.md b/docs/api/overview/main-overview.md index 503bf02..7a9373c 100644 --- a/docs/api/overview/main-overview.md +++ b/docs/api/overview/main-overview.md @@ -17,7 +17,7 @@ new pivot.Pivot("#root", { **Parameters**: - an HTML container (the ID of the HTML container) -- an object of the configuration parameters ([check here](#root-properties)) +- an object of the configuration parameters ([check here](#pivot-properties)) ## Pivot methods diff --git a/docs/assets/trial_pivot.png b/docs/assets/trial_pivot.png new file mode 100644 index 0000000..f2e21cf Binary files /dev/null and b/docs/assets/trial_pivot.png differ diff --git a/docs/guides/configuration.md b/docs/guides/configuration.md index 9ee4acb..021951a 100644 --- a/docs/guides/configuration.md +++ b/docs/guides/configuration.md @@ -567,7 +567,7 @@ In the Configuration panel it's possible to perform the next operations with fie - [add-field](/api/events/add-field-event) - [delete-field](/api/events/delete-field-event) - [update-field](/api/events/update-value-event) -- [move-field](/api/events/reorder-fields-event) +- [move-field](/api/events/move-field-event) ## Example diff --git a/docs/guides/integration-with-angular.md b/docs/guides/integration-with-angular.md new file mode 100644 index 0000000..665b0f1 --- /dev/null +++ b/docs/guides/integration-with-angular.md @@ -0,0 +1,322 @@ +--- +sidebar_label: Integration with Angular +title: Integration with Angular +description: You can learn about the integration with Angular in the documentation of the DHTMLX JavaScript Pivot library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Pivot. +--- + +# Integration with Angular + +:::tip +You should be familiar with basic concepts and patterns of **Angular** before reading this documentation. To refresh your knowledge, please refer to the [**Angular documentation**](https://angular.io/docs). +::: + +DHTMLX Pivot is compatible with **Angular**. We have prepared code examples on how to use DHTMLX Pivot with **Angular**. For more information, refer to the corresponding [**Example on GitHub**](https://github.com/DHTMLX/angular-pivot-demo). + +## Creating a project + +:::info +Before you start to create a new project, install [**Angular CLI**](https://angular.io/cli) and [**Node.js**](https://nodejs.org/en/). +::: + +Create a new **my-angular-pivot-app** project using Angular CLI. Run the following command for this purpose: + +~~~json +ng new my-angular-pivot-app +~~~ + +:::note +If you want to follow this guide, disable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) when creating new Angular app! +::: + +The command above installs all the necessary tools, so you don't need to run any additional commands. + +### Installation of dependencies + +Go to the new created app directory: + +~~~json +cd my-angular-pivot-app +~~~ + +Install dependencies and start the dev server. For this, use the [**yarn**](https://yarnpkg.com/) package manager: + +~~~jsx +yarn +yarn start // or yarn dev +~~~ + +The app should run on a localhost (for instance `http://localhost:3000`). + +## Creating Pivot + +Now you should get the DHTMLX Pivot source code. First of all, stop the app and proceed with installing the Pivot package. + +### Step 1. Package installation + +Download the [**trial Pivot package**](/how-to-start/#installing-trial-pivot-via-npm-and-yarn) and follow steps mentioned in the README file. Note that trial Pivot is available 30 days only. + +### Step 2. Component creation + +Now you need to create an Angular component, to add Pivot into the application. Create the **pivot** folder in the ***src/app/*** directory, add a new file into it and name it ***pivot.component.ts***. Then complete the steps described below. + +#### Import source files + +Open the file and import Pivot source files. Note that: + +- if you use PRO version and install the Pivot package from a local folder, the imported path looks like this: + +~~~jsx +import { Pivot } from 'dhx-pivot-package'; +~~~ + +- if you use the trial version of Pivot, specify the following path: + +~~~jsx +import { Pivot } from '@dhx/trial-pivot'; +~~~ + +In this tutorial you can see how to configure the **trial** version of Pivot. + +#### Set the container and initialize Pivot + +To display Pivot on the page, you need to set the container to render the component inside and initialize Pivot using the corresponding constructor: + +~~~jsx {1,8,12-13,18-19} title="pivot.component.ts" +import { Pivot } from '@dhx/trial-pivot'; +import { Component, ElementRef, OnInit, ViewChild, OnDestroy, ViewEncapsulation } from '@angular/core'; + +@Component({ + encapsulation: ViewEncapsulation.None, + selector: "pivot", // a template name used in the "app.component.ts" file as + styleUrls: ["./pivot.component.css"], // include a css file + template: `
`, +}) + +export class PivotComponent implements OnInit, OnDestroy { + // initialize container for Pivot + @ViewChild('container', { static: true }) pivot_container!: ElementRef; + + private _table!: Pivot; + + ngOnInit() { + // initialize the Pivot component + this._table = new Pivot(this.pivot_container.nativeElement, {}); + } + + ngOnDestroy(): void { + this._table.destructor(); // destruct Pivot + } +} +~~~ + +#### Adding styles + +To display Pivot correctly, you need to provide the corresponding styles. For this purpose, you can create the ***pivot.component.css*** file in the ***src/app/pivot/*** directory and specify important styles for Pivot and its container: + +~~~css title="pivot.component.css" +/* import Pivot styles */ +@import "@dhx/trial-pivot/dist/pivot.css"; + +/* specify styles for initial page */ +html, +body { + margin: 0; + padding: 0; + height: 100%; +} + +/* specify styles for the Pivot container */ +.widget { + width: 100%; + height: 100%; +} +~~~ + +#### Loading data + +To add data into Pivot, you need to provide a data set. You can create the ***data.ts*** file in the ***src/app/pivot/*** directory and add some data into it: + +~~~jsx title="data.ts" +export function getData() { + const dataset = [ + { + "cogs": 51, + "date": "10/1/2018", + "inventory_margin": 503, + "margin": 71, + "market_size": "Major Market", + "market": "Central", + "marketing": 46, + "product_line": "Leaves", + "product_type": "Herbal Tea", + "product": "Lemon", + "profit": -5, + "sales": 122, + "state": "Colorado", + "expenses": 76, + "type": "Decaf" + }, + { + "cogs": 52, + "date": "10/1/2018", + "inventory_margin": 405, + "margin": 71, + "market_size": "Major Market", + "market": "Central", + "marketing": 17, + "product_line": "Leaves", + "product_type": "Herbal Tea", + "product": "Mint", + "profit": 26, + "sales": 123, + "state": "Colorado", + "expenses": 45, + "type": "Decaf" + }, // othe data items + ]; + + const fields: any = [ + { + "id": "cogs", + "label": "Cogs", + "type": "number" + }, + { + "id": "date", + "label": "Date", + "type": "date" + }, // other fields + ]; + + return { dataset, fields }; +}; +~~~ + +Then open the ***pivot.component.ts*** file. Import the file with data and specify the corresponding data properties to the configuration object of Pivot within the `ngOnInit()` method, as shown below. + +~~~jsx {2,18,20-21} title="pivot.component.ts" +import { Pivot } from '@dhx/trial-pivot'; +import { getData } from "./data"; // import data +import { Component, ElementRef, OnInit, ViewChild, OnDestroy, ViewEncapsulation } from '@angular/core'; + +@Component({ + encapsulation: ViewEncapsulation.None, + selector: "pivot", + styleUrls: ["./pivot.component.css"], + template: `
`, +}) + +export class PivotComponent implements OnInit, OnDestroy { + @ViewChild('container', { static: true }) pivot_container!: ElementRef; + + private _table!: Pivot; + + ngOnInit() { + const { dataset, fields } = getData(); // initialize data properties + this._table = new Pivot(this.pivot_container.nativeElement, { + fields, + data: dataset, + config: { + rows: ["state", "product_type"], + columns: ["product_line", "type"], + values: [ + { + field: "profit", + method: "sum" + }, // other values + ] + }, + // other configuration properties + }); + } + + ngOnDestroy(): void { + this._table.destructor(); + } +} +~~~ + +Now the Pivot component is ready to use. When the element will be added to the page, it will initialize the Pivot with data. You can provide necessary configuration settings as well. Visit our [Pivot API docs](/api/overview/properties-overview/) to check the full list of available properties. + +#### Handling events + +When a user makes some action in the Pivot, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](/api/overview/events-overview/). + +Open the ***pivot.component.ts*** file and complete the `ngOnInit()` method as in: + +~~~jsx {18-20} title="pivot.component.ts" +// ... +ngOnInit() { + this._table = new Pivot(this.pivot_container.nativeElement, { + fields, + data: dataset, + config: { + rows: ["state", "product_type"], + columns: ["product_line", "type"], + values: [ + { + field: "profit", + method: "sum" + }, // other values + ] + } + }); + + this._table.api.on("open-filter", (ev) => { + console.log("The field id for which filter is activated:", ev.id); + }); +} + +ngOnDestroy(): void { + this._table.destructor(); +} +~~~ + +### Step 3. Adding Pivot into the app + +To add the ***PivotComponent*** into the app, open the ***src/app/app.component.ts*** file and replace the default code with the following one: + +~~~jsx {5} title="app.component.ts" +import { Component } from "@angular/core"; + +@Component({ + selector: "app-root", + template: `` // a template created in the "pivot.component.ts" file +}) +export class AppComponent { + name = ""; +} +~~~ + +Then create the ***app.module.ts*** file in the ***src/app/*** directory and specify the *PivotComponent* as shown below: + +~~~jsx {4-5,8} title="app.module.ts" +import { NgModule } from "@angular/core"; +import { BrowserModule } from "@angular/platform-browser"; + +import { AppComponent } from "./app.component"; +import { PivotComponent } from "./pivot/pivot.component"; + +@NgModule({ + declarations: [AppComponent, PivotComponent], + imports: [BrowserModule], + bootstrap: [AppComponent] +}) +export class AppModule {} +~~~ + +The last step is to open the ***src/main.ts*** file and replace the existing code with the following one: + +~~~jsx title="main.ts" +import { platformBrowserDynamic } from "@angular/platform-browser-dynamic"; +import { AppModule } from "./app/app.module"; +platformBrowserDynamic() + .bootstrapModule(AppModule) + .catch((err) => console.error(err)); +~~~ + +After that, you can start the app to see Pivot loaded with data on a page. + +![Pivot initialization](../assets/trial_pivot.png) + +Now you know how to integrate DHTMLX Pivot with Angular. You can customize the code according to your specific requirements. The final example you can find on [**GitHub**](https://github.com/DHTMLX/angular-pivot-demo). diff --git a/docs/guides/integration-with-react.md b/docs/guides/integration-with-react.md new file mode 100644 index 0000000..f3d66df --- /dev/null +++ b/docs/guides/integration-with-react.md @@ -0,0 +1,285 @@ +--- +sidebar_label: Integration with React +title: Integration with React +description: You can learn about the integration with React in the documentation of the DHTMLX JavaScript Pivot library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Pivot. +--- + +# Integration with React + +:::tip +You should be familiar with the basic concepts and patterns of [**React**](https://react.dev) before reading this documentation. To refresh your knowledge, please refer to the [**React documentation**](https://reactjs.org/docs/getting-started.html). +::: + +DHTMLX Pivot is compatible with **React**. We have prepared code examples on how to use DHTMLX Pivot with **React**. For more information, refer to the corresponding [**Example on GitHub**](https://github.com/DHTMLX/react-pivot-demo). + +## Creating a project + +:::info +Before you start to create a new project, install [**Vite**](https://vitejs.dev/) (optional) and [**Node.js**](https://nodejs.org/en/). +::: + +You can create a basic **React** project or use **React with Vite**. Let's name the project as **my-react-pivot-app**: + +~~~json +npx create-react-app my-react-pivot-app +~~~ + +### Installation of dependencies + +Go to the new created app directory: + +~~~json +cd my-react-pivot-app +~~~ + +Install dependencies and start the dev server. For this, use a package manager: + +- if you use [**yarn**](https://yarnpkg.com/), run the following commands: + +~~~jsx +yarn +yarn start // or yarn dev +~~~ + +- if you use [**npm**](https://www.npmjs.com/), run the following commands: + +~~~json +npm install +npm run dev +~~~ + +The app should run on a localhost (for instance `http://localhost:3000`). + +## Creating Pivot + +Now you should get the DHTMLX Pivot source code. First of all, stop the app and proceed with installing the Pivot package. + +### Step 1. Package installation + +Download the [**trial Pivot package**](/how-to-start/#installing-trial-pivot-via-npm-and-yarn) and follow steps mentioned in the README file. Note that trial Pivot is available 30 days only. + +### Step 2. Component creation + +Now you need to create a React component, to add a Pivot into the application. Create a new file in the ***src/*** directory and name it ***Pivot.jsx***. + +#### Import source files + +Open the ***Pivot.jsx*** file and import Pivot source files. Note that: + +- if you use PRO version and install the Pivot package from a local folder, the import paths look like this: + +~~~jsx title="Pivot.jsx" +import { Pivot } from 'dhx-pivot-package'; +import 'dhx-pivot-package/dist/pivot.css'; +~~~ + +Note that depending on the used package, the source files can be minified. In this case make sure that you are importing the CSS file as ***pivot.min.css***. + +- if you use the trial version of Pivot, specify the following paths: + +~~~jsx title="Pivot.jsx" +import { Pivot } from '@dhx/trial-pivot'; +import "@dhx/trial-pivot/dist/pivot.css"; +~~~ + +In this tutorial you can see how to configure the **trial** version of Pivot. + +#### Setting the container and adding Pivot + +To display Pivot on the page, you need to create the container for Pivot, and initialize this component using the corresponding constructor: + +~~~jsx {2,6,9-10} title="Pivot.jsx" +import { useEffect, useRef } from "react"; +import { Pivot } from "@dhx/trial-pivot"; +import "@dhx/trial-pivot/dist/pivot.css"; // include Pivot styles + +export default function PivotComponent(props) { + let container = useRef(); // initialize container for Pivot + + useEffect(() => { + // initialize the Pivot component + const table = new Pivot(container.current, {}); + + return () => { + table.destructor(); // destruct Pivot + }; + }, []); + + return
; +} +~~~ + +#### Adding styles + +To display Pivot correctly, you need to specify important styles for Pivot and its container in the main css file of the project: + +~~~css title="index.css" +/* specify styles for initial page */ +html, +body, +#root { + height: 100%; + padding: 0; + margin: 0; +} + +/* specify styles for the Pivot container */ +.widget { + height: 100%; + width: 100%; +} +~~~ + +#### Loading data + +To add data into the Pivot, you need to provide a data set. You can create the ***data.js*** file in the ***src/*** directory and add some data into it: + +~~~jsx title="data.js" +export function getData() { + const dataset = [ + { + "cogs": 51, + "date": "10/1/2018", + "inventory_margin": 503, + "margin": 71, + "market_size": "Major Market", + "market": "Central", + "marketing": 46, + "product_line": "Leaves", + "product_type": "Herbal Tea", + "product": "Lemon", + "profit": -5, + "sales": 122, + "state": "Colorado", + "expenses": 76, + "type": "Decaf" + }, + { + "cogs": 52, + "date": "10/1/2018", + "inventory_margin": 405, + "margin": 71, + "market_size": "Major Market", + "market": "Central", + "marketing": 17, + "product_line": "Leaves", + "product_type": "Herbal Tea", + "product": "Mint", + "profit": 26, + "sales": 123, + "state": "Colorado", + "expenses": 45, + "type": "Decaf" + }, // othe data items + ]; + + const fields = [ + { + "id": "cogs", + "label": "Cogs", + "type": "number" + }, + { + "id": "date", + "label": "Date", + "type": "date" + }, // other fields + ]; + + return { dataset, fields }; +}; +~~~ + +Then open the ***App.js*** file and import data. After this you can pass data into the new created `` components as **props**: + +~~~jsx {2,5-6} title="App.js" +import Pivot from "./Pivot"; +import { getData } from "./data"; + +function App() { + const { fields, dataset } = getData(); + return ; +} + +export default App; +~~~ + +Go to the ***Pivot.jsx*** file and apply the passed **props** to the Pivot configuration object: + +~~~jsx {5,10-11} title="Pivot.jsx" +import { useEffect, useRef } from "react"; +import { Pivot } from "@dhx/trial-pivot"; +import "@dhx/trial-pivot/dist/pivot.css"; + +export default function PivotComponent(props) { + let container = useRef(); + + useEffect(() => { + const table = new Pivot(container.current, { + fields, + data: dataset, + config: { + rows: ["state", "product_type"], + columns: ["product_line", "type"], + values: [ + { + field: "profit", + method: "sum" + }, // other values + ] + }, + // other configuration properties + }); + + return () => { + table.destructor(); + } + }, []); + + return
; +} +~~~ + +Now the Pivot component is ready to use. When the element will be added to the page, it will initialize the Pivot with data. You can provide necessary configuration settings as well. Visit our [Pivot API docs](/api/overview/properties-overview/) to check the full list of available properties. + +#### Handling events + +When a user makes some action in the Pivot, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](/api/overview/events-overview/). + +Open ***Pivot.jsx*** and complete the `useEffect()` method in the following way: + +~~~jsx {19-21} title="Pivot.jsx" +// ... +useEffect(() => { + const table = new Pivot(container.current, { + fields, + data: dataset, + config: { + rows: ["state", "product_type"], + columns: ["product_line", "type"], + values: [ + { + field: "profit", + method: "sum" + }, // other values + ] + }, + // other configuration properties + }); + + table.api.on("open-filter", (ev) => { + console.log("The field id for which filter is activated:", ev.id); + }); + + return () => { + table.destructor(); + } +}, []); +// ... +~~~ + +After that, you can start the app to see Pivot loaded with data on a page. + +![Pivot initialization](../assets/trial_pivot.png) + +Now you know how to integrate DHTMLX Pivot with React. You can customize the code according to your specific requirements. The final example you can find on [**GitHub**](https://github.com/DHTMLX/react-pivot-demo). diff --git a/docs/guides/integration-with-svelte.md b/docs/guides/integration-with-svelte.md new file mode 100644 index 0000000..651f14d --- /dev/null +++ b/docs/guides/integration-with-svelte.md @@ -0,0 +1,300 @@ +--- +sidebar_label: Integration with Svelte +title: Integration with Svelte +description: You can learn about the integration with Svelte in the documentation of the DHTMLX JavaScript Pivot library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Pivot. +--- + +# Integration with Svelte + +:::tip +You should be familiar with the basic concepts and patterns of **Svelte** before reading this documentation. To refresh your knowledge, please refer to the [**Svelte documentation**](https://svelte.dev/). +::: + +DHTMLX Pivot is compatible with **Svelte**. We have prepared code examples on how to use DHTMLX Pivot with **Svelte**. For more information, refer to the corresponding [**Example on GitHub**](https://github.com/DHTMLX/svelte-pivot-demo). + +## Creating a project + +:::info +Before you start to create a new project, install [**Vite**](https://vitejs.dev/) (optional) and [**Node.js**](https://nodejs.org/en/). +::: + +To create a **Svelte** JS project, run the following command: + +~~~json +npm create vite@latest +~~~ + +Let's name the project as **my-svelte-pivot-app**. + +### Installation of dependencies + +Go to the app directory: + +~~~json +cd my-svelte-pivot-app +~~~ + +Install dependencies and start the dev server. For this, use a package manager: + +- if you use [**yarn**](https://yarnpkg.com/), run the following commands: + +~~~jsx +yarn +yarn start // or yarn dev +~~~ + +- if you use [**npm**](https://www.npmjs.com/), run the following commands: + +~~~json +npm install +npm run dev +~~~ + +The app should run on a localhost (for instance `http://localhost:3000`). + +## Creating Pivot + +Now you should get the DHTMLX Pivot source code. First of all, stop the app and proceed with installing the Pivot package. + +### Step 1. Package installation + +Download the [**trial Pivot package**](/how-to-start/#installing-trial-pivot-via-npm-and-yarn) and follow steps mentioned in the README file. Note that trial Pivot is available 30 days only. + +### Step 2. Component creation + +Now you need to create a Svelte component, to add Pivot into the application. Let's create a new file in the ***src/*** directory and name it ***Pivot.svelte***. + +#### Import source files + +Open the ***Pivot.svelte*** file and import Pivot source files. Note that: + +- if you use PRO version and install the Pivot package from a local folder, the import paths look like this: + +~~~html title="Pivot.svelte" + +~~~ + +Note that depending on the used package, the source files can be minified. In this case make sure that you are importing the CSS file as ***pivot.min.css***. + +- if you use the trial version of Pivot, specify the following paths: + +~~~html title="Pivot.svelte" + +~~~ + +In this tutorial you can see how to configure the **trial** version of Pivot. + +#### Setting the container and adding Pivot + +To display Pivot on the page, you need to create the container for Pivot, and initialize this component using the corresponding constructor: + +~~~html {3,6,10-11,19} title="Pivot.svelte" + + +
+~~~ + +#### Adding styles + +To display Pivot correctly, you need to specify important styles for Pivot and its container in the main css file of the project: + +~~~css title="main.css" +/* specify styles for initial page */ +html, +body, +#app { /* make sure that you use the #app root container */ + height: 100%; + padding: 0; + margin: 0; +} + +/* specify styles for the Pivot container */ +.widget { + height: 100%; + width: 100%; +} +~~~ + +#### Loading data + +To add data into the Pivot, we need to provide a data set. You can create the ***data.js*** file in the ***src/*** directory and add some data into it: + +~~~jsx title="data.js" +export function getData() { + const dataset = [ + { + "cogs": 51, + "date": "10/1/2018", + "inventory_margin": 503, + "margin": 71, + "market_size": "Major Market", + "market": "Central", + "marketing": 46, + "product_line": "Leaves", + "product_type": "Herbal Tea", + "product": "Lemon", + "profit": -5, + "sales": 122, + "state": "Colorado", + "expenses": 76, + "type": "Decaf" + }, + { + "cogs": 52, + "date": "10/1/2018", + "inventory_margin": 405, + "margin": 71, + "market_size": "Major Market", + "market": "Central", + "marketing": 17, + "product_line": "Leaves", + "product_type": "Herbal Tea", + "product": "Mint", + "profit": 26, + "sales": 123, + "state": "Colorado", + "expenses": 45, + "type": "Decaf" + }, // othe data items + ]; + + const fields = [ + { + "id": "cogs", + "label": "Cogs", + "type": "number" + }, + { + "id": "date", + "label": "Date", + "type": "date" + }, // other fields + ]; + + return { dataset, fields }; +}; +~~~ + +Then open the ***App.svelte*** file, import data, and pass it into the new created `` components as **props**: + +~~~html {3,5,8} title="App.svelte" + + + +~~~ + +Go to the ***Pivot.svelte*** file and apply the passed **props** to the Pivot configuration object: + +~~~html {6-7,14-15} title="Pivot.svelte" + + +
+~~~ + +Now the Pivot component is ready to use. When the element will be added to the page, it will initialize the Pivot with data. You can provide necessary configuration settings as well. Visit our [Pivot API docs](/api/overview/properties-overview/) to check the full list of available properties. + +#### Handling events + +When a user makes some action in the Pivot, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](/api/overview/events-overview/). + +Open ***Pivot.svelte*** and complete the `onMount()` method in the following way: + +~~~html {22-24} title="Pivot.svelte" + + +// ... +~~~ + +After that, you can start the app to see Pivot loaded with data on a page. + +![Pivot initialization](../assets/trial_pivot.png) + +Now you know how to integrate DHTMLX Pivot with Svelte. You can customize the code according to your specific requirements. The final example you can find on [**GitHub**](https://github.com/DHTMLX/svelte-pivot-demo). diff --git a/docs/guides/integration-with-vue.md b/docs/guides/integration-with-vue.md new file mode 100644 index 0000000..7eeef55 --- /dev/null +++ b/docs/guides/integration-with-vue.md @@ -0,0 +1,310 @@ +--- +sidebar_label: Integration with Vue +title: Integration with Vue +description: You can learn about the integration with Vue in the documentation of the DHTMLX JavaScript Pivot library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Pivot. +--- + +# Integration with Vue + +:::tip +You should be familiar with the basic concepts and patterns of [**Vue**](https://vuejs.org/) before reading this documentation. To refresh your knowledge, please refer to the [**Vue 3 documentation**](https://v3.vuejs.org/guide/introduction.html#getting-started). +::: + +DHTMLX Pivot is compatible with **Vue**. We have prepared code examples on how to use DHTMLX Pivot with **Vue 3**. For more information, refer to the corresponding [**Example on GitHub**](https://github.com/DHTMLX/vue-pivot-demo). + +## Creating a project + +:::info +Before you start to create a new project, install [**Node.js**](https://nodejs.org/en/). +::: + +To create a **Vue** project, run the following command: + +~~~json +npm create vue@latest +~~~ + +This command installs and executes `create-vue`, the official **Vue** project scaffolding tool. Check the details in the [Vue.js Quick Start](https://vuejs.org/guide/quick-start.html#creating-a-vue-application). + +Let's name the project as **my-vue-pivot-app**. + +### Installation of dependencies + +Go to the app directory: + +~~~json +cd my-vue-pivot-app +~~~ + +Install dependencies and start the dev server. For this, use a package manager: + +- if you use [**yarn**](https://yarnpkg.com/), run the following commands: + +~~~jsx +yarn +yarn start // or yarn dev +~~~ + +- if you use [**npm**](https://www.npmjs.com/), run the following commands: + +~~~json +npm install +npm run dev +~~~ + +The app should run on a localhost (for instance `http://localhost:3000`). + +## Creating Pivot + +Now you should get the DHTMLX Pivot source code. First of all, stop the app and proceed with installing the Pivot package. + +### Step 1. Package installation + +Download the [**trial Pivot package**](/how-to-start/#installing-trial-pivot-via-npm-and-yarn) and follow steps mentioned in the README file. Note that trial Pivot is available 30 days only. + +### Step 2. Component creation + +Now you need to create a Vue component, to add Pivot into the application. Create a new file in the ***src/components/*** directory and name it ***Pivot.vue***. + +#### Import source files + +Open the ***Pivot.vue*** file and import Pivot source files. Note that: + +- if you use PRO version and install the Pivot package from a local folder, the import paths look like this: + +~~~html title="Pivot.vue" + +~~~ + +Note that depending on the used package, the source files can be minified. In this case make sure that you are importing the CSS file as ***pivot.min.css***. + +- if you use the trial version of Pivot, specify the following paths: + +~~~html title="Pivot.vue" + + + +~~~ + +#### Adding styles + +To display Pivot correctly, you need to specify important styles for Pivot and its container in the main css file of the project: + +~~~css title="style.css" +/* specify styles for initial page */ +html, +body, +#app { /* make sure that you use the #app root container */ + height: 100%; + padding: 0; + margin: 0; +} + +/* specify styles for the Pivot container */ +.widget { + width: 100%; + height: 100%; +} +~~~ + +#### Loading data + +To add data into the Pivot, you need to provide a data set. You can create the ***data.js*** file in the ***src/*** directory and add some data into it: + +~~~jsx title="data.js" +export function getData() { + const dataset = [ + { + "cogs": 51, + "date": "10/1/2018", + "inventory_margin": 503, + "margin": 71, + "market_size": "Major Market", + "market": "Central", + "marketing": 46, + "product_line": "Leaves", + "product_type": "Herbal Tea", + "product": "Lemon", + "profit": -5, + "sales": 122, + "state": "Colorado", + "expenses": 76, + "type": "Decaf" + }, + { + "cogs": 52, + "date": "10/1/2018", + "inventory_margin": 405, + "margin": 71, + "market_size": "Major Market", + "market": "Central", + "marketing": 17, + "product_line": "Leaves", + "product_type": "Herbal Tea", + "product": "Mint", + "profit": 26, + "sales": 123, + "state": "Colorado", + "expenses": 45, + "type": "Decaf" + }, // othe data items + ]; + + const fields = [ + { + "id": "cogs", + "label": "Cogs", + "type": "number" + }, + { + "id": "date", + "label": "Date", + "type": "date" + }, // other fields + ]; + + return { dataset, fields }; +}; +~~~ + +Then open the ***App.vue*** file, import data, and initialize it via the inner `data()` method. After this you can pass data into the new created `` component as **props**: + +~~~html {3,7-13,18} title="App.vue" + + + +~~~ + +Go to the ***Pivot.vue*** file and apply the passed **props** to the Pivot configuration object: + +~~~html {6,10-11} title="Pivot.vue" + + + +~~~ + +Now the Pivot component is ready to use. When the element will be added to the page, it will initialize the Pivot with data. You can provide necessary configuration settings as well. Visit our [Pivot API docs](/api/overview/properties-overview/) to check the full list of available properties. + +#### Handling events + +When a user makes some action in the Pivot, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](/api/overview/events-overview/). + +Open ***Pivot.vue*** and complete the `mounted()` method: + +~~~html {22-24} title="Pivot.vue" + + +// ... +~~~ + +After that, you can start the app to see Pivot loaded with data on a page. + +![Pivot initialization](../assets/trial_pivot.png) + +Now you know how to integrate DHTMLX Pivot with Vue. You can customize the code according to your specific requirements. The final example you can find on [**GitHub**](https://github.com/DHTMLX/vue-pivot-demo). diff --git a/docs/how-to-start.md b/docs/how-to-start.md index 2247239..02b7f27 100644 --- a/docs/how-to-start.md +++ b/docs/how-to-start.md @@ -16,13 +16,17 @@ This clear and comprehensive tutorial will guide your through the steps you need You can import JavaScript Pivot into your project using `yarn` or `npm` package manager. -#### Installing trial Pivot via npm and yarn +:::info +If you want to integrate Pivot into React, Angular, Svelte or Vue projects, refer to the corresponding [**integration guides**](/category/integration-with-frameworks/) for more information. +::: + +### Installing trial Pivot via npm and yarn :::info -If you want to use trial version of Pivot, download the trial [Pivot package](https://dhtmlx.com/docs/products/dhtmlxPivot/download.shtml) and follow the steps mentioned in the *README* file. Note that trial Pivot is available for 30 days only. +If you want to use trial version of Pivot, download the [**trial Pivot package**](https://dhtmlx.com/docs/products/dhtmlxPivot/download.shtml) and follow the steps mentioned in the *README* file. Note that trial Pivot is available for 30 days only. ::: -#### Installing PRO Pivot via npm and yarn +### Installing PRO Pivot via npm and yarn :::info If you have already purchased Pivot under the proprietary license, send your **license number** to the *contact@dhtmlx.com* email in order to receive *login* and *password* for private **npm** as well as detailed guide on how to install Pivot. Note that private **npm** is available before the expiration of the proprietary Pivot license. @@ -53,13 +57,9 @@ There are two necessary files: ~~~ -:::tip -If you want to integrate JavaScript Pivot into React, Angular or Vue projects, refer to the corresponding [**Examples on CodeSandbox**](https://codesandbox.io/u/DHTMLX) for more information. -::: - ## Step 3. Creating Pivot -Now you are ready to add Pivot to the page. First, let's create the DIV container for Pivot. +Now you are ready to add Pivot to the page. First, let's create the DIV container for Pivot. ~~~html {} title="index.html" @@ -92,7 +92,7 @@ To start working with Pivot, first you need to provide the initial data. The exa The **fields** array is necessary to define the fields IDs, labels for display, and data types. -The **data** array should hold the actual data that is displayed in the Pivot widget. Each object in the array represents a row in the table. +The **data** array should hold the actual data that is displayed in the Pivot widget. Each object in the array represents a row in the table. The **config** object defines the structure of the Pivot table, namely, which fields will be applied as rows and columns of the table and which data aggregation methods should be applied to the fields. diff --git a/docs/news/whats-new.md b/docs/news/whats-new.md index e11c51f..33adf9f 100644 --- a/docs/news/whats-new.md +++ b/docs/news/whats-new.md @@ -6,6 +6,17 @@ description: You can explore what's new in DHTMLX Pivot and its release history # What's new +If you are updating Pivot from an older version, check [Migration to newer versions](news/migration.md) for details. + +## Version 2.0.2 + +Released on October 22, 2024 + +### Fixes + +- `columnShape` type definition +- correct package contents + ## Version 2.0 Released on August 26, 2024 @@ -42,4 +53,4 @@ For tips about migration to the new version, check the [Migration](/news/migrati - [processing data with predicates](/guides/working-with-data#processing-data-with-predicates) - applying custom pre-processing functions for data - [setting date format via locale](/guides/loading-exporting-data#setting-date-format) - New methods are added: [`getTable()`](/api/methods/gettable-method), [`setConfig()`](/api/methods/setconfig-method), [`setLocale()`](/api/methods/setlocale-method), [`showConfigPanel()`](/api/methods/showconfigpanel-method) -- New events are added: [`add-field`](/api/events/add-field-event), [`delete-field`](/api/events/delete-field-event), [`open-filter`](/api/events/open-filter-event), [`render-table`](/api/events/render-table-event), [`reorder-fields`](/api/events/reorder-fields-event), [`show-config-panel`](/api/events/show-config-panel-event), [`show-config-panel`](/api/events/show-config-panel-event), [`update-config`](/api/events/update-config-event), [`update-value`](/api/events/update-value-event). +- New events are added: [`add-field`](/api/events/add-field-event), [`delete-field`](/api/events/delete-field-event), [`open-filter`](/api/events/open-filter-event), [`render-table`](/api/events/render-table-event), [`move-field`](/api/events/move-field-event), [`show-config-panel`](/api/events/show-config-panel-event), [`show-config-panel`](/api/events/show-config-panel-event), [`update-config`](/api/events/update-config-event), [`update-value`](/api/events/update-value-event). diff --git a/sidebars.js b/sidebars.js index 417f4e8..08878e4 100644 --- a/sidebars.js +++ b/sidebars.js @@ -149,6 +149,24 @@ module.exports = { } ] }, + //start Framework integration + { + type: "category", + label: "Integration with frameworks", + link: { + type: 'generated-index', + title: "Integration with frameworks", + keywords: ['integration with frameworks'], + image: '/img/docusaurus.png' + }, + items: [ + "guides/integration-with-angular", + "guides/integration-with-react", + "guides/integration-with-vue", + "guides/integration-with-svelte" + ] + }, + // end Framework integration { type: "category", label: "Guides",