Skip to content

Commit

Permalink
Add bulkEditor documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
johnvanbreda committed May 16, 2024
1 parent afc74dd commit 16e2c2e
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions site-building/iform/helpers/elasticsearch-report-helper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ example::
@source=photos-data

ElasticsearchReportHelper::controlLayout
---------------------------------------
----------------------------------------

A control for managing layout, e.g. for verification pages.

Expand All @@ -587,14 +587,44 @@ Options

**id**

Optional. Specify an ID for the `customScript` control allowing you to refer to it from
Optional. Specify an ID for the `controlLayout` control allowing you to refer to it from
elsewhere, e.g. CSS. If not specified, then a unique ID is generated by the code which
cannot be relied on.

**setHeightPercent**

**setOriginY**

ElasticsearchReportHelper::bulkEditor
-------------------------------------

A button that pops up a dialog allowing the user to bulk edit all or selected records in the
current occurrences dataset. Limited to recorder name, date, location name and spatial reference
fields.

Options
^^^^^^^

**caption**

Optional. Button caption, defaults to "Bulk edit records".

**id**

Optional. Specify an ID for the `bulkEditor` control allowing you to refer to it from
elsewhere, e.g. CSS. If not specified, then a unique ID is generated by the code which
cannot be relied on.

**linkToDataControl**

Required. The ID of the dataGrid or cardGallery which is displaying the dataset of records that can
be bulk edited.

**restrictToOwnData**

Optional. Defaults to true. Set to false if on an admin-access page where editing other user's data
is appropriate.

ElasticsearchReportHelper::customScript
---------------------------------------

Expand Down

0 comments on commit 16e2c2e

Please sign in to comment.