ILNumerics Ultimate VS

Legend Properties

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development

The Legend type exposes the following members.

Properties

  NameDescription
Public propertyAlpha
Alpha value, range [0...1], if set, this value modifies the alpha values for ALL nodes of this subtree. Use for blend effects only!

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyAnchor
Gets the reference point for the location of the screen rectangle relative to the rectangles size. Default: center of the rectangle (.5,.5)

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyAnimations (Inherited from Group.)
Public propertyBackground
Background fill area

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyBorder
Border of the screen rectangle

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyChildren
Collection of child for this group

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyClipping
Gets all 6 available clipping planes for the group or sets it. Null: derive clipping from parent node (default)

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyColorOverride
If set, this color will override all individual colors in this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyDefaultItemStyle
Holds an LegendItem template used to style new legend items or null.

[ILNumerics Visualization Engine]

Public propertyDefaultLabelStyle
The default label used to style the labels for newly created LegendItem items or null.

[ILNumerics Visualization Engine]

Public propertyHeight
Height of the screen rectangle in units defined by HeightUnit. Default: Auto (null); determined by content

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyHeightUnit
Units for the height of the screen rectangle

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyID
Unique ID for the node within the scene

[ILNumerics Visualization Engine]

(Inherited from Node.)
Protected propertyIsSynchedNode (Inherited from Node.)
Public propertyItems
The collection of node items for display in this legend

[ILNumerics Visualization Engine]

Public propertyLegendItemSize
Get or sets the width for the area in pixels where lines & markers are drawn; default: 100px

[ILNumerics Visualization Engine]

Public propertyLocation
Location of the anchor point of the screen rectangle in units defined by LocationXUnit and LocationYUnit. Default: viewport center

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyLocationXUnit
Units for the horizontal location of the anchor point

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyLocationYUnit
Units for the vertical location of the anchor point

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyMarkable
Determines, if this node can be marked by the user

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyMarked
Marked state for the node

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyMinimumSize
Minimum size of the screen rect when Size mode is null (auto), in units defined by WidthUnit and HeightUnit

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyMovable
Dis-/allows the user to move the rectangle on screen interactively (if supported by the driver). Default: true

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyPadding
Spacing between outer border of the legend and the legend items measured in pixels

[ILNumerics Visualization Engine]

Public propertyParent
Get the parent of this node or null, if this node is a root node

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyPickingID
If set to a valid shape ID, that shape will be marked in picking operations insted of this shape.

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyRootID
Gets the root node of the subtree in the scene, which is considered for finding legend items automatically or sets it. Default: the plot cube containing this legend (null)

[ILNumerics Visualization Engine]

Protected propertySynchedVersion
The version of the sync source from the last synchronization.

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyTag
Object tag used to identify the node within the scene

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyTarget
If set, determines the target for rendering: world (3D) or screen (2D) on top. Default: not set (derive from parent)

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyTimeoutAware
Sets if this group and all children are sensible for timeouts during rendering or gets that flag. Default: null -> derive from parent

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyTransform
[4x4] matrix with the affine transforms which this node applies to all children

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyVersion
Modification version of this node, gets incremented at every change

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyVisible
Determines, if this node is visible or sets the visible state

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyWidth
Width of the screen rectangle in units defined by WidthUnit. Default: Auto (null); determined by content

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyWidthUnit
Units for the width of the screen rectangle

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Public propertyZCoord
Gets or sets the Z coordinate for this screen object. Childs will take this as base depth value.

[ILNumerics Visualization Engine]

(Inherited from ScreenObject.)
Top
See Also

Reference