-
Notifications
You must be signed in to change notification settings - Fork 3
2016 API dlibrary.document
Used for all document related stuff, like units, layers, resources, ....
builtins.object
........AbstractResourceList(builtins.object)
................RecordDefinitionResourceList(AbstractResourceList)
................SymbolDefinitionResourceList(AbstractResourceList)
........DataFieldTypeEnum(builtins.object)
........DefinitionTypeEnum(builtins.object)
........IAttributes(builtins.object)
................IClazzAttributes(IAttributes)
........................Clazz(dlibrary.object_base.AbstractKeyedObject, IClazzAttributes)
................IDocumentAttributes(IAttributes)
........................Document(IDocumentAttributes)
........IRecords(builtins.object)
........Layer(builtins.object)
................DesignLayer(Layer)
................SheetLayer(Layer)
........PatternFillEnum(builtins.object)
........PioFieldTypeEnum(builtins.object)
........RecordField(builtins.object)
........ResourceFolder(builtins.object)
........ResourceLocation(builtins.object)
........Units(builtins.object)
dlibrary.object_base.AbstractKeyedObject(builtins.object)
........AbstractResource(dlibrary.object_base.AbstractKeyedObject)
................RecordDefinition(AbstractResource)
................SymbolDefinition(AbstractResource, IRecords)
........AbstractVectorFill(dlibrary.object_base.AbstractKeyedObject)
................GradientVectorFill(AbstractVectorFill)
................HatchVectorFill(AbstractVectorFill)
................ImageVectorFill(AbstractVectorFill)
................TileVectorFill(AbstractVectorFill)
........AbstractVectorLine(dlibrary.object_base.AbstractKeyedObject)
................LineStyle(AbstractVectorLine)
........Clazz(dlibrary.object_base.AbstractKeyedObject, IClazzAttributes)
........Record(dlibrary.object_base.AbstractKeyedObject)
Class to represent a document resource.
OBSOLETE name parameter. Will be removed and is now optional.
:type handle_or_name: vs.Handle | str
__init__(self, resource_type: int, abstract_resource: , location: int=0, folder: int=0, path: str='')
:type location: ResourceLocation
:type folder: ResourceFolder
Abstract base class for vector fills = fill resources.
:type handle_or_name: vs.Handle | str
Abstract base class for vector lines = line resources.
:type handle_or_name: vs.Handle | str
Class for working with class definitions.
:type handle_or_name: vs.Handle | str
Creates a new class with the given name.
:rtype: Clazz
Gets the class, creates if not found.
:rtype: Clazz
Holds all data field type constants. There are for data records and worksheets, not for PIO field types.
- BOOLEAN = 2
- INTEGER = 1
- NUMBER_ANGLE = 10
- NUMBER_DATETIME = 11
- NUMBER_DECIMAL = 5
- NUMBER_DIMENSION = 9
- NUMBER_DIMENSION_AREA = 14
- NUMBER_DIMENSION_VOLUME = 15
- NUMBER_FRACTIONAL = 8
- NUMBER_GENERAL = 3
- NUMBER_PERCENTAGE = 6
- NUMBER_SCIENTIFIC = 7
- TEXT = 4
SYMBOL_DEFINITION is OBSOLETE. Use ObjectTypeEnum from object_base!
- RECORD_DEFINITION = 47
- SYMBOL_DEFINITION = 16
Class to represent the active document. Python scripts are always executed in context of the currently active document, that's why this is a singleton.
:rtype: float`
:type handle_or_name: vs.Handle | str
:type handle_or_name: vs.Handle | str
Abstract interface for handling attributes.
Interface for handling class attributes.
Interface for handling document attributes.
Interface that handles attached records.
:type handle_or_name: vs.Handle | str
:type handle_or_name: vs.Handle | str
Holds the most important pattern fill indices in a human readable name. These are No fill, background color fill and foreground color fill. It is recommended to not use any other fills anymore, as there are several issues with them, especially with printing.
- BACKGROUND_COLOR = 1
- FOREGROUND_COLOR = 2
- NONE = 0
Holds all data field type constants for PIO fields.
- BOOLEAN = 2
- INTEGER = 1
- REAL = 3
- REAL_DIMENSION = 7
- REAL_X_COORDINATE = 10
- REAL_Y_COORDINATE = 11
- TEXT = 4
- TEXT_CLASS_POPUP = 18
- TEXT_POPUP = 8
- TEXT_RADIO_BUTTON = 9
- TEXT_STATIC = 14
Class to represent a record instance, aka attached record.
Get the field based on it's index, 1-n based.
Class to represent a record definition.
OBSOLETE name parameter. Will be removed and is now made optional.
:type handle_or_name: vs.Handle | str
:type location: ResourceLocation
:type folder: ResourceFolder
Class to handle record instance fields.
__init__(self, record_handle: vs.Handle, index: int, record_name: str, object_handle: vs.Handle, parametric: bool)
"Constants for all possible application resource folders.
- DEFAULTS = 14
- NONE = 0
"Constants that reflect where to get the asked resources from.
- APP = -1
- DOC = 0
- DOC_APP = 1
Class to represent a symbol definition.
OBSOLETE name parameter. This will be removed and is now optional.
:type handle: vs.Handle | str
OBSOLETE. Use ObjectRepository().get(handle_or_name) from object_base instead.
OBSOLETE, use Symbol.create instead!
:type location: ResourceLocation
:type folder: ResourceFolder
:type handle_or_name: vs.Handle | str
Will return the same, but length unit strings will be transformed to floats.
For a float or str dimension, this will return a float.
For a tuple, which would be a point, this will return a tuple of floats.:type dimension: float | str | tuple
:rtype: float | tuple
:type length_in_length_units_or_str: float || str
:type length_in_inches_or_str: float || str
d:\development\vw libraries\dlibrary\dlibrary\document.py