/* @license Copyright (C) Exontrol. All rights reserved. */ /////////////////////////////////////////////////////////// (exontrol.Pivot) // // The exontrol.Pivot class provides the following fields (public): // // Listeners {object}, holds a reference to exontrol.Lts which defines the events of the control. // Shortcuts {object}, holds a reference to exontrol.Sts which defines the shortcuts of the control. // Aggregates {object}, defines the aggregate-callbacks/functions the control supports (sum, count, ... ) // // The exontrol.Pivot class provides the following methods (public): // // BeginUpdate(), suspends the control's render until the EndUpdate() method is called. It maintains performance, while multiple changes occurs within the control. // EndUpdate(), resumes the control's render, after it is suspended by the BeginUpdate() method // Refresh(), refreshes the control // Clear(), clears the control's data (columns, items and filter) // ChooseFile(error), clears the control's data and adds an input-file element to let user choose a local file (CSV format) to import data from // Update(callback, thisArg), locks the control's update during the callback, and invalidates the control once the method ends. // Smooth(callback, thisArg), performs a smooth-transition from a layout to another. The smooth-transition goes from the current layout to the new layout generated by the callback. // Home(), zooms to 100% and scrolls the control to origin (0,0) // Soom(zoomTo, oPointAbs), zooms or/and scrolls the control's content. // FitToClient(rtLayout), ensures that the entire (null/undefined) or giving layout fits the control's client area // EnsureVisibleClient(clientA[, ensureOpts]), ensures that the giving client fits the control's client area. // Selection/GetSelection()/SetSelection(value), gets or sets the control's selected-items. // SelectAll, selects all items within the control. // UnselectAll, clears the selection. // RemoveSelection(), deletes the selected-items. // EnsureVisibleSelection(), scrolls the control's content to ensure that the control's selection fits the control's client area // AddTreeView(name,attributes), creates a new view to display the columns/items // RemoveTreeView(name), removes the view already created by the AddTreeView() method // Items/GetItems() {exontrol.Tree.Items}, returns the control's items. // Columns/GetColumns() {exontrol.Tree.Columns}, returns the control's columns // ConditionalFormats/GetConditionalFormats() {exontrol.Tree.ConditionalFormats}, returns the control's conditional formats // Item(item) {exontrol.Tree.Item}, returns the item based on its index or identifier. // Cell(item,column) {exontrol.Tree.Cell}, returns the cell based on the item and column. // Column(id) {exontrol.Tree.Column}, returns the column based on its index or identifier. // ConditionalFormat(id) {exontrol.Tree.ConditionalFormat}, returns a conditional format based on its key // Scroll(key), scrolls the view based on the giving key // ExpandAll(), expands all items // CollapseAll(), collapses all items // ClearFilter(), clears the control's filter (if any) // ApplyFilter(), applies the control's filter (if any) // Layout/GetLayout()/SetLayout(value) {string}, saves or loads the control's UI layout, such as positions of the columns, scroll position, filtering values // Statistics/GetStatistics() {string}, gives statistics data of objects being hold by the control // Import(source, importOpts), imports data from CSV, XML format // LoadXML(source), loads an XML document (previously saved by an exontrol component) // // FormatAppearances/GetFormatAppearances() {exontrol.Pivot.FormatAppearances}, returns the control's format-appearances that defines the visual-appearance to apply on pivot-columns // FormatConditionalAppearances/GetFormatConditionalAppearances() {exontrol.Pivot.FormatConditionalAppearances}, returns the control's format conditional-appearances that defines the visual-appearance to apply on pivot-columns, based on conditions // FormatContents/GetFormatContents() {exontrol.Pivot.FormatContents}, returns the control's format-contents that specifies how a column or row can be displayed, formatted or converted // // Options/GetOptions()/SetOptions(value) {object}, specifies the options of the exontrol.Pivot control // Tfi/GetTfi()/SetTfi(value), specifies an object of {bold,italic,...}/exontrol.TFI type that defines font attributes to display the captions within the control. // Locked/GetLocked()/SetLocked(value) {boolean}, specifies whether the control is locked(protected) or unlocked // ReadOnly/GetReadOnly()/SetReadOnly(value) {boolean}, specifies whether the control is read-only // WheelChange/GetWheelChange()/SetWheelChange(value) {number}, defines the amount the control scrolls when the user rolls the mouse wheel. // GetSmooth()/SetSmooth(value), defines the time in ms the control goes from one layout to another. // Margins/GetMargins()/SetMargins(value), specifies the control's margins // Zoom/GetZoom()/SetZoom(value), defines the zoom factor of the control's content. // ZoomLevels/GetZoomLevels()/SetZoomLevels(value), defines the zoom-levels the user can magnify the control's content // SingleSel/GetSingleSel()/SetSingleSel(value), specifies whether the control supports single, multiple, toggle selection. // Selection/GetSelection()/SetSelection(value), gets or sets the control's selected-items. // FormatText/GetFormatText()/SetFormatText(value) {exontrol.DrawTextFormatEnum}, defines the global format to display the item's caption. // Pad/GetPad()/SetPad(value) {(number|string|array)}, specifies the space between item's content and its borders. // ImageSize/GetImageSize()/SetImageSize(value) {any}, defines the global size of the item's image. The image can be added using the exontrol.HTMLPicture.Add() method // ImageAlign/GetImageAlign()/SetImageAlign(value) {number}, defines the global-alignment of the item's image relative to its caption. // Shapes/GetShapes()/SetShapes(value) {string}, defines the shapes each part of the control can display. The shapes field customizes the control's visual appearance. // Cursors/GetCursors()/SetCursors(value) {string}, defines the mouse cursor to display when pointing over different parts of the control. // AllowActions/GetAllowActions()/SetAllowActions(value) {string}, customizes the actions the user can perform once the control is clicked or touched. // HeaderHeight/GetHeaderHeight()/SetHeaderHeight(value), specifies the height of the control's header // HeaderVisible/GetHeaderVisible()/SetHeaderVisible(value), shows or hides the control's header // CountLockedColumns/GetCountLockedColumns()/SetCountLockedColumns(value), specifies the number of locked columns (a locked column is not scrollable, and it is fixed to the left side of the control) // ColumnAutoResize/GetColumnAutoResize()/SetColumnAutoResize(value), indicates whether the control will automatically size its visible columns to fit on the control's client width // SortBarVisible/GetSortBarVisible()/SetSortBarVisible(value), shows or hides the control's sortbar // SortBarCaption/GetSortBarCaption()/SetSortBarCaption(value), specifies the caption to be shown on the control's sortbar when it is empty. // SingleSort/GetSingleSort()/SetSingleSort(value), indicates whether the control supports single or multiple-columns sort // SortOnClick/GetSortOnClick()/SetSortOnClick(value), specifies whether the column gets sorted once the user clicks its header. // AllowGroupBy/GetAllowGroupBy()/SetAllowGroupBy(value), defines whether the control supports group-by view // ColumnsFloatBarVisible/GetColumnsFloatBarVisible()/SetColumnsFloatBarVisible(value), shows or hides the Columns float-bar, which shows hidden or groupable columns // ColumnsFloatBarSortOrder/GetColumnsFloatBarSortOrder()/SetColumnsFloatBarSortOrder(value), specifies the sort order to show the columns within the control's columns floating panel // ColumnsFloatBarCaption/GetColumnsFloatBarCaption()/SetColumnsFloatBarCaption(value), specifies caption to show within the columns float bar // FilterInclude/GetFilterInclude()/SetFilterInclude(value), specifies the items to include once the control's filter is applied. // FilterBarHeight/GetFilterBarHeight()/SetFilterBarHeight(value), specifies the height of the control's filter-bar // FilterBarVisible/GetFilterBarVisible()/SetFilterBarVisible(value), shows or hides the control's filter-bar // FilterBarCaption/GetFilterBarCaption()/SetFilterBarCaption(value), customizes the caption to display within the control's filter-bar // FilterBarPrompt/GetFilterBarPrompt()/SetFilterBarPrompt(value), specifies the caption to show while the pattern of the filter-prompt is empty // FilterBarPromptPattern/GetFilterBarPromptPattern()/SetFilterBarPromptPattern(value), specifies the pattern of the control's filter-prompt. // FilterBarPromptType/GetFilterBarPromptType()/SetFilterBarPromptType(value), specifies the type of the control's filter-prompt. // FilterBarPromptColumns/GetFilterBarPromptColumns()/SetFilterBarPromptColumns(value), indicates the list of columns the pattern of filter-prompt is applying to. // DrawGridLines/GetDrawGridLines()/SetDrawGridLines(value), shows or hides the control's grid-lines // GridLines/GetGridLines()/SetGridLines(value), customizes the color, width and style of the control's grid-lines. // DefaultItemHeight/GetDefaultItemHeight()/SetDefaultItemHeight(value), defines the item's default-height // TreeColumnIndex/GetTreeColumnIndex()/SetTreeColumnIndex(value), specifies the index or identifier/key/caption of the column that displays the hierarchy // ExpandOnDblClick/GetExpandOnDblClick()/SetExpandOnDblClick(value), specifies whether the item is expanded or collapsed once the user double-clicks the item // ItemAllowSizing/GetItemAllowSizing()/SetItemAllowSizing(value), indicates whether all or none of the items are resizable or fixed // EnsureOnSort/GetEnsureOnSort()/SetEnsureOnSort(value), ensures that the selection fits the view's client-area once the user sorts or groups a column // ShowLockedItems/GetShowLockedItems()/SetShowLockedItems(value), indicates whether the locked/fixed items are visible or hidden // GetLockedItemsCount(alignment)/SetLockedItemsCount(alignment, value), specifies the number of items fixed on the top or bottom side of the control // GetLockedItem(alignment,index), gets a locked item giving its index or identifier/key // AllowDrop/GetAllowDrop()/SetAllowDrop(value), indicates whether the user can drag and drop local files into the control. // OnErrorChooseFile/GetOnErrorChooseFile()/SetOnErrorChooseFile(value), specifies whether the control displays an input-file to let user choose a local filte to import, as soon as an error occurs // ScrollPos/GetScrollPos()/SetScrollPos(value) {object}, scrolls horizontally and/or vertically the control's default view // ToolTipDelay/GetToolTipDelay()/SetToolTipDelay(value) {number}, specifies how long the mouse pointer must point to an object before the tool tip appears // ToolTipPopDelay/GetToolTipPopDelay()/SetToolTipPopDelay(value) {number}, specifies the period in ms of time the tool top remains visible if the mouse pointer is stationary within a control // ToolTipWidth/GetToolTipWidth()/SetToolTipWidth(value) {number}, specifies the width of the control's tooltip // Statistics/GetStatistics() {string}, gives statistics data of objects being hold by the control // // The exontrol.Pivot class provides the following additional methods (public): // // PivotBarVisible/GetPivotBarVisible()/SetPivotBarVisible(value), shows or hides the control's pivot bar (it displays the layout of the pivot-table) // PivotColumnsFloatBarVisible/GetPivotColumnsFloatBarVisible()/SetPivotColumnsFloatBarVisible(value), shows or hides the pivot-columns floatbar (it displays the columns that can used to build the pivot-table) // PivotRows/GetPivotRows()/SetPivotRows(value), specifies the list of group-by columns that determines the rows in the pivot-table // PivotColumns/GetPivotColumns()/SetPivotColumns(value), specifies the list of columns to be displayed in the pivot-table // PivotTotals/GetPivotTotals()/SetPivotTotals(value), indicates the list of totals/subtotals to be shown in the pivot-table // ShowDataOnDblClick/GetShowDataOnDblClick()/SetShowDataOnDblClick(value), shows the original data that generated the result when the user double clicks the item // DisplayPivotFields/GetDisplayPivotFields()/SetDisplayPivotFields(value), specifies the maximum number of columns to be displayed on the control's generated-list. // DisplayPivotRows/GetDisplayPivotRows()/SetDisplayPivotRows(value), specifies the maximum number of rows to be displayed on the control's generated-list. // FormatPivotHeader/GetFormatPivotHeader()/SetFormatPivotHeader(value), specifies the format to display the columns within the pivot bar // // The exontrol.Pivot class provides the following events (through Listeners): // // "onselchange", notifies your application that the control's selection has been changed. The onselchange's parameter could be any of the following: // // oEvent {null}, indicates that the control has no selected items // oEvent {object}, indicates an object of exontrol.Tree.Item type that defines the control's single-item selected. // oEvent {array}, specifies an array of [exontrol.Tree.Item] type that holds all selected items within the control // // "onclick", occurs once the user clicks or double-clicks an item. The onclick's parameter is: // // oEvent {object}, specifies an object of {dblClick,button,modifiers,..} type, that holds information about the object being clicked // // oEvent.cell {object}, specifies undefined or an object of exontrol.Tree.Cell type that indicates the cell being clicked // oEvent.column {object}, specifies undefined or an object of exontrol.Tree.Column type that specifies the column being clicked // oEvent.view {object}, indicates an object of exontrol.Tree.TV, exontrol.Tree.TV.Header, ... type that specifies the view/window where the click occurred // oEvent.dblClick {boolean}, indicates whether the user clicks or double-clicks the item // oEvent.button {number}, indicates which button is pressed while clicking the item as 1 (left), 2 (right) or 4 (middle) // oEvent.modifiers {number}, specifies a combination of 1, 2, 4 and 16 according with modifier keys (ALT, CTRL, META and SHIFT), or 0 if no modifier keys // // "onchange", notifies your application that a cell, item, column, or more has been changed (expanded, checked, ...). The onchange's parameter is: // // oEvent {object}, specifies an object of {object,action} type, that holds information about the control's object being changed. // // oEvent.object {object}, specifies an object of the control being changed. The type of the object depends on the action it occured // oEvent.action {string}, Specifies the name of action such as follow: // // "expand-item" {string}, notifies that an item has been expanded or collapsed (the object refers to an exontrol.Tree.Item type) // "resize-item" {string}, notifies that the item's height has been changed (the object refers to an exontrol.Tree.Item type) // "drag-item" {string}, notifies the user drags the item to a new position (the object refers to an exontrol.Tree.Item type) // "check-cell" {string}, notifies that a cell has been checked or unchecked (the object refers to exontrol.Tree.Cell type) // "change-cell" {string}, occurs once the cell's value has changed (while UI edit) (the object refers to exontrol.Tree.Cell type) // "expand-column" {string}, notifies that a column has been expanded or collapsed (the object refers to an exontrol.Tree.Column type) // "resize-column" {string}, notifies that a column has been resized (the object refers to an exontrol.Tree.Column type) // "show-column" {string}, notifies that a column has shows or hidden (the object refers to an exontrol.Tree.Column type) // "drag-column" {string}, notifies that a column has been moved to a new position (the object refers to an exontrol.Tree.Column type) // "sort-column" {string}, notifies that a column has been sorted (the object refers to an exontrol.Tree.Column type) // // "onscroll", notifies your application once the control's view is scrolled. The onscroll's parameter is: // // oEvent {object}, specifies an object of {view,type,value} type, that holds information about the view's scroll that has been changed as explained: // // oEvent.view {object}, specifies the view, where the scroll occurs // oEvent.type {exontrol.SB.ModeEnum}, specifies the view's scroll that has changed as 0(vertical), 1(horizontal) // oEvent.value {number}, specifies the scroll's value // // "onsort", notifies your application once a column gets sorted or grouped by. The onsort's parameter is: // // oEvent {number}, defines the sort-operation it occured as a combination of one or more flags: // // 1 {number}, indicates sort operation // 2 {number}, indicates a group-by operation // // "onfilter", notifies your application once the control's filter has been changed. The onfilter has no parameters. // "onload", notifies your application once the control loads/imports data. The onload has no parameters. // "onerror", notifies your application once the control encountered an error. The onerror's parameter is: // // oEvent {object}, specifies an object of DOMException (or any other) type that holds information about the error // // "ondolayout", notifies your application once once the pivot's layout is ready (the control's content has been re-generated/formatted, after pivotRows, pivotColumns or pivotTotals property has been changed). The ondolayout has no parameters. // /////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////// (exontrol.Def.Pivot) // // The exontrol.Def.Pivot namespace provides definitions for different objects, primitives, objects of exontrol.Pivot object // // The exontrol.Def.Pivot namespace provides the following fields: // // scrollBars {exontrol.ScrollBarsEnum}, determines whether the control has horizontal and/or vertical scroll bars // tfi {(string|object)}, holds the font attributes for captions within the control. The tfi field can be defined using a string representation such as "b monospace 16" or as an object such as {bold: true, fontName: "monospace", fontSize: 16}. // locked {boolean}, indicates whether the control is locked(protected) or unlocked // wheelChange {number}, specifies the amount the control scrolls when the user rolls the mouse wheel. // smooth {number}, defines the time in ms the control goes from one layout to another. // margins {object}, specifies control's margins. // shapes {string}, defines the shapes each part of the control can display. The shapes field customizes the control's visual appearance. // cursors {string}, specifies the mouse cursor to be displayed when pointing over a part of the control. // singleSel {exontrol.Tree.SingleSelEnum}, specifies whether the control supports single, multiple, toggle selection. // zoom {number}, defines the zoom factor of the control's content. The zoomLevels field defines the margins of the zoom-factor the control is allowed to magnify. // zoomLevels {string}, defines the zoom-levels the user can magnify the control's content // formatText {exontrol.DrawTextFormatEnum}, specifies the format to display the item's caption. // pad {(number|string|array)}, defines the item's padding (space between the item's content and its border) // imageSize {(null|number|array)}, defines the size of the item's image. // imageAlign {number}, defines the alignment of the image within the item. // allowActions {string}, customizes the actions the user can perform once the user clicks or touches the control. // expandGlyphSize {number}, specifies the size to show the item's expand/collapse glyphs // crSize {number}, specifies the size to show the check-box/radio-button // headerHeight {number}, specifies the height to display the control's header // headerVisible {boolean}, shows or hides the control's header // countLockedColumns {number}, specifies the number of locked columns (a locked column is not scrollable, and it is fixed to the left side of the control) // columnAutoResize {boolean}, specifies whether the control will automatically size its visible columns to fit on the control's client width // sortBarVisible {boolean}, shows or hides the control's sortbar // sortBarCaption {string}, defines the caption to be shown on the control's sortbar when it is empty. // singleSort {boolean}, specifies whether the control supports single or multiple columns-sort // sortOnClick {exontrol.Tree.SortOnClickEnum}, indicates whether the column gets sorted once its header is clicked. // allowGroupBy {boolean}, indicates whether the control supports Group-By view // groupByFormatCell {string}, indicates the format of the cell to be displayed when the column gets grouped by // columnsFloatBarVisible {exontrol.Tree.ColumnsFloatBarVisibleEnum}, shows or hides the columns float-bar, which displays hidden or groupable columns // columnsFloatBarSortOrder {number}, specifies the sort order to show the columns within the control's columns floating panel // columnsFloatBarCaption {string}, indicates the caption the columns floatbar displays // filterInclude {exontrol.Tree.FilterIncludeEnum}, specifies the items to include once the control's filter is applied. // filterBarHeight {number}, specifies the height to display the control's filter-bar // filterBarVisible {exontrol.Tree.FilterBarVisibleEnum}, shows or hides the control's filter-bar // filterBarCaption {string}, customizes the caption to be shown within the control's filter-bar // filterBarPrompt {string}, specifies the caption to show while the pattern of the filter-prompt is empty // filterBarPromptPattern {string}, indicates the pattern of the filter-prompt // filterBarPromptType {exontrol.Tree.FilterPromptEnum}, specifies the type of filter-prompt. // filterBarPromptColumns {any}, indicates the list of columns the pattern of filter-prompt is applying to. // drawGridLines {exontrol.Tree.GridLinesEnum}, shows or hides the control's grid-lines // gridLines {object}, defines the color, width and style of the control's grid-lines // defaultItemHeight {number}, defines the item's default-height // treeColumnIndex {any}, specifies the index or identifier/key/caption of the column that displays the hierarchy // expandOnDblClick {boolean}, specifies whether the item is expanded or collapsed once the user double-clicks the item // itemAllowSizing {boolean}, specifies whether all or none of the items are resizable or fixed // ensureOnSort {boolean}, ensures that the selection fits the view's client-area once the user sorts or groups a column // showLockedItems {boolean}, indicates whether the locked/fixed items are visible or hidden // allowDrop {boolean}, specifies whether the user can drag and drop local files into the control // onErrorChooseFile {boolean}, specifies whether the control displays an input-file to let user choose a local filte to import, as soon as an error occurs // scrollPos {object}, defines the horizontal and vertical scroll-position of the control's default view, as an object of {x,y} type // toolTipDelay {number}, specifies how long the mouse pointer must point to an object before the tool tip appears // toolTipPopDelay {number}, specifies the period in ms of time the tool top remains visible if the mouse pointer is stationary within a control // toolTipWidth {number}, indicates the width of the control's tooltip // data {any}, imports (CSV, XML) or exports(Array) the control's data // pivotBarVisible {exontrol.Pivot.PivotBarVisibleEnum}, shows or hides the control's pivot bar (it displays the layout of the pivot-table) // pivotColumnsFloatBarVisible {exontrol.Tree.ColumnsFloatBarVisibleEnum}, shows or hides the pivot-columns floatbar (it displays the columns that can used to build the pivot-table) // pivotRows {string}, specifies the list of group-by columns that determines the rows in the pivot-table // pivotColumns {string}, specifies the list of columns to be displayed in the pivot-table // pivotTotals {string}, indicates the list of totals/subtotals to be shown in the pivot-table. // showDataOnDblClick {boolean}, shows the original data that generated the result when the user double clicks the item // displayPivotFields {number}, specifies the maximum number of columns to be displayed on the control's generated-list. // displayPivotRows {number}, specifies the maximum number of rows to be displayed on the control's generated-list. // formatPivotHeader {string}, specifies the format to display the columns within the pivot bar // /////////////////////////////////////////////////////////// /** * @description The exontrol.Def.Pivot namespace provides definitions for different objects, primitives, objects of exontrol.Pivot object */ exontrol.Def.Tree = { /** * @description The scrollBars field determines whether the control has horizontal and/or vertical scroll bars * @type {exontrol.ScrollBarsEnum} A combination of one or more exontrol.ScrollBarsEnum flags that determines whether the control has horizontal and/or vertical scroll bars. * * The exontrol.ScrollBarsEnum type defines the following flags: * * exNoScroll (0), specifies that no scroll bars are shown (scroll is not allowed) * exHorizontal (1), specifies that only horizontal scroll bars is shown * exVertical (2), specifies that only vertical scroll bars is shown * exBoth (3), specifies that both horizontal and vertical scroll bars are shown * exDisableNoHorizontal (5), specifies that the horizontal scroll bar is always shown, it is disabled if it is unnecessary * exDisableNoVertical (10), specifies that the vertical scroll bar is always shown, it is disabled if it is unnecessary * exDisableBoth (15), specifies that both horizontal and vertical scroll bars are always shown, disabled if they are unnecessary * exHScrollOnThumbRelease (0x100), specifies that the control's content is horizontally scrolled as soon as the user releases the thumb of the horizontal scroll bar (use this option to specify that the user scrolls the control's content when the thumb of the scroll box is released) * exVScrollOnThumbRelease (0x200), specifies that the control's content is vertically scrolled as soon as the user releases the thumb of the vertical scroll bar (use this option to specify that the user scrolls the control's content when the thumb of the scroll box is released) * exScrollOnThumbRelease (0x300), specifies that the control's content is scrolled as soon as the user releases the thumb of the horizontal scroll bar (use this option to specify that the user scrolls the control's content when the thumb of the scroll box is released) * exHScrollEmptySpace (0x400), allows empty space, when the control's content is horizontally scrolled to the end * exVScrollEmptySpace (0x800), allows empty space, when the control's content is vertically scrolled to the end * exScrollEmptySpace (0xC00), allows empty space, when the control's content is scrolled to the end * exExtendSBS (0x3000), specifies that the control's scroll-bars are visible only when cursor hovers the window. Also, the control's client area is extended on the scroll bars portion * exMinSBS (0xC000), specifies that the control's scroll-bars are shown as minimized * exHideSBS (0x10000), specifies that no scroll bars are shown (scroll is allowed) * * @example * * 0 or exontrol.ScrollBarsEnum.exNoScroll {number}, removes the control's scroll bars, so scroll is not allowed * 15 or exontrol.ScrollBarsEnum.exDisableBoth {number}, the control always displays the scroll bars, and they are active only if scroll is possible * 12291 or exontrol.ScrollBarsEnum.exBoth | exontrol.ScrollBarsEnum.exExtendSBS {number}, the control shows the scroll bars only if the cursor hovers the control, and the control scroll bars are hidden as soon as the cursor leaves the control */ scrollBars: exontrol.ScrollBarsEnum.exBoth, /** * @description The tfi field applies font attributes to captions within the control. The tfi field can be defined using a string representation such as "b monospace 16" or as an object such as {bold: true, fontName: "monospace", fontSize: 16}. * * The tfi field as string supports any of the following keywords (each keyword can be specified using first letters only such as "b" for "bold) separated by space characters: * * bold, displays the text in bold (equivalent of tag) * italic, displays the text in italics (equivalent of tag) * underline, underlines the text (equivalent of tag) * strikeout, specifies whether the text is strike-through (equivalent of tag) * , specifies the font's family (equivalent of tag) * , specifies the size of the font (equivalent of tag) * , specifies the text's foreground color (equivalent of tag) * , specifies the text's background color (equivalent of tag) * , defines the text's shadow (equivalent of tag) * , shows the text with outlined characters (CSScolor) (equivalent of tag) * , defines a gradient text (equivalent of tag) * * Any other word within the tfi field that's not recognized as a keyword is interpreted as: * * name of the font (not a number), specifies the font's family (equivalent of tag) * size of the font (number), specifies the size of the font (equivalent of tag) * * The tfi field as object supports any of the following fields: * * bold {boolean}, displays the text in bold (equivalent of tag) * italic {boolean}, displays the text in italics (equivalent of tag) * underline {boolean}, underlines the text (equivalent of tag) * strikeout {boolean}, specifies whether the text is strike-through (equivalent of tag) * fontName {string}, specifies the font's family (equivalent of tag) * fontSize {number}, specifies the size of the font (equivalent of tag) * fgColor {string}, specifies the text's foreground color (CSScolor) (equivalent of tag) * bgColor {string}, specifies the text's background color (CSScolor) (equivalent of tag) * shaColor {object}, specifies an object of {color, width, offset} type that defines the text's shadow (equivalent of tag), where: * color {string}, defines the color of the text's shadow (CSScolor) * width {number}, defines the size of the text's shadow * offset {number}, defines the offset to show the text's shadow relative to the text * outColor {string}, shows the text with outlined characters (CSScolor) (equivalent of tag) * graColor {object}, specifies an object of {color, mode, blend} type that defines a gradient text (equivalent of tag), where: * color {string}, defines the gradient-color (CSScolor) * mode {number}, defines the gradient mode as a value between 0 and 4 * blend {number}, defines the gradient blend as a value between 0 and 1 * * CSSColor or CSS legal color values can be specified by the following methods: * * Hexadecimal colors, is specified with: #RRGGBB, where the RR (red), GG (green) and BB (blue) hexadecimal integers specify the components of the color. All values must be between 00 and FF. For example, #0000ff value is rendered as blue, because the blue component is set to its highest value (ff) and the others are set to 00. * Hexadecimal colors with transparency, is specified with: #RRGGBBAA, where AA (alpha) value must be between 00 and FF. For example, #0000ff80 defines a semi-transparent blue. * RGB colors, is specified with the RGB(red, green, blue) function. Each parameter (red, green, and blue) defines the intensity of the color and can be an integer between 0 and 255. For example, rgb(0,0,255) defines the blue color. * RGBA colors, are an extension of RGB color values with an alpha channel as RGBA(red, green, blue, alpha) function, where the alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque). For example, rgba(0,0,255,0.5) defines a semi-transparent blue. * HSL colors, is specified with the HSL(hue, saturation, lightness) function, where hue is a degree on the color wheel (from 0 to 360) - 0 (or 360) is red, 120 is green, 240 is blue. saturation is a percentage value; 0% means a shade of gray and 100% is the full color. lightness is also a percentage; 0% is black, 100% is white. HSL stands for hue, saturation, and lightness - and represents a cylindrical-coordinate representation of colors. For example, hsl(240, 100%, 50%) defines the blue color. * HSLA colors, are an extension of HSL color values with an alpha channel - which specifies the opacity of the object as HSLA(hue, saturation, lightness, alpha) function, where alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque). For example, hsla(240, 100%, 50%,0.5) defines a semi-transparent blue. * Predefined/Cross-browser color names, 140 color names are predefined in the HTML and CSS color specification. For example, blue defines the blue color. * * @type {(string|object)} * @example * * null {null}, the tfi field is ignored * "bold monospace 16" {string}, defines Monospace font of 16px height, bold * {bold: true, fontName: "monospace", fontSize: 16} {object}, defines Monospace font of 16px height, bold */ tfi: null, /** * @description The locked field indicates whether the control is locked(protected) or unlocked * @type {boolean} Specifies whether the control is protected. * @example * * false {boolean}, unlocks the control (can select any item) * true {boolean}, locks the control (can't select any item) */ locked: false, /** * @description The readOnly field indicates whether the control is read-only * @type {boolean} Specifies whether the control is read-only. * @example * * false {boolean}, the user can edit or drag any item * true {boolean}, the user can not edit or drag the items */ readOnly: false, /** * @description The wheelChange field specifies the amount the control scrolls when the user rolls the mouse wheel. * @type {number} Specifies the amount the control scrolls when the user rolls the mouse wheel. * @example * * 0 {number}, locks any action the mouse's wheel performs * 18 {number}, scrolls the control by 18-pixels when mouse's wheel is rotated (CTRL + wheel scrolls horizontally) */ wheelChange: 18, /** * @description The smooth field defines the time in ms the control goes from one layout to another. * @type {number} Indicates the time in ms the control goes from one layout to another (125, by default). * @example * * 0 {number}, no smooth changes once the control goes from a layout to another * 125 {number}, specifies that a smooth-transition is performed from a layout to another for 125 ms. */ smooth: 125, /** * @description The margins field specifies control's margins. * @type {object} Indicates an object of {border} type that defines the control's margins */ margins: { /** * @description The indent field defines the distance between a child item and its parent, while the items are arranged as a tree. * @type {number} Specifies the distance between a child item and its parent, while the items are arranged as a tree. * @example * * 0 {number}, defines no indention * 16 {number}, defines 16-pixels indention */ indent: 16 }, /** * @description The shapes field defines the shapes each part of the control can display. The shapes field customizes the control's visual appearance. * @type {string} A string expression that defines the shapes each part of the control can display. * * The format of shapes property is: * * "shape(part),shape(part),..." * * where: * * "shape", defines the shape to apply on the UI part as one of the following: * * any of 140 color names any browser supports (such as red, blue, green, ...) * hexadecimal colors, is specified with: #RRGGBB, where the RR (red), GG (green) and BB (blue) hexadecimal integers specify the components of the color. All values must be between 00 and FF (such as #0000ff which defines a blue background) * hexadecimal colors with transparency, is specified with: #RRGGBBAA, where AA (alpha) value must be between 00 and FF (such as #0000ff80 which defines a semi-transparent blue background) * RGB colors, is specified with the RGB(red, green, blue) function. Each parameter (red, green, and blue) defines the intensity of the color and can be an integer between 0 and 255( such as rgb(0,0,255) that defines a blue background) * RGBA colors, are an extension of RGB color values with an alpha channel as RGBA(red, green, blue, alpha) function, where the alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque) ( such as rgba(0,0,255,0.5) which defines a semi-transparent blue background) * HSL colors, is specified with the HSL(hue, saturation, lightness) function, where hue is a degree on the color wheel (from 0 to 360) - 0 (or 360) is red, 120 is green, 240 is blue. saturation is a percentage value; 0% means a shade of gray and 100% is the full color. lightness is also a percentage; 0% is black, 100% is white. HSL stands for hue, saturation, and lightness - and represents a cylindrical-coordinate representation of colors (such as hsl(240, 100%, 50%) that defines a blue background) * HSLA colors, are an extension of HSL color values with an alpha channel - which specifies the opacity of the object as HSLA(hue, saturation, lightness, alpha) function, where alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque) (such as hsla(240, 100%, 50%,0.5) that defines a semi-transparent blue background) * a JSON representation of the shape object to apply (while it starts with { character, such as '{"normal": {"primitive": "RoundRect","fillColor":"black","tfi": {"fgColor": "white"}}}') * specifies the name of the field within the exontrol.Shapes.Tree object (while it starts with a lowercase letter, such as shitem which refers to exontrol.Shapes.Tree.shitem shape) * specifies the name of the field within the exontrol.Shapes object (while it starts with an uppercase letter, such as Button which refers to exontrol.Shapes.Button shape) * * "part", defines the name of the part the shape is applied on (as defined below) * * The shapes property supports any of the following parts: * * "itemTot", defines the visual-appearance for item of total type * "itemSub", defines the visual-appearance for item of sub-total type * "pivotBar-idem", defines the visual-appearance of idem-columns within the control's pivotbar * "pivotBar-aggregate", defines the visual-appearance of an aggregate-glyph within the control's pivotbar * "pivotBar-total", defines the visual-appearance of a total-field within the control's pivotbar * "pivotBar-refresh", defines the visual-appearance of the "Refresh" button within the control's pivotbar * "pivotBar-addNew", defines the visual-appearance of the "add-new" buttons within the control's pivotbar * * "lock", defines the visual-appearance for locked-part of the tree-view (left-side panel of the tree-view, determined by the countLockedColumns field, displays un-scrollable columns) * "lock-header", defines the visual-appearance for locked-part of the header (left-side panel of the header, determined by the countLockedColumns field, displays un-scrollable columns) * "unlock", defines the visual-appearance for unlocked-part of the tree-view (ride-side panel of the tree-view, determined by the countLockedColumns field, displays scrollable columns) * "unlock-header", defines the visual-appearance for unlocked-part of the header (ride-side panel of the header, determined by the countLockedColumns field, displays scrollable columns) * "filterBar-close", defines the visual-appearance of the filter-bar's close button * "filterBar", defines the visual-appearance of the control's filter-bar * "sortBar-caption", defines the visual-appearance of control's sortbar when it displays no columns * "column", defines the visual-appearance of column's header * "column-filter", defines the visual-appearance of column's filter-button * "radio", defines the visual-appearance of the radio-button * "check", defines the visual-appearance of the check-box * "expand", defines the visual-appearance of expand/collapse glyphs * "cell", defines the visual-appearance for all cells within the control * "item", defines the visual-appearance for all items within the control * "itemDiv", defines the visual-appearance for divider-items (a divider-item displays only a single-cell) * "itemAlt", defines the visual-appearance for alternate-items (every second item) * "select", defines the visual-appearance of selected-item * "frameFit", defines the visual-appearance to display the frame while fitting objects into the control's client area by drag * "frameSel", defines the visual appearance to display a frame while selecting objects by drag * "multiSel", specifies the visual appearance to show the count of multiple-selected items * * @example * * null {null}, specifies the default visual appearance * "" {string}, no shape (no visual appearance is applied to any part of the control) * "red(itemAlt)", "#FF0000(itemAlt)", "rgb(255,0,0)(itemAlt)", "rgba(255,0,0,1)(itemAlt)" {string}, shows alternate-items in red * '{"hover":{"fillColor":"black","tfi":{"fgColor":"white"}}}(item)' {string}, shows the item in white on a black-background, while the cursor hovers it * "xxx(d),yyy(d,m),zzz(y)" {string}, specifies that the exontrol.Shapes.Tree.xxx combined with exontrol.Shapes.Tree.yyy object defines the visual appearance of "d" part of the control, exontrol.Shapes.Tree.yyy object defines the visual appearance of "m" part of the control and exontrol.Shapes.Tree.zzz object defines the visual appearance of "y" part of the control */ shapes: "shitem(item),shcell(cell),shtotal(pivotBar-total),shaddNew(pivotBar-addNew),shcolumn(column,sortBar-caption),shfilterBar(filterBar),Expand(expand),FrameFit(frameFit),FrameSel(frameSel,select),shcheck(check),shradio(radio),Button(filterBar-close,pivotBar-refresh),Border(pivotBar-aggregate,itemTot,itemSub),shmulti(multiSel)", /** * @description The cursors field specifies the mouse cursor to be displayed when pointing over a part of the control. * @type {string} Specifies the mouse cursor to be displayed when pointing over a part of the control. * * The format of cursors property is: * * "cursor(part),cursor(part),..." * * where: * * "cursor", defines the CSS mouse cursor to display while cursor hovers the part * "part", defines the name of the part the cursor is applied on (as defined below) * * The cursors property supports any of the following parts: * * "pivotBar-aggregate", defines the mouse-cursor to show when the mouse pointer hovers an aggregate-glyph within the control's pivotbar * "pivotBar-total", defines the mouse-cursor to show when the mouse pointer hovers a total-field within the control's pivotbar * "pivotBar-refresh", defines the mouse-cursor to show when the mouse pointer hovers the "Refresh" button within the control's pivotbar * "pivotBar-addNew", defines the mouse-cursor to show when the mouse pointer hovers the "add-new" buttons within the control's pivotbar * "filterBar-close", defines the mouse-cursor to show when the mouse pointer hovers the filter-bar's close button * "filterBar-prompt", defines the mouse-cursor to show when the mouse pointer hovers the filter-bar's prompt field * "filterBar-caption", defines the mouse-cursor to show when the mouse pointer hovers the filter-bar's caption field * "filterBar-caption-column", defines the mouse-cursor to show when the mouse pointer hovers a column of the filter-bar's caption field * "column", defines the mouse-cursor to show when the mouse pointer hovers the column's header * "column-filter", defines the mouse-cursor to show when the mouse pointer hovers the column's filter-button * "column-drag", defines the mouse-cursor while the column is dragging * "item", defines the mouse-cursor when the mouse pointer hovers any item * "item-drag", defines the mouse-cursor while the item is dragging * "cell", defines the mouse-cursor when the mouse pointer hovers any cell * "expand", defines the mouse-cursor to be shown when the mouse pointer hovers the expand/collapse glyphs * "anchor" (hyperlink), defines the mouse-cursor when the mouse pointer hovers the anchor (the ex-HTML part marks an anchor or hyperlink element) (@since 2.2) * "check", defines the mouse-cursor to be shown when the mouse pointer hovers the check-box/radio-button * "long", specifies the mouse-cursor to be shown as soon as a "long" click or touch action begins (see allowActions field) * * @example * * "pointer(xxx,yy)" {string}, indicates that the "pointer" mouse cursor is shown while cursor hovers any "xxx" or "yyy" part of the control */ cursors: "not-allowed(no),grab(long),pointer(expand,check,radio,filterBar-close,filterBar-caption-column,column-filter,column-drag,item-drag,drag-drop,anchor,pivotBar-total,pivotBar-refresh,pivotBar-addNew,pivotBar-aggregate),text(filterBar-prompt)", /** * @description The singleSel field specifies whether the control supports single, multiple, toggle selection. * @type {exontrol.Tree.SingleSelEnum} Indicates whether the control supports single or multiple selection. * * The exontrol.Tree.SingleSelEnum type defines the following flags: * * exDisableSel(0), specifies that the control's selection is disabled (can not be combined with any other flags) * exEnableSel(1), specifies that the control's selection is enabled (multiple-selection, unless the exSingleSel is set ) * exSingleSel(2), specifies that the user can select a item only * exToggleSel(4), specifies that the item's selection state is toggled once the user clicks a item. * exDisableCtrlSel(8), disables toggling the item's selection state when user clicks a item, while CTRL modifier key is pressed. * exDisableShiftSel(16), disables selecting items using the SHIFT key. * exDisableDrag(32), disables selecting items by drag. * * @example * * 0 or exontrol.Tree.SingleSelEnum.exDisableSel {number}, disables selecting any item * 3 or exontrol.Tree.SingleSelEnum.exSingleSel | exontrol.Tree.SingleSelEnum.exEnableSel {number}, enables control's single selection, so only a single item can be selected * 6 or exontrol.Tree.SingleSelEnum.exToggleSel | exontrol.Tree.SingleSelEnum.exSingleSel {number}, enables control's single and toggle selection, which means that once a item is selected it gets unselected once it is clicked, or reverse, and only a single-item can be selected at once. */ singleSel: exontrol.Tree.SingleSelEnum.exEnableSel, /** * @description The zoom field defines the zoom factor of the control's content. The zoomLevels field defines the margins of the zoom-factor the control is allowed to magnify. * @type {number} Indicates the content's zoom factor in percent. The zoom field can be any value between 10 (10%) and 1000 (1000%) * @example * * null {null}, Specifies normal-view (100%) * 150 {number}, Indicates that the control's content is magnfied to 150% */ zoom: 100, /** * @description The zoomLevels field defines the zoom-levels the user can magnify the control's content * @type {string} Specifies a list of numbers separated by comma that indicates the zoom-levels/zoom-margins the control's content is allowed to zoom * @example * * null {null}, Specifies that the control's zoom factor is always 100% * 150 {number}, Specifies that the control's zoom factor is always 150% * "50,100,200,350" {string}, Indicates that the zoom-factor can be any of selected values, and the margins of zoom-factor is 50% to 350% */ zoomLevels: "50,65,75,80,90,100,110,125,150,175,200,250,300,400,500", /** * @description The formatText field specifies the format to display the item's caption. * @type {exontrol.DrawTextFormatEnum} A combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the item's caption. * * The exontrol.DrawTextFormatEnum type supports the following flags: * * exTextAlignTop (0x00), justifies the text to the top of the rectangle * exTextAlignLeft (0x00), aligns text to the left * exTextAlignCenter (0x01), centers text horizontally in the rectangle * exTextAlignRight (0x02), aligns text to the right * exTextAlignVCenter (0x04), centers text vertically * exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle. * exTextAlignMask (0x0F), specifies the mask for text's alignment. * exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line. * exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line. * exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight. * exPlainText (0x80), treats the text as plain text. * exTextNoClip (0x0100), draws without clipping. * exHTMLTextNoColors (0x0200), ignores the and tags. * exTextCalcRect (0x0400), determines the width and height of the text. * exHTMLTextNoTags (0x0800), ignores all HTML tags. * exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash. * exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses. * exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses. * * @example * * null {null}, centers the caption * 32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption * 0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned */ formatText: exontrol.DrawTextFormatEnum.exTextAlignLeft | exontrol.DrawTextFormatEnum.exTextAlignVCenter | exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextWordEllipsis, /** * @description The pad field defines the item's padding (space between the item's content and its border) * @type {(number|string|array)} A value that could be a numeric value, to pad horizontal and vertical size with the same value, or a "x,y" or [x,y] type to specify the padding on h/v size * @example * * null {null}, indicates that the default-padding field is used ([4,4]) * 0 {number}, indicates no padding * "8,4" {string}, increases the item's width with 2 * 8-pixels and item's height with 2 * 4-pixels * [8,4] {array}, increases the item's width with 2 * 8-pixels and item's height with 2 * 4-pixels */ pad: [4,4], /** * @description The imageSize field defines the size of the item's image. * @type {(null|number|array)} Indicates the size of the item's image. * * The imageSize could be of one of the following types: * * {null}, Indicates that the item's image is displayed as it is (full-sized). * {number}, Specifies that the item's image is displayed into a square of giving size (same width and height). If 0 the item displays no image, if negative the item's image is stretched to giving square, else the item's picture is scaled to fit the giving rectangle. * {array}, Specifies an array of [aspect-width,aspect-height] type that defines the limits for width or/and height. The aspect-width and aspect-height define the width/height of the item's picture to scale or stretch to. * * @example * * null {null}, Indicates that the item's image is displayed as it is (full-sized). * 0 {number}, no image is displayed * 64 {number}, the image is scaled to fit a 64 x 64 rectangle * -64 {number}, the image is strected to a 64 x 64 rectangle * [32,64] {array}, scales the image to the largest ratio-rectangle (32 x 64) that fits the client * [-32,-64] {array}, stretches the image to a 32 x 64 rectangle */ imageSize: 18, /** * @description The imageAlign field defines the alignment of the image within the item. * @type {number} Indicates the alignment of the image within the item. as 0 (left, default), 1(right), 2(top) or 3(bottom). * * The imageAlign propery can be any of the following: * * 0, the image is on the left of the item's caption * 1, the image is on the right of the item's caption * 2, the image is on the top of the item's caption * 3, the image is on the bottom of the item's caption * * @example * * null {null}, the image is aligned left to the caption (default) * 1 {number}, the image is displayed to the right of the item's caption */ imageAlign: 0, /** * @description The allowActions field customizes the actions the user can perform once the user clicks or touches the control. * @type {string} Specifies the list and order of the actions the user can perform once the user clicks or touches the control. * * The format of allowActions field is: * * "action(shortcut,shortcut,...),action(shortcut,shortcut,...)..." * * where * * "action", indicates the name of the action. The "action" can have any of the following values: * * "format", formats (content, appearance, conditional) of the column from the cursor * "scroll", scrolls the control's content by drag. The "scroll" action allows flags such as: * [view], specifies that the "scroll" is possible once the user clicks the view * [header], specifies that the "scroll" is possible once the user clicks the header of the view * "zoom", zooms the control's content at dragging-point. * "fit", fits the drag-area into the control's client area. * "select", selects items by drag * "edit", edits the cell being clicked (not available if the control is read-only) * "item-drag", moves items by drag (not available if the control is read-only). The "item-drag" action allows flags such as: * [position], The item can be dragged from a position to another, but not outside of its group. If your items are arranged as a flat list, no hierarchy, this option can be used to allow the user change the item's position at runtime by drag and drop. This option does not change the parent of any dragged item. * [keepIndent], The item can be dragged to any position or to any parent, while the dragging object keeps its indentation. This option can be used to allow the user change the item's position at runtime by drag and drop. In the same time, the parent's item could be changed but keeping the item's indentation. * [any], The item can be dragged to any position or to any parent, with no restriction (by default, if no flag is present). * "item-resize", resize items by drag (available only if the control's readOnly property is false, and item's allowSizing field is true). The "item-resize" action allows flags such as: * [all], specifies that once an item gets resized all resizable-items get resized (changes the control's defaultItemHeight property). If the [all] flag is missing, only the item (or all selected items) get resized * "column-resize", resizes columns by drag. If "column-resize" action has no flags it indicates that resizing is possible in view and header as well (available only if the control's readOnly property is false, and the column's allowSizing field is true). The "column-resize" action allows flags such as: * [view], specifies that the "column-resize" operation is possible in the view * [header], specifies that the "column-resize" operation is possible in the header of the view * "column-drag", drags the column to a new position (not available if the control is read-only) * * "shortcut", defines the event's button or/and the modifier-keys that are required to perform the action. The "shortcut" is a combination of none, one or more of the following values: * * "Shift", indicates that the SHIFT key is pressed * "Ctrl" or "Control", indicates that the CTRL key is pressed * "Alt" or "Menu", indicates that the ALT key is pressed * "Meta" , indicates that the META key is pressed * "LButton", specifies that the mouse's left-button is pressed * "RButton", specifies that the mouse's right-button is pressed * "MButton", specifies that the mouse's middle/wheel-button is pressed * "Long", specifies that the action requires a "long" click or touch before it begins * "Double", specifies that the action requires a "double" click before it begins (this flag is available for non-dragable actions only such as "edit") * "+", indicates AND between values * * @example * * null {null}, indicates the control's default allowActions value * "" {string}, specifies that no operation is allowed once the user clicks or touches the control * "scroll" {string}, specifies that only "scroll" operation is allowed, no matter of the event's button or modifier-keys is pressed. * "column-resize[view](LButton)" {string}, allows resizing the columns (inside the view), while pressing the mouse's left-button only * "column-drag(Shift+LButton),item-drag,scroll" {string}, indicates that dragging a column is possible only if the user presses the mouse's left-button while SHIFT key is pressed, and "item-drag" or "scroll" is possible no matter of the event's button or modifier-keys in this order (if one operation is not possible, the next one is performed). * */ allowActions: "fit(Shift+MButton,Ctrl+MButton,Alt+MButton),zoom(MButton),select(Shift,Ctrl),column-resize[header],column-drag,scroll,format(RButton)", /** * @description The expandGlyphSize field specifies the size to show the item's expand/collapse glyphs * @type {number} Indicates the size to show the item's expand/collapse glyphs * @example * * 0 {number}, displays no node's expand/collapse glyphs * 24 {number}, specifies a size of 24x24 to display the node's expand/collapse glyphs */ expandGlyphSize: 16, /** * @description The crSize field specifies the size to show the check-box/radio-button * @type {number} Indicates the size to show the check-box/radio-button * @example * * 0 {number}, displays no check-box/radio-button * 24 {number}, specifies a size of 24x24 to display the check-box/radio-button */ crSize: 16, /** * @description The headerHeight field specifies the height to display the control's header (specifies the height the header's level, where columns header is being shown). The header displays the header of each visible-columns. * @type {number} Specifies the height to display the control's header * @example * * 0 {number}, hides the control's header * 24 {number}, indicates that the height of the control's header is 24 */ headerHeight: 24, /** * @description The headerVisible field specifies whether the control's header is visible or hidden. The header displays the header of each visible-columns. * @type {exontrol.Tree.HeaderVisibleEnum} Indicates whether the control's header is visible or hidden * * The exontrol.Tree.HeaderVisibleEnum type defines the following values: * * exHeaderHidden(0), the control's header is hidden * exHeaderVisible(-1), the control's header is visible * exHeaderVisibleExtendLevels(1), the control's header is visible, and each column's header is extended to cover all levels of the header * * @example * * false {boolean} or 0 {number}, hides the control's header * -1 {number} or exontrol.Tree.HeaderVisibleEnum.exHeaderVisible {number}, shows the control's header * true {boolean} or 1 {number}, shows the control's header (each column's header is extended to cover all levels of the header) */ headerVisible: exontrol.Tree.HeaderVisibleEnum.exHeaderVisible, /** * @description The countLockedColumns field specifies the number of locked columns (a locked column is not scrollable, and it is fixed to the left side of the control) * @type {number} specifies the number of locked columns. The countLockedColumns field splits the view into lock and unlock parts. The lock-part hosts the columns that are fixed, and can not be scrolled. * @example * * 0 {number}, indicates that the control displays no locked-columns * 2 {number}, specifies that the first two-visible columns are locked (not scrollable and fixed to the left side of the control) */ countLockedColumns: 0, /** * @description The columnAutoResize field specifies whether the control will automatically size its visible columns to fit on the control's client width * @type {boolean} specifies whether the control will automatically size its visible columns to fit on the control's client width * @example * * false {boolean}, no effect * true {number}, all visible columns are proportionally resized to fit the control's width */ columnAutoResize: false, /** * @description The sortBarVisible field specifies whether the control's sortbar is visible or hidden. The sortbar displays the header of each sorted/grouped-columns. * @type {boolean} Indicates whether the control's sortbar is visible or hidden * @example * * false {boolean}, hides the control's sortbar * true {boolean}, shows the control's sortbar */ sortBarVisible: false, /** * @description The sortBarCaption field specifies the caption to be shown on the control's sortbar when it is empty. * @type {string} Defines the caption of the control's sortbar while it is empty * @example * * null {null}, the control's sortbar shows the default-caption * "Drag a column header here to drag by that column." {string}, changes the caption to be displayed on the control's sortbar while it is empty. */ sortBarCaption: "Drag a column header here to sort by that column.", /** * @description The singleSort field specifies whether the control supports single or multiple-columns sort * @type {boolean} Indicates whether the control supports single or multiple-columns sort * @example * * false {boolean}, specifies that the control supports one ore more sorted-columns * true {boolean}, the control supports single-column sorts only */ singleSort: false, /** * @description The sortOnClick field indicates whether the column gets sorted once the user clicks its header. * @type {exontrol.Tree.SortOnClickEnum} Specifies a numeric value that defines the action once the user clicks the column's header * * The exontrol.Tree.SortOnClickEnum type defines the following values: * * exNoSort(0), the column is not sorted when user clicks the column's header. * exDefaultSort(-1), The column gets sorted when user the clicks the column's header. * exUserSort(-1), The control displays the sort icons, but it doesn't sort the column (not supported) * * @example * * null {null}, specifies the control's default sort on click, equivalent of exDefaultSort * 0 {number}, no column gets sorted once the user clicks any column's header */ sortOnClick: exontrol.Tree.SortOnClickEnum.exDefaultSort, /** * @description The allowGroupBy field specifies whether the control supports group-by view * @type {boolean} Indicates whether the control supports group-by view * @example * * false {boolean}, no group-view is generated once the user drags a column to the control's group-by/sort bar * true {boolean}, the control supports group-by view */ allowGroupBy: false, /** * @description The groupByFormatCell field indicates the format of the cell to be displayed when the column gets grouped by * @type {string} Specifies the format of the cell to be displayed when the column gets grouped by * * The format-expression supports the following keywords: * * value, indicates the value of the current cell ( "value/2 format ``", displays half of the value using current regional format ) * %0, %1, %2, ... specifies the value of the cell in the column with the index 0, 1 2, ... ( "currency(%0 + %1)", adds the value of first and second cell and displays it as a currency ) * %C0, %C1, %C2, ... specifies the caption of the cell, or the string the cell displays in the column with the index 0, 1 2, ... ( "%C0 + %C1", concatenates the caption of first and second cell ) * %CD0, %CD1, %CD2, ... specifies the cell's user-date in the column with the index 0, 1 2, ... ( "%CD0 ? value : ``", displays the cell's value only if the cell's data is not empty ) * %CS0, %CS1, %CS2, ... specifies the cell's state in the column with the index 0, 1 2, ... ( "(%CS0 ? `` : ``) + value", displays the cell's value in bold only if the first cell is checked ) * * The format-expression supports the following unary-operators: * * exp(``), checks whether the item is expanded or collapsed ( "(exp(``) ? `` : ``) + value", shows expanded-items in bold ) * get(`aggregate(list,direction,formula)`), summarizes the cell based on "aggregate(list,direction,formula)" syntax, where: * * aggregate, must be one of the following: * * sum, performs addition of values * min, retrieves the minimum value * max, retrieves the maximum value * count, counts the number of items * avg, calculates the average of values * std, gets standard-deviation of numbers * * list, must be one of the following: * * a number expression that specifies the index of the item being referred * all, indicates all items, so the formula is being applied to all items. The direction has no effect * current, refers the current item * parent, refers to the parent item * root, refers to the root item (the root item has no parent items) * * direction, must be one of the following: * * dir, collects only direct descendents (child-items) * rec, collects recursivelly the leaf descendents ( leaf items ). A leaf item is an item with no child items * all, collects all descendents * * Currently, the following items are excluded by aggregate functions: * * not-sortable items. The SortableItem property specifies whether the item can be sorted ( a sortable item can change its position after sorting, while a not-sortable item keeps its position after sorting. * not-selectable items. The SelectableItem property specifies whether the user can selects/focus the specified item. * divider items. The ItemDivider property specifies whether the item displays a single cell, instead displaying whole cells. * * In conclusion, aggregate functions counts ONLY items that are sortable, selectable and not a divider-item. * * For instance: * * "get(`count(current,dir,1)`)", gets the count of child-items * "get(`count(current,all,1)`)", gets the count of all child-items (implies recursively child items) * "get(`count(current,rec,1)`)", counts the number of leaf items ( a leaf item is an item with no child items ). * "get(`sum(current,dir,%1 ? 1 : 0)`)", counts the number of child-items that have not-empty cells within the second-column * "get(`sum(current,dir,value)`)", gets the total of values of child-items (direct descendent) within the same column * "get(`sum(all,rec,value)`)", gets the total of values of leaf-items within the same column * "get(`sum(parent,dir,dbl(%1) + dbl(%2))`)", gets the addition of all cells in the second (%1) and third (%2) column that are directly descendent of the parent item (sibling). * * The format-expression supports the following binary-operators: * * 0 index `format`, gets the index of the item (0-based). The first added item has the index 0, the second added item has the index 1, and so on. The index of the item remains the same even if the order of the items is changed by sorting or grouping ( "1 index ``", gets the index of the item starting from 1 ) * 0 rindex `delimiter|format|format|...`, returns the recursive-index of the item ("1 rindex `.|A-Z`", returns values as A, A.1, A.2, B, ...) * 0 pos `format`, returns the relative position of the item (the position within the parent's children collection) ( "1 pos ``", returns the position of the item (1-based) within the parent's child items collection ) * 0 rpos `delimiter|format|format|...`, returns the recursive relative-position of the item (the position within the parent's children collection) ( "1 rpos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * 0 opos `format`, returns the relative old position of the item (the position within the parent's children collection) ( "1 opos ``", returns the position of the item (1-based) within the parent's child items collection ) * 0 ropos `delimiter|format|format|...`, returns the recursive relative-old-position of the item (the position within the parent's children collection) ( "1 ropos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * 0 apos `format`, returns the absolute position of the item (the position from the first visible item) ( "1 apos ``", gets absolute position of the item ) * 0 rapos `delimiter|format|format|...`, returns the recursive absolute-position of the item (the position from the first visible item) ( "1 rapos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * * where: * * `delimiter`, is a character to separated recursive-operators such as "rindex", "rpos", "ropos" and "rapos" * `format`, is a set of characters to be used for specifying the index * * @example * * "" {string}, the default group-by value gets displayed once the column gets grouped by * "upper(value)" {string}, the default group-by value (in upper case) gets displayed once the column gets grouped by * "value + ` ` + get(`count(current,rec,1)`)" {string}, the default group-by value plus the count of items within the group gets displayed once the column gets grouped by */ groupByFormatCell: "(exp(``) ? `` : ``) + value + (0:=get(`count(current,rec,1)`) ? (` (` + =:0 + `)`) : ``)", /** * @description The columnsFloatBarVisible field indicates whether the columns float bar is visible or hidden. * @type {exontrol.Tree.ColumnsFloatBarVisibleEnum} Specifies the type of columns the control's float bar displays when it is visible. * * The exontrol.Tree.ColumnsFloatBarVisibleEnum type supports the following values: * * exColumnsFloatBarHidden(0), the Columns float bar is hidden * exColumnsFloatBarVisibleIncludeGroupByColumns(1), the Columns float bar is visible, and it displays dragable (AllowDragging property) and groupable (AllowGroupBy property) columns of the control. * exColumnsFloatBarVisibleIncludeCheckColumns(2), the Columns float bar is visible, and it displays dragable (AllowDragging property), and a check-box for each Column to update its Visible property (shor or hide the column). * exColumnsFloatBarVisibleIncludeHiddenColumns(4), the Columns float bar is visible, and it displays dragable (AllowDragging property) and hidden (Visible property) columns of the control. * exColumnsFloatBarFloat(0x100), the columns floatbar is shows as floated. This flag can be combined with exColumnsFloatBarVisibleIncludeHiddenColumns, exColumnsFloatBarVisibleIncludeCheckColumns or exColumnsFloatBarVisibleIncludeGroupByColumns type. * * @example * * false {boolean} or 0 {number}, hides the columns float bar * true {boolean}, 1 or exontrol.Tree.ColumnsFloatBarVisibleEnum.exColumnsFloatBarVisibleIncludeGroupByColumns {number}, the columns float bar is visible and displays groupable columns */ columnsFloatBarVisible: exontrol.Tree.ColumnsFloatBarVisibleEnum.exColumnsFloatBarHidden, /** * @description The columnsFloatBarSortOrder field specifies the sort order to show the columns within the control's columns float panel * @type {number} Specifies the columns sort-order as listed: * * 0 {number}, shows columns unsorted * 1 {number}, shows columns in ascending order (by name) * 2 {number}, shows columns in descending order (by name) * * @example * * 0 {number}, shows columns unsorted * 1 {number}, shows columns in ascending order (by name) */ columnsFloatBarSortOrder: 0, /** * @description The columnsFloatBarCaption field defines the caption to display on the columns float bar. * @type {string} Specifies the caption of the columns float bar * @example * * "" {string}, hides the caption of the columns float bar * "Columns" {string}, displays in bold the caption of the columns float bar */ columnsFloatBarCaption: "Columns", /** * @description The filterInclude field specifies the items to include once the control's filter is applied. * @type {exontrol.Tree.FilterIncludeEnum} Specifies the items to include once the control's filter is applied. * * The exontrol.Tree.FilterIncludeEnum type supports the following flags: * * exItemsWithoutChilds(0), items (and parent-items) that match the filter are shown (no child-items are included) * exItemsWithChilds(1), items (parent and child-items) that match the filter are shown * exRootsWithoutChilds(2), only root-items (excludes child-items) that match the filter are displayed * exRootsWithChilds(3), root-items (and child-items) that match the filter are displayed * exMatchingItemsOnly(4), shows only the items that matches the filter (no parent or child-items are included) * exMatchIncludeParent(0xF0), specifies that the item matches the filter if any of its parent-item matches the filter. The exMatchIncludeParent flag can be combined with any other value * * @example * * null {null}, specifies the control's default FilterInclude property (exontrol.Tree.FilterIncludeEnum.exItemsWithoutChilds), so items (and parent-items) that match the filter are shown (no child-items are included) * 4 or exontrol.Tree.FilterIncludeEnum.exMatchingItemsOnly {number}, shows only the items that matches the filter (no parent or child-items are included) * 0xF4 or exontrol.Tree.FilterIncludeEnum.exMatchingItemsOnly | exontrol.Tree.FilterIncludeEnum.exMatchIncludeParent {number}, shows the items (including the child-items) that match the filter */ filterInclude: exontrol.Tree.FilterIncludeEnum.exItemsWithoutChilds, /** * @description The filterBarHeight field specifies the height to display the control's filter-bar * @type {number} Specifies the height to display the control's filter-bar * @example * * 0 {number}, hides the control's filter-bar * 24 {number}, indicates that the height of the control's filter-bar is 24 */ filterBarHeight: 24, /** * @description The filterBarVisible field indicates whether the control's filter-bar is visible or hidden * @type {exontrol.Tree.FilterBarVisibleEnum} Specifies whether the control's filter-bar is visible or hidden * * The exontrol.Tree.FilterBarVisibleEnum type supports the following flags: * * exFilterBarHidden(0), indicates that the control's filter-bar is visible only if the control has a filter applied (use the filterBarHeight on 0 to effectively hides the control's filter-bar) * exFilterBarPromptVisible(1), specifies that the control's filter-bar displays the filter prompt * exFilterBarVisible(2), forces the control's filter-bar to be shown, no matter if any filter is applied * exFilterBarCaptionVisible(4), forces the control's filter-bar to display the FilterBarCaption property. * exFilterBarSingleLine(16), specifies that the caption on the control's filter bar is displayed on a single line. The exFilterBarSingleLine flag , specifies that the filter bar's caption is shown on a single line, so
HTML tag or \r\n are not handled. By default, the control's filter description applies word wrapping. Can be combined to exFilterBarCompact to display a single-line filter bar. If missing, the caption on the control's filter bar is displayed on multiple lines. You can change the height of the control's filter bar using the FilterBarHeight property. * exFilterBarToggle(256), specifies that the user can close the control's filter bar ( removes the control's filter ) by clicking the close button of the filter bar or by pressing the CTRL + F, while the control's filter bar is visible. If no filter bar is displayed, the user can display the control's filter bar by pressing the CTRL + F key. While the control's filter bar is visible the user can navigate though the list or control's filter bar using the ALT + Up/Down keys. If missing, the control's filter bar is always shown if any of the following flags is present exFilterBarPromptVisible, exFilterBarVisible, exFilterBarCaptionVisible. * exFilterBarShowCloseIfRequired(512), indicates that the close button of the control's filter bar is displayed only if the control has any currently filter applied. * exFilterBarShowCloseOnRight(1024), specifies that the close button of the control's filter bar should be displayed on the right side. * exFilterBarCompact(2048), compacts the control's filter bar, so the filter-prompt will be displayed to the left, while the control's filter bar caption will be displayed to the right. This flag has effect only if combined with the exFilterBarPromptVisible. This flag can be combined with the exFilterBarSingleLine flag, so all filter bar will be displayed compact and on a single line. * exFilterBarShort(4096), specifies that the control's filter bar is displayed only on the default-view (has effect if the control displays multiple views). * * @example * * 0 or exontrol.Tree.FilterBarVisibleEnum.exFilterBarHidden {number}, (default) the control's filter-bar is visible only if there is a filter applied. * 1 or exontrol.Tree.FilterBarVisibleEnum.exFilterBarPromptVisible {number}, the control's filter-bar is visible and shows the control's filter-prompt */ filterBarVisible: exontrol.Tree.FilterBarVisibleEnum.exFilterBarHidden, /** * @description The filterBarCaption field customizes the caption shown within the control's filter-bar * @type {string} Defines the caption (supports expressions and ex-HTML) to show within the control's filter-bar. * * The filterBarCaption expresasion supports the following keywords, constants, operators and functions: * * "value" or "current", returns the current filter as a string. At runtime the value may return a string such as "[EmployeeID] = '4| 5| 6' and [ShipVia] = 1", so the control automatically applies HTML format, which you can change it. For instance, "upper(value)" displays the caption in uppercase or "value replace `` with `` replace `` with `
`" displays the column's name with a different foreground color. * "itemcount", returns the total number of items as indicated by ItemCount property. At runtime the itemcount is a positive integer that indicates the count of all items. For instance, "value + `Total: ` + itemcount" includes in the filter bar the number of items aligned to the right. * "visibleitemcount", returns the number of visible items as indicated by VisibleItemCount property. At runtime, the visibleitemcount is a positive integer if no filter is applied, and negative if a filter is applied. If positive, it indicates the number of visible items. The visible items does not include child items of a collapsed item. If negative, a filter is applied, and the absolute value minus one, indicates the number of visible items after filter is applied. 0 indicates no visible items, while -1 indicates that a filter is applied, but no item matches the filter criteria. For instance, "value + `` + ( visibleitemcount < 0 ? ( `Result: ` + ( abs(visibleitemcount) - 1 ) ) : ( `Visible: ` + visibleitemcount ) )" includes "Visible: " plus number of visible items, if no filter is applied or "Result: " plus number of visible items, if filter is applied, aligned to the right * "matchitemcount", returns the number of items that match the filter as indicated by MatchItemCount property. At runtime, the matchitemcount is a positive integer if no filter is applied, and negative if a filter is applied. If positive, it indicates the number of items within the control (ItemCount property). If negative, a filter is applied, and the absolute value minus one, indicates the number of matching items after filter is applied. A matching item includes its parent items, if the control's FilterInclude property allows including child items. 0 indicates no visible items, while -1 indicates that a filter is applied, but no item matches the filter criteria. For instance, "value + `` + ( matchitemcount < 0 ? ( `Result: ` + ( abs(matchitemcount) - 1 ) ) : ( `Visible: ` + matchitemcount ) )" includes "Visible: " plus number of visible items, if no filter is applied or "Result: " plus number of macthing items, if filter is applied, aligned to the right * "leafitemcount", returns the number of leaf-items. A leaf item is an item with no child items. At runtime, the leafitemcount is a positive number that computes the number of leaf-items ( expanded or collapsed ). For instance, the "value + `` + leafitemcount" displays the number of leaf-items aligned to the right with a different font and foreground color. * "promptpattern", returns the pattern in the filter bar's prompt, as a string. The FilterBarPromptPattern specifies the pattern for the filter prompt. The control's filter bar prompt is visible, if the exFilterBarPromptVisible flag is included in the FilterBarPromptVisible property. * "available", returns the list of columns that are not currently part of the control's filter, but are available to be filtered. A column is available to be filtered, if the DisplayFilterButton property of the Column object, is True. At runtime, the available keyword may return a string such as "[OrderDate] [RequiredDate] [ShippedDate] [ShipCountry] [Select]
", so the control automatically applies HTML format, which you can change it. For instance, "value + ` ` + available", displays the current filter, including all available columns to be filtered. For instance, the "value + `` + available replace `C0C0C0` with `FF0000`" displays the available columns aligned to the right with a different foreground color. * "allui", returns the list of columns that are part of the current filter and available columns to be filtered. A column is available to be filtered, if the DisplayFilterButton property of the Column object, is True. At runtime, the allui keyword may return a string such as "[EmployeeID] = '4| 5| 6' [OrderDate]
[RequiredDate]
[ShippedDate]
[ShipVia] = 1 [ShipCountry] [Select]", so the control automatically applies HTML format, which you can change it. For instance, "allui", displays the current filter, including all available columns to be filtered. For instance, the "((allui + `` + ( matchitemcount < 0 ? ( ( len(allui) ? `` : `` ) + `` + abs(matchitemcount + 1) + ` result(s)` ) : (``+ itemcount + ` item(s)`) )) replace `[` with ` ` replace `]` with ` ` replace `[` with ` ` replace `]` with ` ` )" displays all available columns to be filtered with different background/foreground colors including the number of items/results * "all", returns the list of all columns ( visible or hidden ) no matter if the DisplayFilterButton property is True or False. At runtime, the all keyword may return a string such as "[OrderID] [EmployeeID] = '4| 5| 6' [OrderDate] [RequiredDate]", so the control automatically applies HTML format, which you can change it. For instance, "all", displays the current filter, including all other columns. For instance, the "((all + `` + ( matchitemcount < 0 ? ( ( len(allui) ? `` : `` ) + `` + abs(matchitemcount + 1) + ` result(s)` ) : (``+ itemcount + ` item(s)`) )) replace `[` with ` ` replace `]` with ` ` replace `[` with ` ` replace `]` with ` ` )" displays all columns with different background/foreground colors including the number of items/results * * @example * * "" {string}, displays no filter bar while no filter is applied, else it displays the filter as default * "no filter" {string}, shows no filter caption all the time * "allui" {string}, displays all available columns (column's DisplayFilterButton property is true) * "value replace ` and ` with ` and ` replace `|` with ` or ` replace ` ` with ` `" {string}, replaces the AND and | values * "value replace `[` with ` ` replace `]` with ` `" {string}, highlights the columns being filtered with a different background/foreground colors. * */ //filterBarCaption: "(( ( current replace `[` with ` ` replace `]` with ` ` ) + ` ` + ( available replace `[` with ` ` replace `]` with ` ` replace `` with `` replace `` with `` ) + `` + ( matchitemcount < 0 ? ( ( len(value) ? `` : `` ) + `` + abs(matchitemcount + 1) + ` result(s)` ) : (``+ itemcount + ` item(s)`) )))", filterBarCaption: "(( ( current replace `[` with ` ` replace `]` with ` ` ) + `` + ( matchitemcount < 0 ? ( ( len(value) ? `` : `` ) + `` + abs(matchitemcount + 1) + ` result(s)` ) : (``+ itemcount + ` item(s)`) )))", /** * @description The filterBarPrompt field specifies the caption to show while the pattern of the filter-prompt is empty * @type {string} Defines the caption (supports ex-HTML) to show while the pattern of the filter-prompt is empty * @example * * "" {string}, displays no caption (while the pattern of the filter-prompt is empty) * "filter..." {string}, displays the message "filter..." in italics */ filterBarPrompt: "Start Filter...", /** * @description The filterBarPromptPattern field defines the filter-pattern for the control's filter-prompt * @type {string} Defines the pattern for the control's filter-prompt. * * Based on the filterBarPromptType field the filterBarPromptPattern field defines how the pattern filters for items as explained below: * * filters for items that includes all of the sequences within the filter-pattern (exFilterPromptContainsAll) * filters for items that includes any of the sequences within the filter-pattern (exFilterPromptContainsAny) * filters for items that starts with any of the sequences within the filter-pattern (exFilterPromptStartWith) * filters for items that ends with any of the sequences within the filter-pattern (exFilterPromptEndWith) * filters for items that that matches the filter-pattern, which may includes wild-characters such as ?, * or # (exFilterPromptPattern) * * @example * * "" {string}, clears the pattern of the filter-prompt * "A" {string}, filters for items includes "A" (exFilterPromptContainsAll) * "A* *B" {string}, filters for items start starts with "A" or ends with "B" (exFilterPromptPattern) */ filterBarPromptPattern: "", /** * @description The filterBarPromptType field defines the type of control's filter-prompt (filterBarPromptPattern field) * @type {exontrol.Tree.FilterPromptEnum} Defines the type of control's filter-prompt. * * The exontrol.Tree.FilterPromptEnum type supports the following flags: * * exFilterPromptContainsAll(1), the list includes the items that contains all specified sequences in the filter. Can be combined with exFilterPromptCaseSensitive, exFilterPromptStartWords, exFilterPromptEndWords or exFilterPromptWords * exFilterPromptContainsAny(2), the list includes the items that contains any of specified sequences in the filter. Can be combined with exFilterPromptCaseSensitive, exFilterPromptStartWords, exFilterPromptEndWords or exFilterPromptWords * exFilterPromptStartWith(3), the list includes the items that starts with any specified sequences in the filter. Can be combined with exFilterPromptCaseSensitive, exFilterPromptStartWords, exFilterPromptEndWords or exFilterPromptWords * exFilterPromptEndWith(4), the list includes the items that ends with any specified sequences in the filter. Can be combined with exFilterPromptCaseSensitive, exFilterPromptStartWords, exFilterPromptEndWords or exFilterPromptWords * exFilterPromptPattern(16), the filter indicates a pattern that may include wild characters to be used to filter the items in the list. Can be combined with exFilterPromptCaseSensitive. The filterBarPromptPattern field may include wild characters as follows: * * '?' for any single character * '*' for zero or more occurrences of any character * '#' for any digit character * ' ' space delimits the patterns inside the filter * * exFilterPromptCaseSensitive(0x0100), filtering the list is case sensitive. Can be combined with exFilterPromptContainsAll, exFilterPromptContainsAny, exFilterPromptStartWith, exFilterPromptEndWith or exFilterPromptPattern. * exFilterPromptStartWords(0x1200), the list includes the items that starts with specified words, in any position. Can be combined with exFilterPromptContainsAll, exFilterPromptContainsAny, exFilterPromptStartWith or exFilterPromptEndWith. * exFilterPromptEndWords(0x2200), the list includes the items that ends with specified words, in any position. Can be combined with exFilterPromptContainsAll, exFilterPromptContainsAny, exFilterPromptStartWith or exFilterPromptEndWith. * exFilterPromptWords(0x3200), the filter indicates a list of words. Can be combined with exFilterPromptContainsAll, exFilterPromptContainsAny, exFilterPromptStartWith or exFilterPromptEndWith. * * @example * * 2 or exontrol.Tree.FilterPromptEnum.exFilterPromptContainsAny {number}, filters for items that contains any sequences in the filter * 0x3202 or exontrol.Tree.FilterPromptEnum.exFilterPromptContainsAny | exontrol.Tree.FilterPromptEnum.exFilterPromptWords {number}, filters for items that contains any words in the filter * 0x3203 or exontrol.Tree.FilterPromptEnum.exFilterPromptStartWith | exontrol.Tree.FilterPromptEnum.exFilterPromptWords {number}, filters for items that starts with any word within the filter */ filterBarPromptType: exontrol.Tree.FilterPromptEnum.exFilterPromptContainsAll, /** * @description The filterBarPromptColumns field defines the list of columns the pattern of filter-prompt is applying to * @type {any} Specifies the list of columns the pattern of filter-prompt is applying to (as explained below): * * null {null} or -1 {number}, all columns (visible or hidden) * {number}, specifies the index of the column * {string}, specifies a list of index/identifier/key/caption/plain-caption, separated by comma character * {exontrol.Tree.Column}, specifies the column reference * * @example * * null {null}, the pattern of filter-prompt is applying to all columns (visible or hidden) * 1 {number}, the pattern of filter-prompt is applying to a single-column only (the column wiht the index 1) * "ID,Name" {string}, the pattern of filter-prompt is applying to columns "ID" and "Name" only */ filterBarPromptColumns: -1, /** * @description The drawGridLines field specifies whether the control's grid-lines are shown or hidden. * @type {exontrol.Tree.GridLinesEnum} Shows or hides the control's grid-lines. The gridLines field defines the color, width and style of the control's grid-lines. * * The exontrol.Tree.GridLinesEnum type supports the following flags: * * exNoLines(0), no grid lines * exAllLines(-1), shows all vertical and horizontal grid lines * exRowLines(-2), shows grid lines for existing rows only * exHLines(1), shows only the horizontal grid lines * exVLines(2), shows only the vertical grid lines * * @example * * 0 or exontrol.Tree.GridLinesEnum.exNoLines {number}, hides the grid-lines (default) * -1 or exontrol.Tree.GridLinesEnum.exAllLines {number}, shows all vertical and horizontal grid lines */ drawGridLines: exontrol.Tree.GridLinesEnum.exNoLines, /** * @description The gridLines field defines the color, width and style of the control's grid-lines. * @type {object} Defines the color, width and style of the control's grid-lines. * * The gridLines object includes any of the following: * * width {number}, specifies the line's width or size (1 by default) * color {string}, indicates the line's color (partial-black by default) * style {array}, specifies the dash pattern to show the lines (dotted by default) */ gridLines: { /** * @description The width field defines the size/width of the line. * @type {number} Specifies the size/width of the line. * @example * * null {null}, indicates line of 1-pixel wide * 2 {number}, indicates line of 2-pixels wide */ width: undefined, /** * @description The color field specifies the color to show the line * @type {string} Defines the color of the line as a CSS color format * @example * * null {null}, indicates a black line * "transparent" {string}, specifies a transparent line * "red" {string}, specifies a red line * "#00FF00" {string}, specifies a green line * "rgba(255,0,0,0.5)" {string}, indicates 50% red line */ color: "rgb(196,196,196)", /** * @description The style field defines the style of the line * @type {array} An Array of numbers which specify distances to alternately draw a line and a gap. If the number of elements in the array is odd, the elements of the array get copied and concatenated. * @example * * null {null} or [] {array}, defines solid grid-lines * 2 {number}, becomes [2, 2, ...] * [5, 15, 25] {array}, becomes [5, 15, 25, 5, 15, 25, ...] */ style: 1 }, /** * @description The defaultItemHeight field defines the item's default height * @type {number} Indicates the item's default height * @example * * null {null}, specifies that the item's height is 24 (by default) * 18 {number}, changes the item's default height to 18 */ defaultItemHeight: 24, /** * @description The treeColumnIndex field specifies the index or identifier/key/caption of the column that displays the hierarchy. * @type {number} Indicates the index or identifier/key/caption of the column that displays the hierarchy * @example * * null {null}, no column displays the hierarchy. * 0 {number}, the column with the index 0, displays the hierarchy (displays the expand/collapse glyphs) * "xxx" {string}, the column with the key or plain-caption on "xxx" displays the hierarchy. */ treeColumnIndex: 0, /** * @description The expandOnDblClick field specifies whether the item is expanded or collapsed once the user double-clicks the item * @type {boolean} Specifies whether the item is expanded or collapsed once the user double-clicks the item * @example * * false {boolean}, the item is not expanded or collapsed once the user double-clicks it * true {boolean}, the item is expanded or collapsed once the user double-clicks it */ expandOnDblClick: true, /** * @description The itemAllowSizing field specifies whether all or none of the items are resizable or fixed * @type {boolean} Specifies whether all or none of the items are resizable or fixed * @example * * false {boolean}, none of the items are resizable (unless the item's allowSizing field is true) * true {boolean}, all of the items are resizable (unless the item's allowSizing field is false) */ itemAllowSizing: false, /** * @description The ensureOnSort field ensures that the selection (including the parent-items) fits the view's client-area once the user sorts or groups a column * @type {boolean} Specifies whether the selection fits the view's client-area once the user sorts or groups a column * @example * * false {boolean}, no effect * true {boolean}, scrolls the view, so the selection (including the parent-items) fits the view's client area */ ensureOnSort: true, /** * @description The showLockedItems field indicates whether the locked/fixed items are visible or hidden * @type {boolean} Specifies whether the locked/fixed items are visible or hidden * @example * * false {boolean}, the control's locked/fixed items are not shown * true {boolean}, the control's locked/fixed items are visible */ showLockedItems: true, /** * @description The allowDrop field specifies whether the user can drag and drop local files into the control. * @type {boolean} * @example * * false {boolean}, no file can be drop into the control * true {boolean}, the user can drag and drop files into the control */ allowDrop: true, /** * @description The onErrorChooseFile field specifies whether the control displays an input-file to let user choose a local filte to import, as soon as an error occurs * @type {boolean} Specifies whether the control displays an input-file to let user choose a local filte to import, as soon as an error occurs * @example * * false {boolean}, no input-file is displayed as soon an error occurs * true {boolean}, the control displays an input-file to let user choose a local filte to import, as soon as an error occurs */ onErrorChooseFile: true, /** * @description The scrollPos field defines the horizontal and vertical scroll-position of the control's default view. * @type {object} Specifies an object of {x,y} type that defines the control's horizontal and vertical scroll-position as explained: * * x {number}, indicates the horizontal scroll-position * y {number}, indicates the vertical scroll-position * * @example * * {x: 100} {object}, scrolls horizontally to position 100 * {x: 100, y: 50} {object}, scrolls horizontally to position 100, and vertically to 50 */ scrollPos: { /** * @description The x field defines the horizontal scroll-position of the control's default view. * @type {number} Indicates the horizontal scroll-position of the control's default view. * * @example * * 100 {number}, scrolls horizontally to position 100 * */ x: undefined, /** * @description The y field defines the vertical scroll-position of the control's default view. * @type {number} Indicates the vertical scroll-position of the control's default view. * * @example * * 50 {number}, scrolls vertical to position 50 * */ y: undefined }, /** * @description The toolTipDelay field specifies how long the mouse pointer must point to an object before the tool tip appears * @type {number} Specifies how long the mouse pointer must point to an object before the tool tip appears * @example * * 0 {number}, the tooltip is shown "immediately" * 128 {number}, the tooltip is displayed in 128 ms. */ toolTipDelay: 500, /** * @description The toolTipPopDelay field specifies the period in ms of time the tool top remains visible if the mouse pointer is stationary within a control * @type {number} Specifies the period in ms of time the tool top remains visible if the mouse pointer is stationary within a control * @example * * 0 {number}, no tooltip is shown for any object (disabled) * -1 {number}, the tooltip stays indefinitely (negative) * 1000 {number}, the tooltip is visible for 1 second */ toolTipPopDelay: 5000, /** * @description The toolTipWidth field indicates the max-width of the control's tooltip (in pixels) * @type {number} Specifies the width of the control's tooltip * @example * * 0 {number}, no tooltip is shown for any object (disabled) * -1 {number}, the tooltip's content is displayed on a single line (without limit the width of it) * 300 {number}, the tooltip's max-width is 300 pixels */ toolTipWidth: -1, /** * @description The pivotBarVisible field shows or hides the control's pivot bar (it displays the layout of the pivot-table) * @type {exontrol.Pivot.PivotBarVisibleEnum} Specifies whether the control's pivot bar is visible or hidden * * The exontrol.Pivot.PivotBarVisibleEnum type supports the following values: * * exPivotBarHidden(0), the pivot bar is hidden. * exPivotBarVisible(1), the pivot bar is visible. include or exclude this flag to show or hide the pivot bar. * exPivotBarSizable(2), the pivot bar is sizable. Include or exclude this flag to allow or prevent resizing the pivot bar at runtime. If this flag is present, the user can resize the pivot bar by dragging the bottom side of the control. The resize cursor is shown when the pivot bar is resizable and cursor hovers the bottom side of the pivot bar. * exPivotBarFloat(4), the pivot bar is shown into a floating window. Include this flag, to display the pivot bar to a separate window (a floating panel) * exPivotBarAutoFit(8), the pivot bar's size is updated automatically so all elements fits the client area (When this flag is present, the height of the pivot's bar is automatically adjusted so the entire content fits the header). * exPivotBarShowTotals(16), the pivot bar shows the Total/SubTotal fields. Include or exclude this flag to show or hide the Total field in the pivot bar. * exPivotBarAutoHide(32), shows the pivotbar as soon as the cursor hovers it, and hides it as soon as the cursor leaves it * exPivotBarAllowValues(64), specifies if the user can drop values of the columns to the pivot bar. * exPivotBarAllowFormatAppearance(128), specifies if the user can select a different appearance for columns or total/subtotal fields. * exPivotBarAllowFormatConditionalAppearance(0x1000000), specifies if the user can select conditional appearance for columns. * exPivotBarAllowFormatContent(256), specifies if the user can select the way the column's data is displayed. * exPivotBarAutoUpdate(512), indicates whether the control' list (pivot-table) is automatically updated once the user drops objects in the pivot bar. Exclude this flag from the pivotBarVisible property, and so the Refresh button is shown in the bottom side of the control, and the changes will be applied to the control's list once the user clicks the Refresh button. Once the data is updated, the buttons shows as disabled until next change occurs. * exPivotBarAllowUndoRedo(1024), indicates if the pivot bar allows Undo/Redo operations, if the user presses the CTRL+Z/Y. The control restores the previously layout once the user presses the CTRL + Z keys combination. The control restores the next layout once the user presses the CTRL + Y keys combination. Exclude this flag, and the Undo/Redo feature is disabled. * exPivotBarAllowResizeColumns(2048), indicates if the user can resize the columns in the pivot bar. This flag affects the columns to be displayed din the pivot bar, not the columns to be displayed in the control's list. * exPivotBarHideAddNew(4096), prevents showing the add new buttons in the pivot bar. Clicking the Add New button displays a list of columns or aggregate functions that can be added in the current context. * exPivotBarContextSortAscending(0x10000), shows the columns alphabetically in ascending order. This flag can be combined with exPivotBarContextSortReverse and so, the columns will be alphabetically displayed in descending order. * exPivotBarContextSortReverse(0x100000), shows the columns in reverse order. This flag can be combined with exPivotBarContextSortAscending and so, the columns will be alphabetically displayed in descending order. * exPivotBarReadOnly(0x10000000), makes the pivot bar read only, so no changes are allowed * * @example * * false {boolean} or 0 {number}, the control's pivotbar is hidden * 0x10000000 or exontrol.Pivot.PivotBarVisibleEnum.exPivotBarReadOnly {number}, shows a read-only pivot bar (no changes are allowed) */ pivotBarVisible: exontrol.Pivot.PivotBarVisibleEnum.exPivotBarVisible | exontrol.Pivot.PivotBarVisibleEnum.exPivotBarSizable | exontrol.Pivot.PivotBarVisibleEnum.exPivotBarAutoFit | exontrol.Pivot.PivotBarVisibleEnum.exPivotBarShowTotals | exontrol.Pivot.PivotBarVisibleEnum.exPivotBarAllowValues | exontrol.Pivot.PivotBarVisibleEnum.exPivotBarAllowFormatAppearance | exontrol.Pivot.PivotBarVisibleEnum.exPivotBarAllowFormatConditionalAppearance | exontrol.Pivot.PivotBarVisibleEnum.exPivotBarAllowFormatContent | exontrol.Pivot.PivotBarVisibleEnum.exPivotBarAutoUpdate | exontrol.Pivot.PivotBarVisibleEnum.exPivotBarAllowUndoRedo | exontrol.Pivot.PivotBarVisibleEnum.exPivotBarAllowResizeColumns, /** * @description The pivotColumnsFloatBarVisible field specifies whether the window that displays the pivot-columns is visible or hidden (it displays the columns that can used to build the pivot-table) * @type {exontrol.Tree.ColumnsFloatBarVisibleEnum} Specifies whether the window that displays the pivot-columns is visible or hidden * * The exontrol.Tree.ColumnsFloatBarVisibleEnum type supports the following values: * * exColumnsFloatBarHidden(0), the pivot-columns floatbar is hidden * exColumnsFloatBarVisible(1), the pivot-columns floatbar is visible. This flag can be combined with exColumnsFloatBarFloat flag, to show the pivot-columns floatbar as floated * exColumnsFloatBarFloat(0x100), the pivot-columns floatbar is shows as floated. This flag can be combined with exColumnsFloatBarVisible type. * * @example * * false {boolean} or 0 {number}, the control shows no pivot-columns floatbar * true {boolean} or 1 {number}, the control shows the pivot-columns floatbar * 0x101 or exontrol.Tree.ColumnsFloatBarVisibleEnum.exColumnsFloatBarVisible | exontrol.Tree.ColumnsFloatBarVisibleEnum.exColumnsFloatBarFloat {number}, the control's pivot-columns floatbar is visible and floated */ pivotColumnsFloatBarVisible: exontrol.Tree.ColumnsFloatBarVisibleEnum.exColumnsFloatBarVisible, /** * @description The pivotRows field specifies the list of group-by columns that determines the rows in the pivot-table * @type {string} specifies the list of group-by columns that determines the rows in the pivot-table * * The pivotRows in BNF notation is: * * pivotRows ::= "[,]" * Column ::= <Index>[:][<Options>] * Index ::= [] * Digit ::= 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 * Order ::= A | D * Options ::= \[<Option> | ,<Option>\] * Option ::= <CheckOption> | content=<RadioOption> * * where * * Index, is the index of the column * CheckOption is any Key in the FormatAppearances collection * RadioOption is any Key in the FormatContents collection * * @example * * "" {string}, displays the source-data * "0,1:D[bold]" {string}, displays the pivot-table that groups by 0(ascending) and 1(descending) columns, and values of column 1 are shown in bold */ pivotRows: "", /** * @description The pivotColumns specifies the list of columns to be displayed in the pivot-table * @type {string} specifies the list of columns to be displayed in the pivot-table * * The pivotColumns in BNF notation is: * * pivotColumns ::= "<Aggregate>[,<Aggregate>]" * Aggregate ::= <AggregateKey>(<Index>)[<Options>] | <AggregateKey>(<Index>)[<Options>]/<Index>[:][<Options>][;<Index>[:][<Options>]] * Index ::= [] * Digit ::= 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 * Order ::= A | D * Options ::= \[<Option> | ,<Option>\] * Option ::= <CheckOption> | content=<RadioOption> * * where * * Index, is the index of the column * CheckOption is any Key in the FormatAppearances collection * RadioOption is any Key in the FormatContents collection * AggregateKey, is any Key in the Aggregates collection * * @example * * "sum(5)" {string}, adds a single column that displays the sum of data column with the index 5 * "sum(5)[content=numeric]/12" {string}, adds a column for each unique value found in the data column with the index 12, and each column displays the sum of data column with the index 5 as numeric, associated with the value of the data column * "sum(5)[content=numeric]/12;6" {string}, groups by data columns with the index 12 and 6, and adds a new column for each unique value found, by displaying the sum of data column with the index 5 as numeric, for the associated values in the data columns * "sum(5)[bold,content=numeric],sum(5)[content=numeric]/12;6" string, adds a single column that displays the sum of data column with the index 5 in bold as numeric, and follows the group-by data columns shown earlier */ pivotColumns: "", /** * @description The pivotTotals indicates the list of totals/subtotals to be shown in the pivot-table. * @type {string} indicates the list of totals/subtotals to be shown in the pivot-table * * The pivotTotals in BNF notation is: * * pivotTotals ::= "<Part> | <Part>/<Part>" * Part ::= "<Aggregate>[,<Aggregate>]" * Aggregate ::= <AggregateKey>[<Options>] | <AggregateKey>(<Index>)[<Options>] * Index ::= [] * Digit ::= 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 * Options ::= \[<Option>|,<Option>\] * Option ::= <CheckOption>|content=<RadioOption> * * where * * Index, is the index of the column * CheckOption is any Key in the FormatAppearances collection * RadioOption is any Key in the FormatContents collection * AggregateKey, is any Key in the Aggregates collection * * @example * * "sum" {string}, adds a total-row (adds the values within each column and shows up the result) * "max/min" {string}, adds a min-row to show up and a max-row to show down */ pivotTotals: "", /** * @description The showDataOnDblClick field specifies whether the control shows the original data that generated the result when the user double clicks the item * @type {boolean} Indicates whether the control shows the original data that generated the result when the user double clicks the item * @example * * false {boolean}, no effect, instead the expandOnDblClick has effect (specifies whether the item is expanded or collapsed once the user double-clicks the item) * true {boolean}, the control displays the original data that generated the result, as soon as user double-clicks the item (expandOnDblClick has no effect) */ showDataOnDblClick: true, /** * @description The displayPivotFields field defines the maximum number of columns to be displayed on the control's list * @type {number} Specifies the number of maximum columns to be added during the execution of the current layout. * @example * * 0 {number}, the control displays no pivot-columns * 256 {number}, the control displays maximum 256 pivot-columns * -1 {number}, there is no limit for generated pivot-columns */ displayPivotFields: 256, /** * @description The displayPivotRows field defines the maximum number of rows to be displayed on the control's list * @type {number} Specifies the number of maximum rows to be added during the execution of the current layout. * @example * * 0 {number}, the control displays no generated-rows * 16384 {number}, the control displays maximum 16384 rows * -1 {number}, there is no limit for generated rows */ displayPivotRows: 16384, /** * @description The formatPivotHeader field specifies the format to display the columns within the pivot bar * @type {string} Specifies the format to display the columns in the pivot bar * * The formatPivotHeader property supports the following keywords: * * aggregate {string}, specifies the name of the aggregate-function associated with the column, or empty, for pivot-rows columns * ilevel {number}, indicates the index of the level where the aggregate-function is shown. This is valid for total-rows only, else it is -1 * caption {string}, indicates the original-caption of the column * icaption {number}, specifies the index of the column * display {number}, specifies whether the caption is shown on the control's pivot bar (0), or in the columns header(1) * * @example * * "" {string}, no caption is displayed for any of columns within the pivot bar * "lower(aggregate and caption ? ('' + aggregate + '(' + caption + ')') : aggregate or caption)" {string}, shows the aggregate-function in gray and the column between parenthesis * "(aggregate = 'sum' ? 'Σ' : aggregate) + (aggregate and caption ? '(':'') + caption + (aggregate and caption ? ')':'') + (aggregate = 'sum' ? '' : '')", shows sigma-character instead of Sum of */ formatPivotHeader : "ilevel >= 0 ? (aggregate = `sum` ? (ilevel > 1 ? `Subtotal` : `Total`) : proper(aggregate)) : (aggregate and caption ? (proper(aggregate) + ' of ' + caption) : proper(aggregate) or caption)" } /////////////////////////////////////////////////////////// (exontrol.Tree.EditOptions) // // The exontrol.Tree.EditOptions type holds options to apply on the input element while editing the cell // // The exontrol.Tree.EditOptions type defines the following fields: // // change {boolean}, specifies whether the cell's value is updated as soon as user types into the element. // ttc {number}, indicates the time in ms to wait until cell's value is changed once the user alters the text within the element (should be used when change field is specified) // inner {object}, specifies an object whose properties (recursively) are applied to inner HTML-element // view {object}, specifies the view where the element should be displayed. The view field has no effect, if the control displays a single view. // thisArg {any}, indicates the value of "this" keyword during the validate callback (if not specified the thisArg refers to the current cell as an object of exontrol.Tree.Cell type) // validate {callback}, defines a function of callback(value) {boolean} type that validates the newly value // /////////////////////////////////////////////////////////// exontrol.Tree.EditOptions = { /** * @description The change field specifies whether the cell's value is updated as soon as user types into the element. * @type {boolean} Defines whether the cell's value is updated as soon as user types into the element. If the change field is missing/null/undefined/0/false the cell's value is updated as soon as user clicks outside of the element, or presses Enter key * @example * * false {boolean}, the cell's value is updated as soon as user clicks outside of the element, or presses Enter key (default) * true {boolean}, the cell's value is updated (invalidates the view's conditional format, computed fields, and so on) as soon as user types into the element (based on the ttc field) */ change: null, /** * @description The ttc field indicates the time in ms to wait until cell's value is changed once the user alters the text within the element * @type {number} Defines the time in ms to wait until cell's value is changed once the user alters the text within the element (has effect only if change field is specified/true) * @example * * 0 {number}, the cell's value is updated (invalidates the view's conditional format, computed fields, and so on) as soon as user types into the element * 1000 {number}, the cell's value is updated (invalidates the view's conditional format, computed fields, and so on) as soon as user types into the element, after 1 second */ ttc: null, /** * @description The inner field specifies an object whose properties (recursively) are applied to inner HTML-element * @type {object} Defines an object whose properties (recursively) are applied to inner HTML-element */ inner: { /** * @description The value field defines the default value of an element * @type {any} Defines the input's default value when edit begins (if not specified, the cell's value is used instead) * @example * * "1234" {string}, displays "1234" as soon as edit starts */ value: null, /** * @description The type field specifies the style of the element * @type {string} Indicates the style of the element * @example * * "number" {string}, defines a field for entering a number. * "range" {string}, defines a control for entering a number whose exact value is not important (like a slider control). * "password" {string}, defines a field for entering a password. */ type: null, /** * @description The style field holds CSS properties to apply to the input element * @type {object} Specifies an object that defines the CSS properties to apply to the input element */ style: { /** * @description The background field sets the input's background color * @type {string} Specifies the input's background color * @example * * "red" {string}, shows the input's background in red * "rgba(255,0,0,0.5)" {string}, shows the input's background in partial-red */ background: null, /** * @description The color field sets the input's foreground color * @type {string} Specifies the input's foreground color * @example * * "blue" {string}, shows the input's foreground in blue * "rgba(0,0,255,0.5)" {string}, shows the input's foreground in partial-blue */ color: null, /** * @description The font field specifies the font to display text within the input element * @type {string} Specifies the font to display text within the input element * @example * * "italic bold 12px Georgia" {string}, defines a different font to display */ font: null, /** * @description The border field sets the style of the input's border * @type {string} Specifies the style of the input's border * @example * * "1px solid blue" {string}, shows a blue solid-border color arround the input element * "2px inset" {string}, shows "inset" border arround the input element */ border: null, /** * @description The padding field sets the space between input's content and its border * @type {string} Specifies the space between input's content and its border * @example * * "2px" {string}, all four paddings are 2px */ padding: null } }, /** * @description The view field specifies the view where the element should be displayed. The view field has no effect, if the control displays a single view. * @type {object} An object of exontrol.Tree.TV type. Use the AddTreeView() method to add a new view to the control. You can use the onclick event's "view" field to specify the view where the edit is displayed. */ view: null, /** * @description The thisArg field indicates the value of "this" keyword during the validate callback. * @type {any} Specifies the value of "this" keyword during the validate callback (if not specified the thisArg refers to the current cell as an object of exontrol.Tree.Cell type) */ thisArg: null, /** * @description The validate field defines a function of callback(value) {boolean} type that validates the newly value. * @type {callback} defines a function of callback(value) {boolean} type. The new value is validated if the function returns true, else the value is not validated and so no change occurs within the cell's value. * @example * * function(value) { return value < 10; } {callback} validates only values less than 10 (in other words the cell's value is changed only if the value is less than 10) * function(value) { return this.SetValue(Math.min(10, value)) || true; } {callback}, validates any value, but always ensures that's not greater than 10 */ validate: null }; /////////////////////////////////////////////////////////// (exontrol.Tree.ExportOptions) // // The exontrol.Tree.ExportOptions type defines options to export the control's data into CSV format. A comma-separated values (CSV) file is a delimited text file that uses a comma to separate values. Each line of the file is a data record. Each record consists of one or more fields, separated by commas // // The exontrol.Tree.ExportOptions type supports the following fields: // // items {string}, specifies the items to export as one of the following values: // // "all", exports all items, including the hidden or collapsed items // "vis", exports only visible items ( child items of a collapsed item, or not-visible items ( item's height is 0 ) are not exported ) // "sel", exports only selected items // "chk", exports only checked items (within the first column of columns field, else column with the index 0) // // columns {any}, specifies a list of columns to export as explained below: // // columns {null}, exports all columns of the control // columns {number}, indicates a numeric value that defines the index of the column to export // columns {string}, specifies a list of index/identifier/key/caption/plain-caption, separated by comma character // columns {exontrol.Tree.Column}, specifies the object reference to the column to export // // rtrim {boolean}, specifies whether undefined values on the right of each row/item are excluded from the export data (specifies whether the number of fields within the lines is constant or variable) // format {string}, determines the type of data the Export() method returns // eor {string}, specifies the characters the row/item/line ends (has effect only if format field is "CSV") // eof {string}, specifies the character to separate fields within the row/item/line (has effect only if format field is "CSV") // str {string}, specifies the character to quote values (has effect only if format field is "CSV") // /////////////////////////////////////////////////////////// exontrol.Tree.ExportOptions = { /** * @description The items field specifies the items to export. * @type {string} The items field can be one of the following value: * * "all", exports all items, including the hidden or collapsed items * "vis", exports only visible items ( child items of a collapsed item, or not-visible items ( item's height is 0 ) are not exported ) * "sel", exports only selected items * "chk", exports only checked items (within the first column of columns field, else column with the index 0) * * @example * * "", exports nothing * "sel", exports only selected items */ items: null, /** * @description The columns field specifies a list of columns to export * @type {any} Specifies the list of columns to export. The columns can be one of the following: * * columns {null}, exports all columns of the control * columns {number}, indicates a numeric value that defines the index of the column to export * columns {string}, specifies a list of index/identifier/key/caption/plain-caption, separated by comma character * columns {exontrol.Tree.Column}, specifies the object reference to the column to export * * @example * * null {null}, exports all columns of the control * 0 {number}, exports the first column only * "C1,C2" {string}, exports the columns C1 and C2 */ columns: null, /** * @description The rtrim field includes or excludes undefined values from right of each row/item/line * @type {boolean} Specifies a boolean value to include or exclude undefined values from right of each row/item/line * @example * * false {boolean}, all values are included in the result (generates the same number of fields on each line) * true {boolean}, undefined values on the right of each row/item/line are excluded (generates different number of fields on different lines) */ rtrim: true, /** * @description The format field determines the type of data the Export() method returns * @type {string} Specifies the type of data the Export() method returns * @example * * null {null}, specifies that the Export() method returns an array of [[value]] type * "CSV" {string}, specifies that the Export() method returns a string in CSV format */ format: null, /** * @description The eor (EndOfRow) field specifies the characters the row/item/line ends (has effect only if format field is "CSV") * @type {string} Specifies the end of the row/item/line * @example * * ";" {string}, specifies that the ; character to end each row/item/line */ eor: "\r\n", /** * @description The eof (EndOfField) field specifies the character to separate fields within the row/item/line (has effect only if format field is "CSV") * @type {string} Specifies the character to separate fields within the row/item/line * @example * * "\t" {string}, specifies TAB charactar as field separator */ eof: ",", /** * @description The str field specifies the character to quote values (has effect only if format field is "CSV") * @type {string} Specifies the character to quote values * @example * * "'" {string}, specifies ' character to quote any value that contains other ' or eof character */ str: "\"" } /////////////////////////////////////////////////////////// (exontrol.Tree.ImportOptions) // // The exontrol.Tree.ImportOptions type defines options to import data from CSV format. A comma-separated values (CSV) file is a delimited text file that uses a comma to separate values. Each line of the file is a data record. Each record consists of one or more fields, separated by commas // // The exontrol.Tree.ImportOptions type supports the following fields: // // columnCaption {string}, defines an expression that generates captions for new columns. // clear {boolean}, specifies whether previously data of the control is cleared // parent {any}, defines the parent item to insert data to // limit {number}, specifies the maximum number of rows/items/lines to import // format {string}, determines the format of source to import data from // eor {string}, specifies the characters the row/item/line ends (has effect only if format field is "CSV") // eof {string}, specifies the character to separate fields within the row/item/line (has effect only if format field is "CSV") // str {string}, specifies the character to quote values (has effect only if format field is "CSV") // hdr {boolean}, indicates whether the first line in data represents the control's header (has effect only if format field is "CSV") // ignoreXML {boolean}, specifies whether the file is loaded as CSV even if it is an .xml file (files of XML type) // /////////////////////////////////////////////////////////// exontrol.Tree.ImportOptions = { /** * @description The columnCaption field defines an expression that generates captions for new columns. * @type {string} A string value that defines the expression to generate captions for new columns. * * The columnCaption field supports the following keywords: * * index, returns the index of the column whose caption need to be generated * * @example * * "" {string}, no caption is provided for new columns * "`import`" {string}, all columns are named `import` * "index" {string}, the caption's index (0-based) is the caption of the column * "`Column ` + (1 + index)" {string}, generates captions such as "Column 1", "Column 2", ... where the index (1-based) is displayed in bold up to the caption * */ columnCaption: "`Column ` + (1 + index)", /** * @description The clear field specifies whether previously data of the control is cleared * @type {boolean} Indicates whether previously data of the control is cleared * @example * * false {boolean}, the control's data is not cleared by Import() method, so new data is appended * true {boolean}, the control's data is cleared before import new data */ clear: true, /** * @description The parent field defines the parent item the import data goes to. * @type {any} The parent field can be one of the following: * * parent {number}, indicates a numeric value that defines the index of the parent's item (0-based) * parent {string}, specifies a string expression that defines the identifier/key of the parent's item * parent {exontrol.Tree.Item}, specifies the object reference to the parent's item * * @example * * 0 {number}, the items to import are added as child-items of item with the index 0 */ parent: null, /** * @description The limit field specifies the maximum number of rows/items/lines to import * @type {number} Indicates the maximum number of rows/items/lines to import * @example * * undefined {undefined}, specifies unlimited number of rows/items/lines to import * 1000 {number}, limits the items to import to 1,000 */ limit: undefined, /** * @description The format field specifies the format of source to import data form * @type {string} Specifies the format of source to import data form * @example * * null {null}, specifies that the source of import is an array of [[value]] type * "CSV" {string}, specifies that the source of import is a string in CSV format */ format: null, /** * @description The eor (EndOfRow) field specifies the characters the row/item/line ends (has effect only if format field is "CSV") * @type {string} Specifies the end of the row/item/line * @example * * ";" {string}, specifies that the ; character to end each row/item/line */ eor: "\r\n", /** * @description The eof (EndOfField) field specifies the character to separate fields within the row/item/line (has effect only if format field is "CSV") * @type {string} Specifies the character to separate fields within the row/item/line * @example * * "\t" {string}, specifies TAB charactar as field separator */ eof: ",", /** * @description The str field specifies the character to quote values (has effect only if format field is "CSV") * @type {string} Specifies the character to quote values * @example * * "'" {string}, specifies ' character to quote any value that contains other ' or eof character */ str: "\"", /** * @description The hdr field specifies whether the first line indicates the control's header (has effect only if format field is "CSV") * @type {boolean} Specifies whether the first line indicates the control's header * @example * * false {boolean}, specifies the no header line is provided * true {boolean}, the first line defines the control's header */ hdr: true, /** * @description The ignoreXML field specifies whether the file is loaded as CSV even for .xml files (files of XML type) * @type {boolean} Indicates whether the data is imported as CSV or XML * @example * * false {boolean}, indicates that an .xml file is loaded using the LoadXML() method, any other file is loaded as CSV file * true {boolean}, no matter of file's extension the data is loaded as CSV file */ ignoreXML: false } /////////////////////////////////////////////////////////// (exontrol.Tree.ConditionalFormats) // // The exontrol.Tree.ConditionalFormats object holds a collection of exontrol.Tree.ConditionalFormat type. The conditional formatting // feature allows you to apply formats to a cell or range of cells, and have that formatting change depending on the value of the cell // or the value of a formula. // // The exontrol.Tree.ConditionalFormats object provides the following methods: // // Add(oConditionalFormatOpts) {exontrol.Tree.ConditionalFormat}, creates and adds a new conditional format into the control. // Count/GetCount() {number}, returns the number of conditional formats within the collection. // Item(id) {exontrol.Tree.ConditionalFormat}, gets the conditional format by index, key or reference. // Remove(id), removes the conditional format by index, key or reference. // Clear(), removes all conditional formats of the control. // /////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////// (exontrol.Tree.ConditionalFormatOptions) // // The exontrol.Tree.ConditionalFormatOptions type holds all options a conditional format can display or own // // The exontrol.Tree.ConditionalFormatOptions type defines the following fields: // // applyTo {any}, indicates whether the format is applied to items or columns. // expression {string}, defines the conditional format's expression (the condition) // enabled {boolean}, specifies whether the condition is enabled or disabled. // key {string}, specifies the key associated with the conditional format // shape {any}, defines the shape to apply on the cell or conditional format when the condition is verified // /////////////////////////////////////////////////////////// exontrol.Tree.ConditionalFormatOptions = { /** * @description The applyTo field specifies whether the conditional format is applied to items or to columns * @type {any} Indicates whether the conditional format is applied to items or to columns * @example * * null{null} or -1 {number}, the format is applied to items (negative-number) * 0 {number}, the format is applied to all cells of the conditional format with the index 0 that verify the condition * "C1,C2" {string}, the format is applied to all cells of the columns "C1" and "C2" that verify the condition */ applyTo: -1, /** * @description The expression field specifies the condition of the conditional format (no format or shape is applied if the condition is invalid or disabled) * @type {string} Specifies the condition of the conditional format * * The expression supports the following keywords: * * value, gets the value of the cell being formatted/evaluated * * The expression supports the following variables: * * %0, %1, %2, ... specifies the value of the cell in the conditional format with the index 0, 1 2, ... * %C0, %C1, %C2, ... specifies the caption of the cell, or the string the cell displays in the conditional format with the index 0, 1 2, ... * %CD0, %CD1, %CD2, ... specifies the cell's user-date in the conditional format with the index 0, 1 2, ... * %CS0, %CS1, %CS2, ... specifies the cell's state in the conditional format with the index 0, 1 2, ... * * The expression supports the following functions: * * index, gets the index of the item * rindex, returns the recursive-index of the item * pos, returns the relative position of the item (the position within the parent's children collection) * rpos, returns the recursive relative-position of the item (the position within the parent's children collection) * opos, returns the relative old position of the item (the position within the parent's children collection) * ropos, returns the recursive relative-old-position of the item (the position within the parent's children collection) * apos, returns the absolute position of the item (the position from the first visible item) * rapos, returns the recursive absolute-position of the item (the position from the first visible item) * * @example * * "1" {string}, highlights all cells or items. * "%0 >= 0" {string}, highlights the cells or items, when the cells in the first conditional format have the value greater or equal with zero * "%0 startwith 'A'" {string}, highlights the cells or items, when the cells in the first column starts with A */ expression: null, /** * @description The enabled field indicates whether the condition is enabled or disabled (no format or shape is applied if the condition is invalid or disabled) * @type {boolean} Specifies whether the condition is enabled or disabled * @example * * false {boolean}, disables the condition (no format or shape is applied if the condition is invalid or disabled) * true {boolean}, enables the condition */ enabled: true, /** * @description The key field specifies the key associated with the conditional format. * @type {string} Specifies the key associated with the conditional format. * @example * * "cond" {string}, defines the conditional format with the giving key (cond). You can use the ConditionalFormats.Item("cond") method to request the conditional format giving its key. */ key: null, /** * @description The shape field defines the shape to apply on the cell / column if the condition is verified * @type {any} A string expression that defines shape's name within the exontrol.Shape.Pivot or exontrol.Shape namespace, a CSS color, a JSON string-representation of an object of exontrol.Def.Shape type, for the conditional format itself or an object of {normal,hover,click,disabled} type. The normal,hover,click and disabled are objects of exontrol.Def.Shape type. * * @example * * "" {string}, null {null}, no shape is applied * "red" {string}, fills the object's background in red (CSS color) * '{"fillColor": "red"}' or '{"normal":{"fillColor": "red"}}' {string}, fills the object's background in red (JSON-representation of an object of exontrol.Def.Shape type) * "xxx" {string}, indicates that exontrol.Shapes.Tree.xxx or exontrol.Shapes.xxx is applied on the object's background. If the xxx field is missing, no custom shape is applied (no default object's shape is be applied) * exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace */ shape: null } /////////////////////////////////////////////////////////// (exontrol.Tree.Columns) // // The exontrol.Tree.Columns object holds a collection of exontrol.Tree.Column type (column of the control) // // The exontrol.Tree.Columns object provides the following methods: // // Add(oColumnOpts) {exontrol.Tree.Column}, creates and adds a new column into the control. // Count/GetCount() {number}, returns the number of columns within the collection. // Item(id) {exontrol.Tree.Column}, gets the column giving its index, identifier/key/caption or reference. // Items(range) {exontrol.Arr([exontrol.Tree.Column])}, gets the columns giving its index, identifier/key/caption, separated by comma character. // Remove(id), removes the column giving its index, identifier/key/caption or reference. // Clear(), removes all columns of the control. // Sorts/GetSorts()/SetSorts(value) {string}, sorts(groups) multiple-columns at once giving a string-representation such as "C1:A C2:D, C0:A" // /////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////// (exontrol.Tree.Column) // // The exontrol.Tree.Column object holds information(options) about a column within the control. // // The Add(oColumnOpts) method of exontrol.Tree.Columns creates and adds a new column into the control. // // The exontrol.Tree.Column object provides the following methods: // // Options/GetOptions()/SetOptions(value) {exontrol.Tree.ColumnOptions}, indicates the column's options (at once) such as visibility, caption and so on // Remove(), removes the column itself from columns collection ( equivalent of Columns.Remove(oColumn) method ) // Index/GetIndex() {number}, returns the index of the column (0-based) // Position/GetPosition()/SetPosition(value) {number}, specifies the column's position (0-based) // Key/GetKey()/SetKey(value) {boolean}, specifies the column's key (the Columns.Item(key) requests a column by its index, identifier/key/caption or reference) // Visible/GetVisible()/SetVisible(value) {boolean}, shows or hides the column // Enabled/GetEnabled()/SetEnabled(value) {boolean}, enables or disables the column // Caption/GetCaption()/SetCaption(value) {string}, specifies the column's caption (ex-HTML format) // ToolTip/GetToolTip()/SetToolTip(value) {string}, indicates the column's predefined tooltip (ex-HTML format) // FormatText/GetFormatText()/SetFormatText(value) {exontrol.DrawTextFormatEnum}, defines the format to display the column's caption. // Pad/GetPad()/SetPad(value) {(number|string|array)}, defines the format to display the column's caption. // Image/GetImage()/SetImage(value) {string}, defines the column's image. The image can be added using the exontrol.HTMLPicture.Add() method // ImageSize/GetImageSize()/SetImageSize(value) {any}, defines the size of the column's image. The image can be added using the exontrol.HTMLPicture.Add() method // ImageAlign/GetImageAlign()/SetImageAlign(value) {number}, defines the alignment of the column's image relative to its caption. // Shape/GetShape()/SetShape(value) {any}, defines the shape for the column itself (column's header). // CellShape/GetCellShape()/SetCellShape(value) {any}, defines the shape for the column's body/data/cells. // Cursor/GetCursor()/SetCursor(value) {any}, the mouse cursor for the column itself (column's header). // CellCursor/GetCellCursor()/SetCellCursor(value) {any}, the mouse cursor for the column's body/data/cells. // Width/GetWidth()/SetWidth(value) {number}, specifies the column's width. // ExpandColumns/GetExpandColumns()/SetExpandColumns(value) {any}, specifies the list of columns to be shown when the current column is expanded. // Expanded/GetExpanded()/SetExpanded(value) {boolean}, indicates whether the column is expanded or collapsed. // AllowSizing/GetAllowSizing()/SetAllowSizing(value) {boolean}, specifies whether the column is resizable or fixed // DisplayExpandButton/GetDisplayExpandButton()/SetDisplayExpandButton(value) {boolean}, specifies whether the column displays its expand/collapse glyphs // SortOrder/GetSortOrder()/SetSortOrder(value) {number}, indicates the column's sort order // DefaultSortOrder/GetDefaultSortOrder()/SetDefaultSortOrder(value) {number}, indicates the column's default sort order // SortType/GetSortType()/SetSortType(value) {number}, specifies whether the column gets sorted as string, number or date, or by value, state or image // AllowSort/GetAllowSort()/SetAllowSort(value) {boolean}, specifies whether the column is sortable // AllowDrag/GetAllowDrag()/SetAllowDrag(value) {boolean}, specifies whether the column is dragable // AllowGroupBy/GetAllowGroupBy()/SetAllowGroupBy(value) {boolean}, specifies whether the column can be grouped by // GroupByFormatCell/GetGroupByFormatCell()/SetGroupByFormatCell(value) {string}, indicates the format of the cell to be displayed when the column gets grouped by // DisplayFilterButton/GetDisplayFilterButton()/SetDisplayFilterButton(value) {boolean}, shows or hides the column's filter button. // CellHasCheck/GetCellHasCheck()/SetCellHasCheck(value) {boolean}, shows or hides check-box, or radio-buttons for all cells within the column // PartialCheck/GetPartialCheck()/SetPartialCheck(value) {boolean}, enables or disables partial-check feature // Format/GetFormat()/SetFormat(value) {string}, specifies the format to display the cells in the column // AllowEdit/GetAllowEdit()/SetAllowEdit(value) {boolean}, specifies whether the column is editable or readonly // Filter/GetFilter()/SetFilter(value) {string}, specifies the column's filter // FilterType/GetFilterType()/SetFilterType(value) {exontrol.Tree.FilterTypeEnum}, specifies the type of the column's filter // ExcludeFilter/GetExcludeFilter()/SetExcludeFilter(value) {boolean}, specifies the state of the column's exclude flag // ChangeFilter(filterType, filter), changes the column's filter and filterType at once (validates the view and applies the filter once) // FilterList/GetFilterList()/SetFilterList(value) {exontrol.Tree.FilterListEnum}, specifies whether the drop down filter list includes visible or all items // FilterOnType/GetFilterOnType()/SetFilterOnType(value) {boolean}, allows you to filter the control's data based on the typed characters // /////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////// (exontrol.Tree.ColumnOptions) // // The exontrol.Tree.ColumnOptions type holds all options a column can display or own // // The exontrol.Tree.ColumnOptions type defines the following fields: // // position {number}, specifies the column's position // visible {boolean}, indicates whether the column is visible or hidden // enabled {boolean}, indicates whether the column is enabled or disabled(unselectable) // key {string}, specifies the key associated with the column // caption {string}, defines the column's caption // toolTip {string}, specifies the column's predefined tooltip // formatText {exontrol.DrawTextFormatEnum}, specifies the format to display the column's caption // pad {(number|string|array)}, defines the column's padding (space between the column's content and its border) // image {string}, specifies the name of the image/picture the column displays. The image can be added using the exontrol.HTMLPicture.Add() method // imageSize {any}, defines the size of the column's image // imageAlign {number}, defines the alignment of the image within the column as 0 (left, default), 1(right), 2(top) or 3(bottom) // shape {any}, defines the shape for individual column (column's header) // cellShape {any}, defines shape to apply on the column's body/data/cells. // cursor {string}, defines the mouse-cursor for individual column (column's header) // cellCursor {string}, defines the cursor to show within the column's body/data/cells // width {number}, defines the column's width // expandColumns {any}, specifies the list of columns to be shown when the current column is expanded // expanded {boolean}, indicates whether the column is expanded or collapsed // displayExpandButton {boolean}, shows or hides the column's expand/collapse glyphs // allowSizing {boolean}, specifies whether the column is resizable or fixed // sortOrder {number}, indicates the column's sort-order as 0(unsorted), 1(ascending) and 2(descending) // defaultSortOrder {number}, indicates the column's default sort-order as 1(ascending) or 2(descending). The defaultSortOrder indicates the column's sort order once the user clicks the column's header or drags it to the control's sortbar. // sortType {exontrol.Tree.SortTypeEnum}, specifies whether the column gets sorted as string, number or date, or by value, state or image // allowSort {boolean}, specifies whether the column is sortable // allowDrag {boolean}, specifies whether the column is dragable // allowGroupBy {boolean}, specifies whether the column can be grouped by // groupByFormatCell {string}, indicates the format of the cell to be displayed when the column gets grouped by // displayFilterButton {boolean}, shows or hides the column's filter button // cellHasCheck {number}, indicates whether the cells within the column displays check-box(1) or a radio-button(2) // partialCheck {number}, specifies whether the column supports partial-check feature // format {string}, formats the column giving an expression // allowEdit {boolean}, specifies whether the column is editable or readonly // filter {string}, specifies the column's filter // filterType {exontrol.Tree.FilterTypeEnum}, specifies the column's filter type // filterList {exontrol.Tree.FilterListEnum}, specifies whether the drop down filter list includes visible or all items // filterOnType {boolean}, allows you to filter the control's data based on the typed characters // /////////////////////////////////////////////////////////// exontrol.Tree.ColumnOptions = { /** * @description The position field specifies the column's position. * @type {number} Indicates the column's position * @example * * null {null}, the null value has no effect * 0 {number}, sets the column on the first position */ position: null, /** * @description The visible field indicates whether the column is visible or hidden. * @type {boolean} Specifies whether the column is visible or hidden. * @example * * false {boolean}, hides the column * true {boolean}, shows the column */ visible: true, /** * @description The enabled field indicates whether the column is enabled or disabled(unselectable) * @type {boolean} Specifies whether the column is enabled or disabled * @example * * false {boolean}, disables the column * true {boolean}, enables the column */ enabled: true, /** * @description The key field specifies the key associated with the column. * @type {string} Specifies the key associated with the column. If no key is provided, the column's plain-caption can be used to request an item. The plain-caption includes no ex-HTML tags, such as , and so on * @example * * "logo" {string}, defines the column with the giving key (logo). You can use the Column("logo") method to request the column giving its key. */ key: null, /** * @description The caption field defines the column's caption. * @type {string} Specifies the ex-HTML caption the column displays. * @example * * null {null}, indicates no caption * "caption" {string}, declares a plain-caption * "text" {string}, displays the text in bold * "logo" {string}, displays the "logo" image. The image can be added using the exontrol.HTMLPicture.Add() method */ caption: null, /** * @description The formatText field specifies the format to display the column's caption. * @type {exontrol.DrawTextFormatEnum} A exontrol.DrawTextFormatEnum value that defines the format to show the column's caption. * * The exontrol.DrawTextFormatEnum type supports the following flags: * * exTextAlignTop (0x00), justifies the text to the top of the rectangle * exTextAlignLeft (0x00), aligns text to the left * exTextAlignCenter (0x01), centers text horizontally in the rectangle * exTextAlignRight (0x02), aligns text to the right * exTextAlignVCenter (0x04), centers text vertically * exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle. * exTextAlignMask (0x0F), specifies the mask for text's alignment. * exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line. * exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line. * exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight. * exPlainText (0x80), treats the text as plain text. * exTextNoClip (0x0100), draws without clipping. * exHTMLTextNoColors (0x0200), ignores the and tags. * exTextCalcRect (0x0400), determines the width and height of the text. * exHTMLTextNoTags (0x0800), ignores all HTML tags. * exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash. * exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses. * exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses. * * @example * * null {null}, centers the caption * 32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption * 0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned */ formatText: null, /** * @description The pad field defines the column's padding (space between the column's content and its border) * @type {(number|string|array)} A value that could be a numeric value, to pad horizontal and vertical size with the same value, or a "x,y" or [x,y] type to specify the padding on h/v size * @example * * null {null}, indicates that the default-padding field is used ([4,4]) * 0 {number}, indicates no padding * "8,4" {string}, increases the element's width with 2 * 8-pixels and element's height with 2 * 4-pixels * [8,4] {array}, increases the element's width with 2 * 8-pixels and element's height with 2 * 4-pixels */ pad: null, /** * @description The image field specifies the name of the image/picture the column displays. The image can be added using the exontrol.HTMLPicture.Add() method * @type {string} Indicates the name of the image/picture the column displays. */ image: null, /** * @description The imageSize field defines the size of the column's image. * @type {(null|number|array)} Indicates the size of the column's image. * * The imageSize can be of one of the following types: * * {null}, Indicates that the object's image is displayed as it is (full-sized). * {number}, Specifies that the object's image is displayed into a square of giving size (same width and height). If 0 the object displays no image, if negative the object's image is stretched to giving square, else the object's picture is scaled to fit the giving rectangle. * {array}, Specifies an array of [aspect-width,aspect-height] type that defines the limits for width or/and height. The aspect-width and aspect-height define the width/height of the object's picture to scale or stretch to. * * @example * * null {null}, Indicates that the object's image is displayed as it is (full-sized). * 0 {number}, no image is displayed * 64 {number}, the image is scaled to fit a 64 x 64 rectangle * -64 {number}, the image is strected to a 64 x 64 rectangle * [32,64] {array}, scales the image to the largest ratio-rectangle (32 x 64) that fits the client * [-32,-64] {array}, stretches the image to a 32 x 64 rectangle */ imageSize: undefined, /** * @description The imageAlign field defines the alignment of the image within the column. * @type {number} Indicates the alignment of the image within the column as explained: * * The imageAlign propery can be any of the following: * * 0, the image is on the left of the item's caption * 1, the image is on the right of the item's caption * 2, the image is on the top of the item's caption * 3, the image is on the bottom of the item's caption * * @example * * null {null}, the image is aligned left to the caption (default) * 1 {number}, the image is displayed to the right of the item's caption */ imageAlign: null, /** * @description The shape field defines the shape for individual column (column's header). * @type {any} A string expression that defines shape's name within the exontrol.Shape.Pivot or exontrol.Shape namespace, a CSS color, a JSON string-representation of an object of exontrol.Def.Shape type, for the column itself or an object of {normal,hover,click,disabled} type. The normal,hover,click and disabled are objects of exontrol.Def.Shape type. * * @example * * null {null}, no custom shape is applied (default object's shape may be applied) * "" {string}, no custom shape is applied (no default object's shape is be applied) * "red" {string}, fills the object's background in red (CSS color) * '{"fillColor": "red"}' or '{"normal":{"fillColor": "red"}}' {string}, fills the object's background in red (JSON-representation of an object of exontrol.Def.Shape type) * "xxx" {string}, indicates that exontrol.Shapes.Tree.xxx or exontrol.Shapes.xxx is applied on the object's background. If the xxx field is missing, no custom shape is applied (no default object's shape is be applied) * exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace */ shape: null, /** * @description The cellShape field defines shape to apply on the column's body/data/cells. * @type {any} A string expression that defines shape to apply on the column's body/data/cells or an object of {normal,hover,click,disabled} type. The normal,hover,click and disabled are objects of exontrol.Def.Shape type. * * @example * * null {null}, no custom shape is applied (default object's shape may be applied) * "" {string}, no custom shape is applied (no default object's shape is be applied) * "red" {string}, fills the object's background in red (CSS color) * '{"fillColor": "red"}' or '{"normal":{"fillColor": "red"}}' {string}, fills the object's background in red (JSON-representation of an object of exontrol.Def.Shape type) * "xxx" {string}, indicates that exontrol.Shapes.Tree.xxx or exontrol.Shapes.xxx is applied on the object's background. If the xxx field is missing, no custom shape is applied (no default object's shape is be applied) * exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace */ cellShape: null, /** * @description The cursor field defines the mouse-cursor for individual column (column's header). * @type {string} A string expression that defines the mouse-cursor for individual column. * * @example * * "pointer" {string}, The cursor is a pointer that indicates a link (typically an image of a pointing hand) */ cursor: null, /** * @description The cellCursor field defines the cursor to show within the column's body/data/cells. * @type {string} A string expression that defines the mouse-cursor for individual column. * * @example * * "pointer" {string}, The cursor is a pointer that indicates a link (typically an image of a pointing hand) */ cellCursor: null, /** * @description The width field defines the column's width. * @type {number} Defines the column's width. * @example * * 128 {number}, defines the column's width to 128 pixels. */ width: 128, /** * @description The expandColumns field specifies the list of columns to be shown when the current column is expanded. * @type {any} Defines the list of columns to be shown when the current column is expanded. * * The expandColumns field can be any of the following: * * {number} Indicates a numeric value that defines the index of the column to request * {string} Specifies a list of index/identifier/key/caption/plain-caption, separated by comma character * {exontrol.Tree.Column} specifies the object reference to be shown, once the current column is expanded * * @example * * 1 {number}, specifies that the column with the index 1, is shown once the current column is expanded. * "C1,C2" {string}, indicates that the columns C1 and C2 are being shown once the current column is expanded. */ expandColumns: null, /** * @description The expanded field indicates whether the column is expanded or collapsed. * @type {boolean} Expands or collapses the column. * @example * * false {boolean}, the column is collapsed * true {boolean}, the column is expanded */ expanded: true, /** * @description The allowSizing field indicates whether the column is resizable or fixed * @type {boolean} Enables or disables resizing the column * @example * * false {boolean}, the user can not resize the column * true {boolean}, the column is resizable */ allowSizing: true, /** * @description The displayExpandButton field specifies whether the column displays its expand/collapse glyphs. The displayExpandButton field has effect only if the column contains visible child-columns. The expandColumns property specifies the list of columns the current column expands or collapses. * @type {boolean} Shows or hides the column's expand/collapse glyphs. * @example * * false {boolean}, the column hides its expand/collapse glyphs * true {boolean}, the column shows its expand/collapse glyphs. */ displayExpandButton: true, /** * @description The sortOrder field specifies the column's sort order * @type {number} Specifies the column's sort-order as listed: * * 0 {number}, indicates an unsorted column * 1 {number}, sorts ascending the column * 2 {number}, sorts descending the column * * @example * * 0 {number}, unsorts the column * 2 {number}, sorts descending the column */ sortOrder: 0, /** * @description The defaultSortOrder field indicates the column's sort order once the user clicks the column's header or drags it to the control's sortbar. * @type {number} Specifies the column's default sort-order as listed: * * 1 {number}, sorts ascending the column * 2 {number}, sorts descending the column * * @example * * 1 {number}, sorts ascending the column * 2 {number}, sorts descending the column */ defaultSortOrder: 1, /** * @description The sortType field specifies whether the column gets sorted as string, number or date, or by value, state or image. By default, the column gets sorted as string (by "caption" as "string"). * @type {exontrol.Tree.SortTypeEnum} Indicates type of column's sort-as. * * The exontrol.Tree.SortTypeEnum type supports the following values (group A): * * exSortString (0), the column's content is sorted as string (by default) * exSortNumeric (1), the column's content is sorted as numbers * exSortDate (2), the column's content is sorted as dates * * Also, the exontrol.Tree.SortTypeEnum type supports the following additional values (group B): * * exSortByValue (0x10), the column gets sorted by cell's value rather than cell's caption (the cell's caption include formatting) * exSortByState (0x20), the column gets sorted by cell's state (checked, unchecked) rather than cell's caption (the cell's caption include formatting) * exSortByImage (0x30), the column gets sorted by cell's image rather than cell's caption (the cell's caption include formatting) * * (any value of group A can be combined with any value of group B) * * @example * * 2 or exontrol.Tree.SortTypeEnum.exSortDate {number}, sorts the columns as dates * 0x11 or exontrol.Tree.SortTypeEnum.exSortNumeric | exontrol.Tree.SortTypeEnum.exSortByValue {number}, sorts the column by "value" as numbers. For instance, column's formatColumn property formats the values within the column(cell can display number-grouping, ex-HTML format and so on), so this option sorts the column's value rather than formatted-caption it displays */ sortType: 0, /** * @description The allowSort field specifies whether the column is sortable. * @type {boolean} Enables or disables sorting the column * @example * * false {boolean}, the user can not sort the column * true {boolean}, the column is sortable */ allowSort: true, /** * @description The allowDrag field specifies whether the column is dragable. * @type {boolean} Enables or disables dragging the column * @example * * false {boolean}, the user can not drag the column * true {boolean}, the column is dragable */ allowDrag: true, /** * @description The allowGroupBy field specifies whether the column can be grouped by * @type {boolean} Enables or disables group-by the column * @example * * false {boolean}, the user can not group by this column * true {boolean}, the column gets grouped-by once the column's header is dropped into the control's sortbar */ allowGroupBy: true, /** * @description The groupByFormatCell field indicates the format of the cell to be displayed when the column gets grouped by * @type {string} Specifies the format of the cell to be displayed when the column gets grouped by * * The format-expression supports the following keywords: * * value, indicates the value of the current cell ( "value/2 format ``", displays half of the value using current regional format ) * %0, %1, %2, ... specifies the value of the cell in the column with the index 0, 1 2, ... ( "currency(%0 + %1)", adds the value of first and second cell and displays it as a currency ) * %C0, %C1, %C2, ... specifies the caption of the cell, or the string the cell displays in the column with the index 0, 1 2, ... ( "%C0 + %C1", concatenates the caption of first and second cell ) * %CD0, %CD1, %CD2, ... specifies the cell's user-date in the column with the index 0, 1 2, ... ( "%CD0 ? value : ``", displays the cell's value only if the cell's data is not empty ) * %CS0, %CS1, %CS2, ... specifies the cell's state in the column with the index 0, 1 2, ... ( "(%CS0 ? `` : ``) + value", displays the cell's value in bold only if the first cell is checked ) * * The format-expression supports the following unary-operators: * * exp(``), checks whether the item is expanded or collapsed ( "(exp(``) ? `` : ``) + value", shows expanded-items in bold ) * get(`aggregate(list,direction,formula)`), summarizes the cell based on "aggregate(list,direction,formula)" syntax, where: * * aggregate, must be one of the following: * * sum, performs addition of values * min, retrieves the minimum value * max, retrieves the maximum value * count, counts the number of items * avg, calculates the average of values * std, gets standard-deviation of numbers * * list, must be one of the following: * * a number expression that specifies the index of the item being referred * all, indicates all items, so the formula is being applied to all items. The direction has no effect * current, refers the current item * parent, refers to the parent item * root, refers to the root item (the root item has no parent items) * * direction, must be one of the following: * * dir, collects only direct descendents (child-items) * rec, collects recursivelly the leaf descendents ( leaf items ). A leaf item is an item with no child items * all, collects all descendents * * Currently, the following items are excluded by aggregate functions: * * not-sortable items. The SortableItem property specifies whether the item can be sorted ( a sortable item can change its position after sorting, while a not-sortable item keeps its position after sorting. * not-selectable items. The SelectableItem property specifies whether the user can selects/focus the specified item. * divider items. The ItemDivider property specifies whether the item displays a single cell, instead displaying whole cells. * * In conclusion, aggregate functions counts ONLY items that are sortable, selectable and not a divider-item. * * For instance: * * "get(`count(current,dir,1)`)", gets the count of child-items * "get(`count(current,all,1)`)", gets the count of all child-items (implies recursively child items) * "get(`count(current,rec,1)`)", counts the number of leaf items ( a leaf item is an item with no child items ). * "get(`sum(current,dir,%1 ? 1 : 0)`)", counts the number of child-items that have not-empty cells within the second-column * "get(`sum(current,dir,value)`)", gets the total of values of child-items (direct descendent) within the same column * "get(`sum(all,rec,value)`)", gets the total of values of leaf-items within the same column * "get(`sum(parent,dir,dbl(%1) + dbl(%2))`)", gets the addition of all cells in the second (%1) and third (%2) column that are directly descendent of the parent item (sibling). * * The format-expression supports the following binary-operators: * * 0 index `format`, gets the index of the item (0-based). The first added item has the index 0, the second added item has the index 1, and so on. The index of the item remains the same even if the order of the items is changed by sorting or grouping ( "1 index ``", gets the index of the item starting from 1 ) * 0 rindex `delimiter|format|format|...`, returns the recursive-index of the item ("1 rindex `.|A-Z`", returns values as A, A.1, A.2, B, ...) * 0 pos `format`, returns the relative position of the item (the position within the parent's children collection) ( "1 pos ``", returns the position of the item (1-based) within the parent's child items collection ) * 0 rpos `delimiter|format|format|...`, returns the recursive relative-position of the item (the position within the parent's children collection) ( "1 rpos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * 0 opos `format`, returns the relative old position of the item (the position within the parent's children collection) ( "1 opos ``", returns the position of the item (1-based) within the parent's child items collection ) * 0 ropos `delimiter|format|format|...`, returns the recursive relative-old-position of the item (the position within the parent's children collection) ( "1 ropos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * 0 apos `format`, returns the absolute position of the item (the position from the first visible item) ( "1 apos ``", gets absolute position of the item ) * 0 rapos `delimiter|format|format|...`, returns the recursive absolute-position of the item (the position from the first visible item) ( "1 rapos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * * where: * * `delimiter`, is a character to separated recursive-operators such as "rindex", "rpos", "ropos" and "rapos" * `format`, is a set of characters to be used for specifying the index * * @example * * null {null}, the control's groupByFormatCell option is used instead * "" {string}, the default group-by value gets displayed once the column gets grouped by * "upper(value)" {string}, the default group-by value (in upper case) gets displayed once the column gets grouped by * "value + ` ` + get(`count(current,rec,1)`)" {string}, the default group-by value plus the count of items within the group gets displayed once the column gets grouped by */ groupByFormatCell: null, /** * @description The displayFilterButton field specifies whether the column's filter button is shown or hidden * @type {boolean} Shows or hides the column's filter button * @example * * false {boolean}, the column's filter button is hidden * true {boolean}, the column's filter button is shown */ displayFilterButton: false, /** * @description The cellHasCheck field specifies whether the cells within the column shows a check-box or radio-button. * @type {number} Defines whether the cell's check-box, radio-button is visible as follows: * * 0 {number}, the column shows no check-box or radio-button * 1 {number}, the column displays a check-box for each cell. * 2 {number}, the column displays a radio-button for each cell (only a cell within the entire-column can be checked). * * @example * * 0 {number}, the cell's hasCheck field specifies whether a check-box or radio-button is shown within the cell * 1 {number}, the column shows a check-box for each cell (while cell's hasCheck field is not 0) * 2 {number}, the column shows a radio-button for each cell (while cell's hasCheck field is not 0). If column's cellHasCheck field is 0, you can have multiple group of radio-cells, by using the cell's hasCheck propery on 2 (sibling cells are considered a group of radio-cells) * */ cellHasCheck: 0, /** * @description The partialCheck field indicates whether the column supports partial-check feature * @type {boolean} Specifies whether the column supports partial-check feature. * * @example * * false {boolean}, the column supports no partial-check feature. * true {boolean}, the column supports partial-check feature, so once a parent item is checked/unchecked all its descendents are checked/unchecked. * */ partialCheck: false, /** * @description The format field specifies the expression to format the column * @type {string} Indicates the expression to format the column * * The format-expression supports the following keywords: * * value, indicates the value of the current cell ( "value/2 format ``", displays half of the value using current regional format ) * %0, %1, %2, ... specifies the value of the cell in the column with the index 0, 1 2, ... ( "currency(%0 + %1)", adds the value of first and second cell and displays it as a currency ) * %C0, %C1, %C2, ... specifies the caption of the cell, or the string the cell displays in the column with the index 0, 1 2, ... ( "%C0 + %C1", concatenates the caption of first and second cell ) * %CD0, %CD1, %CD2, ... specifies the cell's user-date in the column with the index 0, 1 2, ... ( "%CD0 ? value : ``", displays the cell's value only if the cell's data is not empty ) * %CS0, %CS1, %CS2, ... specifies the cell's state in the column with the index 0, 1 2, ... ( "(%CS0 ? `` : ``) + value", displays the cell's value in bold only if the first cell is checked ) * * The format-expression supports the following unary-operators: * * exp(``), checks whether the item is expanded or collapsed ( "(exp(``) ? `` : ``) + value", shows expanded-items in bold ) * get(`aggregate(list,direction,formula)`), summarizes the cell based on "aggregate(list,direction,formula)" syntax, where: * * aggregate, must be one of the following: * * sum, performs addition of values * min, retrieves the minimum value * max, retrieves the maximum value * count, counts the number of items * avg, calculates the average of values * std, gets standard-deviation of numbers * * list, must be one of the following: * * a number expression that specifies the index of the item being referred * all, indicates all items, so the formula is being applied to all items. The direction has no effect * current, refers the current item * parent, refers to the parent item * root, refers to the root item (the root item has no parent items) * * direction, must be one of the following: * * dir, collects only direct descendents (child-items) * rec, collects recursivelly the leaf descendents ( leaf items ). A leaf item is an item with no child items * all, collects all descendents * * Currently, the following items are excluded by aggregate functions: * * not-sortable items. The SortableItem property specifies whether the item can be sorted ( a sortable item can change its position after sorting, while a not-sortable item keeps its position after sorting. * not-selectable items. The SelectableItem property specifies whether the user can selects/focus the specified item. * divider items. The ItemDivider property specifies whether the item displays a single cell, instead displaying whole cells. * * In conclusion, aggregate functions counts ONLY items that are sortable, selectable and not a divider-item. * * For instance: * * "get(`count(current,dir,1)`)", gets the count of child-items * "get(`count(current,all,1)`)", gets the count of all child-items (implies recursively child items) * "get(`count(current,rec,1)`)", counts the number of leaf items ( a leaf item is an item with no child items ). * "get(`sum(current,dir,%1 ? 1 : 0)`)", counts the number of child-items that have not-empty cells within the second-column * "get(`sum(current,dir,value)`)", gets the total of values of child-items (direct descendent) within the same column * "get(`sum(all,rec,value)`)", gets the total of values of leaf-items within the same column * "get(`sum(parent,dir,dbl(%1) + dbl(%2))`)", gets the addition of all cells in the second (%1) and third (%2) column that are directly descendent of the parent item (sibling). * * The format-expression supports the following binary-operators: * * 0 index `format`, gets the index of the item (0-based). The first added item has the index 0, the second added item has the index 1, and so on. The index of the item remains the same even if the order of the items is changed by sorting or grouping ( "1 index ``", gets the index of the item starting from 1 ) * 0 rindex `delimiter|format|format|...`, returns the recursive-index of the item ("1 rindex `.|A-Z`", returns values as A, A.1, A.2, B, ...) * 0 pos `format`, returns the relative position of the item (the position within the parent's children collection) ( "1 pos ``", returns the position of the item (1-based) within the parent's child items collection ) * 0 rpos `delimiter|format|format|...`, returns the recursive relative-position of the item (the position within the parent's children collection) ( "1 rpos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * 0 opos `format`, returns the relative old position of the item (the position within the parent's children collection) ( "1 opos ``", returns the position of the item (1-based) within the parent's child items collection ) * 0 ropos `delimiter|format|format|...`, returns the recursive relative-old-position of the item (the position within the parent's children collection) ( "1 ropos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * 0 apos `format`, returns the absolute position of the item (the position from the first visible item) ( "1 apos ``", gets absolute position of the item ) * 0 rapos `delimiter|format|format|...`, returns the recursive absolute-position of the item (the position from the first visible item) ( "1 rapos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * * where: * * `delimiter`, is a character to separated recursive-operators such as "rindex", "rpos", "ropos" and "rapos" * `format`, is a set of characters to be used for specifying the index * * @example * * "value format ``" {string}, shows the column's value formatted as a number (as in regional settings) * "1 index ``" {string}, gets the index (1-based) of the item * "1 rpos `.|A-Z`" {string}, displays A, B, C for root-items, and A.1, A.2, A.1.1, ... B.1, B.2, ... for child-items * "currency(dbl(%0) + dbl(%1))" {string}, adds columns 0 and 1 and displays the result as currency * */ format: null, /** * @description The allowEdit field specifies whether the column is editable or readonly * @type {boolean} Specifies whether the cells within the column are editable or readonly * * @example * * false {boolean}, specifies a readonly column * true {boolean}, the cells within the column are editable (if "edit" action is allowed) * */ allowEdit: false, /** * @description The filter field defines the filter to apply to this column only. * @type {string} Specifies the column's filter. The filter depends on the filterType as explained: * * filterType = exFilter, the filter field indicates the list (separated by "|" character) of values to filter for. For instance, filter = "Cell A", filters for items with the caption "Cell A", filter = "Cell A|Cell B", filters for items with the caption "CellA" or "CellB". * filterType = exPattern, the filter field defines the wild-patterns to filter for items (separated by "|" character). A pattern-filter may contain wild card characters like '?' for any single character, '*' for zero or more occurrences of any character, '#' for any digit character. For instance: "A*" filters for items that begins with "A" or "a", "A*|B*" filters for items that starts with "A", "a", "B" or "b". * filterType = exDate, the filter field contains alternative interval-dates to filter for (separated by "|" character). An interval-date could be of "[dateFrom] [to] [dateTo]" or "[operator] date [operator date ...]" format. The "[dateFrom] [to] [dateTo]" format filter for items that fit the interval. For instance: "2/13/2004" filter only for items with the date on 2/13/2004, "2/13/2004 to", filter for items whose date is greater or equal with 2/13/2004, "to 2/13/2004" filter for items with the date less or equal with 2/13/2004. For instance: "2/13/2004 | 2/13/2005 to" filter for items with the date on 2/13/2004 or greater or equal with 2/13/2005. The "operator date [operator date ...]" format allows to filter using multiple operators as <, <=, =, <>, !=, >= or >. For instance: "> 2/13/2004" filter for items with the date greater than 2/13/2004, "> 2/13/2004 | <= 2/13/2002" filter for dates greater than 2/13/2004 or less or greater than 2/13/2002 * filterType = exNumeric, the filter field specifies a list of numeric-rules to filter for (separated by "|" character). The format of filter field is "[operator] number [operator number ...]", which define numeric-rule, where operator is one of <, <=, =, <>, !=, >= or >. For instance, the "> 10" filters for numbers greater than 10, "> 10 < 100" filters for numbers greater than 10 and less than 100, "10|20|>50" filters for items that include 10, 20 or any number greater than 50 * filterType = exCheck, the filter field specifies a list of states to filter for (separated by "|" character). The cell's state is "0" (unchecked), "1" (checked) and "2" (partial-checked). For instance: "1" filters for checked items, "1|2" filters for partially and checked items * filterType = exImage, the filter field defines the list of images (separated by "|" character) to filter for. The cell's image property specifies the image of the cell. For instance, "Al" filters for items that displays the "Al" picture/image, "Al|Peggy" filters for items that displays the "Al" or "Peggy" images. The exontrol.HTMLPicture.Add() method adds named images to the control. * * The filter field has no effect if the filterType field is exAll, exBlanks or exNonBlanks. The filter is case-sensitive, if the filterType includes the exFilterDoCaseSensitive flag. * * @example * * null {null}, clears the column's filter * "" {string}, filters for empty-captions * "Cell A|Cell B" {string}, filters for items that include "Cell A" or "Cell B" within the column * */ filter: null, /** * @description The filterType field defines the type of the column's filter. * @type {exontrol.Tree.FilterTypeEnum} Indicates the type of the column's filter. * * The exontrol.Tree.FilterTypeEnum type supports the following values and flags: * * exAll (0), no filter is applied * exBlanks (1), includes only blank/empty items (a blank item is an empty item or an item that displays whitespace characters) * exNonBlanks (2), includes only non blank/empty items (a blank item is an empty item or an item that displays whitespace characters) * exPattern (3), includes only items that match the pattern. The Filter property defines the pattern. A pattern may contain the wild card characters '?' for any single character, '*' for zero or more occurrences of any character, '#' for any digit character, and [chars] indicates a group of characters. If any of the *, ?, # or | characters are preceded by a \ ( escape character ) it masks the character itself. Can be combined with exFilterDoCaseSensitive flag * exDate (4), includes only items that fit the date interval. The Filter property of the Column object defines the interval of dates being used to filter items. The interval of dates should be as [dateFrom] to [dateTo]. If the dateFrom value is missing, the control includes only the items before the dateTo date, if the dateTo value is missing, the control includes the items after the dateFrom date. If both dates ( dateFrom and dateTo ) are present, the control includes the items between this interval of dates. For instance, the "2/13/2004 to" includes all items after 2/13/2004 inclusive, or "2/13/2004 to Feb 14 2005" includes all items between 2/13/2004 and 2/14/2004. * exNumeric (5), includes only items of numeric type that check the expression. The expression supports operators like <, <=, =, <>, >= or > and numbers to define rules. For instance, the "> 10 < 100" filter indicates all numbers greater than 10 and less than 100. * exCheck (6), includes only checked-items, while Filter property is "1" or unchecked-items if Filter is "0" * exImage (10), includes only items that match the images within the Filter property. * exFilter (240), includes only items that match the Filter property. Can be combined with exFilterDoCaseSensitive flag * exFilterDoCaseSensitive (0x100), By default, the column's filter is case-insensitive. Specifies a case-sensitive column's filter. Can be combined with exPattern or exFilter flag * exFilterExclude (0x200), The flag indicates that the Exclude field of the column is checked. The flag indicates that the items that match the filter are excluded from the list. * * The filter depends on the filterType as explained: * * filterType = exFilter, the filter field indicates the list (separated by "|" character) of values to filter for. For instance, filter = "Cell A", filters for items with the caption "Cell A", filter = "Cell A|Cell B", filters for items with the caption "CellA" or "CellB". * filterType = exPattern, the filter field defines the wild-patterns to filter for items (separated by "|" character). A pattern-filter may contain wild card characters like '?' for any single character, '*' for zero or more occurrences of any character, '#' for any digit character. For instance: "A*" filters for items that begins with "A" or "a", "A*|B*" filters for items that starts with "A", "a", "B" or "b". * filterType = exDate, the filter field contains alternative interval-dates to filter for (separated by "|" character). An interval-date could be of "[dateFrom] [to] [dateTo]" or "[operator] date [operator date ...]" format. The "[dateFrom] [to] [dateTo]" format filter for items that fit the interval. For instance: "2/13/2004" filter only for items with the date on 2/13/2004, "2/13/2004 to", filter for items whose date is greater or equal with 2/13/2004, "to 2/13/2004" filter for items with the date less or equal with 2/13/2004. For instance: "2/13/2004 | 2/13/2005 to" filter for items with the date on 2/13/2004 or greater or equal with 2/13/2005. The "operator date [operator date ...]" format allows to filter using multiple operators as <, <=, =, <>, !=, >= or >. For instance: "> 2/13/2004" filter for items with the date greater than 2/13/2004, "> 2/13/2004 | <= 2/13/2002" filter for dates greater than 2/13/2004 or less or greater than 2/13/2002 * filterType = exNumeric, the filter field specifies a list of numeric-rules to filter for (separated by "|" character). The format of filter field is "[operator] number [operator number ...]", which define numeric-rule, where operator is one of <, <=, =, <>, !=, >= or >. For instance, the "> 10" filters for numbers greater than 10, "> 10 < 100" filters for numbers greater than 10 and less than 100, "10|20|>50" filters for items that include 10, 20 or any number greater than 50 * filterType = exCheck, the filter field specifies a list of states to filter for (separated by "|" character). The cell's state is "0" (unchecked), "1" (checked) and "2" (partial-checked). For instance: "1" filters for checked items, "1|2" filters for partially and checked items * filterType = exImage, the filter field defines the list of images (separated by "|" character) to filter for. The cell's image property specifies the image of the cell. For instance, "Al" filters for items that displays the "Al" picture/image, "Al|Peggy" filters for items that displays the "Al" or "Peggy" images. The exontrol.HTMLPicture.Add() method adds named images to the control. * * The filter field has no effect if the filterType field is exAll, exBlanks or exNonBlanks. The filter is case-sensitive, if the filterType includes the exFilterDoCaseSensitive flag. * * @example * * 2 or exontrol.Tree.FilterTypeEnum.exNonBlanks {number}, filters for not-blank items (a blank item is an empty item or an item that displays whitespace characters) * 6 or exontrol.Tree.FilterTypeEnum.exCheck {number}, filters for checked-items (while filter field is "1") or unchecked-items (while filter field is "0") * */ filterType: exontrol.Tree.FilterTypeEnum.exAll, /** * @description The filterList field specifies whether the drop down filter list includes visible or all items. * @type {exontrol.Tree.FilterListEnum} Specifies options to display the column's drop down filter * * The exontrol.Tree.FilterListEnum type supports the following values and flags: * * exAllItems (0), the filter's list includes all values in the column. * exVisibleItems (1), the filter's list includes only visible (filtered) items from the column. The visible items include child items of collapsed items. * exNoItems (2), the filter's list includes no item from the column. * exLeafItems (3), the filter's list includes the leaf items only. A leaf item is an item with no child items. * exRootItems (4), the filter's list includes the root items only. A root item has no parent item. * exSortItemsDesc (0x10), sorts descending the items of the filter's list. If none of the exSortItemsAsc or exSortItemsDesc is present, the list is built as the items are displayed in the control. * exSortItemsAsc (0x20), sorts ascending the items of the filter's list. If none of the exSortItemsAsc or exSortItemsDesc is present, the list is built as the items are displayed in the control. * exShowCheckBox (0x100), Displays a check-box for each item within the filter's list. * exShowExclude (0x2000), Shows or hides the Exclude field. The exFilterExclude flag excludes programmatically the selected items in the drop down filter panel. * exShowBlanks (0x4000), The filter's list includes (Blanks) and (NonBlanks) items * * @example * * 2 or exontrol.Tree.FilterTypeEnum.exNonBlanks {number}, filters for not-blank items (a blank item is an empty item or an item that displays whitespace characters) * 6 or exontrol.Tree.FilterTypeEnum.exCheck {number}, filters for checked-items (while filter field is "1") or unchecked-items (while filter field is "0") */ filterList: exontrol.Tree.FilterListEnum.exAllItems, /** * @description The filterOnType field allows you to filter the control's data based on the typed characters * @type {boolean} Specifies whether the column gets filtered as soon as user types characters * * @example * * false {boolean}, no filter-on-type input is available for the column (excepts columns of exPattern, exDate or exNumeric type) * true {boolean}, the column's filter-on-type input is displayed as soon as the user clicks the column's funnel glyph (no column's filter-list is displayed, if available) */ filterOnType: false }; /////////////////////////////////////////////////////////// (exontrol.Tree.Items) // // The exontrol.Tree.Items object holds a collection of exontrol.Tree.Item type (item of the control) // // The exontrol.Tree.Items object provides the following methods: // // Add(oItemOpts) {exontrol.Tree.Item}, creates and adds a new item into the control // Count/GetCount() {number}, returns the number of items within the collection. // Item(id) {exontrol.Tree.Item}, gets the item giving its index, identifier/key or reference // Remove(id), removes the item giving its index, identifier/key or reference // Clear(), removes all items of the control // VisibleCount/GetVisibleCount() {number}, returns the number of visible-items // MatchCount/GetMatchCount() {number}, returns the number of items that match the filter // LeafCount/GetLeafCount() {number}, counts the leaf-items (a leaf item is an item with no child items) // HasChildren/GetHasChildren() {boolean}, checks whether the control contains any child-item (list or tree) // /////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////// (exontrol.Tree.Item) // // The exontrol.Tree.Item object holds information(options) about an item within the control. // // The Add(oItemOpts) method of exontrol.Tree.Items creates and adds a new item into the control. The Add(oItemOpts) method of exontrol.Tree.Item creates and adds a new child-item into the control. // // The exontrol.Tree.Item object provides the following methods: // // Add(oItemOpts) {exontrol.Tree.Item}, creates and adds a new child-item into the control. // Remove(), removes the item itself from items collection ( equivalent of Items.Remove(oItem) method ) // Options/GetOptions()/SetOptions(value) {exontrol.Tree.ItemOptions}, indicates the item's options (at once) such as visibility, position and so on // Index/GetIndex() {number}, returns the index of the item (0-based) // Position/GetPosition()/SetPosition(value) {number}, specifies the item's position (0-based) // Key/GetKey()/SetKey(value) {boolean}, specifies the item's key (the Items.Item(key) requests an item by its index, identifier/key or reference) // Visible/GetVisible()/SetVisible(value) {boolean}, shows or hides the item // Enabled/GetEnabled()/SetEnabled(value) {boolean}, enables or disables the item // Shape/GetShape()/SetShape(value) {any}, the shape for the item itself. // Cursor/GetCursor()/SetCursor(value) {string}, the mouse cursor for the item itself. // Height/GetHeight()/SetHeight(value) {number}, defines the item's height. // Parent/GetParent()/SetParent(value) {any}, specifies the parent's item. // Expanded/GetExpanded()/SetExpanded(value) {boolean}, expands or collapses the item // ToggleExpand(), toggles the item's expand state. For instance, if the item is expanded, the ToggleExpand() method collapses the item. // Divider/GetDivider()/SetDivider(value) {any}, shows the item as a divider (an divider-item shows a cell only) // Selectable/GetSelectable()/SetSelectable(value) {boolean}, specifies whether the item is selectable // AllowSizing/GetAllowSizing()/SetAllowSizing(value) {boolean}, indicates whether the item is resizable // Sortable/GetSortable()/SetSortable(value) {boolean}, specifies whether the item is sortable // ShowExpand/GetShowExpand()/SetShowExpand(value) {boolean}, specifies whether the item's expand/collapse glyph is visible or hidden // Selected/GetSelected()/SetSelected(value) {boolean}, specifies whether the item is selected or unselected // GroupItem/GetGroupItem() {number}, indicates a group item if positive or zero (specifies the index of the column that has been grouped) // /////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////// (exontrol.Tree.ItemOptions) // // The exontrol.Tree.ItemOptions type holds all options an item can display or own // // The exontrol.Tree.ItemOptions type defines the following fields: // // value {any}, defines the value(s) of the item's first-cell(s) at adding time // visible {boolean}, indicates whether the item is visible or hidden // enabled {boolean}, indicates whether the item is enabled or disabled // key {string}, specifies the key associated with the item // shape {any}, defines the shape for individual item // cursor {string}, defines the mouse-cursor for individual item // height {number}, specifies the item's height // parent {any}, indicates the item's parent // expanded {boolean}, specifies whether the item is expanded or collapsed // divider {any}, shows the item as a divider (an divider-item shows a cell only) // selectable {boolean}, specifies whether the item is selectable // sortable {boolean}, specifies whether the item is sortable, // showExpand {boolean}, shows or hides the item's expand/collapse glyphs // selected {boolean}, specifies whether the item is selected or unselected // /////////////////////////////////////////////////////////// exontrol.Tree.ItemOptions = { /** * @description The value field defines the value(s) of first cell(s) once the item is added. * @type {any} Defines the value of the first cell(s). The value field has effect only while using with the Add({value}) method of exontrol.Tree.Items or exontrol.Tree.Item type. If the value is an array, it specifies the values for cells within the item to be added, else it specifies the value for the first-cell (the cell with the index 0) * * @example * * Add("caption") {exontrol.Tree.Item}, adds a new item, and sets the caption for the first cell. * Add({value: "caption"}) {exontrol.Tree.Item}, adds a new item, and sets the caption for the first cell. * Add(["Cell 1","Cell 2"]) {exontrol.Tree.Item}, adds a new item, and sets the caption for the first and second cell. * Add({value: ["Cell 1","Cell 2"]}) {exontrol.Tree.Item}, adds a new item, and sets the caption for the first and second cell. * */ value: undefined, /** * @description The visible field indicates whether the item is visible or hidden. * @type {boolean} Specifies whether the item is visible or hidden. * @example * * false {boolean}, hides the item * true {boolean}, shows the item */ visible: true, /** * @description The enabled field indicates whether the item is enabled or disabled * @type {boolean} Specifies whether the item is enabled or disabled * @example * * false {boolean}, disables the item * true {boolean}, enables the item */ enabled: true, /** * @description The key field specifies the key associated with the item. * @type {string} Specifies the key associated with the item. If no key is provided, the item's plain-caption can be used to request an item. The plain-caption includes no ex-HTML tags, such as , and so on * @example * * "logo" {string}, defines the item with the giving key (logo). You can use the Root.Item("logo") method to request the item giving its key. */ key: null, /** * @description The shape field defines the shape for individual item. * @type {any} A string expression that defines shape's name within the exontrol.Shape.Pivot or exontrol.Shape namespace, a CSS color, a JSON string-representation of an object of exontrol.Def.Shape type, for the item itself or an object of {normal,hover,click,disabled} type. The normal,hover,click and disabled are objects of exontrol.Def.Shape type. * @example * * null {null}, no custom shape is applied (default object's shape may be applied) * "" {string}, no custom shape is applied (no default object's shape is be applied) * "red" {string}, fills the object's background in red (CSS color) * '{"fillColor": "red"}' or '{"normal":{"fillColor": "red"}}' {string}, fills the object's background in red (JSON-representation of an object of exontrol.Def.Shape type) * "xxx" {string}, indicates that exontrol.Shapes.Tree.xxx or exontrol.Shapes.xxx is applied on the object's background. If the xxx field is missing, no custom shape is applied (no default object's shape is be applied) * exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace */ shape: null, /** * @description The cursor field defines the mouse-cursor for individual item. * @type {string} A string expression that defines the mouse-cursor for individual item. * @example * * "pointer" {string}, The cursor is a pointer that indicates a link (typically an image of a pointing hand) */ cursor: null, /** * @description The height field defines the item's height. * @type {number} Defines the item's height. If height field is not specified, the control's defaultItemHeight field defines the item's height. * @example * * null {null}, indicates that the item's height is defined by the control's defaultItemHeight field (22) * 18 {number}, specifies the item's height to 18 */ height: null, /** * @description The parent field defines the item's parent. * @type {any} The parent field can be one of the following: * * parent {number}, indicates a numeric value that defines the index of the parent's item (0-based) * parent {string}, specifies a string expression that defines the identifier/key of the parent's item * parent {exontrol.Tree.Item}, specifies the object reference to the parent's item * * @example * * 0 {number}, indicates that the item with the index 0 is the parent of the current item * "key" {string}, specifies that the parent of the current item is the item with the giving key * */ parent: null, /** * @description The expanded field indicates whether the item is expanded or collapsed. * @type {boolean} Indicates whether the item's children are shown(expanded) or hidden(collapsed) * @example * * false {boolean}, the item is collapsed * true {boolean}, the item is expanded (item's children are shown) * */ expanded: true, /** * @description The divider field shows the item as a divider (an divider-item shows a cell only) * @type {any} Specifies the index or identifier/key/caption of the only cell the divider-item shows * @example * * null {null}, multiple-columns item (no divider-item) * 0 {number}, divider-item that always displays the cell with the index 0 * "xxx" {string}, divider-item that always displays the cell on the column "xxx" (key or plain-caption) */ divider: null, /** * @description The selectable field indicates whether the item is selectable or unselectable * @type {boolean} Specifies whether the item is selectable * @example * * false {boolean}, the item is unselectable * true {boolean}, the item is selectable */ selectable: true, /** * @description The allowSizing field specifies whether the item is resizable or fixed * @type {boolean} Specifies whether the item is resizable or fixed * @example * * null {null}, the control's itemAllowSizing field specifies whether the item is resizable or fixed * false {boolean}, the item is fixed * true {boolean}, the item is resizable, so user can resize the item by drag (if "item-resize" action is allowed) */ allowSizing: null, /** * @description The sortable field indicates whether the item is sortable or unsortable * @type {boolean} Specifies whether the item is sortable * @example * * false {boolean}, the item is unsortable (an unsortable item keeps its position after user performs a sort operation) * true {boolean}, the item is sortable */ sortable: true, /** * @description The showExpand field specifies whether the item displays its expand/collapse glyphs. * @type {boolean} Shows or hides the item's expand/collapse glyphs. * @example * * false {boolean}, the item hides its expand/collapse glyphs (no indentation is applied) * true {boolean}, the item shows its expand/collapse glyphs (indentation is applied) * -1 {number}, the item shows no expand/collapse glyphs, instead indentation is applied */ showExpand: true, /** * @description The selected field indicates whether the item is selected or unselected * @type {boolean} Specifies whether the item is selected * @example * * false {boolean}, the item is unselected * true {boolean}, the item is selected */ selected: null }; /////////////////////////////////////////////////////////// (exontrol.Tree.Cell) // // The exontrol.Tree.Cell object defines a cell within the control. The cell is the intersection of an item with a column. // // The exontrol.Tree.Cell object provides the following methods: // // Options/GetOptions()/SetOptions(value) {exontrol.Tree.Cellptions}, indicates the cell's options (at once) such as caption, image and so on // Item/GetItem() {exontrol.Tree.Item}, gets the cell's item, as an object of exontrol.Tree.Item type // Column/GetColumn() {exontrol.Tree.Column}, gets the cell's column, as an object of exontrol.Tree.Column type // Enabled/GetEnabled()/SetEnabled(value) {boolean}, enables or disables the cell // Value/GetValue()/SetValue(value) {any}, specifies the cell's value // ToolTip/GetToolTip()/SetToolTip(value) {any}, indicates the cell's predefined tooltip // FormatText/GetFormatText()/SetFormatText(value) {exontrol.DrawTextFormatEnum}, defines the format to display the cell's caption. // Pad/GetPad()/SetPad(value) {(number|string|array)}, defines the format to display the cell's caption. // Image/GetImage()/SetImage(value) {string}, defines the cell's image. The image can be added using the exontrol.HTMLPicture.Add() method // ImageSize/GetImageSize()/SetImageSize(value) {any}, defines the size of the cell's image. The image can be added using the exontrol.HTMLPicture.Add() method // ImageAlign/GetImageAlign()/SetImageAlign(value) {number}, defines the alignment of the cell's image relative to its caption. // Shape/GetShape()/SetShape(value) {any}, the shape for the item itself. // Cursor/GetCursor()/SetCursor(value) {any}, the mouse cursor for the item itself. // State/GetState()/SetState(value) {any}, specifies the cell's state (checked or unchecked). // HasCheck/GetHasCheck/()/SetHasCheck/(value) {any}, specifies whether the cell's check-box or radio-button is visible or hidden // Format/GetFormat()/SetFormat(value) {string}, specifies the format to display the cell // Evaluate(formula) {any}, evaluates the formula and returns the result. // Data/GetData()/SetData(value) {string}, associates any extra data to the current cell // Edit(editOpts), edits the current cell. // /////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////// (exontrol.Tree.CellOptions) // // The exontrol.Tree.CellOptions type holds all options an cell can display or own // // The exontrol.Tree.CellOptions type defines the following fields: // // enabled {boolean}, indicates whether the cell is enabled or disabled // value {string}, defines the cell's value (can be requested within format-expression using the %<Index> syntax) // formatText {exontrol.DrawTextFormatEnum}, specifies the format to display the cell's caption // pad {(number|string|array)}, defines the cell's padding (space between the cell's content and its border) // image {string}, specifies the name of the image/picture the cell displays. The image can be added using the exontrol.HTMLPicture.Add() method // imageSize {any}, defines the size of the cell's image // imageAlign {number}, defines the alignment of the image within the cell // shape {any}, defines the shape for individual cell // cursor {string}, defines the mouse-cursor for individual cell // state {number}, specifies the cell's state (unchecked or checked) (can be requested within format-expression using the %CS<Index> syntax) // hasCheck {number}, indicates whether the cell displays a check-box(1) or a radio-button(2) // format {string}, formats the cell giving an expression // data {string}, associates any extra data to the current cell (can be requested within format-expression using the %CD<Index> syntax) // /////////////////////////////////////////////////////////// exontrol.Tree.CellOptions = { /** * @description The enabled field indicates whether the cell is enabled or disabled * @type {boolean} Specifies whether the cell is enabled or disabled * @example * * false {boolean}, disables the cell * true {boolean}, enables the cell */ enabled: true, /** * @description The value field defines the cell's value (can be requested within format-expression using the %<Index> syntax). * @type {string} Specifies the cell's value, that defines what cell displays. * @example * * null {null}, indicates no caption * "caption" {string}, declares a plain-caption * "text" {string}, displays the text in bold * "logo" {string}, displays the "logo" image. The image can be added using the exontrol.HTMLPicture.Add() method */ value: null, /** * @description The formatText field specifies the format to display the cell's caption. * @type {exontrol.DrawTextFormatEnum} A exontrol.DrawTextFormatEnum value that defines the format to show the cell's caption. * * The exontrol.DrawTextFormatEnum type supports the following flags: * * exTextAlignTop (0x00), justifies the text to the top of the rectangle * exTextAlignLeft (0x00), aligns text to the left * exTextAlignCenter (0x01), centers text horizontally in the rectangle * exTextAlignRight (0x02), aligns text to the right * exTextAlignVCenter (0x04), centers text vertically * exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle. * exTextAlignMask (0x0F), specifies the mask for text's alignment. * exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line. * exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line. * exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight. * exPlainText (0x80), treats the text as plain text. * exTextNoClip (0x0100), draws without clipping. * exHTMLTextNoColors (0x0200), ignores the and tags. * exTextCalcRect (0x0400), determines the width and height of the text. * exHTMLTextNoTags (0x0800), ignores all HTML tags. * exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash. * exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses. * exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses. * * @example * * null {null}, centers the caption * 32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption * 0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned */ formatText: null, /** * @description The pad field defines the cell's padding (space between the cell's content and its border) * @type {(number|string|array)} A value that could be a numeric value, to pad horizontal and vertical size with the same value, or a "x,y" or [x,y] type to specify the padding on h/v size * * null {null}, indicates that the default-padding field is used ([4,4]) * 0 {number}, indicates no padding * "8,4" {string}, increases the element's width with 2 * 8-pixels and element's height with 2 * 4-pixels * [8,4] {array}, increases the element's width with 2 * 8-pixels and element's height with 2 * 4-pixels */ pad: null, /** * @description The image field specifies the name of the image/picture the cell displays. The image can be added using the exontrol.HTMLPicture.Add() method * @type {string} Indicates the name of the image/picture the cell displays. */ image: null, /** * @description The imageSize field defines the size of the cell's image. * @type {(null|number|array)} Indicates the size of the cell's image. * * The imageSize could be of one of the following types: * * {null}, Indicates that the object's image is displayed as it is (full-sized). * {number}, Specifies that the object's image is displayed into a square of giving size (same width and height). If 0 the object displays no image, if negative the object's image is stretched to giving square, else the object's picture is scaled to fit the giving rectangle. * {array}, Specifies an array of [aspect-width,aspect-height] type that defines the limits for width or/and height. The aspect-width and aspect-height define the width/height of the object's picture to scale or stretch to. * * @example * * null {null}, Indicates that the object's image is displayed as it is (full-sized). * 0 {number}, no image is displayed * 64 {number}, the image is scaled to fit a 64 x 64 rectangle * -64 {number}, the image is strected to a 64 x 64 rectangle * [32,64] {array}, scales the image to the largest ratio-rectangle (32 x 64) that fits the client * [-32,-64] {array}, stretches the image to a 32 x 64 rectangle */ imageSize: undefined, /** * @description The imageAlign field defines the alignment of the image within the cell. * @type {number} Indicates the alignment of the image within the cell. as 0 (left, default), 1(right), 2(top) or 3(bottom). * * The imageAlign propery can be any of the following: * * 0, the image is on the left of the cell's caption * 1, the image is on the right of the cell's caption * 2, the image is on the top of the cell's caption * 3, the image is on the bottom of the cell's caption * * @example * * null {null}, the image is aligned left to the caption (default) * 1 {number}, the image is displayed to the right of the cell's caption */ imageAlign: null, /** * @description The shape field defines the shape for individual cell. * @type {any} A string expression that defines shape's name within the exontrol.Shape.Pivot or exontrol.Shape namespace, a CSS color, a JSON string-representation of an object of exontrol.Def.Shape type, for the cell itself or an object of {normal,hover,click,disabled} type. The normal,hover,click and disabled are objects of exontrol.Def.Shape type. * * @example * * null {null}, no custom shape is applied (default object's shape may be applied) * "" {string}, no custom shape is applied (no default object's shape is be applied) * "red" {string}, fills the object's background in red (CSS color) * '{"fillColor": "red"}' or '{"normal":{"fillColor": "red"}}' {string}, fills the object's background in red (JSON-representation of an object of exontrol.Def.Shape type) * "xxx" {string}, indicates that exontrol.Shapes.Tree.xxx or exontrol.Shapes.xxx is applied on the object's background. If the xxx field is missing, no custom shape is applied (no default object's shape is be applied) * exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace */ shape: null, /** * @description The cursor field defines the mouse-cursor for individual cell. * @type {string} A string expression that defines the mouse-cursor for individual cell. * * @example * * "pointer" {string}, The cursor is a pointer that indicates a link (typically an image of a pointing hand) */ cursor: null, /** * @description The state field specifies the cell's state (unchecked or checked) (can be requested within format-expression using the %CS<Index> syntax) * @type {number} A numeric expression that specifies whether the cell is checked or unchecked * * @example * * 0 {number}, the cell is unchecked * 1 {number}, the cell is checked * 2 {number}, the cell is partially-checked (valid for cells of check-box type) */ state: null, /** * @description The hasCheck field specifies whether the cell's check-box, radio-button is visible or hidden * @type {number} Defines whether the cell's check-box, radio-button is visible as follows: * * null {null}, the column's hasCheck field determines whether the cell's check-box, radio-button is visible or hidden * 0 {number}, the cell displays no check-box or radio-button * 1 {number}, the cell displays its check-box. * 2 {number}, the cell displays its radio-button (only a cell within the children of the parent-item can be checked). * * @example * * null {null}, the cell's check-box or radio-button is determined by the column's hasCheck field * 2 {number}, the cell displays its radio-button (cells of the same parent-item make the group of radio-cells, so only once can be checked at the time). By using the cell's individual hasCheck field on 2, you can specify multiple group of radio-buttons within the same column. * */ hasCheck: null, /** * @description The format field specifies the expression to format the cell * @type {string} Indicates the expression to format the cell * * The format-expression supports the following keywords: * * value, indicates the value of the current cell ( "value/2 format ``", displays half of the value using current regional format ) * %0, %1, %2, ... specifies the value of the cell in the column with the index 0, 1 2, ... ( "currency(%0 + %1)", adds the value of first and second cell and displays it as a currency ) * %C0, %C1, %C2, ... specifies the caption of the cell, or the string the cell displays in the column with the index 0, 1 2, ... ( "%C0 + %C1", concatenates the caption of first and second cell ) * %CD0, %CD1, %CD2, ... specifies the cell's user-date in the column with the index 0, 1 2, ... ( "%CD0 ? value : ``", displays the cell's value only if the cell's data is not empty ) * %CS0, %CS1, %CS2, ... specifies the cell's state in the column with the index 0, 1 2, ... ( "(%CS0 ? `` : ``) + value", displays the cell's value in bold only if the first cell is checked ) * * The format-expression supports the following unary-operators: * * exp(``), checks whether the item is expanded or collapsed ( "(exp(``) ? `` : ``) + value", shows expanded-items in bold ) * get(`aggregate(list,direction,formula)`), summarizes the cell based on "aggregate(list,direction,formula)" syntax, where: * * aggregate, must be one of the following: * * sum, performs addition of values * min, retrieves the minimum value * max, retrieves the maximum value * count, counts the number of items * avg, calculates the average of values * std, gets standard-deviation of numbers * * list, must be one of the following: * * a number expression that specifies the index of the item being referred * all, indicates all items, so the formula is being applied to all items. The direction has no effect * current, refers the current item * parent, refers to the parent item * root, refers to the root item (the root item has no parent items) * * direction, must be one of the following: * * dir, collects only direct descendents (child-items) * rec, collects recursivelly the leaf descendents ( leaf items ). A leaf item is an item with no child items * all, collects all descendents * * Currently, the following items are excluded by aggregate functions: * * not-sortable items. The SortableItem property specifies whether the item can be sorted ( a sortable item can change its position after sorting, while a not-sortable item keeps its position after sorting. * not-selectable items. The SelectableItem property specifies whether the user can selects/focus the specified item. * divider items. The ItemDivider property specifies whether the item displays a single cell, instead displaying whole cells. * * In conclusion, aggregate functions counts ONLY items that are sortable, selectable and not a divider-item. * * For instance: * * "get(`count(current,dir,1)`)", gets the count of child-items * "get(`count(current,all,1)`)", gets the count of all child-items (implies recursively child items) * "get(`count(current,rec,1)`)", counts the number of leaf items ( a leaf item is an item with no child items ). * "get(`sum(current,dir,%1 ? 1 : 0)`)", counts the number of child-items that have not-empty cells within the second-column * "get(`sum(current,dir,value)`)", gets the total of values of child-items (direct descendent) within the same column * "get(`sum(all,rec,value)`)", gets the total of values of leaf-items within the same column * "get(`sum(parent,dir,dbl(%1) + dbl(%2))`)", gets the addition of all cells in the second (%1) and third (%2) column that are directly descendent of the parent item (sibling). * * The format-expression supports the following binary-operators: * * 0 index `format`, gets the index of the item (0-based). The first added item has the index 0, the second added item has the index 1, and so on. The index of the item remains the same even if the order of the items is changed by sorting or grouping ( "1 index ``", gets the index of the item starting from 1 ) * 0 rindex `delimiter|format|format|...`, returns the recursive-index of the item ("1 rindex `.|A-Z`", returns values as A, A.1, A.2, B, ...) * 0 pos `format`, returns the relative position of the item (the position within the parent's children collection) ( "1 pos ``", returns the position of the item (1-based) within the parent's child items collection ) * 0 rpos `delimiter|format|format|...`, returns the recursive relative-position of the item (the position within the parent's children collection) ( "1 rpos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * 0 opos `format`, returns the relative old position of the item (the position within the parent's children collection) ( "1 opos ``", returns the position of the item (1-based) within the parent's child items collection ) * 0 ropos `delimiter|format|format|...`, returns the recursive relative-old-position of the item (the position within the parent's children collection) ( "1 ropos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * 0 apos `format`, returns the absolute position of the item (the position from the first visible item) ( "1 apos ``", gets absolute position of the item ) * 0 rapos `delimiter|format|format|...`, returns the recursive absolute-position of the item (the position from the first visible item) ( "1 rapos `.|A-Z`", returns values as A, A.1, A.2, B, ... ) * * where: * * `delimiter`, is a character to separated recursive-operators such as "rindex", "rpos", "ropos" and "rapos" * `format`, is a set of characters to be used for specifying the index * * @example * * "value format ``" {string}, shows the cell's value formatted as a number (as in regional settings) * "1 index ``" {string}, gets the index (1-based) of the item * "1 rpos `.|A-Z`" {string}, displays A, B, C for root-items, and A.1, A.2, A.1.1, ... B.1, B.2, ... for child-items * "currency(dbl(%0) + dbl(%1))" {string}, adds columns 0 and 1 and displays the result as currency * */ format: null, /** * @description The data field associates any extra data to the current cell (can be requested within format-expression using the %CD<Index> syntax) * @type {any} Any type of object you associate with the current cell * * @example * * 0 {number}, the cell's data is 0. For instance, "%CD0 == 0" format-expression selects all cells with the cell's data on 0 * "name" {string}, the cell's data is "name". For instance, "%CD0 like `name*`" format-expression selects all cells with the cell's data starting with "name" */ data: undefined }; /////////////////////////////////////////////////////////// (exontrol.Shapes.Tree) // // The exontrol.Shapes.Tree namespace provides support to customize the visual appearance of different parts of the exontrol.Pivot object. // /////////////////////////////////////////////////////////// /** * @description The exontrol.Shapes.Tree namespace provides support to customize the visual appearance of different parts of the exontrol.Pivot object. */ exontrol.Shapes.Tree = { /** * @description The shitem field specifies the visual appearance to display the items * @type {object} Indicates an object of {normal,disabled,hover,click} type */ shitem: { /** * @description The hover field includes definitions to draw the object while cursor hovers it. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while cursor hovers it. */ hover: { frameColor: "rgba(64,128,255,0.50)", fillColor: "rgba(64,128,255,0.10)" }, /** * @description The click field includes definitions to draw the object while it is clicked. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while it is clicked. */ click: { frameColor: "rgba(64,128,255,0.50)", fillColor: "rgba(64,128,255,0.20)" }, /** * @description The disabled field includes definitions to draw the object in disabled state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on disabled state. */ disabled: { opacity: 0.5 } }, /** * @description The shitemAlt field specifies the visual appearance to display the alternate-items * @type {object} Indicates an object of {normal,disabled,hover,click} type */ shitemAlt: { /** * @description The hover field includes definitions to draw the object while cursor hovers it. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while cursor hovers it. */ normal: { fillColor: "rgba(0,0,0,0.025)" }, /** * @description The hover field includes definitions to draw the object while cursor hovers it. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while cursor hovers it. */ hover: { frameColor: "rgba(64,128,255,0.50)", fillColor: "rgba(64,128,255,0.10)" }, /** * @description The click field includes definitions to draw the object while it is clicked. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while it is clicked. */ click: { frameColor: "rgba(64,128,255,0.50)", fillColor: "rgba(64,128,255,0.20)" }, /** * @description The disabled field includes definitions to draw the object in disabled state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on disabled state. */ disabled: { opacity: 0.5 } }, /** * @description The shcolumn field specifies the visual appearance to display the header of columns * @type {object} Indicates an object of {normal,disabled,hover,click} type */ shcolumn: { /** * @description The normal field includes definitions to draw the object in normal state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on normal state. */ normal: { primitive: "RoundRect", fillColor: "rgb(240,240,240)", frameColor: "rgb(128,128,128)" }, /** * @description The hover field includes definitions to draw the object while cursor hovers it. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while cursor hovers it. */ hover: { fillColor: "rgb(200,200,200)" }, /** * @description The click field includes definitions to draw the object while it is clicked. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while it is clicked. */ click: { fillColor: "rgb(200,200,200)" // "rgb(160,160,160)" }, /** * @description The disabled field includes definitions to draw the object in disabled state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on disabled state. */ disabled: { opacity: 0.5 } }, /** * @description The shtotal field specifies the visual appearance to display the total-fields * @type {object} Indicates an object of {normal,disabled,hover,click} type */ shtotal: { /** * @description The normal field includes definitions to draw the object in normal state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on normal state. */ normal: { primitive: "RoundRect", fillColor: "rgb(240,240,240)", frameColor: "rgb(128,128,128)", opacity: 0.5 }, /** * @description The hover field includes definitions to draw the object while cursor hovers it. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while cursor hovers it. */ hover: { fillColor: "rgb(200,200,200)", opacity: 0.5 }, /** * @description The click field includes definitions to draw the object while it is clicked. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while it is clicked. */ click: { fillColor: "rgb(200,200,200)"// "rgb(160,160,160)" }, /** * @description The disabled field includes definitions to draw the object in disabled state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on disabled state. */ disabled: { opacity: 0.25 } }, /** * @description The shaddNew field specifies the visual appearance to display the "add-new" buttons * @type {object} Indicates an object of {normal,disabled,hover,click} type */ shaddNew: { /** * @description The normal field includes definitions to draw the object in normal state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on normal state. */ normal: { primitive: "Ellipse", fillColor: "black", pad: -1 }, /** * @description The hover field includes definitions to draw the object while cursor hovers it. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while cursor hovers it. */ hover: { pad: +1 }, /** * @description The click field includes definitions to draw the object while it is clicked. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background while it is clicked. */ click: { }, /** * @description The disabled field includes definitions to draw the object in disabled state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on disabled state. */ disabled: { opacity: 0.5 } }, /** * @description The shcell field specifies the visual appearance to display the cells * @type {object} Indicates an object of {normal,disabled,hover,click} type */ shcell: { /** * @description The disabled field includes definitions to draw the object in disabled state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on disabled state. */ disabled: { opacity: 0.5 } }, /** * @description The shfilterBar field specifies the visual appearance to display the filter-bar * @type {object} Indicates an object of {normal,disabled,hover,click} type */ shfilterBar: { /** * @description The normal field includes definitions to draw the object in normal state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on normal state. */ normal: { fillColor: "rgb(240,240,240)" }, /** * @description The disabled field includes definitions to draw the object in disabled state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on disabled state. */ disabled: { opacity: 0.5 } }, /** * @description The shcheck field specifies the visual appearance to display the check-boxes * @type {object} Indicates an object of {normal,disabled,hover,click} type */ shcheck: { /** * @description The normal field holds an object of exontrol.Def.Shape type that's applied on the part. * @type {object} Indicates an object of exontrol.Def.Shape type that's applied on the part. */ normal: { pad: -1, fillColor: "white", frameColor: "gray", primitive: "Rect", draw: function( ctx, client , clientShape, oShapeData ) { oShapeData && oShapeData.state && ctx.noFD(function() // ignores the context's font-decoration (bold, italic, underline, ...) { ctx.drawHTMLText( "✓", client, exontrol.DrawTextFormatEnum.exTextAlignCenter | exontrol.DrawTextFormatEnum.exTextAlignVCenter | exontrol.DrawTextFormatEnum.exTextNoClip ); }) } }, /** * @description The disabled field includes definitions to draw the object in disabled state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on disabled state. */ disabled: { opacity: 0.5 } }, /** * @description The shcheck field specifies the visual appearance to display the radio-buttons * @type {object} Indicates an object of {normal,disabled,hover,click} type */ shradio: { /** * @description The normal field holds an object of exontrol.Def.Shape type that's applied on the part. * @type {object} Indicates an object of exontrol.Def.Shape type that's applied on the part. */ normal: { pad: -1, fillColor: "white", frameColor: "gray", primitive: "Circle", draw: function( ctx, client , clientShape, oShapeData ) { oShapeData && oShapeData.state && exontrol.D.P.fill( ctx, exontrol.IRt( clientShape.slice(),-clientShape[exontrol.w] * 0.20,-clientShape[exontrol.w] *.20 ), "#666666", this.primitive, this.primitiveArg ); } }, /** * @description The disabled field includes definitions to draw the object in disabled state. * @type {object} An object of exontrol.Def.Shape type to be applied on the part's background on disabled state. */ disabled: { opacity: 0.5 } }, /** * @description The shmulti field specifies the visual appearance to show the count of dragged items * @type {object} Indicates an object of exontrol.Def.Shape type */ shmulti: { primitive: "RoundRect", fillColor: "black", tfi: { fgColor: "white" } } }