Skip to content

Commit

Permalink
Refactor file paths and imports in pioneer-charts library
Browse files Browse the repository at this point in the history
  • Loading branch information
chad-ramos committed Oct 9, 2024
1 parent 9d77fc5 commit c81e748
Show file tree
Hide file tree
Showing 24 changed files with 72 additions and 70 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
"files.exclude": {
"**/.angular": true,
"**/node_modules": true,
"**/dist": true,
"**/dist": tsrue,
},
}
Original file line number Diff line number Diff line change
@@ -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';

Expand All @@ -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}`);
}
}
36 changes: 18 additions & 18 deletions projects/pioneer-charts-dev/src/app/services/pc.repository.ts
Original file line number Diff line number Diff line change
@@ -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';


Expand All @@ -20,60 +20,60 @@ export class PcRepository {
* Bar Charts Horizontal
*/
getBarHorizontalChart() {
return this.http.get<IPcacBarHorizontalChartConfig>('./assets/mock/bar-charts/bar-horizontal-chart.json');
return this.http.get<PcacBarHorizontalChartConfig>('./assets/mock/bar-charts/bar-horizontal-chart.json');
}

getBarHorizontalChartSingle() {
return this.http.get<IPcacBarHorizontalChartConfig>('./assets/mock/bar-charts/bar-horizontal-chart-single.json');
return this.http.get<PcacBarHorizontalChartConfig>('./assets/mock/bar-charts/bar-horizontal-chart-single.json');
}

getBarHorizontalChartGroup() {
return this.http.get<IPcacBarHorizontalChartConfig>('./assets/mock/bar-charts/bar-horizontal-chart-group.json');
return this.http.get<PcacBarHorizontalChartConfig>('./assets/mock/bar-charts/bar-horizontal-chart-group.json');
}

getBarHorizontalChartStacked() {
return this.http.get<IPcacBarHorizontalChartConfig>('./assets/mock/bar-charts/bar-horizontal-chart-stacked.json');
return this.http.get<PcacBarHorizontalChartConfig>('./assets/mock/bar-charts/bar-horizontal-chart-stacked.json');
}

/**
* Bar Charts Vertical
*/
getBarVerticalChart() {
return this.http.get<IPcacBarVerticalChartConfig>('./assets/mock/bar-charts/bar-vertical-chart.json');
return this.http.get<PcacBarVerticalChartConfig>('./assets/mock/bar-charts/bar-vertical-chart.json');
}

getBarVerticalChartSingle() {
return this.http.get<IPcacBarVerticalChartConfig>('./assets/mock/bar-charts/bar-vertical-chart-single.json');
return this.http.get<PcacBarVerticalChartConfig>('./assets/mock/bar-charts/bar-vertical-chart-single.json');
}

getBarVerticalChartGroup() {
return this.http.get<IPcacBarVerticalChartConfig>('./assets/mock/bar-charts/bar-vertical-chart-group.json');
return this.http.get<PcacBarVerticalChartConfig>('./assets/mock/bar-charts/bar-vertical-chart-group.json');
}

getBarVerticalChartStacked() {
return this.http.get<IPcacBarVerticalChartConfig>('./assets/mock/bar-charts/bar-vertical-chart-stacked.json');
return this.http.get<PcacBarVerticalChartConfig>('./assets/mock/bar-charts/bar-vertical-chart-stacked.json');
}

/**
* Line Area Charts
*/
getLineChart() {
return this.http.get<IPcacLineAreaChartConfig>('./assets/mock/line-area-chart/line-chart-2.json');
return this.http.get<PcacLineAreaChartConfig>('./assets/mock/line-area-chart/line-chart-2.json');
}

getAreaChart() {
return this.http.get<IPcacLineAreaChartConfig>('./assets/mock/line-area-chart/area-chart.json');
return this.http.get<PcacLineAreaChartConfig>('./assets/mock/line-area-chart/area-chart.json');
}

getAreaHideChart() {
return this.http.get<IPcacLineAreaChartConfig>('./assets/mock/line-area-chart/area-chart-hide.json');
return this.http.get<PcacLineAreaChartConfig>('./assets/mock/line-area-chart/area-chart-hide.json');
}

getPieChartConfig() {
return this.http.get<IPcacPieChartConfig>('./assets/mock/pie-chart.json');
return this.http.get<PcacPieChartConfig>('./assets/mock/pie-chart.json');
}

getShareConfig() {
return this.http.get<IPcacData[]>('./assets/mock/shared-config.json');
return this.http.get<PcacData[]>('./assets/mock/shared-config.json');
}
}
36 changes: 18 additions & 18 deletions projects/pioneer-charts-dev/src/app/services/pc.service.ts
Original file line number Diff line number Diff line change
@@ -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';

Expand All @@ -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';
Expand Down
13 changes: 9 additions & 4 deletions projects/pioneer-charts-dev/src/app/test/test.component.ts
Original file line number Diff line number Diff line change
@@ -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',
Expand All @@ -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
Expand Down Expand Up @@ -90,6 +95,6 @@ export class TestComponent {
}
]
}
] as IPcacData[]
] as PcacData[]
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"value": "data"
},
{
"value": "Collection of IPcacData objects"
"value": "Collection of PcacData objects"
}
]
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ <h6 id="configuration">Configuration</h6>
<tr>
<td>data</td>
<td>Collection of
<a routerLink="/docs/guides/data-contract">IPcacData</a> objects.
<a routerLink="/docs/guides/data-contract">PcacData</a> objects.
</td>
</tr>
<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ <h3 id="api">API</h3>
<tr>
<td>thresholds</td>
<td>Threshold are configure using the same structure as
<a routerLink="/docs/guides/data-contract">IPcacData</a>.
<a routerLink="/docs/guides/data-contract">PcacData</a>.
<ul style="margin: 0">
<li>If the thresholds variable is left empty, you will get no thresholds on the UI.</li>
<li>If there is one object in the first dimension with no objects in that "data" variable of that
Expand Down Expand Up @@ -124,7 +124,7 @@ <h3 id="events">Events</h3>
</td>
<td>Emitted when a bar in the graph is clicked.</td>
<td>
<a routerLink="/docs/guides/data-contract">IPcacData</a>
<a routerLink="/docs/guides/data-contract">PcacData</a>
</td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ <h3 id="events">Events</h3>
</td>
<td>Emitted when a dot on a line is clicked clicked.</td>
<td>
<a routerLink="/docs/guides/data-contract">IPcacData</a>
<a routerLink="/docs/guides/data-contract">PcacData</a>
</td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ <h3 id="events">Events</h3>
</td>
<td>Emitted when a slice is clicked.</td>
<td>
<a routerLink="/docs/guides/data-contract">IPcacData</a>
<a routerLink="/docs/guides/data-contract">PcacData</a>
</td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@
can always be expressed as a multi-dimensional array.</p>
</section>
<section class="pc-doc-section">
<h3 id="data">IPcacData</h3>
<h3 id="data">PcacData</h3>
<app-code language="typescript" [code]="data"></app-code>
<p>When a configuration interface is created for a chart, it starts off with a representation of raw data.
<b>data: IPcacData[];</b> represent the base of our multi-dimensional array that we discussed above.
<b>data: PcacData[];</b> represent the base of our multi-dimensional array that we discussed above.
</p>
</section>
<section class="pc-doc-section">
<h3 id="chart-config">IPcacChartConfig</h3>
<app-code language="typescript" [code]="baseConfig"></app-code>
<p>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
<b>IPcacData[]</b>.
<b>PcacData[]</b>.
</p>
</section>
<section class="pc-doc-section">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export class DataContractComponent {
level: JumpNavLevel.h1
},
{
key: 'IPcacData',
key: 'PcacData',
value: 'data',
level: JumpNavLevel.h2
},
Expand All @@ -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 {
Expand All @@ -56,7 +56,7 @@ export class DataContractComponent {
*/
height: number;
...
data: IPcacData[];
data: PcacData[];
}`;

barChartConfig = `import { IPcacChartConfig } from '../core/chart.model';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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];
})
...`;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"value": "data"
},
{
"value": "Collection of IPcacData objects"
"value": "Collection of PcacData objects"
}
]
}
Expand Down
4 changes: 2 additions & 2 deletions projects/pioneer-charts/ng-package.json
Original file line number Diff line number Diff line change
@@ -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"
}
Expand Down
2 changes: 1 addition & 1 deletion projects/pioneer-charts/src/lib/core/chart.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion projects/pioneer-charts/src/lib/core/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export * from './public_api';
export * from './public-api';
10 changes: 5 additions & 5 deletions projects/pioneer-charts/src/public-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';

3 changes: 0 additions & 3 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@
"paths": {
"@pioneer-code/pioneer-charts": [
"dist/pioneer-charts"
],
"pioneer-charts": [
"dist/pioneer-charts"
]
},
"esModuleInterop": true,
Expand Down

0 comments on commit c81e748

Please sign in to comment.