kintone.events.on(). The specific pages where each API is available are noted in each entry.Show or hide UI buttons
kintone.app.showAddRecordButton(visible)
kintone.app.showAddRecordButton(visible)
kintone.app.showAppSettingsButton(visible)
kintone.app.showAppSettingsButton(visible)
kintone.app.record.showDuplicateRecordButton(visible)
kintone.app.record.showDuplicateRecordButton(visible)
kintone.app.record.showEditRecordButton(visible)
kintone.app.record.showEditRecordButton(visible)
kintone.app.showFilterButton(visible)
kintone.app.showFilterButton(visible)
kintone.app.showViewAndReportSelector(visible)
kintone.app.showViewAndReportSelector(visible)
kintone.mobile.app.showReportSelector(visible) (graphs only) and kintone.mobile.app.showViewSelector(visible) (views only).Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
visible | boolean | Yes | true to show the selector, false to hide it |
Return value
undefinedExample
kintone.app.showOptionsButton(visible)
kintone.app.showOptionsButton(visible)
kintone.app.record.showPager(visible)
kintone.app.record.showPager(visible)
kintone.mobile.app.record.showPager(visible).Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
visible | boolean | Yes | true to show the pager, false to hide it |
Return value
undefinedExample
kintone.app.showReportButton(visible)
kintone.app.showReportButton(visible)
kintone.app.record.showSideBar(visible)
kintone.app.record.showSideBar(visible)
kintone.app.record.showActionButton(visible)
kintone.app.record.showActionButton(visible)
kintone.app.record.showStatusActionButton(visible)
kintone.app.record.showStatusActionButton(visible)
Get elements
Use these APIs to retrieve DOM elements and inject custom UI content.Record form elements
kintone.app.record.getFieldElement(fieldCode)
kintone.app.record.getFieldElement(fieldCode)
kintone.mobile.app.record.getFieldElement(fieldCode).Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldCode | string | Yes | The field code of the target field |
Return value
| Type | Description |
|---|---|
| Element | null | The DOM element for the field, or null if not found |
Example
kintone.app.record.getHeaderMenuSpaceElement()
kintone.app.record.getHeaderMenuSpaceElement()
kintone.app.record.getSpaceElement(id)
kintone.app.record.getSpaceElement(id)
kintone.mobile.app.record.getSpaceElement(id).Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The element ID of the blank space field |
Return value
| Type | Description |
|---|---|
| Element | null | The DOM element for the space, or null if not found |
Example
Record list elements
kintone.app.getFieldElements(fieldCode)
kintone.app.getFieldElements(fieldCode)
kintone.mobile.app.getFieldElements(fieldCode).Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldCode | string | Yes | The field code of the target field |
Return value
| Type | Description |
|---|---|
| Element[] | null | Array of DOM elements (one per record row), or null if not found |
Example
kintone.app.getHeaderMenuSpaceElement()
kintone.app.getHeaderMenuSpaceElement()
kintone.app.getHeaderSpaceElement()
kintone.app.getHeaderSpaceElement()
Parameters
NoneReturn value
| Type | Description |
|---|---|
| Element | null | The DOM element for the header space, or null if not found |
Example
Portal and space elements
kintone.portal.getContentSpaceElement()
kintone.portal.getContentSpaceElement()
kintone.mobile.portal.getContentSpaceElement().Parameters
NoneReturn value
| Type | Description |
|---|---|
| Element | null | The DOM element for the portal content area, or null if not found |
Example
kintone.space.portal.getContentSpaceElement()
kintone.space.portal.getContentSpaceElement()
kintone.mobile.space.portal.getContentSpaceElement().Parameters
NoneReturn value
| Type | Description |
|---|---|
| Element | null | The DOM element for the space content area, or null if not found |
Example
Get element display state
These APIs return the current visibility state of UI elements. Use them to check the current state before toggling visibility.kintone.app.getDescriptionDisplayState()
kintone.app.getDescriptionDisplayState()
kintone.app.record.getSideBarDisplayState()
kintone.app.record.getSideBarDisplayState()
kintone.app.getAddRecordButtonDisplayState()
kintone.app.getAddRecordButtonDisplayState()
kintone.app.record.getEditRecordButtonDisplayState()
kintone.app.record.getEditRecordButtonDisplayState()
kintone.app.record.getDuplicateRecordButtonDisplayState()
kintone.app.record.getDuplicateRecordButtonDisplayState()
kintone.app.getAppSettingsButtonDisplayState()
kintone.app.getAppSettingsButtonDisplayState()
kintone.app.getOptionsButtonDisplayState()
kintone.app.getOptionsButtonDisplayState()
kintone.app.record.getPagerDisplayState()
kintone.app.record.getPagerDisplayState()
kintone.mobile.app.record.getPagerDisplayState().Parameters
NoneReturn value
| Type | Description |
|---|---|
| boolean | true if the pager buttons are visible |
Example
kintone.app.getFilterButtonDisplayState()
kintone.app.getFilterButtonDisplayState()
kintone.app.getReportButtonDisplayState()
kintone.app.getReportButtonDisplayState()
kintone.app.getViewAndReportSelectorDisplayState()
kintone.app.getViewAndReportSelectorDisplayState()
kintone.mobile.app.getReportSelectorDisplayState() (graphs) and kintone.mobile.app.getViewSelectorDisplayState() (views).Parameters
NoneReturn value
| Type | Description |
|---|---|
| boolean | true if the selector is visible |
Example
kintone.app.record.getActionButtonDisplayState()
kintone.app.record.getActionButtonDisplayState()
kintone.app.record.getStatusActionButtonDisplayState()
kintone.app.record.getStatusActionButtonDisplayState()
Related
- Field visibility — Show or hide individual form fields
- Event handling — Register event handlers
- Record list events
- Record detail events