Highloadblock element provider
This provider gets data for entity selection (EntitySelector) – for quick search string and selection list:
Call parameters
Parameter | Description | Type | Required |
---|---|---|---|
highloadblockId | Identifier (ID) for highload block. | Int | Yes |
valueField | Field name with record ID in highload block. Default value – UF_XML_ID (for Dictionary iblock property).For custom Bind to highload information block elements fields you must pass the ID value. | String | No |
titleField | Field name for a record in highload block. Default value – UF_NAME (for Dictionary iblock properties).
For Bind to highload information block elements custom fields, pass the field name only in case if it differs from UF_NAME . | String | No |
orderField | Field name, used to sort the elements. Default value – UF_SORT . | String | No |
direction | Sort direction – by ascension/descension. Variants – ASC/DESC . Default value – ASC . | String | No |
Examples
Example of describing filter field in the component main.ui.filter (for Dictionary iblock property):
$field = [ 'type' => 'entity_selector', 'params' => [ 'multiple' => 'Y', 'dialogOptions' => [ 'entities' => [ [ 'id' => 'highloadblock-element', // provider name 'dynamicLoad' => true, 'dynamicSearch' => true, 'options' => [ 'highloadblockId' => 13, // replace to ID of your highload block 'direction' => 'DESC', // default sorting ], ], ], 'searchOptions' => [ 'allowCreateItem' => false, ], ], ], ];
© «Bitrix24», 2001-2024