Skip to content

Latest commit

 

History

History
70 lines (53 loc) · 2.32 KB

components.md

File metadata and controls

70 lines (53 loc) · 2.32 KB
Raw

Components

This page details the Angular components that are part of the application and how they relate to each other.

flowchart TB
  subgraph Components
    CarbonEstimator["`CarbonEstimatorComponent
    carbon-estimator`"]
    CarbonEstimatorForm["`CarbonEstimatorFormComponent
    carbon-estimator-form`"]
    CarbonEstimation["`CarbonEstimationComponent
    carbon-estimation`"]
    Assumptions["`AssumptionsAndLimitationComponent
    assumptions-and-limitation`"]
    Note["`NoteComponent
    note`"]
    Disclaimer["`DisclaimerComponent
    disclaimer`"]
    ExpansionPanel["`ExpansionPanelComponent
    expansion-panel`"]
  end
  subgraph Services
    CarbonEstimationService
    CarbonIntensityService
  end
  subgraph Pipes
    FormatCostRangePipe
  end

  CarbonEstimator --> CarbonEstimatorForm & CarbonEstimation & Assumptions & Disclaimer
  CarbonEstimatorForm ---> FormatCostRangePipe
  CarbonEstimatorForm --> Note
  CarbonEstimator & CarbonEstimatorForm ---> CarbonEstimationService
  CarbonEstimatorForm & CarbonEstimation & Disclaimer --> ExpansionPanel
  CarbonEstimationService & Assumptions --> CarbonIntensityService
Loading

CarbonEstimatorComponent

Chooses which of its sub-components to display based on the current state.
Receives events from sub components to transition between states.
Uses the CarbonEstimationService to produce the estimation for display.

CarbonEstimatorFormComponent

The main form for user input, takes care of validation and updates descriptions in response to input changes.
Uses the CarbonEstimationService to estimate the number of servers.
Uses the FormatCostRangePipe to display the monthly cloud bill options.

CarbonEstimationComponent

Visualises the Carbon Estimation result.

AssumptionsAndLimitationComponent

Provides information on the Assumptions and Limitations of the estimation.
Uses the CarbonIntensityService to get the latest carbon intensity figures to display.

NoteComponent

Highlights assumptions that will be made when certain options are selected.

DisclaimerComponent

Displays disclaimer about how the tool should be used.

ExpansionPanelComponent

Displays explanatory text that can be hidden if desired.