ColorRamp - API Documentation

Public Properties

	Property		Defined By
		callbacksAreDelayed : Boolean [read-only]	CallbackCollection
		_linkableObject : ILinkableObject	CallbackCollection
		locked : Boolean [read-only] This is set to true when lock() is called.	LinkableVariable
		state : Object	LinkableVariable
		triggerCounter : uint [read-only]	CallbackCollection
		wasDisposed : Boolean [read-only] This flag becomes true after dispose() is called.	CallbackCollection

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		_bypassDiff : Boolean = true If true, session states will be altered to bypass the diff calculation on DynamicState Arrays.	LinkableVariable
		_locked : Boolean = false This is set to true when lock() is called.	LinkableVariable
		_preCallback : Function = null This is the function that gets called immediately before every callback.	CallbackCollection
		_primitiveType : Boolean = false This is true if the _sessionStateType is a primitive type.	LinkableVariable
		_sessionStateExternal : * = undefined Available externally via getSessionState()	LinkableVariable
		_sessionStateInternal : * = undefined Cannot be modified externally because it is not returned by getSessionState()	LinkableVariable
		_sessionStateType : Class = null Type restriction passed in to the constructor.	LinkableVariable
		_sessionStateWasSet : Boolean = false This is true if the session state has been set at least once.	LinkableVariable
		_verifier : Function = null This function is used to prevent the session state from having unwanted values.	LinkableVariable

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ColorRamp(sessionState:Object = null)	ColorRamp
		addDisposeCallback(relevantContext:Object, callback:Function, allowDelay:Boolean = false):void	CallbackCollection
		addGroupedCallback(relevantContext:Object, groupedCallback:Function, triggerCallbackNow:Boolean = false, delayWhileBusy:Boolean = true):void	CallbackCollection
		addImmediateCallback(relevantContext:Object, callback:Function, runCallbackNow:Boolean = false, alwaysCallLast:Boolean = false):void	CallbackCollection
		delayCallbacks():void	CallbackCollection
		detectChanges():void This function may be called to detect change to a non-primitive session state in case it has been modified externally.	LinkableVariable
		dispose():void [override]	LinkableVariable
		findMatchingColorRamp(ramp:ColorRamp):Object [static]	ColorRamp
		getColor(value:Number, min:Number = 0, max:Number = 1):Number Normalizes a value between min and max and returns an RGB hex color.	ColorRamp
		getColorFromNorm(normValue:Number):Number	ColorRamp
		getColorRampByName(rampName:String):Object [static]	ColorRamp
		getColors():Array	ColorRamp
		getHexColor(value:Number, min:Number = 0, max:Number = 1):String Normalizes a value between min and max and returns an RGB hex color.	ColorRamp
		getHexColors():Array	ColorRamp
		getSessionState():Object	LinkableVariable
		getSessionStateType():Class The type restriction passed in to the constructor.	LinkableVariable
		lock():void Call this function when you do not want to allow any more changes to the value of this sessioned property.	LinkableVariable
		removeCallback(relevantContext:Object, callback:Function):void	CallbackCollection
		resumeCallbacks():void	CallbackCollection
		reverse():void	ColorRamp
		setSessionState(value:Object):void	LinkableVariable
		triggerCallbacks():void	CallbackCollection
		verifyValue(value:Object):Boolean This function will verify if a given value is a valid session state for this linkable variable.	LinkableVariable

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		_runCallbacksImmediately(... preCallbackParams):void This function runs callbacks immediately, ignoring any delays.	CallbackCollection
		sessionStateEquals(otherSessionState:*):Boolean This function is used in setSessionState() to determine if the value has changed or not.	LinkableVariable

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		allColorRamps : Array [static]	ColorRamp
		COLOR : String = color [static]	ColorRamp
		DEFAULT_TRIGGER_COUNT : uint = 1 [static] This is the default value of triggerCounter.	CallbackCollection
		POSITION : String = position [static]	ColorRamp
		STACK_TRACE_TRIGGER : String = This is the stack trace from when the callbacks were last triggered. [static]	CallbackCollection

Package	weavejs.util
Class	public class ColorRamp
Inheritance	ColorRamp LinkableVariable CallbackCollection Object

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

	`value:Number` — A numeric value

	`min:Number` (default = `0`) — The min value used for normalization

	`max:Number` (default = `1`) — The max value used for normalization