Note and Position Number Symbols
- Last UpdatedNov 24, 2023
- 1 minute read
Functions for accessing modal properties for notes and position numbers.
See Creating Note and Position Number symbols in Drafting User's Guide for further information..
|
note_symbol_set(Symbol) |
||
|
The function sets the modal note symbol. |
||
|
Input Parameters: |
||
|
Symbol |
integer |
The modal note symbol in the font for Note symbols (range [31-60] in the standard font, range [1-400] in the alternative font). |
|
(to suppress the note symbol, give -1) |
||
|
Returned value: |
||
|
None |
||
|
Exceptions: |
||
|
SymbolInvalid |
||
|
note_symbol_get() |
||
|
The function gets the modal note symbol. |
||
|
Input Parameters: |
||
|
None |
||
|
Returned value: |
||
|
[0] |
integer |
The modal note symbol in the font for Note symbols |
|
Exceptions: |
||
|
None |
||
|
posno_symbol_set(Symbol) |
||
|
The function sets the modal position number symbol. |
||
|
Input Parameters: |
||
|
Symbol |
integer |
The modal position symbol in the font for Position Number symbols (range [61-80] in the standard font, range [601-999] in the alternative font). |
|
Returned value: |
||
|
None |
||
|
Exceptions: |
||
|
SymbolInvalid |
||
|
posno_symbol_get() |
||
|
The function gets the modal position number symbol. |
||
|
Input Parameters: |
||
|
None |
||
|
Returned value: |
||
|
[0] |
integer |
The modal position symbol in the font for Position Number symbols |
|
Exceptions: |
||
|
None |
||
|
posno_height_set(Height) |
||
|
The function sets the modal height of position number symbols. |
||
|
Input Parameters: |
||
|
Height |
real |
The height of position number symbols (> 0.0) |
|
Returned value: |
||
|
None |
||
|
Exceptions: |
||
|
kcs_ValueError |
Invalid parameter value |
|
|
posno_height_get() |
||
|
The function gets the modal height of position number symbols. |
||
|
Input Parameters: |
||
|
None |
||
|
Returned value: |
||
|
[0] |
real |
The height of position number symbols |
|
Exceptions: |
||
|
None |
||
|
Example: |
||
|
# Example: kcs_ex_draft4.py |
||