Interface GlobalResources

The global resources interface allows to retrieve global settings for the product. This includes the available options for:

canvas options
stock options
output type options
dynamic size settings

Hierarchy

GlobalResources

Index

Methods

Canvases DynamicSizeSettings OutputTypes StockItems

Methods

Canvases

Canvases(callback): void
Retrieve all linked canvas options.
Parameters
- callback: ((canvases) => void)
  
  The callback function that will be called once the canvas options are retrieved.
  - - (canvases): void
    - Parameters
      
      canvases: Canvas[]
      
      Returns void
Returns void

DynamicSizeSettings

DynamicSizeSettings(callback): void
Retrieve the available canvas options for dynamic sizing. If dynamic sizing is not enabled, this will return an empty object.
Parameters
- callback: ((settings) => void)
  
  The callback function that will be called once the canvas options are retrieved.
  - - (settings): void
    - Parameters
      
      settings: DynamicSizeSettings
      
      Returns void
Returns void

OutputTypes

OutputTypes(callback): void
Retrieve all linked output type options.
Parameters
- callback: ((types) => void)
  
  The callback function that will be called once the output type options are retrieved.
  - - (types): void
    - Parameters
      
      types: OutputType[]
      
      Returns void
Returns void

StockItems

StockItems(callback): void
Retrieve all linked stock options.
Parameters
- callback: ((items) => void)
  
  The callback function that will be called once the stock options are retrieved.
  - - (items): void
    - Parameters
      
      items: StockItem[]
      
      Returns void
Returns void

Generated using TypeDoc