intellisense.annotate(ej,{
Accordion:function(){
///
/// Constructor of ej.Accordion
///
}
});
ej.Accordion=(function(){
var original=ej.Accordion
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
addItem:function(header_name, content, index, isAjaxReq){
///
///
/// AddItem method is used to add the panel in dynamically. It receives the following parameters
///
/// specify the name of the header
///
///
///
/// AddItem method is used to add the panel in dynamically. It receives the following parameters
///
/// content of the new panel
///
///
///
/// AddItem method is used to add the panel in dynamically. It receives the following parameters
///
/// insertion place of the new panel
///
///
///
/// AddItem method is used to add the panel in dynamically. It receives the following parameters
///
/// Enable or disable the AJAX request to the added panel
///
},
collapseAll:function(){
///
///
/// This method used to collapse the all the expanded items in accordion at a time.
///
},
collapsePanel:function(){
///
///
/// This method used to Collapses the specified items in accordion at a time.
///
},
destroy:function(){
///
///
/// destroy the Accordion widget all events bound using this._on will be unbind automatically and bring the control to pre-init state.
///
},
disable:function(){
///
///
/// Disables the accordion widget includes all the headers and content panels.
///
},
disableItems:function(index){
///
///
/// Disable the accordion widget item based on specified header index.
///
/// index values to disable the panels
///
},
enable:function(){
///
///
/// Enable the accordion widget includes all the headers and content panels.
///
},
enableItems:function(index){
///
///
/// Enable the accordion widget item based on specified header index.
///
/// index values to enable the panels
///
},
expandAll:function(){
///
///
/// To expand all the accordion widget items.
///
},
expandPanel:function(){
///
///
/// This method used to Expand the specified items in accordion at a time.
///
},
getItemsCount:function(){
///
///
/// Returns the total number of panels in the control.
///
},
hide:function(){
///
///
/// Hides the visible Accordion control.
///
},
refresh:function(){
///
///
/// The refresh method is used to adjust the control size based on the parent element dimension.
///
},
removeItem:function(index){
///
///
/// RemoveItem method is used to remove the specified index panel.It receives the parameter as number.
///
/// specify the index value for remove the accordion panel.
///
},
show:function(){
///
///
/// Shows the hidden Accordion control.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejAccordion=function(){
this.data("ejAccordion",new ej.Accordion());
return this;
};
intellisense.annotate(jQuery.fn,{
ejAccordion :function (options) {
///
///
///The Accordion control is an interface where lists of items can be collapsed or expanded. It has several collapsible panels where only one can be expanded at a time that is useful for dashboards where space is limited. Each Accordion control has a template for its header and its content.
///Specifies the ajaxSettings option to load the content to the accordion control.
///
ajaxSettings-AjaxSettings default-null
///
///It specifies, whether to enable or disable asynchronous request.
///
async-boolean default-
///
///It specifies the page will be cached in the web browser.
///
cache-boolean default-
///
///It specifies the type of data is send in the query string.
///
contentType-string default-
///
///It specifies the data as an object, will be passed in the query string.
///
data-any default-
///
///It specifies the type of data that you're expecting back from the response.
///
dataType-string default-
///
///It specifies the HTTP request type.
///
type-string default-
///
///Accordion headers can be expanded and collapsed on keyboard action.
///
allowKeyboardNavigation-boolean default-true
///
///To set the Accordion headers Collapse Speed.
///
collapseSpeed-number default-300
///
///Specifies the collapsible state of accordion control.
///
collapsible-boolean default-false
///
///Sets the root CSS class for Accordion theme, which is used customize.
///
cssClass-string default-
///
///Allows you to set the custom header Icon. It accepts two key values “headerâ€, â€selectedHeaderâ€.
///
customIcon-CustomIcon default-{ header: e-collapse, selectedHeader: e-expand }
///
///This class name set to collapsing header.
///
header-string default-
///
///This class name set to expanded (active) header.
///
selectedHeader-string default-
///
///Disables the specified indexed items in accordion.
///
disabledItems-number[] default-[]
///
///Specifies the animation behavior in accordion.
///
enableAnimation-boolean default-true
///
///With this enabled property, you can enable or disable the Accordion.
///
enabled-boolean default-true
///
///Used to enable the disabled items in accordion.
///
enabledItems-number[] default-[]
///
///Multiple content panels to activate at a time.
///
enableMultipleOpen-boolean default-false
///
///Save current model value to browser cookies for maintaining states. When refreshing the accordion control page, the model value is applied from browser cookies or HTML 5local storage.
///
enablePersistence-boolean default-false
///
///Display headers and panel text from right-to-left.
///
enableRTL-boolean default-false
///
///The events API binds the action for activating the accordion header. Users can activate the header by using mouse actions such as mouse-over, mouse-up, mouse-down, and soon.
///
events-string default-click
///
///To set the Accordion headers Expand Speed.
///
expandSpeed-number default-300
///
///Sets the height for Accordion items header.
///
headerSize-number|string default-
///
///Specifies height of the accordion.
///
height-number|string default-null
///
///Adjusts the content panel height based on the given option (content, auto, or fill). By default, the panel heights are adjusted based on the content.
///
heightAdjustMode-ej.Accordion.HeightAdjustMode|string default-content
///
///It allows to define the characteristics of the Accordion control. It will helps to extend the capability of an HTML element.
///
htmlAttributes-any default-{}
///
///The given index header will activate (open). If collapsible is set to true, and a negative value is given, then all headers are collapsed. Otherwise, the first panel isactivated.
///
selectedItemIndex-number default-0
///
///Activate the specified indexed items of the accordion
///
selectedItems-number[] default-[0]
///
///Used to determines the close button visibility an each accordion items. This close button helps to remove the accordion item from the control.
///
showCloseButton-boolean default-false
///
///Displays rounded corner borders on the Accordion control's panels and headers.
///
showRoundedCorner-boolean default-false
///
///Specifies width of the accordion.
///
width-number|string default-null
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Autocomplete:function(){
///
/// Constructor of ej.Autocomplete
///
}
});
ej.Autocomplete=(function(){
var original=ej.Autocomplete
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
clearText:function(){
///
///
/// Clears the text in the Autocomplete textbox.
///
},
destroy:function(){
///
///
/// Destroys the Autocomplete widget.
///
},
disable:function(){
///
///
/// Disables the autocomplete widget.
///
},
enable:function(){
///
///
/// Enables the autocomplete widget.
///
},
getSelectedItems:function(){
///
///
/// Returns objects (data object) of all the selected items in the autocomplete textbox.
///
},
getValue:function(){
///
///
/// Returns the current selected value from the Autocomplete textbox.
///
},
getActiveText:function(){
///
///
/// Returns the current active text value in the Autocomplete suggestion list.
///
},
hide:function(){
///
///
/// Hides the Autocomplete suggestion list.
///
},
search:function(){
///
///
/// Search the entered text and show it in the suggestion list if available.
///
},
open:function(){
///
///
/// Open up the autocomplete suggestion popup with all list items.
///
},
selectValueByKey:function(Key){
///
///
/// Sets the value of the Autocomplete textbox based on the given key value.
///
/// The key value of the specific suggestion item.
///
},
selectValueByText:function(Text){
///
///
/// Sets the value of the Autocomplete textbox based on the given input text value.
///
/// The text (label) value of the specific suggestion item.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejAutocomplete=function(){
this.data("ejAutocomplete",new ej.Autocomplete());
return this;
};
intellisense.annotate(jQuery.fn,{
ejAutocomplete :function (options) {
///
///
///The AutoComplete control is a textbox control that provides a list of suggestions based on the user query.When the users enters the text in the text box, the control performs a search operation and provides a list of results in the suggestion pop up. There are several filter types available to perform the search.
///Customize "Add New" text (label) to be added in the autocomplete popup list for the entered text when there are no suggestions for it.
///
addNewText-string default-Add New
///
///Allows new values to be added to the autocomplete input other than the values in the suggestion list. Normally, when there are no suggestions it will display “No suggestions†label in the popup.
///
allowAddNew-boolean default-false
///
///Enables or disables the sorting of suggestion list item. The default sort order is ascending order. You customize sort order.
///
allowSorting-boolean default-true
///
///Enables or disables selecting the animation style for the popup list. Animation types can be selected through either of the following options,
///
animateType-ej.Autocomplete.Animation|string default-slide
///
///To focus the items in the suggestion list when the popup is shown. By default first item will be focused.
///
autoFocus-boolean default-false
///
///Enables or disables the case sensitive search.
///
caseSensitiveSearch-boolean default-false
///
///The root class for the Autocomplete textbox widget which helps in customizing its theme.
///
cssClass-string default-â€â€
///
///The data source contains the list of data for the suggestions list. It can be a string array or JSON array or service URL that returns JSON.
///
dataSource-any|Array<any> default-null
///
///The time delay (in milliseconds) after which the suggestion popup will be shown.
///
delaySuggestionTimeout-number default-200
///
///The special character which acts as a separator for the given words for multi-mode search i.e. the text after the delimiter are considered as a separate word or query for search operation.
///
delimiterChar-string default-’,’
///
///The text to be displayed in the popup when there are no suggestions available for the entered text.
///
emptyResultText-string default-“No suggestionsâ€
///
///Fills the autocomplete textbox with the first matched item from the suggestion list automatically based on the entered text when enabled.
///
enableAutoFill-boolean default-false
///
///Enables or disables the Autocomplete textbox widget.
///
enabled-boolean default-true
///
///Enables or disables displaying the duplicate names present in the search result.
///
enableDistinct-boolean default-false
///
///Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true. While refreshing the page, it retains the model value from browser cookies or local storage.
///
enablePersistence-boolean default-false
///
///Displays the Autocomplete widget’s content from right to left when enabled.
///
enableRTL-boolean default-false
///
///Mapping fields for the suggestion items of the Autocomplete textbox widget.
///
fields-Fields default-null
///
///Used to group the suggestion list items.
///
groupBy-string default-
///
///Defines the HTML attributes such as id, class, styles for the item.
///
htmlAttributes-any default-
///
///Defines the specific field name which contains unique key values for the list items.
///
key-string default-
///
///Defines the specific field name in the data source to load the suggestion list with data.
///
text-string default-
///
///Specifies the search filter type. There are several types of search filter available such as ‘startswith’, ‘contains’, ‘endswith’, ‘lessthan’, ‘lessthanorequal’, ‘greaterthan’, ‘greaterthanorequal’, ‘equal’, ‘notequal’.
///
filterType-string default-ej.filterType.StartsWith
///
///The height of the Autocomplete textbox.
///
height-string|number default-null
///
///The search text can be highlighted in the AutoComplete suggestion list when enabled.
///
highlightSearch-boolean default-false
///
///Number of items to be displayed in the suggestion list.
///
itemsCount-number default-0
///
///To enable or disable the diacritic characters of the Autocomplete suggestion list when filtering.
///
ignoreAccent-boolean default-false
///
///Set the localization culture for Autocomplete Widget.
///
locale-string default-
///
///Minimum number of character to be entered in the Autocomplete textbox to show the suggestion list.
///
minCharacter-number default-1
///
///An Autocomplete column collection can be defined and customized through the multiColumnSettings property.Column's header, field, and stringFormat can be define via multiColumnSettings properties.
///
multiColumnSettings-MultiColumnSettings default-
///
///Allow list of data to be displayed in several columns.
///
enable-boolean default-false
///
///Allow header text to be displayed in corresponding columns.
///
showHeader-boolean default-true
///
///Displayed selected value and autocomplete search based on mentioned column value specified in that format.
///
stringFormat-string default-
///
///This property allows user to search text for any number of fields in the suggestion list without modifying the selected text format.
///
searchColumnIndices-Array<any> default-
///
///Field and Header Text collections can be defined and customized through columns field.
///
columns-Array<any> default-
///
///Get or set a value that indicates to display the columns in the autocomplete mapping with column name of the dataSource.
///
field-string default-
///
///Get or set a value that indicates to display the title of that particular column.
///
headerText-string default-
///
///Gets or sets a value that indicates to render the multicolumn with custom theme.
///
cssClass-string default-
///
///Specifies the search data type. There are four types of data types available such as string, ‘number’, ‘boolean’ and ‘date’.
///
type-ej.Type|string default-ej.Type.String
///
///Specifies the search filter type. There are several types of search filter available such as ‘startswith’, ‘contains’, ‘endswith’, ‘lessthan’, ‘lessthanorequal’, ‘greaterthan’, ‘greaterthanorequal’, ‘equal’, ‘notequal’.
///
filterType-ej.filterType|string default-ej.filterType.StartsWith
///
///This defines the text alignment of a particular column header cell value. See headerTextAlign
///
headerTextAlign-ej.TextAlign|string default-ej.TextAlign.Left
///
///Gets or sets a value that indicates to align the text within the column. See textAlign
///
textAlign-ej.TextAlign|string default-ej.TextAlign.Left
///
///Enables or disables selecting multiple values from the suggestion list. Multiple values can be selected through either of the following options,
///
multiSelectMode-ej.Autocomplete.MultiSelectMode|string default-ej.MultiSelectMode.None
///
///The height of the suggestion list.
///
popupHeight-string default-“152pxâ€
///
///The width of the suggestion list.
///
popupWidth-string default-“autoâ€
///
///The query to retrieve the data from the data source.
///
query-ej.Query default-null
///
///Indicates that the autocomplete textbox values can only be readable.
///
readOnly-boolean default-false
///
///Sets the value for the Autocomplete textbox based on the given input key value.
///
selectValueByKey-number default-
///
///Enables or disables showing the message when there are no suggestions for the entered text.
///
showEmptyResultText-boolean default-true
///
///Enables or disables the loading icon to intimate the searching operation. The loading icon is visible when there is a time delay to perform the search.
///
showLoadingIcon-boolean default-true
///
///Enables the showPopup button in autocomplete textbox. When the showPopup button is clicked, it displays all the available data from the data source.
///
showPopupButton-boolean default-false
///
///Enables or disables rounded corner.
///
showRoundedCorner-boolean default-false
///
///Enables or disables reset icon to clear the textbox values.
///
showResetIcon-boolean default-false
///
///Sort order specifies whether the suggestion list values has to be displayed in ascending or descending order.
///
sortOrder-ej.Autocomplete.SortOrder|string default-ej.SortOrder.Ascending
///
///The template to display the suggestion list items with customized appearance.
///
template-string default-null
///
///The jQuery validation error message to be displayed on form validation.
///
validationMessage-any default-null
///
///The jQuery validation rules for form validation.
///
validationRules-any default-null
///
///The value to be displayed in the autocomplete textbox.
///
value-string default-null
///
///Enables or disables the visibility of the autocomplete textbox.
///
visible-boolean default-true
///
///The text to be displayed when the value of the autocomplete textbox is empty.
///
watermarkText-string default-null
///
///The width of the Autocomplete textbox.
///
width-string|number default-null
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Barcode:function(){
///
/// Constructor of ej.Barcode
///
}
});
ej.Barcode=(function(){
var original=ej.Barcode
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
disable:function(){
///
///
/// To disable the barcode
///
},
enable:function(){
///
///
/// To enable the barcode
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejBarcode=function(){
this.data("ejBarcode",new ej.Barcode());
return this;
};
intellisense.annotate(jQuery.fn,{
ejBarcode :function (options) {
///
///
///$(element).ejBarcode()
///Specifies the distance between the barcode and text below it.
///
barcodeToTextGapHeight-number default-
///
///Specifies the height of bars in the Barcode. By modifying the barHeight, the entire barcode height can be customized. Please refer to xDimension for two dimensional barcode height customization.
///
barHeight-number default-
///
///Specifies the dark bar color of the Barcode. One dimensional barcode contains a series of dark and light bars which are usually colored as black and white respectively.
///
darkBarColor-any default-
///
///Specifies whether the text below the barcode is visible or hidden.
///
displayText-boolean default-
///
///Specifies whether the control is enabled.
///
enabled-boolean default-
///
///Specifies the start and stop encode symbol in the Barcode. In one dimensional barcodes, an additional character is added as start and stop delimiters. These symbols are optional and the unique of the symbol allows the reader to determine the direction of the barcode being scanned.
///
encodeStartStopSymbol-number default-
///
///Specifies the light bar color of the Barcode. One dimensional barcode contains a series of dark and light bars which are usually colored as black and white respectively.
///
lightBarColor-any default-
///
///Specifies the width of the narrow bars in the barcode. The dark bars in the one dimensional barcode contains random narrow and wide bars based on the provided input which can be specified during initialization.
///
narrowBarWidth-number default-
///
///Specifies the width of the quiet zone. In barcode, a quiet zone is the blank margin on either side of a barcode which informs the reader where a barcode's symbology starts and stops. The purpose of a quiet zone is to prevent the reader from picking up unrelated information.
///
quietZone-QuietZone default-
///
///Specifies the quiet zone around the Barcode.
///
all-number default-
///
///Specifies the bottom quiet zone of the Barcode.
///
bottom-number default-
///
///Specifies the left quiet zone of the Barcode.
///
left-number default-
///
///Specifies the right quiet zone of the Barcode.
///
right-number default-
///
///Specifies the top quiet zone of the Barcode.
///
top-number default-
///
///Specifies the type of the Barcode. See SymbologyType
///
symbologyType-ej.datavisualization.Barcode.SymbologyType|string default-
///
///Specifies the text to be encoded in the barcode.
///
text-string default-
///
///Specifies the color of the text/data at the bottom of the barcode.
///
textColor-any default-
///
///Specifies the width of the wide bars in the barcode. One dimensional barcode usually contains random narrow and wide bars based on the provided which can be customized during initialization.
///
wideBarWidth-number default-
///
///Specifies the width of the narrowest element(bar or space) in a barcode. The greater the x dimension, the more easily a barcode reader will scan.
///
xDimension-number default-
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
BulletGraph:function(){
///
/// Constructor of ej.BulletGraph
///
}
});
ej.BulletGraph=(function(){
var original=ej.BulletGraph
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
destroy:function(){
///
///
/// To destroy the bullet graph
///
},
redraw:function(){
///
///
/// To redraw the bullet graph
///
},
setComparativeMeasureSymbol:function(index, measure){
///
///
/// To set the value for comparative measure in bullet graph.
///
/// value for the graph
///
///
///
/// To set the value for comparative measure in bullet graph.
///
/// value for the graph
///
},
setFeatureMeasureBarValue:function(index, measure){
///
///
/// To set the value for feature measure bar.
///
/// value for the graph
///
///
///
/// To set the value for feature measure bar.
///
/// value for the graph
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejBulletGraph=function(){
this.data("ejBulletGraph",new ej.BulletGraph());
return this;
};
intellisense.annotate(jQuery.fn,{
ejBulletGraph :function (options) {
///
///
///$(element).ejBulletGraph()
///Toggles the visibility of the range stroke color of the labels.
///
applyRangeStrokeToLabels-boolean default-false
///
///Toggles the visibility of the range stroke color of the ticks.
///
applyRangeStrokeToTicks-boolean default-false
///
///Contains property to customize the caption in bullet graph.
///
captionSettings-CaptionSettings default-
///
///Specifies whether trim the labels will be true or false.
///
enableTrim-boolean default-true
///
///Contains property to customize the font of caption.
///
font-any default-
///
///Specifies the color of the text in caption.
///
color-string default-null
///
///Specifies the fontFamily of caption. Caption text render with this fontFamily
///
fontFamily-string default-Segoe UI
///
///Specifies the fontStyle of caption
///
fontStyle-ej.datavisualization.BulletGraph.FontStyle|string default-Normal
///
///Specifies the fontWeight of caption
///
fontWeight-ej.datavisualization.BulletGraph.FontWeight|string default-regular
///
///Specifies the opacity of caption. Caption text render with this opacity.
///
opacity-number default-1
///
///Specifies the size of caption. Caption text render with this size
///
size-string default-12px
///
///Contains property to customize the indicator.
///
indicator-any default-
///
///Contains property to customize the font of indicator.
///
font-any default-
///
///Specifies the color of the indicator's text.
///
color-string default-null
///
///Specifies the fontFamily of indicator. Indicator text render with this fontFamily.
///
fontFamily-string default-Segoe UI
///
///Specifies the fontStyle of indicator. Indicator text render with this fontStyle. See FontStyle
///
fontStyle-ej.datavisualization.BulletGraph.FontStyle|string default-Normal
///
///Specifies the fontWeight of indicator. Indicator text render with this fontWeight. See FontWeight
///
fontWeight-ej.datavisualization.BulletGraph.FontWeight|string default-regular
///
///Specifies the opacity of indicator text. Indicator text render with this Opacity.
///
opacity-number default-1
///
///Specifies the size of indicator. Indicator text render with this size.
///
size-string default-12px
///
///Contains property to customize the location of indicator.
///
location-any default-
///
///Specifies the horizontal position of the indicator.
///
x-number default-10
///
///Specifies the vertical position of the indicator.
///
y-number default-60
///
///Specifies the padding to be applied when text position is used.
///
padding-number default-2
///
///Contains property to customize the symbol of indicator.
///
symbol-any default-
///
///Contains property to customize the border of indicator symbol.
///
border-any default-
///
///Specifies the border color of indicator symbol.
///
color-string default-null
///
///Specifies the border width of indicator symbol.
///
width-number default-1
///
///Specifies the color of indicator symbol.
///
color-string default-null
///
///Specifies the URL of image that represents indicator symbol.
///
imageURL-string default-
///
///Specifies the opacity of indicator symbol.
///
opacity-number default-1
///
///Specifies the shape of indicator symbol.
///
shape-string default-
///
///Contains property to customize the size of indicator symbol.
///
size-any default-
///
///Specifies the height of indicator symbol.
///
height-number default-10
///
///Specifies the width of indicator symbol.
///
width-number default-10
///
///Specifies the text to be displayed as indicator text. By default difference between current value and target will be displayed
///
text-string default-
///
///Specifies the alignment of indicator with respect to scale based on text position
///
textAlignment-ej.datavisualization.BulletGraph.TextAlignment|string default-'Near'
///
///Specifies where indicator text should be anchored when indicator overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position.
///
textAnchor-ej.datavisualization.BulletGraph.TextAnchor|string default-'start'
///
///indicator text render in the specified angle.
///
textAngle-number default-0
///
///Specifies where indicator should be placed
///
textPosition-ej.datavisualization.BulletGraph.TextPosition|string default-'float'
///
///Specifies the space between indicator symbol and text.
///
textSpacing-number default-3
///
///Specifies whether indicator will be visible or not.
///
visible-boolean default-false
///
///Contains property to customize the location.
///
location-any default-
///
///Specifies the position in horizontal direction
///
x-number default-17
///
///Specifies the position in horizontal direction
///
y-number default-30
///
///Specifies the padding to be applied when text position is used.
///
padding-number default-5
///
///Contains property to customize the subtitle.
///
subTitle-any default-
///
///Contains property to customize the font of subtitle.
///
font-any default-
///
///Specifies the color of the subtitle's text.
///
color-string default-null
///
///Specifies the fontFamily of subtitle. Subtitle text render with this fontFamily.
///
fontFamily-string default-Segoe UI
///
///Specifies the fontStyle of subtitle. Subtitle text render with this fontStyle. See FontStyle
///
fontStyle-ej.datavisualization.BulletGraph.FontStyle|string default-Normal
///
///Specifies the fontWeight of subtitle. Subtitle text render with this fontWeight. See FontWeight
///
fontWeight-ej.datavisualization.BulletGraph.FontWeight|string default-regular
///
///Specifies the opacity of subtitle. Subtitle text render with this opacity.
///
opacity-number default-1
///
///Specifies the size of subtitle. Subtitle text render with this size.
///
size-string default-12px
///
///Contains property to customize the location of subtitle.
///
location-any default-
///
///Specifies the horizontal position of the subtitle.
///
x-number default-10
///
///Specifies the vertical position of the subtitle.
///
y-number default-45
///
///Specifies the padding to be applied when text position is used.
///
padding-number default-5
///
///Specifies the text to be displayed as subtitle.
///
text-string default-
///
///Specifies the alignment of sub title text with respect to scale. Alignment will not be applied in float position.
///
textAlignment-ej.datavisualization.BulletGraph.TextAlignment|string default-'Near'
///
///Specifies where subtitle text should be anchored when sub title text overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position.
///
textAnchor-ej.datavisualization.BulletGraph.TextAnchor|string default-'start'
///
///Subtitle render in the specified angle.
///
textAngle-number default-0
///
///Specifies where sub title text should be placed.
///
textPosition-ej.datavisualization.BulletGraph.TextPosition|string default-'float'
///
///Specifies the text to be displayed on bullet graph.
///
text-string default-
///
///Specifies the alignment of caption text with respect to scale. This property will not be applied when text position is float.
///
textAlignment-ej.datavisualization.BulletGraph.TextAlignment|string default-'Near'
///
///Specifies caption text anchoring when caption text overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position.
///
textAnchor-ej.datavisualization.BulletGraph.TextAnchor|string default-'start'
///
///Specifies the angel in which the caption is rendered.
///
textAngle-number default-0
///
///Specifies how caption text should be placed.
///
textPosition-ej.datavisualization.BulletGraph.TextPosition|string default-'float'
///
///Comparative measure bar in bullet graph render till the specified value.
///
comparativeMeasureValue-number default-0
///
///Toggles the animation of bullet graph.
///
enableAnimation-boolean default-true
///
///Controls whether bullet graph has to be responsive while resizing.
///
enableResizing-boolean default-true
///
///Specifies the direction of flow in bullet graph. Neither it may be backward nor forward.
///
flowDirection-ej.datavisualization.BulletGraph.FlowDirection|string default-forward
///
///Specifies the height of the bullet graph.
///
height-number default-90
///
///Sets a value whether to make the bullet graph responsive on resize.
///
isResponsive-boolean default-true
///
///Specifies to convert the date object to string, using locale settings.
///
enableGroupSeparator-boolean default-false
///
///Name of the culture based on which bulletgraph should be localized.
///
locale-string default-en-US
///
///Bullet graph will render in the specified orientation.
///
orientation-ej.datavisualization.BulletGraph.Orientation|string default-horizontal
///
///Contains property to customize the qualitative ranges.
///
qualitativeRanges-Array<QualitativeRanges> default-
///
///Specifies the ending range to which the qualitative ranges will render.
///
rangeEnd-number default-3
///
///Specifies the opacity for the qualitative ranges.
///
rangeOpacity-number default-1
///
///Specifies the stroke for the qualitative ranges.
///
rangeStroke-string default-null
///
///Size of the qualitative range depends up on the specified value.
///
qualitativeRangeSize-number default-32
///
///Length of the quantitative range depends up on the specified value.
///
quantitativeScaleLength-number default-475
///
///Contains all the properties to customize quantitative scale.
///
quantitativeScaleSettings-QuantitativeScaleSettings default-
///
///Contains property to customize the comparative measure.
///
comparativeMeasureSettings-any default-
///
///Specifies the stroke of the comparative measure.
///
stroke-number default-null
///
///Specifies the width of the comparative measure.
///
width-number default-5
///
///Contains property to customize the featured measure.
///
featuredMeasureSettings-any default-
///
///Specifies the Stroke of the featured measure in bullet graph.
///
stroke-number default-null
///
///Specifies the width of the featured measure in bullet graph.
///
width-number default-2
///
///Contains property to customize the featured measure.
///
featureMeasures-Array<any> default-
///
///Specifies the category of feature measure.
///
category-string default-null
///
///Comparative measure render till the specified value.
///
comparativeMeasureValue-number default-null
///
///Feature measure render till the specified value.
///
value-number default-null
///
///Contains property to customize the fields.
///
fields-any default-
///
///Specifies the category of the bullet graph.
///
category-string default-null
///
///Comparative measure render based on the values in the specified field.
///
comparativeMeasure-string default-null
///
///Specifies the dataSource for the bullet graph.
///
dataSource-any default-null
///
///Feature measure render based on the values in the specified field.
///
featureMeasures-string default-null
///
///Specifies the query for fetching the values form data source to render the bullet graph.
///
query-string default-null
///
///Specifies the name of the table.
///
tableName-string default-null
///
///Specifies the interval for the Graph.
///
interval-number default-1
///
///Contains property to customize the labels.
///
labelSettings-any default-
///
///Contains property to customize the font of the labels in bullet graph.
///
font-any default-
///
///Specifies the fontFamily of labels in bullet graph. Labels render with this fontFamily.
///
fontFamily-string default-Segoe UI
///
///Specifies the fontStyle of labels in bullet graph. Labels render with this fontStyle. See FontStyle
///
fontStyle-ej.datavisualization.BulletGraph.FontStyle|string default-Normal
///
///Specifies the fontWeight of labels in bullet graph. Labels render with this fontWeight. See FontWeight
///
fontWeight-ej.datavisualization.BulletGraph.FontWeight|string default-regular
///
///Specifies the opacity of labels in bullet graph. Labels render with this opacity
///
opacity-number default-1
///
///Specifies the placement of labels in bullet graph scale.
///
labelPlacement-ej.datavisualization.BulletGraph.LabelPlacement|string default-outside
///
///Specifies the prefix to be added with labels in bullet graph.
///
labelPrefix-string default-Empty string
///
///Specifies the suffix to be added after labels in bullet graph.
///
labelSuffix-string default-Empty string
///
///Specifies the horizontal/vertical padding of labels.
///
offset-number default-15
///
///Specifies the position of the labels to render either above or below the graph. See
///
position-ej.datavisualization.BulletGraph.LabelPosition|string default-below
///
///Specifies the Size of the labels.
///
size-number default-12
///
///Specifies the stroke color of the labels in bullet graph.
///
stroke-string default-null
///
///Contains property to customize the position of the quantitative scale
///
location-any default-
///
///This property specifies the x position for rendering quantitative scale.
///
x-number default-10
///
///This property specifies the y position for rendering quantitative scale.
///
y-number default-10
///
///Contains property to customize the major tick lines.
///
majorTickSettings-any default-
///
///Specifies the size of the major ticks.
///
size-number default-13
///
///Specifies the stroke color of the major tick lines.
///
stroke-string default-null
///
///Specifies the width of the major tick lines.
///
width-number default-2
///
///Specifies the maximum value of the Graph.
///
maximum-number default-10
///
///Specifies the minimum value of the Graph.
///
minimum-number default-0
///
///Contains property to customize the minor ticks.
///
minorTickSettings-any default-
///
///Specifies the size of minor ticks.
///
size-number default-7
///
///Specifies the stroke color of minor ticks in bullet graph.
///
stroke-string default-null
///
///Specifies the width of the minor ticks in bullet graph.
///
width-number default-2
///
///The specified number of minor ticks will be rendered per interval.
///
minorTicksPerInterval-number default-4
///
///Specifies the placement of ticks to render either inside or outside the scale.
///
tickPlacement-ej.datavisualization.BulletGraph.TickPlacement|string default-ej.datavisualization.BulletGraph.TickPlacement.Outside
///
///Specifies the position of the ticks to render either above,below or inside
///
tickPosition-ej.datavisualization.BulletGraph.TickPosition|string default-ej.datavisualization.BulletGraph.TickPosition.Far
///
///By specifying this property the user can change the theme of the bullet graph.
///
theme-string default-flatlight
///
///Contains all the properties to customize tooltip.
///
tooltipSettings-TooltipSettings default-
///
///Specifies template for caption tooltip
///
captionTemplate-string default-null
///
///Toggles the visibility of caption tooltip
///
enableCaptionTooltip-boolean default-false
///
///Specifies the ID of a div, which is to be displayed as tooltip.
///
template-string default-null
///
///Toggles the visibility of tooltip
///
visible-boolean default-true
///
///Feature measure bar in bullet graph render till the specified value.
///
value-number default-0
///
///Specifies the width of the bullet graph.
///
width-number default-595
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Button:function(){
///
/// Constructor of ej.Button
///
}
});
ej.Button=(function(){
var original=ej.Button
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
destroy:function(){
///
///
/// destroy the button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state.
///
},
disable:function(){
///
///
/// To disable the button
///
},
enable:function(){
///
///
/// To enable the button
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejButton=function(){
this.data("ejButton",new ej.Button());
return this;
};
intellisense.annotate(jQuery.fn,{
ejButton :function (options) {
///
///
///Custom Design for HTML Button control.
///Specifies the contentType of the Button. See below to know available ContentType
///
contentType-ej.ContentType|string default-ej.ContentType.TextOnly
///
///Sets the root CSS class for Button theme, which is used customize.
///
cssClass-string default-
///
///Specifies the button control state.
///
enabled-boolean default-true
///
///Specify the Right to Left direction to button
///
enableRTL-boolean default-false
///
///Specifies the height of the Button.
///
height-number default-28
///
///It allows to define the characteristics of the Button control. It will helps to extend the capability of an HTML element.
///
htmlAttributes-any default-{}
///
///Specifies the image position of the Button. This image position is applicable only with the textandimage contentType property. The images can be positioned in both imageLeft and imageRight options. See below to know about available ImagePosition
///
imagePosition-ej.ImagePosition|string default-ej.ImagePosition.ImageLeft
///
///Specifies the primary icon for Button. This icon will be displayed from the left margin of the button.
///
prefixIcon-string default-null
///
///Convert the button as repeat button. It raises the 'Click' event repeatedly from the it is pressed until it is released.
///
repeatButton-boolean default-false
///
///Displays the Button with rounded corners.
///
showRoundedCorner-boolean default-false
///
///Specifies the size of the Button. See below to know available ButtonSize
///
size-ej.ButtonSize|string default-ej.ButtonSize.Normal
///
///Specifies the secondary icon for Button. This icon will be displayed from the right margin of the button.
///
suffixIcon-string default-null
///
///Specifies the text content for Button.
///
text-string default-null
///
///Specified the time interval between two consecutive 'click' event on the button.
///
timeInterval-string default-150
///
///Specifies the Type of the Button. See below to know available ButtonType
///
type-ej.ButtonType|string default-ej.ButtonType.Submit
///
///Specifies the width of the Button.
///
width-string|number default-100px
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Calculate:function(){
///
/// Constructor of ej.Calculate
///
}
});
ej.Calculate=(function(){
var original=ej.Calculate
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
addCustomFunction:function(FormulaName, FunctionName){
///
///
/// Add the custom formulas with function in CalcEngine library
///
/// pass the formula name
///
///
///
/// Add the custom formulas with function in CalcEngine library
///
/// pass the custom function name to call
///
},
addNamedRange:function(Name, cellRange){
///
///
/// Adds a named range to the NamedRanges collection
///
/// pass the namedRange's name
///
///
///
/// Adds a named range to the NamedRanges collection
///
/// pass the cell range of NamedRange
///
},
adjustRangeArg:function(Name){
///
///
/// Accepts a possible parsed formula and returns the calculated value without quotes.
///
/// pass the cell range to adjust its range
///
},
clearFormulaDependentCells:function(Cell){
///
///
/// When a formula cell changes, call this method to clear it from its dependent cells.
///
/// pass the changed cell address
///
},
clearLibraryComputationException:function(){
///
///
/// Call this method to clear whether an exception was raised during the computation of a library function.
///
},
colIndex:function(Cell){
///
///
/// Get the column index from a cell reference passed in.
///
/// pass the cell address
///
},
computedValue:function(Formula){
///
///
/// Evaluates a parsed formula.
///
/// pass the parsed formula
///
},
computeFormula:function(Formula){
///
///
/// Evaluates a parsed formula.
///
/// pass the parsed formula
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejCalculate=function(){
this.data("ejCalculate",new ej.Calculate());
return this;
};
intellisense.annotate(jQuery.fn,{
ejCalculate :function (options) {
///
///
///Custom engine to perform calculation like excel sheet$(element).ejCalculate()Example{:.example}
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Captcha:function(){
///
/// Constructor of ej.Captcha
///
}
});
ej.Captcha=(function(){
var original=ej.Captcha
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejCaptcha=function(){
this.data("ejCaptcha",new ej.Captcha());
return this;
};
intellisense.annotate(jQuery.fn,{
ejCaptcha :function (options) {
///
///
///Captcha is a popular technique that is used to prevent computer programs from sending automated requests and is used for meta-searching search engines, performing dictionary attacks in login pages, or sending spam by using mail servers. Captcha is validated at the time of form submission.
///Specifies the character set of the Captcha that will be used to generate captcha text randomly.
///
characterSet-string default-
///
///Specifies the error message to be displayed when the Captcha mismatch.
///
customErrorMessage-string default-
///
///Set the Captcha validation automatically.
///
enableAutoValidation-boolean default-
///
///Specifies the case sensitivity for the characters typed in the Captcha.
///
enableCaseSensitivity-boolean default-
///
///Specifies the background patterns for the Captcha.
///
enablePattern-boolean default-
///
///Sets the Captcha direction as right to left alignment.
///
enableRTL-boolean default-
///
///Specifies the background appearance for the captcha.
///
hatchStyle-ej.HatchStyle|string default-
///
///Specifies the height of the Captcha.
///
height-number default-
///
///Specifies the method with values to be mapped in the Captcha.
///
mapper-string default-
///
///Specifies the maximum number of characters used in the Captcha.
///
maximumLength-number default-
///
///Specifies the minimum number of characters used in the Captcha.
///
minimumLength-number default-
///
///Specifies the method to map values to Captcha.
///
requestMapper-string default-
///
///Sets the Captcha with audio support, that enables to dictate the captcha text.
///
showAudioButton-boolean default-
///
///Sets the Captcha with a refresh button.
///
showRefreshButton-boolean default-
///
///Specifies the target button of the Captcha to validate the entered text and captcha text.
///
targetButton-string default-
///
///Specifies the target input element that will verify the Captcha.
///
targetInput-string default-
///
///Specifies the width of the Captcha.
///
width-number default-
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Chart:function(){
///
/// Constructor of ej.Chart
///
}
});
ej.Chart=(function(){
var original=ej.Chart
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
animate:function(options){
///
///
/// Animates the series and/or indicators in Chart. When parameter is not passed to this method, then all the series and indicators present in Chart are animated.
///
/// If an array collection is passed as parameter, series and indicator objects passed in array collection are animated.ExampleIf a series or indicator object is passed to this method, then the specific series or indicator is animated.Example,
///
},
print:function(){
///
///
/// Prints the rendered chart.
///
},
export:function(type, URL, exportMultipleChart){
///
///
/// Exports chart as an image or to an excel file. Chart can be exported as an image only when exportCanvasRendering option is set to true.
///
/// Type of the export operation to be performed. Following are the two export types that are supported now,1. 'image'2. 'excel'Example
///
///
///
/// Exports chart as an image or to an excel file. Chart can be exported as an image only when exportCanvasRendering option is set to true.
///
/// URL of the service, where the chart will be exported to excel.Example,
///
///
///
/// Exports chart as an image or to an excel file. Chart can be exported as an image only when exportCanvasRendering option is set to true.
///
/// When this parameter is true, all the chart objects initialized to the same document are exported to a single excel file. This is an optional parameter. By default, it is false.Example,
///
},
redraw:function(){
///
///
/// Redraws the entire chart. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejChart=function(){
this.data("ejChart",new ej.Chart());
return this;
};
intellisense.annotate(jQuery.fn,{
ejChart :function (options) {
///
///
///Essential chart can be easily configured to the DOM element, such as div. You can create a Chart with highly customizable look and feel.
///Options for adding and customizing annotations in Chart.
///
annotations-Array<Annotations> default-
///
///Angle to rotate the annotation in degrees.
///
angle-number default-'0'
///
///Text content or id of a HTML element to be displayed as annotation.
///
content-string default-
///
///Specifies how annotations have to be placed in Chart.
///
coordinateUnit-ej.datavisualization.Chart.CoordinateUnit|string default-none. See CoordinateUnit
///
///Specifies the horizontal alignment of the annotation.
///
horizontalAlignment-ej.datavisualization.Chart.HorizontalAlignment|string default-middle. See HorizontalAlignment
///
///Options to customize the margin of annotation.
///
margin-any default-
///
///Annotation is placed at the specified value above its original position.
///
bottom-number default-0
///
///Annotation is placed at the specified value from left side of its original position.
///
left-number default-0
///
///Annotation is placed at the specified value from the right side of its original position.
///
right-number default-0
///
///Annotation is placed at the specified value under its original position.
///
top-number default-0
///
///Controls the opacity of the annotation.
///
opacity-number default-1
///
///Specifies whether annotation has to be placed with respect to chart or series.
///
region-ej.datavisualization.Chart.Region|string default-chart. See Region
///
///Specifies the vertical alignment of the annotation.
///
verticalAlignment-ej.datavisualization.Chart.VerticalAlignment|string default-middle. See VerticalAlignment
///
///Controls the visibility of the annotation.
///
visible-boolean default-false
///
///Represents the horizontal offset when coordinateUnit is pixels.when coordinateUnit is points, it represents the x-coordinate of axis bounded with xAxisName property or primary X axis when xAxisName is not provided.This property is not applicable when coordinateUnit is none.
///
x-number default-0
///
///Name of the horizontal axis to be used for positioning the annotation. This property is applicable only when coordinateUnit is points.
///
xAxisName-string default-
///
///Represents the vertical offset when coordinateUnit is pixels.When coordinateUnit is points, it represents the y-coordinate of axis bounded with yAxisName property or primary Y axis when yAxisName is not provided.This property is not applicable when coordinateUnit is none.
///
y-number default-0
///
///Name of the vertical axis to be used for positioning the annotation.This property is applicable only when coordinateUnit is points.
///
yAxisName-string default-
///
///Sets the background color of the chart.
///
background-string default-transparent
///
///URL of the image to be used as chart background.
///
backGroundImageUrl-string default-null
///
///Options for customizing the color, opacity and width of the chart border.
///
border-Border default-
///
///Border color of the chart.
///
color-string default-null
///
///Opacity of the chart border.
///
opacity-number default-0.3
///
///Width of the Chart border.
///
width-number default-0
///
///This provides options for customizing export settings
///
exportSettings-ExportSettings default-
///
///Specifies the downloading filename
///
filename-string default-chart
///
///Specifies the name of the action URL
///
action-string default-
///
///Specifies the angle for rotation
///
angle-number default-0
///
///Specifies the format of the file to export
///
type-ej.datavisualization.Chart.ExportingType|string default-png
///
///Specifies the orientation of the document
///
orientation-ej.datavisualization.Chart.ExportingOrientation|string default-portrait
///
///Specifies the mode of exporting
///
mode-ej.datavisualization.Chart.ExportingMode|string default-client
///
///Enable/ disable the multiple excel exporting
///
multipleExport-boolean default-false
///
///Options for configuring the border and background of the plot area.
///
chartArea-ChartArea default-
///
///Background color of the plot area.
///
background-string default-transparent
///
///Options for customizing the border of the plot area.
///
border-any default-
///
///Border color of the plot area.
///
color-string default-Gray
///
///Opacity of the plot area border.
///
opacity-number default-0.3
///
///Border width of the plot area.
///
width-number default-0.5
///
///Options to split Chart into multiple plotting areas vertically. Each object in the collection represents a plotting area in Chart.
///
columnDefinitions-Array<ColumnDefinitions> default-
///
///Specifies the unit to measure the width of the column in plotting area.
///
unit-ej.datavisualization.Chart.Unit|string default-'pixel'. See Unit
///
///Width of the column in plotting area. Width is measured in either pixel or percentage based on the value of unit property.
///
columnWidth-number default-50
///
///Color of the line that indicates the starting point of the column in plotting area.
///
lineColor-string default-transparent
///
///Width of the line that indicates the starting point of the column in plot area.
///
lineWidth-number default-1
///
///Options for configuring the properties of all the series. You can also override the options for specific series by using series collection.
///
commonSeriesOptions-CommonSeriesOptions default-
///
///Specifies animation duration for series rendering
///
animationDuration-string default-null
///
///Options to customize the border of all the series.
///
border-any default-
///
///Border color of all series.
///
color-string default-transparent
///
///DashArray for border of the series.
///
dashArray-string default-null
///
///Border width of all series.
///
width-number default-1
///
///To render the column and bar type series in rectangle/cylinder shape. See
///
columnFacet-ej.datavisualization.Chart.ColumnFacet|string default-rectangle
///
///Relative width of the columns in column type series. Value ranges from 0 to 1. Width also depends upon columnSpacing property.
///
columnWidth-number default-0.7
///
///Spacing between columns of different series. Value ranges from 0 to 1
///
columnSpacing-number default-0
///
///Enables or disables the visibility of legend item.
///
visibleOnLegend-string default-visible
///
///Group of the stacking collection series.
///
stackingGroup-string default-
///
///Pattern of dashes and gaps used to stroke all the line type series.
///
dashArray-string default-
///
///Set the dataSource for all series. It can be an array of JSON objects or an instance of ej.DataManager.
///
dataSource-any default-null
///
///Specifies spline tension value for cardinal spline type. Value ranges from 0 to 1.
///
cardinalSplineTension-number default-0.5
///
///Controls the size of the hole in doughnut series. Value ranges from 0 to 1
///
doughnutCoefficient-number default-0.4
///
///Controls the size of the doughnut series. Value ranges from 0 to 1.
///
doughnutSize-number default-0.8
///
///Specifies the type of series to be drawn in radar or polar series.
///
drawType-ej.datavisualization.Chart.DrawType|string default-line. See DrawType
///
///Enable/disable the animation for all the series.
///
enableAnimation-boolean default-true
///
///To avoid overlapping of data labels smartly.
///
enableSmartLabels-boolean default-true
///
///Start angle of pie/doughnut series.
///
endAngle-number default-null
///
///Explodes the pie/doughnut slices on mouse move.
///
explode-boolean default-false
///
///Explodes all the slice of pie/doughnut on render.
///
explodeAll-boolean default-false
///
///Index of the point to be exploded from pie/doughnut/pyramid/funnel.
///
explodeIndex-number default-null
///
///Specifies the distance of the slice from the center, when it is exploded.
///
explodeOffset-number default-0.4
///
///Fill color for all the series.
///
fill-string default-null
///
///Options for customizing the font of all the series.
///
font-any default-
///
///Font color of the text in all series.
///
color-string default-#707070
///
///Font Family for all the series.
///
fontFamily-string default-Segoe UI
///
///Specifies the font Style for all the series.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-normal
///
///Specifies the font weight for all the series.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-regular
///
///Opacity for text in all the series.
///
opacity-number default-1
///
///Font size for text in all the series.
///
size-string default-12px
///
///Sets the height of the funnel in funnel series. Values can be either pixel or percentage.
///
funnelHeight-string default-32.7%
///
///Sets the width of the funnel in funnel series. Values can be either pixel or percentage.
///
funnelWidth-string default-11.6%
///
///Gap between the slices in pyramid and funnel series.
///
gapRatio-number default-0
///
///Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path.
///
isClosed-boolean default-true
///
///Specifies whether to stack the column series in polar/radar charts.
///
isStacking-boolean default-false
///
///Renders the chart vertically. This is applicable only for Cartesian type series.
///
isTransposed-boolean default-false
///
///Render the x mark in the center of the box and whisker series type.x represents the average value of the box and whisker series.
///
showMedian-boolean default-true
///
///Position of the data label in pie/doughnut/pyramid/funnel series. OutsideExtended position is not applicable for pyramid/funnel.
///
labelPosition-ej.datavisualization.Chart.LabelPosition|string default-inside. See LabelPosition
///
///Specifies the mode for splitting the data points in pieOfPie series.
///
splitMode-ej.datavisualization.Chart.SplitMode|string default-value. See SplitMode
///
///Quartile calculation has been performed in three different formulas to render the box and whisker series.
///
boxPlotMode-ej.datavisualization.Chart.boxPlotMode|string default-exclusive
///
///Options for customizing the bubble options of the Bubble series
///
bubbleOptions-any default-
///
///Used for the calculation of the bubble radius based on the mode selected
///
radiusMode-ej.datavisualization.Chart.RadiusMode|string default-minMax
///
///Used for the setting the minimum radius of the bubble
///
minRadius-number default-1
///
///Used for setting the maximum radius of the bubble
///
maxRadius-number default-3
///
///To render the spline series curve in different forms.
///
splineType-ej.datavisualization.Chart.SplineType|string default-natural. See SplineType
///
///Specifies the line cap of the series.
///
lineCap-ej.datavisualization.Chart.LineCap|string default-butt. See LineCap
///
///Specifies the type of shape to be used where two lines meet.
///
lineJoin-ej.datavisualization.Chart.LineJoin|string default-round. See LineJoin
///
///Options for displaying and customizing marker for individual point in a series. Marker contains shapes and/or data labels.
///
marker-any default-
///
///Options for customizing the border of the marker shape.
///
border-any default-
///
///Border color of the marker shape.
///
color-string default-white
///
///Border width of the marker shape.
///
width-number default-3
///
///Options for displaying and customizing data labels.
///
dataLabel-any default-
///
///Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate.
///
angle-number default-null
///
///Maximum label width of the data label.
///
maximumLabelWidth-number default-null
///
///Enable the wrap option to the data label.
///
enableWrap-boolean default-false
///
///Enables saturation to the data label.
///
enableContrastColor-boolean default-false
///
///Displays the partially visible labels inside the chart Area
///
showEdgeLabels-boolean default-false
///
///Options for customizing the border of the data label.
///
border-any default-
///
///Border color of the data label.
///
color-string default-null
///
///Border width of the data label.
///
width-number default-0.1
///
///Options for displaying and customizing the line that connects point and data label.
///
connectorLine-any default-
///
///Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types.
///
type-ej.datavisualization.Chart.ConnectorLineType|string default-line. See ConnectorLineType
///
///Width of the connector.
///
width-number default-0.5
///
///Color of the connector line.
///
color-string default-#565656
///
///Height of the connector line.
///
height-string default-null
///
///Background color of the data label.
///
fill-string default-null
///
///Options for customizing the data label font.
///
font-any default-
///
///Font family of the data label.
///
fontFamily-string default-Segoe UI
///
///Font style of the data label.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-normal. See FontStyle
///
///Font weight of the data label.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-regular. See FontWeight
///
///Opacity of the text.
///
opacity-number default-1
///
///Font color of the data label text.
///
color-string default-null
///
///Font size of the data label.
///
size-string default-12px
///
///Horizontal alignment of the data label.
///
horizontalTextAlignment-ej.datavisualization.Chart.HorizontalTextAlignment|string default-center
///
///Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text.
///
margin-any default-
///
///Bottom margin of the text.
///
bottom-number default-5
///
///Left margin of the text.
///
left-number default-5
///
///Right margin of the text.
///
right-number default-5
///
///Top margin of the text.
///
top-number default-5
///
///Opacity of the data label.
///
opacity-number default-1
///
///Options for customizing the datalabel positions
///
offset-any|number default-
///
///X value or horizontal offset to position the labels in chart.
///
x-number default-0
///
///Y value or vertical offset to position the labels.
///
y-number default-0
///
///Background shape of the data label.
///
shape-ej.datavisualization.Chart.Shape|string default-none. See Shape
///
///Custom template to format the data label content. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value.
///
template-string default-
///
///Name of a field in data source, where datalabel text is displayed.
///
textMappingName-string default-
///
///Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC.
///
textPosition-ej.datavisualization.Chart.TextPosition|string default-top. See TextPosition
///
///Vertical alignment of the data label.
///
verticalTextAlignment-ej.datavisualization.Chart.VerticalTextAlignment|string default-center
///
///Controls the visibility of the data labels.
///
visible-boolean default-false
///
///Color of the marker shape.
///
fill-string default-null
///
///The URL for the Image to be displayed as marker. In order to display image as marker, set series.marker.shape as ‘image’.
///
imageUrl-string default-
///
///Opacity of the marker.
///
opacity-number default-1
///
///Specifies the shape of the marker.
///
shape-ej.datavisualization.Chart.Shape|string default-circle. See Shape
///
///Options for customizing the size of the marker shape.
///
size-any default-
///
///Height of the marker.
///
height-number default-6
///
///Width of the marker.
///
width-number default-6
///
///Controls the visibility of the marker shape.
///
visible-boolean default-false
///
///Opacity of the series.
///
opacity-number default-1
///
///Options for customizing the outlier of the series.
///
outlierSettings-any default-
///
///Specifies the shape of the outlier.
///
shape-ej.datavisualization.Chart.Shape|string default-circle. See Shape
///
///Options for customizing the size of the outlier shape.
///
size-any default-
///
///Height of the outlier shape.
///
height-number default-6
///
///Width of the outlier shape.
///
width-number default-6
///
///Name of a field in data source, where the fill color for all the data points is generated.
///
palette-string default-
///
///Controls the size of pie series. Value ranges from 0 to 1.
///
pieCoefficient-number default-0.8
///
///Controls the size of the second pie in pieOfPie series. Value ranges from 0 to 1.
///
pieOfPieCoefficient-number default-0.6
///
///Split Value of pieOfPie series.
///
splitValue-string default-null
///
///Distance between the two pie's in pieOfPie series.
///
gapWidth-number default-50
///
///Name of the property in the datasource that contains fill color for the series.
///
pointColorMappingName-string default-null
///
///Specifies the mode of the pyramid series.
///
pyramidMode-ej.datavisualization.Chart.PyramidMode|string default-linear. See PyramidMode
///
///Start angle from where the pie/doughnut series renders. By default it starts from 0.
///
startAngle-number default-null
///
///Options for customizing the corner radius. cornerRadius property also takes the numeric input and applies it for all the four corners of the column.
///
cornerRadius-any default-
///
///Specifies the radius for the top left corner.
///
topLeft-number default-0
///
///Specifies the radius for the top right corner.
///
topRight-number default-0
///
///Specifies the radius for the bottom left corner.
///
bottomLeft-number default-0
///
///Specifies the radius for the bottom right corner.
///
bottomRight-number default-0
///
///Options for customizing the tooltip of chart.
///
tooltip-any default-
///
///Options for customizing the border of the tooltip.
///
border-any default-
///
///Border color of the tooltip.
///
color-string default-null
///
///Border width of the tooltip.
///
width-number default-1
///
///Customize the corner radius of the tooltip rectangle.
///
rx-number default-0
///
///Customize the corner radius of the tooltip rectangle.
///
ry-number default-0
///
///Specifies the duration, the tooltip has to be displayed.
///
duration-string default-500ms
///
///Enables/disables the animation of the tooltip when moving from one point to other.
///
enableAnimation-boolean default-true
///
///Background color of the tooltip.
///
fill-string default-null
///
///Format of the tooltip content.
///
format-string default-#point.x# : #point.y#
///
///Opacity of the tooltip.
///
opacity-number default-0.5
///
///Custom template to format the tooltip content. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value.
///
template-string default-null
///
///Controls the visibility of the tooltip.
///
visible-boolean default-false
///
///Specifies the type of the series to render in chart.
///
type-ej.datavisualization.Chart.Type|string default-column. See Type
///
///Specifies the name of the x-axis that has to be associated with this series. Add an axis instance with this name to axes collection.
///
xAxisName-string default-null
///
///Name of the property in the datasource that contains x value for the series.
///
xName-string default-null
///
///Specifies the name of the y-axis that has to be associated with this series. Add an axis instance with this name to axes collection.
///
yAxisName-string default-null
///
///Name of the property in the datasource that contains y value for the series.
///
yName-string default-null
///
///Name of the property in the datasource that contains high value for the series.
///
high-string default-null
///
///Name of the property in the datasource that contains low value for the series.
///
low-string default-null
///
///Name of the property in the datasource that contains open value for the series.
///
open-string default-null
///
///Name of the property in the datasource that contains close value for the series.
///
close-string default-null
///
///Z-order of the series.
///
zOrder-number default-0
///
///Name of the property in the datasource that contains the size value for the bubble series.
///
size-string default-null
///
///Options for customizing the empty point in the series.
///
emptyPointSettings-any default-
///
///Controls the visibility of the empty point.
///
visible-boolean default-true
///
///Specifies the mode of empty point.
///
displayMode-ej.datavisualization.Chart.EmptyPointMode|string default-gap
///
///Options for customizing the color and border of the empty point in the series.
///
style-any default-
///
///Color of the empty point.
///
color-string default-
///
///Options for customizing border of the empty point in the series.
///
border-any default-
///
///Border color of the empty point.
///
color-string default-
///
///Border width of the empty point.
///
width-number default-1
///
///Fill color for the positive column of the waterfall.
///
positiveFill-string default-null
///
///Options for customizing the waterfall connector line.
///
connectorLine-any default-
///
///Width of the connector line.
///
width-number default-1
///
///Color of the connector line.
///
color-string default-#565656
///
///DashArray of the connector line.
///
dashArray-string default-null
///
///DashArray of the connector line.
///
opacity-number default-1
///
///Options to customize the drag and drop in series.
///
dragSettings-any default-
///
///drag/drop the series
///
enable-boolean default-false
///
///Specifies the type of drag settings.
///
type-string default-xy
///
///Options to customize the error bar in series.
///
errorBar-any default-
///
///Show/hides the error bar
///
visibility-boolean default-visible
///
///Specifies the type of error bar.
///
type-ej.datavisualization.Chart.ErrorBarType|string default-FixedValue
///
///Specifies the mode of error bar.
///
mode-ej.datavisualization.Chart.ErrorBarMode|string default-vertical
///
///Specifies the direction of error bar.
///
direction-ej.datavisualization.Chart.ErrorBarDirection|string default-both
///
///Value of vertical error bar.
///
verticalErrorValue-number default-3
///
///Value of horizontal error bar.
///
horizontalErrorValue-number default-1
///
///Value of positive horizontal error bar.
///
horizontalPositiveErrorValue-number default-1
///
///Value of negative horizontal error bar.
///
horizontalNegativeErrorValue-number default-1
///
///Value of positive vertical error bar.
///
verticalPositiveErrorValue-number default-5
///
///Value of negative vertical error bar.
///
verticalNegativeErrorValue-number default-5
///
///Fill color of the error bar.
///
fill-string default-#000000
///
///Width of the error bar.
///
width-number default-1
///
///Options for customizing the error bar cap.
///
cap-any default-
///
///Show/Hides the error bar cap.
///
visible-boolean default-true
///
///Width of the error bar cap.
///
width-number default-1
///
///Length of the error bar cap.
///
length-number default-1
///
///Color of the error bar cap.
///
fill-string default-“#000000â€
///
///Option to add the trendlines to chart.
///
trendlines-Array<any> default-
///
///Show/hides the trendline.
///
visibility-boolean default-
///
///Show/hides the trendline legend.
///
visibleOnLegend-string default-visible
///
///Specifies the type of the trendline for the series.
///
type-ej.datavisualization.Chart.TrendlinesType|string default-linear. See TrendlinesType
///
///Name for the trendlines that is to be displayed in the legend text.
///
name-string default-trendline
///
///Fill color of the trendlines.
///
fill-string default-#0000FF
///
///Width of the trendlines.
///
width-number default-1
///
///Opacity of the trendline.
///
opacity-number default-1
///
///Pattern of dashes and gaps used to stroke the trendline.
///
dashArray-string default-
///
///Future trends of the current series.
///
forwardForecast-number default-0
///
///Past trends of the current series.
///
backwardForecast-number default-0
///
///Specifies the order of the polynomial trendlines.
///
polynomialOrder-number default-0
///
///Specifies the moving average starting period value.
///
period-number default-2
///
///Options for customizing the tooltip of the trendlines in the chart.
///
tooltip-any default-
///
///Options for customizing the border of the trendline tooltip.
///
border-any default-
///
///Border color of the trendline tooltip.
///
color-string default-null
///
///Border width of the trendline tooltip.
///
width-number default-1
///
///Customize the corner radius of the trendline tooltip rectangle.
///
rx-number default-0
///
///Customize the corner radius of the trendline tooltip rectangle.
///
ry-number default-0
///
///Specifies the duration, the tooltip has to be displayed.
///
duration-string default-500ms
///
///Enables/disables the animation of the trendline tooltip when moving from one point to other.
///
enableAnimation-boolean default-true
///
///Background color of the trendline tooltip.
///
fill-string default-null
///
///Format of the tooltip content displayed in the trendlines.
///
format-string default-#point.x# : #point.y#
///
///Opacity of the trendline tooltip.
///
opacity-number default-0.5
///
///Specifies the intercept value of the trendlines.
///
intercept-number default-null
///
///Options for customizing the appearance of the series or data point while highlighting.
///
highlightSettings-any default-
///
///Enables/disables the ability to highlight the series or data point interactively.
///
enable-boolean default-false
///
///Specifies whether the series or data point has to be highlighted.
///
mode-ej.datavisualization.Chart.Mode|string default-series. See Mode
///
///Color of the series/point on highlight.
///
color-string default-
///
///Opacity of the series/point on highlight.
///
opacity-number default-0.6
///
///Options for customizing the border of series on highlight.
///
border-any default-
///
///Border color of the series/point on highlight.
///
color-string default-
///
///Border width of the series/point on highlight.
///
width-string default-2
///
///Specifies the pattern for the series/point on highlight.
///
pattern-string default-none. See Pattern
///
///Custom pattern for the series on highlight.
///
customPattern-string default-
///
///Options for customizing the appearance of the series/data point on selection.
///
selectionSettings-any default-
///
///Enables/disables the ability to select a series/data point interactively.
///
enable-boolean default-false
///
///Specifies the type of selection.
///
type-ej.datavisualization.Chart.SelectionType|string default-single
///
///Specifies whether the series or data point has to be selected.
///
mode-ej.datavisualization.Chart.Mode|string default-series. See Mode
///
///Specifies the drawn rectangle type.
///
rangeType-ej.datavisualization.Chart.RangeType|string default-xy
///
///Color of the series/point on selection.
///
color-string default-
///
///Opacity of the series/point on selection.
///
opacity-number default-0.6
///
///Options for customizing the border of the series on selection.
///
border-any default-
///
///Border color of the series/point on selection.
///
color-string default-
///
///Border width of the series/point on selection.
///
width-string default-2
///
///Specifies the pattern for the series/point on selection.
///
pattern-string default-none. See Pattern
///
///Custom pattern for the series on selection.
///
customPattern-string default-
///
///Options for displaying the chart along with selected points while loading
///
selectedDataPointIndexes-Array<any> default-[ ]
///
///Options for displaying and customizing the crosshair.
///
crosshair-Crosshair default-
///
///Options for customizing the trackball tooltip.
///
trackballTooltipSettings-any default-
///
///Options for customizing the trackball tooltip border.
///
border-any default-
///
///Border width of the trackball tooltip.
///
width-number default-null
///
///Border color of the trackball tooltip.
///
color-string default-null
///
///Background color of the trackball tooltip.
///
fill-string default-null
///
///Rounded corner x value of the trackball tooltip.
///
rx-number default-3
///
///Rounded corner y value of the trackball tooltip.
///
ry-number default-3
///
///Opacity value of the trackball tooltip.
///
opacity-number default-1
///
///Specifies the mode of the trackball tooltip.
///
mode-ej.datavisualization.Chart.CrosshairMode|string default-float. See CrosshairMode
///
///Options for customizing the marker in crosshair.
///
marker-any default-
///
///Options for customizing the border.
///
border-any default-
///
///Border width of the marker.
///
width-number default-3
///
///Opacity of the marker.
///
opacity-boolean default-true
///
///Options for customizing the size of the marker.
///
size-any default-
///
///Height of the marker.
///
height-number default-10
///
///Width of the marker.
///
width-number default-10
///
///Show/hides the marker.
///
visible-boolean default-true
///
///Options for customizing the crosshair line.
///
line-any default-
///
///Color of the crosshair line.
///
color-string default-transparent
///
///Width of the crosshair line.
///
width-number default-1
///
///Specifies the type of the crosshair. It can be trackball or crosshair
///
type-ej.datavisualization.Chart.CrosshairType|string default-crosshair. See CrosshairType
///
///Show/hides the crosshair/trackball visibility.
///
visible-boolean default-false
///
///Depth of the 3D Chart from front view of series to background wall. This property is applicable only for 3D view.
///
depth-number default-100
///
///Controls whether 3D view has to be enabled or not. 3D view is supported only for column, bar. Stacking column, stacking bar, pie and doughnut series types.
///
enable3D-boolean default-false
///
///Controls whether Chart has to be rendered as Canvas or SVG. Canvas rendering supports all functionalities in SVG rendering except 3D Charts.
///
enableCanvasRendering-boolean default-false
///
///Controls whether the series has to be rendered at initial loading of chart, this will be useful in scenarios where chart is placed at the bottom of the web page and we need to render the series only when the chart is visible while scrolling to the top.
///
initSeriesRender-boolean default-true
///
///Controls whether 3D view has to be rotated on dragging. This property is applicable only for 3D view.
///
enableRotation-boolean default-false
///
///Options to customize the technical indicators.
///
indicators-Array<Indicators> default-
///
///The dPeriod value for stochastic indicator.
///
dPeriod-number default-3
///
///Enables/disables the animation.
///
enableAnimation-boolean default-false
///
///Specifies animation duration for indicator rendering.
///
animationDuration-boolean default-null
///
///Color of the technical indicator.
///
fill-string default-#00008B
///
///Options to customize the histogram in MACD indicator.
///
histogram-any default-
///
///Options to customize the histogram border in MACD indicator.
///
border-any default-
///
///Color of the histogram border in MACD indicator.
///
color-string default-#9999ff
///
///Controls the width of histogram border line in MACD indicator.
///
width-number default-1
///
///Color of histogram columns in MACD indicator.
///
fill-string default-#ccccff
///
///Opacity of histogram columns in MACD indicator.
///
opacity-number default-1
///
///Specifies the k period in stochastic indicator.
///
kPeriod-number default-3
///
///Specifies the long period in MACD indicator.
///
longPeriod-number default-26
///
///Options to customize the lower line in indicators.
///
lowerLine-any default-
///
///Color of lower line.
///
fill-string default-#008000
///
///Width of the lower line.
///
width-number default-2
///
///Options to customize the MACD line.
///
macdLine-any default-
///
///Color of MACD line.
///
fill-string default-#ff9933
///
///Width of the MACD line.
///
width-number default-2
///
///Specifies the type of the MACD indicator.
///
macdType-string default-line. See MACDType
///
///Specifies period value in indicator.
///
period-number default-14
///
///Options to customize the period line in indicators.
///
periodLine-any default-
///
///Color of period line in indicator.
///
fill-string default-blue
///
///Width of the period line in indicators.
///
width-number default-2
///
///Name of the series for which indicator has to be drawn.
///
seriesName-string default-
///
///Specifies the short period in MACD indicator.
///
shortPeriod-number default-13
///
///Specifies the standard deviation value for Bollinger band indicator.
///
standardDeviations-number default-2
///
///Options to customize the tooltip.
///
tooltip-any default-
///
///Option to customize the border of indicator tooltip.
///
border-any default-
///
///Border color of indicator tooltip.
///
color-string default-null
///
///Border width of indicator tooltip.
///
width-number default-1
///
///Specifies the animation duration of indicator tooltip.
///
duration-string default-500ms
///
///Enables/disables the tooltip animation.
///
enableAnimation-boolean default-true
///
///Format of indicator tooltip. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value.
///
format-string default-#point.x# : #point.y#
///
///Background color of indicator tooltip.
///
fill-string default-null
///
///Opacity of indicator tooltip.
///
opacity-number default-0.95
///
///Controls the visibility of indicator tooltip.
///
visible-boolean default-false
///
///Trigger value of MACD indicator.
///
trigger-number default-9
///
///Specifies the visibility of indicator.
///
visibility-string default-visible
///
///Specifies the type of indicator that has to be rendered.
///
type-string default-sma. See IndicatorsType
///
///Options to customize the upper line in indicators
///
upperLine-any default-
///
///Fill color of the upper line in indicators
///
fill-string default-#ff9933
///
///Width of the upper line in indicators.
///
width-number default-2
///
///Width of the indicator line.
///
width-number default-2
///
///Name of the horizontal axis used for indicator. Primary X axis is used when x axis name is not specified.
///
xAxisName-string default-
///
///Name of the vertical axis used for indicator. Primary Y axis is used when y axis name is not specified
///
yAxisName-string default-
///
///Controls whether Chart has to be responsive while resizing.
///
isResponsive-boolean default-false
///
///Options to customize the legend items and legend title.
///
legend-Legend default-
///
///Horizontal alignment of the legend.
///
alignment-ej.datavisualization.Chart.Alignment|string default-Center. See Alignment
///
///Background for the legend. Use this property to add a background image or background color for the legend.
///
background-string default-
///
///Options for customizing the legend border.
///
border-any default-
///
///Border color of the legend.
///
color-string default-transparent
///
///Border width of the legend.
///
width-number default-1
///
///Number of columns to arrange the legend items.
///
columnCount-number default-null
///
///Controls whether legend has to use scrollbar or not. When enabled, scroll bar appears depending upon size and position properties of legend.
///
enableScrollbar-boolean default-true
///
///Fill color for the legend items. By using this property, it displays all legend item shapes in same color.Legend items representing invisible series is displayed in gray color.
///
fill-string default-null
///
///Options to customize the font used for legend item text.
///
font-any default-
///
///Font family for legend item text.
///
fontFamily-string default-Segoe UI
///
///Font style for legend item text.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-Normal. See FontStyle
///
///Font weight for legend item text.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-Regular. See FontWeight
///
///Font size for legend item text.
///
size-string default-12px
///
///Gap or padding between the legend items.
///
itemPadding-number default-10
///
///Options to customize the style of legend items.
///
itemStyle-any default-
///
///Options for customizing the border of legend items.
///
border-any default-
///
///Border color of the legend items.
///
color-string default-transparent
///
///Border width of the legend items.
///
width-number default-1
///
///Height of the shape in legend items.
///
height-number default-10
///
///Width of the shape in legend items.
///
width-number default-10
///
///Options to customize the location of chart legend. Legend is placed in provided location only when value of position property is custom
///
location-any default-
///
///X value or horizontal offset to position the legend in chart.
///
x-number default-0
///
///Y value or vertical offset to position the legend.
///
y-number default-0
///
///Opacity of the legend.
///
opacity-number default-1
///
///Places the legend at specified position. Legend can be placed at **left**, **right**, **top** or **bottom** of the chart area. To manually specify the location of legend, set **custom** as value to this property.
///
position-ej.datavisualization.Chart.Position|string default-Bottom. See Position
///
///Number of rows to arrange the legend items.
///
rowCount-number default-null
///
///Shape of the legend items. Default shape for pie and doughnut series is circle and all other series uses rectangle.
///
shape-ej.datavisualization.Chart.Shape|string default-None. See Shape
///
///Options to customize the size of the legend.
///
size-any default-
///
///Height of the legend. Height can be specified in either pixel or percentage.
///
height-string default-null
///
///Width of the legend. Width can be specified in either pixel or percentage.
///
width-string default-null
///
///Options to customize the legend title.
///
title-any default-
///
///Options to customize the font used for legend title
///
font-any default-
///
///Font family for the text in legend title.
///
fontFamily-string default-Segoe UI
///
///Font style for legend title.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-normal. See FontStyle
///
///Font weight for legend title.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-normal. See FontWeight
///
///Font size for legend title.
///
size-string default-12px
///
///Text to be displayed in legend title.
///
text-string default-
///
///Alignment of the legend title.
///
textAlignment-ej.datavisualization.Chart.Alignment|string default-center. See Alignment
///
///Specifies the action taken when the legend width is more than the textWidth.
///
textOverflow-ej.datavisualization.Chart.TextOverflow|string default-none. See textOverflow
///
///Text width for legend item.
///
textWidth-number default-34
///
///Controls the visibility of the legend.
///
visible-boolean default-true
///
///Controls the selection through the legend.
///
toggleSeriesVisibility-boolean default-true
///
///Name of the culture based on which chart should be localized. Number and date time values are localized with respect to the culture name.String type properties like title text are not localized automatically. Provide localized text as value to string type properties.
///
locale-string default-en-US
///
///Palette is used to store the series fill color in array and apply the color to series collection in the order of series index.
///
palette-Array<any> default-null
///
///Options to customize the left, right, top and bottom margins of chart area.
///
margin-Margin default-
///
///Spacing for the left margin of chart area. Setting positive value decreases the width of the chart area from left side.
///
left-number default-10
///
///Spacing for the right margin of chart area. Setting positive value decreases the width of the chart area from right side.
///
right-number default-10
///
///Spacing for the top margin of chart area. Setting positive value decreases the height of the chart area from the top.
///
top-number default-10
///
///Spacing for the bottom margin of the chart area. Setting positive value decreases the height of the chart area from the bottom.
///
bottom-number default-10
///
///Perspective angle of the 3D view. Chart appears closer when perspective angle is decreased, and distant when perspective angle is increased.This property is applicable only when 3D view is enabled
///
perspectiveAngle-number default-90
///
///This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the series’s xAxisName property to link both axis and series.
///
primaryXAxis-PrimaryXAxis default-
///
///Options for customizing horizontal axis alternate grid band.
///
alternateGridBand-any default-
///
///Options for customizing even grid band.
///
even-any default-
///
///Fill color for the even grid bands.
///
fill-string default-transparent
///
///Opacity of the even grid band.
///
opacity-number default-1
///
///Options for customizing odd grid band.
///
odd-any default-
///
///Fill color of the odd grid bands
///
fill-string default-transparent
///
///Opacity of odd grid band
///
opacity-number default-1
///
///Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side.
///
crossesAt-number default-null
///
///Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing
///
crossesInAxis-string default-null
///
///Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting ‘isIndexed’ property to true.
///
isIndexed-boolean default-false
///
///Specifies the interval of the axis according to the zoomed data of the chart.
///
enableAutoIntervalOnZooming-boolean default-true
///
///Options for customizing the axis line.
///
axisLine-any default-
///
///Pattern of dashes and gaps to be applied to the axis line.
///
dashArray-string default-null
///
///Padding for axis line. Normally, it is used along with plotOffset to pad the plot area.
///
offset-number default-null
///
///Show/hides the axis line.
///
visible-boolean default-true
///
///Default Value
///
color-string default-
///
///Width of axis line.
///
width-number default-1
///
///Specifies the index of the column where the axis is associated, when the chart area is divided into multiple plot areas by using columnDefinitions.
///
columnIndex-number default-null
///
///Specifies the number of columns or plot areas an axis has to span horizontally.
///
columnSpan-number default-null
///
///Options to customize the crosshair label.
///
crosshairLabel-any default-
///
///Show/hides the crosshair label associated with this axis.
///
visible-boolean default-false
///
///With this setting, you can request axis to calculate intervals approximately equal to your desired interval.
///
desiredIntervals-number default-null
///
///Specifies the placement of labels.
///
labelPlacement-ej.datavisualization.Chart.LabelPlacement|string default-ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement
///
///Specifies the position of labels at the edge of the axis.
///
edgeLabelPlacement-ej.datavisualization.Chart.EdgeLabelPlacement|string default-ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement
///
///Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth.
///
enableTrim-boolean default-false
///
///Options for customizing the font of the axis Labels.
///
font-any default-
///
///Font family of labels.
///
fontFamily-string default-Segoe UI
///
///Font style of labels.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-ej.datavisualization.Chart.FontStyle.Normal. See FontStyle
///
///Font weight of the label.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-ej.datavisualization.Chart.FontWeight.Regular. See FontWeight
///
///Opacity of the axis labels.
///
opacity-number default-1
///
///Font size of the axis labels.
///
size-string default-13px
///
///Specifies the type of interval in date time axis.
///
intervalType-ej.datavisualization.Chart.IntervalType|string default-null. See IntervalType
///
///Specifies whether to inverse the axis.
///
isInversed-boolean default-false
///
///Custom formatting for axis label and supports all standard formatting type of numerical and date time values.
///
labelFormat-string default-null
///
///Specifies the action to take when the axis labels are overlapping with each other.
///
labelIntersectAction-ej.datavisualization.Chart.LabelIntersectAction|string default-ej.datavisualization.Chart.LabelIntersectAction.None. See LabelIntersectAction
///
///Specifies the position of the axis labels.
///
labelPosition-ej.datavisualization.Chart.LabelPosition|string default-outside. See LabelPosition
///
///Specifies the position of the axis labels.
///
alignment-ej.datavisualization.Chart.LabelAlignment|string default-center. See Alignment
///
///Angle in degrees to rotate the axis labels.
///
labelRotation-number default-null
///
///Logarithmic base value. This is applicable only for logarithmic axis.
///
logBase-number default-10
///
///Options for customizing major gird lines.
///
majorGridLines-any default-
///
///Pattern of dashes and gaps used to stroke the major grid lines.
///
dashArray-string default-null
///
///Color of the major grid line.
///
color-string default-null
///
///Opacity of major grid lines.
///
opacity-number default-1
///
///Show/hides the major grid lines.
///
visible-boolean default-true
///
///Width of the major grid lines.
///
width-number default-1
///
///Options for customizing the major tick lines.
///
majorTickLines-any default-
///
///Length of the major tick lines.
///
size-number default-5
///
///Show/hides the major tick lines.
///
visible-boolean default-true
///
///Width of the major tick lines.
///
width-number default-1
///
///Maximum number of labels to be displayed in every 100 pixels.
///
maximumLabels-number default-3
///
///Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true.
///
maximumLabelWidth-number default-34
///
///Options for customizing the minor grid lines.
///
minorGridLines-any default-
///
///Patterns of dashes and gaps used to stroke the minor grid lines.
///
dashArray-string default-null
///
///Show/hides the minor grid lines.
///
visible-boolean default-true
///
///Width of the minorGridLines.
///
width-number default-1
///
///Options for customizing the minor tick lines.
///
minorTickLines-any default-
///
///Length of the minor tick lines.
///
size-number default-5
///
///Show/hides the minor tick lines.
///
visible-boolean default-true
///
///Width of the minor tick line.
///
width-number default-1
///
///Specifies the number of minor ticks per interval.
///
minorTicksPerInterval-number default-null
///
///Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series.
///
name-string default-null
///
///Specifies whether to render the axis at the opposite side of its default position.
///
opposedPosition-boolean default-false
///
///Specifies the orientation of the axis line
///
orientation-ej.datavisualization.Chart.AxisOrientation|string default-Horizontal
///
///Specifies the padding for the plot area.
///
plotOffset-number default-10
///
///Options to customize the range of the axis.
///
range-any default-
///
///Minimum value of the axis range.
///
min-number default-null
///
///Maximum value of the axis range.
///
max-number default-null
///
///Interval of the axis range.
///
interval-number default-null
///
///Specifies the padding for the axis range.
///
rangePadding-ej.datavisualization.Chart.RangePadding|string default-None. See RangePadding
///
///Rounds the number to the given number of decimals.
///
roundingPlaces-number default-null
///
///Options for customizing the multi level labels.
///
multiLevelLabels-Array<any> default-[ ]
///
///Visibility of the multi level labels.
///
visible-boolean default-false
///
///Text of the multi level labels.
///
text-string default-
///
///Starting value of the multi level labels.
///
start-any default-null
///
///Ending value of the multi level labels.
///
end-any default-null
///
///Specifies the level of multi level labels.
///
level-number default-0
///
///Specifies the maximum width of the text in multi level labels.
///
maximumTextWidth-number default-null
///
///Specifies the alignment of the text in multi level labels.
///
textAlignment-ej.datavisualization.Chart.TextAlignment|string default-center. See TextAlignment
///
///Specifies the handling of text over flow in multi level labels.
///
textOverflow-ej.datavisualization.Chart.TextOverflow|string default-center. See TextOverflow
///
///Options for customizing the font of the text.
///
font-any default-
///
///Font color of the multi level labels text.
///
color-string default-null
///
///Font family of the multi level labels text.
///
fontFamily-string default-Segoe UI
///
///Font style of the multi level labels text.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-Normal
///
///Font weight of the multi level label text.
///
fontWeight-string default-regular
///
///Opacity of the multi level label text.
///
opacity-number default-1
///
///Font size of the multi level label text.
///
size-string default-12px
///
///Options for customizing the border of the series.
///
border-any default-
///
///Border color of the multi level labels.
///
color-string default-null
///
///Border width of the multi level labels.
///
width-number default-1
///
///Border type of the multi level labels.
///
type-ej.datavisualization.Chart.MultiLevelLabelsBorderType|string default-rectangle. See Type
///
///Specifies whether the axis elements need to be placed nearby the axis line, while crossing.
///
showNextToAxisLine-boolean default-true
///
///Options for customizing the strip lines.
///
stripLine-Array<any> default-[ ]
///
///Border color of the strip line.
///
borderColor-string default-gray
///
///Background color of the strip line.
///
color-string default-gray
///
///End value of the strip line.
///
end-number default-null
///
///Options for customizing the font of the text.
///
font-any default-
///
///Font color of the strip line text.
///
color-string default-black
///
///Font family of the strip line text.
///
fontFamily-string default-Segoe UI
///
///Font style of the strip line text.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-Normal
///
///Font weight of the strip line text.
///
fontWeight-string default-regular
///
///Opacity of the strip line text.
///
opacity-number default-1
///
///Font size of the strip line text.
///
size-string default-12px
///
///Start value of the strip line.
///
start-number default-null
///
///Indicates whether to render the strip line from the minimum/start value of the axis. This property does not work when start property is set.
///
startFromAxis-boolean default-false
///
///Specifies text to be displayed inside the strip line.
///
text-string default-stripLine
///
///Specifies the alignment of the text inside the strip line.
///
textAlignment-ej.datavisualization.Chart.TextAlignment|string default-middlecenter. See TextAlignment
///
///Show/hides the strip line.
///
visible-boolean default-false
///
///Width of the strip line.
///
width-number default-0
///
///Specifies the order where the strip line and the series have to be rendered. When Z-order is “behindâ€, strip line is rendered under the series and when it is “overâ€, it is rendered above the series.
///
zIndex-ej.datavisualization.Chart.ZIndex|string default-over. See ZIndex
///
///Specifies the position of the axis tick lines.
///
tickLinesPosition-ej.datavisualization.Chart.TickLinesPosition|string default-outside. See TickLinesPosition
///
///Options for customizing the border of the labels.
///
labelBorder-any default-
///
///Specifies the color of the label border.
///
color-string default-null
///
///Specifies the width of the label border.
///
width-number default-1
///
///Options for customizing the axis title.
///
title-any default-
///
///Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title.
///
enableTrim-boolean default-false
///
///Options for customizing the title font.
///
font-any default-
///
///Font family of the title text.
///
fontFamily-string default-Segoe UI
///
///Font style of the title text.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-ej.datavisualization.Chart.FontStyle.Normal
///
///Font weight of the title text.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-ej.datavisualization.Chart.FontWeight.Regular. See FontWeight
///
///Opacity of the axis title text.
///
opacity-number default-1
///
///Font size of the axis title.
///
size-string default-16px
///
///Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true.
///
maximumTitleWidth-number default-34
///
///Title for the axis.
///
text-string default-
///
///Controls the visibility of axis title.
///
visible-boolean default-true
///
///offset value for axis title.
///
offset-number default-0
///
///Specifies the position of the axis title.
///
position-ej.datavisualization.Chart.LabelPosition|string default-outside. See Position
///
///Specifies the position of the axis title.
///
alignment-ej.datavisualization.Chart.TextAlignment|string default-center. See Alignment
///
///Specifies the type of data the axis is handling.
///
valueType-ej.datavisualization.Chart.ValueType|string default-null. See ValueType
///
///Show/hides the axis.
///
visible-boolean default-true
///
///The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Value ranges from 0 to 1.
///
zoomFactor-number default-1
///
///Position of the zoomed axis. Value ranges from 0 to 1.
///
zoomPosition-number default-0
///
///Options for customizing the axis scrollbar
///
scrollbarSettings-any default-
///
///Specifies to enables or disables the scroll bar.
///
visible-boolean default-false
///
///Controls whether scrollbar has to be responsive in the chart.
///
canResize-boolean default-false
///
///Options to customize the range for the scrollbar in the axis.
///
range-any default-
///
///Minimum value of the scrollbar range.
///
min-number default-null
///
///Maximum value for the scrollbar range .
///
max-number default-null
///
///The maximum number of points to be displayed in the scrollbar.
///
pointsLength-number default-null
///
///To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the series’s xAxisName property to link both axis and series.
///
axes-Array<Axes> default-
///
///Options for customizing axis alternate grid band.
///
alternateGridBand-any default-
///
///Options for customizing even grid band.
///
even-any default-
///
///Fill color for the even grid bands.
///
fill-string default-transparent
///
///Opacity of the even grid band.
///
opacity-number default-1
///
///Options for customizing odd grid band.
///
odd-any default-
///
///Fill color of the odd grid bands
///
fill-string default-transparent
///
///Opacity of odd grid band
///
opacity-number default-1
///
///Specifies where axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side.
///
crossesAt-number default-null
///
///Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting ‘isIndexed’ property to true.
///
isIndexed-boolean default-false
///
///Options for customizing the axis line.
///
axisLine-any default-
///
///Pattern of dashes and gaps to be applied to the axis line.
///
dashArray-string default-null
///
///Padding for axis line. Normally, it is used along with plotOffset to pad the plot area.
///
offset-number default-null
///
///Show/hides the axis line.
///
visible-boolean default-true
///
///Color of axis line.
///
color-string default-
///
///Width of axis line.
///
width-number default-1
///
///Specifies the index of the column where the axis is associated, when the chart area is divided into multiple plot areas by using columnDefinitions.
///
columnIndex-number default-null
///
///Specifies the number of columns or plot areas an axis has to span horizontally.
///
columnSpan-number default-null
///
///Options to customize the crosshair label.
///
crosshairLabel-any default-
///
///Show/hides the crosshair label associated with this axis.
///
visible-boolean default-false
///
///With this setting, you can request axis to calculate intervals approximately equal to your desired interval.
///
desiredIntervals-number default-null
///
///Specifies the placement of labels.
///
labelPlacement-ej.datavisualization.Chart.LabelPlacement|string default-ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement
///
///Specifies the position of labels at the edge of the axis.
///
edgeLabelPlacement-ej.datavisualization.Chart.EdgeLabelPlacement|string default-ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement
///
///Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth.
///
enableTrim-boolean default-false
///
///Specifies the interval of the axis according to the zoomed data of the chart.
///
enableAutoIntervalOnZooming-boolean default-true
///
///Options for customizing the font of the axis Labels.
///
font-any default-
///
///Font family of labels.
///
fontFamily-string default-Segoe UI
///
///Font style of labels.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-ej.datavisualization.Chart.FontStyle.Normal. See FontStyle
///
///Font weight of the label.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-ej.datavisualization.Chart.FontWeight.Regular. See FontWeight
///
///Opacity of the axis labels.
///
opacity-number default-1
///
///Font size of the axis labels.
///
size-string default-13px
///
///Specifies the type of interval in date time axis.
///
intervalType-ej.datavisualization.Chart.IntervalType|string default-null. See IntervalType
///
///Specifies whether to inverse the axis.
///
isInversed-boolean default-false
///
///Custom formatting for axis label and supports all standard formatting type of numerical and date time values.
///
labelFormat-string default-null
///
///Specifies the action to take when the axis labels are overlapping with each other.
///
labelIntersectAction-ej.datavisualization.Chart.LabelIntersectAction|string default-ej.datavisualization.Chart.LabelIntersectAction.None. See LabelIntersectAction
///
///Specifies the position of the axis labels.
///
labelPosition-ej.datavisualization.Chart.LabelPosition|string default-outside. See LabelPosition
///
///Specifies the position of the axis labels.
///
alignment-ej.datavisualization.Chart.LabelAlignment|string default-center. See Alignment
///
///Angle in degrees to rotate the axis labels.
///
labelRotation-number default-null
///
///Logarithmic base value. This is applicable only for logarithmic axis.
///
logBase-number default-10
///
///Options for customizing major gird lines.
///
majorGridLines-any default-
///
///Pattern of dashes and gaps used to stroke the major grid lines.
///
dashArray-string default-null
///
///Color of the major grid line.
///
color-string default-null
///
///Opacity of major grid lines.
///
opacity-number default-1
///
///Show/hides the major grid lines.
///
visible-boolean default-true
///
///Width of the major grid lines.
///
width-number default-1
///
///Options for customizing the major tick lines.
///
majorTickLines-any default-
///
///Length of the major tick lines.
///
size-number default-5
///
///Show/hides the major tick lines.
///
visible-boolean default-true
///
///Width of the major tick lines.
///
width-number default-1
///
///Maximum number of labels to be displayed in every 100 pixels.
///
maximumLabels-number default-3
///
///Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true.
///
maximumLabelWidth-number default-34
///
///Options for customizing the minor grid lines.
///
minorGridLines-any default-
///
///Patterns of dashes and gaps used to stroke the minor grid lines.
///
dashArray-string default-null
///
///Show/hides the minor grid lines.
///
visible-boolean default-true
///
///Width of the minorGridLines.
///
width-number default-1
///
///Options for customizing the minor tick lines.
///
minorTickLines-any default-
///
///Length of the minor tick lines.
///
size-number default-5
///
///Show/hides the minor tick lines.
///
visible-boolean default-true
///
///Width of the minor tick line.
///
width-number default-1
///
///Specifies the number of minor ticks per interval.
///
minorTicksPerInterval-number default-null
///
///Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series.
///
name-string default-null
///
///Specifies whether to render the axis at the opposite side of its default position.
///
opposedPosition-boolean default-false
///
///Specifies the orientation of the axis line in the chart.
///
orientation-ej.datavisualization.Chart.AxisOrientation|string default-'horizontal'
///
///Specifies the padding for the plot area.
///
plotOffset-number default-10
///
///Options to customize the range of the axis.
///
range-any default-
///
///Minimum value of the axis range.
///
min-number default-null
///
///Maximum value of the axis range.
///
max-number default-null
///
///Interval of the axis range.
///
interval-number default-null
///
///Specifies the padding for the axis range.
///
rangePadding-ej.datavisualization.Chart.RangePadding|string default-None. See RangePadding
///
///Rounds the number to the given number of decimals.
///
roundingPlaces-number default-null
///
///Options for customizing the multi level labels.
///
multiLevelLabels-Array<any> default-[ ]
///
///Visibility of the multi level labels.
///
visible-boolean default-false
///
///Text of the multi level labels.
///
text-string default-
///
///Starting value of the multi level labels.
///
start-any default-null
///
///Ending value of the multi level labels.
///
end-any default-null
///
///Specifies the level of multi level labels.
///
level-number default-0
///
///Specifies the maximum width of the text in multi level labels.
///
maximumTextWidth-number default-null
///
///Specifies the alignment of the text in multi level labels.
///
textAlignment-ej.datavisualization.Chart.TextAlignment|string default-center. See TextAlignment
///
///Specifies the handling of text over flow in multi level labels.
///
textOverflow-ej.datavisualization.Chart.TextOverflow|string default-center. See TextOverflow
///
///Options for customizing the font of the text.
///
font-any default-
///
///Font color of the multi level labels text.
///
color-string default-null
///
///Font family of the multi level labels text.
///
fontFamily-string default-Segoe UI
///
///Font style of the multi level labels text.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-Normal
///
///Font weight of the multi level label text.
///
fontWeight-string default-regular
///
///Opacity of the multi level label text.
///
opacity-number default-1
///
///Font size of the multi level label text.
///
size-string default-12px
///
///Options for customizing the border of the series.
///
border-any default-
///
///Border color of the multi level labels.
///
color-string default-null
///
///Border width of the multi level labels.
///
width-number default-1
///
///Border type of the multi level labels.
///
type-ej.datavisualization.Chart.MultiLevelLabelsBorderType|string default-rectangle. See Type
///
///Specifies whether the axis elements need to be placed nearby the axis line, while crossing.
///
showNextToAxisLine-boolean default-true
///
///Options for customizing the strip lines.
///
stripLine-Array<any> default-[ ]
///
///Border color of the strip line.
///
borderColor-string default-gray
///
///Background color of the strip line.
///
color-string default-gray
///
///End value of the strip line.
///
end-number default-null
///
///Options for customizing the font of the text.
///
font-any default-
///
///Font color of the strip line text.
///
color-string default-black
///
///Font family of the strip line text.
///
fontFamily-string default-Segoe UI
///
///Font style of the strip line text.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-Normal
///
///Font weight of the strip line text.
///
fontWeight-string default-regular
///
///Opacity of the strip line text.
///
opacity-number default-1
///
///Font size of the strip line text.
///
size-string default-12px
///
///Start value of the strip line.
///
start-number default-null
///
///Indicates whether to render the strip line from the minimum/start value of the axis. This property does not work when start property is set.
///
startFromAxis-boolean default-false
///
///Specifies text to be displayed inside the strip line.
///
text-string default-stripLine
///
///Specifies the alignment of the text inside the strip line.
///
textAlignment-ej.datavisualization.Chart.TextAlignment|string default-middlecenter. See TextAlignment
///
///Show/hides the strip line.
///
visible-boolean default-false
///
///Width of the strip line.
///
width-number default-0
///
///Specifies the order where the strip line and the series have to be rendered. When Z-order is “behindâ€, strip line is rendered under the series and when it is “overâ€, it is rendered above the series.
///
zIndex-ej.datavisualization.Chart.ZIndex|string default-over. See ZIndex
///
///Specifies the position of the axis tick lines.
///
tickLinesPosition-ej.datavisualization.Chart.TickLinesPosition|string default-outside. See TickLinesPosition
///
///Options for customizing the border of the labels.
///
labelBorder-any default-
///
///Specifies the color of the label border.
///
color-string default-null
///
///Specifies the width of the label border.
///
width-number default-1
///
///Options for customizing the axis title.
///
title-any default-
///
///Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title.
///
enableTrim-boolean default-false
///
///Options for customizing the title font.
///
font-any default-
///
///Font family of the title text.
///
fontFamily-string default-Segoe UI
///
///Font style of the title text.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-ej.datavisualization.Chart.FontStyle.Normal
///
///Font weight of the title text.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-ej.datavisualization.Chart.FontWeight.Regular. See FontWeight
///
///Opacity of the axis title text.
///
opacity-number default-1
///
///Font size of the axis title.
///
size-string default-16px
///
///Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true.
///
maximumTitleWidth-number default-34
///
///Title for the axis.
///
text-string default-
///
///Controls the visibility of axis title.
///
visible-boolean default-true
///
///offset value for axis title.
///
offset-number default-0
///
///Specifies the position of the axis title.
///
position-ej.datavisualization.Chart.LabelPosition|string default-outside. See Position
///
///Specifies the position of the axis title.
///
alignment-ej.datavisualization.Chart.TextAlignment|string default-center. See Alignment
///
///Specifies the type of data the axis is handling.
///
valueType-ej.datavisualization.Chart.ValueType|string default-null. See ValueType
///
///Show/hides the axis.
///
visible-boolean default-true
///
///The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Value ranges from 0 to 1.
///
zoomFactor-number default-1
///
///Position of the zoomed axis. Value ranges from 0 to 1.
///
zoomPosition-number default-0
///
///Options for customizing the axis scrollbar.
///
scrollbarSettings-any default-
///
///Specifies to enable or disable the scrollbar.
///
visible-boolean default-false
///
///Controls whether scrollbar has to be responsive in the chart.
///
canResize-boolean default-false
///
///Options to customize the range for the scrollbar in the axis.
///
range-any default-
///
///Minimum value of the scrollbar range.
///
min-number default-null
///
///Maximum value for the scrollbar range .
///
max-number default-null
///
///The maximum number of points to be displayed in the scrollbar.
///
pointsLength-number default-null
///
///This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the series’s yAxisName property to link both axis and series.
///
primaryYAxis-PrimaryYAxis default-
///
///Options for customizing vertical axis alternate grid band.
///
alternateGridBand-any default-
///
///Options for customizing even grid band.
///
even-any default-
///
///Fill color for the even grid bands.
///
fill-string default-transparent
///
///Opacity of the even grid band.
///
opacity-number default-1
///
///Options for customizing odd grid band.
///
odd-any default-
///
///Fill color of the odd grid bands.
///
fill-string default-transparent
///
///Opacity of odd grid band.
///
opacity-number default-1
///
///Specifies the interval of the axis according to the zoomed data of the chart.
///
enableAutoIntervalOnZooming-boolean default-true
///
///Options for customizing the axis line.
///
axisLine-any default-
///
///Pattern of dashes and gaps to be applied to the axis line.
///
dashArray-string default-null
///
///Padding for axis line. Normally, it is used along with plotOffset to pad the plot area.
///
offset-number default-null
///
///Show/hides the axis line.
///
visible-boolean default-true
///
///Color of axis line.
///
color-string default-
///
///Width of axis line.
///
width-number default-1
///
///Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side.
///
crossesAt-number default-null
///
///Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing
///
crossesInAxis-string default-null
///
///Options to customize the crosshair label.
///
crosshairLabel-any default-
///
///Show/hides the crosshair label associated with this axis.
///
visible-boolean default-false
///
///With this setting, you can request axis to calculate intervals approximately equal to your desired interval.
///
desiredIntervals-number default-null
///
///Specifies the placement of labels.
///
labelPlacement-ej.datavisualization.Chart.LabelPlacement|string default-ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement
///
///Specifies the position of labels at the edge of the axis.
///
edgeLabelPlacement-ej.datavisualization.Chart.EdgeLabelPlacement|string default-ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement
///
///Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth.
///
enableTrim-boolean default-false
///
///Options for customizing the font of the axis Labels.
///
font-any default-
///
///Font family of labels.
///
fontFamily-string default-Segoe UI
///
///Font style of labels.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-ej.datavisualization.Chart.FontStyle.Normal. See FontStyle
///
///Font weight of the label.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-ej.datavisualization.Chart.FontWeight.Regular. See FontWeight
///
///Opacity of the axis labels.
///
opacity-number default-1
///
///Font size of the axis labels.
///
size-string default-13px
///
///Specifies the type of interval in date time axis.
///
intervalType-ej.datavisualization.Chart.IntervalType|string default-null. See IntervalType
///
///Specifies whether to inverse the axis.
///
isInversed-boolean default-false
///
///Custom formatting for axis label and supports all standard formatting type of numerical and date time values.
///
labelFormat-string default-null
///
///Specifies the action to take when the axis labels are overlapping with each other.
///
labelIntersectAction-ej.datavisualization.Chart.LabelIntersectAction|string default-ej.datavisualization.Chart.LabelIntersectAction.None
///
///Specifies the position of the axis labels.
///
labelPosition-ej.datavisualization.Chart.LabelPosition|string default-outside. See LabelPosition
///
///Specifies the position of the axis labels.
///
alignment-ej.datavisualization.Chart.LabelAlignment|string default-center. See Alignment
///
///Logarithmic base value. This is applicable only for logarithmic axis.
///
logBase-number default-10
///
///Options for customizing major gird lines.
///
majorGridLines-any default-
///
///Pattern of dashes and gaps used to stroke the major grid lines.
///
dashArray-string default-null
///
///Color of the major grid lines.
///
color-string default-null
///
///Opacity of major grid lines.
///
opacity-number default-1
///
///Show/hides the major grid lines.
///
visible-boolean default-true
///
///Width of the major grid lines.
///
width-number default-1
///
///Options for customizing the major tick lines.
///
majorTickLines-any default-
///
///Length of the major tick lines.
///
size-number default-5
///
///Show/hides the major tick lines.
///
visible-boolean default-true
///
///Width of the major tick lines.
///
width-number default-1
///
///Maximum number of labels to be displayed in every 100 pixels.
///
maximumLabels-number default-3
///
///Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true.
///
maximumLabelWidth-number default-ej.datavisualization.Chart.maximumLabelWidth type {int}
///
///Options for customizing the minor grid lines.
///
minorGridLines-any default-
///
///Patterns of dashes and gaps used to stroke the minor grid lines.
///
dashArray-string default-null
///
///Show/hides the minor grid lines.
///
visible-boolean default-true
///
///Width of the minorGridLines.
///
width-number default-1
///
///Options for customizing the minor tick lines.
///
minorTickLines-any default-
///
///Length of the minor tick lines.
///
size-number default-5
///
///Show/hides the minor tick lines.
///
visible-boolean default-true
///
///Width of the minor tick line
///
width-number default-1
///
///Specifies the number of minor ticks per interval.
///
minorTicksPerInterval-number default-null
///
///Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series.
///
name-string default-null
///
///Specifies whether to render the axis at the opposite side of its default position.
///
opposedPosition-boolean default-false
///
///Specifies the orientation of the axis line in the chart.
///
orientation-ej.datavisualization.Chart.AxisOrientation|string default-Vertical
///
///Specifies the padding for the plot area.
///
plotOffset-number default-10
///
///Options to customize the range of the axis.
///
range-any default-
///
///Minimum value of the axis range.
///
min-number default-null
///
///Maximum value of the axis range.
///
max-number default-null
///
///Interval for the range.
///
interval-number default-null
///
///Specifies the padding for the axis range.
///
rangePadding-ej.datavisualization.Chart.RangePadding|string default-ej.datavisualization.Chart.RangePadding.None. See RangePadding
///
///Rounds the number to the given number of decimals.
///
roundingPlaces-number default-null
///
///Specifies the index of the row to which the axis is associated, when the chart area is divided into multiple plot areas by using rowDefinitions.
///
rowIndex-number default-null
///
///Specifies the number of row or plot areas an axis has to span vertically.
///
rowSpan-number default-null
///
///Options for customizing the multi level labels.
///
multiLevelLabels-Array<any> default-[ ]
///
///Visibility of the multi level labels.
///
visible-boolean default-false
///
///Text of the multi level labels.
///
text-string default-
///
///Starting value of the multi level labels.
///
start-number default-null
///
///Ending value of the multi level labels.
///
end-number default-null
///
///Specifies the level of multi level labels.
///
level-number default-0
///
///Specifies the maximum width of the text in multi level labels.
///
maximumTextWidth-number default-null
///
///Specifies the alignment of the text in multi level labels.
///
textAlignment-ej.datavisualization.Chart.TextAlignment|string default-center. See TextAlignment
///
///Specifies the handling of text over flow in multi level labels.
///
textOverflow-ej.datavisualization.Chart.TextOverflow|string default-center. See TextOverflow
///
///Options for customizing the font of the text.
///
font-any default-
///
///Font color of the multi level labels text.
///
color-string default-null
///
///Font family of the multi level labels text.
///
fontFamily-string default-Segoe UI
///
///Font style of the multi level labels text.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-Normal
///
///Font weight of the multi level label text.
///
fontWeight-string default-regular
///
///Opacity of the multi level label text.
///
opacity-number default-1
///
///Font size of the multi level label text.
///
size-string default-12px
///
///Options for customizing the border of the series.
///
border-any default-
///
///Border color of the multi level labels.
///
color-string default-null
///
///Border width of the multi level labels.
///
width-number default-1
///
///Border type of the multi level labels.
///
type-ej.datavisualization.Chart.MultiLevelLabelsBorderType|string default-rectangle. See Type
///
///Specifies whether the axis elements need to be placed nearby the axis line, while crossing.
///
showNextToAxisLine-boolean default-true
///
///Options for customizing the axis scrollbar.
///
scrollbarSettings-any default-
///
///Specifies to enable or disable the scrollbar.
///
visible-boolean default-false
///
///Controls whether scrollbar has to be responsive in the chart.
///
canResize-boolean default-false
///
///Options to customize the range for the scrollbar in the axis.
///
range-any default-
///
///Minimum value of the scrollbar range.
///
min-number default-null
///
///Maximum value for the scrollbar range .
///
max-number default-null
///
///The maximum number of points to be displayed in the scrollbar.
///
pointsLength-number default-null
///
///Options for customizing the strip lines.
///
stripLine-Array<any> default-[ ]
///
///Border color of the strip line.
///
borderColor-string default-gray
///
///Background color of the strip line.
///
color-string default-gray
///
///End value of the strip line.
///
end-number default-null
///
///Options for customizing the font of the text.
///
font-any default-
///
///Font color of the strip line text.
///
color-string default-black
///
///Font family of the strip line text.
///
fontFamily-string default-Segoe UI
///
///Font style of the strip line text.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-Normal
///
///Font weight of the strip line text.
///
fontWeight-string default-regular
///
///Opacity of the strip line text.
///
opacity-number default-1
///
///Font size of the strip line text.
///
size-string default-12px
///
///Start value of the strip line.
///
start-number default-null
///
///Indicates whether to render the strip line from the minimum/start value of the axis. This property won’t work when start property is set.
///
startFromAxis-boolean default-false
///
///Specifies text to be displayed inside the strip line.
///
text-string default-stripLine
///
///Specifies the alignment of the text inside the strip line.
///
textAlignment-ej.datavisualization.Chart.TextAlignment|string default-middlecenter. See TextAlignment
///
///Show/hides the strip line.
///
visible-boolean default-false
///
///Width of the strip line.
///
width-number default-0
///
///Specifies the order in which strip line and the series have to be rendered. When Z-order is “behindâ€, strip line is rendered below the series and when it is “overâ€, it is rendered above the series.
///
zIndex-ej.datavisualization.Chart.ZIndex|string default-over. See ZIndex
///
///Specifies the position of the axis tick lines.
///
tickLinesPosition-ej.datavisualization.Chart.TickLinesPosition|string default-outside. See TickLinesPosition
///
///Options for customizing the border of the labels.
///
labelBorder-any default-
///
///Specifies the color of the label border.
///
color-string default-null
///
///Specifies the width of the label border.
///
width-number default-1
///
///Options for customizing the axis title.
///
title-any default-
///
///Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title.
///
enableTrim-boolean default-ej.datavisualization.Chart.enableTrim
///
///Options for customizing the title font.
///
font-any default-
///
///Font family of the title text.
///
fontFamily-string default-Segoe UI
///
///Font style of the title text.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-ej.datavisualization.Chart.FontStyle.Normal
///
///Font weight of the title text.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-ej.datavisualization.Chart.FontWeight.Regular. See FontWeight
///
///Opacity of the axis title text.
///
opacity-number default-1
///
///Font size of the axis title.
///
size-string default-16px
///
///Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true.
///
maximumTitleWidth-number default-ej.datavisualization.Chart.maximumTitleWidth.null
///
///Title for the axis.
///
text-string default-
///
///Controls the visibility of axis title.
///
visible-boolean default-true
///
///offset value for axis title.
///
offset-number default-0
///
///Specifies the position of the axis title.
///
position-ej.datavisualization.Chart.LabelPosition|string default-outside. See Position
///
///Specifies the position of the axis title.
///
alignment-ej.datavisualization.Chart.TextAlignment|string default-center. See Alignment
///
///Specifies the type of data the axis is handling.
///
valueType-ej.datavisualization.Chart.ValueType|string default-null. See ValueType
///
///Show/hides the axis.
///
visible-boolean default-true
///
///The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Values ranges from 0 to 1.
///
zoomFactor-number default-1
///
///Position of the zoomed axis. Value ranges from 0 to 1
///
zoomPosition-number default-0
///
///Rotation angle of the 3D view. This property is applicable only when 3D view is enabled.
///
rotation-number default-0
///
///Options to split Chart into multiple plotting areas horizontally. Each object in the collection represents a plotting area in Chart.
///
rowDefinitions-Array<RowDefinitions> default-
///
///Specifies the unit to measure the height of the row in plotting area.
///
unit-ej.datavisualization.Chart.Unit|string default-'pixel'. See Unit
///
///Height of the row in plotting area. Height is measured in either pixel or percentage based on the value of unit property.
///
rowHeight-number default-50
///
///Color of the line that indicates the starting point of the row in plotting area.
///
lineColor-string default-transparent
///
///Width of the line that indicates the starting point of the row in plot area.
///
lineWidth-number default-1
///
///Specifies the properties used for customizing the series.
///
series-Array<Series> default-
///
///Color of the point, where the close is up in financial chart.
///
bearFillColor-string default-null
///
///Options for customizing the border of the series.
///
border-any default-
///
///Border color of the series.
///
color-string default-transparent
///
///Border width of the series.
///
width-number default-1
///
///DashArray for border of the series.
///
dashArray-string default-null
///
///Specifies animation duration for series rendering.
///
animationDuration-string default-null
///
///Color of the point, where the close is down in financial chart.
///
bullFillColor-string default-null
///
///To render the column and bar type series in rectangle/cylinder shape. See ColumnFacet
///
columnFacet-ej.datavisualization.Chart.ColumnFacet|string default-rectangle
///
///Relative width of the columns in column type series. Value ranges from 0 to 1. Width also depends upon columnSpacing property.
///
columnWidth-number default-0.7
///
///Spacing between columns of different series. Value ranges from 0 to 1
///
columnSpacing-number default-0
///
///To group the series of stacking collection.
///
stackingGroup-string default-
///
///Pattern of dashes and gaps used to stroke the line type series.
///
dashArray-string default-
///
///Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager.
///
dataSource-any default-null
///
///Specifies spline tension values for cardinal spline type.Value ranges from 0 to 1.
///
cardinalSplineTension-number default-0.5
///
///Controls the size of the hole in doughnut series. Value ranges from 0 to 1.
///
doughnutCoefficient-number default-0.4
///
///Controls the size of the doughnut series. Value ranges from 0 to 1.
///
doughnutSize-number default-0.8
///
///Type of series to be drawn in radar or polar series.
///
drawType-ej.datavisualization.Chart.DrawType|string default-line. See DrawType
///
///Enable/disable the animation of series.
///
enableAnimation-boolean default-false
///
///To avoid overlapping of data labels smartly.
///
enableSmartLabels-number default-null
///
///End angle of pie/doughnut series. For a complete circle, it has to be 360, by default.
///
endAngle-number default-null
///
///Explodes the pie/doughnut slices on mouse move.
///
explode-boolean default-false
///
///Explodes all the slice of pie/doughnut on render.
///
explodeAll-boolean default-null
///
///Index of the point to be exploded from pie/doughnut/pyramid/funnel.
///
explodeIndex-number default-null
///
///Specifies the distance of the slice from the center, when it is exploded.
///
explodeOffset-number default-25
///
///Fill color of the series.
///
fill-string default-null
///
///Options for customizing the series font.
///
font-any default-
///
///Font color of the series text.
///
color-string default-#707070
///
///Font Family of the series.
///
fontFamily-string default-Segoe UI
///
///Font Style of the series.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-Normal
///
///Font weight of the series.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-Regular
///
///Opacity of series text.
///
opacity-number default-1
///
///Size of the series text.
///
size-string default-12px
///
///Specifies the height of the funnel in funnel series. Values can be in both pixel and percentage.
///
funnelHeight-string default-32.7%
///
///Specifies the width of the funnel in funnel series. Values can be in both pixel and percentage.
///
funnelWidth-string default-11.6%
///
///Gap between the slices of pyramid/funnel series.
///
gapRatio-number default-0
///
///Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path.
///
isClosed-boolean default-true
///
///Specifies whether to stack the column series in polar/radar charts.
///
isStacking-boolean default-true
///
///Renders the chart vertically. This is applicable only for Cartesian type series.
///
isTransposed-boolean default-false
///
///Render the x mark in the center of the box and whisker series type.x represents the average value of the box and whisker series.
///
showMedian-boolean default-true
///
///Position of the data label in pie/doughnut/pyramid/funnel series. OutsideExtended position is not applicable for pyramid/funnel.
///
labelPosition-ej.datavisualization.Chart.LabelPosition|string default-inside. See LabelPosition
///
///Specifies the mode for splitting the data points in pieOfPie series.
///
splitMode-ej.datavisualization.Chart.SplitMode|string default-value. See SplitMode
///
///Quartile calculation has been performed in three different formulas to render the boxplot series .
///
boxPlotMode-ej.datavisualization.Chart.LabelPosition|string default-exclusive.See BoxPlotMode
///
///Options for customizing the bubble options of the Bubble series
///
bubbleOptions-any default-
///
///Used for the calculation of the bubble radius based on the mode selected
///
radiusMode-ej.datavisualization.Chart.RadiusMode|string default-minMax .See RadiusMode
///
///Used for the setting the minimum radius of the bubble
///
minRadius-number default-1
///
///Used for setting the maximum radius of the bubble
///
maxRadius-number default-3
///
///Specifies the different types of spline curve.
///
splineType-ej.datavisualization.Chart.SplineType|string default-Natural. See SplineType
///
///Specifies the line cap of the series.
///
lineCap-ej.datavisualization.Chart.LineCap|string default-Butt. See LineCap
///
///Specifies the type of shape to be used where two lines meet.
///
lineJoin-ej.datavisualization.Chart.LineJoin|string default-Round. See LineJoin
///
///Options for displaying and customizing marker for individual point in a series. Marker contains shapes and/or data labels.
///
marker-any default-
///
///Options for customizing the border of the marker shape.
///
border-any default-
///
///Border color of the marker shape.
///
color-string default-white
///
///Border width of the marker shape.
///
width-number default-3
///
///Options for displaying and customizing data labels.
///
dataLabel-any default-
///
///Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate.
///
angle-number default-null
///
///Maximum label width of the data label.
///
maximumLabelWidth-number default-null
///
///Enable the wrap option to the data label.
///
enableWrap-boolean default-false
///
///Enables saturation to the data label.
///
enableContrastColor-boolean default-false
///
///Displays the partially visible data labels inside the chart Area.
///
showEdgeLabels-boolean default-false
///
///Options for customizing the border of the data label.
///
border-any default-
///
///Border color of the data label.
///
color-string default-null
///
///Border width of the data label.
///
width-number default-0.1
///
///Options for displaying and customizing the line that connects point and data label.
///
connectorLine-any default-
///
///Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types.
///
type-ej.datavisualization.Chart.Type|string default-line. See ConnectorLineType
///
///Width of the connector.
///
width-number default-0.5
///
///Color of the connector.
///
color-string default-null
///
///Height of the connector.
///
height-number default-null
///
///Background color of the data label.
///
fill-string default-null
///
///Options for customizing the data label font.
///
font-any default-
///
///Font family of the data label.
///
fontFamily-string default-Segoe UI
///
///Font color of the data label text.
///
color-string default-null
///
///Font style of the data label.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-normal. See FontStyle
///
///Font weight of the data label.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-regular. See FontWeight
///
///Opacity of the text.
///
opacity-number default-1
///
///Font size of the data label.
///
size-string default-12px
///
///Horizontal alignment of the data label.
///
horizontalTextAlignment-ej.datavisualization.Chart.HorizontalTextAlignment|string default-center
///
///Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text.
///
margin-any default-
///
///Bottom margin of the text.
///
bottom-number default-5
///
///Left margin of the text.
///
left-number default-5
///
///Right margin of the text.
///
right-number default-5
///
///Top margin of the text.
///
top-number default-5
///
///Opacity of the data label.
///
opacity-number default-1
///
///Background shape of the data label.
///
shape-ej.datavisualization.Chart.Shape|string default-No shape is rendered by default, so its value is ‘none’. See Shape
///
///Name of a field in data source where datalabel text is displayed.
///
textMappingName-string default-
///
///Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC.
///
textPosition-ej.datavisualization.Chart.TextPosition|string default-top. See TextPosition
///
///Vertical alignment of the data label.
///
verticalTextAlignment-ej.datavisualization.Chart.VerticalTextAlignment|string default-'center'
///
///Controls the visibility of the data labels.
///
visible-boolean default-false
///
///Custom template to format the data label content. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value.
///
template-string default-
///
///Options for customizing the datalabel positions
///
offset-any|number default-
///
///X value or horizontal offset to position the labels in chart.
///
x-number default-0
///
///Y value or vertical offset to position the labels.
///
y-number default-0
///
///Color of the marker shape.
///
fill-string default-null
///
///The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as ‘image’.
///
imageUrl-string default-
///
///Opacity of the marker.
///
opacity-number default-1
///
///Specifies the shape of the marker.
///
shape-ej.datavisualization.Chart.Shape|string default-circle. See Shape
///
///Options for customizing the size of the marker shape.
///
size-any default-
///
///Height of the marker.
///
height-number default-6
///
///Width of the marker.
///
width-number default-6
///
///Controls the visibility of the marker shape.
///
visible-boolean default-false
///
///Name of the series, that is to be displayed in the legend.
///
name-string default-Add a comment to this line
///
///Opacity of the series.
///
opacity-number default-1
///
///Options for customizing the outlier of individual series.
///
outlierSettings-any default-
///
///Specifies the shape of the outlier.
///
shape-ej.datavisualization.Chart.Shape|string default-circle. See Shape
///
///Options for customizing the size of the outlier shape.
///
size-any default-
///
///Height of the outlier shape.
///
height-number default-6
///
///Width of the outlier shape.
///
width-number default-6
///
///Name of a field in data source where fill color for all the data points is generated.
///
palette-string default-
///
///Controls the size of pie series. Value ranges from 0 to 1.
///
pieCoefficient-number default-0.8
///
///Controls the size of the second pie in pieOfPie series. Value ranges from 0 to 1.
///
pieOfPieCoefficient-number default-0.6
///
///Split Value of pieOfPie series.
///
splitValue-string default-null
///
///Distance between the two pie's in pieOfPie series.
///
gapWidth-number default-50
///
///Options for customizing the empty point in the series.
///
emptyPointSettings-any default-
///
///Controls the visibility of the empty point.
///
visible-boolean default-true
///
///Specifies the mode of empty point.
///
displayMode-ej.datavisualization.Chart.EmptyPointMode|string default-gap
///
///Options for customizing the color and border of the empty point in the series.
///
style-any default-
///
///Color of the empty point.
///
color-string default-
///
///Options for customizing border of the empty point in the series.
///
border-any default-
///
///Border color of the empty point.
///
color-string default-
///
///Border width of the empty point.
///
width-number default-1
///
///Fill color for the positive column of the waterfall.
///
positiveFill-string default-null
///
///Options for customizing the waterfall connector line.
///
connectorLine-any default-
///
///Width of the connector line.
///
width-number default-1
///
///Color of the connector line.
///
color-string default-#565656
///
///DashArray of the connector line.
///
dashArray-string default-null
///
///Opacity of the connector line.
///
opacity-number default-1
///
///Options to customize the drag and drop in series.
///
dragSettings-any default-
///
///drag/drop the series
///
enable-boolean default-false
///
///Specifies the type of drag settings.
///
type-string default-xy
///
///Options to customize the error bar in series.
///
errorBar-any default-
///
///Show/hides the error bar
///
visibility-boolean default-visible
///
///Specifies the type of error bar.
///
type-ej.datavisualization.Chart.ErrorBarType|string default-FixedValue
///
///Specifies the mode of error bar.
///
mode-ej.datavisualization.Chart.ErrorBarMode|string default-vertical
///
///Specifies the direction of error bar.
///
direction-ej.datavisualization.Chart.ErrorBarDirection|string default-both
///
///Value of vertical error bar.
///
verticalErrorValue-number default-3
///
///Value of horizontal error bar.
///
horizontalErrorValue-number default-1
///
///Value of positive horizontal error bar.
///
horizontalPositiveErrorValue-number default-1
///
///Value of negative horizontal error bar.
///
horizontalNegativeErrorValue-number default-1
///
///Value of positive vertical error bar.
///
verticalPositiveErrorValue-number default-5
///
///Value of negative vertical error bar.
///
verticalNegativeErrorValue-number default-5
///
///Fill color of the error bar.
///
fill-string default-#000000
///
///Width of the error bar.
///
width-number default-1
///
///Options for customizing the error bar cap.
///
cap-any default-
///
///Show/Hides the error bar cap.
///
visible-boolean default-true
///
///Width of the error bar cap.
///
width-number default-1
///
///Length of the error bar cap.
///
length-number default-1
///
///Color of the error bar cap.
///
fill-string default-#000000
///
///Option to add data points; each point should have x and y property. Also, optionally, you can customize the points color, border, marker by using fill, border and marker options.
///
points-Array<any> default-
///
///Options for customizing the border of a point. This is applicable only for column type series and accumulation type series.
///
border-any default-
///
///Border color of the point.
///
color-string default-null
///
///Border width of the point.
///
width-number default-null
///
///Enables or disables the visibility of legend item.
///
visibleOnLegend-string default-visible
///
///To show/hide the intermediate summary from the last intermediate point.
///
showIntermediateSum-boolean default-false
///
///To show/hide the total summary of the waterfall series.
///
showTotalSum-boolean default-false
///
///Close value of the point. Close value is applicable only for financial type series.
///
close-number default-null
///
///Size of a bubble in the bubble series. This is applicable only for the bubble series.
///
size-number default-null
///
///Background color of the point. This is applicable only for column type series and accumulation type series.
///
fill-string default-null
///
///High value of the point. High value is applicable only for financial type series, range area series and range column series.
///
high-number default-null
///
///Low value of the point. Low value is applicable only for financial type series, range area series and range column series.
///
low-number default-null
///
///Options for displaying and customizing marker for a data point. Marker contains shapes and/or data labels.
///
marker-any default-
///
///Options for customizing the border of the marker shape.
///
border-any default-
///
///Border color of the marker shape.
///
color-string default-white
///
///Border width of the marker shape.
///
width-number default-3
///
///Options for displaying and customizing data label.
///
dataLabel-any default-
///
///Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate.
///
angle-number default-null
///
///Options for customizing the border of the data label.
///
border-any default-
///
///Border color of the data label.
///
color-string default-null
///
///Border width of the data label.
///
width-number default-0.1
///
///Options for displaying and customizing the line that connects point and data label.
///
connectorLine-any default-
///
///Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types.
///
type-ej.datavisualization.Chart.ConnectorLineType|string default-line. See ConnectorLineType
///
///Width of the connector.
///
width-number default-0.5
///
///Background color of the data label.
///
fill-string default-null
///
///Options for customizing the data label font.
///
font-any default-
///
///Font family of the data label.
///
fontFamily-string default-Segoe UI
///
///Font style of the data label.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-normal. See FontStyle
///
///Font weight of the data label.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-regular. See FontWeight
///
///Opacity of the text.
///
opacity-number default-1
///
///Font size of the data label.
///
size-string default-12px
///
///Horizontal alignment of the data label.
///
horizontalTextAlignment-ej.datavisualization.Chart.HorizontalTextAlignment|string default-center
///
///Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text.
///
margin-any default-
///
///Bottom margin of the text.
///
bottom-number default-5
///
///Left margin of the text.
///
left-number default-5
///
///Right margin of the text.
///
right-number default-5
///
///Top margin of the text.
///
top-number default-5
///
///Opacity of the data label.
///
opacity-number default-1
///
///Background shape of the data label.
///
shape-ej.datavisualization.Chart.Shape|string default-No shape is rendered by default, so its value is ‘none’. See Shape
///
///Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC.
///
textPosition-ej.datavisualization.Chart.TextPosition|string default-top. See TextPosition
///
///Vertical alignment of the data label.
///
verticalTextAlignment-ej.datavisualization.Chart.VerticalTextAlignment|string default-'center'
///
///Controls the visibility of the data labels.
///
visible-boolean default-false
///
///Custom template to format the data label content. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value.
///
template-string default-
///
///Moves the label vertically by specified offset.
///
offset-number default-0
///
///Color of the marker shape.
///
fill-string default-null
///
///The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as ‘image’.
///
imageUrl-string default-
///
///Opacity of the marker.
///
opacity-number default-1
///
///Specifies the shape of the marker.
///
shape-ej.datavisualization.Chart.Shape|string default-circle. See Shape
///
///Options for customizing the size of the marker shape.
///
size-any default-
///
///Height of the marker.
///
height-number default-6
///
///Width of the marker.
///
width-number default-6
///
///Controls the visibility of the marker shape.
///
visible-boolean default-false
///
///Open value of the point. This is applicable only for financial type series.
///
open-number default-null
///
///Datalabel text for the point.
///
text-string default-null
///
///X value of the point.
///
x-number default-null
///
///Y value of the point.
///
y-number default-null
///
///Specifies the mode of the pyramid series.
///
pyramidMode-ej.datavisualization.Chart.PyramidMode|string default-linear
///
///Specifies ej.Query to select data from dataSource. This property is applicable only when the dataSource is ej.DataManager.
///
query-any default-null
///
///Start angle from where the pie/doughnut series renders. It starts from 0, by default.
///
startAngle-number default-null
///
///Options for customizing the corner radius. cornerRadius property also takes the numeric input and applies it for all the four corners of the column.
///
cornerRadius-any default-
///
///Specifies the radius for the top left corner.
///
topLeft-number default-0
///
///Specifies the radius for the top right corner.
///
topRight-number default-0
///
///Specifies the radius for the bottom left corner.
///
bottomLeft-number default-0
///
///Specifies the radius for the bottom right corner.
///
bottomRight-number default-0
///
///Options for customizing the tooltip of chart.
///
tooltip-any default-
///
///Options for customizing the border of the tooltip.
///
border-any default-
///
///Border Color of the tooltip.
///
color-string default-null
///
///Border Width of the tooltip.
///
width-number default-1
///
///Customize the corner radius of the tooltip rectangle.
///
rx-number default-0
///
///Customize the corner radius of the tooltip rectangle.
///
ry-number default-0
///
///Specifies the duration, the tooltip has to be displayed.
///
duration-string default-500ms
///
///Enables/disables the animation of the tooltip when moving from one point to another.
///
enableAnimation-boolean default-true
///
///Background color of the tooltip.
///
fill-string default-null
///
///Format of the tooltip content.
///
format-string default-#point.x# : #point.y#
///
///Opacity of the tooltip.
///
opacity-number default-0.95
///
///Custom template to format the tooltip content. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value.
///
template-string default-null
///
///Controls the visibility of the tooltip.
///
visible-boolean default-false
///
///Specifies the type of the series to render in chart.
///
type-ej.datavisualization.Chart.Type|string default-column. see Type
///
///Controls the visibility of the series.
///
visibility-string default-visible
///
///Enables or disables the visibility of legend item.
///
visibleOnLegend-string default-visible
///
///Specifies the name of the x-axis that has to be associated with this series. Add an axis instance with this name to axes collection.
///
xAxisName-string default-null
///
///Name of the property in the datasource that contains x value for the series.
///
xName-string default-null
///
///Specifies the name of the y-axis that has to be associated with this series. Add an axis instance with this name to axes collection.
///
yAxisName-string default-null
///
///Name of the property in the datasource that contains y value for the series.
///
yName-string default-null
///
///Name of the property in the datasource that contains high value for the series.
///
high-string default-null
///
///Name of the property in the datasource that contains low value for the series.
///
low-string default-null
///
///Name of the property in the datasource that contains open value for the series.
///
open-string default-null
///
///Name of the property in the datasource that contains close value for the series.
///
close-string default-null
///
///Name of the property in the datasource that contains fill color for the series.
///
pointColorMappingName-string default-null
///
///Z-order of the series.
///
zOrder-number default-0
///
///Name of the property in the datasource that contains the size value for the bubble series.
///
size-string default-null
///
///Option to add trendlines to chart.
///
trendlines-Array<any> default-
///
///Show/hides the trendline.
///
visibility-boolean default-
///
///Specifies the type of trendline for the series.
///
type-string default-linear. See TrendlinesType
///
///Name for the trendlines that is to be displayed in legend text.
///
name-string default-Trendline
///
///Fill color of the trendlines.
///
fill-string default-#0000FF
///
///Width of the trendlines.
///
width-number default-1
///
///Opacity of the trendline.
///
opacity-number default-1
///
///Pattern of dashes and gaps used to stroke the trendline.
///
dashArray-string default-
///
///Future trends of the current series.
///
forwardForecast-number default-0
///
///Past trends of the current series.
///
backwardForecast-number default-0
///
///Specifies the order of polynomial trendlines.
///
polynomialOrder-number default-0
///
///Specifies the moving average starting period value.
///
period-number default-2
///
///Options for customizing the trendline tooltip
///
tooltip-any default-
///
///Options for customizing the border of the trendline tooltip.
///
border-any default-
///
///Specify the Border color of the trendline tooltip.
///
color-string default-null
///
///Border width of the trendline tooltip.
///
width-number default-1
///
///Customize the corner radius of the trendline tooltip rectangle.
///
rx-number default-0
///
///Customize the corner radius of the trendline tooltip rectangle.
///
ry-number default-0
///
///Specifies the duration of the trendline tooltip to be displayed.
///
duration-string default-500ms
///
///Enables/disables the animation of the trendline tooltip when moving from one point to other.
///
enableAnimation-boolean default-true
///
///Background color of the trendline tooltip.
///
fill-string default-null
///
///Format of the trendline tooltip content.
///
format-string default-#point.x# : #point.y#
///
///Opacity of the trendline tooltip.
///
opacity-number default-0.5
///
///Show/hides the trendline legend.
///
visibleOnLegend-string default-visible
///
///Specifies the trendline intercept value
///
intercept-number default-null
///
///Options for customizing the appearance of the series or data point while highlighting.
///
highlightSettings-any default-
///
///Enables/disables the ability to highlight series or data point interactively.
///
enable-boolean default-false
///
///Specifies whether series or data point has to be highlighted.
///
mode-ej.datavisualization.Chart.Mode|string default-series. See Mode
///
///Color of the series/point on highlight.
///
color-string default-
///
///Opacity of the series/point on highlight.
///
opacity-number default-0.6
///
///Options for customizing the border of series on highlight.
///
border-any default-
///
///Border color of the series/point on highlight.
///
color-string default-
///
///Border width of the series/point on highlight.
///
width-string default-2
///
///Specifies the pattern for the series/point on highlight.
///
pattern-string default-none. See Pattern
///
///Custom pattern for the series on highlight.
///
customPattern-string default-
///
///Options for customizing the appearance of the series/data point on selection.
///
selectionSettings-any default-
///
///Enables/disables the ability to select a series/data point interactively.
///
enable-boolean default-false
///
///Specifies whether series or data point has to be selected.
///
mode-ej.datavisualization.Chart.Mode|string default-series. See Mode
///
///Specifies the type of selection.
///
type-ej.datavisualization.Chart.SelectionType|string default-single
///
///Specifies the drawn rectangle type.
///
rangeType-ej.datavisualization.Chart.RangeType|string default-xy
///
///Color of the series/point on selection.
///
color-string default-
///
///Opacity of the series/point on selection.
///
opacity-number default-0.6
///
///Options for customizing the border of series on selection.
///
border-any default-
///
///Border color of the series/point on selection.
///
color-string default-
///
///Border width of the series/point on selection.
///
width-string default-2
///
///Specifies the pattern for the series/point on selection.
///
pattern-string default-none. See Pattern
///
///Custom pattern for the series on selection.
///
customPattern-string default-
///
///Controls whether data points has to be displayed side by side or along the depth of the axis.
///
sideBySideSeriesPlacement-boolean default-false
///
///Options to customize the Chart size.
///
size-Size default-
///
///Height of the Chart. Height can be specified in either pixel or percentage.
///
height-string default-'450'
///
///Width of the Chart. Width can be specified in either pixel or percentage.
///
width-string default-'450'
///
///Specifies the theme for Chart.
///
theme-ej.datavisualization.Chart.Theme|string default-Flatlight. See Theme
///
///Slope angle of 3D Chart. This property is applicable only when 3D view is enabled.
///
tilt-number default-0
///
///Options for customizing the title and subtitle of Chart.
///
title-Title default-
///
///Background color for the chart title.
///
background-string default-transparent
///
///Options to customize the border of the title.
///
border-any default-
///
///Width of the title border.
///
width-number default-1
///
///color of the title border.
///
color-string default-transparent
///
///opacity of the title border.
///
opacity-number default-0.8
///
///opacity of the title border.
///
cornerRadius-number default-0.8
///
///Options for customizing the font of Chart title.
///
font-any default-
///
///Font family for Chart title.
///
fontFamily-string default-Segoe UI
///
///Font style for Chart title.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-Normal. See FontStyle
///
///Font weight for Chart title.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-Regular. See FontWeight
///
///Opacity of the Chart title.
///
opacity-number default-0.5
///
///Font size for Chart title.
///
size-string default-20px
///
///Controls the visibility of the Chart title
///
visible-boolean default-true
///
///Specifies whether to trim the Chart Title when the width of the title exceeds the maximumWidth.
///
enableTrim-boolean default-false
///
///Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true.
///
maximumWidth-string default-auto
///
///Specifies the action taken when the Chart width is more than the titleWidth.
///
textOverflow-ej.datavisualization.Chart.TextOverflow|string default-trim.
///
///Options to customize the sub title of Chart.
///
subTitle-any default-
///
///Options for customizing the font of sub title.
///
font-any default-
///
///Font family of sub title.
///
fontFamily-string default-Segoe UI
///
///Font style for sub title.
///
fontStyle-ej.datavisualization.Chart.FontStyle|string default-Normal. See FontStyle
///
///Font weight for sub title.
///
fontWeight-ej.datavisualization.Chart.FontWeight|string default-Regular. See FontWeight
///
///Opacity of the sub title.
///
opacity-number default-1
///
///Font size for sub title.
///
size-string default-12px
///
///Background color for the chart subtitle.
///
background-string default-transparent
///
///Options to customize the border of the title.
///
border-any default-
///
///Width of the subtitle border.
///
width-number default-1
///
///color of the subtitle border.
///
color-string default-transparent
///
///opacity of the subtitle border.
///
opacity-number default-0.8
///
///opacity of the subtitle border.
///
cornerRadius-number default-0.8
///
///Text to be displayed in sub title.
///
text-string default-
///
///Alignment of sub title text.
///
textAlignment-ej.datavisualization.Chart.Alignment|string default-far. See TextAlignment
///
///Controls the visibility of the Chart SubTitle
///
visible-boolean default-true
///
///Specifies whether to trim the Chart SubTitle when the width of the Subtitle exceeds the maximumWidth.
///
enableTrim-boolean default-false
///
///Maximum width of the Subtitle, when the Subtitle exceeds this width, the Subtitle gets trimmed, when enableTrim is true.
///
maximumWidth-string default-auto
///
///Specifies the action taken when the Chart width is more than the SubTitleWidth.
///
textOverflow-ej.datavisualization.Chart.TextOverflow|string default-trim.
///
///Text to be displayed in Chart title.
///
text-string default-
///
///Alignment of the title text.
///
textAlignment-ej.datavisualization.Chart.Alignment|string default-Center. See TextAlignment
///
///Width of the wall used in 3D Chart. Wall is present only in Cartesian type 3D series and not in 3D pie or Doughnut series. This property is applicable only when 3D view is enabled.
///
wallSize-number default-2
///
///Options for enabling zooming feature of chart.
///
zooming-Zooming default-
///
///Enables or disables zooming.
///
enable-boolean default-false
///
///Enables or disables pinch zooming.
///
enablePinching-boolean default-true
///
///Enable or disables the differed zooming. When it is enabled, chart is updated only on mouse up action while zooming and panning.
///
enableDeferredZoom-boolean default-false
///
///Enables/disables the ability to zoom the chart on moving the mouse wheel.
///
enableMouseWheel-boolean default-false
///
///Specifies whether to allow zooming the chart vertically or horizontally or in both ways.
///
type-string default-'x,y'
///
///Toggles the visibility of the scrollbar, which will be displayed while zooming.
///
enableScrollbar-boolean default-false
///
///To display user specified buttons in zooming toolbar.
///
toolbarItems-Array<any> default-[zoomIn, zoomOut, zoom, pan, reset]
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
CheckBox:function(){
///
/// Constructor of ej.CheckBox
///
}
});
ej.CheckBox=(function(){
var original=ej.CheckBox
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
destroy:function(){
///
///
/// Destroy the CheckBox widget all events bound using this._on will be unbind automatically and bring the control to pre-init state.
///
},
disable:function(){
///
///
/// Disable the CheckBox to prevent all user interactions.
///
},
enable:function(){
///
///
/// To enable the CheckBox
///
},
isChecked:function(){
///
///
/// To Check the status of CheckBox
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejCheckBox=function(){
this.data("ejCheckBox",new ej.CheckBox());
return this;
};
intellisense.annotate(jQuery.fn,{
ejCheckBox :function (options) {
///
///
///The CheckBox control allows you to check an option to perform an action. This control allows you to select true, false or an intermediate option. These CheckBoxes are supported with themes. The HTML CheckBox control is rendered as Essential JavaScript CheckBox control.
///Specifies whether CheckBox has to be in checked or not. We can also specify array of string as value for this property. If any of the value in the specified array matches the value of the textbox, then it will be considered as checked. It will be useful in MVVM binding, specify array type to identify the values of the checked CheckBoxes.
///
checked-boolean|string[] default-false
///
///Specifies the State of CheckBox.See below to get available CheckState
///
checkState-ej.CheckState|string default-null
///
///Sets the root CSS class for CheckBox theme, which is used customize.
///
cssClass-string default-
///
///Specifies the checkbox control state.
///
enabled-boolean default-true
///
///Specifies the persist property for CheckBox while initialization. The persist API save current model value to browser cookies for state maintains. While refreshing the CheckBox control page the model value apply from browser cookies.
///
enablePersistence-boolean default-false
///
///Specify the Right to Left direction to Checkbox
///
enableRTL-boolean default-false
///
///Specifies the enable or disable Tri-State for checkbox control.
///
enableTriState-boolean default-false
///
///It allows to define the characteristics of the CheckBox control. It will helps to extend the capability of an HTML element.
///
htmlAttributes-any default-{}
///
///Specified value to be added an id attribute of the CheckBox.
///
id-string default-null
///
///Specify the prefix value of id to be added before the current id of the CheckBox.
///
idPrefix-string default-ej
///
///Specifies the name attribute of the CheckBox.
///
name-string default-null
///
///Displays rounded corner borders to CheckBox
///
showRoundedCorner-boolean default-false
///
///Specifies the size of the CheckBox.See below to know available CheckboxSize
///
size-ej.CheckboxSize|string default-small
///
///Specifies the text content to be displayed for CheckBox.
///
text-string default-
///
///Set the jQuery validation error message in CheckBox.
///
validationMessage-any default-null
///
///Set the jQuery validation rules in CheckBox.
///
validationRules-any default-null
///
///Specifies the value attribute of the CheckBox.
///
value-string default-null
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
CircularGauge:function(){
///
/// Constructor of ej.CircularGauge
///
}
});
ej.CircularGauge=(function(){
var original=ej.CircularGauge
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
destroy:function(){
///
///
/// destroy the circular gauge widget. all events bound using this._on will be unbind automatically and bring the control to pre-init state.
///
},
exportImage:function(fileName, fileType){
///
///
/// To export Image
///
/// fileName for the Image
///
///
///
/// To export Image
///
/// fileType for the Image
///
},
getBackNeedleLength:function(scaleIndex, pointerIndex){
///
///
/// To get BackNeedleLength
///
/// scaleIndex value for the Gauge
///
///
///
/// To get BackNeedleLength
///
/// pointerIndex value for the Gauge
///
},
getCustomLabelAngle:function(scaleIndex, customLabelIndex){
///
///
/// To get CustomLabelAngle
///
/// scaleIndex value for the Gauge
///
///
///
/// To get CustomLabelAngle
///
/// customLabelIndex value for the Gauge
///
},
getCustomLabelValue:function(scaleIndex, customLabelIndex){
///
///
/// To get CustomLabelValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To get CustomLabelValue
///
/// customLabelIndex value for the Gauge
///
},
getLabelAngle:function(scaleIndex, labelIndex){
///
///
/// To get LabelAngle
///
/// scaleIndex value for the Gauge
///
///
///
/// To get LabelAngle
///
/// labelIndex value for the Gauge
///
},
getLabelDistanceFromScale:function(scaleIndex, labelIndex){
///
///
/// To get LabelDistanceFromScale
///
/// scaleIndex value for the Gauge
///
///
///
/// To get LabelDistanceFromScale
///
/// labelIndex value for the Gauge
///
},
getLabelPlacement:function(scaleIndex, labelIndex){
///
///
/// To get LabelPlacement
///
/// scaleIndex value for the Gauge
///
///
///
/// To get LabelPlacement
///
/// labelIndex value for the Gauge
///
},
getLabelStyle:function(scaleIndex, labelIndex){
///
///
/// To get LabelStyle
///
/// scaleIndex value for the Gauge
///
///
///
/// To get LabelStyle
///
/// labelIndex value for the Gauge
///
},
getMajorIntervalValue:function(scaleIndex){
///
///
/// To get MajorIntervalValue
///
/// scaleIndex value for the Gauge
///
},
getMarkerDistanceFromScale:function(scaleIndex, pointerIndex){
///
///
/// To get MarkerDistanceFromScale
///
/// scaleIndex value for the Gauge
///
///
///
/// To get MarkerDistanceFromScale
///
/// pointerIndex value for the Gauge
///
},
getMarkerStyle:function(scaleIndex, pointerIndex){
///
///
/// To get MarkerStyle
///
/// scaleIndex value for the Gauge
///
///
///
/// To get MarkerStyle
///
/// pointerIndex value for the Gauge
///
},
getMaximumValue:function(scaleIndex){
///
///
/// To get MaximumValue
///
/// scaleIndex value for the Gauge
///
},
getMinimumValue:function(scaleIndex){
///
///
/// To get MinimumValue
///
/// scaleIndex value for the Gauge
///
},
getMinorIntervalValue:function(scaleIndex){
///
///
/// To get MinorIntervalValue
///
/// scaleIndex value for the Gauge
///
},
getNeedleStyle:function(scaleIndex, pointerIndex){
///
///
/// To get NeedleStyle
///
/// scaleIndex value for the Gauge
///
///
///
/// To get NeedleStyle
///
/// pointerIndex value for the Gauge
///
},
getPointerCapBorderWidth:function(scaleIndex){
///
///
/// To get PointerCapBorderWidth
///
/// scaleIndex value for the Gauge
///
},
getPointerCapRadius:function(scaleIndex){
///
///
/// To get PointerCapRadius
///
/// scaleIndex value for the Gauge
///
},
getPointerLength:function(scaleIndex, pointerIndex){
///
///
/// To get PointerLength
///
/// scaleIndex value for the Gauge
///
///
///
/// To get PointerLength
///
/// pointerIndex value for the Gauge
///
},
getPointerNeedleType:function(scaleIndex, pointerIndex){
///
///
/// To get PointerNeedleType
///
/// scaleIndex value for the Gauge
///
///
///
/// To get PointerNeedleType
///
/// pointerIndex value for the Gauge
///
},
getPointerPlacement:function(scaleIndex, pointerIndex){
///
///
/// To get PointerPlacement
///
/// scaleIndex value for the Gauge
///
///
///
/// To get PointerPlacement
///
/// pointerIndex value for the Gauge
///
},
getPointerValue:function(scaleIndex, pointerIndex){
///
///
/// To get PointerValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To get PointerValue
///
/// pointerIndex value for the Gauge
///
},
getPointerWidth:function(scaleIndex, pointerIndex){
///
///
/// To get PointerWidth
///
/// scaleIndex value for the Gauge
///
///
///
/// To get PointerWidth
///
/// pointerIndex value for the Gauge
///
},
getRangeBorderWidth:function(scaleIndex, rangeIndex){
///
///
/// To get RangeBorderWidth
///
/// scaleIndex value for the Gauge
///
///
///
/// To get RangeBorderWidth
///
/// rangeIndex value for the Gauge
///
},
getRangeDistanceFromScale:function(scaleIndex, rangeIndex){
///
///
/// To get RangeDistanceFromScale
///
/// scaleIndex value for the Gauge
///
///
///
/// To get RangeDistanceFromScale
///
/// rangeIndex value for the Gauge
///
},
getRangeEndValue:function(scaleIndex, rangeIndex){
///
///
/// To get RangeEndValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To get RangeEndValue
///
/// rangeIndex value for the Gauge
///
},
getRangePosition:function(scaleIndex, rangeIndex){
///
///
/// To get RangePosition
///
/// scaleIndex value for the Gauge
///
///
///
/// To get RangePosition
///
/// rangeIndex value for the Gauge
///
},
getRangeSize:function(scaleIndex, rangeIndex){
///
///
/// To get RangeSize
///
/// scaleIndex value for the Gauge
///
///
///
/// To get RangeSize
///
/// rangeIndex value for the Gauge
///
},
getRangeStartValue:function(scaleIndex, rangeIndex){
///
///
/// To get RangeStartValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To get RangeStartValue
///
/// rangeIndex value for the Gauge
///
},
getScaleBarSize:function(scaleIndex){
///
///
/// To get ScaleBarSize
///
/// scaleIndex value for the Gauge
///
},
getScaleBorderWidth:function(scaleIndex){
///
///
/// To get ScaleBorderWidth
///
/// scaleIndex value for the Gauge
///
},
getScaleDirection:function(scaleIndex){
///
///
/// To get ScaleDirection
///
/// scaleIndex value for the Gauge
///
},
getScaleRadius:function(scaleIndex){
///
///
/// To get ScaleRadius
///
/// scaleIndex value for the Gauge
///
},
getStartAngle:function(scaleIndex){
///
///
/// To get StartAngle
///
/// scaleIndex value for the Gauge
///
},
getSubGaugeLocation:function(scaleIndex, GaugeIndex){
///
///
/// To get SubGaugeLocation
///
/// scaleIndex value for the Gauge
///
///
///
/// To get SubGaugeLocation
///
/// GaugeIndex value for the Gauge
///
},
getSweepAngle:function(scaleIndex){
///
///
/// To get SweepAngle
///
/// scaleIndex value for the Gauge
///
},
getTickAngle:function(scaleIndex, tickIndex){
///
///
/// To get TickAngle
///
/// scaleIndex value for the Gauge
///
///
///
/// To get TickAngle
///
/// tickIndex value for the Gauge
///
},
getTickDistanceFromScale:function(scaleIndex, tickIndex){
///
///
/// To get TickDistanceFromScale
///
/// scaleIndex value for the Gauge
///
///
///
/// To get TickDistanceFromScale
///
/// tickIndex value for the Gauge
///
},
getTickHeight:function(scaleIndex, labelIndex){
///
///
/// To get TickHeight
///
/// scaleIndex value for the Gauge
///
///
///
/// To get TickHeight
///
/// labelIndex value for the Gauge
///
},
getTickPlacement:function(scaleIndex, tickIndex){
///
///
/// To get TickPlacement
///
/// scaleIndex value for the Gauge
///
///
///
/// To get TickPlacement
///
/// tickIndex value for the Gauge
///
},
getTickStyle:function(scaleIndex, tickIndex){
///
///
/// To get TickStyle
///
/// scaleIndex value for the Gauge
///
///
///
/// To get TickStyle
///
/// tickIndex value for the Gauge
///
},
getTickWidth:function(scaleIndex, tickIndex){
///
///
/// To get TickWidth
///
/// scaleIndex value for the Gauge
///
///
///
/// To get TickWidth
///
/// tickIndex value for the Gauge
///
},
includeFirstValue:function(scaleIndex, labelIndex, value){
///
///
/// To set includeFirstValue
///
/// scaleIndex value for the gauge
///
///
///
/// To set includeFirstValue
///
/// labelIndex value for the gauge
///
///
///
/// To set includeFirstValue
///
/// value for the gauge
///
},
redraw:function(value){
///
///
/// Switching the redraw option for the gauge
///
/// redraw value for the gauge
///
},
setBackNeedleLength:function(scaleIndex, pointerIndex, value){
///
///
/// To set BackNeedleLength
///
/// scaleIndex value for the gauge
///
///
///
/// To set BackNeedleLength
///
/// pointerIndex value for the gauge
///
///
///
/// To set BackNeedleLength
///
/// value for the gauge
///
},
setCustomLabelAngle:function(scaleIndex, customLabelIndex, value){
///
///
/// To set CustomLabelAngle
///
/// scaleIndex value for the gauge
///
///
///
/// To set CustomLabelAngle
///
/// customLabelIndex value for the gauge
///
///
///
/// To set CustomLabelAngle
///
/// value for the gauge
///
},
setCustomLabelValue:function(scaleIndex, customLabelIndex, value){
///
///
/// To set CustomLabelValue
///
/// scaleIndex value for the gauge
///
///
///
/// To set CustomLabelValue
///
/// customLabelIndex value for the gauge
///
///
///
/// To set CustomLabelValue
///
/// value for the gauge
///
},
setLabelAngle:function(scaleIndex, labelIndex, angle){
///
///
/// To set LabelAngle
///
/// scaleIndex value for the gauge
///
///
///
/// To set LabelAngle
///
/// labelIndex value for the gauge
///
///
///
/// To set LabelAngle
///
/// angle value for the gauge
///
},
setLabelDistanceFromScale:function(scaleIndex, labelIndex, value){
///
///
/// To set LabelDistanceFromScale
///
/// scaleIndex value for the gauge
///
///
///
/// To set LabelDistanceFromScale
///
/// labelIndex value for the gauge
///
///
///
/// To set LabelDistanceFromScale
///
/// value for the gauge
///
},
setLabelPlacement:function(scaleIndex, labelIndex, value){
///
///
/// To set LabelPlacement
///
/// scaleIndex value for the gauge
///
///
///
/// To set LabelPlacement
///
/// labelIndex value for the gauge
///
///
///
/// To set LabelPlacement
///
/// value for the gauge
///
},
setLabelStyle:function(scaleIndex, labelIndex, value){
///
///
/// To set LabelStyle
///
/// scaleIndex value for the gauge
///
///
///
/// To set LabelStyle
///
/// labelIndex value for the gauge
///
///
///
/// To set LabelStyle
///
/// value for the gauge
///
},
setMajorIntervalValue:function(scaleIndex, value){
///
///
/// To set MajorIntervalValue
///
/// scaleIndex value for the gauge
///
///
///
/// To set MajorIntervalValue
///
/// value for the gauge
///
},
setMarkerDistanceFromScale:function(scaleIndex, pointerIndex, value){
///
///
/// To set MarkerDistanceFromScale
///
/// scaleIndex value for the gauge
///
///
///
/// To set MarkerDistanceFromScale
///
/// pointerIndex value for the gauge
///
///
///
/// To set MarkerDistanceFromScale
///
/// value for the gauge
///
},
setMarkerStyle:function(scaleIndex, pointerIndex, value){
///
///
/// To set MarkerStyle
///
/// scaleIndex value for the gauge
///
///
///
/// To set MarkerStyle
///
/// pointerIndex value for the gauge
///
///
///
/// To set MarkerStyle
///
/// value for the gauge
///
},
setMaximumValue:function(scaleIndex, value){
///
///
/// To set MaximumValue
///
/// scaleIndex value for the gauge
///
///
///
/// To set MaximumValue
///
/// value for the gauge
///
},
setMinimumValue:function(scaleIndex, value){
///
///
/// To set MinimumValue
///
/// scaleIndex value for the gauge
///
///
///
/// To set MinimumValue
///
/// value for the gauge
///
},
setMinorIntervalValue:function(scaleIndex, value){
///
///
/// To set MinorIntervalValue
///
/// scaleIndex value for the gauge
///
///
///
/// To set MinorIntervalValue
///
/// value for the gauge
///
},
setNeedleStyle:function(scaleIndex, pointerIndex, value){
///
///
/// To set NeedleStyle
///
/// scaleIndex value for the gauge
///
///
///
/// To set NeedleStyle
///
/// pointerIndex value for the gauge
///
///
///
/// To set NeedleStyle
///
/// value for the gauge
///
},
setPointerCapBorderWidth:function(scaleIndex, value){
///
///
/// To set PointerCapBorderWidth
///
/// scaleIndex value for the gauge
///
///
///
/// To set PointerCapBorderWidth
///
/// value for the gauge
///
},
setPointerCapRadius:function(scaleIndex, value){
///
///
/// To set PointerCapRadius
///
/// scaleIndex value for the gauge
///
///
///
/// To set PointerCapRadius
///
/// value for the gauge
///
},
setPointerLength:function(scaleIndex, pointerIndex, value){
///
///
/// To set PointerLength
///
/// scaleIndex value for the gauge
///
///
///
/// To set PointerLength
///
/// pointerIndex value for the gauge
///
///
///
/// To set PointerLength
///
/// value for the gauge
///
},
setPointerNeedleType:function(scaleIndex, pointerIndex, value){
///
///
/// To set PointerNeedleType
///
/// scaleIndex value for the gauge
///
///
///
/// To set PointerNeedleType
///
/// pointerIndex value for the gauge
///
///
///
/// To set PointerNeedleType
///
/// value for the gauge
///
},
setPointerPlacement:function(scaleIndex, pointerIndex, value){
///
///
/// To set PointerPlacement
///
/// scaleIndex value for the gauge
///
///
///
/// To set PointerPlacement
///
/// pointerIndex value for the gauge
///
///
///
/// To set PointerPlacement
///
/// value for the gauge
///
},
setPointerValue:function(scaleIndex, pointerIndex, value){
///
///
/// To set PointerValue
///
/// scaleIndex value for the gauge
///
///
///
/// To set PointerValue
///
/// pointerIndex value for the gauge
///
///
///
/// To set PointerValue
///
/// value for the gauge
///
},
setPointerWidth:function(scaleIndex, pointerIndex, value){
///
///
/// To set PointerWidth
///
/// scaleIndex value for the gauge
///
///
///
/// To set PointerWidth
///
/// pointerIndex value for the gauge
///
///
///
/// To set PointerWidth
///
/// value for the gauge
///
},
setRangeBorderWidth:function(scaleIndex, rangeIndex, value){
///
///
/// To set RangeBorderWidth
///
/// scaleIndex value for the gauge
///
///
///
/// To set RangeBorderWidth
///
/// rangeIndex value for the gauge
///
///
///
/// To set RangeBorderWidth
///
/// value for the gauge
///
},
setRangeDistanceFromScale:function(scaleIndex, rangeIndex, value){
///
///
/// To set RangeDistanceFromScale
///
/// scaleIndex value for the gauge
///
///
///
/// To set RangeDistanceFromScale
///
/// rangeIndex value for the gauge
///
///
///
/// To set RangeDistanceFromScale
///
/// value for the gauge
///
},
setRangeEndValue:function(scaleIndex, rangeIndex, value){
///
///
/// To set RangeEndValue
///
/// scaleIndex value for the gauge
///
///
///
/// To set RangeEndValue
///
/// rangeIndex value for the gauge
///
///
///
/// To set RangeEndValue
///
/// value for the gauge
///
},
setRangePosition:function(scaleIndex, rangeIndex, value){
///
///
/// To set RangePosition
///
/// scaleIndex value for the gauge
///
///
///
/// To set RangePosition
///
/// rangeIndex value for the gauge
///
///
///
/// To set RangePosition
///
/// value for the gauge
///
},
setRangeSize:function(scaleIndex, rangeIndex, value){
///
///
/// To set RangeSize
///
/// scaleIndex value for the gauge
///
///
///
/// To set RangeSize
///
/// rangeIndex value for the gauge
///
///
///
/// To set RangeSize
///
/// value for the gauge
///
},
setRangeStartValue:function(scaleIndex, rangeIndex, value){
///
///
/// To set RangeStartValue
///
/// scaleIndex value for the gauge
///
///
///
/// To set RangeStartValue
///
/// rangeIndex value for the gauge
///
///
///
/// To set RangeStartValue
///
/// value for the gauge
///
},
setScaleBarSize:function(scaleIndex, value){
///
///
/// To set ScaleBarSize
///
/// scaleIndex value for the gauge
///
///
///
/// To set ScaleBarSize
///
/// value for the gauge
///
},
setScaleBorderWidth:function(scaleIndex, value){
///
///
/// To set ScaleBorderWidth
///
/// scaleIndex value for the gauge
///
///
///
/// To set ScaleBorderWidth
///
/// value for the gauge
///
},
setScaleDirection:function(scaleIndex, value){
///
///
/// To set ScaleDirection
///
/// scaleIndex value for the gauge
///
///
///
/// To set ScaleDirection
///
/// value for the gauge
///
},
setScaleRadius:function(scaleIndex, value){
///
///
/// To set ScaleRadius
///
/// scaleIndex value for the gauge
///
///
///
/// To set ScaleRadius
///
/// value for the gauge
///
},
setStartAngle:function(scaleIndex, value){
///
///
/// To set StartAngle
///
/// scaleIndex value for the gauge
///
///
///
/// To set StartAngle
///
/// value for the gauge
///
},
setSubGaugeLocation:function(scaleIndex, GaugeIndex, value){
///
///
/// To set SubGaugeLocation
///
/// scaleIndex value for the gauge
///
///
///
/// To set SubGaugeLocation
///
/// GaugeIndex value for the gauge
///
///
///
/// To set SubGaugeLocation
///
/// value for the gauge
///
},
setSweepAngle:function(scaleIndex, value){
///
///
/// To set SweepAngle
///
/// scaleIndex value for the gauge
///
///
///
/// To set SweepAngle
///
/// value for the gauge
///
},
setTickAngle:function(scaleIndex, tickIndex, value){
///
///
/// To set TickAngle
///
/// scaleIndex value for the gauge
///
///
///
/// To set TickAngle
///
/// tickIndex value for the gauge
///
///
///
/// To set TickAngle
///
/// value for the gauge
///
},
setTickDistanceFromScale:function(scaleIndex, tickIndex, value){
///
///
/// To set TickDistanceFromScale
///
/// scaleIndex value for the gauge
///
///
///
/// To set TickDistanceFromScale
///
/// tickIndex value for the gauge
///
///
///
/// To set TickDistanceFromScale
///
/// value for the gauge
///
},
setTickHeight:function(scaleIndex, tickIndex, value){
///
///
/// To set TickHeight
///
/// scaleIndex value for the gauge
///
///
///
/// To set TickHeight
///
/// tickIndex value for the gauge
///
///
///
/// To set TickHeight
///
/// value for the gauge
///
},
setTickPlacement:function(scaleIndex, tickIndex, value){
///
///
/// To set TickPlacement
///
/// scaleIndex value for the gauge
///
///
///
/// To set TickPlacement
///
/// tickIndex value for the gauge
///
///
///
/// To set TickPlacement
///
/// value for the gauge
///
},
setTickStyle:function(scaleIndex, tickIndex, value){
///
///
/// To set TickStyle
///
/// scaleIndex value for the gauge
///
///
///
/// To set TickStyle
///
/// tickIndex value for the gauge
///
///
///
/// To set TickStyle
///
/// value for the gauge
///
},
setTickWidth:function(scaleIndex, tickIndex, value){
///
///
/// To set TickWidth
///
/// scaleIndex value for the gauge
///
///
///
/// To set TickWidth
///
/// tickIndex value for the gauge
///
///
///
/// To set TickWidth
///
/// value for the gauge
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejCircularGauge=function(){
this.data("ejCircularGauge",new ej.CircularGauge());
return this;
};
intellisense.annotate(jQuery.fn,{
ejCircularGauge :function (options) {
///
///
///The Circular gauge can be easily configured to the DOM element, such as div. you can create a circular gauge with a highly customizable look and feel.
///Specifies animationSpeed of circular gauge
///
animationSpeed-number default-500
///
///Specifies the background color of circular gauge.
///
backgroundColor-string default-null
///
///Specify distanceFromCorner value of circular gauge
///
distanceFromCorner-number default-center
///
///Specify range Z-order placement of circular gauge.
///
rangeZOrder-ej.datavisualization.CircularGauge.RangeZOrderPlacement|string default-Rear
///
///Specify animate value of circular gauge
///
enableAnimation-boolean default-true
///
///Specify to convert the date object to string, using locale settings.
///
enableGroupSeparator-boolean default-false
///
///Controls whether circular gauge has to be responsive while resizing.
///
enableResize-boolean default-false
///
///This provides options for customizing export settings
///
exportSettings-ExportSettings default-
///
///Specifies the downloading filename
///
filename-string default-CircularGauge
///
///Specifies the format of the file to export
///
type-ej.datavisualization.CircularGauge.ExportingType|string default-png
///
///Specifies the name of the action URL
///
action-string default-
///
///Specifies the mode of exporting
///
mode-ej.datavisualization.CircularGauge.ExportingMode|string default-client
///
///Specify the frame of circular gauge
///
frame-Frame default-Object
///
///Specify the URL of the frame background image for circular gauge
///
backgroundImageUrl-string default-null
///
///Specifies the frameType of circular gauge. See
///
frameType-ej.datavisualization.CircularGauge.FrameType|string default-FullCircle
///
///Specifies the end angle for the half circular frame.
///
halfCircleFrameEndAngle-number default-360
///
///Specifies the start angle for the half circular frame.
///
halfCircleFrameStartAngle-number default-180
///
///Specify gaugePosition value of circular gauge See GaugePosition
///
gaugePosition-ej.datavisualization.CircularGauge.gaugePosition|string default-center
///
///Specifies the height of circular gauge.
///
height-number default-360
///
///Specifies the interiorGradient of circular gauge.
///
interiorGradient-any default-null
///
///Specify isRadialGradient value of circular gauge
///
isRadialGradient-boolean default-false
///
///Specify isResponsive value of circular gauge
///
isResponsive-boolean default-false
///
///Name of the culture based on which circular gauge should be localized.
///
locale-string default-en-US
///
///Specifies the maximum value of circular gauge.
///
maximum-number default-100
///
///Specifies the minimum value of circular gauge.
///
minimum-number default-0
///
///Specify outerCustomLabelPosition value of circular gauge See
///
outerCustomLabelPosition-ej.datavisualization.CircularGauge.OuterCustomLabelPosition|string default-bottom
///
///Specifies the radius of circular gauge.
///
radius-number default-180
///
///Specify readonly value of circular gauge
///
readOnly-boolean default-true
///
///Specify the pointers, ticks, labels, indicators, ranges of circular gauge
///
scales-Array<Scales> default-null
///
///Specify backgroundColor for the scale of circular gauge
///
backgroundColor-string default-null
///
///Specify border for scales of circular gauge
///
border-any default-Object
///
///Specify border color for scales of circular gauge
///
color-string default-null
///
///Specify border width of circular gauge
///
width-number default-1.5
///
///Specify scale direction of circular gauge. See
///
direction-ej.datavisualization.CircularGauge.Direction|string default-Clockwise
///
///Specify the custom labels for the scales.
///
customLabels-Array<any> default-Array
///
///Value of the custom labels.
///
value-string default-
///
///Color of the custom labels.
///
color-string default-
///
///Specify position of custom labels
///
position-any default-Object
///
///Specify x-axis position of label
///
x-number default-0
///
///Specify y-axis position of labels.
///
y-number default-0
///
///Specify angle for the rotation of the custom labels in degrees.
///
textAngle-number default-0
///
///Specify font for custom labels
///
font-any default-Object
///
///Specify font fontFamily for custom labels.
///
fontFamily-string default-Arial
///
///Specify font Style for custom labels.
///
fontStyle-string default-Bold
///
///Specify font size for custom labels.
///
size-string default-12px
///
///Specifies the position of the custom labels. See
///
positionType-ej.datavisualization.CircularGauge.CustomLabelPositionType|string default-inner
///
///Specify representing state of circular gauge
///
indicators-Array<any> default-Array
///
///Specify indicator height of circular gauge
///
height-number default-15
///
///Specify imageUrl of circular gauge
///
imageUrl-string default-null
///
///Specify position of circular gauge
///
position-any default-Object
///
///Specify x-axis of position of circular gauge
///
x-number default-0
///
///Specify y-axis of position of circular gauge
///
y-number default-0
///
///Specify the various states of circular gauge
///
stateRanges-Array<any> default-Array
///
///Specify backgroundColor for indicator of circular gauge
///
backgroundColor-string default-null
///
///Specify borderColor for indicator of circular gauge
///
borderColor-string default-null
///
///Specify end value for each specified state of circular gauge
///
endValue-number default-0
///
///Specify value of the font as the indicator when the indicator style is set with the value "text" of circular gauge
///
font-any default-null
///
///Specify start value for each specified state of circular gauge
///
startValue-number default-0
///
///Specify value of the text as the indicator when the indicator style is set with the value "text" of circular gauge
///
text-string default-
///
///Specify value of the textColor as the indicator when the indicator style is set with the value "text" of circular gauge
///
textColor-string default-null
///
///Specify indicator style of circular gauge. See
///
type-ej.datavisualization.CircularGauge.IndicatorTypes|string default-Circle
///
///Specify indicator width of circular gauge
///
width-number default-15
///
///Specify the text values displayed in a meaningful manner alongside the ticks of circular gauge
///
labels-Array<any> default-Array
///
///Specify the angle for the labels of circular gauge
///
angle-number default-0
///
///Specify labels autoAngle value of circular gauge
///
autoAngle-boolean default-false
///
///Specify label color of circular gauge
///
color-string default-null
///
///Specify distanceFromScale value for labels of circular gauge
///
distanceFromScale-number default-0
///
///Specify font for labels of circular gauge
///
font-any default-Object
///
///Specify font fontFamily for labels of circular gauge
///
fontFamily-string default-Arial
///
///Specify font Style for labels of circular gauge
///
fontStyle-string default-Bold
///
///Specify font size for labels of circular gauge
///
size-string default-11px
///
///Specify includeFirstValue of circular gauge
///
includeFirstValue-boolean default-true
///
///Specify opacity value for labels of circular gauge
///
opacity-number default-null
///
///Specify label placement of circular gauge. See
///
placement-ej.datavisualization.CircularGauge.Placement|string default-Near
///
///Specify label Style of circular gauge. See
///
type-ej.datavisualization.CircularGauge.LabelType|string default-Major
///
///Specify unitText of circular gauge
///
unitText-string default-
///
///Specify unitTextPosition of circular gauge. See UnitTextPosition
///
unitTextPosition-ej.datavisualization.CircularGauge.UnitTextPlacement|string default-Back
///
///Specify majorIntervalValue of circular gauge
///
majorIntervalValue-number default-10
///
///Specify maximum scale value of circular gauge
///
maximum-number default-null
///
///Specify minimum scale value of circular gauge
///
minimum-number default-null
///
///Specify minorIntervalValue of circular gauge
///
minorIntervalValue-number default-2
///
///Specify opacity value of circular gauge
///
opacity-number default-1
///
///Specify pointer cap of circular gauge
///
pointerCap-any default-Object
///
///Specify cap backgroundColor of circular gauge
///
backgroundColor-string default-null
///
///Specify cap borderColor of circular gauge
///
borderColor-string default-null
///
///Specify pointerCap borderWidth value of circular gauge
///
borderWidth-number default-3
///
///Specify cap interiorGradient value of circular gauge
///
interiorGradient-any default-null
///
///Specify pointerCap Radius value of circular gauge
///
radius-number default-7
///
///Specify pointers value of circular gauge
///
pointers-Array<any> default-Array
///
///Specify backgroundColor for the pointer of circular gauge
///
backgroundColor-string default-null
///
///Specify backNeedleLength of circular gauge
///
backNeedleLength-number default-10
///
///Specify the border for pointers of circular gauge
///
border-any default-Object
///
///Specify border color for pointer of circular gauge
///
color-string default-null
///
///Specify border width for pointers of circular gauge
///
width-number default-1.5
///
///Specify distanceFromScale value for pointers of circular gauge
///
distanceFromScale-number default-0
///
///Specify pointer gradients of circular gauge
///
gradients-any default-null
///
///Specify pointer image of circular gauge.It is applicable for both marker as well as needle type pointers.
///
imageUrl-string default-NULL
///
///Specify pointer length of circular gauge
///
length-number default-150
///
///Specify marker Style value of circular gauge. See
///
markerType-ej.datavisualization.CircularGauge.MarkerType|string default-Rectangle
///
///Specify needle Style value of circular gauge. See
///
needleType-ej.datavisualization.CircularGauge.NeedleType|string default-Triangle
///
///Specify opacity value for pointer of circular gauge
///
opacity-number default-1
///
///Specify radius value for pointer of circular gauge
///
radius-number default-null
///
///Specify pointer Placement value of circular gauge. See PointerPlacement
///
placement-ej.datavisualization.CircularGauge.Placement|string default-Near
///
///Specify pointer value text of circular gauge.
///
pointerValueText-any default-Object
///
///Specify pointer text angle of circular gauge.
///
angle-number default-0
///
///Specify pointer text auto angle of circular gauge.
///
autoAngle-boolean default-false
///
///Specify pointer value text color of circular gauge.
///
color-string default-#8c8c8c
///
///Specify pointer value text distance from pointer of circular gauge.
///
distance-number default-20
///
///Specify pointer value text font option of circular gauge.
///
font-any default-object
///
///Specify pointer value text font family of circular gauge.
///
fontFamily-string default-Arial
///
///Specify pointer value text font style of circular gauge.
///
fontStyle-string default-Bold
///
///Specify pointer value text size of circular gauge.
///
size-string default-11px
///
///Specify pointer value text opacity of circular gauge.
///
opacity-number default-1
///
///enable pointer value text visibility of circular gauge.
///
showValue-boolean default-false
///
///Specify showBackNeedle value of circular gauge
///
showBackNeedle-boolean default-false
///
///Specify pointer type value of circular gauge. See
///
type-ej.datavisualization.CircularGauge.PointerType|string default-Needle
///
///Specify value of the pointer of circular gauge
///
value-number default-null
///
///Specify pointer width of circular gauge
///
width-number default-7
///
///Specify scale radius of circular gauge
///
radius-number default-170
///
///Specify ranges value of circular gauge
///
ranges-Array<any> default-Array
///
///Specify backgroundColor for the ranges of circular gauge
///
backgroundColor-string default-#32b3c6
///
///Specify text for the ranges of circular gauge
///
legendText-string default-null
///
///Specify border for ranges of circular gauge
///
border-any default-Object
///
///Specify border color for ranges of circular gauge
///
color-string default-#32b3c6
///
///Specify border width for ranges of circular gauge
///
width-number default-1.5
///
///Specify distanceFromScale value for ranges of circular gauge
///
distanceFromScale-number default-25
///
///Specify endValue for ranges of circular gauge
///
endValue-number default-null
///
///Specify endWidth for ranges of circular gauge
///
endWidth-number default-10
///
///Specify range gradients of circular gauge
///
gradients-any default-null
///
///Specify opacity value for ranges of circular gauge
///
opacity-number default-null
///
///Specify placement of circular gauge. See RangePlacement
///
placement-ej.datavisualization.CircularGauge.Placement|string default-Near
///
///Specify size of the range value of circular gauge
///
size-number default-5
///
///Specify startValue for ranges of circular gauge
///
startValue-number default-null
///
///Specify startWidth of circular gauge
///
startWidth-number default-[Array.number] scale.ranges.startWidth = 10
///
///Specify shadowOffset value of circular gauge
///
shadowOffset-number default-0
///
///Specify showIndicators of circular gauge
///
showIndicators-boolean default-false
///
///Specify showLabels of circular gauge
///
showLabels-boolean default-true
///
///Specify showPointers of circular gauge
///
showPointers-boolean default-true
///
///Specify showRanges of circular gauge
///
showRanges-boolean default-false
///
///Specify showScaleBar of circular gauge
///
showScaleBar-boolean default-false
///
///Specify showTicks of circular gauge
///
showTicks-boolean default-true
///
///Specify scaleBar size of circular gauge
///
size-number default-6
///
///Specify startAngle of circular gauge
///
startAngle-number default-115
///
///Specify subGauge of circular gauge
///
subGauges-Array<any> default-Array
///
///Specify subGauge Height of circular gauge
///
height-number default-150
///
///Specify position for sub-gauge of circular gauge
///
position-any default-Object
///
///Specify x-axis position for sub-gauge of circular gauge
///
x-number default-0
///
///Specify y-axis position for sub-gauge of circular gauge
///
y-number default-0
///
///Specify subGauge Width of circular gauge
///
width-number default-150
///
///Specify sweepAngle of circular gauge
///
sweepAngle-number default-310
///
///Specify ticks of circular gauge
///
ticks-Array<any> default-Array
///
///Specify the angle for the ticks of circular gauge
///
angle-number default-0
///
///Specify tick color of circular gauge
///
color-string default-null
///
///Specify distanceFromScale value for ticks of circular gauge
///
distanceFromScale-number default-0
///
///Specify tick height of circular gauge
///
height-number default-16
///
///Specify tick placement of circular gauge. See TickPlacement
///
placement-ej.datavisualization.CircularGauge.Placement|string default-Near
///
///Specify tick Style of circular gauge. See TickType
///
type-ej.datavisualization.CircularGauge.LabelType|string default-Major
///
///Specify tick width of circular gauge
///
width-number default-3
///
///Specify the theme of circular gauge.
///
theme-string default-flatlight
///
///Options to customize the legend.
///
legend-Legend default-
///
///Toggles the visibility of the legend.
///
visible-boolean default-false
///
///Toggles the visibility of the ranges.
///
toggleVisibility-boolean default-true
///
///Specifies the alignment of the legend.
///
alignment-ej.datavisualization.CircularGauge.LegendAlignment|string default-Center. See Alignment
///
///Options for customizing the legend border.
///
border-any default-
///
///Border color of the legend.
///
color-string default-transparent
///
///Border width of the legend.
///
width-number default-1
///
///Fill color for the legend items. By using this property, it displays all legend item shapes in same color.Legend items representing invisible ranges is displayed in gray color.
///
fill-string default-null
///
///Gap or padding between the legend items.
///
itemPadding-number default-20
///
///Options to customize the style of legend items.
///
itemStyle-any default-
///
///Options for customizing the border of legend items.
///
border-any default-
///
///Border color of the legend items.
///
color-string default-transparent
///
///Border width of the legend items.
///
width-number default-1
///
///Specifies the height of the legend item shapes.
///
height-number default-10
///
///Specifies the width of the legend item shapes.
///
width-number default-10
///
///Opacity of the legend.
///
opacity-number default-1
///
///Places the legend at specified position. Legend can be placed at **left**, **right**, **top** or **bottom** of the circular gauge.
///
position-ej.datavisualization.CircularGauge.LegendPosition|string default-Bottom. See Position
///
///Shape of the legend items.
///
shape-ej.datavisualization.CircularGauge.LegendShape|string default-Circle. See Shape
///
///Options to customize the size of the legend.
///
size-any default-
///
///Specify the height of the legend. Height can be specified in pixel.
///
height-string default-null
///
///Specify the width of the legend. Width can be specified in pixel.
///
width-string default-null
///
///Options to customize the font used for legend item text.
///
font-any default-
///
///Font family for legend item text.
///
fontFamily-string default-Segoe UI
///
///Font style for legend item text.
///
fontStyle-string default-Normal
///
///Font weight for legend item text.
///
fontWeight-string default-Regular
///
///Font size for legend item text.
///
size-string default-12px
///
///Font color of the text for legend items.
///
color-string default-null
///
///Specify tooltip option of circular gauge
///
tooltip-Tooltip default-object
///
///enable showCustomLabelTooltip of circular gauge
///
showCustomLabelTooltip-boolean default-false
///
///enable showLabelTooltip of circular gauge
///
showLabelTooltip-boolean default-false
///
///Specify tooltip templateID of circular gauge
///
templateID-string default-false
///
///Specifies the value of circular gauge.
///
value-number default-0
///
///Specifies the width of circular gauge.
///
width-number default-360
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
ColorPicker:function(){
///
/// Constructor of ej.ColorPicker
///
}
});
ej.ColorPicker=(function(){
var original=ej.ColorPicker
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
disable:function(){
///
///
/// Disables the color picker control
///
},
enable:function(){
///
///
/// Enable the color picker control
///
},
getColor:function(){
///
///
/// Gets the selected color in RGB format
///
},
getValue:function(){
///
///
/// Gets the selected color value as string
///
},
hexCodeToRGB:function(colorCode){
///
///
/// To Convert color value from hexCode to RGB
///
/// Specified HEX code converted to RGB
///
},
hide:function(){
///
///
/// Hides the ColorPicker popup, if in opened state.
///
},
HSVToRGB:function(HSV){
///
///
/// Convert color value from HSV to RGB
///
/// Specified HSV code converted to RGB
///
},
RGBToHEX:function(RGB){
///
///
/// Convert color value from RGB to HEX
///
/// Specified RGB code converted to HEX code
///
},
RGBToHSV:function(RGB){
///
///
/// Convert color value from RGB to HSV
///
/// Specified RGB code converted to HSV code
///
},
show:function(){
///
///
/// Open the ColorPicker popup.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejColorPicker=function(){
this.data("ejColorPicker",new ej.ColorPicker());
return this;
};
intellisense.annotate(jQuery.fn,{
ejColorPicker :function (options) {
///
///
///The ColorPicker control provides you a rich visual interface for color selection. You can select the color from the professionally designed palettes or custom color. By clicking a point on the color, you can change the active color to the color that is located under the pointer.
///The ColorPicker control allows to define the customized text to displayed in button elements. Using the property to achieve the customized culture values.
///
buttonText-ButtonText default-{ apply: Apply, cancel: Cancel, swatches: Swatches }
///
///Sets the text for the apply button.
///
apply-string default-
///
///Sets the text for the cancel button.
///
cancel-string default-
///
///Sets the header text for the swatches area.
///
swatches-string default-
///
///Allows to change the mode of the button. Please refer below to know available button mode
///
buttonMode-ej.ButtonMode|string default-ej.ButtonMode.Split
///
///Specifies the number of columns to be displayed color palette model.
///
columns-number|string default-10
///
///This property allows you to customize its appearance using user-defined CSS and custom skin options such as colors and backgrounds.
///
cssClass-string default-
///
///This property allows to define the custom colors in the palette model.Custom palettes are created by passing a comma delimited string of HEX values or an array of colors.
///
custom-Array<any> default-empty
///
///This property allows to embed the popup in the order of DOM element flow . When we set the value as true, the color picker popup is always in visible state.
///
displayInline-boolean default-false
///
///This property allows to change the control in enabled or disabled state.
///
enabled-boolean default-true
///
///This property allows to enable or disable the opacity slider in the color picker control
///
enableOpacity-boolean default-true
///
///It allows to define the characteristics of the ColorPicker control. It will helps to extend the capability of an HTML element.
///
htmlAttributes-any default-{}
///
///Defines the localized text values in button and tooltip.
///
locale-string default-en-US
///
///Specifies the model type to be rendered initially in the color picker control. See below to get available ModelType
///
modelType-ej.ColorPicker.ModelType|string default-ej.ColorPicker.ModelType.Default
///
///This property allows to change the opacity value .The selected color opacity will be adjusted by using this opacity value.
///
opacityValue-number|string default-100
///
///Specifies the palette type to be displayed at initial time in palette model.There two types of palette model available in ColorPicker control. See below available Palette
///
palette-ej.ColorPicker.Palette|string default-ej.ColorPicker.Palette.BasicPalette
///
///This property allows to define the preset model to be rendered initially in palette type.It consists of 12 different types of presets. Each presets have 50 colors. See below available Presets
///
presetType-ej.ColorPicker.Presets|string default-ej.ColorPicker.Presets.Basic
///
///Allows to show/hides the apply and cancel buttons in ColorPicker control
///
showApplyCancel-boolean default-true
///
///Allows to show/hides the clear button in ColorPicker control
///
showClearButton-boolean default-true
///
///This property allows to provides live preview support for current cursor selection color and selected color.
///
showPreview-boolean default-true
///
///This property allows to store the color values in custom list.The ColorPicker will keep up to 11 colors in a custom list.By clicking the add button, the selected color from picker or palette will get added in the recent color list.
///
showRecentColors-boolean default-false
///
///Allows to show/hides the switcher button in ColorPicker control.It helps to switch palette or picker mode in colorpicker.
///
showSwitcher-boolean default-true
///
///This property allows to shows tooltip to notify the slider value in color picker control.
///
showTooltip-boolean default-false
///
///Specifies the toolIcon to be displayed in dropdown control color area.
///
toolIcon-string default-null
///
///This property allows to define the customized text or content to displayed when mouse over the following elements. This property also allows to use the culture values.
///
tooltipText-TooltipText default-{ switcher: Switcher, addButton: Add Color, basic: Basic, monoChrome: Mono Chrome, flatColors: Flat Color, seaWolf: Sea Wolf, webColors: Web Colors, sandy: Sandy, pinkShades: Pink Shades, misty: Misty, citrus: Citrus, vintage: Vintage, moonLight: Moon Light, candyCrush: Candy Crush, currentColor: Current Color, selectedColor: Selected Color }
///
///Sets the tooltip text for the switcher button.
///
switcher-string default-
///
///Sets the tooltip text for the add button.
///
addButton-string default-
///
///Sets the tooltip text for the basic preset.
///
basic-string default-
///
///Sets the tooltip text for the mono chrome preset.
///
monoChrome-string default-
///
///Sets the tooltip text for the flat colors preset.
///
flatColors-string default-
///
///Sets the tooltip text for the sea wolf preset.
///
seaWolf-string default-
///
///Sets the tooltip text for the web colors preset.
///
webColors-string default-
///
///Sets the tooltip text for the sandy preset.
///
sandy-string default-
///
///Sets the tooltip text for the pink shades preset.
///
pinkShades-string default-
///
///Sets the tooltip text for the misty preset.
///
misty-string default-
///
///Sets the tooltip text for the citrus preset.
///
citrus-string default-
///
///Sets the tooltip text for the vintage preset.
///
vintage-string default-
///
///Sets the tooltip text for the moon light preset.
///
moonLight-string default-
///
///Sets the tooltip text for the candy crush preset.
///
candyCrush-string default-
///
///Sets the tooltip text for the current color area.
///
currentColor-string default-
///
///Sets the tooltip text for the selected color area.
///
selectedColor-string default-
///
///Specifies the color value for color picker control, the value is in hexadecimal form with prefix of "#".
///
value-string default-null
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
ComboBox:function(){
///
/// Constructor of ej.ComboBox
///
}
});
ej.ComboBox=(function(){
var original=ej.ComboBox
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
addItem:function(){
///
///
/// Adds a new item to the popup list. By default, new item appends to the list as the last item, but you can insert based on the index parameter.
///
},
focusIn:function(){
///
///
/// Sets the focus to the component for interaction.
///
},
focusOut:function(){
///
///
/// Moves the focus from the component if the component is already focused.
///
},
getDataByValue:function(){
///
///
/// Gets the data object that matches the given value.
///
},
getItems:function(){
///
///
/// Gets all the list items bound on this component.
///
},
hidePopup:function(){
///
///
/// Hides the popup if it is in open state.
///
},
showPopup:function(){
///
///
/// Opens the popup that displays the list of items.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejComboBox=function(){
this.data("ejComboBox",new ej.ComboBox());
return this;
};
intellisense.annotate(jQuery.fn,{
ejComboBox :function (options) {
///
///
///The ComboBox component allows the user to type a value or choose an option from the list of predefined options.
///Accepts the template and assigns it to the popup list content of the component when the data fetch request from the remote server fails.
///
actionFailureTemplate-string default-The Request Failed
///
///Specifies whether the component allows user defined value which does not exist in data source.
///
allowCustom-boolean default-true
///
///When allowFiltering is set to true, show the filter bar (search box) of the component. The filter action retrieves matched items through the filtering event based on the characters typed in the search TextBox. If no match is found, the value of the noRecordsTemplate property will be displayed.
///
allowFiltering-boolean default-false
///
///Specifies whether suggest a first matched item in input when searching. No action happens when no matches found.
///
autofill-boolean default-false
///
///Sets CSS classes to the root element of the component that helps customize the UI styles.
///
cssClass-string default-null
///
///Accepts the list items either through local or remote service and binds it to the component. It can be an array of JSON objects or an instance of DataManager.
///
dataSource-any|Array<any> default-[]
///
///When set to true, enables RTL mode of the component that displays the content in the right-to-left direction.
///
enableRtl-boolean default-false
///
///Specifies a value that indicates whether the component is enabled or not.
///
enabled-boolean default-true
///
///The fields property maps the columns of the data table and binds the data to the component.
///
fields-Fields default-
///
///Used to group the popup list items.
///
groupBy-string default-null
///
///Defines class for the item.
///
iconCss-string default-null
///
///Defines the specific field name which contains unique values for the list items.
///
value-string default-null
///
///Defines the specific field name in the data source to load the popup list with data.
///
text-string default-null
///
///Accepts the template design and assigns it to the footer container of the popup list.
///
footerTemplate-string default-null
///
///Accepts the template design and assigns it to the group headers present in the popup list.
///
groupTemplate-string default-null
///
///Accepts the template design and assigns it to the header container of the popup list.
///
headerTemplate-string default-null
///
///Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
///
htmlAttributes-any default-{}
///
///Gets or sets the index of the selected item in the component.
///
index-number default-null
///
///Accepts the template design and assigns it to each list item present in the popup.
///
itemTemplate-string default-null
///
///Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
///
locale-string default-en-US
///
///Accepts the template design and assigns it to popup list of component when no data is available on the component.
///
noRecordsTemplate-string default-No Records Found
///
///Accepts the value to be displayed as a watermark text on the component input.
///
placeholder-string default-null
///
///Specifies the height of the popup list.
///
popupHeight-string|number default-300px
///
///Specifies the width of the popup list. By default, the popup width sets based on the width of the component.
///
popupWidth-string|number default-100%
///
///The query to retrieve the data from the data source.
///
query-ej.Query default-null
///
///When set to true, the user interactions on the component are disabled.
///
readonly-boolean default-false
///
///Specifies whether to show or hide the clear button. When the clear button is clicked, value, text, and index properties are reset to null.
///
showClearButton-boolean default-true
///
///Specifies the sortOrder to sort the data source. The available type of sort orders are
///
sortOrder-ej.ComboBox.SortOrder|string default-ej.SortOrder.None
///
///Gets or sets the display text of the selected item in the component.
///
text-string default-null
///
///Gets or sets the value of the selected item in the component.
///
value-number|string default-null
///
///Specifies the width of the component. By default, the component width sets based on the width of its parent container. You can also set the width in pixel values.
///
width-number|string default-100%
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
DataManager:function(){
///
/// Constructor of ej.DataManager
///
}
});
ej.DataManager=(function(){
var original=ej.DataManager
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
executeLocal:function(query){
///
///
/// This method does not execute more than one operation at a time; it waits for one operation to complete, and then executes the next operation.
///
/// Sets the default query for the data source.
///
},
executeQuery:function(query, done, fail, always){
///
///
/// The executeQuery property is used to process the data based on the query on URL Binding.
///
/// Sets the default query for the data source.
///
///
///
/// The executeQuery property is used to process the data based on the query on URL Binding.
///
/// A function to be called if the request succeeds.
///
///
///
/// The executeQuery property is used to process the data based on the query on URL Binding.
///
/// A function to be called if the request fails.
///
///
///
/// The executeQuery property is used to process the data based on the query on URL Binding.
///
/// A function to be called when the request finishes (after success and error callbacks are executed).
///
},
insert:function(data, tableName, query){
///
///
/// Inserts a data item in the data table.
///
/// JSON data or JSON array
///
///
///
/// Inserts a data item in the data table.
///
/// Name of the table
///
///
///
/// Inserts a data item in the data table.
///
/// Sets the default query for the data source.
///
},
remove:function(keyField, value, tableName, query){
///
///
/// It is used to remove the data from the dataSource.
///
/// KeyColumn to find the data
///
///
///
/// It is used to remove the data from the dataSource.
///
/// Specified value for the keyField
///
///
///
/// It is used to remove the data from the dataSource.
///
/// Name of the source table
///
///
///
/// It is used to remove the data from the dataSource.
///
/// Sets the default query for the data source.
///
},
saveChanges:function(changes, key, tableName, query){
///
///
/// This method is used to save the changes to the corresponding table. You can add a new record, edit an existing record, or delete a record by using this method.
///
/// Specified values for the Data Table
///
///
///
/// This method is used to save the changes to the corresponding table. You can add a new record, edit an existing record, or delete a record by using this method.
///
/// KeyColumn to find the data
///
///
///
/// This method is used to save the changes to the corresponding table. You can add a new record, edit an existing record, or delete a record by using this method.
///
/// Name of the source table
///
///
///
/// This method is used to save the changes to the corresponding table. You can add a new record, edit an existing record, or delete a record by using this method.
///
/// Sets the default query for the data source.
///
},
update:function(keyField, value, tableName, query){
///
///
/// Updates existing record and saves the changes to the table.
///
/// KeyColumn to find the data
///
///
///
/// Updates existing record and saves the changes to the table.
///
/// Specified value for the keyField
///
///
///
/// Updates existing record and saves the changes to the table.
///
/// Name of the source table
///
///
///
/// Updates existing record and saves the changes to the table.
///
/// Sets the default query for the data source.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDataManager=function(){
this.data("ejDataManager",new ej.DataManager());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDataManager :function (options) {
///
///
///Communicates with data source and returns the desired result based on the Query provided.
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
DatePicker:function(){
///
/// Constructor of ej.DatePicker
///
}
});
ej.DatePicker=(function(){
var original=ej.DatePicker
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
disable:function(){
///
///
/// Disables the DatePicker control.
///
},
enable:function(){
///
///
/// Enable the DatePicker control, if it is in disabled state.
///
},
getValue:function(){
///
///
/// Returns the current date value in the DatePicker control.
///
},
setValue:function(){
///
///
/// sets the date value for the DatePicker.
///
},
hide:function(){
///
///
/// Close the DatePicker popup, if it is in opened state.
///
},
show:function(){
///
///
/// Opens the DatePicker popup.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDatePicker=function(){
this.data("ejDatePicker",new ej.DatePicker());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDatePicker :function (options) {
///
///
///Input field that display the DatePicker calendar as popup to select and set the date value
///Used to allow or restrict the editing in DatePicker input field directly. By setting false to this API, You can only pick the date from DatePicker popup.
///
allowEdit-boolean default-true
///
///allow or restrict the drill down to multiple levels of view (month/year/decade) in DatePicker calendar
///
allowDrillDown-boolean default-true
///
///Disable the list of specified date value.
///
blackoutDates-any default-{}
///
///Sets the specified text value to the today button in the DatePicker calendar.
///
buttonText-string default-Today
///
///Sets the root CSS class for DatePicker theme, which is used customize.
///
cssClass-string default-
///
///Formats the value of the DatePicker in to the specified date format. If this API is not specified, dateFormat will be set based on the current culture of DatePicker.
///
dateFormat-string default-MM/dd/yyyy
///
///Specifies the header format of days in DatePicker calendar. See below to get available Headers options
///
dayHeaderFormat-string | ej.DatePicker.Header default-ej.DatePicker.Header.Short
///
///Specifies the navigation depth level in DatePicker calendar. This option is not applied when start level view option is lower than depth level view. See below to know available levels in DatePicker Calendar
///
depthLevel-string | ej.DatePicker.Level default-
///
///Allows to embed the DatePicker calendar in the page. Also associates DatePicker with div element instead of input.
///
displayInline-boolean default-false
///
///Enables or disables the animation effect with DatePicker calendar.
///
enableAnimation-boolean default-true
///
///Enable or disable the DatePicker control.
///
enabled-boolean default-true
///
///Sustain the entire widget model of DatePicker even after form post or browser refresh
///
enablePersistence-boolean default-false
///
///Displays DatePicker calendar along with DatePicker input field in Right to Left direction.
///
enableRTL-boolean default-false
///
///Allows to enter valid or invalid date in input textbox and indicate as error if it is invalid value, when this API value is set to true. For false value, invalid date is not allowed to input field and corrected to valid date automatically, even if invalid date is given.
///
enableStrictMode-boolean default-false
///
///Used the required fields for special Dates in DatePicker in order to customize the special dates in a calendar.
///
fields-Fields default-null
///
///Specifies the specials dates
///
date-string default-
///
///Specifies the icon class to special dates.
///
iconClass-string default-
///
///Specifies the tooltip to special dates.
///
tooltip-string default-
///
///Specifies the CSS class to customize the date.
///
cssClass-string default-
///
///Specifies the header format to be displayed in the DatePicker calendar.
///
headerFormat-string default-MMMM yyyy
///
///Specifies the height of the DatePicker input text.
///
height-string default-28px
///
///HighlightSection is used to highlight currently selected date's month/week/workdays. See below to get available HighlightSection options
///
highlightSection-string | ej.DatePicker.HighlightSection default-none
///
///Weekend dates will be highlighted when this property is set to true.
///
highlightWeekend-boolean default-false
///
///Specifies the HTML Attributes of the DatePicker.
///
htmlAttributes-any default-{}
///
///Change the DatePicker calendar and date format based on given culture.
///
locale-string default-en-US
///
///Specifies the maximum date in the calendar that the user can select.
///
maxDate-string|Date default-new Date(2099, 11, 31)
///
///Specifies the minimum date in the calendar that the user can select.
///
minDate-string|Date default-new Date(1900, 00, 01)
///
///Allows to toggles the read only state of the DatePicker. When the widget is readOnly, it doesn't allow your input.
///
readOnly-boolean default-false
///
///It allow to show/hide the disabled date ranges
///
showDisabledRange-boolean default-true
///
///It allows to display footer in DatePicker calendar.
///
showFooter-boolean default-true
///
///It allows to display/hides the other months days from the current month calendar in a DatePicker.
///
showOtherMonths-boolean default-true
///
///Shows/hides the date icon button at right side of textbox, which is used to open or close the DatePicker calendar popup.
///
showPopupButton-boolean default-true
///
///DatePicker input is displayed with rounded corner when this property is set to true.
///
showRoundedCorner-boolean default-false
///
///Used to show the tooltip when hovering on the days in the DatePicker calendar.
///
showTooltip-boolean default-true
///
///Specifies the special dates in DatePicker.
///
specialDates-any default-null
///
///Specifies the start day of the week in DatePicker calendar.
///
startDay-number default-0
///
///Specifies the start level view in DatePicker calendar. See below available Levels
///
startLevel-string | ej.DatePicker.Level default-ej.DatePicker.Level.Month
///
///Specifies the number of months to be navigate for one click of next and previous button in a DatePicker Calendar.
///
stepMonths-number default-1
///
///Provides option to customize the tooltip format.
///
tooltipFormat-string default-ddd MMM dd yyyy
///
///Sets the jQuery validation support to DatePicker Date value. See validation
///
validationMessage-any default-null
///
///Sets the jQuery validation custom rules to the DatePicker. see validation
///
validationRules-any default-null
///
///sets or returns the current value of DatePicker
///
value-string|Date default-null
///
///Specifies the water mark text to be displayed in input text.
///
watermarkText-string default-Select date
///
///Allows to embed a new column with the calendar in the popup, which will display the week number of every week in a calendar year.
///
weekNumber-boolean default-false
///
///Specifies the width of the DatePicker input text.
///
width-string default-160px
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
DateRangePicker:function(){
///
/// Constructor of ej.DateRangePicker
///
}
});
ej.DateRangePicker=(function(){
var original=ej.DateRangePicker
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
addRanges:function(label, range){
///
///
/// Add the preset ranges to DateRangePicker popup.
///
/// Display name
///
///
///
/// Add the preset ranges to DateRangePicker popup.
///
/// StartDate and endDate of range.
///
},
clearRanges:function(){
///
///
/// Clears the all ranges selections in DateRangePicker popup
///
},
disable:function(){
///
///
/// Disables the DateRangePicker control.
///
},
enable:function(){
///
///
/// Enable the DateRangePicker control, if it is in disabled state.
///
},
getSelectedRange:function(){
///
///
/// Returns the startDate and endDate values in the selected ranges in the DateRangePicker control.
///
},
popupHide:function(){
///
///
/// Close the DateRangePicker popup, if it is in opened state.
///
},
popupShow:function(){
///
///
/// Opens the DateRangePicker popup.
///
},
setRange:function(){
///
///
/// set the preset ranges to DateRangePicker popup.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDateRangePicker=function(){
this.data("ejDateRangePicker",new ej.DateRangePicker());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDateRangePicker :function (options) {
///
///
///Input field that displays the two DatePicker type calendar in a single popup to select and set the different date ranges
///Used to allow or restrict the editing in DateRangePicker input field directly. By setting false to this API, You can only pick the date ranges from DateRangePicker popup.
///
allowEdit-boolean default-true
///
///Sets the specified text value to the available buttons (Reset, Cancel, Apply) in the DateRangePicker popup.
///
buttonText-any default-{ reset: Reset, cancel: Cancel, apply: Apply}
///
///Sets the root CSS class for DateRangePicker theme, which is used to customize.
///
cssClass-string default-
///
///Formats the date value of the DateRangePicker in to the specified date format. If this API is not specified, dateFormat will be set based on the current culture of DateRangePicker.
///
dateFormat-string default-MM/dd/yyyy
///
///Allows to embed the Timepicker align with the calendars in the page, two timepicker will be render, for selecting start and end date.
///
enableTimePicker-boolean default-false
///
///Enable or disable the DateRangePicker control.
///
enabled-boolean default-true
///
///Sustain the entire widget model of DateRangePicker even after form post or browser refresh
///
enablePersistence-boolean default-false
///
///Specifies the end date of the date ranges.
///
endDate-string|Date default-null
///
///Specifies the height of the DateRangePicker input.
///
height-string|number default-28px
///
///Change the DateRangePicker calendar and date format based on given culture.
///
locale-string default-en-US
///
///Specifies the maximum date in the calendar that the user can select as a startDate or endDate.
///
maxDate-string|Date default-new Date(2099, 11, 31)
///
///Specifies the minimum date in the calendar that the user can select as a startDate or endDate.
///
minDate-string|Date default-new Date(1900, 00, 01)
///
///Used to add the preset ranges. Added ranges using this, will show in popup in right side for easy selection of different preset ranges.
///
ranges-any default-null
///
///Used to separate the two date strings of the value in the DateRangePicker popup.
///
separator-string default--
///
///Specifies the start date of the date ranges
///
startDate-string|Date default-null
///
///Shows/hides the date icon button at right side of textbox, which is used to open or close the DateRangePicker calendar popup.
///
showPopupButton-boolean default-true
///
///DateRangePicker input and popup is displayed with rounded corner when this property is set to true.
///
showRoundedCorner-boolean default-false
///
///Formats the date value of the DateRangePicker in to the specified time format. If this API is not specified, timeFormat will be set based on the current culture of DateRangePicker.
///
timeFormat-string default-HH:mm tt
///
///Separated two date values in string format to sets the date ranges in calendars.
///
value-string default-null
///
///Specifies the water mark text to be displayed in input text.
///
watermarkText-string default-Select Range
///
///Specifies the width of the DateRangePicker input text.
///
width-string|number default-160px
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
DateTimePicker:function(){
///
/// Constructor of ej.DateTimePicker
///
}
});
ej.DateTimePicker=(function(){
var original=ej.DateTimePicker
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
disable:function(){
///
///
/// Disables the DateTimePicker control.
///
},
enable:function(){
///
///
/// Enables the DateTimePicker control.
///
},
getValue:function(){
///
///
/// Returns the current datetime value in the DateTimePicker.
///
},
hide:function(){
///
///
/// Hides or closes the DateTimePicker popup.
///
},
setCurrentDateTime:function(){
///
///
/// Updates the current system date value and time value to the DateTimePicker.
///
},
show:function(){
///
///
/// Shows or opens the DateTimePicker popup.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDateTimePicker=function(){
this.data("ejDateTimePicker",new ej.DateTimePicker());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDateTimePicker :function (options) {
///
///
///The DateTimePicker control is used to input the date and time with a specific format. It combines the DatePicker and TimePicker controls so that users can select the date and time with their desired format.
///Used to allow or restrict the editing in DateTimePicker input field directly. By setting false to this API, You can only pick the date and time values from DateTimePicker popup.
///
allowEdit-boolean default-true
///
///Displays the custom text for the buttons inside the DateTimePicker popup. when the culture value changed, we can change the buttons text based on the culture.
///
buttonText-ButtonText default-{ today: Today, timeNow: Time Now, done: Done, timeTitle: Time }
///
///Sets the text for the Done button inside the datetime popup.
///
done-string default-
///
///Sets the text for the Now button inside the datetime popup.
///
timeNow-string default-
///
///Sets the header text for the Time dropdown.
///
timeTitle-string default-
///
///Sets the text for the Today button inside the datetime popup.
///
today-string default-
///
///Disable the list of specified date value.
///
blackoutDates-any default-{}
///
///Set the root class for DateTimePicker theme. This cssClass API helps to use custom skinning option for DateTimePicker control.
///
cssClass-string default-
///
///Defines the datetime format displayed in the DateTimePicker. The value should be a combination of date format and time format.
///
dateTimeFormat-string default-M/d/yyyy h:mm tt
///
///Specifies the header format of the datepicker inside the DateTimePicker popup. See DatePicker.Header
///
dayHeaderFormat-ej.DatePicker.Header|string default-ej.DatePicker.Header.Short
///
///Specifies the navigation depth level in DatePicker calendar inside DateTimePicker popup. This option is not applied when start level view option is lower than depth level view. See ej.DatePicker.Level
///
depthLevel-ej.DatePicker.Level|string default-
///
///Specifies the list of time range to be disabled.
///
disableTimeRanges-any default-{}
///
///Enable or disable the animation effect in DateTimePicker.
///
enableAnimation-boolean default-true
///
///When this property is set to false, it disables the DateTimePicker control.
///
enabled-boolean default-false
///
///Enables or disables the state maintenance of DateTimePicker.
///
enablePersistence-boolean default-false
///
///Sets the DateTimePicker direction as right to left alignment.
///
enableRTL-boolean default-false
///
///When enableStrictMode true it allows the value outside of the range also but it highlights the textbox with error class, otherwise it internally changed to the correct value.
///
enableStrictMode-boolean default-false
///
///Specifies the header format to be displayed in the DatePicker calendar inside the DateTimePicker popup.
///
headerFormat-string default-MMMM yyyy
///
///Defines the height of the DateTimePicker textbox.
///
height-string|number default-30
///
///Specifies the HTML Attributes of the ejDateTimePicker
///
htmlAttributes-any default-{}
///
///Sets the time interval between the two adjacent time values in the time popup.
///
interval-number default-30
///
///Defines the localization culture for DateTimePicker.
///
locale-string default-en-US
///
///Sets the maximum value to the DateTimePicker. Beyond the maximum value an error class is added to the wrapper element when we set true to enableStrictMode.
///
maxDateTime-string|Date default-new Date(12/31/2099 11:59:59 PM)
///
///Sets the minimum value to the DateTimePicker. Behind the minimum value an error class is added to the wrapper element.
///
minDateTime-string|Date default-new Date(1/1/1900 12:00:00 AM)
///
///Specifies the popup position of DateTimePicker.See below to know available popup positions
///
popupPosition-string | ej.popupPosition default-ej.PopupPosition.Bottom
///
///Indicates that the DateTimePicker value can only be read and can’t change.
///
readOnly-boolean default-false
///
///It allows showing days in other months of DatePicker calendar inside the DateTimePicker popup.
///
showOtherMonths-boolean default-true
///
///Shows or hides the arrow button from the DateTimePicker textbox. When the button disabled, the DateTimePicker popup opens while focus in the textbox and hides while focus out from the textbox.
///
showPopupButton-boolean default-true
///
///Changes the sharped edges into rounded corner for the DateTimePicker textbox and popup.
///
showRoundedCorner-boolean default-false
///
///Specifies the special dates in DateTimePicker.
///
specialDates-any default-null
///
///Specifies the start day of the week in datepicker inside the DateTimePicker popup.
///
startDay-number default-1
///
///Specifies the start level view in datepicker inside the DateTimePicker popup. See DatePicker.Level
///
startLevel-ej.DatePicker.Level|string default-ej.DatePicker.Level.Month or month
///
///Specifies the number of months to navigate at one click of next and previous button in datepicker inside the DateTimePicker popup.
///
stepMonths-number default-1
///
///Defines the time format displayed in the time dropdown inside the DateTimePicker popup.
///
timeDisplayFormat-string default-h:mm tt
///
///We can drill down up to time interval on selected date with meridian details.
///
timeDrillDown-TimeDrillDown default-{ enabled: false, interval: 5, showMeridian: false, autoClose: true }
///
///This is the field to show/hide the timeDrillDown in DateTimePicker.
///
enabled-boolean default-
///
///Sets the interval time of minutes on selected date.
///
interval-number default-
///
///Allows the user to show or hide the meridian with time in DateTimePicker.
///
showMeridian-boolean default-
///
///After choosing the time, the popup will close automatically if we set it as true, otherwise we focus out the DateTimePicker or choose timeNow button for closing the popup.
///
autoClose-boolean default-
///
///Defines the width of the time dropdown inside the DateTimePicker popup.
///
timePopupWidth-string|number default-100
///
///Set the jQuery validation error message in DateTimePicker.
///
validationMessage-any default-null
///
///Set the jQuery validation rules in DateTimePicker.
///
validationRules-any default-null
///
///Sets the DateTime value to the control.
///
value-string|Date default-
///
///Specifies the water mark text to be displayed in input text.
///
watermarkText-string default-Select date and time
///
///Defines the width of the DateTimePicker textbox.
///
width-string|number default-143
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Diagram:function(){
///
/// Constructor of ej.Diagram
///
}
});
ej.Diagram=(function(){
var original=ej.Diagram
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
add:function(node){
///
///
/// Add nodes and connectors to diagram at runtime
///
/// a JSON to define a node/connector or an array of nodes and connector
///
},
addLabel:function(nodeName, newLabel){
///
///
/// Add a label to a node at runtime
///
/// name of the node to which label will be added
///
///
///
/// Add a label to a node at runtime
///
/// JSON for the new label to be added
///
},
addLane:function(lane, index){
///
///
/// Add dynamic Lanes to swimlane at runtime
///
/// JSON for the new lane to be added
///
///
///
/// Add dynamic Lanes to swimlane at runtime
///
/// Index value to add the lane in swimlane
///
},
addPhase:function(name, options){
///
///
/// Add a phase to a swimlane at runtime
///
/// name of the swimlane to which the phase will be added
///
///
///
/// Add a phase to a swimlane at runtime
///
/// JSON object to define the phase to be added
///
},
addLayers:function(layers){
///
///
/// Add a collection of layers can be added to the existing diagram layer at runtime.
///
/// a collection of layers to be added to the existing diagram layers.
///
},
addNodeToLayer:function(layerName, nodes){
///
///
/// Add a collection of diagram elements can be added to the specific diagram layer.
///
/// specifies the name of the layer to the nodes will be added.
///
///
///
/// Add a collection of diagram elements can be added to the specific diagram layer.
///
/// collection of diagram elements to be added to the specific layer.
///
},
addPorts:function(name, ports){
///
///
/// Add a collection of ports to the node specified by name
///
/// name of the node to which the ports have to be added
///
///
///
/// Add a collection of ports to the node specified by name
///
/// a collection of ports to be added to the specified node
///
},
addSelection:function(node, clearSelection){
///
///
/// Add the specified node to selection list
///
/// the node to be selected
///
///
///
/// Add the specified node to selection list
///
/// to define whether to clear the existing selection or not
///
},
align:function(direction){
///
///
/// Align the selected objects based on the reference object and direction
///
/// to specify the direction towards which the selected objects are to be aligned("left","right",top","bottom")
///
},
bringIntoView:function(rect){
///
///
/// Bring the specified portion of the diagram content to the diagram viewport
///
/// the rectangular region that is to be brought into diagram viewport
///
},
bringToCenter:function(rect){
///
///
/// Bring the specified portion of the diagram content to the center of the diagram viewport
///
/// the rectangular region that is to be brought to the center of diagram viewport
///
},
bringToFront:function(){
///
///
/// Visually move the selected object over all other intersected objects
///
},
clear:function(){
///
///
/// Remove all the elements from diagram
///
},
clearHistory:function(){
///
///
/// Clears the actions which is recorded to perform undo/redo operation in the diagram.
///
},
clearSelection:function(){
///
///
/// Remove the current selection in diagram
///
},
copy:function(){
///
///
/// Copy the selected object to internal clipboard and get the copied object
///
},
cut:function(){
///
///
/// Cut the selected object from diagram to diagram internal clipboard
///
},
exportDiagram:function(options){
///
///
/// Export the diagram as downloadable files or as data
///
/// options to export the desired region of diagram to the desired formats.
///
},
exportImage:function(image, exportImageSettings){
///
///
/// The exportImage method is used to export the image passed through argument with different image format and exporting options as like exportDiagram method.
///
/// pass the base64String image to be exported.
///
///
///
/// The exportImage method is used to export the image passed through argument with different image format and exporting options as like exportDiagram method.
///
/// options to export the desired region of diagram to the desired formats.
///
},
findNode:function(name){
///
///
/// Read a node/connector object by its name
///
/// name of the node/connector that is to be identified
///
},
fitToPage:function(mode, region, margin){
///
///
/// Fit the diagram content into diagram viewport
///
/// to set the mode of fit to command.
///
///
///
/// Fit the diagram content into diagram viewport
///
/// to set whether the region to be fit will be based on diagram elements or page settings.
///
///
///
/// Fit the diagram content into diagram viewport
///
/// to set the required margin
///
},
getDiagramContent:function(styleSheets){
///
///
/// Get the diagram DOM element as a string along with dependent stylesheets.
///
/// If its specified, will get the diagram DOM element along with specified stylesheet references. Please note that you have to define absolute path for local CSS file. If not specified, will get the diagram content along with all stylesheets loaded in the document.
///
},
getDiagramBounds:function(){
///
///
/// Get the bounds of the diagram.
///
},
group:function(){
///
///
/// Group the selected nodes and connectors
///
},
insertLabel:function(name, label, index){
///
///
/// Insert a label into a node's label collection at runtime
///
/// name of the node to which the label has to be inserted
///
///
///
/// Insert a label into a node's label collection at runtime
///
/// JSON to define the new label
///
///
///
/// Insert a label into a node's label collection at runtime
///
/// index to insert the label into the node
///
},
layout:function(){
///
///
/// Refresh the diagram with the specified layout
///
},
load:function(data){
///
///
/// Load the diagram
///
/// JSON data to load the diagram
///
},
moveForward:function(){
///
///
/// Visually move the selected object over its closest intersected object
///
},
nudge:function(direction, delta){
///
///
/// Move the selected objects by either one pixel or by the pixels specified through argument
///
/// specifies the direction to move the selected objects ("left","right",top","bottom")
///
///
///
/// Move the selected objects by either one pixel or by the pixels specified through argument
///
/// specifies the number of pixels by which the selected objects have to be moved
///
},
paste:function(object, rename){
///
///
/// Paste the selected object from internal clipboard to diagram
///
/// object to be added to diagram
///
///
///
/// Paste the selected object from internal clipboard to diagram
///
/// to define whether the specified object is to be renamed or not
///
},
print:function(printSettings){
///
///
/// Print the diagram as image
///
/// options to print the desired region of diagram and print the diagram in multiple pages.
///
},
printImage:function(image, printImageSettings){
///
///
/// The printImage method is used to print the image passed through argument with desired region and multiple pages as like print method.
///
/// pass the base64String image to be printed.
///
///
///
/// The printImage method is used to print the image passed through argument with desired region and multiple pages as like print method.
///
/// options to export the desired region of diagram to the desired formats.
///
},
redo:function(){
///
///
/// Restore the last action that was reverted
///
},
refresh:function(){
///
///
/// Refresh the diagram at runtime
///
},
remove:function(node){
///
///
/// Remove either the given node/connector or the selected element from diagram
///
/// the node/connector to be removed from diagram
///
},
removeLayers:function(layers){
///
///
/// Remove the collection of layers from the diagram layers.
///
/// collection of layers to be removed from diagram layer.
///
},
removeNodeToLayer:function(layerName, nodes){
///
///
/// Remove the collection of nodes from the specific layer.
///
/// Specifies the layer name to the node will be removed.
///
///
///
/// Remove the collection of nodes from the specific layer.
///
/// collection of diagram elements name to be removed from specific layer.
///
},
removePorts:function(name, ports){
///
///
/// Remove the collection of ports from the specified node.
///
/// name of the node to which the ports have to be added
///
///
///
/// Remove the collection of ports from the specified node.
///
/// a collection of ports to be deleted from the specified node
///
},
removeLabels:function(name, labels){
///
///
/// Add a collection of ports to the node specified by name
///
/// name of the node to which the ports have to be added
///
///
///
/// Add a collection of ports to the node specified by name
///
/// a collection of labels to be deleted from the specified node
///
},
removeSelection:function(node){
///
///
/// Remove a particular object from selection list
///
/// the node/connector to be removed from selection list
///
},
sameHeight:function(){
///
///
/// Scale the selected objects to the height of the first selected object
///
},
sameSize:function(){
///
///
/// Scale the selected objects to the size of the first selected object
///
},
sameWidth:function(){
///
///
/// Scale the selected objects to the width of the first selected object
///
},
save:function(){
///
///
/// Returns the diagram as serialized JSON
///
},
scrollToNode:function(node){
///
///
/// Bring the node into view
///
/// the node/connector to be brought into view
///
},
selectAll:function(){
///
///
/// Select all nodes and connector in diagram
///
},
sendBackward:function(){
///
///
/// Visually move the selected object behind its closest intersected object
///
},
sendToBack:function(){
///
///
/// Visually move the selected object behind all other intersected objects
///
},
spaceAcross:function(){
///
///
/// Update the horizontal space between the selected objects as equal and within the selection boundary
///
},
spaceDown:function(){
///
///
/// Update the vertical space between the selected objects as equal and within the selection boundary
///
},
startLabelEdit:function(node, label){
///
///
/// Move the specified label to edit mode
///
/// node/connector that contains the label to be edited
///
///
///
/// Move the specified label to edit mode
///
/// to be edited
///
},
undo:function(){
///
///
/// Reverse the last action that was performed
///
},
ungroup:function(){
///
///
/// Ungroup the selected group
///
},
update:function(options){
///
///
/// Update diagram at runtime
///
/// JSON to specify the diagram properties that have to be modified
///
},
updateConnector:function(name, options){
///
///
/// Update Connectors at runtime
///
/// name of the connector to be updated
///
///
///
/// Update Connectors at runtime
///
/// JSON to specify the connector properties that have to be updated
///
},
updateLabel:function(nodeName, label, options){
///
///
/// Update the given label at runtime
///
/// the name of node/connector which contains the label to be updated
///
///
///
/// Update the given label at runtime
///
/// the label to be modified
///
///
///
/// Update the given label at runtime
///
/// JSON to specify the label properties that have to be updated
///
},
updateLayer:function(layerName, options){
///
///
/// Update the given layer at run time.
///
/// the name of layer to be updated
///
///
///
/// Update the given layer at run time.
///
/// the layer object to be modified
///
},
updateNode:function(name, options){
///
///
/// Update nodes at runtime
///
/// name of the node that is to be updated
///
///
///
/// Update nodes at runtime
///
/// JSON to specify the properties of node that have to be updated
///
},
updatePort:function(nodeName, port, options){
///
///
/// Update a port with its modified properties at runtime
///
/// the name of node which contains the port to be updated
///
///
///
/// Update a port with its modified properties at runtime
///
/// the port to be updated
///
///
///
/// Update a port with its modified properties at runtime
///
/// JSON to specify the properties of the port that have to be updated
///
},
updateSelectedObject:function(name){
///
///
/// Update the specified node as selected object
///
/// name of the node to be updated as selected object
///
},
updateSelection:function(showUserHandles){
///
///
/// Update the selection at runtime
///
/// to specify whether to show the user handles or not
///
},
updateUserHandles:function(node){
///
///
/// Update user handles with respect to the given node
///
/// node/connector with respect to which, the user handles have to be updated
///
},
updateViewPort:function(){
///
///
/// Update the diagram viewport at runtime
///
},
upgrade:function(data){
///
///
/// Upgrade the diagram from old version
///
/// to be upgraded
///
},
zoomTo:function(Zoom){
///
///
/// Used to zoomIn/zoomOut diagram
///
/// options to zoom the diagram(zoom factor, zoomIn/zoomOut)
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDiagram=function(){
this.data("ejDiagram",new ej.Diagram());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDiagram :function (options) {
///
///
///The diagram control provides 2D surface to visualize the data as shapes, lines, text and images. It can be configured to DOM element such as DIV.
///Defines the background color of diagram elements
///
backgroundColor-string default-transparent
///
///Defines the path of the background image of diagram elements
///
backgroundImage-string default-
///
///Defines how to align the background image over the diagram area.
///
alignment-ej.datavisualization.Diagram.ImageAlignment |string default-ej.datavisualization.Diagram.ImageAlignment.XMidYMid
///
///Sets the direction of line bridges.
///
bridgeDirection-ej.datavisualization.Diagram.BridgeDirection|string default-ej.datavisualization.Diagram.BridgeDirection.Top
///
///Defines a set of custom commands and binds them with a set of desired key gestures.
///
commandManager-CommandManager default-
///
///An object that maps a set of command names with the corresponding command objects
///
commands-any default-{}
///
///A method that defines whether the command is executable at the moment or not.
///
canExecute-Function default-
///
///A method that defines what to be executed when the key combination is recognized.
///
execute-Function default-
///
///Defines a combination of keys and key modifiers, on recognition of which the command will be executed
///
gesture-any default-
///
///Sets the key value, on recognition of which the command will be executed.
///
key-ej.datavisualization.Diagram.Keys|string default-ej.datavisualization.Diagram.Keys.None
///
///Sets a combination of key modifiers, on recognition of which the command will be executed.
///
keyModifiers-ej.datavisualization.Diagram.KeyModifiers|string default-ej.datavisualization.Diagram.KeyModifiers.None
///
///Defines any additional parameters that are required at runtime
///
parameter-any default-null
///
///A collection of JSON objects where each object represents a connector
///
connectors-Array<Connectors> default-[]
///
///To maintain additional information about connectors
///
addInfo-any default-null
///
///Defines the width of the line bridges
///
bridgeSpace-number default-10
///
///Enables or disables the behaviors of connectors.
///
constraints-ej.datavisualization.Diagram.ConnectorConstraints|string default-ej.datavisualization.Diagram.ConnectorConstraints.Default
///
///Defines the radius of the rounded corner
///
cornerRadius-number default-0
///
///This property allows you to customize connectors appearance using user-defined CSS.
///
cssClass-string default-
///
///Sets the horizontal alignment of the connector. Applicable, if the parent of the connector is a container.
///
horizontalAlign-ej.datavisualization.Diagram.HorizontalAlignment|string default-ej.datavisualization.Diagram.HorizontalAlignment.Left
///
///A collection of JSON objects where each object represents a label.
///
labels-Array<any> default-[]
///
///Defines how the label should be aligned with respect to the segment
///
alignment-ej.datavisualization.Diagram.Alignment|string default-ej.datavisualization.Diagram.Alignment.Center
///
///Enables/disables the bold style
///
bold-boolean default-false
///
///Sets the border color of the label
///
borderColor-string default-transparent
///
///Sets the border width of the label
///
borderWidth-number default-0
///
///Defines whether the label should be aligned within the connector boundaries
///
boundaryConstraints-boolean default-true
///
///Enables or disables the default behaviors of the label.
///
constraints-ej.datavisualization.Diagram.LabelConstraints|string default-ej.datavisualization.Diagram.LabelConstraints.None
///
///Sets the fill color of the text area
///
fillColor-string default-transparent
///
///Sets the font color of the text
///
fontColor-string default-black
///
///Sets the font family of the text
///
fontFamily-string default-Arial
///
///Defines the font size of the text
///
fontSize-number default-12
///
///Sets the height of the label(the maximum value of label height and the connector height will be considered as label height)
///
height-number default-0
///
///Sets the horizontal alignment of the label.
///
horizontalAlignment-ej.datavisualization.Diagram.HorizontalAlignment|string default-ej.datavisualization.Diagram.HorizontalAlignment.Center
///
///Sets the hyperlink for the labels in the connectors.
///
hyperlink-string default-none
///
///Enables/disables the italic style
///
italic-boolean default-false
///
///Gets whether the label is currently being edited or not.
///
mode-ej.datavisualization.Diagram.LabelEditMode|string default-ej.datavisualization.Diagram.LabelEditMode.Edit
///
///Sets the unique identifier of the label
///
name-string default-
///
///Sets the fraction/ratio(relative to connector) that defines the position of the label
///
offset-any default-ej.datavisualization.Diagram.Point(0.5, 0.5)
///
///Sets the fraction/ratio(relative to connector) that defines the position of the label
///
margin-any default-ej.datavisualization.Diagram.Point(0.5, 0.5)
///
///To set the margin of the label in right direction
///
right-number default-0
///
///To set the margin of the label in left direction
///
left-number default-0
///
///To set the margin of the label in top direction
///
top-number default-0
///
///To set the margin of the label in bottom direction
///
bottom-number default-0
///
///Sets the padding for connector label.
///
padding-any default-ej.datavisualization.Diagram.Point(0.5, 0.5)
///
///Sets the value which is used to drag the label within certain bounds.
///
dragLimit-any default-null
///
///To set the drag limit of the label in right direction
///
right-number default-10
///
///To set the drag limit of the label in left direction
///
left-number default-10
///
///To set the drag limit of the label in top direction
///
top-number default-10
///
///To set the drag limit of the label in bottom direction
///
bottom-number default-10
///
///Defines the transparency of labels
///
opacity-number default-1
///
///Defines whether the label is editable or not
///
readOnly-boolean default-false
///
///Defines whether the label should be positioned whether relative to segments or connector boundaries
///
relativeMode-ej.datavisualization.Diagram.LabelRelativeMode|string default-ej.datavisualization.Diagram.LabelRelativeMode.SegmentPath
///
///Defines the angle to which the label needs to be rotated
///
rotateAngle-number default-0
///
///Sets the position of the label with respect to the total segment length
///
segmentOffset-string default-0.5
///
///Defines the label text
///
text-string default-
///
///Defines how to align the text inside the label.
///
textAlign-ej.datavisualization.Diagram.TextAlign|string default-ej.datavisualization.Diagram.TextAlign.Center
///
///Sets how to decorate the label text.
///
textDecoration-ej.datavisualization.Diagram.TextDecorations|string default-ej.datavisualization.Diagram.TextDecorations.None
///
///Sets the vertical alignment of the label.
///
verticalAlignment-ej.datavisualization.Diagram.VerticalAlignment|string default-ej.datavisualization.Diagram.VerticalAlignment.Center
///
///Enables or disables the visibility of the label
///
visible-boolean default-true
///
///Sets the width of the label(the maximum value of label width and the connector width will be considered as label width)
///
width-number default-50
///
///Defines how the label text needs to be wrapped.
///
wrapping-ej.datavisualization.Diagram.TextWrapping|string default-ej.datavisualization.Diagram.TextWrapping.WrapWithOverflow
///
///Sets the stroke color of the connector
///
lineColor-string default-black
///
///Sets the pattern of dashes and gaps used to stroke the path of the connector
///
lineDashArray-string default-
///
///Defines the padding value to ease the interaction with connectors
///
lineHitPadding-number default-10
///
///Sets the width of the line
///
lineWidth-number default-1
///
///Defines the minimum space to be left between the bottom of parent bounds and the connector. Applicable, if the parent is a container.
///
marginBottom-number default-0
///
///Defines the minimum space to be left between the left of parent bounds and the connector. Applicable, if the parent is a container.
///
marginLeft-number default-0
///
///Defines the minimum space to be left between the right of parent bounds and the connector. Applicable, if the parent is a container.
///
marginRight-number default-0
///
///Defines the minimum space to be left between the top of parent bounds and the connector. Applicable, if the parent is a container.
///
marginTop-number default-0
///
///Sets a unique name for the connector
///
name-string default-
///
///Defines the transparency of the connector
///
opacity-number default-1
///
///Defines the size and preview size of the node to add that to symbol palette. To explore palette item, refer Palette Item
///
paletteItem-any default-null
///
///Sets the parent name of the connector.
///
parent-string default-
///
///An array of JSON objects where each object represents a segment
///
segments-Array<any> default-[ { type:straight } ]
///
///Sets the direction of orthogonal segment
///
direction-string default-
///
///Describes the length of orthogonal segment
///
length-number default-undefined
///
///Describes the end point of bezier/straight segment
///
point-ej.datavisualization.Diagram.ConnectorsSourcePoint default-Diagram.Point()
///
///Defines the first control point of the bezier segment
///
point1-ej.datavisualization.Diagram.ConnectorsSourcePoint default-null
///
///Defines the second control point of bezier segment
///
point2-ej.datavisualization.Diagram.ConnectorsSourcePoint default-null
///
///Sets the type of the segment.
///
type-ej.datavisualization.Diagram.Segments|string default-ej.datavisualization.Diagram.Segments.Straight
///
///Describes the length and angle between the first control point and the start point of bezier segment
///
vector1-any default-null
///
///Describes the length and angle between the second control point and end point of bezier segment
///
vector2-any default-null
///
///Defines the role/meaning of the connector
///
shape-any default-null
///
///Sets the type of the connector
///
type-ej.datavisualization.Diagram.ConnectorShapes|string default-ej.datavisualization.Diagram.ConnectorShapes.BPMN
///
///Sets the type of the flow in a BPMN Process
///
flow-ej.datavisualization.Diagram.BPMNFlows|string default-ej.datavisualization.Diagram.BPMNFlows.Sequence
///
///Sets the type of the Association in a BPMN Process
///
association-ej.datavisualization.Diagram.AssociationFlows|string default-ej.datavisualization.Diagram.AssociationFlows.Default
///
///Sets the type of the message flow. Applicable, if the connector is of type "BPMN"
///
message-ej.datavisualization.Diagram.BPMNMessageFlows|string default-ej.datavisualization.Diagram.BPMNMessageFlows.Default
///
///Sets the type of BPMN sequence flow
///
sequence-ej.datavisualization.Diagram.BPMNSequenceFlows|string default-ej.datavisualization.Diagram.BPMNSequenceFlows.Normal
///
///Defines the role of the connector in a UML Class Diagram. Applicable, if the type of the connector is "classifier".
///
relationship-ej.datavisualization.Diagram.ClassifierShapes|string default-ej.datavisualization.Diagram.ClassifierShapes.Association
///
///Defines the multiplicity option of the connector
///
multiplicity-any default-null
///
///Sets the type of the multiplicity. Applicable, if the connector is of type "classifier"
///
type-ej.datavisualization.Diagram.Multiplicity|string default-ej.datavisualization.Diagram.Multiplicity.OneToOne
///
///Defines the source label to connector. Applicable, if the connector is of type "UML"
///
source-any default-
///
///Defines the source label to connector. Applicable, if the connector is of type "UML"
///
optional-boolean default-true
///
///Defines the source label to connector. Applicable, if the connector is of type "UML"
///
lowerBounds-number default-null
///
///Defines the source label to connector. Applicable, if the connector is of type "UML"
///
upperBounds-number default-null
///
///Defines the target label to connector. Applicable, if the connector is of type "UML"
///
target-ej.datavisualization.Diagram.ConnectorsShapeMultiplicitySource default-true
///
///Defines the shape of UMLActivity to connector. Applicable, if the connector is of type UMLActivity
///
ActivityFlow-ej.datavisualization.Diagram.UMLActivityFlow|string default-ej.datavisualization.Diagram.UMLActivityFlow.Control
///
///Defines the source decorator of the connector
///
sourceDecorator-any default-{ shape:arrow, width: 8, height:8, borderColor:black, fillColor:black }
///
///Sets the border color of the source decorator
///
borderColor-string default-black
///
///Sets the border width of the decorator
///
borderWidth-number default-1
///
///This property allows you to customize sourceDecorator appearance using user-defined CSS.
///
cssClass-string default-
///
///Sets the fill color of the source decorator
///
fillColor-string default-black
///
///Sets the height of the source decorator
///
height-number default-8
///
///Defines the custom shape of the source decorator
///
pathData-string default-
///
///Defines the shape of the source decorator.
///
shape-ej.datavisualization.Diagram.DecoratorShapes|string default-ej.datavisualization.Diagram.DecoratorShapes.Arrow
///
///Defines the width of the source decorator
///
width-number default-8
///
///Sets the source node of the connector
///
sourceNode-string default-
///
///Defines the space to be left between the source node and the source point of a connector
///
sourcePadding-number default-0
///
///Describes the start point of the connector
///
sourcePoint-any default-ej.datavisualization.Diagram.Point()
///
///Defines the x-coordinate of a position
///
x-number default-0
///
///Defines the y-coordinate of a position
///
y-number default-0
///
///Sets the source port of the connector
///
sourcePort-string default-
///
///Defines the target decorator of the connector
///
targetDecorator-any default-{ shape:arrow, width: 8, height:8, borderColor:black, fillColor:black }
///
///Sets the border color of the decorator
///
borderColor-string default-black
///
///This property allows you to customize targetDecorator appearance using user-defined CSS.
///
cssClass-string default-
///
///Sets the color with which the decorator will be filled
///
fillColor-string default-black
///
///Defines the height of the target decorator
///
height-number default-8
///
///Defines the custom shape of the target decorator
///
pathData-string default-
///
///Defines the shape of the target decorator.
///
shape-ej.datavisualization.Diagram.DecoratorShapes|string default-ej.datavisualization.Diagram.DecoratorShapes.Arrow
///
///Defines the width of the target decorator
///
width-number default-8
///
///Sets the target node of the connector
///
targetNode-string default-
///
///Defines the space to be left between the target node and the target point of the connector
///
targetPadding-number default-0
///
///Describes the end point of the connector
///
targetPoint-ej.datavisualization.Diagram.ConnectorsSourcePoint default-ej.datavisualization.Diagram.Point()
///
///Sets the targetPort of the connector
///
targetPort-string default-
///
///Defines the tooltip that should be shown when the mouse hovers over connector. For tooltip properties, refer Tooltip
///
tooltip-any default-null
///
///To set the vertical alignment of connector (Applicable,if the parent is group).
///
verticalAlign-ej.datavisualization.Diagram.VerticalAlignment|string default-ej.datavisualization.Diagram.VerticalAlignment.Top
///
///Enables or disables the visibility of connector
///
visible-boolean default-true
///
///Sets the z-index of the connector
///
zOrder-number default-0
///
///Binds the custom JSON data with connector properties
///
connectorTemplate-any default-null
///
///Enables/Disables the default behaviors of the diagram.
///
constraints-ej.datavisualization.Diagram.DiagramConstraints|string default-ej.datavisualization.Diagram.DiagramConstraints.All
///
///An object to customize the context menu of diagram
///
contextMenu-ContextMenu default-
///
///Defines the collection of context menu items
///
items-Array<any> default-[]
///
///Defines the text for the collection of context menu item
///
text-string default-null
///
///Defines the name for the collection of context menu items
///
name-string default-null
///
///Defines the image url for the collection of context menu items
///
imageUrl-string default-null
///
///Defines the CssClass for the collection of context menu items
///
cssClass-string default-null
///
///Defines the collection of sub items for the context menu items
///
subItems-Array<any> default-[]
///
///To set whether to display the default context menu items or not
///
showCustomMenuItemsOnly-boolean default-false
///
///Configures the data source that is to be bound with diagram
///
dataSourceSettings-DataSourceSettings default-
///
///Defines the data source either as a collection of objects or as an instance of ej.DataManager
///
dataSource-any default-null
///
///Sets the unique id of the data source items
///
id-string default-
///
///Defines the parent id of the data source item
///
parent-string default-''
///
///Describes query to retrieve a set of data from the specified datasource
///
query-string default-null
///
///Sets the unique id of the root data source item
///
root-string default-
///
///Describes the name of the table on which the specified query has to be executed
///
tableName-string default-null
///
///Specifies the method name which is used to get the updated data from client side to the server side
///
crudAction-any default-null
///
///Specifies the create method which is used to get the nodes to be added from client side to the server side
///
create-string default-null
///
///Specifies the update method which is used to get the updated data from client side to the server side
///
update-string default-null
///
///Specifies the destroy method which is used to get the deleted items data from client side to the server side
///
destroy-string default-null
///
///Specifies the read method to get the created nodes from client side to the server side
///
read-string default-null
///
///Specifies the custom fields to get the updated data from client side to the server side
///
customFields-Array<any> default-[]
///
///Defines the data source either as a collection of objects or as an instance of ej.DataManager
///
connectionDataSource-any default-null
///
///Sets the datasource for the connection datasource settings items.
///
dataSource-string default-null
///
///Sets the unique id of the connection data source item
///
id-string default-null
///
///Sets the source node of the connection data source item
///
sourceNode-string default-null
///
///Sets the target node of the connection data source item
///
targetNode-string default-null
///
///Sets the sourcePointX value of the connection data source item
///
sourcePointX-string default-null
///
///Sets the sourcePointY value of the connection data source item
///
sourcePointY-string default-null
///
///Sets the targetPoint-x value of the connection data source item
///
targetPointX-string default-null
///
///Sets the targetPoint-y value of the connection data source item
///
targetPointY-string default-null
///
///Specifies the method name which is used to get updated connectors from client side to the server side
///
crudAction-any default-null
///
///Specifies the create method which is used to get the connectors to be added from client side to the server side
///
create-string default-null
///
///Specifies the update method which is used to get the updated connectors from client side to the server side
///
update-string default-null
///
///Specifies the destroy method which is used to get the deleted items data from client side to the server side
///
destroy-string default-null
///
///Specifies the read method which is used to get the data from client side to the server side
///
read-string default-null
///
///Specifies the custom fields to get the updated data from client side to the server side
///
customFields-Array<any> default-[]
///
///Initializes the default values for nodes and connectors
///
defaultSettings-DefaultSettings default-{}
///
///Initializes the default connector properties
///
connector-any default-null
///
///Initializes the default properties of groups
///
group-any default-null
///
///Initializes the default properties for nodes
///
node-any default-null
///
///Sets the type of JSON object to be drawn through drawing tool
///
drawType-any default-{}
///
///Enables or disables auto scroll in diagram
///
enableAutoScroll-boolean default-true
///
///Enables or disables diagram context menu
///
enableContextMenu-boolean default-true
///
///Specifies the height of the diagram
///
height-string default-null
///
///Customizes the undo redo functionality
///
historyManager-HistoryManager default-
///
///A method that takes a history entry as argument and returns whether the specific entry can be popped or not
///
canPop-Function default-
///
///A method that ends grouping the changes
///
closeGroupAction-Function default-
///
///A method that removes the history of a recent change made in diagram
///
pop-Function default-
///
///A method that allows to track the custom changes made in diagram
///
push-Function default-
///
///Defines what should be happened while trying to restore a custom change
///
redo-Function default-null
///
///The redoStack property is used to get the number of redo actions to be stored on the history manager. Its an read-only property and the collection should not be modified.
///
redoStack-Array<any> default-[]
///
///The stackLimit property used to restrict the undo and redo actions to a certain limit.
///
stackLimit-number default-null
///
///A method that starts to group the changes to revert/restore them in a single undo or redo
///
startGroupAction-Function default-
///
///Defines what should be happened while trying to revert a custom change
///
undo-Function default-
///
///The undoStack property is used to get the number of undo actions to be stored on the history manager. Its an read-only property and the collection should not be modified.
///
undoStack-Array<any> default-[]
///
///Defines the type of the rendering mode of label.
///
labelRenderingMode-ej.datavisualization.Diagram.LabelRenderingMode|string default-HTML
///
///Automatically arranges the nodes and connectors in a predefined manner.
///
layout-Layout default-
///
///Specifies the custom bounds to arrange/align the layout
///
bounds-any default-ej.datavisualization.Diagram.Rectangle()
///
///Defines the fixed node with reference to which, the layout will be arranged and fixed node will not be repositioned
///
fixedNode-string default-
///
///Customizes the orientation of trees/sub trees. For orientations, see Chart Orientations. For chart types, see Chart Types
///
getLayoutInfo-any default-null
///
///Defines a method to customize the segments based on source and target nodes.
///
getConnectorSegments-any default-null
///
///Sets the space to be horizontally left between nodes
///
horizontalSpacing-number default-30
///
///Defines the space to be left between layout bounds and layout.
///
margin-any default-ej.datavisualization.Diagram.Margin()
///
///Defines how to horizontally align the layout within the layout bounds
///
horizontalAlignment-ej.datavisualization.Diagram.HorizontalAlignment|string default-ej.datavisualization.Diagram.HorizontalAlignment.Center
///
///Defines how to vertically align the layout within the layout bounds
///
verticalAlignment-ej.datavisualization.Diagram.VerticalAlignment|string default-ej.datavisualization.Diagram.VerticalAlignment.Center
///
///Sets the orientation/direction to arrange the diagram elements.
///
orientation-ej.datavisualization.Diagram.LayoutOrientations|string default-ej.datavisualization.Diagram.LayoutOrientations.TopToBottom
///
///Sets the type of the layout based on which the elements will be arranged.
///
type-ej.datavisualization.Diagram.LayoutTypes|string default-ej.datavisualization.Diagram.LayoutTypes.None
///
///Sets the space to be vertically left between nodes
///
verticalSpacing-number default-30
///
///Sets the value is used to define the root node of the layout.
///
root-string default-30
///
///Defines how long edges should be, ideally. This will be the resting length for the springs.
///
springLength-number default-100
///
///Defines how long edges should be, ideally. This will be the resting length for the springs.
///
springFactor-number default-0.442
///
///Defines how long edges should be, ideally. This will be the resting length for the springs.
///
maxIteration-number default-1000
///
///Enable or disable connector's segment overlapping with each other when executing the layout with multiple parents.
///
avoidSegmentOverlapping-boolean default-false
///
///Defines the current culture of diagram
///
locale-string default-en-US
///
///Array of JSON objects where each object represents a node
///
nodes-Array<Nodes> default-[]
///
///Defines the type of BPMN Activity. Applicable, if the node is a BPMN activity.
///
activity-ej.datavisualization.Diagram.BPMNActivity|string default-ej.datavisualization.Diagram.BPMNActivity.Task
///
///To maintain additional information about nodes
///
addInfo-any default-{}
///
///Defines the additional information of a process. It is not directly related to the message flows or sequence flows of the process.
///
annotation-any default-ej.datavisualization.Diagram.BPMNTextAnnotation()
///
///Sets the angle between the BPMN shape and the annotation
///
angle-number default-0
///
///Sets the direction of the text annotation
///
direction-ej.datavisualization.Diagram.BPMNAnnotationDirection|string default-ej.datavisualization.Diagram.BPMNAnnotationDirections.Left
///
///Sets the height of the text annotation
///
height-number default-20
///
///Sets the distance between the BPMN shape and the annotation
///
length-number default-0
///
///Defines the additional information about the flow object in a BPMN Process
///
text-string default-
///
///Sets the width of the text annotation
///
width-number default-20
///
///Sets the border color of node
///
borderColor-string default-black
///
///Sets the pattern of dashes and gaps to stroke the border
///
borderDashArray-string default-
///
///Sets the border width of the node
///
borderWidth-number default-1
///
///Defines whether the group can be ungrouped or not
///
canUngroup-boolean default-true
///
///Array of JSON objects where each object represents a child node/connector
///
children-Array<any> default-[]
///
///Sets the type of UML classifier. Applicable, if the node is a UML Class Diagram shape.
///
classifier-ej.datavisualization.Diagram.ClassifierShapes|string default-ej.datavisualization.Diagram.ClassifierShapes.Class
///
///Defines the name, attributes and methods of a Class. Applicable, if the node is a Class.
///
class-any default-null
///
///Sets the name of class.
///
name-string default-
///
///Defines the collection of attributes
///
attributes-Array<any> default-[]
///
///Sets the name of the attribute
///
name-string default-
///
///Sets the data type of attribute
///
type-string default-
///
///Defines the visibility of the attribute
///
scope-string default-ej.datavisualization.Diagram.ScopeValueDefaults.Public
///
///Defines the collection of methods of a Class.
///
methods-Array<any> default-[]
///
///Sets the visibility of the method.
///
scope-string default-ej.datavisualization.Diagram.ScopeValueDefaults.Public
///
///Defines the state of the node is collapsed.
///
collapseIcon-any default-
///
///Sets the border color for collapse icon of node
///
borderColor-string default-black
///
///Sets the border width for collapse icon of node
///
borderWidth-number default-1
///
///Sets the fill color for collapse icon of node
///
fillColor-string default-white
///
///Defines the height for collapse icon of node
///
height-number default-15
///
///Sets the horizontal alignment of the icon.
///
horizontalAlignment-ej.datavisualization.Diagram.HorizontalAlignment|string default-ej.datavisualization.Diagram.HorizontalAlignment.Center
///
///To set the margin for the collapse icon of node
///
margin-any default-ej.datavisualization.Diagram.Margin()
///
///Sets the fraction/ratio(relative to node) that defines the position of the icon
///
offset-any default-ej.datavisualization.Diagram.Point(0.5, 1)
///
///Defines the shape of the collapsed state of the node.
///
shape-ej.datavisualization.Diagram.IconShapes|string default-ej.datavisualization.Diagram.IconShapes.None
///
///Sets the vertical alignment of the icon.
///
verticalAlignment-ej.datavisualization.Diagram.VerticalAlignment|string default-ej.datavisualization.Diagram.VerticalAlignment.Center
///
///Defines the distance to be left between a node and its connections(In coming and out going connections).
///
connectorPadding-number default-0
///
///Enables or disables the default behaviors of the node.
///
constraints-ej.datavisualization.Diagram.NodeConstraints|string default-ej.datavisualization.Diagram.NodeConstraints.Default
///
///Defines how the child objects need to be arranged(Either in any predefined manner or automatically). Applicable, if the node is a group.
///
container-any default-null
///
///Defines the orientation of the container. Applicable, if the group is a container.
///
orientation-string default-vertical
///
///Sets the type of the container. Applicable if the group is a container.
///
type-ej.datavisualization.Diagram.ContainerType|string default-ej.datavisualization.Diagram.ContainerType.Canvas
///
///Defines the corner radius of rectangular shapes.
///
cornerRadius-number default-0
///
///This property allows you to customize nodes appearance using user-defined CSS.
///
cssClass-string default-
///
///Defines the BPMN data object
///
data-any default-
///
///Sets the type of the BPMN Data object
///
type-ej.datavisualization.Diagram.BPMNDataObjects|string default-ej.datavisualization.Diagram.BPMNDataObjects.None
///
///Defines whether the BPMN data object is a collection or not
///
collection-boolean default-false
///
///Defines an Enumeration in a UML Class Diagram
///
enumeration-any default-null
///
///Sets the name of the Enumeration
///
name-string default-
///
///Defines the collection of enumeration members
///
members-Array<any> default-[]
///
///Sets the name of the enumeration member
///
name-string default-
///
///Sets the type of the BPMN Events. Applicable, if the node is a BPMN event.
///
event-ej.datavisualization.Diagram.BPMNEvents|string default-ej.datavisualization.Diagram.BPMNEvents.Start
///
///Defines whether the node can be automatically arranged using layout or not
///
excludeFromLayout-boolean default-false
///
///Defines the state of the node is expanded or collapsed.
///
expandIcon-any default-
///
///Sets the border color for expand icon of node
///
borderColor-string default-black
///
///Sets the border width for expand icon of node
///
borderWidth-number default-1
///
///Sets the fill color for expand icon of node
///
fillColor-string default-white
///
///Defines the height for expand icon of node
///
height-number default-15
///
///Sets the horizontal alignment of the icon.
///
horizontalAlignment-ej.datavisualization.Diagram.HorizontalAlignment|string default-ej.datavisualization.Diagram.HorizontalAlignment.Center
///
///To set the margin for the expand icon of node
///
margin-any default-ej.datavisualization.Diagram.Margin()
///
///Sets the fraction/ratio(relative to node) that defines the position of the icon
///
offset-any default-ej.datavisualization.Diagram.Point(0.5, 1)
///
///Defines the shape of the expanded state of the node.
///
shape-ej.datavisualization.Diagram.IconShapes|string default-ej.datavisualization.Diagram.IconShapes.None
///
///Sets the vertical alignment of the icon.
///
verticalAlignment-ej.datavisualization.Diagram.VerticalAlignment|string default-ej.datavisualization.Diagram.VerticalAlignment.Center
///
///Defines the fill color of the node
///
fillColor-string default-white
///
///Sets the type of the BPMN Gateway. Applicable, if the node is a BPMN gateway.
///
gateway-ej.datavisualization.Diagram.BPMNGateways|string default-ej.datavisualization.Diagram.BPMNGateways.None
///
///Paints the node with a smooth transition from one color to another color
///
gradient-any default-
///
///Paints the node with linear color transitions
///
LinearGradient-any default-
///
///Defines the different colors and the region of color transitions
///
stops-Array<any> default-[]
///
///Defines the type of gradient
///
type-string default-linear
///
///Defines the left most position(relative to node) of the rectangular region that needs to be painted
///
x1-number default-0
///
///Defines the right most position(relative to node) of the rectangular region that needs to be painted
///
x2-number default-0
///
///Defines the top most position(relative to node) of the rectangular region that needs to be painted
///
y1-number default-0
///
///Defines the bottom most position(relative to node) of the rectangular region that needs to be painted
///
y2-number default-0
///
///Paints the node with radial color transitions. A focal point defines the beginning of the gradient, and a circle defines the end point of the gradient.
///
RadialGradient-any default-
///
///Defines the type of gradient
///
type-string default-radial
///
///Defines the position of the outermost circle
///
cx-number default-0
///
///Defines the outer most circle of the radial gradient
///
cy-number default-0
///
///Defines the innermost circle of the radial gradient
///
fx-number default-0
///
///Defines the innermost circle of the radial gradient
///
fy-number default-0
///
///Defines the different colors and the region of color transitions.
///
stops-Array<any> default-[]
///
///Defines the color and a position where the previous color transition ends and a new color transition starts
///
Stop-any default-
///
///Sets the color to be filled over the specified region
///
color-string default-
///
///Sets the position where the previous color transition ends and a new color transition starts
///
offset-number default-0
///
///Describes the transparency level of the region
///
opacity-number default-1
///
///defines the node border with a smooth transition from one color to another color.
///
borderGradient-any default-null
///
///Defines the header of a swimlane/lane
///
header-any default-{ text: Title, fontSize: 11 }
///
///Defines the height of the node
///
height-number default-0
///
///Sets the horizontal alignment of the node. Applicable, if the parent of the node is a container.
///
horizontalAlign-ej.datavisualization.Diagram.HorizontalAlignment|string default-ej.datavisualization.Diagram.HorizontalAlignment.Left
///
///A read only collection of the incoming connectors/edges of the node
///
inEdges-Array<any> default-[]
///
///Defines an interface in a UML Class Diagram
///
interface-any default-null
///
///Sets the name of the interface
///
name-string default-
///
///Defines a collection of attributes of the interface
///
attributes-Array<any> default-[]
///
///Sets the name of the attribute
///
name-string default-
///
///Sets the type of the attribute
///
type-string default-
///
///Sets the visibility of the attribute
///
scope-string default-
///
///Defines the collection of public methods of an interface
///
methods-Array<any> default-[]
///
///Sets the visibility of the method
///
scope-string default-
///
///Defines whether the sub tree of the node is expanded or collapsed
///
isExpanded-boolean default-true
///
///Sets the node as a swimlane
///
isSwimlane-boolean default-false
///
///A collection of objects where each object represents a label
///
labels-Array<any> default-[]
///
///Enables/disables the bold style
///
bold-boolean default-false
///
///Sets the border color of the label
///
borderColor-string default-transparent
///
///Sets the border width of the label
///
borderWidth-number default-0
///
///This property allows you to customize labels appearance using user-defined CSS.
///
cssClass-string default-
///
///Enables or disables the default behaviors of the label.
///
constraints-ej.datavisualization.Diagram.LabelConstraints|string default-ej.datavisualization.Diagram.LabelConstraints.None
///
///Sets the fill color of the text area
///
fillColor-string default-transparent
///
///Sets the font color of the text
///
fontColor-string default-black
///
///Sets the font family of the text
///
fontFamily-string default-Arial
///
///Defines the font size of the text
///
fontSize-number default-12
///
///Sets the height of the label(the maximum value of label height and the node height will be considered as label height)
///
height-number default-0
///
///Sets the horizontal alignment of the label.
///
horizontalAlignment-ej.datavisualization.Diagram.HorizontalAlignment|string default-ej.datavisualization.Diagram.HorizontalAlignment.Center
///
///Enables/disables the italic style
///
italic-boolean default-false
///
///To set the margin of the label
///
margin-any default-ej.datavisualization.Diagram.Margin()
///
///Gets whether the label is currently being edited or not.
///
mode-ej.datavisualization.Diagram.LabelEditMode|string default-ej.datavisualization.Diagram.LabelEditMode.Edit
///
///Sets the unique identifier of the label
///
name-string default-
///
///Sets the fraction/ratio(relative to node) that defines the position of the label
///
offset-any default-ej.datavisualization.Diagram.Point(0.5, 0.5)
///
///Defines the transparency of the labels
///
opacity-number default-1
///
///Sets the overflowType of the labels
///
overflowType-ej.datavisualization.Diagram.OverflowType|string default-ej.datavisualization.Diagram.OverflowType.Ellipsis
///
///To set the padding of the node label
///
padding-any default-ej.datavisualization.Diagram.Padding()
///
///Defines whether the label is editable or not
///
readOnly-boolean default-false
///
///Defines the angle to which the label needs to be rotated
///
rotateAngle-number default-0
///
///Sets the id of svg/html templates. Applicable, if the node's label is HTML or native.
///
templateId-string default-
///
///Defines the label text
///
text-string default-
///
///Defines how to align the text inside the label.
///
textAlign-ej.datavisualization.Diagram.TextAlign|string default-ej.datavisualization.Diagram.TextAlign.Center
///
///Sets how to decorate the label text.
///
textDecoration-ej.datavisualization.Diagram.TextDecorations|string default-ej.datavisualization.Diagram.TextDecorations.None
///
///Defines the overflowed content is displayed or not.
///
textOverflow-boolean default-false
///
///Sets the vertical alignment of the label.
///
verticalAlignment-ej.datavisualization.Diagram.VerticalAlignment|string default-ej.datavisualization.Diagram.VerticalAlignment.Center
///
///Enables or disables the visibility of the label
///
visible-boolean default-true
///
///Sets the width of the label(the maximum value of label width and the node width will be considered as label width)
///
width-number default-50
///
///Defines how the label text needs to be wrapped.
///
wrapping-ej.datavisualization.Diagram.TextWrapping|string default-ej.datavisualization.Diagram.TextWrapping.WrapWithOverflow
///
///An array of objects where each object represents a lane. Applicable, if the node is a swimlane.
///
lanes-Array<any> default-[]
///
///This property allows you to customize lanes appearance using user-defined CSS.
///
cssClass-string default-
///
///Defines the width of lane
///
width-number default-0
///
///Defines the height of lane
///
height-number default-0
///
///Defines the z-index of the lane
///
zorder-number default-0
///
///Allows to maintain additional information about lane
///
addInfo-any default-{}
///
///An array of objects where each object represents a child node of the lane
///
children-Array<any> default-[]
///
///Defines the fill color of the lane
///
fillColor-string default-white
///
///Defines the header of the lane
///
header-any default-{ text: Function, fontSize: 11 }
///
///Defines the object as a lane
///
isLane-boolean default-false
///
///Sets the unique identifier of the lane
///
name-string default-
///
///Sets the orientation of the lane.
///
orientation-string default-vertical
///
///Defines the minimum space to be left between the bottom of parent bounds and the node. Applicable, if the parent is a container.
///
marginBottom-number default-0
///
///Defines the minimum space to be left between the left of parent bounds and the node. Applicable, if the parent is a container.
///
marginLeft-number default-0
///
///Defines the minimum space to be left between the right of the parent bounds and the node. Applicable, if the parent is a container.
///
marginRight-number default-0
///
///Defines the minimum space to be left between the top of parent bounds and the node. Applicable, if the parent is a container.
///
marginTop-number default-0
///
///Defines the maximum height limit of the node
///
maxHeight-number default-0
///
///Defines the maximum width limit of the node
///
maxWidth-number default-0
///
///Defines the minimum height limit of the node
///
minHeight-number default-0
///
///Defines the minimum width limit of the node
///
minWidth-number default-0
///
///Sets the unique identifier of the node
///
name-string default-
///
///Defines the position of the node on X-Axis
///
offsetX-number default-0
///
///Defines the position of the node on Y-Axis
///
offsetY-number default-0
///
///Defines the opaque of the node
///
opacity-number default-1
///
///Defines the orientation of nodes. Applicable, if the node is a swimlane.
///
orientation-string default-vertical
///
///A read only collection of outgoing connectors/edges of the node
///
outEdges-Array<any> default-[]
///
///Defines the minimum padding value to be left between the bottom most position of a group and its children. Applicable, if the group is a container.
///
paddingBottom-number default-0
///
///Defines the minimum padding value to be left between the left most position of a group and its children. Applicable, if the group is a container.
///
paddingLeft-number default-0
///
///Defines the minimum padding value to be left between the right most position of a group and its children. Applicable, if the group is a container.
///
paddingRight-number default-0
///
///Defines the minimum padding value to be left between the top most position of a group and its children. Applicable, if the group is a container.
///
paddingTop-number default-0
///
///Defines the size and preview size of the node to add that to symbol palette
///
paletteItem-any default-null
///
///Defines whether the symbol should be drawn at its actual size regardless of precedence factors or not
///
enableScale-boolean default-true
///
///Defines the height of the symbol
///
height-number default-0
///
///To display a name for nodes in the symbol palette
///
label-string default-null
///
///Defines the margin of the symbol item
///
margin-any default-{ left: 4, right: 4, top: 4, bottom: 4 }
///
///Defines the preview height of the symbol
///
previewHeight-number default-undefined
///
///Defines the preview width of the symbol
///
previewWidth-number default-undefined
///
///Defines the width of the symbol
///
width-number default-0
///
///Sets the name of the parent group
///
parent-string default-
///
///Sets the path geometry that defines the shape of a path node
///
pathData-string default-
///
///An array of objects, where each object represents a smaller region(phase) of a swimlane.
///
phases-Array<any> default-[]
///
///Defines the header of the smaller regions
///
label-any default-null
///
///Defines the line color of the splitter that splits adjacent phases.
///
lineColor-string default-#606060
///
///Sets the dash array that used to stroke the phase splitter
///
lineDashArray-string default-3,3
///
///Sets the lineWidth of the phase
///
lineWidth-number default-1
///
///Sets the unique identifier of the phase
///
name-string default-
///
///Sets the length of the smaller region(phase) of a swimlane
///
offset-number default-100
///
///Sets the orientation of the phase
///
orientation-string default-horizontal
///
///Sets the type of the object as phase
///
type-string default-phase
///
///Sets the height of the phase headers
///
phaseSize-number default-0
///
///Sets the ratio/ fractional value relative to node, based on which the node will be transformed(positioning, scaling and rotation)
///
pivot-any default-ej.datavisualization.Diagram.Points(0.5,0.5)
///
///Defines a collection of points to draw a polygon. Applicable, if the shape is a polygon.
///
points-Array<any> default-[]
///
///An array of objects where each object represents a port
///
ports-Array<any> default-[]
///
///Sets the border color of the port
///
borderColor-string default-#1a1a1a
///
///Sets the stroke width of the port
///
borderWidth-number default-1
///
///Defines the space to be left between the port bounds and its incoming and outgoing connections.
///
connectorPadding-number default-0
///
///Defines whether connections can be created with the port
///
constraints-ej.datavisualization.Diagram.PortConstraints|string default-ej.datavisualization.Diagram.PortConstraints.Connect
///
///This property allows you to customize ports appearance using user-defined CSS.
///
cssClass-string default-
///
///Sets the fill color of the port
///
fillColor-string default-white
///
///Sets the unique identifier of the port
///
name-string default-
///
///Defines the position of the port as fraction/ ratio relative to node
///
offset-any default-ej.datavisualization.Diagram.Point(0, 0)
///
///Defines the path data to draw the port. Applicable, if the port shape is path.
///
pathData-string default-
///
///Defines the shape of the port.
///
shape-ej.datavisualization.Diagram.PortShapes|string default-ej.datavisualization.Diagram.PortShapes.Square
///
///Defines the size of the port
///
size-number default-8
///
///Defines when the port should be visible.
///
visibility-ej.datavisualization.Diagram.PortVisibility|string default-ej.datavisualization.Diagram.PortVisibility.Default
///
///Sets the name of the node which contains this port.
///
parent-string default-
///
///Sets the angle to which the node should be rotated
///
rotateAngle-number default-0
///
///Defines the opacity and the position of shadow
///
shadow-any default-ej.datavisualization.Diagram.Shadow()
///
///Defines the angle of the shadow relative to node
///
angle-number default-45
///
///Sets the distance to move the shadow relative to node
///
distance-number default-5
///
///Defines the opaque of the shadow
///
opacity-number default-0.7
///
///Sets the shape of the node. It depends upon the type of node.
///
shape-ej.datavisualization.Diagram.BasicShapes | ej.datavisualization.Diagram.FlowShapes | ej.datavisualization.Diagram.BPMNShapes | ej.datavisualization.Diagram.UMLActivityShapes|string default-ej.datavisualization.Diagram.BasicShapes.Rectangle
///
///Sets the source path of the image. Applicable, if the type of the node is image.
///
source-string default-
///
///Defines the sub process of a BPMN Activity. Applicable, if the type of the BPMN activity is sub process.
///
subProcess-any default-ej.datavisualization.Diagram.BPMNSubProcess()
///
///Defines whether the BPMN sub process is without any prescribed order or not
///
adhoc-boolean default-false
///
///Sets the boundary of the BPMN process
///
boundary-ej.datavisualization.Diagram.BPMNBoundary|string default-ej.datavisualization.Diagram.BPMNBoundary.Default
///
///Sets whether the BPMN subprocess is triggered as a compensation of a specific activity
///
compensation-boolean default-false
///
///Sets whether the BPMN subprocess is triggered as a collapsed of a specific activity
///
collapsed-boolean default-true
///
///Sets the type of the event by which the sub-process will be triggered
///
event-ej.datavisualization.Diagram.BPMNEvents|string default-ej.datavisualization.Diagram.BPMNEvents.Start
///
///Defines the collection of events that need to be appended with BPMN Sub-Process
///
events-Array<any> default-
///
///Sets the type of the event by which the sub-process will be triggered
///
event-ej.datavisualization.Diagram.BPMNEvents|string default-ej.datavisualization.Diagram.BPMNEvents.Start
///
///Sets the fraction/ratio(relative to parent) that defines the position of the event shape
///
offset-any default-ej.datavisualization.Diagram.Point(0.5, 0.5)
///
///Sets the name of the BPMN event shape.
///
name-string default-
///
///Defines the type of the event trigger
///
trigger-ej.datavisualization.Diagram.BPMNTriggers|string default-ej.datavisualization.Diagram.BPMNTriggers.Message
///
///An array of objects where each object represents a port
///
ports-Array<any> default-[]
///
///A collection of objects where each object represents a label
///
labels-Array<any> default-[]
///
///Defines the loop type of a sub process.
///
loop-ej.datavisualization.Diagram.BPMNLoops|string default-ej.datavisualization.Diagram.BPMNLoops.None
///
///Defines the children for BPMN's SubProcess
///
Processes-Array<any> default-[]
///
///Defines the type of the event trigger
///
trigger-ej.datavisualization.Diagram.BPMNTriggers|string default-ej.datavisualization.Diagram.BPMNTriggers.Message
///
///Defines the type of a sub process
///
type-ej.datavisualization.Diagram.BPMNSubProcessTypes|string default-ej.datavisualization.Diagram.BPMNSubProcessTypes.None
///
///Defines the task of the BPMN activity. Applicable, if the type of activity is set as task.
///
task-any default-ej.datavisualization.Diagram.BPMNTask()
///
///To set whether the task is a global task or not
///
call-boolean default-false
///
///Sets whether the task is triggered as a compensation of another specific activity
///
compensation-boolean default-false
///
///Sets the loop type of a BPMN task.
///
loop-ej.datavisualization.Diagram.BPMNLoops|string default-ej.datavisualization.Diagram.BPMNLoops.None
///
///Sets the type of the BPMN task.
///
type-ej.datavisualization.Diagram.BPMNTasks|string default-ej.datavisualization.Diagram.BPMNTasks.None
///
///Defines the collection of events that need to be appended with BPMN tasks
///
events-Array<any> default-
///
///Sets the id of svg/html templates. Applicable, if the node is HTML or native.
///
templateId-string default-
///
///Defines the textBlock of a text node
///
textBlock-any default-null
///
///Defines the tooltip that should be shown when the mouse hovers over node. For tooltip properties, refer Tooltip
///
tooltip-any default-null
///
///Sets the type of BPMN Event Triggers.
///
trigger-ej.datavisualization.Diagram.BPMNTriggers|string default-ej.datavisualization.Diagram.BPMNTriggers.None
///
///Defines the type of the node.
///
type-ej.datavisualization.Diagram.Shapes|string default-ej.datavisualization.Diagram.Shapes.Basic
///
///Sets the vertical alignment of a node. Applicable, if the parent of a node is a container.
///
verticalAlign-ej.datavisualization.Diagram.VerticalAlignment|string default-ej.datavisualization.Diagram.VerticalAlignment.Top
///
///Defines the visibility of the node
///
visible-boolean default-true
///
///Defines the width of the node
///
width-number default-0
///
///Defines the z-index of the node
///
zOrder-number default-0
///
///A collection of JSON objects where each object represents a layer. Layer is a named category of diagram shapes.
///
layers-Array<Layers> default-[]
///
///To specify the name of the diagram layer. Layer name should be unique.
///
name-string default-
///
///Enable or disable diagram objects to be added to the specific layer.
///
active-boolean default-false
///
///Enable or disable the specific layer objects to be visible.
///
visible-boolean default-true
///
///Enable or disable the specific layer objects to be visible on printing or exporting.
///
print-boolean default-true
///
///Enable or disable the interaction of the specific diagram objects.
///
lock-boolean default-false
///
///To Specify the collection of the object names belongs to the layer.
///
objects-Array<any> default-[]
///
///Binds the custom JSON data with node properties
///
nodeTemplate-any default-null
///
///Defines the size and appearance of diagram page
///
pageSettings-PageSettings default-
///
///Defines the maximum distance to be left between the object and the scroll bar to trigger auto scrolling
///
autoScrollBorder-any default-{ left: 15, top: 15, right: 15, bottom: 15 }
///
///Sets whether multiple pages can be created to fit all nodes and connectors
///
multiplePage-boolean default-false
///
///Defines the background color of diagram pages
///
pageBackgroundColor-string default-#ffffff
///
///Defines the page border color
///
pageBorderColor-string default-#565656
///
///Sets the border width of diagram pages
///
pageBorderWidth-number default-0
///
///Defines the height of a page
///
pageHeight-number default-null
///
///Defines the page margin
///
pageMargin-number default-24
///
///Sets the orientation of the page.
///
pageOrientation-ej.datavisualization.Diagram.PageOrientations|string default-ej.datavisualization.Diagram.PageOrientations.Portrait
///
///Defines the height of a diagram page
///
pageWidth-number default-null
///
///Defines the scrollable area of diagram. Applicable, if the scroll limit is "limited".
///
scrollableArea-any default-null
///
///Defines the scrollable region of diagram.
///
scrollLimit-ej.datavisualization.Diagram.ScrollLimit|string default-ej.datavisualization.Diagram.ScrollLimit.Infinite
///
///Defines the draggable region of diagram elements.
///
boundaryConstraints-ej.datavisualization.Diagram.BoundaryConstraints|string default-ej.datavisualization.Diagram.BoundaryConstraints.Infinite
///
///Enables or disables the page breaks
///
showPageBreak-boolean default-false
///
///Defines the zoom value, zoom factor, scroll status and view port size of the diagram
///
scrollSettings-ScrollSettings default-
///
///Allows to read the zoom value of diagram
///
currentZoom-number default-0
///
///Sets the horizontal scroll offset
///
horizontalOffset-number default-0
///
///Allows to extend the scrollable region that is based on the scroll limit
///
padding-any default-{left: 0, right: 0, top:0, bottom: 0}
///
///Sets the vertical scroll offset
///
verticalOffset-number default-0
///
///Allows to read the view port height of the diagram
///
viewPortHeight-number default-0
///
///Allows to read the view port width of the diagram
///
viewPortWidth-number default-0
///
///Defines the size and position of selected items and defines the appearance of selector
///
selectedItems-SelectedItems default-
///
///A read only collection of the selected items
///
children-Array<any> default-[]
///
///Controls the visibility of selector.
///
constraints-ej.datavisualization.Diagram.SelectorConstraints|string default-ej.datavisualization.Diagram.SelectorConstraints.All
///
///Defines a method that dynamically enables/ disables the interaction with multiple selection.
///
getConstraints-any default-null
///
///Sets the height of the selected items
///
height-number default-0
///
///Sets the x position of the selector
///
offsetX-number default-0
///
///Sets the y position of the selector
///
offsetY-number default-0
///
///Sets the angle to rotate the selected items
///
rotateAngle-number default-0
///
///Sets the angle to rotate the selected items. For tooltip properties, refer Tooltip
///
tooltip-any default-ej.datavisualization.Diagram.Tooltip()
///
///A collection of frequently used commands that will be added around the selector
///
userHandles-Array<any> default-[]
///
///Sets the horizontal alignment of the user handle
///
horizontalAlignment-ej.datavisualization.Diagram.HorizontalAlignment|string default-ej.datavisualization.Diagram.HorizontalAlignment.Center
///
///To set the margin of the user handle
///
margin-any default-ej.datavisualization.Diagram.Margin()
///
///Defines the name of the user handle
///
name-string default-
///
///Defines the background color of the user handle
///
backgroundColor-string default-#2382c3
///
///Sets the border color of the user handle
///
borderColor-string default-transparent
///
///Defines whether the user handle should be added, when more than one element is selected
///
enableMultiSelection-boolean default-false
///
///Sets the fraction/ratio(relative to node) that defines the position of the user handle
///
offset-any default-ej.datavisualization.Diagram.point(0.5, 1)
///
///Sets the stroke color of the user handle
///
pathColor-string default-transparent
///
///Defines the custom shape of the user handle
///
pathData-string default-
///
///Defines the position of the user handle
///
position-ej.datavisualization.Diagram.UserHandlePositions |string default-ej.datavisualization.Diagram.UserHandlePositions.BottomCenter
///
///Defines the size of the user handle
///
size-number default-8
///
///Defines the interactive behaviors of the user handle
///
tool-any default-
///
///Sets the vertical alignment of the user handle
///
verticalAlignment-ej.datavisualization.Diagram.VerticalAlignment|string default-ej.datavisualization.Diagram.VerticalAlignment.Center
///
///Defines the visibility of the user handle
///
visible-boolean default-true
///
///Sets the width of the selected items
///
width-number default-0
///
///Enables or disables tooltip of diagram
///
showTooltip-boolean default-true
///
///Defines diagram serialization properties that would defines how the serialization content would be.
///
serializationSettings-SerializationSettings default-
///
///defines whether the default diagram properties can be serialized or not.
///
preventDefaultValues-boolean default-false
///
///Defines the properties of the both the horizontal and vertical gauge to measure the diagram area.
///
rulerSettings-RulerSettings default-
///
///Enables or disables both the horizontal and vertical ruler.
///
showRulers-boolean default-false
///
///Defines the appearance of horizontal ruler
///
horizontalRuler-any default-
///
///Defines the number of intervals to be present on the each segment of the horizontal ruler.
///
interval-number default-5
///
///Defines the textual description of the ruler segment, and the appearance of the ruler ticks of the horizontal ruler.
///
segmentWidth-number default-100
///
///Defines the method which used to position and arrange the tick elements of the horizontal ruler.
///
arrangeTick-any default-null
///
///Defines and sets the tick alignment of the ruler scale.
///
tickAlignment-ej.datavisualization.Diagram.TickAlignment|string default-ej.datavisualization.Diagram.TickAlignment.RightOrBottom
///
///Defines the color of the horizontal marker brush.
///
markerColor-string default-red
///
///Defines the width of the horizontal ruler.
///
length-number default-null
///
///Defines the height of the horizontal ruler.
///
thickness-number default-25
///
///Defines the appearance of vertical ruler
///
verticalRuler-any default-
///
///Defines the number of intervals to be present on the each segment of the vertical ruler.
///
interval-number default-5
///
///Defines the textual description of the ruler segment, and the appearance of the ruler ticks of the vertical ruler.
///
segmentWidth-number default-100
///
///Defines the method which used to position and arrange the tick elements of the vertical ruler.
///
arrangeTick-any default-null
///
///Defines and sets the tick alignment of the ruler scale.
///
tickAlignment-ej.datavisualization.Diagram.TickAlignment|string default-ej.datavisualization.Diagram.TickAlignment.RightOrBottom
///
///Defines the color of the vertical marker brush.
///
markerColor-string default-red
///
///Defines the height of the vertical ruler.
///
length-number default-null
///
///Defines the width of the vertical ruler.
///
thickness-number default-25
///
///Defines the gridlines and defines how and when the objects have to be snapped
///
snapSettings-SnapSettings default-
///
///Enables or disables snapping nodes/connectors to objects
///
enableSnapToObject-boolean default-true
///
///Defines the appearance of horizontal gridlines
///
horizontalGridLines-any default-
///
///Defines the line color of horizontal grid lines
///
lineColor-string default-lightgray
///
///Specifies the pattern of dashes and gaps used to stroke horizontal grid lines
///
lineDashArray-string default-
///
///A pattern of lines and gaps that defines a set of horizontal gridlines
///
linesInterval-Array<any> default-[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]
///
///Specifies a set of intervals to snap the objects
///
snapInterval-Array<any> default-[20]
///
///Defines the angle by which the object needs to be snapped
///
snapAngle-number default-5
///
///Defines and sets the snapConstraints
///
snapConstraints-ej.datavisualization.Diagram.SnapConstraints|string default-
///
///Defines the minimum distance between the selected object and the nearest object
///
snapObjectDistance-number default-5
///
///Defines the appearance of horizontal gridlines
///
verticalGridLines-any default-
///
///Defines the line color of horizontal grid lines
///
lineColor-string default-lightgray
///
///Specifies the pattern of dashes and gaps used to stroke horizontal grid lines
///
lineDashArray-string default-
///
///A pattern of lines and gaps that defines a set of horizontal gridlines
///
linesInterval-Array<any> default-[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]
///
///Specifies a set of intervals to snap the objects
///
snapInterval-Array<any> default-[20]
///
///Enables/Disables the interactive behaviors of diagram.
///
tool-ej.datavisualization.Diagram.Tool|string default-ej.datavisualization.Diagram.Tool.All
///
///An object that defines the description, appearance and alignments of tooltips
///
tooltip-Tooltip default-null
///
///Aligns the tooltip around nodes/connectors
///
alignment-any default-
///
///Defines the horizontal alignment of tooltip.
///
horizontal-ej.datavisualization.Diagram.HorizontalAlignment|string default-ej.datavisualization.Diagram.HorizontalAlignment.Center
///
///Defines the vertical alignment of tooltip.
///
vertical-ej.datavisualization.Diagram.VerticalAlignment|string default-ej.datavisualization.Diagram.VerticalAlignment.Bottom
///
///Sets the margin of the tooltip
///
margin-any default-{ left: 5, right: 5, top: 5, bottom: 5 }
///
///Defines whether the tooltip should be shown at the mouse position or around node.
///
relativeMode-ej.datavisualization.Diagram.RelativeMode|string default-ej.datavisualization.Diagram.RelativeMode.Object
///
///Sets the svg/html template to be bound with tooltip
///
templateId-string default-
///
///Specifies the width of the diagram
///
width-string default-null
///
///Sets the factor by which we can zoom in or zoom out
///
zoomFactor-number default-0.2
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Dialog:function(){
///
/// Constructor of ej.Dialog
///
}
});
ej.Dialog=(function(){
var original=ej.Dialog
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
close:function(){
///
///
/// Closes the dialog widget dynamically.
///
},
collapse:function(){
///
///
/// Collapses the content area when it is expanded.
///
},
destroy:function(){
///
///
/// Destroys the Dialog widget.
///
},
expand:function(){
///
///
/// Expands the content area when it is collapsed.
///
},
isOpen:function(){
///
///
/// Checks whether the Dialog widget is opened or not. This methods returns Boolean value.
///
},
maximize:function(){
///
///
/// Maximizes the Dialog widget.
///
},
minimize:function(){
///
///
/// Minimizes the Dialog widget.
///
},
open:function(){
///
///
/// Opens the Dialog widget.
///
},
pin:function(){
///
///
/// Pins the dialog in its current position.
///
},
refresh:function(){
///
///
/// Refreshes the dialog content dynamically.
///
},
restore:function(){
///
///
/// Restores the dialog.
///
},
unpin:function(){
///
///
/// Unpins the Dialog widget.
///
},
setTitle:function(Title){
///
///
/// Sets the title for the Dialog widget.
///
/// The title for the dialog widget.
///
},
setContent:function(content){
///
///
/// Sets the content for the Dialog widget dynamically.
///
/// The content for the dialog widget. It accepts both string and HTML string.
///
},
focus:function(){
///
///
/// Sets the focus on the Dialog widget.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDialog=function(){
this.data("ejDialog",new ej.Dialog());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDialog :function (options) {
///
///
///The Dialog control displays a Dialog window within a web page. The Dialog enables a message to be displayed, such as supplementary content like images and text, and an interactive content like forms.
///Adds action buttons like close, minimize, pin, maximize in the dialog header.
///
actionButtons-string[] default-
///
///Specifies the ajaxSettings option to load the content to the Dialog control.
///
ajaxSettings-AjaxSettings default-null
///
///It specifies, whether to enable or disable asynchronous request.
///
async-boolean default-
///
///It specifies the page will be cached in the web browser.
///
cache-boolean default-
///
///It specifies the type of data is send in the query string.
///
contentType-string default-
///
///It specifies the data as an object, will be passed in the query string.
///
data-any default-
///
///It specifies the type of data that you're expecting back from the response.
///
dataType-string default-
///
///It specifies the HTTP request type.
///
type-string default-
///
///Enables or disables draggable.
///
allowDraggable-boolean default-
///
///Enables or disables keyboard interaction.
///
allowKeyboardNavigation-boolean default-
///
///Customizes the Dialog widget animations. The Dialog widget can be animated while opening and closing the dialog. In order to customize animation effects, you need to set “enableAnimation†as true. It contains the following sub properties.
///
animation-any default-
///
///To Enable or disable the scrolling for background element of the modal dialog. This will work only with modal dialog.
///
backgroundScroll-boolean default-
///
///Closes the dialog widget on pressing the ESC key when it is set to true.
///
closeOnEscape-boolean default-
///
///The selector for the container element. If the property is set, then dialog will append to the selected element and it is restricted to move only within the specified container element.
///
containment-string default-
///
///The content type to load the dialog content at run time. The possible values are null, AJAX, iframe and image. When it is null (default value), the content inside dialog element will be displayed as content and when it is not null, the content will be loaded from the URL specified in the contentUrl property.
///
contentType-string default-
///
///The URL to load the dialog content (such as AJAX, image, and iframe). In order to load content from URL, you need to set contentType as ‘ajax’ or ‘iframe’ or ‘image’.
///
contentUrl-string default-
///
///The root class for the Dialog widget to customize the existing theme.
///
cssClass-string default-
///
///Enable or disables animation when the dialog is opened or closed.
///
enableAnimation-boolean default-
///
///Enables or disables the Dialog widget.
///
enabled-boolean default-
///
///Enable or disables modal dialog. The modal dialog acts like a child window that is displayed on top of the main window/screen and disables the main window interaction until it is closed.
///
enableModal-boolean default-
///
///Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true.
///
enablePersistence-boolean default-
///
///Allows the dialog to be resized. The dialog cannot be resized less than the minimum height, width values and greater than the maximum height and width.
///
enableResize-boolean default-
///
///Displays dialog content from right to left when set to true.
///
enableRTL-boolean default-
///
///The CSS class name to display the favicon in the dialog header. In order to display favicon, you need to set showHeader as true since the favicon will be displayed in the dialog header.
///
faviconCSS-string default-
///
///Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like “autoâ€, “100%â€, “100px†as string type and “100â€, “500†as integer type.
///
height-string|number default-
///
///Specifies the HTML Attributes of the Dialog.
///
htmlAttributes-any default-{}
///
///Enable or disables responsive behavior.
///
isResponsive-boolean default-
///
///Default Value:{:.param}“en-USâ€
///
locale-string default-
///
///Sets the maximum height for the dialog widget.
///
maxHeight-string|number default-
///
///Sets the maximum width for the dialog widget.
///
maxWidth-string|number default-
///
///Sets the minimum height for the dialog widget.
///
minHeight-string|number default-
///
///Sets the minimum width for the dialog widget.
///
minWidth-string|number default-
///
///Displays the Dialog widget at the given X and Y position.
///
position-any default-
///
///Shows or hides the dialog header.
///
showHeader-boolean default-
///
///The Dialog widget can be opened by default i.e. on initialization, when it is set to true.
///
showOnInit-boolean default-
///
///Enables or disables the rounder corner.
///
showRoundedCorner-boolean default-
///
///The selector for the container element. If this property is set, the dialog will be displayed (positioned) based on its container.
///
target-string default-
///
///The title text to be displayed in the dialog header. In order to set title, you need to set showHeader as true since the title will be displayed in the dialog header.
///
title-string default-
///
///Add or configure the tooltip text for actionButtons in the dialog header.
///
tooltip-any default-
///
///Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like “autoâ€, “100%â€, “100px†as string type and “100â€, “500†as integer type.
///
width-string|number default-
///
///Sets the z-index value for the Dialog widget.
///
zIndex-number default-
///
///Sets the Footer for the Dialog widget.
///
showFooter-boolean default-
///
///Sets the FooterTemplate for the Dialog widget.
///
footerTemplateId-string default-
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
DigitalGauge:function(){
///
/// Constructor of ej.DigitalGauge
///
}
});
ej.DigitalGauge=(function(){
var original=ej.DigitalGauge
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
destroy:function(){
///
///
/// To destroy the digital gauge
///
},
exportImage:function(fileName, fileType){
///
///
/// To export Digital Gauge as Image
///
/// fileName for the Image
///
///
///
/// To export Digital Gauge as Image
///
/// fileType for the Image
///
},
getPosition:function(itemIndex){
///
///
/// Gets the location of an item that is displayed on the gauge.
///
/// Position value of an item that is displayed on the gauge.
///
},
getValue:function(itemIndex){
///
///
/// ClientSideMethod getValue Gets the value of an item that is displayed on the gauge
///
/// Index value of an item that displayed on the gauge
///
},
refresh:function(){
///
///
/// Refresh the digital gauge widget
///
},
setPosition:function(itemIndex, value){
///
///
/// ClientSideMethod Set Position Sets the location of an item to be displayed in the gauge
///
/// Index value of the digital gauge item
///
///
///
/// ClientSideMethod Set Position Sets the location of an item to be displayed in the gauge
///
/// Location value of the digital gauge
///
},
setValue:function(itemIndex, value){
///
///
/// ClientSideMethod SetValue Sets the value of an item to be displayed in the gauge.
///
/// Index value of the digital gauge item
///
///
///
/// ClientSideMethod SetValue Sets the value of an item to be displayed in the gauge.
///
/// Text value to be displayed in the gaugeS
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDigitalGauge=function(){
this.data("ejDigitalGauge",new ej.DigitalGauge());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDigitalGauge :function (options) {
///
///
///The Digital gauge can be easily configured to the DOM element, such as div. you can create a digital gauge with a highly customizable look and feel.
///This provides options for customizing export settings
///
exportSettings-ExportSettings default-
///
///Specifies the downloading filename
///
filename-string default-DigitalGauge
///
///Specifies the format of the file to export
///
type-ej.datavisualization.DigitalGauge.ExportingType|string default-png
///
///Specifies the name of the action URL
///
action-string default-
///
///Specifies the mode of exporting
///
mode-ej.datavisualization.DigitalGauge.ExportingMode|string default-client
///
///Specifies the frame of the Digital gauge.
///
frame-Frame default-{backgroundImageUrl: null, innerWidth: 6, outerWidth: 10}
///
///Specifies the URL of an image to be displayed as background of the Digital gauge.
///
backgroundImageUrl-string default-null
///
///Specifies the inner width for the frame, when the background image has been set for the Digital gauge..
///
innerWidth-number default-6
///
///Specifies the outer width of the frame, when the background image has been set for the Digital gauge.
///
outerWidth-number default-10
///
///Specifies the height of the DigitalGauge.
///
height-number default-150
///
///Specifies the resize option of the DigitalGauge.
///
isResponsive-boolean default-false
///
///Specifies the responsiveness of the Digital gauge
///
enableResize-boolean default-false
///
///Specifies the items for the DigitalGauge.
///
items-Array<Items> default-null
///
///Specifies the Character settings for the DigitalGauge.
///
characterSettings-any default-null
///
///Specifies the CharacterCount value for the DigitalGauge.
///
count-number default-4
///
///Specifies the opacity value for the DigitalGauge.
///
opacity-number default-1
///
///Specifies the value for spacing between the characters
///
spacing-number default-2
///
///Specifies the character type for the text to be displayed.
///
type-ej.datavisualization.DigitalGauge.CharacterType|string default-ej.datavisualization.DigitalGauge.CharacterType.EightCrossEightDotMatrix
///
///Enable/Disable the custom font to be applied to the text in the gauge.
///
enableCustomFont-boolean default-false
///
///Set the specific font for the text, when the enableCustomFont is set to true
///
font-any default-null
///
///Set the font family value
///
fontFamily-string default-Arial
///
///Set the font style for the font
///
fontStyle-ej.datavisualization.DigitalGauge.FontStyle|string default-italic
///
///Set the font size value
///
size-string default-11px
///
///Set the location for the text, where it needs to be placed within the gauge.
///
position-any default-null
///
///Set the horizontal location for the text, where it needs to be placed within the gauge.
///
x-number default-0
///
///Set the vertical location for the text, where it needs to be placed within the gauge.
///
y-number default-0
///
///Set the segment settings for the digital gauge.
///
segmentSettings-any default-null
///
///Set the color for the text segments.
///
color-string default-null
///
///Set the gradient for the text segments.
///
gradient-any default-null
///
///Set the length for the text segments.
///
length-number default-2
///
///Set the opacity for the text segments.
///
opacity-number default-0
///
///Set the spacing for the text segments.
///
spacing-number default-1
///
///Set the width for the text segments.
///
width-number default-1
///
///Set the value for enabling/disabling the blurring effect for the shadows of the text
///
shadowBlur-number default-0
///
///Specifies the color of the text shadow.
///
shadowColor-string default-null
///
///Set the x offset value for the shadow of the text, indicating the location where it needs to be displayed.
///
shadowOffsetX-number default-1
///
///Set the y offset value for the shadow of the text, indicating the location where it needs to be displayed.
///
shadowOffsetY-number default-1
///
///Set the alignment of the text that is displayed within the gauge.See TextAlign
///
textAlign-string default-left
///
///Specifies the color of the text.
///
textColor-string default-null
///
///Specifies the text value.
///
value-string default-null
///
///Specifies the matrixSegmentData for the DigitalGauge.
///
matrixSegmentData-any default-
///
///Specifies the segmentData for the DigitalGauge.
///
segmentData-any default-
///
///Specifies the themes for the Digital gauge. See Themes
///
themes-string default-flatlight
///
///Specifies the value to the DigitalGauge.
///
value-string default-text
///
///Specifies the width for the Digital gauge.
///
width-number default-400
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
DocumentEditor:function(){
///
/// Constructor of ej.DocumentEditor
///
}
});
ej.DocumentEditor=(function(){
var original=ej.DocumentEditor
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
load:function(path){
///
///
/// Loads the document from specified path using web API provided by importUrl.
///
/// Specifies the file path.
///
},
getCurrentPageNumber:function(){
///
///
/// Gets the page number of current selection in the document.
///
},
getPageCount:function(){
///
///
/// Gets the total number of pages in the document.
///
},
getSelectedText:function(){
///
///
/// Gets the text of current selection in the document.
///
},
getZoomFactor:function(){
///
///
/// Gets the current zoom factor value of the document editor.
///
},
setZoomFactor:function(factor){
///
///
/// Scales the document editor with the specified zoom factor. The range of zoom factor should be 0.10 to 5.00 (10 - 500 %).
///
/// Specifies the factor for zooming.
///
},
print:function(){
///
///
/// Prints the document content as page by page.
///
},
find:function(text){
///
///
/// Finds the first occurrence of specified text from current selection and highlights the result. If the document end is reached, find operation will occur from the document start position.
///
/// Specifies the text to search in a document.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDocumentEditor=function(){
this.data("ejDocumentEditor",new ej.DocumentEditor());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDocumentEditor :function (options) {
///
///
///Document Editor JS is an editor component to view and print DOCX, DOC, RTF and Text documents.
///Gets or sets an object that indicates initialization of importing and exporting documents in document editor.
///
importExportSettings-ImportExportSettings default-
///
///Gets or sets URL of Web API that should be used to parse the document while loading.
///
importUrl-string default-
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Draggable:function(){
///
/// Constructor of ej.Draggable
///
}
});
ej.Draggable=(function(){
var original=ej.Draggable
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
destroy:function(){
///
///
/// destroy in the draggable.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDraggable=function(){
this.data("ejDraggable",new ej.Draggable());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDraggable :function (options) {
///
///
///Plugin to make any DOM element draggable.
///If clone is specified.
///
clone-boolean default-false
///
///Sets the offset of the dragging helper relative to the mouse cursor.
///
cursorAt-any default-{ top: -1, left: -2 }
///
///Distance in pixels after mousedown the mouse must move before dragging should start. This option can be used to prevent unwanted drags when clicking on an element.
///
distance-number default-1
///
///The drag area is used to restrict the dragging element bounds.Specify the id of the container within which the element should be dragged.
///
dragArea-boolean default-null
///
///If specified, restricts drag start click to the specified element(s).
///
handle-string default-null
///
///Used to group sets of draggable and droppable items, in addition to droppable's accept option. A draggable with the same scope value as a droppable will be accepted by the droppable.
///
scope-string default-'default'
///
///Used to enable auto scroll while drag and drop the element.
///
autoScroll-boolean default-'false'
///
///Represents when to start the scrolling inside the scroll container on dragging
///
scrollSensitivity-number default-'20'
///
///Specifies how much distance of scroll should move on dragging once reached scroll sensitivity area.
///
scrollSpeed-number default-'20'
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
DropDownList:function(){
///
/// Constructor of ej.DropDownList
///
}
});
ej.DropDownList=(function(){
var original=ej.DropDownList
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
addItem:function(data){
///
///
/// Adding a single item or an array of items into the DropDownList allows you to specify all the field attributes such as value, template, image URL, and HTML attributes for those items.Grouping and sorting will not be supported when we add items through this method.
///
/// this parameter should have field attributes with respect to mapped field attributes and it's corresponding values to fields
///
},
checkAll:function(){
///
///
/// This method is used to select all the items in the DropDownList.
///
},
clearText:function(){
///
///
/// Clears the text in the DropDownList textbox.
///
},
destroy:function(){
///
///
/// Destroys the DropDownList widget.
///
},
disable:function(){
///
///
/// This property is used to disable the DropDownList widget.
///
},
disableItemsByIndices:function(index){
///
///
/// This property disables the set of items in the DropDownList.
///
/// disable the given index list items
///
},
enable:function(){
///
///
/// This property enables the DropDownList control.
///
},
enableItemsByIndices:function(index){
///
///
/// Enables an Item or set of Items that are disabled in the DropDownList
///
/// enable the given index list items if it's disabled
///
},
getItemDataByValue:function(value){
///
///
/// This method retrieves the items using given value.
///
/// Return the whole object of data based on given value
///
},
getListData:function(){
///
///
/// This method is used to retrieve the items that are bound with the DropDownList.
///
},
getSelectedItem:function(){
///
///
/// This method is used to get the selected items in the DropDownList.
///
},
getSelectedValue:function(){
///
///
/// This method is used to retrieve the items value that are selected in the DropDownList.
///
},
hidePopup:function(){
///
///
/// This method hides the suggestion popup in the DropDownList.
///
},
selectItemsByIndices:function(index){
///
///
/// This method is used to select the list of items in the DropDownList through the Index of the items.
///
/// select the given index list items
///
},
selectItemByText:function(index){
///
///
/// This method is used to select an item in the DropDownList by using the given text value.
///
/// select the list items relates to given text
///
},
selectItemByValue:function(index){
///
///
/// This method is used to select an item in the DropDownList by using the given value.
///
/// select the list items relates to given values
///
},
showPopup:function(){
///
///
/// This method shows the DropDownList control with the suggestion popup.
///
},
unCheckAll:function(){
///
///
/// This method is used to unselect all the items in the DropDownList.
///
},
unselectItemsByIndices:function(index){
///
///
/// This method is used to unselect the list of items in the DropDownList through Index of the items.
///
/// unselect the given index list items
///
},
unselectItemByText:function(index){
///
///
/// This method is used to unselect an item in the DropDownList by using the given text value.
///
/// unselect the list items relates to given text
///
},
unselectItemByValue:function(index){
///
///
/// This method is used to unselect an item in the DropDownList by using the given value.
///
/// unselect the list items relates to given values
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDropDownList=function(){
this.data("ejDropDownList",new ej.DropDownList());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDropDownList :function (options) {
///
///
///The DropDownList control provides a list of options to choose an item from the list. It can including other HTML elements such as images, textboxes, check box, radio buttons, and so on.
///The Virtual Scrolling(lazy loading) feature is used to display a large amount of data that you require without buffering the entire load of a huge database records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true.
///
allowVirtualScrolling-boolean default-false
///
///The cascading DropDownLists is a series of two or more DropDownLists in which each DropDownList is filtered according to the previous DropDownList’s value.
///
cascadeTo-string default-null
///
///Sets the case sensitivity of the search operation. It supports both enableFilterSearch and enableIncrementalSearch property.
///
caseSensitiveSearch-boolean default-false
///
///Dropdown widget's style and appearance can be controlled based on 13 different default built-in themes.You can customize the appearance of the dropdown by using the cssClass property. You need to specify a class name in the cssClass property and the same class name is used before the class definitions wherever the custom styles are applied.
///
cssClass-string default-
///
///This property is used to serve data from the data services based on the query provided. To bind the data to the dropdown widget, the dataSource property is assigned with the instance of the ej.DataManager.
///
dataSource-any default-null
///
///Sets the separator when the multiSelectMode with delimiter option or checkbox is enabled with the dropdown. When you enter the delimiter value, the texts after the delimiter are considered as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,) or semi-colon (;) or any other special character.
///
delimiterChar-string default-','
///
///The enabled Animation property uses the easeOutQuad animation to SlideDown and SlideUp the Popup list in 200 and 100 milliseconds, respectively.
///
enableAnimation-boolean default-false
///
///This property is used to indicate whether the DropDownList control responds to the user interaction or not. By default, the control is in the enabled mode and you can disable it by setting it to false.
///
enabled-boolean default-true
///
///Specifies to perform incremental search for the selection of items from the DropDownList with the help of this property. This helps in selecting the item by using the typed character.
///
enableIncrementalSearch-boolean default-true
///
///This property selects the item in the DropDownList when the item is entered in the Search textbox.
///
enableFilterSearch-boolean default-false
///
///The serverfiltering is to perform filter action when text is typed in the search box and filtering will be done based on the collection which contains the matched item from entire datasource. Serverfiltering will be done based on the entire items in DataSource.
///
enableServerFiltering-boolean default-false
///
///Saves the current model value to the browser cookies for state maintenance. While refreshing the DropDownList control page, it retains the model value and it is applied from the browser cookies.
///
enablePersistence-boolean default-false
///
///This enables the resize handler to resize the popup to any size.
///
enablePopupResize-boolean default-false
///
///Sets the DropDownList textbox direction from right to left align.
///
enableRTL-boolean default-false
///
///This property is used to sort the Items in the DropDownList. By default, it sorts the items in an ascending order.
///
enableSorting-boolean default-false
///
///The property is used to determine whether the popup list is generated dynamically.
///
loadOnDemand-boolean default-false
///
///Specifies the mapping fields for the data items of the DropDownList.
///
fields-Fields default-null
///
///Used to group the items.
///
groupBy-string default-
///
///Defines the HTML attributes such as ID, class, and styles for the item.
///
htmlAttributes-any default-
///
///Defines the ID for the tag.
///
id-string default-
///
///Defines the image attributes such as height, width, styles, and so on.
///
imageAttributes-string default-
///
///Defines the imageURL for the image location.
///
imageUrl-string default-
///
///Defines the tag value to be selected initially.
///
selected-boolean default-
///
///Defines the sprite CSS for the image tag.
///
spriteCssClass-string default-
///
///Defines the table name for tag value or display text while rendering remote data.
///
tableName-string default-
///
///Defines the text content for the tag.
///
text-string default-
///
///Defines the tag value.
///
value-string default-
///
///When the enableFilterSearch property value is set to true, the values in the DropDownList shows the items starting with or containing the key word/letter typed in the Search textbox.
///
filterType-ej.FilterType|string default-ej.FilterType.Contains
///
///Used to create visualized header for dropdown items
///
headerTemplate-string default-null
///
///Defines the height of the DropDownList textbox.
///
height-string|number default-null
///
///It sets the given HTML attributes for the DropDownList control such as ID, name, disabled, etc.
///
htmlAttributes-any default-null
///
///Data can be fetched in the DropDownList control by using the DataSource, specifying the number of items.
///
itemsCount-number default-5
///
///Allows the user to set the particular country or region language for the DropDownList.
///
locale-string default-en-US
///
///Defines the maximum height of the suggestion box. This property restricts the maximum height of the popup when resize is enabled.
///
maxPopupHeight-string|number default-null
///
///Defines the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled.
///
minPopupHeight-string|number default-null
///
///Defines the maximum width of the suggestion box. This property restricts the maximum width of the popup when resize is enabled.
///
maxPopupWidth-string|number default-null
///
///Defines the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled.
///
minPopupWidth-string|number default-0
///
///With the help of this property, you can make a single or multi selection with the DropDownList and display the text in two modes, delimiter and visual mode. In delimiter mode, you can separate the items by using the delimiter character such as comma (,) or semi-colon (;) or any other special character. In the visual mode, the items are showcased like boxes with close icon in the textbox.
///
multiSelectMode-ej.MultiSelectMode|string default-ej.MultiSelectMode.None
///
///Defines the height of the suggestion popup box in the DropDownList control.
///
popupHeight-string|number default-152px
///
///Defines the width of the suggestion popup box in the DropDownList control.
///
popupWidth-string|number default-auto
///
///Specifies the query to retrieve the data from the DataSource.
///
query-any default-null
///
///Specifies that the DropDownList textbox values should be read-only.
///
readOnly-boolean default-false
///
///Specifies an item to be selected in the DropDownList.
///
selectedIndex-number default-null
///
///Specifies the selectedItems for the DropDownList.
///
selectedIndices-Array<any> default-[]
///
///Selects multiple items in the DropDownList with the help of the checkbox control. To achieve this, enable the showCheckbox option to true.
///
showCheckbox-boolean default-false
///
///DropDownList control is displayed with the popup seen.
///
showPopupOnLoad-boolean default-false
///
///DropDownList textbox displayed with the rounded corner style.
///
showRoundedCorner-boolean default-false
///
///When the enableSorting property value is set to true, this property helps to sort the items either in ascending or descending order
///
sortOrder-ej.SortOrder|string default-ej.SortOrder.Ascending
///
///Specifies the targetID for the DropDownList’s items.
///
targetID-string default-null
///
///By default, you can add any text or image to the DropDownList item. To customize the item layout or to create your own visualized elements, you can use this template support.
///
template-string default-null
///
///Defines the text value that is displayed in the DropDownList textbox.
///
text-string default-null
///
///Sets the jQuery validation error message in the DropDownList
///
validationMessage-any default-null
///
///Sets the jQuery validation rules in the Dropdownlist.
///
validationRules-any default-null
///
///Specifies the value (text content) for the DropDownList control.
///
value-string|number default-null
///
///Specifies a short hint that describes the expected value of the DropDownList control.
///
watermarkText-string default-null
///
///Defines the width of the DropDownList textbox.
///
width-string|number default-null
///
///The Virtual Scrolling feature is used to display a large amount of records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. You can set the itemsCount property that represents the number of items to be fetched from the server on every AJAX request.
///
virtualScrollMode-ej.VirtualScrollMode|string default-normal
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
DropDownTree:function(){
///
/// Constructor of ej.DropDownTree
///
}
});
ej.DropDownTree=(function(){
var original=ej.DropDownTree
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
checkAll:function(){
///
///
/// Checks all the nodes in the DropDownTree.
///
},
checkNode:function(element){
///
///
/// Checks a node in the DropDownTree.
///
/// ID of the DropDownTree node/object of the DropDownTree node/collection of the ID/object of the DropDownTree nodes.
///
},
clearText:function(){
///
///
/// Clears the text in the DropDownTree.
///
},
destroy:function(){
///
///
/// Destroys the DropDownTree control.
///
},
getValue:function(){
///
///
/// Returns the selected value.
///
},
hidePopup:function(){
///
///
/// Hides the popup in the DropDownTree.
///
},
moveNode:function(sourceNode, destinationNode, index){
///
///
/// Moves the DropDownTree node within the same DropDownTree. The new position of the given DropDownTree node will be based on destination node and index position.
///
/// ID of the DropDownTree node/object of the DropDownTree node.
///
///
///
/// Moves the DropDownTree node within the same DropDownTree. The new position of the given DropDownTree node will be based on destination node and index position.
///
/// ID of the DropDownTree node/object of the DropDownTree node.
///
///
///
/// Moves the DropDownTree node within the same DropDownTree. The new position of the given DropDownTree node will be based on destination node and index position.
///
/// New index position of the given source node.
///
},
removeAll:function(){
///
///
/// Removes all the nodes in the DropDownTree.
///
},
removeNode:function(element){
///
///
/// Removes a node in the DropDownTree.
///
/// ID of the DropDownTree node/object of the DropDownTree node/collectionof the ID/object of the DropDownTree nodes.
///
},
selectAll:function(){
///
///
/// Selects all the DropDownTree nodes when allowMultiSelection field is enabled in the treeViewSettings property.
///
},
selectNode:function(element){
///
///
/// Selects a node in the DropDownTree control. To select the collection of nodes in the DropDownTree control, enable allowMultiSelection field of the treeViewSettings property.
///
/// ID of the DropDownTree node/object of the DropDownTree node/ collection of I the D/object of the DropDownTree nodes.
///
},
showPopup:function(){
///
///
/// Shows the DropDownTree control with the popup.
///
},
unCheckAll:function(){
///
///
/// Unchecks all the nodes in the DropDownTree.
///
},
unCheckNode:function(element){
///
///
/// Unchecks a node in the DropDownTree.
///
/// ID of the DropDownTree node/object of the DropDownTree node/collection of the ID/object of the DropDownTree nodes.
///
},
unselectAll:function(){
///
///
/// Unselects all the DropDownTree nodes when allowMultiSelection field of the treeViewSettings property is enabled.
///
},
unselectNode:function(element){
///
///
/// Unselects a node in the DropDownTree control. To unselect the collection of nodes in the DropDownTree control, enable allowMultiSelection field of the treeViewSettings property.
///
/// ID of the DropDownTree node/object of the DropDownTree node/ collection of the ID/object of the DropDownTree nodes.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDropDownTree=function(){
this.data("ejDropDownTree",new ej.DropDownTree());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDropDownTree :function (options) {
///
///
///The DropDownTree control provides a list of hierarchical data to choose an item from the list.It can including other HTML elements such as images, textboxes, check box, radio buttons, and so on.
///Uses the keyboard for any action, including opening and closing the drop-down tree; navigating, expanding, and collapsing nodes of the dropdown tree; and more.
///
allowKeyboardNavigation-boolean default-true
///
///Sets the root CSS class for DropDownTree that allows customization of appearance.
///
cssClass-string default-``
///
///Sets the separator when the multiSelectMode with delimiter option or checkbox is enabled. When you enter the delimiter value, the text after the delimiter is considered as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,), semi-colon (;), or any other special character.
///
delimiter-string default-,
///
///Indicates whether the DropDownTree control responds to user interaction or not. By default, the control is in the enabled mode and can be disabled by setting this to false.
///
enabled-boolean default-true
///
///The enabled animation property uses the easeOutQuad animation to SlideDown and SlideUp the popup wrapper in 200 and 100 milliseconds, respectively.
///
enableAnimation-boolean default-false
///
///Gets or sets a value that indicates whether to continue the DropDownTree model state in the page using applicable medium, i.e., HTML5 localStorage or cookies.
///
enablePersistence-boolean default-false
///
///Sets the DropDownTree textbox direction from right to left alignment.
///
enableRTL-boolean default-false
///
///Creates footer with text or HTML elements for the dropdown items.
///
footerTemplate-string default-null
///
///Serves as a patch of the entries comprising the path (that is set in the entry area) of the selected node.
///
fullPathDelimiter-string default-'/'
///
///Creates header with text or HTML elements for the dropdown items.
///
headerTemplate-string default-null
///
///Defines the height of the DropDownTree textbox.
///
height-string|number default-
///
///Allows you to set a particular country or regional language for the DropDownTree.
///
locale-string default-en-US
///
///Customizes the height and width of the popup wrapper.
///
popupSettings-PopupSettings default-{height: '152px',width: 'auto',showPopupOnLoad: false}
///
///Defines the height of the popup wrapper in the DropDownTree control.
///
height-string|number default-
///
///Defines the width of the popup wrapper in the DropDownTree control.
///
width-string|number default-
///
///The DropDownTree control is displayed with the popup.
///
showPopupOnLoad-boolean default-
///
///Specifies that the DropDownTree textbox values should be read-only.
///
readOnly-boolean default-false
///
///The DropDownTree's textbox is displayed with rounded corner style.
///
showRoundedCorner-boolean default-false
///
///Specifies the targetID for the DropDownTree's items.
///
targetID-string default-null
///
///Specifies the delimiter between nodes (indicating their hierarchy).
///
textMode-ej.Textmode|string default-ej.DropDownTree.TextMode.none
///
///Sets the jQuery validation error message in the DropDownTree.
///
validationMessage-any default-null
///
///Sets the jQuery validation rules in the DropDownTree.
///
validationRules-any default-null
///
///Specifies the value (text content) for the DropDownTree control. For the single selection mode, the selected item's value will be returned in its data type, and for MultiSelectMode, returns the selected items values separated by delimiter in string type.
///
value-string default-null
///
///Specifies a short hint that describes the expected value of the DropDownTree control.
///
watermarkText-string default-null
///
///Defines the width of the DropDownTree textbox.
///
width-string|number default-100%
///
///Defines the popup settings of the DropDownTree widget. You can use any property which are in treeview using this property.
///
treeViewSettings-any default-{}
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Droppable:function(){
///
/// Constructor of ej.Droppable
///
}
});
ej.Droppable=(function(){
var original=ej.Droppable
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
destroy:function(){
///
///
/// destroy in the Droppable.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejDroppable=function(){
this.data("ejDroppable",new ej.Droppable());
return this;
};
intellisense.annotate(jQuery.fn,{
ejDroppable :function (options) {
///
///
///Plugin to make any DOM element Droppable.
///Used to accept the specified draggable items.
///
accept-any default-null
///
///Used to group sets of droppable items, in addition to droppable's accept option. A draggable with the same scope value as a droppable will be accepted by the droppable.
///
scope-string default-'default'
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
FileExplorer:function(){
///
/// Constructor of ej.FileExplorer
///
}
});
ej.FileExplorer=(function(){
var original=ej.FileExplorer
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
adjustSize:function(){
///
///
/// Refresh the size of FileExplorer control.
///
},
disableMenuItem:function(item){
///
///
/// Disable the particular context menu item.
///
/// Id of the menu item/ Menu element to be disabled
///
},
disableToolbarItem:function(item){
///
///
/// Disable the particular toolbar item.
///
/// Id of the toolbar item/ Tool item element to be disabled
///
},
enableMenuItem:function(item){
///
///
/// Enable the particular context menu item.
///
/// Id of the menu item/ Menu element to be Enabled
///
},
enableToolbarItem:function(item){
///
///
/// Enable the particular toolbar item
///
/// Id of the tool item/ Tool item element to be Enabled
///
},
refresh:function(){
///
///
/// Refresh the content of the selected folder in FileExplorer control.
///
},
removeToolbarItem:function(item){
///
///
/// Remove the particular toolbar item.
///
/// Id of the tool item/ tool item element to be removed
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejFileExplorer=function(){
this.data("ejFileExplorer",new ej.FileExplorer());
return this;
};
intellisense.annotate(jQuery.fn,{
ejFileExplorer :function (options) {
///
///
///FileExplorer provides a Windows Explorer-like functionality for any web application. It allows end-users to browse, select and upload files or change the folder structure by renaming, moving and deleting files or folders. File and folder management capabilities are fully customizable and can be disabled when necessary.
///Sets the URL of server side AJAX handling method that handles file operation like Read, Remove, Rename, Create, Upload, Download, Copy and Move in FileExplorer.
///
ajaxAction-string default-
///
///Specifies the data type of server side AJAX handling method.
///
ajaxDataType-string default-json
///
///By using ajaxSettings property, you can customize the AJAX configurations. Normally you can customize the following option in AJAX handling data, URL, type, async, contentType, dataType and success. For upload, download and getImage API, you can only customize URL.
///
ajaxSettings-any default-{ read: {}, createFolder: {}, remove: {}, rename: {}, paste: {}, getDetails: {}, download: {}, upload: {}, getImage: {}, search: {}}
///
///The FileExplorer allows to move the files from one folder to another folder of FileExplorer by using drag and drop option. Also it supports to upload a file by dragging it from windows explorer to the necessary folder of ejFileExplorer.
///
allowDragAndDrop-boolean default-true
///
///Gets or sets a value that indicates whether to enable keyboard support for FileExplorer actions.
///
allowKeyboardNavigation-boolean default-true
///
///The FileExplorer allows to select multiple files by enabling the allowMultiSelection property. You can perform multi selection by pressing the Ctrl key or Shift key.
///
allowMultiSelection-boolean default-true
///
///By using the contextMenuSettings property, you can customize the ContextMenu in the FileExplorer control.
///
contextMenuSettings-ContextMenuSettings default-
///
///The items property is used to configure and group the required ContextMenu items in FileExplorer control.
///
items-any default-{% highlight javascript %}{navbar: [NewFolder, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, Getinfo],cwd: [Refresh, Paste,|, SortBy, |, NewFolder, Upload, |, Getinfo],files: [Open, Download, |, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, OpenFolderLocation, Getinfo]}{% endhighlight %}
///
///The customMenuFields property is used to define custom functionality for custom ContextMenu item's which are defined in items property.
///
customMenuFields-Array<any> default-[]
///
///Sets the root class for FileExplorer theme. This cssClass API allows to use custom skinning option for File Explorer control. By defining the root class by using this API, you have to include this root class in CSS.
///
cssClass-string default-
///
///Specify the enablePersistence to FileExplorer to save the current model value in browser cookies for state maintains.
///
enablePersistence-boolean default-false
///
///Enables or disables the resize support in FileExplorer control.
///
enableResize-boolean default-false
///
///Enables or disables the Right to Left alignment support in FileExplorer control.
///
enableRTL-boolean default-false
///
///Enables or disables the thumbnail image compression option in FileExplorer control. By enabling this option, you can reduce the thumbnail image size while loading.
///
enableThumbnailCompress-boolean default-false
///
///Allows specified type of files only to display in FileExplorer control.
///
fileTypes-string default-* . *
///
///By using filterSettings property, you can customize the search functionality of the search bar in FileExplorer control.
///
filterSettings-FilterSettings default-
///
///It allows to search the text given in search Textbox in every keyup event. When this property was set as false, searching will works only on Enter key and searchbar blur.
///
allowSearchOnTyping-boolean default-true
///
///Enables or disables to perform the filter operation with case sensitive.
///
caseSensitiveSearch-boolean default-false
///
///Sets the search filter type. There are several filter types available such as "startswith", "contains", "endswith". See filterType.
///
filterType-ej.FilterType|string default-ej.FileExplorer.filterType.Contains
///
///By using the gridSettings property, you can customize the grid behavior in the FileExplorer control.
///
gridSettings-GridSettings default-
///
///Allows to Resize the width of the columns by simply click and move the particular column header line.
///
allowResizing-boolean default-true
///
///Gets or sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header.
///
allowSorting-boolean default-true
///
///Gets or sets an object that indicates to render the grid with specified columns. You can use this property same as the column property in Grid control.
///
columns-Array<any> default-[{ field: name, headerText: Name, width: 30% }, { field: dateModified, headerText: Date Modified, width: 30% }, { field: type, headerText: Type, width: 15% }, { field: size, headerText: Size, width: 12%, textAlign: right, headerTextAlign: left }]
///
///Specifies the height of FileExplorer control.
///
height-string|number default-400
///
///Enables or disables the responsive support for FileExplorer control during the window resizing time.
///
isResponsive-boolean default-false
///
///Sets the file view type. There are three view types available such as Grid, Tile and Large icons. See layoutType.
///
layout-ej.FileExplorer.layoutType|string default-ej.FileExplorer.layoutType.Grid
///
///Sets the culture in FileExplorer.
///
locale-string default-en-US
///
///Sets the maximum height of FileExplorer control.
///
maxHeight-string|number default-null
///
///Sets the maximum width of FileExplorer control.
///
maxWidth-string|number default-null
///
///Sets the minimum height of FileExplorer control.
///
minHeight-string|number default-250px
///
///Sets the minimum width of FileExplorer control.
///
minWidth-string|number default-400px
///
///The property path denotes the filesystem path that are to be explored. The path for the filesystem can be physical path or relative path, but it has to be relevant to where the Web API is hosted.
///
path-string default-
///
///Sets the alias name of root folder name in FileExplorer. It is used to replace the actual root folder name in FileExplorer.
///
rootFolderName-string default-
///
///The selectedFolder is used to select the specified folder of FileExplorer control.
///
selectedFolder-string default-
///
///The selectedItems is used to select the specified items (file, folder) of FileExplorer control.
///
selectedItems-string|Array<any> default-
///
///Enables or disables the checkbox option in FileExplorer control.
///
showCheckbox-boolean default-true
///
///Enables or disables the context menu option in FileExplorer control.
///
showContextMenu-boolean default-true
///
///Enables or disables the footer in FileExplorer control. The footer element displays the details of the current selected files and folders. And also the footer having the switcher to change the layout view.
///
showFooter-boolean default-true
///
///FileExplorer control is displayed with rounded corner when this property is set to true.
///
showRoundedCorner-boolean default-false
///
///FileExplorer control is rendered with thumbnail preview of images in Tile and LargeIcons layout when this property set to true.
///
showThumbnail-boolean default-true
///
///Shows or disables the toolbar in FileExplorer control.
///
showToolbar-boolean default-true
///
///Enables or disables the navigation pane in FileExplorer control. The navigation pane contains a tree view element that displays all the folders from the filesystem in a hierarchical manner. This is useful to a quick navigation of any folder in the filesystem.
///
showNavigationPane-boolean default-true
///
///The tools property is used to configure and group required toolbar items in FileExplorer control.
///
tools-any default-{ creation: [NewFolder], navigation: [Back, Forward, Upward], addressBar: [Addressbar], editing: [Refresh, Upload, Delete, Rename, Download], copyPaste: [Cut, Copy, Paste], getProperties: [Details], searchBar: [Searchbar], layout: [Layout], sortBy: [SortBy]}
///
///The toolsList property is used to arrange the toolbar items in the FileExplorer control.
///
toolsList-Array<any> default-[layout, creation, navigation, addressBar, editing, copyPaste, sortBy, getProperties, searchBar]
///
///Gets or sets an object that indicates whether to customize the upload behavior in the FileExplorer.
///
uploadSettings-UploadSettings default-
///
///Enables or disables the multiple files upload. When it is enabled, you can upload multiple files at a time and when disabled, you can upload only one file at a time.
///
allowMultipleFile-boolean default-true
///
///Enables or disables the auto upload option while uploading files in FileExplorer control.
///
autoUpload-boolean default-false
///
///Specifies the actions for upload dialog during initialization.
///
dialogAction-any default-{ modal:false, closeOnComplete:false, content:null, drag:true }
///
///Specifies the position at which the upload dialog is displayed using X and Y values. X: Sets the left position value for dialog. Y: Sets the top position value for dialog.
///
dialogPosition-any default-null
///
///Specifies the maximum file size allowed to upload. It accepts the value in bytes.
///
maxFileSize-number default-31457280
///
///Specifies the file details which are to be displayed when selected for upload by setting the showFileDetails to true.
///
showFileDetails-boolean default-true
///
///Specifies the virtual item count for virtual support.
///
virtualItemCount-number default-0
///
///Specifies the width of FileExplorer control.
///
width-string|number default-850
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Gantt:function(){
///
/// Constructor of ej.Gantt
///
}
});
ej.Gantt=(function(){
var original=ej.Gantt
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
addRecord:function(data, rowPosition){
///
///
/// To add a new item in Gantt
///
/// Item to add in Gantt row.
///
///
///
/// To add a new item in Gantt
///
/// Defines in which position the row wants to add
///
},
cancelEdit:function(){
///
///
/// To cancel the edited state of an item in Gantt
///
},
clearFilter:function(){
///
///
/// To clear all the filtered columns in Gantt.
///
},
clearSorting:function(){
///
///
/// To clear the sorted columns in Gantt.
///
},
collapseAllItems:function(){
///
///
/// To collapse all the parent items in Gantt
///
},
deleteDependency:function(fromTaskId, toTaskId){
///
///
/// To delete the dependency between the two tasks.
///
/// taskID of predecessor task
///
///
///
/// To delete the dependency between the two tasks.
///
/// taskID of successor task
///
},
deleteItem:function(){
///
///
/// To delete a selected item in Gantt
///
},
destroy:function(){
///
///
/// destroy the Gantt widget all events bound using this._on will be unbind automatically and bring the control to pre-init state.
///
},
expandAllItems:function(){
///
///
/// To Expand all the parent items in Gantt
///
},
expandCollapseRecord:function(taskId){
///
///
/// To expand and collapse an item in Gantt using item's ID
///
/// Expand or Collapse a record based on task id.
///
},
export:function(action, serverEvent, multipleExport){
///
///
/// Export the Gantt content to excel or PDF document.
///
/// Pass the controller action name corresponding to exporting
///
///
///
/// Export the Gantt content to excel or PDF document.
///
/// optionalASP server event name corresponding to exporting
///
///
///
/// Export the Gantt content to excel or PDF document.
///
/// optionalPass the multiple exporting value as true/false
///
},
filterColumn:function(fieldName, filterOperator, filterValue, predicate, matchCase){
///
///
/// Sends filtering request to filter a column in Gantt dynamically.
///
/// Pass the field name of the column.
///
///
///
/// Sends filtering request to filter a column in Gantt dynamically.
///
/// string/integer/date operator.
///
///
///
/// Sends filtering request to filter a column in Gantt dynamically.
///
/// Pass the value to be filtered in a column.
///
///
///
/// Sends filtering request to filter a column in Gantt dynamically.
///
/// Optional - Pass the predicate as and/or.
///
///
///
/// Sends filtering request to filter a column in Gantt dynamically.
///
/// Optional - pass the match case value as true/false.
///
},
filterContent:function(ejPredicate){
///
///
/// To filter multiple columns with multiple conditions dynamically in Gantt.
///
/// Pass the filtering column details and conditions as ejPredicate instance. The ejPredicate object is defined as fieldName,filterOperator, filterValue and ignoreCase properties.
///
},
getColumns:function(){
///
///
/// To get available column collection in Gantt.
///
},
getResourceViewEditColumns:function(){
///
///
/// To get the column collection which are used to edit the task by using task add/edit dialog in resource view.
///
},
hideColumn:function(headerText){
///
///
/// To hide the column by using header text
///
/// you can pass a header text of a column to hide
///
},
indentItem:function(){
///
///
/// To indent a selected item in Gantt
///
},
openAddDialog:function(){
///
///
/// To Open the dialog to add new task to the Gantt
///
},
openEditDialog:function(){
///
///
/// To Open the dialog to edit existing task to the Gantt
///
},
outdentItem:function(){
///
///
/// To outdent a selected item in Gantt
///
},
saveEdit:function(){
///
///
/// To save the edited state of an item in Gantt
///
},
searchItem:function(searchString){
///
///
/// To search an item with search string provided at the run time
///
/// you can pass a text to search in Gantt Control.
///
},
selectCells:function(Indexes, preservePreviousSelectedCell){
///
///
/// To select cell based on the cell and row index dynamically.
///
/// array of cell indexes to be select
///
///
///
/// To select cell based on the cell and row index dynamically.
///
/// Defines that we need to preserve the previously selected cells of not
///
},
selectMultipleRows:function(rowIndexes){
///
///
/// To select multiple rows dynamically.
///
/// array of row indexes to select
///
},
setScrollTop:function(Top){
///
///
/// Method to set scroll top value for Gantt control.
///
/// Pass a value to set top position of vertical scroll bar.
///
},
setSplitterIndex:function(index){
///
///
/// Positions the splitter by the specified column index.
///
/// Set the splitter position based on column index.
///
},
setSplitterPosition:function(width){
///
///
/// To set the grid width in Gantt
///
/// you can give either percentage or pixels value
///
},
showColumn:function(headerText){
///
///
/// To show the column by using header text
///
/// you can pass a header text of a column to show
///
},
showCriticalPath:function(isShown){
///
///
/// To show/hide the critical tasks in current project.
///
/// To show/hide the critical tasks
///
},
sortColumn:function(mappingName, columnSortDirection){
///
///
/// To sort the column in required direction
///
/// Defines the column's mapping name in which sorting have to be performed
///
///
///
/// To sort the column in required direction
///
/// Defines the sort direction whether the column has to sorted in ascending/descending order. By default it is sorting in an ascending order
///
},
updateDependency:function(fromTaskId, toTaskId, predecessorType, offset){
///
///
/// To update the predecessor type and offset value for existing task dependency.
///
/// taskID of predecessor task
///
///
///
/// To update the predecessor type and offset value for existing task dependency.
///
/// taskID of successor task
///
///
///
/// To update the predecessor type and offset value for existing task dependency.
///
/// Type of dependency task.
///
///
///
/// To update the predecessor type and offset value for existing task dependency.
///
/// Offset value of dependency task.
///
},
updateRecordByTaskId:function(data){
///
///
/// To update the value of Gantt record by using it's task id value.
///
/// object with modified field values and current task id value
///
},
updateRecordByIndex:function(index, data){
///
///
/// To update the value of Gantt record by using row index.
///
/// index of Gantt record to be updated
///
///
///
/// To update the value of Gantt record by using row index.
///
/// object with modified field value
///
},
updateScheduleDates:function(startDate, endDate){
///
///
/// To update the schedule start date and schedule end date of project.
///
/// New schedule start date of project
///
///
///
/// To update the schedule start date and schedule end date of project.
///
/// New schedule end date of project
///
},
updateTaskId:function(currentId, newId){
///
///
/// To change an existing Gantt ID by new ID value dynamically
///
/// you can pass an existing ID value to be change
///
///
///
/// To change an existing Gantt ID by new ID value dynamically
///
/// you can pass a new ID value to be change
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejGantt=function(){
this.data("ejGantt",new ej.Gantt());
return this;
};
intellisense.annotate(jQuery.fn,{
ejGantt :function (options) {
///
///
///The Essential JavaScript Gantt control is designed to visualize and edit the project schedule, and track the project progress.
///Specifies the fields to be included in the add dialog in Gantt
///
addDialogFields-Array<AddDialogFields> default-[]
///
///Specifies mapping name to include required fields in Gantt
///
field-string default-
///
///Specifies editType of fields to be included in the add dialog in Gantt
///
editType-string default-
///
///Specifies the custom column field was displayed in General tab of add dialog or not.
///
displayInGeneralTab-boolean default-false
///
///Enables or disables the ability to resize column.
///
allowColumnResize-boolean default-false
///
///Enables or disables the ability to drag and drop the row interactively to reorder the rows
///
allowDragAndDrop-boolean default-false
///
///Enables or Disables Gantt chart editing in Gantt
///
allowGanttChartEditing-boolean default-true
///
///Enables or Disables Keyboard navigation in Gantt
///
allowKeyboardNavigation-boolean default-true
///
///Specifies enabling or disabling multiple sorting for Gantt columns
///
allowMultiSorting-boolean default-false
///
///Enables or disables the option for multiple exporting
///
allowMultipleExporting-boolean default-false
///
///Enables or disables the interactive selection of a row.
///
allowSelection-boolean default-true
///
///Enables or disables sorting. When enabled, we can sort the column by clicking on the column.
///
allowSorting-boolean default-false
///
///Enables or disables the rendering of unscheduled tasks.
///
allowUnscheduledTask-boolean default-false
///
///Specifies the baseline background color in Gantt
///
baselineColor-string default-#fba41c
///
///Specifies the mapping property path for baseline end date in datasource
///
baselineEndDateMapping-string default-
///
///Specifies the mapping property path for baseline start date of a task in datasource
///
baselineStartDateMapping-string default-
///
///Specifies the template for cell tooltip
///
cellTooltipTemplate-string default-null
///
///Specifies the mapping property path for sub tasks in datasource
///
childMapping-string default-
///
///To Specify the column fields to be displayed in the dialog while inserting a column using column menu.
///
columnDialogFields-Array<any> default-[]
///
///Specifies the background of connector lines in Gantt
///
connectorLineBackground-string default-
///
///Specifies the width of the connector lines in Gantt
///
connectorlineWidth-number default-1
///
///Specify the CSS class for Gantt to achieve custom theme.
///
cssClass-string default-
///
///Collection of data or hierarchical data to represent in Gantt
///
dataSource-Array<any> default-null
///
///Specifies the dateFormat for Gantt , given format is displayed in tooltip , Grid .
///
dateFormat-string default-MM/dd/yyyy
///
///Specifies the customized working time for tasks in Gantt
///
dayWorkingTime-Array<any> default-[{ from: 08:00 AM, to: 12:00 PM , background: }, { from: 01:00 PM, to: 05:00 PM , background: }]
///
///Option for customizing the drag tooltip while reordering the rows.
///
dragTooltip-DragTooltip default-
///
///Specifies option to enable/disable tooltip while drag and drop a row.
///
showTooltip-boolean default-true
///
///Specifies the data source fields to be displayed in the drag tooltip.
///
tooltipItems-Array<any> default-[]
///
///Specifies the custom template for drag tooltip.
///
tooltipTemplate-string default-null
///
///Specifies the mapping property path for duration of a task in datasource
///
durationMapping-string default-
///
///Specifies the duration unit for each tasks whether days or hours or minutes
///
durationUnit-ej.Gantt.DurationUnit|string default-ej.Gantt.DurationUnit.Day
///
///Specifies the mapping property path for task duration unit in datasource
///
durationUnitMapping-string default-
///
///Specifies the fields to be included in the edit dialog in Gantt
///
editDialogFields-Array<EditDialogFields> default-[]
///
///Specifies mapping name to include required fields in Gantt
///
field-string default-
///
///Specifies editType of fields to be included in the edit dialog in Gantt
///
editType-string default-
///
///Specifies the custom column field was displayed in General tab of edit dialog or not.
///
displayInGeneralTab-boolean default-false
///
///Specifies the editSettings options in Gantt.
///
editSettings-EditSettings default-
///
///Enables or disables add record icon in Gantt toolbar
///
allowAdding-boolean default-false
///
///Enables or disables delete icon in Gantt toolbar
///
allowDeleting-boolean default-false
///
///Specifies the option for enabling or disabling editing in Gantt grid part
///
allowEditing-boolean default-false
///
///Specifies the option for enabling or disabling indent action in Gantt.
///
allowIndent-boolean default-false
///
///Specifies the mouse action whether single click or double click to begin the editing
///
beginEditAction-ej.Gantt.BeginEditAction|string default-ej.Gantt.BeginEditAction.DblClick
///
///Specifies the edit mode in Gantt, "normal" is for dialog editing ,"cellEditing" is for cell type editing
///
editMode-string default-normal
///
///Specifies the position where the new row has to be added.
///
rowPosition-ej.Gantt.RowPosition|string default-ej.Gantt.RowPosition.BelowSelectedRow
///
///Enable or disable the confirmation dialog while deleting the record.
///
showDeleteConfirmDialog-boolean default-false
///
///Enables or Disables enableAltRow row effect in Gantt
///
enableAltRow-boolean default-true
///
///Enables or disables the collapse all records when loading the Gantt.
///
enableCollapseAll-boolean default-false
///
///Enables or disables the contextmenu for Gantt , when enabled contextmenu appears on right clicking Gantt
///
enableContextMenu-boolean default-false
///
///Enable or disable predecessor validation. When it is true, all the task's start and end dates are aligned based on its predecessors start and end dates.
///
enablePredecessorValidation-boolean default-true
///
///Indicates whether we can edit the progress of a task interactively in Gantt.
///
enableProgressBarResizing-boolean default-true
///
///Enables or disables the option for dynamically updating the Gantt size on window resizing
///
enableResize-boolean default-false
///
///Enables or disables serial number column for Gantt. When enabled, the records will be number sequenced.
///
enableSerialNumber-boolean default-false
///
///Enables or disables tooltip while editing (dragging/resizing) the taskbar.
///
enableTaskbarDragTooltip-boolean default-true
///
///Enables or disables tooltip for taskbar.
///
enableTaskbarTooltip-boolean default-true
///
///Enables/Disables virtualization for rendering Gantt items.
///
enableVirtualization-boolean default-false
///
///Enables/disables work breakdown structure column.
///
enableWBS-boolean default-false
///
///Enables/disables WBS predecessor column.
///
enableWBSPredecessor-boolean default-false
///
///Specifies the mapping property path for end Date of a task in datasource
///
endDateMapping-string default-
///
///Specifies the mapping property path for the expand status of a record in data source.
///
expandStateMapping-string default-
///
///Options for filtering and customizing filter actions.
///
filterSettings-FilterSettings default-
///
///Specifies the column collection for filtering the Gantt content on initial load
///
filteredColumns-Array<any> default-[]
///
///Specifies the value to be filtered in Gantt.
///
value-string default-
///
///Specifies the field where filtering has to be performed.
///
field-string default-
///
///Specifies the predicate(and/or) value to perform filtering.
///
predicate-string default-
///
///Specifies the filter condition to filtered column. See operator
///
operator-string default-
///
///Specifies the data collection for grouping the resources in resource allocation view in Gantt.
///
groupCollection-Array<any> default-[]
///
///Default Value
///
groupIdMapping-string default-
///
///Default Value
///
groupNameMapping-string default-
///
///Specifies whether to highlight the non working time in Gantt.
///
highlightNonWorkingTime-boolean default-false
///
///Specifies whether to highlight the weekends in Gantt .
///
highlightWeekends-boolean default-true
///
///Collection of holidays with date, background and label information to be displayed in Gantt.
///
holidays-Array<Holidays> default-[]
///
///Specifies holiday date to be displayed in Gantt
///
day-string default-
///
///Specifies the background color for holiday date in Gantt Schedule
///
background-string default-
///
///Specifies the label to be displayed for rendered holiday in Gantt
///
label-string default-
///
///Specifies whether to include weekends while calculating the duration of a task.
///
includeWeekend-boolean default-true
///
///Enables or disables the responsiveness of Gantt
///
isResponsive-boolean default-false
///
///Specifies the data source field name to be displayed as left task label
///
leftTaskLabelMapping-string default-
///
///Specifies the template for left task label
///
leftTaskLabelTemplate-string default-
///
///Specify the locale for Gantt
///
locale-string default-en-US
///
///Specifies the mapping property path for milestone in datasource
///
milestoneMapping-string default-
///
///To Specify the JsRender script Id to customize the mile stone with our preference
///
milestoneTemplate-string default-
///
///Specifies the background color for non working time in Gantt.
///
nonWorkingBackground-string default-
///
///Specifies the mapping property path for the task description in datasource
///
notesMapping-string default-
///
///Specifies the background of parent progressbar in Gantt
///
parentProgressbarBackground-string default-
///
///Specifies the mapping property path for parent task Id in self reference datasource
///
parentTaskIdMapping-string default-
///
///Specifies the background of parent taskbar in Gantt
///
parentTaskbarBackground-string default-
///
///Specifies the template for parent taskbar
///
parentTaskbarTemplate-string default-
///
///Specifies the mapping property path for predecessors of a task in datasource
///
predecessorMapping-string default-
///
///Specifies the JsRender template id or template script for predecessor tooltip on mouse action.
///
predecessorTooltipTemplate-string default-
///
///Specifies the mapping property path for progress percentage of a task in datasource
///
progressMapping-string default-
///
///Specifies the background of progressbar in Gantt
///
progressbarBackground-string default-
///
///Specified the height of the progressbar in taskbar
///
progressbarHeight-number default-100
///
///Specifies the template for tooltip on resizing progressbar
///
progressbarTooltipTemplate-string default-null
///
///Specifies the template ID for customized tooltip for progressbar editing in Gantt
///
progressbarTooltipTemplateId-string default-null
///
///It receives query to retrieve data from the table (query is same as SQL).
///
query-any default-null
///
///Enables or disables Gantt to read-only mode
///
readOnly-boolean default-false
///
///Enables or Disables rendering baselines in Gantt , when enabled baseline is rendered in Gantt
///
renderBaseline-boolean default-false
///
///Default Value
///
resourceCollectionMapping-string default-
///
///Specifies the mapping property name for resource ID in resource Collection in Gantt
///
resourceIdMapping-string default-
///
///Specifies the mapping property path for resources of a task in datasource
///
resourceInfoMapping-string default-
///
///Specifies the mapping property path for resource name of a task in Gantt
///
resourceNameMapping-string default-
///
///Specifies the mapping property path for resource's percent effort involved in a task in datasource
///
resourceUnitMapping-string default-
///
///Collection of data regarding resources involved in entire project
///
resources-Array<any> default-[]
///
///Specifies the data source field name to be displayed as right task label
///
rightTaskLabelMapping-string default-
///
///Specifies the template for right task label
///
rightTaskLabelTemplate-string default-
///
///Specifies whether rounding off the day working time edits
///
roundOffDayworkingTime-boolean default-true
///
///Specifies the height of a single row in Gantt. Also, we need to set same height in the CSS style with class name e-rowcell.
///
rowHeight-number default-30
///
///Specifies end date of the Gantt schedule. By default, end date will be rounded to its next Saturday.
///
scheduleEndDate-string default-null
///
///Specifies the options for customizing schedule header.
///
scheduleHeaderSettings-ScheduleHeaderSettings default-
///
///Specified the format for day view in schedule header
///
dayHeaderFormat-string default-
///
///Specified the format for Hour view in schedule header
///
hourHeaderFormat-string default-HH
///
///Specifies the number of minutes per interval
///
minutesPerInterval-ej.Gantt.minutesPerInterval|string default-ej.Gantt.minutesPerInterval.Auto
///
///Specified the format for month view in schedule header
///
monthHeaderFormat-string default-MMM
///
///Specifies the schedule mode
///
scheduleHeaderType-ej.Gantt.ScheduleHeaderType|string default-ej.Gantt.ScheduleHeaderType.Week
///
///Specifies the round-off mode for the start date in schedule header.
///
timescaleStartDateMode-ej.Gantt.TimescaleRoundMode|string default-ej.Gantt.TimescaleRoundMode.Auto
///
///Specified the background for weekends in Gantt
///
weekendBackground-string default-#F2F2F2
///
///Specified the format for week view in schedule header
///
weekHeaderFormat-string default-MMM dd , yyyy
///
///Specified the format for year view in schedule header
///
yearHeaderFormat-string default-yyyy
///
///Specifies the size of the lowest time unit along the timescale, with minimum value as "50%" and maximum value as "500%". It is also possible to set the value in pixels.
///
timescaleUnitSize-string default-100%
///
///Specifies the start day of the week in week timescale mode
///
weekStartDay-number default-0
///
///Enable or disable the automatic timescale update on cell editing, dialog editing and taskbar editing.
///
updateTimescaleView-boolean default-true
///
///Specifies start date of the Gantt schedule. By default, start date will be rounded to its previous Sunday.
///
scheduleStartDate-string default-null
///
///Specifies the selected cell information on rendering Gantt.
///
selectedCellIndexes-Array<SelectedCellIndexes> default-
///
///Specifies the row index of the cell to be selected Gantt control
///
rowIndex-number default--1
///
///Specifies the cell index to be selected in the row.
///
cellIndex-number default--1
///
///Specifies the selected row Index in Gantt , the row with given index will highlighted
///
selectedRowIndex-number default--1
///
///Specifies the row selection type.
///
selectionType-ej.Gantt.SelectionType|string default-ej.Gantt.SelectionType.Single
///
///Specifies the type of selection whether to select row or cell.
///
selectionMode-ej.Gantt.SelectionMode|string default-ej.Gantt.SelectionMode.Row
///
///Enables or disables the column chooser.
///
showColumnChooser-boolean default-false
///
///Enables/disables the options for inserting , deleting and renaming columns.
///
showColumnOptions-boolean default-false
///
///Specifies the template for cell tooltip
///
showGridCellTooltip-boolean default-true
///
///Specifies whether to show grid cell tooltip over expander cell alone.
///
showGridExpandCellTooltip-boolean default-true
///
///Specifies whether display task progress inside taskbar.
///
showProgressStatus-boolean default-true
///
///Specifies whether to display resource names for a task beside taskbar.
///
showResourceNames-boolean default-true
///
///Specifies whether to display task name beside task bar.
///
showTaskNames-boolean default-true
///
///Specifies the size option of Gantt control.
///
sizeSettings-SizeSettings default-
///
///Specifies the height of Gantt control
///
height-string default-
///
///Specifies the width of Gantt control
///
width-string default-
///
///Specifies the sorting options for Gantt.
///
sortSettings-SortSettings default-
///
///Specifies the sorted columns for Gantt
///
sortedColumns-Array<any> default-[]
///
///Specifies the field to be sorted in Gantt
///
field-string default-
///
///Specifies the sort direction in Gantt
///
direction-string default-
///
///Specifies splitter position in Gantt.
///
splitterPosition-string default-null
///
///Option to configure the splitter position.
///
splitterSettings-SplitterSettings default-
///
///Specifies position of the splitter in Gantt , splitter can be placed either based on percentage values or pixel values.
///
position-string default-
///
///Specifies the position of splitter in Gantt, based on column index in Gantt.
///
index-string default-
///
///Specifies the mapping property path for start date of a task in datasource
///
startDateMapping-string default-
///
///Specifies the options for striplines
///
stripLines-Array<StripLines> default-[]
///
///Specifies date to render striplines in Gantt
///
day-string default-
///
///Specifies label to be displayed for striplines in Gantt
///
label-string default-
///
///Specifies line style for rendered striplines in Gantt
///
lineStyle-string default-
///
///Specifies the line color for rendered striplines in Gantt
///
lineColor-string default-
///
///Specifies the width of the stripline in Gantt
///
lineWidth-string default-
///
///Default Value
///
taskCollectionMapping-string default-
///
///Specifies the mapping property path for task Id in datasource
///
taskIdMapping-string default-
///
///Specifies the mapping property path for task name in datasource
///
taskNameMapping-string default-
///
///Specifies the task scheduling mode for a project and this will be set to all the tasks available in the project
///
taskSchedulingMode-ej.Gantt.TaskSchedulingMode|string default-ej.Gantt.TaskSchedulingMode.Auto
///
///Specifies the mapping property path for the task scheduling mode for a task in datasource
///
taskSchedulingModeMapping-string default-auto
///
///Specifies the nature of a task for calculating the work, and it can fixed duration, fixed work and fixed resource unit
///
taskType-ej.Gantt.TaskType|string default-ej.Gantt.TaskType.FixedUnit
///
///Specifies the background of the taskbar in Gantt
///
taskbarBackground-string default-
///
///Specifies the template script for customized tooltip for taskbar editing in Gantt
///
taskbarEditingTooltipTemplate-string default-
///
///Specifies the template Id for customized tooltip for taskbar editing in Gantt
///
taskbarEditingTooltipTemplateId-string default-
///
///Specifies the height of taskBar in Gantt.
///
taskbarHeight-number default-20
///
///To Specify the JsRender script Id to customize the task bar with our preference
///
taskbarTemplate-string default-
///
///Specifies the template for tooltip on mouse action on taskbars
///
taskbarTooltipTemplate-string default-
///
///Specifies the template id for tooltip on mouse action on taskbars
///
taskbarTooltipTemplateId-string default-
///
///Specifies the toolbarSettings options.
///
toolbarSettings-ToolbarSettings default-
///
///Specifies the state of enabling or disabling toolbar
///
showToolbar-boolean default-true
///
///Specifies the list of toolbar items to be rendered in Gantt toolbar
///
toolbarItems-array<ej.Gantt.ToolbarItems|string> default-[]
///
///Allows the user to insert custom toolbar items.
///
customToolbarItems-Array<any> default-
///
///Allows the user to insert the custom icons in toolbar using CSS class name selector.
///
text-string default-
///
///Allows the user to insert the custom icons in toolbar using script templates. Using this property we can bind HTML elements and other EJ controls to Gantt toolbar.
///
templateID-string default-
///
///Allows the user to display custom tooltip text for Gantt custom toolbar items.
///
tooltipText-string default-
///
///Specifies the tree expander column in Gantt
///
treeColumnIndex-number default-0
///
///Enables or disables the schedule date validation while connecting a manually scheduled task with predecessor
///
validateManualTasksOnLinking-boolean default-false
///
///Specifies the view type for a project in the Gantt.
///
viewType-ej.Gantt.ViewType|string default-ej.Gantt.ViewType.ProjectView
///
///Specifies the weekendBackground color in Gantt
///
weekendBackground-string default-#F2F2F2
///
///Specifies the mapping property path for the work field of a task in the data source. When it is mapped the end date and duration for a task will be calculated automatically.
///
workMapping-string default-
///
///Specifies the unit for the work involved in a task and it can be day, hour or minute
///
workUnit-ej.Gantt.WorkUnit|string default-ej.Gantt.WorkUnit.Hour
///
///Gets or sets the working days of a week in a project.
///
workWeek-Array<any> default-[Monday,Tuesday,Wednesday,Thursday,Friday]
///
///Specifies the working time schedule of day
///
workingTimeScale-ej.Gantt.workingTimeScale|string default-ej.Gantt.workingTimeScale.TimeScale8Hours
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Grid:function(){
///
/// Constructor of ej.Grid
///
}
});
ej.Grid=(function(){
var original=ej.Grid
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
addIgnoreOnExport:function(propertyNames){
///
///
/// Adds a grid model property which is to be ignored upon exporting.
///
/// Pass the array of parameters which need to be ignored on exporting
///
},
addIgnoreOnToolbarServerClick:function(propertyNames){
///
///
/// Adds a grid model property which is to be ignored upon OnServerToolbarClick.
///
/// Pass the array of parameters which need to be ignored on OnServerToolbarClick
///
},
addRecord:function(data, serverChange){
///
///
/// Add a new record in grid control when allowAdding is set as true.Without passing parameters it will add empty row.
///
/// Pass the array of added Records
///
///
///
/// Add a new record in grid control when allowAdding is set as true.Without passing parameters it will add empty row.
///
/// optionalIf we pass serverChange as true, send post to server side for server action.
///
},
batchCancel:function(){
///
///
/// Cancel the modified changes in grid control when edit mode is "batch".
///
},
batchSave:function(){
///
///
/// Save the modified changes to data source in grid control when edit mode is "batch".
///
},
cancelEdit:function(){
///
///
/// Send a cancel request in grid.
///
},
cancelEditCell:function(){
///
///
/// Send a cancel request to the edited cell in grid.
///
},
calculatePageSizeByParentHeight:function(containerHeight){
///
///
/// Returns the total page size need to be displayed in grid based on the given container height. This method will also work when the property allowTextWrap as true only when wrap mode is header.
///
/// When passing the container height as integer or percentage, it will returns the page size that need to be displayed for grid.
///
},
changePageSize:function(pageSize){
///
///
/// It is used to change the number of records displayed per page in grid based on the given page size.
///
/// When passing the page size, it will change the number of records displayed per page in grid.
///
},
clearCellSelection:function(){
///
///
/// It is used to clear all the cell selection.
///
},
clearCellSelection:function(rowIndex, columnIndex){
///
///
/// It is used to clear specified cell selection based on the rowIndex and columnIndex provided.
///
/// It is used to pass the row index of the cell
///
///
///
/// It is used to clear specified cell selection based on the rowIndex and columnIndex provided.
///
/// It is used to pass the column index of the cell.
///
},
clearColumnSelection:function(index){
///
///
/// It is used to clear all the row selection or at specific row selection based on the index provided.
///
/// optional If index of the column is specified then it will remove the selection from the particular column else it will clears all of the column selection
///
},
clearFiltering:function(field){
///
///
/// It is used to clear all the filtering done.
///
/// If field of the column is specified then it will clear the particular filtering column
///
},
clearSearching:function(){
///
///
/// Clear the searching from the grid
///
},
clearSelection:function(index){
///
///
/// Clear all the row selection or at specific row selection based on the index provided
///
/// optional If index of the row is specified then it will remove the selection from the particular row else it will clears all of the row selection
///
},
clearSorting:function(){
///
///
/// Clear the sorting from columns in the grid
///
},
collapseAll:function(){
///
///
/// Collapse all the group caption rows in grid
///
},
collapseGroupDropArea:function(){
///
///
/// Collapse the group drop area in grid
///
},
columns:function(columnDetails, action){
///
///
/// Add or remove columns in grid column collections
///
/// Pass array of columns or string of field name to add/remove the column in grid
///
///
///
/// Add or remove columns in grid column collections
///
/// optional Pass add/remove action to be performed. By default "add" action will perform
///
},
dataSource:function(datasource, templateRefresh){
///
///
/// Refresh the grid with new data source
///
/// Pass new data source to the grid
///
///
///
/// Refresh the grid with new data source
///
/// optional When templateRefresh is set true, both header and contents get refreshed
///
},
deleteRecord:function(fieldName, data){
///
///
/// Delete a record in grid control when allowDeleting is set as true
///
/// Pass the primary key field Name of the column
///
///
///
/// Delete a record in grid control when allowDeleting is set as true
///
/// Pass the JSON data of record need to be delete.
///
},
deleteRow:function($tr){
///
///
/// Delete the row based on the given tr element in grid.
///
/// Pass the tr element in grid content to get its row index
///
},
destroy:function(){
///
///
/// Destroy the grid widget all events bound using this._on will be unbind automatically and bring the control to pre-init state.
///
},
editCell:function(index, fieldName){
///
///
/// Edit a particular cell based on the row index and field name provided in "batch" edit mode.
///
/// Pass row index to edit particular cell
///
///
///
/// Edit a particular cell based on the row index and field name provided in "batch" edit mode.
///
/// Pass the field name of the column to perform batch edit
///
},
editFormValidate:function(){
///
///
/// It returns a value and if the input field values of edit form is not based on the validation rules then it will show the validation message.
///
},
endEdit:function(){
///
///
/// Send a save request in grid.
///
},
expandAll:function(){
///
///
/// Expand all the group caption rows in grid.
///
},
expandCollapse:function($target){
///
///
/// Expand or collapse the row based on the row state in grid
///
/// Pass the target object to expand/collapse the row based on its row state
///
},
expandGroupDropArea:function(){
///
///
/// Expand the group drop area in grid.
///
},
export:function(action, serverEvent, multipleExport, gridIds){
///
///
/// Export the grid content to excel, word or PDF document.
///
/// Pass the controller action name corresponding to exporting
///
///
///
/// Export the grid content to excel, word or PDF document.
///
/// optionalASP server event name corresponding to exporting
///
///
///
/// Export the grid content to excel, word or PDF document.
///
/// optionalPass the multiple exporting value as true/false
///
///
///
/// Export the grid content to excel, word or PDF document.
///
/// optionalPass the array of the gridIds to be filtered
///
},
filterColumn:function(fieldName, filterOperator, filterValue, predicate, matchcase, actualFilterValue){
///
///
/// Send a filtering request to filter one column in grid.
///
/// Pass the field name of the column
///
///
///
/// Send a filtering request to filter one column in grid.
///
/// string/integer/dateTime operator
///
///
///
/// Send a filtering request to filter one column in grid.
///
/// Pass the value to be filtered in a column
///
///
///
/// Send a filtering request to filter one column in grid.
///
/// Pass the predicate as and/or
///
///
///
/// Send a filtering request to filter one column in grid.
///
/// optional Pass the match case value as true/false
///
///
///
/// Send a filtering request to filter one column in grid.
///
/// optionalactualFilterValue denote the filter object of current filtered columns.Pass the value to filtered in a column
///
},
filterColumn:function(filterQueries){
///
///
/// Send a filtering request to filter single or multiple column in grid.
///
/// Pass array of filterColumn query for performing filter operation
///
},
getBatchChanges:function(){
///
///
/// Get the batch changes of edit, delete and add operations of grid.
///
},
getBrowserDetails:function(){
///
///
/// Get the browser details
///
},
getColumnByField:function(fieldName){
///
///
/// Get the column details based on the given field in grid
///
/// Pass the field name of the column to get the corresponding column object
///
},
getColumnByHeaderText:function(headerText){
///
///
/// Get the column details based on the given header text in grid.
///
/// Pass the header text of the column to get the corresponding column object
///
},
getColumnByIndex:function(columnIndex){
///
///
/// Get the column details based on the given column index in grid
///
/// Pass the index of the column to get the corresponding column object
///
},
getColumnFieldNames:function(){
///
///
/// Get the list of field names from column collection in grid.
///
},
getColumnIndexByField:function(fieldName){
///
///
/// Get the column index of the given field in grid.
///
/// Pass the field name of the column to get the corresponding column index
///
},
getColumnIndexByHeaderText:function(headerText, field){
///
///
/// Get the column index of the given headerText of column in grid.
///
/// Pass the headerText of the column to get that column index
///
///
///
/// Get the column index of the given headerText of column in grid.
///
/// optionalOptional Pass the field name of the column.
///
},
getContent:function(){
///
///
/// Get the content div element of grid.
///
},
getContentTable:function(){
///
///
/// Get the content table element of grid
///
},
getCurrentEditCellData:function(){
///
///
/// Get the data of currently edited cell value in "batch" edit mode
///
},
getCurrentIndex:function(){
///
///
/// Get the current page index in grid pager.
///
},
getCurrentViewData:function(){
///
///
/// Get the current page data source of grid.
///
},
getDataByIndex:function(){
///
///
/// Get the data of given row index in grid.
///
},
getFieldNameByHeaderText:function(headerText){
///
///
/// Get the column field name from the given header text in grid.
///
/// Pass header text of the column to get its corresponding field name
///
},
getFilterBar:function(){
///
///
/// Get the filter bar of grid
///
},
getFilteredRecords:function(){
///
///
/// Get the records filtered or searched in Grid
///
},
getFooterContent:function(){
///
///
/// Get the footer content of grid.
///
},
getFooterTable:function(){
///
///
/// Get the footer table element of grid.
///
},
getHeaderContent:function(){
///
///
/// Get the header content div element of grid.
///
},
getHeaderTable:function(){
///
///
/// Get the header table element of grid
///
},
getHeaderTextByFieldName:function(field){
///
///
/// Get the column header text from the given field name in grid.
///
/// Pass field name of the column to get its corresponding header text
///
},
getHiddenColumnNames:function(){
///
///
/// Get the names of all the hidden column collections in grid.
///
},
getIndexByRow:function($tr){
///
///
/// Get the row index based on the given tr element in grid.
///
/// Pass the tr element in grid content to get its row index
///
},
getPager:function(){
///
///
/// Get the pager of grid.
///
},
getPrimaryKeyFieldNames:function(){
///
///
/// Get the names of primary key columns in Grid
///
},
getRowByIndex:function(from, to){
///
///
/// Get the rows(tr element) from the given from and to row index in grid
///
/// Pass the from index from which the rows to be returned
///
///
///
/// Get the rows(tr element) from the given from and to row index in grid
///
/// Pass the to index to which the rows to be returned
///
},
getRowHeight:function(){
///
///
/// Get the row height of grid.
///
},
getRows:function(){
///
///
/// Get the rows(tr element)of grid which is displayed in the current page.
///
},
getScrollObject:function(){
///
///
/// Get the scroller object of grid.
///
},
getSelectedRecords:function(){
///
///
/// Get the selected records details in grid.
///
},
getSelectedRows:function(){
///
///
/// Get the selected row element details in grid.
///
},
getsortColumnByField:function(field){
///
///
/// It accepts the string value and returns the field and sorted direction of the column in grid.
///
/// Pass the field of the column to get the sorted direction of the corresponding column in Grid.
///
},
getSummaryValues:function(summaryCol, summaryData){
///
///
/// Get the calculated summary values of JSON data passed to it
///
/// Pass Summary Column details
///
///
///
/// Get the calculated summary values of JSON data passed to it
///
/// Pass JSON Array for which its field values to be calculated
///
},
getVisibleColumnNames:function(){
///
///
/// Get the names of all the visible column collections in grid
///
},
gotoPage:function(pageIndex){
///
///
/// Send a paging request to specified page in grid
///
/// Pass the page index to perform paging at specified page index
///
},
groupColumn:function(fieldName){
///
///
/// Send a column grouping request in grid.
///
/// Pass the field Name of the column to be grouped in grid control
///
},
hideColumns:function(headerText){
///
///
/// Hide columns from the grid based on the header text
///
/// you can pass either array of header text of various columns or a header text of a column to hide
///
},
print:function(){
///
///
/// Print the grid control
///
},
refreshBatchEditChanges:function(){
///
///
/// It is used to refresh and reset the changes made in "batch" edit mode
///
},
refreshHeader:function(){
///
///
/// It is used to refresh the grid header.
///
},
refreshContent:function(templateRefresh){
///
///
/// Refresh the grid contents. The template refreshment is based on the argument passed along with this method
///
/// optional When templateRefresh is set true, template and grid contents both are refreshed in grid else only grid content is refreshed
///
},
refreshData:function(additionalParameters){
///
///
/// Refresh the grid contents with updated server Data, using XMLHttpRequest. Url Path should be provided in Grid datasource otherwise it refreshes with local data without XMLHttpRequest.
///
/// optionalData to the server
///
},
refreshTemplate:function(){
///
///
/// Refresh the template of the grid
///
},
refreshToolbar:function(){
///
///
/// Refresh the toolbar items in grid.
///
},
removeSortedColumns:function(fieldName){
///
///
/// Remove a column or collection of columns from a sorted column collections in grid.
///
/// Pass array of field names of the columns to remove a collection of sorted columns or pass a string of field name to remove a column from sorted column collections
///
},
render:function(){
///
///
/// Creates a grid control
///
},
reorderColumns:function(fromFieldName, toFieldName){
///
///
/// Re-order the column in grid
///
/// Pass the from field name of the column needs to be changed
///
///
///
/// Re-order the column in grid
///
/// Pass the to field name of the column needs to be changed
///
},
reorderRows:function(indexes, toIndex){
///
///
/// Re-order the row in grid
///
/// Pass the indexes of the rows needs to reorder.
///
///
///
/// Re-order the row in grid
///
/// Pass the index of a row where to be reordered.
///
},
resetModelCollections:function(){
///
///
/// Reset the model collections like pageSettings, groupSettings, filterSettings, sortSettings and summaryRows.
///
},
resizeColumns:function(column, width){
///
///
/// Resize the columns by giving column name and width for the corresponding one.
///
/// Pass the column name that needs to be changed
///
///
///
/// Resize the columns by giving column name and width for the corresponding one.
///
/// Pass the width to resize the particular columns
///
},
rowHeightRefresh:function(){
///
///
/// Resolves row height issue when unbound column is used with FrozenColumn
///
},
saveCell:function(preventSaveEvent){
///
///
/// We can prevent the client side cellSave event triggering by passing the preventSaveEvent argument as true.Without argument it will save the particular edited grid cell.
///
/// optionalIf we pass preventSaveEvent as true, it prevents the client side cellSave event triggering
///
},
setDimension:function(height, width){
///
///
/// Set dimension for grid with corresponding to grid parent.
///
/// Pass the height of the grid container
///
///
///
/// Set dimension for grid with corresponding to grid parent.
///
/// Pass the width of the grid container
///
},
setWidthToColumns:function(){
///
///
/// Send a request to grid to refresh the width set to columns
///
},
search:function(searchString){
///
///
/// Send a search request to grid with specified string passed in it
///
/// Pass the string to search in Grid records
///
},
selectCells:function(rowCellIndexes){
///
///
/// Select cells in grid.
///
/// It is used to set the starting index of row and indexes of cells for that corresponding row for selecting cells.
///
},
selectColumns:function(fromIndex){
///
///
/// Select columns in grid.
///
/// It is used to set the starting index of column for selecting columns.
///
},
selectColumns:function(columnIndex, toIndex){
///
///
/// Select the specified columns in grid based on Index provided.
///
/// It is used to set the starting index of column for selecting columns.
///
///
///
/// Select the specified columns in grid based on Index provided.
///
/// optionalIt is used to set the ending index of column for selecting columns.
///
},
selectRows:function(fromIndex, toIndex){
///
///
/// Select rows in grid.
///
/// It is used to set the starting index of row for selecting rows.
///
///
///
/// Select rows in grid.
///
/// It is used to set the ending index of row for selecting rows.
///
},
selectRows:function(from, to, target){
///
///
/// Select specified rows in grid based on Index provided.
///
/// It is used to set the starting index of row for selecting rows.
///
///
///
/// Select specified rows in grid based on Index provided.
///
/// optionalIt is used to set the ending index of row for selecting rows.
///
///
///
/// Select specified rows in grid based on Index provided.
///
/// optionalTarget element which is clicked.
///
},
selectRows:function(rowIndexes){
///
///
/// Select rows in grid.
///
/// Pass array of rowIndexes for selecting rows
///
},
setCellText:function(){
///
///
/// Used to update a particular cell value.
///
},
setCellValue:function(Index, fieldName, value){
///
///
/// Used to update a particular cell value based on specified row Index and the fieldName.
///
/// It is used to set the index for selecting the row.
///
///
///
/// Used to update a particular cell value based on specified row Index and the fieldName.
///
/// It is used to set the field name for selecting column.
///
///
///
/// Used to update a particular cell value based on specified row Index and the fieldName.
///
/// It is used to set the value for the selected cell.
///
},
setDefaultData:function(){
///
///
/// It sets the default data to the column in grid during adding record in batch edit mode.
///
},
setPhoneModeMaxWidth:function(Index){
///
///
/// The grid rows has to be rendered as detail view in mobile mode based on given value.
///
/// It is used to render grid rows as details view in mobile mode.
///
},
setValidation:function(){
///
///
/// Set validation to edit form in the grid.
///
},
setValidationToField:function(fieldName, rules){
///
///
/// Set validation to a particular input field in a edit form dynamically.
///
/// Specify the field name of the column to set validation rules
///
///
///
/// Set validation to a particular input field in a edit form dynamically.
///
/// Specify the validation rules for the field
///
},
showColumns:function(headerText){
///
///
/// Show columns in the grid based on the header text
///
/// you can pass either array of header text of various columns or a header text of a column to show
///
},
sortColumn:function(columnName, sortingDirection){
///
///
/// Send a sorting request in grid.
///
/// Pass the field name of the column as columnName for which sorting have to be performed
///
///
///
/// Send a sorting request in grid.
///
/// optional Pass the sort direction ascending/descending by which the column have to be sort. By default it is sorting in an ascending order
///
},
startEdit:function($tr){
///
///
/// Send an edit record request in grid
///
/// Pass the tr- selected row element to be edited in grid
///
},
ungroupColumn:function(fieldName){
///
///
/// Un-group a column from grouped columns collection in grid
///
/// Pass the field Name of the column to be ungrouped from grouped column collection
///
},
updateRecord:function(fieldName, data){
///
///
/// Update a edited record in grid control when allowEditing is set as true.
///
/// Pass the primary key field Name of the column
///
///
///
/// Update a edited record in grid control when allowEditing is set as true.
///
/// Pass the edited JSON data of record need to be update.
///
},
windowonresize:function(){
///
///
/// It adapts grid to its parent element or to the browsers window.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejGrid=function(){
this.data("ejGrid",new ej.Grid());
return this;
};
intellisense.annotate(jQuery.fn,{
ejGrid :function (options) {
///
///
///The grid can be easily configured to the DOM element, such as div. you can create a grid with a highly customizable look and feel.
///Gets or sets a value that indicates whether to customizing cell based on our needs.
///
allowCellMerging-boolean default-false
///
///Gets or sets a value that indicates whether to enable dynamic grouping behavior. Grouping can be done by drag on drop desired columns to grid’s GroupDropArea. This can be further customized through “groupSettings†property.
///
allowGrouping-boolean default-false
///
///Gets or sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType – Gets or sets a value that indicates whether to enable single row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows
///
allowKeyboardNavigation-boolean default-true
///
///Gets or sets a value that indicates whether to enable dynamic filtering behavior on grid. Filtering can be used to limit the records displayed using required criteria and this can be further customized through “filterSettings†property
///
allowFiltering-boolean default-false
///
///Gets or sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header.
///
allowSorting-boolean default-false
///
///Gets or sets a value that indicates whether to enable multi columns sorting behavior in grid. Sort multiple columns by holding CTRL and click on the corresponding column header.
///
allowMultiSorting-boolean default-false
///
///This specifies the grid to show the paginated data. Also enables pager control at the bottom of grid for dynamic navigation through data source. Paging can be further customized through “pageSettings†property.
///
allowPaging-boolean default-false
///
///Gets or sets a value that indicates whether to enable the columns reordering behavior in the grid. Reordering can be done through by drag and drop the particular column from one index to another index within the grid.
///
allowReordering-boolean default-false
///
///Gets or sets a value that indicates whether the column is non resizable. Column width is set automatically based on the content or header text which is large.
///
allowResizeToFit-boolean default-false
///
///Gets or sets a value that indicates whether to enable dynamic resizable of columns. Resize the width of the columns by simply click and move the particular column header line
///
allowResizing-boolean default-false
///
///Gets or sets a value that indicates whether to enable the rows reordering in Grid and drag & drop rows between multiple Grid.
///
allowRowDragAndDrop-boolean default-false
///
///Gets or sets a value that indicates whether to enable the scrollbar in the grid and view the records by scroll through the grid manually
///
allowScrolling-boolean default-false
///
///Gets or sets a value that indicates whether to enable dynamic searching behavior in grid. Currently search box can be enabled through “toolbarSettingsâ€
///
allowSearching-boolean default-false
///
///Gets or sets a value that indicates whether user can select rows on grid. On enabling feature, selected row will be highlighted.
///
allowSelection-boolean default-true
///
///Gets or sets a value that indicates whether the Content will wrap to the next line if the content exceeds the boundary of the Column Cells.
///
allowTextWrap-boolean default-false
///
///Gets or sets a value that indicates whether to enable the multiple exporting behavior on grid data.
///
allowMultipleExporting-boolean default-false
///
///Gets or sets a value that indicates to define common width for all the columns in the grid.
///
commonWidth-number default-
///
///Gets or sets a value that indicates to enable the visibility of the grid lines.
///
gridLines-ej.Grid.GridLines|string default-ej.Grid.GridLines.Both
///
///This specifies the grid to add the grid control inside the grid row of the parent with expand/collapse options
///
childGrid-any default-null
///
///Sets the clip mode for Grid cell as ellipsis or clipped content(both header and content)
///
clipMode-ej.Grid.ClipMode|string default-ej.Grid.ClipMode.Clip
///
///Used to enable or disable static width settings for column. If the columnLayout is set as fixed, then column width will be static.
///
columnLayout-ej.Grid.ColumnLayout|string default-ej.Grid.ColumnLayout.Auto
///
///Gets or sets an object that indicates to render the grid with specified columns
///
columns-Array<Columns> default-[]
///
///Gets or sets a value that indicates whether to enable editing behavior for particular column.
///
allowEditing-boolean default-true
///
///Gets or sets a value that indicates whether to enable dynamic filtering behavior for particular column.
///
allowFiltering-boolean default-true
///
///Gets or sets a value that indicates whether to enable dynamic grouping behavior for particular column.
///
allowGrouping-boolean default-true
///
///Gets or sets a value that indicates whether to enable dynamic sorting behavior for particular column.
///
allowSorting-boolean default-true
///
///Gets or sets a value that indicates whether to enable dynamic resizable for particular column.
///
allowResizing-boolean default-true
///
///Gets or sets an object that indicates to define a command column in the grid.
///
commands-Array<any> default-[]
///
///Gets or sets an object that indicates to define all the button options which are available in ejButton.
///
buttonOptions-any default-
///
///Gets or sets a value that indicates to add the command column button. See unboundType
///
type-ej.Grid.UnboundType|string default-
///
///Gets or sets a value that indicates to provide custom CSS for an individual column.
///
cssClass-string default-
///
///Gets or sets a value that indicates the attribute values to the td element of a particular column
///
customAttributes-any default-
///
///Gets or sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column.
///
dataSource-any default-null
///
///Gets or sets a value that indicates to display the specified default value while adding a new record to the grid
///
defaultValue-string|number|boolean|Date default-
///
///Gets or sets a value that indicates to render the grid content and header with an HTML elements
///
disableHtmlEncode-boolean default-false
///
///Gets or sets a value that indicates to display a column value as checkbox or string
///
displayAsCheckbox-boolean default-true
///
///Gets or sets a value that indicates to customize ejNumericTextbox of an editable column. See editingType
///
editParams-any default-
///
///Gets or sets a template that displays a custom editor used to edit column values. See editTemplate
///
editTemplate-any default-null
///
///Gets or sets a value that indicates to render the element(based on edit type) for editing the grid record. See editingType
///
editType-ej.Grid.EditingType|string default-ej.Grid.EditingType.String
///
///Gets or sets a value that indicates to groups the column based on its column format.
///
enableGroupByFormat-boolean default-false
///
///Gets or sets a value that indicates to display the columns in the grid mapping with column name of the dataSource.
///
field-string default-
///
///Gets or sets a template that customize the filter control from default . See filterBarTemplate
///
filterBarTemplate-any default-null
///
///Gets or sets a value that indicates to render the excel or menu filter dialog to the grid columns. See filterType
///
filterType-ej.Grid.FilterType|string default-null
///
///Gets or sets a value that indicates to define foreign key field name of the grid datasource.
///
foreignKeyField-string default-null
///
///Gets or sets a value that indicates to bind the field which is in foreign column datasource based on the foreignKeyField
///
foreignKeyValue-string default-null
///
///Gets or sets a value that indicates the format for the text applied on the column
///
format-string default-
///
///Gets or sets a value that indicates to add the template within the header element of the particular column.
///
headerTemplateID-string default-null
///
///Gets or sets a value that indicates to display the title of that particular column.
///
headerText-string default-
///
///This defines the text alignment of a particular column header cell value. See headerTextAlign
///
headerTextAlign-ej.TextAlign|string default-null
///
///It accepts the string value and shows the tooltip for the Grid column header.
///
headerTooltip-string default-null
///
///You can use this property to freeze selected columns in grid at the time of scrolling.
///
isFrozen-boolean default-false
///
///Gets or sets a value that indicates the column has an identity in the database.
///
isIdentity-boolean default-false
///
///Gets or sets a value that indicates the column is act as a primary key(read-only) of the grid. The editing is performed based on the primary key column
///
isPrimaryKey-boolean default-false
///
///Gets or sets a value that indicates the order of Column that are to be hidden or visible when Grid element is in responsive mode and could not occupy all columns.
///
priority-number default--1
///
///Used to hide the particular column in column chooser by giving value as false.
///
showInColumnChooser-boolean default-true
///
///Gets or sets a value that indicates whether to enables column template for a particular column.
///
template-boolean|string default-false
///
///Gets or sets a value that indicates to align the text within the column. See textAlign
///
textAlign-ej.TextAlign|string default-ej.TextAlign.Left
///
///Sets the template for Tooltip in Grid Columns(both header and content)
///
tooltip-string default-
///
///Gets or sets a value that indicates to specify the data type of the specified columns.
///
type-string default-
///
///Gets or sets a value that indicates to define constraints for saving data to the database.
///
validationRules-any default-
///
///Gets or sets a value that indicates whether this column is visible in the grid.
///
visible-boolean default-true
///
///Gets or sets a value that indicates to define the width for a particular column in the grid.
///
width-number default-
///
///Gets or sets an object that indicates whether to customize the context menu behavior of the grid.
///
contextMenuSettings-ContextMenuSettings default-
///
///Gets or sets a value that indicates whether to add the default context menu actions as a context menu items If enableContextMenu is true it will show all the items related to the target, if you want selected items from contextmenu you have to mention in the contextMenuItems
///
contextMenuItems-Array<any> default-[]
///
///Gets or sets a value that indicates whether to add custom contextMenu items within the toolbar to perform any action in the grid
///
customContextMenuItems-Array<any> default-[]
///
///Gets or sets a value that indicates whether to enable the context menu action in the grid.
///
enableContextMenu-boolean default-false
///
///Used to get or set the subMenu to the corresponding custom context menu item.
///
subContextMenu-Array<any> default-
///
///Used to get or set the corresponding custom context menu item to which the submenu to be appended.
///
contextMenuItem-string default-null
///
///Used to get or set the sub menu items to the custom context menu item.
///
subMenu-Array<any> default-[]
///
///Used to get or set the sub menu items to the custom context menu item using JsRender template.
///
template-string default-null
///
///Gets or sets a value that indicates whether to disable the default context menu items in the grid.
///
disableDefaultItems-boolean default-false
///
///Gets or sets a value that indicates to render the grid with custom theme.
///
cssClass-string default-
///
///Gets or sets the data to render the grid with records
///
dataSource-any default-null
///
///Default Value:
///
detailsTemplate-string default-null
///
///Gets or sets an object that indicates whether to customize the editing behavior of the grid.
///
editSettings-EditSettings default-
///
///Gets or sets a value that indicates whether to enable insert action in the editing mode.
///
allowAdding-boolean default-false
///
///Gets or sets a value that indicates whether to enable the delete action in the editing mode.
///
allowDeleting-boolean default-false
///
///Gets or sets a value that indicates whether to enable the edit action in the editing mode.
///
allowEditing-boolean default-false
///
///Gets or sets a value that indicates whether to enable the editing action while double click on the record
///
allowEditOnDblClick-boolean default-true
///
///This specifies the id of the template. This template can be used to display the data that you require to be edited using the Dialog Box
///
dialogEditorTemplateID-string default-null
///
///Gets or sets a value that indicates whether to define the mode of editing See editMode
///
editMode-ej.Grid.EditMode|string default-ej.Grid.EditMode.Normal
///
///This specifies the id of the template. This template can be used to display the data that you require to be edited using the External edit form
///
externalFormTemplateID-string default-null
///
///This specifies to set the position of an External edit form either in the top-right or bottom-left of the grid. See formPosition
///
formPosition-ej.Grid.FormPosition|string default-ej.Grid.FormPosition.BottomLeft
///
///This specifies the id of the template. This template can be used to display the data that you require to be edited using the Inline edit form
///
inlineFormTemplateID-string default-null
///
///This specifies to set the position of an adding new row either in the top or bottom of the grid. See rowPosition
///
rowPosition-ej.Grid.RowPosition|string default-ej.Grid.RowPosition.Top
///
///Gets or sets a value that indicates whether the confirm dialog has to be shown while saving or discarding the batch changes
///
showConfirmDialog-boolean default-true
///
///Gets or sets a value that indicates whether the confirm dialog has to be shown while deleting record
///
showDeleteConfirmDialog-boolean default-false
///
///Gets or sets a value that indicates whether the title for edit form is different from the primarykey column.
///
titleColumn-string default-null
///
///Gets or sets a value that indicates whether to display the add new form by default in the grid.
///
showAddNewRow-boolean default-false
///
///Gets or sets a value that indicates whether to enable the alternative rows differentiation in the grid records based on corresponding theme.
///
enableAltRow-boolean default-true
///
///Gets or sets a value that indicates whether to enable the save action in the grid through row selection
///
enableAutoSaveOnSelectionChange-boolean default-true
///
///Gets or sets a value that indicates whether to enable mouse over effect on the corresponding column header cell of the grid
///
enableHeaderHover-boolean default-false
///
///Gets or sets a value that indicates whether to persist the grid model state in page using applicable medium i.e., HTML5 localStorage or cookies
///
enablePersistence-boolean default-false
///
///Gets or sets a value that indicates whether the grid rows has to be rendered as detail view in mobile mode
///
enableResponsiveRow-boolean default-false
///
///Gets or sets a value that indicates whether to enable mouse over effect on corresponding grid row.
///
enableRowHover-boolean default-true
///
///Align content in the grid control from right to left by setting the property as true.
///
enableRTL-boolean default-false
///
///To Disable the mouse swipe property as false.
///
enableTouch-boolean default-true
///
///It sets a value that indicates whether to enable toolbar items, when allowEditing, allowAdding and allowDeleting property set as false in the grid.
///
enableToolbarItems-boolean default-false
///
///Act as mapper for the excel exporting URL.
///
exportToExcelAction-string default-ExportToExcel
///
///Act as mapper for the PDF exporting URL.
///
exportToPdfAction-string default-ExportToPdf
///
///Act as mapper for the Word exporting URL.
///
exportToWordAction-string default-ExportToWord
///
///Gets or sets an object that indicates whether to customize the filtering behavior of the grid
///
filterSettings-FilterSettings default-
///
///Gets or sets a value that indicates to perform the filter operation with case sensitive in excel styled filter menu mode
///
enableCaseSensitivity-boolean default-false
///
///Gets or sets a value that indicates to define the interDeterminateState of checkbox in excel filter dialog.
///
enableInterDeterminateState-boolean default-true
///
///This specifies the grid to starts the filter action while typing in the filterBar or after pressing the enter key. based on the filterBarMode. See filterBarMode.
///
filterBarMode-ej.Grid.FilterBarMode|string default-ej.Grid.FilterBarMode.Immediate
///
///Gets or sets a value that indicates whether to define the filtered columns details programmatically at initial load
///
filteredColumns-Array<any> default-[]
///
///Gets or sets a value that indicates whether to define the field name of the column to be filter.
///
field-string default-
///
///Gets or sets a value that indicates whether to define the matchCase of given value to be filter.
///
matchCase-boolean default-
///
///Gets or sets a value that indicates whether to define the filter condition to filtered column. See operator
///
operator-ej.FilterOperators|string default-
///
///Gets or sets a value that indicates whether to define the predicate as and/or.
///
predicate-string default-
///
///Gets or sets a value that indicates whether to define the value to be filtered in a column.
///
value-string|number default-
///
///This specifies the grid to show the filterBar or filterMenu to the grid records. See filterType
///
filterType-ej.Grid.FilterType|string default-ej.Grid.FilterType.FilterBar
///
///This specifies the grid to delay the filter action while typing in the filterBar.
///
immediateModeDelay-number default-1500
///
///Gets or sets a value that indicates the maximum number of filter choices that can be showed in the excel styled filter menu.
///
maxFilterChoices-number default-1000
///
///This specifies the grid to show the filter text within the grid pager itself.
///
showFilterBarStatus-boolean default-true
///
///Gets or sets a value that indicates whether to enable the predicate options in the filtering menu
///
showPredicate-boolean default-false
///
///Gets or sets an object that indicates whether to customize the grouping behavior of the grid.
///
groupSettings-GroupSettings default-
///
///Gets or sets a value that customize the group caption format.
///
captionFormat-string default-null
///
///Gets or sets a value that indicates whether to enable animation button option in the group drop area of the grid.
///
enableDropAreaAutoSizing-boolean default-false
///
///Gets or sets a value that indicates whether to add grouped columns programmatically at initial load
///
groupedColumns-Array<any> default-[]
///
///Gets or sets a value that indicates whether to show the group drop area just above the column header. It can be used to avoid ungrouping the already grouped column using groupSettings.
///
showDropArea-boolean default-true
///
///Gets or sets a value that indicates whether to hide the grouped columns from the grid
///
showGroupedColumn-boolean default-false
///
///Gets or sets a value that indicates whether to show the group button image(toggle button)in the column header and also in the grouped column in the group drop area . It can be used to group/ungroup the columns by click on the toggle button.
///
showToggleButton-boolean default-false
///
///Gets or sets a value that indicates whether to enable the close button in the grouped column which is in the group drop area to ungroup the grouped column
///
showUngroupButton-boolean default-false
///
///Gets or sets a value that indicates whether the grid design has be to made responsive.
///
isResponsive-boolean default-false
///
///This specifies to change the key in keyboard interaction to grid control
///
keySettings-any default-null
///
///Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region.
///
locale-string default-en-US
///
///Gets or sets a value that indicates whether to set the minimum width of the responsive grid while isResponsive property is true and enableResponsiveRow property is set as false.
///
minWidth-number default-0
///
///Gets or sets an object that indicates whether to modify the pager default configuration.
///
pageSettings-PageSettings default-
///
///Gets or sets a value that indicates whether to define which page to display currently in the grid
///
currentPage-number default-1
///
///Gets or sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page.
///
enableQueryString-boolean default-false
///
///Gets or sets a value that indicates whether to enables pager template for the grid.
///
enableTemplates-boolean default-false
///
///Gets or sets a value that indicates whether to define the number of pages displayed in the pager for navigation
///
pageCount-number default-8
///
///Gets or sets a value that indicates whether to define the number of records displayed per page
///
pageSize-number default-12
///
///Gets or sets different page size values to the Dropdown in Grid Pager, by which number of records in a page can be changed dynamically.
///
pageSizeList-Array<any> default-[]
///
///Gets or sets a value that indicates whether to enables default pager for the grid.
///
showDefaults-boolean default-false
///
///Gets or sets a value that indicates to add the template as a pager template for grid.
///
template-string default-null
///
///Get the value of total number of pages in the grid. The totalPages value is calculated based on page size and total records of grid
///
totalPages-number default-null
///
///Get the value of total number of records which is bound to the grid. The totalRecordsCount value is calculated based on dataSource bound to the grid.
///
totalRecordsCount-number default-null
///
///Gets or sets a value that indicates whether to define the number of pages to print. See printMode.
///
printMode-ej.Grid.PrintMode|string default-ej.Grid.PrintMode.AllPages
///
///Query the dataSource from the table for Grid.
///
query-any default-null
///
///Gets or sets an object that indicates whether to modify the resizing behavior.
///
resizeSettings-ResizeSettings default-
///
///Gets or sets a value that indicates whether to define the mode of resizing.
///
resizeMode-ej.Grid.ResizeMode|string default-ej.Grid.ResizeMode.Normal
///
///Gets or sets a value that indicates to render the grid with template rows. The template row must be a table row. That table row must have the JavaScript render binding format ({{:columnName}}) then the grid data source binds the data to the corresponding table row of the template.
///
rowTemplate-string default-null
///
///Gets or sets an object that indicates whether to customize the drag and drop behavior of the grid rows
///
rowDropSettings-RowDropSettings default-
///
///This specifies the grid to drop the grid rows only at particular target element.
///
dropTargetID-any default-null
///
///This helps in mapping server-side action when rows are dragged from Grid.
///
dragMapper-string default-null
///
///This helps in mapping server-side action when rows are dropped in Grid.
///
dropMapper-string default-null
///
///Gets or sets a value that indicates whether move or copy a record from one grid to another or within the grid
///
dragBehavior-ej.Grid.DragBehavior|string default-ej.Grid.DragBehavior.Move
///
///Gets or sets an object that indicates whether to customize the searching behavior of the grid
///
searchSettings-SearchSettings default-
///
///This specify the grid to search for the value in particular columns that is mentioned in the field.
///
fields-any default-[]
///
///This specifies the grid to search the particular data that is mentioned in the key.
///
key-string default-
///
///It specifies the grid to search the records based on operator.
///
operator-string default-contains
///
///It enables or disables case-sensitivity while searching the search key in grid.
///
ignoreCase-boolean default-true
///
///Gets a value that display the array of selected records in the Grid.
///
selectedRecords-Array<any> default-null
///
///Gets or sets a value that indicates to select the row while initializing the grid
///
selectedRowIndex-number default--1
///
///Gets or sets a value that indicates the selected rows in grid
///
selectedRowIndices-Array<any> default-[]
///
///This property is used to configure the selection behavior of the grid.
///
selectionSettings-SelectionSettings default-
///
///Gets or sets a value that indicates the cell selection actions based on the cell selection mode.
///
cellSelectionMode-ej.Grid.CellSelectionMode|string default-ej.Grid.CellSelectionMode.Flow
///
///Gets or sets a value that indicates whether to enable the toggle selection behavior for row, cell and column.
///
enableToggle-boolean default-false
///
///Gets or sets a value that indicates whether to select multiple rows or cells by performing dragging in Grid.
///
allowDragSelection-boolean default-false
///
///Gets or sets a value that indicates whether to add the default selection actions as a selection mode.See selectionMode
///
selectionMode-Array<any> default-[row]
///
///The row selection behavior of grid. Accepting types are "single" and "multiple".
///
selectionType-ej.Grid.SelectionType|string default-ej.Grid.SelectionType.Single
///
///Gets or sets an object that indicates whether to customize the scrolling behavior of the grid.
///
scrollSettings-ScrollSettings default-
///
///This specify the grid to to view data that you require without buffering the entire load of a huge database
///
allowVirtualScrolling-boolean default-false
///
///It accepts the boolean value and shows or hides the scrollbar while focus in or focus out of the Grid.
///
autoHide-boolean default-false
///
///Specifies the height and width of button in the scrollbar.
///
buttonSize-number default-18
///
///This specify the grid to enable/disable touch control for scrolling.
///
enableTouchScroll-boolean default-true
///
///This specify the grid to freeze particular columns at the time of scrolling.
///
frozenColumns-number default-0
///
///This specify the grid to freeze particular rows at the time of scrolling.
///
frozenRows-number default-0
///
///This specify the grid to show the vertical scroll bar, to scroll and view the grid contents.
///
height-string|number default-0
///
///It accepts the integer value and sets the width of scrollbar.
///
scrollerSize-number default-18
///
///This is used to define the mode of virtual scrolling in grid. See virtualScrollMode
///
virtualScrollMode-ej.Grid.VirtualScrollMode|string default-ej.Grid.VirtualScrollMode.Normal
///
///This is used to enable the enhanced virtual scrolling in Grid.
///
enableVirtualization-boolean default-false
///
///This specify the grid to show the horizontal scroll bar, to scroll and view the grid contents
///
width-string|number default-250
///
///This specify the scroll down pixel of mouse wheel, to scroll mouse wheel and view the grid contents.
///
scrollOneStepBy-number default-57
///
///Default Value:
///
showColumnChooser-boolean default-false
///
///Gets or sets a value that indicates stacked header should be shown on grid layout when the property “stackedHeaderRows†is set.
///
showStackedHeader-boolean default-false
///
///Gets or sets a value that indicates summary rows should be shown on grid layout when the property “summaryRows†is set
///
showSummary-boolean default-false
///
///Gets or sets a value that indicates whether to customize the sorting behavior of the grid.
///
sortSettings-SortSettings default-
///
///Gets or sets a value that indicates whether to define the direction and field to sort the column.
///
sortedColumns-Array<any> default-
///
///Gets or sets a value that indicates whether to define the direction to sort the column.
///
direction-string default-
///
///Gets or sets a value that indicates whether to define the field name of the column to be sort
///
field-string default-
///
///Gets or sets an object that indicates to managing the collection of stacked header rows for the grid.
///
stackedHeaderRows-Array<StackedHeaderRows> default-[]
///
///Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows
///
stackedHeaderColumns-Array<any> default-[]
///
///Gets or sets a value that indicates the header text for the particular stacked header column.
///
column-any default-null
///
///Gets or sets a value that indicates class to the corresponding stackedHeaderColumn.
///
cssClass-string default-null
///
///Gets or sets a value that indicates the header text for the particular stacked header column.
///
headerText-string default-null
///
///Gets or sets a value that indicates the text alignment of the corresponding headerText.
///
textAlign-string default-ej.TextAlign.Left
///
///Sets the template for tooltip for the Grid stackedHeaderColumns.
///
tooltip-string default-null
///
///Gets or sets an object that indicates to managing the collection of summary rows for the grid.
///
summaryRows-Array<SummaryRows> default-[]
///
///Gets or sets a value that indicates whether to show the summary value within the group caption area for the corresponding summary column while grouping the column
///
showCaptionSummary-boolean default-false
///
///Gets or sets a value that indicates whether to show the group summary value for the corresponding summary column while grouping a column
///
showGroupSummary-boolean default-false
///
///Gets or sets a value that indicates whether to show the total summary value the for the corresponding summary column. The summary row is added after the grid content.
///
showTotalSummary-boolean default-true
///
///Gets or sets a value that indicates whether to add summary columns into the summary rows.
///
summaryColumns-Array<any> default-[]
///
///Gets or sets a value that indicates the text displayed in the summary column as a value
///
customSummaryValue-string default-null
///
///This specifies summary column used to perform the summary calculation
///
dataMember-string default-null
///
///Gets or sets a value that indicates to define the target column at which to display the summary.
///
displayColumn-string default-null
///
///Gets or sets a value that indicates the format for the text applied on the column
///
format-string default-null
///
///Gets or sets a value that indicates the text displayed before the summary column value
///
prefix-string default-null
///
///Gets or sets a value that indicates the text displayed after the summary column value
///
suffix-string default-null
///
///Gets or sets a value that indicates the type of calculations to be performed for the corresponding summary column. See summaryType.
///
summaryType-ej.Grid.SummaryType|string default-[]
///
///Gets or sets a value that indicates to add the template for the summary value of dataMember given.
///
template-string default-null
///
///This specifies the grid to show the title for the summary rows.
///
title-string default-
///
///This specifies the grid to show the title of summary row in the specified column.
///
titleColumn-string default-null
///
///Gets or sets an object that indicates whether to auto wrap the grid header or content or both
///
textWrapSettings-TextWrapSettings default-
///
///This specifies the grid to apply the auto wrap for grid content or header or both.
///
wrapMode-ej.Grid.WrapMode|string default-ej.Grid.WrapMode.Both
///
///Gets or sets an object that indicates whether to enable the toolbar in the grid and add toolbar items
///
toolbarSettings-ToolbarSettings default-
///
///Gets or sets a value that indicates whether to add custom toolbar items within the toolbar to perform any action in the grid
///
customToolbarItems-Array<any> default-[]
///
///Gets or sets a value that indicates whether to add custom toolbar item as a template element.
///
templateID-string default-
///
///Gets or sets a value that indicates whether to add custom toolbar item with a custom tooltip.
///
tooltip-string default-
///
///Gets or sets a value that indicates whether to enable toolbar in the grid.
///
showToolbar-boolean default-false
///
///Gets or sets a value that indicates whether to add the default editing actions as a toolbar items. See toolbarItems.
///
toolbarItems-array<ej.Grid.ToolBarItems|string> default-[]
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
GroupButton:function(){
///
/// Constructor of ej.GroupButton
///
}
});
ej.GroupButton=(function(){
var original=ej.GroupButton
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
deselectItem:function(element){
///
///
/// Remove the selection state of the specified the button element from the GroupButton
///
/// Specific button element
///
},
destroy:function(){
///
///
/// Destroy the GroupButton widget all events bound using this._on will be unbind automatically and bring the control to pre-init state.
///
},
disable:function(){
///
///
/// Disables the GroupButton control
///
},
disableItem:function(element){
///
///
/// Disable the specified button element from the ejGroupButton control.
///
/// Specific button element
///
},
enable:function(){
///
///
/// Enables the disabled ejGroupButton control.
///
},
enableItem:function(element){
///
///
/// Enable the specified disabled button element from the ejGroupButton control.
///
/// Specific button element
///
},
getIndex:function(element){
///
///
/// Returns the index value for specified button element in the GroupButton control.
///
/// Specific button element
///
},
getSelectedItem:function(){
///
///
/// This method returns the list of active state button elements from the GroupButton control.
///
},
hide:function(){
///
///
/// Hides the GroupButton control
///
},
hideItem:function(element){
///
///
/// Hide the specified button element from the ejGroupButton control.
///
/// Specific button element
///
},
isDisabled:function(){
///
///
/// Returns the disabled state of the specified element button element in GroupButton as Boolean.
///
},
isSelected:function(){
///
///
/// Returns the state of the specified button element as Boolean.
///
},
selectItem:function(element){
///
///
/// Public method used to select the specified button element from the ejGroupButton control.
///
/// Specific button element
///
},
show:function(){
///
///
/// Shows the GroupButton control, if its hide.
///
},
showItem:function(element){
///
///
/// Show the specified hidden button element from the ejGroupButton control.
///
/// Specific button element
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejGroupButton=function(){
this.data("ejGroupButton",new ej.GroupButton());
return this;
};
intellisense.annotate(jQuery.fn,{
ejGroupButton :function (options) {
///
///
///The Essential JavaScript Group Button widget helps to display multiple buttons which are stacked together in a single line and used as a navigation component. Also it manages the checked/unchecked state for a set of buttons, since it supports radio and check button modes.
///Sets the specified class to GroupButton wrapper element, which allows for custom skinning option in ejGroupButton control.
///
cssClass-string default-
///
///To set the local JSON data, define a JSON array and initialize the GroupButton with dataSource property. Specify the column names in the fields property.
///
dataSource-any default-null
///
///Displays the ejGroupButton in Right to Left direction.
///
enableRTL-boolean default-false
///
///Used to enable or disable the ejGroupButton control.
///
enabled-boolean default-true
///
///Gets or sets a value that indicates to display the values of the data.
///
fields-any default-null
///
///Sets the GroupButton behavior to works as Checkbox mode/ radio button mode based on the specified option.
///
groupButtonMode-ej.GroupButtonMode | string default-ej.GroupButtonMode.RadioButton
///
///Used to sets the height of the ejGroupButton control.
///
height-string|number default-28
///
///Defines the characteristics of the ejGroupButton control and extend the capability of an HTML element by adding specified attributes to element tag and by performing the related actions
///
htmlAttributes-any default-{}
///
///Specify the orientation of the GroupButton. See below to get available orientations
///
orientation-ej.Orientation|string default-ej.Orientation.Horizontal
///
///Query the dataSource from the table for Groupbutton
///
query-any default-null
///
///Sets the list of button elements to be selected. To enable this option groupButtonMode should be in “checkbox†mode.
///
selectedItemIndex-number[]|string[] default-[]
///
///Sets the rounder corner to the GroupButton, if sets as true.
///
showRoundedCorner-boolean default-false
///
///Specifies the size of the button. See available size
///
size-ej.ButtonSize|string default-ej.ButtonSize.Normal
///
///Defines the width of the ejGroupButton control.
///
width-string|number default-
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
HeatMap:function(){
///
/// Constructor of ej.HeatMap
///
}
});
ej.HeatMap=(function(){
var original=ej.HeatMap
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejHeatMap=function(){
this.data("ejHeatMap",new ej.HeatMap());
return this;
};
intellisense.annotate(jQuery.fn,{
ejHeatMap :function (options) {
///
///
///Essential HeatMap JS represents tabular data values as gradient colors instead of numbers,low and high values are different colors with different gradients.
///Specifies the width of the heat map.
///
width-any default-null
///
///Specifies the width of the heat map.
///
height-any default-null
///
///Specifies the name of the heat map.
///
id-number default-null
///
///Enables or disables tooltip of heatmap
///
showTooltip-boolean default-true
///
///Defines the tooltip that should be shown when the mouse hovers over rows/columns.
///
tooltipSettings-TooltipSettings default-
///
///Defines the tooltip that should be shown when the mouse hovers over rows/columns.
///
templateId-string default-null
///
///Defines the tooltip of associate that should be shown when the mouse hovers over rows/columns.
///
associate-ej.datavisualization.HeatMap.Associate|string default-mouseFollow
///
///Enables/ disables the balloon for the tooltip to be shown
///
isBalloon-boolean default-true
///
///Defines various attributes of the Tooltip position
///
position-any default-
///
///Sets the Tooltip position against target.
///
target-any default-
///
///Sets the arrow position again popup based on horizontal(x) value
///
horizontal-ej.datavisualization.HeatMap.Horizontal|string default-center
///
///Sets the arrow position again popup based on vertical(y) value
///
vertical-ej.datavisualization.HeatMap.Vertical|string default-top
///
///Sets the arrow position again popup.
///
stem-any default-
///
///Sets the arrow position again popup based on horizontal(x) value
///
horizontal-ej.datavisualization.HeatMap.Horizontal|string default-center
///
///Sets the arrow position again popup based on vertical(y) value
///
vertical-ej.datavisualization.HeatMap.Vertical|string default-bottom
///
///Defines the tooltip to be triggered.
///
trigger-ej.datavisualization.HeatMap.Trigger|string default-hover
///
///Defines the animation for the tooltip that should be shown when the mouse hovers over rows/columns.
///
animation-any default-
///
///Defines the animation effect for the tooltip that should be shown when the mouse hovers over rows/columns.
///
effect-ej.datavisualization.HeatMap.Effect|string default-none
///
///Defines the animation speed for the tooltip that should be shown when the mouse hovers over rows/columns.
///
speed-number default-0
///
///Specifies the source data of the heat map.
///
itemsSource-any default-[]
///
///Specifies the property of the heat map cell.
///
heatMapCell-HeatMapCell default-Null
///
///Specifies whether the cell content can be visible or not.
///
showContent-ej.datavisualization.HeatMap.CellVisibility|string default-ej.HeatMap.CellVisibility.Visible
///
///Specifies whether the cell color can be visible or not.
///
showColor-boolean default-true
///
///Specifies can enable responsive mode or not for heat map.
///
isResponsive-boolean default-false
///
///Specifies whether the virtualization can be enable or not.
///
enableVirtualization-boolean default-false
///
///Specifies the default column properties for all the column style not specified in column properties.
///
defaultColumnStyle-DefaultColumnStyle default-[]
///
///Specifies the alignment mode of the heat map column.
///
textAlign-any default-ej.HeatMap.TextAlign.Center
///
///Specifies the template id of the heat map column header.
///
headerTemplateID-string default-
///
///Specifies the template id of all individual cell data of the heat map.
///
templateID-string default-
///
///Specifies the no of legends can sync with heat map.
///
legendCollection-Array<any> default-[]
///
///Specifies the property and display value of the heat map column.
///
itemsMapping-ItemsMapping default-[]
///
///Column settings for the individual heat map column.
///
columnStyle-any default-null
///
///Specifies the width of the heat map column.
///
width-number default-0
///
///Specifies the text align mode of the heat map column.
///
textAlign-string default-ej.HeatMap.TextAlign.Center
///
///Specifies the template id of the column header.
///
headerTemplateID-string default-
///
///Specifies the template id of all individual cell data.
///
templateID-string default-
///
///Specifies the property and display value of the column.
///
column-any default-null
///
///Specifies the name of the column or row.
///
propertyName-string default-
///
///Specifies the value of the column or row.
///
displayName-string default-
///
///Specifies the row property and display value of the heat map.
///
row-any default-null
///
///Specifies the name of the column or row.
///
propertyName-string default-
///
///Specifies the value of the column or row.
///
displayName-string default-
///
///Specifies the property and display value of the column value.
///
value-any default-null
///
///Specifies the name of the column or row.
///
propertyName-string default-
///
///Specifies the value of the column or row.
///
displayName-string default-
///
///Specifies the property and display value of the header.
///
headerMapping-any default-null
///
///Specifies the name of the column or row.
///
propertyName-string default-
///
///Specifies the value of the column or row.
///
displayName-string default-
///
///Specifies the property and display value of the header.
///
columnStyle-any default-null
///
///Specifies the property and display value of the collection of column.
///
columnMapping-Array<any> default-[]
///
///Specifies the color values of the heat map column data.
///
colorMappingCollection-Array<ColorMappingCollection> default-[]
///
///Specifies the color of the heat map column data.
///
color-string default-white
///
///Specifies the color values of the heat map column data.
///
value-number default-0
///
///Specifies the label properties of the heat map color.
///
label-any default-null
///
///Enables/disables the bold style of the heat map label.
///
bold-boolean default-false
///
///Enables/disables the italic style of the heat map label.
///
italic-boolean default-false
///
///specifies the text value of the heat map label.
///
text-string default-
///
///Specifies the text style of the heat map label.
///
textDecoration-ej.datavisualization.HeatMap.TextDecoration |string default-ej.HeatMap.TextDecoration.None
///
///Specifies the font size of the heat map label.
///
fontSize-number default-10
///
///Specifies the font family of the heat map label.
///
fontFamily-string default-Arial
///
///Specifies the font color of the heat map label.
///
fontColor-string default-black
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
HeatMapLegend:function(){
///
/// Constructor of ej.HeatMapLegend
///
}
});
ej.HeatMapLegend=(function(){
var original=ej.HeatMapLegend
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejHeatMapLegend=function(){
this.data("ejHeatMapLegend",new ej.HeatMapLegend());
return this;
};
intellisense.annotate(jQuery.fn,{
ejHeatMapLegend :function (options) {
///
///
///Legend is a control used to summarize the range of colors in HeatMap. This gives visual guideline for mapping between value and color.
///Specifies the width of the heatmap legend.
///
width-any default-null
///
///Specifies the height of the heatmap legend.
///
height-any default-null
///
///Specifies can enable responsive mode or not for heatmap legend.
///
isResponsive-boolean default-false
///
///Specifies whether the cell label can be shown or not.
///
showLabel-boolean default-false
///
///Specifies the color values of the column data.
///
colorMappingCollection-Array<ColorMappingCollection> default-[]
///
///Specifies the color of the heatmap legend data.
///
color-string default-white
///
///Specifies the color values of the heatmap legend column data.
///
value-number default-0
///
///Specifies the label properties of the heatmap legend color.
///
label-any default-null
///
///Enables/disables the bold style of the heatmap legend label.
///
bold-boolean default-false
///
///Enables/disables the italic style of the heatmap legend label.
///
italic-boolean default-false
///
///specifies the text value of the heatmap legend label.
///
text-string default-
///
///Specifies the text style of the heatmap legend label.
///
textDecoration-ej.datavisualization.HeatMap.TextDecoration|string default-ej.HeatMap.TextDecoration.None
///
///Specifies the font size of the heatmap legend label.
///
fontSize-number default-10
///
///Specifies the font family of the heatmap legend label.
///
fontFamily-string default-Arial
///
///Specifies the font color of the heatmap legend label.
///
fontColor-string default-black
///
///Specifies the orientation of the heatmap legend
///
orientation-ej.datavisualization.HeatMap.LegendOrientation|string default-ej.HeatMap.LegendOrientation.Horizontal
///
///Specifies the legend mode as gradient or list.
///
legendMode-ej.datavisualization.HeatMap.LegendMode|string default-ej.HeatMap.LegendMode.Gradient
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Kanban:function(){
///
/// Constructor of ej.Kanban
///
}
});
ej.Kanban=(function(){
var original=ej.Kanban
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
columns:function(columndetails, keyvalue, action){
///
///
/// Add or remove columns in Kanban columns collections.Default action is add.
///
/// Pass array of columns or string of headerText to add/remove the column in Kanban
///
///
///
/// Add or remove columns in Kanban columns collections.Default action is add.
///
/// Pass array of columns or string of key value to add/remove the column in Kanban
///
///
///
/// Add or remove columns in Kanban columns collections.Default action is add.
///
/// optional Pass add/remove action to be performed. By default "add" action will perform
///
},
destroy:function(){
///
///
/// Destroy the Kanban widget all events bound using this._on will be unbind automatically and bring the control to pre-init state.
///
},
dataSource:function(datasource){
///
///
/// Refresh the Kanban with new data source.
///
/// Pass new data source to the Kanban
///
},
toggleColumn:function(headerText){
///
///
/// toggleColumn based on the headerText in Kanban.
///
/// Pass the header text of the column to get the corresponding column object
///
},
toggleCard:function(key){
///
///
/// Expand or collapse the card based on the state of target "div"
///
/// Pass the id of card to be toggle
///
},
getVisibleColumnNames:function(){
///
///
/// Used for get the names of all the visible column name collections in Kanban.
///
},
getScrollObject:function(){
///
///
/// Get the scroller object of Kanban.
///
},
getColumnByHeaderText:function(headerText){
///
///
/// Get the column details based on the given header text in Kanban.
///
/// Pass the header text of the column to get the corresponding column object
///
},
getHeaderTable:function(){
///
///
/// Get the table details based on the given header table in Kanban.
///
},
hideColumns:function(headerText){
///
///
/// Hide columns from the Kanban based on the header text
///
/// you can pass either array of header text of various columns or a header text of a column to hide
///
},
print:function(){
///
///
/// Print the Kanban Board
///
},
refreshTemplate:function(){
///
///
/// Refresh the template of the Kanban
///
},
refresh:function(templateRefresh){
///
///
/// Refresh the Kanban contents.The template refreshment is based on the argument passed along with this method
///
/// optional When templateRefresh is set true, template and Kanban contents both are refreshed in Kanban else only Kanban content is refreshed
///
},
showColumns:function(headerText){
///
///
/// Show columns in the Kanban based on the header text.
///
/// You can pass either array of header text of various columns or a header text of a column to show
///
},
updateCard:function(key, data){
///
///
/// Update a card in Kanban control based on key and JSON data given.
///
/// Pass the key field Name of the column
///
///
///
/// Update a card in Kanban control based on key and JSON data given.
///
/// Pass the edited JSON data of card need to be update.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejKanban=function(){
this.data("ejKanban",new ej.Kanban());
return this;
};
intellisense.annotate(jQuery.fn,{
ejKanban :function (options) {
///
///
///The Kanban can be easily configured to the DOM element, such as div. You can create a Kanban with a highly customizable look and feel.
///Gets or sets a value that indicates whether to enable allowDragAndDrop behavior on Kanban.
///
allowDragAndDrop-boolean default-true
///
///Gets or sets a value that indicates whether to enable drag and drop behavior between Kanban controls.
///
allowExternalDragAndDrop-boolean default-false
///
///To enable or disable the title of the card.
///
allowTitle-boolean default-false
///
///Customize the settings for swim lane.
///
swimlaneSettings-SwimlaneSettings default-Object
///
///To enable or disable items count in swim lane.
///
showCount-boolean default-true
///
///To enable or disable DragAndDrop across swim lane.
///
allowDragAndDrop-boolean default-false
///
///To enable or disable empty swimlane on Kanban board. It is used to shown empty swimlane when no data's present on headers key mapping value.
///
showEmptySwimlane-boolean default-false
///
///Gets or sets an object that indicates to render the swimlane rows with specified swimlane headers.
///
headers-Array<any> default-[]
///
///Gets or sets a value that indicates to render the Kanban with specified swimlane header text.
///
text-string default-null
///
///Gets or sets a value that indicates to render the Kanban with specified swimlane header key.
///
key-string default-null
///
///Customize the settings for unassigned category of swim lane.
///
unassignedGroup-any default-Object
///
///To enable or disable unassigned category change with swim lane key values.
///
enable-boolean default-true
///
///To set the user defined values which are need to categorized as unassigned category swim lane groups.
///
keys-Array<any> default-[null,undefined,]
///
///To enable or disable the column expand /collapse.
///
allowToggleColumn-boolean default-false
///
///To enable Searching operation in Kanban.
///
allowSearching-boolean default-false
///
///To enable filtering behavior on Kanban.User can specify query in filterSettings collection after enabling allowFiltering.
///
allowFiltering-boolean default-false
///
///Gets or sets a value that indicates whether to enable allowSelection behavior on Kanban.User can select card and the selected card will be highlighted on Kanban.
///
allowSelection-boolean default-true
///
///Gets or sets a value that indicates whether to allow card hover actions.
///
allowHover-boolean default-true
///
///To allow keyboard navigation actions.
///
allowKeyboardNavigation-boolean default-false
///
///Gets or sets a value that indicates whether to enable the scrollbar in the Kanban and view the card by scroll through the Kanban manually.
///
allowScrolling-boolean default-false
///
///Gets or sets a value that indicates whether to enable printing option.
///
allowPrinting-boolean default-false
///
///Gets or sets an object that indicates whether to customize the context menu behavior of the Kanban.
///
contextMenuSettings-ContextMenuSettings default-Object
///
///To enable context menu.All default context menu will show.
///
enable-boolean default-false
///
///Gets or sets a value that indicates the list of items needs to be disable from default context menu items.
///
disableDefaultItems-Array<any> default-Array
///
///Its used to add specific default context menu items.
///
menuItems-Array<any> default-Array
///
///Gets or sets a value that indicates whether to add custom contextMenu items.
///
customMenuItems-Array<any> default-Array
///
///Its sets target element to custom context menu item.
///
target-ej.Kanban.Target|string default-ej.Kanban.Target.All
///
///Gets the display name to custom menu item.
///
text-string default-null
///
///Gets the template to render custom context menu item.
///
template-string default-null
///
///Gets or sets an object that indicates to render the Kanban with specified columns.
///
columns-Array<Columns> default-Array
///
///Gets or sets an object that indicates to render the Kanban with specified columns header text.
///
headerText-string default-null
///
///To customize the totalCount properties.
///
totalCount-any default-Object
///
///To customize the totalCount text properties.
///
text-string default-null
///
///Gets or sets an object that indicates to render the Kanban with specified columns key.
///
key-string|number default-null
///
///To enable/disable allowDrop for specific column wise.
///
allowDrop-boolean default-true
///
///To enable/disable allowDrag for specific column wise.
///
allowDrag-boolean default-true
///
///To set column collapse or expand state
///
isCollapsed-boolean default-false
///
///To customize the column level constraints with minimum ,maximum limit validation.
///
constraints-any default-Object
///
///It is used to specify the type of constraints as column or swimlane.
///
type-string default-null
///
///It is used to specify the minimum amount of card in particular column cell or swimlane cell can hold.
///
min-number default-null
///
///It is used to specify the maximum amount of card in particular column cell or swimlane cell can hold.
///
max-number default-null
///
///Gets or sets a value that indicates to add the template within the header element.
///
headerTemplate-string default-null
///
///Gets or sets an object that indicates to render the Kanban with specified columns width.
///
width-string|number default-null
///
///Gets or sets an object that indicates to set specific column visibility.
///
visible-boolean default-true
///
///Gets or sets an object that indicates whether to show add new button.
///
showAddButton-boolean default-false
///
///Gets or sets an object that indicates whether to Customize the card settings.
///
cardSettings-CardSettings default-Object
///
///Gets or sets a value that indicates to add the template for card .
///
template-string default-null
///
///To customize the card border color based on assigned task. Colors and corresponding values defined here will be mapped with colorField mapped data source column.
///
colorMapping-any default-Object
///
///This specifies the Kanban card to drop into particular target element.
///
externalDropTarget-string default-
///
///Gets or sets a value that indicates whether to add customToolbarItems within the toolbar to perform any action in the Kanban.
///
customToolbarItems-Array<CustomToolbarItems> default-[]
///
///Gets the template to render customToolbarItems.
///
template-string default-null
///
///Gets or sets a value that indicates to render the Kanban with custom theme.
///
cssClass-string default-
///
///Gets or sets the data to render the Kanban with cards.
///
dataSource-any default-null
///
///To perform kanban functionalities with touch interaction.
///
enableTouch-boolean default-true
///
///Align content in the Kanban control align from right to left by setting the property as true.
///
enableRTL-boolean default-false
///
///To show total count of cards in each column.
///
enableTotalCount-boolean default-false
///
///Get or sets an object that indicates whether to customize the editing behavior of the Kanban.
///
editSettings-EditSettings default-Object
///
///Gets or sets a value that indicates whether to enable the editing action in cards of Kanban.
///
allowEditing-boolean default-false
///
///Gets or sets a value that indicates whether to enable the adding action in cards behavior on Kanban.
///
allowAdding-boolean default-false
///
///This specifies the id of the template which is require to be edited using the Dialog Box.
///
dialogTemplate-string default-null
///
///Get or sets an object that indicates whether to customize the editMode of the Kanban.
///
editMode-ej.Kanban.EditMode|string default-ej.Kanban.EditMode.Dialog
///
///Get or sets an object that indicates whether to customize the editing fields of Kanban card.
///
editItems-Array<any> default-Array
///
///It is used to map editing field from the data source.
///
field-string default-null
///
///It is used to set the particular editType in the card for editing.
///
editType-ej.Kanban.EditingType|string default-ej.Kanban.EditingType.String
///
///Gets or sets a value that indicates to define constraints for saving data to the database.
///
validationRules-any default-Object
///
///It is used to set the particular editparams in the card for editing.
///
editParams-any default-Object
///
///It is used to specify defaultValue for the fields while adding new card.
///
defaultValue-string|number default-null
///
///This specifies the id of the template which is require to be edited using the External edit form.
///
externalFormTemplate-string default-null
///
///This specifies to set the position of an External edit form either in the right or bottom of the Kanban.
///
formPosition-ej.Kanban.FormPosition|string default-ej.Kanban.FormPosition.Bottom
///
///To customize field mappings for card , editing title and control key parameters
///
fields-Fields default-Object
///
///The primarykey field is mapped to data source field. And this will used for Drag and drop and editing mainly.
///
primaryKey-string default-null
///
///To enable swimlane grouping based on the given key field from datasource mapping.
///
swimlaneKey-string default-null
///
///Priority field has been mapped data source field to maintain cards priority.
///
priority-string default-null
///
///Content field has been Mapped into card text.
///
content-string default-null
///
///Tag field has been Mapped into card tag.
///
tag-string default-null
///
///Title field has been Mapped to field in datasource for title content. If title field specified , card expand/collapse will be enabled with header and content section.
///
title-string default-null
///
///To customize the card has been Mapped into card color field.
///
color-string default-null
///
///ImageUrl field has been Mapped into card image.
///
imageUrl-string default-null
///
///Get or sets an object that indicates the options to map the cards to the collapsible area.
///
collapsibleCards-any default-Object
///
///It is used to specify the collapsible card's field mapping.
///
field-string default-null
///
///It is used to specify the collapsible card's key mapping which is available in datasource value of field mapped in collapsibleCards.field.
///
key-string default-null
///
///To map datasource field for column values mapping
///
keyField-string default-null
///
///When set to true, adapts the Kanban layout to fit the screen size of devices on which it renders.
///
isResponsive-boolean default-false
///
///Gets or sets a value that indicates whether to set the minimum width of the responsive Kanban while isResponsive property is true.
///
minWidth-number default-0
///
///To customize the filtering behavior based on queries given.
///
filterSettings-Array<FilterSettings> default-Array
///
///Gets or sets an object of display name to filter queries.
///
text-string default-null
///
///Gets or sets an object that Queries to perform filtering
///
query-any default-Object
///
///Gets or sets an object of tooltip to filter buttons.
///
description-string default-null
///
///ej Query to query database of Kanban.
///
query-any default-null
///
///To change the key in keyboard interaction to Kanban control.
///
keySettings-any default-null
///
///Gets or sets an object that indicates whether to customize the scrolling behavior of the Kanban.
///
scrollSettings-ScrollSettings default-Object
///
///Gets or sets an object that indicates to render the Kanban with specified scroll height.
///
height-string|number default-0
///
///Gets or sets an object that indicates to render the Kanban with specified scroll width.
///
width-string|number default-auto
///
///To allow the Kanban to freeze particular swimlane at the time of scrolling , until scroll reaches next swimlane and it continues.
///
allowFreezeSwimlane-boolean default-false
///
///To customize the searching behavior of the Kanban.
///
searchSettings-SearchSettings default-Object
///
///To customize the fields the searching operation can be perform.
///
fields-Array<any> default-Array
///
///To customize the searching string.
///
key-string default-
///
///To customize the operator based on searching.
///
operator-string default-contains
///
///To customize the ignore case based on searching.
///
ignoreCase-boolean default-true
///
///To allow customize selection type. Accepting types are "single" and "multiple".
///
selectionType-ej.Kanban.SelectionType|string default-ej.Kanban.SelectionType.Single
///
///Gets or sets an object that indicates to managing the collection of stacked header rows for the Kanban.
///
stackedHeaderRows-Array<StackedHeaderRows> default-Array
///
///Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows.
///
stackedHeaderColumns-Array<any> default-Array
///
///Gets or sets a value that indicates the headerText for the particular stacked header column.
///
headerText-string default-null
///
///Gets or sets a value that indicates the column for the particular stacked header column.
///
column-string default-null
///
///The tooltip allows to display card details in a tooltip while hovering on it.
///
tooltipSettings-TooltipSettings default-
///
///To enable or disable the tooltip display.
///
enable-boolean default-false
///
///To customize the tooltip display based on your requirements.
///
template-string default-null
///
///Gets or sets an object that indicates to render the Kanban with specified workflows.
///
workflows-Array<Workflows> default-Array
///
///Gets or sets an object that indicates to render the Kanban with specified workflows key.
///
key-string|number default-null
///
///Gets or sets an object that indicates to render the Kanban with specified workflows allowed Transitions.
///
allowedTransitions-string default-null
///
///Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region.
///
locale-string default-en-US
///
///Gets or sets a value that indicates whether to render kanban columns using without data source.
///
showColumnWhenEmpty-boolean default-false
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
LinearGauge:function(){
///
/// Constructor of ej.LinearGauge
///
}
});
ej.LinearGauge=(function(){
var original=ej.LinearGauge
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
destroy:function(){
///
///
/// destroy the linear gauge all events bound using this._on will be unbind automatically and bring the control to pre-init state.
///
},
exportImage:function(fileName, fileType){
///
///
/// To export Image
///
/// for the Image
///
///
///
/// To export Image
///
/// for the Image
///
},
getBarDistanceFromScale:function(scaleIndex, pointerIndex){
///
///
/// To get Bar Distance From Scale in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Bar Distance From Scale in number
///
/// pointerIndex value for the Gauge
///
},
getBarPointerValue:function(scaleIndex, pointerIndex){
///
///
/// To get Bar Pointer Value in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Bar Pointer Value in number
///
/// pointerIndex value for the Gauge
///
},
getBarWidth:function(scaleIndex, pointerIndex){
///
///
/// To get Bar Width in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Bar Width in number
///
/// pointerIndex value for the Gauge
///
},
getCustomLabelAngle:function(scaleIndex, customLabelIndex){
///
///
/// To get CustomLabel Angle in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get CustomLabel Angle in number
///
/// customLabelIndex value for the Gauge
///
},
getCustomLabelValue:function(scaleIndex, customLabelIndex){
///
///
/// To get CustomLabel Value in string
///
/// scaleIndex value for the Gauge
///
///
///
/// To get CustomLabel Value in string
///
/// customLabelIndex value for the Gauge
///
},
getLabelAngle:function(scaleIndex, labelIndex){
///
///
/// To get Label Angle in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Label Angle in number
///
/// value for the Gauge
///
},
getLabelPlacement:function(scaleIndex, labelIndex){
///
///
/// To get LabelPlacement in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get LabelPlacement in number
///
/// value for the Gauge
///
},
getLabelStyle:function(scaleIndex, labelIndex){
///
///
/// To get LabelStyle in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get LabelStyle in number
///
/// value for the Gauge
///
},
getLabelXDistanceFromScale:function(scaleIndex, labelIndex){
///
///
/// To get Label XDistance From Scale in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Label XDistance From Scale in number
///
/// value for the Gauge
///
},
getLabelYDistanceFromScale:function(scaleIndex, labelIndex){
///
///
/// To get PointerValue in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get PointerValue in number
///
/// value for the Gauge
///
},
getMajorIntervalValue:function(scaleIndex){
///
///
/// To get Major Interval Value in number
///
/// scaleIndex value for the Gauge
///
},
getMarkerStyle:function(scaleIndex, pointerIndex){
///
///
/// To get MarkerStyle in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get MarkerStyle in number
///
/// pointerIndex value for the Gauge
///
},
getMaximumValue:function(scaleIndex){
///
///
/// To get Maximum Value in number
///
/// scaleIndex value for the Gauge
///
},
getMinimumValue:function(scaleIndex, pointerIndex){
///
///
/// To get PointerValue in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get PointerValue in number
///
/// value for the Gauge
///
},
getMinorIntervalValue:function(scaleIndex){
///
///
/// To get Minor Interval Value in number
///
/// scaleIndex value for the Gauge
///
},
getPointerDistanceFromScale:function(scaleIndex, pointerIndex){
///
///
/// To get Pointer Distance From Scale in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Pointer Distance From Scale in number
///
/// pointerIndex value for the Gauge
///
},
getPointerHeight:function(scaleIndex, pointerIndex){
///
///
/// To get PointerHeight in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get PointerHeight in number
///
/// pointerIndex value for the Gauge
///
},
getPointerPlacement:function(scaleIndex, pointerIndex){
///
///
/// To get Pointer Placement in String
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Pointer Placement in String
///
/// pointerIndex value for the Gauge
///
},
getPointerValue:function(scaleIndex, pointerIndex){
///
///
/// To get PointerValue in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get PointerValue in number
///
/// pointerIndex value for the Gauge
///
},
getPointerWidth:function(scaleIndex, pointerIndex){
///
///
/// To get PointerWidth in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get PointerWidth in number
///
/// pointerIndex value for the Gauge
///
},
getRangeBorderWidth:function(scaleIndex, rangeIndex){
///
///
/// To get Range Border Width in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Range Border Width in number
///
/// rangeIndex value for the Gauge
///
},
getRangeDistanceFromScale:function(scaleIndex, rangeIndex){
///
///
/// To get Range Distance From Scale in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Range Distance From Scale in number
///
/// rangeIndex value for the Gauge
///
},
getRangeEndValue:function(scaleIndex, rangeIndex){
///
///
/// To get Range End Value in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Range End Value in number
///
/// rangeIndex value for the Gauge
///
},
getRangeEndWidth:function(scaleIndex, rangeIndex){
///
///
/// To get Range End Width in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Range End Width in number
///
/// rangeIndex value for the Gauge
///
},
getRangePosition:function(scaleIndex, rangeIndex){
///
///
/// To get Range Position in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Range Position in number
///
/// rangeIndex value for the Gauge
///
},
getRangeStartValue:function(scaleIndex, rangeIndex){
///
///
/// To get Range Start Value in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Range Start Value in number
///
/// rangeIndex value for the Gauge
///
},
getRangeStartWidth:function(scaleIndex, rangeIndex){
///
///
/// To get Range Start Width in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Range Start Width in number
///
/// rangeIndex value for the Gauge
///
},
getScaleBarLength:function(scaleIndex){
///
///
/// To get ScaleBarLength in number
///
/// scaleIndex value for the Gauge
///
},
getScaleBarSize:function(scaleIndex, pointerIndex){
///
///
/// To get Scale Bar Size in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Scale Bar Size in number
///
/// value for the Gauge
///
},
getScaleBorderWidth:function(scaleIndex){
///
///
/// To get Scale Border Width in number
///
/// scaleIndex value for the Gauge
///
},
getScaleDirection:function(scaleIndex){
///
///
/// To get Scale Direction in number
///
/// scaleIndex value for the Gauge
///
},
getScaleLocation:function(scaleIndex){
///
///
/// To get Scale Location in object
///
/// scaleIndex value for the Gauge
///
},
getScaleStyle:function(scaleIndex){
///
///
/// To get Scale Style in string
///
/// scaleIndex value for the Gauge
///
},
getTickAngle:function(scaleIndex, tickIndex){
///
///
/// To get Tick Angle in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Tick Angle in number
///
/// value for the Gauge
///
},
getTickHeight:function(scaleIndex, tickIndex){
///
///
/// To get Tick Height in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Tick Height in number
///
/// value for the Gauge
///
},
getTickPlacement:function(scaleIndex, tickIndex){
///
///
/// To get getTickPlacement in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get getTickPlacement in number
///
/// value for the Gauge
///
},
getTickStyle:function(scaleIndex, tickIndex){
///
///
/// To get Tick Style in string
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Tick Style in string
///
/// value for the Gauge
///
},
getTickWidth:function(scaleIndex, tickIndex){
///
///
/// To get Tick Width in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Tick Width in number
///
/// value for the Gauge
///
},
getTickXDistanceFromScale:function(scaleIndex, tickIndex){
///
///
/// To get get Tick XDistance From Scale in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get get Tick XDistance From Scale in number
///
/// value for the Gauge
///
},
getTickYDistanceFromScale:function(scaleIndex, tickIndex){
///
///
/// To get Tick YDistance From Scale in number
///
/// scaleIndex value for the Gauge
///
///
///
/// To get Tick YDistance From Scale in number
///
/// value for the Gauge
///
},
scales:function(){
///
///
/// Specifies the scales.
///
},
setBarDistanceFromScale:function(scaleIndex, pointerIndex, value){
///
///
/// To set setBarDistanceFromScale
///
/// scaleIndex,value for the Gauge
///
///
///
/// To set setBarDistanceFromScale
///
/// pointerIndex value for the Gauge
///
///
///
/// To set setBarDistanceFromScale
///
/// Bar DistanceFromScale value for Gauge
///
},
setBarPointerValue:function(scaleIndex, pointerIndex, value){
///
///
/// To set setBarPointerValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setBarPointerValue
///
/// pointerIndex value for the Gauge
///
///
///
/// To set setBarPointerValue
///
/// Bar Pointer Value for Gauge
///
},
setBarWidth:function(scaleIndex, pointerIndex, value){
///
///
/// To set setBarWidth
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setBarWidth
///
/// pointerIndex value for the Gauge
///
///
///
/// To set setBarWidth
///
/// Bar Width for Gauge
///
},
setCustomLabelAngle:function(scaleIndex, customLabelIndex, value){
///
///
/// To set setCustomLabelAngle
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setCustomLabelAngle
///
/// customLabelIndex value for the Gauge
///
///
///
/// To set setCustomLabelAngle
///
/// Custom Label Angle for Gauge
///
},
setCustomLabelValue:function(scaleIndex, customLabelIndex, value){
///
///
/// To set setCustomLabelValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setCustomLabelValue
///
/// customLabelIndex value for the Gauge
///
///
///
/// To set setCustomLabelValue
///
/// CustomLabel value for Gauge
///
},
setLabelAngle:function(scaleIndex, labelIndex, angle){
///
///
/// To set setLabelAngle
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setLabelAngle
///
/// value for the Gauge
///
///
///
/// To set setLabelAngle
///
/// Label Angle for Gauge
///
},
setLabelPlacement:function(scaleIndex, labelIndex, value){
///
///
/// To set setLabelPlacement
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setLabelPlacement
///
/// value for the Gauge
///
///
///
/// To set setLabelPlacement
///
/// Label Placement for Gauge
///
},
setLabelStyle:function(scaleIndex, labelIndex, value){
///
///
/// To set setLabelStyle
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setLabelStyle
///
/// value for the Gauge
///
///
///
/// To set setLabelStyle
///
/// Label Style for Gauge
///
},
setLabelXDistanceFromScale:function(scaleIndex, labelIndex, value){
///
///
/// To set setLabelXDistanceFromScale
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setLabelXDistanceFromScale
///
/// value for the Gauge
///
///
///
/// To set setLabelXDistanceFromScale
///
/// Label XDistance From Scale for Gauge
///
},
setLabelYDistanceFromScale:function(scaleIndex, labelIndex, value){
///
///
/// To set setLabelYDistanceFromScale
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setLabelYDistanceFromScale
///
/// value for the Gauge
///
///
///
/// To set setLabelYDistanceFromScale
///
/// Label YDistance From Scale for Gauge
///
},
setMajorIntervalValue:function(scaleIndex, value){
///
///
/// To set setMajorIntervalValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setMajorIntervalValue
///
/// Major Interval Value for Gauge
///
},
setMarkerStyle:function(scaleIndex, pointerIndex, value){
///
///
/// To set setMarkerStyle
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setMarkerStyle
///
/// pointerIndex value for the Gauge
///
///
///
/// To set setMarkerStyle
///
/// marker Style for Gauge
///
},
setMaximumValue:function(scaleIndex, value){
///
///
/// To set setMaximumValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setMaximumValue
///
/// MaximumValue for Gauge
///
},
setMinimumValue:function(scaleIndex, value){
///
///
/// To set setMinimumValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setMinimumValue
///
/// MinimumValue for Gauge
///
},
setMinorIntervalValue:function(scaleIndex, value){
///
///
/// To set setMinorIntervalValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setMinorIntervalValue
///
/// Minor Interval Value for Gauge
///
},
setPointerDistanceFromScale:function(scaleIndex, pointerIndex, value){
///
///
/// To set setPointerDistanceFromScale
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setPointerDistanceFromScale
///
/// pointerIndex value for the Gauge
///
///
///
/// To set setPointerDistanceFromScale
///
/// for Gauge
///
},
setPointerHeight:function(scaleIndex, pointerIndex, height){
///
///
/// To set PointerHeight
///
/// scaleIndex value for the Gauge
///
///
///
/// To set PointerHeight
///
/// pointerIndex value for the Gauge
///
///
///
/// To set PointerHeight
///
/// for Gauge
///
},
setPointerPlacement:function(scaleIndex, pointerIndex, value){
///
///
/// To set setPointerPlacement
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setPointerPlacement
///
/// pointerIndex value for the Gauge
///
///
///
/// To set setPointerPlacement
///
/// pointer placement for Gauge
///
},
setPointerValue:function(scaleIndex, pointerIndex, value){
///
///
/// To set PointerValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To set PointerValue
///
/// pointerIndex value for the Gauge
///
///
///
/// To set PointerValue
///
/// Pointer value for Gauge
///
},
setPointerWidth:function(scaleIndex, pointerIndex, width){
///
///
/// To set PointerWidth
///
/// scaleIndex value for the Gauge
///
///
///
/// To set PointerWidth
///
/// pointerIndex value for the Gauge
///
///
///
/// To set PointerWidth
///
/// Pointer width for Gauge
///
},
setRangeBorderWidth:function(scaleIndex, rangeIndex, value){
///
///
/// To set setRangeBorderWidth
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setRangeBorderWidth
///
/// rangeIndex value for the Gauge
///
///
///
/// To set setRangeBorderWidth
///
/// Range Border Width for Gauge
///
},
setRangeDistanceFromScale:function(scaleIndex, rangeIndex, value){
///
///
/// To set setRangeDistanceFromScale
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setRangeDistanceFromScale
///
/// rangeIndex value for the Gauge
///
///
///
/// To set setRangeDistanceFromScale
///
/// Range Distance FromScale for Gauge
///
},
setRangeEndValue:function(scaleIndex, rangeIndex, value){
///
///
/// To set setRangeEndValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setRangeEndValue
///
/// rangeIndex value for the Gauge
///
///
///
/// To set setRangeEndValue
///
/// Range end value for Gauge
///
},
setRangeEndWidth:function(scaleIndex, rangeIndex, value){
///
///
/// To set setRangeEndWidth
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setRangeEndWidth
///
/// rangeIndex value for the Gauge
///
///
///
/// To set setRangeEndWidth
///
/// Range End Width for Gauge
///
},
setRangePosition:function(scaleIndex, rangeIndex, value){
///
///
/// To set setRangePosition
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setRangePosition
///
/// rangeIndex value for the Gauge
///
///
///
/// To set setRangePosition
///
/// Range Position for Gauge
///
},
setRangeStartValue:function(scaleIndex, rangeIndex, value){
///
///
/// To set setRangeStartValue
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setRangeStartValue
///
/// rangeIndex value for the Gauge
///
///
///
/// To set setRangeStartValue
///
/// range start value for Gauge
///
},
setRangeStartWidth:function(scaleIndex, rangeIndex, value){
///
///
/// To set setRangeStartWidth
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setRangeStartWidth
///
/// rangeIndex value for the Gauge
///
///
///
/// To set setRangeStartWidth
///
/// Range Start Width for Gauge
///
},
setScaleBarLength:function(scaleIndex, value){
///
///
/// To set setScaleBarLength
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setScaleBarLength
///
/// Scale Bar Length for Gauge
///
},
setScaleBarSize:function(scaleIndex, value){
///
///
/// To set setScaleBarSize
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setScaleBarSize
///
/// ScaleBarSize for Gauge
///
},
setScaleBorderWidth:function(scaleIndex, value){
///
///
/// To set setScaleBorderWidth
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setScaleBorderWidth
///
/// Scale Border Width for Gauge
///
},
setScaleDirection:function(scaleIndex, value){
///
///
/// To set setScaleDirection
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setScaleDirection
///
/// Scale Direction for Gauge
///
},
setScaleLocation:function(scaleIndex, value){
///
///
/// To set setScaleLocation
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setScaleLocation
///
/// Scale position for Gauge
///
},
setScaleStyle:function(scaleIndex, value){
///
///
/// To set setScaleStyle
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setScaleStyle
///
/// for Gauge
///
},
setTickAngle:function(scaleIndex, tickIndex, angle){
///
///
/// To set setTickAngle
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setTickAngle
///
/// value for the Gauge
///
///
///
/// To set setTickAngle
///
/// Tick Angle for Gauge
///
},
setTickHeight:function(scaleIndex, tickIndex, value){
///
///
/// To set setTickHeight
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setTickHeight
///
/// value for the Gauge
///
///
///
/// To set setTickHeight
///
/// Tick Height for Gauge
///
},
setTickPlacement:function(scaleIndex, tickIndex, value){
///
///
/// To set setTickPlacement
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setTickPlacement
///
/// value for the Gauge
///
///
///
/// To set setTickPlacement
///
/// Tick Placement for Gauge
///
},
setTickStyle:function(scaleIndex, tickIndex, value){
///
///
/// To set setTickStyle
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setTickStyle
///
/// value for the Gauge
///
///
///
/// To set setTickStyle
///
/// Tick Style for Gauge
///
},
setTickWidth:function(scaleIndex, tickIndex, value){
///
///
/// To set setTickWidth
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setTickWidth
///
/// value for the Gauge
///
///
///
/// To set setTickWidth
///
/// Tick Width for Gauge
///
},
setTickXDistanceFromScale:function(scaleIndex, tickIndex, value){
///
///
/// To set setTickXDistanceFromScale
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setTickXDistanceFromScale
///
/// value for the Gauge
///
///
///
/// To set setTickXDistanceFromScale
///
/// Tick XDistance From Scale for Gauge
///
},
setTickYDistanceFromScale:function(scaleIndex, tickIndex, value){
///
///
/// To set setTickYDistanceFromScale
///
/// scaleIndex value for the Gauge
///
///
///
/// To set setTickYDistanceFromScale
///
/// value for the Gauge
///
///
///
/// To set setTickYDistanceFromScale
///
/// Tick YDistance From Scale for Gauge
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejLinearGauge=function(){
this.data("ejLinearGauge",new ej.LinearGauge());
return this;
};
intellisense.annotate(jQuery.fn,{
ejLinearGauge :function (options) {
///
///
///The Linear gauge can be easily configured to the DOM element, such as div. you can create a linear gauge with a highly customizable look and feel.
///Specifies the animationSpeed
///
animationSpeed-number default-500
///
///Specifies the backgroundColor for Linear gauge.
///
backgroundColor-string default-null
///
///Specifies the borderColor for Linear gauge.
///
borderColor-string default-null
///
///Specifies the animate state
///
enableAnimation-boolean default-true
///
///Specifies the animate state for marker pointer
///
enableMarkerPointerAnimation-boolean default-true
///
///This provides options for customizing export settings
///
exportSettings-ExportSettings default-
///
///Specifies the downloading filename
///
filename-string default-LinearGauge
///
///Specifies the format of the file to export
///
type-ej.datavisualization.LinearGauge.ExportingType|string default-png
///
///Specifies the name of the action URL
///
action-string default-
///
///Specifies the mode of exporting
///
mode-ej.datavisualization.LinearGauge.ExportingMode|string default-client
///
///Specifies the can resize state.
///
isResponsive-boolean default-false
///
///Used to Convert the date object to string while using the locale settings
///
enableGroupSeparator-boolean default-false
///
///Responsiveness of the linear gauge is controlled
///
enableResize-boolean default-false
///
///Specify frame of linear gauge
///
frame-Frame default-null
///
///Specifies the frame background image URL of linear gauge
///
backgroundImageUrl-string default-null
///
///Specifies the frame InnerWidth
///
innerWidth-number default-8
///
///Specifies the frame OuterWidth
///
outerWidth-number default-12
///
///Specifies the height of Linear gauge.
///
height-number default-400
///
///Specifies the labelColor for Linear gauge.
///
labelColor-string default-null
///
///Set the localization culture for the Linear gauge
///
locale-string default-en-US
///
///Specifies the maximum value of Linear gauge.
///
maximum-number default-100
///
///Specifies the minimum value of Linear gauge.
///
minimum-number default-0
///
///Specifies the orientation for Linear gauge.
///
orientation-string default-Vertical
///
///Specify labelPosition value of Linear gauge See
///
outerCustomLabelPosition-ej.datavisualization.LinearGauge.OuterCustomLabelPosition|string default-bottom
///
///Specifies the pointerGradient1 for Linear gauge.
///
pointerGradient1-any default-null
///
///Specifies the pointerGradient2 for Linear gauge.
///
pointerGradient2-any default-null
///
///Specifies the read only state.
///
readOnly-boolean default-true
///
///Specifies the scales
///
scales-Array<Scales> default-null
///
///Specifies the backgroundColor of the Scale.
///
backgroundColor-string default-null
///
///Specifies the scaleBar Gradient of bar pointer
///
barPointers-Array<any> default-Array
///
///Specifies the backgroundColor of bar pointer
///
backgroundColor-string default-null
///
///Specifies the border of bar pointer
///
border-any default-null
///
///Specifies the border Color of bar pointer
///
color-string default-null
///
///Specifies the border Width of bar pointer
///
width-number default-1.5
///
///Specifies the distanceFromScale of bar pointer
///
distanceFromScale-number default-0
///
///Specifies the scaleBar Gradient of bar pointer
///
gradients-any default-null
///
///Specifies the opacity of bar pointer
///
opacity-number default-1
///
///Specifies the value of bar pointer
///
value-number default-null
///
///Specifies the pointer Width of bar pointer
///
width-number default-width=30
///
///Specifies the border of the Scale.
///
border-any default-null
///
///Specifies the border color of the Scale.
///
color-string default-null
///
///Specifies the border width of the Scale.
///
width-number default-1.5
///
///Specifies the customLabel
///
customLabels-Array<any> default-Array
///
///Specifies the label Color in customLabels
///
color-number default-null
///
///Specifies the font in customLabels
///
font-any default-null
///
///Specifies the fontFamily in customLabels
///
fontFamily-string default-Arial
///
///Specifies the fontStyle in customLabels. See
///
fontStyle-ej.datavisualization.LinearGauge.FontStyle|string default-Bold
///
///Specifies the font size in customLabels
///
size-string default-11px
///
///Specifies the opacity in customLabels
///
opacity-string default-0
///
///Specifies the position in customLabels
///
position-any default-null
///
///Specifies the position x in customLabels
///
x-number default-0
///
///Specifies the y in customLabels
///
y-number default-0
///
///Specifies the positionType in customLabels.See CustomLabelPositionType
///
positionType-any default-null
///
///Specifies the textAngle in customLabels
///
textAngle-number default-0
///
///Specifies the label Value in customLabels
///
value-string default-
///
///Specifies the scale Direction of the Scale. See
///
direction-ej.datavisualization.LinearGauge.Direction|string default-CounterClockwise
///
///Specifies the indicator
///
indicators-Array<any> default-Array
///
///Specifies the backgroundColor in bar indicators
///
backgroundColor-string default-null
///
///Specifies the border in bar indicators
///
border-number default-null
///
///Specifies the border Color in bar indicators
///
color-string default-null
///
///Specifies the border Width in bar indicators
///
width-number default-1.5
///
///Specifies the font of bar indicators
///
font-any default-null
///
///Specifies the fontFamily of font in bar indicators
///
fontFamily-string default-Arial
///
///Specifies the fontStyle of font in bar indicators. See FontStyle
///
fontStyle-ej.datavisualization.LinearGauge.FontStyle|string default-ej.datavisualization.LinearGauge.FontStyle.Bold
///
///Specifies the size of font in bar indicators
///
size-string default-11px
///
///Specifies the indicator Height of bar indicators
///
height-number default-30
///
///Specifies the opacity in bar indicators
///
opacity-number default-null
///
///Specifies the position in bar indicators
///
position-any default-null
///
///Specifies the x position in bar indicators
///
x-number default-0
///
///Specifies the y position in bar indicators
///
y-number default-0
///
///Specifies the state ranges in bar indicators
///
stateRanges-Array<any> default-Array
///
///Specifies the backgroundColor in bar indicators state ranges
///
backgroundColor-string default-null
///
///Specifies the borderColor in bar indicators state ranges
///
borderColor-string default-null
///
///Specifies the endValue in bar indicators state ranges
///
endValue-number default-60
///
///Specifies the startValue in bar indicators state ranges
///
startValue-number default-50
///
///Specifies the text in bar indicators state ranges
///
text-string default-
///
///Specifies the textColor in bar indicators state ranges
///
textColor-string default-null
///
///Specifies the textLocation in bar indicators
///
textLocation-any default-null
///
///Specifies the textLocation position in bar indicators
///
x-number default-0
///
///Specifies the Y position in bar indicators
///
y-number default-0
///
///Specifies the indicator Style of font in bar indicators
///
type-ej.datavisualization.LinearGauge.IndicatorTypes|string default-ej.datavisualization.LinearGauge.IndicatorType.Rectangle
///
///Specifies the indicator Width in bar indicators
///
width-number default-30
///
///Specifies the labels.
///
labels-Array<any> default-Array
///
///Specifies the angle of labels.
///
angle-number default-0
///
///Specifies the DistanceFromScale of labels.
///
distanceFromScale-any default-null
///
///Specifies the xDistanceFromScale of labels.
///
x-number default--10
///
///Specifies the yDistanceFromScale of labels.
///
y-number default-0
///
///Specifies the font of labels.
///
font-any default-null
///
///Specifies the fontFamily of font.
///
fontFamily-string default-Arial
///
///Specifies the fontStyle of font.See FontStyle
///
fontStyle-ej.datavisualization.LinearGauge.FontStyle|string default-ej.datavisualization.LinearGauge.FontStyle.Bold
///
///Specifies the size of font.
///
size-string default-11px
///
///need to includeFirstValue.
///
includeFirstValue-boolean default-true
///
///Specifies the opacity of label.
///
opacity-number default-0
///
///Specifies the label Placement of label. See
///
placement-ej.datavisualization.LinearGauge.PointerPlacement|string default-Near
///
///Specifies the textColor of font.
///
textColor-string default-null
///
///Specifies the label Style of label. See
///
type-ej.datavisualization.LinearGauge.ScaleType|string default-ej.datavisualization.LinearGauge.LabelType.Major
///
///Specifies the unitText of label.
///
unitText-string default-
///
///Specifies the unitText Position of label.See
///
unitTextPlacement-ej.datavisualization.LinearGauge.UnitTextPlacement|string default-Back
///
///Specifies the scaleBar Length.
///
length-number default-290
///
///Specifies the majorIntervalValue of the Scale.
///
majorIntervalValue-number default-10
///
///Specifies the markerPointers
///
markerPointers-Array<any> default-Array
///
///Specifies the backgroundColor of marker pointer
///
backgroundColor-string default-null
///
///Specifies the border of marker pointer
///
border-any default-null
///
///Specifies the border color of marker pointer
///
color-string default-null
///
///Specifies the border of marker pointer
///
width-number default-number
///
///Specifies the distanceFromScale of marker pointer
///
distanceFromScale-number default-0
///
///Specifies the pointer Gradient of marker pointer
///
gradients-any default-null
///
///Specifies the pointer Length of marker pointer
///
length-number default-30
///
///Specifies the opacity of marker pointer
///
opacity-number default-1
///
///Specifies the pointer Placement of marker pointer See PointerPlacement
///
placement-ej.datavisualization.LinearGauge.PointerPlacement|string default-Far
///
///Specifies the marker Style of marker pointerSee
///
type-ej.datavisualization.LinearGauge.MarkerType|string default-Triangle
///
///Specifies the value of marker pointer
///
value-number default-null
///
///Specifies the pointer Width of marker pointer
///
width-number default-30
///
///Specifies the maximum of the Scale.
///
maximum-number default-null
///
///Specifies the minimum of the Scale.
///
minimum-number default-null
///
///Specifies the minorIntervalValue of the Scale.
///
minorIntervalValue-number default-2
///
///Specifies the opacity of the Scale.
///
opacity-number default-NaN
///
///Specifies the position
///
position-any default-null
///
///Specifies the Horizontal position
///
x-number default-50
///
///Specifies the vertical position
///
y-number default-50
///
///Specifies the ranges in the tick.
///
ranges-Array<any> default-Array
///
///Specifies the backgroundColor in the ranges.
///
backgroundColor-string default-null
///
///Specifies the border in the ranges.
///
border-any default-null
///
///Specifies the border color in the ranges.
///
color-string default-null
///
///Specifies the border width in the ranges.
///
width-number default-1.5
///
///Specifies the distanceFromScale in the ranges.
///
distanceFromScale-number default-0
///
///Specifies the endValue in the ranges.
///
endValue-number default-60
///
///Specifies the endWidth in the ranges.
///
endWidth-number default-10
///
///Specifies the range Gradient in the ranges.
///
gradients-any default-null
///
///Specifies the opacity in the ranges.
///
opacity-number default-null
///
///Specifies the range Position in the ranges. See RangePlacement
///
placement-ej.datavisualization.LinearGauge.PointerPlacement|string default-Center
///
///Specifies the startValue in the ranges.
///
startValue-number default-20
///
///Specifies the startWidth in the ranges.
///
startWidth-number default-10
///
///Specifies the shadowOffset.
///
shadowOffset-number default-0
///
///Specifies the showBarPointers state.
///
showBarPointers-boolean default-true
///
///Specifies the showCustomLabels state.
///
showCustomLabels-boolean default-false
///
///Specifies the showIndicators state.
///
showIndicators-boolean default-false
///
///Specifies the showLabels state.
///
showLabels-boolean default-true
///
///Specifies the showMarkerPointers state.
///
showMarkerPointers-boolean default-true
///
///Specifies the showRanges state.
///
showRanges-boolean default-false
///
///Specifies the showTicks state.
///
showTicks-boolean default-true
///
///Specifies the ticks in the scale.
///
ticks-Array<any> default-Array
///
///Specifies the angle in the tick.
///
angle-number default-0
///
///Specifies the tick Color in the tick.
///
color-string default-null
///
///Specifies the DistanceFromScale in the tick.
///
distanceFromScale-any default-null
///
///Specifies the xDistanceFromScale in the tick.
///
x-number default-0
///
///Specifies the yDistanceFromScale in the tick.
///
y-number default-0
///
///Specifies the tick Height in the tick.
///
height-number default-10
///
///Specifies the opacity in the tick.
///
opacity-number default-0
///
///Specifies the tick Placement in the tick. See TickPlacement
///
placement-ej.datavisualization.LinearGauge.PointerPlacement|string default-Near
///
///Specifies the tick Style in the tick. See
///
type-ej.datavisualization.LinearGauge.TicksType|string default-MajorInterval
///
///Specifies the tick Width in the tick.
///
width-number default-3
///
///Specifies the scaleBar type .See
///
type-ej.datavisualization.LinearGauge.ScaleType|string default-Rectangle
///
///Specifies the scaleBar width.
///
width-number default-30
///
///Specifies the theme for Linear gauge. See LinearGauge.Themes
///
theme-ej.datavisualization.LinearGauge.Themes|string default-flatlight
///
///Specifies the tick Color for Linear gauge.
///
tickColor-string default-null
///
///Specify tooltip options of linear gauge
///
tooltip-Tooltip default-false
///
///Specify showCustomLabelTooltip value of linear gauge
///
showCustomLabelTooltip-boolean default-false
///
///Specify showLabelTooltip value of linear gauge
///
showLabelTooltip-boolean default-false
///
///Specify templateID value of linear gauge
///
templateID-string default-false
///
///Specifies the value of the Gauge.
///
value-number default-0
///
///Specifies the width of Linear gauge.
///
width-number default-150
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
ListBox:function(){
///
/// Constructor of ej.ListBox
///
}
});
ej.ListBox=(function(){
var original=ej.ListBox
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
addItem:function(listItem, index){
///
///
/// Adds a given list items in the ListBox widget at a specified index. It accepts two parameters.
///
/// This can be a list item object (for JSON binding) or a string (for UL and LI rendering). Also we can the specify this as an array of list item object or an array of strings to add multiple items.
///
///
///
/// Adds a given list items in the ListBox widget at a specified index. It accepts two parameters.
///
/// The index value to add the given items at the specified index. If index is not specified, the given items will be added at the end of the list.
///
},
checkAll:function(){
///
///
/// Checks all the list items in the ListBox widget. It is dependent on showCheckbox property.
///
},
checkItemByIndex:function(index){
///
///
/// Checks a list item by using its index. It is dependent on showCheckbox property.
///
/// Index of the listbox item to be checked. If index is not specified, the given items will be added at the end of the list.
///
},
checkItemsByIndices:function(indices){
///
///
/// Checks multiple list items by using its index values. It is dependent on showCheckbox property.
///
/// Index/Indices of the listbox items to be checked. If index is not specified, the given items will be added at the end of the list.
///
},
disable:function(){
///
///
/// Disables the ListBox widget.
///
},
disableItem:function(text){
///
///
/// Disables a list item by passing the item text as parameter.
///
/// Text of the listbox item to be disabled.
///
},
disableItemByIndex:function(index){
///
///
/// Disables a list Item using its index value.
///
/// Index of the listbox item to be disabled.
///
},
disableItemsByIndices:function(Indices){
///
///
/// Disables set of list Items using its index values.
///
/// Indices of the listbox items to be disabled.
///
},
enable:function(){
///
///
/// Enables the ListBox widget when it is disabled.
///
},
enableItem:function(text){
///
///
/// Enables a list Item using its item text value.
///
/// Text of the listbox item to be enabled.
///
},
enableItemByIndex:function(index){
///
///
/// Enables a list item using its index value.
///
/// Index of the listbox item to be enabled.
///
},
enableItemsByIndices:function(indices){
///
///
/// Enables a set of list Items using its index values.
///
/// Indices of the listbox items to be enabled.
///
},
getCheckedItems:function(){
///
///
/// Returns the list of checked items in the ListBox widget. It is dependent on showCheckbox property.
///
},
getSelectedItems:function(){
///
///
/// Returns the list of selected items in the ListBox widget.
///
},
getIndexByText:function(text){
///
///
/// Returns an item’s index based on the given text.
///
/// The list item text (label)
///
},
getIndexByValue:function(indices){
///
///
/// Returns an item’s index based on the value given.
///
/// The list item’s value
///
},
getTextByIndex:function(){
///
///
/// Returns an item’s text (label) based on the index given.
///
},
getItemByIndex:function(){
///
///
/// Returns a list item’s object using its index.
///
},
getItemByText:function(text){
///
///
/// Returns a list item’s object based on the text given.
///
/// The list item text.
///
},
mergeData:function(data){
///
///
/// Merges the given data with the existing data items in the listbox.
///
/// Data to merge in listbox.
///
},
moveDown:function(){
///
///
/// Selects the next item based on the current selection.
///
},
moveUp:function(){
///
///
/// Selects the previous item based on the current selection.
///
},
refresh:function(refreshData){
///
///
/// Refreshes the ListBox widget.
///
/// Refreshes both the datasource and the dimensions of the ListBox widget when the parameter is passed as true, otherwise only the ListBox dimensions will be refreshed.
///
},
removeAll:function(){
///
///
/// Removes all the list items from listbox.
///
},
removeSelectedItems:function(){
///
///
/// Removes the selected list items from the listbox.
///
},
removeItemByText:function(text){
///
///
/// Removes a list item by using its text.
///
/// Text of the listbox item to be removed.
///
},
removeItemByIndex:function(index){
///
///
/// Removes a list item by using its index value.
///
/// Index of the listbox item to be removed.
///
},
selectAll:function(){
///
///
///
///
},
selectItemByText:function(text){
///
///
/// Selects the list item using its text value.
///
/// Text of the listbox item to be selected.
///
},
selectItemByValue:function(value){
///
///
/// Selects list item using its value property.
///
/// Value of the listbox item to be selected.
///
},
selectItemByIndex:function(index){
///
///
/// Selects list item using its index value.
///
/// Index of the listbox item to be selected.
///
},
selectItemsByIndices:function(Indices){
///
///
/// Selects a set of list items through its index values.
///
/// Index/Indices of the listbox item to be selected.
///
},
uncheckAll:function(){
///
///
/// Unchecks all the checked list items in the ListBox widget. To use this method showCheckbox property to be set as true.
///
},
uncheckItemByIndex:function(index){
///
///
/// Unchecks a checked list item using its index value. To use this method showCheckbox property to be set as true.
///
/// Index of the listbox item to be unchecked.
///
},
uncheckItemsByIndices:function(indices){
///
///
/// Unchecks the set of checked list items using its index values. To use this method showCheckbox property must be set to true.
///
/// Indices of the listbox item to be unchecked.
///
},
unselectAll:function(){
///
///
///
///
},
unselectItemByIndex:function(index){
///
///
/// Unselects a selected list item using its index value
///
/// Index of the listbox item to be unselected.
///
},
unselectItemByText:function(text){
///
///
/// Unselects a selected list item using its text value.
///
/// Text of the listbox item to be unselected.
///
},
unselectItemByValue:function(value){
///
///
/// Unselects a selected list item using its value.
///
/// Value of the listbox item to be unselected.
///
},
unselectItemsByIndices:function(indices){
///
///
/// Unselects a set of list items using its index values.
///
/// Indices of the listbox item to be unselected.
///
},
hideCheckedItems:function(){
///
///
/// Hides all the checked items in the listbox.
///
},
showItemByIndices:function(indices){
///
///
/// Shows a set of hidden list Items using its index values.
///
/// Indices of the listbox items to be shown.
///
},
hideItemsByIndices:function(indices){
///
///
/// Hides a set of list Items using its index values.
///
/// Indices of the listbox items to be hidden.
///
},
showItemsByValues:function(values){
///
///
/// Shows the hidden list items using its values.
///
/// Values of the listbox items to be shown.
///
},
hideItemsByValues:function(values){
///
///
/// Hides the list item using its values.
///
/// Values of the listbox items to be hidden.
///
},
showItemByValue:function(value){
///
///
/// Shows a hidden list item using its value.
///
/// Value of the listbox item to be shown.
///
},
hideItemByValue:function(value){
///
///
/// Hide a list item using its value.
///
/// Value of the listbox item to be hidden.
///
},
showItemByIndex:function(index){
///
///
/// Shows a hidden list item using its index value.
///
/// Index of the listbox item to be shown.
///
},
hideItemByIndex:function(index){
///
///
/// Hides a list item using its index value.
///
/// Index of the listbox item to be hidden.
///
},
show:function(){
///
///
///
///
},
hide:function(){
///
///
/// Hides the listbox.
///
},
hideAllItems:function(){
///
///
/// Hides all the listbox items in the listbox.
///
},
showAllItems:function(){
///
///
/// Shows all the listbox items in the listbox.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejListBox=function(){
this.data("ejListBox",new ej.ListBox());
return this;
};
intellisense.annotate(jQuery.fn,{
ejListBox :function (options) {
///
///
///The ListBox control provides a list of options for users to select from. It is capable of including other HTML elements such as images, textboxes, check box, and radio buttons and so on. It also supports data binding, template options, multi-select options, etc.
///Enables/disables the dragging behavior of the items in ListBox widget.
///
allowDrag-boolean default-false
///
///Accepts the items which are dropped in to it, when it is set to true.
///
allowDrop-boolean default-false
///
///Enables or disables multiple selection.
///
allowMultiSelection-boolean default-false
///
///Loads the list data on demand via scrolling behavior to improve the application’s performance. There are two ways to load data which can be defined using “virtualScrollMode†property.
///
allowVirtualScrolling-boolean default-false
///
///Enables or disables the case sensitive search for list item by typing the text (search) value.
///
caseSensitiveSearch-boolean default-false
///
///Dynamically populate data of a list box while selecting an item in another list box i.e. rendering child list box based on the item selection in parent list box. This property accepts the id of the child ListBox widget to populate the data.
///
cascadeTo-string default-null
///
///Set of list items to be checked by default using its index. It works only when the showCheckbox property is set to true.
///
checkedIndices-Array<any> default-null
///
///The root class for the ListBox widget to customize the existing theme.
///
cssClass-string default-“â€
///
///Contains the list of data for generating the list items.
///
dataSource-any default-null
///
///Enables or disables the ListBox widget.
///
enabled-boolean default-true
///
///Enables or disables the search behavior to find the specific list item by typing the text value.
///
enableIncrementalSearch-boolean default-false
///
///Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true.
///
enablePersistence-boolean default-false
///
///Displays the ListBox widget’s content from right to left when enabled.
///
enableRTL-boolean default-false
///
///Specifies ellipsis ("...") representation in an overflowed list item content when it is set to false.
///
enableWordWrap-boolean default-true
///
///Mapping fields for the data items of the ListBox widget.
///
fields-Fields default-null
///
///Defines the specific field name which contains Boolean values to specify whether the list items to be checked by default or not.
///
checkBy-boolean default-
///
///The grouping in the ListBox widget can be defined using this field.
///
groupBy-string default-
///
///Defines the HTML attributes such as id, class, styles for the specific ListBox item.
///
htmlAttributes-any default-
///
///Defines the specific field name which contains id values for the list items.
///
id-string default-
///
///Defines the imageURL for the image to be displayed in the ListBox item.
///
imageUrl-string default-
///
///Defines the image attributes such as height, width, styles and so on.
///
imageAttributes-string default-
///
///Defines the specific field name which contains Boolean values to specify whether the list items to be selected by default or not.
///
selectBy-boolean default-
///
///Defines the sprite CSS class for the image to be displayed.
///
spriteCssClass-string default-
///
///Defines the table name to get the specific set of list items to be loaded in the ListBox widget while rendering with remote data.
///
tableName-string default-
///
///Defines the specific field name in the data source to load the list with data.
///
text-string default-
///
///Defines the specific field name in the data source to load the list with data value property.
///
value-string default-
///
///Defines the height of the ListBox widget.
///
height-string default-null
///
///Defines the height for individual ListBox item.
///
itemHeight-string default-null
///
///The number of list items to be shown in the ListBox widget. The remaining list items will be scrollable.
///
itemsCount-number default-null
///
///The total number of list items to be rendered in the ListBox widget.
///
totalItemsCount-number default-null
///
///The number of list items to be loaded in the list box while enabling virtual scrolling and when virtualScrollMode is set to continuous.
///
itemRequestCount-number default-5
///
///Loads data for the listbox by default (i.e. on initialization) when it is set to true. It creates empty ListBox if it is set to false.
///
loadDataOnInit-boolean default-true
///
///The query to retrieve required data from the data source.
///
query-ej.Query default-ej.Query()
///
///The list item to be selected by default using its index.
///
selectedIndex-number default-null
///
///The list items to be selected by default using its indices. To use this property allowMultiSelection should be enabled.
///
selectedIndices-Array<any> default-[]
///
///Enables/Disables the multi selection option with the help of checkbox control.
///
showCheckbox-boolean default-false
///
///To display the ListBox container with rounded corners.
///
showRoundedCorner-boolean default-false
///
///Set to sort ListBox items either by Ascending or Descending order. By default sortOrder is set as enum type of "None".You can use only below mentioned type for sorting purpose.
///
sortOrder-ej.ListBox.SortOrder|string default-ej.SortOrder.None
///
///The template to display the ListBox widget with customized appearance.
///
template-string default-null
///
///Holds the selected items values and used to bind value to the list item using AngularJS and KnockoutJS.
///
value-number default-“â€
///
///Specifies the virtual scroll mode to load the list data on demand via scrolling behavior. There are two types of mode.
///
virtualScrollMode-ej.VirtualScrollMode|string default-ej.VirtualScrollMode.Normal
///
///Defines the width of the ListBox widget.
///
width-string default-null
///
///Specifies the targetID for the listbox items.
///
targetID-string default-null
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
ListView:function(){
///
/// Constructor of ej.ListView
///
}
});
ej.ListView=(function(){
var original=ej.ListView
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
addItem:function(item, index, groupid){
///
///
/// To add item in the given index. If you have enabled grouping in ListView then you need to pass the corresponding group list title to add item in it. Depending on the data bound to ListView, we need to pass either an HTML element or JSON objects in this method.
///
/// To pass the list item as element/ JSON object
///
///
///
/// To add item in the given index. If you have enabled grouping in ListView then you need to pass the corresponding group list title to add item in it. Depending on the data bound to ListView, we need to pass either an HTML element or JSON objects in this method.
///
/// Specifies the index where item to be added
///
///
///
/// To add item in the given index. If you have enabled grouping in ListView then you need to pass the corresponding group list title to add item in it. Depending on the data bound to ListView, we need to pass either an HTML element or JSON objects in this method.
///
/// optionalThis is an optional parameter. You must pass the group list title here if grouping is enabled in the ListView
///
},
checkAllItem:function(){
///
///
/// To check all the items.
///
},
checkItem:function(index){
///
///
/// To check item in the given index.
///
/// Specifies the index of the item to be checked
///
},
clear:function(){
///
///
/// To clear all the list item in the control before updating with new datasource.
///
},
deActive:function(index){
///
///
/// To make the item in the given index to be default state.
///
/// Specifies the index to make the item to be in default state.
///
},
disableItem:function(index){
///
///
/// To disable item in the given index.
///
/// Specifies the index value to be disabled.
///
},
enableItem:function(index){
///
///
/// To enable item in the given index.
///
/// Specifies the index value to be enabled.
///
},
getActiveItem:function(){
///
///
/// To get the active item.
///
},
getActiveItemText:function(){
///
///
/// To get the text of the active item.
///
},
getCheckedItems:function(){
///
///
/// To get all the checked items.
///
},
getCheckedItemsText:function(){
///
///
/// To get the text of all the checked items.
///
},
getItemsCount:function(){
///
///
/// To get the total item count.
///
},
getItemText:function(index){
///
///
/// To get the text of the item in the given index.
///
/// Specifies the index value to get the text value.
///
},
hasChild:function(index){
///
///
/// To check whether the item in the given index has child item.
///
/// Specifies the index value to check the item has child or not.
///
},
hide:function(){
///
///
/// To hide the list.
///
},
hideItem:function(index){
///
///
/// To hide item in the given index.
///
/// Specifies the index value to hide the item.
///
},
isChecked:function(){
///
///
/// To check whether item in the given index is checked.
///
},
loadAjaxContent:function(item){
///
///
/// To load the AJAX content while selecting the item.
///
/// Specifies the item to load the AJAX content.
///
},
removeCheckMark:function(index){
///
///
/// To remove the check mark either for specific item in the given index or for all items.
///
/// Specifies the index value to remove the checkbox.
///
},
removeItem:function(index){
///
///
/// To remove item in the given index.
///
/// Specifies the index value to remove the item.
///
},
selectItem:function(index){
///
///
/// To select item in the given index.
///
/// Specifies the index value to select the item.
///
},
setActive:function(index){
///
///
/// To make the item in the given index to be active state.
///
/// Specifies the index value to make the item in active state.
///
},
show:function(){
///
///
/// To show the list.
///
},
showItem:function(index){
///
///
/// To show item in the given index.
///
/// Specifies the index value to show the hidden item.
///
},
unCheckAllItem:function(){
///
///
/// To uncheck all the items.
///
},
unCheckItem:function(index){
///
///
/// To uncheck item in the given index.
///
/// Specifies the index value to uncheck the item.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejListView=function(){
this.data("ejListView",new ej.ListView());
return this;
};
intellisense.annotate(jQuery.fn,{
ejListView :function (options) {
///
///
///The ListView widget builds interactive ListView interface. This control allows you to select an item from a list-like interface and display a set of data items in different layouts or views. Lists are used for displaying data, data navigation, result lists, and data entry.
///Specifies the ajaxSettings option to load the items to the ListView control.
///
ajaxSettings-AjaxSettings default-null
///
///It specifies, whether to enable or disable asynchronous request.
///
async-boolean default-
///
///It specifies the page will be cached in the web browser.
///
cache-boolean default-
///
///It specifies the type of data is send in the query string.
///
contentType-string default-
///
///It specifies the data as an object, will be passed in the query string.
///
data-any default-
///
///It specifies the type of data that you're expecting back from the response.
///
dataType-string default-
///
///It specifies the HTTP request type.
///
type-string default-
///
///Set the index values to be selected on initial loading. This works only when enableCheckMark is set true.
///
checkedIndices-Array<any> default-[]
///
///Sets the root class for ListView theme. This cssClass API helps to use custom skinning option for ListView control. By defining the root class using this API, we need to include this root class in CSS.
///
cssClass-string default-
///
///Contains the list of data for generating the ListView items.
///
dataSource-Array<any> default-[]
///
///Specifies whether to load AJAX content while selecting item.
///
enableAjax-boolean default-false
///
///Specifies whether to enable caching the content.
///
enableCache-boolean default-false
///
///Specifies whether to enable check mark for the item.
///
enableCheckMark-boolean default-false
///
///Specifies whether to enable the filtering feature to filter the item.
///
enableFiltering-boolean default-false
///
///Specifies whether to group the list item.
///
enableGroupList-boolean default-false
///
///Specifies to maintain the current model value to browser cookies for state maintenance. While refresh the page, the model value will get apply to the control from browser cookies.
///
enablePersistence-boolean default-false
///
///Specifies the field settings to map the datasource.
///
fieldSettings-FieldSettings default-
///
///Defines the specific field name which contains Boolean values to specify whether the list items to be checked by default or not.
///
checked-boolean default-
///
///Defines the URL to be navigated while clicking the list item.
///
navigateUrl-string default-
///
///Defines the HTML attributes such as id, class, styles for the specific list item.
///
attributes-any default-
///
///Defines the specific field name which contains id values for the list items.
///
id-string default-
///
///Defines the URL for the image to be displayed in the list item.
///
imageUrl-string default-
///
///Defines the class name for image in that specific list items.
///
imageClass-string default-
///
///Specifies whether to prevent the selection of the list item.
///
preventSelection-boolean default-
///
///Specifies whether to retain the selection of the list item.
///
persistSelection-boolean default-
///
///To define the first level of list items.
///
primaryKey-string default-
///
///To define the child level of list items inside the parent items.
///
parentPrimaryKey-string default-
///
///Defines the specific field name in the data source to load the list with data.
///
text-string default-
///
///To trigger the mouseup event for specific list items.
///
mouseUP-string default-
///
///To trigger the mousedown event for specific list items.
///
mouseDown-string default-
///
///Contains the array of items to be added in ListView.
///
items-Array<any> default-[]
///
///Specifies the text of the back button in the header.
///
headerBackButtonText-string default-null
///
///Specifies the title of the header.
///
headerTitle-string default-Title
///
///Specifies the height.
///
height-string|number default-null
///
///Set the localization culture for ListView Widget.
///
locale-string default-
///
///Specifies whether to retain the selection of the item.
///
persistSelection-boolean default-false
///
///Specifies whether to prevent the selection of the item.
///
preventSelection-boolean default-false
///
///Specifies the query to execute with the datasource.
///
query-any default-null
///
///Specifies whether need to render the control with the template contents.
///
renderTemplate-boolean default-false
///
///Specifies the index of item which need to be in selected state initially while loading.
///
selectedItemIndex-number default-0
///
///Specifies whether to show the header.
///
showHeader-boolean default-true
///
///Specifies whether to show the back button header.
///
showHeaderBackButton-boolean default-false
///
///Specifies ID of the element contains template contents.
///
templateId-string default-null
///
///Specifies the width.
///
width-string|number default-null
///
///Specifies the number of items to be fetched on each scroll. Note: This property works only with Virtual scrolling.
///
itemRequestCount-number default-5
///
///Specifies the maximum number of items to be fetched. Note: This will work only with Virtual scrolling
///
totalItemsCount-number default-5
///
///Loads the list data on demand via scrolling behavior to improve the application’s performance. There are two ways to load data which can be defined using virtualScrollMode property.
///
allowVirtualScrolling-boolean default-false
///
///Specifies the virtual scroll mode to load the list data on demand via scrolling behavior. There are two types of mode.
///
virtualScrollMode-ej.VirtualScrollMode|string default-ej.VirtualScrollMode.Normal
///
///
///The widget configuration options
///
///
}
});
intellisense.annotate(ej,{
Map:function(){
///
/// Constructor of ej.Map
///
}
});
ej.Map=(function(){
var original=ej.Map
var wrapper=function(){
var instance = new original();
intellisense.annotate(instance, {
navigateTo:function(latitude, longitude, level){
///
///
/// Method for navigating to specific shape based on latitude, longitude and zoom level.
///
/// Pass the latitude value for map
///
///
///
/// Method for navigating to specific shape based on latitude, longitude and zoom level.
///
/// Pass the longitude value for map
///
///
///
/// Method for navigating to specific shape based on latitude, longitude and zoom level.
///
/// Pass the zoom level for map
///
},
pan:function(direction){
///
///
/// Method to perform map panning
///
/// Pass the direction in which map should be panned
///
},
refresh:function(){
///
///
/// Method to reload the map.
///
},
refreshLayers:function(){
///
///
/// Method to reload the shapeLayers with updated values
///
},
refreshNavigationControl:function(navigation){
///
///
/// Method to reload the navigation control with updated values.
///
/// Pass the navigation control instance
///
},
zoom:function(level, isAnimate){
///
///
/// Method to perform map zooming.
///
/// Pass the zoom level for map to be zoomed
///
///
///
/// Method to perform map zooming.
///
/// Pass the boolean value to enable or disable animation while zooming
///
},
refreshLayer:function(){
///
///
/// Method to reload the specified layer based on layer and sublayer index value.
///
},
addMarkers:function(){
///
///
/// Add markers dynamically based on layer and sublayer index value.
///
},
});
return instance;
};
intellisense.redirectDefinition(wrapper, original);
return wrapper;
})();
jQuery.fn.ejMap=function(){
this.data("ejMap",new ej.Map());
return this;
};
intellisense.annotate(jQuery.fn,{
ejMap :function (options) {
///
///