diff options
author | bobzel <zzzman@gmail.com> | 2023-05-14 12:03:40 -0400 |
---|---|---|
committer | bobzel <zzzman@gmail.com> | 2023-05-14 12:03:40 -0400 |
commit | 42afc0250de658fc3e924864bfae5afb4edec335 (patch) | |
tree | d61bbc43d95cb6e1d6fa5c997102d505adc09af5 /src/fields/documentSchemas.ts | |
parent | 0849fbd97c61688d51e5fea6cf8edc47989df5de (diff) |
major overhaul of field naming conventions.
Diffstat (limited to 'src/fields/documentSchemas.ts')
-rw-r--r-- | src/fields/documentSchemas.ts | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/src/fields/documentSchemas.ts b/src/fields/documentSchemas.ts index b7fd06973..7b2fd74d0 100644 --- a/src/fields/documentSchemas.ts +++ b/src/fields/documentSchemas.ts @@ -13,11 +13,11 @@ export const documentSchema = createSchema({ links: listSpec(Doc), // computed (readonly) list of links associated with this document // "Location" properties in a very general sense - _curPage: 'number', // current page of a page based document + _layout_curPage: 'number', // current page of a page based document _currentFrame: 'number', // current frame of a frame based collection (e.g., a progressive slide) lastFrame: 'number', // last frame of a frame based collection (e.g., a progressive slide) activeFrame: 'number', // the active frame of a frame based animated document - _currentTimecode: 'number', // current play back time of a temporal document (video / audio) + _layout_currentTimecode: 'number', // current play back time of a temporal document (video / audio) _timecodeToShow: 'number', // the time that a document should be displayed (e.g., time an annotation should be displayed on a video) _timecodeToHIde: 'number', // the time that a document should be hidden markers: listSpec(Doc), // list of markers for audio / video @@ -25,52 +25,52 @@ export const documentSchema = createSchema({ y: 'number', // y coordinate when in a freeform view z: 'number', // z "coordinate" - non-zero specifies the overlay layer of a freeformview zIndex: 'number', // zIndex of a document in a freeform view - _scrollTop: 'number', // scroll position of a scrollable document (pdf, text, web) + _layout_scrollTop: 'number', // scroll position of a scrollable document (pdf, text, web) lat: 'number', lng: 'number', // appearance properties on the layout '_backgroundGrid-spacing': 'number', // the size of the grid for collection views - _autoHeight: 'boolean', // whether the height of the document should be computed automatically based on its contents + _layout_autoHeight: 'boolean', // whether the height of the document should be computed automatically based on its contents _nativeWidth: 'number', // native width of document which determines how much document contents are scaled when the document's width is set _nativeHeight: 'number', // " _width: 'number', // width of document in its container's coordinate system _height: 'number', // " - _xPadding: 'number', // pixels of padding on left/right of collectionfreeformview contents when fitContentsToBox is set - _yPadding: 'number', // pixels of padding on top/bottom of collectionfreeformview contents when fitContentsToBox is set + _xPadding: 'number', // pixels of padding on left/right of collectionfreeformview contents when freeform_fitContentsToBox is set + _yPadding: 'number', // pixels of padding on top/bottom of collectionfreeformview contents when freeform_fitContentsToBox is set _xMargin: 'number', // margin added on left/right of most documents to add separation from their container _yMargin: 'number', // margin added on top/bottom of most documents to add separation from their container _overflow: 'string', // sets overflow behvavior for CollectionFreeForm views - _showCaption: 'string', // whether editable caption text is overlayed at the bottom of the document - _showTitle: 'string', // the fieldkey(s) whose contents should be displayed at the top of the document. separate multiple keys with ";". Use :hover suffix to indicate title should be shown on hover + _layout_showCaption: 'string', // whether editable caption text is overlayed at the bottom of the document + _layout_showTitle: 'string', // the fieldkey(s) whose contents should be displayed at the top of the document. separate multiple keys with ";". Use :hover suffix to indicate title should be shown on hover _pivotField: 'string', // specifies which field key should be used as the timeline/pivot axis _columnsFill: 'boolean', // whether documents in a stacking view column should be sized to fill the column _columnsSort: 'string', // how a document should be sorted "ascending", "descending", undefined (none) _columnsHideIfEmpty: 'boolean', // whether empty stacking view column headings should be hidden - _columnHeaders: listSpec(SchemaHeaderField), // header descriptions for stacking/masonry - _schemaHeaders: listSpec(SchemaHeaderField), // header descriptions for schema views + // _columnHeaders: listSpec(SchemaHeaderField), // header descriptions for stacking/masonry + // _schemaHeaders: listSpec(SchemaHeaderField), // header descriptions for schema views _fontSize: 'string', _fontFamily: 'string', - _sidebarWidthPercent: 'string', // percent of text window width taken up by sidebar + _layout_sidebarWidthPercent: 'string', // percent of text window width taken up by sidebar // appearance properties on the data document backgroundColor: 'string', // background color of document borderRounding: 'string', // border radius rounding of document boxShadow: 'string', // the amount of shadow around the perimeter of a document color: 'string', // foreground color of document - fitContentsToBox: 'boolean', // whether freeform view contents should be zoomed/panned to fill the area of the document view box + freeform_fitContentsToBox: 'boolean', // whether freeform view contents should be zoomed/panned to fill the area of the document view box fontSize: 'string', hidden: 'boolean', // whether a document should not be displayed - isInkMask: 'boolean', // is the document a mask (ie, sits on top of other documents, has an unbounded width/height that is dark, and content uses 'hard-light' mix-blend-mode to let other documents pop through) - layout: 'string', // this is the native layout string for the document. templates can be added using other fields and setting layoutKey below - layoutKey: 'string', // holds the field key for the field that actually holds the current lyoat + stroke_isInkMask: 'boolean', // is the document a mask (ie, sits on top of other documents, has an unbounded width/height that is dark, and content uses 'hard-light' mix-blend-mode to let other documents pop through) + layout: 'string', // this is the native layout string for the document. templates can be added using other fields and setting layout_fieldKey below + layout_fieldKey: 'string', // holds the field key for the field that actually holds the current lyoat letterSpacing: 'string', opacity: 'number', // opacity of document - strokeWidth: 'number', - strokeBezier: 'number', - strokeStartMarker: 'string', - strokeEndMarker: 'string', - strokeDash: 'string', + stroke_width: 'number', + stroke_bezier: 'number', + stroke_startMarker: 'string', + stroke_endMarker: 'string', + stroke_dash: 'string', textTransform: 'string', treeViewOpen: 'boolean', // flag denoting whether the documents sub-tree (contents) is visible or hidden treeViewExpandedView: 'string', // name of field whose contents are being displayed as the document's subtree @@ -87,20 +87,20 @@ export const documentSchema = createSchema({ followLinkLocation: 'string', // flag for where to place content when following a click interaction (e.g., add:right, lightbox, default, ) hideLinkButton: 'boolean', // whether the blue link counter button should be hidden hideAllLinks: 'boolean', // whether all individual blue anchor dots should be hidden - linkDisplay: 'boolean', // whether a link connection should be shown between link anchor endpoints. + layout_linkDisplay: 'boolean', // whether a link connection should be shown between link anchor endpoints. isLightbox: 'boolean', // whether the marked object will display addDocTab() calls that target "lightbox" destinations layers: listSpec('string'), // which layers the document is part of _lockedPosition: 'boolean', // whether the document can be moved (dragged) _lockedTransform: 'boolean', // whether a freeformview can pan/zoom - linkDisplayArrow: 'boolean', // toggles directed arrows + layout_linkDisplayArrow: 'boolean', // toggles directed arrows // drag drop properties _stayInCollection: 'boolean', // whether document can be dropped into a different collection dragFactory: Doc, // the document that serves as the "template" for the onDragStart script. ie, to drag out copies of the dragFactory document. - dropAction: 'string', // override specifying what should happen when this document is dropped (can be "alias", "copy", "move") - targetDropAction: 'string', // allows the target of a drop event to specify the dropAction ("alias", "copy", "move") NOTE: if the document is dropped within the same collection, the dropAction is coerced to 'move' - childDropAction: 'string', // specify the override for what should happen when the child of a collection is dragged from it and dropped (can be "alias" or "copy") - removeDropProperties: listSpec('string'), // properties that should be removed from the alias/copy/etc of this document when it is dropped + dropAction: 'string', // override specifying what should happen when this document is dropped (can be "embed", "copy", "move") + targetDropAction: 'string', // allows the target of a drop event to specify the dropAction ("embed", "copy", "move") NOTE: if the document is dropped within the same collection, the dropAction is coerced to 'move' + childDropAction: 'string', // specify the override for what should happen when the child of a collection is dragged from it and dropped (can be "embed" or "copy") + removeDropProperties: listSpec('string'), // properties that should be removed from the embed/copy/etc of this document when it is dropped }); export const collectionSchema = createSchema({ |