Notes on JSDoc¶
JSDoc outputs just the classname if you specify like this:
.. js:autoclass:: MyClass
:members:
gives the result:
js:autoclass:: MyClass :members:
But, if you use the path (for instance, if you have multiple files or modules with the same name), then it will output the entire path tree in the docs.
.. js:autoclass:: ./mson-react/MyClass.module:MyClass
:members:
gives the result:
- js:autoclass:: ./mson-react/MyClass.module:MyClass
members:
This looks very cluttered. It would be nice if we could take the path prefix off, display it once, maybe in a footer something like:
File location: /path/to/said/files/parent/folder
- js:autoclass:: ./mson-react/MyClass.module.exports
members:
-
class
mson.src.fields.collection-field.CollectionField()¶ CollectionField
The CollectionField stores a list of MSON Form Components ( aka records, docs, documents) in a list mapa.
Items can be inserted, moved, reordered, etc.
-
mson.src.fields.collection-field.CollectionField.moveAndSaveForm(Object)¶ Move the Form to a different location in the CollectionField’s mapa then save the changes to the changed Form (a.k.a. record, doc, item). The schema of the form is determined by the fields array property of the CollectionField
Arguments: - Object (Object) –
- Object.sourceIndex (number) – The index of where the form was
- Object.destinationIndex (number) – The index of where it is being moved to
- Object.muteChange (boolean) – Whether or not we notify the UI
Returns: Object – The newly saved Form (record).
-
mson.src.fields.collection-field.CollectionField.moveForm(Object)¶ Move the Form to a different location in the CollectionField’s mapa without saving changes to the Form. The schema of the form is determined by the fields array property of the CollectionField
Arguments: - Object (Object) –
- Object.sourceIndex (number) – The index of where the form was
- Object.destinationIndex (number) – The index of where it is being moved to
- Object.muteChange (boolean) – Whether or not we notify the UI
Returns: Object – The changed Form (record).
-
-
class
CollectionField()¶ CollectionField
The CollectionField stores a list of MSON Form Components ( aka records, docs, documents) in a list mapa.
Items can be inserted, moved, reordered, etc.
-
CollectionField.moveAndSaveForm(Object)¶ Move the Form to a different location in the CollectionField’s mapa then save the changes to the changed Form (a.k.a. record, doc, item). The schema of the form is determined by the fields array property of the CollectionField
Arguments: - Object (Object) –
- Object.sourceIndex (number) – The index of where the form was
- Object.destinationIndex (number) – The index of where it is being moved to
- Object.muteChange (boolean) – Whether or not we notify the UI
Returns: Object – The newly saved Form (record).
-
CollectionField.moveForm(Object)¶ Move the Form to a different location in the CollectionField’s mapa without saving changes to the Form. The schema of the form is determined by the fields array property of the CollectionField
Arguments: - Object (Object) –
- Object.sourceIndex (number) – The index of where the form was
- Object.destinationIndex (number) – The index of where it is being moved to
- Object.muteChange (boolean) – Whether or not we notify the UI
Returns: Object – The changed Form (record).
-
References: