EntitiesPanelOptions interface

May 8, 2019

EntitiesPanel options

Index

Properties

attrPlacement

Defines where to display attributes in the tree: 0 - attributes are displayed after entities 1 - attributes are displayed before entities 2 - attributes and entities are mixed, and displayed in alphabetical order. In this case the sortEntities option value dosn't matter.

● attrPlacement?: number

attributeRenderedCallback

The callback that is called when the attribute node has been rendered. It allows you to make any changes you need to the markup of the node. Parameters: attrNode - jQuery object that represents the node div

● attributeRenderedCallback?: (attrNode: HTMLElement) => void

Example:


attributeRenderedCallbackHandler: function (attrNode) {
   attrNode.addClass("some-cool-class");
}

autoClearSelection

Defines whether all selections will be cleared automatically after add columns or add conditions operation.

● autoClearSelection?: boolean

clickableAttributes

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.

● clickableAttributes?: number

draggableAttributes

● draggableAttributes?: boolean

entityRenderedCallback

The callback that is called when the entity node has been rendered. It allows you to make any changes you need to the markup of the node. Parameters: entNode - jQuery object that represents the node div

● entityRenderedCallback?: (entNode: HTMLElement) => void

Example:


entityRenderedCallbackHandler: function (entNode) {
     entNode.addClass("some-cool-class");
}

filterBoxMode

Gets or sets a value defining how the search is performed in EntitiesPanel. Values: 0 - checks if node name contains the filter text. Default behaviour. 1 - checks if node name starts with the filter text.

● filterBoxMode?: number

showAddColumnButton

● showAddColumnButton?: boolean

showAddConditionButton

● showAddConditionButton?: boolean

showAttributes

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.

● showAttributes?: UsedInOptions

showCheckboxes

● showCheckboxes?: boolean

showClearSelectionButton

● showClearSelectionButton?: boolean

showFilterBox

● showFilterBox?: boolean

showIndicatorOnLoad

Gets or sets a value indicating whether a progress indicator should appear while th emodel is loading

● showIndicatorOnLoad?: boolean

showSelectAllButton

● showSelectAllButton?: boolean

showToolbar

● showToolbar?: boolean

showTooltips

● showTooltips?: boolean

sortEntities

Defines whether entities and attributes should be sorted alphabetically. If false, they are displayed as listed in the model.

● sortEntities?: boolean

syncWithColumns

● syncWithColumns?: boolean