Skip to content

ngx-d3 is a D3 wrapper service for Angular applications inspired by @tomwanzek/d3-ng2-service.

License

Notifications You must be signed in to change notification settings

simonegosetto/ngx-d3

Repository files navigation

Forked from https://gitlab.com/dmp-repo/js-pkg/ngx-d3

ngx-d3 is a D3 wrapper service for Angular applications inspired by @tomwanzek/d3-ng2-service.

Sadly, tomwanzek is no longer maintaining the project. The last push for his library was in April 2018 and the latest supported version of angular is Angular 5. The torch of keeping the package up to speed in terms of angular compatibility was then passed onto ZeevKats's @katze/ngx-d3 package, which kept the package updated up to angular 12, and finally to dmp's @d-m-p/ngx-d3 which kept it updated up to angular 16.

The package appears to be no longer maintained as it has now fallen behind a couple versions and I am taking over the mantle.


Installation

yarn add ngx-d3-wrapper

Usage

  • NgxD3Service: The Angular D3 Service injectable,
  • D3: A TypeScript type alias for the d3 variable which can be obtained from the NgxD3Service, and
  • the various TypeScript interfaces and type aliases which are related to the D3 modules constituting d3 as provided by this service (e.g. Selection, Transition, Axis).

To obtain the d3 object from an injected D3 service ngxD3Service: NgxD3Service, it offers a method ngxD3Service.getD3() with return type D3.


How to use

import { Component, OnInit } from '@angular/core';
import { NgxD3Service } from 'ngx-d3-wrapper';

@Component({
  selector: 'histogram-component',
  templateUrl: 'histogram-component.component.html',
  styleUrls: ['histogram-component.component.css']
})
export class HistogramComponent implements OnInit {
  private readonly d3 = this.ngxD3Service.getD3();

  constructor(private readonly ngxD3Service: NgxD3Service) {}

  ngOnInit() {
    this.d3.select(...)
    // ...
  }
}

Publishing

> rm -rf dist/ node_modules/ libs/ngx-d3/node_modules/
> npm run build -- -c production
> cd dist/libs/ngx-d3
> npm publish --access public

About

ngx-d3 is a D3 wrapper service for Angular applications inspired by @tomwanzek/d3-ng2-service.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published