Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Symbol

The Symbol class represents a symbol. Symbol instances are immutable.

Fields

FieldTypeDescription
symbolIDstringRead only. The unique ID for this symbol.
identifierstringRead only. A string suitable as a parameter to the Document method getSymbolByName.

Methods

equals( object )

Returns True if object represents the same symbol as self.

generateSvg(document, x, y, scale, maxSize)

Generate an SVG fragment that renders the symbol at the given position with given scale factor (see Symbol Scale and Size Type) and maxSize, a tuple of (width, height) and can be None.