API reference - Class LayerProperties

Notation used in Ruby API documentation

Description: The layer properties structure

The layer properties encapsulate the settings relevant for the display and source of a layer.

Each attribute is present in two incarnations: local and real. "real" refers to the effective attribute after collecting the attributes from the parents to the leaf property node. In the spirit of this distinction, all read accessors are present in "local" and "real" form. The read accessors take a boolean parameter "real" that must be set to true, if the real value shall be returned.

"brightness" is a index that indicates how much to make the color brighter to darker rendering the effective color (eff_frame_color, eff_fill_color). It's value is roughly between -255 and 255.

Public constructors

new LayerProperties ptrnewCreates a new object of this class

Public methods

[const]bool!=(const LayerProperties other)Inequality
[const]bool==(const LayerProperties other)Equality
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]intanimation(bool real)Gets the animation state
[const]intanimationGets the animation state
voidanimation=(int animation)Sets the animation state
voidassign(const LayerProperties other)Assigns another object to self
[const]intcellviewGets the the cellview index
voidclear_dither_patternClears the dither pattern
voidclear_fill_colorResets the fill color
voidclear_frame_colorResets the frame color
voidclear_line_styleClears the line style
voidclear_lower_hier_levelClears the lower hierarchy level specification
voidclear_source_nameRemoves any stream layer name specification from this layer
voidclear_upper_hier_levelClears the upper hierarchy level specification
[const]intdither_pattern(bool real)Gets the dither pattern index
[const]intdither_patternGets the dither pattern index
voiddither_pattern=(int index)Sets the dither pattern index
[const]new LayerProperties ptrdupCreates a copy of self
[const]unsigned inteff_dither_pattern(bool real)Gets the effective dither pattern index
[const]unsigned inteff_dither_patternGets the effective dither pattern index
[const]unsigned inteff_fill_color(bool real)Gets the effective fill color
[const]unsigned inteff_fill_colorGets the effective fill color
[const]unsigned inteff_frame_color(bool real)Gets the effective frame color
[const]unsigned inteff_frame_colorGets the effective frame color
[const]unsigned inteff_line_style(bool real)Gets the effective line style index
[const]unsigned inteff_line_styleGets the line style index
[const]intfill_brightness(bool real)Gets the fill brightness value
[const]intfill_brightnessGets the fill brightness value
voidfill_brightness=(int brightness)Sets the fill brightness
[const]unsigned intfill_color(bool real)Gets the fill color
[const]unsigned intfill_colorGets the fill color
voidfill_color=(unsigned int color)Sets the fill color to the given value
[const]LayerPropertiesflatReturns the "flattened" (effective) layer properties entry for this node
[const]intframe_brightness(bool real)Gets the frame brightness value
[const]intframe_brightnessGets the frame brightness value
voidframe_brightness=(int brightness)Sets the frame brightness
[const]unsigned intframe_color(bool real)Gets the frame color
[const]unsigned intframe_colorGets the frame color
voidframe_color=(unsigned int color)Sets the frame color to the given value
[const]boolhas_dither_pattern?(bool real)True, if the dither pattern is set
[const]boolhas_dither_pattern?True, if the dither pattern is set
[const]boolhas_fill_color?(bool real)True, if the fill color is set
[const]boolhas_fill_color?True, if the fill color is set
[const]boolhas_frame_color?(bool real)True, if the frame color is set
[const]boolhas_frame_color?True, if the frame color is set
[const]boolhas_line_style?(bool real)Gets a value indicating whether the line style is set
[const]boolhas_line_style?True, if the line style is set
[const]boolhas_lower_hier_level?(bool real)Gets a value indicating whether a lower hierarchy level is explicitly specified
[const]boolhas_lower_hier_level?Gets a value indicating whether a lower hierarchy level is explicitly specified
[const]boolhas_source_name?(bool real)Gets a value indicating whether a stream layer name is specified for this layer
[const]boolhas_source_name?Gets a value indicating whether a stream layer name is specified for this layer
[const]boolhas_upper_hier_level?(bool real)Gets a value indicating whether an upper hierarchy level is explicitly specified
[const]boolhas_upper_hier_level?Gets a value indicating whether an upper hierarchy level is explicitly specified
[const]intlayer_indexGets the the layer index
[const]intline_style(bool real)Gets the line style index
[const]intline_styleGets the line style index
voidline_style=(int index)Sets the line style index
[const]intlower_hier_level(bool real)Gets the lower hierarchy level shown
[const]intlower_hier_levelGets the lower hierarchy level shown
voidlower_hier_level=(int level)Sets the lower hierarchy level
[const]intlower_hier_level_mode(bool arg1)Gets the mode for the lower hierarchy level.
[const]intlower_hier_level_modeGets the mode for the lower hierarchy level.
[const]boollower_hier_level_relative?(bool real)Gets a value indicating whether the lower hierarchy level is relative.
[const]boollower_hier_level_relative?Gets a value indicating whether the upper hierarchy level is relative.
voidmarked=(bool marked)Sets the marked state
[const]boolmarked?(bool real)Gets the marked state
[const]boolmarked?Gets the marked state
[const]stringnameGets the name
voidname=(string name)Sets the name to the given string
voidset_lower_hier_level(int level,
bool relative)
Sets the lower hierarchy level and if it is relative to the context cell
voidset_lower_hier_level(int level,
bool relative,
int mode)
Sets the lower hierarchy level, whether it is relative to the context cell and the mode
voidset_upper_hier_level(int level,
bool relative)
Sets the upper hierarchy level and if it is relative to the context cell
voidset_upper_hier_level(int level,
bool relative,
int mode)
Sets the upper hierarchy level, if it is relative to the context cell and the mode
[const]stringsource(bool real)Gets the source specification
[const]stringsourceGets the source specification
voidsource=(string s)Loads the source specification from a string
[const]intsource_cellview(bool real)Gets the cellview index that this layer refers to
[const]intsource_cellviewGets the cellview index that this layer refers to
voidsource_cellview=(int cellview_index)Sets the cellview index that this layer refers to
[const]intsource_datatype(bool real)Gets the stream datatype that the shapes are taken from
[const]intsource_datatypeGets the stream datatype that the shapes are taken from
voidsource_datatype=(int datatype)Sets the stream datatype that the shapes are taken from
[const]intsource_layer(bool real)Gets the stream layer that the shapes are taken from
[const]intsource_layerGets the stream layer that the shapes are taken from
voidsource_layer=(int layer)Sets the stream layer that the shapes are taken from
[const]intsource_layer_index(bool real)Gets the layer index that the shapes are taken from
[const]intsource_layer_indexGets the stream layer that the shapes are taken from
voidsource_layer_index=(int index)Sets the layer index specification that the shapes are taken from
[const]stringsource_name(bool real)Gets the stream name that the shapes are taken from
[const]stringsource_nameGets the stream name that the shapes are taken from
voidsource_name=(string name)Sets the stream layer name that the shapes are taken from
[const]DCplxTrans[]trans(bool real)Gets the transformations that the layer is transformed with
[const]DCplxTrans[]transGets the transformations that the layer is transformed with
voidtrans=(DCplxTrans[] trans_vector)Sets the transformations that the layer is transformed with
voidtransparent=(bool transparent)Sets the transparency state
[const]booltransparent?(bool real)Gets the transparency state
[const]booltransparent?Gets the transparency state
[const]intupper_hier_level(bool real)Gets the upper hierarchy level shown
[const]intupper_hier_levelGets the upper hierarchy level shown
voidupper_hier_level=(int level)Sets a upper hierarchy level
[const]intupper_hier_level_mode(bool real)Gets the mode for the upper hierarchy level.
[const]intupper_hier_level_modeGets the mode for the upper hierarchy level.
[const]boolupper_hier_level_relative?(bool real)Gets a value indicating whether if the upper hierarchy level is relative.
[const]boolupper_hier_level_relative?Gets a value indicating whether the upper hierarchy level is relative.
voidvalid=(bool valid)Sets the validity state
[const]boolvalid?(bool real)Gets the validity state
[const]boolvalid?Gets the validity state
voidvisible=(bool visible)Sets the visibility state
[const]boolvisible?(bool real)Gets the visibility state
[const]boolvisible?Gets the visibility state
[const]intwidth(bool real)Gets the line width
[const]intwidthGets the line width
voidwidth=(int width)Sets the line width to the given width
voidxfill=(bool xfill)Sets a value indicating whether shapes are drawn with a cross
[const]boolxfill?(bool real)Gets a value indicating whether shapes are drawn with a cross
[const]boolxfill?Gets a value indicating whether shapes are drawn with a cross

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

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead
[const]boollower_hier_level_relative(bool real)Use of this method is deprecated. Use lower_hier_level_relative? instead
[const]boollower_hier_level_relativeUse of this method is deprecated. Use lower_hier_level_relative? instead
[const]boolupper_hier_level_relative(bool real)Use of this method is deprecated. Use upper_hier_level_relative? instead
[const]boolupper_hier_level_relativeUse of this method is deprecated. Use upper_hier_level_relative? instead

Detailed description

!=

Signature: [const] bool != (const LayerProperties other)

Description: Inequality

other:The other object to compare against

==

Signature: [const] bool == (const LayerProperties other)

Description: Equality

other:The other object to compare against

_create

Signature: 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.

_destroy

Signature: 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.

_destroyed?

Signature: [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.

_is_const_object?

Signature: [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.

_manage

Signature: 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.

_unmanage

Signature: 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.

animation

Signature: [const] int animation (bool real)

Description: Gets the animation state

The animation state is an integer either being 0 (static), 1 (scrolling), 2 (blinking) or 3 (inversely blinking)

Python specific notes:
This method is available as method 'animation_' in Python

Signature: [const] int animation

Description: Gets the animation state

This method is a convenience method for "animation(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'animation'. This is the getter.

animation=

Signature: void animation= (int animation)

Description: Sets the animation state

See the description of the animation method for details about the animation state

Python specific notes:
The object exposes a writable attribute 'animation'. This is the setter.

assign

Signature: void assign (const LayerProperties other)

Description: Assigns another object to self

cellview

Signature: [const] int cellview

Description: Gets the the cellview index

This is the index of the actual cellview to use. Basically, this method returns source_cellview in "real" mode. The result may be different, if the cellview is not valid for example. In this case, a negative value is returned.

clear_dither_pattern

Signature: void clear_dither_pattern

Description: Clears the dither pattern

clear_fill_color

Signature: void clear_fill_color

Description: Resets the fill color

clear_frame_color

Signature: void clear_frame_color

Description: Resets the frame color

clear_line_style

Signature: void clear_line_style

Description: Clears the line style

This method has been introduced in version 0.25.

clear_lower_hier_level

Signature: void clear_lower_hier_level

Description: Clears the lower hierarchy level specification

See has_lower_hier_level for a description of this property

clear_source_name

Signature: void clear_source_name

Description: Removes any stream layer name specification from this layer

clear_upper_hier_level

Signature: void clear_upper_hier_level

Description: Clears the upper hierarchy level specification

See has_upper_hier_level for a description of this property

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

destroyed?

Signature: [const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

dither_pattern

Signature: [const] int dither_pattern (bool real)

Description: Gets the dither pattern index

real:Set to true to return the real instead of local value

This method may deliver an invalid dither pattern index if it is not set.

Python specific notes:
This method is available as method 'dither_pattern_' in Python

Signature: [const] int dither_pattern

Description: Gets the dither pattern index

This method is a convenience method for "dither_pattern(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'dither_pattern'. This is the getter.

dither_pattern=

Signature: void dither_pattern= (int index)

Description: Sets the dither pattern index

The dither pattern index must be one of the valid indices. The first indices are reserved for built-in pattern, the following ones are custom pattern. Index 0 is always solid filled and 1 is always the hollow filled pattern. For custom pattern see LayoutView#add_stipple.

Python specific notes:
The object exposes a writable attribute 'dither_pattern'. This is the setter.

dup

Signature: [const] new LayerProperties ptr dup

Description: Creates a copy of self

eff_dither_pattern

Signature: [const] unsigned int eff_dither_pattern (bool real)

Description: Gets the effective dither pattern index

real:Set to true to return the real instead of local value

The effective dither pattern index is always a valid index, even if no dither pattern is set.

Signature: [const] unsigned int eff_dither_pattern

Description: Gets the effective dither pattern index

This method is a convenience method for "eff_dither_pattern(true)"

This method has been introduced in version 0.22.

eff_fill_color

Signature: [const] unsigned int eff_fill_color (bool real)

Description: Gets the effective fill color

real:Set to true to return the real instead of local value

The effective fill color is computed from the frame color brightness and the frame color.

Signature: [const] unsigned int eff_fill_color

Description: Gets the effective fill color

This method is a convenience method for "eff_fill_color(true)"

This method has been introduced in version 0.22.

eff_frame_color

Signature: [const] unsigned int eff_frame_color (bool real)

Description: Gets the effective frame color

real:Set to true to return the real instead of local value

The effective frame color is computed from the frame color brightness and the frame color.

Signature: [const] unsigned int eff_frame_color

Description: Gets the effective frame color

This method is a convenience method for "eff_frame_color(true)"

This method has been introduced in version 0.22.

eff_line_style

Signature: [const] unsigned int eff_line_style (bool real)

Description: Gets the effective line style index

real:Set to true to return the real instead of local value

The effective line style index is always a valid index, even if no line style is set. In that case, a default style index will be returned.

This method has been introduced in version 0.25.

Signature: [const] unsigned int eff_line_style

Description: Gets the line style index

This method is a convenience method for "eff_line_style(true)"

This method has been introduced in version 0.25.

fill_brightness

Signature: [const] int fill_brightness (bool real)

Description: Gets the fill brightness value

real:Set to true to return the real instead of local value

If the brightness is not set, this method may return an invalid value

Python specific notes:
This method is available as method 'fill_brightness_' in Python

Signature: [const] int fill_brightness

Description: Gets the fill brightness value

This method is a convenience method for "fill_brightness(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'fill_brightness'. This is the getter.

fill_brightness=

Signature: void fill_brightness= (int brightness)

Description: Sets the fill brightness

For neutral brightness set this value to 0. For darker colors set it to a negative value (down to -255), for brighter colors to a positive value (up to 255)

Python specific notes:
The object exposes a writable attribute 'fill_brightness'. This is the setter.

fill_color

Signature: [const] unsigned int fill_color (bool real)

Description: Gets the fill color

real:Set to true to return the real instead of local value

This method may return an invalid color if the color is not set.

Python specific notes:
This method is available as method 'fill_color_' in Python

Signature: [const] unsigned int fill_color

Description: Gets the fill color

This method is a convenience method for "fill_color(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'fill_color'. This is the getter.

fill_color=

Signature: void fill_color= (unsigned int color)

Description: Sets the fill color to the given value

The color is a 32bit value encoding the blue value in the lower 8 bits, the green value in the next 8 bits and the red value in the 8 bits above that.

Python specific notes:
The object exposes a writable attribute 'fill_color'. This is the setter.

flat

Signature: [const] LayerProperties flat

Description: Returns the "flattened" (effective) layer properties entry for this node

This method returns a LayerProperties object that is not embedded into a hierarchy. This object represents the effective layer properties for the given node. In particular, all 'local' properties are identical to the 'real' properties. Such an object can be used as a basis for manipulations. This method has been introduced in version 0.22.

frame_brightness

Signature: [const] int frame_brightness (bool real)

Description: Gets the frame brightness value

real:Set to true to return the real instead of local value

If the brightness is not set, this method may return an invalid value

Python specific notes:
This method is available as method 'frame_brightness_' in Python

Signature: [const] int frame_brightness

Description: Gets the frame brightness value

This method is a convenience method for "frame_brightness(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'frame_brightness'. This is the getter.

frame_brightness=

Signature: void frame_brightness= (int brightness)

Description: Sets the frame brightness

For neutral brightness set this value to 0. For darker colors set it to a negative value (down to -255), for brighter colors to a positive value (up to 255)

Python specific notes:
The object exposes a writable attribute 'frame_brightness'. This is the setter.

frame_color

Signature: [const] unsigned int frame_color (bool real)

Description: Gets the frame color

real:Set to true to return the real instead of local value

This method may return an invalid color if the color is not set.

Python specific notes:
This method is available as method 'frame_color_' in Python

Signature: [const] unsigned int frame_color

Description: Gets the frame color

This method is a convenience method for "frame_color(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'frame_color'. This is the getter.

frame_color=

Signature: void frame_color= (unsigned int color)

Description: Sets the frame color to the given value

The color is a 32bit value encoding the blue value in the lower 8 bits, the green value in the next 8 bits and the red value in the 8 bits above that.

Python specific notes:
The object exposes a writable attribute 'frame_color'. This is the setter.

has_dither_pattern?

Signature: [const] bool has_dither_pattern? (bool real)

Description: True, if the dither pattern is set

Signature: [const] bool has_dither_pattern?

Description: True, if the dither pattern is set

This method is a convenience method for "has_dither_pattern?(true)"

This method has been introduced in version 0.22.

has_fill_color?

Signature: [const] bool has_fill_color? (bool real)

Description: True, if the fill color is set

Signature: [const] bool has_fill_color?

Description: True, if the fill color is set

This method is a convenience method for "has_fill_color?(true)"

This method has been introduced in version 0.22.

has_frame_color?

Signature: [const] bool has_frame_color? (bool real)

Description: True, if the frame color is set

Signature: [const] bool has_frame_color?

Description: True, if the frame color is set

This method is a convenience method for "has_frame_color?(true)"

This method has been introduced in version 0.22.

has_line_style?

Signature: [const] bool has_line_style? (bool real)

Description: Gets a value indicating whether the line style is set

This method has been introduced in version 0.25.

Signature: [const] bool has_line_style?

Description: True, if the line style is set

This method is a convenience method for "has_line_style?(true)"

This method has been introduced in version 0.25.

has_lower_hier_level?

Signature: [const] bool has_lower_hier_level? (bool real)

Description: Gets a value indicating whether a lower hierarchy level is explicitly specified

If "real" is true, the effective value is returned.

Signature: [const] bool has_lower_hier_level?

Description: Gets a value indicating whether a lower hierarchy level is explicitly specified

This method is a convenience method for "has_lower_hier_level?(true)"

This method has been introduced in version 0.22.

has_source_name?

Signature: [const] bool has_source_name? (bool real)

Description: Gets a value indicating whether a stream layer name is specified for this layer

If "real" is true, the effective value is returned.

Signature: [const] bool has_source_name?

Description: Gets a value indicating whether a stream layer name is specified for this layer

This method is a convenience method for "has_source_name?(true)"

This method has been introduced in version 0.22.

has_upper_hier_level?

Signature: [const] bool has_upper_hier_level? (bool real)

Description: Gets a value indicating whether an upper hierarchy level is explicitly specified

If "real" is true, the effective value is returned.

Signature: [const] bool has_upper_hier_level?

Description: Gets a value indicating whether an upper hierarchy level is explicitly specified

This method is a convenience method for "has_upper_hier_level?(true)"

This method has been introduced in version 0.22.

is_const_object?

Signature: [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

layer_index

Signature: [const] int layer_index

Description: Gets the the layer index

This is the index of the actual layer used. The source specification given by source_layer, source_datatype, source_name is evaluated and the corresponding layer is looked up in the layout object. If a source_layer_index is specified, this layer index is taken as the layer index to use.

line_style

Signature: [const] int line_style (bool real)

Description: Gets the line style index

real:Set to true to return the real instead of local value

This method may deliver an invalid line style index if it is not set (see has_line_style?).

This method has been introduced in version 0.25.

Python specific notes:
This method is available as method 'line_style_' in Python

Signature: [const] int line_style

Description: Gets the line style index

This method is a convenience method for "line_style(true)"

This method has been introduced in version 0.25.

Python specific notes:
The object exposes a readable attribute 'line_style'. This is the getter.

line_style=

Signature: void line_style= (int index)

Description: Sets the line style index

The line style index must be one of the valid indices. The first indices are reserved for built-in pattern, the following ones are custom pattern. Index 0 is always solid filled. For custom line styles see LayoutView#add_line_style.

This method has been introduced in version 0.25.

Python specific notes:
The object exposes a writable attribute 'line_style'. This is the setter.

lower_hier_level

Signature: [const] int lower_hier_level (bool real)

Description: Gets the lower hierarchy level shown

This is the hierarchy level at which the drawing starts. This property is only meaningful, if has_lower_hier_level is true. The hierarchy level can be relative in which case, 0 refers to the context cell's level. A mode can be specfied for the hierarchy level which is 0 for absolute, 1 for minimum of specified level and set level and 2 for maximum of specified level and set level.

Python specific notes:
This method is available as method 'lower_hier_level_' in Python

Signature: [const] int lower_hier_level

Description: Gets the lower hierarchy level shown

This method is a convenience method for "lower_hier_level(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'lower_hier_level'. This is the getter.

lower_hier_level=

Signature: void lower_hier_level= (int level)

Description: Sets the lower hierarchy level

If this method is called, the lower hierarchy level is enabled. See lower_hier_level for a description of this property.

Python specific notes:
The object exposes a writable attribute 'lower_hier_level'. This is the setter.

lower_hier_level_mode

Signature: [const] int lower_hier_level_mode (bool arg1)

Description: Gets the mode for the lower hierarchy level.

real:If true, the computed value is returned, otherwise the local node value

The mode value can be 0 (value is given by lower_hier_level), 1 for "minimum value" and 2 for "maximum value".

This method has been introduced in version 0.20.

Signature: [const] int lower_hier_level_mode

Description: Gets the mode for the lower hierarchy level.

This method is a convenience method for "lower_hier_level_mode(true)"

This method has been introduced in version 0.22.

lower_hier_level_relative

Signature: [const] bool lower_hier_level_relative (bool real)

Description: Gets a value indicating whether the lower hierarchy level is relative.

Use of this method is deprecated. Use lower_hier_level_relative? instead

Signature: [const] bool lower_hier_level_relative

Description: Gets a value indicating whether the upper hierarchy level is relative.

Use of this method is deprecated. Use lower_hier_level_relative? instead

lower_hier_level_relative?

Signature: [const] bool lower_hier_level_relative? (bool real)

Description: Gets a value indicating whether the lower hierarchy level is relative.

See lower_hier_level for a description of this property.

This method has been introduced in version 0.19.

Signature: [const] bool lower_hier_level_relative?

Description: Gets a value indicating whether the upper hierarchy level is relative.

This method is a convenience method for "lower_hier_level_relative(true)"

This method has been introduced in version 0.22.

marked=

Signature: void marked= (bool marked)

Description: Sets the marked state

Python specific notes:
The object exposes a writable attribute 'marked'. This is the setter.

marked?

Signature: [const] bool marked? (bool real)

Description: Gets the marked state

Python specific notes:
This method is available as method 'marked_' in Python

Signature: [const] bool marked?

Description: Gets the marked state

This method is a convenience method for "marked?(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'marked'. This is the getter.

name

Signature: [const] string name

Description: Gets the name

Python specific notes:
The object exposes a readable attribute 'name'. This is the getter.

name=

Signature: void name= (string name)

Description: Sets the name to the given string

Python specific notes:
The object exposes a writable attribute 'name'. This is the setter.

new

Signature: [static] new LayerProperties ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object

set_lower_hier_level

Signature: void set_lower_hier_level (int level,bool relative)

Description: Sets the lower hierarchy level and if it is relative to the context cell

If this method is called, the lower hierarchy level is enabled. See lower_hier_level for a description of this property.

This method has been introduced in version 0.19.

Signature: void set_lower_hier_level (int level,bool relative,int mode)

Description: Sets the lower hierarchy level, whether it is relative to the context cell and the mode

If this method is called, the lower hierarchy level is enabled. See lower_hier_level for a description of this property.

This method has been introduced in version 0.20.

set_upper_hier_level

Signature: void set_upper_hier_level (int level,bool relative)

Description: Sets the upper hierarchy level and if it is relative to the context cell

If this method is called, the upper hierarchy level is enabled. See upper_hier_level for a description of this property.

This method has been introduced in version 0.19.

Signature: void set_upper_hier_level (int level,bool relative,int mode)

Description: Sets the upper hierarchy level, if it is relative to the context cell and the mode

If this method is called, the upper hierarchy level is enabled. See upper_hier_level for a description of this property.

This method has been introduced in version 0.20.

source

Signature: [const] string source (bool real)

Description: Gets the source specification

real:Set to true to return the computed instead of local value

This method delivers the source specification as a string

Python specific notes:
This method is available as method 'source_' in Python

Signature: [const] string source

Description: Gets the source specification

This method is a convenience method for "source(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'source'. This is the getter.

source=

Signature: void source= (string s)

Description: Loads the source specification from a string

Sets the source specification to the given string. The source specification may contain the cellview index, the source layer (given by layer/datatype or layer name), transformation, property selector etc. This method throws an exception if the specification is not valid.

Python specific notes:
The object exposes a writable attribute 'source'. This is the setter.

source_cellview

Signature: [const] int source_cellview (bool real)

Description: Gets the cellview index that this layer refers to

If "real" is true, the effective value is returned.

Python specific notes:
This method is available as method 'source_cellview_' in Python

Signature: [const] int source_cellview

Description: Gets the cellview index that this layer refers to

This method is a convenience method for "source_cellview(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'source_cellview'. This is the getter.

source_cellview=

Signature: void source_cellview= (int cellview_index)

Description: Sets the cellview index that this layer refers to

See cellview for a description of the transformations.

Python specific notes:
The object exposes a writable attribute 'source_cellview'. This is the setter.

source_datatype

Signature: [const] int source_datatype (bool real)

Description: Gets the stream datatype that the shapes are taken from

If the datatype is positive, the actual layer is looked up by this stream datatype. If a name or layer index is specified, the stream datatype is not used.

If "real" is true, the effective value is returned.

Python specific notes:
This method is available as method 'source_datatype_' in Python

Signature: [const] int source_datatype

Description: Gets the stream datatype that the shapes are taken from

This method is a convenience method for "source_datatype(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'source_datatype'. This is the getter.

source_datatype=

Signature: void source_datatype= (int datatype)

Description: Sets the stream datatype that the shapes are taken from

See datatype for a description of this property

Python specific notes:
The object exposes a writable attribute 'source_datatype'. This is the setter.

source_layer

Signature: [const] int source_layer (bool real)

Description: Gets the stream layer that the shapes are taken from

If the layer is positive, the actual layer is looked up by this stream layer. If a name or layer index is specified, the stream layer is not used.

If "real" is true, the effective value is returned.

Python specific notes:
This method is available as method 'source_layer_' in Python

Signature: [const] int source_layer

Description: Gets the stream layer that the shapes are taken from

This method is a convenience method for "source_layer(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'source_layer'. This is the getter.

source_layer=

Signature: void source_layer= (int layer)

Description: Sets the stream layer that the shapes are taken from

See source_layer for a description of this property

Python specific notes:
The object exposes a writable attribute 'source_layer'. This is the setter.

source_layer_index

Signature: [const] int source_layer_index (bool real)

Description: Gets the layer index that the shapes are taken from

If the layer index is positive, the shapes drawn are taken from this layer rather than searched for by layer and datatype. This property is stronger than the layer/datatype or name specification.

The similar method layer_index returns the actual layer index used, not the given one. The latter may be negative indicating that layer/datatype or name specifications are used.

If "real" is true, the effective value is returned.

Python specific notes:
This method is available as method 'source_layer_index_' in Python

Signature: [const] int source_layer_index

Description: Gets the stream layer that the shapes are taken from

This method is a convenience method for "source_layer_index(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'source_layer_index'. This is the getter.

source_layer_index=

Signature: void source_layer_index= (int index)

Description: Sets the layer index specification that the shapes are taken from

See source_layer_index for a description of this property.

Python specific notes:
The object exposes a writable attribute 'source_layer_index'. This is the setter.

source_name

Signature: [const] string source_name (bool real)

Description: Gets the stream name that the shapes are taken from

If the name is non-empty, the actual layer is looked up by this stream layer name. If a layer index (see layer_index) is specified, the stream datatype is not used. A name is only meaningful for OASIS files.

If "real" is true, the effective value is returned.

Python specific notes:
This method is available as method 'source_name_' in Python

Signature: [const] string source_name

Description: Gets the stream name that the shapes are taken from

This method is a convenience method for "source_name(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'source_name'. This is the getter.

source_name=

Signature: void source_name= (string name)

Description: Sets the stream layer name that the shapes are taken from

See name for a description of this property

Python specific notes:
The object exposes a writable attribute 'source_name'. This is the setter.

trans

Signature: [const] DCplxTrans[] trans (bool real)

Description: Gets the transformations that the layer is transformed with

The transformations returned by this accessor is the one used for displaying this layer. The layout is transformed with each of these transformations before it is drawn.

If "real" is true, the effective value is returned.

Python specific notes:
This method is available as method 'trans_' in Python

Signature: [const] DCplxTrans[] trans

Description: Gets the transformations that the layer is transformed with

This method is a convenience method for "trans(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'trans'. This is the getter.

trans=

Signature: void trans= (DCplxTrans[] trans_vector)

Description: Sets the transformations that the layer is transformed with

See trans for a description of the transformations.

Python specific notes:
The object exposes a writable attribute 'trans'. This is the setter.

transparent=

Signature: void transparent= (bool transparent)

Description: Sets the transparency state

Python specific notes:
The object exposes a writable attribute 'transparent'. This is the setter.

transparent?

Signature: [const] bool transparent? (bool real)

Description: Gets the transparency state

Python specific notes:
This method is available as method 'transparent_' in Python

Signature: [const] bool transparent?

Description: Gets the transparency state

This method is a convenience method for "transparent?(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'transparent'. This is the getter.

upper_hier_level

Signature: [const] int upper_hier_level (bool real)

Description: Gets the upper hierarchy level shown

This is the hierarchy level at which the drawing starts. This property is only meaningful, if has_upper_hier_level is true. The hierarchy level can be relative in which case, 0 refers to the context cell's level. A mode can be specfied for the hierarchy level which is 0 for absolute, 1 for minimum of specified level and set level and 2 for maximum of specified level and set level.

Python specific notes:
This method is available as method 'upper_hier_level_' in Python

Signature: [const] int upper_hier_level

Description: Gets the upper hierarchy level shown

This method is a convenience method for "upper_hier_level(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'upper_hier_level'. This is the getter.

upper_hier_level=

Signature: void upper_hier_level= (int level)

Description: Sets a upper hierarchy level

If this method is called, the upper hierarchy level is enabled. See upper_hier_level for a description of this property.

Python specific notes:
The object exposes a writable attribute 'upper_hier_level'. This is the setter.

upper_hier_level_mode

Signature: [const] int upper_hier_level_mode (bool real)

Description: Gets the mode for the upper hierarchy level.

real:If true, the computed value is returned, otherwise the local node value

The mode value can be 0 (value is given by upper_hier_level), 1 for "minimum value" and 2 for "maximum value".

This method has been introduced in version 0.20.

Signature: [const] int upper_hier_level_mode

Description: Gets the mode for the upper hierarchy level.

This method is a convenience method for "upper_hier_level_mode(true)"

This method has been introduced in version 0.22.

upper_hier_level_relative

Signature: [const] bool upper_hier_level_relative (bool real)

Description: Gets a value indicating whether if the upper hierarchy level is relative.

Use of this method is deprecated. Use upper_hier_level_relative? instead

Signature: [const] bool upper_hier_level_relative

Description: Gets a value indicating whether the upper hierarchy level is relative.

Use of this method is deprecated. Use upper_hier_level_relative? instead

upper_hier_level_relative?

Signature: [const] bool upper_hier_level_relative? (bool real)

Description: Gets a value indicating whether if the upper hierarchy level is relative.

See upper_hier_level for a description of this property.

This method has been introduced in version 0.19.

Signature: [const] bool upper_hier_level_relative?

Description: Gets a value indicating whether the upper hierarchy level is relative.

This method is a convenience method for "upper_hier_level_relative(true)"

This method has been introduced in version 0.22.

valid=

Signature: void valid= (bool valid)

Description: Sets the validity state

Python specific notes:
The object exposes a writable attribute 'valid'. This is the setter.

valid?

Signature: [const] bool valid? (bool real)

Description: Gets the validity state

Python specific notes:
This method is available as method 'valid_' in Python

Signature: [const] bool valid?

Description: Gets the validity state

This method is a convenience method for "valid?(true)"

This method has been introduced in version 0.23.

Python specific notes:
The object exposes a readable attribute 'valid'. This is the getter.

visible=

Signature: void visible= (bool visible)

Description: Sets the visibility state

Python specific notes:
The object exposes a writable attribute 'visible'. This is the setter.

visible?

Signature: [const] bool visible? (bool real)

Description: Gets the visibility state

Python specific notes:
This method is available as method 'visible_' in Python

Signature: [const] bool visible?

Description: Gets the visibility state

This method is a convenience method for "visible?(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'visible'. This is the getter.

width

Signature: [const] int width (bool real)

Description: Gets the line width

Python specific notes:
This method is available as method 'width_' in Python

Signature: [const] int width

Description: Gets the line width

This method is a convenience method for "width(true)"

This method has been introduced in version 0.22.

Python specific notes:
The object exposes a readable attribute 'width'. This is the getter.

width=

Signature: void width= (int width)

Description: Sets the line width to the given width

Python specific notes:
The object exposes a writable attribute 'width'. This is the setter.

xfill=

Signature: void xfill= (bool xfill)

Description: Sets a value indicating whether shapes are drawn with a cross

This attribute has been introduced in version 0.25.

Python specific notes:
The object exposes a writable attribute 'xfill'. This is the setter.

xfill?

Signature: [const] bool xfill? (bool real)

Description: Gets a value indicating whether shapes are drawn with a cross

This attribute has been introduced in version 0.25.

Python specific notes:
This method is available as method 'xfill_' in Python

Signature: [const] bool xfill?

Description: Gets a value indicating whether shapes are drawn with a cross

This method is a convenience method for "xfill?(true)"

This attribute has been introduced in version 0.25.

Python specific notes:
The object exposes a readable attribute 'xfill'. This is the getter.