Home       Trees       Indices       Help   
S3
Package s3 :: Module s3timeplot :: Class S3TimeSeries
[frames] | no frames]

Class S3TimeSeries

source code

object --+
         |
        S3TimeSeries

Class representing a time series

Instance Methods
 
__init__(self, resource, start=None, end=None, slots=None, event_start=None, event_end=None, rows=None, cols=None, facts=None, baseline=None, title=None)
Constructor		 source code
 
as_dict(self)
Return the time series as JSON-serializable dict		 source code
 
resolve_timestamp(self, event_start, event_end)
Resolve the event_start and event_end field selectors		 source code
 
resolve_baseline(self, baseline)
Resolve the baseline field selector		 source code
 
resolve_axes(self, rows, cols)
Resolve the grouping axes field selectors		 source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods
 
dtparse(timestr, start=None)
Parse a string for start/end date(time) of an interval		 source code
Properties

Inherited from object: __class__

Method Details

__init__(self, resource, start=None, end=None, slots=None, event_start=None, event_end=None, rows=None, cols=None, facts=None, baseline=None, title=None)
(Constructor)

source code 

Constructor

Parameters:
  • resource - the resource
  • start - the start of the series (datetime or string expression)
  • end - the end of the time series (datetime or string expression)
  • slots - the slot size (string expression)
  • event_start - the event start field (field selector)
  • event_end - the event end field (field selector)
  • rows - the rows axis for event grouping (field selector)
  • cols - the columns axis for event grouping (field selector)
  • facts - an array of facts (S3TimeSeriesFact)
  • baseline - the baseline field (field selector)
  • title - the time series title
Overrides: object.__init__

as_dict(self)

source code 

Return the time series as JSON-serializable dict

resolve_timestamp(self, event_start, event_end)

source code 

Resolve the event_start and event_end field selectors

Parameters:
  • event_start - the field selector for the event start field
  • event_end - the field selector for the event end field

resolve_baseline(self, baseline)

source code 

Resolve the baseline field selector

Parameters:
  • baseline - the baseline selector

resolve_axes(self, rows, cols)

source code 

Resolve the grouping axes field selectors

Parameters:
  • rows - the rows field selector
  • cols - the columns field selector

dtparse(timestr, start=None)
Static Method

source code 

Parse a string for start/end date(time) of an interval

Parameters:
  • timestr - the time string
  • start - the start datetime to relate relative times to

   Home       Trees       Indices       Help   
S3
Generated by Epydoc 3.0.1 on Fri Mar 15 08:51:50 2019 http://epydoc.sourceforge.net