diff --git a/docs/classes/Abstract2dArt.html b/docs/classes/Abstract2dArt.html index 8a6fa017b..d62a13084 100644 --- a/docs/classes/Abstract2dArt.html +++ b/docs/classes/Abstract2dArt.html @@ -1,4 +1,4 @@ -
Abstract2dArt is an abstract class which all arts rendered in 2D extend.
Unique identifier of each art
Abstract2dArt implements some of the functionality of Abstract2dArt to make implementation of square objects simpler.
Abstract2dArt
use hook useMeasure or Measure component instead @see TextArt
AbstractArt is an abstract class which all art classes extend.
It only provides unique identifier for each art
This art holds information about a backgroud image of the board.
Z-position of background. Currently unused
AbstractEnvironmentArt creates a category of arts that changes the environment on board like background, pattern, skybox etc.
AbstractPlacedArt is an abstract class which all arts with position and size extend.
Default z-index of art
AbstractUIArt is an abstract class providing functionality regarding adding or removing components from UI
AbstractUIArt is not implemented within the system yet
ApiClient provides API calls to the remote server.
Promise which is resolved when the system is initialized and ready to use.
AppState is not quite a system but an object representing the state of the Collboard app.
This system will be split into two CollSpace and SelectionSystem and removed
ArtSerializer serializes and deseriales Collboard arts and other objects
ArtSupportSyncer installs / uninstalls art support modules
AttributeSupportSyncer installs / uninstalls ONLY STANDARD attribute modules when needed
AttributesSystem manages shared art attributes and modules capable of selecting from them. It auto-installs / uninstalls attribute modules.
Art setting background with color style
see AbstractBackgroundArt
AbstractBackgroundArt
Art setting background with pattern style (scrolling)
Source of the background pattern tile
Art setting background with wallpaper style (not scrolling)
Optional override for formatting stack traces
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class Abstract2dArt
Abstract2dArt is an abstract class which all arts rendered in 2D extend.
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Abstract2dArt
Properties
Readonly art Id
Unique identifier of each art
diff --git a/docs/classes/Abstract2dBoxArt.html b/docs/classes/Abstract2dBoxArt.html index 72abaf779..99ccd49b0 100644 --- a/docs/classes/Abstract2dBoxArt.html +++ b/docs/classes/Abstract2dBoxArt.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class Abstract2dBoxArt
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class Abstract2dBoxArt
Abstract2dArt implements some of the functionality of
Abstract2dArt
to make implementation of square objects simpler.use hook useMeasure or Measure component instead @see TextArt
diff --git a/docs/classes/AbstractArt.html b/docs/classes/AbstractArt.html index eaad1f11f..589f415a4 100644 --- a/docs/classes/AbstractArt.html +++ b/docs/classes/AbstractArt.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class AbstractArt
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class AbstractArt
AbstractArt is an abstract class which all art classes extend.
It only provides unique identifier for each art
Hierarchy
Indexable
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class AbstractBackgroundArt
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class AbstractBackgroundArt
This art holds information about a backgroud image of the board.
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
Optional z: number
Z-position of background. Currently unused
diff --git a/docs/classes/AbstractEnvironmentArt.html b/docs/classes/AbstractEnvironmentArt.html index 99f6b2d28..9cf3bdf88 100644 --- a/docs/classes/AbstractEnvironmentArt.html +++ b/docs/classes/AbstractEnvironmentArt.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class AbstractEnvironmentArt
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class AbstractEnvironmentArt
AbstractEnvironmentArt creates a category of arts that changes the environment on board like background, pattern, skybox etc.
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Returns AbstractEnvironmentArt
Properties
Readonly art Id
Unique identifier of each art
diff --git a/docs/classes/AbstractPlacedArt.html b/docs/classes/AbstractPlacedArt.html index 9d484c22a..d21cb027b 100644 --- a/docs/classes/AbstractPlacedArt.html +++ b/docs/classes/AbstractPlacedArt.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class AbstractPlacedArt
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class AbstractPlacedArt
AbstractPlacedArt is an abstract class which all arts with position and size extend.
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns AbstractPlacedArt
Properties
Readonly art Id
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class AbstractTrayArt
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
itemId: string
shift: Vector
Returns AbstractTrayArt
Properties
Readonly art Id
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class AbstractTrayArt
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
itemId: string
shift: Vector
Returns AbstractTrayArt
Properties
Readonly art Id
Unique identifier of each art
color
defaultZIndex
Default z-index of art
diff --git a/docs/classes/AbstractUserInterfaceArt.html b/docs/classes/AbstractUserInterfaceArt.html index 44677b626..e4c26c140 100644 --- a/docs/classes/AbstractUserInterfaceArt.html +++ b/docs/classes/AbstractUserInterfaceArt.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class AbstractUserInterfaceArt
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class AbstractUserInterfaceArt
AbstractUIArt is an abstract class providing functionality regarding adding or removing components from UI
AbstractUIArt is not implemented within the system yet
diff --git a/docs/classes/Additional.html b/docs/classes/Additional.html index dd385b288..e9893d310 100644 --- a/docs/classes/Additional.html +++ b/docs/classes/Additional.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class Additional<TKey, TValue>
Type parameters
TKey
TValue
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Type parameters
TKey
TValue
Parameters
keys: TKey[]
valueCallback: (key: TKey) => TValue
Parameters
key: TKey
Returns TValue
Returns Additional<TKey, TValue>
Properties
Private lib
Methods
get
Parameters
key: TKey
Returns TValue
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class Additional<TKey, TValue>
Type parameters
TKey
TValue
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Type parameters
TKey
TValue
Parameters
keys: TKey[]
valueCallback: (key: TKey) => TValue
Parameters
key: TKey
Returns TValue
Returns Additional<TKey, TValue>
Properties
Private lib
Methods
get
Parameters
key: TKey
Returns TValue
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class ApiClient
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class ApiClient
ApiClient provides API calls to the remote server.
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
systems: ISystemsExtended
apiUrl: URL
Returns ApiClient
Properties
Private api Client Cache
Private api Url
Private get
Private post
Private process Response
Readonly ready
Promise which is resolved when the system is initialized and ready to use.
diff --git a/docs/classes/AppState.html b/docs/classes/AppState.html index 8017807fd..7a4ea34c2 100644 --- a/docs/classes/AppState.html +++ b/docs/classes/AppState.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class AppState
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class AppState
AppState is not quite a system but an object representing the state of the Collboard app.
This system will be split into two CollSpace and SelectionSystem and removed
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
systems: ISystemsExtended
Returns AppState
Properties
Readonly boardname
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class ArtSerializer
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class ArtSerializer
ArtSerializer serializes and deseriales Collboard arts and other objects
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class ArtSupportSyncer
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class ArtSupportSyncer
ArtSupportSyncer installs / uninstalls art support modules
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
systems: ISystemsExtended
Returns ArtSupportSyncer
Properties
Private art Dependencies
Protected modules Storage
Readonly ready
Promise which is resolved when the system is initialized and ready to use.
diff --git a/docs/classes/AttributeSupportSyncer.html b/docs/classes/AttributeSupportSyncer.html index c510cd43d..7a0c34340 100644 --- a/docs/classes/AttributeSupportSyncer.html +++ b/docs/classes/AttributeSupportSyncer.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class AttributeSupportSyncer
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class AttributeSupportSyncer
AttributeSupportSyncer installs / uninstalls ONLY STANDARD attribute modules when needed
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
systems: ISystemsExtended
Returns AttributeSupportSyncer
Properties
Private attribute Dependencies
Protected modules Storage
Readonly ready
Promise which is resolved when the system is initialized and ready to use.
diff --git a/docs/classes/AttributesSystem.html b/docs/classes/AttributesSystem.html index 1fec578b8..9cef31e22 100644 --- a/docs/classes/AttributesSystem.html +++ b/docs/classes/AttributesSystem.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class AttributesSystem
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class AttributesSystem
AttributesSystem manages shared art attributes and modules capable of selecting from them. It auto-installs / uninstalls attribute modules.
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
systems: ISystemsExtended
Returns AttributesSystem
Properties
Private attributes Rules
Private attributes Value
Private get Attribute Value Defined
Private input Render Defined
Readonly ready
Promise which is resolved when the system is initialized and ready to use.
diff --git a/docs/classes/BackgroundColorArt.html b/docs/classes/BackgroundColorArt.html index 4933faf83..e6f8a05a4 100644 --- a/docs/classes/BackgroundColorArt.html +++ b/docs/classes/BackgroundColorArt.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class BackgroundColorArt
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class BackgroundColorArt
Art setting background with color style
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
color: Color
Optional z: number
see
diff --git a/docs/classes/BackgroundPatternArt.html b/docs/classes/BackgroundPatternArt.html index 811d9946b..1f36d837d 100644 --- a/docs/classes/BackgroundPatternArt.html +++ b/docs/classes/BackgroundPatternArt.html @@ -1,4 +1,4 @@ -AbstractBackgroundArt
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class BackgroundPatternArt
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class BackgroundPatternArt
Art setting background with pattern style (scrolling)
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
src: string
Source of the background pattern tile
diff --git a/docs/classes/BackgroundWallpaperArt.html b/docs/classes/BackgroundWallpaperArt.html index 767930efc..cc8cd4d4f 100644 --- a/docs/classes/BackgroundWallpaperArt.html +++ b/docs/classes/BackgroundWallpaperArt.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class BackgroundWallpaperArt
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class BackgroundWallpaperArt
Art setting background with wallpaper style (not scrolling)
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
src: string
Source of the background pattern tile
diff --git a/docs/classes/BoardAlreadyExistsError.html b/docs/classes/BoardAlreadyExistsError.html index 40d277949..fa856dc71 100644 --- a/docs/classes/BoardAlreadyExistsError.html +++ b/docs/classes/BoardAlreadyExistsError.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.1800Class BoardAlreadyExistsError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
uriId: string
Returns BoardAlreadyExistsError
Properties
message
Readonly name
Optional stack
Static Optional prepare Stack Trace
- Preparing search index...
- The search index is not available
Modules SDK toolkit for Collboard.com - v35.13.2000Class BoardAlreadyExistsError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
uriId: string
Returns BoardAlreadyExistsError
Properties
message
Readonly name
Optional stack
Static Optional prepare Stack Trace
Optional override for formatting stack traces
Type declaration