From c81e7483b0667f76b89ca9bef8407fec2e183dab Mon Sep 17 00:00:00 2001 From: chad-ramos Date: Wed, 9 Oct 2024 10:00:01 -0500 Subject: [PATCH] Refactor file paths and imports in pioneer-charts library --- .vscode/settings.json | 2 +- .../src/app/charts/charts.component.ts | 4 +-- .../src/app/services/pc.repository.ts | 36 +++++++++---------- .../src/app/services/pc.service.ts | 36 +++++++++---------- .../src/app/test/test.component.ts | 13 ++++--- .../src/assets/mock/shared-config.json | 2 +- .../base-config/base-config.component.html | 2 +- .../charts/bar-chart/bar-chart.component.html | 4 +-- .../line-area-chart.component.html | 2 +- .../charts/pie-chart/pie-chart.component.html | 2 +- .../data-contract.component.html | 6 ++-- .../data-contract/data-contract.component.ts | 8 ++--- .../docs/guides/theme/theme.component.ts | 2 +- .../src/assets/mock/shared-config.json | 2 +- projects/pioneer-charts/ng-package.json | 4 +-- .../{public_api.ts => public-api.ts} | 0 .../{public_api.ts => public-api.ts} | 0 projects/pioneer-charts/src/lib/core/chart.ts | 2 +- projects/pioneer-charts/src/lib/core/index.ts | 2 +- .../lib/core/{public_api.ts => public-api.ts} | 0 .../{public_api.ts => public-api.ts} | 0 .../{public_api.ts => public-api.ts} | 0 projects/pioneer-charts/src/public-api.ts | 10 +++--- tsconfig.json | 3 -- 24 files changed, 72 insertions(+), 70 deletions(-) rename projects/pioneer-charts/src/lib/bar-chart/bar-horizontal-chart/{public_api.ts => public-api.ts} (100%) rename projects/pioneer-charts/src/lib/bar-chart/bar-vertical-chart/{public_api.ts => public-api.ts} (100%) rename projects/pioneer-charts/src/lib/core/{public_api.ts => public-api.ts} (100%) rename projects/pioneer-charts/src/lib/line-area-chart/{public_api.ts => public-api.ts} (100%) rename projects/pioneer-charts/src/lib/pie-chart/{public_api.ts => public-api.ts} (100%) diff --git a/.vscode/settings.json b/.vscode/settings.json index 281fe214..34caeff2 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -7,6 +7,6 @@ "files.exclude": { "**/.angular": true, "**/node_modules": true, - "**/dist": true, + "**/dist": tsrue, }, } \ No newline at end of file diff --git a/projects/pioneer-charts-dev/src/app/charts/charts.component.ts b/projects/pioneer-charts-dev/src/app/charts/charts.component.ts index bdf92660..ef6acaa2 100644 --- a/projects/pioneer-charts-dev/src/app/charts/charts.component.ts +++ b/projects/pioneer-charts-dev/src/app/charts/charts.component.ts @@ -1,5 +1,5 @@ import { Component, inject } from '@angular/core'; -import { IPcacData, PcacBarHorizontalChartComponent, PcacBarVerticalChartComponent, PcacLineAreaChartComponent, PcacPieChartComponent } from '@pioneer-code/pioneer-charts'; +import { PcacData, PcacBarHorizontalChartComponent, PcacBarVerticalChartComponent, PcacLineAreaChartComponent, PcacPieChartComponent } from '@pioneer-code/pioneer-charts'; import { PcService } from '../services/pc.service'; import { MatCardModule } from '@angular/material/card'; @@ -19,7 +19,7 @@ import { MatCardModule } from '@angular/material/card'; export class ChartsComponent { readonly service = inject(PcService) - onClicked(data: IPcacData) { + onClicked(data: PcacData) { alert(`Key: ${data.key} - Value: ${data.value}`); } } diff --git a/projects/pioneer-charts-dev/src/app/services/pc.repository.ts b/projects/pioneer-charts-dev/src/app/services/pc.repository.ts index a622624d..5cbd3f3b 100644 --- a/projects/pioneer-charts-dev/src/app/services/pc.repository.ts +++ b/projects/pioneer-charts-dev/src/app/services/pc.repository.ts @@ -1,11 +1,11 @@ import { Injectable } from '@angular/core'; import { HttpClient } from '@angular/common/http'; import { - IPcacLineAreaChartConfig, - IPcacData, - IPcacBarHorizontalChartConfig, - IPcacBarVerticalChartConfig, - IPcacPieChartConfig + PcacLineAreaChartConfig, + PcacData, + PcacBarHorizontalChartConfig, + PcacBarVerticalChartConfig, + PcacPieChartConfig } from '@pioneer-code/pioneer-charts'; @@ -20,60 +20,60 @@ export class PcRepository { * Bar Charts Horizontal */ getBarHorizontalChart() { - return this.http.get('./assets/mock/bar-charts/bar-horizontal-chart.json'); + return this.http.get('./assets/mock/bar-charts/bar-horizontal-chart.json'); } getBarHorizontalChartSingle() { - return this.http.get('./assets/mock/bar-charts/bar-horizontal-chart-single.json'); + return this.http.get('./assets/mock/bar-charts/bar-horizontal-chart-single.json'); } getBarHorizontalChartGroup() { - return this.http.get('./assets/mock/bar-charts/bar-horizontal-chart-group.json'); + return this.http.get('./assets/mock/bar-charts/bar-horizontal-chart-group.json'); } getBarHorizontalChartStacked() { - return this.http.get('./assets/mock/bar-charts/bar-horizontal-chart-stacked.json'); + return this.http.get('./assets/mock/bar-charts/bar-horizontal-chart-stacked.json'); } /** * Bar Charts Vertical */ getBarVerticalChart() { - return this.http.get('./assets/mock/bar-charts/bar-vertical-chart.json'); + return this.http.get('./assets/mock/bar-charts/bar-vertical-chart.json'); } getBarVerticalChartSingle() { - return this.http.get('./assets/mock/bar-charts/bar-vertical-chart-single.json'); + return this.http.get('./assets/mock/bar-charts/bar-vertical-chart-single.json'); } getBarVerticalChartGroup() { - return this.http.get('./assets/mock/bar-charts/bar-vertical-chart-group.json'); + return this.http.get('./assets/mock/bar-charts/bar-vertical-chart-group.json'); } getBarVerticalChartStacked() { - return this.http.get('./assets/mock/bar-charts/bar-vertical-chart-stacked.json'); + return this.http.get('./assets/mock/bar-charts/bar-vertical-chart-stacked.json'); } /** * Line Area Charts */ getLineChart() { - return this.http.get('./assets/mock/line-area-chart/line-chart-2.json'); + return this.http.get('./assets/mock/line-area-chart/line-chart-2.json'); } getAreaChart() { - return this.http.get('./assets/mock/line-area-chart/area-chart.json'); + return this.http.get('./assets/mock/line-area-chart/area-chart.json'); } getAreaHideChart() { - return this.http.get('./assets/mock/line-area-chart/area-chart-hide.json'); + return this.http.get('./assets/mock/line-area-chart/area-chart-hide.json'); } getPieChartConfig() { - return this.http.get('./assets/mock/pie-chart.json'); + return this.http.get('./assets/mock/pie-chart.json'); } getShareConfig() { - return this.http.get('./assets/mock/shared-config.json'); + return this.http.get('./assets/mock/shared-config.json'); } } diff --git a/projects/pioneer-charts-dev/src/app/services/pc.service.ts b/projects/pioneer-charts-dev/src/app/services/pc.service.ts index 0cce72b2..dc4f53da 100644 --- a/projects/pioneer-charts-dev/src/app/services/pc.service.ts +++ b/projects/pioneer-charts-dev/src/app/services/pc.service.ts @@ -1,10 +1,10 @@ import { Injectable } from '@angular/core'; import { - IPcacLineAreaChartConfig, - IPcacData, - IPcacBarVerticalChartConfig, - IPcacBarHorizontalChartConfig, - IPcacPieChartConfig, + PcacLineAreaChartConfig, + PcacData, + PcacBarVerticalChartConfig, + PcacBarHorizontalChartConfig, + PcacPieChartConfig, } from '@pioneer-code/pioneer-charts'; import { PcRepository } from './pc.repository'; @@ -13,19 +13,19 @@ import { PcRepository } from './pc.repository'; providedIn: 'root', }) export class PcService { - barVerticalChartConfig!: IPcacBarVerticalChartConfig; - barVerticalChartSingleConfig!: IPcacBarVerticalChartConfig; - barVerticalChartGroupConfig!: IPcacBarVerticalChartConfig; - barVerticalChartStackedConfig!: IPcacBarVerticalChartConfig; - barHorizontalChartConfig!: IPcacBarHorizontalChartConfig; - barHorizontalChartSingleConfig!: IPcacBarHorizontalChartConfig; - barHorizontalChartGroupConfig!: IPcacBarHorizontalChartConfig; - barHorizontalChartStackedConfig!: IPcacBarHorizontalChartConfig; - lineChartConfig!: IPcacLineAreaChartConfig; - areaChartConfig!: IPcacLineAreaChartConfig; - areaChartHideConfig!: IPcacLineAreaChartConfig; - pieChartConfig!: IPcacPieChartConfig; - sharedConfig = [] as IPcacData[]; + barVerticalChartConfig!: PcacBarVerticalChartConfig; + barVerticalChartSingleConfig!: PcacBarVerticalChartConfig; + barVerticalChartGroupConfig!: PcacBarVerticalChartConfig; + barVerticalChartStackedConfig!: PcacBarVerticalChartConfig; + barHorizontalChartConfig!: PcacBarHorizontalChartConfig; + barHorizontalChartSingleConfig!: PcacBarHorizontalChartConfig; + barHorizontalChartGroupConfig!: PcacBarHorizontalChartConfig; + barHorizontalChartStackedConfig!: PcacBarHorizontalChartConfig; + lineChartConfig!: PcacLineAreaChartConfig; + areaChartConfig!: PcacLineAreaChartConfig; + areaChartHideConfig!: PcacLineAreaChartConfig; + pieChartConfig!: PcacPieChartConfig; + sharedConfig = [] as PcacData[]; currentMainRoute = 'home'; currentDocRoute = 'bar-chart'; navDisplay = 'none'; diff --git a/projects/pioneer-charts-dev/src/app/test/test.component.ts b/projects/pioneer-charts-dev/src/app/test/test.component.ts index dd9115e1..8038063b 100644 --- a/projects/pioneer-charts-dev/src/app/test/test.component.ts +++ b/projects/pioneer-charts-dev/src/app/test/test.component.ts @@ -1,6 +1,6 @@ import { Component, inject } from '@angular/core'; import { PcService } from '../services/pc.service' -import { IPcacBarVerticalChartConfig, IPcacData, PcacBarVerticalChartComponent } from '@pioneer-code/pioneer-charts'; +import { PcacBarVerticalChartConfig, PcacData, PcacBarVerticalChartComponent, PcacFormatEnum, PcacBarVerticalChartColorOverrideConfig } from '@pioneer-code/pioneer-charts'; @Component({ selector: 'pc-test', @@ -13,17 +13,22 @@ import { IPcacBarVerticalChartConfig, IPcacData, PcacBarVerticalChartComponent } }) export class TestComponent { readonly service = inject(PcService) - data: IPcacBarVerticalChartConfig = { + data: PcacBarVerticalChartConfig = { "domainMax": 1000, "height": 200, "isStacked": false, + "tickFormat": PcacFormatEnum.None, + "spreadColorsPerGroup": false, + "hideGrid": false, + "hideAxis": false, + "colorOverride": new PcacBarVerticalChartColorOverrideConfig(), "numberOfTicks": 5, "thresholds": [ ], "data": [ { "key": "7/29", - "data": [ + "data": [ { "value": 687, "hide": false @@ -90,6 +95,6 @@ export class TestComponent { } ] } - ] as IPcacData[] + ] as PcacData[] } } diff --git a/projects/pioneer-charts-dev/src/assets/mock/shared-config.json b/projects/pioneer-charts-dev/src/assets/mock/shared-config.json index e8f53d71..f9605ef4 100644 --- a/projects/pioneer-charts-dev/src/assets/mock/shared-config.json +++ b/projects/pioneer-charts-dev/src/assets/mock/shared-config.json @@ -15,7 +15,7 @@ "value": "data" }, { - "value": "Collection of IPcacData objects" + "value": "Collection of PcacData objects" } ] } diff --git a/projects/pioneer-charts-web/src/app/components/base-config/base-config.component.html b/projects/pioneer-charts-web/src/app/components/base-config/base-config.component.html index bf0c4c94..24280f41 100644 --- a/projects/pioneer-charts-web/src/app/components/base-config/base-config.component.html +++ b/projects/pioneer-charts-web/src/app/components/base-config/base-config.component.html @@ -10,7 +10,7 @@
Configuration
data Collection of - IPcacData objects. + PcacData objects. diff --git a/projects/pioneer-charts-web/src/app/pages/docs/components/charts/bar-chart/bar-chart.component.html b/projects/pioneer-charts-web/src/app/pages/docs/components/charts/bar-chart/bar-chart.component.html index 512b6c5f..18efa998 100644 --- a/projects/pioneer-charts-web/src/app/pages/docs/components/charts/bar-chart/bar-chart.component.html +++ b/projects/pioneer-charts-web/src/app/pages/docs/components/charts/bar-chart/bar-chart.component.html @@ -80,7 +80,7 @@

API

thresholds Threshold are configure using the same structure as - IPcacData. + PcacData.
  • If the thresholds variable is left empty, you will get no thresholds on the UI.
  • If there is one object in the first dimension with no objects in that "data" variable of that @@ -124,7 +124,7 @@

    Events

    Emitted when a bar in the graph is clicked. - IPcacData + PcacData diff --git a/projects/pioneer-charts-web/src/app/pages/docs/components/charts/line-area-chart/line-area-chart.component.html b/projects/pioneer-charts-web/src/app/pages/docs/components/charts/line-area-chart/line-area-chart.component.html index 75f87af5..7cc42e63 100644 --- a/projects/pioneer-charts-web/src/app/pages/docs/components/charts/line-area-chart/line-area-chart.component.html +++ b/projects/pioneer-charts-web/src/app/pages/docs/components/charts/line-area-chart/line-area-chart.component.html @@ -78,7 +78,7 @@

    Events

    Emitted when a dot on a line is clicked clicked. - IPcacData + PcacData diff --git a/projects/pioneer-charts-web/src/app/pages/docs/components/charts/pie-chart/pie-chart.component.html b/projects/pioneer-charts-web/src/app/pages/docs/components/charts/pie-chart/pie-chart.component.html index 0550c636..10a17a7d 100644 --- a/projects/pioneer-charts-web/src/app/pages/docs/components/charts/pie-chart/pie-chart.component.html +++ b/projects/pioneer-charts-web/src/app/pages/docs/components/charts/pie-chart/pie-chart.component.html @@ -47,7 +47,7 @@

    Events

    Emitted when a slice is clicked. - IPcacData + PcacData diff --git a/projects/pioneer-charts-web/src/app/pages/docs/guides/data-contract/data-contract.component.html b/projects/pioneer-charts-web/src/app/pages/docs/guides/data-contract/data-contract.component.html index 3ff76878..49589c67 100644 --- a/projects/pioneer-charts-web/src/app/pages/docs/guides/data-contract/data-contract.component.html +++ b/projects/pioneer-charts-web/src/app/pages/docs/guides/data-contract/data-contract.component.html @@ -9,10 +9,10 @@ can always be expressed as a multi-dimensional array.

    -

    IPcacData

    +

    PcacData

    When a configuration interface is created for a chart, it starts off with a representation of raw data. - data: IPcacData[]; represent the base of our multi-dimensional array that we discussed above. + data: PcacData[]; represent the base of our multi-dimensional array that we discussed above.

    @@ -20,7 +20,7 @@

    IPcacChartConfig

    A lot of charts inside the Pioneer Charts library share basic configuration parameters. Of which are represented in this interface. We account for these shared parameters in this interface, of which has a property of the type - IPcacData[]. + PcacData[].

    diff --git a/projects/pioneer-charts-web/src/app/pages/docs/guides/data-contract/data-contract.component.ts b/projects/pioneer-charts-web/src/app/pages/docs/guides/data-contract/data-contract.component.ts index 391415b4..0ec269cf 100644 --- a/projects/pioneer-charts-web/src/app/pages/docs/guides/data-contract/data-contract.component.ts +++ b/projects/pioneer-charts-web/src/app/pages/docs/guides/data-contract/data-contract.component.ts @@ -23,7 +23,7 @@ export class DataContractComponent { level: JumpNavLevel.h1 }, { - key: 'IPcacData', + key: 'PcacData', value: 'data', level: JumpNavLevel.h2 }, @@ -44,10 +44,10 @@ export class DataContractComponent { } ] as IJumpNav[]; - data = `export interface IPcacData { + data = `export interface PcacData { key: string | number; value: string | number; - data: IPcacData[]; + data: PcacData[]; }`; baseConfig = `export interface IPcacChartConfig { @@ -56,7 +56,7 @@ export class DataContractComponent { */ height: number; ... - data: IPcacData[]; + data: PcacData[]; }`; barChartConfig = `import { IPcacChartConfig } from '../core/chart.model'; diff --git a/projects/pioneer-charts-web/src/app/pages/docs/guides/theme/theme.component.ts b/projects/pioneer-charts-web/src/app/pages/docs/guides/theme/theme.component.ts index 82820c11..acc90f31 100644 --- a/projects/pioneer-charts-web/src/app/pages/docs/guides/theme/theme.component.ts +++ b/projects/pioneer-charts-web/src/app/pages/docs/guides/theme/theme.component.ts @@ -59,7 +59,7 @@ this.colors = this.colorService.getColorScale(config.data.length); ... ... -.style('fill', (d: IPcacData, i: number) => { +.style('fill', (d: PcacData, i: number) => { return this.colors[i]; }) ...`; diff --git a/projects/pioneer-charts-web/src/assets/mock/shared-config.json b/projects/pioneer-charts-web/src/assets/mock/shared-config.json index e8f53d71..f9605ef4 100644 --- a/projects/pioneer-charts-web/src/assets/mock/shared-config.json +++ b/projects/pioneer-charts-web/src/assets/mock/shared-config.json @@ -15,7 +15,7 @@ "value": "data" }, { - "value": "Collection of IPcacData objects" + "value": "Collection of PcacData objects" } ] } diff --git a/projects/pioneer-charts/ng-package.json b/projects/pioneer-charts/ng-package.json index 05a1c66b..65a58ce4 100644 --- a/projects/pioneer-charts/ng-package.json +++ b/projects/pioneer-charts/ng-package.json @@ -1,6 +1,6 @@ { - "$schema": "../../../node_modules/ng-packagr/ng-package.schema.json", - "dest": "../../../dist/pioneer-charts", + "$schema": "../../node_modules/ng-packagr/ng-package.schema.json", + "dest": "../../dist/pioneer-charts", "lib": { "entryFile": "src/public-api.ts" } diff --git a/projects/pioneer-charts/src/lib/bar-chart/bar-horizontal-chart/public_api.ts b/projects/pioneer-charts/src/lib/bar-chart/bar-horizontal-chart/public-api.ts similarity index 100% rename from projects/pioneer-charts/src/lib/bar-chart/bar-horizontal-chart/public_api.ts rename to projects/pioneer-charts/src/lib/bar-chart/bar-horizontal-chart/public-api.ts diff --git a/projects/pioneer-charts/src/lib/bar-chart/bar-vertical-chart/public_api.ts b/projects/pioneer-charts/src/lib/bar-chart/bar-vertical-chart/public-api.ts similarity index 100% rename from projects/pioneer-charts/src/lib/bar-chart/bar-vertical-chart/public_api.ts rename to projects/pioneer-charts/src/lib/bar-chart/bar-vertical-chart/public-api.ts diff --git a/projects/pioneer-charts/src/lib/core/chart.ts b/projects/pioneer-charts/src/lib/core/chart.ts index 3f302f68..41b23851 100644 --- a/projects/pioneer-charts/src/lib/core/chart.ts +++ b/projects/pioneer-charts/src/lib/core/chart.ts @@ -71,7 +71,7 @@ export class PcacChart { * For example, labels on a horizontal bar chart are dynamic and such the margin needs to be calculated ahead of * chart axis construction. * @param chartElm Reference to SVG on dom - * @param data Generic multi-dimensional IPcacData structure + * @param data Generic multi-dimensional PcacData structure * @param yScale D3 scale transformation object (d3.ScaleBand) */ setHorizontalMarginsBasedOnContent(chartElm: ElementRef, data: PcacData[], yScale: any): void { diff --git a/projects/pioneer-charts/src/lib/core/index.ts b/projects/pioneer-charts/src/lib/core/index.ts index 4aaf8f92..7e1a213e 100644 --- a/projects/pioneer-charts/src/lib/core/index.ts +++ b/projects/pioneer-charts/src/lib/core/index.ts @@ -1 +1 @@ -export * from './public_api'; +export * from './public-api'; diff --git a/projects/pioneer-charts/src/lib/core/public_api.ts b/projects/pioneer-charts/src/lib/core/public-api.ts similarity index 100% rename from projects/pioneer-charts/src/lib/core/public_api.ts rename to projects/pioneer-charts/src/lib/core/public-api.ts diff --git a/projects/pioneer-charts/src/lib/line-area-chart/public_api.ts b/projects/pioneer-charts/src/lib/line-area-chart/public-api.ts similarity index 100% rename from projects/pioneer-charts/src/lib/line-area-chart/public_api.ts rename to projects/pioneer-charts/src/lib/line-area-chart/public-api.ts diff --git a/projects/pioneer-charts/src/lib/pie-chart/public_api.ts b/projects/pioneer-charts/src/lib/pie-chart/public-api.ts similarity index 100% rename from projects/pioneer-charts/src/lib/pie-chart/public_api.ts rename to projects/pioneer-charts/src/lib/pie-chart/public-api.ts diff --git a/projects/pioneer-charts/src/public-api.ts b/projects/pioneer-charts/src/public-api.ts index 7b19ca02..768bc1bc 100644 --- a/projects/pioneer-charts/src/public-api.ts +++ b/projects/pioneer-charts/src/public-api.ts @@ -3,10 +3,10 @@ */ -export * from './lib/core/public_api'; +export * from './lib/core/public-api'; -export * from './lib/line-area-chart/public_api'; -export * from './lib/pie-chart/public_api'; -export * from './lib/bar-chart/bar-horizontal-chart/public_api'; -export * from './lib/bar-chart/bar-vertical-chart/public_api'; +export * from './lib/line-area-chart/public-api'; +export * from './lib/pie-chart/public-api'; +export * from './lib/bar-chart/bar-horizontal-chart/public-api'; +export * from './lib/bar-chart/bar-vertical-chart/public-api'; diff --git a/tsconfig.json b/tsconfig.json index 570b57e9..3246e76b 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -14,9 +14,6 @@ "paths": { "@pioneer-code/pioneer-charts": [ "dist/pioneer-charts" - ], - "pioneer-charts": [ - "dist/pioneer-charts" ] }, "esModuleInterop": true,