Differences

This shows you the differences between two versions of the page.

Link to this comparison view

easyquery:js:entitiespanel-widget [2015/07/27 12:32] (current)
Line 1: Line 1:
 +
 +====== EntitiesPanel widget ======
 +<jxd:widgetSummary>This widget represents "entities panel" - a rectangular area of your web-page which contains the tree of entities/attributes found in your model
 +and provides the way to add a column(s) to the columns panel and to add a condition(s) to query panel. This also includes drag-and-drop support.</jxd:widgetSummary>
 +<jxd:widgetExample><code>
 +var EPDiv = $('#EntitiesPanel');
 +if (EPDiv.length &gt; 0) {
 +   EPDiv.EntitiesPanel({
 +     showAddColumnButton: false,
 +     showAttributes: { usedInConditions: true, usedInColumns: false, usedInSorting: false }
 +   });
 +}
 +</code></jxd:widgetExample>
 +<jxd:widgetNotes>Usually this widget is initilized implicitly, through <see cref="F:EQ.client.init" /> function call</jxd:widgetNotes>
 +
 +===== Options =====
 +
 +
 +==== queryPanelId ====
 +
 +<jxd:option>
 +<jxd:optionType>String</jxd:optionType>
 +<jxd:optionDefault>QueryPanel</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets an ID of the query panel on the same page that will be used to add conditions to</jxd:optionSummary>
 +</jxd:option>
 +
 +==== columnsPanelId ====
 +
 +<jxd:option>
 +<jxd:optionType>String</jxd:optionType>
 +<jxd:optionDefault>ColumnsPanel</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets an ID of the columns panel on the same page that will be used to add columns to</jxd:optionSummary>
 +</jxd:option>
 +
 +==== showToolbar ====
 +
 +<jxd:option>
 +<jxd:optionType>Boolean</jxd:optionType>
 +<jxd:optionDefault>true</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value indicating whether entities panel should show a toolbar with buttons at the bottom</jxd:optionSummary>
 +</jxd:option>
 +
 +==== showSelectAllButton ====
 +
 +<jxd:option>
 +<jxd:optionType>Boolean</jxd:optionType>
 +<jxd:optionDefault>true</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value indicating whether entities panel should show the "Select all" button on the toolbar</jxd:optionSummary>
 +</jxd:option>
 +
 +==== showClearSelectionButton ====
 +
 +<jxd:option>
 +<jxd:optionType>Boolean</jxd:optionType>
 +<jxd:optionDefault>true</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value indicating whether entities panel should show the "Select none" button on the toolbar</jxd:optionSummary>
 +</jxd:option>
 +
 +==== showAddColumnButton ====
 +
 +<jxd:option>
 +<jxd:optionType>Boolean</jxd:optionType>
 +<jxd:optionDefault>true</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value indicating whether entities panel should show the "Add column" button on the toolbar</jxd:optionSummary>
 +</jxd:option>
 +
 +==== showAddConditionButton ====
 +
 +<jxd:option>
 +<jxd:optionType>Boolean</jxd:optionType>
 +<jxd:optionDefault>true</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value indicating whether entities panel should show the "Add condition" button on the toolbar</jxd:optionSummary>
 +</jxd:option>
 +
 +==== showCheckboxes ====
 +
 +<jxd:option>
 +<jxd:optionType>Boolean</jxd:optionType>
 +<jxd:optionDefault>true</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value indicating whether tree nodes in entities panel should contain checkboxes that allow to select/deselect the nodes</jxd:optionSummary>
 +</jxd:option>
 +
 +==== clickableAttributes ====
 +
 +<jxd:option>
 +<jxd:optionType>Integer</jxd:optionType>
 +<jxd:optionDefault>0</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value defining what should happen when user clicks on the attribute node. Values:
 +  0 - nothing happen. Default behaviour.
 +  1 - attibute is added to conditions.
 +  2 - attribute is added to columns.
 +"draggableAttributes" option should be set to "false" in order to get values 1 and 2 worked.</jxd:optionSummary>
 +</jxd:option>
 +
 +==== draggableAttributes ====
 +
 +<jxd:option>
 +<jxd:optionType>Boolean</jxd:optionType>
 +<jxd:optionDefault>true</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value indicating whether attributes may be dragged to be droppen at query panel or columns panel</jxd:optionSummary>
 +</jxd:option>
 +
 +==== showAttributes ====
 +
 +<jxd:option>
 +<jxd:optionType>PlainObject</jxd:optionType>
 +<jxd:optionDefault>{ usedInConditions: true, usedInColumns: true, usedInSorting: false }</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value defining which attributes from the model should be shown in the tree. Each attribute in the model has "Use in conditions", "Use in columns", "Use in sorting" properties. This option allows to filter all the attributes by these properties values.</jxd:optionSummary>
 +</jxd:option>
 +
 +==== showFilterBox ====
 +
 +<jxd:option>
 +<jxd:optionType>Boolean</jxd:optionType>
 +<jxd:optionDefault>true</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value indicating whether filtef box should be show to allow filtering of visible entities/attributes</jxd:optionSummary>
 +</jxd:option>
 +
 +==== showIndicatorOnLoad ====
 +
 +<jxd:option>
 +<jxd:optionType>Boolean</jxd:optionType>
 +<jxd:optionDefault>true</jxd:optionDefault>
 +<jxd:optionSummary>Gets or sets a value indicating whether a progress indicator should appear while th emodel is loading</jxd:optionSummary>
 +</jxd:option>
 +
 +===== Methods  =====
 +
 +
 +==== refresh ====
 +
 +<jxd:function>
 +<jxd:functionSummary>Re-renders the panel</jxd:functionSummary>
 +</jxd:function>
 +<PRELOAD>/apistyle.css</PRELOAD>