KLayout Manual: Main Index » Class Index » API reference - Class LayoutView

API reference - Class LayoutView

Notation used in Ruby API documentation

Description: The view object presenting one or more layout objects

• Public constructors
• Public methods
• Public static methods and constants
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

The visual part of the view is the tab panel in the main window. The non-visual part are the redraw thread, the layout handles, cell lists, layer view lists etc. This object controls these aspects of the view and controls the appearance of the data.

Public constructors

Public methods

Public static methods and constants

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

[const] CellView active_cellview

Description: Get the active cellview (shown in hierarchy browser)

This is a convenience method which is equivalent to cellview(active_cellview_index()).

This method has been introduced in version 0.19.

[const] int active_cellview_index

Description: Get the index of the active cellview (shown in hierarchy browser)

void add_active_cellview_observer(ObserverBase observer)

Description: Add an observer for the active cellview

If the active cellview is changed by selecting a new one from the drop-down list, this observer is triggered.

This method has been added in version 0.23.

void add_cell_visibility_observer(ObserverBase observer)

Description: Add a cell visibility observer

If a cell is hidden or shown, this observer is triggered.

void add_cellview_list_observer(ObserverBase observer)

Description: Add a cellview list observer

If a cellview is added or removed, this observer is triggered.

void add_cellview_observer(ObserverBase observer)

Description: Add a cellview observer

If a cellview is changed (i.e. the cell is changed) this event is sent. The integer argument slot ("signal_int") of the observer will be triggered as well with the index of the cellview that has changed.

void add_file_open_observer(ObserverBase observer)

Description: Add a file open observer

If a new file is loaded, this observer is triggered.

void add_layer_list_observer(ObserverBase observer)

Description: Add a layer list observer

If the layer list changes, the observer's "signal_int" and "signal" slot is triggered. The int's bit 0 is set, if the properties have changed. If the arguments bit 1 is set, the hierarchy has changed.

void add_missing_layers

Description: Add new layers to layer list

This method was introduced in version 0.19.

void add_rdb_list_changed_observer(ObserverBase observer)

Description: Add a observer for the list of report databases

If a report database is added or removed, this observer is triggered.

void add_selection_changed_observer(ObserverBase observer)

Description: Add a selection observer

If the selection is changed, this observer is triggered.

This method was added in version 0.18.

unsigned int add_stipple(string name,unsigned int[] data,unsigned int bits)

Description: Add a stipple pattern

'data' is an array of unsigned integers describing the bits that make up the stipple pattern. If the array has less than 32 entries, the pattern will be repeated vertically. The number of bits used can be less than 32 bit which can be specified by the 'bits' parameter. Logically, the pattern will be put at the end of the list.

void add_transient_selection_changed_observer(ObserverBase observer)

Description: Add a transient selection observer

If the transient selection is changed, this observer is triggered.

This method was added in version 0.18.

void add_viewport_changed_observer(ObserverBase observer)

Description: Add a viewport changed observer

If the viewport (the rectangle that is shown) changes, this observer is triggered.

InstElement ascend(int index)

Description: Ascend upwards in the hierarchy.

Removes one element from the specific path of the cellview with the given index. Returns the element removed.

[const] LayerPropertiesIterator begin_layers

Description: Begin iterator for the layers

This iterator delivers the layers of this view, either in a recursive or non-recursive fashion, depending which iterator increment methods are used. The iterator delivered by end_layers is the past-the-end iterator. It can be compared agains a current iterator to check, if there are no further elements.

[const] LayerPropertiesIterator begin_layers(unsigned int index)

Description: Begin iterator for the layers

This iterator delivers the layers of this view, either in a recursive or non-recursive fashion, depending which iterator increment methods are used. The iterator delivered by end_layers is the past-the-end iterator. It can be compared agains a current iterator to check, if there are no further elements. This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21.

void bookmark_view(string name)

Description: Bookmark the current view under the given name

[const] DBox box

Description: Return the displayed box in micron space

void cancel

Description: Cancel all edit operations

This method will stop all pending edit operations (i.e. drag and drop) and cancel the current selection. Calling this method is useful to ensure there are no potential interactions with the script's functionality.

[const] CellView cellview(unsigned int cv_index)

Description: Get the cellview object for a given index

[const] unsigned int cellviews

Description: Get the number of cellviews

void clear_annotations

Description: Clears all annotations on this view

void clear_config

Description: Clear the local configuration parameters

See set_config for a description of the local configuration parameters.

void clear_images

Description: Clear all images on this view

void clear_layers

Description: Clear all layers

void clear_layers(unsigned int index)

Description: Clear all layers for the given layer properties list

This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21.

[const] void clear_object_selection

Description: Clears the selection of geometrical objects (shapes or cell instances)

The selection of other objects (such as annotations and images) will not be affected.

This method has been introduced in version 0.24

void clear_stipples

Description: Remove all stipple pattern

All stipple pattern except the fixed ones are removed. If any of the custom stipple pattern is still used by the layers displayed, the results will not be predictable.

void clear_transactions

Description: Clear all transactions

Discard all actions in the undo buffer. After clearing that buffer, no undo is available. It is important to clear the buffer when making database modifications outside transactions, i.e after that modifications have been done. If failing to do so, 'undo' operations are likely to produce invalid results. This method was introduced in version 0.16.

void commit

Description: End a transaction

See transaction for a detailed description of transactions. This method was introduced in version 0.16.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

unsigned int create_layout(bool add_cellview)

Description: Create a new, empty layout

The add_cellview parameter controls whether to create a new cellview (true) or clear all cellviews before (false).

This version will associate the new layout with the default technology.

unsigned int create_layout(string tech,bool add_cellview)

Description: Create a new, empty layout and associate it with the given technology

The add_cellview parameter controls whether to create a new cellview (true) or clear all cellviews before (false).

This variant has been introduced in version 0.22.

unsigned int create_layout(string tech,bool add_cellview,bool init_layers)

Description: Create a new, empty layout and associate it with the given technology

The add_cellview parameter controls whether to create a new cellview (true) or clear all cellviews before (false). This variant also allows to control whether the layer properties are initialized (init_layers = true) or not (init_layers = false).

This variant has been introduced in version 0.22.

unsigned int create_rdb(string name)

Description: Creates a new report database and returns the index of the new database

This method returns an index of the new report database. Use rdb to get the actual object. If a report database with the given name already exists, a unique name will be created. The name will be replaced by the file name when a file is loaded into the report database.

[static] LayoutView ptr current

Description: Returns the current view

The current view is the one that is shown in the current tab. Returns nil if no layout is loaded.

This method has been introduce in version 0.23.

[const] LayerPropertiesIterator current_layer

Description: Gets the current layer view

Returns the LayerPropertiesIterator pointing to the current layer view (the one that has the focus). If no layer view is active currently, a null iterator is returned.

Python specific notes:

The object exposes a readable attribute 'current_layer'. This is the getter.

void current_layer=(const LayerPropertiesIterator iter)

Description: Sets the current layer view

Specifies an LayerPropertiesIterator pointing to the new current layer view.

This method has been introduced in version 0.23.

Python specific notes:

The object exposes a writable attribute 'current_layer'. This is the setter.

[const] unsigned int current_layer_list

Description: Gets the index of the currently selected layer properties tab

This method has been introduced in version 0.21.

Python specific notes:

The object exposes a readable attribute 'current_layer_list'. This is the getter.

void current_layer_list=(unsigned int index)

Description: Sets the index of the currently selected layer properties tab

This method has been introduced in version 0.21.

Python specific notes:

The object exposes a writable attribute 'current_layer_list'. This is the setter.

void delete_layer(LayerPropertiesIterator iter)

Description: Delete the layer properties node specified by the iterator

This method deletes the object that the iterator points to and invalidates the iterator since the object that the iterator points to is no longer valid.

void delete_layer(unsigned int index,LayerPropertiesIterator iter)

Description: Delete the layer properties node specified by the iterator

This method deletes the object that the iterator points to and invalidates the iterator since the object that the iterator points to is no longer valid. This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21.

void delete_layer_list(unsigned int index)

Description: Deletes the given properties list

At least one layer properties list must remain. This method may change the current properties list. This method has been introduced in version 0.21.

void delete_layers(LayerPropertiesIterator[] iterators)

Description: Delete the layer properties nodes specified by the iterator

This method deletes the nodes specifies by the iterators. This method is the most convenient way to delete multiple entries.

This method has been added in version 0.22.

void delete_layers(unsigned int index,LayerPropertiesIterator[] iterators)

Description: Delete the layer properties nodes specified by the iterator

This method deletes the nodes specifies by the iterators. This method is the most convenient way to delete multiple entries. This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.22.

void descend(InstElement[] path,int index)

Description: Descend further into the hierarchy.

Adds the given path (given as an array of InstElement objects) to the specific path of the cellview with the given index. In effect, the cell addressed by the terminal of the new path components can be shown in the context of the upper cells, if the minimum hierarchy level is set to a negative value. The path is assumed to originate from the current cell and contain specific instances sorted from top to bottom.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[iter] Annotation each_annotation

Description: Iterates over all annotations attached to this view

[const,iter] Annotation each_annotation_selected

Description: Iterate over each selected annotation objects, yielding a Annotation object for each of them

This method was introduced in version 0.19.

[iter] Image each_image

Description: Iterate over all images attached to this view

[const,iter] Image each_image_selected

Description: Iterate over each selected image object, yielding a Image object for each of them

This method was introduced in version 0.19.

[const,iter] ObjectInstPath each_object_selected

Description: Iterates over each selected geometrical object, yielding a ObjectInstPath object for each of them

This iterator will deliver const objects - they cannot be modified. In order to modify the selection, create a copy of the ObjectInstPath objects, modify them and install the new selection using select_object or object_selection=.

Another way of obtaining the selection is object_selection, which returns an array of ObjectInstPath objects.

[const,iter] ObjectInstPath each_object_selected_transient

Description: Iterates over each geometrical objects in the transient selection, yielding a ObjectInstPath object for each of them

This method was introduced in version 0.18.

void enable_edits(bool enable)

Description: Enable or disable editing

[const] LayerPropertiesIterator end_layers

Description: End iterator for the layers

See begin_layers for a description about this iterator

[const] LayerPropertiesIterator end_layers(unsigned int index)

Description: End iterator for the layers

See begin_layers for a description about this iterator This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21.

void erase_annotation(int id)

Description: Erases the annotation given by the id

Deletes an existing annotation given by the id parameter. The id of an annotation can be obtained through Annotation#id.

This method has been introduced in version 0.24.

void erase_cellview(unsigned int index)

Description: Erase the cellview with the given index

This closes the given cellview and unloads the layout associated with it, unless referred to by another cellview.

void erase_image(unsigned long id)

Description: Erase the given image

Erases the image with the given Id. The Id can be obtained with if "id" method of the image object.

This method has been introduced in version 0.20.

void expand_layer_properties

Description: Expands the layer properties for all tabs

This method will expand all wildcard specifications in the layer properties by iterating over the specified objects (i.e. layers, cellviews) and by replacing default colors and stipples by the ones specified with the palettes.

This method was introduced in version 0.21.

void expand_layer_properties(unsigned int index)

Description: Expands the layer properties for the given tab

This method will expand all wildcard specifications in the layer properties by iterating over the specified objects (i.e. layers, cellviews) and by replacing default colors and stipples by the ones specified with the palettes.

This method was introduced in version 0.21.

[const] string get_config(string name)

Description: Get the value of a local configuration parameter

See set_config for a description of the local configuration parameters.

[const] unsigned int[] get_current_cell_path(int cv_index)

Description: Cell path of the current cell

The current cell is the one highlighted in the browser with the focus rectangle. The current path is returned for the cellview given by cv_index. The cell path is a list of cell indices from the top cell to the current cell.

QImage get_image(unsigned int width,unsigned int height)

Description: Gets the layout image as a QImage

The image contains the current scene (layout, annotations etc.). The image is drawn synchroneously with the given width and height. Drawing may take some time.

QImage get_image_with_options(unsigned int width,unsigned int height,int linewidth,int oversampling,double resolution,const DBox target,bool monochrome)

Description: Gets the layout image as a QImage (with options)

The image contains the current scene (layout, annotations etc.). The image is written as a PNG file to the given file. The image is drawn synchroneously with the given width and height. Drawing may take some time. Monochrome images don't have background or annotation objects currently.

This method has been introduced in 0.23.10.

QImage get_screenshot

Description: Gets a screenshot as a QImage

Getting the image requires the drawing to be complete. Ideally, synchroneous mode is switched on for the application to guarantee this condition. The image will have the size of the viewport showing the current layout.

[const] bool has_annotation_selection?

Description: Returns true, if annotations (rulers) are selected in this view

This method was introduced in version 0.19.

[const] bool has_image_selection?

Description: Returns true, if images are selected in this view

This method was introduced in version 0.19.

[const] bool has_object_selection?

Description: Returns true, if geometrical objects (shapes or cell instances) are selected in this view

[const] bool has_transient_object_selection?

Description: Returns true, if geometrical objects (shapes or cell instances) are selected in this view in the transient selection

The transient selection represents the objects selected when the mouse hovers over the layout windows. This selection is not used for operations but rather to indicate which object would be selected if the mouse is clicked.

This method was introduced in version 0.18.

void hide_cell(unsigned int cell_index,int cv_index)

Description: Hide the given cell for the given cellview

[const] void init_layer_properties(LayerProperties props)

Description: Fill the layer properties for a new layer

This method initializes a layer properties object's color and stipples according to the defaults for the given layer source specification. The layer's source must be set already on the layer properties object.

This method was introduced in version 0.19.

void insert_annotation(const Annotation obj)

Description: Inserts an annotation object into the given view

Inserts a new annotation into the view. Existing annotation will remain. Use clear_annotations to delete them before inserting new ones. Use replace_annotation to replace an existing one with a new one.

void insert_image(const Image obj)

Description: Insert an image object into the given view

Insert the image object given by obj into the view.

const LayerPropertiesNode ptr insert_layer(const LayerPropertiesIterator iter,const LayerProperties node)

Description: Insert the given layer properties node into the list before the given position

This method inserts the new properties node before the position given by "iter" and returns a const reference to the element created. The iterator that specified the position will remain valid after the node was inserted and will point to the newly created node. It can be used to add futher nodes. To add children to the node inserted, use iter.last_child as insertion point for the next insert operations.

Since version 0.22, this method accepts LayerProperties and LayerPropertiesNode objects. A LayerPropertiesNode object can contain a hierarchy of further nodes.

const LayerPropertiesNode ptr insert_layer(unsigned int index,const LayerPropertiesIterator iter,const LayerProperties node)

Description: Insert the given layer properties node into the list before the given position

This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method inserts the new properties node before the position given by "iter" and returns a const reference to the element created. The iterator that specified the position will remain valid after the node was inserted and will point to the newly created node. It can be used to add futher nodes. This method has been introduced in version 0.21. Since version 0.22, this method accepts LayerProperties and LayerPropertiesNode objects. A LayerPropertiesNode object can contain a hierarchy of further nodes.

void insert_layer_list(unsigned int index)

Description: Inserts a new layer properties list at the given index

This method inserts a new tab at the given position. The current layer properties list will be changed to the new list. This method has been introduced in version 0.21.

[const] bool is_cell_hidden?(unsigned int cell_index,int cv_index)

Description: Tell, if the cell is hidden

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

bool is_transacting?

Description: Tell if a transaction is ongoing

See transaction for a detailed description of transactions. This method was introduced in version 0.16.

void load_layer_props(string fn)

Description: Load the layer properties

Load the layer properties from the file given in "fn"

void load_layer_props(string fn,bool add_default)

Description: Load the layer properties with options

Load the layer properties from the file given in "fn". This version allows to specify whether defaults should be used for all other layers by setting "add_default" to true.

This variant has been added on version 0.21.

void load_layer_props(string fn,int cv_index,bool add_default)

Description: Load the layer properties with options

Load the layer properties from the file given in "fn". This version allows to specify whether defaults should be used for all other layers by setting "add_default" to true. It can be used to load the layer properties for a specific cellview by setting "cv_index" to the index for which the layer properties file should be applied. All present definitions for this layout will be removed before the properties file is loaded. "cv_index" can be set to -1. In that case, the layer properties file is applied to each of the layouts individually.

Note that this version will override all cellview index definitions in the layer properties file.

This variant has been added on version 0.21.

unsigned int load_layout(string filename,const LoadLayoutOptions options,string technology,bool add_cellview)

Description: Load a (new) file into the layout view with the given technology

Loads the file given by the "filename" parameter and associates it with the given technology. The options specify various options for reading the file. The add_cellview param controls whether to create a new cellview (true) or clear all cellviews before (false).

This version has been introduced in version 0.22.

unsigned int load_layout(string filename,const LoadLayoutOptions options,bool add_cellview)

Description: Load a (new) file into the layout view

Loads the file given by the "filename" parameter. The options specify various options for reading the file. The add_cellview param controls whether to create a new cellview (true) or clear all cellviews before (false).

This method has been introduced in version 0.18.

unsigned int load_layout(string filename,string technology,bool add_cellview)

Description: Load a (new) file into the layout view with the given technology

Loads the file given by the "filename" parameter and associates it with the given technology. The add_cellview param controls whether to create a new cellview (true) or clear all cellviews before (false).

This version has been introduced in version 0.22.

unsigned int load_layout(string filename,bool add_cellview)

Description: Load a (new) file into the layout view

Loads the file given by the "filename" parameter. The add_cellview param controls whether to create a new cellview (true) or clear all cellviews before (false).

void max_hier

Description: Select all hierarchy levels available

Show the layout in full depth down to the deepest level of hierarchy. This method may cause a redraw.

[const] int max_hier_levels

Description: Returns the maximum hierarchy level up to which to display geometries

Python specific notes:

The object exposes a readable attribute 'max_hier_levels'. This is the getter.

void max_hier_levels=(int level)

Description: Set the maximum hierarchy level up to which to display geometries

This methods allows to set the maximum hierarchy below which to display geometries.This method may cause a redraw if required.

Python specific notes:

The object exposes a writable attribute 'max_hier_levels'. This is the setter.

[const] int min_hier_levels

Description: Returns the minimum hierarchy level at which to display geometries

Python specific notes:

The object exposes a readable attribute 'min_hier_levels'. This is the getter.

void min_hier_levels=(int level)

Description: Set the minimum hierarchy level at which to display geometries

This methods allows to set the minimum hierarchy level above which to display geometries.This method may cause a redraw if required.

Python specific notes:

The object exposes a writable attribute 'min_hier_levels'. This is the setter.

[static] new LayoutView ptr new

Description: Creates a new object of this class

Python specific notes:

This method is the default initializer of the object

[const] unsigned int num_layer_lists

Description: Gets the number of layer properties tabs present

This method has been introduced in version 0.23.

[const] unsigned int num_rdbs

Description: Get the number of report databases loaded into this view

[const] ObjectInstPath[] object_selection

Description: Returns a list of selected objects

This method will deliver an array of ObjectInstPath objects listing the selected geometrical objects. Other selected objects such as annotations and images will not be contained in that list.

The list returned is an array of copies of ObjectInstPath objects. They can be modified, but they will become a new selection only after re-introducing them into the view through object_selection= or select_object.

Another way of obtaining the selected objects is each_object_selected.

This method has been introduced in version 0.24.

Python specific notes:

The object exposes a readable attribute 'object_selection'. This is the getter.

[const] void object_selection=(ObjectInstPath[] sel)

Description: Sets the list of selected objects

This method will set the selection of geometrical objects such as shapes and instances. It is the setter which complements the object_selection method.

Another way of setting the selection is through clear_object_selection and select_object.

This method has been introduced in version 0.24.

Python specific notes:

The object exposes a writable attribute 'object_selection'. This is the setter.

void pan_center(const DPoint p)

Description: Pan to the given point

The window is positioned such that "p" becomes the new center

void pan_down

Description: Pan down

void pan_left

Description: Pan to the left

void pan_right

Description: Pan to the right

void pan_up

Description: Pan upward

ReportDatabase ptr rdb(int index)

Description: Gets the report database with the given index

void reload_layout(unsigned int cv)

Description: Reload the given cellview

void remove_active_cellview_observer(ObserverBase observer)

Description: Remove an observer for the active cellview

This method has been added in version 0.23.

void remove_cell_visibility_observer(ObserverBase observer)

Description: Remove a cell visibility observer

void remove_cellview_list_observer(ObserverBase observer)

Description: Remove a cellview list observer

void remove_cellview_observer(ObserverBase observer)

Description: Remove a cellview observer

void remove_file_open_observer(ObserverBase observer)

Description: Remove a file open observer

void remove_layer_list_observer(ObserverBase observer)

Description: Remove a layer list observer

void remove_rdb(unsigned int index)

Description: Remove a report database with the given index

void remove_rdb_list_changed_observer(ObserverBase observer)

Description: Remove a observer for the list of report databases

void remove_selection_changed_observer(ObserverBase observer)

Description: Remove a selection observer

This method was added in version 0.18.

void remove_stipple(unsigned int index)

Description: Remove the stipple pattern with the given index

The pattern with an index less than 16 cannot be removed. If a stipple pattern is removed that is still used, the results are not predictable.

void remove_transient_selection_changed_observer(ObserverBase observer)

Description: Remove a transient selection observer

This method was added in version 0.18.

void remove_unused_layers

Description: Remove unused layers from layer list

This method was introduced in version 0.19.

void remove_viewport_changed_observer(ObserverBase observer)

Description: Remove a viewport changed observer

void rename_cellview(string name,int index)

Description: Rename the cellview with the given index

If the name is not unique, a unique name will be constructed from the name given. The name may be different from the filename but is associated with the layout object. If a layout is shared between multiple cellviews (which may happen due to a clone of the layout view for example), all cellviews are renamed.

void rename_layer_list(unsigned int index,string name)

Description: Sets the title of the given layer properties tab

This method has been introduced in version 0.21.

void replace_annotation(int id,const Annotation obj)

Description: Replaces the annotation given by the id with the new one

Replaces an existing annotation given by the id parameter with the new one. The id of an annotation can be obtained through Annotation#id.

This method has been introduced in version 0.24.

void replace_image(unsigned long id,Image new_obj)

Description: Replace an image object with the new image

Replaces the image with the given Id with the new object. The Id can be obtained with if "id" method of the image object.

This method has been introduced in version 0.20.

void replace_layer_node(const LayerPropertiesIterator iter,const LayerProperties node)

Description: Replace the layer node at the position given by "iter" with a new one

Since version 0.22, this method accepts LayerProperties and LayerPropertiesNode objects. A LayerPropertiesNode object can contain a hierarchy of further nodes.

void replace_layer_node(unsigned int index,const LayerPropertiesIterator iter,const LayerProperties node)

Description: Replace the layer node at the position given by "iter" with a new one

This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21. Since version 0.22, this method accepts LayerProperties and LayerPropertiesNode objects. A LayerPropertiesNode object can contain a hierarchy of further nodes.

void reset_title

Description: Reset the title to the standard title

See set_title and title for a description about how titles are handled.

void save_as(unsigned int index,string filename,bool gzip,const SaveLayoutOptions options)

Description: Save a layout to the given stream file

Use of this method is deprecated

void save_as(unsigned int index,string filename,const SaveLayoutOptions options)

Description: Save a layout to the given stream file

The layout with the given index is written to the stream file with the given options. 'options' is a SaveLayoutOptions object that specifies which format to write and further options such as scaling factor etc. Calling this method is equivalent to calling 'write' on the respective layout object.

If the file name ends with a suffix ".gz" or ".gzip", the file is compressed with the zlib algorithm.

void save_image(string filename,unsigned int width,unsigned int height)

Description: Save the layout as an image to the given file

The image contains the current scene (layout, annotations etc.). The image is written as a PNG file to the given file. The image is drawn synchroneously with the given width and height. Drawing may take some time.

void save_image_with_options(string filename,unsigned int width,unsigned int height,int linewidth,int oversampling,double resolution,const DBox target,bool monochrome)

Description: Save the layout as an image to the given file (with options)

The image contains the current scene (layout, annotations etc.). The image is written as a PNG file to the given file. The image is drawn synchroneously with the given width and height. Drawing may take some time. Monochrome images don't have background or annotation objects currently.

This method has been introduced in 0.23.10.

void save_layer_props(string fn)

Description: Save the layer properties

Save the layer properties to the file given in "fn"

void save_screenshot(string filename)

Description: Save a screenshot to the given file

The screenshot is written as a PNG file to the given file. This requires the drawing to be complete. Ideally, synchroneous mode is switched on for the application to guarantee this condition. The image will have the size of the viewport showing the current layout.

void select_cell(unsigned int cell_index,int cv_index)

Description: Select a cell by index for a certain cell view

Select the current (top) cell by specifying a path (a list of cell indices from top to the actual cell) and the cellview index for which this cell should become the currently shown one. This method selects the cell to be drawn. In constrast, the set_current_cell_path method selects the cell that is highlighted in the cell tree (but not necessarily drawn).

void select_cell_path(unsigned int[] cell_index,int cv_index)

Description: Select a cell by cell index for a certain cell view

Select the current (top) cell by specifying a cell indexand the cellview index for which this cell should become the currently shown one. The path to the cell is constructed by selecting one that leads to a top cell. This method selects the cell to be drawn. In constrast, the set_current_cell_path method selects the cell that is highlighted in the cell tree (but not necessarily drawn).

[const] void select_object(const ObjectInstPath obj)

Description: Adds the given selection to the list of selected objects

The selection provided by the ObjectInstPath descriptor is added to the list of selected objects. To clear the previous selection, use clear_object_selection.

The selection of other objects (such as annotations and images) will not be affected.

Another way of selecting objects is object_selection=.

This method has been introduced in version 0.24

[const] LayerPropertiesIterator[] selected_layers

Description: Get the selected layers

Returns an array of LayerPropertiesIterator objects pointing to the currently selected layers. If no layer view is selected currently, an empty array is returned.

void set_active_cellview_index(int index)

Description: Make the cellview with the given index the active one (shown in hierarchy browser)

See active_cellview_index.

void set_config(string name,string value)

Description: Set a local configuration parameter with the given name to the given value

This method sets a local configuration parameter with the given name to the given value. Values can only be strings. Numerical values have to be converted into strings first. Local configuration parameters override global configurations for this specific view. This allows for example to override global settings of background colors. Any local settings are not written to the configuration file.

void set_current_cell_path(int cv_index,unsigned int[] arg2)

Description: Set the path to the current cell

The current cell is the one highlighted in the browser with the focus rectangle. The cell given by the path is hightlighted and scrolled into view. To select the cell to be drawn, use the select_cell or select_cell_path method.

void set_current_layer_list(unsigned int index)

Description: Sets the index of the currently selected layer properties tab

Use of this method is deprecated. Use current_layer_list= instead

void set_layer_properties(const LayerPropertiesIterator iter,const LayerProperties props)

Description: Set the layer properties of the layer pointed to by the iterator

This method replaces the layer properties of the element pointed to by "iter" by the properties given by "props". It will not change the hierarchy but just the properties of the given node.

void set_layer_properties(unsigned int index,const LayerPropertiesIterator iter,const LayerProperties props)

Description: Set the layer properties of the layer pointed to by the iterator

This method replaces the layer properties of the element pointed to by "iter" by the properties given by "props" in the tab given by "index". It will not change the hierarchy but just the properties of the given node.This version addresses a specific list in a multi-tab layer properties arrangement with the "index" parameter. This method has been introduced in version 0.21.

void set_title(string title)

Description: Set the title of the view

Use of this method is deprecated. Use title= instead

void show_all_cells

Description: Make all cells shown (cancel effects of hide_cell)

void show_cell(unsigned int cell_index,int cv_index)

Description: Show the given cell for the given cellview (cancel effect of hide_cell)

void show_image(unsigned long id,bool visible)

Description: Shows or hides the given image

Sets the visibility of the image with the given Id. The Id can be obtained with if "id" method of the image object.

This method has been introduced in version 0.20.

unsigned int show_layout(Layout ptr layout,bool add_cellview)

Description: Shows an existing layout in the view

Shows the given layout in the view. If add_cellview is true, the new layout is added to the list of cellviews in the view.

Note: once a layout is passed to the view with show_layout, it is owned by the view and must not be destroyed with the 'destroy' method.

This method has been introduced in version 0.22.

unsigned int show_layout(Layout ptr layout,string tech,bool add_cellview)

Description: Shows an existing layout in the view

Shows the given layout in the view. If add_cellview is true, the new layout is added to the list of cellviews in the view. The technology to use for that layout can be specified as well with the 'tech' parameter. Depending on the definition of the technology, layer properties may be loaded for example. The technology string can be empty for the default technology.

Note: once a layout is passed to the view with show_layout, it is owned by the view and must not be destroyed with the 'destroy' method.

This method has been introduced in version 0.22.

unsigned int show_layout(Layout ptr layout,string tech,bool add_cellview,bool init_layers)

Description: Shows an existing layout in the view

Shows the given layout in the view. If add_cellview is true, the new layout is added to the list of cellviews in the view. The technology to use for that layout can be specified as well with the 'tech' parameter. Depending on the definition of the technology, layer properties may be loaded for example. The technology string can be empty for the default technology. This variant also allows to control whether the layer properties are initialized (init_layers = true) or not (init_layers = false).

Note: once a layout is passed to the view with show_layout, it is owned by the view and must not be destroyed with the 'destroy' method.

This method has been introduced in version 0.22.

void show_rdb(int rdb_index,int cv_index)

Description: Shows a report database in the marker browser on a certain layout

The marker browser is opened showing the report database with the index given by "rdb_index". It will be attached (i.e. navigate to) the layout with the given cellview index in "cv_index".

void stop

Description: Stop redraw thread and close any browsers

This method usually does not need to be called explicitly. The redraw thread is stopped automatically.

void stop_redraw

Description: Stop the redraw thread

It is very important to stop the redraw thread before applying changes to the layout or the cell views and the LayoutView configuration. This is usually done automatically. For rare cases, where this is not the case, this method is provided.

[const] string title

Description: Return the view's title string

The title string is either a string composed of the file names loaded (in some "readable" manner) or a customized title string set by set_title.

Python specific notes:

The object exposes a readable attribute 'title'. This is the getter.

void title=(string title)

Description: Set the title of the view

Override the standard title of the view indicating the file names loaded by the specified title string. The title string can be reset with reset_title to the standard title again.

Python specific notes:

The object exposes a writable attribute 'title'. This is the setter.

void transaction(string description)

Description: Begin a transaction

A transaction brackets a sequence of database modifications that appear as a single undo action. Only modifications that are wrapped inside a transaction..commit call pair can be undone. Each transaction must be terminated with a commit method call, even if some error occured. It is advisable therefore to catch errors and issue a commit call in this case.

This method was introduced in version 0.16.

[const] void unselect_object(const ObjectInstPath obj)

Description: Removes the given selection from the list of selected objects

The selection provided by the ObjectInstPath descriptor is removed from the list of selected objects. If the given object was not part of the selection, nothing will be changed. The selection of other objects (such as annotations and images) will not be affected.

This method has been introduced in version 0.24

void update_content

Description: Update the layout view to the current state

This method triggers an update of the hierarchy tree and layer view tree. Usually, this method does not need to be called. The widgets are updated automatically in most cases.

Currently, this method should be called however, after the layer view tree has been changed by the insert_layer, replace_layer_node or delete_layer methods.

[const] int viewport_height

Description: Return the viewport height in pixels

This method was introduced in version 0.18.

[const] DCplxTrans viewport_trans

Description: Return the transformation that converts micron coordinates to pixels

Hint: the transformation returned will convert any point in micron coordinate space into a pixel coordinate. Contrary to usual convention, the y pixel coordinate is given in a mathematically oriented space - which means the bottom coordinate is 0. This method was introduced in version 0.18.

[const] int viewport_width

Description: Return the viewport width in pixels

This method was introduced in version 0.18.

void zoom_box(const DBox box)

Description: Set the viewport to the given box

void zoom_fit

Description: Fit the contents of the current view into the window

void zoom_in

Description: Zoom in somewhat

void zoom_out

Description: Zoom out somewhat