weavejs.path.WeavePathUI

	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
		WeavePathUI(weave:Weave, basePath:Array)	WeavePathUI
		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
		pushPlotter(plotterName:String, plotterType:Object = null):WeavePath This is a shortcut for pushing the path to a plotter from the current path, which should reference a visualization tool.	WeavePathUI
		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

Constructor Detail

WeavePathUI

()

Constructor

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

Parameters

	`weave:Weave`

	`basePath:Array`

Method Detail

pushPlotter

()

method

public function pushPlotter(plotterName:String, plotterType:Object = null):WeavePath

This is a shortcut for pushing the path to a plotter from the current path, which should reference a visualization tool.

Parameters

	`plotterName:String` — (Optional) The name of an existing or new plotter. If omitted and the current path points to a LayerSettings object, the corresponding plotter will be used. Otherwise if omitted the default plotter name ("plot") will be used.

	`plotterType:Object` (default = `null`) — (Optional) The type of plotter to request if it doesn't exist yet.

Returns

WeavePath — A new WeavePath object which remembers the current WeavePath as its parent.

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

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

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