API Docs for: 0.13.12
Show:

Data.Store Class

Defined in: src\firebrick.js:1829
Module: Firebrick

Methods

_basicStoreConfigurations

(
  • config
)
Object private

Defined in src\firebrick.js:1876

Basic view configurations when defining/creating a view

Parameters:

  • config Object

    (optional)

Returns:

Object:

_loadStore

(
  • store
  • options
)
Object private

Defined in src\firebrick.js:1890

Used by Firebrick.store.Base:load GET

Parameters:

  • store Object

    Firebrick.store.Base object

  • options Object
    • async Boolean

      [default=store.async]

    • callback Function

      [store, jsonObject, status, response]

    • error Function

      [response, error, errorMessage]

    • scope Object

Returns:

Object:

store

_submit

(
  • store
  • callback
)
Object private

Defined in src\firebrick.js:1958

Submit the given store with its data to the specified url POST

Parameters:

  • store Object

    //Firebricks.store.Base class

  • callback Function

    (optional) function to call on store submission success

Returns:

Object:

store

createStore

(
  • name
  • config
)
Object

Defined in src\firebrick.js:1835

creates a new Firebrick.store.Base store to be used OR if a name and config are supplied, then Firebrick.create() is called

Parameters:

  • name String

    if string, then Firebrick:create is called

  • config Object

    data to config the class with - called in conjuction when name is set

Returns:

Object:

Firebrick.store.Base

Example:

    //creates a new class Firebrick.store.Base to be used
    createStore({
                       data:{name:"bob"}
                   });
    createStore("MyApp.store.MyStore", {}); //Firebrick.create() is called
    createStore() //returns a Store class to be used