DataMinerNode Members

Data Miner Node.

Functions

Name Description
AddChild Adds a child node to this node. Return value: DataMinerNode.
AddChildAssociation Adds a child node association to this node.
EditByGroup Return value: Boolean.
EditParameters Show the parameters dialog.
EditVariableSelections Show the variable selection dialog.
Execute Executes the node after first executing any dirty parent nodes.
GenerateCode Return value: String.
HideDocument Hide the attached document, if any.
IsChildOf Determines if this node is a child of the given node. If bRecurse is False, this node must be an immediate child of the given node, otherwise recurses to children of children, etc. Return value: Boolean.
IsParentOf Determines if this node is a parent of the given node. If bRecurse is False, this node must be an immediate parent of the given node, otherwise recurses to parents of parents, etc. Return value: Boolean.
RemoveChild Removes the connection to the child node.
RouteOutput Routes the given output (Spreadsheet, Graph, InputDescriptor, or StaDocuments collection) and returns the new child node(s). Return value: DataMinerNodes.
RouteOutput2 Routes the given output (Spreadsheet, Graph, InputDescriptor, or StaDocuments collection) and returns the new child node(s). Return value: DataMinerNodes.
ShowDocument Make the attached document, if any, visible.

Properties

Name Description
Application Returns application object. Return value: Application. This property is read only.
AssociatedChildNodes Get this nodes children which are marked as associated nodes. Return value: DataMinerNodes. This property is read only.
AssociatedParentNodes Get this nodes parents which are marked as associated nodes. Return value: DataMinerNodes. This property is read only.
ByGroupEnabled Return value: Boolean. This property is read only.
ChildNodes Get this nodes children. Return value: DataMinerNodes. This property is read only.
Code Get/Set this node's SVB code. Return/assignment value: String.
ConnectionEnabled Enable/disable the connection to the specified child. The nodes must already be connected. Return/assignment value: Boolean.
ConnectionIsAssociation Get/Set the connection to the specified child as an association. The nodes must already be connected. Return/assignment value: Boolean.
DMIFile Get the node's dmi file name. Return value: String. This property is read only.
Dirty Get/Set this node's dirty flag. Return/assignment value: Boolean.
Document Get this node's attached document (spreadsheet, graph, workbook), if applicable. Return value: Object. This property is read only.
DocumentPathname Get/Set the attached document's pathname. Return/assignment value: String.
EmbedDocument Get/Set flag indicating if this node will embed its attached document on save. Return/assignment value: Boolean.
GUID Return value: String. This property is read only.
Id Get the unique identifier of this node. Return value: Long. This property is read only.
InputDescriptor Get this node's InputDescriptor, if applicable. Return value: InputDescriptor. This property is read only.
LongDescription Return value: String. This property is read only.
Name Get/Set this node's name. Return/assignment value: String.
OpenInputReadOnly Get/Set Open linked input spreadsheet read-only. Return/assignment value: Boolean.
OriginalDocumentPathname Get/Set the attached document's original pathname. Return value: String. This property is read only.
Parameters Get/Set this node's parameters Dictionary object. Return/assignment value: Object.
ParametersObject Return an object suitable for setting node parameters for scDMAnalysisNode2 types; the node dictionary otherwise. Return value: Object. This property is read only.
Parent Returns the parent document of the object. Return value: DataMiner. This property is read only.
ParentNodes Get this nodes parents. Return value: DataMinerNodes. This property is read only.
Placement Get the Node's placement (which rectangle in the view it is displayed in). Return value: DMNodePlacement. This property is read only.
ScriptPathname Get/Set the script pathname. Return/assignment value: String.
Selected Get/Set this node selected state. Return/assignment value: Boolean.
ShortDescription Return value: String. This property is read only.
SupportsByGroup Return value: Boolean. This property is read only.
Type Get the type of this node. Return value: DMNodeType. This property is read only.
UserVariableSelection For Result Input Spreadsheet Nodes, controls if manual variable selections will override any selections the generating node may make. Return/assignment value: Boolean.
xAbsPos Get/Set the absolute x coordinate of the node's position. The position coordinates are relative to the upper left corner of the node's placement rectangle. Return/assignment value: Long.
xRelPos Get/Set the relative x coordinate of the node's position. The position coordinates are relative to the upper left corner of the node's placement rectangle and in [0, 1]. Return/assignment value: Double.
yAbsPos Get/Set the absolute y coordinate of the node's position. The position coordinates are relative to the upper left corner of the node's placement rectangle. Return/assignment value: Long.
yRelPos Get/Set the relative y coordinate of the node's position. The position coordinates are relative to the upper left corner of the node's placement rectangle and in [0, 1]. Return/assignment value: Double.