Version

FunnelChartModel Class Members

The following tables list the members exposed by FunnelChartModel.

Public Constructors
 NameDescription
Public ConstructorFunnelChartModel ConstructorInitializes a new instance of the igFunnelChart Model class.  
Public Properties
 NameDescription
Public PropertyAllowSliceSelectionGets or sets whether to allow slices to be selected.  
Public PropertyBezierPointsGets or sets values for upper and lower bezier points. That option has effect only when useBezierCurve is enabled.

Value should provide 4 numeric values in range from 0 to 1 separated by space character. The first number defines upper-x position, second: upper-y, third: lower-x, fourth: lower-y.

Internal default is "0.5 0 0.5 1".

Example: bezierPoints: "0.4 0.1 0.6 1"  
Public PropertyBottomEdgeWidthGets or sets the percentage (from near 0 to 1) of space the bottom edge of the funnel should take.  
Public PropertyBrushesGets sets colors which are used to paint slices. Item in array should represent a valid html-color. For example, "red", "#f0f022", etc.  
Public PropertyBrushesListthe chart brushes  
Public PropertyClientEventsSet implementations of client events raised by a widget.

Event handler assumes 2 parameters: 1st parameter has name "evt" and 2nd parameter has name "ui". To get information about member variables available for "ui" parameter, please consult documentation of a widget and its events.

Examples:

1. Full implementation:

new Dictionary<string, string> { { "dropDownOpening", "function(evt,ui){alert('drop:'+ui.owner);}" } }

2. Content of inline function:

new Dictionary<string, string> { { "dropDownOpening", "alert('drop:'+ui.owner);" } }

3. Name of global function:

new Dictionary<string, string> { { "dropDownOpening", "nameOfGlobalFunction" } } Note:

Instead of explicit key-strings, which represent name of event exposed by a widget, the event-constants defined by a particular control can be used.

Example:

new Dictionary<string, string> { { ComboClientEvents.DropDownOpening, "nameOfGlobalFunction" } } (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public PropertyDataSourceGets or sets the data source object. (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyDataSourceTypeGets or sets the type of the data source. (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyDataSourceUrlGets or sets the data source URL. (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyDataViewthe DataView property contains the filtered and transformed data records after data binding and all feature transformations have been applied (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyFormatInnerLabelGets sets javascript function which formats inner labels.

Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to igFunnelChart.

Example:

"function(val, i, chart) { return 'Value=' + chart.getDataItem(i).Value; }"  
Public PropertyFormatOuterLabelGets sets javascript function which formats outer labels.

Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to igFunnelChart.

Example:

"function(val, i, chart) { return '$' + val + ', ID=' + chart.getDataItem(i).ID; }"  
Public PropertyFunnelSliceDisplayGets or sets how the heights of the funnel slices should be configured.  
Public PropertyHeightGets or sets the height of the igFunnelChart container. (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyHtmlAttributesSets custom attributes of the div on which the map widget will be created. (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyIDGets or sets the ID of the igFunnelChart container. (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyInnerLabelMemberPathGets or sets the InnerLabel mapping property for the current series object.  
Public PropertyInnerLabelVisibilityGets or sets whether the inner labels are visible.  
Public PropertyIsInvertedGets or sets if the funnel should be rendered inverted.  
Public PropertyLegendGets sets the chart legend  
Public PropertyLocalSchemaTransformwhen local schema transforming is turned off, all of the data provided is sent to the client. When it is turned on, only the fields provided in MemberPath options are sent to the client. (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyMaxRecCountGets sets maximum number of displayed slices in chart (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyOuterLabelAlignmentGets or sets which side of the chart the outer labels should appear.  
Public PropertyOuterLabelMemberPathGets or sets the OuterLabel mapping property for the current series object.  
Public PropertyOuterLabelTextColorGets or sets the brush used for the outer labels.  
Public PropertyOuterLabelTextStyleGets or sets the text style for outer labels  
Public PropertyOuterLabelVisibilityGets or sets whether the outer labels are visible.  
Public PropertyOutlinesGets sets colors which are used to paint outlines of slices. Item in array should represent a valid html-color. For example, "red", "#f0f022", etc.  
Public PropertyOutlinesListthe chart outlines  
Public PropertyOutlineThicknessGets or sets the thickness of outline around slices.  
Public PropertyPixelScalingRatioGets or sets the scaling value used to affect the pixel density of the control.  
Public PropertyResponseDataKeyGets or sets the response data key. (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyResponseTotalRecCountKeyGets or sets the property in the response specifying the total number of records on the server (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertySelectedSliceStyleGets or sets style which is applied to selected slices.

Note: the Thickness member of ShapeStyleModel is not supported. Please use OutlineThickness.  
Public PropertyTextColorGets or sets the brush used for the inner labels.  
Public PropertyTextStyleGets or sets the text style for inner labels  
Public PropertyTooltipTemplateGets or sets the template for tooltip. Example: "Value: $(ValueMemberPathInDataSource)" (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public PropertyTransitionDurationGets or sets how long the animations should take to run.  
Public PropertyUnselectedSliceStyleGets or sets style which is applied to unselected slices.

Note: the Thickness member of ShapeStyleModel is not supported. Please use OutlineThickness.  
Public PropertyUseBezierCurveGets or sets whether to use a Bezier curve to define the funnel.  
Public PropertyUseOuterLabelsForLegendGets or sets whether to use the outer labels to identify the legend items.  
Public PropertyUseUnselectedStyleGets or sets whether to use the unselected style on unselected slices.  
Public PropertyValueMemberPathGets or sets the value member path for the funnel chart.  
Public PropertyWidthGets or sets the width of the igFunnelChart container. (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Protected Properties
 NameDescription
Protected PropertyStoreReturn the store with all of the options (Inherited from Infragistics.Web.Mvc.ModelBase)
Public Methods
 NameDescription
Public MethodAddClientEventAdds javascript function to process client event of widget. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public MethodDataBindInitialize data source (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public MethodGetDatafirst performs data binding and generates the JsonResult object (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Public MethodToJsonSerializes the object to JSON. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected Methods
 NameDescription
Protected MethodCamelizeConverts the provided string to camel case. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodEnsureClientEventsAdds client events to Serializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Protected MethodGetBoolGets the value of a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetCharSets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDataMemberPathsOverridden. Gets list which contains ValueMemberPath, InnerLabelMemberPath and OuterLabelMemberPath if those properties are defined.  
Protected MethodGetDateTimeGets the value of a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDoubleGets the value of a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIEnumerable<T>Gets the value of an IEnumerable property of the model. If the value is null a new IEnumerable of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIntGets the value of an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetJSLiteralSets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetLongGets the value of a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetModel<T>Gets the value of an IModel property of the model. If the value is null a new model of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringGets the value of a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringEnum<T>Gets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValue<T>Gets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValueModel<T>Gets the value of an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromBoolSerializes a bool object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDateTimeSerializes a DateTime object into json Date object. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDoubleSerializes a double object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromFloatSerializes a float object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIDictionarySerializes an IDictionary of objects into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIEnumerableSerializes an IEnumerable object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIntSerializes an int object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromModelStoreModelBase.JsonFromModelStore (Inherited from Infragistics.Web.Mvc.ChartModelBase)
Protected MethodJsonFromObjectSerializes an arbitrary object in json using the typed serialization methods. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromStringSerializes a string object into json string, escaping all single quotes. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBoolSets a value to a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBrush (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCamelizedStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCharGets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDateTimeSets a value to a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDoubleSets a value to a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIEnumerable<T>Sets a value to an IEnumerable property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIntSets a value to an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetJSLiteralGets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetLongSets a value to a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetModel<T>Sets a value to an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringSets a value to a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetValue<T>Sets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodTransformDataTransforms the data. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodValidValueType<T>Checks type for value of existing property. Returns false as well if non existing property. (Inherited from Infragistics.Web.Mvc.ModelBase)
See Also

View on GitHub