krewSheet

https://krew.mescius.com/docs/online-krewsheet/
Admin
krewSheet is a plug-in for Cybozu kintone that allows users to view and edit records in an...
Tokens:72,107
Snippets:699
Trust Score:8.7
Update:5 days ago
Show doc for...
Tokens:
Raw
### app.record.index.edit.show - Upon starting editing operation

Source: https://krew.mescius.com/docs/online-krewsheet/event_recordlist.html

This event fires when an editing operation is started on the record view. The source text does not provide detailed information about this event.

```APIDOC
## Event - Upon starting editing operation

### Description
This event fires when an editing operation is started on the record view. The source text does not provide detailed information about this event.

### Event Type
app.record.index.edit.show

### Timing of Event Firing
Not specified in the source.

### Event Object Property
Not specified in the source.

### Control Depending on Field value
Not specified in the source.
```

--------------------------------

### app.record.index.edit.show

Source: https://krew.mescius.com/docs/online-krewsheet/event_recordlist.html

This event fires when editing of krewSheet is started. It provides access to the record data at the time editing began.

```APIDOC
## Event: app.record.index.edit.show

### Description
This event fires when editing of krewSheet is started.

### Event Type
app.record.index.edit.show

### Event Object Properties
- **appId** (Number) - App ID
- **record** (Object) - Record objects retaining the data at the time when editing was started
- **recordId** (Number) - Record ID
- **type** (String) - Event type

### Control Depending on Field Value
This function isn't available.

```

--------------------------------

### Redirect after successful save using app.record.index.edit.submit.success

Source: https://krew.mescius.com/docs/online-krewsheet/event_recordlist.html

This snippet shows how to set the url property in the event object for the app.record.index.edit.submit.success event to redirect to a specified URL after a successful save. If the url property is not specified or is null, the screen remains unchanged. The example redirects to https://krew.mescius.com/.

```javascript
// After a successful save operation, it will move to https://krew.mescius.com/.Kintone.events.on("app.record.index.show," function(e) {
    krewSheet.events.on('app.record.index.edit.submit.success," function (event) {
        event.url = "https://krew.mescius.com/";
        console.log("url: " + event.url);
        return event;
    });
});
```

--------------------------------

### Sample: Display update time after saving record

Source: https://krew.mescius.com/docs/online-krewsheet/event_recordlist.html

Sample program that displays the time and date of update after saving a record. It uses krewSheet events and alerts the value of the 'time and date of update' field for each record.

```javascript
// Display the time and date of update after saving the record
Kintone.events.on('app.record.index.show," function(e) {
    krewSheet.events.on('app.record.index.edit.submit.success," function (event) {
        var records = event.records;
        for(let i=0; i<records.length;i++){
            alert(tTime and date of update" + records[i]["time and date of update"]["value"] + ."");
        }
        // console.log(event);
        return event;
    });
});
```

--------------------------------

### app.record.index.show - After displaying record view screen

Source: https://krew.mescius.com/docs/online-krewsheet/event_recordlist.html

This event fires when the record view screen using krewSheet is displayed. It can be used to perform asynchronous processing by returning a Kintone.Promise object.

```APIDOC
## Event - After displaying record view screen

### Description
This event fires when the record view screen (using krewSheet) is displayed. If a Kintone.Promise object is returned, event processing begins upon the completion of asynchronous processing.

### Event Type
app.record.index.show

### Timing of Event Firing
- At the time of displaying record view screen
- At the time of sending page on record view screen
- When sorting is done in record view screen
- When a filtering condition for the record view screen is applied

### Event Object Property
| Property Name | Type | Description |
|---------------|------|-------------|
| appId | Number | App ID |
| viewType | String | Custom (krewSheet supports [Customize] format view only) |
| viewId | Number | View ID |
| viewName | String | View Name |
| records | Array | Array of record object |
| offset | Number | Number of offsets of the view |
| size | Number | Number of records of the view |
| date | String | null |
| type | String | Event type |

### Control Depending on Field value
This function isn't available.
```

--------------------------------

### WORKDAY.INTL

Source: https://krew.mescius.com/docs/online-krewsheet/formulafunctions.html

Returns the serial number of the date before or after a specified number of workdays from a start date using a parameter that indicates which and how many days are weekend days.

```APIDOC
## WORKDAY.INTL

### Description
Returns the serial number of the date before or after a specified number of workdays from a start date using a parameter that indicates which and how many days are weekend days.

### Function
WORKDAY.INTL

### Parameters
- **start_date** (number/DateTime) - Required - The start date.
- **days** (number) - Required - The number of workdays before or after start_date.
- **weekend** (number/string) - Optional - A number or string that specifies which days are weekend days.
- **holidays** (array) - Optional - A list of dates to exclude from the workday calendar.

### Return Value
- **number** - The serial number of the resulting date.
```

--------------------------------

### Register an event handler with krewsheet.events.on

Source: https://krew.mescius.com/docs/online-krewsheet/event_handling.html

Registers an event handler for a specific event type. The handler is registered after krewSheet is loaded, so it should be registered after kintone's record view screen is displayed.

```javascript
// Execute the registration of event handler
var handler = function(event) {
    console.log(event);
};
kintone.events.on('app.record.index.show', function(event) {
    krewsheet.events.on('app.record.index.show', handler);
});

```

--------------------------------

### WORKDAY

Source: https://krew.mescius.com/docs/online-krewsheet/formulafunctions.html

Returns the total number of workdays (= days excluding Saturday, Sunday, and specified holidays) to the date that is the specified number of days before (-) or after (+) a specified start date (number/DateTime object).

```APIDOC
## WORKDAY

### Description
Returns the total number of workdays (= days excluding Saturday, Sunday, and specified holidays) to the date that is the specified number of days before (-) or after (+) a specified start date (number/DateTime object).

### Function
WORKDAY

### Parameters
- **start_date** (number/DateTime) - Required - The start date.
- **days** (number) - Required - The number of workdays before or after start_date.
- **holidays** (array) - Optional - A list of dates to exclude from the workday calendar.

### Return Value
- **DateTime** - The resulting date.
```

--------------------------------

### app.record.index.edit.change.<Field Code>

Source: https://krew.mescius.com/docs/online-krewsheet/event_recordlist.html

This event fires when the field value becomes modified. The modification of the value which triggered the event won't be canceled. If a Kintone.Promise object is returned, event processing starts upon the completion of asynchronous processing.

```APIDOC
## Event: app.record.index.edit.change.<Field Code>

### Description
This event fires when the field value becomes modified. The modification of the value which triggered the event won't be canceled. If a Kintone.Promise object is returned, event processing starts upon the completion of asynchronous processing.

### Event Type
app.record.index.edit.change.<Field Code>

### Fields That Can be Specified in Field Code
Handler can be performed only in the following situations: when field codes present in <Field Code> are specified; and the field types such as those shown below are specified. If any fields that aren't present in <Field Code> or field types other than those shown below are specified, no event will occur.
- Radio Button
- Drop-down
- Check box
- Multiple-choice
- User selection
- Department Selection
- Group selection
- Date
- Time
- Date and time
- Text (single-row)
- Number
- Table

*For Text (single-row) and Number fields, event fires at the following timing:
- When modified cell is moved

*For Table field, event fires at the following timing:
- When table rows are added and when the [Delete Row] button is clicked.

### Event Object Properties
- **appId** (Number) - App ID
- **record** (Object) - Record object retaining the data input by user when event is fired
- **recordId** (Number) - Record ID
- **changes** (Object) - Changed object
- **changes.field** (Object) - Changed Field object
- **type** (String) - Event type

### Control Depending on Field Value
- Rewrite the field value
- Obtain changed fields and row objects in tables

```

--------------------------------

### SWITCH

Source: https://krew.mescius.com/docs/online-krewsheet/formulafunctions.html

Evaluates an expression against a list of values and returns the result that corresponds to the first matching value.

```APIDOC
## SWITCH

### Description
Evaluates an expression against a list of values and returns the result that corresponds to the first matching value. If no match is found, an optional default value is returned.

### Function
SWITCH

### Parameters
- **expression** (any) - Required - The expression to evaluate.
- **value1** (any) - Required - The first value to compare against.
- **result1** (any) - Required - The result to return if expression matches value1.
- **value2** (any) - Optional - Additional value/result pairs.
- **result2** (any) - Optional - Additional result.
- **default** (any) - Optional - The default value to return if no match is found.

### Return Value
- **any** - The result corresponding to the first matching value, or the default value if no match.
```

--------------------------------

### TRIM

Source: https://krew.mescius.com/docs/online-krewsheet/formulafunctions.html

Removes all spaces from a specified string except for single spaces between words.

```APIDOC
## TRIM

### Description
Removes all spaces from a specified string except for single spaces between words.

### Function
TRIM

### Parameters
- **text** (string) - Required - The string to trim.

### Return Value
- **string** - The trimmed string.
```

--------------------------------

### app.record.index.delete.submit

Source: https://krew.mescius.com/docs/online-krewsheet/event_recordlist.html

This event fires after clicking the "Delete" button on the command bar and then "OK" on the popup menu. This event fires only once when multiple records are saved simultaneously. If false is returned, the deletion process can be canceled.

```APIDOC
## Event: app.record.index.delete.submit

### Description
This event fires after clicking the "Delete" button on the command bar and then "OK" on the popup menu. This event fires only once when multiple records are saved simultaneously. If false is returned, the deletion process can be canceled. Multiple records can be obtained only from the data changed by the Records property of the event object. If a Kintone.Promise object is returned, event processing starts upon the completion of asynchronous processing.

### Event Type
app.record.index.delete.submit

### Event Object Properties
- **appId** (Number) - App ID
- **recordIds** (Array) - Array of record ID
- **records** (Array) - Array of record objects retaining record data to be deleted
- **type** (String) - Event type

```

--------------------------------

### app.record.index.delete.submit - Before deleting a record

Source: https://krew.mescius.com/docs/online-krewsheet/event_recordlist.html

This event fires before a record is deleted. The source text does not provide detailed information about this event.

```APIDOC
## Event - Before deleting a record

### Description
This event fires before a record is deleted. The source text does not provide detailed information about this event.

### Event Type
app.record.index.delete.submit

### Timing of Event Firing
Not specified in the source.

### Event Object Property
Not specified in the source.

### Control Depending on Field value
Not specified in the source.
```

--------------------------------

### SUBSTITUTE

Source: https://krew.mescius.com/docs/online-krewsheet/formulafunctions.html

Replaces a specified substring with another string in a given string.

```APIDOC
## SUBSTITUTE

### Description
Returns a specified string after replacing a specified substring with another string. Use the REPLACE function for string replacement by location.

### Function
SUBSTITUTE

### Parameters
- **text** (string) - Required - The original string.
- **old_text** (string) - Required - The substring to be replaced.
- **new_text** (string) - Required - The substring to replace with.
- **instance_num** (number) - Optional - Specifies which occurrence of old_text to replace. If omitted, all occurrences are replaced.

### Return Value
- **string** - The resulting string after replacement.
```

--------------------------------

### WEIBULL.DIST

Source: https://krew.mescius.com/docs/online-krewsheet/formulafunctions.html

Returns the value of the Weibull distribution.

```APIDOC
## WEIBULL.DIST

### Description
Returns the value of the Weibull distribution.

### Function
WEIBULL.DIST

### Parameters
- **x** (number) - Required - The value at which to evaluate the distribution.
- **alpha** (number) - Required - The alpha parameter.
- **beta** (number) - Required - The beta parameter.
- **cumulative** (logical) - Required - A logical value that determines the form of the function (TRUE for cumulative distribution, FALSE for probability density).

### Return Value
- **number** - The distribution value.
```

--------------------------------

### TRUE

Source: https://krew.mescius.com/docs/online-krewsheet/formulafunctions.html

Returns a logical value of True (= 1).

```APIDOC
## TRUE

### Description
Returns a logical value of True (= 1).

### Function
TRUE

### Parameters
None

### Return Value
- **logical** - True.
```

--------------------------------

### TODAY

Source: https://krew.mescius.com/docs/online-krewsheet/formulafunctions.html

Returns a DateTime object that represents the current date.

```APIDOC
## TODAY

### Description
Returns a DateTime object that represents the current date.

### Function
TODAY

### Parameters
None

### Return Value
- **DateTime** - The current date.
```
Tokens:
Raw