app.md

Classes

PatentView

The Patent View application class

Constants

$CONTROLLER

Exported reference to application model and controller

PatentView

The Patent View application class

Kind: global class

• PatentView
  • .render() ⇒ undefined
  • .getDefaultDOM() ⇒ undefined
  • .updateDOM(nodeUpdater, selector) ⇒ undefined
  • .getSettings(url) ⇒ Promise.<object>
  • .getPage(page, query) ⇒ Promise.<undefined>
  • .router([e]) ⇒ undefined
  • .init() ⇒ Promise.<undefined>

patentView.render() ⇒ undefined

Render Page

Attach the virtual DOM children to the page DOM

Kind: instance method of PatentView
Access: public

patentView.getDefaultDOM() ⇒ undefined

Get Default Page DOM

Retrieve the page's default content from the configured application wrapper

Kind: instance method of PatentView
Access: public

patentView.updateDOM(nodeUpdater, selector) ⇒ undefined

Update Stored DOM

Update the virtual DOM with new content

Kind: instance method of PatentView

Param	Type	Description
nodeUpdater	Node	node containing updated content
selector	string	string identifier of target element that will be updated

patentView.getSettings(url) ⇒ Promise.<object>

Get Settings

Kind: instance method of PatentView
Returns: Promise.<object> - Parsed JSON object
Access: public

Param	Type	Description
url	string	settings path

patentView.getPage(page, query) ⇒ Promise.<undefined>

Get Page

Retrieve the requested view

Kind: instance method of PatentView
Returns: Promise.<undefined> - Promise
Access: public

Param	Type	Description
page	string	page path
query	string	query string

patentView.router([e]) ⇒ undefined

Router

The application router

Kind: instance method of PatentView

Param	Type	Description
[e]	Event	optional event object

patentView.init() ⇒ Promise.<undefined>

Initializer

Kind: instance method of PatentView
Returns: Promise.<undefined> - Promise

$CONTROLLER

Exported reference to application model and controller

Kind: global constant
Access: public
Properties

Name	Type
$CONTROLLER	object