Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataService

Objective

  • Store structured data for use in
    • Input for analysis
    • Output of analysis
  • Gain intuition on data through visualizations

Views

Used in the front-end for visualizing a data type. This is often a combination of multiple things, such as

  • View format (table, graph, waterfall, box-plot, etc.)
  • Filter (ways to filter the data before viewing) --- Ex. filter for week/weekend or by season
  • Order (ways to order data after filtering) --- Ex. order by value to get duration curve
  • Calculations (calculations to perform on data before viewing) --- Statistics, primarily nesting by key and then rolling up and showing a variety of statistics such as quantiles, means, median, min, max etc.

Views will be inheritied. Example, data:timeseries:8760 would be able to use data:timeseries views

Types

Currently Supported Types

  • data:timeseries:8760

Future Types to Support

Timeseries

An array of objects { x: .., y: ..} where x is related to a time measure. x and y are arbitrary and are defined in meta data in the data/item object

  • data:timeseries:8760
    • Hourly timeseries data for 1 year
  • data:timeseries:annual
    • Annual data points for up to X years

Key Value

An object with { [key]: value } that is a very generic type

  • data:keyvalue
    • store as object, unordered
  • data:keyvalue:ordered
    • store as list (maybe better way, I dont know it though.)

Example object, Waterfall Chart

// As Object
{
    "Product Revenue":420000,
    "Services Revenue":210000,
    "Fixed Costs":-170000,
    "Variable Costs":-140000
} 

// As List
[
    {
        key: "Product Revenue",
        value: 420000
    },{
        key:"Services Revenue",
        value:210000
    },{
        key: "Fixed Costs",
        value: -170000
    },{
        key:"Variable Costs",
        value: -140000
    }
]

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

rData

resource

resource: ResourceMap

services

services: CoreServices

Methods

registerResource

  • registerResource(name: string, resourceClass: any): any

Generated using TypeDoc