Home       Trees       Indices       Help   
S3
Package s3 :: Module s3dashboard :: Class S3DashboardConfig
[frames] | no frames]

Class S3DashboardConfig

source code

object --+
         |
        S3DashboardConfig

Dashboard Configuration

Instance Methods
 
__init__(self, layout, widgets=None, default=None, configurable=False)
Constructor		 source code
 
load(self, context)
Load the current active configuration for the context		 source code
 
save(self, context, update=None)
Save this configuration in the database		 source code

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

Class Variables
  DEFAULT_LAYOUT = "boxes"
Properties

Inherited from object: __class__

Method Details

__init__(self, layout, widgets=None, default=None, configurable=False)
(Constructor)

source code 

Constructor

Parameters:
  • layout - the layout, or the config dict
  • widgets - the available widgets as dict {name: widget}
  • default - the default configuration (=list of widget configs)
  • configurable - whether this dashboard is user-configurable
Overrides: object.__init__

load(self, context)

source code 

Load the current active configuration for the context

Parameters:
  • context - the current S3DashboardContext

save(self, context, update=None)

source code 

Save this configuration in the database

Parameters:
  • context - the current S3DashboardContext
  • update - widget configurations to update, as dict {widget_id: {config-dict}}
Returns:
the new version key, or None if not successful

Class Variable Details

DEFAULT_LAYOUT

Value:
"boxes"

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