weavejs.path.WeavePathData

	Property	Defined By
		ColumnUtils : *	WeavePathData
		DynamicColumn : *	WeavePathData
		ExtendedDynamicColumn : *	WeavePathData
		IAttributeColumn : *	WeavePathData
		IDataSource : *	WeavePathData
		IKeySet : *	WeavePathData
		IKeySetCallbackInterface : *	WeavePathData
		indexToQKey : Function	WeavePathData
		IQualifiedKey : *	WeavePathData
		probe_keyset : WeavePathData	WeavePathData
		qkeyToIndex : Function	WeavePathData
		qkeyToString : Function	WeavePathData
		ReferencedColumn : *	WeavePathData
		selection_keyset : WeavePathData	WeavePathData
		stringToQKey : Function	WeavePathData
		subset_filter : WeavePathData	WeavePathData
		weave : Weave A pointer to the Weave instance.	WeavePath

	Property	Defined By
		_parent : WeavePath	WeavePath
		_path : Array	WeavePath

Public Methods

	Method		Defined By
		WeavePathData(weave:Weave, basePath:Array)	WeavePathData
		addCallback(relevantContext:Object, callback:Function, triggerCallbackNow:Boolean = false, immediateMode:Boolean = false, delayWhileBusy:Boolean = true):WeavePath Adds a callback to the object at the current path.	WeavePath
		addKeys(... relativePath_qkeyStringArray):WeavePath Adds the specified keys to the KeySet at this path.	WeavePathData
		addKeySetCallback(callback:Function, triggerCallbackNow:Boolean = false):WeavePath Adds a callback to the KeySet specified by this path which will return information about which keys were added or removed to/from the set.	WeavePathData
		call(func:Function, ... args):WeavePath Calls a function using the current WeavePath object as the 'this' value.	WeavePath
		diff(... relativePath_diff):WeavePath Applies a session state diff to the object at the current path or relative to the current path.	WeavePath
		exec(script_or_function:*, callback:Function = null):WeavePath Evaluates an ActionScript expression using the current path, vars, and libs.	WeavePath
		filterKeys(... relativePath_qkeyStringArray):Array Intersects the specified keys with the KeySet at this path.	WeavePathData
		flushKeys(... relativePath):WeavePath Forces a flush of the add/remove key buffers for the KeySet specified by this path.	WeavePathData
		forEach(items:Object, visitorFunction:Function):WeavePath Applies a function to each item in an Array or an Object.	WeavePath
		forEachChild(... relativePath_visitorFunction):WeavePath Calls a function for each child of the current WeavePath or the one specified by a relativePath.	WeavePath
		forEachName(... relativePath_visitorFunction):WeavePath Calls a function for each child of the current WeavePath or the one specified by a relativePath.	WeavePath
		getChildren(... relativePath):Array Gets an Array of child WeavePath objects under the object at the current path or relative to the current path.	WeavePath
		getDiff(... relativePath_previousState):Object Gets the changes that have occurred since previousState for the object at the current path or relative to the current path.	WeavePath
		getKeys(... relativePath):Array Returns an array of alphanumeric strings uniquely corresponding to the KeySet referenced by this path.	WeavePathData
		getLabel(... relativePath):String Gets the previously-stored human-readable label for an ILinkableObject.	WeavePathData
		getNames(... relativePath):Array Gets an Array of child names under the object at the current path or relative to the current path.	WeavePath
		getObject(... relativePath):ILinkableObject	WeavePath
		getPath(... relativePath):Array Returns a copy of the current path Array or the path Array of a descendant object.	WeavePath
		getProperties(... relativePath):Object Constructs and returns an object containing keys corresponding to the children of the session state object referenced by this path, the values of which are new WeavePath objects.	WeavePathData
		getReverseDiff(... relativePath_otherState):Object Gets the changes that would have to occur to get to another state for the object at the current path or relative to the current path.	WeavePath
		getSimpleType(... relativePath):String Gets the simple type (unqualified class name) of the object at the current path or relative to the current path.	WeavePath
		getState(... relativePath):Object Gets the session state of an object at the current path or relative to the current path.	WeavePath
		getType(... relativePath):String Gets the type (qualified class name) of the object at the current path or relative to the current path.	WeavePath
		getTypedState(... relativePath):Object	WeavePath
		getUntypedState(... relativePath):Object	WeavePath
		getValue(script_or_function:*, ... args):Object Returns the value of an ActionScript expression or variable using the current path as the 'this' argument.	WeavePath
		label(... relativePath_label):WeavePath Sets a human-readable label for an ILinkableObject to be used in editors.	WeavePathData
		migrate(source:WeavePath, destination:Weave):void [static]	WeavePath
		pop():WeavePath Returns to the previous WeavePath that spawned the current one with push().	WeavePath
		push(... relativePath):WeavePath Creates a new WeavePath relative to the current one.	WeavePath
		remove(... relativePath):WeavePath Removes a dynamically created object.	WeavePath
		removeCallback(relevantContext:Object, callback:Function):WeavePath Removes a callback from the object at the current path or from everywhere.	WeavePath
		removeKeys(... relativePath_qkeyStringArray):WeavePath Removes the specified keys to the KeySet at this path.	WeavePathData
		reorder(... orderedNames):WeavePath Reorders the children of an ILinkableHashMap at the current path.	WeavePath
		request(... relativePath_objectType):WeavePath Requests that an object be created if it doesn't already exist at the current path (or relative path, if specified).	WeavePath
		retrieveRecords(pathMapping:Object, options:Object = null):Array Retrieves a list of records defined by a mapping of property names to column paths or by an array of column names.	WeavePathData
		setColumn(metadata:Object, dataSourceName:String):WeavePath Sets the metadata for a column at the current path.	WeavePathData
		setColumns(metadataMapping:Object, dataSourceName:String):WeavePathData Sets the metadata for multiple columns that are children of the current path.	WeavePathData
		setKeys(... relativePath_qkeyStringArray):WeavePath Replaces the contents of the KeySet at this path with the specified keys.	WeavePathData
		state(... relativePath_state):WeavePath Sets the session state of the object at the current path or relative to the current path.	WeavePath
		toString():String Provides a human-readable string containing the path.	WeavePath
		trace(... args):WeavePath Calls weaveTrace() in Weave to print to the log window.	WeavePath

	Method	Defined By
		_assertParams(methodName:String, args:Array, minLength:int = 1):Boolean [static]	WeavePath
		_failMessage(methodName:String, message:String, path:Array = null):* [static]	WeavePath
		_failObject(methodName:String, path:Array):* [static]	WeavePath
		_failPath(methodName:String, path:Array):* [static]	WeavePath

Property Detail

ColumnUtils

property

public var ColumnUtils:*

DynamicColumn

property

public var DynamicColumn:*

ExtendedDynamicColumn

property

public var ExtendedDynamicColumn:*

IAttributeColumn

property

public var IAttributeColumn:*

IDataSource

property

public var IDataSource:*

IKeySet

property

public var IKeySet:*

IKeySetCallbackInterface

property

public var IKeySetCallbackInterface:*

indexToQKey

property

public var indexToQKey:Function

IQualifiedKey

property

public var IQualifiedKey:*

probe_keyset

property

public var probe_keyset:WeavePathData

qkeyToIndex

property

public var qkeyToIndex:Function

qkeyToString

property

public var qkeyToString:Function

ReferencedColumn

property

public var ReferencedColumn:*

selection_keyset

property

public var selection_keyset:WeavePathData

stringToQKey

property

public var stringToQKey:Function

subset_filter

property

public var subset_filter:WeavePathData

Constructor Detail

WeavePathData

()

Constructor

public function WeavePathData(weave:Weave, basePath:Array)

Parameters

	`weave:Weave`

	`basePath:Array`

Method Detail

addKeys

()

method

public function addKeys(... relativePath_qkeyStringArray):WeavePath

Adds the specified keys to the KeySet at this path. These will not be added immediately, but are queued with flush timeout of approx. 25 ms.

Parameters

... relativePath_qkeyStringArray — An optional Array (or multiple parameters) specifying descendant names relative to the current path A child index number may be used in place of a name in the path when its parent object is a LinkableHashMap.

Returns

WeavePath — {weave.WeavePath} The current WeavePath object.

addKeySetCallback

()

method

public function addKeySetCallback(callback:Function, triggerCallbackNow:Boolean = false):WeavePath

Adds a callback to the KeySet specified by this path which will return information about which keys were added or removed to/from the set.

Parameters

	`callback:Function` — callback A callback function which will receive an object containing two fields, 'added' and 'removed' which contain a list of the keys which changed in the referenced KeySet

	`triggerCallbackNow:Boolean` (default = `false`) — [triggerCallbackNow] Whether to trigger the callback immediately after it is added.

Returns

WeavePath — {weave.WeavePath} The current WeavePath object.

filterKeys

()

method

public function filterKeys(... relativePath_qkeyStringArray):Array

Intersects the specified keys with the KeySet at this path.

Parameters

Returns

Array — {Array} The keys which exist in both the qkeyStringArray and in the KeySet at this path.

flushKeys

()

method

public function flushKeys(... relativePath):WeavePath

Forces a flush of the add/remove key buffers for the KeySet specified by this path.

Parameters

... relativePath — An optional Array (or multiple parameters) specifying descendant names relative to the current path A child index number may be used in place of a name in the path when its parent object is a LinkableHashMap.

Returns

WeavePath — {weave.WeavePath} The current WeavePath object.

getKeys

()

method

public function getKeys(... relativePath):Array

Returns an array of alphanumeric strings uniquely corresponding to the KeySet referenced by this path.

Parameters

... relativePath — An optional Array (or multiple parameters) specifying descendant names relative to the current path. A child index number may be used in place of a name in the path when its parent object is a LinkableHashMap.

Returns

Array — {Array} An array of alphanumeric strings corresponding to the keys contained by the KeySet.

getLabel

()

method

public function getLabel(... relativePath):String

Gets the previously-stored human-readable label for an ILinkableObject.

Parameters

... relativePath — An optional Array (or multiple parameters) specifying child names relative to the current path. A child index number may be used in place of a name in the path when its parent object is a LinkableHashMap.

Returns

String — {string} The human-readable label for an ILinkableObject.

getProperties

()

method

public function getProperties(... relativePath):Object

Constructs and returns an object containing keys corresponding to the children of the session state object referenced by this path, the values of which are new WeavePath objects.

Parameters

Returns

Object — {object} An object containing keys corresponding to the children of the session state object.

label

()

method

public function label(... relativePath_label):WeavePath

Sets a human-readable label for an ILinkableObject to be used in editors.

Parameters

... relativePath_label — An optional Array (or multiple parameters) specifying child names relative to the current path. A child index number may be used in place of a name in the path when its parent object is a LinkableHashMap.

Returns

WeavePath — {weave.WeavePath} The current WeavePath object.

removeKeys

()

method

public function removeKeys(... relativePath_qkeyStringArray):WeavePath

Removes the specified keys to the KeySet at this path. These will not be removed immediately, but are queued with a flush timeout of approx. 25 ms.

Parameters

Returns

WeavePath — {weave.WeavePath} The current WeavePath object.

retrieveRecords

()

method

public function retrieveRecords(pathMapping:Object, options:Object = null):Array

Retrieves a list of records defined by a mapping of property names to column paths or by an array of column names.

Parameters

	`pathMapping:Object` — pathMapping An object containing a mapping of desired property names to column paths or an array of child names. pathMapping can be one of three different forms: 1. An array of column names corresponding to children of the WeavePath this method is called from, e.g., path.retrieveRecords(["x", "y"]); the column names will also be used as the corresponding property names in the resultant records. 2. An object, for which each property=>value is the target record property => source column WeavePath. This can be defined to include recursive structures, e.g., path.retrieveRecords({point: {x: x_column, y: y_column}, color: color_column}), which would result in records with the same form. 3. If it is null, all children of the WeavePath will be retrieved. This is equivalent to: path.retrieveRecords(path.getNames()); The alphanumeric QualifiedKey for each record will be stored in the 'id' field, which means it is to be considered a reserved name.

	`options:Object` (default = `null`) — [options] An object containing optional parameters: "keySet": A WeavePath object pointing to an IKeySet (columns are also IKeySets.) "dataType": A String specifying dataType: string/number/date/geometry

Returns

Array — {Array} An array of record objects.

setColumn

()

method

public function setColumn(metadata:Object, dataSourceName:String):WeavePath

Sets the metadata for a column at the current path.

Parameters

	`metadata:Object` — metadata The metadata identifying the column. The format depends on the data source.

	`dataSourceName:String` — dataSourceName (Optional) The name of the data source in the session state. If ommitted, the first data source in the session state will be used.

Returns

WeavePath — {weave.WeavePath} The current WeavePath object.

setColumns

()

method

public function setColumns(metadataMapping:Object, dataSourceName:String):WeavePathData

Sets the metadata for multiple columns that are children of the current path.

Parameters

	`metadataMapping:Object` — An object mapping child names (or indices) to column metadata. An Array of column metadata objects may be given for a LinkableHashMap.

	`dataSourceName:String` — The name of the data source in the session state. If ommitted, the first data source in the session state will be used.

Returns

WeavePathData — The current WeavePath object.

setKeys

()

method

public function setKeys(... relativePath_qkeyStringArray):WeavePath

Replaces the contents of the KeySet at this path with the specified keys.

Parameters

Returns

WeavePath — {weave.WeavePath} The current WeavePath object.

Wed Jun 28 2017, 02:22 PM -04:00

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
WeavePathData	Properties \| Methods

Package	weavejs.path
Class	public class WeavePathData
Inheritance	WeavePathData WeavePath Object
Subclasses	WeavePathUI