Document QML Type
Each instance of this type represents an open document. More...
| Import Statement: | import BrickStore 1.0 |
Properties
- currencyCode : string
- fileName : string
- lotCount : string
- order : Order
- title : string
- visibleLotCount : string
Methods
- int lots.add(Item item, Color color)
- Lot lots.at(int index)
- lots.remove(Lot lot)
- lots.removeAt(int index)
- lots.removeVisibleAt(int index)
- Lot lots.visibleAt(int index)
Detailed Description
Note: The index parameter of the lot API is the index into the internal data structure and not related to any sorting or filtering in the visible document window.
Property Documentation
currencyCode : string |
The ISO currency code used in this document, e.g. EUR.
fileName : string |
The file name of this document. New and imported documents that have not been saved yet will not have fileName set.
lotCount : string |
The number of lots in this document. This count is ignoring filtering.
order : Order |
An Order object or null, if this document is not a BrickLink order.
title : string |
The title of this document. Documents loaded from files do not have titles, but documents created from online imports do. A store import would have a title like Store import <date>.
visibleLotCount : string |
The number of visible lots in this document. This count is after filtering: it's the the exact number of visible lots as seen in the document view.
Method Documentation
Adds a new lot for the given item and color combination to the document. Returns the index of the newly created lot in the document. This index is independent of sort order and filtering.
Lot lots.at(int index) |
Returns the lot at the specified index in the document. This index is independent of sort order and filtering.
lots.remove(Lot lot) |
Removes the specified lot from the document.
lots.removeAt(int index) |
Removes the lot at the specified index from the document. This index is independent of sort order and filtering.
lots.removeVisibleAt(int index) |
Removes the lot at the specified visible index from the document. This index is taking sort order and filtering into account: it's the the exact visible index as seen in the document view.
Lot lots.visibleAt(int index) |
Returns the lot at the specified visible index in the document. This index is taking sort order and filtering into account: it's the the exact visible index as seen in the document view.
© 2004-2025 Robert Griebl. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.