into which the plot is rendered |
| [debug] | Boolean | false | Assign the graph div to window.gd for debugging |
| [useResizeHandler] | Boolean | false | When true, adds a call to Plotly.Plot.resize() as a window.resize event handler |

Note: To make a plot responsive, i.e. to fill its containing element and resize when the window is resized, use style or className to set the dimensions of the element (i.e. using width: 100%; height: 100% or some similar values) and set useResizeHandler to true while setting layout.autosize to true and leaving layout.height and layout.width undefined. This will implement the behaviour documented here: https://plot.ly/javascript/responsive-fluid-layout/

`typescript
@Component({
selector: 'plotly-example',
template:
[useResizeHandler]="true" [style]="{position: 'relative', width: '100%', height: '100%'}">
,
})
export class PlotlyExampleComponent {
public graph = {
data: [{ x: [1, 2, 3], y: [2, 5, 3], type: 'bar' }],
layout: {autosize: true, title: 'A Fancy Plot'},
};
}
`

$3

Event handlers for specific plotly.js events may be attached through the following props:

| Prop | Type | Plotly Event | Obs |
| ------------------------- | ---------- | ------------------------------ | --- |
| (afterExport) | Function | plotly_afterexport | |
| (afterPlot) | Function | plotly_afterplot | |
| (animated) | Function | plotly_animated | |
| (animatingFrame) | Function | plotly_animatingframe | |
| (animationInterrupted) | Function | plotly_animationinterrupted | |
| (autoSize) | Function | plotly_autosize | |
| (beforeExport) | Function | plotly_beforeexport | |
| (buttonClicked) | Function | plotly_buttonclicked | |
| (plotlyClick) | Function | plotly_click | why not (click)? |
| (clickAnnotation) | Function | plotly_clickannotation | |
| (deselect) | Function | plotly_deselect | |
| (doubleClick) | Function | plotly_doubleclick | |
| (framework) | Function | plotly_framework | |
| (hover) | Function | plotly_hover | |
| (legendClick) | Function | plotly_legendclick | |
| (legendDoubleClick) | Function | plotly_legenddoubleclick | |
| (react) | Function | plotly_react | |
| (relayout) | Function | plotly_relayout | |
| (restyle) | Function | plotly_restyle | |
| (redraw) | Function | plotly_redraw | |
| (selected) | Function | plotly_selected | |
| (selecting) | Function | plotly_selecting | |
| (sliderChange) | Function | plotly_sliderchange | |
| (sliderEnd) | Function | plotly_sliderend | |
| (sliderStart) | Function | plotly_sliderstart | |
| (transitioning) | Function | plotly_transitioning | |
| (transitionInterrupted) | Function | plotly_transitioninterrupted | |
| (unhover) | Function | plotly_unhover | |
| (relayouting) | Function | plotly_relayouting | |
| (treemapclick) | Function | plotly_treemapclick | |
| (sunburstclick) | Function | plotly_sunburstclick | |

$3

\ component supports injection of user-defined contents:
`html

user-defined Angular template

`
will put the user template into the root \ of the resulting plotly.js plot,
in front of any plotly-generated elements. This could be useful for implementing plot overlays.




Customizing the plotly.js bundle

By default, this library bundles plotly.js from the peer dependency together within the output. This results on huge outputs, for plotly.js itself is ~3MB when bundled. It also makes the build (with ng serve --prod) really slow, for it minifies everything together.

If you wish to optimize loading plotly.js in a different way, please check both PlotlyViaCDNModule and PlotlyViaWindowModule modules below.




$3

If you want to load plotly.js from a CDN, use the PlotlyViaCDNModule and set on the version argument the plotly.js's version you want to use and, optionally, you can also set on the bundleName argument the plotly.js's build you want to use:

`typescript
import { NgModule } from '@angular/core';
import { CommonModule } from '@angular/common';

import { PlotlyViaCDNModule } from 'angular-plotly.js';


@NgModule({
imports: [
CommonModule,
PlotlyViaCDNModule.forRoot({
version: '1.55.2' // can be latest or any version number (i.e.: '1.40.0')
bundleName: 'basic' // optional: can be null (for full) or 'basic', 'cartesian', 'geo', 'gl3d', 'gl2d', 'mapbox' or 'finance'
}),
],
...
})
export class AppModule { }
`

By default, plotly's CDN is used to fetch the requested bundle.js. However, you can either choose plotly, cloudflare or custom.

`typescript
...

// For cloudflare
PlotlyViaCDNModule.forRoot({
version: '1.55.2',
cdnProvider: 'cloudflare', // cloudflare doesn't support latest. It is mandatory to supply version.
bundleName: 'basic' // optional: can be null (for full) or 'basic', 'cartesian', 'geo', 'gl3d', 'gl2d', 'mapbox' or 'finance'
});


// For custom CDN URL
PlotlyViaCDNModule.loadViaCDN('custom', );
PlotlyViaCDNModule.forRoot({
cdnProvider: 'custom', // cloudflare doesn't support latest. It is mandatory to supply version.
customUrl: 'https://custom.cdn/url' // can be used directly for any self hosted plotly bundle
});

...
`

$3

plotly.js can be added as a global script on angular.json to avoid it being bundled into the final project's code. To make this happen, you must first add plotly.js path into angular.json file as shown below:

`javascript
// angular.json
{
...
"projects": {
"project-name": { // This is your project's name
...
"architect": {
"build": {
...
"options": {
"scripts": [
"node_modules/plotly.js-dist-min/plotly.min.js" // add this
]
}
}
}
...
}
}
}
`

This will include plotly.js into the vendor.js file generated by angular CLI build process, and plotly.js library will be loaded before angular and your project's code. The window.Plotly will be available. Thus, you must use PlotlyViaWindowModule module to force angular-plotly.js to use window.Plotly object:


`typescript
import { NgModule } from '@angular/core';
import { CommonModule } from '@angular/common';

import { PlotlyViaWindowModule } from 'angular-plotly.js';

@NgModule({
imports: [CommonModule, PlotlyViaWindowModule],
...
})
export class AppModule { }
`

If you want to use a different precompiled bundle or if you wish to assemble you own customized bundle, you can use PlotlyViaWindowModule to force the use of window.Plotly object as shown above.

Development

To get started:

`bash
$ npm install
`

To see the demo app, run:

`bash
$ npm start
`

To run the tests:

`bash
$ npm run test
``

FAQ

Please, check the FAQ

License

© 2019 Plotly, Inc. MIT License.