3.0.0 • Published 3 years ago

@muros-ct/angular-plotly v3.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

angular-plotly.js

angular-plotly-logo

A plotly.js Angular component from Plotly.

CircleCI Coverage Status


Supports Angular 9.x and up. If you want to use with Angular 8.x, please use version angular-plotly.js@1.x.

Content

Installation

$ npm install angular-plotly.js plotly.js

Using the angular CLI to start a new project

$ ng new my-project
$ cd my-project
$ npm install angular-plotly.js plotly.js --save

Quick start

Add the PlotlyModule into the main app module of your project

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

import * as PlotlyJS from 'plotly.js/dist/plotly.js';
import { PlotlyModule } from 'angular-plotly.js.js';

PlotlyModule.plotlyjs = PlotlyJS;

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

Then use the <plotly-plot> component to display the graph

import { Component } from '@angular/core';

@Component({
    selector: 'plotly-example',
    template: '<plotly-plot [data]="graph.data" [layout]="graph.layout"></plotly-plot>',
})
export class PlotlyExampleComponent {
    public graph = {
        data: [
            { x: [1, 2, 3], y: [2, 6, 3], type: 'scatter', mode: 'lines+points', marker: {color: 'red'} },
            { x: [1, 2, 3], y: [2, 5, 3], type: 'bar' },
        ],
        layout: {width: 320, height: 240, title: 'A Fancy Plot'}
    };
}

You should see a plot like this:

For a full description of Plotly chart types and attributes see the following resources:

The plotly.js is bundled within the angular code. To avoid this, please read how to customize the plotlyjs bundle below.

API Reference

Basic Props

PropTypeDefaultDescription
[data]Array[]list of trace objects (see https://plot.ly/javascript/reference/)
[layout]Objectundefinedlayout object (see https://plot.ly/javascript/reference/#layout)
[frames]Arrayundefinedlist of frame objects (see https://plot.ly/javascript/reference/)
[config]Objectundefinedconfig object (see https://plot.ly/javascript/configuration-options/)
[revision]NumberundefinedWhen provided, causes the plot to update only when the revision is incremented.
[updateOnLayoutChange]BooleantrueFlag which determines if this component should watch to changes on layout property and update the graph.
[updateOnDataChange]BooleantrueFlag which determines if this component should watch to changes on data property and update the graph.
[updateOnlyWithRevision]BooleanfalseIf true, this component will update only when the property revision is increased.
(initialized)Function(figure, graphDiv)undefinedCallback executed after plot is initialized. See below for parameter information.
(update)Function(figure, graphDiv)undefinedCallback executed when when a plot is updated due to new data or layout, or when user interacts with a plot. See below for parameter information.
(purge)Function(figure, graphDiv)undefinedCallback executed when component unmounts, before Plotly.purge strips the graphDiv of all private attributes. See below for parameter information.
(error)Function(err)undefinedCallback executed when a plotly.js API method rejects
[divId]stringundefinedid assigned to the <div> into which the plot is rendered.
[className]stringundefinedapplied to the <div> into which the plot is rendered
[style]Object{position: 'relative', display: 'inline-block'}used to style the <div> into which the plot is rendered
[debug]BooleanfalseAssign the graph div to window.gd for debugging
[useResizeHandler]BooleanfalseWhen 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/

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

Event handler props

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

PropTypePlotly EventObs
(afterExport)Functionplotly_afterexport
(afterPlot)Functionplotly_afterplot
(animated)Functionplotly_animated
(animatingFrame)Functionplotly_animatingframe
(animationInterrupted)Functionplotly_animationinterrupted
(autoSize)Functionplotly_autosize
(beforeExport)Functionplotly_beforeexport
(buttonClicked)Functionplotly_buttonclicked
(plotlyClick)Functionplotly_clickwhy not (click)?
(clickAnnotation)Functionplotly_clickannotation
(deselect)Functionplotly_deselect
(doubleClick)Functionplotly_doubleclick
(framework)Functionplotly_framework
(hover)Functionplotly_hover
(legendClick)Functionplotly_legendclick
(legendDoubleClick)Functionplotly_legenddoubleclick
(react)Functionplotly_react
(relayout)Functionplotly_relayout
(restyle)Functionplotly_restyle
(redraw)Functionplotly_redraw
(selected)Functionplotly_selected
(selecting)Functionplotly_selecting
(sliderChange)Functionplotly_sliderchange
(sliderEnd)Functionplotly_sliderend
(sliderStart)Functionplotly_sliderstart
(transitioning)Functionplotly_transitioning
(transitionInterrupted)Functionplotly_transitioninterrupted
(unhover)Functionplotly_unhover
(relayouting)Functionplotly_relayouting
(treemapclick)Functionplotly_treemapclick
(sunburstclick)Functionplotly_sunburstclick

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.

Plotly Via CDN Module

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

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

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


PlotlyViaCDNModule.setPlotlyVersion('1.55.2'); // can be `latest` or any version number (i.e.: '1.40.0')
PlotlyViaCDNModule.setPlotlyBundle('basic'); // optional: can be null (for full) or 'basic', 'cartesian', 'geo', 'gl3d', 'gl2d', 'mapbox' or 'finance'

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

Plotly Via Window Module

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:

// angular.json
{
    ...
    "projects": {
        "project-name": { // This is your project's name
            ...
            "architect": {
                "build": {
                    ...
                    "options": {
                        "scripts": [
                            "node_modules/plotly.js/dist/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:

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

import { PlotlyViaWindowModule } from 'angular-plotly.js.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:

$ npm install

To see the demo app, run:

$ npm start

To run the tests:

$ npm run test

FAQ

Please, check the FAQ

License

© 2019 Plotly, Inc. MIT License.